1 /*******************************************************************************
2 * Filename: target_core_transport.c
4 * This file contains the Generic Target Engine Core.
6 * Copyright (c) 2002, 2003, 2004, 2005 PyX Technologies, Inc.
7 * Copyright (c) 2005, 2006, 2007 SBE, Inc.
8 * Copyright (c) 2007-2010 Rising Tide Systems
9 * Copyright (c) 2008-2010 Linux-iSCSI.org
11 * Nicholas A. Bellinger <nab@kernel.org>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 ******************************************************************************/
29 #include <linux/net.h>
30 #include <linux/delay.h>
31 #include <linux/string.h>
32 #include <linux/timer.h>
33 #include <linux/slab.h>
34 #include <linux/blkdev.h>
35 #include <linux/spinlock.h>
36 #include <linux/kthread.h>
38 #include <linux/cdrom.h>
39 #include <linux/module.h>
40 #include <linux/ratelimit.h>
41 #include <asm/unaligned.h>
44 #include <scsi/scsi.h>
45 #include <scsi/scsi_cmnd.h>
46 #include <scsi/scsi_tcq.h>
48 #include <target/target_core_base.h>
49 #include <target/target_core_backend.h>
50 #include <target/target_core_fabric.h>
51 #include <target/target_core_configfs.h>
53 #include "target_core_internal.h"
54 #include "target_core_alua.h"
55 #include "target_core_pr.h"
56 #include "target_core_ua.h"
58 static int sub_api_initialized;
60 static struct workqueue_struct *target_completion_wq;
61 static struct kmem_cache *se_sess_cache;
62 struct kmem_cache *se_ua_cache;
63 struct kmem_cache *t10_pr_reg_cache;
64 struct kmem_cache *t10_alua_lu_gp_cache;
65 struct kmem_cache *t10_alua_lu_gp_mem_cache;
66 struct kmem_cache *t10_alua_tg_pt_gp_cache;
67 struct kmem_cache *t10_alua_tg_pt_gp_mem_cache;
69 static int transport_generic_write_pending(struct se_cmd *);
70 static int transport_processing_thread(void *param);
71 static int __transport_execute_tasks(struct se_device *dev, struct se_cmd *);
72 static void transport_complete_task_attr(struct se_cmd *cmd);
73 static void transport_handle_queue_full(struct se_cmd *cmd,
74 struct se_device *dev);
75 static void transport_free_dev_tasks(struct se_cmd *cmd);
76 static int transport_generic_get_mem(struct se_cmd *cmd);
77 static void transport_put_cmd(struct se_cmd *cmd);
78 static void transport_remove_cmd_from_queue(struct se_cmd *cmd);
79 static int transport_set_sense_codes(struct se_cmd *cmd, u8 asc, u8 ascq);
80 static void target_complete_ok_work(struct work_struct *work);
82 int init_se_kmem_caches(void)
84 se_sess_cache = kmem_cache_create("se_sess_cache",
85 sizeof(struct se_session), __alignof__(struct se_session),
88 pr_err("kmem_cache_create() for struct se_session"
92 se_ua_cache = kmem_cache_create("se_ua_cache",
93 sizeof(struct se_ua), __alignof__(struct se_ua),
96 pr_err("kmem_cache_create() for struct se_ua failed\n");
97 goto out_free_sess_cache;
99 t10_pr_reg_cache = kmem_cache_create("t10_pr_reg_cache",
100 sizeof(struct t10_pr_registration),
101 __alignof__(struct t10_pr_registration), 0, NULL);
102 if (!t10_pr_reg_cache) {
103 pr_err("kmem_cache_create() for struct t10_pr_registration"
105 goto out_free_ua_cache;
107 t10_alua_lu_gp_cache = kmem_cache_create("t10_alua_lu_gp_cache",
108 sizeof(struct t10_alua_lu_gp), __alignof__(struct t10_alua_lu_gp),
110 if (!t10_alua_lu_gp_cache) {
111 pr_err("kmem_cache_create() for t10_alua_lu_gp_cache"
113 goto out_free_pr_reg_cache;
115 t10_alua_lu_gp_mem_cache = kmem_cache_create("t10_alua_lu_gp_mem_cache",
116 sizeof(struct t10_alua_lu_gp_member),
117 __alignof__(struct t10_alua_lu_gp_member), 0, NULL);
118 if (!t10_alua_lu_gp_mem_cache) {
119 pr_err("kmem_cache_create() for t10_alua_lu_gp_mem_"
121 goto out_free_lu_gp_cache;
123 t10_alua_tg_pt_gp_cache = kmem_cache_create("t10_alua_tg_pt_gp_cache",
124 sizeof(struct t10_alua_tg_pt_gp),
125 __alignof__(struct t10_alua_tg_pt_gp), 0, NULL);
126 if (!t10_alua_tg_pt_gp_cache) {
127 pr_err("kmem_cache_create() for t10_alua_tg_pt_gp_"
129 goto out_free_lu_gp_mem_cache;
131 t10_alua_tg_pt_gp_mem_cache = kmem_cache_create(
132 "t10_alua_tg_pt_gp_mem_cache",
133 sizeof(struct t10_alua_tg_pt_gp_member),
134 __alignof__(struct t10_alua_tg_pt_gp_member),
136 if (!t10_alua_tg_pt_gp_mem_cache) {
137 pr_err("kmem_cache_create() for t10_alua_tg_pt_gp_"
139 goto out_free_tg_pt_gp_cache;
142 target_completion_wq = alloc_workqueue("target_completion",
144 if (!target_completion_wq)
145 goto out_free_tg_pt_gp_mem_cache;
149 out_free_tg_pt_gp_mem_cache:
150 kmem_cache_destroy(t10_alua_tg_pt_gp_mem_cache);
151 out_free_tg_pt_gp_cache:
152 kmem_cache_destroy(t10_alua_tg_pt_gp_cache);
153 out_free_lu_gp_mem_cache:
154 kmem_cache_destroy(t10_alua_lu_gp_mem_cache);
155 out_free_lu_gp_cache:
156 kmem_cache_destroy(t10_alua_lu_gp_cache);
157 out_free_pr_reg_cache:
158 kmem_cache_destroy(t10_pr_reg_cache);
160 kmem_cache_destroy(se_ua_cache);
162 kmem_cache_destroy(se_sess_cache);
167 void release_se_kmem_caches(void)
169 destroy_workqueue(target_completion_wq);
170 kmem_cache_destroy(se_sess_cache);
171 kmem_cache_destroy(se_ua_cache);
172 kmem_cache_destroy(t10_pr_reg_cache);
173 kmem_cache_destroy(t10_alua_lu_gp_cache);
174 kmem_cache_destroy(t10_alua_lu_gp_mem_cache);
175 kmem_cache_destroy(t10_alua_tg_pt_gp_cache);
176 kmem_cache_destroy(t10_alua_tg_pt_gp_mem_cache);
179 /* This code ensures unique mib indexes are handed out. */
180 static DEFINE_SPINLOCK(scsi_mib_index_lock);
181 static u32 scsi_mib_index[SCSI_INDEX_TYPE_MAX];
184 * Allocate a new row index for the entry type specified
186 u32 scsi_get_new_index(scsi_index_t type)
190 BUG_ON((type < 0) || (type >= SCSI_INDEX_TYPE_MAX));
192 spin_lock(&scsi_mib_index_lock);
193 new_index = ++scsi_mib_index[type];
194 spin_unlock(&scsi_mib_index_lock);
199 static void transport_init_queue_obj(struct se_queue_obj *qobj)
201 atomic_set(&qobj->queue_cnt, 0);
202 INIT_LIST_HEAD(&qobj->qobj_list);
203 init_waitqueue_head(&qobj->thread_wq);
204 spin_lock_init(&qobj->cmd_queue_lock);
207 void transport_subsystem_check_init(void)
211 if (sub_api_initialized)
214 ret = request_module("target_core_iblock");
216 pr_err("Unable to load target_core_iblock\n");
218 ret = request_module("target_core_file");
220 pr_err("Unable to load target_core_file\n");
222 ret = request_module("target_core_pscsi");
224 pr_err("Unable to load target_core_pscsi\n");
226 ret = request_module("target_core_stgt");
228 pr_err("Unable to load target_core_stgt\n");
230 sub_api_initialized = 1;
234 struct se_session *transport_init_session(void)
236 struct se_session *se_sess;
238 se_sess = kmem_cache_zalloc(se_sess_cache, GFP_KERNEL);
240 pr_err("Unable to allocate struct se_session from"
242 return ERR_PTR(-ENOMEM);
244 INIT_LIST_HEAD(&se_sess->sess_list);
245 INIT_LIST_HEAD(&se_sess->sess_acl_list);
246 INIT_LIST_HEAD(&se_sess->sess_cmd_list);
247 INIT_LIST_HEAD(&se_sess->sess_wait_list);
248 spin_lock_init(&se_sess->sess_cmd_lock);
249 kref_init(&se_sess->sess_kref);
253 EXPORT_SYMBOL(transport_init_session);
256 * Called with spin_lock_irqsave(&struct se_portal_group->session_lock called.
258 void __transport_register_session(
259 struct se_portal_group *se_tpg,
260 struct se_node_acl *se_nacl,
261 struct se_session *se_sess,
262 void *fabric_sess_ptr)
264 unsigned char buf[PR_REG_ISID_LEN];
266 se_sess->se_tpg = se_tpg;
267 se_sess->fabric_sess_ptr = fabric_sess_ptr;
269 * Used by struct se_node_acl's under ConfigFS to locate active se_session-t
271 * Only set for struct se_session's that will actually be moving I/O.
272 * eg: *NOT* discovery sessions.
276 * If the fabric module supports an ISID based TransportID,
277 * save this value in binary from the fabric I_T Nexus now.
279 if (se_tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
280 memset(&buf[0], 0, PR_REG_ISID_LEN);
281 se_tpg->se_tpg_tfo->sess_get_initiator_sid(se_sess,
282 &buf[0], PR_REG_ISID_LEN);
283 se_sess->sess_bin_isid = get_unaligned_be64(&buf[0]);
285 kref_get(&se_nacl->acl_kref);
287 spin_lock_irq(&se_nacl->nacl_sess_lock);
289 * The se_nacl->nacl_sess pointer will be set to the
290 * last active I_T Nexus for each struct se_node_acl.
292 se_nacl->nacl_sess = se_sess;
294 list_add_tail(&se_sess->sess_acl_list,
295 &se_nacl->acl_sess_list);
296 spin_unlock_irq(&se_nacl->nacl_sess_lock);
298 list_add_tail(&se_sess->sess_list, &se_tpg->tpg_sess_list);
300 pr_debug("TARGET_CORE[%s]: Registered fabric_sess_ptr: %p\n",
301 se_tpg->se_tpg_tfo->get_fabric_name(), se_sess->fabric_sess_ptr);
303 EXPORT_SYMBOL(__transport_register_session);
305 void transport_register_session(
306 struct se_portal_group *se_tpg,
307 struct se_node_acl *se_nacl,
308 struct se_session *se_sess,
309 void *fabric_sess_ptr)
313 spin_lock_irqsave(&se_tpg->session_lock, flags);
314 __transport_register_session(se_tpg, se_nacl, se_sess, fabric_sess_ptr);
315 spin_unlock_irqrestore(&se_tpg->session_lock, flags);
317 EXPORT_SYMBOL(transport_register_session);
319 static void target_release_session(struct kref *kref)
321 struct se_session *se_sess = container_of(kref,
322 struct se_session, sess_kref);
323 struct se_portal_group *se_tpg = se_sess->se_tpg;
325 se_tpg->se_tpg_tfo->close_session(se_sess);
328 void target_get_session(struct se_session *se_sess)
330 kref_get(&se_sess->sess_kref);
332 EXPORT_SYMBOL(target_get_session);
334 int target_put_session(struct se_session *se_sess)
336 return kref_put(&se_sess->sess_kref, target_release_session);
338 EXPORT_SYMBOL(target_put_session);
340 static void target_complete_nacl(struct kref *kref)
342 struct se_node_acl *nacl = container_of(kref,
343 struct se_node_acl, acl_kref);
345 complete(&nacl->acl_free_comp);
348 void target_put_nacl(struct se_node_acl *nacl)
350 kref_put(&nacl->acl_kref, target_complete_nacl);
353 void transport_deregister_session_configfs(struct se_session *se_sess)
355 struct se_node_acl *se_nacl;
358 * Used by struct se_node_acl's under ConfigFS to locate active struct se_session
360 se_nacl = se_sess->se_node_acl;
362 spin_lock_irqsave(&se_nacl->nacl_sess_lock, flags);
363 if (se_nacl->acl_stop == 0)
364 list_del(&se_sess->sess_acl_list);
366 * If the session list is empty, then clear the pointer.
367 * Otherwise, set the struct se_session pointer from the tail
368 * element of the per struct se_node_acl active session list.
370 if (list_empty(&se_nacl->acl_sess_list))
371 se_nacl->nacl_sess = NULL;
373 se_nacl->nacl_sess = container_of(
374 se_nacl->acl_sess_list.prev,
375 struct se_session, sess_acl_list);
377 spin_unlock_irqrestore(&se_nacl->nacl_sess_lock, flags);
380 EXPORT_SYMBOL(transport_deregister_session_configfs);
382 void transport_free_session(struct se_session *se_sess)
384 kmem_cache_free(se_sess_cache, se_sess);
386 EXPORT_SYMBOL(transport_free_session);
388 void transport_deregister_session(struct se_session *se_sess)
390 struct se_portal_group *se_tpg = se_sess->se_tpg;
391 struct target_core_fabric_ops *se_tfo;
392 struct se_node_acl *se_nacl;
394 bool comp_nacl = true;
397 transport_free_session(se_sess);
400 se_tfo = se_tpg->se_tpg_tfo;
402 spin_lock_irqsave(&se_tpg->session_lock, flags);
403 list_del(&se_sess->sess_list);
404 se_sess->se_tpg = NULL;
405 se_sess->fabric_sess_ptr = NULL;
406 spin_unlock_irqrestore(&se_tpg->session_lock, flags);
409 * Determine if we need to do extra work for this initiator node's
410 * struct se_node_acl if it had been previously dynamically generated.
412 se_nacl = se_sess->se_node_acl;
414 spin_lock_irqsave(&se_tpg->acl_node_lock, flags);
415 if (se_nacl && se_nacl->dynamic_node_acl) {
416 if (!se_tfo->tpg_check_demo_mode_cache(se_tpg)) {
417 list_del(&se_nacl->acl_list);
418 se_tpg->num_node_acls--;
419 spin_unlock_irqrestore(&se_tpg->acl_node_lock, flags);
420 core_tpg_wait_for_nacl_pr_ref(se_nacl);
421 core_free_device_list_for_node(se_nacl, se_tpg);
422 se_tfo->tpg_release_fabric_acl(se_tpg, se_nacl);
425 spin_lock_irqsave(&se_tpg->acl_node_lock, flags);
428 spin_unlock_irqrestore(&se_tpg->acl_node_lock, flags);
430 pr_debug("TARGET_CORE[%s]: Deregistered fabric_sess\n",
431 se_tpg->se_tpg_tfo->get_fabric_name());
433 * If last kref is dropping now for an explict NodeACL, awake sleeping
434 * ->acl_free_comp caller to wakeup configfs se_node_acl->acl_group
437 if (se_nacl && comp_nacl == true)
438 target_put_nacl(se_nacl);
440 transport_free_session(se_sess);
442 EXPORT_SYMBOL(transport_deregister_session);
445 * Called with cmd->t_state_lock held.
447 static void transport_all_task_dev_remove_state(struct se_cmd *cmd)
449 struct se_device *dev = cmd->se_dev;
450 struct se_task *task;
456 list_for_each_entry(task, &cmd->t_task_list, t_list) {
457 if (task->task_flags & TF_ACTIVE)
460 spin_lock_irqsave(&dev->execute_task_lock, flags);
461 if (task->t_state_active) {
462 pr_debug("Removed ITT: 0x%08x dev: %p task[%p]\n",
463 cmd->se_tfo->get_task_tag(cmd), dev, task);
465 list_del(&task->t_state_list);
466 atomic_dec(&cmd->t_task_cdbs_ex_left);
467 task->t_state_active = false;
469 spin_unlock_irqrestore(&dev->execute_task_lock, flags);
474 /* transport_cmd_check_stop():
476 * 'transport_off = 1' determines if CMD_T_ACTIVE should be cleared.
477 * 'transport_off = 2' determines if task_dev_state should be removed.
479 * A non-zero u8 t_state sets cmd->t_state.
480 * Returns 1 when command is stopped, else 0.
482 static int transport_cmd_check_stop(
489 spin_lock_irqsave(&cmd->t_state_lock, flags);
491 * Determine if IOCTL context caller in requesting the stopping of this
492 * command for LUN shutdown purposes.
494 if (cmd->transport_state & CMD_T_LUN_STOP) {
495 pr_debug("%s:%d CMD_T_LUN_STOP for ITT: 0x%08x\n",
496 __func__, __LINE__, cmd->se_tfo->get_task_tag(cmd));
498 cmd->transport_state &= ~CMD_T_ACTIVE;
499 if (transport_off == 2)
500 transport_all_task_dev_remove_state(cmd);
501 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
503 complete(&cmd->transport_lun_stop_comp);
507 * Determine if frontend context caller is requesting the stopping of
508 * this command for frontend exceptions.
510 if (cmd->transport_state & CMD_T_STOP) {
511 pr_debug("%s:%d CMD_T_STOP for ITT: 0x%08x\n",
513 cmd->se_tfo->get_task_tag(cmd));
515 if (transport_off == 2)
516 transport_all_task_dev_remove_state(cmd);
519 * Clear struct se_cmd->se_lun before the transport_off == 2 handoff
522 if (transport_off == 2)
524 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
526 complete(&cmd->t_transport_stop_comp);
530 cmd->transport_state &= ~CMD_T_ACTIVE;
531 if (transport_off == 2) {
532 transport_all_task_dev_remove_state(cmd);
534 * Clear struct se_cmd->se_lun before the transport_off == 2
535 * handoff to fabric module.
539 * Some fabric modules like tcm_loop can release
540 * their internally allocated I/O reference now and
543 * Fabric modules are expected to return '1' here if the
544 * se_cmd being passed is released at this point,
545 * or zero if not being released.
547 if (cmd->se_tfo->check_stop_free != NULL) {
548 spin_unlock_irqrestore(
549 &cmd->t_state_lock, flags);
551 return cmd->se_tfo->check_stop_free(cmd);
554 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
558 cmd->t_state = t_state;
559 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
564 static int transport_cmd_check_stop_to_fabric(struct se_cmd *cmd)
566 return transport_cmd_check_stop(cmd, 2, 0);
569 static void transport_lun_remove_cmd(struct se_cmd *cmd)
571 struct se_lun *lun = cmd->se_lun;
577 spin_lock_irqsave(&cmd->t_state_lock, flags);
578 if (cmd->transport_state & CMD_T_DEV_ACTIVE) {
579 cmd->transport_state &= ~CMD_T_DEV_ACTIVE;
580 transport_all_task_dev_remove_state(cmd);
582 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
584 spin_lock_irqsave(&lun->lun_cmd_lock, flags);
585 if (!list_empty(&cmd->se_lun_node))
586 list_del_init(&cmd->se_lun_node);
587 spin_unlock_irqrestore(&lun->lun_cmd_lock, flags);
590 void transport_cmd_finish_abort(struct se_cmd *cmd, int remove)
592 if (!(cmd->se_cmd_flags & SCF_SCSI_TMR_CDB))
593 transport_lun_remove_cmd(cmd);
595 if (transport_cmd_check_stop_to_fabric(cmd))
598 transport_remove_cmd_from_queue(cmd);
599 transport_put_cmd(cmd);
603 static void transport_add_cmd_to_queue(struct se_cmd *cmd, int t_state,
606 struct se_device *dev = cmd->se_dev;
607 struct se_queue_obj *qobj = &dev->dev_queue_obj;
611 spin_lock_irqsave(&cmd->t_state_lock, flags);
612 cmd->t_state = t_state;
613 cmd->transport_state |= CMD_T_ACTIVE;
614 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
617 spin_lock_irqsave(&qobj->cmd_queue_lock, flags);
619 /* If the cmd is already on the list, remove it before we add it */
620 if (!list_empty(&cmd->se_queue_node))
621 list_del(&cmd->se_queue_node);
623 atomic_inc(&qobj->queue_cnt);
626 list_add(&cmd->se_queue_node, &qobj->qobj_list);
628 list_add_tail(&cmd->se_queue_node, &qobj->qobj_list);
629 cmd->transport_state |= CMD_T_QUEUED;
630 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
632 wake_up_interruptible(&qobj->thread_wq);
635 static struct se_cmd *
636 transport_get_cmd_from_queue(struct se_queue_obj *qobj)
641 spin_lock_irqsave(&qobj->cmd_queue_lock, flags);
642 if (list_empty(&qobj->qobj_list)) {
643 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
646 cmd = list_first_entry(&qobj->qobj_list, struct se_cmd, se_queue_node);
648 cmd->transport_state &= ~CMD_T_QUEUED;
649 list_del_init(&cmd->se_queue_node);
650 atomic_dec(&qobj->queue_cnt);
651 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
656 static void transport_remove_cmd_from_queue(struct se_cmd *cmd)
658 struct se_queue_obj *qobj = &cmd->se_dev->dev_queue_obj;
661 spin_lock_irqsave(&qobj->cmd_queue_lock, flags);
662 if (!(cmd->transport_state & CMD_T_QUEUED)) {
663 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
666 cmd->transport_state &= ~CMD_T_QUEUED;
667 atomic_dec(&qobj->queue_cnt);
668 list_del_init(&cmd->se_queue_node);
669 spin_unlock_irqrestore(&qobj->cmd_queue_lock, flags);
673 * Completion function used by TCM subsystem plugins (such as FILEIO)
674 * for queueing up response from struct se_subsystem_api->do_task()
676 void transport_complete_sync_cache(struct se_cmd *cmd, int good)
678 struct se_task *task = list_entry(cmd->t_task_list.next,
679 struct se_task, t_list);
682 cmd->scsi_status = SAM_STAT_GOOD;
683 task->task_scsi_status = GOOD;
685 task->task_scsi_status = SAM_STAT_CHECK_CONDITION;
686 task->task_se_cmd->scsi_sense_reason =
687 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
691 transport_complete_task(task, good);
693 EXPORT_SYMBOL(transport_complete_sync_cache);
695 static void target_complete_failure_work(struct work_struct *work)
697 struct se_cmd *cmd = container_of(work, struct se_cmd, work);
699 transport_generic_request_failure(cmd);
702 /* transport_complete_task():
704 * Called from interrupt and non interrupt context depending
705 * on the transport plugin.
707 void transport_complete_task(struct se_task *task, int success)
709 struct se_cmd *cmd = task->task_se_cmd;
710 struct se_device *dev = cmd->se_dev;
713 spin_lock_irqsave(&cmd->t_state_lock, flags);
714 task->task_flags &= ~TF_ACTIVE;
717 * See if any sense data exists, if so set the TASK_SENSE flag.
718 * Also check for any other post completion work that needs to be
719 * done by the plugins.
721 if (dev && dev->transport->transport_complete) {
722 if (dev->transport->transport_complete(task) != 0) {
723 cmd->se_cmd_flags |= SCF_TRANSPORT_TASK_SENSE;
724 task->task_flags |= TF_HAS_SENSE;
730 * See if we are waiting for outstanding struct se_task
731 * to complete for an exception condition
733 if (task->task_flags & TF_REQUEST_STOP) {
734 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
735 complete(&task->task_stop_comp);
740 cmd->transport_state |= CMD_T_FAILED;
743 * Decrement the outstanding t_task_cdbs_left count. The last
744 * struct se_task from struct se_cmd will complete itself into the
745 * device queue depending upon int success.
747 if (!atomic_dec_and_test(&cmd->t_task_cdbs_left)) {
748 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
752 * Check for case where an explict ABORT_TASK has been received
753 * and transport_wait_for_tasks() will be waiting for completion..
755 if (cmd->transport_state & CMD_T_ABORTED &&
756 cmd->transport_state & CMD_T_STOP) {
757 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
758 complete(&cmd->t_transport_stop_comp);
760 } else if (cmd->transport_state & CMD_T_FAILED) {
761 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
762 INIT_WORK(&cmd->work, target_complete_failure_work);
764 INIT_WORK(&cmd->work, target_complete_ok_work);
767 cmd->t_state = TRANSPORT_COMPLETE;
768 cmd->transport_state |= (CMD_T_COMPLETE | CMD_T_ACTIVE);
769 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
771 queue_work(target_completion_wq, &cmd->work);
773 EXPORT_SYMBOL(transport_complete_task);
776 * Called by transport_add_tasks_from_cmd() once a struct se_cmd's
777 * struct se_task list are ready to be added to the active execution list
780 * Called with se_dev_t->execute_task_lock called.
782 static inline int transport_add_task_check_sam_attr(
783 struct se_task *task,
784 struct se_task *task_prev,
785 struct se_device *dev)
788 * No SAM Task attribute emulation enabled, add to tail of
791 if (dev->dev_task_attr_type != SAM_TASK_ATTR_EMULATED) {
792 list_add_tail(&task->t_execute_list, &dev->execute_task_list);
796 * HEAD_OF_QUEUE attribute for received CDB, which means
797 * the first task that is associated with a struct se_cmd goes to
798 * head of the struct se_device->execute_task_list, and task_prev
799 * after that for each subsequent task
801 if (task->task_se_cmd->sam_task_attr == MSG_HEAD_TAG) {
802 list_add(&task->t_execute_list,
803 (task_prev != NULL) ?
804 &task_prev->t_execute_list :
805 &dev->execute_task_list);
807 pr_debug("Set HEAD_OF_QUEUE for task CDB: 0x%02x"
808 " in execution queue\n",
809 task->task_se_cmd->t_task_cdb[0]);
813 * For ORDERED, SIMPLE or UNTAGGED attribute tasks once they have been
814 * transitioned from Dermant -> Active state, and are added to the end
815 * of the struct se_device->execute_task_list
817 list_add_tail(&task->t_execute_list, &dev->execute_task_list);
821 /* __transport_add_task_to_execute_queue():
823 * Called with se_dev_t->execute_task_lock called.
825 static void __transport_add_task_to_execute_queue(
826 struct se_task *task,
827 struct se_task *task_prev,
828 struct se_device *dev)
832 head_of_queue = transport_add_task_check_sam_attr(task, task_prev, dev);
833 atomic_inc(&dev->execute_tasks);
835 if (task->t_state_active)
838 * Determine if this task needs to go to HEAD_OF_QUEUE for the
839 * state list as well. Running with SAM Task Attribute emulation
840 * will always return head_of_queue == 0 here
843 list_add(&task->t_state_list, (task_prev) ?
844 &task_prev->t_state_list :
845 &dev->state_task_list);
847 list_add_tail(&task->t_state_list, &dev->state_task_list);
849 task->t_state_active = true;
851 pr_debug("Added ITT: 0x%08x task[%p] to dev: %p\n",
852 task->task_se_cmd->se_tfo->get_task_tag(task->task_se_cmd),
856 static void transport_add_tasks_to_state_queue(struct se_cmd *cmd)
858 struct se_device *dev = cmd->se_dev;
859 struct se_task *task;
862 spin_lock_irqsave(&cmd->t_state_lock, flags);
863 list_for_each_entry(task, &cmd->t_task_list, t_list) {
864 spin_lock(&dev->execute_task_lock);
865 if (!task->t_state_active) {
866 list_add_tail(&task->t_state_list,
867 &dev->state_task_list);
868 task->t_state_active = true;
870 pr_debug("Added ITT: 0x%08x task[%p] to dev: %p\n",
871 task->task_se_cmd->se_tfo->get_task_tag(
872 task->task_se_cmd), task, dev);
874 spin_unlock(&dev->execute_task_lock);
876 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
879 static void __transport_add_tasks_from_cmd(struct se_cmd *cmd)
881 struct se_device *dev = cmd->se_dev;
882 struct se_task *task, *task_prev = NULL;
884 list_for_each_entry(task, &cmd->t_task_list, t_list) {
885 if (!list_empty(&task->t_execute_list))
888 * __transport_add_task_to_execute_queue() handles the
889 * SAM Task Attribute emulation if enabled
891 __transport_add_task_to_execute_queue(task, task_prev, dev);
896 static void transport_add_tasks_from_cmd(struct se_cmd *cmd)
899 struct se_device *dev = cmd->se_dev;
901 spin_lock_irqsave(&dev->execute_task_lock, flags);
902 __transport_add_tasks_from_cmd(cmd);
903 spin_unlock_irqrestore(&dev->execute_task_lock, flags);
906 void __transport_remove_task_from_execute_queue(struct se_task *task,
907 struct se_device *dev)
909 list_del_init(&task->t_execute_list);
910 atomic_dec(&dev->execute_tasks);
913 static void transport_remove_task_from_execute_queue(
914 struct se_task *task,
915 struct se_device *dev)
919 if (WARN_ON(list_empty(&task->t_execute_list)))
922 spin_lock_irqsave(&dev->execute_task_lock, flags);
923 __transport_remove_task_from_execute_queue(task, dev);
924 spin_unlock_irqrestore(&dev->execute_task_lock, flags);
928 * Handle QUEUE_FULL / -EAGAIN and -ENOMEM status
931 static void target_qf_do_work(struct work_struct *work)
933 struct se_device *dev = container_of(work, struct se_device,
935 LIST_HEAD(qf_cmd_list);
936 struct se_cmd *cmd, *cmd_tmp;
938 spin_lock_irq(&dev->qf_cmd_lock);
939 list_splice_init(&dev->qf_cmd_list, &qf_cmd_list);
940 spin_unlock_irq(&dev->qf_cmd_lock);
942 list_for_each_entry_safe(cmd, cmd_tmp, &qf_cmd_list, se_qf_node) {
943 list_del(&cmd->se_qf_node);
944 atomic_dec(&dev->dev_qf_count);
945 smp_mb__after_atomic_dec();
947 pr_debug("Processing %s cmd: %p QUEUE_FULL in work queue"
948 " context: %s\n", cmd->se_tfo->get_fabric_name(), cmd,
949 (cmd->t_state == TRANSPORT_COMPLETE_QF_OK) ? "COMPLETE_OK" :
950 (cmd->t_state == TRANSPORT_COMPLETE_QF_WP) ? "WRITE_PENDING"
953 transport_add_cmd_to_queue(cmd, cmd->t_state, true);
957 unsigned char *transport_dump_cmd_direction(struct se_cmd *cmd)
959 switch (cmd->data_direction) {
962 case DMA_FROM_DEVICE:
966 case DMA_BIDIRECTIONAL:
975 void transport_dump_dev_state(
976 struct se_device *dev,
980 *bl += sprintf(b + *bl, "Status: ");
981 switch (dev->dev_status) {
982 case TRANSPORT_DEVICE_ACTIVATED:
983 *bl += sprintf(b + *bl, "ACTIVATED");
985 case TRANSPORT_DEVICE_DEACTIVATED:
986 *bl += sprintf(b + *bl, "DEACTIVATED");
988 case TRANSPORT_DEVICE_SHUTDOWN:
989 *bl += sprintf(b + *bl, "SHUTDOWN");
991 case TRANSPORT_DEVICE_OFFLINE_ACTIVATED:
992 case TRANSPORT_DEVICE_OFFLINE_DEACTIVATED:
993 *bl += sprintf(b + *bl, "OFFLINE");
996 *bl += sprintf(b + *bl, "UNKNOWN=%d", dev->dev_status);
1000 *bl += sprintf(b + *bl, " Execute/Max Queue Depth: %d/%d",
1001 atomic_read(&dev->execute_tasks), dev->queue_depth);
1002 *bl += sprintf(b + *bl, " SectorSize: %u MaxSectors: %u\n",
1003 dev->se_sub_dev->se_dev_attrib.block_size, dev->se_sub_dev->se_dev_attrib.max_sectors);
1004 *bl += sprintf(b + *bl, " ");
1007 void transport_dump_vpd_proto_id(
1008 struct t10_vpd *vpd,
1009 unsigned char *p_buf,
1012 unsigned char buf[VPD_TMP_BUF_SIZE];
1015 memset(buf, 0, VPD_TMP_BUF_SIZE);
1016 len = sprintf(buf, "T10 VPD Protocol Identifier: ");
1018 switch (vpd->protocol_identifier) {
1020 sprintf(buf+len, "Fibre Channel\n");
1023 sprintf(buf+len, "Parallel SCSI\n");
1026 sprintf(buf+len, "SSA\n");
1029 sprintf(buf+len, "IEEE 1394\n");
1032 sprintf(buf+len, "SCSI Remote Direct Memory Access"
1036 sprintf(buf+len, "Internet SCSI (iSCSI)\n");
1039 sprintf(buf+len, "SAS Serial SCSI Protocol\n");
1042 sprintf(buf+len, "Automation/Drive Interface Transport"
1046 sprintf(buf+len, "AT Attachment Interface ATA/ATAPI\n");
1049 sprintf(buf+len, "Unknown 0x%02x\n",
1050 vpd->protocol_identifier);
1055 strncpy(p_buf, buf, p_buf_len);
1057 pr_debug("%s", buf);
1061 transport_set_vpd_proto_id(struct t10_vpd *vpd, unsigned char *page_83)
1064 * Check if the Protocol Identifier Valid (PIV) bit is set..
1066 * from spc3r23.pdf section 7.5.1
1068 if (page_83[1] & 0x80) {
1069 vpd->protocol_identifier = (page_83[0] & 0xf0);
1070 vpd->protocol_identifier_set = 1;
1071 transport_dump_vpd_proto_id(vpd, NULL, 0);
1074 EXPORT_SYMBOL(transport_set_vpd_proto_id);
1076 int transport_dump_vpd_assoc(
1077 struct t10_vpd *vpd,
1078 unsigned char *p_buf,
1081 unsigned char buf[VPD_TMP_BUF_SIZE];
1085 memset(buf, 0, VPD_TMP_BUF_SIZE);
1086 len = sprintf(buf, "T10 VPD Identifier Association: ");
1088 switch (vpd->association) {
1090 sprintf(buf+len, "addressed logical unit\n");
1093 sprintf(buf+len, "target port\n");
1096 sprintf(buf+len, "SCSI target device\n");
1099 sprintf(buf+len, "Unknown 0x%02x\n", vpd->association);
1105 strncpy(p_buf, buf, p_buf_len);
1107 pr_debug("%s", buf);
1112 int transport_set_vpd_assoc(struct t10_vpd *vpd, unsigned char *page_83)
1115 * The VPD identification association..
1117 * from spc3r23.pdf Section 7.6.3.1 Table 297
1119 vpd->association = (page_83[1] & 0x30);
1120 return transport_dump_vpd_assoc(vpd, NULL, 0);
1122 EXPORT_SYMBOL(transport_set_vpd_assoc);
1124 int transport_dump_vpd_ident_type(
1125 struct t10_vpd *vpd,
1126 unsigned char *p_buf,
1129 unsigned char buf[VPD_TMP_BUF_SIZE];
1133 memset(buf, 0, VPD_TMP_BUF_SIZE);
1134 len = sprintf(buf, "T10 VPD Identifier Type: ");
1136 switch (vpd->device_identifier_type) {
1138 sprintf(buf+len, "Vendor specific\n");
1141 sprintf(buf+len, "T10 Vendor ID based\n");
1144 sprintf(buf+len, "EUI-64 based\n");
1147 sprintf(buf+len, "NAA\n");
1150 sprintf(buf+len, "Relative target port identifier\n");
1153 sprintf(buf+len, "SCSI name string\n");
1156 sprintf(buf+len, "Unsupported: 0x%02x\n",
1157 vpd->device_identifier_type);
1163 if (p_buf_len < strlen(buf)+1)
1165 strncpy(p_buf, buf, p_buf_len);
1167 pr_debug("%s", buf);
1173 int transport_set_vpd_ident_type(struct t10_vpd *vpd, unsigned char *page_83)
1176 * The VPD identifier type..
1178 * from spc3r23.pdf Section 7.6.3.1 Table 298
1180 vpd->device_identifier_type = (page_83[1] & 0x0f);
1181 return transport_dump_vpd_ident_type(vpd, NULL, 0);
1183 EXPORT_SYMBOL(transport_set_vpd_ident_type);
1185 int transport_dump_vpd_ident(
1186 struct t10_vpd *vpd,
1187 unsigned char *p_buf,
1190 unsigned char buf[VPD_TMP_BUF_SIZE];
1193 memset(buf, 0, VPD_TMP_BUF_SIZE);
1195 switch (vpd->device_identifier_code_set) {
1196 case 0x01: /* Binary */
1197 sprintf(buf, "T10 VPD Binary Device Identifier: %s\n",
1198 &vpd->device_identifier[0]);
1200 case 0x02: /* ASCII */
1201 sprintf(buf, "T10 VPD ASCII Device Identifier: %s\n",
1202 &vpd->device_identifier[0]);
1204 case 0x03: /* UTF-8 */
1205 sprintf(buf, "T10 VPD UTF-8 Device Identifier: %s\n",
1206 &vpd->device_identifier[0]);
1209 sprintf(buf, "T10 VPD Device Identifier encoding unsupported:"
1210 " 0x%02x", vpd->device_identifier_code_set);
1216 strncpy(p_buf, buf, p_buf_len);
1218 pr_debug("%s", buf);
1224 transport_set_vpd_ident(struct t10_vpd *vpd, unsigned char *page_83)
1226 static const char hex_str[] = "0123456789abcdef";
1227 int j = 0, i = 4; /* offset to start of the identifer */
1230 * The VPD Code Set (encoding)
1232 * from spc3r23.pdf Section 7.6.3.1 Table 296
1234 vpd->device_identifier_code_set = (page_83[0] & 0x0f);
1235 switch (vpd->device_identifier_code_set) {
1236 case 0x01: /* Binary */
1237 vpd->device_identifier[j++] =
1238 hex_str[vpd->device_identifier_type];
1239 while (i < (4 + page_83[3])) {
1240 vpd->device_identifier[j++] =
1241 hex_str[(page_83[i] & 0xf0) >> 4];
1242 vpd->device_identifier[j++] =
1243 hex_str[page_83[i] & 0x0f];
1247 case 0x02: /* ASCII */
1248 case 0x03: /* UTF-8 */
1249 while (i < (4 + page_83[3]))
1250 vpd->device_identifier[j++] = page_83[i++];
1256 return transport_dump_vpd_ident(vpd, NULL, 0);
1258 EXPORT_SYMBOL(transport_set_vpd_ident);
1260 static void core_setup_task_attr_emulation(struct se_device *dev)
1263 * If this device is from Target_Core_Mod/pSCSI, disable the
1264 * SAM Task Attribute emulation.
1266 * This is currently not available in upsream Linux/SCSI Target
1267 * mode code, and is assumed to be disabled while using TCM/pSCSI.
1269 if (dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV) {
1270 dev->dev_task_attr_type = SAM_TASK_ATTR_PASSTHROUGH;
1274 dev->dev_task_attr_type = SAM_TASK_ATTR_EMULATED;
1275 pr_debug("%s: Using SAM_TASK_ATTR_EMULATED for SPC: 0x%02x"
1276 " device\n", dev->transport->name,
1277 dev->transport->get_device_rev(dev));
1280 static void scsi_dump_inquiry(struct se_device *dev)
1282 struct t10_wwn *wwn = &dev->se_sub_dev->t10_wwn;
1286 * Print Linux/SCSI style INQUIRY formatting to the kernel ring buffer
1288 for (i = 0; i < 8; i++)
1289 if (wwn->vendor[i] >= 0x20)
1290 buf[i] = wwn->vendor[i];
1294 pr_debug(" Vendor: %s\n", buf);
1296 for (i = 0; i < 16; i++)
1297 if (wwn->model[i] >= 0x20)
1298 buf[i] = wwn->model[i];
1302 pr_debug(" Model: %s\n", buf);
1304 for (i = 0; i < 4; i++)
1305 if (wwn->revision[i] >= 0x20)
1306 buf[i] = wwn->revision[i];
1310 pr_debug(" Revision: %s\n", buf);
1312 device_type = dev->transport->get_device_type(dev);
1313 pr_debug(" Type: %s ", scsi_device_type(device_type));
1314 pr_debug(" ANSI SCSI revision: %02x\n",
1315 dev->transport->get_device_rev(dev));
1318 struct se_device *transport_add_device_to_core_hba(
1320 struct se_subsystem_api *transport,
1321 struct se_subsystem_dev *se_dev,
1323 void *transport_dev,
1324 struct se_dev_limits *dev_limits,
1325 const char *inquiry_prod,
1326 const char *inquiry_rev)
1329 struct se_device *dev;
1331 dev = kzalloc(sizeof(struct se_device), GFP_KERNEL);
1333 pr_err("Unable to allocate memory for se_dev_t\n");
1337 transport_init_queue_obj(&dev->dev_queue_obj);
1338 dev->dev_flags = device_flags;
1339 dev->dev_status |= TRANSPORT_DEVICE_DEACTIVATED;
1340 dev->dev_ptr = transport_dev;
1342 dev->se_sub_dev = se_dev;
1343 dev->transport = transport;
1344 INIT_LIST_HEAD(&dev->dev_list);
1345 INIT_LIST_HEAD(&dev->dev_sep_list);
1346 INIT_LIST_HEAD(&dev->dev_tmr_list);
1347 INIT_LIST_HEAD(&dev->execute_task_list);
1348 INIT_LIST_HEAD(&dev->delayed_cmd_list);
1349 INIT_LIST_HEAD(&dev->state_task_list);
1350 INIT_LIST_HEAD(&dev->qf_cmd_list);
1351 spin_lock_init(&dev->execute_task_lock);
1352 spin_lock_init(&dev->delayed_cmd_lock);
1353 spin_lock_init(&dev->dev_reservation_lock);
1354 spin_lock_init(&dev->dev_status_lock);
1355 spin_lock_init(&dev->se_port_lock);
1356 spin_lock_init(&dev->se_tmr_lock);
1357 spin_lock_init(&dev->qf_cmd_lock);
1358 atomic_set(&dev->dev_ordered_id, 0);
1360 se_dev_set_default_attribs(dev, dev_limits);
1362 dev->dev_index = scsi_get_new_index(SCSI_DEVICE_INDEX);
1363 dev->creation_time = get_jiffies_64();
1364 spin_lock_init(&dev->stats_lock);
1366 spin_lock(&hba->device_lock);
1367 list_add_tail(&dev->dev_list, &hba->hba_dev_list);
1369 spin_unlock(&hba->device_lock);
1371 * Setup the SAM Task Attribute emulation for struct se_device
1373 core_setup_task_attr_emulation(dev);
1375 * Force PR and ALUA passthrough emulation with internal object use.
1377 force_pt = (hba->hba_flags & HBA_FLAGS_INTERNAL_USE);
1379 * Setup the Reservations infrastructure for struct se_device
1381 core_setup_reservations(dev, force_pt);
1383 * Setup the Asymmetric Logical Unit Assignment for struct se_device
1385 if (core_setup_alua(dev, force_pt) < 0)
1389 * Startup the struct se_device processing thread
1391 dev->process_thread = kthread_run(transport_processing_thread, dev,
1392 "LIO_%s", dev->transport->name);
1393 if (IS_ERR(dev->process_thread)) {
1394 pr_err("Unable to create kthread: LIO_%s\n",
1395 dev->transport->name);
1399 * Setup work_queue for QUEUE_FULL
1401 INIT_WORK(&dev->qf_work_queue, target_qf_do_work);
1403 * Preload the initial INQUIRY const values if we are doing
1404 * anything virtual (IBLOCK, FILEIO, RAMDISK), but not for TCM/pSCSI
1405 * passthrough because this is being provided by the backend LLD.
1406 * This is required so that transport_get_inquiry() copies these
1407 * originals once back into DEV_T10_WWN(dev) for the virtual device
1410 if (dev->transport->transport_type != TRANSPORT_PLUGIN_PHBA_PDEV) {
1411 if (!inquiry_prod || !inquiry_rev) {
1412 pr_err("All non TCM/pSCSI plugins require"
1413 " INQUIRY consts\n");
1417 strncpy(&dev->se_sub_dev->t10_wwn.vendor[0], "LIO-ORG", 8);
1418 strncpy(&dev->se_sub_dev->t10_wwn.model[0], inquiry_prod, 16);
1419 strncpy(&dev->se_sub_dev->t10_wwn.revision[0], inquiry_rev, 4);
1421 scsi_dump_inquiry(dev);
1425 kthread_stop(dev->process_thread);
1427 spin_lock(&hba->device_lock);
1428 list_del(&dev->dev_list);
1430 spin_unlock(&hba->device_lock);
1432 se_release_vpd_for_dev(dev);
1438 EXPORT_SYMBOL(transport_add_device_to_core_hba);
1440 /* transport_generic_prepare_cdb():
1442 * Since the Initiator sees iSCSI devices as LUNs, the SCSI CDB will
1443 * contain the iSCSI LUN in bits 7-5 of byte 1 as per SAM-2.
1444 * The point of this is since we are mapping iSCSI LUNs to
1445 * SCSI Target IDs having a non-zero LUN in the CDB will throw the
1446 * devices and HBAs for a loop.
1448 static inline void transport_generic_prepare_cdb(
1452 case READ_10: /* SBC - RDProtect */
1453 case READ_12: /* SBC - RDProtect */
1454 case READ_16: /* SBC - RDProtect */
1455 case SEND_DIAGNOSTIC: /* SPC - SELF-TEST Code */
1456 case VERIFY: /* SBC - VRProtect */
1457 case VERIFY_16: /* SBC - VRProtect */
1458 case WRITE_VERIFY: /* SBC - VRProtect */
1459 case WRITE_VERIFY_12: /* SBC - VRProtect */
1462 cdb[1] &= 0x1f; /* clear logical unit number */
1467 static struct se_task *
1468 transport_generic_get_task(struct se_cmd *cmd,
1469 enum dma_data_direction data_direction)
1471 struct se_task *task;
1472 struct se_device *dev = cmd->se_dev;
1474 task = dev->transport->alloc_task(cmd->t_task_cdb);
1476 pr_err("Unable to allocate struct se_task\n");
1480 INIT_LIST_HEAD(&task->t_list);
1481 INIT_LIST_HEAD(&task->t_execute_list);
1482 INIT_LIST_HEAD(&task->t_state_list);
1483 init_completion(&task->task_stop_comp);
1484 task->task_se_cmd = cmd;
1485 task->task_data_direction = data_direction;
1490 static int transport_generic_cmd_sequencer(struct se_cmd *, unsigned char *);
1493 * Used by fabric modules containing a local struct se_cmd within their
1494 * fabric dependent per I/O descriptor.
1496 void transport_init_se_cmd(
1498 struct target_core_fabric_ops *tfo,
1499 struct se_session *se_sess,
1503 unsigned char *sense_buffer)
1505 INIT_LIST_HEAD(&cmd->se_lun_node);
1506 INIT_LIST_HEAD(&cmd->se_delayed_node);
1507 INIT_LIST_HEAD(&cmd->se_qf_node);
1508 INIT_LIST_HEAD(&cmd->se_queue_node);
1509 INIT_LIST_HEAD(&cmd->se_cmd_list);
1510 INIT_LIST_HEAD(&cmd->t_task_list);
1511 init_completion(&cmd->transport_lun_fe_stop_comp);
1512 init_completion(&cmd->transport_lun_stop_comp);
1513 init_completion(&cmd->t_transport_stop_comp);
1514 init_completion(&cmd->cmd_wait_comp);
1515 spin_lock_init(&cmd->t_state_lock);
1516 cmd->transport_state = CMD_T_DEV_ACTIVE;
1519 cmd->se_sess = se_sess;
1520 cmd->data_length = data_length;
1521 cmd->data_direction = data_direction;
1522 cmd->sam_task_attr = task_attr;
1523 cmd->sense_buffer = sense_buffer;
1525 EXPORT_SYMBOL(transport_init_se_cmd);
1527 static int transport_check_alloc_task_attr(struct se_cmd *cmd)
1530 * Check if SAM Task Attribute emulation is enabled for this
1531 * struct se_device storage object
1533 if (cmd->se_dev->dev_task_attr_type != SAM_TASK_ATTR_EMULATED)
1536 if (cmd->sam_task_attr == MSG_ACA_TAG) {
1537 pr_debug("SAM Task Attribute ACA"
1538 " emulation is not supported\n");
1542 * Used to determine when ORDERED commands should go from
1543 * Dormant to Active status.
1545 cmd->se_ordered_id = atomic_inc_return(&cmd->se_dev->dev_ordered_id);
1546 smp_mb__after_atomic_inc();
1547 pr_debug("Allocated se_ordered_id: %u for Task Attr: 0x%02x on %s\n",
1548 cmd->se_ordered_id, cmd->sam_task_attr,
1549 cmd->se_dev->transport->name);
1553 /* transport_generic_allocate_tasks():
1555 * Called from fabric RX Thread.
1557 int transport_generic_allocate_tasks(
1563 transport_generic_prepare_cdb(cdb);
1565 * Ensure that the received CDB is less than the max (252 + 8) bytes
1566 * for VARIABLE_LENGTH_CMD
1568 if (scsi_command_size(cdb) > SCSI_MAX_VARLEN_CDB_SIZE) {
1569 pr_err("Received SCSI CDB with command_size: %d that"
1570 " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1571 scsi_command_size(cdb), SCSI_MAX_VARLEN_CDB_SIZE);
1572 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
1573 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
1577 * If the received CDB is larger than TCM_MAX_COMMAND_SIZE,
1578 * allocate the additional extended CDB buffer now.. Otherwise
1579 * setup the pointer from __t_task_cdb to t_task_cdb.
1581 if (scsi_command_size(cdb) > sizeof(cmd->__t_task_cdb)) {
1582 cmd->t_task_cdb = kzalloc(scsi_command_size(cdb),
1584 if (!cmd->t_task_cdb) {
1585 pr_err("Unable to allocate cmd->t_task_cdb"
1586 " %u > sizeof(cmd->__t_task_cdb): %lu ops\n",
1587 scsi_command_size(cdb),
1588 (unsigned long)sizeof(cmd->__t_task_cdb));
1589 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
1590 cmd->scsi_sense_reason =
1591 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1595 cmd->t_task_cdb = &cmd->__t_task_cdb[0];
1597 * Copy the original CDB into cmd->
1599 memcpy(cmd->t_task_cdb, cdb, scsi_command_size(cdb));
1601 * Setup the received CDB based on SCSI defined opcodes and
1602 * perform unit attention, persistent reservations and ALUA
1603 * checks for virtual device backends. The cmd->t_task_cdb
1604 * pointer is expected to be setup before we reach this point.
1606 ret = transport_generic_cmd_sequencer(cmd, cdb);
1610 * Check for SAM Task Attribute Emulation
1612 if (transport_check_alloc_task_attr(cmd) < 0) {
1613 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
1614 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
1617 spin_lock(&cmd->se_lun->lun_sep_lock);
1618 if (cmd->se_lun->lun_sep)
1619 cmd->se_lun->lun_sep->sep_stats.cmd_pdus++;
1620 spin_unlock(&cmd->se_lun->lun_sep_lock);
1623 EXPORT_SYMBOL(transport_generic_allocate_tasks);
1626 * Used by fabric module frontends to queue tasks directly.
1627 * Many only be used from process context only
1629 int transport_handle_cdb_direct(
1636 pr_err("cmd->se_lun is NULL\n");
1639 if (in_interrupt()) {
1641 pr_err("transport_generic_handle_cdb cannot be called"
1642 " from interrupt context\n");
1646 * Set TRANSPORT_NEW_CMD state and CMD_T_ACTIVE following
1647 * transport_generic_handle_cdb*() -> transport_add_cmd_to_queue()
1648 * in existing usage to ensure that outstanding descriptors are handled
1649 * correctly during shutdown via transport_wait_for_tasks()
1651 * Also, we don't take cmd->t_state_lock here as we only expect
1652 * this to be called for initial descriptor submission.
1654 cmd->t_state = TRANSPORT_NEW_CMD;
1655 cmd->transport_state |= CMD_T_ACTIVE;
1658 * transport_generic_new_cmd() is already handling QUEUE_FULL,
1659 * so follow TRANSPORT_NEW_CMD processing thread context usage
1660 * and call transport_generic_request_failure() if necessary..
1662 ret = transport_generic_new_cmd(cmd);
1664 transport_generic_request_failure(cmd);
1668 EXPORT_SYMBOL(transport_handle_cdb_direct);
1671 * target_submit_cmd - lookup unpacked lun and submit uninitialized se_cmd
1673 * @se_cmd: command descriptor to submit
1674 * @se_sess: associated se_sess for endpoint
1675 * @cdb: pointer to SCSI CDB
1676 * @sense: pointer to SCSI sense buffer
1677 * @unpacked_lun: unpacked LUN to reference for struct se_lun
1678 * @data_length: fabric expected data transfer length
1679 * @task_addr: SAM task attribute
1680 * @data_dir: DMA data direction
1681 * @flags: flags for command submission from target_sc_flags_tables
1683 * This may only be called from process context, and also currently
1684 * assumes internal allocation of fabric payload buffer by target-core.
1686 void target_submit_cmd(struct se_cmd *se_cmd, struct se_session *se_sess,
1687 unsigned char *cdb, unsigned char *sense, u32 unpacked_lun,
1688 u32 data_length, int task_attr, int data_dir, int flags)
1690 struct se_portal_group *se_tpg;
1693 se_tpg = se_sess->se_tpg;
1695 BUG_ON(se_cmd->se_tfo || se_cmd->se_sess);
1696 BUG_ON(in_interrupt());
1698 * Initialize se_cmd for target operation. From this point
1699 * exceptions are handled by sending exception status via
1700 * target_core_fabric_ops->queue_status() callback
1702 transport_init_se_cmd(se_cmd, se_tpg->se_tpg_tfo, se_sess,
1703 data_length, data_dir, task_attr, sense);
1705 * Obtain struct se_cmd->cmd_kref reference and add new cmd to
1706 * se_sess->sess_cmd_list. A second kref_get here is necessary
1707 * for fabrics using TARGET_SCF_ACK_KREF that expect a second
1708 * kref_put() to happen during fabric packet acknowledgement.
1710 target_get_sess_cmd(se_sess, se_cmd, (flags & TARGET_SCF_ACK_KREF));
1712 * Signal bidirectional data payloads to target-core
1714 if (flags & TARGET_SCF_BIDI_OP)
1715 se_cmd->se_cmd_flags |= SCF_BIDI;
1717 * Locate se_lun pointer and attach it to struct se_cmd
1719 if (transport_lookup_cmd_lun(se_cmd, unpacked_lun) < 0) {
1720 transport_send_check_condition_and_sense(se_cmd,
1721 se_cmd->scsi_sense_reason, 0);
1722 target_put_sess_cmd(se_sess, se_cmd);
1726 * Sanitize CDBs via transport_generic_cmd_sequencer() and
1727 * allocate the necessary tasks to complete the received CDB+data
1729 rc = transport_generic_allocate_tasks(se_cmd, cdb);
1731 transport_generic_request_failure(se_cmd);
1735 * Dispatch se_cmd descriptor to se_lun->lun_se_dev backend
1736 * for immediate execution of READs, otherwise wait for
1737 * transport_generic_handle_data() to be called for WRITEs
1738 * when fabric has filled the incoming buffer.
1740 transport_handle_cdb_direct(se_cmd);
1743 EXPORT_SYMBOL(target_submit_cmd);
1745 static void target_complete_tmr_failure(struct work_struct *work)
1747 struct se_cmd *se_cmd = container_of(work, struct se_cmd, work);
1749 se_cmd->se_tmr_req->response = TMR_LUN_DOES_NOT_EXIST;
1750 se_cmd->se_tfo->queue_tm_rsp(se_cmd);
1751 transport_generic_free_cmd(se_cmd, 0);
1755 * target_submit_tmr - lookup unpacked lun and submit uninitialized se_cmd
1758 * @se_cmd: command descriptor to submit
1759 * @se_sess: associated se_sess for endpoint
1760 * @sense: pointer to SCSI sense buffer
1761 * @unpacked_lun: unpacked LUN to reference for struct se_lun
1762 * @fabric_context: fabric context for TMR req
1763 * @tm_type: Type of TM request
1764 * @gfp: gfp type for caller
1765 * @tag: referenced task tag for TMR_ABORT_TASK
1766 * @flags: submit cmd flags
1768 * Callable from all contexts.
1771 int target_submit_tmr(struct se_cmd *se_cmd, struct se_session *se_sess,
1772 unsigned char *sense, u32 unpacked_lun,
1773 void *fabric_tmr_ptr, unsigned char tm_type,
1774 gfp_t gfp, unsigned int tag, int flags)
1776 struct se_portal_group *se_tpg;
1779 se_tpg = se_sess->se_tpg;
1782 transport_init_se_cmd(se_cmd, se_tpg->se_tpg_tfo, se_sess,
1783 0, DMA_NONE, MSG_SIMPLE_TAG, sense);
1785 * FIXME: Currently expect caller to handle se_cmd->se_tmr_req
1786 * allocation failure.
1788 ret = core_tmr_alloc_req(se_cmd, fabric_tmr_ptr, tm_type, gfp);
1792 if (tm_type == TMR_ABORT_TASK)
1793 se_cmd->se_tmr_req->ref_task_tag = tag;
1795 /* See target_submit_cmd for commentary */
1796 target_get_sess_cmd(se_sess, se_cmd, (flags & TARGET_SCF_ACK_KREF));
1798 ret = transport_lookup_tmr_lun(se_cmd, unpacked_lun);
1801 * For callback during failure handling, push this work off
1802 * to process context with TMR_LUN_DOES_NOT_EXIST status.
1804 INIT_WORK(&se_cmd->work, target_complete_tmr_failure);
1805 schedule_work(&se_cmd->work);
1808 transport_generic_handle_tmr(se_cmd);
1811 EXPORT_SYMBOL(target_submit_tmr);
1814 * Used by fabric module frontends defining a TFO->new_cmd_map() caller
1815 * to queue up a newly setup se_cmd w/ TRANSPORT_NEW_CMD_MAP in order to
1816 * complete setup in TCM process context w/ TFO->new_cmd_map().
1818 int transport_generic_handle_cdb_map(
1823 pr_err("cmd->se_lun is NULL\n");
1827 transport_add_cmd_to_queue(cmd, TRANSPORT_NEW_CMD_MAP, false);
1830 EXPORT_SYMBOL(transport_generic_handle_cdb_map);
1832 /* transport_generic_handle_data():
1836 int transport_generic_handle_data(
1840 * For the software fabric case, then we assume the nexus is being
1841 * failed/shutdown when signals are pending from the kthread context
1842 * caller, so we return a failure. For the HW target mode case running
1843 * in interrupt code, the signal_pending() check is skipped.
1845 if (!in_interrupt() && signal_pending(current))
1848 * If the received CDB has aleady been ABORTED by the generic
1849 * target engine, we now call transport_check_aborted_status()
1850 * to queue any delated TASK_ABORTED status for the received CDB to the
1851 * fabric module as we are expecting no further incoming DATA OUT
1852 * sequences at this point.
1854 if (transport_check_aborted_status(cmd, 1) != 0)
1857 transport_add_cmd_to_queue(cmd, TRANSPORT_PROCESS_WRITE, false);
1860 EXPORT_SYMBOL(transport_generic_handle_data);
1862 /* transport_generic_handle_tmr():
1866 int transport_generic_handle_tmr(
1869 transport_add_cmd_to_queue(cmd, TRANSPORT_PROCESS_TMR, false);
1872 EXPORT_SYMBOL(transport_generic_handle_tmr);
1875 * If the task is active, request it to be stopped and sleep until it
1878 bool target_stop_task(struct se_task *task, unsigned long *flags)
1880 struct se_cmd *cmd = task->task_se_cmd;
1881 bool was_active = false;
1883 if (task->task_flags & TF_ACTIVE) {
1884 task->task_flags |= TF_REQUEST_STOP;
1885 spin_unlock_irqrestore(&cmd->t_state_lock, *flags);
1887 pr_debug("Task %p waiting to complete\n", task);
1888 wait_for_completion(&task->task_stop_comp);
1889 pr_debug("Task %p stopped successfully\n", task);
1891 spin_lock_irqsave(&cmd->t_state_lock, *flags);
1892 atomic_dec(&cmd->t_task_cdbs_left);
1893 task->task_flags &= ~(TF_ACTIVE | TF_REQUEST_STOP);
1900 static int transport_stop_tasks_for_cmd(struct se_cmd *cmd)
1902 struct se_task *task, *task_tmp;
1903 unsigned long flags;
1906 pr_debug("ITT[0x%08x] - Stopping tasks\n",
1907 cmd->se_tfo->get_task_tag(cmd));
1910 * No tasks remain in the execution queue
1912 spin_lock_irqsave(&cmd->t_state_lock, flags);
1913 list_for_each_entry_safe(task, task_tmp,
1914 &cmd->t_task_list, t_list) {
1915 pr_debug("Processing task %p\n", task);
1917 * If the struct se_task has not been sent and is not active,
1918 * remove the struct se_task from the execution queue.
1920 if (!(task->task_flags & (TF_ACTIVE | TF_SENT))) {
1921 spin_unlock_irqrestore(&cmd->t_state_lock,
1923 transport_remove_task_from_execute_queue(task,
1926 pr_debug("Task %p removed from execute queue\n", task);
1927 spin_lock_irqsave(&cmd->t_state_lock, flags);
1931 if (!target_stop_task(task, &flags)) {
1932 pr_debug("Task %p - did nothing\n", task);
1936 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
1942 * Handle SAM-esque emulation for generic transport request failures.
1944 void transport_generic_request_failure(struct se_cmd *cmd)
1948 pr_debug("-----[ Storage Engine Exception for cmd: %p ITT: 0x%08x"
1949 " CDB: 0x%02x\n", cmd, cmd->se_tfo->get_task_tag(cmd),
1950 cmd->t_task_cdb[0]);
1951 pr_debug("-----[ i_state: %d t_state: %d scsi_sense_reason: %d\n",
1952 cmd->se_tfo->get_cmd_state(cmd),
1953 cmd->t_state, cmd->scsi_sense_reason);
1954 pr_debug("-----[ t_tasks: %d t_task_cdbs_left: %d"
1955 " t_task_cdbs_sent: %d t_task_cdbs_ex_left: %d --"
1956 " CMD_T_ACTIVE: %d CMD_T_STOP: %d CMD_T_SENT: %d\n",
1957 cmd->t_task_list_num,
1958 atomic_read(&cmd->t_task_cdbs_left),
1959 atomic_read(&cmd->t_task_cdbs_sent),
1960 atomic_read(&cmd->t_task_cdbs_ex_left),
1961 (cmd->transport_state & CMD_T_ACTIVE) != 0,
1962 (cmd->transport_state & CMD_T_STOP) != 0,
1963 (cmd->transport_state & CMD_T_SENT) != 0);
1966 * For SAM Task Attribute emulation for failed struct se_cmd
1968 if (cmd->se_dev->dev_task_attr_type == SAM_TASK_ATTR_EMULATED)
1969 transport_complete_task_attr(cmd);
1971 switch (cmd->scsi_sense_reason) {
1972 case TCM_NON_EXISTENT_LUN:
1973 case TCM_UNSUPPORTED_SCSI_OPCODE:
1974 case TCM_INVALID_CDB_FIELD:
1975 case TCM_INVALID_PARAMETER_LIST:
1976 case TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE:
1977 case TCM_UNKNOWN_MODE_PAGE:
1978 case TCM_WRITE_PROTECTED:
1979 case TCM_CHECK_CONDITION_ABORT_CMD:
1980 case TCM_CHECK_CONDITION_UNIT_ATTENTION:
1981 case TCM_CHECK_CONDITION_NOT_READY:
1983 case TCM_RESERVATION_CONFLICT:
1985 * No SENSE Data payload for this case, set SCSI Status
1986 * and queue the response to $FABRIC_MOD.
1988 * Uses linux/include/scsi/scsi.h SAM status codes defs
1990 cmd->scsi_status = SAM_STAT_RESERVATION_CONFLICT;
1992 * For UA Interlock Code 11b, a RESERVATION CONFLICT will
1993 * establish a UNIT ATTENTION with PREVIOUS RESERVATION
1996 * See spc4r17, section 7.4.6 Control Mode Page, Table 349
1999 cmd->se_dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 2)
2000 core_scsi3_ua_allocate(cmd->se_sess->se_node_acl,
2001 cmd->orig_fe_lun, 0x2C,
2002 ASCQ_2CH_PREVIOUS_RESERVATION_CONFLICT_STATUS);
2004 ret = cmd->se_tfo->queue_status(cmd);
2005 if (ret == -EAGAIN || ret == -ENOMEM)
2009 pr_err("Unknown transport error for CDB 0x%02x: %d\n",
2010 cmd->t_task_cdb[0], cmd->scsi_sense_reason);
2011 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
2015 * If a fabric does not define a cmd->se_tfo->new_cmd_map caller,
2016 * make the call to transport_send_check_condition_and_sense()
2017 * directly. Otherwise expect the fabric to make the call to
2018 * transport_send_check_condition_and_sense() after handling
2019 * possible unsoliticied write data payloads.
2021 ret = transport_send_check_condition_and_sense(cmd,
2022 cmd->scsi_sense_reason, 0);
2023 if (ret == -EAGAIN || ret == -ENOMEM)
2027 transport_lun_remove_cmd(cmd);
2028 if (!transport_cmd_check_stop_to_fabric(cmd))
2033 cmd->t_state = TRANSPORT_COMPLETE_QF_OK;
2034 transport_handle_queue_full(cmd, cmd->se_dev);
2036 EXPORT_SYMBOL(transport_generic_request_failure);
2038 static inline u32 transport_lba_21(unsigned char *cdb)
2040 return ((cdb[1] & 0x1f) << 16) | (cdb[2] << 8) | cdb[3];
2043 static inline u32 transport_lba_32(unsigned char *cdb)
2045 return (cdb[2] << 24) | (cdb[3] << 16) | (cdb[4] << 8) | cdb[5];
2048 static inline unsigned long long transport_lba_64(unsigned char *cdb)
2050 unsigned int __v1, __v2;
2052 __v1 = (cdb[2] << 24) | (cdb[3] << 16) | (cdb[4] << 8) | cdb[5];
2053 __v2 = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
2055 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
2059 * For VARIABLE_LENGTH_CDB w/ 32 byte extended CDBs
2061 static inline unsigned long long transport_lba_64_ext(unsigned char *cdb)
2063 unsigned int __v1, __v2;
2065 __v1 = (cdb[12] << 24) | (cdb[13] << 16) | (cdb[14] << 8) | cdb[15];
2066 __v2 = (cdb[16] << 24) | (cdb[17] << 16) | (cdb[18] << 8) | cdb[19];
2068 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
2071 static void transport_set_supported_SAM_opcode(struct se_cmd *se_cmd)
2073 unsigned long flags;
2075 spin_lock_irqsave(&se_cmd->t_state_lock, flags);
2076 se_cmd->se_cmd_flags |= SCF_SUPPORTED_SAM_OPCODE;
2077 spin_unlock_irqrestore(&se_cmd->t_state_lock, flags);
2081 * Called from Fabric Module context from transport_execute_tasks()
2083 * The return of this function determins if the tasks from struct se_cmd
2084 * get added to the execution queue in transport_execute_tasks(),
2085 * or are added to the delayed or ordered lists here.
2087 static inline int transport_execute_task_attr(struct se_cmd *cmd)
2089 if (cmd->se_dev->dev_task_attr_type != SAM_TASK_ATTR_EMULATED)
2092 * Check for the existence of HEAD_OF_QUEUE, and if true return 1
2093 * to allow the passed struct se_cmd list of tasks to the front of the list.
2095 if (cmd->sam_task_attr == MSG_HEAD_TAG) {
2096 pr_debug("Added HEAD_OF_QUEUE for CDB:"
2097 " 0x%02x, se_ordered_id: %u\n",
2099 cmd->se_ordered_id);
2101 } else if (cmd->sam_task_attr == MSG_ORDERED_TAG) {
2102 atomic_inc(&cmd->se_dev->dev_ordered_sync);
2103 smp_mb__after_atomic_inc();
2105 pr_debug("Added ORDERED for CDB: 0x%02x to ordered"
2106 " list, se_ordered_id: %u\n",
2108 cmd->se_ordered_id);
2110 * Add ORDERED command to tail of execution queue if
2111 * no other older commands exist that need to be
2114 if (!atomic_read(&cmd->se_dev->simple_cmds))
2118 * For SIMPLE and UNTAGGED Task Attribute commands
2120 atomic_inc(&cmd->se_dev->simple_cmds);
2121 smp_mb__after_atomic_inc();
2124 * Otherwise if one or more outstanding ORDERED task attribute exist,
2125 * add the dormant task(s) built for the passed struct se_cmd to the
2126 * execution queue and become in Active state for this struct se_device.
2128 if (atomic_read(&cmd->se_dev->dev_ordered_sync) != 0) {
2130 * Otherwise, add cmd w/ tasks to delayed cmd queue that
2131 * will be drained upon completion of HEAD_OF_QUEUE task.
2133 spin_lock(&cmd->se_dev->delayed_cmd_lock);
2134 cmd->se_cmd_flags |= SCF_DELAYED_CMD_FROM_SAM_ATTR;
2135 list_add_tail(&cmd->se_delayed_node,
2136 &cmd->se_dev->delayed_cmd_list);
2137 spin_unlock(&cmd->se_dev->delayed_cmd_lock);
2139 pr_debug("Added CDB: 0x%02x Task Attr: 0x%02x to"
2140 " delayed CMD list, se_ordered_id: %u\n",
2141 cmd->t_task_cdb[0], cmd->sam_task_attr,
2142 cmd->se_ordered_id);
2144 * Return zero to let transport_execute_tasks() know
2145 * not to add the delayed tasks to the execution list.
2150 * Otherwise, no ORDERED task attributes exist..
2156 * Called from fabric module context in transport_generic_new_cmd() and
2157 * transport_generic_process_write()
2159 static int transport_execute_tasks(struct se_cmd *cmd)
2162 struct se_device *se_dev = cmd->se_dev;
2164 * Call transport_cmd_check_stop() to see if a fabric exception
2165 * has occurred that prevents execution.
2167 if (!transport_cmd_check_stop(cmd, 0, TRANSPORT_PROCESSING)) {
2169 * Check for SAM Task Attribute emulation and HEAD_OF_QUEUE
2170 * attribute for the tasks of the received struct se_cmd CDB
2172 add_tasks = transport_execute_task_attr(cmd);
2176 * __transport_execute_tasks() -> __transport_add_tasks_from_cmd()
2177 * adds associated se_tasks while holding dev->execute_task_lock
2178 * before I/O dispath to avoid a double spinlock access.
2180 __transport_execute_tasks(se_dev, cmd);
2185 __transport_execute_tasks(se_dev, NULL);
2190 * Called to check struct se_device tcq depth window, and once open pull struct se_task
2191 * from struct se_device->execute_task_list and
2193 * Called from transport_processing_thread()
2195 static int __transport_execute_tasks(struct se_device *dev, struct se_cmd *new_cmd)
2198 struct se_cmd *cmd = NULL;
2199 struct se_task *task = NULL;
2200 unsigned long flags;
2203 spin_lock_irq(&dev->execute_task_lock);
2204 if (new_cmd != NULL)
2205 __transport_add_tasks_from_cmd(new_cmd);
2207 if (list_empty(&dev->execute_task_list)) {
2208 spin_unlock_irq(&dev->execute_task_lock);
2211 task = list_first_entry(&dev->execute_task_list,
2212 struct se_task, t_execute_list);
2213 __transport_remove_task_from_execute_queue(task, dev);
2214 spin_unlock_irq(&dev->execute_task_lock);
2216 cmd = task->task_se_cmd;
2217 spin_lock_irqsave(&cmd->t_state_lock, flags);
2218 task->task_flags |= (TF_ACTIVE | TF_SENT);
2219 atomic_inc(&cmd->t_task_cdbs_sent);
2221 if (atomic_read(&cmd->t_task_cdbs_sent) ==
2222 cmd->t_task_list_num)
2223 cmd->transport_state |= CMD_T_SENT;
2225 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2227 if (cmd->execute_task)
2228 error = cmd->execute_task(task);
2230 error = dev->transport->do_task(task);
2232 spin_lock_irqsave(&cmd->t_state_lock, flags);
2233 task->task_flags &= ~TF_ACTIVE;
2234 cmd->transport_state &= ~CMD_T_SENT;
2235 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2237 transport_stop_tasks_for_cmd(cmd);
2238 transport_generic_request_failure(cmd);
2247 static inline u32 transport_get_sectors_6(
2252 struct se_device *dev = cmd->se_dev;
2255 * Assume TYPE_DISK for non struct se_device objects.
2256 * Use 8-bit sector value.
2262 * Use 24-bit allocation length for TYPE_TAPE.
2264 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
2265 return (u32)(cdb[2] << 16) + (cdb[3] << 8) + cdb[4];
2268 * Everything else assume TYPE_DISK Sector CDB location.
2269 * Use 8-bit sector value. SBC-3 says:
2271 * A TRANSFER LENGTH field set to zero specifies that 256
2272 * logical blocks shall be written. Any other value
2273 * specifies the number of logical blocks that shall be
2277 return cdb[4] ? : 256;
2280 static inline u32 transport_get_sectors_10(
2285 struct se_device *dev = cmd->se_dev;
2288 * Assume TYPE_DISK for non struct se_device objects.
2289 * Use 16-bit sector value.
2295 * XXX_10 is not defined in SSC, throw an exception
2297 if (dev->transport->get_device_type(dev) == TYPE_TAPE) {
2303 * Everything else assume TYPE_DISK Sector CDB location.
2304 * Use 16-bit sector value.
2307 return (u32)(cdb[7] << 8) + cdb[8];
2310 static inline u32 transport_get_sectors_12(
2315 struct se_device *dev = cmd->se_dev;
2318 * Assume TYPE_DISK for non struct se_device objects.
2319 * Use 32-bit sector value.
2325 * XXX_12 is not defined in SSC, throw an exception
2327 if (dev->transport->get_device_type(dev) == TYPE_TAPE) {
2333 * Everything else assume TYPE_DISK Sector CDB location.
2334 * Use 32-bit sector value.
2337 return (u32)(cdb[6] << 24) + (cdb[7] << 16) + (cdb[8] << 8) + cdb[9];
2340 static inline u32 transport_get_sectors_16(
2345 struct se_device *dev = cmd->se_dev;
2348 * Assume TYPE_DISK for non struct se_device objects.
2349 * Use 32-bit sector value.
2355 * Use 24-bit allocation length for TYPE_TAPE.
2357 if (dev->transport->get_device_type(dev) == TYPE_TAPE)
2358 return (u32)(cdb[12] << 16) + (cdb[13] << 8) + cdb[14];
2361 return (u32)(cdb[10] << 24) + (cdb[11] << 16) +
2362 (cdb[12] << 8) + cdb[13];
2366 * Used for VARIABLE_LENGTH_CDB WRITE_32 and READ_32 variants
2368 static inline u32 transport_get_sectors_32(
2374 * Assume TYPE_DISK for non struct se_device objects.
2375 * Use 32-bit sector value.
2377 return (u32)(cdb[28] << 24) + (cdb[29] << 16) +
2378 (cdb[30] << 8) + cdb[31];
2382 static inline u32 transport_get_size(
2387 struct se_device *dev = cmd->se_dev;
2389 if (dev->transport->get_device_type(dev) == TYPE_TAPE) {
2390 if (cdb[1] & 1) { /* sectors */
2391 return dev->se_sub_dev->se_dev_attrib.block_size * sectors;
2396 pr_debug("Returning block_size: %u, sectors: %u == %u for"
2397 " %s object\n", dev->se_sub_dev->se_dev_attrib.block_size, sectors,
2398 dev->se_sub_dev->se_dev_attrib.block_size * sectors,
2399 dev->transport->name);
2401 return dev->se_sub_dev->se_dev_attrib.block_size * sectors;
2404 static void transport_xor_callback(struct se_cmd *cmd)
2406 unsigned char *buf, *addr;
2407 struct scatterlist *sg;
2408 unsigned int offset;
2412 * From sbc3r22.pdf section 5.48 XDWRITEREAD (10) command
2414 * 1) read the specified logical block(s);
2415 * 2) transfer logical blocks from the data-out buffer;
2416 * 3) XOR the logical blocks transferred from the data-out buffer with
2417 * the logical blocks read, storing the resulting XOR data in a buffer;
2418 * 4) if the DISABLE WRITE bit is set to zero, then write the logical
2419 * blocks transferred from the data-out buffer; and
2420 * 5) transfer the resulting XOR data to the data-in buffer.
2422 buf = kmalloc(cmd->data_length, GFP_KERNEL);
2424 pr_err("Unable to allocate xor_callback buf\n");
2428 * Copy the scatterlist WRITE buffer located at cmd->t_data_sg
2429 * into the locally allocated *buf
2431 sg_copy_to_buffer(cmd->t_data_sg,
2437 * Now perform the XOR against the BIDI read memory located at
2438 * cmd->t_mem_bidi_list
2442 for_each_sg(cmd->t_bidi_data_sg, sg, cmd->t_bidi_data_nents, count) {
2443 addr = kmap_atomic(sg_page(sg));
2447 for (i = 0; i < sg->length; i++)
2448 *(addr + sg->offset + i) ^= *(buf + offset + i);
2450 offset += sg->length;
2451 kunmap_atomic(addr);
2459 * Used to obtain Sense Data from underlying Linux/SCSI struct scsi_cmnd
2461 static int transport_get_sense_data(struct se_cmd *cmd)
2463 unsigned char *buffer = cmd->sense_buffer, *sense_buffer = NULL;
2464 struct se_device *dev = cmd->se_dev;
2465 struct se_task *task = NULL, *task_tmp;
2466 unsigned long flags;
2469 WARN_ON(!cmd->se_lun);
2474 spin_lock_irqsave(&cmd->t_state_lock, flags);
2475 if (cmd->se_cmd_flags & SCF_SENT_CHECK_CONDITION) {
2476 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2480 list_for_each_entry_safe(task, task_tmp,
2481 &cmd->t_task_list, t_list) {
2482 if (!(task->task_flags & TF_HAS_SENSE))
2485 if (!dev->transport->get_sense_buffer) {
2486 pr_err("dev->transport->get_sense_buffer"
2491 sense_buffer = dev->transport->get_sense_buffer(task);
2492 if (!sense_buffer) {
2493 pr_err("ITT[0x%08x]_TASK[%p]: Unable to locate"
2494 " sense buffer for task with sense\n",
2495 cmd->se_tfo->get_task_tag(cmd), task);
2498 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2500 offset = cmd->se_tfo->set_fabric_sense_len(cmd,
2501 TRANSPORT_SENSE_BUFFER);
2503 memcpy(&buffer[offset], sense_buffer,
2504 TRANSPORT_SENSE_BUFFER);
2505 cmd->scsi_status = task->task_scsi_status;
2506 /* Automatically padded */
2507 cmd->scsi_sense_length =
2508 (TRANSPORT_SENSE_BUFFER + offset);
2510 pr_debug("HBA_[%u]_PLUG[%s]: Set SAM STATUS: 0x%02x"
2512 dev->se_hba->hba_id, dev->transport->name,
2516 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2521 static inline long long transport_dev_end_lba(struct se_device *dev)
2523 return dev->transport->get_blocks(dev) + 1;
2526 static int transport_cmd_get_valid_sectors(struct se_cmd *cmd)
2528 struct se_device *dev = cmd->se_dev;
2531 if (dev->transport->get_device_type(dev) != TYPE_DISK)
2534 sectors = (cmd->data_length / dev->se_sub_dev->se_dev_attrib.block_size);
2536 if ((cmd->t_task_lba + sectors) > transport_dev_end_lba(dev)) {
2537 pr_err("LBA: %llu Sectors: %u exceeds"
2538 " transport_dev_end_lba(): %llu\n",
2539 cmd->t_task_lba, sectors,
2540 transport_dev_end_lba(dev));
2547 static int target_check_write_same_discard(unsigned char *flags, struct se_device *dev)
2550 * Determine if the received WRITE_SAME is used to for direct
2551 * passthrough into Linux/SCSI with struct request via TCM/pSCSI
2552 * or we are signaling the use of internal WRITE_SAME + UNMAP=1
2553 * emulation for -> Linux/BLOCK disbard with TCM/IBLOCK code.
2555 int passthrough = (dev->transport->transport_type ==
2556 TRANSPORT_PLUGIN_PHBA_PDEV);
2559 if ((flags[0] & 0x04) || (flags[0] & 0x02)) {
2560 pr_err("WRITE_SAME PBDATA and LBDATA"
2561 " bits not supported for Block Discard"
2566 * Currently for the emulated case we only accept
2567 * tpws with the UNMAP=1 bit set.
2569 if (!(flags[0] & 0x08)) {
2570 pr_err("WRITE_SAME w/o UNMAP bit not"
2571 " supported for Block Discard Emulation\n");
2579 /* transport_generic_cmd_sequencer():
2581 * Generic Command Sequencer that should work for most DAS transport
2584 * Called from transport_generic_allocate_tasks() in the $FABRIC_MOD
2587 * FIXME: Need to support other SCSI OPCODES where as well.
2589 static int transport_generic_cmd_sequencer(
2593 struct se_device *dev = cmd->se_dev;
2594 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
2595 int ret = 0, sector_ret = 0, passthrough;
2596 u32 sectors = 0, size = 0, pr_reg_type = 0;
2600 * Check for an existing UNIT ATTENTION condition
2602 if (core_scsi3_ua_check(cmd, cdb) < 0) {
2603 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
2604 cmd->scsi_sense_reason = TCM_CHECK_CONDITION_UNIT_ATTENTION;
2608 * Check status of Asymmetric Logical Unit Assignment port
2610 ret = su_dev->t10_alua.alua_state_check(cmd, cdb, &alua_ascq);
2613 * Set SCSI additional sense code (ASC) to 'LUN Not Accessible';
2614 * The ALUA additional sense code qualifier (ASCQ) is determined
2615 * by the ALUA primary or secondary access state..
2619 pr_debug("[%s]: ALUA TG Port not available,"
2620 " SenseKey: NOT_READY, ASC/ASCQ: 0x04/0x%02x\n",
2621 cmd->se_tfo->get_fabric_name(), alua_ascq);
2623 transport_set_sense_codes(cmd, 0x04, alua_ascq);
2624 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
2625 cmd->scsi_sense_reason = TCM_CHECK_CONDITION_NOT_READY;
2628 goto out_invalid_cdb_field;
2631 * Check status for SPC-3 Persistent Reservations
2633 if (su_dev->t10_pr.pr_ops.t10_reservation_check(cmd, &pr_reg_type) != 0) {
2634 if (su_dev->t10_pr.pr_ops.t10_seq_non_holder(
2635 cmd, cdb, pr_reg_type) != 0) {
2636 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
2637 cmd->se_cmd_flags |= SCF_SCSI_RESERVATION_CONFLICT;
2638 cmd->scsi_status = SAM_STAT_RESERVATION_CONFLICT;
2639 cmd->scsi_sense_reason = TCM_RESERVATION_CONFLICT;
2643 * This means the CDB is allowed for the SCSI Initiator port
2644 * when said port is *NOT* holding the legacy SPC-2 or
2645 * SPC-3 Persistent Reservation.
2650 * If we operate in passthrough mode we skip most CDB emulation and
2651 * instead hand the commands down to the physical SCSI device.
2654 (dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV);
2658 sectors = transport_get_sectors_6(cdb, cmd, §or_ret);
2660 goto out_unsupported_cdb;
2661 size = transport_get_size(sectors, cdb, cmd);
2662 cmd->t_task_lba = transport_lba_21(cdb);
2663 cmd->se_cmd_flags |= SCF_SCSI_DATA_SG_IO_CDB;
2666 sectors = transport_get_sectors_10(cdb, cmd, §or_ret);
2668 goto out_unsupported_cdb;
2669 size = transport_get_size(sectors, cdb, cmd);
2670 cmd->t_task_lba = transport_lba_32(cdb);
2671 cmd->se_cmd_flags |= SCF_SCSI_DATA_SG_IO_CDB;
2674 sectors = transport_get_sectors_12(cdb, cmd, §or_ret);
2676 goto out_unsupported_cdb;
2677 size = transport_get_size(sectors, cdb, cmd);
2678 cmd->t_task_lba = transport_lba_32(cdb);
2679 cmd->se_cmd_flags |= SCF_SCSI_DATA_SG_IO_CDB;
2682 sectors = transport_get_sectors_16(cdb, cmd, §or_ret);
2684 goto out_unsupported_cdb;
2685 size = transport_get_size(sectors, cdb, cmd);
2686 cmd->t_task_lba = transport_lba_64(cdb);
2687 cmd->se_cmd_flags |= SCF_SCSI_DATA_SG_IO_CDB;
2690 sectors = transport_get_sectors_6(cdb, cmd, §or_ret);
2692 goto out_unsupported_cdb;
2693 size = transport_get_size(sectors, cdb, cmd);
2694 cmd->t_task_lba = transport_lba_21(cdb);
2695 cmd->se_cmd_flags |= SCF_SCSI_DATA_SG_IO_CDB;
2698 sectors = transport_get_sectors_10(cdb, cmd, §or_ret);
2700 goto out_unsupported_cdb;
2701 size = transport_get_size(sectors, cdb, cmd);
2702 cmd->t_task_lba = transport_lba_32(cdb);
2704 cmd->se_cmd_flags |= SCF_FUA;
2705 cmd->se_cmd_flags |= SCF_SCSI_DATA_SG_IO_CDB;
2708 sectors = transport_get_sectors_12(cdb, cmd, §or_ret);
2710 goto out_unsupported_cdb;
2711 size = transport_get_size(sectors, cdb, cmd);
2712 cmd->t_task_lba = transport_lba_32(cdb);
2714 cmd->se_cmd_flags |= SCF_FUA;
2715 cmd->se_cmd_flags |= SCF_SCSI_DATA_SG_IO_CDB;
2718 sectors = transport_get_sectors_16(cdb, cmd, §or_ret);
2720 goto out_unsupported_cdb;
2721 size = transport_get_size(sectors, cdb, cmd);
2722 cmd->t_task_lba = transport_lba_64(cdb);
2724 cmd->se_cmd_flags |= SCF_FUA;
2725 cmd->se_cmd_flags |= SCF_SCSI_DATA_SG_IO_CDB;
2727 case XDWRITEREAD_10:
2728 if ((cmd->data_direction != DMA_TO_DEVICE) ||
2729 !(cmd->se_cmd_flags & SCF_BIDI))
2730 goto out_invalid_cdb_field;
2731 sectors = transport_get_sectors_10(cdb, cmd, §or_ret);
2733 goto out_unsupported_cdb;
2734 size = transport_get_size(sectors, cdb, cmd);
2735 cmd->t_task_lba = transport_lba_32(cdb);
2736 cmd->se_cmd_flags |= SCF_SCSI_DATA_SG_IO_CDB;
2739 * Do now allow BIDI commands for passthrough mode.
2742 goto out_unsupported_cdb;
2745 * Setup BIDI XOR callback to be run after I/O completion.
2747 cmd->transport_complete_callback = &transport_xor_callback;
2749 cmd->se_cmd_flags |= SCF_FUA;
2751 case VARIABLE_LENGTH_CMD:
2752 service_action = get_unaligned_be16(&cdb[8]);
2753 switch (service_action) {
2754 case XDWRITEREAD_32:
2755 sectors = transport_get_sectors_32(cdb, cmd, §or_ret);
2757 goto out_unsupported_cdb;
2758 size = transport_get_size(sectors, cdb, cmd);
2760 * Use WRITE_32 and READ_32 opcodes for the emulated
2761 * XDWRITE_READ_32 logic.
2763 cmd->t_task_lba = transport_lba_64_ext(cdb);
2764 cmd->se_cmd_flags |= SCF_SCSI_DATA_SG_IO_CDB;
2767 * Do now allow BIDI commands for passthrough mode.
2770 goto out_unsupported_cdb;
2773 * Setup BIDI XOR callback to be run during after I/O
2776 cmd->transport_complete_callback = &transport_xor_callback;
2778 cmd->se_cmd_flags |= SCF_FUA;
2781 sectors = transport_get_sectors_32(cdb, cmd, §or_ret);
2783 goto out_unsupported_cdb;
2786 size = transport_get_size(1, cdb, cmd);
2788 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not"
2790 goto out_invalid_cdb_field;
2793 cmd->t_task_lba = get_unaligned_be64(&cdb[12]);
2794 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2796 if (target_check_write_same_discard(&cdb[10], dev) < 0)
2797 goto out_unsupported_cdb;
2799 cmd->execute_task = target_emulate_write_same;
2802 pr_err("VARIABLE_LENGTH_CMD service action"
2803 " 0x%04x not supported\n", service_action);
2804 goto out_unsupported_cdb;
2807 case MAINTENANCE_IN:
2808 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
2809 /* MAINTENANCE_IN from SCC-2 */
2811 * Check for emulated MI_REPORT_TARGET_PGS.
2813 if (cdb[1] == MI_REPORT_TARGET_PGS &&
2814 su_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED) {
2816 target_emulate_report_target_port_groups;
2818 size = (cdb[6] << 24) | (cdb[7] << 16) |
2819 (cdb[8] << 8) | cdb[9];
2821 /* GPCMD_SEND_KEY from multi media commands */
2822 size = (cdb[8] << 8) + cdb[9];
2824 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2828 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2830 case MODE_SELECT_10:
2831 size = (cdb[7] << 8) + cdb[8];
2832 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2836 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2838 cmd->execute_task = target_emulate_modesense;
2841 size = (cdb[7] << 8) + cdb[8];
2842 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2844 cmd->execute_task = target_emulate_modesense;
2846 case GPCMD_READ_BUFFER_CAPACITY:
2847 case GPCMD_SEND_OPC:
2850 size = (cdb[7] << 8) + cdb[8];
2851 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2853 case READ_BLOCK_LIMITS:
2854 size = READ_BLOCK_LEN;
2855 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2857 case GPCMD_GET_CONFIGURATION:
2858 case GPCMD_READ_FORMAT_CAPACITIES:
2859 case GPCMD_READ_DISC_INFO:
2860 case GPCMD_READ_TRACK_RZONE_INFO:
2861 size = (cdb[7] << 8) + cdb[8];
2862 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2864 case PERSISTENT_RESERVE_IN:
2865 if (su_dev->t10_pr.res_type == SPC3_PERSISTENT_RESERVATIONS)
2866 cmd->execute_task = target_scsi3_emulate_pr_in;
2867 size = (cdb[7] << 8) + cdb[8];
2868 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2870 case PERSISTENT_RESERVE_OUT:
2871 if (su_dev->t10_pr.res_type == SPC3_PERSISTENT_RESERVATIONS)
2872 cmd->execute_task = target_scsi3_emulate_pr_out;
2873 size = (cdb[7] << 8) + cdb[8];
2874 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2876 case GPCMD_MECHANISM_STATUS:
2877 case GPCMD_READ_DVD_STRUCTURE:
2878 size = (cdb[8] << 8) + cdb[9];
2879 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2882 size = READ_POSITION_LEN;
2883 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2885 case MAINTENANCE_OUT:
2886 if (dev->transport->get_device_type(dev) != TYPE_ROM) {
2887 /* MAINTENANCE_OUT from SCC-2
2889 * Check for emulated MO_SET_TARGET_PGS.
2891 if (cdb[1] == MO_SET_TARGET_PGS &&
2892 su_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED) {
2894 target_emulate_set_target_port_groups;
2897 size = (cdb[6] << 24) | (cdb[7] << 16) |
2898 (cdb[8] << 8) | cdb[9];
2900 /* GPCMD_REPORT_KEY from multi media commands */
2901 size = (cdb[8] << 8) + cdb[9];
2903 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2906 size = (cdb[3] << 8) + cdb[4];
2908 * Do implict HEAD_OF_QUEUE processing for INQUIRY.
2909 * See spc4r17 section 5.3
2911 if (cmd->se_dev->dev_task_attr_type == SAM_TASK_ATTR_EMULATED)
2912 cmd->sam_task_attr = MSG_HEAD_TAG;
2913 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2915 cmd->execute_task = target_emulate_inquiry;
2918 size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
2919 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2922 size = READ_CAP_LEN;
2923 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2925 cmd->execute_task = target_emulate_readcapacity;
2927 case READ_MEDIA_SERIAL_NUMBER:
2928 case SECURITY_PROTOCOL_IN:
2929 case SECURITY_PROTOCOL_OUT:
2930 size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
2931 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2933 case SERVICE_ACTION_IN:
2934 switch (cmd->t_task_cdb[1] & 0x1f) {
2935 case SAI_READ_CAPACITY_16:
2938 target_emulate_readcapacity_16;
2944 pr_err("Unsupported SA: 0x%02x\n",
2945 cmd->t_task_cdb[1] & 0x1f);
2946 goto out_invalid_cdb_field;
2949 case ACCESS_CONTROL_IN:
2950 case ACCESS_CONTROL_OUT:
2952 case READ_ATTRIBUTE:
2953 case RECEIVE_COPY_RESULTS:
2954 case WRITE_ATTRIBUTE:
2955 size = (cdb[10] << 24) | (cdb[11] << 16) |
2956 (cdb[12] << 8) | cdb[13];
2957 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2959 case RECEIVE_DIAGNOSTIC:
2960 case SEND_DIAGNOSTIC:
2961 size = (cdb[3] << 8) | cdb[4];
2962 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2964 /* #warning FIXME: Figure out correct GPCMD_READ_CD blocksize. */
2967 sectors = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
2968 size = (2336 * sectors);
2969 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2974 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2978 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2980 cmd->execute_task = target_emulate_request_sense;
2982 case READ_ELEMENT_STATUS:
2983 size = 65536 * cdb[7] + 256 * cdb[8] + cdb[9];
2984 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2987 size = (cdb[6] << 16) + (cdb[7] << 8) + cdb[8];
2988 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
2993 * The SPC-2 RESERVE does not contain a size in the SCSI CDB.
2994 * Assume the passthrough or $FABRIC_MOD will tell us about it.
2996 if (cdb[0] == RESERVE_10)
2997 size = (cdb[7] << 8) | cdb[8];
2999 size = cmd->data_length;
3002 * Setup the legacy emulated handler for SPC-2 and
3003 * >= SPC-3 compatible reservation handling (CRH=1)
3004 * Otherwise, we assume the underlying SCSI logic is
3005 * is running in SPC_PASSTHROUGH, and wants reservations
3006 * emulation disabled.
3008 if (su_dev->t10_pr.res_type != SPC_PASSTHROUGH)
3009 cmd->execute_task = target_scsi2_reservation_reserve;
3010 cmd->se_cmd_flags |= SCF_SCSI_NON_DATA_CDB;
3015 * The SPC-2 RELEASE does not contain a size in the SCSI CDB.
3016 * Assume the passthrough or $FABRIC_MOD will tell us about it.
3018 if (cdb[0] == RELEASE_10)
3019 size = (cdb[7] << 8) | cdb[8];
3021 size = cmd->data_length;
3023 if (su_dev->t10_pr.res_type != SPC_PASSTHROUGH)
3024 cmd->execute_task = target_scsi2_reservation_release;
3025 cmd->se_cmd_flags |= SCF_SCSI_NON_DATA_CDB;
3027 case SYNCHRONIZE_CACHE:
3028 case SYNCHRONIZE_CACHE_16:
3030 * Extract LBA and range to be flushed for emulated SYNCHRONIZE_CACHE
3032 if (cdb[0] == SYNCHRONIZE_CACHE) {
3033 sectors = transport_get_sectors_10(cdb, cmd, §or_ret);
3034 cmd->t_task_lba = transport_lba_32(cdb);
3036 sectors = transport_get_sectors_16(cdb, cmd, §or_ret);
3037 cmd->t_task_lba = transport_lba_64(cdb);
3040 goto out_unsupported_cdb;
3042 size = transport_get_size(sectors, cdb, cmd);
3043 cmd->se_cmd_flags |= SCF_SCSI_NON_DATA_CDB;
3049 * Check to ensure that LBA + Range does not exceed past end of
3050 * device for IBLOCK and FILEIO ->do_sync_cache() backend calls
3052 if ((cmd->t_task_lba != 0) || (sectors != 0)) {
3053 if (transport_cmd_get_valid_sectors(cmd) < 0)
3054 goto out_invalid_cdb_field;
3056 cmd->execute_task = target_emulate_synchronize_cache;
3059 size = get_unaligned_be16(&cdb[7]);
3060 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
3062 cmd->execute_task = target_emulate_unmap;
3065 sectors = transport_get_sectors_16(cdb, cmd, §or_ret);
3067 goto out_unsupported_cdb;
3070 size = transport_get_size(1, cdb, cmd);
3072 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
3073 goto out_invalid_cdb_field;
3076 cmd->t_task_lba = get_unaligned_be64(&cdb[2]);
3077 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
3079 if (target_check_write_same_discard(&cdb[1], dev) < 0)
3080 goto out_unsupported_cdb;
3082 cmd->execute_task = target_emulate_write_same;
3085 sectors = transport_get_sectors_10(cdb, cmd, §or_ret);
3087 goto out_unsupported_cdb;
3090 size = transport_get_size(1, cdb, cmd);
3092 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
3093 goto out_invalid_cdb_field;
3096 cmd->t_task_lba = get_unaligned_be32(&cdb[2]);
3097 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
3099 * Follow sbcr26 with WRITE_SAME (10) and check for the existence
3100 * of byte 1 bit 3 UNMAP instead of original reserved field
3102 if (target_check_write_same_discard(&cdb[1], dev) < 0)
3103 goto out_unsupported_cdb;
3105 cmd->execute_task = target_emulate_write_same;
3107 case ALLOW_MEDIUM_REMOVAL:
3113 case TEST_UNIT_READY:
3115 case WRITE_FILEMARKS:
3116 cmd->se_cmd_flags |= SCF_SCSI_NON_DATA_CDB;
3118 cmd->execute_task = target_emulate_noop;
3120 case GPCMD_CLOSE_TRACK:
3121 case INITIALIZE_ELEMENT_STATUS:
3122 case GPCMD_LOAD_UNLOAD:
3123 case GPCMD_SET_SPEED:
3125 cmd->se_cmd_flags |= SCF_SCSI_NON_DATA_CDB;
3128 cmd->execute_task = target_report_luns;
3129 size = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
3131 * Do implict HEAD_OF_QUEUE processing for REPORT_LUNS
3132 * See spc4r17 section 5.3
3134 if (cmd->se_dev->dev_task_attr_type == SAM_TASK_ATTR_EMULATED)
3135 cmd->sam_task_attr = MSG_HEAD_TAG;
3136 cmd->se_cmd_flags |= SCF_SCSI_CONTROL_SG_IO_CDB;
3139 pr_warn("TARGET_CORE[%s]: Unsupported SCSI Opcode"
3140 " 0x%02x, sending CHECK_CONDITION.\n",
3141 cmd->se_tfo->get_fabric_name(), cdb[0]);
3142 goto out_unsupported_cdb;
3145 if (size != cmd->data_length) {
3146 pr_warn("TARGET_CORE[%s]: Expected Transfer Length:"
3147 " %u does not match SCSI CDB Length: %u for SAM Opcode:"
3148 " 0x%02x\n", cmd->se_tfo->get_fabric_name(),
3149 cmd->data_length, size, cdb[0]);
3151 cmd->cmd_spdtl = size;
3153 if (cmd->data_direction == DMA_TO_DEVICE) {
3154 pr_err("Rejecting underflow/overflow"
3156 goto out_invalid_cdb_field;
3159 * Reject READ_* or WRITE_* with overflow/underflow for
3160 * type SCF_SCSI_DATA_SG_IO_CDB.
3162 if (!ret && (dev->se_sub_dev->se_dev_attrib.block_size != 512)) {
3163 pr_err("Failing OVERFLOW/UNDERFLOW for LBA op"
3164 " CDB on non 512-byte sector setup subsystem"
3165 " plugin: %s\n", dev->transport->name);
3166 /* Returns CHECK_CONDITION + INVALID_CDB_FIELD */
3167 goto out_invalid_cdb_field;
3170 if (size > cmd->data_length) {
3171 cmd->se_cmd_flags |= SCF_OVERFLOW_BIT;
3172 cmd->residual_count = (size - cmd->data_length);
3174 cmd->se_cmd_flags |= SCF_UNDERFLOW_BIT;
3175 cmd->residual_count = (cmd->data_length - size);
3177 cmd->data_length = size;
3180 if (cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB &&
3181 sectors > dev->se_sub_dev->se_dev_attrib.fabric_max_sectors) {
3182 printk_ratelimited(KERN_ERR "SCSI OP %02xh with too big sectors %u\n",
3184 goto out_invalid_cdb_field;
3187 /* reject any command that we don't have a handler for */
3188 if (!(passthrough || cmd->execute_task ||
3189 (cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB)))
3190 goto out_unsupported_cdb;
3192 transport_set_supported_SAM_opcode(cmd);
3195 out_unsupported_cdb:
3196 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
3197 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
3199 out_invalid_cdb_field:
3200 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
3201 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
3206 * Called from I/O completion to determine which dormant/delayed
3207 * and ordered cmds need to have their tasks added to the execution queue.
3209 static void transport_complete_task_attr(struct se_cmd *cmd)
3211 struct se_device *dev = cmd->se_dev;
3212 struct se_cmd *cmd_p, *cmd_tmp;
3213 int new_active_tasks = 0;
3215 if (cmd->sam_task_attr == MSG_SIMPLE_TAG) {
3216 atomic_dec(&dev->simple_cmds);
3217 smp_mb__after_atomic_dec();
3218 dev->dev_cur_ordered_id++;
3219 pr_debug("Incremented dev->dev_cur_ordered_id: %u for"
3220 " SIMPLE: %u\n", dev->dev_cur_ordered_id,
3221 cmd->se_ordered_id);
3222 } else if (cmd->sam_task_attr == MSG_HEAD_TAG) {
3223 dev->dev_cur_ordered_id++;
3224 pr_debug("Incremented dev_cur_ordered_id: %u for"
3225 " HEAD_OF_QUEUE: %u\n", dev->dev_cur_ordered_id,
3226 cmd->se_ordered_id);
3227 } else if (cmd->sam_task_attr == MSG_ORDERED_TAG) {
3228 atomic_dec(&dev->dev_ordered_sync);
3229 smp_mb__after_atomic_dec();
3231 dev->dev_cur_ordered_id++;
3232 pr_debug("Incremented dev_cur_ordered_id: %u for ORDERED:"
3233 " %u\n", dev->dev_cur_ordered_id, cmd->se_ordered_id);
3236 * Process all commands up to the last received
3237 * ORDERED task attribute which requires another blocking
3240 spin_lock(&dev->delayed_cmd_lock);
3241 list_for_each_entry_safe(cmd_p, cmd_tmp,
3242 &dev->delayed_cmd_list, se_delayed_node) {
3244 list_del(&cmd_p->se_delayed_node);
3245 spin_unlock(&dev->delayed_cmd_lock);
3247 pr_debug("Calling add_tasks() for"
3248 " cmd_p: 0x%02x Task Attr: 0x%02x"
3249 " Dormant -> Active, se_ordered_id: %u\n",
3250 cmd_p->t_task_cdb[0],
3251 cmd_p->sam_task_attr, cmd_p->se_ordered_id);
3253 transport_add_tasks_from_cmd(cmd_p);
3256 spin_lock(&dev->delayed_cmd_lock);
3257 if (cmd_p->sam_task_attr == MSG_ORDERED_TAG)
3260 spin_unlock(&dev->delayed_cmd_lock);
3262 * If new tasks have become active, wake up the transport thread
3263 * to do the processing of the Active tasks.
3265 if (new_active_tasks != 0)
3266 wake_up_interruptible(&dev->dev_queue_obj.thread_wq);
3269 static void transport_complete_qf(struct se_cmd *cmd)
3273 if (cmd->se_dev->dev_task_attr_type == SAM_TASK_ATTR_EMULATED)
3274 transport_complete_task_attr(cmd);
3276 if (cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) {
3277 ret = cmd->se_tfo->queue_status(cmd);
3282 switch (cmd->data_direction) {
3283 case DMA_FROM_DEVICE:
3284 ret = cmd->se_tfo->queue_data_in(cmd);
3287 if (cmd->t_bidi_data_sg) {
3288 ret = cmd->se_tfo->queue_data_in(cmd);
3292 /* Fall through for DMA_TO_DEVICE */
3294 ret = cmd->se_tfo->queue_status(cmd);
3302 transport_handle_queue_full(cmd, cmd->se_dev);
3305 transport_lun_remove_cmd(cmd);
3306 transport_cmd_check_stop_to_fabric(cmd);
3309 static void transport_handle_queue_full(
3311 struct se_device *dev)
3313 spin_lock_irq(&dev->qf_cmd_lock);
3314 list_add_tail(&cmd->se_qf_node, &cmd->se_dev->qf_cmd_list);
3315 atomic_inc(&dev->dev_qf_count);
3316 smp_mb__after_atomic_inc();
3317 spin_unlock_irq(&cmd->se_dev->qf_cmd_lock);
3319 schedule_work(&cmd->se_dev->qf_work_queue);
3322 static void target_complete_ok_work(struct work_struct *work)
3324 struct se_cmd *cmd = container_of(work, struct se_cmd, work);
3325 int reason = 0, ret;
3328 * Check if we need to move delayed/dormant tasks from cmds on the
3329 * delayed execution list after a HEAD_OF_QUEUE or ORDERED Task
3332 if (cmd->se_dev->dev_task_attr_type == SAM_TASK_ATTR_EMULATED)
3333 transport_complete_task_attr(cmd);
3335 * Check to schedule QUEUE_FULL work, or execute an existing
3336 * cmd->transport_qf_callback()
3338 if (atomic_read(&cmd->se_dev->dev_qf_count) != 0)
3339 schedule_work(&cmd->se_dev->qf_work_queue);
3342 * Check if we need to retrieve a sense buffer from
3343 * the struct se_cmd in question.
3345 if (cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) {
3346 if (transport_get_sense_data(cmd) < 0)
3347 reason = TCM_NON_EXISTENT_LUN;
3350 * Only set when an struct se_task->task_scsi_status returned
3351 * a non GOOD status.
3353 if (cmd->scsi_status) {
3354 ret = transport_send_check_condition_and_sense(
3356 if (ret == -EAGAIN || ret == -ENOMEM)
3359 transport_lun_remove_cmd(cmd);
3360 transport_cmd_check_stop_to_fabric(cmd);
3365 * Check for a callback, used by amongst other things
3366 * XDWRITE_READ_10 emulation.
3368 if (cmd->transport_complete_callback)
3369 cmd->transport_complete_callback(cmd);
3371 switch (cmd->data_direction) {
3372 case DMA_FROM_DEVICE:
3373 spin_lock(&cmd->se_lun->lun_sep_lock);
3374 if (cmd->se_lun->lun_sep) {
3375 cmd->se_lun->lun_sep->sep_stats.tx_data_octets +=
3378 spin_unlock(&cmd->se_lun->lun_sep_lock);
3380 ret = cmd->se_tfo->queue_data_in(cmd);
3381 if (ret == -EAGAIN || ret == -ENOMEM)
3385 spin_lock(&cmd->se_lun->lun_sep_lock);
3386 if (cmd->se_lun->lun_sep) {
3387 cmd->se_lun->lun_sep->sep_stats.rx_data_octets +=
3390 spin_unlock(&cmd->se_lun->lun_sep_lock);
3392 * Check if we need to send READ payload for BIDI-COMMAND
3394 if (cmd->t_bidi_data_sg) {
3395 spin_lock(&cmd->se_lun->lun_sep_lock);
3396 if (cmd->se_lun->lun_sep) {
3397 cmd->se_lun->lun_sep->sep_stats.tx_data_octets +=
3400 spin_unlock(&cmd->se_lun->lun_sep_lock);
3401 ret = cmd->se_tfo->queue_data_in(cmd);
3402 if (ret == -EAGAIN || ret == -ENOMEM)
3406 /* Fall through for DMA_TO_DEVICE */
3408 ret = cmd->se_tfo->queue_status(cmd);
3409 if (ret == -EAGAIN || ret == -ENOMEM)
3416 transport_lun_remove_cmd(cmd);
3417 transport_cmd_check_stop_to_fabric(cmd);
3421 pr_debug("Handling complete_ok QUEUE_FULL: se_cmd: %p,"
3422 " data_direction: %d\n", cmd, cmd->data_direction);
3423 cmd->t_state = TRANSPORT_COMPLETE_QF_OK;
3424 transport_handle_queue_full(cmd, cmd->se_dev);
3427 static void transport_free_dev_tasks(struct se_cmd *cmd)
3429 struct se_task *task, *task_tmp;
3430 unsigned long flags;
3431 LIST_HEAD(dispose_list);
3433 spin_lock_irqsave(&cmd->t_state_lock, flags);
3434 list_for_each_entry_safe(task, task_tmp,
3435 &cmd->t_task_list, t_list) {
3436 if (!(task->task_flags & TF_ACTIVE))
3437 list_move_tail(&task->t_list, &dispose_list);
3439 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
3441 while (!list_empty(&dispose_list)) {
3442 task = list_first_entry(&dispose_list, struct se_task, t_list);
3444 if (task->task_sg != cmd->t_data_sg &&
3445 task->task_sg != cmd->t_bidi_data_sg)
3446 kfree(task->task_sg);
3448 list_del(&task->t_list);
3450 cmd->se_dev->transport->free_task(task);
3454 static inline void transport_free_sgl(struct scatterlist *sgl, int nents)
3456 struct scatterlist *sg;
3459 for_each_sg(sgl, sg, nents, count)
3460 __free_page(sg_page(sg));
3465 static inline void transport_free_pages(struct se_cmd *cmd)
3467 if (cmd->se_cmd_flags & SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC)
3470 transport_free_sgl(cmd->t_data_sg, cmd->t_data_nents);
3471 cmd->t_data_sg = NULL;
3472 cmd->t_data_nents = 0;
3474 transport_free_sgl(cmd->t_bidi_data_sg, cmd->t_bidi_data_nents);
3475 cmd->t_bidi_data_sg = NULL;
3476 cmd->t_bidi_data_nents = 0;
3480 * transport_release_cmd - free a command
3481 * @cmd: command to free
3483 * This routine unconditionally frees a command, and reference counting
3484 * or list removal must be done in the caller.
3486 static void transport_release_cmd(struct se_cmd *cmd)
3488 BUG_ON(!cmd->se_tfo);
3490 if (cmd->se_cmd_flags & SCF_SCSI_TMR_CDB)
3491 core_tmr_release_req(cmd->se_tmr_req);
3492 if (cmd->t_task_cdb != cmd->__t_task_cdb)
3493 kfree(cmd->t_task_cdb);
3495 * If this cmd has been setup with target_get_sess_cmd(), drop
3496 * the kref and call ->release_cmd() in kref callback.
3498 if (cmd->check_release != 0) {
3499 target_put_sess_cmd(cmd->se_sess, cmd);
3502 cmd->se_tfo->release_cmd(cmd);
3506 * transport_put_cmd - release a reference to a command
3507 * @cmd: command to release
3509 * This routine releases our reference to the command and frees it if possible.
3511 static void transport_put_cmd(struct se_cmd *cmd)
3513 unsigned long flags;
3516 spin_lock_irqsave(&cmd->t_state_lock, flags);
3517 if (atomic_read(&cmd->t_fe_count)) {
3518 if (!atomic_dec_and_test(&cmd->t_fe_count))
3522 if (atomic_read(&cmd->t_se_count)) {
3523 if (!atomic_dec_and_test(&cmd->t_se_count))
3527 if (cmd->transport_state & CMD_T_DEV_ACTIVE) {
3528 cmd->transport_state &= ~CMD_T_DEV_ACTIVE;
3529 transport_all_task_dev_remove_state(cmd);
3532 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
3534 if (free_tasks != 0)
3535 transport_free_dev_tasks(cmd);
3537 transport_free_pages(cmd);
3538 transport_release_cmd(cmd);
3541 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
3545 * transport_generic_map_mem_to_cmd - Use fabric-alloced pages instead of
3546 * allocating in the core.
3547 * @cmd: Associated se_cmd descriptor
3548 * @mem: SGL style memory for TCM WRITE / READ
3549 * @sg_mem_num: Number of SGL elements
3550 * @mem_bidi_in: SGL style memory for TCM BIDI READ
3551 * @sg_mem_bidi_num: Number of BIDI READ SGL elements
3553 * Return: nonzero return cmd was rejected for -ENOMEM or inproper usage
3556 int transport_generic_map_mem_to_cmd(
3558 struct scatterlist *sgl,
3560 struct scatterlist *sgl_bidi,
3563 if (!sgl || !sgl_count)
3566 if ((cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) ||
3567 (cmd->se_cmd_flags & SCF_SCSI_CONTROL_SG_IO_CDB)) {
3569 * Reject SCSI data overflow with map_mem_to_cmd() as incoming
3570 * scatterlists already have been set to follow what the fabric
3571 * passes for the original expected data transfer length.
3573 if (cmd->se_cmd_flags & SCF_OVERFLOW_BIT) {
3574 pr_warn("Rejecting SCSI DATA overflow for fabric using"
3575 " SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC\n");
3576 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
3577 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
3581 cmd->t_data_sg = sgl;
3582 cmd->t_data_nents = sgl_count;
3584 if (sgl_bidi && sgl_bidi_count) {
3585 cmd->t_bidi_data_sg = sgl_bidi;
3586 cmd->t_bidi_data_nents = sgl_bidi_count;
3588 cmd->se_cmd_flags |= SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
3593 EXPORT_SYMBOL(transport_generic_map_mem_to_cmd);
3595 void *transport_kmap_data_sg(struct se_cmd *cmd)
3597 struct scatterlist *sg = cmd->t_data_sg;
3598 struct page **pages;
3603 * We need to take into account a possible offset here for fabrics like
3604 * tcm_loop who may be using a contig buffer from the SCSI midlayer for
3605 * control CDBs passed as SGLs via transport_generic_map_mem_to_cmd()
3607 if (!cmd->t_data_nents)
3609 else if (cmd->t_data_nents == 1)
3610 return kmap(sg_page(sg)) + sg->offset;
3612 /* >1 page. use vmap */
3613 pages = kmalloc(sizeof(*pages) * cmd->t_data_nents, GFP_KERNEL);
3617 /* convert sg[] to pages[] */
3618 for_each_sg(cmd->t_data_sg, sg, cmd->t_data_nents, i) {
3619 pages[i] = sg_page(sg);
3622 cmd->t_data_vmap = vmap(pages, cmd->t_data_nents, VM_MAP, PAGE_KERNEL);
3624 if (!cmd->t_data_vmap)
3627 return cmd->t_data_vmap + cmd->t_data_sg[0].offset;
3629 EXPORT_SYMBOL(transport_kmap_data_sg);
3631 void transport_kunmap_data_sg(struct se_cmd *cmd)
3633 if (!cmd->t_data_nents) {
3635 } else if (cmd->t_data_nents == 1) {
3636 kunmap(sg_page(cmd->t_data_sg));
3640 vunmap(cmd->t_data_vmap);
3641 cmd->t_data_vmap = NULL;
3643 EXPORT_SYMBOL(transport_kunmap_data_sg);
3646 transport_generic_get_mem(struct se_cmd *cmd)
3648 u32 length = cmd->data_length;
3654 nents = DIV_ROUND_UP(length, PAGE_SIZE);
3655 cmd->t_data_sg = kmalloc(sizeof(struct scatterlist) * nents, GFP_KERNEL);
3656 if (!cmd->t_data_sg)
3659 cmd->t_data_nents = nents;
3660 sg_init_table(cmd->t_data_sg, nents);
3662 zero_flag = cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB ? 0 : __GFP_ZERO;
3665 u32 page_len = min_t(u32, length, PAGE_SIZE);
3666 page = alloc_page(GFP_KERNEL | zero_flag);
3670 sg_set_page(&cmd->t_data_sg[i], page, page_len, 0);
3678 __free_page(sg_page(&cmd->t_data_sg[i]));
3681 kfree(cmd->t_data_sg);
3682 cmd->t_data_sg = NULL;
3686 /* Reduce sectors if they are too long for the device */
3687 static inline sector_t transport_limit_task_sectors(
3688 struct se_device *dev,
3689 unsigned long long lba,
3692 sectors = min_t(sector_t, sectors, dev->se_sub_dev->se_dev_attrib.max_sectors);
3694 if (dev->transport->get_device_type(dev) == TYPE_DISK)
3695 if ((lba + sectors) > transport_dev_end_lba(dev))
3696 sectors = ((transport_dev_end_lba(dev) - lba) + 1);
3703 * This function can be used by HW target mode drivers to create a linked
3704 * scatterlist from all contiguously allocated struct se_task->task_sg[].
3705 * This is intended to be called during the completion path by TCM Core
3706 * when struct target_core_fabric_ops->check_task_sg_chaining is enabled.
3708 void transport_do_task_sg_chain(struct se_cmd *cmd)
3710 struct scatterlist *sg_first = NULL;
3711 struct scatterlist *sg_prev = NULL;
3712 int sg_prev_nents = 0;
3713 struct scatterlist *sg;
3714 struct se_task *task;
3715 u32 chained_nents = 0;
3718 BUG_ON(!cmd->se_tfo->task_sg_chaining);
3721 * Walk the struct se_task list and setup scatterlist chains
3722 * for each contiguously allocated struct se_task->task_sg[].
3724 list_for_each_entry(task, &cmd->t_task_list, t_list) {
3729 sg_first = task->task_sg;
3730 chained_nents = task->task_sg_nents;
3732 sg_chain(sg_prev, sg_prev_nents, task->task_sg);
3733 chained_nents += task->task_sg_nents;
3736 * For the padded tasks, use the extra SGL vector allocated
3737 * in transport_allocate_data_tasks() for the sg_prev_nents
3738 * offset into sg_chain() above.
3740 * We do not need the padding for the last task (or a single
3741 * task), but in that case we will never use the sg_prev_nents
3742 * value below which would be incorrect.
3744 sg_prev_nents = (task->task_sg_nents + 1);
3745 sg_prev = task->task_sg;
3748 * Setup the starting pointer and total t_tasks_sg_linked_no including
3749 * padding SGs for linking and to mark the end.
3751 cmd->t_tasks_sg_chained = sg_first;
3752 cmd->t_tasks_sg_chained_no = chained_nents;
3754 pr_debug("Setup cmd: %p cmd->t_tasks_sg_chained: %p and"
3755 " t_tasks_sg_chained_no: %u\n", cmd, cmd->t_tasks_sg_chained,
3756 cmd->t_tasks_sg_chained_no);
3758 for_each_sg(cmd->t_tasks_sg_chained, sg,
3759 cmd->t_tasks_sg_chained_no, i) {
3761 pr_debug("SG[%d]: %p page: %p length: %d offset: %d\n",
3762 i, sg, sg_page(sg), sg->length, sg->offset);
3763 if (sg_is_chain(sg))
3764 pr_debug("SG: %p sg_is_chain=1\n", sg);
3766 pr_debug("SG: %p sg_is_last=1\n", sg);
3769 EXPORT_SYMBOL(transport_do_task_sg_chain);
3772 * Break up cmd into chunks transport can handle
3775 transport_allocate_data_tasks(struct se_cmd *cmd,
3776 enum dma_data_direction data_direction,
3777 struct scatterlist *cmd_sg, unsigned int sgl_nents)
3779 struct se_device *dev = cmd->se_dev;
3781 unsigned long long lba;
3782 sector_t sectors, dev_max_sectors;
3785 if (transport_cmd_get_valid_sectors(cmd) < 0)
3788 dev_max_sectors = dev->se_sub_dev->se_dev_attrib.max_sectors;
3789 sector_size = dev->se_sub_dev->se_dev_attrib.block_size;
3791 WARN_ON(cmd->data_length % sector_size);
3793 lba = cmd->t_task_lba;
3794 sectors = DIV_ROUND_UP(cmd->data_length, sector_size);
3795 task_count = DIV_ROUND_UP_SECTOR_T(sectors, dev_max_sectors);
3798 * If we need just a single task reuse the SG list in the command
3799 * and avoid a lot of work.
3801 if (task_count == 1) {
3802 struct se_task *task;
3803 unsigned long flags;
3805 task = transport_generic_get_task(cmd, data_direction);
3809 task->task_sg = cmd_sg;
3810 task->task_sg_nents = sgl_nents;
3812 task->task_lba = lba;
3813 task->task_sectors = sectors;
3814 task->task_size = task->task_sectors * sector_size;
3816 spin_lock_irqsave(&cmd->t_state_lock, flags);
3817 list_add_tail(&task->t_list, &cmd->t_task_list);
3818 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
3823 for (i = 0; i < task_count; i++) {
3824 struct se_task *task;
3825 unsigned int task_size, task_sg_nents_padded;
3826 struct scatterlist *sg;
3827 unsigned long flags;
3830 task = transport_generic_get_task(cmd, data_direction);
3834 task->task_lba = lba;
3835 task->task_sectors = min(sectors, dev_max_sectors);
3836 task->task_size = task->task_sectors * sector_size;
3839 * This now assumes that passed sg_ents are in PAGE_SIZE chunks
3840 * in order to calculate the number per task SGL entries
3842 task->task_sg_nents = DIV_ROUND_UP(task->task_size, PAGE_SIZE);
3844 * Check if the fabric module driver is requesting that all
3845 * struct se_task->task_sg[] be chained together.. If so,
3846 * then allocate an extra padding SG entry for linking and
3847 * marking the end of the chained SGL for every task except
3848 * the last one for (task_count > 1) operation, or skipping
3849 * the extra padding for the (task_count == 1) case.
3851 if (cmd->se_tfo->task_sg_chaining && (i < (task_count - 1))) {
3852 task_sg_nents_padded = (task->task_sg_nents + 1);
3854 task_sg_nents_padded = task->task_sg_nents;
3856 task->task_sg = kmalloc(sizeof(struct scatterlist) *
3857 task_sg_nents_padded, GFP_KERNEL);
3858 if (!task->task_sg) {
3859 cmd->se_dev->transport->free_task(task);
3863 sg_init_table(task->task_sg, task_sg_nents_padded);
3865 task_size = task->task_size;
3867 /* Build new sgl, only up to task_size */
3868 for_each_sg(task->task_sg, sg, task->task_sg_nents, count) {
3869 if (cmd_sg->length > task_size)
3873 task_size -= cmd_sg->length;
3874 cmd_sg = sg_next(cmd_sg);
3877 lba += task->task_sectors;
3878 sectors -= task->task_sectors;
3880 spin_lock_irqsave(&cmd->t_state_lock, flags);
3881 list_add_tail(&task->t_list, &cmd->t_task_list);
3882 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
3889 transport_allocate_control_task(struct se_cmd *cmd)
3891 struct se_task *task;
3892 unsigned long flags;
3894 /* Workaround for handling zero-length control CDBs */
3895 if ((cmd->se_cmd_flags & SCF_SCSI_CONTROL_SG_IO_CDB) &&
3899 task = transport_generic_get_task(cmd, cmd->data_direction);
3903 task->task_sg = cmd->t_data_sg;
3904 task->task_size = cmd->data_length;
3905 task->task_sg_nents = cmd->t_data_nents;
3907 spin_lock_irqsave(&cmd->t_state_lock, flags);
3908 list_add_tail(&task->t_list, &cmd->t_task_list);
3909 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
3911 /* Success! Return number of tasks allocated */
3916 * Allocate any required ressources to execute the command, and either place
3917 * it on the execution queue if possible. For writes we might not have the
3918 * payload yet, thus notify the fabric via a call to ->write_pending instead.
3920 int transport_generic_new_cmd(struct se_cmd *cmd)
3922 struct se_device *dev = cmd->se_dev;
3923 int task_cdbs, task_cdbs_bidi = 0;
3928 * Determine is the TCM fabric module has already allocated physical
3929 * memory, and is directly calling transport_generic_map_mem_to_cmd()
3932 if (!(cmd->se_cmd_flags & SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC) &&
3934 ret = transport_generic_get_mem(cmd);
3940 * For BIDI command set up the read tasks first.
3942 if (cmd->t_bidi_data_sg &&
3943 dev->transport->transport_type != TRANSPORT_PLUGIN_PHBA_PDEV) {
3944 BUG_ON(!(cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB));
3946 task_cdbs_bidi = transport_allocate_data_tasks(cmd,
3947 DMA_FROM_DEVICE, cmd->t_bidi_data_sg,
3948 cmd->t_bidi_data_nents);
3949 if (task_cdbs_bidi <= 0)
3952 atomic_inc(&cmd->t_fe_count);
3953 atomic_inc(&cmd->t_se_count);
3957 if (cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
3958 task_cdbs = transport_allocate_data_tasks(cmd,
3959 cmd->data_direction, cmd->t_data_sg,
3962 task_cdbs = transport_allocate_control_task(cmd);
3967 else if (!task_cdbs && (cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB)) {
3968 spin_lock_irq(&cmd->t_state_lock);
3969 cmd->t_state = TRANSPORT_COMPLETE;
3970 cmd->transport_state |= CMD_T_ACTIVE;
3971 spin_unlock_irq(&cmd->t_state_lock);
3973 if (cmd->t_task_cdb[0] == REQUEST_SENSE) {
3974 u8 ua_asc = 0, ua_ascq = 0;
3976 core_scsi3_ua_clear_for_request_sense(cmd,
3980 INIT_WORK(&cmd->work, target_complete_ok_work);
3981 queue_work(target_completion_wq, &cmd->work);
3986 atomic_inc(&cmd->t_fe_count);
3987 atomic_inc(&cmd->t_se_count);
3990 cmd->t_task_list_num = (task_cdbs + task_cdbs_bidi);
3991 atomic_set(&cmd->t_task_cdbs_left, cmd->t_task_list_num);
3992 atomic_set(&cmd->t_task_cdbs_ex_left, cmd->t_task_list_num);
3995 * For WRITEs, let the fabric know its buffer is ready..
3996 * This WRITE struct se_cmd (and all of its associated struct se_task's)
3997 * will be added to the struct se_device execution queue after its WRITE
3998 * data has arrived. (ie: It gets handled by the transport processing
3999 * thread a second time)
4001 if (cmd->data_direction == DMA_TO_DEVICE) {
4002 transport_add_tasks_to_state_queue(cmd);
4003 return transport_generic_write_pending(cmd);
4006 * Everything else but a WRITE, add the struct se_cmd's struct se_task's
4007 * to the execution queue.
4009 transport_execute_tasks(cmd);
4013 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
4014 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
4017 EXPORT_SYMBOL(transport_generic_new_cmd);
4019 /* transport_generic_process_write():
4023 void transport_generic_process_write(struct se_cmd *cmd)
4025 transport_execute_tasks(cmd);
4027 EXPORT_SYMBOL(transport_generic_process_write);
4029 static void transport_write_pending_qf(struct se_cmd *cmd)
4033 ret = cmd->se_tfo->write_pending(cmd);
4034 if (ret == -EAGAIN || ret == -ENOMEM) {
4035 pr_debug("Handling write_pending QUEUE__FULL: se_cmd: %p\n",
4037 transport_handle_queue_full(cmd, cmd->se_dev);
4041 static int transport_generic_write_pending(struct se_cmd *cmd)
4043 unsigned long flags;
4046 spin_lock_irqsave(&cmd->t_state_lock, flags);
4047 cmd->t_state = TRANSPORT_WRITE_PENDING;
4048 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4051 * Clear the se_cmd for WRITE_PENDING status in order to set
4052 * CMD_T_ACTIVE so that transport_generic_handle_data can be called
4053 * from HW target mode interrupt code. This is safe to be called
4054 * with transport_off=1 before the cmd->se_tfo->write_pending
4055 * because the se_cmd->se_lun pointer is not being cleared.
4057 transport_cmd_check_stop(cmd, 1, 0);
4060 * Call the fabric write_pending function here to let the
4061 * frontend know that WRITE buffers are ready.
4063 ret = cmd->se_tfo->write_pending(cmd);
4064 if (ret == -EAGAIN || ret == -ENOMEM)
4072 pr_debug("Handling write_pending QUEUE__FULL: se_cmd: %p\n", cmd);
4073 cmd->t_state = TRANSPORT_COMPLETE_QF_WP;
4074 transport_handle_queue_full(cmd, cmd->se_dev);
4078 void transport_generic_free_cmd(struct se_cmd *cmd, int wait_for_tasks)
4080 if (!(cmd->se_cmd_flags & SCF_SE_LUN_CMD)) {
4081 if (wait_for_tasks && (cmd->se_cmd_flags & SCF_SCSI_TMR_CDB))
4082 transport_wait_for_tasks(cmd);
4084 transport_release_cmd(cmd);
4087 transport_wait_for_tasks(cmd);
4089 core_dec_lacl_count(cmd->se_sess->se_node_acl, cmd);
4092 transport_lun_remove_cmd(cmd);
4094 transport_free_dev_tasks(cmd);
4096 transport_put_cmd(cmd);
4099 EXPORT_SYMBOL(transport_generic_free_cmd);
4101 /* target_get_sess_cmd - Add command to active ->sess_cmd_list
4102 * @se_sess: session to reference
4103 * @se_cmd: command descriptor to add
4104 * @ack_kref: Signal that fabric will perform an ack target_put_sess_cmd()
4106 void target_get_sess_cmd(struct se_session *se_sess, struct se_cmd *se_cmd,
4109 unsigned long flags;
4111 kref_init(&se_cmd->cmd_kref);
4113 * Add a second kref if the fabric caller is expecting to handle
4114 * fabric acknowledgement that requires two target_put_sess_cmd()
4115 * invocations before se_cmd descriptor release.
4117 if (ack_kref == true) {
4118 kref_get(&se_cmd->cmd_kref);
4119 se_cmd->se_cmd_flags |= SCF_ACK_KREF;
4122 spin_lock_irqsave(&se_sess->sess_cmd_lock, flags);
4123 list_add_tail(&se_cmd->se_cmd_list, &se_sess->sess_cmd_list);
4124 se_cmd->check_release = 1;
4125 spin_unlock_irqrestore(&se_sess->sess_cmd_lock, flags);
4127 EXPORT_SYMBOL(target_get_sess_cmd);
4129 static void target_release_cmd_kref(struct kref *kref)
4131 struct se_cmd *se_cmd = container_of(kref, struct se_cmd, cmd_kref);
4132 struct se_session *se_sess = se_cmd->se_sess;
4133 unsigned long flags;
4135 spin_lock_irqsave(&se_sess->sess_cmd_lock, flags);
4136 if (list_empty(&se_cmd->se_cmd_list)) {
4137 spin_unlock_irqrestore(&se_sess->sess_cmd_lock, flags);
4138 se_cmd->se_tfo->release_cmd(se_cmd);
4141 if (se_sess->sess_tearing_down && se_cmd->cmd_wait_set) {
4142 spin_unlock_irqrestore(&se_sess->sess_cmd_lock, flags);
4143 complete(&se_cmd->cmd_wait_comp);
4146 list_del(&se_cmd->se_cmd_list);
4147 spin_unlock_irqrestore(&se_sess->sess_cmd_lock, flags);
4149 se_cmd->se_tfo->release_cmd(se_cmd);
4152 /* target_put_sess_cmd - Check for active I/O shutdown via kref_put
4153 * @se_sess: session to reference
4154 * @se_cmd: command descriptor to drop
4156 int target_put_sess_cmd(struct se_session *se_sess, struct se_cmd *se_cmd)
4158 return kref_put(&se_cmd->cmd_kref, target_release_cmd_kref);
4160 EXPORT_SYMBOL(target_put_sess_cmd);
4162 /* target_splice_sess_cmd_list - Split active cmds into sess_wait_list
4163 * @se_sess: session to split
4165 void target_splice_sess_cmd_list(struct se_session *se_sess)
4167 struct se_cmd *se_cmd;
4168 unsigned long flags;
4170 WARN_ON(!list_empty(&se_sess->sess_wait_list));
4171 INIT_LIST_HEAD(&se_sess->sess_wait_list);
4173 spin_lock_irqsave(&se_sess->sess_cmd_lock, flags);
4174 se_sess->sess_tearing_down = 1;
4176 list_splice_init(&se_sess->sess_cmd_list, &se_sess->sess_wait_list);
4178 list_for_each_entry(se_cmd, &se_sess->sess_wait_list, se_cmd_list)
4179 se_cmd->cmd_wait_set = 1;
4181 spin_unlock_irqrestore(&se_sess->sess_cmd_lock, flags);
4183 EXPORT_SYMBOL(target_splice_sess_cmd_list);
4185 /* target_wait_for_sess_cmds - Wait for outstanding descriptors
4186 * @se_sess: session to wait for active I/O
4187 * @wait_for_tasks: Make extra transport_wait_for_tasks call
4189 void target_wait_for_sess_cmds(
4190 struct se_session *se_sess,
4193 struct se_cmd *se_cmd, *tmp_cmd;
4196 list_for_each_entry_safe(se_cmd, tmp_cmd,
4197 &se_sess->sess_wait_list, se_cmd_list) {
4198 list_del(&se_cmd->se_cmd_list);
4200 pr_debug("Waiting for se_cmd: %p t_state: %d, fabric state:"
4201 " %d\n", se_cmd, se_cmd->t_state,
4202 se_cmd->se_tfo->get_cmd_state(se_cmd));
4204 if (wait_for_tasks) {
4205 pr_debug("Calling transport_wait_for_tasks se_cmd: %p t_state: %d,"
4206 " fabric state: %d\n", se_cmd, se_cmd->t_state,
4207 se_cmd->se_tfo->get_cmd_state(se_cmd));
4209 rc = transport_wait_for_tasks(se_cmd);
4211 pr_debug("After transport_wait_for_tasks se_cmd: %p t_state: %d,"
4212 " fabric state: %d\n", se_cmd, se_cmd->t_state,
4213 se_cmd->se_tfo->get_cmd_state(se_cmd));
4217 wait_for_completion(&se_cmd->cmd_wait_comp);
4218 pr_debug("After cmd_wait_comp: se_cmd: %p t_state: %d"
4219 " fabric state: %d\n", se_cmd, se_cmd->t_state,
4220 se_cmd->se_tfo->get_cmd_state(se_cmd));
4223 se_cmd->se_tfo->release_cmd(se_cmd);
4226 EXPORT_SYMBOL(target_wait_for_sess_cmds);
4228 /* transport_lun_wait_for_tasks():
4230 * Called from ConfigFS context to stop the passed struct se_cmd to allow
4231 * an struct se_lun to be successfully shutdown.
4233 static int transport_lun_wait_for_tasks(struct se_cmd *cmd, struct se_lun *lun)
4235 unsigned long flags;
4238 * If the frontend has already requested this struct se_cmd to
4239 * be stopped, we can safely ignore this struct se_cmd.
4241 spin_lock_irqsave(&cmd->t_state_lock, flags);
4242 if (cmd->transport_state & CMD_T_STOP) {
4243 cmd->transport_state &= ~CMD_T_LUN_STOP;
4245 pr_debug("ConfigFS ITT[0x%08x] - CMD_T_STOP, skipping\n",
4246 cmd->se_tfo->get_task_tag(cmd));
4247 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4248 transport_cmd_check_stop(cmd, 1, 0);
4251 cmd->transport_state |= CMD_T_LUN_FE_STOP;
4252 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4254 wake_up_interruptible(&cmd->se_dev->dev_queue_obj.thread_wq);
4256 ret = transport_stop_tasks_for_cmd(cmd);
4258 pr_debug("ConfigFS: cmd: %p t_tasks: %d stop tasks ret:"
4259 " %d\n", cmd, cmd->t_task_list_num, ret);
4261 pr_debug("ConfigFS: ITT[0x%08x] - stopping cmd....\n",
4262 cmd->se_tfo->get_task_tag(cmd));
4263 wait_for_completion(&cmd->transport_lun_stop_comp);
4264 pr_debug("ConfigFS: ITT[0x%08x] - stopped cmd....\n",
4265 cmd->se_tfo->get_task_tag(cmd));
4267 transport_remove_cmd_from_queue(cmd);
4272 static void __transport_clear_lun_from_sessions(struct se_lun *lun)
4274 struct se_cmd *cmd = NULL;
4275 unsigned long lun_flags, cmd_flags;
4277 * Do exception processing and return CHECK_CONDITION status to the
4280 spin_lock_irqsave(&lun->lun_cmd_lock, lun_flags);
4281 while (!list_empty(&lun->lun_cmd_list)) {
4282 cmd = list_first_entry(&lun->lun_cmd_list,
4283 struct se_cmd, se_lun_node);
4284 list_del_init(&cmd->se_lun_node);
4287 * This will notify iscsi_target_transport.c:
4288 * transport_cmd_check_stop() that a LUN shutdown is in
4289 * progress for the iscsi_cmd_t.
4291 spin_lock(&cmd->t_state_lock);
4292 pr_debug("SE_LUN[%d] - Setting cmd->transport"
4293 "_lun_stop for ITT: 0x%08x\n",
4294 cmd->se_lun->unpacked_lun,
4295 cmd->se_tfo->get_task_tag(cmd));
4296 cmd->transport_state |= CMD_T_LUN_STOP;
4297 spin_unlock(&cmd->t_state_lock);
4299 spin_unlock_irqrestore(&lun->lun_cmd_lock, lun_flags);
4302 pr_err("ITT: 0x%08x, [i,t]_state: %u/%u\n",
4303 cmd->se_tfo->get_task_tag(cmd),
4304 cmd->se_tfo->get_cmd_state(cmd), cmd->t_state);
4308 * If the Storage engine still owns the iscsi_cmd_t, determine
4309 * and/or stop its context.
4311 pr_debug("SE_LUN[%d] - ITT: 0x%08x before transport"
4312 "_lun_wait_for_tasks()\n", cmd->se_lun->unpacked_lun,
4313 cmd->se_tfo->get_task_tag(cmd));
4315 if (transport_lun_wait_for_tasks(cmd, cmd->se_lun) < 0) {
4316 spin_lock_irqsave(&lun->lun_cmd_lock, lun_flags);
4320 pr_debug("SE_LUN[%d] - ITT: 0x%08x after transport_lun"
4321 "_wait_for_tasks(): SUCCESS\n",
4322 cmd->se_lun->unpacked_lun,
4323 cmd->se_tfo->get_task_tag(cmd));
4325 spin_lock_irqsave(&cmd->t_state_lock, cmd_flags);
4326 if (!(cmd->transport_state & CMD_T_DEV_ACTIVE)) {
4327 spin_unlock_irqrestore(&cmd->t_state_lock, cmd_flags);
4330 cmd->transport_state &= ~CMD_T_DEV_ACTIVE;
4331 transport_all_task_dev_remove_state(cmd);
4332 spin_unlock_irqrestore(&cmd->t_state_lock, cmd_flags);
4334 transport_free_dev_tasks(cmd);
4336 * The Storage engine stopped this struct se_cmd before it was
4337 * send to the fabric frontend for delivery back to the
4338 * Initiator Node. Return this SCSI CDB back with an
4339 * CHECK_CONDITION status.
4342 transport_send_check_condition_and_sense(cmd,
4343 TCM_NON_EXISTENT_LUN, 0);
4345 * If the fabric frontend is waiting for this iscsi_cmd_t to
4346 * be released, notify the waiting thread now that LU has
4347 * finished accessing it.
4349 spin_lock_irqsave(&cmd->t_state_lock, cmd_flags);
4350 if (cmd->transport_state & CMD_T_LUN_FE_STOP) {
4351 pr_debug("SE_LUN[%d] - Detected FE stop for"
4352 " struct se_cmd: %p ITT: 0x%08x\n",
4354 cmd, cmd->se_tfo->get_task_tag(cmd));
4356 spin_unlock_irqrestore(&cmd->t_state_lock,
4358 transport_cmd_check_stop(cmd, 1, 0);
4359 complete(&cmd->transport_lun_fe_stop_comp);
4360 spin_lock_irqsave(&lun->lun_cmd_lock, lun_flags);
4363 pr_debug("SE_LUN[%d] - ITT: 0x%08x finished processing\n",
4364 lun->unpacked_lun, cmd->se_tfo->get_task_tag(cmd));
4366 spin_unlock_irqrestore(&cmd->t_state_lock, cmd_flags);
4367 spin_lock_irqsave(&lun->lun_cmd_lock, lun_flags);
4369 spin_unlock_irqrestore(&lun->lun_cmd_lock, lun_flags);
4372 static int transport_clear_lun_thread(void *p)
4374 struct se_lun *lun = p;
4376 __transport_clear_lun_from_sessions(lun);
4377 complete(&lun->lun_shutdown_comp);
4382 int transport_clear_lun_from_sessions(struct se_lun *lun)
4384 struct task_struct *kt;
4386 kt = kthread_run(transport_clear_lun_thread, lun,
4387 "tcm_cl_%u", lun->unpacked_lun);
4389 pr_err("Unable to start clear_lun thread\n");
4392 wait_for_completion(&lun->lun_shutdown_comp);
4398 * transport_wait_for_tasks - wait for completion to occur
4399 * @cmd: command to wait
4401 * Called from frontend fabric context to wait for storage engine
4402 * to pause and/or release frontend generated struct se_cmd.
4404 bool transport_wait_for_tasks(struct se_cmd *cmd)
4406 unsigned long flags;
4408 spin_lock_irqsave(&cmd->t_state_lock, flags);
4409 if (!(cmd->se_cmd_flags & SCF_SE_LUN_CMD) &&
4410 !(cmd->se_cmd_flags & SCF_SCSI_TMR_CDB)) {
4411 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4415 * Only perform a possible wait_for_tasks if SCF_SUPPORTED_SAM_OPCODE
4416 * has been set in transport_set_supported_SAM_opcode().
4418 if (!(cmd->se_cmd_flags & SCF_SUPPORTED_SAM_OPCODE) &&
4419 !(cmd->se_cmd_flags & SCF_SCSI_TMR_CDB)) {
4420 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4424 * If we are already stopped due to an external event (ie: LUN shutdown)
4425 * sleep until the connection can have the passed struct se_cmd back.
4426 * The cmd->transport_lun_stopped_sem will be upped by
4427 * transport_clear_lun_from_sessions() once the ConfigFS context caller
4428 * has completed its operation on the struct se_cmd.
4430 if (cmd->transport_state & CMD_T_LUN_STOP) {
4431 pr_debug("wait_for_tasks: Stopping"
4432 " wait_for_completion(&cmd->t_tasktransport_lun_fe"
4433 "_stop_comp); for ITT: 0x%08x\n",
4434 cmd->se_tfo->get_task_tag(cmd));
4436 * There is a special case for WRITES where a FE exception +
4437 * LUN shutdown means ConfigFS context is still sleeping on
4438 * transport_lun_stop_comp in transport_lun_wait_for_tasks().
4439 * We go ahead and up transport_lun_stop_comp just to be sure
4442 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4443 complete(&cmd->transport_lun_stop_comp);
4444 wait_for_completion(&cmd->transport_lun_fe_stop_comp);
4445 spin_lock_irqsave(&cmd->t_state_lock, flags);
4447 transport_all_task_dev_remove_state(cmd);
4449 * At this point, the frontend who was the originator of this
4450 * struct se_cmd, now owns the structure and can be released through
4451 * normal means below.
4453 pr_debug("wait_for_tasks: Stopped"
4454 " wait_for_completion(&cmd->t_tasktransport_lun_fe_"
4455 "stop_comp); for ITT: 0x%08x\n",
4456 cmd->se_tfo->get_task_tag(cmd));
4458 cmd->transport_state &= ~CMD_T_LUN_STOP;
4461 if (!(cmd->transport_state & CMD_T_ACTIVE)) {
4462 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4466 cmd->transport_state |= CMD_T_STOP;
4468 pr_debug("wait_for_tasks: Stopping %p ITT: 0x%08x"
4469 " i_state: %d, t_state: %d, CMD_T_STOP\n",
4470 cmd, cmd->se_tfo->get_task_tag(cmd),
4471 cmd->se_tfo->get_cmd_state(cmd), cmd->t_state);
4473 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4475 wake_up_interruptible(&cmd->se_dev->dev_queue_obj.thread_wq);
4477 wait_for_completion(&cmd->t_transport_stop_comp);
4479 spin_lock_irqsave(&cmd->t_state_lock, flags);
4480 cmd->transport_state &= ~(CMD_T_ACTIVE | CMD_T_STOP);
4482 pr_debug("wait_for_tasks: Stopped wait_for_compltion("
4483 "&cmd->t_transport_stop_comp) for ITT: 0x%08x\n",
4484 cmd->se_tfo->get_task_tag(cmd));
4486 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4490 EXPORT_SYMBOL(transport_wait_for_tasks);
4492 static int transport_get_sense_codes(
4497 *asc = cmd->scsi_asc;
4498 *ascq = cmd->scsi_ascq;
4503 static int transport_set_sense_codes(
4508 cmd->scsi_asc = asc;
4509 cmd->scsi_ascq = ascq;
4514 int transport_send_check_condition_and_sense(
4519 unsigned char *buffer = cmd->sense_buffer;
4520 unsigned long flags;
4522 u8 asc = 0, ascq = 0;
4524 spin_lock_irqsave(&cmd->t_state_lock, flags);
4525 if (cmd->se_cmd_flags & SCF_SENT_CHECK_CONDITION) {
4526 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4529 cmd->se_cmd_flags |= SCF_SENT_CHECK_CONDITION;
4530 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4532 if (!reason && from_transport)
4535 if (!from_transport)
4536 cmd->se_cmd_flags |= SCF_EMULATED_TASK_SENSE;
4538 * Data Segment and SenseLength of the fabric response PDU.
4540 * TRANSPORT_SENSE_BUFFER is now set to SCSI_SENSE_BUFFERSIZE
4541 * from include/scsi/scsi_cmnd.h
4543 offset = cmd->se_tfo->set_fabric_sense_len(cmd,
4544 TRANSPORT_SENSE_BUFFER);
4546 * Actual SENSE DATA, see SPC-3 7.23.2 SPC_SENSE_KEY_OFFSET uses
4547 * SENSE KEY values from include/scsi/scsi.h
4550 case TCM_NON_EXISTENT_LUN:
4552 buffer[offset] = 0x70;
4553 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4554 /* ILLEGAL REQUEST */
4555 buffer[offset+SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
4556 /* LOGICAL UNIT NOT SUPPORTED */
4557 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x25;
4559 case TCM_UNSUPPORTED_SCSI_OPCODE:
4560 case TCM_SECTOR_COUNT_TOO_MANY:
4562 buffer[offset] = 0x70;
4563 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4564 /* ILLEGAL REQUEST */
4565 buffer[offset+SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
4566 /* INVALID COMMAND OPERATION CODE */
4567 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x20;
4569 case TCM_UNKNOWN_MODE_PAGE:
4571 buffer[offset] = 0x70;
4572 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4573 /* ILLEGAL REQUEST */
4574 buffer[offset+SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
4575 /* INVALID FIELD IN CDB */
4576 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x24;
4578 case TCM_CHECK_CONDITION_ABORT_CMD:
4580 buffer[offset] = 0x70;
4581 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4582 /* ABORTED COMMAND */
4583 buffer[offset+SPC_SENSE_KEY_OFFSET] = ABORTED_COMMAND;
4584 /* BUS DEVICE RESET FUNCTION OCCURRED */
4585 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x29;
4586 buffer[offset+SPC_ASCQ_KEY_OFFSET] = 0x03;
4588 case TCM_INCORRECT_AMOUNT_OF_DATA:
4590 buffer[offset] = 0x70;
4591 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4592 /* ABORTED COMMAND */
4593 buffer[offset+SPC_SENSE_KEY_OFFSET] = ABORTED_COMMAND;
4595 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x0c;
4596 /* NOT ENOUGH UNSOLICITED DATA */
4597 buffer[offset+SPC_ASCQ_KEY_OFFSET] = 0x0d;
4599 case TCM_INVALID_CDB_FIELD:
4601 buffer[offset] = 0x70;
4602 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4603 /* ILLEGAL REQUEST */
4604 buffer[offset+SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
4605 /* INVALID FIELD IN CDB */
4606 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x24;
4608 case TCM_INVALID_PARAMETER_LIST:
4610 buffer[offset] = 0x70;
4611 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4612 /* ILLEGAL REQUEST */
4613 buffer[offset+SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
4614 /* INVALID FIELD IN PARAMETER LIST */
4615 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x26;
4617 case TCM_UNEXPECTED_UNSOLICITED_DATA:
4619 buffer[offset] = 0x70;
4620 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4621 /* ABORTED COMMAND */
4622 buffer[offset+SPC_SENSE_KEY_OFFSET] = ABORTED_COMMAND;
4624 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x0c;
4625 /* UNEXPECTED_UNSOLICITED_DATA */
4626 buffer[offset+SPC_ASCQ_KEY_OFFSET] = 0x0c;
4628 case TCM_SERVICE_CRC_ERROR:
4630 buffer[offset] = 0x70;
4631 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4632 /* ABORTED COMMAND */
4633 buffer[offset+SPC_SENSE_KEY_OFFSET] = ABORTED_COMMAND;
4634 /* PROTOCOL SERVICE CRC ERROR */
4635 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x47;
4637 buffer[offset+SPC_ASCQ_KEY_OFFSET] = 0x05;
4639 case TCM_SNACK_REJECTED:
4641 buffer[offset] = 0x70;
4642 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4643 /* ABORTED COMMAND */
4644 buffer[offset+SPC_SENSE_KEY_OFFSET] = ABORTED_COMMAND;
4646 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x11;
4647 /* FAILED RETRANSMISSION REQUEST */
4648 buffer[offset+SPC_ASCQ_KEY_OFFSET] = 0x13;
4650 case TCM_WRITE_PROTECTED:
4652 buffer[offset] = 0x70;
4653 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4655 buffer[offset+SPC_SENSE_KEY_OFFSET] = DATA_PROTECT;
4656 /* WRITE PROTECTED */
4657 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x27;
4659 case TCM_CHECK_CONDITION_UNIT_ATTENTION:
4661 buffer[offset] = 0x70;
4662 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4663 /* UNIT ATTENTION */
4664 buffer[offset+SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
4665 core_scsi3_ua_for_check_condition(cmd, &asc, &ascq);
4666 buffer[offset+SPC_ASC_KEY_OFFSET] = asc;
4667 buffer[offset+SPC_ASCQ_KEY_OFFSET] = ascq;
4669 case TCM_CHECK_CONDITION_NOT_READY:
4671 buffer[offset] = 0x70;
4672 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4674 buffer[offset+SPC_SENSE_KEY_OFFSET] = NOT_READY;
4675 transport_get_sense_codes(cmd, &asc, &ascq);
4676 buffer[offset+SPC_ASC_KEY_OFFSET] = asc;
4677 buffer[offset+SPC_ASCQ_KEY_OFFSET] = ascq;
4679 case TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE:
4682 buffer[offset] = 0x70;
4683 buffer[offset+SPC_ADD_SENSE_LEN_OFFSET] = 10;
4684 /* ILLEGAL REQUEST */
4685 buffer[offset+SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
4686 /* LOGICAL UNIT COMMUNICATION FAILURE */
4687 buffer[offset+SPC_ASC_KEY_OFFSET] = 0x80;
4691 * This code uses linux/include/scsi/scsi.h SAM status codes!
4693 cmd->scsi_status = SAM_STAT_CHECK_CONDITION;
4695 * Automatically padded, this value is encoded in the fabric's
4696 * data_length response PDU containing the SCSI defined sense data.
4698 cmd->scsi_sense_length = TRANSPORT_SENSE_BUFFER + offset;
4701 return cmd->se_tfo->queue_status(cmd);
4703 EXPORT_SYMBOL(transport_send_check_condition_and_sense);
4705 int transport_check_aborted_status(struct se_cmd *cmd, int send_status)
4709 if (cmd->transport_state & CMD_T_ABORTED) {
4711 (cmd->se_cmd_flags & SCF_SENT_DELAYED_TAS))
4714 pr_debug("Sending delayed SAM_STAT_TASK_ABORTED"
4715 " status for CDB: 0x%02x ITT: 0x%08x\n",
4717 cmd->se_tfo->get_task_tag(cmd));
4719 cmd->se_cmd_flags |= SCF_SENT_DELAYED_TAS;
4720 cmd->se_tfo->queue_status(cmd);
4725 EXPORT_SYMBOL(transport_check_aborted_status);
4727 void transport_send_task_abort(struct se_cmd *cmd)
4729 unsigned long flags;
4731 spin_lock_irqsave(&cmd->t_state_lock, flags);
4732 if (cmd->se_cmd_flags & SCF_SENT_CHECK_CONDITION) {
4733 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4736 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
4739 * If there are still expected incoming fabric WRITEs, we wait
4740 * until until they have completed before sending a TASK_ABORTED
4741 * response. This response with TASK_ABORTED status will be
4742 * queued back to fabric module by transport_check_aborted_status().
4744 if (cmd->data_direction == DMA_TO_DEVICE) {
4745 if (cmd->se_tfo->write_pending_status(cmd) != 0) {
4746 cmd->transport_state |= CMD_T_ABORTED;
4747 smp_mb__after_atomic_inc();
4750 cmd->scsi_status = SAM_STAT_TASK_ABORTED;
4752 pr_debug("Setting SAM_STAT_TASK_ABORTED status for CDB: 0x%02x,"
4753 " ITT: 0x%08x\n", cmd->t_task_cdb[0],
4754 cmd->se_tfo->get_task_tag(cmd));
4756 cmd->se_tfo->queue_status(cmd);
4759 static int transport_generic_do_tmr(struct se_cmd *cmd)
4761 struct se_device *dev = cmd->se_dev;
4762 struct se_tmr_req *tmr = cmd->se_tmr_req;
4765 switch (tmr->function) {
4766 case TMR_ABORT_TASK:
4767 core_tmr_abort_task(dev, tmr, cmd->se_sess);
4769 case TMR_ABORT_TASK_SET:
4771 case TMR_CLEAR_TASK_SET:
4772 tmr->response = TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED;
4775 ret = core_tmr_lun_reset(dev, tmr, NULL, NULL);
4776 tmr->response = (!ret) ? TMR_FUNCTION_COMPLETE :
4777 TMR_FUNCTION_REJECTED;
4779 case TMR_TARGET_WARM_RESET:
4780 tmr->response = TMR_FUNCTION_REJECTED;
4782 case TMR_TARGET_COLD_RESET:
4783 tmr->response = TMR_FUNCTION_REJECTED;
4786 pr_err("Uknown TMR function: 0x%02x.\n",
4788 tmr->response = TMR_FUNCTION_REJECTED;
4792 cmd->t_state = TRANSPORT_ISTATE_PROCESSING;
4793 cmd->se_tfo->queue_tm_rsp(cmd);
4795 transport_cmd_check_stop_to_fabric(cmd);
4799 /* transport_processing_thread():
4803 static int transport_processing_thread(void *param)
4807 struct se_device *dev = param;
4809 while (!kthread_should_stop()) {
4810 ret = wait_event_interruptible(dev->dev_queue_obj.thread_wq,
4811 atomic_read(&dev->dev_queue_obj.queue_cnt) ||
4812 kthread_should_stop());
4817 cmd = transport_get_cmd_from_queue(&dev->dev_queue_obj);
4821 switch (cmd->t_state) {
4822 case TRANSPORT_NEW_CMD:
4825 case TRANSPORT_NEW_CMD_MAP:
4826 if (!cmd->se_tfo->new_cmd_map) {
4827 pr_err("cmd->se_tfo->new_cmd_map is"
4828 " NULL for TRANSPORT_NEW_CMD_MAP\n");
4831 ret = cmd->se_tfo->new_cmd_map(cmd);
4833 transport_generic_request_failure(cmd);
4836 ret = transport_generic_new_cmd(cmd);
4838 transport_generic_request_failure(cmd);
4842 case TRANSPORT_PROCESS_WRITE:
4843 transport_generic_process_write(cmd);
4845 case TRANSPORT_PROCESS_TMR:
4846 transport_generic_do_tmr(cmd);
4848 case TRANSPORT_COMPLETE_QF_WP:
4849 transport_write_pending_qf(cmd);
4851 case TRANSPORT_COMPLETE_QF_OK:
4852 transport_complete_qf(cmd);
4855 pr_err("Unknown t_state: %d for ITT: 0x%08x "
4856 "i_state: %d on SE LUN: %u\n",
4858 cmd->se_tfo->get_task_tag(cmd),
4859 cmd->se_tfo->get_cmd_state(cmd),
4860 cmd->se_lun->unpacked_lun);
4868 WARN_ON(!list_empty(&dev->state_task_list));
4869 WARN_ON(!list_empty(&dev->dev_queue_obj.qobj_list));
4870 dev->process_thread = NULL;