xref: /linux-6.15/include/uapi/rdma/rdma_user_cm.h (revision edaa7a55)
1 /*
2  * Copyright (c) 2005-2006 Intel Corporation.  All rights reserved.
3  *
4  * This software is available to you under a choice of one of two
5  * licenses.  You may choose to be licensed under the terms of the GNU
6  * General Public License (GPL) Version 2, available from the file
7  * COPYING in the main directory of this source tree, or the
8  * OpenIB.org BSD license below:
9  *
10  *     Redistribution and use in source and binary forms, with or
11  *     without modification, are permitted provided that the following
12  *     conditions are met:
13  *
14  *      - Redistributions of source code must retain the above
15  *        copyright notice, this list of conditions and the following
16  *        disclaimer.
17  *
18  *      - Redistributions in binary form must reproduce the above
19  *        copyright notice, this list of conditions and the following
20  *        disclaimer in the documentation and/or other materials
21  *        provided with the distribution.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30  * SOFTWARE.
31  */
32 
33 #ifndef RDMA_USER_CM_H
34 #define RDMA_USER_CM_H
35 
36 #include <linux/types.h>
37 #include <linux/in6.h>
38 #include <rdma/ib_user_verbs.h>
39 #include <rdma/ib_user_sa.h>
40 
41 #define RDMA_USER_CM_ABI_VERSION	4
42 
43 #define RDMA_MAX_PRIVATE_DATA		256
44 
45 enum {
46 	RDMA_USER_CM_CMD_CREATE_ID,
47 	RDMA_USER_CM_CMD_DESTROY_ID,
48 	RDMA_USER_CM_CMD_BIND_ADDR,
49 	RDMA_USER_CM_CMD_RESOLVE_ADDR,
50 	RDMA_USER_CM_CMD_RESOLVE_ROUTE,
51 	RDMA_USER_CM_CMD_QUERY_ROUTE,
52 	RDMA_USER_CM_CMD_CONNECT,
53 	RDMA_USER_CM_CMD_LISTEN,
54 	RDMA_USER_CM_CMD_ACCEPT,
55 	RDMA_USER_CM_CMD_REJECT,
56 	RDMA_USER_CM_CMD_DISCONNECT,
57 	RDMA_USER_CM_CMD_INIT_QP_ATTR,
58 	RDMA_USER_CM_CMD_GET_EVENT,
59 	RDMA_USER_CM_CMD_GET_OPTION,
60 	RDMA_USER_CM_CMD_SET_OPTION,
61 	RDMA_USER_CM_CMD_NOTIFY,
62 	RDMA_USER_CM_CMD_JOIN_MCAST,
63 	RDMA_USER_CM_CMD_LEAVE_MCAST,
64 	RDMA_USER_CM_CMD_MIGRATE_ID,
65 	RDMA_USER_CM_CMD_QUERY
66 };
67 
68 /*
69  * command ABI structures.
70  */
71 struct rdma_ucm_cmd_hdr {
72 	__u32 cmd;
73 	__u16 in;
74 	__u16 out;
75 };
76 
77 struct rdma_ucm_create_id {
78 	__u64 uid;
79 	__u64 response;
80 	__u16 ps;
81 	__u8  qp_type;
82 	__u8  reserved[5];
83 };
84 
85 struct rdma_ucm_create_id_resp {
86 	__u32 id;
87 };
88 
89 struct rdma_ucm_destroy_id {
90 	__u64 response;
91 	__u32 id;
92 	__u32 reserved;
93 };
94 
95 struct rdma_ucm_destroy_id_resp {
96 	__u32 events_reported;
97 };
98 
99 struct rdma_ucm_bind_addr {
100 	__u64 response;
101 	struct sockaddr_in6 addr;
102 	__u32 id;
103 };
104 
105 struct rdma_ucm_resolve_addr {
106 	struct sockaddr_in6 src_addr;
107 	struct sockaddr_in6 dst_addr;
108 	__u32 id;
109 	__u32 timeout_ms;
110 };
111 
112 struct rdma_ucm_resolve_route {
113 	__u32 id;
114 	__u32 timeout_ms;
115 };
116 
117 enum {
118 	RDMA_USER_CM_QUERY_ADDR,
119 	RDMA_USER_CM_QUERY_PATH,
120 	RDMA_USER_CM_QUERY_GID
121 };
122 
123 struct rdma_ucm_query {
124 	__u64 response;
125 	__u32 id;
126 	__u32 option;
127 };
128 
129 struct rdma_ucm_query_route_resp {
130 	__u64 node_guid;
131 	struct ib_user_path_rec ib_route[2];
132 	struct sockaddr_in6 src_addr;
133 	struct sockaddr_in6 dst_addr;
134 	__u32 num_paths;
135 	__u8 port_num;
136 	__u8 reserved[3];
137 };
138 
139 struct rdma_ucm_query_addr_resp {
140 	__u64 node_guid;
141 	__u8  port_num;
142 	__u8  reserved;
143 	__u16 pkey;
144 	__u16 src_size;
145 	__u16 dst_size;
146 	struct sockaddr_storage src_addr;
147 	struct sockaddr_storage dst_addr;
148 };
149 
150 struct rdma_ucm_query_path_resp {
151 	__u32 num_paths;
152 	__u32 reserved;
153 	struct ib_path_rec_data path_data[0];
154 };
155 
156 struct rdma_ucm_conn_param {
157 	__u32 qp_num;
158 	__u32 qkey;
159 	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
160 	__u8  private_data_len;
161 	__u8  srq;
162 	__u8  responder_resources;
163 	__u8  initiator_depth;
164 	__u8  flow_control;
165 	__u8  retry_count;
166 	__u8  rnr_retry_count;
167 	__u8  valid;
168 };
169 
170 struct rdma_ucm_ud_param {
171 	__u32 qp_num;
172 	__u32 qkey;
173 	struct ib_uverbs_ah_attr ah_attr;
174 	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
175 	__u8  private_data_len;
176 	__u8  reserved[7];
177 };
178 
179 struct rdma_ucm_connect {
180 	struct rdma_ucm_conn_param conn_param;
181 	__u32 id;
182 	__u32 reserved;
183 };
184 
185 struct rdma_ucm_listen {
186 	__u32 id;
187 	__u32 backlog;
188 };
189 
190 struct rdma_ucm_accept {
191 	__u64 uid;
192 	struct rdma_ucm_conn_param conn_param;
193 	__u32 id;
194 	__u32 reserved;
195 };
196 
197 struct rdma_ucm_reject {
198 	__u32 id;
199 	__u8  private_data_len;
200 	__u8  reserved[3];
201 	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
202 };
203 
204 struct rdma_ucm_disconnect {
205 	__u32 id;
206 };
207 
208 struct rdma_ucm_init_qp_attr {
209 	__u64 response;
210 	__u32 id;
211 	__u32 qp_state;
212 };
213 
214 struct rdma_ucm_notify {
215 	__u32 id;
216 	__u32 event;
217 };
218 
219 struct rdma_ucm_join_mcast {
220 	__u64 response;		/* rdma_ucm_create_id_resp */
221 	__u64 uid;
222 	struct sockaddr_in6 addr;
223 	__u32 id;
224 };
225 
226 struct rdma_ucm_get_event {
227 	__u64 response;
228 };
229 
230 struct rdma_ucm_event_resp {
231 	__u64 uid;
232 	__u32 id;
233 	__u32 event;
234 	__u32 status;
235 	union {
236 		struct rdma_ucm_conn_param conn;
237 		struct rdma_ucm_ud_param   ud;
238 	} param;
239 };
240 
241 /* Option levels */
242 enum {
243 	RDMA_OPTION_ID		= 0,
244 	RDMA_OPTION_IB		= 1
245 };
246 
247 /* Option details */
248 enum {
249 	RDMA_OPTION_ID_TOS	 = 0,
250 	RDMA_OPTION_ID_REUSEADDR = 1,
251 	RDMA_OPTION_ID_AFONLY	 = 2,
252 	RDMA_OPTION_IB_PATH	 = 1
253 };
254 
255 struct rdma_ucm_set_option {
256 	__u64 optval;
257 	__u32 id;
258 	__u32 level;
259 	__u32 optname;
260 	__u32 optlen;
261 };
262 
263 struct rdma_ucm_migrate_id {
264 	__u64 response;
265 	__u32 id;
266 	__u32 fd;
267 };
268 
269 struct rdma_ucm_migrate_resp {
270 	__u32 events_reported;
271 };
272 
273 #endif /* RDMA_USER_CM_H */
274