include/uapi/rdma/rdma_user_cm.h

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