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