include/rdma/rdma_cm.h

   1 /*
   2  * Copyright (c) 2005 Voltaire Inc.  All rights reserved.
   3  * Copyright (c) 2005 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
  34 #if !defined(RDMA_CM_H)
  35 #define RDMA_CM_H
  36
  37 #include <linux/socket.h>
  38 #include <linux/in6.h>
  39 #include <rdma/ib_addr.h>
  40 #include <rdma/ib_sa.h>
  41
  42 /*
  43  * Upon receiving a device removal event, users must destroy the associated
  44  * RDMA identifier and release all resources allocated with the device.
  45  */
  46 enum rdma_cm_event_type {
  47         RDMA_CM_EVENT_ADDR_RESOLVED,
  48         RDMA_CM_EVENT_ADDR_ERROR,
  49         RDMA_CM_EVENT_ROUTE_RESOLVED,
  50         RDMA_CM_EVENT_ROUTE_ERROR,
  51         RDMA_CM_EVENT_CONNECT_REQUEST,
  52         RDMA_CM_EVENT_CONNECT_RESPONSE,
  53         RDMA_CM_EVENT_CONNECT_ERROR,
  54         RDMA_CM_EVENT_UNREACHABLE,
  55         RDMA_CM_EVENT_REJECTED,
  56         RDMA_CM_EVENT_ESTABLISHED,
  57         RDMA_CM_EVENT_DISCONNECTED,
  58         RDMA_CM_EVENT_DEVICE_REMOVAL,
  59         RDMA_CM_EVENT_MULTICAST_JOIN,
  60         RDMA_CM_EVENT_MULTICAST_ERROR,
  61         RDMA_CM_EVENT_ADDR_CHANGE,
  62         RDMA_CM_EVENT_TIMEWAIT_EXIT
  63 };
  64
  65 enum rdma_port_space {
  66         RDMA_PS_SDP   = 0x0001,
  67         RDMA_PS_IPOIB = 0x0002,
  68         RDMA_PS_IB    = 0x013F,
  69         RDMA_PS_TCP   = 0x0106,
  70         RDMA_PS_UDP   = 0x0111,
  71 };
  72
  73 #define RDMA_IB_IP_PS_MASK   0xFFFFFFFFFFFF0000ULL
  74 #define RDMA_IB_IP_PS_TCP    0x0000000001060000ULL
  75 #define RDMA_IB_IP_PS_UDP    0x0000000001110000ULL
  76 #define RDMA_IB_IP_PS_IB     0x00000000013F0000ULL
  77
  78 struct rdma_addr {
  79         struct sockaddr_storage src_addr;
  80         struct sockaddr_storage dst_addr;
  81         struct rdma_dev_addr dev_addr;
  82 };
  83
  84 struct rdma_route {
  85         struct rdma_addr addr;
  86         struct ib_sa_path_rec *path_rec;
  87         int num_paths;
  88 };
  89
  90 struct rdma_conn_param {
  91         const void *private_data;
  92         u8 private_data_len;
  93         u8 responder_resources;
  94         u8 initiator_depth;
  95         u8 flow_control;
  96         u8 retry_count;         /* ignored when accepting */
  97         u8 rnr_retry_count;
  98         /* Fields below ignored if a QP is created on the rdma_cm_id. */
  99         u8 srq;
 100         u32 qp_num;
 101 };
 102
 103 struct rdma_ud_param {
 104         const void *private_data;
 105         u8 private_data_len;
 106         struct ib_ah_attr ah_attr;
 107         u32 qp_num;
 108         u32 qkey;
 109 };
 110
 111 struct rdma_cm_event {
 112         enum rdma_cm_event_type  event;
 113         int                      status;
 114         union {
 115                 struct rdma_conn_param  conn;
 116                 struct rdma_ud_param    ud;
 117         } param;
 118 };
 119
 120 enum rdma_cm_state {
 121         RDMA_CM_IDLE,
 122         RDMA_CM_ADDR_QUERY,
 123         RDMA_CM_ADDR_RESOLVED,
 124         RDMA_CM_ROUTE_QUERY,
 125         RDMA_CM_ROUTE_RESOLVED,
 126         RDMA_CM_CONNECT,
 127         RDMA_CM_DISCONNECT,
 128         RDMA_CM_ADDR_BOUND,
 129         RDMA_CM_LISTEN,
 130         RDMA_CM_DEVICE_REMOVAL,
 131         RDMA_CM_DESTROYING
 132 };
 133
 134 struct rdma_cm_id;
 135
 136 /**
 137  * rdma_cm_event_handler - Callback used to report user events.
 138  *
 139  * Notes: Users may not call rdma_destroy_id from this callback to destroy
 140  *   the passed in id, or a corresponding listen id.  Returning a
 141  *   non-zero value from the callback will destroy the passed in id.
 142  */
 143 typedef int (*rdma_cm_event_handler)(struct rdma_cm_id *id,
 144                                      struct rdma_cm_event *event);
 145
 146 struct rdma_cm_id {
 147         struct ib_device        *device;
 148         void                    *context;
 149         struct ib_qp            *qp;
 150         rdma_cm_event_handler    event_handler;
 151         struct rdma_route        route;
 152         enum rdma_port_space     ps;
 153         enum ib_qp_type          qp_type;
 154         u8                       port_num;
 155 };
 156
 157 /**
 158  * rdma_create_id - Create an RDMA identifier.
 159  *
 160  * @event_handler: User callback invoked to report events associated with the
 161  *   returned rdma_id.
 162  * @context: User specified context associated with the id.
 163  * @ps: RDMA port space.
 164  * @qp_type: type of queue pair associated with the id.
 165  */
 166 struct rdma_cm_id *rdma_create_id(rdma_cm_event_handler event_handler,
 167                                   void *context, enum rdma_port_space ps,
 168                                   enum ib_qp_type qp_type);
 169
 170 /**
 171   * rdma_destroy_id - Destroys an RDMA identifier.
 172   *
 173   * @id: RDMA identifier.
 174   *
 175   * Note: calling this function has the effect of canceling in-flight
 176   * asynchronous operations associated with the id.
 177   */
 178 void rdma_destroy_id(struct rdma_cm_id *id);
 179
 180 /**
 181  * rdma_bind_addr - Bind an RDMA identifier to a source address and
 182  *   associated RDMA device, if needed.
 183  *
 184  * @id: RDMA identifier.
 185  * @addr: Local address information.  Wildcard values are permitted.
 186  *
 187  * This associates a source address with the RDMA identifier before calling
 188  * rdma_listen.  If a specific local address is given, the RDMA identifier will
 189  * be bound to a local RDMA device.
 190  */
 191 int rdma_bind_addr(struct rdma_cm_id *id, struct sockaddr *addr);
 192
 193 /**
 194  * rdma_resolve_addr - Resolve destination and optional source addresses
 195  *   from IP addresses to an RDMA address.  If successful, the specified
 196  *   rdma_cm_id will be bound to a local device.
 197  *
 198  * @id: RDMA identifier.
 199  * @src_addr: Source address information.  This parameter may be NULL.
 200  * @dst_addr: Destination address information.
 201  * @timeout_ms: Time to wait for resolution to complete.
 202  */
 203 int rdma_resolve_addr(struct rdma_cm_id *id, struct sockaddr *src_addr,
 204                       struct sockaddr *dst_addr, int timeout_ms);
 205
 206 /**
 207  * rdma_resolve_route - Resolve the RDMA address bound to the RDMA identifier
 208  *   into route information needed to establish a connection.
 209  *
 210  * This is called on the client side of a connection.
 211  * Users must have first called rdma_resolve_addr to resolve a dst_addr
 212  * into an RDMA address before calling this routine.
 213  */
 214 int rdma_resolve_route(struct rdma_cm_id *id, int timeout_ms);
 215
 216 /**
 217  * rdma_create_qp - Allocate a QP and associate it with the specified RDMA
 218  * identifier.
 219  *
 220  * QPs allocated to an rdma_cm_id will automatically be transitioned by the CMA
 221  * through their states.
 222  */
 223 int rdma_create_qp(struct rdma_cm_id *id, struct ib_pd *pd,
 224                    struct ib_qp_init_attr *qp_init_attr);
 225
 226 /**
 227  * rdma_destroy_qp - Deallocate the QP associated with the specified RDMA
 228  * identifier.
 229  *
 230  * Users must destroy any QP associated with an RDMA identifier before
 231  * destroying the RDMA ID.
 232  */
 233 void rdma_destroy_qp(struct rdma_cm_id *id);
 234
 235 /**
 236  * rdma_init_qp_attr - Initializes the QP attributes for use in transitioning
 237  *   to a specified QP state.
 238  * @id: Communication identifier associated with the QP attributes to
 239  *   initialize.
 240  * @qp_attr: On input, specifies the desired QP state.  On output, the
 241  *   mandatory and desired optional attributes will be set in order to
 242  *   modify the QP to the specified state.
 243  * @qp_attr_mask: The QP attribute mask that may be used to transition the
 244  *   QP to the specified state.
 245  *
 246  * Users must set the @qp_attr->qp_state to the desired QP state.  This call
 247  * will set all required attributes for the given transition, along with
 248  * known optional attributes.  Users may override the attributes returned from
 249  * this call before calling ib_modify_qp.
 250  *
 251  * Users that wish to have their QP automatically transitioned through its
 252  * states can associate a QP with the rdma_cm_id by calling rdma_create_qp().
 253  */
 254 int rdma_init_qp_attr(struct rdma_cm_id *id, struct ib_qp_attr *qp_attr,
 255                        int *qp_attr_mask);
 256
 257 /**
 258  * rdma_connect - Initiate an active connection request.
 259  * @id: Connection identifier to connect.
 260  * @conn_param: Connection information used for connected QPs.
 261  *
 262  * Users must have resolved a route for the rdma_cm_id to connect with
 263  * by having called rdma_resolve_route before calling this routine.
 264  *
 265  * This call will either connect to a remote QP or obtain remote QP
 266  * information for unconnected rdma_cm_id's.  The actual operation is
 267  * based on the rdma_cm_id's port space.
 268  */
 269 int rdma_connect(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
 270
 271 /**
 272  * rdma_listen - This function is called by the passive side to
 273  *   listen for incoming connection requests.
 274  *
 275  * Users must have bound the rdma_cm_id to a local address by calling
 276  * rdma_bind_addr before calling this routine.
 277  */
 278 int rdma_listen(struct rdma_cm_id *id, int backlog);
 279
 280 /**
 281  * rdma_accept - Called to accept a connection request or response.
 282  * @id: Connection identifier associated with the request.
 283  * @conn_param: Information needed to establish the connection.  This must be
 284  *   provided if accepting a connection request.  If accepting a connection
 285  *   response, this parameter must be NULL.
 286  *
 287  * Typically, this routine is only called by the listener to accept a connection
 288  * request.  It must also be called on the active side of a connection if the
 289  * user is performing their own QP transitions.
 290  *
 291  * In the case of error, a reject message is sent to the remote side and the
 292  * state of the qp associated with the id is modified to error, such that any
 293  * previously posted receive buffers would be flushed.
 294  */
 295 int rdma_accept(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
 296
 297 /**
 298  * rdma_notify - Notifies the RDMA CM of an asynchronous event that has
 299  * occurred on the connection.
 300  * @id: Connection identifier to transition to established.
 301  * @event: Asynchronous event.
 302  *
 303  * This routine should be invoked by users to notify the CM of relevant
 304  * communication events.  Events that should be reported to the CM and
 305  * when to report them are:
 306  *
 307  * IB_EVENT_COMM_EST - Used when a message is received on a connected
 308  *    QP before an RTU has been received.
 309  */
 310 int rdma_notify(struct rdma_cm_id *id, enum ib_event_type event);
 311
 312 /**
 313  * rdma_reject - Called to reject a connection request or response.
 314  */
 315 int rdma_reject(struct rdma_cm_id *id, const void *private_data,
 316                 u8 private_data_len);
 317
 318 /**
 319  * rdma_disconnect - This function disconnects the associated QP and
 320  *   transitions it into the error state.
 321  */
 322 int rdma_disconnect(struct rdma_cm_id *id);
 323
 324 /**
 325  * rdma_join_multicast - Join the multicast group specified by the given
 326  *   address.
 327  * @id: Communication identifier associated with the request.
 328  * @addr: Multicast address identifying the group to join.
 329  * @context: User-defined context associated with the join request, returned
 330  * to the user through the private_data pointer in multicast events.
 331  */
 332 int rdma_join_multicast(struct rdma_cm_id *id, struct sockaddr *addr,
 333                         void *context);
 334
 335 /**
 336  * rdma_leave_multicast - Leave the multicast group specified by the given
 337  *   address.
 338  */
 339 void rdma_leave_multicast(struct rdma_cm_id *id, struct sockaddr *addr);
 340
 341 /**
 342  * rdma_set_service_type - Set the type of service associated with a
 343  *   connection identifier.
 344  * @id: Communication identifier to associated with service type.
 345  * @tos: Type of service.
 346  *
 347  * The type of service is interpretted as a differentiated service
 348  * field (RFC 2474).  The service type should be specified before
 349  * performing route resolution, as existing communication on the
 350  * connection identifier may be unaffected.  The type of service
 351  * requested may not be supported by the network to all destinations.
 352  */
 353 void rdma_set_service_type(struct rdma_cm_id *id, int tos);
 354
 355 /**
 356  * rdma_set_reuseaddr - Allow the reuse of local addresses when binding
 357  *    the rdma_cm_id.
 358  * @id: Communication identifier to configure.
 359  * @reuse: Value indicating if the bound address is reusable.
 360  *
 361  * Reuse must be set before an address is bound to the id.
 362  */
 363 int rdma_set_reuseaddr(struct rdma_cm_id *id, int reuse);
 364
 365 /**
 366  * rdma_set_afonly - Specify that listens are restricted to the
 367  *    bound address family only.
 368  * @id: Communication identifer to configure.
 369  * @afonly: Value indicating if listens are restricted.
 370  *
 371  * Must be set before identifier is in the listening state.
 372  */
 373 int rdma_set_afonly(struct rdma_cm_id *id, int afonly);
 374
 375 #endif /* RDMA_CM_H */