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