sys/ofed/include/rdma/rdma_cm.h

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