1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 #ifndef _UAPI_RDMA_NETLINK_H
3 #define _UAPI_RDMA_NETLINK_H
5 #include <linux/types.h>
10 RDMA_NL_LS, /* RDMA Local Services */
11 RDMA_NL_NLDEV, /* RDMA device interface */
16 RDMA_NL_GROUP_IWPM = 2,
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)
25 /* The minimum version that the iwpm kernel supports */
26 #define IWPM_UABI_VERSION_MIN 3
28 /* The latest version that the iwpm kernel supports */
29 #define IWPM_UABI_VERSION 4
31 /* iwarp port mapper message flags */
34 /* Do not map the port for this IWPM request */
35 IWPM_FLAGS_NO_PORT_MAP = (1 << 0),
38 /* iwarp port mapper op-codes */
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,
47 RDMA_NL_IWPM_MAPINFO_NUM,
53 IWPM_NLA_REG_PID_UNSPEC = 0,
56 IWPM_NLA_REG_IBDEV_NAME,
57 IWPM_NLA_REG_ULIB_NAME,
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,
73 IWPM_NLA_MANAGE_MAPPING_UNSPEC = 0,
74 IWPM_NLA_MANAGE_MAPPING_SEQ,
76 IWPM_NLA_MANAGE_FLAGS,
77 IWPM_NLA_MANAGE_MAPPING_MAX
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
91 #define IWPM_NLA_MAPINFO_SEND_MAX 3
92 #define IWPM_NLA_REMOVE_MAPPING_MAX 3
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,
100 IWPM_NLA_QUERY_MAPPING_MAX,
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
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
122 IWPM_NLA_MAPINFO_UNSPEC = 0,
123 IWPM_NLA_MAPINFO_LOCAL_ADDR,
124 IWPM_NLA_MAPINFO_MAPPED_ADDR,
125 IWPM_NLA_MAPINFO_FLAGS,
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
138 IWPM_NLA_ERR_UNSPEC = 0,
145 IWPM_NLA_HELLO_UNSPEC = 0,
146 IWPM_NLA_HELLO_ABI_VERSION,
150 /* For RDMA_NLDEV_ATTR_DEV_NODE_TYPE */
152 /* IB values map to NodeInfo:NodeType. */
159 RDMA_NODE_UNSPECIFIED,
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.
169 RDMA_NL_LS_OP_RESOLVE = 0,
170 RDMA_NL_LS_OP_SET_TIMEOUT,
171 RDMA_NL_LS_OP_IP_RESOLVE,
175 /* Local service netlink message flags */
176 #define RDMA_NL_LS_F_ERR 0x0100 /* Failed response */
179 * Local service resolve operation family header.
180 * The layout for the resolve operation:
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
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
201 #define LS_DEVICE_NAME_MAX 64
203 struct rdma_ls_resolve_header {
204 __u8 device_name[LS_DEVICE_NAME_MAX];
209 struct rdma_ls_ip_resolve_header {
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))
219 * Local service attributes:
220 * Attr Name Size Byte order
221 * -----------------------------------------------------
222 * PATH_RECORD struct ib_path_rec_data
234 LS_NLA_TYPE_UNSPEC = 0,
235 LS_NLA_TYPE_PATH_RECORD,
237 LS_NLA_TYPE_SERVICE_ID,
242 LS_NLA_TYPE_QOS_CLASS,
248 /* Local service DGID/SGID attribute: big endian */
249 struct rdma_nla_ls_gid {
253 enum rdma_nldev_command {
254 RDMA_NLDEV_CMD_UNSPEC,
256 RDMA_NLDEV_CMD_GET, /* can dump */
259 RDMA_NLDEV_CMD_NEWLINK,
261 RDMA_NLDEV_CMD_DELLINK,
263 RDMA_NLDEV_CMD_PORT_GET, /* can dump */
265 RDMA_NLDEV_CMD_SYS_GET,
266 RDMA_NLDEV_CMD_SYS_SET,
268 /* 8 is free to use */
270 RDMA_NLDEV_CMD_RES_GET = 9, /* can dump */
272 RDMA_NLDEV_CMD_RES_QP_GET, /* can dump */
274 RDMA_NLDEV_CMD_RES_CM_ID_GET, /* can dump */
276 RDMA_NLDEV_CMD_RES_CQ_GET, /* can dump */
278 RDMA_NLDEV_CMD_RES_MR_GET, /* can dump */
280 RDMA_NLDEV_CMD_RES_PD_GET, /* can dump */
282 RDMA_NLDEV_CMD_GET_CHARDEV,
284 RDMA_NLDEV_CMD_STAT_SET,
286 RDMA_NLDEV_CMD_STAT_GET, /* can dump */
288 RDMA_NLDEV_CMD_STAT_DEL,
290 RDMA_NLDEV_CMD_RES_QP_GET_RAW,
292 RDMA_NLDEV_CMD_RES_CQ_GET_RAW,
294 RDMA_NLDEV_CMD_RES_MR_GET_RAW,
296 RDMA_NLDEV_CMD_RES_CTX_GET, /* can dump */
298 RDMA_NLDEV_CMD_RES_SRQ_GET, /* can dump */
300 RDMA_NLDEV_CMD_STAT_GET_STATUS,
305 enum rdma_nldev_print_type {
306 RDMA_NLDEV_PRINT_TYPE_UNSPEC,
307 RDMA_NLDEV_PRINT_TYPE_HEX,
310 enum rdma_nldev_attr {
311 /* don't change the order or add anything between, this is ABI! */
312 RDMA_NLDEV_ATTR_UNSPEC,
314 /* Pad attribute for 64b alignment */
315 RDMA_NLDEV_ATTR_PAD = RDMA_NLDEV_ATTR_UNSPEC,
317 /* Identifier for ib_device */
318 RDMA_NLDEV_ATTR_DEV_INDEX, /* u32 */
320 RDMA_NLDEV_ATTR_DEV_NAME, /* string */
322 * Device index together with port index are identifiers
323 * for port/link properties.
325 * For RDMA_NLDEV_CMD_GET commamnd, port index will return number
326 * of available ports in ib_device, while for port specific operations,
327 * it will be real port index as it appears in sysfs. Port index follows
328 * sysfs notation and starts from 1 for the first port.
330 RDMA_NLDEV_ATTR_PORT_INDEX, /* u32 */
333 * Device and port capabilities
335 * When used for port info, first 32-bits are CapabilityMask followed by
336 * 16-bit CapabilityMask2.
338 RDMA_NLDEV_ATTR_CAP_FLAGS, /* u64 */
343 RDMA_NLDEV_ATTR_FW_VERSION, /* string */
346 * Node GUID (in host byte order) associated with the RDMA device.
348 RDMA_NLDEV_ATTR_NODE_GUID, /* u64 */
351 * System image GUID (in host byte order) associated with
352 * this RDMA device and other devices which are part of a
355 RDMA_NLDEV_ATTR_SYS_IMAGE_GUID, /* u64 */
358 * Subnet prefix (in host byte order)
360 RDMA_NLDEV_ATTR_SUBNET_PREFIX, /* u64 */
363 * Local Identifier (LID),
364 * According to IB specification, It is 16-bit address assigned
365 * by the Subnet Manager. Extended to be 32-bit for OmniPath users.
367 RDMA_NLDEV_ATTR_LID, /* u32 */
368 RDMA_NLDEV_ATTR_SM_LID, /* u32 */
371 * LID mask control (LMC)
373 RDMA_NLDEV_ATTR_LMC, /* u8 */
375 RDMA_NLDEV_ATTR_PORT_STATE, /* u8 */
376 RDMA_NLDEV_ATTR_PORT_PHYS_STATE, /* u8 */
378 RDMA_NLDEV_ATTR_DEV_NODE_TYPE, /* u8 */
380 RDMA_NLDEV_ATTR_RES_SUMMARY, /* nested table */
381 RDMA_NLDEV_ATTR_RES_SUMMARY_ENTRY, /* nested table */
382 RDMA_NLDEV_ATTR_RES_SUMMARY_ENTRY_NAME, /* string */
383 RDMA_NLDEV_ATTR_RES_SUMMARY_ENTRY_CURR, /* u64 */
385 RDMA_NLDEV_ATTR_RES_QP, /* nested table */
386 RDMA_NLDEV_ATTR_RES_QP_ENTRY, /* nested table */
390 RDMA_NLDEV_ATTR_RES_LQPN, /* u32 */
393 * Applicable for RC and UC only IBTA 11.2.5.3 QUERY QUEUE PAIR
395 RDMA_NLDEV_ATTR_RES_RQPN, /* u32 */
398 * Applicable for RC and UC only 11.2.5.3 QUERY QUEUE PAIR
400 RDMA_NLDEV_ATTR_RES_RQ_PSN, /* u32 */
404 RDMA_NLDEV_ATTR_RES_SQ_PSN, /* u32 */
405 RDMA_NLDEV_ATTR_RES_PATH_MIG_STATE, /* u8 */
407 * QP types as visible to RDMA/core, the reserved QPT
408 * are not exported through this interface.
410 RDMA_NLDEV_ATTR_RES_TYPE, /* u8 */
411 RDMA_NLDEV_ATTR_RES_STATE, /* u8 */
413 * Process ID which created object,
414 * in case of kernel origin, PID won't exist.
416 RDMA_NLDEV_ATTR_RES_PID, /* u32 */
418 * The name of process created following resource.
419 * It will exist only for kernel objects.
420 * For user created objects, the user is supposed
421 * to read /proc/PID/comm file.
423 RDMA_NLDEV_ATTR_RES_KERN_NAME, /* string */
425 RDMA_NLDEV_ATTR_RES_CM_ID, /* nested table */
426 RDMA_NLDEV_ATTR_RES_CM_ID_ENTRY, /* nested table */
428 * rdma_cm_id port space.
430 RDMA_NLDEV_ATTR_RES_PS, /* u32 */
432 * Source and destination socket addresses
434 RDMA_NLDEV_ATTR_RES_SRC_ADDR, /* __kernel_sockaddr_storage */
435 RDMA_NLDEV_ATTR_RES_DST_ADDR, /* __kernel_sockaddr_storage */
437 RDMA_NLDEV_ATTR_RES_CQ, /* nested table */
438 RDMA_NLDEV_ATTR_RES_CQ_ENTRY, /* nested table */
439 RDMA_NLDEV_ATTR_RES_CQE, /* u32 */
440 RDMA_NLDEV_ATTR_RES_USECNT, /* u64 */
441 RDMA_NLDEV_ATTR_RES_POLL_CTX, /* u8 */
443 RDMA_NLDEV_ATTR_RES_MR, /* nested table */
444 RDMA_NLDEV_ATTR_RES_MR_ENTRY, /* nested table */
445 RDMA_NLDEV_ATTR_RES_RKEY, /* u32 */
446 RDMA_NLDEV_ATTR_RES_LKEY, /* u32 */
447 RDMA_NLDEV_ATTR_RES_IOVA, /* u64 */
448 RDMA_NLDEV_ATTR_RES_MRLEN, /* u64 */
450 RDMA_NLDEV_ATTR_RES_PD, /* nested table */
451 RDMA_NLDEV_ATTR_RES_PD_ENTRY, /* nested table */
452 RDMA_NLDEV_ATTR_RES_LOCAL_DMA_LKEY, /* u32 */
453 RDMA_NLDEV_ATTR_RES_UNSAFE_GLOBAL_RKEY, /* u32 */
455 * Provides logical name and index of netdevice which is
456 * connected to physical port. This information is relevant
457 * for RoCE and iWARP.
459 * The netdevices which are associated with containers are
460 * supposed to be exported together with GID table once it
461 * will be exposed through the netlink. Because the
462 * associated netdevices are properties of GIDs.
464 RDMA_NLDEV_ATTR_NDEV_INDEX, /* u32 */
465 RDMA_NLDEV_ATTR_NDEV_NAME, /* string */
467 * driver-specific attributes.
469 RDMA_NLDEV_ATTR_DRIVER, /* nested table */
470 RDMA_NLDEV_ATTR_DRIVER_ENTRY, /* nested table */
471 RDMA_NLDEV_ATTR_DRIVER_STRING, /* string */
473 * u8 values from enum rdma_nldev_print_type
475 RDMA_NLDEV_ATTR_DRIVER_PRINT_TYPE, /* u8 */
476 RDMA_NLDEV_ATTR_DRIVER_S32, /* s32 */
477 RDMA_NLDEV_ATTR_DRIVER_U32, /* u32 */
478 RDMA_NLDEV_ATTR_DRIVER_S64, /* s64 */
479 RDMA_NLDEV_ATTR_DRIVER_U64, /* u64 */
482 * Indexes to get/set secific entry,
483 * for QP use RDMA_NLDEV_ATTR_RES_LQPN
485 RDMA_NLDEV_ATTR_RES_PDN, /* u32 */
486 RDMA_NLDEV_ATTR_RES_CQN, /* u32 */
487 RDMA_NLDEV_ATTR_RES_MRN, /* u32 */
488 RDMA_NLDEV_ATTR_RES_CM_IDN, /* u32 */
489 RDMA_NLDEV_ATTR_RES_CTXN, /* u32 */
491 * Identifies the rdma driver. eg: "rxe" or "siw"
493 RDMA_NLDEV_ATTR_LINK_TYPE, /* string */
496 * net namespace mode for rdma subsystem:
497 * either shared or exclusive among multiple net namespaces.
499 RDMA_NLDEV_SYS_ATTR_NETNS_MODE, /* u8 */
501 * Device protocol, e.g. ib, iw, usnic, roce and opa
503 RDMA_NLDEV_ATTR_DEV_PROTOCOL, /* string */
506 * File descriptor handle of the net namespace object
508 RDMA_NLDEV_NET_NS_FD, /* u32 */
510 * Information about a chardev.
511 * CHARDEV_TYPE is the name of the chardev ABI (ie uverbs, umad, etc)
512 * CHARDEV_ABI signals the ABI revision (historical)
513 * CHARDEV_NAME is the kernel name for the /dev/ file (no directory)
514 * CHARDEV is the 64 bit dev_t for the inode
516 RDMA_NLDEV_ATTR_CHARDEV_TYPE, /* string */
517 RDMA_NLDEV_ATTR_CHARDEV_NAME, /* string */
518 RDMA_NLDEV_ATTR_CHARDEV_ABI, /* u64 */
519 RDMA_NLDEV_ATTR_CHARDEV, /* u64 */
520 RDMA_NLDEV_ATTR_UVERBS_DRIVER_ID, /* u64 */
522 * Counter-specific attributes.
524 RDMA_NLDEV_ATTR_STAT_MODE, /* u32 */
525 RDMA_NLDEV_ATTR_STAT_RES, /* u32 */
526 RDMA_NLDEV_ATTR_STAT_AUTO_MODE_MASK, /* u32 */
527 RDMA_NLDEV_ATTR_STAT_COUNTER, /* nested table */
528 RDMA_NLDEV_ATTR_STAT_COUNTER_ENTRY, /* nested table */
529 RDMA_NLDEV_ATTR_STAT_COUNTER_ID, /* u32 */
530 RDMA_NLDEV_ATTR_STAT_HWCOUNTERS, /* nested table */
531 RDMA_NLDEV_ATTR_STAT_HWCOUNTER_ENTRY, /* nested table */
532 RDMA_NLDEV_ATTR_STAT_HWCOUNTER_ENTRY_NAME, /* string */
533 RDMA_NLDEV_ATTR_STAT_HWCOUNTER_ENTRY_VALUE, /* u64 */
536 * CQ adaptive moderatio (DIM)
538 RDMA_NLDEV_ATTR_DEV_DIM, /* u8 */
540 RDMA_NLDEV_ATTR_RES_RAW, /* binary */
542 RDMA_NLDEV_ATTR_RES_CTX, /* nested table */
543 RDMA_NLDEV_ATTR_RES_CTX_ENTRY, /* nested table */
545 RDMA_NLDEV_ATTR_RES_SRQ, /* nested table */
546 RDMA_NLDEV_ATTR_RES_SRQ_ENTRY, /* nested table */
547 RDMA_NLDEV_ATTR_RES_SRQN, /* u32 */
549 RDMA_NLDEV_ATTR_MIN_RANGE, /* u32 */
550 RDMA_NLDEV_ATTR_MAX_RANGE, /* u32 */
552 RDMA_NLDEV_SYS_ATTR_COPY_ON_FORK, /* u8 */
554 RDMA_NLDEV_ATTR_STAT_HWCOUNTER_INDEX, /* u32 */
555 RDMA_NLDEV_ATTR_STAT_HWCOUNTER_DYNAMIC, /* u8 */
564 * Supported counter bind modes. All modes are mutual-exclusive.
566 enum rdma_nl_counter_mode {
567 RDMA_COUNTER_MODE_NONE,
570 * A qp is bound with a counter automatically during initialization
571 * based on the auto mode (e.g., qp type, ...)
573 RDMA_COUNTER_MODE_AUTO,
576 * Which qp are bound with which counter is explicitly specified
579 RDMA_COUNTER_MODE_MANUAL,
584 RDMA_COUNTER_MODE_MAX,
588 * Supported criteria in counter auto mode.
589 * Currently only "qp type" is supported
591 enum rdma_nl_counter_mask {
592 RDMA_COUNTER_MASK_QP_TYPE = 1,
593 RDMA_COUNTER_MASK_PID = 1 << 1,
595 #endif /* _UAPI_RDMA_NETLINK_H */