4 * Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>.
5 * Copyright (c) Intel Corporation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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
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.
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.
35 #ifndef SPDK_ISCSI_TASK_H
36 #define SPDK_ISCSI_TASK_H
38 #include "iscsi/iscsi.h"
39 #include "spdk/scsi.h"
40 #include "spdk/util.h"
42 struct spdk_iscsi_task
{
43 struct spdk_scsi_task scsi
;
45 struct spdk_iscsi_task
*parent
;
47 uint8_t rsp_scsi_status
;
48 uint8_t rsp_sense_data
[32];
49 size_t rsp_sense_data_len
;
51 struct spdk_iscsi_conn
*conn
;
52 struct spdk_iscsi_pdu
*pdu
;
53 uint32_t outstanding_r2t
;
55 uint32_t desired_data_transfer_length
;
57 /* Only valid for Read/Write */
58 uint32_t bytes_completed
;
60 uint32_t data_out_cnt
;
63 * Tracks the current offset of large read io.
65 uint32_t current_datain_offset
;
68 * next_expected_r2t_offset is used when we receive
71 uint32_t next_expected_r2t_offset
;
74 * Tracks the length of the R2T that is in progress.
75 * Used to check that an R2T burst does not exceed
78 uint32_t current_r2t_length
;
81 * next_r2t_offset is used when we are sending the
82 * R2T packet to keep track of next offset of r2t.
84 uint32_t next_r2t_offset
;
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 */
95 * Record the lun id just in case the lun is invalid,
96 * which will happen when hot removing the lun.
100 struct spdk_poller
*mgmt_poller
;
102 TAILQ_ENTRY(spdk_iscsi_task
) link
;
104 TAILQ_HEAD(subtask_list
, spdk_iscsi_task
) subtask_list
;
105 TAILQ_ENTRY(spdk_iscsi_task
) subtask_link
;
106 bool is_queued
; /* is queued in scsi layer for handling */
110 spdk_iscsi_task_put(struct spdk_iscsi_task
*task
)
112 spdk_scsi_task_put(&task
->scsi
);
115 static inline struct spdk_iscsi_pdu
*
116 spdk_iscsi_task_get_pdu(struct spdk_iscsi_task
*task
)
122 spdk_iscsi_task_set_pdu(struct spdk_iscsi_task
*task
, struct spdk_iscsi_pdu
*pdu
)
127 static inline struct iscsi_bhs
*
128 spdk_iscsi_task_get_bhs(struct spdk_iscsi_task
*task
)
130 return &spdk_iscsi_task_get_pdu(task
)->bhs
;
134 spdk_iscsi_task_associate_pdu(struct spdk_iscsi_task
*task
, struct spdk_iscsi_pdu
*pdu
)
136 spdk_iscsi_task_set_pdu(task
, pdu
);
141 spdk_iscsi_task_disassociate_pdu(struct spdk_iscsi_task
*task
)
143 if (spdk_iscsi_task_get_pdu(task
)) {
144 spdk_put_pdu(spdk_iscsi_task_get_pdu(task
));
145 spdk_iscsi_task_set_pdu(task
, NULL
);
150 spdk_iscsi_task_is_immediate(struct spdk_iscsi_task
*task
)
152 struct iscsi_bhs_scsi_req
*scsi_req
;
154 scsi_req
= (struct iscsi_bhs_scsi_req
*)spdk_iscsi_task_get_bhs(task
);
155 return (scsi_req
->immediate
== 1);
159 spdk_iscsi_task_is_read(struct spdk_iscsi_task
*task
)
161 struct iscsi_bhs_scsi_req
*scsi_req
;
163 scsi_req
= (struct iscsi_bhs_scsi_req
*)spdk_iscsi_task_get_bhs(task
);
164 return (scsi_req
->read_bit
== 1);
167 static inline uint32_t
168 spdk_iscsi_task_get_cmdsn(struct spdk_iscsi_task
*task
)
170 return spdk_iscsi_task_get_pdu(task
)->cmd_sn
;
173 struct spdk_iscsi_task
*spdk_iscsi_task_get(struct spdk_iscsi_conn
*conn
,
174 struct spdk_iscsi_task
*parent
,
175 spdk_scsi_task_cpl cpl_fn
);
177 static inline struct spdk_iscsi_task
*
178 spdk_iscsi_task_from_scsi_task(struct spdk_scsi_task
*task
)
180 return SPDK_CONTAINEROF(task
, struct spdk_iscsi_task
, scsi
);
183 static inline struct spdk_iscsi_task
*
184 spdk_iscsi_task_get_primary(struct spdk_iscsi_task
*task
)
193 #endif /* SPDK_ISCSI_TASK_H */