[mirror_iproute2.git] / rdma / include / uapi / rdma / rdma_user_cm.h

/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR Linux-OpenIB) */
/*
 * Copyright (c) 2005-2006 Intel Corporation.  All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef RDMA_USER_CM_H
#define RDMA_USER_CM_H

#include <linux/types.h>
#include <linux/socket.h>
#include <linux/in6.h>
#include <rdma/ib_user_verbs.h>
#include <rdma/ib_user_sa.h>

#define RDMA_USER_CM_ABI_VERSION	4

#define RDMA_MAX_PRIVATE_DATA		256

enum {
	RDMA_USER_CM_CMD_CREATE_ID,
	RDMA_USER_CM_CMD_DESTROY_ID,
	RDMA_USER_CM_CMD_BIND_IP,
	RDMA_USER_CM_CMD_RESOLVE_IP,
	RDMA_USER_CM_CMD_RESOLVE_ROUTE,
	RDMA_USER_CM_CMD_QUERY_ROUTE,
	RDMA_USER_CM_CMD_CONNECT,
	RDMA_USER_CM_CMD_LISTEN,
	RDMA_USER_CM_CMD_ACCEPT,
	RDMA_USER_CM_CMD_REJECT,
	RDMA_USER_CM_CMD_DISCONNECT,
	RDMA_USER_CM_CMD_INIT_QP_ATTR,
	RDMA_USER_CM_CMD_GET_EVENT,
	RDMA_USER_CM_CMD_GET_OPTION,
	RDMA_USER_CM_CMD_SET_OPTION,
	RDMA_USER_CM_CMD_NOTIFY,
	RDMA_USER_CM_CMD_JOIN_IP_MCAST,
	RDMA_USER_CM_CMD_LEAVE_MCAST,
	RDMA_USER_CM_CMD_MIGRATE_ID,
	RDMA_USER_CM_CMD_QUERY,
	RDMA_USER_CM_CMD_BIND,
	RDMA_USER_CM_CMD_RESOLVE_ADDR,
	RDMA_USER_CM_CMD_JOIN_MCAST
};

/* See IBTA Annex A11, servies ID bytes 4 & 5 */
enum rdma_ucm_port_space {
	RDMA_PS_IPOIB = 0x0002,
	RDMA_PS_IB    = 0x013F,
	RDMA_PS_TCP   = 0x0106,
	RDMA_PS_UDP   = 0x0111,
};

/*
 * command ABI structures.
 */
struct rdma_ucm_cmd_hdr {
	__u32 cmd;
	__u16 in;
	__u16 out;
};

struct rdma_ucm_create_id {
	__aligned_u64 uid;
	__aligned_u64 response;
	__u16 ps;                  /* use enum rdma_ucm_port_space */
	__u8  qp_type;
	__u8  reserved[5];
};

struct rdma_ucm_create_id_resp {
	__u32 id;
};

struct rdma_ucm_destroy_id {
	__aligned_u64 response;
	__u32 id;
	__u32 reserved;
};

struct rdma_ucm_destroy_id_resp {
	__u32 events_reported;
};

struct rdma_ucm_bind_ip {
	__aligned_u64 response;
	struct sockaddr_in6 addr;
	__u32 id;
};

struct rdma_ucm_bind {
	__u32 id;
	__u16 addr_size;
	__u16 reserved;
	struct __kernel_sockaddr_storage addr;
};

struct rdma_ucm_resolve_ip {
	struct sockaddr_in6 src_addr;
	struct sockaddr_in6 dst_addr;
	__u32 id;
	__u32 timeout_ms;
};

struct rdma_ucm_resolve_addr {
	__u32 id;
	__u32 timeout_ms;
	__u16 src_size;
	__u16 dst_size;
	__u32 reserved;
	struct __kernel_sockaddr_storage src_addr;
	struct __kernel_sockaddr_storage dst_addr;
};

struct rdma_ucm_resolve_route {
	__u32 id;
	__u32 timeout_ms;
};

enum {
	RDMA_USER_CM_QUERY_ADDR,
	RDMA_USER_CM_QUERY_PATH,
	RDMA_USER_CM_QUERY_GID
};

struct rdma_ucm_query {
	__aligned_u64 response;
	__u32 id;
	__u32 option;
};

struct rdma_ucm_query_route_resp {
	__aligned_u64 node_guid;
	struct ib_user_path_rec ib_route[2];
	struct sockaddr_in6 src_addr;
	struct sockaddr_in6 dst_addr;
	__u32 num_paths;
	__u8 port_num;
	__u8 reserved[3];
};

struct rdma_ucm_query_addr_resp {
	__aligned_u64 node_guid;
	__u8  port_num;
	__u8  reserved;
	__u16 pkey;
	__u16 src_size;
	__u16 dst_size;
	struct __kernel_sockaddr_storage src_addr;
	struct __kernel_sockaddr_storage dst_addr;
};

struct rdma_ucm_query_path_resp {
	__u32 num_paths;
	__u32 reserved;
	struct ib_path_rec_data path_data[0];
};

struct rdma_ucm_conn_param {
	__u32 qp_num;
	__u32 qkey;
	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
	__u8  private_data_len;
	__u8  srq;
	__u8  responder_resources;
	__u8  initiator_depth;
	__u8  flow_control;
	__u8  retry_count;
	__u8  rnr_retry_count;
	__u8  valid;
};

struct rdma_ucm_ud_param {
	__u32 qp_num;
	__u32 qkey;
	struct ib_uverbs_ah_attr ah_attr;
	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
	__u8  private_data_len;
	__u8  reserved[7];
};

struct rdma_ucm_connect {
	struct rdma_ucm_conn_param conn_param;
	__u32 id;
	__u32 reserved;
};

struct rdma_ucm_listen {
	__u32 id;
	__u32 backlog;
};

struct rdma_ucm_accept {
	__aligned_u64 uid;
	struct rdma_ucm_conn_param conn_param;
	__u32 id;
	__u32 reserved;
};

struct rdma_ucm_reject {
	__u32 id;
	__u8  private_data_len;
	__u8  reserved[3];
	__u8  private_data[RDMA_MAX_PRIVATE_DATA];
};

struct rdma_ucm_disconnect {
	__u32 id;
};

struct rdma_ucm_init_qp_attr {
	__aligned_u64 response;
	__u32 id;
	__u32 qp_state;
};

struct rdma_ucm_notify {
	__u32 id;
	__u32 event;
};

struct rdma_ucm_join_ip_mcast {
	__aligned_u64 response;		/* rdma_ucm_create_id_resp */
	__aligned_u64 uid;
	struct sockaddr_in6 addr;
	__u32 id;
};

/* Multicast join flags */
enum {
	RDMA_MC_JOIN_FLAG_FULLMEMBER,
	RDMA_MC_JOIN_FLAG_SENDONLY_FULLMEMBER,
	RDMA_MC_JOIN_FLAG_RESERVED,
};

struct rdma_ucm_join_mcast {
	__aligned_u64 response;		/* rdma_ucma_create_id_resp */
	__aligned_u64 uid;
	__u32 id;
	__u16 addr_size;
	__u16 join_flags;
	struct __kernel_sockaddr_storage addr;
};

struct rdma_ucm_get_event {
	__aligned_u64 response;
};

struct rdma_ucm_event_resp {
	__aligned_u64 uid;
	__u32 id;
	__u32 event;
	__u32 status;
	/*
	 * NOTE: This union is not aligned to 8 bytes so none of the union
	 * members may contain a u64 or anything with higher alignment than 4.
	 */
	union {
		struct rdma_ucm_conn_param conn;
		struct rdma_ucm_ud_param   ud;
	} param;
	__u32 reserved;
};

/* Option levels */
enum {
	RDMA_OPTION_ID		= 0,
	RDMA_OPTION_IB		= 1
};

/* Option details */
enum {
	RDMA_OPTION_ID_TOS	 = 0,
	RDMA_OPTION_ID_REUSEADDR = 1,
	RDMA_OPTION_ID_AFONLY	 = 2,
	RDMA_OPTION_ID_ACK_TIMEOUT = 3
};

enum {
	RDMA_OPTION_IB_PATH	 = 1
};

struct rdma_ucm_set_option {
	__aligned_u64 optval;
	__u32 id;
	__u32 level;
	__u32 optname;
	__u32 optlen;
};

struct rdma_ucm_migrate_id {
	__aligned_u64 response;
	__u32 id;
	__u32 fd;
};

struct rdma_ucm_migrate_resp {
	__u32 events_reported;
};

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