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 #include <uapi/rdma/rdma_user_cm.h>
  42
  43 /*
  44  * Upon receiving a device removal event, users must destroy the associated
  45  * RDMA identifier and release all resources allocated with the device.
  46  */
  47 enum rdma_cm_event_type {
  48         RDMA_CM_EVENT_ADDR_RESOLVED,
  49         RDMA_CM_EVENT_ADDR_ERROR,
  50         RDMA_CM_EVENT_ROUTE_RESOLVED,
  51         RDMA_CM_EVENT_ROUTE_ERROR,
  52         RDMA_CM_EVENT_CONNECT_REQUEST,
  53         RDMA_CM_EVENT_CONNECT_RESPONSE,
  54         RDMA_CM_EVENT_CONNECT_ERROR,
  55         RDMA_CM_EVENT_UNREACHABLE,
  56         RDMA_CM_EVENT_REJECTED,
  57         RDMA_CM_EVENT_ESTABLISHED,
  58         RDMA_CM_EVENT_DISCONNECTED,
  59         RDMA_CM_EVENT_DEVICE_REMOVAL,
  60         RDMA_CM_EVENT_MULTICAST_JOIN,
  61         RDMA_CM_EVENT_MULTICAST_ERROR,
  62         RDMA_CM_EVENT_ADDR_CHANGE,
  63         RDMA_CM_EVENT_TIMEWAIT_EXIT
  64 };
  65
  66 const char *__attribute_const__ rdma_event_msg(enum rdma_cm_event_type event);
  67
  68 #define RDMA_IB_IP_PS_MASK   0xFFFFFFFFFFFF0000ULL
  69 #define RDMA_IB_IP_PS_TCP    0x0000000001060000ULL
  70 #define RDMA_IB_IP_PS_UDP    0x0000000001110000ULL
  71 #define RDMA_IB_IP_PS_IB     0x00000000013F0000ULL
  72
  73 struct rdma_addr {
  74         struct sockaddr_storage src_addr;
  75         struct sockaddr_storage dst_addr;
  76         struct rdma_dev_addr dev_addr;
  77 };
  78
  79 struct rdma_route {
  80         struct rdma_addr addr;
  81         struct sa_path_rec *path_rec;
  82         int num_paths;
  83 };
  84
  85 struct rdma_conn_param {
  86         const void *private_data;
  87         u8 private_data_len;
  88         u8 responder_resources;
  89         u8 initiator_depth;
  90         u8 flow_control;
  91         u8 retry_count;         /* ignored when accepting */
  92         u8 rnr_retry_count;
  93         /* Fields below ignored if a QP is created on the rdma_cm_id. */
  94         u8 srq;
  95         u32 qp_num;
  96         u32 qkey;
  97 };
  98
  99 struct rdma_ud_param {
 100         const void *private_data;
 101         u8 private_data_len;
 102         struct rdma_ah_attr ah_attr;
 103         u32 qp_num;
 104         u32 qkey;
 105 };
 106
 107 struct rdma_cm_event {
 108         enum rdma_cm_event_type  event;
 109         int                      status;
 110         union {
 111                 struct rdma_conn_param  conn;
 112                 struct rdma_ud_param    ud;
 113         } param;
 114 };
 115
 116 struct rdma_cm_id;
 117
 118 /**
 119  * rdma_cm_event_handler - Callback used to report user events.
 120  *
 121  * Notes: Users may not call rdma_destroy_id from this callback to destroy
 122  *   the passed in id, or a corresponding listen id.  Returning a
 123  *   non-zero value from the callback will destroy the passed in id.
 124  */
 125 typedef int (*rdma_cm_event_handler)(struct rdma_cm_id *id,
 126                                      struct rdma_cm_event *event);
 127
 128 struct rdma_cm_id {
 129         struct ib_device        *device;
 130         void                    *context;
 131         struct ib_qp            *qp;
 132         rdma_cm_event_handler    event_handler;
 133         struct rdma_route        route;
 134         enum rdma_ucm_port_space ps;
 135         enum ib_qp_type          qp_type;
 136         u8                       port_num;
 137 };
 138
 139 struct rdma_cm_id *__rdma_create_id(struct net *net,
 140                                     rdma_cm_event_handler event_handler,
 141                                     void *context, enum rdma_ucm_port_space ps,
 142                                     enum ib_qp_type qp_type,
 143                                     const char *caller);
 144
 145 /**
 146  * rdma_create_id - Create an RDMA identifier.
 147  *
 148  * @net: The network namespace in which to create the new id.
 149  * @event_handler: User callback invoked to report events associated with the
 150  *   returned rdma_id.
 151  * @context: User specified context associated with the id.
 152  * @ps: RDMA port space.
 153  * @qp_type: type of queue pair associated with the id.
 154  *
 155  * The id holds a reference on the network namespace until it is destroyed.
 156  */
 157 #define rdma_create_id(net, event_handler, context, ps, qp_type) \
 158         __rdma_create_id((net), (event_handler), (context), (ps), (qp_type), \
 159                          KBUILD_MODNAME)
 160
 161 /**
 162   * rdma_destroy_id - Destroys an RDMA identifier.
 163   *
 164   * @id: RDMA identifier.
 165   *
 166   * Note: calling this function has the effect of canceling in-flight
 167   * asynchronous operations associated with the id.
 168   */
 169 void rdma_destroy_id(struct rdma_cm_id *id);
 170
 171 /**
 172  * rdma_bind_addr - Bind an RDMA identifier to a source address and
 173  *   associated RDMA device, if needed.
 174  *
 175  * @id: RDMA identifier.
 176  * @addr: Local address information.  Wildcard values are permitted.
 177  *
 178  * This associates a source address with the RDMA identifier before calling
 179  * rdma_listen.  If a specific local address is given, the RDMA identifier will
 180  * be bound to a local RDMA device.
 181  */
 182 int rdma_bind_addr(struct rdma_cm_id *id, struct sockaddr *addr);
 183
 184 /**
 185  * rdma_resolve_addr - Resolve destination and optional source addresses
 186  *   from IP addresses to an RDMA address.  If successful, the specified
 187  *   rdma_cm_id will be bound to a local device.
 188  *
 189  * @id: RDMA identifier.
 190  * @src_addr: Source address information.  This parameter may be NULL.
 191  * @dst_addr: Destination address information.
 192  * @timeout_ms: Time to wait for resolution to complete.
 193  */
 194 int rdma_resolve_addr(struct rdma_cm_id *id, struct sockaddr *src_addr,
 195                       const struct sockaddr *dst_addr, int timeout_ms);
 196
 197 /**
 198  * rdma_resolve_route - Resolve the RDMA address bound to the RDMA identifier
 199  *   into route information needed to establish a connection.
 200  *
 201  * This is called on the client side of a connection.
 202  * Users must have first called rdma_resolve_addr to resolve a dst_addr
 203  * into an RDMA address before calling this routine.
 204  */
 205 int rdma_resolve_route(struct rdma_cm_id *id, int timeout_ms);
 206
 207 /**
 208  * rdma_create_qp - Allocate a QP and associate it with the specified RDMA
 209  * identifier.
 210  *
 211  * QPs allocated to an rdma_cm_id will automatically be transitioned by the CMA
 212  * through their states.
 213  */
 214 int rdma_create_qp(struct rdma_cm_id *id, struct ib_pd *pd,
 215                    struct ib_qp_init_attr *qp_init_attr);
 216
 217 /**
 218  * rdma_destroy_qp - Deallocate the QP associated with the specified RDMA
 219  * identifier.
 220  *
 221  * Users must destroy any QP associated with an RDMA identifier before
 222  * destroying the RDMA ID.
 223  */
 224 void rdma_destroy_qp(struct rdma_cm_id *id);
 225
 226 /**
 227  * rdma_init_qp_attr - Initializes the QP attributes for use in transitioning
 228  *   to a specified QP state.
 229  * @id: Communication identifier associated with the QP attributes to
 230  *   initialize.
 231  * @qp_attr: On input, specifies the desired QP state.  On output, the
 232  *   mandatory and desired optional attributes will be set in order to
 233  *   modify the QP to the specified state.
 234  * @qp_attr_mask: The QP attribute mask that may be used to transition the
 235  *   QP to the specified state.
 236  *
 237  * Users must set the @qp_attr->qp_state to the desired QP state.  This call
 238  * will set all required attributes for the given transition, along with
 239  * known optional attributes.  Users may override the attributes returned from
 240  * this call before calling ib_modify_qp.
 241  *
 242  * Users that wish to have their QP automatically transitioned through its
 243  * states can associate a QP with the rdma_cm_id by calling rdma_create_qp().
 244  */
 245 int rdma_init_qp_attr(struct rdma_cm_id *id, struct ib_qp_attr *qp_attr,
 246                        int *qp_attr_mask);
 247
 248 /**
 249  * rdma_connect - Initiate an active connection request.
 250  * @id: Connection identifier to connect.
 251  * @conn_param: Connection information used for connected QPs.
 252  *
 253  * Users must have resolved a route for the rdma_cm_id to connect with
 254  * by having called rdma_resolve_route before calling this routine.
 255  *
 256  * This call will either connect to a remote QP or obtain remote QP
 257  * information for unconnected rdma_cm_id's.  The actual operation is
 258  * based on the rdma_cm_id's port space.
 259  */
 260 int rdma_connect(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
 261
 262 /**
 263  * rdma_listen - This function is called by the passive side to
 264  *   listen for incoming connection requests.
 265  *
 266  * Users must have bound the rdma_cm_id to a local address by calling
 267  * rdma_bind_addr before calling this routine.
 268  */
 269 int rdma_listen(struct rdma_cm_id *id, int backlog);
 270
 271 int __rdma_accept(struct rdma_cm_id *id, struct rdma_conn_param *conn_param,
 272                   const char *caller);
 273
 274 /**
 275  * rdma_accept - Called to accept a connection request or response.
 276  * @id: Connection identifier associated with the request.
 277  * @conn_param: Information needed to establish the connection.  This must be
 278  *   provided if accepting a connection request.  If accepting a connection
 279  *   response, this parameter must be NULL.
 280  *
 281  * Typically, this routine is only called by the listener to accept a connection
 282  * request.  It must also be called on the active side of a connection if the
 283  * user is performing their own QP transitions.
 284  *
 285  * In the case of error, a reject message is sent to the remote side and the
 286  * state of the qp associated with the id is modified to error, such that any
 287  * previously posted receive buffers would be flushed.
 288  */
 289 #define rdma_accept(id, conn_param) \
 290         __rdma_accept((id), (conn_param),  KBUILD_MODNAME)
 291
 292 /**
 293  * rdma_notify - Notifies the RDMA CM of an asynchronous event that has
 294  * occurred on the connection.
 295  * @id: Connection identifier to transition to established.
 296  * @event: Asynchronous event.
 297  *
 298  * This routine should be invoked by users to notify the CM of relevant
 299  * communication events.  Events that should be reported to the CM and
 300  * when to report them are:
 301  *
 302  * IB_EVENT_COMM_EST - Used when a message is received on a connected
 303  *    QP before an RTU has been received.
 304  */
 305 int rdma_notify(struct rdma_cm_id *id, enum ib_event_type event);
 306
 307 /**
 308  * rdma_reject - Called to reject a connection request or response.
 309  */
 310 int rdma_reject(struct rdma_cm_id *id, const void *private_data,
 311                 u8 private_data_len);
 312
 313 /**
 314  * rdma_disconnect - This function disconnects the associated QP and
 315  *   transitions it into the error state.
 316  */
 317 int rdma_disconnect(struct rdma_cm_id *id);
 318
 319 /**
 320  * rdma_join_multicast - Join the multicast group specified by the given
 321  *   address.
 322  * @id: Communication identifier associated with the request.
 323  * @addr: Multicast address identifying the group to join.
 324  * @join_state: Multicast JoinState bitmap requested by port.
 325  *              Bitmap is based on IB_SA_MCMEMBER_REC_JOIN_STATE bits.
 326  * @context: User-defined context associated with the join request, returned
 327  * to the user through the private_data pointer in multicast events.
 328  */
 329 int rdma_join_multicast(struct rdma_cm_id *id, struct sockaddr *addr,
 330                         u8 join_state, void *context);
 331
 332 /**
 333  * rdma_leave_multicast - Leave the multicast group specified by the given
 334  *   address.
 335  */
 336 void rdma_leave_multicast(struct rdma_cm_id *id, struct sockaddr *addr);
 337
 338 /**
 339  * rdma_set_service_type - Set the type of service associated with a
 340  *   connection identifier.
 341  * @id: Communication identifier to associated with service type.
 342  * @tos: Type of service.
 343  *
 344  * The type of service is interpretted as a differentiated service
 345  * field (RFC 2474).  The service type should be specified before
 346  * performing route resolution, as existing communication on the
 347  * connection identifier may be unaffected.  The type of service
 348  * requested may not be supported by the network to all destinations.
 349  */
 350 void rdma_set_service_type(struct rdma_cm_id *id, int tos);
 351
 352 /**
 353  * rdma_set_reuseaddr - Allow the reuse of local addresses when binding
 354  *    the rdma_cm_id.
 355  * @id: Communication identifier to configure.
 356  * @reuse: Value indicating if the bound address is reusable.
 357  *
 358  * Reuse must be set before an address is bound to the id.
 359  */
 360 int rdma_set_reuseaddr(struct rdma_cm_id *id, int reuse);
 361
 362 /**
 363  * rdma_set_afonly - Specify that listens are restricted to the
 364  *    bound address family only.
 365  * @id: Communication identifer to configure.
 366  * @afonly: Value indicating if listens are restricted.
 367  *
 368  * Must be set before identifier is in the listening state.
 369  */
 370 int rdma_set_afonly(struct rdma_cm_id *id, int afonly);
 371
 372  /**
 373  * rdma_get_service_id - Return the IB service ID for a specified address.
 374  * @id: Communication identifier associated with the address.
 375  * @addr: Address for the service ID.
 376  */
 377 __be64 rdma_get_service_id(struct rdma_cm_id *id, struct sockaddr *addr);
 378
 379 /**
 380  * rdma_reject_msg - return a pointer to a reject message string.
 381  * @id: Communication identifier that received the REJECT event.
 382  * @reason: Value returned in the REJECT event status field.
 383  */
 384 const char *__attribute_const__ rdma_reject_msg(struct rdma_cm_id *id,
 385                                                 int reason);
 386 /**
 387  * rdma_is_consumer_reject - return true if the consumer rejected the connect
 388  *                           request.
 389  * @id: Communication identifier that received the REJECT event.
 390  * @reason: Value returned in the REJECT event status field.
 391  */
 392 bool rdma_is_consumer_reject(struct rdma_cm_id *id, int reason);
 393
 394 /**
 395  * rdma_consumer_reject_data - return the consumer reject private data and
 396  *                             length, if any.
 397  * @id: Communication identifier that received the REJECT event.
 398  * @ev: RDMA CM reject event.
 399  * @data_len: Pointer to the resulting length of the consumer data.
 400  */
 401 const void *rdma_consumer_reject_data(struct rdma_cm_id *id,
 402                                       struct rdma_cm_event *ev, u8 *data_len);
 403
 404 /**
 405  * rdma_read_gids - Return the SGID and DGID used for establishing
 406  *                  connection. This can be used after rdma_resolve_addr()
 407  *                  on client side. This can be use on new connection
 408  *                  on server side. This is applicable to IB, RoCE, iWarp.
 409  *                  If cm_id is not bound yet to the RDMA device, it doesn't
 410  *                  copy and SGID or DGID to the given pointers.
 411  * @id: Communication identifier whose GIDs are queried.
 412  * @sgid: Pointer to SGID where SGID will be returned. It is optional.
 413  * @dgid: Pointer to DGID where DGID will be returned. It is optional.
 414  * Note: This API should not be used by any new ULPs or new code.
 415  * Instead, users interested in querying GIDs should refer to path record
 416  * of the rdma_cm_id to query the GIDs.
 417  * This API is provided for compatibility for existing users.
 418  */
 419
 420 void rdma_read_gids(struct rdma_cm_id *cm_id, union ib_gid *sgid,
 421                     union ib_gid *dgid);
 422
 423 struct iw_cm_id *rdma_iw_cm_id(struct rdma_cm_id *cm_id);
 424 struct rdma_cm_id *rdma_res_to_id(struct rdma_restrack_entry *res);
 425
 426 #endif /* RDMA_CM_H */