[linux-2.6-block.git] / include / uapi / rdma / rdma_user_cm.h

/*
 * 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
};

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

struct rdma_ucm_create_id {
	__u64 uid;
	__u64 response;
	__u16 ps;
	__u8  qp_type;
	__u8  reserved[5];
};

struct rdma_ucm_create_id_resp {
	__u32 id;
};

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

struct rdma_ucm_destroy_id_resp {
	__u32 events_reported;
};

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

struct rdma_ucm_bind {
	__u32 id;
	__u16 addr_size;
	__u16 reserved;
	struct 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 sockaddr_storage src_addr;
	struct 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 {
	__u64 response;
	__u32 id;
	__u32 option;
};

struct rdma_ucm_query_route_resp {
	__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 {
	__u64 node_guid;
	__u8  port_num;
	__u8  reserved;
	__u16 pkey;
	__u16 src_size;
	__u16 dst_size;
	struct sockaddr_storage src_addr;
	struct 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 {
	__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 {
	__u64 response;
	__u32 id;
	__u32 qp_state;
};

struct rdma_ucm_notify {
	__u32 id;
	__u32 event;
};

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

struct rdma_ucm_join_mcast {
	__u64 response;		/* rdma_ucma_create_id_resp */
	__u64 uid;
	__u32 id;
	__u16 addr_size;
	__u16 reserved;
	struct sockaddr_storage addr;
};

struct rdma_ucm_get_event {
	__u64 response;
};

struct rdma_ucm_event_resp {
	__u64 uid;
	__u32 id;
	__u32 event;
	__u32 status;
	union {
		struct rdma_ucm_conn_param conn;
		struct rdma_ucm_ud_param   ud;
	} param;
};

/* 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_IB_PATH	 = 1
};

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

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

struct rdma_ucm_migrate_resp {
	__u32 events_reported;
};

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