drbd.h 10 KB

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