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.
12 * This software is available to you under a choice of one of two
13 * licenses. You may choose to be licensed under the terms of the GNU
14 * General Public License (GPL) Version 2, available from the file
15 * COPYING in the main directory of this source tree, or the
16 * OpenIB.org BSD license below:
18 * Redistribution and use in source and binary forms, with or
19 * without modification, are permitted provided that the following
22 * - Redistributions of source code must retain the above
23 * copyright notice, this list of conditions and the following
26 * - Redistributions in binary form must reproduce the above
27 * copyright notice, this list of conditions and the following
28 * disclaimer in the documentation and/or other materials
29 * provided with the distribution.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
35 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
36 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
37 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
40 * $Id: iscsi_iser.h 7051 2006-05-10 12:29:11Z ogerlitz $
42 #ifndef __ISCSI_ISER_H__
43 #define __ISCSI_ISER_H__
45 #include <linux/types.h>
46 #include <linux/net.h>
47 #include <scsi/libiscsi.h>
48 #include <scsi/scsi_transport_iscsi.h>
50 #include <linux/wait.h>
51 #include <linux/sched.h>
52 #include <linux/list.h>
53 #include <linux/slab.h>
54 #include <linux/dma-mapping.h>
55 #include <linux/mutex.h>
56 #include <linux/mempool.h>
57 #include <linux/uio.h>
59 #include <linux/socket.h>
61 #include <linux/in6.h>
63 #include <rdma/ib_verbs.h>
64 #include <rdma/ib_fmr_pool.h>
65 #include <rdma/rdma_cm.h>
67 #define DRV_NAME "iser"
68 #define PFX DRV_NAME ": "
70 #define DRV_DATE "May 7th, 2006"
72 #define iser_dbg(fmt, arg...) \
74 if (iser_debug_level > 1) \
75 printk(KERN_DEBUG PFX "%s:" fmt,\
79 #define iser_warn(fmt, arg...) \
81 if (iser_debug_level > 0) \
82 printk(KERN_DEBUG PFX "%s:" fmt,\
86 #define iser_err(fmt, arg...) \
88 printk(KERN_ERR PFX "%s:" fmt, \
93 #define SIZE_4K (1UL << SHIFT_4K)
94 #define MASK_4K (~(SIZE_4K-1))
96 /* support upto 512KB in one RDMA */
97 #define ISCSI_ISER_SG_TABLESIZE (0x80000 >> SHIFT_4K)
98 #define ISCSI_ISER_MAX_LUN 256
101 /* Maximal bounds on received asynchronous PDUs */
102 #define ISER_MAX_RX_MISC_PDUS 4 /* NOOP_IN(2) , ASYNC_EVENT(2) */
104 #define ISER_MAX_TX_MISC_PDUS 6 /* NOOP_OUT(2), TEXT(1), *
105 * SCSI_TMFUNC(2), LOGOUT(1) */
107 #define ISER_QP_MAX_RECV_DTOS (ISCSI_DEF_XMIT_CMDS_MAX + \
108 ISER_MAX_RX_MISC_PDUS + \
109 ISER_MAX_TX_MISC_PDUS)
111 /* the max TX (send) WR supported by the iSER QP is defined by *
112 * max_send_wr = T * (1 + D) + C ; D is how many inflight dataouts we expect *
113 * to have at max for SCSI command. The tx posting & completion handling code *
114 * supports -EAGAIN scheme where tx is suspended till the QP has room for more *
115 * send WR. D=8 comes from 64K/8K */
117 #define ISER_INFLIGHT_DATAOUTS 8
119 #define ISER_QP_MAX_REQ_DTOS (ISCSI_DEF_XMIT_CMDS_MAX * \
120 (1 + ISER_INFLIGHT_DATAOUTS) + \
121 ISER_MAX_TX_MISC_PDUS + \
122 ISER_MAX_RX_MISC_PDUS)
124 #define ISER_VER 0x10
125 #define ISER_WSV 0x08
126 #define ISER_RSV 0x04
131 __be32 write_stag
; /* write rkey */
133 __be32 read_stag
; /* read rkey */
135 } __attribute__((packed
));
138 /* Length of an object name string */
139 #define ISER_OBJECT_NAME_SIZE 64
141 enum iser_ib_conn_state
{
142 ISER_CONN_INIT
, /* descriptor allocd, no conn */
143 ISER_CONN_PENDING
, /* in the process of being established */
144 ISER_CONN_UP
, /* up and running */
145 ISER_CONN_TERMINATING
, /* in the process of being terminated */
146 ISER_CONN_DOWN
, /* shut down */
150 enum iser_task_status
{
151 ISER_TASK_STATUS_INIT
= 0,
152 ISER_TASK_STATUS_STARTED
,
153 ISER_TASK_STATUS_COMPLETED
157 ISER_DIR_IN
= 0, /* to initiator */
158 ISER_DIR_OUT
, /* from initiator */
162 struct iser_data_buf
{
163 void *buf
; /* pointer to the sg list */
164 unsigned int size
; /* num entries of this sg */
165 unsigned long data_len
; /* total data len */
166 unsigned int dma_nents
; /* returned by dma_map_sg */
167 char *copy_buf
; /* allocated copy buf for SGs unaligned *
168 * for rdma which are copied */
169 struct scatterlist sg_single
; /* SG-ified clone of a non SG SC or *
173 /* fwd declarations */
175 struct iscsi_iser_conn
;
176 struct iscsi_iser_task
;
178 struct iser_mem_reg
{
187 struct iser_regd_buf
{
188 struct iser_mem_reg reg
; /* memory registration info */
190 struct iser_device
*device
; /* device->device for dma_unmap */
191 u64 dma_addr
; /* if non zero, addr for dma_unmap */
192 enum dma_data_direction direction
; /* direction for dma_unmap */
193 unsigned int data_size
;
194 atomic_t ref_count
; /* refcount, freed when dec to 0 */
197 #define MAX_REGD_BUF_VECTOR_LEN 2
200 struct iscsi_iser_task
*task
;
201 struct iser_conn
*ib_conn
;
204 /* vector of registered buffers */
205 unsigned int regd_vector_len
;
206 struct iser_regd_buf
*regd
[MAX_REGD_BUF_VECTOR_LEN
];
208 /* offset into the registered buffer may be specified */
209 unsigned int offset
[MAX_REGD_BUF_VECTOR_LEN
];
211 /* a smaller size may be specified, if 0, then full size is used */
212 unsigned int used_sz
[MAX_REGD_BUF_VECTOR_LEN
];
215 enum iser_desc_type
{
218 ISCSI_TX_SCSI_COMMAND
,
223 struct iser_hdr iser_header
;
224 struct iscsi_hdr iscsi_header
;
225 struct iser_regd_buf hdr_regd_buf
;
226 void *data
; /* used by RX & TX_CONTROL */
227 struct iser_regd_buf data_regd_buf
; /* used by RX & TX_CONTROL */
228 enum iser_desc_type type
;
233 struct ib_device
*ib_device
;
237 struct tasklet_struct cq_tasklet
;
238 struct list_head ig_list
; /* entry in ig devices list */
243 struct iscsi_iser_conn
*iser_conn
; /* iser conn for upcalls */
244 enum iser_ib_conn_state state
; /* rdma connection state */
246 spinlock_t lock
; /* used for state changes */
247 struct iser_device
*device
; /* device context */
248 struct rdma_cm_id
*cma_id
; /* CMA ID */
249 struct ib_qp
*qp
; /* QP */
250 struct ib_fmr_pool
*fmr_pool
; /* pool of IB FMRs */
251 int disc_evt_flag
; /* disconn event delivered */
252 wait_queue_head_t wait
; /* waitq for conn/disconn */
253 atomic_t post_recv_buf_count
; /* posted rx count */
254 atomic_t post_send_buf_count
; /* posted tx count */
255 char name
[ISER_OBJECT_NAME_SIZE
];
256 struct iser_page_vec
*page_vec
; /* represents SG to fmr maps*
257 * maps serialized as tx is*/
258 struct list_head conn_list
; /* entry in ig conn list */
261 struct iscsi_iser_conn
{
262 struct iscsi_conn
*iscsi_conn
;/* ptr to iscsi conn */
263 struct iser_conn
*ib_conn
; /* iSER IB conn */
268 struct iscsi_iser_task
{
269 struct iser_desc desc
;
270 struct iscsi_iser_conn
*iser_conn
;
271 enum iser_task_status status
;
272 int command_sent
; /* set if command sent */
273 int dir
[ISER_DIRS_NUM
]; /* set if dir use*/
274 struct iser_regd_buf rdma_regd
[ISER_DIRS_NUM
];/* regd rdma buf */
275 struct iser_data_buf data
[ISER_DIRS_NUM
]; /* orig. data des*/
276 struct iser_data_buf data_copy
[ISER_DIRS_NUM
];/* contig. copy */
279 struct iser_page_vec
{
287 struct mutex device_list_mutex
;/* */
288 struct list_head device_list
; /* all iSER devices */
289 struct mutex connlist_mutex
;
290 struct list_head connlist
; /* all iSER IB connections */
292 struct kmem_cache
*desc_cache
;
295 extern struct iser_global ig
;
296 extern int iser_debug_level
;
298 /* allocate connection resources needed for rdma functionality */
299 int iser_conn_set_full_featured_mode(struct iscsi_conn
*conn
);
301 int iser_send_control(struct iscsi_conn
*conn
,
302 struct iscsi_task
*task
);
304 int iser_send_command(struct iscsi_conn
*conn
,
305 struct iscsi_task
*task
);
307 int iser_send_data_out(struct iscsi_conn
*conn
,
308 struct iscsi_task
*task
,
309 struct iscsi_data
*hdr
);
311 void iscsi_iser_recv(struct iscsi_conn
*conn
,
312 struct iscsi_hdr
*hdr
,
316 int iser_conn_init(struct iser_conn
**ib_conn
);
318 void iser_conn_get(struct iser_conn
*ib_conn
);
320 void iser_conn_put(struct iser_conn
*ib_conn
);
322 void iser_conn_terminate(struct iser_conn
*ib_conn
);
324 void iser_rcv_completion(struct iser_desc
*desc
,
325 unsigned long dto_xfer_len
);
327 void iser_snd_completion(struct iser_desc
*desc
);
329 void iser_task_rdma_init(struct iscsi_iser_task
*task
);
331 void iser_task_rdma_finalize(struct iscsi_iser_task
*task
);
333 void iser_dto_buffs_release(struct iser_dto
*dto
);
335 int iser_regd_buff_release(struct iser_regd_buf
*regd_buf
);
337 void iser_reg_single(struct iser_device
*device
,
338 struct iser_regd_buf
*regd_buf
,
339 enum dma_data_direction direction
);
341 void iser_finalize_rdma_unaligned_sg(struct iscsi_iser_task
*task
,
342 enum iser_data_dir cmd_dir
);
344 int iser_reg_rdma_mem(struct iscsi_iser_task
*task
,
345 enum iser_data_dir cmd_dir
);
347 int iser_connect(struct iser_conn
*ib_conn
,
348 struct sockaddr_in
*src_addr
,
349 struct sockaddr_in
*dst_addr
,
352 int iser_reg_page_vec(struct iser_conn
*ib_conn
,
353 struct iser_page_vec
*page_vec
,
354 struct iser_mem_reg
*mem_reg
);
356 void iser_unreg_mem(struct iser_mem_reg
*mem_reg
);
358 int iser_post_recv(struct iser_desc
*rx_desc
);
359 int iser_post_send(struct iser_desc
*tx_desc
);
361 int iser_conn_state_comp(struct iser_conn
*ib_conn
,
362 enum iser_ib_conn_state comp
);
364 int iser_dma_map_task_data(struct iscsi_iser_task
*iser_task
,
365 struct iser_data_buf
*data
,
366 enum iser_data_dir iser_dir
,
367 enum dma_data_direction dma_dir
);
369 void iser_dma_unmap_task_data(struct iscsi_iser_task
*iser_task
);