include/rdma/rdma_cm.h

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