Linux-libre 5.7.6-gnu
[librecmc/linux-libre.git] / include / uapi / rdma / rdma_netlink.h
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 #ifndef _UAPI_RDMA_NETLINK_H
3 #define _UAPI_RDMA_NETLINK_H
4
5 #include <linux/types.h>
6
7 enum {
8         RDMA_NL_IWCM = 2,
9         RDMA_NL_RSVD,
10         RDMA_NL_LS,     /* RDMA Local Services */
11         RDMA_NL_NLDEV,  /* RDMA device interface */
12         RDMA_NL_NUM_CLIENTS
13 };
14
15 enum {
16         RDMA_NL_GROUP_IWPM = 2,
17         RDMA_NL_GROUP_LS,
18         RDMA_NL_NUM_GROUPS
19 };
20
21 #define RDMA_NL_GET_CLIENT(type) ((type & (((1 << 6) - 1) << 10)) >> 10)
22 #define RDMA_NL_GET_OP(type) (type & ((1 << 10) - 1))
23 #define RDMA_NL_GET_TYPE(client, op) ((client << 10) + op)
24
25 /* The minimum version that the iwpm kernel supports */
26 #define IWPM_UABI_VERSION_MIN   3
27
28 /* The latest version that the iwpm kernel supports */
29 #define IWPM_UABI_VERSION       4
30
31 /* iwarp port mapper message flags */
32 enum {
33
34         /* Do not map the port for this IWPM request */
35         IWPM_FLAGS_NO_PORT_MAP = (1 << 0),
36 };
37
38 /* iwarp port mapper op-codes */
39 enum {
40         RDMA_NL_IWPM_REG_PID = 0,
41         RDMA_NL_IWPM_ADD_MAPPING,
42         RDMA_NL_IWPM_QUERY_MAPPING,
43         RDMA_NL_IWPM_REMOVE_MAPPING,
44         RDMA_NL_IWPM_REMOTE_INFO,
45         RDMA_NL_IWPM_HANDLE_ERR,
46         RDMA_NL_IWPM_MAPINFO,
47         RDMA_NL_IWPM_MAPINFO_NUM,
48         RDMA_NL_IWPM_HELLO,
49         RDMA_NL_IWPM_NUM_OPS
50 };
51
52 enum {
53         IWPM_NLA_REG_PID_UNSPEC = 0,
54         IWPM_NLA_REG_PID_SEQ,
55         IWPM_NLA_REG_IF_NAME,
56         IWPM_NLA_REG_IBDEV_NAME,
57         IWPM_NLA_REG_ULIB_NAME,
58         IWPM_NLA_REG_PID_MAX
59 };
60
61 enum {
62         IWPM_NLA_RREG_PID_UNSPEC = 0,
63         IWPM_NLA_RREG_PID_SEQ,
64         IWPM_NLA_RREG_IBDEV_NAME,
65         IWPM_NLA_RREG_ULIB_NAME,
66         IWPM_NLA_RREG_ULIB_VER,
67         IWPM_NLA_RREG_PID_ERR,
68         IWPM_NLA_RREG_PID_MAX
69
70 };
71
72 enum {
73         IWPM_NLA_MANAGE_MAPPING_UNSPEC = 0,
74         IWPM_NLA_MANAGE_MAPPING_SEQ,
75         IWPM_NLA_MANAGE_ADDR,
76         IWPM_NLA_MANAGE_FLAGS,
77         IWPM_NLA_MANAGE_MAPPING_MAX
78 };
79
80 enum {
81         IWPM_NLA_RMANAGE_MAPPING_UNSPEC = 0,
82         IWPM_NLA_RMANAGE_MAPPING_SEQ,
83         IWPM_NLA_RMANAGE_ADDR,
84         IWPM_NLA_RMANAGE_MAPPED_LOC_ADDR,
85         /* The following maintains bisectability of rdma-core */
86         IWPM_NLA_MANAGE_MAPPED_LOC_ADDR = IWPM_NLA_RMANAGE_MAPPED_LOC_ADDR,
87         IWPM_NLA_RMANAGE_MAPPING_ERR,
88         IWPM_NLA_RMANAGE_MAPPING_MAX
89 };
90
91 #define IWPM_NLA_MAPINFO_SEND_MAX   3
92 #define IWPM_NLA_REMOVE_MAPPING_MAX 3
93
94 enum {
95         IWPM_NLA_QUERY_MAPPING_UNSPEC = 0,
96         IWPM_NLA_QUERY_MAPPING_SEQ,
97         IWPM_NLA_QUERY_LOCAL_ADDR,
98         IWPM_NLA_QUERY_REMOTE_ADDR,
99         IWPM_NLA_QUERY_FLAGS,
100         IWPM_NLA_QUERY_MAPPING_MAX,
101 };
102
103 enum {
104         IWPM_NLA_RQUERY_MAPPING_UNSPEC = 0,
105         IWPM_NLA_RQUERY_MAPPING_SEQ,
106         IWPM_NLA_RQUERY_LOCAL_ADDR,
107         IWPM_NLA_RQUERY_REMOTE_ADDR,
108         IWPM_NLA_RQUERY_MAPPED_LOC_ADDR,
109         IWPM_NLA_RQUERY_MAPPED_REM_ADDR,
110         IWPM_NLA_RQUERY_MAPPING_ERR,
111         IWPM_NLA_RQUERY_MAPPING_MAX
112 };
113
114 enum {
115         IWPM_NLA_MAPINFO_REQ_UNSPEC = 0,
116         IWPM_NLA_MAPINFO_ULIB_NAME,
117         IWPM_NLA_MAPINFO_ULIB_VER,
118         IWPM_NLA_MAPINFO_REQ_MAX
119 };
120
121 enum {
122         IWPM_NLA_MAPINFO_UNSPEC = 0,
123         IWPM_NLA_MAPINFO_LOCAL_ADDR,
124         IWPM_NLA_MAPINFO_MAPPED_ADDR,
125         IWPM_NLA_MAPINFO_FLAGS,
126         IWPM_NLA_MAPINFO_MAX
127 };
128
129 enum {
130         IWPM_NLA_MAPINFO_NUM_UNSPEC = 0,
131         IWPM_NLA_MAPINFO_SEQ,
132         IWPM_NLA_MAPINFO_SEND_NUM,
133         IWPM_NLA_MAPINFO_ACK_NUM,
134         IWPM_NLA_MAPINFO_NUM_MAX
135 };
136
137 enum {
138         IWPM_NLA_ERR_UNSPEC = 0,
139         IWPM_NLA_ERR_SEQ,
140         IWPM_NLA_ERR_CODE,
141         IWPM_NLA_ERR_MAX
142 };
143
144 enum {
145         IWPM_NLA_HELLO_UNSPEC = 0,
146         IWPM_NLA_HELLO_ABI_VERSION,
147         IWPM_NLA_HELLO_MAX
148 };
149
150 /* For RDMA_NLDEV_ATTR_DEV_NODE_TYPE */
151 enum {
152         /* IB values map to NodeInfo:NodeType. */
153         RDMA_NODE_IB_CA = 1,
154         RDMA_NODE_IB_SWITCH,
155         RDMA_NODE_IB_ROUTER,
156         RDMA_NODE_RNIC,
157         RDMA_NODE_USNIC,
158         RDMA_NODE_USNIC_UDP,
159         RDMA_NODE_UNSPECIFIED,
160 };
161
162 /*
163  * Local service operations:
164  *   RESOLVE - The client requests the local service to resolve a path.
165  *   SET_TIMEOUT - The local service requests the client to set the timeout.
166  *   IP_RESOLVE - The client requests the local service to resolve an IP to GID.
167  */
168 enum {
169         RDMA_NL_LS_OP_RESOLVE = 0,
170         RDMA_NL_LS_OP_SET_TIMEOUT,
171         RDMA_NL_LS_OP_IP_RESOLVE,
172         RDMA_NL_LS_NUM_OPS
173 };
174
175 /* Local service netlink message flags */
176 #define RDMA_NL_LS_F_ERR        0x0100  /* Failed response */
177
178 /*
179  * Local service resolve operation family header.
180  * The layout for the resolve operation:
181  *    nlmsg header
182  *    family header
183  *    attributes
184  */
185
186 /*
187  * Local service path use:
188  * Specify how the path(s) will be used.
189  *   ALL - For connected CM operation (6 pathrecords)
190  *   UNIDIRECTIONAL - For unidirectional UD (1 pathrecord)
191  *   GMP - For miscellaneous GMP like operation (at least 1 reversible
192  *         pathrecord)
193  */
194 enum {
195         LS_RESOLVE_PATH_USE_ALL = 0,
196         LS_RESOLVE_PATH_USE_UNIDIRECTIONAL,
197         LS_RESOLVE_PATH_USE_GMP,
198         LS_RESOLVE_PATH_USE_MAX
199 };
200
201 #define LS_DEVICE_NAME_MAX 64
202
203 struct rdma_ls_resolve_header {
204         __u8 device_name[LS_DEVICE_NAME_MAX];
205         __u8 port_num;
206         __u8 path_use;
207 };
208
209 struct rdma_ls_ip_resolve_header {
210         __u32 ifindex;
211 };
212
213 /* Local service attribute type */
214 #define RDMA_NLA_F_MANDATORY    (1 << 13)
215 #define RDMA_NLA_TYPE_MASK      (~(NLA_F_NESTED | NLA_F_NET_BYTEORDER | \
216                                   RDMA_NLA_F_MANDATORY))
217
218 /*
219  * Local service attributes:
220  *   Attr Name       Size                       Byte order
221  *   -----------------------------------------------------
222  *   PATH_RECORD     struct ib_path_rec_data
223  *   TIMEOUT         u32                        cpu
224  *   SERVICE_ID      u64                        cpu
225  *   DGID            u8[16]                     BE
226  *   SGID            u8[16]                     BE
227  *   TCLASS          u8
228  *   PKEY            u16                        cpu
229  *   QOS_CLASS       u16                        cpu
230  *   IPV4            u32                        BE
231  *   IPV6            u8[16]                     BE
232  */
233 enum {
234         LS_NLA_TYPE_UNSPEC = 0,
235         LS_NLA_TYPE_PATH_RECORD,
236         LS_NLA_TYPE_TIMEOUT,
237         LS_NLA_TYPE_SERVICE_ID,
238         LS_NLA_TYPE_DGID,
239         LS_NLA_TYPE_SGID,
240         LS_NLA_TYPE_TCLASS,
241         LS_NLA_TYPE_PKEY,
242         LS_NLA_TYPE_QOS_CLASS,
243         LS_NLA_TYPE_IPV4,
244         LS_NLA_TYPE_IPV6,
245         LS_NLA_TYPE_MAX
246 };
247
248 /* Local service DGID/SGID attribute: big endian */
249 struct rdma_nla_ls_gid {
250         __u8            gid[16];
251 };
252
253 enum rdma_nldev_command {
254         RDMA_NLDEV_CMD_UNSPEC,
255
256         RDMA_NLDEV_CMD_GET, /* can dump */
257         RDMA_NLDEV_CMD_SET,
258
259         RDMA_NLDEV_CMD_NEWLINK,
260
261         RDMA_NLDEV_CMD_DELLINK,
262
263         RDMA_NLDEV_CMD_PORT_GET, /* can dump */
264
265         RDMA_NLDEV_CMD_SYS_GET,
266         RDMA_NLDEV_CMD_SYS_SET,
267
268         /* 8 is free to use */
269
270         RDMA_NLDEV_CMD_RES_GET = 9, /* can dump */
271
272         RDMA_NLDEV_CMD_RES_QP_GET, /* can dump */
273
274         RDMA_NLDEV_CMD_RES_CM_ID_GET, /* can dump */
275
276         RDMA_NLDEV_CMD_RES_CQ_GET, /* can dump */
277
278         RDMA_NLDEV_CMD_RES_MR_GET, /* can dump */
279
280         RDMA_NLDEV_CMD_RES_PD_GET, /* can dump */
281
282         RDMA_NLDEV_CMD_GET_CHARDEV,
283
284         RDMA_NLDEV_CMD_STAT_SET,
285
286         RDMA_NLDEV_CMD_STAT_GET, /* can dump */
287
288         RDMA_NLDEV_CMD_STAT_DEL,
289
290         RDMA_NLDEV_NUM_OPS
291 };
292
293 enum rdma_nldev_print_type {
294         RDMA_NLDEV_PRINT_TYPE_UNSPEC,
295         RDMA_NLDEV_PRINT_TYPE_HEX,
296 };
297
298 enum rdma_nldev_attr {
299         /* don't change the order or add anything between, this is ABI! */
300         RDMA_NLDEV_ATTR_UNSPEC,
301
302         /* Pad attribute for 64b alignment */
303         RDMA_NLDEV_ATTR_PAD = RDMA_NLDEV_ATTR_UNSPEC,
304
305         /* Identifier for ib_device */
306         RDMA_NLDEV_ATTR_DEV_INDEX,              /* u32 */
307
308         RDMA_NLDEV_ATTR_DEV_NAME,               /* string */
309         /*
310          * Device index together with port index are identifiers
311          * for port/link properties.
312          *
313          * For RDMA_NLDEV_CMD_GET commamnd, port index will return number
314          * of available ports in ib_device, while for port specific operations,
315          * it will be real port index as it appears in sysfs. Port index follows
316          * sysfs notation and starts from 1 for the first port.
317          */
318         RDMA_NLDEV_ATTR_PORT_INDEX,             /* u32 */
319
320         /*
321          * Device and port capabilities
322          *
323          * When used for port info, first 32-bits are CapabilityMask followed by
324          * 16-bit CapabilityMask2.
325          */
326         RDMA_NLDEV_ATTR_CAP_FLAGS,              /* u64 */
327
328         /*
329          * FW version
330          */
331         RDMA_NLDEV_ATTR_FW_VERSION,             /* string */
332
333         /*
334          * Node GUID (in host byte order) associated with the RDMA device.
335          */
336         RDMA_NLDEV_ATTR_NODE_GUID,                      /* u64 */
337
338         /*
339          * System image GUID (in host byte order) associated with
340          * this RDMA device and other devices which are part of a
341          * single system.
342          */
343         RDMA_NLDEV_ATTR_SYS_IMAGE_GUID,         /* u64 */
344
345         /*
346          * Subnet prefix (in host byte order)
347          */
348         RDMA_NLDEV_ATTR_SUBNET_PREFIX,          /* u64 */
349
350         /*
351          * Local Identifier (LID),
352          * According to IB specification, It is 16-bit address assigned
353          * by the Subnet Manager. Extended to be 32-bit for OmniPath users.
354          */
355         RDMA_NLDEV_ATTR_LID,                    /* u32 */
356         RDMA_NLDEV_ATTR_SM_LID,                 /* u32 */
357
358         /*
359          * LID mask control (LMC)
360          */
361         RDMA_NLDEV_ATTR_LMC,                    /* u8 */
362
363         RDMA_NLDEV_ATTR_PORT_STATE,             /* u8 */
364         RDMA_NLDEV_ATTR_PORT_PHYS_STATE,        /* u8 */
365
366         RDMA_NLDEV_ATTR_DEV_NODE_TYPE,          /* u8 */
367
368         RDMA_NLDEV_ATTR_RES_SUMMARY,            /* nested table */
369         RDMA_NLDEV_ATTR_RES_SUMMARY_ENTRY,      /* nested table */
370         RDMA_NLDEV_ATTR_RES_SUMMARY_ENTRY_NAME, /* string */
371         RDMA_NLDEV_ATTR_RES_SUMMARY_ENTRY_CURR, /* u64 */
372
373         RDMA_NLDEV_ATTR_RES_QP,                 /* nested table */
374         RDMA_NLDEV_ATTR_RES_QP_ENTRY,           /* nested table */
375         /*
376          * Local QPN
377          */
378         RDMA_NLDEV_ATTR_RES_LQPN,               /* u32 */
379         /*
380          * Remote QPN,
381          * Applicable for RC and UC only IBTA 11.2.5.3 QUERY QUEUE PAIR
382          */
383         RDMA_NLDEV_ATTR_RES_RQPN,               /* u32 */
384         /*
385          * Receive Queue PSN,
386          * Applicable for RC and UC only 11.2.5.3 QUERY QUEUE PAIR
387          */
388         RDMA_NLDEV_ATTR_RES_RQ_PSN,             /* u32 */
389         /*
390          * Send Queue PSN
391          */
392         RDMA_NLDEV_ATTR_RES_SQ_PSN,             /* u32 */
393         RDMA_NLDEV_ATTR_RES_PATH_MIG_STATE,     /* u8 */
394         /*
395          * QP types as visible to RDMA/core, the reserved QPT
396          * are not exported through this interface.
397          */
398         RDMA_NLDEV_ATTR_RES_TYPE,               /* u8 */
399         RDMA_NLDEV_ATTR_RES_STATE,              /* u8 */
400         /*
401          * Process ID which created object,
402          * in case of kernel origin, PID won't exist.
403          */
404         RDMA_NLDEV_ATTR_RES_PID,                /* u32 */
405         /*
406          * The name of process created following resource.
407          * It will exist only for kernel objects.
408          * For user created objects, the user is supposed
409          * to read /proc/PID/comm file.
410          */
411         RDMA_NLDEV_ATTR_RES_KERN_NAME,          /* string */
412
413         RDMA_NLDEV_ATTR_RES_CM_ID,              /* nested table */
414         RDMA_NLDEV_ATTR_RES_CM_ID_ENTRY,        /* nested table */
415         /*
416          * rdma_cm_id port space.
417          */
418         RDMA_NLDEV_ATTR_RES_PS,                 /* u32 */
419         /*
420          * Source and destination socket addresses
421          */
422         RDMA_NLDEV_ATTR_RES_SRC_ADDR,           /* __kernel_sockaddr_storage */
423         RDMA_NLDEV_ATTR_RES_DST_ADDR,           /* __kernel_sockaddr_storage */
424
425         RDMA_NLDEV_ATTR_RES_CQ,                 /* nested table */
426         RDMA_NLDEV_ATTR_RES_CQ_ENTRY,           /* nested table */
427         RDMA_NLDEV_ATTR_RES_CQE,                /* u32 */
428         RDMA_NLDEV_ATTR_RES_USECNT,             /* u64 */
429         RDMA_NLDEV_ATTR_RES_POLL_CTX,           /* u8 */
430
431         RDMA_NLDEV_ATTR_RES_MR,                 /* nested table */
432         RDMA_NLDEV_ATTR_RES_MR_ENTRY,           /* nested table */
433         RDMA_NLDEV_ATTR_RES_RKEY,               /* u32 */
434         RDMA_NLDEV_ATTR_RES_LKEY,               /* u32 */
435         RDMA_NLDEV_ATTR_RES_IOVA,               /* u64 */
436         RDMA_NLDEV_ATTR_RES_MRLEN,              /* u64 */
437
438         RDMA_NLDEV_ATTR_RES_PD,                 /* nested table */
439         RDMA_NLDEV_ATTR_RES_PD_ENTRY,           /* nested table */
440         RDMA_NLDEV_ATTR_RES_LOCAL_DMA_LKEY,     /* u32 */
441         RDMA_NLDEV_ATTR_RES_UNSAFE_GLOBAL_RKEY, /* u32 */
442         /*
443          * Provides logical name and index of netdevice which is
444          * connected to physical port. This information is relevant
445          * for RoCE and iWARP.
446          *
447          * The netdevices which are associated with containers are
448          * supposed to be exported together with GID table once it
449          * will be exposed through the netlink. Because the
450          * associated netdevices are properties of GIDs.
451          */
452         RDMA_NLDEV_ATTR_NDEV_INDEX,             /* u32 */
453         RDMA_NLDEV_ATTR_NDEV_NAME,              /* string */
454         /*
455          * driver-specific attributes.
456          */
457         RDMA_NLDEV_ATTR_DRIVER,                 /* nested table */
458         RDMA_NLDEV_ATTR_DRIVER_ENTRY,           /* nested table */
459         RDMA_NLDEV_ATTR_DRIVER_STRING,          /* string */
460         /*
461          * u8 values from enum rdma_nldev_print_type
462          */
463         RDMA_NLDEV_ATTR_DRIVER_PRINT_TYPE,      /* u8 */
464         RDMA_NLDEV_ATTR_DRIVER_S32,             /* s32 */
465         RDMA_NLDEV_ATTR_DRIVER_U32,             /* u32 */
466         RDMA_NLDEV_ATTR_DRIVER_S64,             /* s64 */
467         RDMA_NLDEV_ATTR_DRIVER_U64,             /* u64 */
468
469         /*
470          * Indexes to get/set secific entry,
471          * for QP use RDMA_NLDEV_ATTR_RES_LQPN
472          */
473         RDMA_NLDEV_ATTR_RES_PDN,               /* u32 */
474         RDMA_NLDEV_ATTR_RES_CQN,               /* u32 */
475         RDMA_NLDEV_ATTR_RES_MRN,               /* u32 */
476         RDMA_NLDEV_ATTR_RES_CM_IDN,            /* u32 */
477         RDMA_NLDEV_ATTR_RES_CTXN,              /* u32 */
478         /*
479          * Identifies the rdma driver. eg: "rxe" or "siw"
480          */
481         RDMA_NLDEV_ATTR_LINK_TYPE,              /* string */
482
483         /*
484          * net namespace mode for rdma subsystem:
485          * either shared or exclusive among multiple net namespaces.
486          */
487         RDMA_NLDEV_SYS_ATTR_NETNS_MODE,         /* u8 */
488         /*
489          * Device protocol, e.g. ib, iw, usnic, roce and opa
490          */
491         RDMA_NLDEV_ATTR_DEV_PROTOCOL,           /* string */
492
493         /*
494          * File descriptor handle of the net namespace object
495          */
496         RDMA_NLDEV_NET_NS_FD,                   /* u32 */
497         /*
498          * Information about a chardev.
499          * CHARDEV_TYPE is the name of the chardev ABI (ie uverbs, umad, etc)
500          * CHARDEV_ABI signals the ABI revision (historical)
501          * CHARDEV_NAME is the kernel name for the /dev/ file (no directory)
502          * CHARDEV is the 64 bit dev_t for the inode
503          */
504         RDMA_NLDEV_ATTR_CHARDEV_TYPE,           /* string */
505         RDMA_NLDEV_ATTR_CHARDEV_NAME,           /* string */
506         RDMA_NLDEV_ATTR_CHARDEV_ABI,            /* u64 */
507         RDMA_NLDEV_ATTR_CHARDEV,                /* u64 */
508         RDMA_NLDEV_ATTR_UVERBS_DRIVER_ID,       /* u64 */
509         /*
510          * Counter-specific attributes.
511          */
512         RDMA_NLDEV_ATTR_STAT_MODE,              /* u32 */
513         RDMA_NLDEV_ATTR_STAT_RES,               /* u32 */
514         RDMA_NLDEV_ATTR_STAT_AUTO_MODE_MASK,    /* u32 */
515         RDMA_NLDEV_ATTR_STAT_COUNTER,           /* nested table */
516         RDMA_NLDEV_ATTR_STAT_COUNTER_ENTRY,     /* nested table */
517         RDMA_NLDEV_ATTR_STAT_COUNTER_ID,        /* u32 */
518         RDMA_NLDEV_ATTR_STAT_HWCOUNTERS,        /* nested table */
519         RDMA_NLDEV_ATTR_STAT_HWCOUNTER_ENTRY,   /* nested table */
520         RDMA_NLDEV_ATTR_STAT_HWCOUNTER_ENTRY_NAME,      /* string */
521         RDMA_NLDEV_ATTR_STAT_HWCOUNTER_ENTRY_VALUE,     /* u64 */
522
523         /*
524          * CQ adaptive moderatio (DIM)
525          */
526         RDMA_NLDEV_ATTR_DEV_DIM,                /* u8 */
527
528         /*
529          * Always the end
530          */
531         RDMA_NLDEV_ATTR_MAX
532 };
533
534 /*
535  * Supported counter bind modes. All modes are mutual-exclusive.
536  */
537 enum rdma_nl_counter_mode {
538         RDMA_COUNTER_MODE_NONE,
539
540         /*
541          * A qp is bound with a counter automatically during initialization
542          * based on the auto mode (e.g., qp type, ...)
543          */
544         RDMA_COUNTER_MODE_AUTO,
545
546         /*
547          * Which qp are bound with which counter is explicitly specified
548          * by the user
549          */
550         RDMA_COUNTER_MODE_MANUAL,
551
552         /*
553          * Always the end
554          */
555         RDMA_COUNTER_MODE_MAX,
556 };
557
558 /*
559  * Supported criteria in counter auto mode.
560  * Currently only "qp type" is supported
561  */
562 enum rdma_nl_counter_mask {
563         RDMA_COUNTER_MASK_QP_TYPE = 1,
564 };
565 #endif /* _UAPI_RDMA_NETLINK_H */