blob: 36d525110fd2b28cad5ef05594665cdb14bccd3b [file] [log] [blame]
Or Gerlitz49cd5382006-05-11 10:00:21 +03001/*
2 * iSER transport for the Open iSCSI Initiator & iSER transport internals
3 *
4 * Copyright (C) 2004 Dmitry Yusupov
5 * Copyright (C) 2004 Alex Aizman
6 * Copyright (C) 2005 Mike Christie
7 * based on code maintained by open-iscsi@googlegroups.com
8 *
9 * Copyright (c) 2004, 2005, 2006 Voltaire, Inc. All rights reserved.
10 * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
Or Gerlitz3ee07d22014-04-01 16:28:41 +030011 * Copyright (c) 2013-2014 Mellanox Technologies. All rights reserved.
Or Gerlitz49cd5382006-05-11 10:00:21 +030012 *
13 * This software is available to you under a choice of one of two
14 * licenses. You may choose to be licensed under the terms of the GNU
15 * General Public License (GPL) Version 2, available from the file
16 * COPYING in the main directory of this source tree, or the
17 * OpenIB.org BSD license below:
18 *
19 * Redistribution and use in source and binary forms, with or
20 * without modification, are permitted provided that the following
21 * conditions are met:
22 *
23 * - Redistributions of source code must retain the above
24 * copyright notice, this list of conditions and the following
25 * disclaimer.
26 *
27 * - Redistributions in binary form must reproduce the above
28 * copyright notice, this list of conditions and the following
29 * disclaimer in the documentation and/or other materials
30 * provided with the distribution.
31 *
32 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
33 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
34 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
35 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
36 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
37 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
38 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
39 * SOFTWARE.
Or Gerlitz49cd5382006-05-11 10:00:21 +030040 */
41#ifndef __ISCSI_ISER_H__
42#define __ISCSI_ISER_H__
43
44#include <linux/types.h>
45#include <linux/net.h>
Roi Dayan4f363882013-05-01 13:25:25 +000046#include <linux/printk.h>
Or Gerlitz49cd5382006-05-11 10:00:21 +030047#include <scsi/libiscsi.h>
48#include <scsi/scsi_transport_iscsi.h>
Sagi Grimberg177e31bd2014-03-05 19:43:48 +020049#include <scsi/scsi_cmnd.h>
50#include <scsi/scsi_device.h>
Sagi Grimbergd3cf81f2015-12-09 14:12:03 +020051#include <scsi/iser.h>
Or Gerlitz49cd5382006-05-11 10:00:21 +030052
Alexey Dobriyana6b7a402011-06-06 10:43:46 +000053#include <linux/interrupt.h>
Or Gerlitz49cd5382006-05-11 10:00:21 +030054#include <linux/wait.h>
55#include <linux/sched.h>
56#include <linux/list.h>
57#include <linux/slab.h>
58#include <linux/dma-mapping.h>
59#include <linux/mutex.h>
60#include <linux/mempool.h>
61#include <linux/uio.h>
62
63#include <linux/socket.h>
64#include <linux/in.h>
65#include <linux/in6.h>
66
67#include <rdma/ib_verbs.h>
68#include <rdma/ib_fmr_pool.h>
69#include <rdma/rdma_cm.h>
70
71#define DRV_NAME "iser"
72#define PFX DRV_NAME ": "
Sagi Grimberg4fcd14702015-04-14 18:08:27 +030073#define DRV_VER "1.6"
Or Gerlitz49cd5382006-05-11 10:00:21 +030074
Sagi Grimberge9d49b82014-10-01 14:02:14 +030075#define iser_dbg(fmt, arg...) \
76 do { \
Sagi Grimberg60e20902014-12-07 16:10:04 +020077 if (unlikely(iser_debug_level > 2)) \
Sagi Grimberge9d49b82014-10-01 14:02:14 +030078 printk(KERN_DEBUG PFX "%s: " fmt,\
79 __func__ , ## arg); \
Eli Dorfman6f735e32008-04-29 13:46:52 -070080 } while (0)
81
82#define iser_warn(fmt, arg...) \
83 do { \
Sagi Grimberg60e20902014-12-07 16:10:04 +020084 if (unlikely(iser_debug_level > 0)) \
Sagi Grimberge9d49b82014-10-01 14:02:14 +030085 pr_warn(PFX "%s: " fmt, \
Roi Dayan4f363882013-05-01 13:25:25 +000086 __func__ , ## arg); \
87 } while (0)
88
89#define iser_info(fmt, arg...) \
90 do { \
Sagi Grimberg60e20902014-12-07 16:10:04 +020091 if (unlikely(iser_debug_level > 1)) \
Sagi Grimberge9d49b82014-10-01 14:02:14 +030092 pr_info(PFX "%s: " fmt, \
Or Gerlitz49cd5382006-05-11 10:00:21 +030093 __func__ , ## arg); \
94 } while (0)
95
Sagi Grimberg60e20902014-12-07 16:10:04 +020096#define iser_err(fmt, arg...) \
97 pr_err(PFX "%s: " fmt, __func__ , ## arg)
Or Gerlitz49cd5382006-05-11 10:00:21 +030098
Erez Zilber8dfa0872006-09-11 12:22:30 +030099#define SHIFT_4K 12
Or Gerlitz0ace64b2011-08-01 21:12:09 +0000100#define SIZE_4K (1ULL << SHIFT_4K)
Erez Zilber8dfa0872006-09-11 12:22:30 +0300101#define MASK_4K (~(SIZE_4K-1))
Sagi Grimbergdf749cdc2015-08-06 18:33:04 +0300102
103/* Default support is 512KB I/O size */
104#define ISER_DEF_MAX_SECTORS 1024
105#define ISCSI_ISER_DEF_SG_TABLESIZE ((ISER_DEF_MAX_SECTORS * 512) >> SHIFT_4K)
106/* Maximum support is 8MB I/O size */
107#define ISCSI_ISER_MAX_SG_TABLESIZE ((16384 * 512) >> SHIFT_4K)
108
Shlomo Pongratzb7f04512013-07-28 12:35:38 +0300109#define ISER_DEF_XMIT_CMDS_DEFAULT 512
110#if ISCSI_DEF_XMIT_CMDS_MAX > ISER_DEF_XMIT_CMDS_DEFAULT
111 #define ISER_DEF_XMIT_CMDS_MAX ISCSI_DEF_XMIT_CMDS_MAX
112#else
113 #define ISER_DEF_XMIT_CMDS_MAX ISER_DEF_XMIT_CMDS_DEFAULT
114#endif
115#define ISER_DEF_CMD_PER_LUN ISER_DEF_XMIT_CMDS_MAX
Or Gerlitz49cd5382006-05-11 10:00:21 +0300116
117/* QP settings */
118/* Maximal bounds on received asynchronous PDUs */
119#define ISER_MAX_RX_MISC_PDUS 4 /* NOOP_IN(2) , ASYNC_EVENT(2) */
120
121#define ISER_MAX_TX_MISC_PDUS 6 /* NOOP_OUT(2), TEXT(1), *
122 * SCSI_TMFUNC(2), LOGOUT(1) */
123
Shlomo Pongratzb7f04512013-07-28 12:35:38 +0300124#define ISER_QP_MAX_RECV_DTOS (ISER_DEF_XMIT_CMDS_MAX)
Or Gerlitzbcc60c32010-02-08 13:17:42 +0000125
Shlomo Pongratzb7f04512013-07-28 12:35:38 +0300126#define ISER_MIN_POSTED_RX (ISER_DEF_XMIT_CMDS_MAX >> 2)
Or Gerlitz49cd5382006-05-11 10:00:21 +0300127
128/* the max TX (send) WR supported by the iSER QP is defined by *
129 * max_send_wr = T * (1 + D) + C ; D is how many inflight dataouts we expect *
130 * to have at max for SCSI command. The tx posting & completion handling code *
131 * supports -EAGAIN scheme where tx is suspended till the QP has room for more *
132 * send WR. D=8 comes from 64K/8K */
133
134#define ISER_INFLIGHT_DATAOUTS 8
135
Shlomo Pongratzb7f04512013-07-28 12:35:38 +0300136#define ISER_QP_MAX_REQ_DTOS (ISER_DEF_XMIT_CMDS_MAX * \
Or Gerlitz49cd5382006-05-11 10:00:21 +0300137 (1 + ISER_INFLIGHT_DATAOUTS) + \
138 ISER_MAX_TX_MISC_PDUS + \
139 ISER_MAX_RX_MISC_PDUS)
140
Alex Tabachnik6b5a8fb2014-03-05 19:43:47 +0200141/* Max registration work requests per command */
142#define ISER_MAX_REG_WR_PER_CMD 5
143
144/* For Signature we don't support DATAOUTs so no need to make room for them */
145#define ISER_QP_SIG_MAX_REQ_DTOS (ISER_DEF_XMIT_CMDS_MAX * \
146 (1 + ISER_MAX_REG_WR_PER_CMD) + \
147 ISER_MAX_TX_MISC_PDUS + \
148 ISER_MAX_RX_MISC_PDUS)
149
Minh Tranf4641ef2014-12-07 16:09:52 +0200150#define ISER_GET_MAX_XMIT_CMDS(send_wr) ((send_wr \
151 - ISER_MAX_TX_MISC_PDUS \
152 - ISER_MAX_RX_MISC_PDUS) / \
153 (1 + ISER_INFLIGHT_DATAOUTS))
154
Sagi Grimberg6df5a122014-10-01 14:02:12 +0300155#define ISER_SIGNAL_CMD_COUNT 32
Sagi Grimberg6e6fe2f2014-10-01 14:02:11 +0300156
Or Gerlitzbcc60c32010-02-08 13:17:42 +0000157/* Constant PDU lengths calculations */
Sagi Grimbergd3cf81f2015-12-09 14:12:03 +0200158#define ISER_HEADERS_LEN (sizeof(struct iser_ctrl) + sizeof(struct iscsi_hdr))
Or Gerlitzbcc60c32010-02-08 13:17:42 +0000159
160#define ISER_RECV_DATA_SEG_LEN 128
161#define ISER_RX_PAYLOAD_SIZE (ISER_HEADERS_LEN + ISER_RECV_DATA_SEG_LEN)
162#define ISER_RX_LOGIN_SIZE (ISER_HEADERS_LEN + ISCSI_DEF_MAX_RECV_SEG_LEN)
Or Gerlitz49cd5382006-05-11 10:00:21 +0300163
164/* Length of an object name string */
165#define ISER_OBJECT_NAME_SIZE 64
166
Sagi Grimberg5716af62014-10-01 14:01:57 +0300167enum iser_conn_state {
Or Gerlitz49cd5382006-05-11 10:00:21 +0300168 ISER_CONN_INIT, /* descriptor allocd, no conn */
169 ISER_CONN_PENDING, /* in the process of being established */
170 ISER_CONN_UP, /* up and running */
171 ISER_CONN_TERMINATING, /* in the process of being terminated */
172 ISER_CONN_DOWN, /* shut down */
173 ISER_CONN_STATES_NUM
174};
175
176enum iser_task_status {
177 ISER_TASK_STATUS_INIT = 0,
178 ISER_TASK_STATUS_STARTED,
179 ISER_TASK_STATUS_COMPLETED
180};
181
182enum iser_data_dir {
183 ISER_DIR_IN = 0, /* to initiator */
184 ISER_DIR_OUT, /* from initiator */
185 ISER_DIRS_NUM
186};
187
Sagi Grimbergcd886212014-10-01 14:02:15 +0300188/**
189 * struct iser_data_buf - iSER data buffer
190 *
Sagi Grimberge3784bd2015-04-14 18:08:15 +0300191 * @sg: pointer to the sg list
Sagi Grimbergcd886212014-10-01 14:02:15 +0300192 * @size: num entries of this sg
193 * @data_len: total beffer byte len
194 * @dma_nents: returned by dma_map_sg
Sagi Grimbergcd886212014-10-01 14:02:15 +0300195 */
Or Gerlitz49cd5382006-05-11 10:00:21 +0300196struct iser_data_buf {
Sagi Grimberge3784bd2015-04-14 18:08:15 +0300197 struct scatterlist *sg;
Sagi Grimberg39405882015-10-13 19:11:33 +0300198 int size;
Sagi Grimbergcd886212014-10-01 14:02:15 +0300199 unsigned long data_len;
Max Gurtovoyc1545f12019-02-26 12:22:11 +0200200 int dma_nents;
Sagi Grimbergdd0107a2015-10-13 19:12:58 +0300201};
Or Gerlitz49cd5382006-05-11 10:00:21 +0300202
203/* fwd declarations */
204struct iser_device;
Mike Christie2261ec32008-05-21 15:54:11 -0500205struct iscsi_iser_task;
Mike Christie412eeaf2008-05-21 15:54:14 -0500206struct iscsi_endpoint;
Sagi Grimberg32467c42015-08-06 18:33:02 +0300207struct iser_reg_resources;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300208
Sagi Grimbergcd886212014-10-01 14:02:15 +0300209/**
210 * struct iser_mem_reg - iSER memory registration info
211 *
Sagi Grimberg90a66842015-04-14 18:08:24 +0300212 * @sge: memory region sg element
213 * @rkey: memory region remote key
Sagi Grimbergcd886212014-10-01 14:02:15 +0300214 * @mem_h: pointer to registration context (FMR/Fastreg)
Sagi Grimbergcd886212014-10-01 14:02:15 +0300215 */
Or Gerlitz49cd5382006-05-11 10:00:21 +0300216struct iser_mem_reg {
Sagi Grimberg90a66842015-04-14 18:08:24 +0300217 struct ib_sge sge;
218 u32 rkey;
219 void *mem_h;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300220};
221
Or Gerlitz49cd5382006-05-11 10:00:21 +0300222enum iser_desc_type {
Or Gerlitz49cd5382006-05-11 10:00:21 +0300223 ISCSI_TX_CONTROL ,
224 ISCSI_TX_SCSI_COMMAND,
225 ISCSI_TX_DATAOUT
226};
227
Sagi Grimberg7332bed2015-08-06 18:33:06 +0300228/* Maximum number of work requests per task:
229 * Data memory region local invalidate + fast registration
230 * Protection memory region local invalidate + fast registration
231 * Signature memory region local invalidate + fast registration
232 * PDU send
233 */
234#define ISER_MAX_WRS 7
235
Sagi Grimbergcd886212014-10-01 14:02:15 +0300236/**
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800237 * struct iser_tx_desc - iSER TX descriptor
Sagi Grimbergcd886212014-10-01 14:02:15 +0300238 *
239 * @iser_header: iser header
240 * @iscsi_header: iscsi header
241 * @type: command/control/dataout
242 * @dam_addr: header buffer dma_address
243 * @tx_sg: sg[0] points to iser/iscsi headers
244 * sg[1] optionally points to either of immediate data
245 * unsolicited data-out or control
246 * @num_sge: number sges used on this TX task
Sagi Grimberg8d5944d2015-08-06 18:32:50 +0300247 * @mapped: Is the task header mapped
Sagi Grimberg7332bed2015-08-06 18:33:06 +0300248 * @wr_idx: Current WR index
249 * @wrs: Array of WRs per task
250 * @data_reg: Data buffer registration details
251 * @prot_reg: Protection buffer registration details
252 * @sig_attrs: Signature attributes
Sagi Grimbergcd886212014-10-01 14:02:15 +0300253 */
Or Gerlitzf19624a2010-02-08 13:19:56 +0000254struct iser_tx_desc {
Sagi Grimbergd3cf81f2015-12-09 14:12:03 +0200255 struct iser_ctrl iser_header;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300256 struct iscsi_hdr iscsi_header;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300257 enum iser_desc_type type;
Or Gerlitzf19624a2010-02-08 13:19:56 +0000258 u64 dma_addr;
Or Gerlitzf19624a2010-02-08 13:19:56 +0000259 struct ib_sge tx_sg[2];
260 int num_sge;
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800261 struct ib_cqe cqe;
Sagi Grimberg8d5944d2015-08-06 18:32:50 +0300262 bool mapped;
Sagi Grimberg7332bed2015-08-06 18:33:06 +0300263 u8 wr_idx;
Christoph Hellwige622f2f2015-10-08 09:16:33 +0100264 union iser_wr {
265 struct ib_send_wr send;
Sagi Grimberg39405882015-10-13 19:11:33 +0300266 struct ib_reg_wr fast_reg;
Christoph Hellwige622f2f2015-10-08 09:16:33 +0100267 struct ib_sig_handover_wr sig;
268 } wrs[ISER_MAX_WRS];
Sagi Grimberg7332bed2015-08-06 18:33:06 +0300269 struct iser_mem_reg data_reg;
270 struct iser_mem_reg prot_reg;
271 struct ib_sig_attrs sig_attrs;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300272};
273
Or Gerlitzbcc60c32010-02-08 13:17:42 +0000274#define ISER_RX_PAD_SIZE (256 - (ISER_RX_PAYLOAD_SIZE + \
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800275 sizeof(u64) + sizeof(struct ib_sge) + \
276 sizeof(struct ib_cqe)))
Sagi Grimbergcd886212014-10-01 14:02:15 +0300277/**
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800278 * struct iser_rx_desc - iSER RX descriptor
Sagi Grimbergcd886212014-10-01 14:02:15 +0300279 *
280 * @iser_header: iser header
281 * @iscsi_header: iscsi header
282 * @data: received data segment
283 * @dma_addr: receive buffer dma address
284 * @rx_sg: ib_sge of receive buffer
285 * @pad: for sense data TODO: Modify to maximum sense length supported
286 */
Or Gerlitzbcc60c32010-02-08 13:17:42 +0000287struct iser_rx_desc {
Sagi Grimbergd3cf81f2015-12-09 14:12:03 +0200288 struct iser_ctrl iser_header;
Or Gerlitzbcc60c32010-02-08 13:17:42 +0000289 struct iscsi_hdr iscsi_header;
290 char data[ISER_RECV_DATA_SEG_LEN];
291 u64 dma_addr;
292 struct ib_sge rx_sg;
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800293 struct ib_cqe cqe;
Or Gerlitzbcc60c32010-02-08 13:17:42 +0000294 char pad[ISER_RX_PAD_SIZE];
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800295} __packed;
Sagi Grimberg0f512b32015-11-04 10:50:31 +0200296
297/**
298 * struct iser_login_desc - iSER login descriptor
299 *
300 * @req: pointer to login request buffer
301 * @resp: pointer to login response buffer
302 * @req_dma: DMA address of login request buffer
303 * @rsp_dma: DMA address of login response buffer
304 * @sge: IB sge for login post recv
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800305 * @cqe: completion handler
Sagi Grimberg0f512b32015-11-04 10:50:31 +0200306 */
307struct iser_login_desc {
308 void *req;
309 void *rsp;
310 u64 req_dma;
311 u64 rsp_dma;
312 struct ib_sge sge;
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800313 struct ib_cqe cqe;
Erez Alfasi19b1a292019-02-25 08:52:30 +0200314} __packed;
Or Gerlitzbcc60c32010-02-08 13:17:42 +0000315
Sagi Grimbergb4e155f2013-07-28 12:35:39 +0300316struct iser_conn;
Sagi Grimberga4ee3532014-10-01 14:01:58 +0300317struct ib_conn;
Sagi Grimbergb4e155f2013-07-28 12:35:39 +0300318struct iscsi_iser_task;
319
Sagi Grimbergbf175542014-10-01 14:02:07 +0300320/**
321 * struct iser_comp - iSER completion context
322 *
Sagi Grimberg6aabfa72014-10-01 14:02:09 +0300323 * @cq: completion queue
Sagi Grimbergbf175542014-10-01 14:02:07 +0300324 * @active_qps: Number of active QPs attached
325 * to completion context
326 */
327struct iser_comp {
Sagi Grimberg6aabfa72014-10-01 14:02:09 +0300328 struct ib_cq *cq;
Sagi Grimbergbf175542014-10-01 14:02:07 +0300329 int active_qps;
330};
331
Sagi Grimbergcd886212014-10-01 14:02:15 +0300332/**
Sagi Grimberg48afbff2015-08-06 18:32:56 +0300333 * struct iser_device - Memory registration operations
334 * per-device registration schemes
335 *
336 * @alloc_reg_res: Allocate registration resources
337 * @free_reg_res: Free registration resources
Sagi Grimberg32467c42015-08-06 18:33:02 +0300338 * @fast_reg_mem: Register memory buffers
339 * @unreg_mem: Un-register memory buffers
Sagi Grimberg81722902015-08-06 18:33:01 +0300340 * @reg_desc_get: Get a registration descriptor for pool
341 * @reg_desc_put: Get a registration descriptor to pool
Sagi Grimberg48afbff2015-08-06 18:32:56 +0300342 */
343struct iser_reg_ops {
344 int (*alloc_reg_res)(struct ib_conn *ib_conn,
Sagi Grimbergf8db6512015-08-06 18:33:03 +0300345 unsigned cmds_max,
346 unsigned int size);
Sagi Grimberg48afbff2015-08-06 18:32:56 +0300347 void (*free_reg_res)(struct ib_conn *ib_conn);
Sagi Grimberg32467c42015-08-06 18:33:02 +0300348 int (*reg_mem)(struct iscsi_iser_task *iser_task,
349 struct iser_data_buf *mem,
350 struct iser_reg_resources *rsc,
351 struct iser_mem_reg *reg);
352 void (*unreg_mem)(struct iscsi_iser_task *iser_task,
353 enum iser_data_dir cmd_dir);
Sagi Grimberg81722902015-08-06 18:33:01 +0300354 struct iser_fr_desc * (*reg_desc_get)(struct ib_conn *ib_conn);
355 void (*reg_desc_put)(struct ib_conn *ib_conn,
356 struct iser_fr_desc *desc);
Sagi Grimberg48afbff2015-08-06 18:32:56 +0300357};
358
359/**
Sagi Grimbergcd886212014-10-01 14:02:15 +0300360 * struct iser_device - iSER device handle
361 *
362 * @ib_device: RDMA device
363 * @pd: Protection Domain for this device
Sagi Grimbergcd886212014-10-01 14:02:15 +0300364 * @mr: Global DMA memory region
365 * @event_handler: IB events handle routine
366 * @ig_list: entry in devices list
367 * @refcount: Reference counter, dominated by open iser connections
368 * @comps_used: Number of completion contexts used, Min between online
369 * cpus and device max completion vectors
370 * @comps: Dinamically allocated array of completion handlers
Sagi Grimberg48afbff2015-08-06 18:32:56 +0300371 * @reg_ops: Registration ops
Jenny Derzhavetz59caaed2015-12-24 12:20:48 +0200372 * @remote_inv_sup: Remote invalidate is supported on this device
Sagi Grimbergcd886212014-10-01 14:02:15 +0300373 */
Or Gerlitz49cd5382006-05-11 10:00:21 +0300374struct iser_device {
375 struct ib_device *ib_device;
376 struct ib_pd *pd;
Or Gerlitz2110f9b2010-05-05 17:30:10 +0300377 struct ib_event_handler event_handler;
Sagi Grimbergcd886212014-10-01 14:02:15 +0300378 struct list_head ig_list;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300379 int refcount;
Sagi Grimbergbf175542014-10-01 14:02:07 +0300380 int comps_used;
Sagi Grimbergda64bdb2014-12-07 16:10:03 +0200381 struct iser_comp *comps;
Julia Lawall2392a4c2015-11-28 16:52:04 +0100382 const struct iser_reg_ops *reg_ops;
Jenny Derzhavetz59caaed2015-12-24 12:20:48 +0200383 bool remote_inv_sup;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300384};
385
Sagi Grimbergd711d812015-08-06 18:32:53 +0300386/**
387 * struct iser_reg_resources - Fast registration recources
388 *
389 * @mr: memory region
Adir Lev2b3bf952015-08-06 18:32:59 +0300390 * @fmr_pool: pool of fmrs
Adir Lev2b3bf952015-08-06 18:32:59 +0300391 * @page_vec: fast reg page list used by fmr pool
Sagi Grimbergd711d812015-08-06 18:32:53 +0300392 * @mr_valid: is mr valid indicator
393 */
394struct iser_reg_resources {
Adir Lev2b3bf952015-08-06 18:32:59 +0300395 union {
396 struct ib_mr *mr;
397 struct ib_fmr_pool *fmr_pool;
398 };
Sagi Grimberg39405882015-10-13 19:11:33 +0300399 struct iser_page_vec *page_vec;
Sagi Grimbergd711d812015-08-06 18:32:53 +0300400 u8 mr_valid:1;
Alex Tabachnik6b5a8fb2014-03-05 19:43:47 +0200401};
402
Sagi Grimbergcd886212014-10-01 14:02:15 +0300403/**
404 * struct iser_pi_context - Protection information context
405 *
Sagi Grimbergd711d812015-08-06 18:32:53 +0300406 * @rsc: protection buffer registration resources
407 * @sig_mr: signature enable memory region
408 * @sig_mr_valid: is sig_mr valid indicator
409 * @sig_protected: is region protected indicator
Sagi Grimbergcd886212014-10-01 14:02:15 +0300410 */
Alex Tabachnik6b5a8fb2014-03-05 19:43:47 +0200411struct iser_pi_context {
Sagi Grimbergd711d812015-08-06 18:32:53 +0300412 struct iser_reg_resources rsc;
Alex Tabachnik6b5a8fb2014-03-05 19:43:47 +0200413 struct ib_mr *sig_mr;
Sagi Grimbergd711d812015-08-06 18:32:53 +0300414 u8 sig_mr_valid:1;
415 u8 sig_protected:1;
Sagi Grimberg73bc06b2014-03-05 19:43:43 +0200416};
417
Sagi Grimbergcd886212014-10-01 14:02:15 +0300418/**
Sagi Grimberg5190cc22015-08-06 18:32:54 +0300419 * struct iser_fr_desc - Fast registration descriptor
Sagi Grimbergcd886212014-10-01 14:02:15 +0300420 *
421 * @list: entry in connection fastreg pool
Sagi Grimbergd711d812015-08-06 18:32:53 +0300422 * @rsc: data buffer registration resources
Sagi Grimbergcd886212014-10-01 14:02:15 +0300423 * @pi_ctx: protection information context
Sagi Grimbergcd886212014-10-01 14:02:15 +0300424 */
Sagi Grimberg5190cc22015-08-06 18:32:54 +0300425struct iser_fr_desc {
Sagi Grimberg55878562013-07-28 12:35:42 +0300426 struct list_head list;
Sagi Grimbergd711d812015-08-06 18:32:53 +0300427 struct iser_reg_resources rsc;
Alex Tabachnik6b5a8fb2014-03-05 19:43:47 +0200428 struct iser_pi_context *pi_ctx;
Sagi Grimbergea174c92017-02-27 20:16:33 +0200429 struct list_head all_list;
Sagi Grimberg55878562013-07-28 12:35:42 +0300430};
431
Sagi Grimberga4ee3532014-10-01 14:01:58 +0300432/**
Sagi Grimberg385ad872015-08-06 18:32:58 +0300433 * struct iser_fr_pool: connection fast registration pool
434 *
Adir Lev2b3bf952015-08-06 18:32:59 +0300435 * @list: list of fastreg descriptors
Sagi Grimberg385ad872015-08-06 18:32:58 +0300436 * @lock: protects fmr/fastreg pool
Adir Lev2b3bf952015-08-06 18:32:59 +0300437 * @size: size of the pool
Sagi Grimberg385ad872015-08-06 18:32:58 +0300438 */
439struct iser_fr_pool {
Adir Lev2b3bf952015-08-06 18:32:59 +0300440 struct list_head list;
441 spinlock_t lock;
442 int size;
Sagi Grimbergea174c92017-02-27 20:16:33 +0200443 struct list_head all_list;
Sagi Grimberg385ad872015-08-06 18:32:58 +0300444};
445
446/**
Sagi Grimberga4ee3532014-10-01 14:01:58 +0300447 * struct ib_conn - Infiniband related objects
448 *
449 * @cma_id: rdma_cm connection maneger handle
450 * @qp: Connection Queue-pair
451 * @post_recv_buf_count: post receive counter
Max Gurtovoy6ec9d4d2014-12-07 16:09:56 +0200452 * @sig_count: send work request signal count
Sagi Grimberga4ee3532014-10-01 14:01:58 +0300453 * @rx_wr: receive work request for batch posts
454 * @device: reference to iser device
Sagi Grimbergbf175542014-10-01 14:02:07 +0300455 * @comp: iser completion context
Sagi Grimberg385ad872015-08-06 18:32:58 +0300456 * @fr_pool: connection fast registration poool
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800457 * @pi_support: Indicate device T10-PI support
Sagi Grimberga4ee3532014-10-01 14:01:58 +0300458 */
459struct ib_conn {
460 struct rdma_cm_id *cma_id;
461 struct ib_qp *qp;
462 int post_recv_buf_count;
Max Gurtovoy6ec9d4d2014-12-07 16:09:56 +0200463 u8 sig_count;
Sagi Grimberga4ee3532014-10-01 14:01:58 +0300464 struct ib_recv_wr rx_wr[ISER_MIN_POSTED_RX];
465 struct iser_device *device;
Sagi Grimbergbf175542014-10-01 14:02:07 +0300466 struct iser_comp *comp;
Sagi Grimberg385ad872015-08-06 18:32:58 +0300467 struct iser_fr_pool fr_pool;
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800468 bool pi_support;
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800469 struct ib_cqe reg_cqe;
Sagi Grimberga4ee3532014-10-01 14:01:58 +0300470};
471
Sagi Grimbergcd886212014-10-01 14:02:15 +0300472/**
473 * struct iser_conn - iSER connection context
474 *
475 * @ib_conn: connection RDMA resources
476 * @iscsi_conn: link to matching iscsi connection
477 * @ep: transport handle
478 * @state: connection logical state
479 * @qp_max_recv_dtos: maximum number of data outs, corresponds
480 * to max number of post recvs
481 * @qp_max_recv_dtos_mask: (qp_max_recv_dtos - 1)
482 * @min_posted_rx: (qp_max_recv_dtos >> 2)
Minh Tranf4641ef2014-12-07 16:09:52 +0200483 * @max_cmds: maximum cmds allowed for this connection
Sagi Grimbergcd886212014-10-01 14:02:15 +0300484 * @name: connection peer portal
485 * @release_work: deffered work for release job
486 * @state_mutex: protects iser onnection state
487 * @stop_completion: conn_stop completion
488 * @ib_completion: RDMA cleanup completion
489 * @up_completion: connection establishment completed
490 * (state is ISER_CONN_UP)
491 * @conn_list: entry in ig conn list
Sagi Grimberg0f512b32015-11-04 10:50:31 +0200492 * @login_desc: login descriptor
Sagi Grimbergcd886212014-10-01 14:02:15 +0300493 * @rx_desc_head: head of rx_descs cyclic buffer
494 * @rx_descs: rx buffers array (cyclic buffer)
495 * @num_rx_descs: number of rx descriptors
Sagi Grimbergdf749cdc2015-08-06 18:33:04 +0300496 * @scsi_sg_tablesize: scsi host sg_tablesize
Sergey Gorenko434dda42018-05-21 18:55:53 +0300497 * @pages_per_mr: maximum pages available for registration
Sagi Grimbergcd886212014-10-01 14:02:15 +0300498 */
Or Gerlitz49cd5382006-05-11 10:00:21 +0300499struct iser_conn {
Sagi Grimberga4ee3532014-10-01 14:01:58 +0300500 struct ib_conn ib_conn;
Ariel Nahum4667f5d2014-04-01 16:28:39 +0300501 struct iscsi_conn *iscsi_conn;
Mike Christie412eeaf2008-05-21 15:54:14 -0500502 struct iscsi_endpoint *ep;
Sagi Grimbergcd886212014-10-01 14:02:15 +0300503 enum iser_conn_state state;
504 unsigned qp_max_recv_dtos;
505 unsigned qp_max_recv_dtos_mask;
506 unsigned min_posted_rx;
Minh Tranf4641ef2014-12-07 16:09:52 +0200507 u16 max_cmds;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300508 char name[ISER_OBJECT_NAME_SIZE];
Ariel Nahumb73c3ad2014-05-22 11:00:18 +0300509 struct work_struct release_work;
Ariel Nahum504130c2014-07-31 13:27:49 +0300510 struct mutex state_mutex;
Sagi Grimbergc47a3c92014-10-01 14:02:01 +0300511 struct completion stop_completion;
512 struct completion ib_completion;
Ariel Nahum9a6d3232014-07-31 13:27:50 +0300513 struct completion up_completion;
Sagi Grimbergcd886212014-10-01 14:02:15 +0300514 struct list_head conn_list;
Sagi Grimberg0f512b32015-11-04 10:50:31 +0200515 struct iser_login_desc login_desc;
Or Gerlitzbcc60c32010-02-08 13:17:42 +0000516 unsigned int rx_desc_head;
517 struct iser_rx_desc *rx_descs;
Sagi Grimberg6aabfa72014-10-01 14:02:09 +0300518 u32 num_rx_descs;
Sagi Grimbergdf749cdc2015-08-06 18:33:04 +0300519 unsigned short scsi_sg_tablesize;
Sergey Gorenko434dda42018-05-21 18:55:53 +0300520 unsigned short pages_per_mr;
Jenny Derzhavetz59caaed2015-12-24 12:20:48 +0200521 bool snd_w_inv;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300522};
523
Sagi Grimbergcd886212014-10-01 14:02:15 +0300524/**
525 * struct iscsi_iser_task - iser task context
526 *
527 * @desc: TX descriptor
528 * @iser_conn: link to iser connection
529 * @status: current task status
530 * @sc: link to scsi command
531 * @command_sent: indicate if command was sent
532 * @dir: iser data direction
Sagi Grimbergb130ede2015-04-14 18:08:19 +0300533 * @rdma_reg: task rdma registration desc
Sagi Grimbergcd886212014-10-01 14:02:15 +0300534 * @data: iser data buffer desc
Sagi Grimbergcd886212014-10-01 14:02:15 +0300535 * @prot: iser protection buffer desc
Sagi Grimbergcd886212014-10-01 14:02:15 +0300536 */
Mike Christie2261ec32008-05-21 15:54:11 -0500537struct iscsi_iser_task {
Or Gerlitzf19624a2010-02-08 13:19:56 +0000538 struct iser_tx_desc desc;
Sagi Grimberg5716af62014-10-01 14:01:57 +0300539 struct iser_conn *iser_conn;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300540 enum iser_task_status status;
Sagi Grimberg177e31bd2014-03-05 19:43:48 +0200541 struct scsi_cmnd *sc;
Sagi Grimbergcd886212014-10-01 14:02:15 +0300542 int command_sent;
543 int dir[ISER_DIRS_NUM];
Sagi Grimbergb130ede2015-04-14 18:08:19 +0300544 struct iser_mem_reg rdma_reg[ISER_DIRS_NUM];
Sagi Grimbergcd886212014-10-01 14:02:15 +0300545 struct iser_data_buf data[ISER_DIRS_NUM];
Sagi Grimbergcd886212014-10-01 14:02:15 +0300546 struct iser_data_buf prot[ISER_DIRS_NUM];
Or Gerlitz49cd5382006-05-11 10:00:21 +0300547};
548
549struct iser_page_vec {
550 u64 *pages;
Sagi Grimbergbfe066e2015-12-09 14:12:00 +0200551 int npages;
552 struct ib_mr fake_mr;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300553};
554
Sagi Grimbergcd886212014-10-01 14:02:15 +0300555/**
556 * struct iser_global: iSER global context
557 *
558 * @device_list_mutex: protects device_list
559 * @device_list: iser devices global list
560 * @connlist_mutex: protects connlist
561 * @connlist: iser connections global list
562 * @desc_cache: kmem cache for tx dataout
563 */
Or Gerlitz49cd5382006-05-11 10:00:21 +0300564struct iser_global {
Sagi Grimbergcd886212014-10-01 14:02:15 +0300565 struct mutex device_list_mutex;
566 struct list_head device_list;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300567 struct mutex connlist_mutex;
Sagi Grimbergcd886212014-10-01 14:02:15 +0300568 struct list_head connlist;
Roland Dreiere54f8182006-11-29 15:33:07 -0800569 struct kmem_cache *desc_cache;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300570};
571
572extern struct iser_global ig;
573extern int iser_debug_level;
Alex Tabachnik7f733842014-03-05 19:43:46 +0200574extern bool iser_pi_enable;
575extern int iser_pi_guard;
Sagi Grimbergdf749cdc2015-08-06 18:33:04 +0300576extern unsigned int iser_max_sectors;
Sagi Grimberg3cffd932015-09-24 10:34:22 +0300577extern bool iser_always_reg;
Or Gerlitz49cd5382006-05-11 10:00:21 +0300578
Sagi Grimberg48afbff2015-08-06 18:32:56 +0300579int iser_assign_reg_ops(struct iser_device *device);
580
Mike Christie2747fdb2008-05-21 15:54:08 -0500581int iser_send_control(struct iscsi_conn *conn,
Mike Christie2261ec32008-05-21 15:54:11 -0500582 struct iscsi_task *task);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300583
Mike Christie2747fdb2008-05-21 15:54:08 -0500584int iser_send_command(struct iscsi_conn *conn,
Mike Christie2261ec32008-05-21 15:54:11 -0500585 struct iscsi_task *task);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300586
Mike Christie2747fdb2008-05-21 15:54:08 -0500587int iser_send_data_out(struct iscsi_conn *conn,
Mike Christie2261ec32008-05-21 15:54:11 -0500588 struct iscsi_task *task,
Mike Christie2747fdb2008-05-21 15:54:08 -0500589 struct iscsi_data *hdr);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300590
591void iscsi_iser_recv(struct iscsi_conn *conn,
Sagi Grimbergcd886212014-10-01 14:02:15 +0300592 struct iscsi_hdr *hdr,
593 char *rx_data,
594 int rx_data_len);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300595
Sagi Grimberg5716af62014-10-01 14:01:57 +0300596void iser_conn_init(struct iser_conn *iser_conn);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300597
Sagi Grimberg5716af62014-10-01 14:01:57 +0300598void iser_conn_release(struct iser_conn *iser_conn);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300599
Sagi Grimbergc47a3c92014-10-01 14:02:01 +0300600int iser_conn_terminate(struct iser_conn *iser_conn);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300601
Ariel Nahumb73c3ad2014-05-22 11:00:18 +0300602void iser_release_work(struct work_struct *work);
603
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800604void iser_err_comp(struct ib_wc *wc, const char *type);
605void iser_login_rsp(struct ib_cq *cq, struct ib_wc *wc);
606void iser_task_rsp(struct ib_cq *cq, struct ib_wc *wc);
607void iser_cmd_comp(struct ib_cq *cq, struct ib_wc *wc);
608void iser_ctrl_comp(struct ib_cq *cq, struct ib_wc *wc);
609void iser_dataout_comp(struct ib_cq *cq, struct ib_wc *wc);
610void iser_reg_comp(struct ib_cq *cq, struct ib_wc *wc);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300611
Mike Christie2261ec32008-05-21 15:54:11 -0500612void iser_task_rdma_init(struct iscsi_iser_task *task);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300613
Mike Christie2261ec32008-05-21 15:54:11 -0500614void iser_task_rdma_finalize(struct iscsi_iser_task *task);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300615
Sagi Grimberg5716af62014-10-01 14:01:57 +0300616void iser_free_rx_descriptors(struct iser_conn *iser_conn);
Or Gerlitzbcc60c32010-02-08 13:17:42 +0000617
Sagi Grimberg9a8b08f2014-03-05 19:43:44 +0200618void iser_finalize_rdma_unaligned_sg(struct iscsi_iser_task *iser_task,
619 struct iser_data_buf *mem,
Sagi Grimberg9a8b08f2014-03-05 19:43:44 +0200620 enum iser_data_dir cmd_dir);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300621
Sagi Grimberg32467c42015-08-06 18:33:02 +0300622int iser_reg_rdma_mem(struct iscsi_iser_task *task,
Jenny Derzhavetzb5f04b02015-12-09 14:12:01 +0200623 enum iser_data_dir dir,
624 bool all_imm);
Sagi Grimberg32467c42015-08-06 18:33:02 +0300625void iser_unreg_rdma_mem(struct iscsi_iser_task *task,
626 enum iser_data_dir dir);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300627
Sagi Grimbergcd886212014-10-01 14:02:15 +0300628int iser_connect(struct iser_conn *iser_conn,
629 struct sockaddr *src_addr,
630 struct sockaddr *dst_addr,
631 int non_blocking);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300632
Sagi Grimberge6575712013-07-28 12:35:41 +0300633void iser_unreg_mem_fmr(struct iscsi_iser_task *iser_task,
634 enum iser_data_dir cmd_dir);
Sagi Grimberg7306b8f2014-03-05 19:43:39 +0200635void iser_unreg_mem_fastreg(struct iscsi_iser_task *iser_task,
636 enum iser_data_dir cmd_dir);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300637
Sagi Grimberg5716af62014-10-01 14:01:57 +0300638int iser_post_recvl(struct iser_conn *iser_conn);
639int iser_post_recvm(struct iser_conn *iser_conn, int count);
Sagi Grimberg6df5a122014-10-01 14:02:12 +0300640int iser_post_send(struct ib_conn *ib_conn, struct iser_tx_desc *tx_desc,
641 bool signal);
Or Gerlitz49cd5382006-05-11 10:00:21 +0300642
Mike Christie2261ec32008-05-21 15:54:11 -0500643int iser_dma_map_task_data(struct iscsi_iser_task *iser_task,
Sagi Grimbergcd886212014-10-01 14:02:15 +0300644 struct iser_data_buf *data,
645 enum iser_data_dir iser_dir,
646 enum dma_data_direction dma_dir);
Erez Zilber74a20782006-09-27 16:43:06 +0300647
Sagi Grimberg9a8b08f2014-03-05 19:43:44 +0200648void iser_dma_unmap_task_data(struct iscsi_iser_task *iser_task,
Roi Dayanc6c95ef2014-12-28 14:26:11 +0200649 struct iser_data_buf *data,
650 enum dma_data_direction dir);
651
Or Gerlitzf19624a2010-02-08 13:19:56 +0000652int iser_initialize_task_headers(struct iscsi_task *task,
653 struct iser_tx_desc *tx_desc);
Sagi Grimberg5716af62014-10-01 14:01:57 +0300654int iser_alloc_rx_descriptors(struct iser_conn *iser_conn,
655 struct iscsi_session *session);
Sagi Grimbergf8db6512015-08-06 18:33:03 +0300656int iser_alloc_fmr_pool(struct ib_conn *ib_conn,
657 unsigned cmds_max,
658 unsigned int size);
Sagi Grimberga4ee3532014-10-01 14:01:58 +0300659void iser_free_fmr_pool(struct ib_conn *ib_conn);
Sagi Grimbergf8db6512015-08-06 18:33:03 +0300660int iser_alloc_fastreg_pool(struct ib_conn *ib_conn,
661 unsigned cmds_max,
662 unsigned int size);
Sagi Grimberga4ee3532014-10-01 14:01:58 +0300663void iser_free_fastreg_pool(struct ib_conn *ib_conn);
Sagi Grimberg0a7a08a2014-03-05 19:43:50 +0200664u8 iser_check_task_pi_status(struct iscsi_iser_task *iser_task,
665 enum iser_data_dir cmd_dir, sector_t *sector);
Sagi Grimberg5190cc22015-08-06 18:32:54 +0300666struct iser_fr_desc *
Sagi Grimberg81722902015-08-06 18:33:01 +0300667iser_reg_desc_get_fr(struct ib_conn *ib_conn);
Sagi Grimbergbd8b9442015-04-14 18:08:21 +0300668void
Sagi Grimberg81722902015-08-06 18:33:01 +0300669iser_reg_desc_put_fr(struct ib_conn *ib_conn,
670 struct iser_fr_desc *desc);
671struct iser_fr_desc *
672iser_reg_desc_get_fmr(struct ib_conn *ib_conn);
673void
674iser_reg_desc_put_fmr(struct ib_conn *ib_conn,
675 struct iser_fr_desc *desc);
Sagi Grimberg7332bed2015-08-06 18:33:06 +0300676
677static inline struct ib_send_wr *
678iser_tx_next_wr(struct iser_tx_desc *tx_desc)
679{
Christoph Hellwige622f2f2015-10-08 09:16:33 +0100680 struct ib_send_wr *cur_wr = &tx_desc->wrs[tx_desc->wr_idx].send;
Sagi Grimberg7332bed2015-08-06 18:33:06 +0300681 struct ib_send_wr *last_wr;
682
683 if (tx_desc->wr_idx) {
Christoph Hellwige622f2f2015-10-08 09:16:33 +0100684 last_wr = &tx_desc->wrs[tx_desc->wr_idx - 1].send;
Sagi Grimberg7332bed2015-08-06 18:33:06 +0300685 last_wr->next = cur_wr;
686 }
687 tx_desc->wr_idx++;
688
689 return cur_wr;
690}
691
Sagi Grimberg7edc5a92015-11-04 10:50:32 +0200692static inline struct iser_conn *
693to_iser_conn(struct ib_conn *ib_conn)
694{
695 return container_of(ib_conn, struct iser_conn, ib_conn);
696}
697
Christoph Hellwigcfeb91b2015-12-11 11:54:28 -0800698static inline struct iser_rx_desc *
699iser_rx(struct ib_cqe *cqe)
700{
701 return container_of(cqe, struct iser_rx_desc, cqe);
702}
703
704static inline struct iser_tx_desc *
705iser_tx(struct ib_cqe *cqe)
706{
707 return container_of(cqe, struct iser_tx_desc, cqe);
708}
709
710static inline struct iser_login_desc *
711iser_login(struct ib_cqe *cqe)
712{
713 return container_of(cqe, struct iser_login_desc, cqe);
714}
715
Or Gerlitz49cd5382006-05-11 10:00:21 +0300716#endif