1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
3 * Copyright (c) 2005 Topspin Communications. All rights reserved.
4 * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
5 * Copyright (c) 2005 PathScale, Inc. All rights reserved.
6 * Copyright (c) 2006 Mellanox Technologies. All rights reserved.
8 * This software is available to you under a choice of one of two
9 * licenses. You may choose to be licensed under the terms of the GNU
10 * General Public License (GPL) Version 2, available from the file
11 * COPYING in the main directory of this source tree, or the
12 * OpenIB.org BSD license below:
14 * Redistribution and use in source and binary forms, with or
15 * without modification, are permitted provided that the following
18 * - Redistributions of source code must retain the above
19 * copyright notice, this list of conditions and the following
22 * - Redistributions in binary form must reproduce the above
23 * copyright notice, this list of conditions and the following
24 * disclaimer in the documentation and/or other materials
25 * provided with the distribution.
27 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
28 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
29 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
30 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
31 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
32 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
33 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
37 #ifndef IB_USER_VERBS_H
38 #define IB_USER_VERBS_H
40 #include <linux/types.h>
43 * Increment this value if any changes that break userspace ABI
44 * compatibility are made.
46 #define IB_USER_VERBS_ABI_VERSION 6
47 #define IB_USER_VERBS_CMD_THRESHOLD 50
50 IB_USER_VERBS_CMD_GET_CONTEXT,
51 IB_USER_VERBS_CMD_QUERY_DEVICE,
52 IB_USER_VERBS_CMD_QUERY_PORT,
53 IB_USER_VERBS_CMD_ALLOC_PD,
54 IB_USER_VERBS_CMD_DEALLOC_PD,
55 IB_USER_VERBS_CMD_CREATE_AH,
56 IB_USER_VERBS_CMD_MODIFY_AH,
57 IB_USER_VERBS_CMD_QUERY_AH,
58 IB_USER_VERBS_CMD_DESTROY_AH,
59 IB_USER_VERBS_CMD_REG_MR,
60 IB_USER_VERBS_CMD_REG_SMR,
61 IB_USER_VERBS_CMD_REREG_MR,
62 IB_USER_VERBS_CMD_QUERY_MR,
63 IB_USER_VERBS_CMD_DEREG_MR,
64 IB_USER_VERBS_CMD_ALLOC_MW,
65 IB_USER_VERBS_CMD_BIND_MW,
66 IB_USER_VERBS_CMD_DEALLOC_MW,
67 IB_USER_VERBS_CMD_CREATE_COMP_CHANNEL,
68 IB_USER_VERBS_CMD_CREATE_CQ,
69 IB_USER_VERBS_CMD_RESIZE_CQ,
70 IB_USER_VERBS_CMD_DESTROY_CQ,
71 IB_USER_VERBS_CMD_POLL_CQ,
72 IB_USER_VERBS_CMD_PEEK_CQ,
73 IB_USER_VERBS_CMD_REQ_NOTIFY_CQ,
74 IB_USER_VERBS_CMD_CREATE_QP,
75 IB_USER_VERBS_CMD_QUERY_QP,
76 IB_USER_VERBS_CMD_MODIFY_QP,
77 IB_USER_VERBS_CMD_DESTROY_QP,
78 IB_USER_VERBS_CMD_POST_SEND,
79 IB_USER_VERBS_CMD_POST_RECV,
80 IB_USER_VERBS_CMD_ATTACH_MCAST,
81 IB_USER_VERBS_CMD_DETACH_MCAST,
82 IB_USER_VERBS_CMD_CREATE_SRQ,
83 IB_USER_VERBS_CMD_MODIFY_SRQ,
84 IB_USER_VERBS_CMD_QUERY_SRQ,
85 IB_USER_VERBS_CMD_DESTROY_SRQ,
86 IB_USER_VERBS_CMD_POST_SRQ_RECV,
87 IB_USER_VERBS_CMD_OPEN_XRCD,
88 IB_USER_VERBS_CMD_CLOSE_XRCD,
89 IB_USER_VERBS_CMD_CREATE_XSRQ,
90 IB_USER_VERBS_CMD_OPEN_QP,
94 IB_USER_VERBS_EX_CMD_QUERY_DEVICE = IB_USER_VERBS_CMD_QUERY_DEVICE,
95 IB_USER_VERBS_EX_CMD_CREATE_CQ = IB_USER_VERBS_CMD_CREATE_CQ,
96 IB_USER_VERBS_EX_CMD_CREATE_QP = IB_USER_VERBS_CMD_CREATE_QP,
97 IB_USER_VERBS_EX_CMD_MODIFY_QP = IB_USER_VERBS_CMD_MODIFY_QP,
98 IB_USER_VERBS_EX_CMD_CREATE_FLOW = IB_USER_VERBS_CMD_THRESHOLD,
99 IB_USER_VERBS_EX_CMD_DESTROY_FLOW,
100 IB_USER_VERBS_EX_CMD_CREATE_WQ,
101 IB_USER_VERBS_EX_CMD_MODIFY_WQ,
102 IB_USER_VERBS_EX_CMD_DESTROY_WQ,
103 IB_USER_VERBS_EX_CMD_CREATE_RWQ_IND_TBL,
104 IB_USER_VERBS_EX_CMD_DESTROY_RWQ_IND_TBL
108 * Make sure that all structs defined in this file remain laid out so
109 * that they pack the same way on 32-bit and 64-bit architectures (to
110 * avoid incompatibility between 32-bit userspace and 64-bit kernels).
112 * - Do not use pointer types -- pass pointers in __u64 instead.
113 * - Make sure that any structure larger than 4 bytes is padded to a
114 * multiple of 8 bytes. Otherwise the structure size will be
115 * different between 32-bit and 64-bit architectures.
118 struct ib_uverbs_async_event_desc {
120 __u32 event_type; /* enum ib_event_type */
124 struct ib_uverbs_comp_event_desc {
129 * All commands from userspace should start with a __u32 command field
130 * followed by __u16 in_words and out_words fields (which give the
131 * length of the command block and response buffer if any in 32-bit
132 * words). The kernel driver will read these fields first and read
133 * the rest of the command struct based on these value.
136 #define IB_USER_VERBS_CMD_COMMAND_MASK 0xff
137 #define IB_USER_VERBS_CMD_FLAGS_MASK 0xff000000u
138 #define IB_USER_VERBS_CMD_FLAGS_SHIFT 24
140 #define IB_USER_VERBS_CMD_FLAG_EXTENDED 0x80
142 struct ib_uverbs_cmd_hdr {
148 struct ib_uverbs_ex_cmd_hdr {
150 __u16 provider_in_words;
151 __u16 provider_out_words;
152 __u32 cmd_hdr_reserved;
155 struct ib_uverbs_get_context {
157 __u64 driver_data[0];
160 struct ib_uverbs_get_context_resp {
162 __u32 num_comp_vectors;
165 struct ib_uverbs_query_device {
167 __u64 driver_data[0];
170 struct ib_uverbs_query_device_resp {
173 __be64 sys_image_guid;
177 __u32 vendor_part_id;
181 __u32 device_cap_flags;
188 __u32 max_qp_rd_atom;
189 __u32 max_ee_rd_atom;
190 __u32 max_res_rd_atom;
191 __u32 max_qp_init_rd_atom;
192 __u32 max_ee_init_rd_atom;
197 __u32 max_raw_ipv6_qp;
198 __u32 max_raw_ethy_qp;
200 __u32 max_mcast_qp_attach;
201 __u32 max_total_mcast_qp_attach;
204 __u32 max_map_per_fmr;
209 __u8 local_ca_ack_delay;
214 struct ib_uverbs_ex_query_device {
219 struct ib_uverbs_odp_caps {
225 } per_transport_caps;
229 struct ib_uverbs_rss_caps {
230 /* Corresponding bit will be set if qp type from
231 * 'enum ib_qp_type' is supported, e.g.
232 * supported_qpts |= 1 << IB_QPT_UD
234 __u32 supported_qpts;
235 __u32 max_rwq_indirection_tables;
236 __u32 max_rwq_indirection_table_size;
240 struct ib_uverbs_tm_caps {
241 /* Max size of rendezvous request message */
242 __u32 max_rndv_hdr_size;
243 /* Max number of entries in tag matching list */
247 /* Max number of outstanding list operations */
249 /* Max number of SGE in tag matching entry */
254 struct ib_uverbs_ex_query_device_resp {
255 struct ib_uverbs_query_device_resp base;
257 __u32 response_length;
258 struct ib_uverbs_odp_caps odp_caps;
259 __u64 timestamp_mask;
260 __u64 hca_core_clock; /* in KHZ */
261 __u64 device_cap_flags_ex;
262 struct ib_uverbs_rss_caps rss_caps;
263 __u32 max_wq_type_rq;
264 __u32 raw_packet_caps;
265 struct ib_uverbs_tm_caps tm_caps;
268 struct ib_uverbs_query_port {
272 __u64 driver_data[0];
275 struct ib_uverbs_query_port_resp {
276 __u32 port_cap_flags;
279 __u32 qkey_viol_cntr;
291 __u8 init_type_reply;
299 struct ib_uverbs_alloc_pd {
301 __u64 driver_data[0];
304 struct ib_uverbs_alloc_pd_resp {
308 struct ib_uverbs_dealloc_pd {
312 struct ib_uverbs_open_xrcd {
316 __u64 driver_data[0];
319 struct ib_uverbs_open_xrcd_resp {
323 struct ib_uverbs_close_xrcd {
327 struct ib_uverbs_reg_mr {
334 __u64 driver_data[0];
337 struct ib_uverbs_reg_mr_resp {
343 struct ib_uverbs_rereg_mr {
354 struct ib_uverbs_rereg_mr_resp {
359 struct ib_uverbs_dereg_mr {
363 struct ib_uverbs_alloc_mw {
370 struct ib_uverbs_alloc_mw_resp {
375 struct ib_uverbs_dealloc_mw {
379 struct ib_uverbs_create_comp_channel {
383 struct ib_uverbs_create_comp_channel_resp {
387 struct ib_uverbs_create_cq {
394 __u64 driver_data[0];
397 struct ib_uverbs_ex_create_cq {
407 struct ib_uverbs_create_cq_resp {
412 struct ib_uverbs_ex_create_cq_resp {
413 struct ib_uverbs_create_cq_resp base;
415 __u32 response_length;
418 struct ib_uverbs_resize_cq {
422 __u64 driver_data[0];
425 struct ib_uverbs_resize_cq_resp {
428 __u64 driver_data[0];
431 struct ib_uverbs_poll_cq {
437 struct ib_uverbs_wc {
445 __u32 invalidate_rkey;
458 struct ib_uverbs_poll_cq_resp {
461 struct ib_uverbs_wc wc[0];
464 struct ib_uverbs_req_notify_cq {
466 __u32 solicited_only;
469 struct ib_uverbs_destroy_cq {
475 struct ib_uverbs_destroy_cq_resp {
476 __u32 comp_events_reported;
477 __u32 async_events_reported;
480 struct ib_uverbs_global_route {
489 struct ib_uverbs_ah_attr {
490 struct ib_uverbs_global_route grh;
500 struct ib_uverbs_qp_attr {
505 __u32 path_mig_state;
510 __u32 qp_access_flags;
512 struct ib_uverbs_ah_attr ah_attr;
513 struct ib_uverbs_ah_attr alt_ah_attr;
520 __u32 max_inline_data;
523 __u16 alt_pkey_index;
524 __u8 en_sqd_async_notify;
527 __u8 max_dest_rd_atomic;
538 struct ib_uverbs_create_qp {
542 __u32 send_cq_handle;
543 __u32 recv_cq_handle;
549 __u32 max_inline_data;
554 __u64 driver_data[0];
557 enum ib_uverbs_create_qp_mask {
558 IB_UVERBS_CREATE_QP_MASK_IND_TABLE = 1UL << 0,
562 IB_UVERBS_CREATE_QP_SUP_COMP_MASK = IB_UVERBS_CREATE_QP_MASK_IND_TABLE,
567 * This value is equal to IB_QP_DEST_QPN.
569 IB_USER_LEGACY_LAST_QP_ATTR_MASK = 1ULL << 20,
574 * This value is equal to IB_QP_RATE_LIMIT.
576 IB_USER_LAST_QP_ATTR_MASK = 1ULL << 25,
579 struct ib_uverbs_ex_create_qp {
582 __u32 send_cq_handle;
583 __u32 recv_cq_handle;
589 __u32 max_inline_data;
596 __u32 rwq_ind_tbl_handle;
600 struct ib_uverbs_open_qp {
607 __u64 driver_data[0];
610 /* also used for open response */
611 struct ib_uverbs_create_qp_resp {
618 __u32 max_inline_data;
622 struct ib_uverbs_ex_create_qp_resp {
623 struct ib_uverbs_create_qp_resp base;
625 __u32 response_length;
629 * This struct needs to remain a multiple of 8 bytes to keep the
630 * alignment of the modify QP parameters.
632 struct ib_uverbs_qp_dest {
647 struct ib_uverbs_query_qp {
651 __u64 driver_data[0];
654 struct ib_uverbs_query_qp_resp {
655 struct ib_uverbs_qp_dest dest;
656 struct ib_uverbs_qp_dest alt_dest;
661 __u32 max_inline_data;
666 __u32 qp_access_flags;
668 __u16 alt_pkey_index;
675 __u8 max_dest_rd_atomic;
685 __u64 driver_data[0];
688 struct ib_uverbs_modify_qp {
689 struct ib_uverbs_qp_dest dest;
690 struct ib_uverbs_qp_dest alt_dest;
697 __u32 qp_access_flags;
699 __u16 alt_pkey_index;
704 __u8 en_sqd_async_notify;
706 __u8 max_dest_rd_atomic;
715 __u64 driver_data[0];
718 struct ib_uverbs_ex_modify_qp {
719 struct ib_uverbs_modify_qp base;
724 struct ib_uverbs_modify_qp_resp {
727 struct ib_uverbs_ex_modify_qp_resp {
729 __u32 response_length;
732 struct ib_uverbs_destroy_qp {
738 struct ib_uverbs_destroy_qp_resp {
739 __u32 events_reported;
743 * The ib_uverbs_sge structure isn't used anywhere, since we assume
744 * the ib_sge structure is packed the same way on 32-bit and 64-bit
745 * architectures in both kernel and user space. It's just here to
748 struct ib_uverbs_sge {
754 enum ib_uverbs_wr_opcode {
755 IB_UVERBS_WR_RDMA_WRITE = 0,
756 IB_UVERBS_WR_RDMA_WRITE_WITH_IMM = 1,
757 IB_UVERBS_WR_SEND = 2,
758 IB_UVERBS_WR_SEND_WITH_IMM = 3,
759 IB_UVERBS_WR_RDMA_READ = 4,
760 IB_UVERBS_WR_ATOMIC_CMP_AND_SWP = 5,
761 IB_UVERBS_WR_ATOMIC_FETCH_AND_ADD = 6,
762 IB_UVERBS_WR_LOCAL_INV = 7,
763 IB_UVERBS_WR_BIND_MW = 8,
764 IB_UVERBS_WR_SEND_WITH_INV = 9,
765 IB_UVERBS_WR_TSO = 10,
766 IB_UVERBS_WR_RDMA_READ_WITH_INV = 11,
767 IB_UVERBS_WR_MASKED_ATOMIC_CMP_AND_SWP = 12,
768 IB_UVERBS_WR_MASKED_ATOMIC_FETCH_AND_ADD = 13,
769 /* Review enum ib_wr_opcode before modifying this */
772 struct ib_uverbs_send_wr {
775 __u32 opcode; /* see enum ib_uverbs_wr_opcode */
779 __u32 invalidate_rkey;
803 struct ib_uverbs_post_send {
809 struct ib_uverbs_send_wr send_wr[0];
812 struct ib_uverbs_post_send_resp {
816 struct ib_uverbs_recv_wr {
822 struct ib_uverbs_post_recv {
828 struct ib_uverbs_recv_wr recv_wr[0];
831 struct ib_uverbs_post_recv_resp {
835 struct ib_uverbs_post_srq_recv {
841 struct ib_uverbs_recv_wr recv[0];
844 struct ib_uverbs_post_srq_recv_resp {
848 struct ib_uverbs_create_ah {
853 struct ib_uverbs_ah_attr attr;
856 struct ib_uverbs_create_ah_resp {
860 struct ib_uverbs_destroy_ah {
864 struct ib_uverbs_attach_mcast {
869 __u64 driver_data[0];
872 struct ib_uverbs_detach_mcast {
877 __u64 driver_data[0];
880 struct ib_uverbs_flow_spec_hdr {
884 /* followed by flow_spec */
885 __u64 flow_spec_data[0];
888 struct ib_uverbs_flow_eth_filter {
895 struct ib_uverbs_flow_spec_eth {
897 struct ib_uverbs_flow_spec_hdr hdr;
904 struct ib_uverbs_flow_eth_filter val;
905 struct ib_uverbs_flow_eth_filter mask;
908 struct ib_uverbs_flow_ipv4_filter {
917 struct ib_uverbs_flow_spec_ipv4 {
919 struct ib_uverbs_flow_spec_hdr hdr;
926 struct ib_uverbs_flow_ipv4_filter val;
927 struct ib_uverbs_flow_ipv4_filter mask;
930 struct ib_uverbs_flow_tcp_udp_filter {
935 struct ib_uverbs_flow_spec_tcp_udp {
937 struct ib_uverbs_flow_spec_hdr hdr;
944 struct ib_uverbs_flow_tcp_udp_filter val;
945 struct ib_uverbs_flow_tcp_udp_filter mask;
948 struct ib_uverbs_flow_ipv6_filter {
958 struct ib_uverbs_flow_spec_ipv6 {
960 struct ib_uverbs_flow_spec_hdr hdr;
967 struct ib_uverbs_flow_ipv6_filter val;
968 struct ib_uverbs_flow_ipv6_filter mask;
971 struct ib_uverbs_flow_spec_action_tag {
973 struct ib_uverbs_flow_spec_hdr hdr;
984 struct ib_uverbs_flow_spec_action_drop {
986 struct ib_uverbs_flow_spec_hdr hdr;
995 struct ib_uverbs_flow_tunnel_filter {
999 struct ib_uverbs_flow_spec_tunnel {
1001 struct ib_uverbs_flow_spec_hdr hdr;
1008 struct ib_uverbs_flow_tunnel_filter val;
1009 struct ib_uverbs_flow_tunnel_filter mask;
1012 struct ib_uverbs_flow_attr {
1020 /* Following are the optional layers according to user request
1021 * struct ib_flow_spec_xxx
1022 * struct ib_flow_spec_yyy
1024 struct ib_uverbs_flow_spec_hdr flow_specs[0];
1027 struct ib_uverbs_create_flow {
1030 struct ib_uverbs_flow_attr flow_attr;
1033 struct ib_uverbs_create_flow_resp {
1038 struct ib_uverbs_destroy_flow {
1043 struct ib_uverbs_create_srq {
1050 __u64 driver_data[0];
1053 struct ib_uverbs_create_xsrq {
1064 __u64 driver_data[0];
1067 struct ib_uverbs_create_srq_resp {
1074 struct ib_uverbs_modify_srq {
1079 __u64 driver_data[0];
1082 struct ib_uverbs_query_srq {
1086 __u64 driver_data[0];
1089 struct ib_uverbs_query_srq_resp {
1096 struct ib_uverbs_destroy_srq {
1102 struct ib_uverbs_destroy_srq_resp {
1103 __u32 events_reported;
1106 struct ib_uverbs_ex_create_wq {
1114 __u32 create_flags; /* Use enum ib_wq_flags */
1118 struct ib_uverbs_ex_create_wq_resp {
1120 __u32 response_length;
1127 struct ib_uverbs_ex_destroy_wq {
1132 struct ib_uverbs_ex_destroy_wq_resp {
1134 __u32 response_length;
1135 __u32 events_reported;
1139 struct ib_uverbs_ex_modify_wq {
1143 __u32 curr_wq_state;
1144 __u32 flags; /* Use enum ib_wq_flags */
1145 __u32 flags_mask; /* Use enum ib_wq_flags */
1148 /* Prevent memory allocation rather than max expected size */
1149 #define IB_USER_VERBS_MAX_LOG_IND_TBL_SIZE 0x0d
1150 struct ib_uverbs_ex_create_rwq_ind_table {
1152 __u32 log_ind_tbl_size;
1153 /* Following are the wq handles according to log_ind_tbl_size
1157 __u32 wq_handles[0];
1160 struct ib_uverbs_ex_create_rwq_ind_table_resp {
1162 __u32 response_length;
1163 __u32 ind_tbl_handle;
1167 struct ib_uverbs_ex_destroy_rwq_ind_table {
1169 __u32 ind_tbl_handle;
1172 #define IB_DEVICE_NAME_MAX 64
1174 #endif /* IB_USER_VERBS_H */