blob: ef44c7a0638cdaaf087a65e01476aca73d29239b [file] [log] [blame]
Philipp Reisnerb411b362009-09-25 16:07:19 -07001/*
2 drbd.h
3 Kernel module for 2.6.x Kernels
4
5 This file is part of DRBD by Philipp Reisner and Lars Ellenberg.
6
7 Copyright (C) 2001-2008, LINBIT Information Technologies GmbH.
8 Copyright (C) 2001-2008, Philipp Reisner <philipp.reisner@linbit.com>.
9 Copyright (C) 2001-2008, Lars Ellenberg <lars.ellenberg@linbit.com>.
10
11 drbd is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2, or (at your option)
14 any later version.
15
16 drbd is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with drbd; see the file COPYING. If not, write to
23 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24
25*/
26#ifndef DRBD_H
27#define DRBD_H
28#include <linux/connector.h>
29#include <asm/types.h>
30
31#ifdef __KERNEL__
32#include <linux/types.h>
33#include <asm/byteorder.h>
34#else
35#include <sys/types.h>
36#include <sys/wait.h>
37#include <limits.h>
38
39/* Altough the Linux source code makes a difference between
40 generic endianness and the bitfields' endianness, there is no
41 architecture as of Linux-2.6.24-rc4 where the bitfileds' endianness
42 does not match the generic endianness. */
43
44#if __BYTE_ORDER == __LITTLE_ENDIAN
45#define __LITTLE_ENDIAN_BITFIELD
46#elif __BYTE_ORDER == __BIG_ENDIAN
47#define __BIG_ENDIAN_BITFIELD
48#else
49# error "sorry, weird endianness on this box"
50#endif
51
52#endif
53
54
55extern const char *drbd_buildtag(void);
Philipp Reisner8825f7c2010-10-21 17:21:19 +020056#define REL_VERSION "8.3.9"
Philipp Reisnerb411b362009-09-25 16:07:19 -070057#define API_VERSION 88
58#define PRO_VERSION_MIN 86
Lars Ellenberg22cc37a2010-09-14 20:40:41 +020059#define PRO_VERSION_MAX 95
Philipp Reisnerb411b362009-09-25 16:07:19 -070060
61
62enum drbd_io_error_p {
63 EP_PASS_ON, /* FIXME should the better be named "Ignore"? */
64 EP_CALL_HELPER,
65 EP_DETACH
66};
67
68enum drbd_fencing_p {
69 FP_DONT_CARE,
70 FP_RESOURCE,
71 FP_STONITH
72};
73
74enum drbd_disconnect_p {
75 DP_RECONNECT,
76 DP_DROP_NET_CONF,
77 DP_FREEZE_IO
78};
79
80enum drbd_after_sb_p {
81 ASB_DISCONNECT,
82 ASB_DISCARD_YOUNGER_PRI,
83 ASB_DISCARD_OLDER_PRI,
84 ASB_DISCARD_ZERO_CHG,
85 ASB_DISCARD_LEAST_CHG,
86 ASB_DISCARD_LOCAL,
87 ASB_DISCARD_REMOTE,
88 ASB_CONSENSUS,
89 ASB_DISCARD_SECONDARY,
90 ASB_CALL_HELPER,
91 ASB_VIOLENTLY
92};
93
Philipp Reisner265be2d2010-05-31 10:14:17 +020094enum drbd_on_no_data {
95 OND_IO_ERROR,
96 OND_SUSPEND_IO
97};
98
Philipp Reisnerb411b362009-09-25 16:07:19 -070099/* KEEP the order, do not delete or insert. Only append. */
100enum drbd_ret_codes {
101 ERR_CODE_BASE = 100,
102 NO_ERROR = 101,
103 ERR_LOCAL_ADDR = 102,
104 ERR_PEER_ADDR = 103,
105 ERR_OPEN_DISK = 104,
106 ERR_OPEN_MD_DISK = 105,
107 ERR_DISK_NOT_BDEV = 107,
108 ERR_MD_NOT_BDEV = 108,
109 ERR_DISK_TO_SMALL = 111,
110 ERR_MD_DISK_TO_SMALL = 112,
111 ERR_BDCLAIM_DISK = 114,
112 ERR_BDCLAIM_MD_DISK = 115,
113 ERR_MD_IDX_INVALID = 116,
114 ERR_IO_MD_DISK = 118,
115 ERR_MD_INVALID = 119,
116 ERR_AUTH_ALG = 120,
117 ERR_AUTH_ALG_ND = 121,
118 ERR_NOMEM = 122,
119 ERR_DISCARD = 123,
120 ERR_DISK_CONFIGURED = 124,
121 ERR_NET_CONFIGURED = 125,
122 ERR_MANDATORY_TAG = 126,
123 ERR_MINOR_INVALID = 127,
124 ERR_INTR = 129, /* EINTR */
125 ERR_RESIZE_RESYNC = 130,
126 ERR_NO_PRIMARY = 131,
127 ERR_SYNC_AFTER = 132,
128 ERR_SYNC_AFTER_CYCLE = 133,
129 ERR_PAUSE_IS_SET = 134,
130 ERR_PAUSE_IS_CLEAR = 135,
131 ERR_PACKET_NR = 137,
132 ERR_NO_DISK = 138,
133 ERR_NOT_PROTO_C = 139,
134 ERR_NOMEM_BITMAP = 140,
135 ERR_INTEGRITY_ALG = 141, /* DRBD 8.2 only */
136 ERR_INTEGRITY_ALG_ND = 142, /* DRBD 8.2 only */
137 ERR_CPU_MASK_PARSE = 143, /* DRBD 8.2 only */
138 ERR_CSUMS_ALG = 144, /* DRBD 8.2 only */
139 ERR_CSUMS_ALG_ND = 145, /* DRBD 8.2 only */
140 ERR_VERIFY_ALG = 146, /* DRBD 8.2 only */
141 ERR_VERIFY_ALG_ND = 147, /* DRBD 8.2 only */
142 ERR_CSUMS_RESYNC_RUNNING= 148, /* DRBD 8.2 only */
143 ERR_VERIFY_RUNNING = 149, /* DRBD 8.2 only */
144 ERR_DATA_NOT_CURRENT = 150,
145 ERR_CONNECTED = 151, /* DRBD 8.3 only */
Philipp Reisner9f5180e2009-10-06 09:30:14 +0200146 ERR_PERM = 152,
Philipp Reisner6495d2c2010-03-24 16:07:04 +0100147 ERR_NEED_APV_93 = 153,
Philipp Reisner47ff2d02010-06-18 13:56:57 +0200148 ERR_STONITH_AND_PROT_A = 154,
Philipp Reisnerb411b362009-09-25 16:07:19 -0700149
150 /* insert new ones above this line */
151 AFTER_LAST_ERR_CODE
152};
153
154#define DRBD_PROT_A 1
155#define DRBD_PROT_B 2
156#define DRBD_PROT_C 3
157
158enum drbd_role {
159 R_UNKNOWN = 0,
160 R_PRIMARY = 1, /* role */
161 R_SECONDARY = 2, /* role */
162 R_MASK = 3,
163};
164
165/* The order of these constants is important.
166 * The lower ones (<C_WF_REPORT_PARAMS) indicate
167 * that there is no socket!
168 * >=C_WF_REPORT_PARAMS ==> There is a socket
169 */
170enum drbd_conns {
171 C_STANDALONE,
172 C_DISCONNECTING, /* Temporal state on the way to StandAlone. */
173 C_UNCONNECTED, /* >= C_UNCONNECTED -> inc_net() succeeds */
174
175 /* These temporal states are all used on the way
176 * from >= C_CONNECTED to Unconnected.
177 * The 'disconnect reason' states
178 * I do not allow to change beween them. */
179 C_TIMEOUT,
180 C_BROKEN_PIPE,
181 C_NETWORK_FAILURE,
182 C_PROTOCOL_ERROR,
183 C_TEAR_DOWN,
184
185 C_WF_CONNECTION,
186 C_WF_REPORT_PARAMS, /* we have a socket */
187 C_CONNECTED, /* we have introduced each other */
188 C_STARTING_SYNC_S, /* starting full sync by admin request. */
189 C_STARTING_SYNC_T, /* stariing full sync by admin request. */
190 C_WF_BITMAP_S,
191 C_WF_BITMAP_T,
192 C_WF_SYNC_UUID,
193
194 /* All SyncStates are tested with this comparison
195 * xx >= C_SYNC_SOURCE && xx <= C_PAUSED_SYNC_T */
196 C_SYNC_SOURCE,
197 C_SYNC_TARGET,
198 C_VERIFY_S,
199 C_VERIFY_T,
200 C_PAUSED_SYNC_S,
201 C_PAUSED_SYNC_T,
202 C_MASK = 31
203};
204
205enum drbd_disk_state {
206 D_DISKLESS,
207 D_ATTACHING, /* In the process of reading the meta-data */
208 D_FAILED, /* Becomes D_DISKLESS as soon as we told it the peer */
209 /* when >= D_FAILED it is legal to access mdev->bc */
210 D_NEGOTIATING, /* Late attaching state, we need to talk to the peer */
211 D_INCONSISTENT,
212 D_OUTDATED,
213 D_UNKNOWN, /* Only used for the peer, never for myself */
214 D_CONSISTENT, /* Might be D_OUTDATED, might be D_UP_TO_DATE ... */
215 D_UP_TO_DATE, /* Only this disk state allows applications' IO ! */
216 D_MASK = 15
217};
218
219union drbd_state {
220/* According to gcc's docs is the ...
221 * The order of allocation of bit-fields within a unit (C90 6.5.2.1, C99 6.7.2.1).
222 * Determined by ABI.
223 * pointed out by Maxim Uvarov q<muvarov@ru.mvista.com>
224 * even though we transmit as "cpu_to_be32(state)",
225 * the offsets of the bitfields still need to be swapped
226 * on different endianess.
227 */
228 struct {
229#if defined(__LITTLE_ENDIAN_BITFIELD)
230 unsigned role:2 ; /* 3/4 primary/secondary/unknown */
231 unsigned peer:2 ; /* 3/4 primary/secondary/unknown */
232 unsigned conn:5 ; /* 17/32 cstates */
233 unsigned disk:4 ; /* 8/16 from D_DISKLESS to D_UP_TO_DATE */
234 unsigned pdsk:4 ; /* 8/16 from D_DISKLESS to D_UP_TO_DATE */
Philipp Reisnerfb22c402010-09-08 23:20:21 +0200235 unsigned susp:1 ; /* 2/2 IO suspended no/yes (by user) */
Philipp Reisnerb411b362009-09-25 16:07:19 -0700236 unsigned aftr_isp:1 ; /* isp .. imposed sync pause */
237 unsigned peer_isp:1 ;
238 unsigned user_isp:1 ;
Philipp Reisnerfb22c402010-09-08 23:20:21 +0200239 unsigned susp_nod:1 ; /* IO suspended because no data */
240 unsigned susp_fen:1 ; /* IO suspended because fence peer handler runs*/
241 unsigned _pad:9; /* 0 unused */
Philipp Reisnerb411b362009-09-25 16:07:19 -0700242#elif defined(__BIG_ENDIAN_BITFIELD)
Philipp Reisnerfb22c402010-09-08 23:20:21 +0200243 unsigned _pad:9;
244 unsigned susp_fen:1 ;
245 unsigned susp_nod:1 ;
Philipp Reisnerb411b362009-09-25 16:07:19 -0700246 unsigned user_isp:1 ;
247 unsigned peer_isp:1 ;
248 unsigned aftr_isp:1 ; /* isp .. imposed sync pause */
249 unsigned susp:1 ; /* 2/2 IO suspended no/yes */
250 unsigned pdsk:4 ; /* 8/16 from D_DISKLESS to D_UP_TO_DATE */
251 unsigned disk:4 ; /* 8/16 from D_DISKLESS to D_UP_TO_DATE */
252 unsigned conn:5 ; /* 17/32 cstates */
253 unsigned peer:2 ; /* 3/4 primary/secondary/unknown */
254 unsigned role:2 ; /* 3/4 primary/secondary/unknown */
255#else
256# error "this endianess is not supported"
257#endif
258 };
259 unsigned int i;
260};
261
262enum drbd_state_ret_codes {
263 SS_CW_NO_NEED = 4,
264 SS_CW_SUCCESS = 3,
265 SS_NOTHING_TO_DO = 2,
266 SS_SUCCESS = 1,
267 SS_UNKNOWN_ERROR = 0, /* Used to sleep longer in _drbd_request_state */
268 SS_TWO_PRIMARIES = -1,
269 SS_NO_UP_TO_DATE_DISK = -2,
270 SS_NO_LOCAL_DISK = -4,
271 SS_NO_REMOTE_DISK = -5,
272 SS_CONNECTED_OUTDATES = -6,
273 SS_PRIMARY_NOP = -7,
274 SS_RESYNC_RUNNING = -8,
275 SS_ALREADY_STANDALONE = -9,
276 SS_CW_FAILED_BY_PEER = -10,
277 SS_IS_DISKLESS = -11,
278 SS_DEVICE_IN_USE = -12,
279 SS_NO_NET_CONFIG = -13,
280 SS_NO_VERIFY_ALG = -14, /* drbd-8.2 only */
281 SS_NEED_CONNECTION = -15, /* drbd-8.2 only */
282 SS_LOWER_THAN_OUTDATED = -16,
283 SS_NOT_SUPPORTED = -17, /* drbd-8.2 only */
284 SS_IN_TRANSIENT_STATE = -18, /* Retry after the next state change */
285 SS_CONCURRENT_ST_CHG = -19, /* Concurrent cluster side state change! */
286 SS_AFTER_LAST_ERROR = -20, /* Keep this at bottom */
287};
288
289/* from drbd_strings.c */
290extern const char *drbd_conn_str(enum drbd_conns);
291extern const char *drbd_role_str(enum drbd_role);
292extern const char *drbd_disk_str(enum drbd_disk_state);
293extern const char *drbd_set_st_err_str(enum drbd_state_ret_codes);
294
295#define SHARED_SECRET_MAX 64
296
297#define MDF_CONSISTENT (1 << 0)
298#define MDF_PRIMARY_IND (1 << 1)
299#define MDF_CONNECTED_IND (1 << 2)
300#define MDF_FULL_SYNC (1 << 3)
301#define MDF_WAS_UP_TO_DATE (1 << 4)
302#define MDF_PEER_OUT_DATED (1 << 5)
303#define MDF_CRASHED_PRIMARY (1 << 6)
304
305enum drbd_uuid_index {
306 UI_CURRENT,
307 UI_BITMAP,
308 UI_HISTORY_START,
309 UI_HISTORY_END,
310 UI_SIZE, /* nl-packet: number of dirty bits */
311 UI_FLAGS, /* nl-packet: flags */
312 UI_EXTENDED_SIZE /* Everything. */
313};
314
315enum drbd_timeout_flag {
316 UT_DEFAULT = 0,
317 UT_DEGRADED = 1,
318 UT_PEER_OUTDATED = 2,
319};
320
321#define UUID_JUST_CREATED ((__u64)4)
322
323#define DRBD_MAGIC 0x83740267
324#define BE_DRBD_MAGIC __constant_cpu_to_be32(DRBD_MAGIC)
Philipp Reisner0b70a132010-08-20 13:36:10 +0200325#define DRBD_MAGIC_BIG 0x835a
326#define BE_DRBD_MAGIC_BIG __constant_cpu_to_be16(DRBD_MAGIC_BIG)
Philipp Reisnerb411b362009-09-25 16:07:19 -0700327
328/* these are of type "int" */
329#define DRBD_MD_INDEX_INTERNAL -1
330#define DRBD_MD_INDEX_FLEX_EXT -2
331#define DRBD_MD_INDEX_FLEX_INT -3
332
333/* Start of the new netlink/connector stuff */
334
335#define DRBD_NL_CREATE_DEVICE 0x01
336#define DRBD_NL_SET_DEFAULTS 0x02
337
Philipp Reisnerb411b362009-09-25 16:07:19 -0700338
339/* For searching a vacant cn_idx value */
340#define CN_IDX_STEP 6977
341
342struct drbd_nl_cfg_req {
343 int packet_type;
344 unsigned int drbd_minor;
345 int flags;
346 unsigned short tag_list[];
347};
348
349struct drbd_nl_cfg_reply {
350 int packet_type;
351 unsigned int minor;
352 int ret_code; /* enum ret_code or set_st_err_t */
353 unsigned short tag_list[]; /* only used with get_* calls */
354};
355
356#endif