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_task *parent; 45 46 struct spdk_iscsi_conn *conn; 47 struct spdk_iscsi_pdu *pdu; 48 uint32_t outstanding_r2t; 49 50 uint32_t desired_data_transfer_length; 51 52 /* Only valid for Read/Write */ 53 uint32_t bytes_completed; 54 55 uint32_t data_out_cnt; 56 57 /* 58 * Tracks the current offset of large read io. 59 */ 60 uint32_t current_datain_offset; 61 62 /* 63 * next_expected_r2t_offset is used when we receive 64 * the DataOUT PDU. 65 */ 66 uint32_t next_expected_r2t_offset; 67 68 /* 69 * Tracks the length of the R2T that is in progress. 70 * Used to check that an R2T burst does not exceed 71 * MaxBurstLength. 72 */ 73 uint32_t current_r2t_length; 74 75 /* 76 * next_r2t_offset is used when we are sending the 77 * R2T packet to keep track of next offset of r2t. 78 */ 79 uint32_t next_r2t_offset; 80 uint32_t R2TSN; 81 uint32_t r2t_datasn; /* record next datasn for a r2tsn */ 82 uint32_t acked_r2tsn; /* next r2tsn to be acked */ 83 uint32_t datain_datasn; 84 uint32_t acked_data_sn; /* next expected datain datasn */ 85 uint32_t ttt; 86 87 uint32_t tag; 88 89 /** 90 * Record the lun id just in case the lun is invalid, 91 * which will happen when hot removing the lun. 92 */ 93 int lun_id; 94 95 TAILQ_ENTRY(spdk_iscsi_task) link; 96 97 TAILQ_HEAD(subtask_list, spdk_iscsi_task) subtask_list; 98 TAILQ_ENTRY(spdk_iscsi_task) subtask_link; 99 }; 100 101 static inline void 102 spdk_iscsi_task_put(struct spdk_iscsi_task *task) 103 { 104 spdk_scsi_task_put(&task->scsi); 105 } 106 107 static inline struct spdk_iscsi_pdu * 108 spdk_iscsi_task_get_pdu(struct spdk_iscsi_task *task) 109 { 110 return task->pdu; 111 } 112 113 static inline void 114 spdk_iscsi_task_set_pdu(struct spdk_iscsi_task *task, struct spdk_iscsi_pdu *pdu) 115 { 116 task->pdu = pdu; 117 } 118 119 static inline struct iscsi_bhs * 120 spdk_iscsi_task_get_bhs(struct spdk_iscsi_task *task) 121 { 122 return &spdk_iscsi_task_get_pdu(task)->bhs; 123 } 124 125 static inline void 126 spdk_iscsi_task_associate_pdu(struct spdk_iscsi_task *task, struct spdk_iscsi_pdu *pdu) 127 { 128 spdk_iscsi_task_set_pdu(task, pdu); 129 pdu->ref++; 130 } 131 132 static inline void 133 spdk_iscsi_task_disassociate_pdu(struct spdk_iscsi_task *task) 134 { 135 if (spdk_iscsi_task_get_pdu(task)) { 136 spdk_put_pdu(spdk_iscsi_task_get_pdu(task)); 137 spdk_iscsi_task_set_pdu(task, NULL); 138 } 139 } 140 141 static inline int 142 spdk_iscsi_task_is_immediate(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->immediate == 1); 148 } 149 150 static inline int 151 spdk_iscsi_task_is_read(struct spdk_iscsi_task *task) 152 { 153 struct iscsi_bhs_scsi_req *scsi_req; 154 155 scsi_req = (struct iscsi_bhs_scsi_req *)spdk_iscsi_task_get_bhs(task); 156 return (scsi_req->read_bit == 1); 157 } 158 159 static inline uint32_t 160 spdk_iscsi_task_get_cmdsn(struct spdk_iscsi_task *task) 161 { 162 return spdk_iscsi_task_get_pdu(task)->cmd_sn; 163 } 164 165 struct spdk_iscsi_task *spdk_iscsi_task_get(struct spdk_iscsi_conn *conn, 166 struct spdk_iscsi_task *parent, 167 spdk_scsi_task_cpl cpl_fn); 168 169 static inline struct spdk_iscsi_task * 170 spdk_iscsi_task_from_scsi_task(struct spdk_scsi_task *task) 171 { 172 return (struct spdk_iscsi_task *)((uintptr_t)task - offsetof(struct spdk_iscsi_task, scsi)); 173 } 174 175 static inline struct spdk_iscsi_task * 176 spdk_iscsi_task_get_primary(struct spdk_iscsi_task *task) 177 { 178 if (task->parent) { 179 return task->parent; 180 } else { 181 return task; 182 } 183 } 184 185 #endif /* SPDK_ISCSI_TASK_H */ 186