include/linux/drbd_genl.h

   1 /*
   2  * General overview:
   3  * full generic netlink message:
   4  * |nlmsghdr|genlmsghdr|<payload>
   5  *
   6  * payload:
   7  * |optional fixed size family header|<sequence of netlink attributes>
   8  *
   9  * sequence of netlink attributes:
  10  * I chose to have all "top level" attributes NLA_NESTED,
  11  * corresponding to some real struct.
  12  * So we have a sequence of |tla, len|<nested nla sequence>
  13  *
  14  * nested nla sequence:
  15  * may be empty, or contain a sequence of netlink attributes
  16  * representing the struct fields.
  17  *
  18  * The tag number of any field (regardless of containing struct)
  19  * will be available as T_ ## field_name,
  20  * so you cannot have the same field name in two differnt structs.
  21  *
  22  * The tag numbers themselves are per struct, though,
  23  * so should always begin at 1 (not 0, that is the special "NLA_UNSPEC" type,
  24  * which we won't use here).
  25  * The tag numbers are used as index in the respective nla_policy array.
  26  *
  27  * GENL_struct(tag_name, tag_number, struct name, struct fields) - struct and policy
  28  *      genl_magic_struct.h
  29  *              generates the struct declaration,
  30  *              generates an entry in the tla enum,
  31  *      genl_magic_func.h
  32  *              generates an entry in the static tla policy
  33  *              with .type = NLA_NESTED
  34  *              generates the static <struct_name>_nl_policy definition,
  35  *              and static conversion functions
  36  *
  37  *      genl_magic_func.h
  38  *
  39  * GENL_mc_group(group)
  40  *      genl_magic_struct.h
  41  *              does nothing
  42  *      genl_magic_func.h
  43  *              defines and registers the mcast group,
  44  *              and provides a send helper
  45  *
  46  * GENL_notification(op_name, op_num, mcast_group, tla list)
  47  *      These are notifications to userspace.
  48  *
  49  *      genl_magic_struct.h
  50  *              generates an entry in the genl_ops enum,
  51  *      genl_magic_func.h
  52  *              does nothing
  53  *
  54  *      mcast group: the name of the mcast group this notification should be
  55  *      expected on
  56  *      tla list: the list of expected top level attributes,
  57  *      for documentation and sanity checking.
  58  *
  59  * GENL_op(op_name, op_num, flags and handler, tla list) - "genl operations"
  60  *      These are requests from userspace.
  61  *
  62  *      _op and _notification share the same "number space",
  63  *      op_nr will be assigned to "genlmsghdr->cmd"
  64  *
  65  *      genl_magic_struct.h
  66  *              generates an entry in the genl_ops enum,
  67  *      genl_magic_func.h
  68  *              generates an entry in the static genl_ops array,
  69  *              and static register/unregister functions to
  70  *              genl_register_family_with_ops().
  71  *
  72  *      flags and handler:
  73  *              GENL_op_init( .doit = x, .dumpit = y, .flags = something)
  74  *              GENL_doit(x) => .dumpit = NULL, .flags = GENL_ADMIN_PERM
  75  *      tla list: the list of expected top level attributes,
  76  *      for documentation and sanity checking.
  77  */
  78
  79 /*
  80  * STRUCTS
  81  */
  82
  83 /* this is sent kernel -> userland on various error conditions, and contains
  84  * informational textual info, which is supposedly human readable.
  85  * The computer relevant return code is in the drbd_genlmsghdr.
  86  */
  87 GENL_struct(DRBD_NLA_CFG_REPLY, 1, drbd_cfg_reply,
  88                 /* "arbitrary" size strings, nla_policy.len = 0 */
  89         __str_field(1, DRBD_GENLA_F_MANDATORY,  info_text, 0)
  90 )
  91
  92 /* Configuration requests typically need a context to operate on.
  93  * Possible keys are device minor (fits in the drbd_genlmsghdr),
  94  * the replication link (aka connection) name,
  95  * and/or the replication group (aka resource) name,
  96  * and the volume id within the resource. */
  97 GENL_struct(DRBD_NLA_CFG_CONTEXT, 2, drbd_cfg_context,
  98         __u32_field(1, DRBD_GENLA_F_MANDATORY,  ctx_volume)
  99         __str_field(2, DRBD_GENLA_F_MANDATORY,  ctx_resource_name, 128)
 100         __bin_field(3, DRBD_GENLA_F_MANDATORY,  ctx_my_addr, 128)
 101         __bin_field(4, DRBD_GENLA_F_MANDATORY,  ctx_peer_addr, 128)
 102 )
 103
 104 GENL_struct(DRBD_NLA_DISK_CONF, 3, disk_conf,
 105         __str_field(1, DRBD_F_REQUIRED | DRBD_F_INVARIANT,      backing_dev,    128)
 106         __str_field(2, DRBD_F_REQUIRED | DRBD_F_INVARIANT,      meta_dev,       128)
 107         __s32_field(3, DRBD_F_REQUIRED | DRBD_F_INVARIANT,      meta_dev_idx)
 108
 109         /* use the resize command to try and change the disk_size */
 110         __u64_field(4, DRBD_GENLA_F_MANDATORY | DRBD_F_INVARIANT,       disk_size)
 111         /* we could change the max_bio_bvecs,
 112          * but it won't propagate through the stack */
 113         __u32_field(5, DRBD_GENLA_F_MANDATORY | DRBD_F_INVARIANT,       max_bio_bvecs)
 114
 115         __u32_field_def(6, DRBD_GENLA_F_MANDATORY,      on_io_error, DRBD_ON_IO_ERROR_DEF)
 116         __u32_field_def(7, DRBD_GENLA_F_MANDATORY,      fencing, DRBD_FENCING_DEF)
 117
 118         __u32_field_def(8,      DRBD_GENLA_F_MANDATORY, resync_rate, DRBD_RESYNC_RATE_DEF)
 119         __s32_field_def(9,      DRBD_GENLA_F_MANDATORY, resync_after, DRBD_MINOR_NUMBER_DEF)
 120         __u32_field_def(10,     DRBD_GENLA_F_MANDATORY, al_extents, DRBD_AL_EXTENTS_DEF)
 121         __u32_field_def(11,     DRBD_GENLA_F_MANDATORY, c_plan_ahead, DRBD_C_PLAN_AHEAD_DEF)
 122         __u32_field_def(12,     DRBD_GENLA_F_MANDATORY, c_delay_target, DRBD_C_DELAY_TARGET_DEF)
 123         __u32_field_def(13,     DRBD_GENLA_F_MANDATORY, c_fill_target, DRBD_C_FILL_TARGET_DEF)
 124         __u32_field_def(14,     DRBD_GENLA_F_MANDATORY, c_max_rate, DRBD_C_MAX_RATE_DEF)
 125         __u32_field_def(15,     DRBD_GENLA_F_MANDATORY, c_min_rate, DRBD_C_MIN_RATE_DEF)
 126
 127         __flg_field_def(16, DRBD_GENLA_F_MANDATORY,     disk_barrier, DRBD_DISK_BARRIER_DEF)
 128         __flg_field_def(17, DRBD_GENLA_F_MANDATORY,     disk_flushes, DRBD_DISK_FLUSHES_DEF)
 129         __flg_field_def(18, DRBD_GENLA_F_MANDATORY,     disk_drain, DRBD_DISK_DRAIN_DEF)
 130         __flg_field_def(19, DRBD_GENLA_F_MANDATORY,     md_flushes, DRBD_MD_FLUSHES_DEF)
 131         __u32_field_def(20,     DRBD_GENLA_F_MANDATORY, disk_timeout, DRBD_DISK_TIMEOUT_DEF)
 132 )
 133
 134 GENL_struct(DRBD_NLA_RESOURCE_OPTS, 4, res_opts,
 135         __str_field_def(1,      DRBD_GENLA_F_MANDATORY, cpu_mask,       32)
 136         __u32_field_def(2,      DRBD_GENLA_F_MANDATORY, on_no_data, DRBD_ON_NO_DATA_DEF)
 137 )
 138
 139 GENL_struct(DRBD_NLA_NET_CONF, 5, net_conf,
 140         __str_field_def(1,      DRBD_GENLA_F_MANDATORY | DRBD_F_SENSITIVE,
 141                                                 shared_secret,  SHARED_SECRET_MAX)
 142         __str_field_def(2,      DRBD_GENLA_F_MANDATORY, cram_hmac_alg,  SHARED_SECRET_MAX)
 143         __str_field_def(3,      DRBD_GENLA_F_MANDATORY, integrity_alg,  SHARED_SECRET_MAX)
 144         __str_field_def(4,      DRBD_GENLA_F_MANDATORY, verify_alg,     SHARED_SECRET_MAX)
 145         __str_field_def(5,      DRBD_GENLA_F_MANDATORY, csums_alg,      SHARED_SECRET_MAX)
 146         __u32_field_def(6,      DRBD_GENLA_F_MANDATORY, wire_protocol, DRBD_PROTOCOL_DEF)
 147         __u32_field_def(7,      DRBD_GENLA_F_MANDATORY, connect_int, DRBD_CONNECT_INT_DEF)
 148         __u32_field_def(8,      DRBD_GENLA_F_MANDATORY, timeout, DRBD_TIMEOUT_DEF)
 149         __u32_field_def(9,      DRBD_GENLA_F_MANDATORY, ping_int, DRBD_PING_INT_DEF)
 150         __u32_field_def(10,     DRBD_GENLA_F_MANDATORY, ping_timeo, DRBD_PING_TIMEO_DEF)
 151         __u32_field_def(11,     DRBD_GENLA_F_MANDATORY, sndbuf_size, DRBD_SNDBUF_SIZE_DEF)
 152         __u32_field_def(12,     DRBD_GENLA_F_MANDATORY, rcvbuf_size, DRBD_RCVBUF_SIZE_DEF)
 153         __u32_field_def(13,     DRBD_GENLA_F_MANDATORY, ko_count, DRBD_KO_COUNT_DEF)
 154         __u32_field_def(14,     DRBD_GENLA_F_MANDATORY, max_buffers, DRBD_MAX_BUFFERS_DEF)
 155         __u32_field_def(15,     DRBD_GENLA_F_MANDATORY, max_epoch_size, DRBD_MAX_EPOCH_SIZE_DEF)
 156         __u32_field_def(16,     DRBD_GENLA_F_MANDATORY, unplug_watermark, DRBD_UNPLUG_WATERMARK_DEF)
 157         __u32_field_def(17,     DRBD_GENLA_F_MANDATORY, after_sb_0p, DRBD_AFTER_SB_0P_DEF)
 158         __u32_field_def(18,     DRBD_GENLA_F_MANDATORY, after_sb_1p, DRBD_AFTER_SB_1P_DEF)
 159         __u32_field_def(19,     DRBD_GENLA_F_MANDATORY, after_sb_2p, DRBD_AFTER_SB_2P_DEF)
 160         __u32_field_def(20,     DRBD_GENLA_F_MANDATORY, rr_conflict, DRBD_RR_CONFLICT_DEF)
 161         __u32_field_def(21,     DRBD_GENLA_F_MANDATORY, on_congestion, DRBD_ON_CONGESTION_DEF)
 162         __u32_field_def(22,     DRBD_GENLA_F_MANDATORY, cong_fill, DRBD_CONG_FILL_DEF)
 163         __u32_field_def(23,     DRBD_GENLA_F_MANDATORY, cong_extents, DRBD_CONG_EXTENTS_DEF)
 164         __flg_field_def(24, DRBD_GENLA_F_MANDATORY,     two_primaries, DRBD_ALLOW_TWO_PRIMARIES_DEF)
 165         __flg_field(25, DRBD_GENLA_F_MANDATORY | DRBD_F_INVARIANT,      discard_my_data)
 166         __flg_field_def(26, DRBD_GENLA_F_MANDATORY,     tcp_cork, DRBD_TCP_CORK_DEF)
 167         __flg_field_def(27, DRBD_GENLA_F_MANDATORY,     always_asbp, DRBD_ALWAYS_ASBP_DEF)
 168         __flg_field(28, DRBD_GENLA_F_MANDATORY | DRBD_F_INVARIANT,      tentative)
 169         __flg_field_def(29,     DRBD_GENLA_F_MANDATORY, use_rle, DRBD_USE_RLE_DEF)
 170 )
 171
 172 GENL_struct(DRBD_NLA_SET_ROLE_PARMS, 6, set_role_parms,
 173         __flg_field(1, DRBD_GENLA_F_MANDATORY,  assume_uptodate)
 174 )
 175
 176 GENL_struct(DRBD_NLA_RESIZE_PARMS, 7, resize_parms,
 177         __u64_field(1, DRBD_GENLA_F_MANDATORY,  resize_size)
 178         __flg_field(2, DRBD_GENLA_F_MANDATORY,  resize_force)
 179         __flg_field(3, DRBD_GENLA_F_MANDATORY,  no_resync)
 180 )
 181
 182 GENL_struct(DRBD_NLA_STATE_INFO, 8, state_info,
 183         /* the reason of the broadcast,
 184          * if this is an event triggered broadcast. */
 185         __u32_field(1, DRBD_GENLA_F_MANDATORY,  sib_reason)
 186         __u32_field(2, DRBD_F_REQUIRED, current_state)
 187         __u64_field(3, DRBD_GENLA_F_MANDATORY,  capacity)
 188         __u64_field(4, DRBD_GENLA_F_MANDATORY,  ed_uuid)
 189
 190         /* These are for broadcast from after state change work.
 191          * prev_state and new_state are from the moment the state change took
 192          * place, new_state is not neccessarily the same as current_state,
 193          * there may have been more state changes since.  Which will be
 194          * broadcasted soon, in their respective after state change work.  */
 195         __u32_field(5, DRBD_GENLA_F_MANDATORY,  prev_state)
 196         __u32_field(6, DRBD_GENLA_F_MANDATORY,  new_state)
 197
 198         /* if we have a local disk: */
 199         __bin_field(7, DRBD_GENLA_F_MANDATORY,  uuids, (UI_SIZE*sizeof(__u64)))
 200         __u32_field(8, DRBD_GENLA_F_MANDATORY,  disk_flags)
 201         __u64_field(9, DRBD_GENLA_F_MANDATORY,  bits_total)
 202         __u64_field(10, DRBD_GENLA_F_MANDATORY, bits_oos)
 203         /* and in case resync or online verify is active */
 204         __u64_field(11, DRBD_GENLA_F_MANDATORY, bits_rs_total)
 205         __u64_field(12, DRBD_GENLA_F_MANDATORY, bits_rs_failed)
 206
 207         /* for pre and post notifications of helper execution */
 208         __str_field(13, DRBD_GENLA_F_MANDATORY, helper, 32)
 209         __u32_field(14, DRBD_GENLA_F_MANDATORY, helper_exit_code)
 210 )
 211
 212 GENL_struct(DRBD_NLA_START_OV_PARMS, 9, start_ov_parms,
 213         __u64_field(1, DRBD_GENLA_F_MANDATORY,  ov_start_sector)
 214 )
 215
 216 GENL_struct(DRBD_NLA_NEW_C_UUID_PARMS, 10, new_c_uuid_parms,
 217         __flg_field(1, DRBD_GENLA_F_MANDATORY, clear_bm)
 218 )
 219
 220 GENL_struct(DRBD_NLA_TIMEOUT_PARMS, 11, timeout_parms,
 221         __u32_field(1,  DRBD_F_REQUIRED,        timeout_type)
 222 )
 223
 224 GENL_struct(DRBD_NLA_DISCONNECT_PARMS, 12, disconnect_parms,
 225         __flg_field(1, DRBD_GENLA_F_MANDATORY,  force_disconnect)
 226 )
 227
 228 GENL_struct(DRBD_NLA_DETACH_PARMS, 13, detach_parms,
 229         __flg_field(1, DRBD_GENLA_F_MANDATORY,  force_detach)
 230 )
 231
 232 /*
 233  * Notifications and commands (genlmsghdr->cmd)
 234  */
 235 GENL_mc_group(events)
 236
 237         /* kernel -> userspace announcement of changes */
 238 GENL_notification(
 239         DRBD_EVENT, 1, events,
 240         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED)
 241         GENL_tla_expected(DRBD_NLA_STATE_INFO, DRBD_F_REQUIRED)
 242         GENL_tla_expected(DRBD_NLA_NET_CONF, DRBD_GENLA_F_MANDATORY)
 243         GENL_tla_expected(DRBD_NLA_DISK_CONF, DRBD_GENLA_F_MANDATORY)
 244         GENL_tla_expected(DRBD_NLA_SYNCER_CONF, DRBD_GENLA_F_MANDATORY)
 245 )
 246
 247         /* query kernel for specific or all info */
 248 GENL_op(
 249         DRBD_ADM_GET_STATUS, 2,
 250         GENL_op_init(
 251                 .doit = drbd_adm_get_status,
 252                 .dumpit = drbd_adm_get_status_all,
 253                 /* anyone may ask for the status,
 254                  * it is broadcasted anyways */
 255         ),
 256         /* To select the object .doit.
 257          * Or a subset of objects in .dumpit. */
 258         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_GENLA_F_MANDATORY)
 259 )
 260
 261         /* add DRBD minor devices as volumes to resources */
 262 GENL_op(DRBD_ADM_NEW_MINOR, 5, GENL_doit(drbd_adm_add_minor),
 263         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 264 GENL_op(DRBD_ADM_DEL_MINOR, 6, GENL_doit(drbd_adm_delete_minor),
 265         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 266
 267         /* add or delete resources */
 268 GENL_op(DRBD_ADM_NEW_RESOURCE, 7, GENL_doit(drbd_adm_new_resource),
 269         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 270 GENL_op(DRBD_ADM_DEL_RESOURCE, 8, GENL_doit(drbd_adm_del_resource),
 271         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 272
 273 GENL_op(DRBD_ADM_RESOURCE_OPTS, 9,
 274         GENL_doit(drbd_adm_resource_opts),
 275         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED)
 276         GENL_tla_expected(DRBD_NLA_RESOURCE_OPTS, DRBD_GENLA_F_MANDATORY)
 277 )
 278
 279 GENL_op(
 280         DRBD_ADM_CONNECT, 10,
 281         GENL_doit(drbd_adm_connect),
 282         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED)
 283         GENL_tla_expected(DRBD_NLA_NET_CONF, DRBD_F_REQUIRED)
 284 )
 285
 286 GENL_op(
 287         DRBD_ADM_CHG_NET_OPTS, 29,
 288         GENL_doit(drbd_adm_net_opts),
 289         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED)
 290         GENL_tla_expected(DRBD_NLA_NET_CONF, DRBD_F_REQUIRED)
 291 )
 292
 293 GENL_op(DRBD_ADM_DISCONNECT, 11, GENL_doit(drbd_adm_disconnect),
 294         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 295
 296 GENL_op(DRBD_ADM_ATTACH, 12,
 297         GENL_doit(drbd_adm_attach),
 298         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED)
 299         GENL_tla_expected(DRBD_NLA_DISK_CONF, DRBD_F_REQUIRED)
 300 )
 301
 302 GENL_op(DRBD_ADM_CHG_DISK_OPTS, 28,
 303         GENL_doit(drbd_adm_disk_opts),
 304         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED)
 305         GENL_tla_expected(DRBD_NLA_DISK_OPTS, DRBD_F_REQUIRED)
 306 )
 307
 308 GENL_op(
 309         DRBD_ADM_RESIZE, 13,
 310         GENL_doit(drbd_adm_resize),
 311         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED)
 312         GENL_tla_expected(DRBD_NLA_RESIZE_PARMS, DRBD_GENLA_F_MANDATORY)
 313 )
 314
 315 GENL_op(
 316         DRBD_ADM_PRIMARY, 14,
 317         GENL_doit(drbd_adm_set_role),
 318         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED)
 319         GENL_tla_expected(DRBD_NLA_SET_ROLE_PARMS, DRBD_F_REQUIRED)
 320 )
 321
 322 GENL_op(
 323         DRBD_ADM_SECONDARY, 15,
 324         GENL_doit(drbd_adm_set_role),
 325         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED)
 326         GENL_tla_expected(DRBD_NLA_SET_ROLE_PARMS, DRBD_F_REQUIRED)
 327 )
 328
 329 GENL_op(
 330         DRBD_ADM_NEW_C_UUID, 16,
 331         GENL_doit(drbd_adm_new_c_uuid),
 332         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED)
 333         GENL_tla_expected(DRBD_NLA_NEW_C_UUID_PARMS, DRBD_GENLA_F_MANDATORY)
 334 )
 335
 336 GENL_op(
 337         DRBD_ADM_START_OV, 17,
 338         GENL_doit(drbd_adm_start_ov),
 339         GENL_tla_expected(DRBD_NLA_START_OV_PARMS, DRBD_GENLA_F_MANDATORY)
 340 )
 341
 342 GENL_op(DRBD_ADM_DETACH,        18, GENL_doit(drbd_adm_detach),
 343         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED)
 344         GENL_tla_expected(DRBD_NLA_DETACH_PARMS, DRBD_GENLA_F_MANDATORY))
 345
 346 GENL_op(DRBD_ADM_INVALIDATE,    19, GENL_doit(drbd_adm_invalidate),
 347         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 348 GENL_op(DRBD_ADM_INVAL_PEER,    20, GENL_doit(drbd_adm_invalidate_peer),
 349         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 350 GENL_op(DRBD_ADM_PAUSE_SYNC,    21, GENL_doit(drbd_adm_pause_sync),
 351         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 352 GENL_op(DRBD_ADM_RESUME_SYNC,   22, GENL_doit(drbd_adm_resume_sync),
 353         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 354 GENL_op(DRBD_ADM_SUSPEND_IO,    23, GENL_doit(drbd_adm_suspend_io),
 355         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 356 GENL_op(DRBD_ADM_RESUME_IO,     24, GENL_doit(drbd_adm_resume_io),
 357         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 358 GENL_op(DRBD_ADM_OUTDATE,       25, GENL_doit(drbd_adm_outdate),
 359         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 360 GENL_op(DRBD_ADM_GET_TIMEOUT_TYPE, 26, GENL_doit(drbd_adm_get_timeout_type),
 361         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))
 362 GENL_op(DRBD_ADM_DOWN,          27, GENL_doit(drbd_adm_down),
 363         GENL_tla_expected(DRBD_NLA_CFG_CONTEXT, DRBD_F_REQUIRED))