2 * Copyright (c) 2004, 2005, 2006 Voltaire, Inc. All rights reserved.
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32 #include <linux/kernel.h>
33 #include <linux/slab.h>
35 #include <linux/scatterlist.h>
36 #include <linux/kfifo.h>
37 #include <scsi/scsi_cmnd.h>
38 #include <scsi/scsi_host.h>
40 #include "iscsi_iser.h"
42 /* Constant PDU lengths calculations */
43 #define ISER_TOTAL_HEADERS_LEN (sizeof (struct iser_hdr) + \
44 sizeof (struct iscsi_hdr))
46 /* iser_dto_add_regd_buff - increments the reference count for *
47 * the registered buffer & adds it to the DTO object */
48 static void iser_dto_add_regd_buff(struct iser_dto *dto,
49 struct iser_regd_buf *regd_buf,
50 unsigned long use_offset,
51 unsigned long use_size)
55 atomic_inc(®d_buf->ref_count);
57 add_idx = dto->regd_vector_len;
58 dto->regd[add_idx] = regd_buf;
59 dto->used_sz[add_idx] = use_size;
60 dto->offset[add_idx] = use_offset;
62 dto->regd_vector_len++;
65 /* Register user buffer memory and initialize passive rdma
66 * dto descriptor. Total data size is stored in
67 * iser_task->data[ISER_DIR_IN].data_len
69 static int iser_prepare_read_cmd(struct iscsi_task *task,
73 struct iscsi_iser_task *iser_task = task->dd_data;
74 struct iser_regd_buf *regd_buf;
76 struct iser_hdr *hdr = &iser_task->desc.iser_header;
77 struct iser_data_buf *buf_in = &iser_task->data[ISER_DIR_IN];
79 err = iser_dma_map_task_data(iser_task,
86 if (edtl > iser_task->data[ISER_DIR_IN].data_len) {
87 iser_err("Total data length: %ld, less than EDTL: "
88 "%d, in READ cmd BHS itt: %d, conn: 0x%p\n",
89 iser_task->data[ISER_DIR_IN].data_len, edtl,
90 task->itt, iser_task->iser_conn);
94 err = iser_reg_rdma_mem(iser_task,ISER_DIR_IN);
96 iser_err("Failed to set up Data-IN RDMA\n");
99 regd_buf = &iser_task->rdma_regd[ISER_DIR_IN];
101 hdr->flags |= ISER_RSV;
102 hdr->read_stag = cpu_to_be32(regd_buf->reg.rkey);
103 hdr->read_va = cpu_to_be64(regd_buf->reg.va);
105 iser_dbg("Cmd itt:%d READ tags RKEY:%#.4X VA:%#llX\n",
106 task->itt, regd_buf->reg.rkey,
107 (unsigned long long)regd_buf->reg.va);
112 /* Register user buffer memory and initialize passive rdma
113 * dto descriptor. Total data size is stored in
114 * task->data[ISER_DIR_OUT].data_len
117 iser_prepare_write_cmd(struct iscsi_task *task,
119 unsigned int unsol_sz,
122 struct iscsi_iser_task *iser_task = task->dd_data;
123 struct iser_regd_buf *regd_buf;
125 struct iser_dto *send_dto = &iser_task->desc.dto;
126 struct iser_hdr *hdr = &iser_task->desc.iser_header;
127 struct iser_data_buf *buf_out = &iser_task->data[ISER_DIR_OUT];
129 err = iser_dma_map_task_data(iser_task,
136 if (edtl > iser_task->data[ISER_DIR_OUT].data_len) {
137 iser_err("Total data length: %ld, less than EDTL: %d, "
138 "in WRITE cmd BHS itt: %d, conn: 0x%p\n",
139 iser_task->data[ISER_DIR_OUT].data_len,
140 edtl, task->itt, task->conn);
144 err = iser_reg_rdma_mem(iser_task,ISER_DIR_OUT);
146 iser_err("Failed to register write cmd RDMA mem\n");
150 regd_buf = &iser_task->rdma_regd[ISER_DIR_OUT];
152 if (unsol_sz < edtl) {
153 hdr->flags |= ISER_WSV;
154 hdr->write_stag = cpu_to_be32(regd_buf->reg.rkey);
155 hdr->write_va = cpu_to_be64(regd_buf->reg.va + unsol_sz);
157 iser_dbg("Cmd itt:%d, WRITE tags, RKEY:%#.4X "
158 "VA:%#llX + unsol:%d\n",
159 task->itt, regd_buf->reg.rkey,
160 (unsigned long long)regd_buf->reg.va, unsol_sz);
164 iser_dbg("Cmd itt:%d, WRITE, adding imm.data sz: %d\n",
166 iser_dto_add_regd_buff(send_dto,
176 * iser_post_receive_control - allocates, initializes and posts receive DTO.
178 static int iser_post_receive_control(struct iscsi_conn *conn)
180 struct iscsi_iser_conn *iser_conn = conn->dd_data;
181 struct iser_desc *rx_desc;
182 struct iser_regd_buf *regd_hdr;
183 struct iser_regd_buf *regd_data;
184 struct iser_dto *recv_dto = NULL;
185 struct iser_device *device = iser_conn->ib_conn->device;
186 int rx_data_size, err = 0;
188 rx_desc = kmem_cache_alloc(ig.desc_cache, GFP_NOIO);
189 if (rx_desc == NULL) {
190 iser_err("Failed to alloc desc for post recv\n");
193 rx_desc->type = ISCSI_RX;
195 /* for the login sequence we must support rx of upto 8K; login is done
196 * after conn create/bind (connect) and conn stop/bind (reconnect),
197 * what's common for both schemes is that the connection is not started
199 if (conn->c_stage != ISCSI_CONN_STARTED)
200 rx_data_size = ISCSI_DEF_MAX_RECV_SEG_LEN;
201 else /* FIXME till user space sets conn->max_recv_dlength correctly */
204 rx_desc->data = kmalloc(rx_data_size, GFP_NOIO);
205 if (rx_desc->data == NULL) {
206 iser_err("Failed to alloc data buf for post recv\n");
208 goto post_rx_kmalloc_failure;
211 recv_dto = &rx_desc->dto;
212 recv_dto->ib_conn = iser_conn->ib_conn;
213 recv_dto->regd_vector_len = 0;
215 regd_hdr = &rx_desc->hdr_regd_buf;
216 memset(regd_hdr, 0, sizeof(struct iser_regd_buf));
217 regd_hdr->device = device;
218 regd_hdr->virt_addr = rx_desc; /* == &rx_desc->iser_header */
219 regd_hdr->data_size = ISER_TOTAL_HEADERS_LEN;
221 iser_reg_single(device, regd_hdr, DMA_FROM_DEVICE);
223 iser_dto_add_regd_buff(recv_dto, regd_hdr, 0, 0);
225 regd_data = &rx_desc->data_regd_buf;
226 memset(regd_data, 0, sizeof(struct iser_regd_buf));
227 regd_data->device = device;
228 regd_data->virt_addr = rx_desc->data;
229 regd_data->data_size = rx_data_size;
231 iser_reg_single(device, regd_data, DMA_FROM_DEVICE);
233 iser_dto_add_regd_buff(recv_dto, regd_data, 0, 0);
235 err = iser_post_recv(rx_desc);
239 /* iser_post_recv failed */
240 iser_dto_buffs_release(recv_dto);
241 kfree(rx_desc->data);
242 post_rx_kmalloc_failure:
243 kmem_cache_free(ig.desc_cache, rx_desc);
247 /* creates a new tx descriptor and adds header regd buffer */
248 static void iser_create_send_desc(struct iscsi_iser_conn *iser_conn,
249 struct iser_desc *tx_desc)
251 struct iser_regd_buf *regd_hdr = &tx_desc->hdr_regd_buf;
252 struct iser_dto *send_dto = &tx_desc->dto;
254 memset(regd_hdr, 0, sizeof(struct iser_regd_buf));
255 regd_hdr->device = iser_conn->ib_conn->device;
256 regd_hdr->virt_addr = tx_desc; /* == &tx_desc->iser_header */
257 regd_hdr->data_size = ISER_TOTAL_HEADERS_LEN;
259 send_dto->ib_conn = iser_conn->ib_conn;
260 send_dto->notify_enable = 1;
261 send_dto->regd_vector_len = 0;
263 memset(&tx_desc->iser_header, 0, sizeof(struct iser_hdr));
264 tx_desc->iser_header.flags = ISER_VER;
266 iser_dto_add_regd_buff(send_dto, regd_hdr, 0, 0);
270 * iser_conn_set_full_featured_mode - (iSER API)
272 int iser_conn_set_full_featured_mode(struct iscsi_conn *conn)
274 struct iscsi_iser_conn *iser_conn = conn->dd_data;
277 /* no need to keep it in a var, we are after login so if this should
278 * be negotiated, by now the result should be available here */
279 int initial_post_recv_bufs_num = ISER_MAX_RX_MISC_PDUS;
281 iser_dbg("Initially post: %d\n", initial_post_recv_bufs_num);
283 /* Check that there is no posted recv or send buffers left - */
284 /* they must be consumed during the login phase */
285 BUG_ON(atomic_read(&iser_conn->ib_conn->post_recv_buf_count) != 0);
286 BUG_ON(atomic_read(&iser_conn->ib_conn->post_send_buf_count) != 0);
288 /* Initial post receive buffers */
289 for (i = 0; i < initial_post_recv_bufs_num; i++) {
290 if (iser_post_receive_control(conn) != 0) {
291 iser_err("Failed to post recv bufs at:%d conn:0x%p\n",
296 iser_dbg("Posted %d post recv bufs, conn:0x%p\n", i, conn);
301 iser_check_xmit(struct iscsi_conn *conn, void *task)
303 struct iscsi_iser_conn *iser_conn = conn->dd_data;
305 if (atomic_read(&iser_conn->ib_conn->post_send_buf_count) ==
306 ISER_QP_MAX_REQ_DTOS) {
307 iser_dbg("%ld can't xmit task %p\n",jiffies,task);
315 * iser_send_command - send command PDU
317 int iser_send_command(struct iscsi_conn *conn,
318 struct iscsi_task *task)
320 struct iscsi_iser_conn *iser_conn = conn->dd_data;
321 struct iscsi_iser_task *iser_task = task->dd_data;
322 struct iser_dto *send_dto = NULL;
325 struct iser_data_buf *data_buf;
326 struct iscsi_cmd *hdr = (struct iscsi_cmd *)task->hdr;
327 struct scsi_cmnd *sc = task->sc;
329 if (!iser_conn_state_comp(iser_conn->ib_conn, ISER_CONN_UP)) {
330 iser_err("Failed to send, conn: 0x%p is not up\n", iser_conn->ib_conn);
333 if (iser_check_xmit(conn, task))
336 edtl = ntohl(hdr->data_length);
338 /* build the tx desc regd header and add it to the tx desc dto */
339 iser_task->desc.type = ISCSI_TX_SCSI_COMMAND;
340 send_dto = &iser_task->desc.dto;
341 send_dto->task = iser_task;
342 iser_create_send_desc(iser_conn, &iser_task->desc);
344 if (hdr->flags & ISCSI_FLAG_CMD_READ)
345 data_buf = &iser_task->data[ISER_DIR_IN];
347 data_buf = &iser_task->data[ISER_DIR_OUT];
349 if (scsi_sg_count(sc)) { /* using a scatter list */
350 data_buf->buf = scsi_sglist(sc);
351 data_buf->size = scsi_sg_count(sc);
354 data_buf->data_len = scsi_bufflen(sc);
356 if (hdr->flags & ISCSI_FLAG_CMD_READ) {
357 err = iser_prepare_read_cmd(task, edtl);
359 goto send_command_error;
361 if (hdr->flags & ISCSI_FLAG_CMD_WRITE) {
362 err = iser_prepare_write_cmd(task,
365 task->unsol_r2t.data_length,
368 goto send_command_error;
371 iser_reg_single(iser_conn->ib_conn->device,
372 send_dto->regd[0], DMA_TO_DEVICE);
374 if (iser_post_receive_control(conn) != 0) {
375 iser_err("post_recv failed!\n");
377 goto send_command_error;
380 iser_task->status = ISER_TASK_STATUS_STARTED;
382 err = iser_post_send(&iser_task->desc);
387 iser_dto_buffs_release(send_dto);
388 iser_err("conn %p failed task->itt %d err %d\n",conn, task->itt, err);
393 * iser_send_data_out - send data out PDU
395 int iser_send_data_out(struct iscsi_conn *conn,
396 struct iscsi_task *task,
397 struct iscsi_data *hdr)
399 struct iscsi_iser_conn *iser_conn = conn->dd_data;
400 struct iscsi_iser_task *iser_task = task->dd_data;
401 struct iser_desc *tx_desc = NULL;
402 struct iser_dto *send_dto = NULL;
403 unsigned long buf_offset;
404 unsigned long data_seg_len;
408 if (!iser_conn_state_comp(iser_conn->ib_conn, ISER_CONN_UP)) {
409 iser_err("Failed to send, conn: 0x%p is not up\n", iser_conn->ib_conn);
413 if (iser_check_xmit(conn, task))
416 itt = (__force uint32_t)hdr->itt;
417 data_seg_len = ntoh24(hdr->dlength);
418 buf_offset = ntohl(hdr->offset);
420 iser_dbg("%s itt %d dseg_len %d offset %d\n",
421 __func__,(int)itt,(int)data_seg_len,(int)buf_offset);
423 tx_desc = kmem_cache_alloc(ig.desc_cache, GFP_NOIO);
424 if (tx_desc == NULL) {
425 iser_err("Failed to alloc desc for post dataout\n");
429 tx_desc->type = ISCSI_TX_DATAOUT;
430 memcpy(&tx_desc->iscsi_header, hdr, sizeof(struct iscsi_hdr));
432 /* build the tx desc regd header and add it to the tx desc dto */
433 send_dto = &tx_desc->dto;
434 send_dto->task = iser_task;
435 iser_create_send_desc(iser_conn, tx_desc);
437 iser_reg_single(iser_conn->ib_conn->device,
438 send_dto->regd[0], DMA_TO_DEVICE);
440 /* all data was registered for RDMA, we can use the lkey */
441 iser_dto_add_regd_buff(send_dto,
442 &iser_task->rdma_regd[ISER_DIR_OUT],
446 if (buf_offset + data_seg_len > iser_task->data[ISER_DIR_OUT].data_len) {
447 iser_err("Offset:%ld & DSL:%ld in Data-Out "
448 "inconsistent with total len:%ld, itt:%d\n",
449 buf_offset, data_seg_len,
450 iser_task->data[ISER_DIR_OUT].data_len, itt);
452 goto send_data_out_error;
454 iser_dbg("data-out itt: %d, offset: %ld, sz: %ld\n",
455 itt, buf_offset, data_seg_len);
458 err = iser_post_send(tx_desc);
463 iser_dto_buffs_release(send_dto);
464 kmem_cache_free(ig.desc_cache, tx_desc);
465 iser_err("conn %p failed err %d\n",conn, err);
469 int iser_send_control(struct iscsi_conn *conn,
470 struct iscsi_task *task)
472 struct iscsi_iser_conn *iser_conn = conn->dd_data;
473 struct iscsi_iser_task *iser_task = task->dd_data;
474 struct iser_desc *mdesc = &iser_task->desc;
475 struct iser_dto *send_dto = NULL;
476 unsigned long data_seg_len;
478 struct iser_regd_buf *regd_buf;
479 struct iser_device *device;
481 if (!iser_conn_state_comp(iser_conn->ib_conn, ISER_CONN_UP)) {
482 iser_err("Failed to send, conn: 0x%p is not up\n", iser_conn->ib_conn);
486 if (iser_check_xmit(conn, task))
489 /* build the tx desc regd header and add it to the tx desc dto */
490 mdesc->type = ISCSI_TX_CONTROL;
491 send_dto = &mdesc->dto;
492 send_dto->task = NULL;
493 iser_create_send_desc(iser_conn, mdesc);
495 device = iser_conn->ib_conn->device;
497 iser_reg_single(device, send_dto->regd[0], DMA_TO_DEVICE);
499 data_seg_len = ntoh24(task->hdr->dlength);
501 if (data_seg_len > 0) {
502 regd_buf = &mdesc->data_regd_buf;
503 memset(regd_buf, 0, sizeof(struct iser_regd_buf));
504 regd_buf->device = device;
505 regd_buf->virt_addr = task->data;
506 regd_buf->data_size = task->data_count;
507 iser_reg_single(device, regd_buf,
509 iser_dto_add_regd_buff(send_dto, regd_buf,
514 if (iser_post_receive_control(conn) != 0) {
515 iser_err("post_rcv_buff failed!\n");
517 goto send_control_error;
520 err = iser_post_send(mdesc);
525 iser_dto_buffs_release(send_dto);
526 iser_err("conn %p failed err %d\n",conn, err);
531 * iser_rcv_dto_completion - recv DTO completion
533 void iser_rcv_completion(struct iser_desc *rx_desc,
534 unsigned long dto_xfer_len)
536 struct iser_dto *dto = &rx_desc->dto;
537 struct iscsi_iser_conn *conn = dto->ib_conn->iser_conn;
538 struct iscsi_task *task;
539 struct iscsi_iser_task *iser_task;
540 struct iscsi_hdr *hdr;
541 char *rx_data = NULL;
543 unsigned char opcode;
545 hdr = &rx_desc->iscsi_header;
547 iser_dbg("op 0x%x itt 0x%x\n", hdr->opcode,hdr->itt);
549 if (dto_xfer_len > ISER_TOTAL_HEADERS_LEN) { /* we have data */
550 rx_data_len = dto_xfer_len - ISER_TOTAL_HEADERS_LEN;
551 rx_data = dto->regd[1]->virt_addr;
552 rx_data += dto->offset[1];
555 opcode = hdr->opcode & ISCSI_OPCODE_MASK;
557 if (opcode == ISCSI_OP_SCSI_CMD_RSP) {
558 spin_lock(&conn->iscsi_conn->session->lock);
559 task = iscsi_itt_to_ctask(conn->iscsi_conn, hdr->itt);
561 __iscsi_get_task(task);
562 spin_unlock(&conn->iscsi_conn->session->lock);
565 iser_err("itt can't be matched to task!!! "
566 "conn %p opcode %d itt %d\n",
567 conn->iscsi_conn, opcode, hdr->itt);
569 iser_task = task->dd_data;
570 iser_dbg("itt %d task %p\n",hdr->itt, task);
571 iser_task->status = ISER_TASK_STATUS_COMPLETED;
572 iser_task_rdma_finalize(iser_task);
573 iscsi_put_task(task);
576 iser_dto_buffs_release(dto);
578 iscsi_iser_recv(conn->iscsi_conn, hdr, rx_data, rx_data_len);
580 kfree(rx_desc->data);
581 kmem_cache_free(ig.desc_cache, rx_desc);
583 /* decrementing conn->post_recv_buf_count only --after-- freeing the *
584 * task eliminates the need to worry on tasks which are completed in *
585 * parallel to the execution of iser_conn_term. So the code that waits *
586 * for the posted rx bufs refcount to become zero handles everything */
587 atomic_dec(&conn->ib_conn->post_recv_buf_count);
590 void iser_snd_completion(struct iser_desc *tx_desc)
592 struct iser_dto *dto = &tx_desc->dto;
593 struct iser_conn *ib_conn = dto->ib_conn;
594 struct iscsi_iser_conn *iser_conn = ib_conn->iser_conn;
595 struct iscsi_conn *conn = iser_conn->iscsi_conn;
596 struct iscsi_task *task;
599 iser_dbg("Initiator, Data sent dto=0x%p\n", dto);
601 iser_dto_buffs_release(dto);
603 if (tx_desc->type == ISCSI_TX_DATAOUT)
604 kmem_cache_free(ig.desc_cache, tx_desc);
606 if (atomic_read(&iser_conn->ib_conn->post_send_buf_count) ==
607 ISER_QP_MAX_REQ_DTOS)
610 atomic_dec(&ib_conn->post_send_buf_count);
613 iser_dbg("%ld resuming tx\n",jiffies);
614 iscsi_conn_queue_work(conn);
617 if (tx_desc->type == ISCSI_TX_CONTROL) {
618 /* this arithmetic is legal by libiscsi dd_data allocation */
619 task = (void *) ((long)(void *)tx_desc -
620 sizeof(struct iscsi_task));
621 if (task->hdr->itt == RESERVED_ITT)
622 iscsi_put_task(task);
626 void iser_task_rdma_init(struct iscsi_iser_task *iser_task)
629 iser_task->status = ISER_TASK_STATUS_INIT;
631 iser_task->dir[ISER_DIR_IN] = 0;
632 iser_task->dir[ISER_DIR_OUT] = 0;
634 iser_task->data[ISER_DIR_IN].data_len = 0;
635 iser_task->data[ISER_DIR_OUT].data_len = 0;
637 memset(&iser_task->rdma_regd[ISER_DIR_IN], 0,
638 sizeof(struct iser_regd_buf));
639 memset(&iser_task->rdma_regd[ISER_DIR_OUT], 0,
640 sizeof(struct iser_regd_buf));
643 void iser_task_rdma_finalize(struct iscsi_iser_task *iser_task)
646 int is_rdma_aligned = 1;
647 struct iser_regd_buf *regd;
649 /* if we were reading, copy back to unaligned sglist,
650 * anyway dma_unmap and free the copy
652 if (iser_task->data_copy[ISER_DIR_IN].copy_buf != NULL) {
654 iser_finalize_rdma_unaligned_sg(iser_task, ISER_DIR_IN);
656 if (iser_task->data_copy[ISER_DIR_OUT].copy_buf != NULL) {
658 iser_finalize_rdma_unaligned_sg(iser_task, ISER_DIR_OUT);
661 if (iser_task->dir[ISER_DIR_IN]) {
662 regd = &iser_task->rdma_regd[ISER_DIR_IN];
663 deferred = iser_regd_buff_release(regd);
665 iser_err("%d references remain for BUF-IN rdma reg\n",
666 atomic_read(®d->ref_count));
670 if (iser_task->dir[ISER_DIR_OUT]) {
671 regd = &iser_task->rdma_regd[ISER_DIR_OUT];
672 deferred = iser_regd_buff_release(regd);
674 iser_err("%d references remain for BUF-OUT rdma reg\n",
675 atomic_read(®d->ref_count));
679 /* if the data was unaligned, it was already unmapped and then copied */
681 iser_dma_unmap_task_data(iser_task);
684 void iser_dto_buffs_release(struct iser_dto *dto)
688 for (i = 0; i < dto->regd_vector_len; i++)
689 iser_regd_buff_release(dto->regd[i]);