target: Use complete_all for se_cmd->t_transport_stop_comp
[platform/adaptation/renesas_rcar/renesas_kernel.git] / drivers / target / target_core_transport.c
1 /*******************************************************************************
2  * Filename:  target_core_transport.c
3  *
4  * This file contains the Generic Target Engine Core.
5  *
6  * (c) Copyright 2002-2013 Datera, Inc.
7  *
8  * Nicholas A. Bellinger <nab@kernel.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23  *
24  ******************************************************************************/
25
26 #include <linux/net.h>
27 #include <linux/delay.h>
28 #include <linux/string.h>
29 #include <linux/timer.h>
30 #include <linux/slab.h>
31 #include <linux/spinlock.h>
32 #include <linux/kthread.h>
33 #include <linux/in.h>
34 #include <linux/cdrom.h>
35 #include <linux/module.h>
36 #include <linux/ratelimit.h>
37 #include <asm/unaligned.h>
38 #include <net/sock.h>
39 #include <net/tcp.h>
40 #include <scsi/scsi.h>
41 #include <scsi/scsi_cmnd.h>
42 #include <scsi/scsi_tcq.h>
43
44 #include <target/target_core_base.h>
45 #include <target/target_core_backend.h>
46 #include <target/target_core_fabric.h>
47 #include <target/target_core_configfs.h>
48
49 #include "target_core_internal.h"
50 #include "target_core_alua.h"
51 #include "target_core_pr.h"
52 #include "target_core_ua.h"
53
54 #define CREATE_TRACE_POINTS
55 #include <trace/events/target.h>
56
57 static struct workqueue_struct *target_completion_wq;
58 static struct kmem_cache *se_sess_cache;
59 struct kmem_cache *se_ua_cache;
60 struct kmem_cache *t10_pr_reg_cache;
61 struct kmem_cache *t10_alua_lu_gp_cache;
62 struct kmem_cache *t10_alua_lu_gp_mem_cache;
63 struct kmem_cache *t10_alua_tg_pt_gp_cache;
64 struct kmem_cache *t10_alua_tg_pt_gp_mem_cache;
65 struct kmem_cache *t10_alua_lba_map_cache;
66 struct kmem_cache *t10_alua_lba_map_mem_cache;
67
68 static void transport_complete_task_attr(struct se_cmd *cmd);
69 static void transport_handle_queue_full(struct se_cmd *cmd,
70                 struct se_device *dev);
71 static int transport_put_cmd(struct se_cmd *cmd);
72 static void target_complete_ok_work(struct work_struct *work);
73
74 int init_se_kmem_caches(void)
75 {
76         se_sess_cache = kmem_cache_create("se_sess_cache",
77                         sizeof(struct se_session), __alignof__(struct se_session),
78                         0, NULL);
79         if (!se_sess_cache) {
80                 pr_err("kmem_cache_create() for struct se_session"
81                                 " failed\n");
82                 goto out;
83         }
84         se_ua_cache = kmem_cache_create("se_ua_cache",
85                         sizeof(struct se_ua), __alignof__(struct se_ua),
86                         0, NULL);
87         if (!se_ua_cache) {
88                 pr_err("kmem_cache_create() for struct se_ua failed\n");
89                 goto out_free_sess_cache;
90         }
91         t10_pr_reg_cache = kmem_cache_create("t10_pr_reg_cache",
92                         sizeof(struct t10_pr_registration),
93                         __alignof__(struct t10_pr_registration), 0, NULL);
94         if (!t10_pr_reg_cache) {
95                 pr_err("kmem_cache_create() for struct t10_pr_registration"
96                                 " failed\n");
97                 goto out_free_ua_cache;
98         }
99         t10_alua_lu_gp_cache = kmem_cache_create("t10_alua_lu_gp_cache",
100                         sizeof(struct t10_alua_lu_gp), __alignof__(struct t10_alua_lu_gp),
101                         0, NULL);
102         if (!t10_alua_lu_gp_cache) {
103                 pr_err("kmem_cache_create() for t10_alua_lu_gp_cache"
104                                 " failed\n");
105                 goto out_free_pr_reg_cache;
106         }
107         t10_alua_lu_gp_mem_cache = kmem_cache_create("t10_alua_lu_gp_mem_cache",
108                         sizeof(struct t10_alua_lu_gp_member),
109                         __alignof__(struct t10_alua_lu_gp_member), 0, NULL);
110         if (!t10_alua_lu_gp_mem_cache) {
111                 pr_err("kmem_cache_create() for t10_alua_lu_gp_mem_"
112                                 "cache failed\n");
113                 goto out_free_lu_gp_cache;
114         }
115         t10_alua_tg_pt_gp_cache = kmem_cache_create("t10_alua_tg_pt_gp_cache",
116                         sizeof(struct t10_alua_tg_pt_gp),
117                         __alignof__(struct t10_alua_tg_pt_gp), 0, NULL);
118         if (!t10_alua_tg_pt_gp_cache) {
119                 pr_err("kmem_cache_create() for t10_alua_tg_pt_gp_"
120                                 "cache failed\n");
121                 goto out_free_lu_gp_mem_cache;
122         }
123         t10_alua_tg_pt_gp_mem_cache = kmem_cache_create(
124                         "t10_alua_tg_pt_gp_mem_cache",
125                         sizeof(struct t10_alua_tg_pt_gp_member),
126                         __alignof__(struct t10_alua_tg_pt_gp_member),
127                         0, NULL);
128         if (!t10_alua_tg_pt_gp_mem_cache) {
129                 pr_err("kmem_cache_create() for t10_alua_tg_pt_gp_"
130                                 "mem_t failed\n");
131                 goto out_free_tg_pt_gp_cache;
132         }
133         t10_alua_lba_map_cache = kmem_cache_create(
134                         "t10_alua_lba_map_cache",
135                         sizeof(struct t10_alua_lba_map),
136                         __alignof__(struct t10_alua_lba_map), 0, NULL);
137         if (!t10_alua_lba_map_cache) {
138                 pr_err("kmem_cache_create() for t10_alua_lba_map_"
139                                 "cache failed\n");
140                 goto out_free_tg_pt_gp_mem_cache;
141         }
142         t10_alua_lba_map_mem_cache = kmem_cache_create(
143                         "t10_alua_lba_map_mem_cache",
144                         sizeof(struct t10_alua_lba_map_member),
145                         __alignof__(struct t10_alua_lba_map_member), 0, NULL);
146         if (!t10_alua_lba_map_mem_cache) {
147                 pr_err("kmem_cache_create() for t10_alua_lba_map_mem_"
148                                 "cache failed\n");
149                 goto out_free_lba_map_cache;
150         }
151
152         target_completion_wq = alloc_workqueue("target_completion",
153                                                WQ_MEM_RECLAIM, 0);
154         if (!target_completion_wq)
155                 goto out_free_lba_map_mem_cache;
156
157         return 0;
158
159 out_free_lba_map_mem_cache:
160         kmem_cache_destroy(t10_alua_lba_map_mem_cache);
161 out_free_lba_map_cache:
162         kmem_cache_destroy(t10_alua_lba_map_cache);
163 out_free_tg_pt_gp_mem_cache:
164         kmem_cache_destroy(t10_alua_tg_pt_gp_mem_cache);
165 out_free_tg_pt_gp_cache:
166         kmem_cache_destroy(t10_alua_tg_pt_gp_cache);
167 out_free_lu_gp_mem_cache:
168         kmem_cache_destroy(t10_alua_lu_gp_mem_cache);
169 out_free_lu_gp_cache:
170         kmem_cache_destroy(t10_alua_lu_gp_cache);
171 out_free_pr_reg_cache:
172         kmem_cache_destroy(t10_pr_reg_cache);
173 out_free_ua_cache:
174         kmem_cache_destroy(se_ua_cache);
175 out_free_sess_cache:
176         kmem_cache_destroy(se_sess_cache);
177 out:
178         return -ENOMEM;
179 }
180
181 void release_se_kmem_caches(void)
182 {
183         destroy_workqueue(target_completion_wq);
184         kmem_cache_destroy(se_sess_cache);
185         kmem_cache_destroy(se_ua_cache);
186         kmem_cache_destroy(t10_pr_reg_cache);
187         kmem_cache_destroy(t10_alua_lu_gp_cache);
188         kmem_cache_destroy(t10_alua_lu_gp_mem_cache);
189         kmem_cache_destroy(t10_alua_tg_pt_gp_cache);
190         kmem_cache_destroy(t10_alua_tg_pt_gp_mem_cache);
191         kmem_cache_destroy(t10_alua_lba_map_cache);
192         kmem_cache_destroy(t10_alua_lba_map_mem_cache);
193 }
194
195 /* This code ensures unique mib indexes are handed out. */
196 static DEFINE_SPINLOCK(scsi_mib_index_lock);
197 static u32 scsi_mib_index[SCSI_INDEX_TYPE_MAX];
198
199 /*
200  * Allocate a new row index for the entry type specified
201  */
202 u32 scsi_get_new_index(scsi_index_t type)
203 {
204         u32 new_index;
205
206         BUG_ON((type < 0) || (type >= SCSI_INDEX_TYPE_MAX));
207
208         spin_lock(&scsi_mib_index_lock);
209         new_index = ++scsi_mib_index[type];
210         spin_unlock(&scsi_mib_index_lock);
211
212         return new_index;
213 }
214
215 void transport_subsystem_check_init(void)
216 {
217         int ret;
218         static int sub_api_initialized;
219
220         if (sub_api_initialized)
221                 return;
222
223         ret = request_module("target_core_iblock");
224         if (ret != 0)
225                 pr_err("Unable to load target_core_iblock\n");
226
227         ret = request_module("target_core_file");
228         if (ret != 0)
229                 pr_err("Unable to load target_core_file\n");
230
231         ret = request_module("target_core_pscsi");
232         if (ret != 0)
233                 pr_err("Unable to load target_core_pscsi\n");
234
235         sub_api_initialized = 1;
236 }
237
238 struct se_session *transport_init_session(void)
239 {
240         struct se_session *se_sess;
241
242         se_sess = kmem_cache_zalloc(se_sess_cache, GFP_KERNEL);
243         if (!se_sess) {
244                 pr_err("Unable to allocate struct se_session from"
245                                 " se_sess_cache\n");
246                 return ERR_PTR(-ENOMEM);
247         }
248         INIT_LIST_HEAD(&se_sess->sess_list);
249         INIT_LIST_HEAD(&se_sess->sess_acl_list);
250         INIT_LIST_HEAD(&se_sess->sess_cmd_list);
251         INIT_LIST_HEAD(&se_sess->sess_wait_list);
252         spin_lock_init(&se_sess->sess_cmd_lock);
253         kref_init(&se_sess->sess_kref);
254
255         return se_sess;
256 }
257 EXPORT_SYMBOL(transport_init_session);
258
259 int transport_alloc_session_tags(struct se_session *se_sess,
260                                  unsigned int tag_num, unsigned int tag_size)
261 {
262         int rc;
263
264         se_sess->sess_cmd_map = kzalloc(tag_num * tag_size,
265                                         GFP_KERNEL | __GFP_NOWARN | __GFP_REPEAT);
266         if (!se_sess->sess_cmd_map) {
267                 se_sess->sess_cmd_map = vzalloc(tag_num * tag_size);
268                 if (!se_sess->sess_cmd_map) {
269                         pr_err("Unable to allocate se_sess->sess_cmd_map\n");
270                         return -ENOMEM;
271                 }
272         }
273
274         rc = percpu_ida_init(&se_sess->sess_tag_pool, tag_num);
275         if (rc < 0) {
276                 pr_err("Unable to init se_sess->sess_tag_pool,"
277                         " tag_num: %u\n", tag_num);
278                 if (is_vmalloc_addr(se_sess->sess_cmd_map))
279                         vfree(se_sess->sess_cmd_map);
280                 else
281                         kfree(se_sess->sess_cmd_map);
282                 se_sess->sess_cmd_map = NULL;
283                 return -ENOMEM;
284         }
285
286         return 0;
287 }
288 EXPORT_SYMBOL(transport_alloc_session_tags);
289
290 struct se_session *transport_init_session_tags(unsigned int tag_num,
291                                                unsigned int tag_size)
292 {
293         struct se_session *se_sess;
294         int rc;
295
296         se_sess = transport_init_session();
297         if (IS_ERR(se_sess))
298                 return se_sess;
299
300         rc = transport_alloc_session_tags(se_sess, tag_num, tag_size);
301         if (rc < 0) {
302                 transport_free_session(se_sess);
303                 return ERR_PTR(-ENOMEM);
304         }
305
306         return se_sess;
307 }
308 EXPORT_SYMBOL(transport_init_session_tags);
309
310 /*
311  * Called with spin_lock_irqsave(&struct se_portal_group->session_lock called.
312  */
313 void __transport_register_session(
314         struct se_portal_group *se_tpg,
315         struct se_node_acl *se_nacl,
316         struct se_session *se_sess,
317         void *fabric_sess_ptr)
318 {
319         unsigned char buf[PR_REG_ISID_LEN];
320
321         se_sess->se_tpg = se_tpg;
322         se_sess->fabric_sess_ptr = fabric_sess_ptr;
323         /*
324          * Used by struct se_node_acl's under ConfigFS to locate active se_session-t
325          *
326          * Only set for struct se_session's that will actually be moving I/O.
327          * eg: *NOT* discovery sessions.
328          */
329         if (se_nacl) {
330                 /*
331                  * If the fabric module supports an ISID based TransportID,
332                  * save this value in binary from the fabric I_T Nexus now.
333                  */
334                 if (se_tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
335                         memset(&buf[0], 0, PR_REG_ISID_LEN);
336                         se_tpg->se_tpg_tfo->sess_get_initiator_sid(se_sess,
337                                         &buf[0], PR_REG_ISID_LEN);
338                         se_sess->sess_bin_isid = get_unaligned_be64(&buf[0]);
339                 }
340                 kref_get(&se_nacl->acl_kref);
341
342                 spin_lock_irq(&se_nacl->nacl_sess_lock);
343                 /*
344                  * The se_nacl->nacl_sess pointer will be set to the
345                  * last active I_T Nexus for each struct se_node_acl.
346                  */
347                 se_nacl->nacl_sess = se_sess;
348
349                 list_add_tail(&se_sess->sess_acl_list,
350                               &se_nacl->acl_sess_list);
351                 spin_unlock_irq(&se_nacl->nacl_sess_lock);
352         }
353         list_add_tail(&se_sess->sess_list, &se_tpg->tpg_sess_list);
354
355         pr_debug("TARGET_CORE[%s]: Registered fabric_sess_ptr: %p\n",
356                 se_tpg->se_tpg_tfo->get_fabric_name(), se_sess->fabric_sess_ptr);
357 }
358 EXPORT_SYMBOL(__transport_register_session);
359
360 void transport_register_session(
361         struct se_portal_group *se_tpg,
362         struct se_node_acl *se_nacl,
363         struct se_session *se_sess,
364         void *fabric_sess_ptr)
365 {
366         unsigned long flags;
367
368         spin_lock_irqsave(&se_tpg->session_lock, flags);
369         __transport_register_session(se_tpg, se_nacl, se_sess, fabric_sess_ptr);
370         spin_unlock_irqrestore(&se_tpg->session_lock, flags);
371 }
372 EXPORT_SYMBOL(transport_register_session);
373
374 static void target_release_session(struct kref *kref)
375 {
376         struct se_session *se_sess = container_of(kref,
377                         struct se_session, sess_kref);
378         struct se_portal_group *se_tpg = se_sess->se_tpg;
379
380         se_tpg->se_tpg_tfo->close_session(se_sess);
381 }
382
383 void target_get_session(struct se_session *se_sess)
384 {
385         kref_get(&se_sess->sess_kref);
386 }
387 EXPORT_SYMBOL(target_get_session);
388
389 void target_put_session(struct se_session *se_sess)
390 {
391         struct se_portal_group *tpg = se_sess->se_tpg;
392
393         if (tpg->se_tpg_tfo->put_session != NULL) {
394                 tpg->se_tpg_tfo->put_session(se_sess);
395                 return;
396         }
397         kref_put(&se_sess->sess_kref, target_release_session);
398 }
399 EXPORT_SYMBOL(target_put_session);
400
401 static void target_complete_nacl(struct kref *kref)
402 {
403         struct se_node_acl *nacl = container_of(kref,
404                                 struct se_node_acl, acl_kref);
405
406         complete(&nacl->acl_free_comp);
407 }
408
409 void target_put_nacl(struct se_node_acl *nacl)
410 {
411         kref_put(&nacl->acl_kref, target_complete_nacl);
412 }
413
414 void transport_deregister_session_configfs(struct se_session *se_sess)
415 {
416         struct se_node_acl *se_nacl;
417         unsigned long flags;
418         /*
419          * Used by struct se_node_acl's under ConfigFS to locate active struct se_session
420          */
421         se_nacl = se_sess->se_node_acl;
422         if (se_nacl) {
423                 spin_lock_irqsave(&se_nacl->nacl_sess_lock, flags);
424                 if (se_nacl->acl_stop == 0)
425                         list_del(&se_sess->sess_acl_list);
426                 /*
427                  * If the session list is empty, then clear the pointer.
428                  * Otherwise, set the struct se_session pointer from the tail
429                  * element of the per struct se_node_acl active session list.
430                  */
431                 if (list_empty(&se_nacl->acl_sess_list))
432                         se_nacl->nacl_sess = NULL;
433                 else {
434                         se_nacl->nacl_sess = container_of(
435                                         se_nacl->acl_sess_list.prev,
436                                         struct se_session, sess_acl_list);
437                 }
438                 spin_unlock_irqrestore(&se_nacl->nacl_sess_lock, flags);
439         }
440 }
441 EXPORT_SYMBOL(transport_deregister_session_configfs);
442
443 void transport_free_session(struct se_session *se_sess)
444 {
445         if (se_sess->sess_cmd_map) {
446                 percpu_ida_destroy(&se_sess->sess_tag_pool);
447                 if (is_vmalloc_addr(se_sess->sess_cmd_map))
448                         vfree(se_sess->sess_cmd_map);
449                 else
450                         kfree(se_sess->sess_cmd_map);
451         }
452         kmem_cache_free(se_sess_cache, se_sess);
453 }
454 EXPORT_SYMBOL(transport_free_session);
455
456 void transport_deregister_session(struct se_session *se_sess)
457 {
458         struct se_portal_group *se_tpg = se_sess->se_tpg;
459         struct target_core_fabric_ops *se_tfo;
460         struct se_node_acl *se_nacl;
461         unsigned long flags;
462         bool comp_nacl = true;
463
464         if (!se_tpg) {
465                 transport_free_session(se_sess);
466                 return;
467         }
468         se_tfo = se_tpg->se_tpg_tfo;
469
470         spin_lock_irqsave(&se_tpg->session_lock, flags);
471         list_del(&se_sess->sess_list);
472         se_sess->se_tpg = NULL;
473         se_sess->fabric_sess_ptr = NULL;
474         spin_unlock_irqrestore(&se_tpg->session_lock, flags);
475
476         /*
477          * Determine if we need to do extra work for this initiator node's
478          * struct se_node_acl if it had been previously dynamically generated.
479          */
480         se_nacl = se_sess->se_node_acl;
481
482         spin_lock_irqsave(&se_tpg->acl_node_lock, flags);
483         if (se_nacl && se_nacl->dynamic_node_acl) {
484                 if (!se_tfo->tpg_check_demo_mode_cache(se_tpg)) {
485                         list_del(&se_nacl->acl_list);
486                         se_tpg->num_node_acls--;
487                         spin_unlock_irqrestore(&se_tpg->acl_node_lock, flags);
488                         core_tpg_wait_for_nacl_pr_ref(se_nacl);
489                         core_free_device_list_for_node(se_nacl, se_tpg);
490                         se_tfo->tpg_release_fabric_acl(se_tpg, se_nacl);
491
492                         comp_nacl = false;
493                         spin_lock_irqsave(&se_tpg->acl_node_lock, flags);
494                 }
495         }
496         spin_unlock_irqrestore(&se_tpg->acl_node_lock, flags);
497
498         pr_debug("TARGET_CORE[%s]: Deregistered fabric_sess\n",
499                 se_tpg->se_tpg_tfo->get_fabric_name());
500         /*
501          * If last kref is dropping now for an explicit NodeACL, awake sleeping
502          * ->acl_free_comp caller to wakeup configfs se_node_acl->acl_group
503          * removal context.
504          */
505         if (se_nacl && comp_nacl == true)
506                 target_put_nacl(se_nacl);
507
508         transport_free_session(se_sess);
509 }
510 EXPORT_SYMBOL(transport_deregister_session);
511
512 /*
513  * Called with cmd->t_state_lock held.
514  */
515 static void target_remove_from_state_list(struct se_cmd *cmd)
516 {
517         struct se_device *dev = cmd->se_dev;
518         unsigned long flags;
519
520         if (!dev)
521                 return;
522
523         if (cmd->transport_state & CMD_T_BUSY)
524                 return;
525
526         spin_lock_irqsave(&dev->execute_task_lock, flags);
527         if (cmd->state_active) {
528                 list_del(&cmd->state_list);
529                 cmd->state_active = false;
530         }
531         spin_unlock_irqrestore(&dev->execute_task_lock, flags);
532 }
533
534 static int transport_cmd_check_stop(struct se_cmd *cmd, bool remove_from_lists,
535                                     bool write_pending)
536 {
537         unsigned long flags;
538
539         spin_lock_irqsave(&cmd->t_state_lock, flags);
540         if (write_pending)
541                 cmd->t_state = TRANSPORT_WRITE_PENDING;
542
543         if (remove_from_lists) {
544                 target_remove_from_state_list(cmd);
545
546                 /*
547                  * Clear struct se_cmd->se_lun before the handoff to FE.
548                  */
549                 cmd->se_lun = NULL;
550         }
551
552         /*
553          * Determine if frontend context caller is requesting the stopping of
554          * this command for frontend exceptions.
555          */
556         if (cmd->transport_state & CMD_T_STOP) {
557                 pr_debug("%s:%d CMD_T_STOP for ITT: 0x%08x\n",
558                         __func__, __LINE__,
559                         cmd->se_tfo->get_task_tag(cmd));
560
561                 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
562
563                 complete_all(&cmd->t_transport_stop_comp);
564                 return 1;
565         }
566
567         cmd->transport_state &= ~CMD_T_ACTIVE;
568         if (remove_from_lists) {
569                 /*
570                  * Some fabric modules like tcm_loop can release
571                  * their internally allocated I/O reference now and
572                  * struct se_cmd now.
573                  *
574                  * Fabric modules are expected to return '1' here if the
575                  * se_cmd being passed is released at this point,
576                  * or zero if not being released.
577                  */
578                 if (cmd->se_tfo->check_stop_free != NULL) {
579                         spin_unlock_irqrestore(&cmd->t_state_lock, flags);
580                         return cmd->se_tfo->check_stop_free(cmd);
581                 }
582         }
583
584         spin_unlock_irqrestore(&cmd->t_state_lock, flags);
585         return 0;
586 }
587
588 static int transport_cmd_check_stop_to_fabric(struct se_cmd *cmd)
589 {
590         return transport_cmd_check_stop(cmd, true, false);
591 }
592
593 static void transport_lun_remove_cmd(struct se_cmd *cmd)
594 {
595         struct se_lun *lun = cmd->se_lun;
596
597         if (!lun)
598                 return;
599
600         if (cmpxchg(&cmd->lun_ref_active, true, false))
601                 percpu_ref_put(&lun->lun_ref);
602 }
603
604 void transport_cmd_finish_abort(struct se_cmd *cmd, int remove)
605 {
606         if (transport_cmd_check_stop_to_fabric(cmd))
607                 return;
608         if (remove)
609                 transport_put_cmd(cmd);
610 }
611
612 static void target_complete_failure_work(struct work_struct *work)
613 {
614         struct se_cmd *cmd = container_of(work, struct se_cmd, work);
615
616         transport_generic_request_failure(cmd,
617                         TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE);
618 }
619
620 /*
621  * Used when asking transport to copy Sense Data from the underlying
622  * Linux/SCSI struct scsi_cmnd
623  */
624 static unsigned char *transport_get_sense_buffer(struct se_cmd *cmd)
625 {
626         struct se_device *dev = cmd->se_dev;
627
628         WARN_ON(!cmd->se_lun);
629
630         if (!dev)
631                 return NULL;
632
633         if (cmd->se_cmd_flags & SCF_SENT_CHECK_CONDITION)
634                 return NULL;
635
636         cmd->scsi_sense_length = TRANSPORT_SENSE_BUFFER;
637
638         pr_debug("HBA_[%u]_PLUG[%s]: Requesting sense for SAM STATUS: 0x%02x\n",
639                 dev->se_hba->hba_id, dev->transport->name, cmd->scsi_status);
640         return cmd->sense_buffer;
641 }
642
643 void target_complete_cmd(struct se_cmd *cmd, u8 scsi_status)
644 {
645         struct se_device *dev = cmd->se_dev;
646         int success = scsi_status == GOOD;
647         unsigned long flags;
648
649         cmd->scsi_status = scsi_status;
650
651
652         spin_lock_irqsave(&cmd->t_state_lock, flags);
653         cmd->transport_state &= ~CMD_T_BUSY;
654
655         if (dev && dev->transport->transport_complete) {
656                 dev->transport->transport_complete(cmd,
657                                 cmd->t_data_sg,
658                                 transport_get_sense_buffer(cmd));
659                 if (cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE)
660                         success = 1;
661         }
662
663         /*
664          * See if we are waiting to complete for an exception condition.
665          */
666         if (cmd->transport_state & CMD_T_REQUEST_STOP) {
667                 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
668                 complete(&cmd->task_stop_comp);
669                 return;
670         }
671
672         /*
673          * Check for case where an explicit ABORT_TASK has been received
674          * and transport_wait_for_tasks() will be waiting for completion..
675          */
676         if (cmd->transport_state & CMD_T_ABORTED &&
677             cmd->transport_state & CMD_T_STOP) {
678                 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
679                 complete_all(&cmd->t_transport_stop_comp);
680                 return;
681         } else if (!success) {
682                 INIT_WORK(&cmd->work, target_complete_failure_work);
683         } else {
684                 INIT_WORK(&cmd->work, target_complete_ok_work);
685         }
686
687         cmd->t_state = TRANSPORT_COMPLETE;
688         cmd->transport_state |= (CMD_T_COMPLETE | CMD_T_ACTIVE);
689         spin_unlock_irqrestore(&cmd->t_state_lock, flags);
690
691         queue_work(target_completion_wq, &cmd->work);
692 }
693 EXPORT_SYMBOL(target_complete_cmd);
694
695 static void target_add_to_state_list(struct se_cmd *cmd)
696 {
697         struct se_device *dev = cmd->se_dev;
698         unsigned long flags;
699
700         spin_lock_irqsave(&dev->execute_task_lock, flags);
701         if (!cmd->state_active) {
702                 list_add_tail(&cmd->state_list, &dev->state_list);
703                 cmd->state_active = true;
704         }
705         spin_unlock_irqrestore(&dev->execute_task_lock, flags);
706 }
707
708 /*
709  * Handle QUEUE_FULL / -EAGAIN and -ENOMEM status
710  */
711 static void transport_write_pending_qf(struct se_cmd *cmd);
712 static void transport_complete_qf(struct se_cmd *cmd);
713
714 void target_qf_do_work(struct work_struct *work)
715 {
716         struct se_device *dev = container_of(work, struct se_device,
717                                         qf_work_queue);
718         LIST_HEAD(qf_cmd_list);
719         struct se_cmd *cmd, *cmd_tmp;
720
721         spin_lock_irq(&dev->qf_cmd_lock);
722         list_splice_init(&dev->qf_cmd_list, &qf_cmd_list);
723         spin_unlock_irq(&dev->qf_cmd_lock);
724
725         list_for_each_entry_safe(cmd, cmd_tmp, &qf_cmd_list, se_qf_node) {
726                 list_del(&cmd->se_qf_node);
727                 atomic_dec(&dev->dev_qf_count);
728                 smp_mb__after_atomic_dec();
729
730                 pr_debug("Processing %s cmd: %p QUEUE_FULL in work queue"
731                         " context: %s\n", cmd->se_tfo->get_fabric_name(), cmd,
732                         (cmd->t_state == TRANSPORT_COMPLETE_QF_OK) ? "COMPLETE_OK" :
733                         (cmd->t_state == TRANSPORT_COMPLETE_QF_WP) ? "WRITE_PENDING"
734                         : "UNKNOWN");
735
736                 if (cmd->t_state == TRANSPORT_COMPLETE_QF_WP)
737                         transport_write_pending_qf(cmd);
738                 else if (cmd->t_state == TRANSPORT_COMPLETE_QF_OK)
739                         transport_complete_qf(cmd);
740         }
741 }
742
743 unsigned char *transport_dump_cmd_direction(struct se_cmd *cmd)
744 {
745         switch (cmd->data_direction) {
746         case DMA_NONE:
747                 return "NONE";
748         case DMA_FROM_DEVICE:
749                 return "READ";
750         case DMA_TO_DEVICE:
751                 return "WRITE";
752         case DMA_BIDIRECTIONAL:
753                 return "BIDI";
754         default:
755                 break;
756         }
757
758         return "UNKNOWN";
759 }
760
761 void transport_dump_dev_state(
762         struct se_device *dev,
763         char *b,
764         int *bl)
765 {
766         *bl += sprintf(b + *bl, "Status: ");
767         if (dev->export_count)
768                 *bl += sprintf(b + *bl, "ACTIVATED");
769         else
770                 *bl += sprintf(b + *bl, "DEACTIVATED");
771
772         *bl += sprintf(b + *bl, "  Max Queue Depth: %d", dev->queue_depth);
773         *bl += sprintf(b + *bl, "  SectorSize: %u  HwMaxSectors: %u\n",
774                 dev->dev_attrib.block_size,
775                 dev->dev_attrib.hw_max_sectors);
776         *bl += sprintf(b + *bl, "        ");
777 }
778
779 void transport_dump_vpd_proto_id(
780         struct t10_vpd *vpd,
781         unsigned char *p_buf,
782         int p_buf_len)
783 {
784         unsigned char buf[VPD_TMP_BUF_SIZE];
785         int len;
786
787         memset(buf, 0, VPD_TMP_BUF_SIZE);
788         len = sprintf(buf, "T10 VPD Protocol Identifier: ");
789
790         switch (vpd->protocol_identifier) {
791         case 0x00:
792                 sprintf(buf+len, "Fibre Channel\n");
793                 break;
794         case 0x10:
795                 sprintf(buf+len, "Parallel SCSI\n");
796                 break;
797         case 0x20:
798                 sprintf(buf+len, "SSA\n");
799                 break;
800         case 0x30:
801                 sprintf(buf+len, "IEEE 1394\n");
802                 break;
803         case 0x40:
804                 sprintf(buf+len, "SCSI Remote Direct Memory Access"
805                                 " Protocol\n");
806                 break;
807         case 0x50:
808                 sprintf(buf+len, "Internet SCSI (iSCSI)\n");
809                 break;
810         case 0x60:
811                 sprintf(buf+len, "SAS Serial SCSI Protocol\n");
812                 break;
813         case 0x70:
814                 sprintf(buf+len, "Automation/Drive Interface Transport"
815                                 " Protocol\n");
816                 break;
817         case 0x80:
818                 sprintf(buf+len, "AT Attachment Interface ATA/ATAPI\n");
819                 break;
820         default:
821                 sprintf(buf+len, "Unknown 0x%02x\n",
822                                 vpd->protocol_identifier);
823                 break;
824         }
825
826         if (p_buf)
827                 strncpy(p_buf, buf, p_buf_len);
828         else
829                 pr_debug("%s", buf);
830 }
831
832 void
833 transport_set_vpd_proto_id(struct t10_vpd *vpd, unsigned char *page_83)
834 {
835         /*
836          * Check if the Protocol Identifier Valid (PIV) bit is set..
837          *
838          * from spc3r23.pdf section 7.5.1
839          */
840          if (page_83[1] & 0x80) {
841                 vpd->protocol_identifier = (page_83[0] & 0xf0);
842                 vpd->protocol_identifier_set = 1;
843                 transport_dump_vpd_proto_id(vpd, NULL, 0);
844         }
845 }
846 EXPORT_SYMBOL(transport_set_vpd_proto_id);
847
848 int transport_dump_vpd_assoc(
849         struct t10_vpd *vpd,
850         unsigned char *p_buf,
851         int p_buf_len)
852 {
853         unsigned char buf[VPD_TMP_BUF_SIZE];
854         int ret = 0;
855         int len;
856
857         memset(buf, 0, VPD_TMP_BUF_SIZE);
858         len = sprintf(buf, "T10 VPD Identifier Association: ");
859
860         switch (vpd->association) {
861         case 0x00:
862                 sprintf(buf+len, "addressed logical unit\n");
863                 break;
864         case 0x10:
865                 sprintf(buf+len, "target port\n");
866                 break;
867         case 0x20:
868                 sprintf(buf+len, "SCSI target device\n");
869                 break;
870         default:
871                 sprintf(buf+len, "Unknown 0x%02x\n", vpd->association);
872                 ret = -EINVAL;
873                 break;
874         }
875
876         if (p_buf)
877                 strncpy(p_buf, buf, p_buf_len);
878         else
879                 pr_debug("%s", buf);
880
881         return ret;
882 }
883
884 int transport_set_vpd_assoc(struct t10_vpd *vpd, unsigned char *page_83)
885 {
886         /*
887          * The VPD identification association..
888          *
889          * from spc3r23.pdf Section 7.6.3.1 Table 297
890          */
891         vpd->association = (page_83[1] & 0x30);
892         return transport_dump_vpd_assoc(vpd, NULL, 0);
893 }
894 EXPORT_SYMBOL(transport_set_vpd_assoc);
895
896 int transport_dump_vpd_ident_type(
897         struct t10_vpd *vpd,
898         unsigned char *p_buf,
899         int p_buf_len)
900 {
901         unsigned char buf[VPD_TMP_BUF_SIZE];
902         int ret = 0;
903         int len;
904
905         memset(buf, 0, VPD_TMP_BUF_SIZE);
906         len = sprintf(buf, "T10 VPD Identifier Type: ");
907
908         switch (vpd->device_identifier_type) {
909         case 0x00:
910                 sprintf(buf+len, "Vendor specific\n");
911                 break;
912         case 0x01:
913                 sprintf(buf+len, "T10 Vendor ID based\n");
914                 break;
915         case 0x02:
916                 sprintf(buf+len, "EUI-64 based\n");
917                 break;
918         case 0x03:
919                 sprintf(buf+len, "NAA\n");
920                 break;
921         case 0x04:
922                 sprintf(buf+len, "Relative target port identifier\n");
923                 break;
924         case 0x08:
925                 sprintf(buf+len, "SCSI name string\n");
926                 break;
927         default:
928                 sprintf(buf+len, "Unsupported: 0x%02x\n",
929                                 vpd->device_identifier_type);
930                 ret = -EINVAL;
931                 break;
932         }
933
934         if (p_buf) {
935                 if (p_buf_len < strlen(buf)+1)
936                         return -EINVAL;
937                 strncpy(p_buf, buf, p_buf_len);
938         } else {
939                 pr_debug("%s", buf);
940         }
941
942         return ret;
943 }
944
945 int transport_set_vpd_ident_type(struct t10_vpd *vpd, unsigned char *page_83)
946 {
947         /*
948          * The VPD identifier type..
949          *
950          * from spc3r23.pdf Section 7.6.3.1 Table 298
951          */
952         vpd->device_identifier_type = (page_83[1] & 0x0f);
953         return transport_dump_vpd_ident_type(vpd, NULL, 0);
954 }
955 EXPORT_SYMBOL(transport_set_vpd_ident_type);
956
957 int transport_dump_vpd_ident(
958         struct t10_vpd *vpd,
959         unsigned char *p_buf,
960         int p_buf_len)
961 {
962         unsigned char buf[VPD_TMP_BUF_SIZE];
963         int ret = 0;
964
965         memset(buf, 0, VPD_TMP_BUF_SIZE);
966
967         switch (vpd->device_identifier_code_set) {
968         case 0x01: /* Binary */
969                 snprintf(buf, sizeof(buf),
970                         "T10 VPD Binary Device Identifier: %s\n",
971                         &vpd->device_identifier[0]);
972                 break;
973         case 0x02: /* ASCII */
974                 snprintf(buf, sizeof(buf),
975                         "T10 VPD ASCII Device Identifier: %s\n",
976                         &vpd->device_identifier[0]);
977                 break;
978         case 0x03: /* UTF-8 */
979                 snprintf(buf, sizeof(buf),
980                         "T10 VPD UTF-8 Device Identifier: %s\n",
981                         &vpd->device_identifier[0]);
982                 break;
983         default:
984                 sprintf(buf, "T10 VPD Device Identifier encoding unsupported:"
985                         " 0x%02x", vpd->device_identifier_code_set);
986                 ret = -EINVAL;
987                 break;
988         }
989
990         if (p_buf)
991                 strncpy(p_buf, buf, p_buf_len);
992         else
993                 pr_debug("%s", buf);
994
995         return ret;
996 }
997
998 int
999 transport_set_vpd_ident(struct t10_vpd *vpd, unsigned char *page_83)
1000 {
1001         static const char hex_str[] = "0123456789abcdef";
1002         int j = 0, i = 4; /* offset to start of the identifier */
1003
1004         /*
1005          * The VPD Code Set (encoding)
1006          *
1007          * from spc3r23.pdf Section 7.6.3.1 Table 296
1008          */
1009         vpd->device_identifier_code_set = (page_83[0] & 0x0f);
1010         switch (vpd->device_identifier_code_set) {
1011         case 0x01: /* Binary */
1012                 vpd->device_identifier[j++] =
1013                                 hex_str[vpd->device_identifier_type];
1014                 while (i < (4 + page_83[3])) {
1015                         vpd->device_identifier[j++] =
1016                                 hex_str[(page_83[i] & 0xf0) >> 4];
1017                         vpd->device_identifier[j++] =
1018                                 hex_str[page_83[i] & 0x0f];
1019                         i++;
1020                 }
1021                 break;
1022         case 0x02: /* ASCII */
1023         case 0x03: /* UTF-8 */
1024                 while (i < (4 + page_83[3]))
1025                         vpd->device_identifier[j++] = page_83[i++];
1026                 break;
1027         default:
1028                 break;
1029         }
1030
1031         return transport_dump_vpd_ident(vpd, NULL, 0);
1032 }
1033 EXPORT_SYMBOL(transport_set_vpd_ident);
1034
1035 sense_reason_t
1036 target_cmd_size_check(struct se_cmd *cmd, unsigned int size)
1037 {
1038         struct se_device *dev = cmd->se_dev;
1039
1040         if (cmd->unknown_data_length) {
1041                 cmd->data_length = size;
1042         } else if (size != cmd->data_length) {
1043                 pr_warn("TARGET_CORE[%s]: Expected Transfer Length:"
1044                         " %u does not match SCSI CDB Length: %u for SAM Opcode:"
1045                         " 0x%02x\n", cmd->se_tfo->get_fabric_name(),
1046                                 cmd->data_length, size, cmd->t_task_cdb[0]);
1047
1048                 if (cmd->data_direction == DMA_TO_DEVICE) {
1049                         pr_err("Rejecting underflow/overflow"
1050                                         " WRITE data\n");
1051                         return TCM_INVALID_CDB_FIELD;
1052                 }
1053                 /*
1054                  * Reject READ_* or WRITE_* with overflow/underflow for
1055                  * type SCF_SCSI_DATA_CDB.
1056                  */
1057                 if (dev->dev_attrib.block_size != 512)  {
1058                         pr_err("Failing OVERFLOW/UNDERFLOW for LBA op"
1059                                 " CDB on non 512-byte sector setup subsystem"
1060                                 " plugin: %s\n", dev->transport->name);
1061                         /* Returns CHECK_CONDITION + INVALID_CDB_FIELD */
1062                         return TCM_INVALID_CDB_FIELD;
1063                 }
1064                 /*
1065                  * For the overflow case keep the existing fabric provided
1066                  * ->data_length.  Otherwise for the underflow case, reset
1067                  * ->data_length to the smaller SCSI expected data transfer
1068                  * length.
1069                  */
1070                 if (size > cmd->data_length) {
1071                         cmd->se_cmd_flags |= SCF_OVERFLOW_BIT;
1072                         cmd->residual_count = (size - cmd->data_length);
1073                 } else {
1074                         cmd->se_cmd_flags |= SCF_UNDERFLOW_BIT;
1075                         cmd->residual_count = (cmd->data_length - size);
1076                         cmd->data_length = size;
1077                 }
1078         }
1079
1080         return 0;
1081
1082 }
1083
1084 /*
1085  * Used by fabric modules containing a local struct se_cmd within their
1086  * fabric dependent per I/O descriptor.
1087  */
1088 void transport_init_se_cmd(
1089         struct se_cmd *cmd,
1090         struct target_core_fabric_ops *tfo,
1091         struct se_session *se_sess,
1092         u32 data_length,
1093         int data_direction,
1094         int task_attr,
1095         unsigned char *sense_buffer)
1096 {
1097         INIT_LIST_HEAD(&cmd->se_delayed_node);
1098         INIT_LIST_HEAD(&cmd->se_qf_node);
1099         INIT_LIST_HEAD(&cmd->se_cmd_list);
1100         INIT_LIST_HEAD(&cmd->state_list);
1101         init_completion(&cmd->t_transport_stop_comp);
1102         init_completion(&cmd->cmd_wait_comp);
1103         init_completion(&cmd->task_stop_comp);
1104         spin_lock_init(&cmd->t_state_lock);
1105         kref_init(&cmd->cmd_kref);
1106         cmd->transport_state = CMD_T_DEV_ACTIVE;
1107
1108         cmd->se_tfo = tfo;
1109         cmd->se_sess = se_sess;
1110         cmd->data_length = data_length;
1111         cmd->data_direction = data_direction;
1112         cmd->sam_task_attr = task_attr;
1113         cmd->sense_buffer = sense_buffer;
1114
1115         cmd->state_active = false;
1116 }
1117 EXPORT_SYMBOL(transport_init_se_cmd);
1118
1119 static sense_reason_t
1120 transport_check_alloc_task_attr(struct se_cmd *cmd)
1121 {
1122         struct se_device *dev = cmd->se_dev;
1123
1124         /*
1125          * Check if SAM Task Attribute emulation is enabled for this
1126          * struct se_device storage object
1127          */
1128         if (dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV)
1129                 return 0;
1130
1131         if (cmd->sam_task_attr == MSG_ACA_TAG) {
1132                 pr_debug("SAM Task Attribute ACA"
1133                         " emulation is not supported\n");
1134                 return TCM_INVALID_CDB_FIELD;
1135         }
1136         /*
1137          * Used to determine when ORDERED commands should go from
1138          * Dormant to Active status.
1139          */
1140         cmd->se_ordered_id = atomic_inc_return(&dev->dev_ordered_id);
1141         smp_mb__after_atomic_inc();
1142         pr_debug("Allocated se_ordered_id: %u for Task Attr: 0x%02x on %s\n",
1143                         cmd->se_ordered_id, cmd->sam_task_attr,
1144                         dev->transport->name);
1145         return 0;
1146 }
1147
1148 sense_reason_t
1149 target_setup_cmd_from_cdb(struct se_cmd *cmd, unsigned char *cdb)
1150 {
1151         struct se_device *dev = cmd->se_dev;
1152         sense_reason_t ret;
1153
1154         /*
1155          * Ensure that the received CDB is less than the max (252 + 8) bytes
1156          * for VARIABLE_LENGTH_CMD
1157          */
1158         if (scsi_command_size(cdb) > SCSI_MAX_VARLEN_CDB_SIZE) {
1159                 pr_err("Received SCSI CDB with command_size: %d that"
1160                         " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1161                         scsi_command_size(cdb), SCSI_MAX_VARLEN_CDB_SIZE);
1162                 return TCM_INVALID_CDB_FIELD;
1163         }
1164         /*
1165          * If the received CDB is larger than TCM_MAX_COMMAND_SIZE,
1166          * allocate the additional extended CDB buffer now..  Otherwise
1167          * setup the pointer from __t_task_cdb to t_task_cdb.
1168          */
1169         if (scsi_command_size(cdb) > sizeof(cmd->__t_task_cdb)) {
1170                 cmd->t_task_cdb = kzalloc(scsi_command_size(cdb),
1171                                                 GFP_KERNEL);
1172                 if (!cmd->t_task_cdb) {
1173                         pr_err("Unable to allocate cmd->t_task_cdb"
1174                                 " %u > sizeof(cmd->__t_task_cdb): %lu ops\n",
1175                                 scsi_command_size(cdb),
1176                                 (unsigned long)sizeof(cmd->__t_task_cdb));
1177                         return TCM_OUT_OF_RESOURCES;
1178                 }
1179         } else
1180                 cmd->t_task_cdb = &cmd->__t_task_cdb[0];
1181         /*
1182          * Copy the original CDB into cmd->
1183          */
1184         memcpy(cmd->t_task_cdb, cdb, scsi_command_size(cdb));
1185
1186         trace_target_sequencer_start(cmd);
1187
1188         /*
1189          * Check for an existing UNIT ATTENTION condition
1190          */
1191         ret = target_scsi3_ua_check(cmd);
1192         if (ret)
1193                 return ret;
1194
1195         ret = target_alua_state_check(cmd);
1196         if (ret)
1197                 return ret;
1198
1199         ret = target_check_reservation(cmd);
1200         if (ret) {
1201                 cmd->scsi_status = SAM_STAT_RESERVATION_CONFLICT;
1202                 return ret;
1203         }
1204
1205         ret = dev->transport->parse_cdb(cmd);
1206         if (ret)
1207                 return ret;
1208
1209         ret = transport_check_alloc_task_attr(cmd);
1210         if (ret)
1211                 return ret;
1212
1213         cmd->se_cmd_flags |= SCF_SUPPORTED_SAM_OPCODE;
1214
1215         spin_lock(&cmd->se_lun->lun_sep_lock);
1216         if (cmd->se_lun->lun_sep)
1217                 cmd->se_lun->lun_sep->sep_stats.cmd_pdus++;
1218         spin_unlock(&cmd->se_lun->lun_sep_lock);
1219         return 0;
1220 }
1221 EXPORT_SYMBOL(target_setup_cmd_from_cdb);
1222
1223 /*
1224  * Used by fabric module frontends to queue tasks directly.
1225  * Many only be used from process context only
1226  */
1227 int transport_handle_cdb_direct(
1228         struct se_cmd *cmd)
1229 {
1230         sense_reason_t ret;
1231
1232         if (!cmd->se_lun) {
1233                 dump_stack();
1234                 pr_err("cmd->se_lun is NULL\n");
1235                 return -EINVAL;
1236         }
1237         if (in_interrupt()) {
1238                 dump_stack();
1239                 pr_err("transport_generic_handle_cdb cannot be called"
1240                                 " from interrupt context\n");
1241                 return -EINVAL;
1242         }
1243         /*
1244          * Set TRANSPORT_NEW_CMD state and CMD_T_ACTIVE to ensure that
1245          * outstanding descriptors are handled correctly during shutdown via
1246          * transport_wait_for_tasks()
1247          *
1248          * Also, we don't take cmd->t_state_lock here as we only expect
1249          * this to be called for initial descriptor submission.
1250          */
1251         cmd->t_state = TRANSPORT_NEW_CMD;
1252         cmd->transport_state |= CMD_T_ACTIVE;
1253
1254         /*
1255          * transport_generic_new_cmd() is already handling QUEUE_FULL,
1256          * so follow TRANSPORT_NEW_CMD processing thread context usage
1257          * and call transport_generic_request_failure() if necessary..
1258          */
1259         ret = transport_generic_new_cmd(cmd);
1260         if (ret)
1261                 transport_generic_request_failure(cmd, ret);
1262         return 0;
1263 }
1264 EXPORT_SYMBOL(transport_handle_cdb_direct);
1265
1266 sense_reason_t
1267 transport_generic_map_mem_to_cmd(struct se_cmd *cmd, struct scatterlist *sgl,
1268                 u32 sgl_count, struct scatterlist *sgl_bidi, u32 sgl_bidi_count)
1269 {
1270         if (!sgl || !sgl_count)
1271                 return 0;
1272
1273         /*
1274          * Reject SCSI data overflow with map_mem_to_cmd() as incoming
1275          * scatterlists already have been set to follow what the fabric
1276          * passes for the original expected data transfer length.
1277          */
1278         if (cmd->se_cmd_flags & SCF_OVERFLOW_BIT) {
1279                 pr_warn("Rejecting SCSI DATA overflow for fabric using"
1280                         " SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC\n");
1281                 return TCM_INVALID_CDB_FIELD;
1282         }
1283
1284         cmd->t_data_sg = sgl;
1285         cmd->t_data_nents = sgl_count;
1286
1287         if (sgl_bidi && sgl_bidi_count) {
1288                 cmd->t_bidi_data_sg = sgl_bidi;
1289                 cmd->t_bidi_data_nents = sgl_bidi_count;
1290         }
1291         cmd->se_cmd_flags |= SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
1292         return 0;
1293 }
1294
1295 /*
1296  * target_submit_cmd_map_sgls - lookup unpacked lun and submit uninitialized
1297  *                       se_cmd + use pre-allocated SGL memory.
1298  *
1299  * @se_cmd: command descriptor to submit
1300  * @se_sess: associated se_sess for endpoint
1301  * @cdb: pointer to SCSI CDB
1302  * @sense: pointer to SCSI sense buffer
1303  * @unpacked_lun: unpacked LUN to reference for struct se_lun
1304  * @data_length: fabric expected data transfer length
1305  * @task_addr: SAM task attribute
1306  * @data_dir: DMA data direction
1307  * @flags: flags for command submission from target_sc_flags_tables
1308  * @sgl: struct scatterlist memory for unidirectional mapping
1309  * @sgl_count: scatterlist count for unidirectional mapping
1310  * @sgl_bidi: struct scatterlist memory for bidirectional READ mapping
1311  * @sgl_bidi_count: scatterlist count for bidirectional READ mapping
1312  * @sgl_prot: struct scatterlist memory protection information
1313  * @sgl_prot_count: scatterlist count for protection information
1314  *
1315  * Returns non zero to signal active I/O shutdown failure.  All other
1316  * setup exceptions will be returned as a SCSI CHECK_CONDITION response,
1317  * but still return zero here.
1318  *
1319  * This may only be called from process context, and also currently
1320  * assumes internal allocation of fabric payload buffer by target-core.
1321  */
1322 int target_submit_cmd_map_sgls(struct se_cmd *se_cmd, struct se_session *se_sess,
1323                 unsigned char *cdb, unsigned char *sense, u32 unpacked_lun,
1324                 u32 data_length, int task_attr, int data_dir, int flags,
1325                 struct scatterlist *sgl, u32 sgl_count,
1326                 struct scatterlist *sgl_bidi, u32 sgl_bidi_count,
1327                 struct scatterlist *sgl_prot, u32 sgl_prot_count)
1328 {
1329         struct se_portal_group *se_tpg;
1330         sense_reason_t rc;
1331         int ret;
1332
1333         se_tpg = se_sess->se_tpg;
1334         BUG_ON(!se_tpg);
1335         BUG_ON(se_cmd->se_tfo || se_cmd->se_sess);
1336         BUG_ON(in_interrupt());
1337         /*
1338          * Initialize se_cmd for target operation.  From this point
1339          * exceptions are handled by sending exception status via
1340          * target_core_fabric_ops->queue_status() callback
1341          */
1342         transport_init_se_cmd(se_cmd, se_tpg->se_tpg_tfo, se_sess,
1343                                 data_length, data_dir, task_attr, sense);
1344         if (flags & TARGET_SCF_UNKNOWN_SIZE)
1345                 se_cmd->unknown_data_length = 1;
1346         /*
1347          * Obtain struct se_cmd->cmd_kref reference and add new cmd to
1348          * se_sess->sess_cmd_list.  A second kref_get here is necessary
1349          * for fabrics using TARGET_SCF_ACK_KREF that expect a second
1350          * kref_put() to happen during fabric packet acknowledgement.
1351          */
1352         ret = target_get_sess_cmd(se_sess, se_cmd, (flags & TARGET_SCF_ACK_KREF));
1353         if (ret)
1354                 return ret;
1355         /*
1356          * Signal bidirectional data payloads to target-core
1357          */
1358         if (flags & TARGET_SCF_BIDI_OP)
1359                 se_cmd->se_cmd_flags |= SCF_BIDI;
1360         /*
1361          * Locate se_lun pointer and attach it to struct se_cmd
1362          */
1363         rc = transport_lookup_cmd_lun(se_cmd, unpacked_lun);
1364         if (rc) {
1365                 transport_send_check_condition_and_sense(se_cmd, rc, 0);
1366                 target_put_sess_cmd(se_sess, se_cmd);
1367                 return 0;
1368         }
1369         /*
1370          * Save pointers for SGLs containing protection information,
1371          * if present.
1372          */
1373         if (sgl_prot_count) {
1374                 se_cmd->t_prot_sg = sgl_prot;
1375                 se_cmd->t_prot_nents = sgl_prot_count;
1376         }
1377
1378         rc = target_setup_cmd_from_cdb(se_cmd, cdb);
1379         if (rc != 0) {
1380                 transport_generic_request_failure(se_cmd, rc);
1381                 return 0;
1382         }
1383         /*
1384          * When a non zero sgl_count has been passed perform SGL passthrough
1385          * mapping for pre-allocated fabric memory instead of having target
1386          * core perform an internal SGL allocation..
1387          */
1388         if (sgl_count != 0) {
1389                 BUG_ON(!sgl);
1390
1391                 /*
1392                  * A work-around for tcm_loop as some userspace code via
1393                  * scsi-generic do not memset their associated read buffers,
1394                  * so go ahead and do that here for type non-data CDBs.  Also
1395                  * note that this is currently guaranteed to be a single SGL
1396                  * for this case by target core in target_setup_cmd_from_cdb()
1397                  * -> transport_generic_cmd_sequencer().
1398                  */
1399                 if (!(se_cmd->se_cmd_flags & SCF_SCSI_DATA_CDB) &&
1400                      se_cmd->data_direction == DMA_FROM_DEVICE) {
1401                         unsigned char *buf = NULL;
1402
1403                         if (sgl)
1404                                 buf = kmap(sg_page(sgl)) + sgl->offset;
1405
1406                         if (buf) {
1407                                 memset(buf, 0, sgl->length);
1408                                 kunmap(sg_page(sgl));
1409                         }
1410                 }
1411
1412                 rc = transport_generic_map_mem_to_cmd(se_cmd, sgl, sgl_count,
1413                                 sgl_bidi, sgl_bidi_count);
1414                 if (rc != 0) {
1415                         transport_generic_request_failure(se_cmd, rc);
1416                         return 0;
1417                 }
1418         }
1419
1420         /*
1421          * Check if we need to delay processing because of ALUA
1422          * Active/NonOptimized primary access state..
1423          */
1424         core_alua_check_nonop_delay(se_cmd);
1425
1426         transport_handle_cdb_direct(se_cmd);
1427         return 0;
1428 }
1429 EXPORT_SYMBOL(target_submit_cmd_map_sgls);
1430
1431 /*
1432  * target_submit_cmd - lookup unpacked lun and submit uninitialized se_cmd
1433  *
1434  * @se_cmd: command descriptor to submit
1435  * @se_sess: associated se_sess for endpoint
1436  * @cdb: pointer to SCSI CDB
1437  * @sense: pointer to SCSI sense buffer
1438  * @unpacked_lun: unpacked LUN to reference for struct se_lun
1439  * @data_length: fabric expected data transfer length
1440  * @task_addr: SAM task attribute
1441  * @data_dir: DMA data direction
1442  * @flags: flags for command submission from target_sc_flags_tables
1443  *
1444  * Returns non zero to signal active I/O shutdown failure.  All other
1445  * setup exceptions will be returned as a SCSI CHECK_CONDITION response,
1446  * but still return zero here.
1447  *
1448  * This may only be called from process context, and also currently
1449  * assumes internal allocation of fabric payload buffer by target-core.
1450  *
1451  * It also assumes interal target core SGL memory allocation.
1452  */
1453 int target_submit_cmd(struct se_cmd *se_cmd, struct se_session *se_sess,
1454                 unsigned char *cdb, unsigned char *sense, u32 unpacked_lun,
1455                 u32 data_length, int task_attr, int data_dir, int flags)
1456 {
1457         return target_submit_cmd_map_sgls(se_cmd, se_sess, cdb, sense,
1458                         unpacked_lun, data_length, task_attr, data_dir,
1459                         flags, NULL, 0, NULL, 0, NULL, 0);
1460 }
1461 EXPORT_SYMBOL(target_submit_cmd);
1462
1463 static void target_complete_tmr_failure(struct work_struct *work)
1464 {
1465         struct se_cmd *se_cmd = container_of(work, struct se_cmd, work);
1466
1467         se_cmd->se_tmr_req->response = TMR_LUN_DOES_NOT_EXIST;
1468         se_cmd->se_tfo->queue_tm_rsp(se_cmd);
1469
1470         transport_cmd_check_stop_to_fabric(se_cmd);
1471 }
1472
1473 /**
1474  * target_submit_tmr - lookup unpacked lun and submit uninitialized se_cmd
1475  *                     for TMR CDBs
1476  *
1477  * @se_cmd: command descriptor to submit
1478  * @se_sess: associated se_sess for endpoint
1479  * @sense: pointer to SCSI sense buffer
1480  * @unpacked_lun: unpacked LUN to reference for struct se_lun
1481  * @fabric_context: fabric context for TMR req
1482  * @tm_type: Type of TM request
1483  * @gfp: gfp type for caller
1484  * @tag: referenced task tag for TMR_ABORT_TASK
1485  * @flags: submit cmd flags
1486  *
1487  * Callable from all contexts.
1488  **/
1489
1490 int target_submit_tmr(struct se_cmd *se_cmd, struct se_session *se_sess,
1491                 unsigned char *sense, u32 unpacked_lun,
1492                 void *fabric_tmr_ptr, unsigned char tm_type,
1493                 gfp_t gfp, unsigned int tag, int flags)
1494 {
1495         struct se_portal_group *se_tpg;
1496         int ret;
1497
1498         se_tpg = se_sess->se_tpg;
1499         BUG_ON(!se_tpg);
1500
1501         transport_init_se_cmd(se_cmd, se_tpg->se_tpg_tfo, se_sess,
1502                               0, DMA_NONE, MSG_SIMPLE_TAG, sense);
1503         /*
1504          * FIXME: Currently expect caller to handle se_cmd->se_tmr_req
1505          * allocation failure.
1506          */
1507         ret = core_tmr_alloc_req(se_cmd, fabric_tmr_ptr, tm_type, gfp);
1508         if (ret < 0)
1509                 return -ENOMEM;
1510
1511         if (tm_type == TMR_ABORT_TASK)
1512                 se_cmd->se_tmr_req->ref_task_tag = tag;
1513
1514         /* See target_submit_cmd for commentary */
1515         ret = target_get_sess_cmd(se_sess, se_cmd, (flags & TARGET_SCF_ACK_KREF));
1516         if (ret) {
1517                 core_tmr_release_req(se_cmd->se_tmr_req);
1518                 return ret;
1519         }
1520
1521         ret = transport_lookup_tmr_lun(se_cmd, unpacked_lun);
1522         if (ret) {
1523                 /*
1524                  * For callback during failure handling, push this work off
1525                  * to process context with TMR_LUN_DOES_NOT_EXIST status.
1526                  */
1527                 INIT_WORK(&se_cmd->work, target_complete_tmr_failure);
1528                 schedule_work(&se_cmd->work);
1529                 return 0;
1530         }
1531         transport_generic_handle_tmr(se_cmd);
1532         return 0;
1533 }
1534 EXPORT_SYMBOL(target_submit_tmr);
1535
1536 /*
1537  * If the cmd is active, request it to be stopped and sleep until it
1538  * has completed.
1539  */
1540 bool target_stop_cmd(struct se_cmd *cmd, unsigned long *flags)
1541 {
1542         bool was_active = false;
1543
1544         if (cmd->transport_state & CMD_T_BUSY) {
1545                 cmd->transport_state |= CMD_T_REQUEST_STOP;
1546                 spin_unlock_irqrestore(&cmd->t_state_lock, *flags);
1547
1548                 pr_debug("cmd %p waiting to complete\n", cmd);
1549                 wait_for_completion(&cmd->task_stop_comp);
1550                 pr_debug("cmd %p stopped successfully\n", cmd);
1551
1552                 spin_lock_irqsave(&cmd->t_state_lock, *flags);
1553                 cmd->transport_state &= ~CMD_T_REQUEST_STOP;
1554                 cmd->transport_state &= ~CMD_T_BUSY;
1555                 was_active = true;
1556         }
1557
1558         return was_active;
1559 }
1560
1561 /*
1562  * Handle SAM-esque emulation for generic transport request failures.
1563  */
1564 void transport_generic_request_failure(struct se_cmd *cmd,
1565                 sense_reason_t sense_reason)
1566 {
1567         int ret = 0;
1568
1569         pr_debug("-----[ Storage Engine Exception for cmd: %p ITT: 0x%08x"
1570                 " CDB: 0x%02x\n", cmd, cmd->se_tfo->get_task_tag(cmd),
1571                 cmd->t_task_cdb[0]);
1572         pr_debug("-----[ i_state: %d t_state: %d sense_reason: %d\n",
1573                 cmd->se_tfo->get_cmd_state(cmd),
1574                 cmd->t_state, sense_reason);
1575         pr_debug("-----[ CMD_T_ACTIVE: %d CMD_T_STOP: %d CMD_T_SENT: %d\n",
1576                 (cmd->transport_state & CMD_T_ACTIVE) != 0,
1577                 (cmd->transport_state & CMD_T_STOP) != 0,
1578                 (cmd->transport_state & CMD_T_SENT) != 0);
1579
1580         /*
1581          * For SAM Task Attribute emulation for failed struct se_cmd
1582          */
1583         transport_complete_task_attr(cmd);
1584         /*
1585          * Handle special case for COMPARE_AND_WRITE failure, where the
1586          * callback is expected to drop the per device ->caw_mutex.
1587          */
1588         if ((cmd->se_cmd_flags & SCF_COMPARE_AND_WRITE) &&
1589              cmd->transport_complete_callback)
1590                 cmd->transport_complete_callback(cmd);
1591
1592         switch (sense_reason) {
1593         case TCM_NON_EXISTENT_LUN:
1594         case TCM_UNSUPPORTED_SCSI_OPCODE:
1595         case TCM_INVALID_CDB_FIELD:
1596         case TCM_INVALID_PARAMETER_LIST:
1597         case TCM_PARAMETER_LIST_LENGTH_ERROR:
1598         case TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE:
1599         case TCM_UNKNOWN_MODE_PAGE:
1600         case TCM_WRITE_PROTECTED:
1601         case TCM_ADDRESS_OUT_OF_RANGE:
1602         case TCM_CHECK_CONDITION_ABORT_CMD:
1603         case TCM_CHECK_CONDITION_UNIT_ATTENTION:
1604         case TCM_CHECK_CONDITION_NOT_READY:
1605         case TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED:
1606         case TCM_LOGICAL_BLOCK_APP_TAG_CHECK_FAILED:
1607         case TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED:
1608                 break;
1609         case TCM_OUT_OF_RESOURCES:
1610                 sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1611                 break;
1612         case TCM_RESERVATION_CONFLICT:
1613                 /*
1614                  * No SENSE Data payload for this case, set SCSI Status
1615                  * and queue the response to $FABRIC_MOD.
1616                  *
1617                  * Uses linux/include/scsi/scsi.h SAM status codes defs
1618                  */
1619                 cmd->scsi_status = SAM_STAT_RESERVATION_CONFLICT;
1620                 /*
1621                  * For UA Interlock Code 11b, a RESERVATION CONFLICT will
1622                  * establish a UNIT ATTENTION with PREVIOUS RESERVATION
1623                  * CONFLICT STATUS.
1624                  *
1625                  * See spc4r17, section 7.4.6 Control Mode Page, Table 349
1626                  */
1627                 if (cmd->se_sess &&
1628                     cmd->se_dev->dev_attrib.emulate_ua_intlck_ctrl == 2)
1629                         core_scsi3_ua_allocate(cmd->se_sess->se_node_acl,
1630                                 cmd->orig_fe_lun, 0x2C,
1631                                 ASCQ_2CH_PREVIOUS_RESERVATION_CONFLICT_STATUS);
1632
1633                 trace_target_cmd_complete(cmd);
1634                 ret = cmd->se_tfo-> queue_status(cmd);
1635                 if (ret == -EAGAIN || ret == -ENOMEM)
1636                         goto queue_full;
1637                 goto check_stop;
1638         default:
1639                 pr_err("Unknown transport error for CDB 0x%02x: %d\n",
1640                         cmd->t_task_cdb[0], sense_reason);
1641                 sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1642                 break;
1643         }
1644
1645         ret = transport_send_check_condition_and_sense(cmd, sense_reason, 0);
1646         if (ret == -EAGAIN || ret == -ENOMEM)
1647                 goto queue_full;
1648
1649 check_stop:
1650         transport_lun_remove_cmd(cmd);
1651         if (!transport_cmd_check_stop_to_fabric(cmd))
1652                 ;
1653         return;
1654
1655 queue_full:
1656         cmd->t_state = TRANSPORT_COMPLETE_QF_OK;
1657         transport_handle_queue_full(cmd, cmd->se_dev);
1658 }
1659 EXPORT_SYMBOL(transport_generic_request_failure);
1660
1661 void __target_execute_cmd(struct se_cmd *cmd)
1662 {
1663         sense_reason_t ret;
1664
1665         if (cmd->execute_cmd) {
1666                 ret = cmd->execute_cmd(cmd);
1667                 if (ret) {
1668                         spin_lock_irq(&cmd->t_state_lock);
1669                         cmd->transport_state &= ~(CMD_T_BUSY|CMD_T_SENT);
1670                         spin_unlock_irq(&cmd->t_state_lock);
1671
1672                         transport_generic_request_failure(cmd, ret);
1673                 }
1674         }
1675 }
1676
1677 static bool target_handle_task_attr(struct se_cmd *cmd)
1678 {
1679         struct se_device *dev = cmd->se_dev;
1680
1681         if (dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV)
1682                 return false;
1683
1684         /*
1685          * Check for the existence of HEAD_OF_QUEUE, and if true return 1
1686          * to allow the passed struct se_cmd list of tasks to the front of the list.
1687          */
1688         switch (cmd->sam_task_attr) {
1689         case MSG_HEAD_TAG:
1690                 pr_debug("Added HEAD_OF_QUEUE for CDB: 0x%02x, "
1691                          "se_ordered_id: %u\n",
1692                          cmd->t_task_cdb[0], cmd->se_ordered_id);
1693                 return false;
1694         case MSG_ORDERED_TAG:
1695                 atomic_inc(&dev->dev_ordered_sync);
1696                 smp_mb__after_atomic_inc();
1697
1698                 pr_debug("Added ORDERED for CDB: 0x%02x to ordered list, "
1699                          " se_ordered_id: %u\n",
1700                          cmd->t_task_cdb[0], cmd->se_ordered_id);
1701
1702                 /*
1703                  * Execute an ORDERED command if no other older commands
1704                  * exist that need to be completed first.
1705                  */
1706                 if (!atomic_read(&dev->simple_cmds))
1707                         return false;
1708                 break;
1709         default:
1710                 /*
1711                  * For SIMPLE and UNTAGGED Task Attribute commands
1712                  */
1713                 atomic_inc(&dev->simple_cmds);
1714                 smp_mb__after_atomic_inc();
1715                 break;
1716         }
1717
1718         if (atomic_read(&dev->dev_ordered_sync) == 0)
1719                 return false;
1720
1721         spin_lock(&dev->delayed_cmd_lock);
1722         list_add_tail(&cmd->se_delayed_node, &dev->delayed_cmd_list);
1723         spin_unlock(&dev->delayed_cmd_lock);
1724
1725         pr_debug("Added CDB: 0x%02x Task Attr: 0x%02x to"
1726                 " delayed CMD list, se_ordered_id: %u\n",
1727                 cmd->t_task_cdb[0], cmd->sam_task_attr,
1728                 cmd->se_ordered_id);
1729         return true;
1730 }
1731
1732 void target_execute_cmd(struct se_cmd *cmd)
1733 {
1734         /*
1735          * If the received CDB has aleady been aborted stop processing it here.
1736          */
1737         if (transport_check_aborted_status(cmd, 1))
1738                 return;
1739
1740         /*
1741          * Determine if frontend context caller is requesting the stopping of
1742          * this command for frontend exceptions.
1743          */
1744         spin_lock_irq(&cmd->t_state_lock);
1745         if (cmd->transport_state & CMD_T_STOP) {
1746                 pr_debug("%s:%d CMD_T_STOP for ITT: 0x%08x\n",
1747                         __func__, __LINE__,
1748                         cmd->se_tfo->get_task_tag(cmd));
1749
1750                 spin_unlock_irq(&cmd->t_state_lock);
1751                 complete_all(&cmd->t_transport_stop_comp);
1752                 return;
1753         }
1754
1755         cmd->t_state = TRANSPORT_PROCESSING;
1756         cmd->transport_state |= CMD_T_ACTIVE|CMD_T_BUSY|CMD_T_SENT;
1757         spin_unlock_irq(&cmd->t_state_lock);
1758
1759         if (target_handle_task_attr(cmd)) {
1760                 spin_lock_irq(&cmd->t_state_lock);
1761                 cmd->transport_state &= ~CMD_T_BUSY|CMD_T_SENT;
1762                 spin_unlock_irq(&cmd->t_state_lock);
1763                 return;
1764         }
1765
1766         __target_execute_cmd(cmd);
1767 }
1768 EXPORT_SYMBOL(target_execute_cmd);
1769
1770 /*
1771  * Process all commands up to the last received ORDERED task attribute which
1772  * requires another blocking boundary
1773  */
1774 static void target_restart_delayed_cmds(struct se_device *dev)
1775 {
1776         for (;;) {
1777                 struct se_cmd *cmd;
1778
1779                 spin_lock(&dev->delayed_cmd_lock);
1780                 if (list_empty(&dev->delayed_cmd_list)) {
1781                         spin_unlock(&dev->delayed_cmd_lock);
1782                         break;
1783                 }
1784
1785                 cmd = list_entry(dev->delayed_cmd_list.next,
1786                                  struct se_cmd, se_delayed_node);
1787                 list_del(&cmd->se_delayed_node);
1788                 spin_unlock(&dev->delayed_cmd_lock);
1789
1790                 __target_execute_cmd(cmd);
1791
1792                 if (cmd->sam_task_attr == MSG_ORDERED_TAG)
1793                         break;
1794         }
1795 }
1796
1797 /*
1798  * Called from I/O completion to determine which dormant/delayed
1799  * and ordered cmds need to have their tasks added to the execution queue.
1800  */
1801 static void transport_complete_task_attr(struct se_cmd *cmd)
1802 {
1803         struct se_device *dev = cmd->se_dev;
1804
1805         if (dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV)
1806                 return;
1807
1808         if (cmd->sam_task_attr == MSG_SIMPLE_TAG) {
1809                 atomic_dec(&dev->simple_cmds);
1810                 smp_mb__after_atomic_dec();
1811                 dev->dev_cur_ordered_id++;
1812                 pr_debug("Incremented dev->dev_cur_ordered_id: %u for"
1813                         " SIMPLE: %u\n", dev->dev_cur_ordered_id,
1814                         cmd->se_ordered_id);
1815         } else if (cmd->sam_task_attr == MSG_HEAD_TAG) {
1816                 dev->dev_cur_ordered_id++;
1817                 pr_debug("Incremented dev_cur_ordered_id: %u for"
1818                         " HEAD_OF_QUEUE: %u\n", dev->dev_cur_ordered_id,
1819                         cmd->se_ordered_id);
1820         } else if (cmd->sam_task_attr == MSG_ORDERED_TAG) {
1821                 atomic_dec(&dev->dev_ordered_sync);
1822                 smp_mb__after_atomic_dec();
1823
1824                 dev->dev_cur_ordered_id++;
1825                 pr_debug("Incremented dev_cur_ordered_id: %u for ORDERED:"
1826                         " %u\n", dev->dev_cur_ordered_id, cmd->se_ordered_id);
1827         }
1828
1829         target_restart_delayed_cmds(dev);
1830 }
1831
1832 static void transport_complete_qf(struct se_cmd *cmd)
1833 {
1834         int ret = 0;
1835
1836         transport_complete_task_attr(cmd);
1837
1838         if (cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) {
1839                 trace_target_cmd_complete(cmd);
1840                 ret = cmd->se_tfo->queue_status(cmd);
1841                 if (ret)
1842                         goto out;
1843         }
1844
1845         switch (cmd->data_direction) {
1846         case DMA_FROM_DEVICE:
1847                 trace_target_cmd_complete(cmd);
1848                 ret = cmd->se_tfo->queue_data_in(cmd);
1849                 break;
1850         case DMA_TO_DEVICE:
1851                 if (cmd->se_cmd_flags & SCF_BIDI) {
1852                         ret = cmd->se_tfo->queue_data_in(cmd);
1853                         if (ret < 0)
1854                                 break;
1855                 }
1856                 /* Fall through for DMA_TO_DEVICE */
1857         case DMA_NONE:
1858                 trace_target_cmd_complete(cmd);
1859                 ret = cmd->se_tfo->queue_status(cmd);
1860                 break;
1861         default:
1862                 break;
1863         }
1864
1865 out:
1866         if (ret < 0) {
1867                 transport_handle_queue_full(cmd, cmd->se_dev);
1868                 return;
1869         }
1870         transport_lun_remove_cmd(cmd);
1871         transport_cmd_check_stop_to_fabric(cmd);
1872 }
1873
1874 static void transport_handle_queue_full(
1875         struct se_cmd *cmd,
1876         struct se_device *dev)
1877 {
1878         spin_lock_irq(&dev->qf_cmd_lock);
1879         list_add_tail(&cmd->se_qf_node, &cmd->se_dev->qf_cmd_list);
1880         atomic_inc(&dev->dev_qf_count);
1881         smp_mb__after_atomic_inc();
1882         spin_unlock_irq(&cmd->se_dev->qf_cmd_lock);
1883
1884         schedule_work(&cmd->se_dev->qf_work_queue);
1885 }
1886
1887 static void target_complete_ok_work(struct work_struct *work)
1888 {
1889         struct se_cmd *cmd = container_of(work, struct se_cmd, work);
1890         int ret;
1891
1892         /*
1893          * Check if we need to move delayed/dormant tasks from cmds on the
1894          * delayed execution list after a HEAD_OF_QUEUE or ORDERED Task
1895          * Attribute.
1896          */
1897         transport_complete_task_attr(cmd);
1898
1899         /*
1900          * Check to schedule QUEUE_FULL work, or execute an existing
1901          * cmd->transport_qf_callback()
1902          */
1903         if (atomic_read(&cmd->se_dev->dev_qf_count) != 0)
1904                 schedule_work(&cmd->se_dev->qf_work_queue);
1905
1906         /*
1907          * Check if we need to send a sense buffer from
1908          * the struct se_cmd in question.
1909          */
1910         if (cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) {
1911                 WARN_ON(!cmd->scsi_status);
1912                 ret = transport_send_check_condition_and_sense(
1913                                         cmd, 0, 1);
1914                 if (ret == -EAGAIN || ret == -ENOMEM)
1915                         goto queue_full;
1916
1917                 transport_lun_remove_cmd(cmd);
1918                 transport_cmd_check_stop_to_fabric(cmd);
1919                 return;
1920         }
1921         /*
1922          * Check for a callback, used by amongst other things
1923          * XDWRITE_READ_10 and COMPARE_AND_WRITE emulation.
1924          */
1925         if (cmd->transport_complete_callback) {
1926                 sense_reason_t rc;
1927
1928                 rc = cmd->transport_complete_callback(cmd);
1929                 if (!rc && !(cmd->se_cmd_flags & SCF_COMPARE_AND_WRITE_POST)) {
1930                         return;
1931                 } else if (rc) {
1932                         ret = transport_send_check_condition_and_sense(cmd,
1933                                                 rc, 0);
1934                         if (ret == -EAGAIN || ret == -ENOMEM)
1935                                 goto queue_full;
1936
1937                         transport_lun_remove_cmd(cmd);
1938                         transport_cmd_check_stop_to_fabric(cmd);
1939                         return;
1940                 }
1941         }
1942
1943         switch (cmd->data_direction) {
1944         case DMA_FROM_DEVICE:
1945                 spin_lock(&cmd->se_lun->lun_sep_lock);
1946                 if (cmd->se_lun->lun_sep) {
1947                         cmd->se_lun->lun_sep->sep_stats.tx_data_octets +=
1948                                         cmd->data_length;
1949                 }
1950                 spin_unlock(&cmd->se_lun->lun_sep_lock);
1951
1952                 trace_target_cmd_complete(cmd);
1953                 ret = cmd->se_tfo->queue_data_in(cmd);
1954                 if (ret == -EAGAIN || ret == -ENOMEM)
1955                         goto queue_full;
1956                 break;
1957         case DMA_TO_DEVICE:
1958                 spin_lock(&cmd->se_lun->lun_sep_lock);
1959                 if (cmd->se_lun->lun_sep) {
1960                         cmd->se_lun->lun_sep->sep_stats.rx_data_octets +=
1961                                 cmd->data_length;
1962                 }
1963                 spin_unlock(&cmd->se_lun->lun_sep_lock);
1964                 /*
1965                  * Check if we need to send READ payload for BIDI-COMMAND
1966                  */
1967                 if (cmd->se_cmd_flags & SCF_BIDI) {
1968                         spin_lock(&cmd->se_lun->lun_sep_lock);
1969                         if (cmd->se_lun->lun_sep) {
1970                                 cmd->se_lun->lun_sep->sep_stats.tx_data_octets +=
1971                                         cmd->data_length;
1972                         }
1973                         spin_unlock(&cmd->se_lun->lun_sep_lock);
1974                         ret = cmd->se_tfo->queue_data_in(cmd);
1975                         if (ret == -EAGAIN || ret == -ENOMEM)
1976                                 goto queue_full;
1977                         break;
1978                 }
1979                 /* Fall through for DMA_TO_DEVICE */
1980         case DMA_NONE:
1981                 trace_target_cmd_complete(cmd);
1982                 ret = cmd->se_tfo->queue_status(cmd);
1983                 if (ret == -EAGAIN || ret == -ENOMEM)
1984                         goto queue_full;
1985                 break;
1986         default:
1987                 break;
1988         }
1989
1990         transport_lun_remove_cmd(cmd);
1991         transport_cmd_check_stop_to_fabric(cmd);
1992         return;
1993
1994 queue_full:
1995         pr_debug("Handling complete_ok QUEUE_FULL: se_cmd: %p,"
1996                 " data_direction: %d\n", cmd, cmd->data_direction);
1997         cmd->t_state = TRANSPORT_COMPLETE_QF_OK;
1998         transport_handle_queue_full(cmd, cmd->se_dev);
1999 }
2000
2001 static inline void transport_free_sgl(struct scatterlist *sgl, int nents)
2002 {
2003         struct scatterlist *sg;
2004         int count;
2005
2006         for_each_sg(sgl, sg, nents, count)
2007                 __free_page(sg_page(sg));
2008
2009         kfree(sgl);
2010 }
2011
2012 static inline void transport_reset_sgl_orig(struct se_cmd *cmd)
2013 {
2014         /*
2015          * Check for saved t_data_sg that may be used for COMPARE_AND_WRITE
2016          * emulation, and free + reset pointers if necessary..
2017          */
2018         if (!cmd->t_data_sg_orig)
2019                 return;
2020
2021         kfree(cmd->t_data_sg);
2022         cmd->t_data_sg = cmd->t_data_sg_orig;
2023         cmd->t_data_sg_orig = NULL;
2024         cmd->t_data_nents = cmd->t_data_nents_orig;
2025         cmd->t_data_nents_orig = 0;
2026 }
2027
2028 static inline void transport_free_pages(struct se_cmd *cmd)
2029 {
2030         if (cmd->se_cmd_flags & SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC) {
2031                 transport_reset_sgl_orig(cmd);
2032                 return;
2033         }
2034         transport_reset_sgl_orig(cmd);
2035
2036         transport_free_sgl(cmd->t_data_sg, cmd->t_data_nents);
2037         cmd->t_data_sg = NULL;
2038         cmd->t_data_nents = 0;
2039
2040         transport_free_sgl(cmd->t_bidi_data_sg, cmd->t_bidi_data_nents);
2041         cmd->t_bidi_data_sg = NULL;
2042         cmd->t_bidi_data_nents = 0;
2043 }
2044
2045 /**
2046  * transport_release_cmd - free a command
2047  * @cmd:       command to free
2048  *
2049  * This routine unconditionally frees a command, and reference counting
2050  * or list removal must be done in the caller.
2051  */
2052 static int transport_release_cmd(struct se_cmd *cmd)
2053 {
2054         BUG_ON(!cmd->se_tfo);
2055
2056         if (cmd->se_cmd_flags & SCF_SCSI_TMR_CDB)
2057                 core_tmr_release_req(cmd->se_tmr_req);
2058         if (cmd->t_task_cdb != cmd->__t_task_cdb)
2059                 kfree(cmd->t_task_cdb);
2060         /*
2061          * If this cmd has been setup with target_get_sess_cmd(), drop
2062          * the kref and call ->release_cmd() in kref callback.
2063          */
2064         return target_put_sess_cmd(cmd->se_sess, cmd);
2065 }
2066
2067 /**
2068  * transport_put_cmd - release a reference to a command
2069  * @cmd:       command to release
2070  *
2071  * This routine releases our reference to the command and frees it if possible.
2072  */
2073 static int transport_put_cmd(struct se_cmd *cmd)
2074 {
2075         transport_free_pages(cmd);
2076         return transport_release_cmd(cmd);
2077 }
2078
2079 void *transport_kmap_data_sg(struct se_cmd *cmd)
2080 {
2081         struct scatterlist *sg = cmd->t_data_sg;
2082         struct page **pages;
2083         int i;
2084
2085         /*
2086          * We need to take into account a possible offset here for fabrics like
2087          * tcm_loop who may be using a contig buffer from the SCSI midlayer for
2088          * control CDBs passed as SGLs via transport_generic_map_mem_to_cmd()
2089          */
2090         if (!cmd->t_data_nents)
2091                 return NULL;
2092
2093         BUG_ON(!sg);
2094         if (cmd->t_data_nents == 1)
2095                 return kmap(sg_page(sg)) + sg->offset;
2096
2097         /* >1 page. use vmap */
2098         pages = kmalloc(sizeof(*pages) * cmd->t_data_nents, GFP_KERNEL);
2099         if (!pages)
2100                 return NULL;
2101
2102         /* convert sg[] to pages[] */
2103         for_each_sg(cmd->t_data_sg, sg, cmd->t_data_nents, i) {
2104                 pages[i] = sg_page(sg);
2105         }
2106
2107         cmd->t_data_vmap = vmap(pages, cmd->t_data_nents,  VM_MAP, PAGE_KERNEL);
2108         kfree(pages);
2109         if (!cmd->t_data_vmap)
2110                 return NULL;
2111
2112         return cmd->t_data_vmap + cmd->t_data_sg[0].offset;
2113 }
2114 EXPORT_SYMBOL(transport_kmap_data_sg);
2115
2116 void transport_kunmap_data_sg(struct se_cmd *cmd)
2117 {
2118         if (!cmd->t_data_nents) {
2119                 return;
2120         } else if (cmd->t_data_nents == 1) {
2121                 kunmap(sg_page(cmd->t_data_sg));
2122                 return;
2123         }
2124
2125         vunmap(cmd->t_data_vmap);
2126         cmd->t_data_vmap = NULL;
2127 }
2128 EXPORT_SYMBOL(transport_kunmap_data_sg);
2129
2130 int
2131 target_alloc_sgl(struct scatterlist **sgl, unsigned int *nents, u32 length,
2132                  bool zero_page)
2133 {
2134         struct scatterlist *sg;
2135         struct page *page;
2136         gfp_t zero_flag = (zero_page) ? __GFP_ZERO : 0;
2137         unsigned int nent;
2138         int i = 0;
2139
2140         nent = DIV_ROUND_UP(length, PAGE_SIZE);
2141         sg = kmalloc(sizeof(struct scatterlist) * nent, GFP_KERNEL);
2142         if (!sg)
2143                 return -ENOMEM;
2144
2145         sg_init_table(sg, nent);
2146
2147         while (length) {
2148                 u32 page_len = min_t(u32, length, PAGE_SIZE);
2149                 page = alloc_page(GFP_KERNEL | zero_flag);
2150                 if (!page)
2151                         goto out;
2152
2153                 sg_set_page(&sg[i], page, page_len, 0);
2154                 length -= page_len;
2155                 i++;
2156         }
2157         *sgl = sg;
2158         *nents = nent;
2159         return 0;
2160
2161 out:
2162         while (i > 0) {
2163                 i--;
2164                 __free_page(sg_page(&sg[i]));
2165         }
2166         kfree(sg);
2167         return -ENOMEM;
2168 }
2169
2170 /*
2171  * Allocate any required resources to execute the command.  For writes we
2172  * might not have the payload yet, so notify the fabric via a call to
2173  * ->write_pending instead. Otherwise place it on the execution queue.
2174  */
2175 sense_reason_t
2176 transport_generic_new_cmd(struct se_cmd *cmd)
2177 {
2178         int ret = 0;
2179
2180         /*
2181          * Determine is the TCM fabric module has already allocated physical
2182          * memory, and is directly calling transport_generic_map_mem_to_cmd()
2183          * beforehand.
2184          */
2185         if (!(cmd->se_cmd_flags & SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC) &&
2186             cmd->data_length) {
2187                 bool zero_flag = !(cmd->se_cmd_flags & SCF_SCSI_DATA_CDB);
2188
2189                 if ((cmd->se_cmd_flags & SCF_BIDI) ||
2190                     (cmd->se_cmd_flags & SCF_COMPARE_AND_WRITE)) {
2191                         u32 bidi_length;
2192
2193                         if (cmd->se_cmd_flags & SCF_COMPARE_AND_WRITE)
2194                                 bidi_length = cmd->t_task_nolb *
2195                                               cmd->se_dev->dev_attrib.block_size;
2196                         else
2197                                 bidi_length = cmd->data_length;
2198
2199                         ret = target_alloc_sgl(&cmd->t_bidi_data_sg,
2200                                                &cmd->t_bidi_data_nents,
2201                                                bidi_length, zero_flag);
2202                         if (ret < 0)
2203                                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2204                 }
2205
2206                 ret = target_alloc_sgl(&cmd->t_data_sg, &cmd->t_data_nents,
2207                                        cmd->data_length, zero_flag);
2208                 if (ret < 0)
2209                         return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2210         }
2211         /*
2212          * If this command is not a write we can execute it right here,
2213          * for write buffers we need to notify the fabric driver first
2214          * and let it call back once the write buffers are ready.
2215          */
2216         target_add_to_state_list(cmd);
2217         if (cmd->data_direction != DMA_TO_DEVICE) {
2218                 target_execute_cmd(cmd);
2219                 return 0;
2220         }
2221         transport_cmd_check_stop(cmd, false, true);
2222
2223         ret = cmd->se_tfo->write_pending(cmd);
2224         if (ret == -EAGAIN || ret == -ENOMEM)
2225                 goto queue_full;
2226
2227         /* fabric drivers should only return -EAGAIN or -ENOMEM as error */
2228         WARN_ON(ret);
2229
2230         return (!ret) ? 0 : TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2231
2232 queue_full:
2233         pr_debug("Handling write_pending QUEUE__FULL: se_cmd: %p\n", cmd);
2234         cmd->t_state = TRANSPORT_COMPLETE_QF_WP;
2235         transport_handle_queue_full(cmd, cmd->se_dev);
2236         return 0;
2237 }
2238 EXPORT_SYMBOL(transport_generic_new_cmd);
2239
2240 static void transport_write_pending_qf(struct se_cmd *cmd)
2241 {
2242         int ret;
2243
2244         ret = cmd->se_tfo->write_pending(cmd);
2245         if (ret == -EAGAIN || ret == -ENOMEM) {
2246                 pr_debug("Handling write_pending QUEUE__FULL: se_cmd: %p\n",
2247                          cmd);
2248                 transport_handle_queue_full(cmd, cmd->se_dev);
2249         }
2250 }
2251
2252 int transport_generic_free_cmd(struct se_cmd *cmd, int wait_for_tasks)
2253 {
2254         unsigned long flags;
2255         int ret = 0;
2256
2257         if (!(cmd->se_cmd_flags & SCF_SE_LUN_CMD)) {
2258                 if (wait_for_tasks && (cmd->se_cmd_flags & SCF_SCSI_TMR_CDB))
2259                          transport_wait_for_tasks(cmd);
2260
2261                 ret = transport_release_cmd(cmd);
2262         } else {
2263                 if (wait_for_tasks)
2264                         transport_wait_for_tasks(cmd);
2265                 /*
2266                  * Handle WRITE failure case where transport_generic_new_cmd()
2267                  * has already added se_cmd to state_list, but fabric has
2268                  * failed command before I/O submission.
2269                  */
2270                 if (cmd->state_active) {
2271                         spin_lock_irqsave(&cmd->t_state_lock, flags);
2272                         target_remove_from_state_list(cmd);
2273                         spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2274                 }
2275
2276                 if (cmd->se_lun)
2277                         transport_lun_remove_cmd(cmd);
2278
2279                 ret = transport_put_cmd(cmd);
2280         }
2281         return ret;
2282 }
2283 EXPORT_SYMBOL(transport_generic_free_cmd);
2284
2285 /* target_get_sess_cmd - Add command to active ->sess_cmd_list
2286  * @se_sess:    session to reference
2287  * @se_cmd:     command descriptor to add
2288  * @ack_kref:   Signal that fabric will perform an ack target_put_sess_cmd()
2289  */
2290 int target_get_sess_cmd(struct se_session *se_sess, struct se_cmd *se_cmd,
2291                                bool ack_kref)
2292 {
2293         unsigned long flags;
2294         int ret = 0;
2295
2296         /*
2297          * Add a second kref if the fabric caller is expecting to handle
2298          * fabric acknowledgement that requires two target_put_sess_cmd()
2299          * invocations before se_cmd descriptor release.
2300          */
2301         if (ack_kref == true) {
2302                 kref_get(&se_cmd->cmd_kref);
2303                 se_cmd->se_cmd_flags |= SCF_ACK_KREF;
2304         }
2305
2306         spin_lock_irqsave(&se_sess->sess_cmd_lock, flags);
2307         if (se_sess->sess_tearing_down) {
2308                 ret = -ESHUTDOWN;
2309                 goto out;
2310         }
2311         list_add_tail(&se_cmd->se_cmd_list, &se_sess->sess_cmd_list);
2312 out:
2313         spin_unlock_irqrestore(&se_sess->sess_cmd_lock, flags);
2314         return ret;
2315 }
2316 EXPORT_SYMBOL(target_get_sess_cmd);
2317
2318 static void target_release_cmd_kref(struct kref *kref)
2319 {
2320         struct se_cmd *se_cmd = container_of(kref, struct se_cmd, cmd_kref);
2321         struct se_session *se_sess = se_cmd->se_sess;
2322
2323         if (list_empty(&se_cmd->se_cmd_list)) {
2324                 spin_unlock(&se_sess->sess_cmd_lock);
2325                 se_cmd->se_tfo->release_cmd(se_cmd);
2326                 return;
2327         }
2328         if (se_sess->sess_tearing_down && se_cmd->cmd_wait_set) {
2329                 spin_unlock(&se_sess->sess_cmd_lock);
2330                 complete(&se_cmd->cmd_wait_comp);
2331                 return;
2332         }
2333         list_del(&se_cmd->se_cmd_list);
2334         spin_unlock(&se_sess->sess_cmd_lock);
2335
2336         se_cmd->se_tfo->release_cmd(se_cmd);
2337 }
2338
2339 /* target_put_sess_cmd - Check for active I/O shutdown via kref_put
2340  * @se_sess:    session to reference
2341  * @se_cmd:     command descriptor to drop
2342  */
2343 int target_put_sess_cmd(struct se_session *se_sess, struct se_cmd *se_cmd)
2344 {
2345         if (!se_sess) {
2346                 se_cmd->se_tfo->release_cmd(se_cmd);
2347                 return 1;
2348         }
2349         return kref_put_spinlock_irqsave(&se_cmd->cmd_kref, target_release_cmd_kref,
2350                         &se_sess->sess_cmd_lock);
2351 }
2352 EXPORT_SYMBOL(target_put_sess_cmd);
2353
2354 /* target_sess_cmd_list_set_waiting - Flag all commands in
2355  *         sess_cmd_list to complete cmd_wait_comp.  Set
2356  *         sess_tearing_down so no more commands are queued.
2357  * @se_sess:    session to flag
2358  */
2359 void target_sess_cmd_list_set_waiting(struct se_session *se_sess)
2360 {
2361         struct se_cmd *se_cmd;
2362         unsigned long flags;
2363
2364         spin_lock_irqsave(&se_sess->sess_cmd_lock, flags);
2365         if (se_sess->sess_tearing_down) {
2366                 spin_unlock_irqrestore(&se_sess->sess_cmd_lock, flags);
2367                 return;
2368         }
2369         se_sess->sess_tearing_down = 1;
2370         list_splice_init(&se_sess->sess_cmd_list, &se_sess->sess_wait_list);
2371
2372         list_for_each_entry(se_cmd, &se_sess->sess_wait_list, se_cmd_list)
2373                 se_cmd->cmd_wait_set = 1;
2374
2375         spin_unlock_irqrestore(&se_sess->sess_cmd_lock, flags);
2376 }
2377 EXPORT_SYMBOL(target_sess_cmd_list_set_waiting);
2378
2379 /* target_wait_for_sess_cmds - Wait for outstanding descriptors
2380  * @se_sess:    session to wait for active I/O
2381  */
2382 void target_wait_for_sess_cmds(struct se_session *se_sess)
2383 {
2384         struct se_cmd *se_cmd, *tmp_cmd;
2385         unsigned long flags;
2386
2387         list_for_each_entry_safe(se_cmd, tmp_cmd,
2388                                 &se_sess->sess_wait_list, se_cmd_list) {
2389                 list_del(&se_cmd->se_cmd_list);
2390
2391                 pr_debug("Waiting for se_cmd: %p t_state: %d, fabric state:"
2392                         " %d\n", se_cmd, se_cmd->t_state,
2393                         se_cmd->se_tfo->get_cmd_state(se_cmd));
2394
2395                 wait_for_completion(&se_cmd->cmd_wait_comp);
2396                 pr_debug("After cmd_wait_comp: se_cmd: %p t_state: %d"
2397                         " fabric state: %d\n", se_cmd, se_cmd->t_state,
2398                         se_cmd->se_tfo->get_cmd_state(se_cmd));
2399
2400                 se_cmd->se_tfo->release_cmd(se_cmd);
2401         }
2402
2403         spin_lock_irqsave(&se_sess->sess_cmd_lock, flags);
2404         WARN_ON(!list_empty(&se_sess->sess_cmd_list));
2405         spin_unlock_irqrestore(&se_sess->sess_cmd_lock, flags);
2406
2407 }
2408 EXPORT_SYMBOL(target_wait_for_sess_cmds);
2409
2410 static int transport_clear_lun_ref_thread(void *p)
2411 {
2412         struct se_lun *lun = p;
2413
2414         percpu_ref_kill(&lun->lun_ref);
2415
2416         wait_for_completion(&lun->lun_ref_comp);
2417         complete(&lun->lun_shutdown_comp);
2418
2419         return 0;
2420 }
2421
2422 int transport_clear_lun_ref(struct se_lun *lun)
2423 {
2424         struct task_struct *kt;
2425
2426         kt = kthread_run(transport_clear_lun_ref_thread, lun,
2427                         "tcm_cl_%u", lun->unpacked_lun);
2428         if (IS_ERR(kt)) {
2429                 pr_err("Unable to start clear_lun thread\n");
2430                 return PTR_ERR(kt);
2431         }
2432         wait_for_completion(&lun->lun_shutdown_comp);
2433
2434         return 0;
2435 }
2436
2437 /**
2438  * transport_wait_for_tasks - wait for completion to occur
2439  * @cmd:        command to wait
2440  *
2441  * Called from frontend fabric context to wait for storage engine
2442  * to pause and/or release frontend generated struct se_cmd.
2443  */
2444 bool transport_wait_for_tasks(struct se_cmd *cmd)
2445 {
2446         unsigned long flags;
2447
2448         spin_lock_irqsave(&cmd->t_state_lock, flags);
2449         if (!(cmd->se_cmd_flags & SCF_SE_LUN_CMD) &&
2450             !(cmd->se_cmd_flags & SCF_SCSI_TMR_CDB)) {
2451                 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2452                 return false;
2453         }
2454
2455         if (!(cmd->se_cmd_flags & SCF_SUPPORTED_SAM_OPCODE) &&
2456             !(cmd->se_cmd_flags & SCF_SCSI_TMR_CDB)) {
2457                 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2458                 return false;
2459         }
2460
2461         if (!(cmd->transport_state & CMD_T_ACTIVE)) {
2462                 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2463                 return false;
2464         }
2465
2466         cmd->transport_state |= CMD_T_STOP;
2467
2468         pr_debug("wait_for_tasks: Stopping %p ITT: 0x%08x"
2469                 " i_state: %d, t_state: %d, CMD_T_STOP\n",
2470                 cmd, cmd->se_tfo->get_task_tag(cmd),
2471                 cmd->se_tfo->get_cmd_state(cmd), cmd->t_state);
2472
2473         spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2474
2475         wait_for_completion(&cmd->t_transport_stop_comp);
2476
2477         spin_lock_irqsave(&cmd->t_state_lock, flags);
2478         cmd->transport_state &= ~(CMD_T_ACTIVE | CMD_T_STOP);
2479
2480         pr_debug("wait_for_tasks: Stopped wait_for_completion("
2481                 "&cmd->t_transport_stop_comp) for ITT: 0x%08x\n",
2482                 cmd->se_tfo->get_task_tag(cmd));
2483
2484         spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2485
2486         return true;
2487 }
2488 EXPORT_SYMBOL(transport_wait_for_tasks);
2489
2490 static int transport_get_sense_codes(
2491         struct se_cmd *cmd,
2492         u8 *asc,
2493         u8 *ascq)
2494 {
2495         *asc = cmd->scsi_asc;
2496         *ascq = cmd->scsi_ascq;
2497
2498         return 0;
2499 }
2500
2501 static
2502 void transport_err_sector_info(unsigned char *buffer, sector_t bad_sector)
2503 {
2504         /* Place failed LBA in sense data information descriptor 0. */
2505         buffer[SPC_ADD_SENSE_LEN_OFFSET] = 0xc;
2506         buffer[SPC_DESC_TYPE_OFFSET] = 0; /* Information */
2507         buffer[SPC_ADDITIONAL_DESC_LEN_OFFSET] = 0xa;
2508         buffer[SPC_VALIDITY_OFFSET] = 0x80;
2509
2510         /* Descriptor Information: failing sector */
2511         put_unaligned_be64(bad_sector, &buffer[12]);
2512 }
2513
2514 int
2515 transport_send_check_condition_and_sense(struct se_cmd *cmd,
2516                 sense_reason_t reason, int from_transport)
2517 {
2518         unsigned char *buffer = cmd->sense_buffer;
2519         unsigned long flags;
2520         u8 asc = 0, ascq = 0;
2521
2522         spin_lock_irqsave(&cmd->t_state_lock, flags);
2523         if (cmd->se_cmd_flags & SCF_SENT_CHECK_CONDITION) {
2524                 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2525                 return 0;
2526         }
2527         cmd->se_cmd_flags |= SCF_SENT_CHECK_CONDITION;
2528         spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2529
2530         if (!reason && from_transport)
2531                 goto after_reason;
2532
2533         if (!from_transport)
2534                 cmd->se_cmd_flags |= SCF_EMULATED_TASK_SENSE;
2535
2536         /*
2537          * Actual SENSE DATA, see SPC-3 7.23.2  SPC_SENSE_KEY_OFFSET uses
2538          * SENSE KEY values from include/scsi/scsi.h
2539          */
2540         switch (reason) {
2541         case TCM_NO_SENSE:
2542                 /* CURRENT ERROR */
2543                 buffer[0] = 0x70;
2544                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2545                 /* Not Ready */
2546                 buffer[SPC_SENSE_KEY_OFFSET] = NOT_READY;
2547                 /* NO ADDITIONAL SENSE INFORMATION */
2548                 buffer[SPC_ASC_KEY_OFFSET] = 0;
2549                 buffer[SPC_ASCQ_KEY_OFFSET] = 0;
2550                 break;
2551         case TCM_NON_EXISTENT_LUN:
2552                 /* CURRENT ERROR */
2553                 buffer[0] = 0x70;
2554                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2555                 /* ILLEGAL REQUEST */
2556                 buffer[SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
2557                 /* LOGICAL UNIT NOT SUPPORTED */
2558                 buffer[SPC_ASC_KEY_OFFSET] = 0x25;
2559                 break;
2560         case TCM_UNSUPPORTED_SCSI_OPCODE:
2561         case TCM_SECTOR_COUNT_TOO_MANY:
2562                 /* CURRENT ERROR */
2563                 buffer[0] = 0x70;
2564                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2565                 /* ILLEGAL REQUEST */
2566                 buffer[SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
2567                 /* INVALID COMMAND OPERATION CODE */
2568                 buffer[SPC_ASC_KEY_OFFSET] = 0x20;
2569                 break;
2570         case TCM_UNKNOWN_MODE_PAGE:
2571                 /* CURRENT ERROR */
2572                 buffer[0] = 0x70;
2573                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2574                 /* ILLEGAL REQUEST */
2575                 buffer[SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
2576                 /* INVALID FIELD IN CDB */
2577                 buffer[SPC_ASC_KEY_OFFSET] = 0x24;
2578                 break;
2579         case TCM_CHECK_CONDITION_ABORT_CMD:
2580                 /* CURRENT ERROR */
2581                 buffer[0] = 0x70;
2582                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2583                 /* ABORTED COMMAND */
2584                 buffer[SPC_SENSE_KEY_OFFSET] = ABORTED_COMMAND;
2585                 /* BUS DEVICE RESET FUNCTION OCCURRED */
2586                 buffer[SPC_ASC_KEY_OFFSET] = 0x29;
2587                 buffer[SPC_ASCQ_KEY_OFFSET] = 0x03;
2588                 break;
2589         case TCM_INCORRECT_AMOUNT_OF_DATA:
2590                 /* CURRENT ERROR */
2591                 buffer[0] = 0x70;
2592                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2593                 /* ABORTED COMMAND */
2594                 buffer[SPC_SENSE_KEY_OFFSET] = ABORTED_COMMAND;
2595                 /* WRITE ERROR */
2596                 buffer[SPC_ASC_KEY_OFFSET] = 0x0c;
2597                 /* NOT ENOUGH UNSOLICITED DATA */
2598                 buffer[SPC_ASCQ_KEY_OFFSET] = 0x0d;
2599                 break;
2600         case TCM_INVALID_CDB_FIELD:
2601                 /* CURRENT ERROR */
2602                 buffer[0] = 0x70;
2603                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2604                 /* ILLEGAL REQUEST */
2605                 buffer[SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
2606                 /* INVALID FIELD IN CDB */
2607                 buffer[SPC_ASC_KEY_OFFSET] = 0x24;
2608                 break;
2609         case TCM_INVALID_PARAMETER_LIST:
2610                 /* CURRENT ERROR */
2611                 buffer[0] = 0x70;
2612                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2613                 /* ILLEGAL REQUEST */
2614                 buffer[SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
2615                 /* INVALID FIELD IN PARAMETER LIST */
2616                 buffer[SPC_ASC_KEY_OFFSET] = 0x26;
2617                 break;
2618         case TCM_PARAMETER_LIST_LENGTH_ERROR:
2619                 /* CURRENT ERROR */
2620                 buffer[0] = 0x70;
2621                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2622                 /* ILLEGAL REQUEST */
2623                 buffer[SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
2624                 /* PARAMETER LIST LENGTH ERROR */
2625                 buffer[SPC_ASC_KEY_OFFSET] = 0x1a;
2626                 break;
2627         case TCM_UNEXPECTED_UNSOLICITED_DATA:
2628                 /* CURRENT ERROR */
2629                 buffer[0] = 0x70;
2630                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2631                 /* ABORTED COMMAND */
2632                 buffer[SPC_SENSE_KEY_OFFSET] = ABORTED_COMMAND;
2633                 /* WRITE ERROR */
2634                 buffer[SPC_ASC_KEY_OFFSET] = 0x0c;
2635                 /* UNEXPECTED_UNSOLICITED_DATA */
2636                 buffer[SPC_ASCQ_KEY_OFFSET] = 0x0c;
2637                 break;
2638         case TCM_SERVICE_CRC_ERROR:
2639                 /* CURRENT ERROR */
2640                 buffer[0] = 0x70;
2641                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2642                 /* ABORTED COMMAND */
2643                 buffer[SPC_SENSE_KEY_OFFSET] = ABORTED_COMMAND;
2644                 /* PROTOCOL SERVICE CRC ERROR */
2645                 buffer[SPC_ASC_KEY_OFFSET] = 0x47;
2646                 /* N/A */
2647                 buffer[SPC_ASCQ_KEY_OFFSET] = 0x05;
2648                 break;
2649         case TCM_SNACK_REJECTED:
2650                 /* CURRENT ERROR */
2651                 buffer[0] = 0x70;
2652                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2653                 /* ABORTED COMMAND */
2654                 buffer[SPC_SENSE_KEY_OFFSET] = ABORTED_COMMAND;
2655                 /* READ ERROR */
2656                 buffer[SPC_ASC_KEY_OFFSET] = 0x11;
2657                 /* FAILED RETRANSMISSION REQUEST */
2658                 buffer[SPC_ASCQ_KEY_OFFSET] = 0x13;
2659                 break;
2660         case TCM_WRITE_PROTECTED:
2661                 /* CURRENT ERROR */
2662                 buffer[0] = 0x70;
2663                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2664                 /* DATA PROTECT */
2665                 buffer[SPC_SENSE_KEY_OFFSET] = DATA_PROTECT;
2666                 /* WRITE PROTECTED */
2667                 buffer[SPC_ASC_KEY_OFFSET] = 0x27;
2668                 break;
2669         case TCM_ADDRESS_OUT_OF_RANGE:
2670                 /* CURRENT ERROR */
2671                 buffer[0] = 0x70;
2672                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2673                 /* ILLEGAL REQUEST */
2674                 buffer[SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
2675                 /* LOGICAL BLOCK ADDRESS OUT OF RANGE */
2676                 buffer[SPC_ASC_KEY_OFFSET] = 0x21;
2677                 break;
2678         case TCM_CHECK_CONDITION_UNIT_ATTENTION:
2679                 /* CURRENT ERROR */
2680                 buffer[0] = 0x70;
2681                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2682                 /* UNIT ATTENTION */
2683                 buffer[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
2684                 core_scsi3_ua_for_check_condition(cmd, &asc, &ascq);
2685                 buffer[SPC_ASC_KEY_OFFSET] = asc;
2686                 buffer[SPC_ASCQ_KEY_OFFSET] = ascq;
2687                 break;
2688         case TCM_CHECK_CONDITION_NOT_READY:
2689                 /* CURRENT ERROR */
2690                 buffer[0] = 0x70;
2691                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2692                 /* Not Ready */
2693                 buffer[SPC_SENSE_KEY_OFFSET] = NOT_READY;
2694                 transport_get_sense_codes(cmd, &asc, &ascq);
2695                 buffer[SPC_ASC_KEY_OFFSET] = asc;
2696                 buffer[SPC_ASCQ_KEY_OFFSET] = ascq;
2697                 break;
2698         case TCM_MISCOMPARE_VERIFY:
2699                 /* CURRENT ERROR */
2700                 buffer[0] = 0x70;
2701                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2702                 buffer[SPC_SENSE_KEY_OFFSET] = MISCOMPARE;
2703                 /* MISCOMPARE DURING VERIFY OPERATION */
2704                 buffer[SPC_ASC_KEY_OFFSET] = 0x1d;
2705                 buffer[SPC_ASCQ_KEY_OFFSET] = 0x00;
2706                 break;
2707         case TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED:
2708                 /* CURRENT ERROR */
2709                 buffer[0] = 0x70;
2710                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2711                 /* ILLEGAL REQUEST */
2712                 buffer[SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
2713                 /* LOGICAL BLOCK GUARD CHECK FAILED */
2714                 buffer[SPC_ASC_KEY_OFFSET] = 0x10;
2715                 buffer[SPC_ASCQ_KEY_OFFSET] = 0x01;
2716                 transport_err_sector_info(buffer, cmd->bad_sector);
2717                 break;
2718         case TCM_LOGICAL_BLOCK_APP_TAG_CHECK_FAILED:
2719                 /* CURRENT ERROR */
2720                 buffer[0] = 0x70;
2721                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2722                 /* ILLEGAL REQUEST */
2723                 buffer[SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
2724                 /* LOGICAL BLOCK APPLICATION TAG CHECK FAILED */
2725                 buffer[SPC_ASC_KEY_OFFSET] = 0x10;
2726                 buffer[SPC_ASCQ_KEY_OFFSET] = 0x02;
2727                 transport_err_sector_info(buffer, cmd->bad_sector);
2728                 break;
2729         case TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED:
2730                 /* CURRENT ERROR */
2731                 buffer[0] = 0x70;
2732                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2733                 /* ILLEGAL REQUEST */
2734                 buffer[SPC_SENSE_KEY_OFFSET] = ILLEGAL_REQUEST;
2735                 /* LOGICAL BLOCK REFERENCE TAG CHECK FAILED */
2736                 buffer[SPC_ASC_KEY_OFFSET] = 0x10;
2737                 buffer[SPC_ASCQ_KEY_OFFSET] = 0x03;
2738                 transport_err_sector_info(buffer, cmd->bad_sector);
2739                 break;
2740         case TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE:
2741         default:
2742                 /* CURRENT ERROR */
2743                 buffer[0] = 0x70;
2744                 buffer[SPC_ADD_SENSE_LEN_OFFSET] = 10;
2745                 /*
2746                  * Returning ILLEGAL REQUEST would cause immediate IO errors on
2747                  * Solaris initiators.  Returning NOT READY instead means the
2748                  * operations will be retried a finite number of times and we
2749                  * can survive intermittent errors.
2750                  */
2751                 buffer[SPC_SENSE_KEY_OFFSET] = NOT_READY;
2752                 /* LOGICAL UNIT COMMUNICATION FAILURE */
2753                 buffer[SPC_ASC_KEY_OFFSET] = 0x08;
2754                 break;
2755         }
2756         /*
2757          * This code uses linux/include/scsi/scsi.h SAM status codes!
2758          */
2759         cmd->scsi_status = SAM_STAT_CHECK_CONDITION;
2760         /*
2761          * Automatically padded, this value is encoded in the fabric's
2762          * data_length response PDU containing the SCSI defined sense data.
2763          */
2764         cmd->scsi_sense_length  = TRANSPORT_SENSE_BUFFER;
2765
2766 after_reason:
2767         trace_target_cmd_complete(cmd);
2768         return cmd->se_tfo->queue_status(cmd);
2769 }
2770 EXPORT_SYMBOL(transport_send_check_condition_and_sense);
2771
2772 int transport_check_aborted_status(struct se_cmd *cmd, int send_status)
2773 {
2774         if (!(cmd->transport_state & CMD_T_ABORTED))
2775                 return 0;
2776
2777         if (!send_status || (cmd->se_cmd_flags & SCF_SENT_DELAYED_TAS))
2778                 return 1;
2779
2780         pr_debug("Sending delayed SAM_STAT_TASK_ABORTED status for CDB: 0x%02x ITT: 0x%08x\n",
2781                  cmd->t_task_cdb[0], cmd->se_tfo->get_task_tag(cmd));
2782
2783         cmd->se_cmd_flags |= SCF_SENT_DELAYED_TAS;
2784         cmd->scsi_status = SAM_STAT_TASK_ABORTED;
2785         trace_target_cmd_complete(cmd);
2786         cmd->se_tfo->queue_status(cmd);
2787
2788         return 1;
2789 }
2790 EXPORT_SYMBOL(transport_check_aborted_status);
2791
2792 void transport_send_task_abort(struct se_cmd *cmd)
2793 {
2794         unsigned long flags;
2795
2796         spin_lock_irqsave(&cmd->t_state_lock, flags);
2797         if (cmd->se_cmd_flags & (SCF_SENT_CHECK_CONDITION | SCF_SENT_DELAYED_TAS)) {
2798                 spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2799                 return;
2800         }
2801         spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2802
2803         /*
2804          * If there are still expected incoming fabric WRITEs, we wait
2805          * until until they have completed before sending a TASK_ABORTED
2806          * response.  This response with TASK_ABORTED status will be
2807          * queued back to fabric module by transport_check_aborted_status().
2808          */
2809         if (cmd->data_direction == DMA_TO_DEVICE) {
2810                 if (cmd->se_tfo->write_pending_status(cmd) != 0) {
2811                         cmd->transport_state |= CMD_T_ABORTED;
2812                         smp_mb__after_atomic_inc();
2813                         return;
2814                 }
2815         }
2816         cmd->scsi_status = SAM_STAT_TASK_ABORTED;
2817
2818         transport_lun_remove_cmd(cmd);
2819
2820         pr_debug("Setting SAM_STAT_TASK_ABORTED status for CDB: 0x%02x,"
2821                 " ITT: 0x%08x\n", cmd->t_task_cdb[0],
2822                 cmd->se_tfo->get_task_tag(cmd));
2823
2824         trace_target_cmd_complete(cmd);
2825         cmd->se_tfo->queue_status(cmd);
2826 }
2827
2828 static void target_tmr_work(struct work_struct *work)
2829 {
2830         struct se_cmd *cmd = container_of(work, struct se_cmd, work);
2831         struct se_device *dev = cmd->se_dev;
2832         struct se_tmr_req *tmr = cmd->se_tmr_req;
2833         int ret;
2834
2835         switch (tmr->function) {
2836         case TMR_ABORT_TASK:
2837                 core_tmr_abort_task(dev, tmr, cmd->se_sess);
2838                 break;
2839         case TMR_ABORT_TASK_SET:
2840         case TMR_CLEAR_ACA:
2841         case TMR_CLEAR_TASK_SET:
2842                 tmr->response = TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED;
2843                 break;
2844         case TMR_LUN_RESET:
2845                 ret = core_tmr_lun_reset(dev, tmr, NULL, NULL);
2846                 tmr->response = (!ret) ? TMR_FUNCTION_COMPLETE :
2847                                          TMR_FUNCTION_REJECTED;
2848                 break;
2849         case TMR_TARGET_WARM_RESET:
2850                 tmr->response = TMR_FUNCTION_REJECTED;
2851                 break;
2852         case TMR_TARGET_COLD_RESET:
2853                 tmr->response = TMR_FUNCTION_REJECTED;
2854                 break;
2855         default:
2856                 pr_err("Uknown TMR function: 0x%02x.\n",
2857                                 tmr->function);
2858                 tmr->response = TMR_FUNCTION_REJECTED;
2859                 break;
2860         }
2861
2862         cmd->t_state = TRANSPORT_ISTATE_PROCESSING;
2863         cmd->se_tfo->queue_tm_rsp(cmd);
2864
2865         transport_cmd_check_stop_to_fabric(cmd);
2866 }
2867
2868 int transport_generic_handle_tmr(
2869         struct se_cmd *cmd)
2870 {
2871         unsigned long flags;
2872
2873         spin_lock_irqsave(&cmd->t_state_lock, flags);
2874         cmd->transport_state |= CMD_T_ACTIVE;
2875         spin_unlock_irqrestore(&cmd->t_state_lock, flags);
2876
2877         INIT_WORK(&cmd->work, target_tmr_work);
2878         queue_work(cmd->se_dev->tmr_wq, &cmd->work);
2879         return 0;
2880 }
2881 EXPORT_SYMBOL(transport_generic_handle_tmr);