drivers/infiniband/ulp/srpt/ib_srpt.h

   1 /*
   2  * Copyright (c) 2006 - 2009 Mellanox Technology Inc.  All rights reserved.
   3  * Copyright (C) 2009 - 2010 Bart Van Assche <bvanassche@acm.org>.
   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
  35 #ifndef IB_SRPT_H
  36 #define IB_SRPT_H
  37
  38 #include <linux/types.h>
  39 #include <linux/list.h>
  40 #include <linux/wait.h>
  41
  42 #include <rdma/ib_verbs.h>
  43 #include <rdma/ib_sa.h>
  44 #include <rdma/ib_cm.h>
  45
  46 #include <scsi/srp.h>
  47
  48 #include "ib_dm_mad.h"
  49
  50 /*
  51  * The prefix the ServiceName field must start with in the device management
  52  * ServiceEntries attribute pair. See also the SRP specification.
  53  */
  54 #define SRP_SERVICE_NAME_PREFIX         "SRP.T10:"
  55
  56 enum {
  57         /*
  58          * SRP IOControllerProfile attributes for SRP target ports that have
  59          * not been defined in <scsi/srp.h>. Source: section B.7, table B.7
  60          * in the SRP specification.
  61          */
  62         SRP_PROTOCOL = 0x0108,
  63         SRP_PROTOCOL_VERSION = 0x0001,
  64         SRP_IO_SUBCLASS = 0x609e,
  65         SRP_SEND_TO_IOC = 0x01,
  66         SRP_SEND_FROM_IOC = 0x02,
  67         SRP_RDMA_READ_FROM_IOC = 0x08,
  68         SRP_RDMA_WRITE_FROM_IOC = 0x20,
  69
  70         /*
  71          * srp_login_cmd.req_flags bitmasks. See also table 9 in the SRP
  72          * specification.
  73          */
  74         SRP_MTCH_ACTION = 0x03, /* MULTI-CHANNEL ACTION */
  75         SRP_LOSOLNT = 0x10, /* logout solicited notification */
  76         SRP_CRSOLNT = 0x20, /* credit request solicited notification */
  77         SRP_AESOLNT = 0x40, /* asynchronous event solicited notification */
  78
  79         /*
  80          * srp_cmd.sol_nt / srp_tsk_mgmt.sol_not bitmasks. See also tables
  81          * 18 and 20 in the SRP specification.
  82          */
  83         SRP_SCSOLNT = 0x02, /* SCSOLNT = successful solicited notification */
  84         SRP_UCSOLNT = 0x04, /* UCSOLNT = unsuccessful solicited notification */
  85
  86         /*
  87          * srp_rsp.sol_not / srp_t_logout.sol_not bitmasks. See also tables
  88          * 16 and 22 in the SRP specification.
  89          */
  90         SRP_SOLNT = 0x01, /* SOLNT = solicited notification */
  91
  92         /* See also table 24 in the SRP specification. */
  93         SRP_TSK_MGMT_SUCCESS = 0x00,
  94         SRP_TSK_MGMT_FUNC_NOT_SUPP = 0x04,
  95         SRP_TSK_MGMT_FAILED = 0x05,
  96
  97         /* See also table 21 in the SRP specification. */
  98         SRP_CMD_SIMPLE_Q = 0x0,
  99         SRP_CMD_HEAD_OF_Q = 0x1,
 100         SRP_CMD_ORDERED_Q = 0x2,
 101         SRP_CMD_ACA = 0x4,
 102
 103         SRP_LOGIN_RSP_MULTICHAN_NO_CHAN = 0x0,
 104         SRP_LOGIN_RSP_MULTICHAN_TERMINATED = 0x1,
 105         SRP_LOGIN_RSP_MULTICHAN_MAINTAINED = 0x2,
 106
 107         SRPT_DEF_SG_TABLESIZE = 128,
 108         SRPT_DEF_SG_PER_WQE = 16,
 109
 110         MIN_SRPT_SQ_SIZE = 16,
 111         DEF_SRPT_SQ_SIZE = 4096,
 112         SRPT_RQ_SIZE = 128,
 113         MIN_SRPT_SRQ_SIZE = 4,
 114         DEFAULT_SRPT_SRQ_SIZE = 4095,
 115         MAX_SRPT_SRQ_SIZE = 65535,
 116         MAX_SRPT_RDMA_SIZE = 1U << 24,
 117         MAX_SRPT_RSP_SIZE = 1024,
 118
 119         MIN_MAX_REQ_SIZE = 996,
 120         DEFAULT_MAX_REQ_SIZE
 121                 = sizeof(struct srp_cmd)/*48*/
 122                 + sizeof(struct srp_indirect_buf)/*20*/
 123                 + 128 * sizeof(struct srp_direct_buf)/*16*/,
 124
 125         MIN_MAX_RSP_SIZE = sizeof(struct srp_rsp)/*36*/ + 4,
 126         DEFAULT_MAX_RSP_SIZE = 256, /* leaves 220 bytes for sense data */
 127
 128         DEFAULT_MAX_RDMA_SIZE = 65536,
 129 };
 130
 131 /**
 132  * enum srpt_command_state - SCSI command state managed by SRPT.
 133  * @SRPT_STATE_NEW:           New command arrived and is being processed.
 134  * @SRPT_STATE_NEED_DATA:     Processing a write or bidir command and waiting
 135  *                            for data arrival.
 136  * @SRPT_STATE_DATA_IN:       Data for the write or bidir command arrived and is
 137  *                            being processed.
 138  * @SRPT_STATE_CMD_RSP_SENT:  SRP_RSP for SRP_CMD has been sent.
 139  * @SRPT_STATE_MGMT:          Processing a SCSI task management command.
 140  * @SRPT_STATE_MGMT_RSP_SENT: SRP_RSP for SRP_TSK_MGMT has been sent.
 141  * @SRPT_STATE_DONE:          Command processing finished successfully, command
 142  *                            processing has been aborted or command processing
 143  *                            failed.
 144  */
 145 enum srpt_command_state {
 146         SRPT_STATE_NEW           = 0,
 147         SRPT_STATE_NEED_DATA     = 1,
 148         SRPT_STATE_DATA_IN       = 2,
 149         SRPT_STATE_CMD_RSP_SENT  = 3,
 150         SRPT_STATE_MGMT          = 4,
 151         SRPT_STATE_MGMT_RSP_SENT = 5,
 152         SRPT_STATE_DONE          = 6,
 153 };
 154
 155 /**
 156  * struct srpt_ioctx - Shared SRPT I/O context information.
 157  * @buf:   Pointer to the buffer.
 158  * @dma:   DMA address of the buffer.
 159  * @index: Index of the I/O context in its ioctx_ring array.
 160  */
 161 struct srpt_ioctx {
 162         struct ib_cqe           cqe;
 163         void                    *buf;
 164         dma_addr_t              dma;
 165         uint32_t                index;
 166 };
 167
 168 /**
 169  * struct srpt_recv_ioctx - SRPT receive I/O context.
 170  * @ioctx:     See above.
 171  * @wait_list: Node for insertion in srpt_rdma_ch.cmd_wait_list.
 172  */
 173 struct srpt_recv_ioctx {
 174         struct srpt_ioctx       ioctx;
 175         struct list_head        wait_list;
 176 };
 177
 178 /**
 179  * struct srpt_send_ioctx - SRPT send I/O context.
 180  * @ioctx:       See above.
 181  * @ch:          Channel pointer.
 182  * @free_list:   Node in srpt_rdma_ch.free_list.
 183  * @n_rbuf:      Number of data buffers in the received SRP command.
 184  * @rbufs:       Pointer to SRP data buffer array.
 185  * @single_rbuf: SRP data buffer if the command has only a single buffer.
 186  * @sg:          Pointer to sg-list associated with this I/O context.
 187  * @sg_cnt:      SG-list size.
 188  * @mapped_sg_count: ib_dma_map_sg() return value.
 189  * @n_rdma_wrs:  Number of elements in the rdma_wrs array.
 190  * @rdma_wrs:    Array with information about the RDMA mapping.
 191  * @tag:         Tag of the received SRP information unit.
 192  * @spinlock:    Protects 'state'.
 193  * @state:       I/O context state.
 194  * @cmd:         Target core command data structure.
 195  * @sense_data:  SCSI sense data.
 196  */
 197 struct srpt_send_ioctx {
 198         struct srpt_ioctx       ioctx;
 199         struct srpt_rdma_ch     *ch;
 200         struct ib_rdma_wr       *rdma_wrs;
 201         struct ib_cqe           rdma_cqe;
 202         struct srp_direct_buf   *rbufs;
 203         struct srp_direct_buf   single_rbuf;
 204         struct scatterlist      *sg;
 205         struct list_head        free_list;
 206         spinlock_t              spinlock;
 207         enum srpt_command_state state;
 208         struct se_cmd           cmd;
 209         struct completion       tx_done;
 210         int                     sg_cnt;
 211         int                     mapped_sg_count;
 212         u16                     n_rdma_wrs;
 213         u8                      n_rdma;
 214         u8                      n_rbuf;
 215         bool                    queue_status_only;
 216         u8                      sense_data[TRANSPORT_SENSE_BUFFER];
 217 };
 218
 219 /**
 220  * enum rdma_ch_state - SRP channel state.
 221  * @CH_CONNECTING:       QP is in RTR state; waiting for RTU.
 222  * @CH_LIVE:             QP is in RTS state.
 223  * @CH_DISCONNECTING:    DREQ has been received; waiting for DREP
 224  *                       or DREQ has been send and waiting for DREP
 225  *                       or .
 226  * @CH_DRAINING:         QP is in ERR state; waiting for last WQE event.
 227  * @CH_RELEASING:        Last WQE event has been received; releasing resources.
 228  */
 229 enum rdma_ch_state {
 230         CH_CONNECTING,
 231         CH_LIVE,
 232         CH_DISCONNECTING,
 233         CH_DRAINING,
 234         CH_RELEASING
 235 };
 236
 237 /**
 238  * struct srpt_rdma_ch - RDMA channel.
 239  * @cm_id:         IB CM ID associated with the channel.
 240  * @qp:            IB queue pair used for communicating over this channel.
 241  * @cq:            IB completion queue for this channel.
 242  * @rq_size:       IB receive queue size.
 243  * @rsp_size       IB response message size in bytes.
 244  * @sq_wr_avail:   number of work requests available in the send queue.
 245  * @sport:         pointer to the information of the HCA port used by this
 246  *                 channel.
 247  * @i_port_id:     128-bit initiator port identifier copied from SRP_LOGIN_REQ.
 248  * @t_port_id:     128-bit target port identifier copied from SRP_LOGIN_REQ.
 249  * @max_ti_iu_len: maximum target-to-initiator information unit length.
 250  * @req_lim:       request limit: maximum number of requests that may be sent
 251  *                 by the initiator without having received a response.
 252  * @req_lim_delta: Number of credits not yet sent back to the initiator.
 253  * @spinlock:      Protects free_list and state.
 254  * @free_list:     Head of list with free send I/O contexts.
 255  * @state:         channel state. See also enum rdma_ch_state.
 256  * @ioctx_ring:    Send ring.
 257  * @wc:            IB work completion array for srpt_process_completion().
 258  * @list:          Node for insertion in the srpt_device.rch_list list.
 259  * @cmd_wait_list: List of SCSI commands that arrived before the RTU event. This
 260  *                 list contains struct srpt_ioctx elements and is protected
 261  *                 against concurrent modification by the cm_id spinlock.
 262  * @sess:          Session information associated with this SRP channel.
 263  * @sess_name:     Session name.
 264  * @release_work:  Allows scheduling of srpt_release_channel().
 265  * @release_done:  Enables waiting for srpt_release_channel() completion.
 266  */
 267 struct srpt_rdma_ch {
 268         struct ib_cm_id         *cm_id;
 269         struct ib_qp            *qp;
 270         struct ib_cq            *cq;
 271         int                     rq_size;
 272         u32                     rsp_size;
 273         atomic_t                sq_wr_avail;
 274         struct srpt_port        *sport;
 275         u8                      i_port_id[16];
 276         u8                      t_port_id[16];
 277         int                     max_ti_iu_len;
 278         atomic_t                req_lim;
 279         atomic_t                req_lim_delta;
 280         spinlock_t              spinlock;
 281         struct list_head        free_list;
 282         enum rdma_ch_state      state;
 283         struct srpt_send_ioctx  **ioctx_ring;
 284         struct ib_wc            wc[16];
 285         struct list_head        list;
 286         struct list_head        cmd_wait_list;
 287         struct se_session       *sess;
 288         u8                      sess_name[36];
 289         struct work_struct      release_work;
 290         struct completion       *release_done;
 291         bool                    in_shutdown;
 292 };
 293
 294 /**
 295  * struct srpt_port_attib - Attributes for SRPT port
 296  * @srp_max_rdma_size: Maximum size of SRP RDMA transfers for new connections.
 297  * @srp_max_rsp_size: Maximum size of SRP response messages in bytes.
 298  * @srp_sq_size: Shared receive queue (SRQ) size.
 299  */
 300 struct srpt_port_attrib {
 301         u32                     srp_max_rdma_size;
 302         u32                     srp_max_rsp_size;
 303         u32                     srp_sq_size;
 304 };
 305
 306 /**
 307  * struct srpt_port - Information associated by SRPT with a single IB port.
 308  * @sdev:      backpointer to the HCA information.
 309  * @mad_agent: per-port management datagram processing information.
 310  * @enabled:   Whether or not this target port is enabled.
 311  * @port_guid: ASCII representation of Port GUID
 312  * @port:      one-based port number.
 313  * @sm_lid:    cached value of the port's sm_lid.
 314  * @lid:       cached value of the port's lid.
 315  * @gid:       cached value of the port's gid.
 316  * @port_acl_lock spinlock for port_acl_list:
 317  * @work:      work structure for refreshing the aforementioned cached values.
 318  * @port_tpg_1 Target portal group = 1 data.
 319  * @port_wwn:  Target core WWN data.
 320  * @port_acl_list: Head of the list with all node ACLs for this port.
 321  */
 322 struct srpt_port {
 323         struct srpt_device      *sdev;
 324         struct ib_mad_agent     *mad_agent;
 325         bool                    enabled;
 326         u8                      port_guid[64];
 327         u8                      port;
 328         u16                     sm_lid;
 329         u16                     lid;
 330         union ib_gid            gid;
 331         spinlock_t              port_acl_lock;
 332         struct work_struct      work;
 333         struct se_portal_group  port_tpg_1;
 334         struct se_wwn           port_wwn;
 335         struct list_head        port_acl_list;
 336         struct srpt_port_attrib port_attrib;
 337 };
 338
 339 /**
 340  * struct srpt_device - Information associated by SRPT with a single HCA.
 341  * @device:        Backpointer to the struct ib_device managed by the IB core.
 342  * @pd:            IB protection domain.
 343  * @mr:            L_Key (local key) with write access to all local memory.
 344  * @srq:           Per-HCA SRQ (shared receive queue).
 345  * @cm_id:         Connection identifier.
 346  * @srq_size:      SRQ size.
 347  * @ioctx_ring:    Per-HCA SRQ.
 348  * @rch_list:      Per-device channel list -- see also srpt_rdma_ch.list.
 349  * @ch_releaseQ:   Enables waiting for removal from rch_list.
 350  * @spinlock:      Protects rch_list and tpg.
 351  * @port:          Information about the ports owned by this HCA.
 352  * @event_handler: Per-HCA asynchronous IB event handler.
 353  * @list:          Node in srpt_dev_list.
 354  */
 355 struct srpt_device {
 356         struct ib_device        *device;
 357         struct ib_pd            *pd;
 358         struct ib_srq           *srq;
 359         struct ib_cm_id         *cm_id;
 360         int                     srq_size;
 361         struct srpt_recv_ioctx  **ioctx_ring;
 362         struct list_head        rch_list;
 363         wait_queue_head_t       ch_releaseQ;
 364         spinlock_t              spinlock;
 365         struct srpt_port        port[2];
 366         struct ib_event_handler event_handler;
 367         struct list_head        list;
 368 };
 369
 370 /**
 371  * struct srpt_node_acl - Per-initiator ACL data (managed via configfs).
 372  * @nacl:      Target core node ACL information.
 373  * @i_port_id: 128-bit SRP initiator port ID.
 374  * @sport:     port information.
 375  * @list:      Element of the per-HCA ACL list.
 376  */
 377 struct srpt_node_acl {
 378         struct se_node_acl      nacl;
 379         u8                      i_port_id[16];
 380         struct srpt_port        *sport;
 381         struct list_head        list;
 382 };
 383
 384 #endif                          /* IB_SRPT_H */