xref: /linux/include/linux/drbd.h (revision cdb138080b78146d1cdadba9f5dadbeb97445b91)
1 /*
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 
55 extern const char *drbd_buildtag(void);
56 #define REL_VERSION "8.3.8.1"
57 #define API_VERSION 88
58 #define PRO_VERSION_MIN 86
59 #define PRO_VERSION_MAX 94
60 
61 
62 enum drbd_io_error_p {
63 	EP_PASS_ON, /* FIXME should the better be named "Ignore"? */
64 	EP_CALL_HELPER,
65 	EP_DETACH
66 };
67 
68 enum drbd_fencing_p {
69 	FP_DONT_CARE,
70 	FP_RESOURCE,
71 	FP_STONITH
72 };
73 
74 enum drbd_disconnect_p {
75 	DP_RECONNECT,
76 	DP_DROP_NET_CONF,
77 	DP_FREEZE_IO
78 };
79 
80 enum 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 
94 /* KEEP the order, do not delete or insert. Only append. */
95 enum drbd_ret_codes {
96 	ERR_CODE_BASE		= 100,
97 	NO_ERROR		= 101,
98 	ERR_LOCAL_ADDR		= 102,
99 	ERR_PEER_ADDR		= 103,
100 	ERR_OPEN_DISK		= 104,
101 	ERR_OPEN_MD_DISK	= 105,
102 	ERR_DISK_NOT_BDEV	= 107,
103 	ERR_MD_NOT_BDEV		= 108,
104 	ERR_DISK_TO_SMALL	= 111,
105 	ERR_MD_DISK_TO_SMALL	= 112,
106 	ERR_BDCLAIM_DISK	= 114,
107 	ERR_BDCLAIM_MD_DISK	= 115,
108 	ERR_MD_IDX_INVALID	= 116,
109 	ERR_IO_MD_DISK		= 118,
110 	ERR_MD_INVALID          = 119,
111 	ERR_AUTH_ALG		= 120,
112 	ERR_AUTH_ALG_ND		= 121,
113 	ERR_NOMEM		= 122,
114 	ERR_DISCARD		= 123,
115 	ERR_DISK_CONFIGURED	= 124,
116 	ERR_NET_CONFIGURED	= 125,
117 	ERR_MANDATORY_TAG	= 126,
118 	ERR_MINOR_INVALID	= 127,
119 	ERR_INTR		= 129, /* EINTR */
120 	ERR_RESIZE_RESYNC	= 130,
121 	ERR_NO_PRIMARY		= 131,
122 	ERR_SYNC_AFTER		= 132,
123 	ERR_SYNC_AFTER_CYCLE	= 133,
124 	ERR_PAUSE_IS_SET	= 134,
125 	ERR_PAUSE_IS_CLEAR	= 135,
126 	ERR_PACKET_NR		= 137,
127 	ERR_NO_DISK		= 138,
128 	ERR_NOT_PROTO_C		= 139,
129 	ERR_NOMEM_BITMAP	= 140,
130 	ERR_INTEGRITY_ALG	= 141, /* DRBD 8.2 only */
131 	ERR_INTEGRITY_ALG_ND	= 142, /* DRBD 8.2 only */
132 	ERR_CPU_MASK_PARSE	= 143, /* DRBD 8.2 only */
133 	ERR_CSUMS_ALG		= 144, /* DRBD 8.2 only */
134 	ERR_CSUMS_ALG_ND	= 145, /* DRBD 8.2 only */
135 	ERR_VERIFY_ALG		= 146, /* DRBD 8.2 only */
136 	ERR_VERIFY_ALG_ND	= 147, /* DRBD 8.2 only */
137 	ERR_CSUMS_RESYNC_RUNNING= 148, /* DRBD 8.2 only */
138 	ERR_VERIFY_RUNNING	= 149, /* DRBD 8.2 only */
139 	ERR_DATA_NOT_CURRENT	= 150,
140 	ERR_CONNECTED		= 151, /* DRBD 8.3 only */
141 	ERR_PERM		= 152,
142 	ERR_NEED_APV_93		= 153,
143 
144 	/* insert new ones above this line */
145 	AFTER_LAST_ERR_CODE
146 };
147 
148 #define DRBD_PROT_A   1
149 #define DRBD_PROT_B   2
150 #define DRBD_PROT_C   3
151 
152 enum drbd_role {
153 	R_UNKNOWN = 0,
154 	R_PRIMARY = 1,     /* role */
155 	R_SECONDARY = 2,   /* role */
156 	R_MASK = 3,
157 };
158 
159 /* The order of these constants is important.
160  * The lower ones (<C_WF_REPORT_PARAMS) indicate
161  * that there is no socket!
162  * >=C_WF_REPORT_PARAMS ==> There is a socket
163  */
164 enum drbd_conns {
165 	C_STANDALONE,
166 	C_DISCONNECTING,  /* Temporal state on the way to StandAlone. */
167 	C_UNCONNECTED,    /* >= C_UNCONNECTED -> inc_net() succeeds */
168 
169 	/* These temporal states are all used on the way
170 	 * from >= C_CONNECTED to Unconnected.
171 	 * The 'disconnect reason' states
172 	 * I do not allow to change beween them. */
173 	C_TIMEOUT,
174 	C_BROKEN_PIPE,
175 	C_NETWORK_FAILURE,
176 	C_PROTOCOL_ERROR,
177 	C_TEAR_DOWN,
178 
179 	C_WF_CONNECTION,
180 	C_WF_REPORT_PARAMS, /* we have a socket */
181 	C_CONNECTED,      /* we have introduced each other */
182 	C_STARTING_SYNC_S,  /* starting full sync by admin request. */
183 	C_STARTING_SYNC_T,  /* stariing full sync by admin request. */
184 	C_WF_BITMAP_S,
185 	C_WF_BITMAP_T,
186 	C_WF_SYNC_UUID,
187 
188 	/* All SyncStates are tested with this comparison
189 	 * xx >= C_SYNC_SOURCE && xx <= C_PAUSED_SYNC_T */
190 	C_SYNC_SOURCE,
191 	C_SYNC_TARGET,
192 	C_VERIFY_S,
193 	C_VERIFY_T,
194 	C_PAUSED_SYNC_S,
195 	C_PAUSED_SYNC_T,
196 	C_MASK = 31
197 };
198 
199 enum drbd_disk_state {
200 	D_DISKLESS,
201 	D_ATTACHING,      /* In the process of reading the meta-data */
202 	D_FAILED,         /* Becomes D_DISKLESS as soon as we told it the peer */
203 			/* when >= D_FAILED it is legal to access mdev->bc */
204 	D_NEGOTIATING,    /* Late attaching state, we need to talk to the peer */
205 	D_INCONSISTENT,
206 	D_OUTDATED,
207 	D_UNKNOWN,       /* Only used for the peer, never for myself */
208 	D_CONSISTENT,     /* Might be D_OUTDATED, might be D_UP_TO_DATE ... */
209 	D_UP_TO_DATE,       /* Only this disk state allows applications' IO ! */
210 	D_MASK = 15
211 };
212 
213 union drbd_state {
214 /* According to gcc's docs is the ...
215  * The order of allocation of bit-fields within a unit (C90 6.5.2.1, C99 6.7.2.1).
216  * Determined by ABI.
217  * pointed out by Maxim Uvarov q<muvarov@ru.mvista.com>
218  * even though we transmit as "cpu_to_be32(state)",
219  * the offsets of the bitfields still need to be swapped
220  * on different endianess.
221  */
222 	struct {
223 #if defined(__LITTLE_ENDIAN_BITFIELD)
224 		unsigned role:2 ;   /* 3/4	 primary/secondary/unknown */
225 		unsigned peer:2 ;   /* 3/4	 primary/secondary/unknown */
226 		unsigned conn:5 ;   /* 17/32	 cstates */
227 		unsigned disk:4 ;   /* 8/16	 from D_DISKLESS to D_UP_TO_DATE */
228 		unsigned pdsk:4 ;   /* 8/16	 from D_DISKLESS to D_UP_TO_DATE */
229 		unsigned susp:1 ;   /* 2/2	 IO suspended  no/yes */
230 		unsigned aftr_isp:1 ; /* isp .. imposed sync pause */
231 		unsigned peer_isp:1 ;
232 		unsigned user_isp:1 ;
233 		unsigned _pad:11;   /* 0	 unused */
234 #elif defined(__BIG_ENDIAN_BITFIELD)
235 		unsigned _pad:11;   /* 0	 unused */
236 		unsigned user_isp:1 ;
237 		unsigned peer_isp:1 ;
238 		unsigned aftr_isp:1 ; /* isp .. imposed sync pause */
239 		unsigned susp:1 ;   /* 2/2	 IO suspended  no/yes */
240 		unsigned pdsk:4 ;   /* 8/16	 from D_DISKLESS to D_UP_TO_DATE */
241 		unsigned disk:4 ;   /* 8/16	 from D_DISKLESS to D_UP_TO_DATE */
242 		unsigned conn:5 ;   /* 17/32	 cstates */
243 		unsigned peer:2 ;   /* 3/4	 primary/secondary/unknown */
244 		unsigned role:2 ;   /* 3/4	 primary/secondary/unknown */
245 #else
246 # error "this endianess is not supported"
247 #endif
248 	};
249 	unsigned int i;
250 };
251 
252 enum drbd_state_ret_codes {
253 	SS_CW_NO_NEED = 4,
254 	SS_CW_SUCCESS = 3,
255 	SS_NOTHING_TO_DO = 2,
256 	SS_SUCCESS = 1,
257 	SS_UNKNOWN_ERROR = 0, /* Used to sleep longer in _drbd_request_state */
258 	SS_TWO_PRIMARIES = -1,
259 	SS_NO_UP_TO_DATE_DISK = -2,
260 	SS_NO_LOCAL_DISK = -4,
261 	SS_NO_REMOTE_DISK = -5,
262 	SS_CONNECTED_OUTDATES = -6,
263 	SS_PRIMARY_NOP = -7,
264 	SS_RESYNC_RUNNING = -8,
265 	SS_ALREADY_STANDALONE = -9,
266 	SS_CW_FAILED_BY_PEER = -10,
267 	SS_IS_DISKLESS = -11,
268 	SS_DEVICE_IN_USE = -12,
269 	SS_NO_NET_CONFIG = -13,
270 	SS_NO_VERIFY_ALG = -14,       /* drbd-8.2 only */
271 	SS_NEED_CONNECTION = -15,    /* drbd-8.2 only */
272 	SS_LOWER_THAN_OUTDATED = -16,
273 	SS_NOT_SUPPORTED = -17,      /* drbd-8.2 only */
274 	SS_IN_TRANSIENT_STATE = -18,  /* Retry after the next state change */
275 	SS_CONCURRENT_ST_CHG = -19,   /* Concurrent cluster side state change! */
276 	SS_AFTER_LAST_ERROR = -20,    /* Keep this at bottom */
277 };
278 
279 /* from drbd_strings.c */
280 extern const char *drbd_conn_str(enum drbd_conns);
281 extern const char *drbd_role_str(enum drbd_role);
282 extern const char *drbd_disk_str(enum drbd_disk_state);
283 extern const char *drbd_set_st_err_str(enum drbd_state_ret_codes);
284 
285 #define SHARED_SECRET_MAX 64
286 
287 #define MDF_CONSISTENT		(1 << 0)
288 #define MDF_PRIMARY_IND		(1 << 1)
289 #define MDF_CONNECTED_IND	(1 << 2)
290 #define MDF_FULL_SYNC		(1 << 3)
291 #define MDF_WAS_UP_TO_DATE	(1 << 4)
292 #define MDF_PEER_OUT_DATED	(1 << 5)
293 #define MDF_CRASHED_PRIMARY     (1 << 6)
294 
295 enum drbd_uuid_index {
296 	UI_CURRENT,
297 	UI_BITMAP,
298 	UI_HISTORY_START,
299 	UI_HISTORY_END,
300 	UI_SIZE,      /* nl-packet: number of dirty bits */
301 	UI_FLAGS,     /* nl-packet: flags */
302 	UI_EXTENDED_SIZE   /* Everything. */
303 };
304 
305 enum drbd_timeout_flag {
306 	UT_DEFAULT      = 0,
307 	UT_DEGRADED     = 1,
308 	UT_PEER_OUTDATED = 2,
309 };
310 
311 #define UUID_JUST_CREATED ((__u64)4)
312 
313 #define DRBD_MAGIC 0x83740267
314 #define BE_DRBD_MAGIC __constant_cpu_to_be32(DRBD_MAGIC)
315 
316 /* these are of type "int" */
317 #define DRBD_MD_INDEX_INTERNAL -1
318 #define DRBD_MD_INDEX_FLEX_EXT -2
319 #define DRBD_MD_INDEX_FLEX_INT -3
320 
321 /* Start of the new netlink/connector stuff */
322 
323 #define DRBD_NL_CREATE_DEVICE 0x01
324 #define DRBD_NL_SET_DEFAULTS  0x02
325 
326 
327 /* For searching a vacant cn_idx value */
328 #define CN_IDX_STEP			6977
329 
330 struct drbd_nl_cfg_req {
331 	int packet_type;
332 	unsigned int drbd_minor;
333 	int flags;
334 	unsigned short tag_list[];
335 };
336 
337 struct drbd_nl_cfg_reply {
338 	int packet_type;
339 	unsigned int minor;
340 	int ret_code; /* enum ret_code or set_st_err_t */
341 	unsigned short tag_list[]; /* only used with get_* calls */
342 };
343 
344 #endif
345