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 <linux/export.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_cmnd.h>
34 #include <target/target_core_base.h>
35 #include <target/target_core_backend.h>
36 #include <target/target_core_fabric.h>
37 #include <target/target_core_configfs.h>
39 #include "target_core_internal.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.
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_p->tmr_list, &drain_tmr_list);
152 spin_unlock_irqrestore(&dev->se_tmr_lock, flags);
154 list_for_each_entry_safe(tmr_p, tmr_pp, &drain_tmr_list, tmr_list) {
155 list_del_init(&tmr_p->tmr_list);
156 cmd = tmr_p->task_cmd;
158 pr_debug("LUN_RESET: %s releasing TMR %p Function: 0x%02x,"
159 " Response: 0x%02x, t_state: %d\n",
160 (preempt_and_abort_list) ? "Preempt" : "", tmr_p,
161 tmr_p->function, tmr_p->response, cmd->t_state);
163 transport_cmd_finish_abort(cmd, 1);
167 static void core_tmr_drain_task_list(
168 struct se_device *dev,
169 struct se_cmd *prout_cmd,
170 struct se_node_acl *tmr_nacl,
172 struct list_head *preempt_and_abort_list)
174 LIST_HEAD(drain_task_list);
176 struct se_task *task, *task_tmp;
180 * Complete outstanding struct se_task CDBs with TASK_ABORTED SAM status.
181 * This is following sam4r17, section 5.6 Aborting commands, Table 38
184 * a) "Yes" indicates that each command that is aborted on an I_T nexus
185 * other than the one that caused the SCSI device condition is
186 * completed with TASK ABORTED status, if the TAS bit is set to one in
187 * the Control mode page (see SPC-4). "No" indicates that no status is
188 * returned for aborted commands.
190 * d) If the logical unit reset is caused by a particular I_T nexus
191 * (e.g., by a LOGICAL UNIT RESET task management function), then "yes"
192 * (TASK_ABORTED status) applies.
194 * Otherwise (e.g., if triggered by a hard reset), "no"
195 * (no TASK_ABORTED SAM status) applies.
197 * Note that this seems to be independent of TAS (Task Aborted Status)
198 * in the Control Mode Page.
200 spin_lock_irqsave(&dev->execute_task_lock, flags);
201 list_for_each_entry_safe(task, task_tmp, &dev->state_task_list,
203 if (!task->task_se_cmd) {
204 pr_err("task->task_se_cmd is NULL!\n");
207 cmd = task->task_se_cmd;
210 * For PREEMPT_AND_ABORT usage, only process commands
211 * with a matching reservation key.
213 if (preempt_and_abort_list &&
214 (core_scsi3_check_cdb_abort_and_preempt(
215 preempt_and_abort_list, cmd) != 0))
218 * Not aborting PROUT PREEMPT_AND_ABORT CDB..
220 if (prout_cmd == cmd)
223 list_move_tail(&task->t_state_list, &drain_task_list);
224 atomic_set(&task->task_state_active, 0);
226 * Remove from task execute list before processing drain_task_list
228 if (!list_empty(&task->t_execute_list))
229 __transport_remove_task_from_execute_queue(task, dev);
231 spin_unlock_irqrestore(&dev->execute_task_lock, flags);
233 while (!list_empty(&drain_task_list)) {
234 task = list_entry(drain_task_list.next, struct se_task, t_state_list);
235 list_del(&task->t_state_list);
236 cmd = task->task_se_cmd;
238 pr_debug("LUN_RESET: %s cmd: %p task: %p"
239 " ITT/CmdSN: 0x%08x/0x%08x, i_state: %d, t_state: %d"
241 (preempt_and_abort_list) ? "Preempt" : "", cmd, task,
242 cmd->se_tfo->get_task_tag(cmd), 0,
243 cmd->se_tfo->get_cmd_state(cmd), cmd->t_state,
245 pr_debug("LUN_RESET: ITT[0x%08x] - pr_res_key: 0x%016Lx"
246 " t_task_cdbs: %d t_task_cdbs_left: %d"
247 " t_task_cdbs_sent: %d -- t_transport_active: %d"
248 " t_transport_stop: %d t_transport_sent: %d\n",
249 cmd->se_tfo->get_task_tag(cmd), cmd->pr_res_key,
250 cmd->t_task_list_num,
251 atomic_read(&cmd->t_task_cdbs_left),
252 atomic_read(&cmd->t_task_cdbs_sent),
253 atomic_read(&cmd->t_transport_active),
254 atomic_read(&cmd->t_transport_stop),
255 atomic_read(&cmd->t_transport_sent));
258 * If the command may be queued onto a workqueue cancel it now.
260 * This is equivalent to removal from the execute queue in the
261 * loop above, but we do it down here given that
262 * cancel_work_sync may block.
264 if (cmd->t_state == TRANSPORT_COMPLETE)
265 cancel_work_sync(&cmd->work);
267 spin_lock_irqsave(&cmd->t_state_lock, flags);
268 target_stop_task(task, &flags);
270 if (!atomic_dec_and_test(&cmd->t_task_cdbs_ex_left)) {
271 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
272 pr_debug("LUN_RESET: Skipping task: %p, dev: %p for"
273 " t_task_cdbs_ex_left: %d\n", task, dev,
274 atomic_read(&cmd->t_task_cdbs_ex_left));
277 fe_count = atomic_read(&cmd->t_fe_count);
279 if (atomic_read(&cmd->t_transport_active)) {
280 pr_debug("LUN_RESET: got t_transport_active = 1 for"
281 " task: %p, t_fe_count: %d dev: %p\n", task,
283 atomic_set(&cmd->t_transport_aborted, 1);
284 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
286 core_tmr_handle_tas_abort(tmr_nacl, cmd, tas, fe_count);
289 pr_debug("LUN_RESET: Got t_transport_active = 0 for task: %p,"
290 " t_fe_count: %d dev: %p\n", task, fe_count, dev);
291 atomic_set(&cmd->t_transport_aborted, 1);
292 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
294 core_tmr_handle_tas_abort(tmr_nacl, cmd, tas, fe_count);
298 static void core_tmr_drain_cmd_list(
299 struct se_device *dev,
300 struct se_cmd *prout_cmd,
301 struct se_node_acl *tmr_nacl,
303 struct list_head *preempt_and_abort_list)
305 LIST_HEAD(drain_cmd_list);
306 struct se_queue_obj *qobj = &dev->dev_queue_obj;
307 struct se_cmd *cmd, *tcmd;
310 * Release all commands remaining in the struct se_device cmd queue.
312 * This follows the same logic as above for the struct se_device
313 * struct se_task state list, where commands are returned with
314 * TASK_ABORTED status, if there is an outstanding $FABRIC_MOD
315 * reference, otherwise the struct se_cmd is released.
317 spin_lock_irqsave(&qobj->cmd_queue_lock, flags);
318 list_for_each_entry_safe(cmd, tcmd, &qobj->qobj_list, se_queue_node) {
320 * For PREEMPT_AND_ABORT usage, only process commands
321 * with a matching reservation key.
323 if (preempt_and_abort_list &&
324 (core_scsi3_check_cdb_abort_and_preempt(
325 preempt_and_abort_list, cmd) != 0))
328 * Not aborting PROUT PREEMPT_AND_ABORT CDB..
330 if (prout_cmd == cmd)
333 atomic_set(&cmd->t_transport_queue_active, 0);
334 atomic_dec(&qobj->queue_cnt);
335 list_move_tail(&cmd->se_queue_node, &drain_cmd_list);
337 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
339 while (!list_empty(&drain_cmd_list)) {
340 cmd = list_entry(drain_cmd_list.next, struct se_cmd, se_queue_node);
341 list_del_init(&cmd->se_queue_node);
343 pr_debug("LUN_RESET: %s from Device Queue: cmd: %p t_state:"
344 " %d t_fe_count: %d\n", (preempt_and_abort_list) ?
345 "Preempt" : "", cmd, cmd->t_state,
346 atomic_read(&cmd->t_fe_count));
348 core_tmr_handle_tas_abort(tmr_nacl, cmd, tas,
349 atomic_read(&cmd->t_fe_count));
353 int core_tmr_lun_reset(
354 struct se_device *dev,
355 struct se_tmr_req *tmr,
356 struct list_head *preempt_and_abort_list,
357 struct se_cmd *prout_cmd)
359 struct se_node_acl *tmr_nacl = NULL;
360 struct se_portal_group *tmr_tpg = NULL;
363 * TASK_ABORTED status bit, this is configurable via ConfigFS
364 * struct se_device attributes. spc4r17 section 7.4.6 Control mode page
366 * A task aborted status (TAS) bit set to zero specifies that aborted
367 * tasks shall be terminated by the device server without any response
368 * to the application client. A TAS bit set to one specifies that tasks
369 * aborted by the actions of an I_T nexus other than the I_T nexus on
370 * which the command was received shall be completed with TASK ABORTED
371 * status (see SAM-4).
373 tas = dev->se_sub_dev->se_dev_attrib.emulate_tas;
375 * Determine if this se_tmr is coming from a $FABRIC_MOD
376 * or struct se_device passthrough..
378 if (tmr && tmr->task_cmd && tmr->task_cmd->se_sess) {
379 tmr_nacl = tmr->task_cmd->se_sess->se_node_acl;
380 tmr_tpg = tmr->task_cmd->se_sess->se_tpg;
381 if (tmr_nacl && tmr_tpg) {
382 pr_debug("LUN_RESET: TMR caller fabric: %s"
383 " initiator port %s\n",
384 tmr_tpg->se_tpg_tfo->get_fabric_name(),
385 tmr_nacl->initiatorname);
388 pr_debug("LUN_RESET: %s starting for [%s], tas: %d\n",
389 (preempt_and_abort_list) ? "Preempt" : "TMR",
390 dev->transport->name, tas);
392 core_tmr_drain_tmr_list(dev, tmr, preempt_and_abort_list);
393 core_tmr_drain_task_list(dev, prout_cmd, tmr_nacl, tas,
394 preempt_and_abort_list);
395 core_tmr_drain_cmd_list(dev, prout_cmd, tmr_nacl, tas,
396 preempt_and_abort_list);
398 * Clear any legacy SPC-2 reservation when called during
401 if (!preempt_and_abort_list &&
402 (dev->dev_flags & DF_SPC2_RESERVATIONS)) {
403 spin_lock(&dev->dev_reservation_lock);
404 dev->dev_reserved_node_acl = NULL;
405 dev->dev_flags &= ~DF_SPC2_RESERVATIONS;
406 spin_unlock(&dev->dev_reservation_lock);
407 pr_debug("LUN_RESET: SCSI-2 Released reservation\n");
410 spin_lock_irq(&dev->stats_lock);
412 spin_unlock_irq(&dev->stats_lock);
414 pr_debug("LUN_RESET: %s for [%s] Complete\n",
415 (preempt_and_abort_list) ? "Preempt" : "TMR",
416 dev->transport->name);