1 /*******************************************************************************
2 * Filename: target_core_tmr.c
4 * This file contains SPC-3 task management infrastructure
6 * Copyright (c) 2009,2010 Rising Tide Systems
7 * Copyright (c) 2009,2010 Linux-iSCSI.org
9 * Nicholas A. Bellinger <nab@kernel.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 ******************************************************************************/
27 #include <linux/slab.h>
28 #include <linux/spinlock.h>
29 #include <linux/list.h>
30 #include <scsi/scsi.h>
31 #include <scsi/scsi_cmnd.h>
33 #include <target/target_core_base.h>
34 #include <target/target_core_device.h>
35 #include <target/target_core_tmr.h>
36 #include <target/target_core_transport.h>
37 #include <target/target_core_fabric_ops.h>
38 #include <target/target_core_configfs.h>
40 #include "target_core_alua.h"
41 #include "target_core_pr.h"
43 struct se_tmr_req
*core_tmr_alloc_req(
44 struct se_cmd
*se_cmd
,
49 struct se_tmr_req
*tmr
;
51 tmr
= kmem_cache_zalloc(se_tmr_req_cache
, gfp_flags
);
53 pr_err("Unable to allocate struct se_tmr_req\n");
54 return ERR_PTR(-ENOMEM
);
56 tmr
->task_cmd
= se_cmd
;
57 tmr
->fabric_tmr_ptr
= fabric_tmr_ptr
;
58 tmr
->function
= function
;
59 INIT_LIST_HEAD(&tmr
->tmr_list
);
63 EXPORT_SYMBOL(core_tmr_alloc_req
);
65 void core_tmr_release_req(
66 struct se_tmr_req
*tmr
)
68 struct se_device
*dev
= tmr
->tmr_dev
;
72 kmem_cache_free(se_tmr_req_cache
, tmr
);
76 spin_lock_irqsave(&dev
->se_tmr_lock
, flags
);
77 list_del(&tmr
->tmr_list
);
78 spin_unlock_irqrestore(&dev
->se_tmr_lock
, flags
);
80 kmem_cache_free(se_tmr_req_cache
, tmr
);
83 static void core_tmr_handle_tas_abort(
84 struct se_node_acl
*tmr_nacl
,
90 transport_cmd_finish_abort(cmd
, 1);
94 * TASK ABORTED status (TAS) bit support
97 (tmr_nacl
== cmd
->se_sess
->se_node_acl
)) || tas
)
98 transport_send_task_abort(cmd
);
100 transport_cmd_finish_abort(cmd
, 0);
103 static void core_tmr_drain_tmr_list(
104 struct se_device
*dev
,
105 struct se_tmr_req
*tmr
,
106 struct list_head
*preempt_and_abort_list
)
108 LIST_HEAD(drain_tmr_list
);
109 struct se_tmr_req
*tmr_p
, *tmr_pp
;
113 * Release all pending and outgoing TMRs aside from the received
116 spin_lock_irqsave(&dev
->se_tmr_lock
, flags
);
117 list_for_each_entry_safe(tmr_p
, tmr_pp
, &dev
->dev_tmr_list
, tmr_list
) {
119 * Allow the received TMR to return with FUNCTION_COMPLETE.
121 if (tmr
&& (tmr_p
== tmr
))
124 cmd
= tmr_p
->task_cmd
;
126 pr_err("Unable to locate struct se_cmd for TMR\n");
130 * If this function was called with a valid pr_res_key
131 * parameter (eg: for PROUT PREEMPT_AND_ABORT service action
132 * skip non regisration key matching TMRs.
134 if (preempt_and_abort_list
&&
135 (core_scsi3_check_cdb_abort_and_preempt(
136 preempt_and_abort_list
, cmd
) != 0))
139 spin_lock(&cmd
->t_state_lock
);
140 if (!atomic_read(&cmd
->t_transport_active
)) {
141 spin_unlock(&cmd
->t_state_lock
);
144 if (cmd
->t_state
== TRANSPORT_ISTATE_PROCESSING
) {
145 spin_unlock(&cmd
->t_state_lock
);
148 spin_unlock(&cmd
->t_state_lock
);
150 list_move_tail(&tmr
->tmr_list
, &drain_tmr_list
);
152 spin_unlock_irqrestore(&dev
->se_tmr_lock
, flags
);
154 while (!list_empty(&drain_tmr_list
)) {
155 tmr
= list_entry(drain_tmr_list
.next
, struct se_tmr_req
, tmr_list
);
156 list_del(&tmr
->tmr_list
);
157 cmd
= tmr_p
->task_cmd
;
159 pr_debug("LUN_RESET: %s releasing TMR %p Function: 0x%02x,"
160 " Response: 0x%02x, t_state: %d\n",
161 (preempt_and_abort_list
) ? "Preempt" : "", tmr
,
162 tmr
->function
, tmr
->response
, cmd
->t_state
);
164 transport_cmd_finish_abort(cmd
, 1);
168 static void core_tmr_drain_task_list(
169 struct se_device
*dev
,
170 struct se_cmd
*prout_cmd
,
171 struct se_node_acl
*tmr_nacl
,
173 struct list_head
*preempt_and_abort_list
)
175 LIST_HEAD(drain_task_list
);
177 struct se_task
*task
, *task_tmp
;
181 * Complete outstanding struct se_task CDBs with TASK_ABORTED SAM status.
182 * This is following sam4r17, section 5.6 Aborting commands, Table 38
185 * a) "Yes" indicates that each command that is aborted on an I_T nexus
186 * other than the one that caused the SCSI device condition is
187 * completed with TASK ABORTED status, if the TAS bit is set to one in
188 * the Control mode page (see SPC-4). "No" indicates that no status is
189 * returned for aborted commands.
191 * d) If the logical unit reset is caused by a particular I_T nexus
192 * (e.g., by a LOGICAL UNIT RESET task management function), then "yes"
193 * (TASK_ABORTED status) applies.
195 * Otherwise (e.g., if triggered by a hard reset), "no"
196 * (no TASK_ABORTED SAM status) applies.
198 * Note that this seems to be independent of TAS (Task Aborted Status)
199 * in the Control Mode Page.
201 spin_lock_irqsave(&dev
->execute_task_lock
, flags
);
202 list_for_each_entry_safe(task
, task_tmp
, &dev
->state_task_list
,
204 if (!task
->task_se_cmd
) {
205 pr_err("task->task_se_cmd is NULL!\n");
208 cmd
= task
->task_se_cmd
;
211 * For PREEMPT_AND_ABORT usage, only process commands
212 * with a matching reservation key.
214 if (preempt_and_abort_list
&&
215 (core_scsi3_check_cdb_abort_and_preempt(
216 preempt_and_abort_list
, cmd
) != 0))
219 * Not aborting PROUT PREEMPT_AND_ABORT CDB..
221 if (prout_cmd
== cmd
)
224 list_move_tail(&task
->t_state_list
, &drain_task_list
);
225 atomic_set(&task
->task_state_active
, 0);
227 * Remove from task execute list before processing drain_task_list
229 if (atomic_read(&task
->task_execute_queue
) != 0) {
230 list_del(&task
->t_execute_list
);
231 atomic_set(&task
->task_execute_queue
, 0);
232 atomic_dec(&dev
->execute_tasks
);
235 spin_unlock_irqrestore(&dev
->execute_task_lock
, flags
);
237 while (!list_empty(&drain_task_list
)) {
238 task
= list_entry(drain_task_list
.next
, struct se_task
, t_state_list
);
239 list_del(&task
->t_state_list
);
240 cmd
= task
->task_se_cmd
;
242 spin_lock_irqsave(&cmd
->t_state_lock
, flags
);
243 pr_debug("LUN_RESET: %s cmd: %p task: %p"
244 " ITT/CmdSN: 0x%08x/0x%08x, i_state: %d, t_state/"
245 "def_t_state: %d/%d cdb: 0x%02x\n",
246 (preempt_and_abort_list
) ? "Preempt" : "", cmd
, task
,
247 cmd
->se_tfo
->get_task_tag(cmd
), 0,
248 cmd
->se_tfo
->get_cmd_state(cmd
), cmd
->t_state
,
249 cmd
->deferred_t_state
, cmd
->t_task_cdb
[0]);
250 pr_debug("LUN_RESET: ITT[0x%08x] - pr_res_key: 0x%016Lx"
251 " t_task_cdbs: %d t_task_cdbs_left: %d"
252 " t_task_cdbs_sent: %d -- t_transport_active: %d"
253 " t_transport_stop: %d t_transport_sent: %d\n",
254 cmd
->se_tfo
->get_task_tag(cmd
), cmd
->pr_res_key
,
255 cmd
->t_task_list_num
,
256 atomic_read(&cmd
->t_task_cdbs_left
),
257 atomic_read(&cmd
->t_task_cdbs_sent
),
258 atomic_read(&cmd
->t_transport_active
),
259 atomic_read(&cmd
->t_transport_stop
),
260 atomic_read(&cmd
->t_transport_sent
));
262 if (task
->task_flags
& TF_ACTIVE
) {
263 task
->task_flags
|= TF_REQUEST_STOP
;
264 spin_unlock_irqrestore(
265 &cmd
->t_state_lock
, flags
);
267 pr_debug("LUN_RESET: Waiting for task: %p to shutdown"
268 " for dev: %p\n", task
, dev
);
269 wait_for_completion(&task
->task_stop_comp
);
270 pr_debug("LUN_RESET Completed task: %p shutdown for"
271 " dev: %p\n", task
, dev
);
273 spin_lock_irqsave(&cmd
->t_state_lock
, flags
);
274 atomic_dec(&cmd
->t_task_cdbs_left
);
275 task
->task_flags
&= ~(TF_ACTIVE
| TF_REQUEST_STOP
);
277 __transport_stop_task_timer(task
, &flags
);
279 if (!atomic_dec_and_test(&cmd
->t_task_cdbs_ex_left
)) {
280 spin_unlock_irqrestore(&cmd
->t_state_lock
, flags
);
281 pr_debug("LUN_RESET: Skipping task: %p, dev: %p for"
282 " t_task_cdbs_ex_left: %d\n", task
, dev
,
283 atomic_read(&cmd
->t_task_cdbs_ex_left
));
286 fe_count
= atomic_read(&cmd
->t_fe_count
);
288 if (atomic_read(&cmd
->t_transport_active
)) {
289 pr_debug("LUN_RESET: got t_transport_active = 1 for"
290 " task: %p, t_fe_count: %d dev: %p\n", task
,
292 atomic_set(&cmd
->t_transport_aborted
, 1);
293 spin_unlock_irqrestore(&cmd
->t_state_lock
, flags
);
295 core_tmr_handle_tas_abort(tmr_nacl
, cmd
, tas
, fe_count
);
298 pr_debug("LUN_RESET: Got t_transport_active = 0 for task: %p,"
299 " t_fe_count: %d dev: %p\n", task
, fe_count
, dev
);
300 atomic_set(&cmd
->t_transport_aborted
, 1);
301 spin_unlock_irqrestore(&cmd
->t_state_lock
, flags
);
303 core_tmr_handle_tas_abort(tmr_nacl
, cmd
, tas
, fe_count
);
307 static void core_tmr_drain_cmd_list(
308 struct se_device
*dev
,
309 struct se_cmd
*prout_cmd
,
310 struct se_node_acl
*tmr_nacl
,
312 struct list_head
*preempt_and_abort_list
)
314 LIST_HEAD(drain_cmd_list
);
315 struct se_queue_obj
*qobj
= &dev
->dev_queue_obj
;
316 struct se_cmd
*cmd
, *tcmd
;
319 * Release all commands remaining in the struct se_device cmd queue.
321 * This follows the same logic as above for the struct se_device
322 * struct se_task state list, where commands are returned with
323 * TASK_ABORTED status, if there is an outstanding $FABRIC_MOD
324 * reference, otherwise the struct se_cmd is released.
326 spin_lock_irqsave(&qobj
->cmd_queue_lock
, flags
);
327 list_for_each_entry_safe(cmd
, tcmd
, &qobj
->qobj_list
, se_queue_node
) {
329 * For PREEMPT_AND_ABORT usage, only process commands
330 * with a matching reservation key.
332 if (preempt_and_abort_list
&&
333 (core_scsi3_check_cdb_abort_and_preempt(
334 preempt_and_abort_list
, cmd
) != 0))
337 * Not aborting PROUT PREEMPT_AND_ABORT CDB..
339 if (prout_cmd
== cmd
)
342 * Skip direct processing of TRANSPORT_FREE_CMD_INTR for
343 * HW target mode fabrics.
345 spin_lock(&cmd
->t_state_lock
);
346 if (cmd
->t_state
== TRANSPORT_FREE_CMD_INTR
) {
347 spin_unlock(&cmd
->t_state_lock
);
350 spin_unlock(&cmd
->t_state_lock
);
352 atomic_set(&cmd
->t_transport_queue_active
, 0);
353 atomic_dec(&qobj
->queue_cnt
);
354 list_move_tail(&cmd
->se_queue_node
, &drain_cmd_list
);
356 spin_unlock_irqrestore(&qobj
->cmd_queue_lock
, flags
);
358 while (!list_empty(&drain_cmd_list
)) {
359 cmd
= list_entry(drain_cmd_list
.next
, struct se_cmd
, se_queue_node
);
360 list_del_init(&cmd
->se_queue_node
);
362 pr_debug("LUN_RESET: %s from Device Queue: cmd: %p t_state:"
363 " %d t_fe_count: %d\n", (preempt_and_abort_list
) ?
364 "Preempt" : "", cmd
, cmd
->t_state
,
365 atomic_read(&cmd
->t_fe_count
));
367 * Signal that the command has failed via cmd->se_cmd_flags,
369 transport_new_cmd_failure(cmd
);
371 core_tmr_handle_tas_abort(tmr_nacl
, cmd
, tas
,
372 atomic_read(&cmd
->t_fe_count
));
376 int core_tmr_lun_reset(
377 struct se_device
*dev
,
378 struct se_tmr_req
*tmr
,
379 struct list_head
*preempt_and_abort_list
,
380 struct se_cmd
*prout_cmd
)
382 struct se_node_acl
*tmr_nacl
= NULL
;
383 struct se_portal_group
*tmr_tpg
= NULL
;
386 * TASK_ABORTED status bit, this is configurable via ConfigFS
387 * struct se_device attributes. spc4r17 section 7.4.6 Control mode page
389 * A task aborted status (TAS) bit set to zero specifies that aborted
390 * tasks shall be terminated by the device server without any response
391 * to the application client. A TAS bit set to one specifies that tasks
392 * aborted by the actions of an I_T nexus other than the I_T nexus on
393 * which the command was received shall be completed with TASK ABORTED
394 * status (see SAM-4).
396 tas
= dev
->se_sub_dev
->se_dev_attrib
.emulate_tas
;
398 * Determine if this se_tmr is coming from a $FABRIC_MOD
399 * or struct se_device passthrough..
401 if (tmr
&& tmr
->task_cmd
&& tmr
->task_cmd
->se_sess
) {
402 tmr_nacl
= tmr
->task_cmd
->se_sess
->se_node_acl
;
403 tmr_tpg
= tmr
->task_cmd
->se_sess
->se_tpg
;
404 if (tmr_nacl
&& tmr_tpg
) {
405 pr_debug("LUN_RESET: TMR caller fabric: %s"
406 " initiator port %s\n",
407 tmr_tpg
->se_tpg_tfo
->get_fabric_name(),
408 tmr_nacl
->initiatorname
);
411 pr_debug("LUN_RESET: %s starting for [%s], tas: %d\n",
412 (preempt_and_abort_list
) ? "Preempt" : "TMR",
413 dev
->transport
->name
, tas
);
415 core_tmr_drain_tmr_list(dev
, tmr
, preempt_and_abort_list
);
416 core_tmr_drain_task_list(dev
, prout_cmd
, tmr_nacl
, tas
,
417 preempt_and_abort_list
);
418 core_tmr_drain_cmd_list(dev
, prout_cmd
, tmr_nacl
, tas
,
419 preempt_and_abort_list
);
421 * Clear any legacy SPC-2 reservation when called during
424 if (!preempt_and_abort_list
&&
425 (dev
->dev_flags
& DF_SPC2_RESERVATIONS
)) {
426 spin_lock(&dev
->dev_reservation_lock
);
427 dev
->dev_reserved_node_acl
= NULL
;
428 dev
->dev_flags
&= ~DF_SPC2_RESERVATIONS
;
429 spin_unlock(&dev
->dev_reservation_lock
);
430 pr_debug("LUN_RESET: SCSI-2 Released reservation\n");
433 spin_lock_irq(&dev
->stats_lock
);
435 spin_unlock_irq(&dev
->stats_lock
);
437 pr_debug("LUN_RESET: %s for [%s] Complete\n",
438 (preempt_and_abort_list
) ? "Preempt" : "TMR",
439 dev
->transport
->name
);