xref: /linux-6.15/include/uapi/rdma/rdma_user_cm.h (revision eebe4c3a)
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_IP,
49 	RDMA_USER_CM_CMD_RESOLVE_IP,
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_IP_MCAST,
63 	RDMA_USER_CM_CMD_LEAVE_MCAST,
64 	RDMA_USER_CM_CMD_MIGRATE_ID,
65 	RDMA_USER_CM_CMD_QUERY,
66 	RDMA_USER_CM_CMD_BIND
67 };
68 
69 /*
70  * command ABI structures.
71  */
72 struct rdma_ucm_cmd_hdr {
73 	__u32 cmd;
74 	__u16 in;
75 	__u16 out;
76 };
77 
78 struct rdma_ucm_create_id {
79 	__u64 uid;
80 	__u64 response;
81 	__u16 ps;
82 	__u8  qp_type;
83 	__u8  reserved[5];
84 };
85 
86 struct rdma_ucm_create_id_resp {
87 	__u32 id;
88 };
89 
90 struct rdma_ucm_destroy_id {
91 	__u64 response;
92 	__u32 id;
93 	__u32 reserved;
94 };
95 
96 struct rdma_ucm_destroy_id_resp {
97 	__u32 events_reported;
98 };
99 
100 struct rdma_ucm_bind_ip {
101 	__u64 response;
102 	struct sockaddr_in6 addr;
103 	__u32 id;
104 };
105 
106 struct rdma_ucm_bind {
107 	__u32 id;
108 	__u16 addr_size;
109 	__u16 reserved;
110 	struct sockaddr_storage addr;
111 };
112 
113 struct rdma_ucm_resolve_ip {
114 	struct sockaddr_in6 src_addr;
115 	struct sockaddr_in6 dst_addr;
116 	__u32 id;
117 	__u32 timeout_ms;
118 };
119 
120 struct rdma_ucm_resolve_route {
121 	__u32 id;
122 	__u32 timeout_ms;
123 };
124 
125 enum {
126 	RDMA_USER_CM_QUERY_ADDR,
127 	RDMA_USER_CM_QUERY_PATH,
128 	RDMA_USER_CM_QUERY_GID
129 };
130 
131 struct rdma_ucm_query {
132 	__u64 response;
133 	__u32 id;
134 	__u32 option;
135 };
136 
137 struct rdma_ucm_query_route_resp {
138 	__u64 node_guid;
139 	struct ib_user_path_rec ib_route[2];
140 	struct sockaddr_in6 src_addr;
141 	struct sockaddr_in6 dst_addr;
142 	__u32 num_paths;
143 	__u8 port_num;
144 	__u8 reserved[3];
145 };
146 
147 struct rdma_ucm_query_addr_resp {
148 	__u64 node_guid;
149 	__u8  port_num;
150 	__u8  reserved;
151 	__u16 pkey;
152 	__u16 src_size;
153 	__u16 dst_size;
154 	struct sockaddr_storage src_addr;
155 	struct sockaddr_storage dst_addr;
156 };
157 
158 struct rdma_ucm_query_path_resp {
159 	__u32 num_paths;
160 	__u32 reserved;
161 	struct ib_path_rec_data path_data[0];
162 };
163 
164 struct rdma_ucm_conn_param {
165 	__u32 qp_num;
166 	__u32 qkey;
167 	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
168 	__u8  private_data_len;
169 	__u8  srq;
170 	__u8  responder_resources;
171 	__u8  initiator_depth;
172 	__u8  flow_control;
173 	__u8  retry_count;
174 	__u8  rnr_retry_count;
175 	__u8  valid;
176 };
177 
178 struct rdma_ucm_ud_param {
179 	__u32 qp_num;
180 	__u32 qkey;
181 	struct ib_uverbs_ah_attr ah_attr;
182 	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
183 	__u8  private_data_len;
184 	__u8  reserved[7];
185 };
186 
187 struct rdma_ucm_connect {
188 	struct rdma_ucm_conn_param conn_param;
189 	__u32 id;
190 	__u32 reserved;
191 };
192 
193 struct rdma_ucm_listen {
194 	__u32 id;
195 	__u32 backlog;
196 };
197 
198 struct rdma_ucm_accept {
199 	__u64 uid;
200 	struct rdma_ucm_conn_param conn_param;
201 	__u32 id;
202 	__u32 reserved;
203 };
204 
205 struct rdma_ucm_reject {
206 	__u32 id;
207 	__u8  private_data_len;
208 	__u8  reserved[3];
209 	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
210 };
211 
212 struct rdma_ucm_disconnect {
213 	__u32 id;
214 };
215 
216 struct rdma_ucm_init_qp_attr {
217 	__u64 response;
218 	__u32 id;
219 	__u32 qp_state;
220 };
221 
222 struct rdma_ucm_notify {
223 	__u32 id;
224 	__u32 event;
225 };
226 
227 struct rdma_ucm_join_ip_mcast {
228 	__u64 response;		/* rdma_ucm_create_id_resp */
229 	__u64 uid;
230 	struct sockaddr_in6 addr;
231 	__u32 id;
232 };
233 
234 struct rdma_ucm_get_event {
235 	__u64 response;
236 };
237 
238 struct rdma_ucm_event_resp {
239 	__u64 uid;
240 	__u32 id;
241 	__u32 event;
242 	__u32 status;
243 	union {
244 		struct rdma_ucm_conn_param conn;
245 		struct rdma_ucm_ud_param   ud;
246 	} param;
247 };
248 
249 /* Option levels */
250 enum {
251 	RDMA_OPTION_ID		= 0,
252 	RDMA_OPTION_IB		= 1
253 };
254 
255 /* Option details */
256 enum {
257 	RDMA_OPTION_ID_TOS	 = 0,
258 	RDMA_OPTION_ID_REUSEADDR = 1,
259 	RDMA_OPTION_ID_AFONLY	 = 2,
260 	RDMA_OPTION_IB_PATH	 = 1
261 };
262 
263 struct rdma_ucm_set_option {
264 	__u64 optval;
265 	__u32 id;
266 	__u32 level;
267 	__u32 optname;
268 	__u32 optlen;
269 };
270 
271 struct rdma_ucm_migrate_id {
272 	__u64 response;
273 	__u32 id;
274 	__u32 fd;
275 };
276 
277 struct rdma_ucm_migrate_resp {
278 	__u32 events_reported;
279 };
280 
281 #endif /* RDMA_USER_CM_H */
282