include/linux/drbd.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003   drbd.h
0004   Kernel module for 2.6.x Kernels
0005
0006   This file is part of DRBD by Philipp Reisner and Lars Ellenberg.
0007
0008   Copyright (C) 2001-2008, LINBIT Information Technologies GmbH.
0009   Copyright (C) 2001-2008, Philipp Reisner <philipp.reisner@linbit.com>.
0010   Copyright (C) 2001-2008, Lars Ellenberg <lars.ellenberg@linbit.com>.
0011
0012
0013 */
0014 #ifndef DRBD_H
0015 #define DRBD_H
0016 #include <asm/types.h>
0017
0018 #ifdef __KERNEL__
0019 #include <linux/types.h>
0020 #include <asm/byteorder.h>
0021 #else
0022 #include <sys/types.h>
0023 #include <sys/wait.h>
0024 #include <limits.h>
0025
0026 /* Although the Linux source code makes a difference between
0027    generic endianness and the bitfields' endianness, there is no
0028    architecture as of Linux-2.6.24-rc4 where the bitfields' endianness
0029    does not match the generic endianness. */
0030
0031 #if __BYTE_ORDER == __LITTLE_ENDIAN
0032 #define __LITTLE_ENDIAN_BITFIELD
0033 #elif __BYTE_ORDER == __BIG_ENDIAN
0034 #define __BIG_ENDIAN_BITFIELD
0035 #else
0036 # error "sorry, weird endianness on this box"
0037 #endif
0038
0039 #endif
0040
0041 extern const char *drbd_buildtag(void);
0042 #define REL_VERSION "8.4.11"
0043 #define API_VERSION 1
0044 #define PRO_VERSION_MIN 86
0045 #define PRO_VERSION_MAX 101
0046
0047
0048 enum drbd_io_error_p {
0049     EP_PASS_ON, /* FIXME should the better be named "Ignore"? */
0050     EP_CALL_HELPER,
0051     EP_DETACH
0052 };
0053
0054 enum drbd_fencing_p {
0055     FP_NOT_AVAIL = -1, /* Not a policy */
0056     FP_DONT_CARE = 0,
0057     FP_RESOURCE,
0058     FP_STONITH
0059 };
0060
0061 enum drbd_disconnect_p {
0062     DP_RECONNECT,
0063     DP_DROP_NET_CONF,
0064     DP_FREEZE_IO
0065 };
0066
0067 enum drbd_after_sb_p {
0068     ASB_DISCONNECT,
0069     ASB_DISCARD_YOUNGER_PRI,
0070     ASB_DISCARD_OLDER_PRI,
0071     ASB_DISCARD_ZERO_CHG,
0072     ASB_DISCARD_LEAST_CHG,
0073     ASB_DISCARD_LOCAL,
0074     ASB_DISCARD_REMOTE,
0075     ASB_CONSENSUS,
0076     ASB_DISCARD_SECONDARY,
0077     ASB_CALL_HELPER,
0078     ASB_VIOLENTLY
0079 };
0080
0081 enum drbd_on_no_data {
0082     OND_IO_ERROR,
0083     OND_SUSPEND_IO
0084 };
0085
0086 enum drbd_on_congestion {
0087     OC_BLOCK,
0088     OC_PULL_AHEAD,
0089     OC_DISCONNECT,
0090 };
0091
0092 enum drbd_read_balancing {
0093     RB_PREFER_LOCAL,
0094     RB_PREFER_REMOTE,
0095     RB_ROUND_ROBIN,
0096     RB_LEAST_PENDING,
0097     RB_CONGESTED_REMOTE,
0098     RB_32K_STRIPING,
0099     RB_64K_STRIPING,
0100     RB_128K_STRIPING,
0101     RB_256K_STRIPING,
0102     RB_512K_STRIPING,
0103     RB_1M_STRIPING,
0104 };
0105
0106 /* KEEP the order, do not delete or insert. Only append. */
0107 enum drbd_ret_code {
0108     ERR_CODE_BASE       = 100,
0109     NO_ERROR        = 101,
0110     ERR_LOCAL_ADDR      = 102,
0111     ERR_PEER_ADDR       = 103,
0112     ERR_OPEN_DISK       = 104,
0113     ERR_OPEN_MD_DISK    = 105,
0114     ERR_DISK_NOT_BDEV   = 107,
0115     ERR_MD_NOT_BDEV     = 108,
0116     ERR_DISK_TOO_SMALL  = 111,
0117     ERR_MD_DISK_TOO_SMALL   = 112,
0118     ERR_BDCLAIM_DISK    = 114,
0119     ERR_BDCLAIM_MD_DISK = 115,
0120     ERR_MD_IDX_INVALID  = 116,
0121     ERR_IO_MD_DISK      = 118,
0122     ERR_MD_INVALID          = 119,
0123     ERR_AUTH_ALG        = 120,
0124     ERR_AUTH_ALG_ND     = 121,
0125     ERR_NOMEM       = 122,
0126     ERR_DISCARD_IMPOSSIBLE  = 123,
0127     ERR_DISK_CONFIGURED = 124,
0128     ERR_NET_CONFIGURED  = 125,
0129     ERR_MANDATORY_TAG   = 126,
0130     ERR_MINOR_INVALID   = 127,
0131     ERR_INTR        = 129, /* EINTR */
0132     ERR_RESIZE_RESYNC   = 130,
0133     ERR_NO_PRIMARY      = 131,
0134     ERR_RESYNC_AFTER    = 132,
0135     ERR_RESYNC_AFTER_CYCLE  = 133,
0136     ERR_PAUSE_IS_SET    = 134,
0137     ERR_PAUSE_IS_CLEAR  = 135,
0138     ERR_PACKET_NR       = 137,
0139     ERR_NO_DISK     = 138,
0140     ERR_NOT_PROTO_C     = 139,
0141     ERR_NOMEM_BITMAP    = 140,
0142     ERR_INTEGRITY_ALG   = 141, /* DRBD 8.2 only */
0143     ERR_INTEGRITY_ALG_ND    = 142, /* DRBD 8.2 only */
0144     ERR_CPU_MASK_PARSE  = 143, /* DRBD 8.2 only */
0145     ERR_CSUMS_ALG       = 144, /* DRBD 8.2 only */
0146     ERR_CSUMS_ALG_ND    = 145, /* DRBD 8.2 only */
0147     ERR_VERIFY_ALG      = 146, /* DRBD 8.2 only */
0148     ERR_VERIFY_ALG_ND   = 147, /* DRBD 8.2 only */
0149     ERR_CSUMS_RESYNC_RUNNING= 148, /* DRBD 8.2 only */
0150     ERR_VERIFY_RUNNING  = 149, /* DRBD 8.2 only */
0151     ERR_DATA_NOT_CURRENT    = 150,
0152     ERR_CONNECTED       = 151, /* DRBD 8.3 only */
0153     ERR_PERM        = 152,
0154     ERR_NEED_APV_93     = 153,
0155     ERR_STONITH_AND_PROT_A  = 154,
0156     ERR_CONG_NOT_PROTO_A    = 155,
0157     ERR_PIC_AFTER_DEP   = 156,
0158     ERR_PIC_PEER_DEP    = 157,
0159     ERR_RES_NOT_KNOWN   = 158,
0160     ERR_RES_IN_USE      = 159,
0161     ERR_MINOR_CONFIGURED    = 160,
0162     ERR_MINOR_OR_VOLUME_EXISTS = 161,
0163     ERR_INVALID_REQUEST = 162,
0164     ERR_NEED_APV_100    = 163,
0165     ERR_NEED_ALLOW_TWO_PRI  = 164,
0166     ERR_MD_UNCLEAN          = 165,
0167     ERR_MD_LAYOUT_CONNECTED = 166,
0168     ERR_MD_LAYOUT_TOO_BIG   = 167,
0169     ERR_MD_LAYOUT_TOO_SMALL = 168,
0170     ERR_MD_LAYOUT_NO_FIT    = 169,
0171     ERR_IMPLICIT_SHRINK     = 170,
0172     /* insert new ones above this line */
0173     AFTER_LAST_ERR_CODE
0174 };
0175
0176 #define DRBD_PROT_A   1
0177 #define DRBD_PROT_B   2
0178 #define DRBD_PROT_C   3
0179
0180 enum drbd_role {
0181     R_UNKNOWN = 0,
0182     R_PRIMARY = 1,     /* role */
0183     R_SECONDARY = 2,   /* role */
0184     R_MASK = 3,
0185 };
0186
0187 /* The order of these constants is important.
0188  * The lower ones (<C_WF_REPORT_PARAMS) indicate
0189  * that there is no socket!
0190  * >=C_WF_REPORT_PARAMS ==> There is a socket
0191  */
0192 enum drbd_conns {
0193     C_STANDALONE,
0194     C_DISCONNECTING,  /* Temporal state on the way to StandAlone. */
0195     C_UNCONNECTED,    /* >= C_UNCONNECTED -> inc_net() succeeds */
0196
0197     /* These temporal states are all used on the way
0198      * from >= C_CONNECTED to Unconnected.
0199      * The 'disconnect reason' states
0200      * I do not allow to change between them. */
0201     C_TIMEOUT,
0202     C_BROKEN_PIPE,
0203     C_NETWORK_FAILURE,
0204     C_PROTOCOL_ERROR,
0205     C_TEAR_DOWN,
0206
0207     C_WF_CONNECTION,
0208     C_WF_REPORT_PARAMS, /* we have a socket */
0209     C_CONNECTED,      /* we have introduced each other */
0210     C_STARTING_SYNC_S,  /* starting full sync by admin request. */
0211     C_STARTING_SYNC_T,  /* starting full sync by admin request. */
0212     C_WF_BITMAP_S,
0213     C_WF_BITMAP_T,
0214     C_WF_SYNC_UUID,
0215
0216     /* All SyncStates are tested with this comparison
0217      * xx >= C_SYNC_SOURCE && xx <= C_PAUSED_SYNC_T */
0218     C_SYNC_SOURCE,
0219     C_SYNC_TARGET,
0220     C_VERIFY_S,
0221     C_VERIFY_T,
0222     C_PAUSED_SYNC_S,
0223     C_PAUSED_SYNC_T,
0224
0225     C_AHEAD,
0226     C_BEHIND,
0227
0228     C_MASK = 31
0229 };
0230
0231 enum drbd_disk_state {
0232     D_DISKLESS,
0233     D_ATTACHING,      /* In the process of reading the meta-data */
0234     D_FAILED,         /* Becomes D_DISKLESS as soon as we told it the peer */
0235               /* when >= D_FAILED it is legal to access mdev->ldev */
0236     D_NEGOTIATING,    /* Late attaching state, we need to talk to the peer */
0237     D_INCONSISTENT,
0238     D_OUTDATED,
0239     D_UNKNOWN,       /* Only used for the peer, never for myself */
0240     D_CONSISTENT,     /* Might be D_OUTDATED, might be D_UP_TO_DATE ... */
0241     D_UP_TO_DATE,       /* Only this disk state allows applications' IO ! */
0242     D_MASK = 15
0243 };
0244
0245 union drbd_state {
0246 /* According to gcc's docs is the ...
0247  * The order of allocation of bit-fields within a unit (C90 6.5.2.1, C99 6.7.2.1).
0248  * Determined by ABI.
0249  * pointed out by Maxim Uvarov q<muvarov@ru.mvista.com>
0250  * even though we transmit as "cpu_to_be32(state)",
0251  * the offsets of the bitfields still need to be swapped
0252  * on different endianness.
0253  */
0254     struct {
0255 #if defined(__LITTLE_ENDIAN_BITFIELD)
0256         unsigned role:2 ;   /* 3/4   primary/secondary/unknown */
0257         unsigned peer:2 ;   /* 3/4   primary/secondary/unknown */
0258         unsigned conn:5 ;   /* 17/32     cstates */
0259         unsigned disk:4 ;   /* 8/16  from D_DISKLESS to D_UP_TO_DATE */
0260         unsigned pdsk:4 ;   /* 8/16  from D_DISKLESS to D_UP_TO_DATE */
0261         unsigned susp:1 ;   /* 2/2   IO suspended no/yes (by user) */
0262         unsigned aftr_isp:1 ; /* isp .. imposed sync pause */
0263         unsigned peer_isp:1 ;
0264         unsigned user_isp:1 ;
0265         unsigned susp_nod:1 ; /* IO suspended because no data */
0266         unsigned susp_fen:1 ; /* IO suspended because fence peer handler runs*/
0267         unsigned _pad:9;   /* 0  unused */
0268 #elif defined(__BIG_ENDIAN_BITFIELD)
0269         unsigned _pad:9;
0270         unsigned susp_fen:1 ;
0271         unsigned susp_nod:1 ;
0272         unsigned user_isp:1 ;
0273         unsigned peer_isp:1 ;
0274         unsigned aftr_isp:1 ; /* isp .. imposed sync pause */
0275         unsigned susp:1 ;   /* 2/2   IO suspended  no/yes */
0276         unsigned pdsk:4 ;   /* 8/16  from D_DISKLESS to D_UP_TO_DATE */
0277         unsigned disk:4 ;   /* 8/16  from D_DISKLESS to D_UP_TO_DATE */
0278         unsigned conn:5 ;   /* 17/32     cstates */
0279         unsigned peer:2 ;   /* 3/4   primary/secondary/unknown */
0280         unsigned role:2 ;   /* 3/4   primary/secondary/unknown */
0281 #else
0282 # error "this endianness is not supported"
0283 #endif
0284     };
0285     unsigned int i;
0286 };
0287
0288 enum drbd_state_rv {
0289     SS_CW_NO_NEED = 4,
0290     SS_CW_SUCCESS = 3,
0291     SS_NOTHING_TO_DO = 2,
0292     SS_SUCCESS = 1,
0293     SS_UNKNOWN_ERROR = 0, /* Used to sleep longer in _drbd_request_state */
0294     SS_TWO_PRIMARIES = -1,
0295     SS_NO_UP_TO_DATE_DISK = -2,
0296     SS_NO_LOCAL_DISK = -4,
0297     SS_NO_REMOTE_DISK = -5,
0298     SS_CONNECTED_OUTDATES = -6,
0299     SS_PRIMARY_NOP = -7,
0300     SS_RESYNC_RUNNING = -8,
0301     SS_ALREADY_STANDALONE = -9,
0302     SS_CW_FAILED_BY_PEER = -10,
0303     SS_IS_DISKLESS = -11,
0304     SS_DEVICE_IN_USE = -12,
0305     SS_NO_NET_CONFIG = -13,
0306     SS_NO_VERIFY_ALG = -14,       /* drbd-8.2 only */
0307     SS_NEED_CONNECTION = -15,    /* drbd-8.2 only */
0308     SS_LOWER_THAN_OUTDATED = -16,
0309     SS_NOT_SUPPORTED = -17,      /* drbd-8.2 only */
0310     SS_IN_TRANSIENT_STATE = -18,  /* Retry after the next state change */
0311     SS_CONCURRENT_ST_CHG = -19,   /* Concurrent cluster side state change! */
0312     SS_O_VOL_PEER_PRI = -20,
0313     SS_OUTDATE_WO_CONN = -21,
0314     SS_AFTER_LAST_ERROR = -22,    /* Keep this at bottom */
0315 };
0316
0317 #define SHARED_SECRET_MAX 64
0318
0319 #define MDF_CONSISTENT      (1 << 0)
0320 #define MDF_PRIMARY_IND     (1 << 1)
0321 #define MDF_CONNECTED_IND   (1 << 2)
0322 #define MDF_FULL_SYNC       (1 << 3)
0323 #define MDF_WAS_UP_TO_DATE  (1 << 4)
0324 #define MDF_PEER_OUT_DATED  (1 << 5)
0325 #define MDF_CRASHED_PRIMARY (1 << 6)
0326 #define MDF_AL_CLEAN        (1 << 7)
0327 #define MDF_AL_DISABLED     (1 << 8)
0328
0329 #define MAX_PEERS 32
0330
0331 enum drbd_uuid_index {
0332     UI_CURRENT,
0333     UI_BITMAP,
0334     UI_HISTORY_START,
0335     UI_HISTORY_END,
0336     UI_SIZE,      /* nl-packet: number of dirty bits */
0337     UI_FLAGS,     /* nl-packet: flags */
0338     UI_EXTENDED_SIZE   /* Everything. */
0339 };
0340
0341 #define HISTORY_UUIDS MAX_PEERS
0342
0343 enum drbd_timeout_flag {
0344     UT_DEFAULT      = 0,
0345     UT_DEGRADED     = 1,
0346     UT_PEER_OUTDATED = 2,
0347 };
0348
0349 enum drbd_notification_type {
0350     NOTIFY_EXISTS,
0351     NOTIFY_CREATE,
0352     NOTIFY_CHANGE,
0353     NOTIFY_DESTROY,
0354     NOTIFY_CALL,
0355     NOTIFY_RESPONSE,
0356
0357     NOTIFY_CONTINUES = 0x8000,
0358     NOTIFY_FLAGS = NOTIFY_CONTINUES,
0359 };
0360
0361 enum drbd_peer_state {
0362     P_INCONSISTENT = 3,
0363     P_OUTDATED = 4,
0364     P_DOWN = 5,
0365     P_PRIMARY = 6,
0366     P_FENCING = 7,
0367 };
0368
0369 #define UUID_JUST_CREATED ((__u64)4)
0370
0371 enum write_ordering_e {
0372     WO_NONE,
0373     WO_DRAIN_IO,
0374     WO_BDEV_FLUSH,
0375     WO_BIO_BARRIER
0376 };
0377
0378 /* magic numbers used in meta data and network packets */
0379 #define DRBD_MAGIC 0x83740267
0380 #define DRBD_MAGIC_BIG 0x835a
0381 #define DRBD_MAGIC_100 0x8620ec20
0382
0383 #define DRBD_MD_MAGIC_07   (DRBD_MAGIC+3)
0384 #define DRBD_MD_MAGIC_08   (DRBD_MAGIC+4)
0385 #define DRBD_MD_MAGIC_84_UNCLEAN    (DRBD_MAGIC+5)
0386
0387
0388 /* how I came up with this magic?
0389  * base64 decode "actlog==" ;) */
0390 #define DRBD_AL_MAGIC 0x69cb65a2
0391
0392 /* these are of type "int" */
0393 #define DRBD_MD_INDEX_INTERNAL -1
0394 #define DRBD_MD_INDEX_FLEX_EXT -2
0395 #define DRBD_MD_INDEX_FLEX_INT -3
0396
0397 #define DRBD_CPU_MASK_SIZE 32
0398
0399 #endif