xref: /freebsd/sys/ofed/include/uapi/rdma/rdma_user_cm.h (revision d8a0fe102c0cfdfcd5b818f850eff09d8536c9bc)
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 #ifdef _KERNEL
37 #include <linux/types.h>
38 #include <linux/socket.h>
39 #include <linux/in6.h>
40 #else
41 #include <infiniband/types.h>
42 #include <netinet/in.h>
43 #endif
44 
45 #include <rdma/ib_user_verbs.h>
46 #include <rdma/ib_user_sa.h>
47 
48 #define RDMA_USER_CM_ABI_VERSION	4
49 
50 #define RDMA_MAX_PRIVATE_DATA		256
51 
52 enum {
53 	RDMA_USER_CM_CMD_CREATE_ID,
54 	RDMA_USER_CM_CMD_DESTROY_ID,
55 	RDMA_USER_CM_CMD_BIND_IP,
56 	RDMA_USER_CM_CMD_RESOLVE_IP,
57 	RDMA_USER_CM_CMD_RESOLVE_ROUTE,
58 	RDMA_USER_CM_CMD_QUERY_ROUTE,
59 	RDMA_USER_CM_CMD_CONNECT,
60 	RDMA_USER_CM_CMD_LISTEN,
61 	RDMA_USER_CM_CMD_ACCEPT,
62 	RDMA_USER_CM_CMD_REJECT,
63 	RDMA_USER_CM_CMD_DISCONNECT,
64 	RDMA_USER_CM_CMD_INIT_QP_ATTR,
65 	RDMA_USER_CM_CMD_GET_EVENT,
66 	RDMA_USER_CM_CMD_GET_OPTION,
67 	RDMA_USER_CM_CMD_SET_OPTION,
68 	RDMA_USER_CM_CMD_NOTIFY,
69 	RDMA_USER_CM_CMD_JOIN_IP_MCAST,
70 	RDMA_USER_CM_CMD_LEAVE_MCAST,
71 	RDMA_USER_CM_CMD_MIGRATE_ID,
72 	RDMA_USER_CM_CMD_QUERY,
73 	RDMA_USER_CM_CMD_BIND,
74 	RDMA_USER_CM_CMD_RESOLVE_ADDR,
75 	RDMA_USER_CM_CMD_JOIN_MCAST
76 };
77 
78 /*
79  * command ABI structures.
80  */
81 struct rdma_ucm_cmd_hdr {
82 	__u32 cmd;
83 	__u16 in;
84 	__u16 out;
85 };
86 
87 struct rdma_ucm_create_id {
88 	__u64 uid;
89 	__u64 response;
90 	__u16 ps;
91 	__u8  qp_type;
92 	__u8  reserved[5];
93 };
94 
95 struct rdma_ucm_create_id_resp {
96 	__u32 id;
97 };
98 
99 struct rdma_ucm_destroy_id {
100 	__u64 response;
101 	__u32 id;
102 	__u32 reserved;
103 };
104 
105 struct rdma_ucm_destroy_id_resp {
106 	__u32 events_reported;
107 };
108 
109 struct rdma_ucm_bind_ip {
110 	__u64 response;
111 	struct sockaddr_in6 addr;
112 	__u32 id;
113 };
114 
115 struct rdma_ucm_bind {
116 	__u32 id;
117 	__u16 addr_size;
118 	__u16 reserved;
119 	struct sockaddr_storage addr;
120 };
121 
122 struct rdma_ucm_resolve_ip {
123 	struct sockaddr_in6 src_addr;
124 	struct sockaddr_in6 dst_addr;
125 	__u32 id;
126 	__u32 timeout_ms;
127 };
128 
129 struct rdma_ucm_resolve_addr {
130 	__u32 id;
131 	__u32 timeout_ms;
132 	__u16 src_size;
133 	__u16 dst_size;
134 	__u32 reserved;
135 	struct sockaddr_storage src_addr;
136 	struct sockaddr_storage dst_addr;
137 };
138 
139 struct rdma_ucm_resolve_route {
140 	__u32 id;
141 	__u32 timeout_ms;
142 };
143 
144 enum {
145 	RDMA_USER_CM_QUERY_ADDR,
146 	RDMA_USER_CM_QUERY_PATH,
147 	RDMA_USER_CM_QUERY_GID
148 };
149 
150 struct rdma_ucm_query {
151 	__u64 response;
152 	__u32 id;
153 	__u32 option;
154 };
155 
156 struct rdma_ucm_query_route_resp {
157 	__u64 node_guid;
158 	struct ib_user_path_rec ib_route[2];
159 	struct sockaddr_in6 src_addr;
160 	struct sockaddr_in6 dst_addr;
161 	__u32 num_paths;
162 	__u8 port_num;
163 	__u8 reserved[3];
164 };
165 
166 struct rdma_ucm_query_addr_resp {
167 	__u64 node_guid;
168 	__u8  port_num;
169 	__u8  reserved;
170 	__u16 pkey;
171 	__u16 src_size;
172 	__u16 dst_size;
173 	struct sockaddr_storage src_addr;
174 	struct sockaddr_storage dst_addr;
175 };
176 
177 struct rdma_ucm_query_path_resp {
178 	__u32 num_paths;
179 	__u32 reserved;
180 	struct ib_path_rec_data path_data[0];
181 };
182 
183 struct rdma_ucm_conn_param {
184 	__u32 qp_num;
185 	__u32 qkey;
186 	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
187 	__u8  private_data_len;
188 	__u8  srq;
189 	__u8  responder_resources;
190 	__u8  initiator_depth;
191 	__u8  flow_control;
192 	__u8  retry_count;
193 	__u8  rnr_retry_count;
194 	__u8  valid;
195 };
196 
197 struct rdma_ucm_ud_param {
198 	__u32 qp_num;
199 	__u32 qkey;
200 	struct ib_uverbs_ah_attr ah_attr;
201 	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
202 	__u8  private_data_len;
203 	__u8  reserved[7];
204 };
205 
206 struct rdma_ucm_connect {
207 	struct rdma_ucm_conn_param conn_param;
208 	__u32 id;
209 	__u32 reserved;
210 };
211 
212 struct rdma_ucm_listen {
213 	__u32 id;
214 	__u32 backlog;
215 };
216 
217 struct rdma_ucm_accept {
218 	__u64 uid;
219 	struct rdma_ucm_conn_param conn_param;
220 	__u32 id;
221 	__u32 reserved;
222 };
223 
224 struct rdma_ucm_reject {
225 	__u32 id;
226 	__u8  private_data_len;
227 	__u8  reserved[3];
228 	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
229 };
230 
231 struct rdma_ucm_disconnect {
232 	__u32 id;
233 };
234 
235 struct rdma_ucm_init_qp_attr {
236 	__u64 response;
237 	__u32 id;
238 	__u32 qp_state;
239 };
240 
241 struct rdma_ucm_notify {
242 	__u32 id;
243 	__u32 event;
244 };
245 
246 struct rdma_ucm_join_ip_mcast {
247 	__u64 response;		/* rdma_ucm_create_id_resp */
248 	__u64 uid;
249 	struct sockaddr_in6 addr;
250 	__u32 id;
251 };
252 
253 /* Multicast join flags */
254 enum {
255 	RDMA_MC_JOIN_FLAG_FULLMEMBER,
256 	RDMA_MC_JOIN_FLAG_SENDONLY_FULLMEMBER,
257 	RDMA_MC_JOIN_FLAG_RESERVED,
258 };
259 
260 struct rdma_ucm_join_mcast {
261 	__u64 response;		/* rdma_ucma_create_id_resp */
262 	__u64 uid;
263 	__u32 id;
264 	__u16 addr_size;
265 	__u16 join_flags;
266 	struct sockaddr_storage addr;
267 };
268 
269 struct rdma_ucm_get_event {
270 	__u64 response;
271 };
272 
273 struct rdma_ucm_event_resp {
274 	__u64 uid;
275 	__u32 id;
276 	__u32 event;
277 	__u32 status;
278 	union {
279 		struct rdma_ucm_conn_param conn;
280 		struct rdma_ucm_ud_param   ud;
281 	} param;
282 };
283 
284 /* Option levels */
285 enum {
286 	RDMA_OPTION_ID		= 0,
287 	RDMA_OPTION_IB		= 1
288 };
289 
290 /* Option details */
291 enum {
292 	RDMA_OPTION_ID_TOS	 = 0,
293 	RDMA_OPTION_ID_REUSEADDR = 1,
294 	RDMA_OPTION_ID_AFONLY	 = 2,
295 	RDMA_OPTION_IB_PATH	 = 1
296 };
297 
298 struct rdma_ucm_set_option {
299 	__u64 optval;
300 	__u32 id;
301 	__u32 level;
302 	__u32 optname;
303 	__u32 optlen;
304 };
305 
306 struct rdma_ucm_migrate_id {
307 	__u64 response;
308 	__u32 id;
309 	__u32 fd;
310 };
311 
312 struct rdma_ucm_migrate_resp {
313 	__u32 events_reported;
314 };
315 
316 #endif /* RDMA_USER_CM_H */
317