include/linux/rds.h

   1 /*
   2  * Copyright (c) 2008 Oracle.  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
  34 #ifndef _LINUX_RDS_H
  35 #define _LINUX_RDS_H
  36
  37 #include <linux/types.h>
  38
  39 #define RDS_IB_ABI_VERSION              0x301
  40
  41 /*
  42  * setsockopt/getsockopt for SOL_RDS
  43  */
  44 #define RDS_CANCEL_SENT_TO              1
  45 #define RDS_GET_MR                      2
  46 #define RDS_FREE_MR                     3
  47 /* deprecated: RDS_BARRIER 4 */
  48 #define RDS_RECVERR                     5
  49 #define RDS_CONG_MONITOR                6
  50 #define RDS_GET_MR_FOR_DEST             7
  51
  52 /*
  53  * Control message types for SOL_RDS.
  54  *
  55  * CMSG_RDMA_ARGS (sendmsg)
  56  *      Request a RDMA transfer to/from the specified
  57  *      memory ranges.
  58  *      The cmsg_data is a struct rds_rdma_args.
  59  * RDS_CMSG_RDMA_DEST (recvmsg, sendmsg)
  60  *      Kernel informs application about intended
  61  *      source/destination of a RDMA transfer
  62  * RDS_CMSG_RDMA_MAP (sendmsg)
  63  *      Application asks kernel to map the given
  64  *      memory range into a IB MR, and send the
  65  *      R_Key along in an RDS extension header.
  66  *      The cmsg_data is a struct rds_get_mr_args,
  67  *      the same as for the GET_MR setsockopt.
  68  * RDS_CMSG_RDMA_STATUS (recvmsg)
  69  *      Returns the status of a completed RDMA operation.
  70  */
  71 #define RDS_CMSG_RDMA_ARGS              1
  72 #define RDS_CMSG_RDMA_DEST              2
  73 #define RDS_CMSG_RDMA_MAP               3
  74 #define RDS_CMSG_RDMA_STATUS            4
  75 #define RDS_CMSG_CONG_UPDATE            5
  76
  77 #define RDS_INFO_FIRST                  10000
  78 #define RDS_INFO_COUNTERS               10000
  79 #define RDS_INFO_CONNECTIONS            10001
  80 /* 10002 aka RDS_INFO_FLOWS is deprecated */
  81 #define RDS_INFO_SEND_MESSAGES          10003
  82 #define RDS_INFO_RETRANS_MESSAGES       10004
  83 #define RDS_INFO_RECV_MESSAGES          10005
  84 #define RDS_INFO_SOCKETS                10006
  85 #define RDS_INFO_TCP_SOCKETS            10007
  86 #define RDS_INFO_IB_CONNECTIONS         10008
  87 #define RDS_INFO_CONNECTION_STATS       10009
  88 #define RDS_INFO_IWARP_CONNECTIONS      10010
  89 #define RDS_INFO_LAST                   10010
  90
  91 struct rds_info_counter {
  92         u_int8_t        name[32];
  93         u_int64_t       value;
  94 } __packed;
  95
  96 #define RDS_INFO_CONNECTION_FLAG_SENDING        0x01
  97 #define RDS_INFO_CONNECTION_FLAG_CONNECTING     0x02
  98 #define RDS_INFO_CONNECTION_FLAG_CONNECTED      0x04
  99
 100 #define TRANSNAMSIZ     16
 101
 102 struct rds_info_connection {
 103         u_int64_t       next_tx_seq;
 104         u_int64_t       next_rx_seq;
 105         __be32          laddr;
 106         __be32          faddr;
 107         u_int8_t        transport[TRANSNAMSIZ];         /* null term ascii */
 108         u_int8_t        flags;
 109 } __packed;
 110
 111 struct rds_info_flow {
 112         __be32          laddr;
 113         __be32          faddr;
 114         u_int32_t       bytes;
 115         __be16          lport;
 116         __be16          fport;
 117 } __packed;
 118
 119 #define RDS_INFO_MESSAGE_FLAG_ACK               0x01
 120 #define RDS_INFO_MESSAGE_FLAG_FAST_ACK          0x02
 121
 122 struct rds_info_message {
 123         u_int64_t       seq;
 124         u_int32_t       len;
 125         __be32          laddr;
 126         __be32          faddr;
 127         __be16          lport;
 128         __be16          fport;
 129         u_int8_t        flags;
 130 } __packed;
 131
 132 struct rds_info_socket {
 133         u_int32_t       sndbuf;
 134         __be32          bound_addr;
 135         __be32          connected_addr;
 136         __be16          bound_port;
 137         __be16          connected_port;
 138         u_int32_t       rcvbuf;
 139         u_int64_t       inum;
 140 } __packed;
 141
 142 struct rds_info_tcp_socket {
 143         __be32          local_addr;
 144         __be16          local_port;
 145         __be32          peer_addr;
 146         __be16          peer_port;
 147         u_int64_t       hdr_rem;
 148         u_int64_t       data_rem;
 149         u_int32_t       last_sent_nxt;
 150         u_int32_t       last_expected_una;
 151         u_int32_t       last_seen_una;
 152 } __packed;
 153
 154 #define RDS_IB_GID_LEN  16
 155 struct rds_info_rdma_connection {
 156         __be32          src_addr;
 157         __be32          dst_addr;
 158         uint8_t         src_gid[RDS_IB_GID_LEN];
 159         uint8_t         dst_gid[RDS_IB_GID_LEN];
 160
 161         uint32_t        max_send_wr;
 162         uint32_t        max_recv_wr;
 163         uint32_t        max_send_sge;
 164         uint32_t        rdma_mr_max;
 165         uint32_t        rdma_mr_size;
 166 };
 167
 168 /*
 169  * Congestion monitoring.
 170  * Congestion control in RDS happens at the host connection
 171  * level by exchanging a bitmap marking congested ports.
 172  * By default, a process sleeping in poll() is always woken
 173  * up when the congestion map is updated.
 174  * With explicit monitoring, an application can have more
 175  * fine-grained control.
 176  * The application installs a 64bit mask value in the socket,
 177  * where each bit corresponds to a group of ports.
 178  * When a congestion update arrives, RDS checks the set of
 179  * ports that are now uncongested against the list bit mask
 180  * installed in the socket, and if they overlap, we queue a
 181  * cong_notification on the socket.
 182  *
 183  * To install the congestion monitor bitmask, use RDS_CONG_MONITOR
 184  * with the 64bit mask.
 185  * Congestion updates are received via RDS_CMSG_CONG_UPDATE
 186  * control messages.
 187  *
 188  * The correspondence between bits and ports is
 189  *      1 << (portnum % 64)
 190  */
 191 #define RDS_CONG_MONITOR_SIZE   64
 192 #define RDS_CONG_MONITOR_BIT(port)  (((unsigned int) port) % RDS_CONG_MONITOR_SIZE)
 193 #define RDS_CONG_MONITOR_MASK(port) (1ULL << RDS_CONG_MONITOR_BIT(port))
 194
 195 /*
 196  * RDMA related types
 197  */
 198
 199 /*
 200  * This encapsulates a remote memory location.
 201  * In the current implementation, it contains the R_Key
 202  * of the remote memory region, and the offset into it
 203  * (so that the application does not have to worry about
 204  * alignment).
 205  */
 206 typedef u_int64_t       rds_rdma_cookie_t;
 207
 208 struct rds_iovec {
 209         u_int64_t       addr;
 210         u_int64_t       bytes;
 211 };
 212
 213 struct rds_get_mr_args {
 214         struct rds_iovec vec;
 215         u_int64_t       cookie_addr;
 216         uint64_t        flags;
 217 };
 218
 219 struct rds_get_mr_for_dest_args {
 220         struct sockaddr_storage dest_addr;
 221         struct rds_iovec        vec;
 222         u_int64_t               cookie_addr;
 223         uint64_t                flags;
 224 };
 225
 226 struct rds_free_mr_args {
 227         rds_rdma_cookie_t cookie;
 228         u_int64_t       flags;
 229 };
 230
 231 struct rds_rdma_args {
 232         rds_rdma_cookie_t cookie;
 233         struct rds_iovec remote_vec;
 234         u_int64_t       local_vec_addr;
 235         u_int64_t       nr_local;
 236         u_int64_t       flags;
 237         u_int64_t       user_token;
 238 };
 239
 240 struct rds_rdma_notify {
 241         u_int64_t       user_token;
 242         int32_t         status;
 243 };
 244
 245 #define RDS_RDMA_SUCCESS        0
 246 #define RDS_RDMA_REMOTE_ERROR   1
 247 #define RDS_RDMA_CANCELED       2
 248 #define RDS_RDMA_DROPPED        3
 249 #define RDS_RDMA_OTHER_ERROR    4
 250
 251 /*
 252  * Common set of flags for all RDMA related structs
 253  */
 254 #define RDS_RDMA_READWRITE      0x0001
 255 #define RDS_RDMA_FENCE          0x0002  /* use FENCE for immediate send */
 256 #define RDS_RDMA_INVALIDATE     0x0004  /* invalidate R_Key after freeing MR */
 257 #define RDS_RDMA_USE_ONCE       0x0008  /* free MR after use */
 258 #define RDS_RDMA_DONTWAIT       0x0010  /* Don't wait in SET_BARRIER */
 259 #define RDS_RDMA_NOTIFY_ME      0x0020  /* Notify when operation completes */
 260
 261 #endif /* IB_RDS_H */