3 * full generic netlink message:
4 * |nlmsghdr|genlmsghdr|<payload>
7 * |optional fixed size family header|<sequence of netlink attributes>
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>
14 * nested nla sequence:
15 * may be empty, or contain a sequence of netlink attributes
16 * representing the struct fields.
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.
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.
27 * GENL_struct(tag_name, tag_number, struct name, struct fields) - struct and policy
29 * generates the struct declaration,
30 * generates an entry in the tla enum,
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
39 * GENL_mc_group(group)
43 * defines and registers the mcast group,
44 * and provides a send helper
46 * GENL_notification(op_name, op_num, mcast_group, tla list)
47 * These are notifications to userspace.
50 * generates an entry in the genl_ops enum,
54 * mcast group: the name of the mcast group this notification should be
56 * tla list: the list of expected top level attributes,
57 * for documentation and sanity checking.
59 * GENL_op(op_name, op_num, flags and handler, tla list) - "genl operations"
60 * These are requests from userspace.
62 * _op and _notification share the same "number space",
63 * op_nr will be assigned to "genlmsghdr->cmd"
66 * generates an entry in the genl_ops enum,
68 * generates an entry in the static genl_ops array,
69 * and static register/unregister functions to
70 * genl_register_family_with_ops().
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.
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.
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)
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)
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
)
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
)
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
)
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
)
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 __u32_field_def(21, 0 /* OPTIONAL */, read_balancing
, DRBD_READ_BALANCING_DEF
)
133 /* 9: __u32_field_def(22, DRBD_GENLA_F_MANDATORY, unplug_watermark, DRBD_UNPLUG_WATERMARK_DEF) */
134 __flg_field_def(23, 0 /* OPTIONAL */, al_updates
, DRBD_AL_UPDATES_DEF
)
137 GENL_struct(DRBD_NLA_RESOURCE_OPTS
, 4, res_opts
,
138 __str_field_def(1, DRBD_GENLA_F_MANDATORY
, cpu_mask
, 32)
139 __u32_field_def(2, DRBD_GENLA_F_MANDATORY
, on_no_data
, DRBD_ON_NO_DATA_DEF
)
142 GENL_struct(DRBD_NLA_NET_CONF
, 5, net_conf
,
143 __str_field_def(1, DRBD_GENLA_F_MANDATORY
| DRBD_F_SENSITIVE
,
144 shared_secret
, SHARED_SECRET_MAX
)
145 __str_field_def(2, DRBD_GENLA_F_MANDATORY
, cram_hmac_alg
, SHARED_SECRET_MAX
)
146 __str_field_def(3, DRBD_GENLA_F_MANDATORY
, integrity_alg
, SHARED_SECRET_MAX
)
147 __str_field_def(4, DRBD_GENLA_F_MANDATORY
, verify_alg
, SHARED_SECRET_MAX
)
148 __str_field_def(5, DRBD_GENLA_F_MANDATORY
, csums_alg
, SHARED_SECRET_MAX
)
149 __u32_field_def(6, DRBD_GENLA_F_MANDATORY
, wire_protocol
, DRBD_PROTOCOL_DEF
)
150 __u32_field_def(7, DRBD_GENLA_F_MANDATORY
, connect_int
, DRBD_CONNECT_INT_DEF
)
151 __u32_field_def(8, DRBD_GENLA_F_MANDATORY
, timeout
, DRBD_TIMEOUT_DEF
)
152 __u32_field_def(9, DRBD_GENLA_F_MANDATORY
, ping_int
, DRBD_PING_INT_DEF
)
153 __u32_field_def(10, DRBD_GENLA_F_MANDATORY
, ping_timeo
, DRBD_PING_TIMEO_DEF
)
154 __u32_field_def(11, DRBD_GENLA_F_MANDATORY
, sndbuf_size
, DRBD_SNDBUF_SIZE_DEF
)
155 __u32_field_def(12, DRBD_GENLA_F_MANDATORY
, rcvbuf_size
, DRBD_RCVBUF_SIZE_DEF
)
156 __u32_field_def(13, DRBD_GENLA_F_MANDATORY
, ko_count
, DRBD_KO_COUNT_DEF
)
157 __u32_field_def(14, DRBD_GENLA_F_MANDATORY
, max_buffers
, DRBD_MAX_BUFFERS_DEF
)
158 __u32_field_def(15, DRBD_GENLA_F_MANDATORY
, max_epoch_size
, DRBD_MAX_EPOCH_SIZE_DEF
)
159 __u32_field_def(16, DRBD_GENLA_F_MANDATORY
, unplug_watermark
, DRBD_UNPLUG_WATERMARK_DEF
)
160 __u32_field_def(17, DRBD_GENLA_F_MANDATORY
, after_sb_0p
, DRBD_AFTER_SB_0P_DEF
)
161 __u32_field_def(18, DRBD_GENLA_F_MANDATORY
, after_sb_1p
, DRBD_AFTER_SB_1P_DEF
)
162 __u32_field_def(19, DRBD_GENLA_F_MANDATORY
, after_sb_2p
, DRBD_AFTER_SB_2P_DEF
)
163 __u32_field_def(20, DRBD_GENLA_F_MANDATORY
, rr_conflict
, DRBD_RR_CONFLICT_DEF
)
164 __u32_field_def(21, DRBD_GENLA_F_MANDATORY
, on_congestion
, DRBD_ON_CONGESTION_DEF
)
165 __u32_field_def(22, DRBD_GENLA_F_MANDATORY
, cong_fill
, DRBD_CONG_FILL_DEF
)
166 __u32_field_def(23, DRBD_GENLA_F_MANDATORY
, cong_extents
, DRBD_CONG_EXTENTS_DEF
)
167 __flg_field_def(24, DRBD_GENLA_F_MANDATORY
, two_primaries
, DRBD_ALLOW_TWO_PRIMARIES_DEF
)
168 __flg_field(25, DRBD_GENLA_F_MANDATORY
| DRBD_F_INVARIANT
, discard_my_data
)
169 __flg_field_def(26, DRBD_GENLA_F_MANDATORY
, tcp_cork
, DRBD_TCP_CORK_DEF
)
170 __flg_field_def(27, DRBD_GENLA_F_MANDATORY
, always_asbp
, DRBD_ALWAYS_ASBP_DEF
)
171 __flg_field(28, DRBD_GENLA_F_MANDATORY
| DRBD_F_INVARIANT
, tentative
)
172 __flg_field_def(29, DRBD_GENLA_F_MANDATORY
, use_rle
, DRBD_USE_RLE_DEF
)
173 /* 9: __u32_field_def(30, DRBD_GENLA_F_MANDATORY, fencing_policy, DRBD_FENCING_DEF) */
176 GENL_struct(DRBD_NLA_SET_ROLE_PARMS
, 6, set_role_parms
,
177 __flg_field(1, DRBD_GENLA_F_MANDATORY
, assume_uptodate
)
180 GENL_struct(DRBD_NLA_RESIZE_PARMS
, 7, resize_parms
,
181 __u64_field(1, DRBD_GENLA_F_MANDATORY
, resize_size
)
182 __flg_field(2, DRBD_GENLA_F_MANDATORY
, resize_force
)
183 __flg_field(3, DRBD_GENLA_F_MANDATORY
, no_resync
)
186 GENL_struct(DRBD_NLA_STATE_INFO
, 8, state_info
,
187 /* the reason of the broadcast,
188 * if this is an event triggered broadcast. */
189 __u32_field(1, DRBD_GENLA_F_MANDATORY
, sib_reason
)
190 __u32_field(2, DRBD_F_REQUIRED
, current_state
)
191 __u64_field(3, DRBD_GENLA_F_MANDATORY
, capacity
)
192 __u64_field(4, DRBD_GENLA_F_MANDATORY
, ed_uuid
)
194 /* These are for broadcast from after state change work.
195 * prev_state and new_state are from the moment the state change took
196 * place, new_state is not neccessarily the same as current_state,
197 * there may have been more state changes since. Which will be
198 * broadcasted soon, in their respective after state change work. */
199 __u32_field(5, DRBD_GENLA_F_MANDATORY
, prev_state
)
200 __u32_field(6, DRBD_GENLA_F_MANDATORY
, new_state
)
202 /* if we have a local disk: */
203 __bin_field(7, DRBD_GENLA_F_MANDATORY
, uuids
, (UI_SIZE
*sizeof(__u64
)))
204 __u32_field(8, DRBD_GENLA_F_MANDATORY
, disk_flags
)
205 __u64_field(9, DRBD_GENLA_F_MANDATORY
, bits_total
)
206 __u64_field(10, DRBD_GENLA_F_MANDATORY
, bits_oos
)
207 /* and in case resync or online verify is active */
208 __u64_field(11, DRBD_GENLA_F_MANDATORY
, bits_rs_total
)
209 __u64_field(12, DRBD_GENLA_F_MANDATORY
, bits_rs_failed
)
211 /* for pre and post notifications of helper execution */
212 __str_field(13, DRBD_GENLA_F_MANDATORY
, helper
, 32)
213 __u32_field(14, DRBD_GENLA_F_MANDATORY
, helper_exit_code
)
215 __u64_field(15, 0, send_cnt
)
216 __u64_field(16, 0, recv_cnt
)
217 __u64_field(17, 0, read_cnt
)
218 __u64_field(18, 0, writ_cnt
)
219 __u64_field(19, 0, al_writ_cnt
)
220 __u64_field(20, 0, bm_writ_cnt
)
221 __u32_field(21, 0, ap_bio_cnt
)
222 __u32_field(22, 0, ap_pending_cnt
)
223 __u32_field(23, 0, rs_pending_cnt
)
226 GENL_struct(DRBD_NLA_START_OV_PARMS
, 9, start_ov_parms
,
227 __u64_field(1, DRBD_GENLA_F_MANDATORY
, ov_start_sector
)
228 __u64_field(2, DRBD_GENLA_F_MANDATORY
, ov_stop_sector
)
231 GENL_struct(DRBD_NLA_NEW_C_UUID_PARMS
, 10, new_c_uuid_parms
,
232 __flg_field(1, DRBD_GENLA_F_MANDATORY
, clear_bm
)
235 GENL_struct(DRBD_NLA_TIMEOUT_PARMS
, 11, timeout_parms
,
236 __u32_field(1, DRBD_F_REQUIRED
, timeout_type
)
239 GENL_struct(DRBD_NLA_DISCONNECT_PARMS
, 12, disconnect_parms
,
240 __flg_field(1, DRBD_GENLA_F_MANDATORY
, force_disconnect
)
243 GENL_struct(DRBD_NLA_DETACH_PARMS
, 13, detach_parms
,
244 __flg_field(1, DRBD_GENLA_F_MANDATORY
, force_detach
)
248 * Notifications and commands (genlmsghdr->cmd)
250 GENL_mc_group(events
)
252 /* kernel -> userspace announcement of changes */
254 DRBD_EVENT
, 1, events
,
255 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
)
256 GENL_tla_expected(DRBD_NLA_STATE_INFO
, DRBD_F_REQUIRED
)
257 GENL_tla_expected(DRBD_NLA_NET_CONF
, DRBD_GENLA_F_MANDATORY
)
258 GENL_tla_expected(DRBD_NLA_DISK_CONF
, DRBD_GENLA_F_MANDATORY
)
259 GENL_tla_expected(DRBD_NLA_SYNCER_CONF
, DRBD_GENLA_F_MANDATORY
)
262 /* query kernel for specific or all info */
264 DRBD_ADM_GET_STATUS
, 2,
266 .doit
= drbd_adm_get_status
,
267 .dumpit
= drbd_adm_get_status_all
,
268 /* anyone may ask for the status,
269 * it is broadcasted anyways */
271 /* To select the object .doit.
272 * Or a subset of objects in .dumpit. */
273 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_GENLA_F_MANDATORY
)
276 /* add DRBD minor devices as volumes to resources */
277 GENL_op(DRBD_ADM_NEW_MINOR
, 5, GENL_doit(drbd_adm_add_minor
),
278 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
279 GENL_op(DRBD_ADM_DEL_MINOR
, 6, GENL_doit(drbd_adm_delete_minor
),
280 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
282 /* add or delete resources */
283 GENL_op(DRBD_ADM_NEW_RESOURCE
, 7, GENL_doit(drbd_adm_new_resource
),
284 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
285 GENL_op(DRBD_ADM_DEL_RESOURCE
, 8, GENL_doit(drbd_adm_del_resource
),
286 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
288 GENL_op(DRBD_ADM_RESOURCE_OPTS
, 9,
289 GENL_doit(drbd_adm_resource_opts
),
290 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
)
291 GENL_tla_expected(DRBD_NLA_RESOURCE_OPTS
, DRBD_GENLA_F_MANDATORY
)
295 DRBD_ADM_CONNECT
, 10,
296 GENL_doit(drbd_adm_connect
),
297 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
)
298 GENL_tla_expected(DRBD_NLA_NET_CONF
, DRBD_F_REQUIRED
)
302 DRBD_ADM_CHG_NET_OPTS
, 29,
303 GENL_doit(drbd_adm_net_opts
),
304 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
)
305 GENL_tla_expected(DRBD_NLA_NET_CONF
, DRBD_F_REQUIRED
)
308 GENL_op(DRBD_ADM_DISCONNECT
, 11, GENL_doit(drbd_adm_disconnect
),
309 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
311 GENL_op(DRBD_ADM_ATTACH
, 12,
312 GENL_doit(drbd_adm_attach
),
313 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
)
314 GENL_tla_expected(DRBD_NLA_DISK_CONF
, DRBD_F_REQUIRED
)
317 GENL_op(DRBD_ADM_CHG_DISK_OPTS
, 28,
318 GENL_doit(drbd_adm_disk_opts
),
319 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
)
320 GENL_tla_expected(DRBD_NLA_DISK_OPTS
, DRBD_F_REQUIRED
)
325 GENL_doit(drbd_adm_resize
),
326 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
)
327 GENL_tla_expected(DRBD_NLA_RESIZE_PARMS
, DRBD_GENLA_F_MANDATORY
)
331 DRBD_ADM_PRIMARY
, 14,
332 GENL_doit(drbd_adm_set_role
),
333 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
)
334 GENL_tla_expected(DRBD_NLA_SET_ROLE_PARMS
, DRBD_F_REQUIRED
)
338 DRBD_ADM_SECONDARY
, 15,
339 GENL_doit(drbd_adm_set_role
),
340 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
)
341 GENL_tla_expected(DRBD_NLA_SET_ROLE_PARMS
, DRBD_F_REQUIRED
)
345 DRBD_ADM_NEW_C_UUID
, 16,
346 GENL_doit(drbd_adm_new_c_uuid
),
347 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
)
348 GENL_tla_expected(DRBD_NLA_NEW_C_UUID_PARMS
, DRBD_GENLA_F_MANDATORY
)
352 DRBD_ADM_START_OV
, 17,
353 GENL_doit(drbd_adm_start_ov
),
354 GENL_tla_expected(DRBD_NLA_START_OV_PARMS
, DRBD_GENLA_F_MANDATORY
)
357 GENL_op(DRBD_ADM_DETACH
, 18, GENL_doit(drbd_adm_detach
),
358 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
)
359 GENL_tla_expected(DRBD_NLA_DETACH_PARMS
, DRBD_GENLA_F_MANDATORY
))
361 GENL_op(DRBD_ADM_INVALIDATE
, 19, GENL_doit(drbd_adm_invalidate
),
362 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
363 GENL_op(DRBD_ADM_INVAL_PEER
, 20, GENL_doit(drbd_adm_invalidate_peer
),
364 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
365 GENL_op(DRBD_ADM_PAUSE_SYNC
, 21, GENL_doit(drbd_adm_pause_sync
),
366 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
367 GENL_op(DRBD_ADM_RESUME_SYNC
, 22, GENL_doit(drbd_adm_resume_sync
),
368 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
369 GENL_op(DRBD_ADM_SUSPEND_IO
, 23, GENL_doit(drbd_adm_suspend_io
),
370 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
371 GENL_op(DRBD_ADM_RESUME_IO
, 24, GENL_doit(drbd_adm_resume_io
),
372 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
373 GENL_op(DRBD_ADM_OUTDATE
, 25, GENL_doit(drbd_adm_outdate
),
374 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
375 GENL_op(DRBD_ADM_GET_TIMEOUT_TYPE
, 26, GENL_doit(drbd_adm_get_timeout_type
),
376 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))
377 GENL_op(DRBD_ADM_DOWN
, 27, GENL_doit(drbd_adm_down
),
378 GENL_tla_expected(DRBD_NLA_CFG_CONTEXT
, DRBD_F_REQUIRED
))