1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>. 5 * Copyright (c) Intel Corporation. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * * Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * * Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in 16 * the documentation and/or other materials provided with the 17 * distribution. 18 * * Neither the name of Intel Corporation nor the names of its 19 * contributors may be used to endorse or promote products derived 20 * from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 #ifndef SPDK_ISCSI_TASK_H 36 #define SPDK_ISCSI_TASK_H 37 38 #include "iscsi/iscsi.h" 39 #include "spdk/scsi.h" 40 41 struct spdk_iscsi_task { 42 struct spdk_scsi_task scsi; 43 44 struct spdk_iscsi_pdu *pdu; 45 uint32_t outstanding_r2t; 46 47 uint32_t desired_data_transfer_length; 48 49 /* Only valid for Read/Write */ 50 uint32_t bytes_completed; 51 52 uint32_t data_out_cnt; 53 54 /* 55 * Tracks the current offset of large read io. 56 */ 57 uint32_t current_datain_offset; 58 59 /* 60 * next_expected_r2t_offset is used when we receive 61 * the DataOUT PDU. 62 */ 63 uint32_t next_expected_r2t_offset; 64 65 /* 66 * Tracks the length of the R2T that is in progress. 67 * Used to check that an R2T burst does not exceed 68 * MaxBurstLength. 69 */ 70 uint32_t current_r2t_length; 71 72 /* 73 * next_r2t_offset is used when we are sending the 74 * R2T packet to keep track of next offset of r2t. 75 */ 76 uint32_t next_r2t_offset; 77 uint32_t R2TSN; 78 uint32_t r2t_datasn; /* record next datasn for a r2tsn */ 79 uint32_t acked_r2tsn; /* next r2tsn to be acked */ 80 uint32_t datain_datasn; 81 uint32_t acked_data_sn; /* next expected datain datasn */ 82 uint32_t ttt; 83 84 uint32_t tag; 85 86 TAILQ_ENTRY(spdk_iscsi_task) link; 87 88 TAILQ_HEAD(subtask_list, spdk_iscsi_task) subtask_list; 89 TAILQ_ENTRY(spdk_iscsi_task) subtask_link; 90 }; 91 92 static inline void 93 spdk_iscsi_task_put(struct spdk_iscsi_task *task) 94 { 95 spdk_scsi_task_put(&task->scsi); 96 } 97 98 static inline struct spdk_iscsi_pdu * 99 spdk_iscsi_task_get_pdu(struct spdk_iscsi_task *task) 100 { 101 return task->pdu; 102 } 103 104 static inline void 105 spdk_iscsi_task_set_pdu(struct spdk_iscsi_task *task, struct spdk_iscsi_pdu *pdu) 106 { 107 task->pdu = pdu; 108 } 109 110 static inline struct iscsi_bhs * 111 spdk_iscsi_task_get_bhs(struct spdk_iscsi_task *task) 112 { 113 return &spdk_iscsi_task_get_pdu(task)->bhs; 114 } 115 116 static inline void 117 spdk_iscsi_task_associate_pdu(struct spdk_iscsi_task *task, struct spdk_iscsi_pdu *pdu) 118 { 119 spdk_iscsi_task_set_pdu(task, pdu); 120 pdu->ref++; 121 } 122 123 static inline void 124 spdk_iscsi_task_disassociate_pdu(struct spdk_iscsi_task *task) 125 { 126 if (spdk_iscsi_task_get_pdu(task)) { 127 spdk_put_pdu(spdk_iscsi_task_get_pdu(task)); 128 spdk_iscsi_task_set_pdu(task, NULL); 129 } 130 } 131 132 static inline int 133 spdk_iscsi_task_is_immediate(struct spdk_iscsi_task *task) 134 { 135 struct iscsi_bhs_scsi_req *scsi_req; 136 137 scsi_req = (struct iscsi_bhs_scsi_req *)spdk_iscsi_task_get_bhs(task); 138 return (scsi_req->immediate == 1); 139 } 140 141 static inline int 142 spdk_iscsi_task_is_read(struct spdk_iscsi_task *task) 143 { 144 struct iscsi_bhs_scsi_req *scsi_req; 145 146 scsi_req = (struct iscsi_bhs_scsi_req *)spdk_iscsi_task_get_bhs(task); 147 return (scsi_req->read == 1); 148 } 149 150 static inline uint32_t 151 spdk_iscsi_task_get_cmdsn(struct spdk_iscsi_task *task) 152 { 153 return spdk_iscsi_task_get_pdu(task)->cmd_sn; 154 } 155 156 struct spdk_iscsi_task *spdk_iscsi_task_get(uint32_t *owner_task_ctr, 157 struct spdk_iscsi_task *parent); 158 159 static inline struct spdk_iscsi_task * 160 spdk_iscsi_task_get_primary(struct spdk_iscsi_task *task) 161 { 162 struct spdk_scsi_task *scsi_task; 163 struct spdk_scsi_task *scsi_primary_task; 164 165 scsi_task = &task->scsi; 166 scsi_primary_task = spdk_scsi_task_get_primary(scsi_task); 167 return (struct spdk_iscsi_task *)scsi_primary_task; 168 } 169 170 #endif /* SPDK_ISCSI_TASK_H */ 171