Commit | Line | Data |
---|---|---|
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. | |
39 | * | |
40 | * $Id: iscsi_iser.h 7051 2006-05-10 12:29:11Z ogerlitz $ | |
41 | */ | |
42 | #ifndef __ISCSI_ISER_H__ | |
43 | #define __ISCSI_ISER_H__ | |
44 | ||
45 | #include <linux/types.h> | |
46 | #include <linux/net.h> | |
47 | #include <scsi/libiscsi.h> | |
48 | #include <scsi/scsi_transport_iscsi.h> | |
49 | ||
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> | |
58 | ||
59 | #include <linux/socket.h> | |
60 | #include <linux/in.h> | |
61 | #include <linux/in6.h> | |
62 | ||
63 | #include <rdma/ib_verbs.h> | |
64 | #include <rdma/ib_fmr_pool.h> | |
65 | #include <rdma/rdma_cm.h> | |
66 | ||
67 | #define DRV_NAME "iser" | |
68 | #define PFX DRV_NAME ": " | |
69 | #define DRV_VER "0.1" | |
70 | #define DRV_DATE "May 7th, 2006" | |
71 | ||
72 | #define iser_dbg(fmt, arg...) \ | |
6f735e36 ED |
73 | do { \ |
74 | if (iser_debug_level > 1) \ | |
75 | printk(KERN_DEBUG PFX "%s:" fmt,\ | |
76 | __func__ , ## arg); \ | |
77 | } while (0) | |
78 | ||
79 | #define iser_warn(fmt, arg...) \ | |
49cd5382 OG |
80 | do { \ |
81 | if (iser_debug_level > 0) \ | |
82 | printk(KERN_DEBUG PFX "%s:" fmt,\ | |
83 | __func__ , ## arg); \ | |
84 | } while (0) | |
85 | ||
86 | #define iser_err(fmt, arg...) \ | |
87 | do { \ | |
88 | printk(KERN_ERR PFX "%s:" fmt, \ | |
89 | __func__ , ## arg); \ | |
90 | } while (0) | |
91 | ||
8dfa0876 EZ |
92 | #define SHIFT_4K 12 |
93 | #define SIZE_4K (1UL << SHIFT_4K) | |
94 | #define MASK_4K (~(SIZE_4K-1)) | |
95 | ||
49cd5382 | 96 | /* support upto 512KB in one RDMA */ |
8dfa0876 | 97 | #define ISCSI_ISER_SG_TABLESIZE (0x80000 >> SHIFT_4K) |
49cd5382 | 98 | #define ISCSI_ISER_MAX_LUN 256 |
49cd5382 OG |
99 | |
100 | /* QP settings */ | |
101 | /* Maximal bounds on received asynchronous PDUs */ | |
102 | #define ISER_MAX_RX_MISC_PDUS 4 /* NOOP_IN(2) , ASYNC_EVENT(2) */ | |
103 | ||
104 | #define ISER_MAX_TX_MISC_PDUS 6 /* NOOP_OUT(2), TEXT(1), * | |
105 | * SCSI_TMFUNC(2), LOGOUT(1) */ | |
106 | ||
1548271e | 107 | #define ISER_QP_MAX_RECV_DTOS (ISCSI_DEF_XMIT_CMDS_MAX + \ |
49cd5382 OG |
108 | ISER_MAX_RX_MISC_PDUS + \ |
109 | ISER_MAX_TX_MISC_PDUS) | |
110 | ||
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 */ | |
116 | ||
117 | #define ISER_INFLIGHT_DATAOUTS 8 | |
118 | ||
1548271e | 119 | #define ISER_QP_MAX_REQ_DTOS (ISCSI_DEF_XMIT_CMDS_MAX * \ |
49cd5382 OG |
120 | (1 + ISER_INFLIGHT_DATAOUTS) + \ |
121 | ISER_MAX_TX_MISC_PDUS + \ | |
122 | ISER_MAX_RX_MISC_PDUS) | |
123 | ||
124 | #define ISER_VER 0x10 | |
125 | #define ISER_WSV 0x08 | |
126 | #define ISER_RSV 0x04 | |
127 | ||
128 | struct iser_hdr { | |
129 | u8 flags; | |
130 | u8 rsvd[3]; | |
131 | __be32 write_stag; /* write rkey */ | |
132 | __be64 write_va; | |
133 | __be32 read_stag; /* read rkey */ | |
134 | __be64 read_va; | |
135 | } __attribute__((packed)); | |
136 | ||
137 | ||
138 | /* Length of an object name string */ | |
139 | #define ISER_OBJECT_NAME_SIZE 64 | |
140 | ||
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 */ | |
147 | ISER_CONN_STATES_NUM | |
148 | }; | |
149 | ||
150 | enum iser_task_status { | |
151 | ISER_TASK_STATUS_INIT = 0, | |
152 | ISER_TASK_STATUS_STARTED, | |
153 | ISER_TASK_STATUS_COMPLETED | |
154 | }; | |
155 | ||
156 | enum iser_data_dir { | |
157 | ISER_DIR_IN = 0, /* to initiator */ | |
158 | ISER_DIR_OUT, /* from initiator */ | |
159 | ISER_DIRS_NUM | |
160 | }; | |
161 | ||
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 * | |
170 | * unaligned SG */ | |
171 | }; | |
172 | ||
173 | /* fwd declarations */ | |
174 | struct iser_device; | |
175 | struct iscsi_iser_conn; | |
176 | struct iscsi_iser_cmd_task; | |
177 | ||
178 | struct iser_mem_reg { | |
179 | u32 lkey; | |
180 | u32 rkey; | |
181 | u64 va; | |
182 | u64 len; | |
183 | void *mem_h; | |
d8111028 | 184 | int is_fmr; |
49cd5382 OG |
185 | }; |
186 | ||
187 | struct iser_regd_buf { | |
188 | struct iser_mem_reg reg; /* memory registration info */ | |
189 | void *virt_addr; | |
190 | struct iser_device *device; /* device->device for dma_unmap */ | |
5180311f | 191 | u64 dma_addr; /* if non zero, addr for dma_unmap */ |
49cd5382 OG |
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 */ | |
195 | }; | |
196 | ||
197 | #define MAX_REGD_BUF_VECTOR_LEN 2 | |
198 | ||
199 | struct iser_dto { | |
200 | struct iscsi_iser_cmd_task *ctask; | |
87e8df7a | 201 | struct iser_conn *ib_conn; |
49cd5382 OG |
202 | int notify_enable; |
203 | ||
204 | /* vector of registered buffers */ | |
205 | unsigned int regd_vector_len; | |
206 | struct iser_regd_buf *regd[MAX_REGD_BUF_VECTOR_LEN]; | |
207 | ||
208 | /* offset into the registered buffer may be specified */ | |
209 | unsigned int offset[MAX_REGD_BUF_VECTOR_LEN]; | |
210 | ||
211 | /* a smaller size may be specified, if 0, then full size is used */ | |
212 | unsigned int used_sz[MAX_REGD_BUF_VECTOR_LEN]; | |
213 | }; | |
214 | ||
215 | enum iser_desc_type { | |
216 | ISCSI_RX, | |
217 | ISCSI_TX_CONTROL , | |
218 | ISCSI_TX_SCSI_COMMAND, | |
219 | ISCSI_TX_DATAOUT | |
220 | }; | |
221 | ||
222 | struct iser_desc { | |
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; | |
229 | struct iser_dto dto; | |
230 | }; | |
231 | ||
232 | struct iser_device { | |
233 | struct ib_device *ib_device; | |
234 | struct ib_pd *pd; | |
235 | struct ib_cq *cq; | |
236 | struct ib_mr *mr; | |
237 | struct tasklet_struct cq_tasklet; | |
238 | struct list_head ig_list; /* entry in ig devices list */ | |
239 | int refcount; | |
240 | }; | |
241 | ||
242 | struct iser_conn { | |
243 | struct iscsi_iser_conn *iser_conn; /* iser conn for upcalls */ | |
244 | enum iser_ib_conn_state state; /* rdma connection state */ | |
b40977d9 | 245 | atomic_t refcount; |
49cd5382 OG |
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 */ | |
49cd5382 OG |
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 */ | |
259 | }; | |
260 | ||
261 | struct iscsi_iser_conn { | |
262 | struct iscsi_conn *iscsi_conn;/* ptr to iscsi conn */ | |
263 | struct iser_conn *ib_conn; /* iSER IB conn */ | |
264 | ||
265 | rwlock_t lock; | |
266 | }; | |
267 | ||
268 | struct iscsi_iser_cmd_task { | |
269 | struct iser_desc desc; | |
270 | struct iscsi_iser_conn *iser_conn; | |
49cd5382 OG |
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 */ | |
277 | }; | |
278 | ||
279 | struct iser_page_vec { | |
280 | u64 *pages; | |
281 | int length; | |
282 | int offset; | |
283 | int data_size; | |
284 | }; | |
285 | ||
286 | struct iser_global { | |
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 */ | |
291 | ||
e54f8188 | 292 | struct kmem_cache *desc_cache; |
49cd5382 OG |
293 | }; |
294 | ||
295 | extern struct iser_global ig; | |
296 | extern int iser_debug_level; | |
297 | ||
298 | /* allocate connection resources needed for rdma functionality */ | |
299 | int iser_conn_set_full_featured_mode(struct iscsi_conn *conn); | |
300 | ||
2747fdb2 MC |
301 | int iser_send_control(struct iscsi_conn *conn, |
302 | struct iscsi_cmd_task *ctask); | |
49cd5382 | 303 | |
2747fdb2 MC |
304 | int iser_send_command(struct iscsi_conn *conn, |
305 | struct iscsi_cmd_task *ctask); | |
49cd5382 | 306 | |
2747fdb2 | 307 | int iser_send_data_out(struct iscsi_conn *conn, |
49cd5382 | 308 | struct iscsi_cmd_task *ctask, |
2747fdb2 | 309 | struct iscsi_data *hdr); |
49cd5382 OG |
310 | |
311 | void iscsi_iser_recv(struct iscsi_conn *conn, | |
312 | struct iscsi_hdr *hdr, | |
313 | char *rx_data, | |
314 | int rx_data_len); | |
315 | ||
316 | int iser_conn_init(struct iser_conn **ib_conn); | |
317 | ||
b40977d9 MC |
318 | void iser_conn_get(struct iser_conn *ib_conn); |
319 | ||
320 | void iser_conn_put(struct iser_conn *ib_conn); | |
321 | ||
49cd5382 OG |
322 | void iser_conn_terminate(struct iser_conn *ib_conn); |
323 | ||
49cd5382 OG |
324 | void iser_rcv_completion(struct iser_desc *desc, |
325 | unsigned long dto_xfer_len); | |
326 | ||
327 | void iser_snd_completion(struct iser_desc *desc); | |
328 | ||
2747fdb2 | 329 | void iser_ctask_rdma_init(struct iscsi_iser_cmd_task *ctask); |
49cd5382 OG |
330 | |
331 | void iser_ctask_rdma_finalize(struct iscsi_iser_cmd_task *ctask); | |
332 | ||
333 | void iser_dto_buffs_release(struct iser_dto *dto); | |
334 | ||
335 | int iser_regd_buff_release(struct iser_regd_buf *regd_buf); | |
336 | ||
337 | void iser_reg_single(struct iser_device *device, | |
338 | struct iser_regd_buf *regd_buf, | |
339 | enum dma_data_direction direction); | |
340 | ||
49cd5382 OG |
341 | void iser_finalize_rdma_unaligned_sg(struct iscsi_iser_cmd_task *ctask, |
342 | enum iser_data_dir cmd_dir); | |
343 | ||
344 | int iser_reg_rdma_mem(struct iscsi_iser_cmd_task *ctask, | |
345 | enum iser_data_dir cmd_dir); | |
346 | ||
347 | int iser_connect(struct iser_conn *ib_conn, | |
348 | struct sockaddr_in *src_addr, | |
349 | struct sockaddr_in *dst_addr, | |
350 | int non_blocking); | |
351 | ||
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); | |
355 | ||
356 | void iser_unreg_mem(struct iser_mem_reg *mem_reg); | |
357 | ||
358 | int iser_post_recv(struct iser_desc *rx_desc); | |
359 | int iser_post_send(struct iser_desc *tx_desc); | |
360 | ||
361 | int iser_conn_state_comp(struct iser_conn *ib_conn, | |
362 | enum iser_ib_conn_state comp); | |
74a20780 EZ |
363 | |
364 | int iser_dma_map_task_data(struct iscsi_iser_cmd_task *iser_ctask, | |
365 | struct iser_data_buf *data, | |
366 | enum iser_data_dir iser_dir, | |
367 | enum dma_data_direction dma_dir); | |
368 | ||
369 | void iser_dma_unmap_task_data(struct iscsi_iser_cmd_task *iser_ctask); | |
49cd5382 | 370 | #endif |