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