2 * iSER transport for the Open iSCSI Initiator & iSER transport internals
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
9 * Copyright (c) 2004, 2005, 2006 Voltaire, Inc. All rights reserved.
10 * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
11 * Copyright (c) 2013-2014 Mellanox Technologies. All rights reserved.
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:
19 * Redistribution and use in source and binary forms, with or
20 * without modification, are permitted provided that the following
23 * - Redistributions of source code must retain the above
24 * copyright notice, this list of conditions and the following
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.
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
41 #ifndef __ISCSI_ISER_H__
42 #define __ISCSI_ISER_H__
44 #include <linux/types.h>
45 #include <linux/net.h>
46 #include <linux/printk.h>
47 #include <scsi/libiscsi.h>
48 #include <scsi/scsi_transport_iscsi.h>
49 #include <scsi/scsi_cmnd.h>
50 #include <scsi/scsi_device.h>
52 #include <linux/interrupt.h>
53 #include <linux/wait.h>
54 #include <linux/sched.h>
55 #include <linux/list.h>
56 #include <linux/slab.h>
57 #include <linux/dma-mapping.h>
58 #include <linux/mutex.h>
59 #include <linux/mempool.h>
60 #include <linux/uio.h>
62 #include <linux/socket.h>
64 #include <linux/in6.h>
66 #include <rdma/ib_verbs.h>
67 #include <rdma/ib_fmr_pool.h>
68 #include <rdma/rdma_cm.h>
70 #define DRV_NAME "iser"
71 #define PFX DRV_NAME ": "
74 #define iser_dbg(fmt, arg...) \
76 if (unlikely(iser_debug_level > 2)) \
77 printk(KERN_DEBUG PFX "%s: " fmt,\
81 #define iser_warn(fmt, arg...) \
83 if (unlikely(iser_debug_level > 0)) \
84 pr_warn(PFX "%s: " fmt, \
88 #define iser_info(fmt, arg...) \
90 if (unlikely(iser_debug_level > 1)) \
91 pr_info(PFX "%s: " fmt, \
95 #define iser_err(fmt, arg...) \
96 pr_err(PFX "%s: " fmt, __func__ , ## arg)
99 #define SIZE_4K (1ULL << SHIFT_4K)
100 #define MASK_4K (~(SIZE_4K-1))
101 /* support up to 512KB in one RDMA */
102 #define ISCSI_ISER_SG_TABLESIZE (0x80000 >> SHIFT_4K)
103 #define ISER_DEF_XMIT_CMDS_DEFAULT 512
104 #if ISCSI_DEF_XMIT_CMDS_MAX > ISER_DEF_XMIT_CMDS_DEFAULT
105 #define ISER_DEF_XMIT_CMDS_MAX ISCSI_DEF_XMIT_CMDS_MAX
107 #define ISER_DEF_XMIT_CMDS_MAX ISER_DEF_XMIT_CMDS_DEFAULT
109 #define ISER_DEF_CMD_PER_LUN ISER_DEF_XMIT_CMDS_MAX
112 /* Maximal bounds on received asynchronous PDUs */
113 #define ISER_MAX_RX_MISC_PDUS 4 /* NOOP_IN(2) , ASYNC_EVENT(2) */
115 #define ISER_MAX_TX_MISC_PDUS 6 /* NOOP_OUT(2), TEXT(1), *
116 * SCSI_TMFUNC(2), LOGOUT(1) */
118 #define ISER_QP_MAX_RECV_DTOS (ISER_DEF_XMIT_CMDS_MAX)
120 #define ISER_MIN_POSTED_RX (ISER_DEF_XMIT_CMDS_MAX >> 2)
122 /* the max TX (send) WR supported by the iSER QP is defined by *
123 * max_send_wr = T * (1 + D) + C ; D is how many inflight dataouts we expect *
124 * to have at max for SCSI command. The tx posting & completion handling code *
125 * supports -EAGAIN scheme where tx is suspended till the QP has room for more *
126 * send WR. D=8 comes from 64K/8K */
128 #define ISER_INFLIGHT_DATAOUTS 8
130 #define ISER_QP_MAX_REQ_DTOS (ISER_DEF_XMIT_CMDS_MAX * \
131 (1 + ISER_INFLIGHT_DATAOUTS) + \
132 ISER_MAX_TX_MISC_PDUS + \
133 ISER_MAX_RX_MISC_PDUS)
135 /* Max registration work requests per command */
136 #define ISER_MAX_REG_WR_PER_CMD 5
138 /* For Signature we don't support DATAOUTs so no need to make room for them */
139 #define ISER_QP_SIG_MAX_REQ_DTOS (ISER_DEF_XMIT_CMDS_MAX * \
140 (1 + ISER_MAX_REG_WR_PER_CMD) + \
141 ISER_MAX_TX_MISC_PDUS + \
142 ISER_MAX_RX_MISC_PDUS)
144 #define ISER_GET_MAX_XMIT_CMDS(send_wr) ((send_wr \
145 - ISER_MAX_TX_MISC_PDUS \
146 - ISER_MAX_RX_MISC_PDUS) / \
147 (1 + ISER_INFLIGHT_DATAOUTS))
149 #define ISER_WC_BATCH_COUNT 16
150 #define ISER_SIGNAL_CMD_COUNT 32
152 #define ISER_VER 0x10
153 #define ISER_WSV 0x08
154 #define ISER_RSV 0x04
156 #define ISER_FASTREG_LI_WRID 0xffffffffffffffffULL
157 #define ISER_BEACON_WRID 0xfffffffffffffffeULL
160 * struct iser_hdr - iSER header
162 * @flags: flags support (zbva, remote_inv)
164 * @write_stag: write rkey
165 * @write_va: write virtual address
166 * @reaf_stag: read rkey
167 * @read_va: read virtual address
176 } __attribute__((packed));
179 #define ISER_ZBVA_NOT_SUPPORTED 0x80
180 #define ISER_SEND_W_INV_NOT_SUPPORTED 0x40
187 /* Constant PDU lengths calculations */
188 #define ISER_HEADERS_LEN (sizeof(struct iser_hdr) + sizeof(struct iscsi_hdr))
190 #define ISER_RECV_DATA_SEG_LEN 128
191 #define ISER_RX_PAYLOAD_SIZE (ISER_HEADERS_LEN + ISER_RECV_DATA_SEG_LEN)
192 #define ISER_RX_LOGIN_SIZE (ISER_HEADERS_LEN + ISCSI_DEF_MAX_RECV_SEG_LEN)
194 /* Length of an object name string */
195 #define ISER_OBJECT_NAME_SIZE 64
197 enum iser_conn_state {
198 ISER_CONN_INIT, /* descriptor allocd, no conn */
199 ISER_CONN_PENDING, /* in the process of being established */
200 ISER_CONN_UP, /* up and running */
201 ISER_CONN_TERMINATING, /* in the process of being terminated */
202 ISER_CONN_DOWN, /* shut down */
206 enum iser_task_status {
207 ISER_TASK_STATUS_INIT = 0,
208 ISER_TASK_STATUS_STARTED,
209 ISER_TASK_STATUS_COMPLETED
213 ISER_DIR_IN = 0, /* to initiator */
214 ISER_DIR_OUT, /* from initiator */
219 * struct iser_data_buf - iSER data buffer
221 * @buf: pointer to the sg list
222 * @size: num entries of this sg
223 * @data_len: total beffer byte len
224 * @dma_nents: returned by dma_map_sg
225 * @copy_buf: allocated copy buf for SGs unaligned
226 * for rdma which are copied
227 * @sg_single: SG-ified clone of a non SG SC or
230 struct iser_data_buf {
233 unsigned long data_len;
234 unsigned int dma_nents;
236 struct scatterlist sg_single;
239 /* fwd declarations */
241 struct iscsi_iser_task;
242 struct iscsi_endpoint;
245 * struct iser_mem_reg - iSER memory registration info
247 * @lkey: MR local key
248 * @rkey: MR remote key
249 * @va: MR start address (buffer va)
251 * @mem_h: pointer to registration context (FMR/Fastreg)
253 struct iser_mem_reg {
262 * struct iser_regd_buf - iSER buffer registration desc
264 * @reg: memory registration info
265 * @virt_addr: virtual address of buffer
266 * @device: reference to iser device
267 * @direction: dma direction (for dma_unmap)
268 * @data_size: data buffer size in bytes
270 struct iser_regd_buf {
271 struct iser_mem_reg reg;
273 struct iser_device *device;
274 enum dma_data_direction direction;
275 unsigned int data_size;
278 enum iser_desc_type {
280 ISCSI_TX_SCSI_COMMAND,
285 * struct iser_tx_desc - iSER TX descriptor (for send wr_id)
287 * @iser_header: iser header
288 * @iscsi_header: iscsi header
289 * @type: command/control/dataout
290 * @dam_addr: header buffer dma_address
291 * @tx_sg: sg[0] points to iser/iscsi headers
292 * sg[1] optionally points to either of immediate data
293 * unsolicited data-out or control
294 * @num_sge: number sges used on this TX task
296 struct iser_tx_desc {
297 struct iser_hdr iser_header;
298 struct iscsi_hdr iscsi_header;
299 enum iser_desc_type type;
301 struct ib_sge tx_sg[2];
305 #define ISER_RX_PAD_SIZE (256 - (ISER_RX_PAYLOAD_SIZE + \
306 sizeof(u64) + sizeof(struct ib_sge)))
308 * struct iser_rx_desc - iSER RX descriptor (for recv wr_id)
310 * @iser_header: iser header
311 * @iscsi_header: iscsi header
312 * @data: received data segment
313 * @dma_addr: receive buffer dma address
314 * @rx_sg: ib_sge of receive buffer
315 * @pad: for sense data TODO: Modify to maximum sense length supported
317 struct iser_rx_desc {
318 struct iser_hdr iser_header;
319 struct iscsi_hdr iscsi_header;
320 char data[ISER_RECV_DATA_SEG_LEN];
323 char pad[ISER_RX_PAD_SIZE];
324 } __attribute__((packed));
328 struct iscsi_iser_task;
331 * struct iser_comp - iSER completion context
333 * @device: pointer to device handle
334 * @cq: completion queue
335 * @wcs: work completion array
336 * @tasklet: Tasklet handle
337 * @active_qps: Number of active QPs attached
338 * to completion context
341 struct iser_device *device;
343 struct ib_wc wcs[ISER_WC_BATCH_COUNT];
344 struct tasklet_struct tasklet;
349 * struct iser_device - iSER device handle
351 * @ib_device: RDMA device
352 * @pd: Protection Domain for this device
353 * @dev_attr: Device attributes container
354 * @mr: Global DMA memory region
355 * @event_handler: IB events handle routine
356 * @ig_list: entry in devices list
357 * @refcount: Reference counter, dominated by open iser connections
358 * @comps_used: Number of completion contexts used, Min between online
359 * cpus and device max completion vectors
360 * @comps: Dinamically allocated array of completion handlers
361 * Memory registration pool Function pointers (FMR or Fastreg):
362 * @iser_alloc_rdma_reg_res: Allocation of memory regions pool
363 * @iser_free_rdma_reg_res: Free of memory regions pool
364 * @iser_reg_rdma_mem: Memory registration routine
365 * @iser_unreg_rdma_mem: Memory deregistration routine
368 struct ib_device *ib_device;
370 struct ib_device_attr dev_attr;
372 struct ib_event_handler event_handler;
373 struct list_head ig_list;
376 struct iser_comp *comps;
377 int (*iser_alloc_rdma_reg_res)(struct ib_conn *ib_conn,
379 void (*iser_free_rdma_reg_res)(struct ib_conn *ib_conn);
380 int (*iser_reg_rdma_mem)(struct iscsi_iser_task *iser_task,
381 enum iser_data_dir cmd_dir);
382 void (*iser_unreg_rdma_mem)(struct iscsi_iser_task *iser_task,
383 enum iser_data_dir cmd_dir);
386 #define ISER_CHECK_GUARD 0xc0
387 #define ISER_CHECK_REFTAG 0x0f
388 #define ISER_CHECK_APPTAG 0x30
390 enum iser_reg_indicator {
391 ISER_DATA_KEY_VALID = 1 << 0,
392 ISER_PROT_KEY_VALID = 1 << 1,
393 ISER_SIG_KEY_VALID = 1 << 2,
394 ISER_FASTREG_PROTECTED = 1 << 3,
398 * struct iser_pi_context - Protection information context
400 * @prot_mr: protection memory region
401 * @prot_frpl: protection fastreg page list
402 * @sig_mr: signature feature enabled memory region
404 struct iser_pi_context {
405 struct ib_mr *prot_mr;
406 struct ib_fast_reg_page_list *prot_frpl;
407 struct ib_mr *sig_mr;
411 * struct fast_reg_descriptor - Fast registration descriptor
413 * @list: entry in connection fastreg pool
414 * @data_mr: data memory region
415 * @data_frpl: data fastreg page list
416 * @pi_ctx: protection information context
417 * @reg_indicators: fast registration indicators
419 struct fast_reg_descriptor {
420 struct list_head list;
421 struct ib_mr *data_mr;
422 struct ib_fast_reg_page_list *data_frpl;
423 struct iser_pi_context *pi_ctx;
428 * struct ib_conn - Infiniband related objects
430 * @cma_id: rdma_cm connection maneger handle
431 * @qp: Connection Queue-pair
432 * @post_recv_buf_count: post receive counter
433 * @sig_count: send work request signal count
434 * @rx_wr: receive work request for batch posts
435 * @device: reference to iser device
436 * @comp: iser completion context
437 * @pi_support: Indicate device T10-PI support
438 * @beacon: beacon send wr to signal all flush errors were drained
439 * @flush_comp: completes when all connection completions consumed
440 * @lock: protects fmr/fastreg pool
442 * @pool: FMR pool for fast registrations
443 * @page_vec: page vector to hold mapped commands pages
444 * used for registration
446 * @pool: Fast registration descriptors pool for fast
448 * @pool_size: Size of pool
451 struct rdma_cm_id *cma_id;
453 int post_recv_buf_count;
455 struct ib_recv_wr rx_wr[ISER_MIN_POSTED_RX];
456 struct iser_device *device;
457 struct iser_comp *comp;
459 struct ib_send_wr beacon;
460 struct completion flush_comp;
464 struct ib_fmr_pool *pool;
465 struct iser_page_vec *page_vec;
468 struct list_head pool;
475 * struct iser_conn - iSER connection context
477 * @ib_conn: connection RDMA resources
478 * @iscsi_conn: link to matching iscsi connection
479 * @ep: transport handle
480 * @state: connection logical state
481 * @qp_max_recv_dtos: maximum number of data outs, corresponds
482 * to max number of post recvs
483 * @qp_max_recv_dtos_mask: (qp_max_recv_dtos - 1)
484 * @min_posted_rx: (qp_max_recv_dtos >> 2)
485 * @max_cmds: maximum cmds allowed for this connection
486 * @name: connection peer portal
487 * @release_work: deffered work for release job
488 * @state_mutex: protects iser onnection state
489 * @stop_completion: conn_stop completion
490 * @ib_completion: RDMA cleanup completion
491 * @up_completion: connection establishment completed
492 * (state is ISER_CONN_UP)
493 * @conn_list: entry in ig conn list
494 * @login_buf: login data buffer (stores login parameters)
495 * @login_req_buf: login request buffer
496 * @login_req_dma: login request buffer dma address
497 * @login_resp_buf: login response buffer
498 * @login_resp_dma: login response buffer dma address
499 * @rx_desc_head: head of rx_descs cyclic buffer
500 * @rx_descs: rx buffers array (cyclic buffer)
501 * @num_rx_descs: number of rx descriptors
504 struct ib_conn ib_conn;
505 struct iscsi_conn *iscsi_conn;
506 struct iscsi_endpoint *ep;
507 enum iser_conn_state state;
508 unsigned qp_max_recv_dtos;
509 unsigned qp_max_recv_dtos_mask;
510 unsigned min_posted_rx;
512 char name[ISER_OBJECT_NAME_SIZE];
513 struct work_struct release_work;
514 struct mutex state_mutex;
515 struct completion stop_completion;
516 struct completion ib_completion;
517 struct completion up_completion;
518 struct list_head conn_list;
521 char *login_req_buf, *login_resp_buf;
522 u64 login_req_dma, login_resp_dma;
523 unsigned int rx_desc_head;
524 struct iser_rx_desc *rx_descs;
529 * struct iscsi_iser_task - iser task context
531 * @desc: TX descriptor
532 * @iser_conn: link to iser connection
533 * @status: current task status
534 * @sc: link to scsi command
535 * @command_sent: indicate if command was sent
536 * @dir: iser data direction
537 * @rdma_regd: task rdma registration desc
538 * @data: iser data buffer desc
539 * @data_copy: iser data copy buffer desc (bounce buffer)
540 * @prot: iser protection buffer desc
541 * @prot_copy: iser protection copy buffer desc (bounce buffer)
543 struct iscsi_iser_task {
544 struct iser_tx_desc desc;
545 struct iser_conn *iser_conn;
546 enum iser_task_status status;
547 struct scsi_cmnd *sc;
549 int dir[ISER_DIRS_NUM];
550 struct iser_regd_buf rdma_regd[ISER_DIRS_NUM];
551 struct iser_data_buf data[ISER_DIRS_NUM];
552 struct iser_data_buf data_copy[ISER_DIRS_NUM];
553 struct iser_data_buf prot[ISER_DIRS_NUM];
554 struct iser_data_buf prot_copy[ISER_DIRS_NUM];
557 struct iser_page_vec {
565 * struct iser_global: iSER global context
567 * @device_list_mutex: protects device_list
568 * @device_list: iser devices global list
569 * @connlist_mutex: protects connlist
570 * @connlist: iser connections global list
571 * @desc_cache: kmem cache for tx dataout
574 struct mutex device_list_mutex;
575 struct list_head device_list;
576 struct mutex connlist_mutex;
577 struct list_head connlist;
578 struct kmem_cache *desc_cache;
581 extern struct iser_global ig;
582 extern int iser_debug_level;
583 extern bool iser_pi_enable;
584 extern int iser_pi_guard;
586 int iser_send_control(struct iscsi_conn *conn,
587 struct iscsi_task *task);
589 int iser_send_command(struct iscsi_conn *conn,
590 struct iscsi_task *task);
592 int iser_send_data_out(struct iscsi_conn *conn,
593 struct iscsi_task *task,
594 struct iscsi_data *hdr);
596 void iscsi_iser_recv(struct iscsi_conn *conn,
597 struct iscsi_hdr *hdr,
601 void iser_conn_init(struct iser_conn *iser_conn);
603 void iser_conn_release(struct iser_conn *iser_conn);
605 int iser_conn_terminate(struct iser_conn *iser_conn);
607 void iser_release_work(struct work_struct *work);
609 void iser_rcv_completion(struct iser_rx_desc *desc,
610 unsigned long dto_xfer_len,
611 struct ib_conn *ib_conn);
613 void iser_snd_completion(struct iser_tx_desc *desc,
614 struct ib_conn *ib_conn);
616 void iser_task_rdma_init(struct iscsi_iser_task *task);
618 void iser_task_rdma_finalize(struct iscsi_iser_task *task);
620 void iser_free_rx_descriptors(struct iser_conn *iser_conn);
622 void iser_finalize_rdma_unaligned_sg(struct iscsi_iser_task *iser_task,
623 struct iser_data_buf *mem,
624 struct iser_data_buf *mem_copy,
625 enum iser_data_dir cmd_dir);
627 int iser_reg_rdma_mem_fmr(struct iscsi_iser_task *task,
628 enum iser_data_dir cmd_dir);
629 int iser_reg_rdma_mem_fastreg(struct iscsi_iser_task *task,
630 enum iser_data_dir cmd_dir);
632 int iser_connect(struct iser_conn *iser_conn,
633 struct sockaddr *src_addr,
634 struct sockaddr *dst_addr,
637 int iser_reg_page_vec(struct ib_conn *ib_conn,
638 struct iser_page_vec *page_vec,
639 struct iser_mem_reg *mem_reg);
641 void iser_unreg_mem_fmr(struct iscsi_iser_task *iser_task,
642 enum iser_data_dir cmd_dir);
643 void iser_unreg_mem_fastreg(struct iscsi_iser_task *iser_task,
644 enum iser_data_dir cmd_dir);
646 int iser_post_recvl(struct iser_conn *iser_conn);
647 int iser_post_recvm(struct iser_conn *iser_conn, int count);
648 int iser_post_send(struct ib_conn *ib_conn, struct iser_tx_desc *tx_desc,
651 int iser_dma_map_task_data(struct iscsi_iser_task *iser_task,
652 struct iser_data_buf *data,
653 enum iser_data_dir iser_dir,
654 enum dma_data_direction dma_dir);
656 void iser_dma_unmap_task_data(struct iscsi_iser_task *iser_task,
657 struct iser_data_buf *data,
658 enum dma_data_direction dir);
660 int iser_initialize_task_headers(struct iscsi_task *task,
661 struct iser_tx_desc *tx_desc);
662 int iser_alloc_rx_descriptors(struct iser_conn *iser_conn,
663 struct iscsi_session *session);
664 int iser_create_fmr_pool(struct ib_conn *ib_conn, unsigned cmds_max);
665 void iser_free_fmr_pool(struct ib_conn *ib_conn);
666 int iser_create_fastreg_pool(struct ib_conn *ib_conn, unsigned cmds_max);
667 void iser_free_fastreg_pool(struct ib_conn *ib_conn);
668 u8 iser_check_task_pi_status(struct iscsi_iser_task *iser_task,
669 enum iser_data_dir cmd_dir, sector_t *sector);