]> bbs.cooldavid.org Git - net-next-2.6.git/blame - drivers/infiniband/ulp/iser/iscsi_iser.h
IB/iser: New receive buffer posting logic
[net-next-2.6.git] / drivers / infiniband / ulp / iser / iscsi_iser.h
CommitLineData
49cd5382
OG
1/*
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.
11 *
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:
17 *
18 * Redistribution and use in source and binary forms, with or
19 * without modification, are permitted provided that the following
20 * conditions are met:
21 *
22 * - Redistributions of source code must retain the above
23 * copyright notice, this list of conditions and the following
24 * disclaimer.
25 *
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.
30 *
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
38 * SOFTWARE.
49cd5382
OG
39 */
40#ifndef __ISCSI_ISER_H__
41#define __ISCSI_ISER_H__
42
43#include <linux/types.h>
44#include <linux/net.h>
45#include <scsi/libiscsi.h>
46#include <scsi/scsi_transport_iscsi.h>
47
48#include <linux/wait.h>
49#include <linux/sched.h>
50#include <linux/list.h>
51#include <linux/slab.h>
52#include <linux/dma-mapping.h>
53#include <linux/mutex.h>
54#include <linux/mempool.h>
55#include <linux/uio.h>
56
57#include <linux/socket.h>
58#include <linux/in.h>
59#include <linux/in6.h>
60
61#include <rdma/ib_verbs.h>
62#include <rdma/ib_fmr_pool.h>
63#include <rdma/rdma_cm.h>
64
65#define DRV_NAME "iser"
66#define PFX DRV_NAME ": "
67#define DRV_VER "0.1"
68#define DRV_DATE "May 7th, 2006"
69
70#define iser_dbg(fmt, arg...) \
6f735e36
ED
71 do { \
72 if (iser_debug_level > 1) \
73 printk(KERN_DEBUG PFX "%s:" fmt,\
74 __func__ , ## arg); \
75 } while (0)
76
77#define iser_warn(fmt, arg...) \
49cd5382
OG
78 do { \
79 if (iser_debug_level > 0) \
80 printk(KERN_DEBUG PFX "%s:" fmt,\
81 __func__ , ## arg); \
82 } while (0)
83
84#define iser_err(fmt, arg...) \
85 do { \
86 printk(KERN_ERR PFX "%s:" fmt, \
87 __func__ , ## arg); \
88 } while (0)
89
8dfa0876
EZ
90#define SHIFT_4K 12
91#define SIZE_4K (1UL << SHIFT_4K)
92#define MASK_4K (~(SIZE_4K-1))
93
49cd5382 94 /* support upto 512KB in one RDMA */
8dfa0876 95#define ISCSI_ISER_SG_TABLESIZE (0x80000 >> SHIFT_4K)
e28f3d5b 96#define ISER_DEF_CMD_PER_LUN 128
49cd5382
OG
97
98/* QP settings */
99/* Maximal bounds on received asynchronous PDUs */
100#define ISER_MAX_RX_MISC_PDUS 4 /* NOOP_IN(2) , ASYNC_EVENT(2) */
101
102#define ISER_MAX_TX_MISC_PDUS 6 /* NOOP_OUT(2), TEXT(1), *
103 * SCSI_TMFUNC(2), LOGOUT(1) */
104
bcc60c38
OG
105#define ISER_QP_MAX_RECV_DTOS (ISCSI_DEF_XMIT_CMDS_MAX)
106
107#define ISER_MIN_POSTED_RX (ISCSI_DEF_XMIT_CMDS_MAX >> 2)
49cd5382
OG
108
109/* the max TX (send) WR supported by the iSER QP is defined by *
110 * max_send_wr = T * (1 + D) + C ; D is how many inflight dataouts we expect *
111 * to have at max for SCSI command. The tx posting & completion handling code *
112 * supports -EAGAIN scheme where tx is suspended till the QP has room for more *
113 * send WR. D=8 comes from 64K/8K */
114
115#define ISER_INFLIGHT_DATAOUTS 8
116
1548271e 117#define ISER_QP_MAX_REQ_DTOS (ISCSI_DEF_XMIT_CMDS_MAX * \
49cd5382
OG
118 (1 + ISER_INFLIGHT_DATAOUTS) + \
119 ISER_MAX_TX_MISC_PDUS + \
120 ISER_MAX_RX_MISC_PDUS)
121
122#define ISER_VER 0x10
123#define ISER_WSV 0x08
124#define ISER_RSV 0x04
125
126struct iser_hdr {
127 u8 flags;
128 u8 rsvd[3];
129 __be32 write_stag; /* write rkey */
130 __be64 write_va;
131 __be32 read_stag; /* read rkey */
132 __be64 read_va;
133} __attribute__((packed));
134
bcc60c38
OG
135/* Constant PDU lengths calculations */
136#define ISER_HEADERS_LEN (sizeof(struct iser_hdr) + sizeof(struct iscsi_hdr))
137
138#define ISER_RECV_DATA_SEG_LEN 128
139#define ISER_RX_PAYLOAD_SIZE (ISER_HEADERS_LEN + ISER_RECV_DATA_SEG_LEN)
140#define ISER_RX_LOGIN_SIZE (ISER_HEADERS_LEN + ISCSI_DEF_MAX_RECV_SEG_LEN)
49cd5382
OG
141
142/* Length of an object name string */
143#define ISER_OBJECT_NAME_SIZE 64
144
145enum iser_ib_conn_state {
146 ISER_CONN_INIT, /* descriptor allocd, no conn */
147 ISER_CONN_PENDING, /* in the process of being established */
148 ISER_CONN_UP, /* up and running */
149 ISER_CONN_TERMINATING, /* in the process of being terminated */
150 ISER_CONN_DOWN, /* shut down */
151 ISER_CONN_STATES_NUM
152};
153
154enum iser_task_status {
155 ISER_TASK_STATUS_INIT = 0,
156 ISER_TASK_STATUS_STARTED,
157 ISER_TASK_STATUS_COMPLETED
158};
159
160enum iser_data_dir {
161 ISER_DIR_IN = 0, /* to initiator */
162 ISER_DIR_OUT, /* from initiator */
163 ISER_DIRS_NUM
164};
165
166struct iser_data_buf {
167 void *buf; /* pointer to the sg list */
168 unsigned int size; /* num entries of this sg */
169 unsigned long data_len; /* total data len */
170 unsigned int dma_nents; /* returned by dma_map_sg */
171 char *copy_buf; /* allocated copy buf for SGs unaligned *
172 * for rdma which are copied */
173 struct scatterlist sg_single; /* SG-ified clone of a non SG SC or *
174 * unaligned SG */
175 };
176
177/* fwd declarations */
178struct iser_device;
179struct iscsi_iser_conn;
2261ec3d 180struct iscsi_iser_task;
412eeafa 181struct iscsi_endpoint;
49cd5382
OG
182
183struct iser_mem_reg {
184 u32 lkey;
185 u32 rkey;
186 u64 va;
187 u64 len;
188 void *mem_h;
d8111028 189 int is_fmr;
49cd5382
OG
190};
191
192struct iser_regd_buf {
193 struct iser_mem_reg reg; /* memory registration info */
194 void *virt_addr;
195 struct iser_device *device; /* device->device for dma_unmap */
5180311f 196 u64 dma_addr; /* if non zero, addr for dma_unmap */
49cd5382
OG
197 enum dma_data_direction direction; /* direction for dma_unmap */
198 unsigned int data_size;
199 atomic_t ref_count; /* refcount, freed when dec to 0 */
200};
201
202#define MAX_REGD_BUF_VECTOR_LEN 2
203
204struct iser_dto {
2261ec3d 205 struct iscsi_iser_task *task;
87e8df7a 206 struct iser_conn *ib_conn;
49cd5382
OG
207 int notify_enable;
208
209 /* vector of registered buffers */
210 unsigned int regd_vector_len;
211 struct iser_regd_buf *regd[MAX_REGD_BUF_VECTOR_LEN];
212
213 /* offset into the registered buffer may be specified */
214 unsigned int offset[MAX_REGD_BUF_VECTOR_LEN];
215
216 /* a smaller size may be specified, if 0, then full size is used */
217 unsigned int used_sz[MAX_REGD_BUF_VECTOR_LEN];
218};
219
220enum iser_desc_type {
49cd5382
OG
221 ISCSI_TX_CONTROL ,
222 ISCSI_TX_SCSI_COMMAND,
223 ISCSI_TX_DATAOUT
224};
225
226struct iser_desc {
227 struct iser_hdr iser_header;
228 struct iscsi_hdr iscsi_header;
229 struct iser_regd_buf hdr_regd_buf;
230 void *data; /* used by RX & TX_CONTROL */
231 struct iser_regd_buf data_regd_buf; /* used by RX & TX_CONTROL */
232 enum iser_desc_type type;
233 struct iser_dto dto;
234};
235
bcc60c38
OG
236#define ISER_RX_PAD_SIZE (256 - (ISER_RX_PAYLOAD_SIZE + \
237 sizeof(u64) + sizeof(struct ib_sge)))
238struct iser_rx_desc {
239 struct iser_hdr iser_header;
240 struct iscsi_hdr iscsi_header;
241 char data[ISER_RECV_DATA_SEG_LEN];
242 u64 dma_addr;
243 struct ib_sge rx_sg;
244 char pad[ISER_RX_PAD_SIZE];
245} __attribute__((packed));
246
49cd5382
OG
247struct iser_device {
248 struct ib_device *ib_device;
249 struct ib_pd *pd;
250 struct ib_cq *cq;
251 struct ib_mr *mr;
252 struct tasklet_struct cq_tasklet;
253 struct list_head ig_list; /* entry in ig devices list */
254 int refcount;
255};
256
257struct iser_conn {
258 struct iscsi_iser_conn *iser_conn; /* iser conn for upcalls */
412eeafa 259 struct iscsi_endpoint *ep;
49cd5382 260 enum iser_ib_conn_state state; /* rdma connection state */
b40977d9 261 atomic_t refcount;
49cd5382
OG
262 spinlock_t lock; /* used for state changes */
263 struct iser_device *device; /* device context */
264 struct rdma_cm_id *cma_id; /* CMA ID */
265 struct ib_qp *qp; /* QP */
266 struct ib_fmr_pool *fmr_pool; /* pool of IB FMRs */
267 int disc_evt_flag; /* disconn event delivered */
268 wait_queue_head_t wait; /* waitq for conn/disconn */
269 atomic_t post_recv_buf_count; /* posted rx count */
270 atomic_t post_send_buf_count; /* posted tx count */
49cd5382
OG
271 char name[ISER_OBJECT_NAME_SIZE];
272 struct iser_page_vec *page_vec; /* represents SG to fmr maps*
273 * maps serialized as tx is*/
274 struct list_head conn_list; /* entry in ig conn list */
bcc60c38
OG
275
276 char *login_buf;
277 u64 login_dma;
278 unsigned int rx_desc_head;
279 struct iser_rx_desc *rx_descs;
280 struct ib_recv_wr rx_wr[ISER_MIN_POSTED_RX];
49cd5382
OG
281};
282
283struct iscsi_iser_conn {
284 struct iscsi_conn *iscsi_conn;/* ptr to iscsi conn */
285 struct iser_conn *ib_conn; /* iSER IB conn */
49cd5382
OG
286};
287
2261ec3d 288struct iscsi_iser_task {
49cd5382
OG
289 struct iser_desc desc;
290 struct iscsi_iser_conn *iser_conn;
49cd5382
OG
291 enum iser_task_status status;
292 int command_sent; /* set if command sent */
293 int dir[ISER_DIRS_NUM]; /* set if dir use*/
294 struct iser_regd_buf rdma_regd[ISER_DIRS_NUM];/* regd rdma buf */
295 struct iser_data_buf data[ISER_DIRS_NUM]; /* orig. data des*/
296 struct iser_data_buf data_copy[ISER_DIRS_NUM];/* contig. copy */
297};
298
299struct iser_page_vec {
300 u64 *pages;
301 int length;
302 int offset;
303 int data_size;
304};
305
306struct iser_global {
307 struct mutex device_list_mutex;/* */
308 struct list_head device_list; /* all iSER devices */
309 struct mutex connlist_mutex;
310 struct list_head connlist; /* all iSER IB connections */
311
e54f8188 312 struct kmem_cache *desc_cache;
49cd5382
OG
313};
314
315extern struct iser_global ig;
316extern int iser_debug_level;
317
318/* allocate connection resources needed for rdma functionality */
319int iser_conn_set_full_featured_mode(struct iscsi_conn *conn);
320
2747fdb2 321int iser_send_control(struct iscsi_conn *conn,
2261ec3d 322 struct iscsi_task *task);
49cd5382 323
2747fdb2 324int iser_send_command(struct iscsi_conn *conn,
2261ec3d 325 struct iscsi_task *task);
49cd5382 326
2747fdb2 327int iser_send_data_out(struct iscsi_conn *conn,
2261ec3d 328 struct iscsi_task *task,
2747fdb2 329 struct iscsi_data *hdr);
49cd5382
OG
330
331void iscsi_iser_recv(struct iscsi_conn *conn,
332 struct iscsi_hdr *hdr,
333 char *rx_data,
334 int rx_data_len);
335
412eeafa 336void iser_conn_init(struct iser_conn *ib_conn);
49cd5382 337
b40977d9
MC
338void iser_conn_get(struct iser_conn *ib_conn);
339
340void iser_conn_put(struct iser_conn *ib_conn);
49cd5382
OG
341
342void iser_conn_terminate(struct iser_conn *ib_conn);
343
bcc60c38
OG
344void iser_rcv_completion(struct iser_rx_desc *desc,
345 unsigned long dto_xfer_len,
346 struct iser_conn *ib_conn);
49cd5382
OG
347
348void iser_snd_completion(struct iser_desc *desc);
349
2261ec3d 350void iser_task_rdma_init(struct iscsi_iser_task *task);
49cd5382 351
2261ec3d 352void iser_task_rdma_finalize(struct iscsi_iser_task *task);
49cd5382
OG
353
354void iser_dto_buffs_release(struct iser_dto *dto);
355
356int iser_regd_buff_release(struct iser_regd_buf *regd_buf);
357
bcc60c38
OG
358void iser_free_rx_descriptors(struct iser_conn *ib_conn);
359
49cd5382
OG
360void iser_reg_single(struct iser_device *device,
361 struct iser_regd_buf *regd_buf,
362 enum dma_data_direction direction);
363
2261ec3d 364void iser_finalize_rdma_unaligned_sg(struct iscsi_iser_task *task,
49cd5382
OG
365 enum iser_data_dir cmd_dir);
366
2261ec3d 367int iser_reg_rdma_mem(struct iscsi_iser_task *task,
49cd5382
OG
368 enum iser_data_dir cmd_dir);
369
370int iser_connect(struct iser_conn *ib_conn,
371 struct sockaddr_in *src_addr,
372 struct sockaddr_in *dst_addr,
373 int non_blocking);
374
375int iser_reg_page_vec(struct iser_conn *ib_conn,
376 struct iser_page_vec *page_vec,
377 struct iser_mem_reg *mem_reg);
378
379void iser_unreg_mem(struct iser_mem_reg *mem_reg);
380
bcc60c38
OG
381int iser_post_recvl(struct iser_conn *ib_conn);
382int iser_post_recvm(struct iser_conn *ib_conn, int count);
49cd5382
OG
383int iser_post_send(struct iser_desc *tx_desc);
384
385int iser_conn_state_comp(struct iser_conn *ib_conn,
386 enum iser_ib_conn_state comp);
74a20780 387
2261ec3d 388int iser_dma_map_task_data(struct iscsi_iser_task *iser_task,
74a20780
EZ
389 struct iser_data_buf *data,
390 enum iser_data_dir iser_dir,
391 enum dma_data_direction dma_dir);
392
2261ec3d 393void iser_dma_unmap_task_data(struct iscsi_iser_task *iser_task);
49cd5382 394#endif