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 ": "
72 #define DRV_VER "1.4.8"
74 #define iser_dbg(fmt, arg...) \
76 if (iser_debug_level > 2) \
77 printk(KERN_DEBUG PFX "%s: " fmt,\
81 #define iser_warn(fmt, arg...) \
83 if (iser_debug_level > 0) \
84 pr_warn(PFX "%s: " fmt, \
88 #define iser_info(fmt, arg...) \
90 if (iser_debug_level > 1) \
91 pr_info(PFX "%s: " fmt, \
95 #define iser_err(fmt, arg...) \
97 printk(KERN_ERR PFX "%s: " fmt, \
102 #define SIZE_4K (1ULL << SHIFT_4K)
103 #define MASK_4K (~(SIZE_4K-1))
104 /* support up to 512KB in one RDMA */
105 #define ISCSI_ISER_SG_TABLESIZE (0x80000 >> SHIFT_4K)
106 #define ISER_DEF_XMIT_CMDS_DEFAULT 512
107 #if ISCSI_DEF_XMIT_CMDS_MAX > ISER_DEF_XMIT_CMDS_DEFAULT
108 #define ISER_DEF_XMIT_CMDS_MAX ISCSI_DEF_XMIT_CMDS_MAX
110 #define ISER_DEF_XMIT_CMDS_MAX ISER_DEF_XMIT_CMDS_DEFAULT
112 #define ISER_DEF_CMD_PER_LUN ISER_DEF_XMIT_CMDS_MAX
115 /* Maximal bounds on received asynchronous PDUs */
116 #define ISER_MAX_RX_MISC_PDUS 4 /* NOOP_IN(2) , ASYNC_EVENT(2) */
118 #define ISER_MAX_TX_MISC_PDUS 6 /* NOOP_OUT(2), TEXT(1), *
119 * SCSI_TMFUNC(2), LOGOUT(1) */
121 #define ISER_QP_MAX_RECV_DTOS (ISER_DEF_XMIT_CMDS_MAX)
123 #define ISER_MIN_POSTED_RX (ISER_DEF_XMIT_CMDS_MAX >> 2)
125 /* the max TX (send) WR supported by the iSER QP is defined by *
126 * max_send_wr = T * (1 + D) + C ; D is how many inflight dataouts we expect *
127 * to have at max for SCSI command. The tx posting & completion handling code *
128 * supports -EAGAIN scheme where tx is suspended till the QP has room for more *
129 * send WR. D=8 comes from 64K/8K */
131 #define ISER_INFLIGHT_DATAOUTS 8
133 #define ISER_QP_MAX_REQ_DTOS (ISER_DEF_XMIT_CMDS_MAX * \
134 (1 + ISER_INFLIGHT_DATAOUTS) + \
135 ISER_MAX_TX_MISC_PDUS + \
136 ISER_MAX_RX_MISC_PDUS)
138 /* Max registration work requests per command */
139 #define ISER_MAX_REG_WR_PER_CMD 5
141 /* For Signature we don't support DATAOUTs so no need to make room for them */
142 #define ISER_QP_SIG_MAX_REQ_DTOS (ISER_DEF_XMIT_CMDS_MAX * \
143 (1 + ISER_MAX_REG_WR_PER_CMD) + \
144 ISER_MAX_TX_MISC_PDUS + \
145 ISER_MAX_RX_MISC_PDUS)
147 #define ISER_GET_MAX_XMIT_CMDS(send_wr) ((send_wr \
148 - ISER_MAX_TX_MISC_PDUS \
149 - ISER_MAX_RX_MISC_PDUS) / \
150 (1 + ISER_INFLIGHT_DATAOUTS))
152 #define ISER_WC_BATCH_COUNT 16
153 #define ISER_SIGNAL_CMD_COUNT 32
155 #define ISER_VER 0x10
156 #define ISER_WSV 0x08
157 #define ISER_RSV 0x04
159 #define ISER_FASTREG_LI_WRID 0xffffffffffffffffULL
160 #define ISER_BEACON_WRID 0xfffffffffffffffeULL
163 * struct iser_hdr - iSER header
165 * @flags: flags support (zbva, remote_inv)
167 * @write_stag: write rkey
168 * @write_va: write virtual address
169 * @reaf_stag: read rkey
170 * @read_va: read virtual address
179 } __attribute__((packed));
182 #define ISER_ZBVA_NOT_SUPPORTED 0x80
183 #define ISER_SEND_W_INV_NOT_SUPPORTED 0x40
190 /* Constant PDU lengths calculations */
191 #define ISER_HEADERS_LEN (sizeof(struct iser_hdr) + sizeof(struct iscsi_hdr))
193 #define ISER_RECV_DATA_SEG_LEN 128
194 #define ISER_RX_PAYLOAD_SIZE (ISER_HEADERS_LEN + ISER_RECV_DATA_SEG_LEN)
195 #define ISER_RX_LOGIN_SIZE (ISER_HEADERS_LEN + ISCSI_DEF_MAX_RECV_SEG_LEN)
197 /* Length of an object name string */
198 #define ISER_OBJECT_NAME_SIZE 64
200 enum iser_conn_state {
201 ISER_CONN_INIT, /* descriptor allocd, no conn */
202 ISER_CONN_PENDING, /* in the process of being established */
203 ISER_CONN_UP, /* up and running */
204 ISER_CONN_TERMINATING, /* in the process of being terminated */
205 ISER_CONN_DOWN, /* shut down */
209 enum iser_task_status {
210 ISER_TASK_STATUS_INIT = 0,
211 ISER_TASK_STATUS_STARTED,
212 ISER_TASK_STATUS_COMPLETED
216 ISER_DIR_IN = 0, /* to initiator */
217 ISER_DIR_OUT, /* from initiator */
222 * struct iser_data_buf - iSER data buffer
224 * @buf: pointer to the sg list
225 * @size: num entries of this sg
226 * @data_len: total beffer byte len
227 * @dma_nents: returned by dma_map_sg
228 * @copy_buf: allocated copy buf for SGs unaligned
229 * for rdma which are copied
230 * @sg_single: SG-ified clone of a non SG SC or
233 struct iser_data_buf {
236 unsigned long data_len;
237 unsigned int dma_nents;
239 struct scatterlist sg_single;
242 /* fwd declarations */
244 struct iscsi_iser_task;
245 struct iscsi_endpoint;
248 * struct iser_mem_reg - iSER memory registration info
250 * @lkey: MR local key
251 * @rkey: MR remote key
252 * @va: MR start address (buffer va)
254 * @mem_h: pointer to registration context (FMR/Fastreg)
255 * @is_mr: indicates weather we registered the buffer
257 struct iser_mem_reg {
267 * struct iser_regd_buf - iSER buffer registration desc
269 * @reg: memory registration info
270 * @virt_addr: virtual address of buffer
271 * @device: reference to iser device
272 * @direction: dma direction (for dma_unmap)
273 * @data_size: data buffer size in bytes
275 struct iser_regd_buf {
276 struct iser_mem_reg reg;
278 struct iser_device *device;
279 enum dma_data_direction direction;
280 unsigned int data_size;
283 enum iser_desc_type {
285 ISCSI_TX_SCSI_COMMAND,
290 * struct iser_tx_desc - iSER TX descriptor (for send wr_id)
292 * @iser_header: iser header
293 * @iscsi_header: iscsi header
294 * @type: command/control/dataout
295 * @dam_addr: header buffer dma_address
296 * @tx_sg: sg[0] points to iser/iscsi headers
297 * sg[1] optionally points to either of immediate data
298 * unsolicited data-out or control
299 * @num_sge: number sges used on this TX task
301 struct iser_tx_desc {
302 struct iser_hdr iser_header;
303 struct iscsi_hdr iscsi_header;
304 enum iser_desc_type type;
306 struct ib_sge tx_sg[2];
310 #define ISER_RX_PAD_SIZE (256 - (ISER_RX_PAYLOAD_SIZE + \
311 sizeof(u64) + sizeof(struct ib_sge)))
313 * struct iser_rx_desc - iSER RX descriptor (for recv wr_id)
315 * @iser_header: iser header
316 * @iscsi_header: iscsi header
317 * @data: received data segment
318 * @dma_addr: receive buffer dma address
319 * @rx_sg: ib_sge of receive buffer
320 * @pad: for sense data TODO: Modify to maximum sense length supported
322 struct iser_rx_desc {
323 struct iser_hdr iser_header;
324 struct iscsi_hdr iscsi_header;
325 char data[ISER_RECV_DATA_SEG_LEN];
328 char pad[ISER_RX_PAD_SIZE];
329 } __attribute__((packed));
331 #define ISER_MAX_CQ 4
335 struct iscsi_iser_task;
338 * struct iser_comp - iSER completion context
340 * @device: pointer to device handle
341 * @cq: completion queue
342 * @wcs: work completion array
343 * @tasklet: Tasklet handle
344 * @active_qps: Number of active QPs attached
345 * to completion context
348 struct iser_device *device;
350 struct ib_wc wcs[ISER_WC_BATCH_COUNT];
351 struct tasklet_struct tasklet;
356 * struct iser_device - iSER device handle
358 * @ib_device: RDMA device
359 * @pd: Protection Domain for this device
360 * @dev_attr: Device attributes container
361 * @mr: Global DMA memory region
362 * @event_handler: IB events handle routine
363 * @ig_list: entry in devices list
364 * @refcount: Reference counter, dominated by open iser connections
365 * @comps_used: Number of completion contexts used, Min between online
366 * cpus and device max completion vectors
367 * @comps: Dinamically allocated array of completion handlers
368 * Memory registration pool Function pointers (FMR or Fastreg):
369 * @iser_alloc_rdma_reg_res: Allocation of memory regions pool
370 * @iser_free_rdma_reg_res: Free of memory regions pool
371 * @iser_reg_rdma_mem: Memory registration routine
372 * @iser_unreg_rdma_mem: Memory deregistration routine
375 struct ib_device *ib_device;
377 struct ib_device_attr dev_attr;
379 struct ib_event_handler event_handler;
380 struct list_head ig_list;
383 struct iser_comp comps[ISER_MAX_CQ];
384 int (*iser_alloc_rdma_reg_res)(struct ib_conn *ib_conn,
386 void (*iser_free_rdma_reg_res)(struct ib_conn *ib_conn);
387 int (*iser_reg_rdma_mem)(struct iscsi_iser_task *iser_task,
388 enum iser_data_dir cmd_dir);
389 void (*iser_unreg_rdma_mem)(struct iscsi_iser_task *iser_task,
390 enum iser_data_dir cmd_dir);
393 #define ISER_CHECK_GUARD 0xc0
394 #define ISER_CHECK_REFTAG 0x0f
395 #define ISER_CHECK_APPTAG 0x30
397 enum iser_reg_indicator {
398 ISER_DATA_KEY_VALID = 1 << 0,
399 ISER_PROT_KEY_VALID = 1 << 1,
400 ISER_SIG_KEY_VALID = 1 << 2,
401 ISER_FASTREG_PROTECTED = 1 << 3,
405 * struct iser_pi_context - Protection information context
407 * @prot_mr: protection memory region
408 * @prot_frpl: protection fastreg page list
409 * @sig_mr: signature feature enabled memory region
411 struct iser_pi_context {
412 struct ib_mr *prot_mr;
413 struct ib_fast_reg_page_list *prot_frpl;
414 struct ib_mr *sig_mr;
418 * struct fast_reg_descriptor - Fast registration descriptor
420 * @list: entry in connection fastreg pool
421 * @data_mr: data memory region
422 * @data_frpl: data fastreg page list
423 * @pi_ctx: protection information context
424 * @reg_indicators: fast registration indicators
426 struct fast_reg_descriptor {
427 struct list_head list;
428 struct ib_mr *data_mr;
429 struct ib_fast_reg_page_list *data_frpl;
430 struct iser_pi_context *pi_ctx;
435 * struct ib_conn - Infiniband related objects
437 * @cma_id: rdma_cm connection maneger handle
438 * @qp: Connection Queue-pair
439 * @post_recv_buf_count: post receive counter
440 * @sig_count: send work request signal count
441 * @rx_wr: receive work request for batch posts
442 * @device: reference to iser device
443 * @comp: iser completion context
444 * @pi_support: Indicate device T10-PI support
445 * @beacon: beacon send wr to signal all flush errors were drained
446 * @flush_comp: completes when all connection completions consumed
447 * @lock: protects fmr/fastreg pool
449 * @pool: FMR pool for fast registrations
450 * @page_vec: page vector to hold mapped commands pages
451 * used for registration
453 * @pool: Fast registration descriptors pool for fast
455 * @pool_size: Size of pool
458 struct rdma_cm_id *cma_id;
460 int post_recv_buf_count;
462 struct ib_recv_wr rx_wr[ISER_MIN_POSTED_RX];
463 struct iser_device *device;
464 struct iser_comp *comp;
466 struct ib_send_wr beacon;
467 struct completion flush_comp;
471 struct ib_fmr_pool *pool;
472 struct iser_page_vec *page_vec;
475 struct list_head pool;
482 * struct iser_conn - iSER connection context
484 * @ib_conn: connection RDMA resources
485 * @iscsi_conn: link to matching iscsi connection
486 * @ep: transport handle
487 * @state: connection logical state
488 * @qp_max_recv_dtos: maximum number of data outs, corresponds
489 * to max number of post recvs
490 * @qp_max_recv_dtos_mask: (qp_max_recv_dtos - 1)
491 * @min_posted_rx: (qp_max_recv_dtos >> 2)
492 * @max_cmds: maximum cmds allowed for this connection
493 * @name: connection peer portal
494 * @release_work: deffered work for release job
495 * @state_mutex: protects iser onnection state
496 * @stop_completion: conn_stop completion
497 * @ib_completion: RDMA cleanup completion
498 * @up_completion: connection establishment completed
499 * (state is ISER_CONN_UP)
500 * @conn_list: entry in ig conn list
501 * @login_buf: login data buffer (stores login parameters)
502 * @login_req_buf: login request buffer
503 * @login_req_dma: login request buffer dma address
504 * @login_resp_buf: login response buffer
505 * @login_resp_dma: login response buffer dma address
506 * @rx_desc_head: head of rx_descs cyclic buffer
507 * @rx_descs: rx buffers array (cyclic buffer)
508 * @num_rx_descs: number of rx descriptors
511 struct ib_conn ib_conn;
512 struct iscsi_conn *iscsi_conn;
513 struct iscsi_endpoint *ep;
514 enum iser_conn_state state;
515 unsigned qp_max_recv_dtos;
516 unsigned qp_max_recv_dtos_mask;
517 unsigned min_posted_rx;
519 char name[ISER_OBJECT_NAME_SIZE];
520 struct work_struct release_work;
521 struct mutex state_mutex;
522 struct completion stop_completion;
523 struct completion ib_completion;
524 struct completion up_completion;
525 struct list_head conn_list;
528 char *login_req_buf, *login_resp_buf;
529 u64 login_req_dma, login_resp_dma;
530 unsigned int rx_desc_head;
531 struct iser_rx_desc *rx_descs;
536 * struct iscsi_iser_task - iser task context
538 * @desc: TX descriptor
539 * @iser_conn: link to iser connection
540 * @status: current task status
541 * @sc: link to scsi command
542 * @command_sent: indicate if command was sent
543 * @dir: iser data direction
544 * @rdma_regd: task rdma registration desc
545 * @data: iser data buffer desc
546 * @data_copy: iser data copy buffer desc (bounce buffer)
547 * @prot: iser protection buffer desc
548 * @prot_copy: iser protection copy buffer desc (bounce buffer)
550 struct iscsi_iser_task {
551 struct iser_tx_desc desc;
552 struct iser_conn *iser_conn;
553 enum iser_task_status status;
554 struct scsi_cmnd *sc;
556 int dir[ISER_DIRS_NUM];
557 struct iser_regd_buf rdma_regd[ISER_DIRS_NUM];
558 struct iser_data_buf data[ISER_DIRS_NUM];
559 struct iser_data_buf data_copy[ISER_DIRS_NUM];
560 struct iser_data_buf prot[ISER_DIRS_NUM];
561 struct iser_data_buf prot_copy[ISER_DIRS_NUM];
564 struct iser_page_vec {
572 * struct iser_global: iSER global context
574 * @device_list_mutex: protects device_list
575 * @device_list: iser devices global list
576 * @connlist_mutex: protects connlist
577 * @connlist: iser connections global list
578 * @desc_cache: kmem cache for tx dataout
581 struct mutex device_list_mutex;
582 struct list_head device_list;
583 struct mutex connlist_mutex;
584 struct list_head connlist;
585 struct kmem_cache *desc_cache;
588 extern struct iser_global ig;
589 extern int iser_debug_level;
590 extern bool iser_pi_enable;
591 extern int iser_pi_guard;
593 int iser_send_control(struct iscsi_conn *conn,
594 struct iscsi_task *task);
596 int iser_send_command(struct iscsi_conn *conn,
597 struct iscsi_task *task);
599 int iser_send_data_out(struct iscsi_conn *conn,
600 struct iscsi_task *task,
601 struct iscsi_data *hdr);
603 void iscsi_iser_recv(struct iscsi_conn *conn,
604 struct iscsi_hdr *hdr,
608 void iser_conn_init(struct iser_conn *iser_conn);
610 void iser_conn_release(struct iser_conn *iser_conn);
612 int iser_conn_terminate(struct iser_conn *iser_conn);
614 void iser_release_work(struct work_struct *work);
616 void iser_rcv_completion(struct iser_rx_desc *desc,
617 unsigned long dto_xfer_len,
618 struct ib_conn *ib_conn);
620 void iser_snd_completion(struct iser_tx_desc *desc,
621 struct ib_conn *ib_conn);
623 void iser_task_rdma_init(struct iscsi_iser_task *task);
625 void iser_task_rdma_finalize(struct iscsi_iser_task *task);
627 void iser_free_rx_descriptors(struct iser_conn *iser_conn);
629 void iser_finalize_rdma_unaligned_sg(struct iscsi_iser_task *iser_task,
630 struct iser_data_buf *mem,
631 struct iser_data_buf *mem_copy,
632 enum iser_data_dir cmd_dir);
634 int iser_reg_rdma_mem_fmr(struct iscsi_iser_task *task,
635 enum iser_data_dir cmd_dir);
636 int iser_reg_rdma_mem_fastreg(struct iscsi_iser_task *task,
637 enum iser_data_dir cmd_dir);
639 int iser_connect(struct iser_conn *iser_conn,
640 struct sockaddr *src_addr,
641 struct sockaddr *dst_addr,
644 int iser_reg_page_vec(struct ib_conn *ib_conn,
645 struct iser_page_vec *page_vec,
646 struct iser_mem_reg *mem_reg);
648 void iser_unreg_mem_fmr(struct iscsi_iser_task *iser_task,
649 enum iser_data_dir cmd_dir);
650 void iser_unreg_mem_fastreg(struct iscsi_iser_task *iser_task,
651 enum iser_data_dir cmd_dir);
653 int iser_post_recvl(struct iser_conn *iser_conn);
654 int iser_post_recvm(struct iser_conn *iser_conn, int count);
655 int iser_post_send(struct ib_conn *ib_conn, struct iser_tx_desc *tx_desc,
658 int iser_dma_map_task_data(struct iscsi_iser_task *iser_task,
659 struct iser_data_buf *data,
660 enum iser_data_dir iser_dir,
661 enum dma_data_direction dma_dir);
663 void iser_dma_unmap_task_data(struct iscsi_iser_task *iser_task,
664 struct iser_data_buf *data);
665 int iser_initialize_task_headers(struct iscsi_task *task,
666 struct iser_tx_desc *tx_desc);
667 int iser_alloc_rx_descriptors(struct iser_conn *iser_conn,
668 struct iscsi_session *session);
669 int iser_create_fmr_pool(struct ib_conn *ib_conn, unsigned cmds_max);
670 void iser_free_fmr_pool(struct ib_conn *ib_conn);
671 int iser_create_fastreg_pool(struct ib_conn *ib_conn, unsigned cmds_max);
672 void iser_free_fastreg_pool(struct ib_conn *ib_conn);
673 u8 iser_check_task_pi_status(struct iscsi_iser_task *iser_task,
674 enum iser_data_dir cmd_dir, sector_t *sector);