1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 drbd.h 4 Kernel module for 2.6.x Kernels 5 6 This file is part of DRBD by Philipp Reisner and Lars Ellenberg. 7 8 Copyright (C) 2001-2008, LINBIT Information Technologies GmbH. 9 Copyright (C) 2001-2008, Philipp Reisner <[email protected]>. 10 Copyright (C) 2001-2008, Lars Ellenberg <[email protected]>. 11 12 13 */ 14 #ifndef DRBD_H 15 #define DRBD_H 16 #include <asm/types.h> 17 18 #ifdef __KERNEL__ 19 #include <linux/types.h> 20 #include <asm/byteorder.h> 21 #else 22 #include <sys/types.h> 23 #include <sys/wait.h> 24 #include <limits.h> 25 26 /* Although the Linux source code makes a difference between 27 generic endianness and the bitfields' endianness, there is no 28 architecture as of Linux-2.6.24-rc4 where the bitfields' endianness 29 does not match the generic endianness. */ 30 31 #if __BYTE_ORDER == __LITTLE_ENDIAN 32 #define __LITTLE_ENDIAN_BITFIELD 33 #elif __BYTE_ORDER == __BIG_ENDIAN 34 #define __BIG_ENDIAN_BITFIELD 35 #else 36 # error "sorry, weird endianness on this box" 37 #endif 38 39 #endif 40 41 extern const char *drbd_buildtag(void); 42 #define REL_VERSION "8.4.11" 43 #define PRO_VERSION_MIN 86 44 #define PRO_VERSION_MAX 101 45 46 47 enum drbd_io_error_p { 48 EP_PASS_ON, /* FIXME should the better be named "Ignore"? */ 49 EP_CALL_HELPER, 50 EP_DETACH 51 }; 52 53 enum drbd_fencing_p { 54 FP_NOT_AVAIL = -1, /* Not a policy */ 55 FP_DONT_CARE = 0, 56 FP_RESOURCE, 57 FP_STONITH 58 }; 59 60 enum drbd_disconnect_p { 61 DP_RECONNECT, 62 DP_DROP_NET_CONF, 63 DP_FREEZE_IO 64 }; 65 66 enum drbd_after_sb_p { 67 ASB_DISCONNECT, 68 ASB_DISCARD_YOUNGER_PRI, 69 ASB_DISCARD_OLDER_PRI, 70 ASB_DISCARD_ZERO_CHG, 71 ASB_DISCARD_LEAST_CHG, 72 ASB_DISCARD_LOCAL, 73 ASB_DISCARD_REMOTE, 74 ASB_CONSENSUS, 75 ASB_DISCARD_SECONDARY, 76 ASB_CALL_HELPER, 77 ASB_VIOLENTLY 78 }; 79 80 enum drbd_on_no_data { 81 OND_IO_ERROR, 82 OND_SUSPEND_IO 83 }; 84 85 enum drbd_on_congestion { 86 OC_BLOCK, 87 OC_PULL_AHEAD, 88 OC_DISCONNECT, 89 }; 90 91 enum drbd_read_balancing { 92 RB_PREFER_LOCAL, 93 RB_PREFER_REMOTE, 94 RB_ROUND_ROBIN, 95 RB_LEAST_PENDING, 96 RB_CONGESTED_REMOTE, 97 RB_32K_STRIPING, 98 RB_64K_STRIPING, 99 RB_128K_STRIPING, 100 RB_256K_STRIPING, 101 RB_512K_STRIPING, 102 RB_1M_STRIPING, 103 }; 104 105 /* KEEP the order, do not delete or insert. Only append. */ 106 enum drbd_ret_code { 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_TOO_SMALL = 111, 116 ERR_MD_DISK_TOO_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_IMPOSSIBLE = 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_RESYNC_AFTER = 132, 134 ERR_RESYNC_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 */ 152 ERR_PERM = 152, 153 ERR_NEED_APV_93 = 153, 154 ERR_STONITH_AND_PROT_A = 154, 155 ERR_CONG_NOT_PROTO_A = 155, 156 ERR_PIC_AFTER_DEP = 156, 157 ERR_PIC_PEER_DEP = 157, 158 ERR_RES_NOT_KNOWN = 158, 159 ERR_RES_IN_USE = 159, 160 ERR_MINOR_CONFIGURED = 160, 161 ERR_MINOR_OR_VOLUME_EXISTS = 161, 162 ERR_INVALID_REQUEST = 162, 163 ERR_NEED_APV_100 = 163, 164 ERR_NEED_ALLOW_TWO_PRI = 164, 165 ERR_MD_UNCLEAN = 165, 166 ERR_MD_LAYOUT_CONNECTED = 166, 167 ERR_MD_LAYOUT_TOO_BIG = 167, 168 ERR_MD_LAYOUT_TOO_SMALL = 168, 169 ERR_MD_LAYOUT_NO_FIT = 169, 170 ERR_IMPLICIT_SHRINK = 170, 171 /* insert new ones above this line */ 172 AFTER_LAST_ERR_CODE 173 }; 174 175 #define DRBD_PROT_A 1 176 #define DRBD_PROT_B 2 177 #define DRBD_PROT_C 3 178 179 enum drbd_role { 180 R_UNKNOWN = 0, 181 R_PRIMARY = 1, /* role */ 182 R_SECONDARY = 2, /* role */ 183 R_MASK = 3, 184 }; 185 186 /* The order of these constants is important. 187 * The lower ones (<C_WF_REPORT_PARAMS) indicate 188 * that there is no socket! 189 * >=C_WF_REPORT_PARAMS ==> There is a socket 190 */ 191 enum drbd_conns { 192 C_STANDALONE, 193 C_DISCONNECTING, /* Temporal state on the way to StandAlone. */ 194 C_UNCONNECTED, /* >= C_UNCONNECTED -> inc_net() succeeds */ 195 196 /* These temporal states are all used on the way 197 * from >= C_CONNECTED to Unconnected. 198 * The 'disconnect reason' states 199 * I do not allow to change between them. */ 200 C_TIMEOUT, 201 C_BROKEN_PIPE, 202 C_NETWORK_FAILURE, 203 C_PROTOCOL_ERROR, 204 C_TEAR_DOWN, 205 206 C_WF_CONNECTION, 207 C_WF_REPORT_PARAMS, /* we have a socket */ 208 C_CONNECTED, /* we have introduced each other */ 209 C_STARTING_SYNC_S, /* starting full sync by admin request. */ 210 C_STARTING_SYNC_T, /* starting full sync by admin request. */ 211 C_WF_BITMAP_S, 212 C_WF_BITMAP_T, 213 C_WF_SYNC_UUID, 214 215 /* All SyncStates are tested with this comparison 216 * xx >= C_SYNC_SOURCE && xx <= C_PAUSED_SYNC_T */ 217 C_SYNC_SOURCE, 218 C_SYNC_TARGET, 219 C_VERIFY_S, 220 C_VERIFY_T, 221 C_PAUSED_SYNC_S, 222 C_PAUSED_SYNC_T, 223 224 C_AHEAD, 225 C_BEHIND, 226 227 C_MASK = 31 228 }; 229 230 enum drbd_disk_state { 231 D_DISKLESS, 232 D_ATTACHING, /* In the process of reading the meta-data */ 233 D_FAILED, /* Becomes D_DISKLESS as soon as we told it the peer */ 234 /* when >= D_FAILED it is legal to access mdev->ldev */ 235 D_NEGOTIATING, /* Late attaching state, we need to talk to the peer */ 236 D_INCONSISTENT, 237 D_OUTDATED, 238 D_UNKNOWN, /* Only used for the peer, never for myself */ 239 D_CONSISTENT, /* Might be D_OUTDATED, might be D_UP_TO_DATE ... */ 240 D_UP_TO_DATE, /* Only this disk state allows applications' IO ! */ 241 D_MASK = 15 242 }; 243 244 union drbd_state { 245 /* According to gcc's docs is the ... 246 * The order of allocation of bit-fields within a unit (C90 6.5.2.1, C99 6.7.2.1). 247 * Determined by ABI. 248 * pointed out by Maxim Uvarov q<[email protected]> 249 * even though we transmit as "cpu_to_be32(state)", 250 * the offsets of the bitfields still need to be swapped 251 * on different endianness. 252 */ 253 struct { 254 #if defined(__LITTLE_ENDIAN_BITFIELD) 255 unsigned role:2 ; /* 3/4 primary/secondary/unknown */ 256 unsigned peer:2 ; /* 3/4 primary/secondary/unknown */ 257 unsigned conn:5 ; /* 17/32 cstates */ 258 unsigned disk:4 ; /* 8/16 from D_DISKLESS to D_UP_TO_DATE */ 259 unsigned pdsk:4 ; /* 8/16 from D_DISKLESS to D_UP_TO_DATE */ 260 unsigned susp:1 ; /* 2/2 IO suspended no/yes (by user) */ 261 unsigned aftr_isp:1 ; /* isp .. imposed sync pause */ 262 unsigned peer_isp:1 ; 263 unsigned user_isp:1 ; 264 unsigned susp_nod:1 ; /* IO suspended because no data */ 265 unsigned susp_fen:1 ; /* IO suspended because fence peer handler runs*/ 266 unsigned _pad:9; /* 0 unused */ 267 #elif defined(__BIG_ENDIAN_BITFIELD) 268 unsigned _pad:9; 269 unsigned susp_fen:1 ; 270 unsigned susp_nod:1 ; 271 unsigned user_isp:1 ; 272 unsigned peer_isp:1 ; 273 unsigned aftr_isp:1 ; /* isp .. imposed sync pause */ 274 unsigned susp:1 ; /* 2/2 IO suspended no/yes */ 275 unsigned pdsk:4 ; /* 8/16 from D_DISKLESS to D_UP_TO_DATE */ 276 unsigned disk:4 ; /* 8/16 from D_DISKLESS to D_UP_TO_DATE */ 277 unsigned conn:5 ; /* 17/32 cstates */ 278 unsigned peer:2 ; /* 3/4 primary/secondary/unknown */ 279 unsigned role:2 ; /* 3/4 primary/secondary/unknown */ 280 #else 281 # error "this endianness is not supported" 282 #endif 283 }; 284 unsigned int i; 285 }; 286 287 enum drbd_state_rv { 288 SS_CW_NO_NEED = 4, 289 SS_CW_SUCCESS = 3, 290 SS_NOTHING_TO_DO = 2, 291 SS_SUCCESS = 1, 292 SS_UNKNOWN_ERROR = 0, /* Used to sleep longer in _drbd_request_state */ 293 SS_TWO_PRIMARIES = -1, 294 SS_NO_UP_TO_DATE_DISK = -2, 295 SS_NO_LOCAL_DISK = -4, 296 SS_NO_REMOTE_DISK = -5, 297 SS_CONNECTED_OUTDATES = -6, 298 SS_PRIMARY_NOP = -7, 299 SS_RESYNC_RUNNING = -8, 300 SS_ALREADY_STANDALONE = -9, 301 SS_CW_FAILED_BY_PEER = -10, 302 SS_IS_DISKLESS = -11, 303 SS_DEVICE_IN_USE = -12, 304 SS_NO_NET_CONFIG = -13, 305 SS_NO_VERIFY_ALG = -14, /* drbd-8.2 only */ 306 SS_NEED_CONNECTION = -15, /* drbd-8.2 only */ 307 SS_LOWER_THAN_OUTDATED = -16, 308 SS_NOT_SUPPORTED = -17, /* drbd-8.2 only */ 309 SS_IN_TRANSIENT_STATE = -18, /* Retry after the next state change */ 310 SS_CONCURRENT_ST_CHG = -19, /* Concurrent cluster side state change! */ 311 SS_O_VOL_PEER_PRI = -20, 312 SS_OUTDATE_WO_CONN = -21, 313 SS_AFTER_LAST_ERROR = -22, /* Keep this at bottom */ 314 }; 315 316 #define SHARED_SECRET_MAX 64 317 318 #define MDF_CONSISTENT (1 << 0) 319 #define MDF_PRIMARY_IND (1 << 1) 320 #define MDF_CONNECTED_IND (1 << 2) 321 #define MDF_FULL_SYNC (1 << 3) 322 #define MDF_WAS_UP_TO_DATE (1 << 4) 323 #define MDF_PEER_OUT_DATED (1 << 5) 324 #define MDF_CRASHED_PRIMARY (1 << 6) 325 #define MDF_AL_CLEAN (1 << 7) 326 #define MDF_AL_DISABLED (1 << 8) 327 328 #define MAX_PEERS 32 329 330 enum drbd_uuid_index { 331 UI_CURRENT, 332 UI_BITMAP, 333 UI_HISTORY_START, 334 UI_HISTORY_END, 335 UI_SIZE, /* nl-packet: number of dirty bits */ 336 UI_FLAGS, /* nl-packet: flags */ 337 UI_EXTENDED_SIZE /* Everything. */ 338 }; 339 340 #define HISTORY_UUIDS MAX_PEERS 341 342 enum drbd_timeout_flag { 343 UT_DEFAULT = 0, 344 UT_DEGRADED = 1, 345 UT_PEER_OUTDATED = 2, 346 }; 347 348 enum drbd_notification_type { 349 NOTIFY_EXISTS, 350 NOTIFY_CREATE, 351 NOTIFY_CHANGE, 352 NOTIFY_DESTROY, 353 NOTIFY_CALL, 354 NOTIFY_RESPONSE, 355 356 NOTIFY_CONTINUES = 0x8000, 357 NOTIFY_FLAGS = NOTIFY_CONTINUES, 358 }; 359 360 enum drbd_peer_state { 361 P_INCONSISTENT = 3, 362 P_OUTDATED = 4, 363 P_DOWN = 5, 364 P_PRIMARY = 6, 365 P_FENCING = 7, 366 }; 367 368 #define UUID_JUST_CREATED ((__u64)4) 369 370 enum write_ordering_e { 371 WO_NONE, 372 WO_DRAIN_IO, 373 WO_BDEV_FLUSH, 374 WO_BIO_BARRIER 375 }; 376 377 /* magic numbers used in meta data and network packets */ 378 #define DRBD_MAGIC 0x83740267 379 #define DRBD_MAGIC_BIG 0x835a 380 #define DRBD_MAGIC_100 0x8620ec20 381 382 #define DRBD_MD_MAGIC_07 (DRBD_MAGIC+3) 383 #define DRBD_MD_MAGIC_08 (DRBD_MAGIC+4) 384 #define DRBD_MD_MAGIC_84_UNCLEAN (DRBD_MAGIC+5) 385 386 387 /* how I came up with this magic? 388 * base64 decode "actlog==" ;) */ 389 #define DRBD_AL_MAGIC 0x69cb65a2 390 391 /* these are of type "int" */ 392 #define DRBD_MD_INDEX_INTERNAL -1 393 #define DRBD_MD_INDEX_FLEX_EXT -2 394 #define DRBD_MD_INDEX_FLEX_INT -3 395 396 #define DRBD_CPU_MASK_SIZE 32 397 398 #endif 399