]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - drivers/scsi/scsi_lib.c
block: introduce new block status code type
[karo-tx-linux.git] / drivers / scsi / scsi_lib.c
1 /*
2  * Copyright (C) 1999 Eric Youngdale
3  * Copyright (C) 2014 Christoph Hellwig
4  *
5  *  SCSI queueing library.
6  *      Initial versions: Eric Youngdale (eric@andante.org).
7  *                        Based upon conversations with large numbers
8  *                        of people at Linux Expo.
9  */
10
11 #include <linux/bio.h>
12 #include <linux/bitops.h>
13 #include <linux/blkdev.h>
14 #include <linux/completion.h>
15 #include <linux/kernel.h>
16 #include <linux/export.h>
17 #include <linux/init.h>
18 #include <linux/pci.h>
19 #include <linux/delay.h>
20 #include <linux/hardirq.h>
21 #include <linux/scatterlist.h>
22 #include <linux/blk-mq.h>
23 #include <linux/ratelimit.h>
24 #include <asm/unaligned.h>
25
26 #include <scsi/scsi.h>
27 #include <scsi/scsi_cmnd.h>
28 #include <scsi/scsi_dbg.h>
29 #include <scsi/scsi_device.h>
30 #include <scsi/scsi_driver.h>
31 #include <scsi/scsi_eh.h>
32 #include <scsi/scsi_host.h>
33 #include <scsi/scsi_transport.h> /* __scsi_init_queue() */
34 #include <scsi/scsi_dh.h>
35
36 #include <trace/events/scsi.h>
37
38 #include "scsi_debugfs.h"
39 #include "scsi_priv.h"
40 #include "scsi_logging.h"
41
42 static struct kmem_cache *scsi_sdb_cache;
43 static struct kmem_cache *scsi_sense_cache;
44 static struct kmem_cache *scsi_sense_isadma_cache;
45 static DEFINE_MUTEX(scsi_sense_cache_mutex);
46
47 static inline struct kmem_cache *
48 scsi_select_sense_cache(struct Scsi_Host *shost)
49 {
50         return shost->unchecked_isa_dma ?
51                 scsi_sense_isadma_cache : scsi_sense_cache;
52 }
53
54 static void scsi_free_sense_buffer(struct Scsi_Host *shost,
55                 unsigned char *sense_buffer)
56 {
57         kmem_cache_free(scsi_select_sense_cache(shost), sense_buffer);
58 }
59
60 static unsigned char *scsi_alloc_sense_buffer(struct Scsi_Host *shost,
61         gfp_t gfp_mask, int numa_node)
62 {
63         return kmem_cache_alloc_node(scsi_select_sense_cache(shost), gfp_mask,
64                         numa_node);
65 }
66
67 int scsi_init_sense_cache(struct Scsi_Host *shost)
68 {
69         struct kmem_cache *cache;
70         int ret = 0;
71
72         cache = scsi_select_sense_cache(shost);
73         if (cache)
74                 return 0;
75
76         mutex_lock(&scsi_sense_cache_mutex);
77         if (shost->unchecked_isa_dma) {
78                 scsi_sense_isadma_cache =
79                         kmem_cache_create("scsi_sense_cache(DMA)",
80                         SCSI_SENSE_BUFFERSIZE, 0,
81                         SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
82                 if (!scsi_sense_isadma_cache)
83                         ret = -ENOMEM;
84         } else {
85                 scsi_sense_cache =
86                         kmem_cache_create("scsi_sense_cache",
87                         SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN, NULL);
88                 if (!scsi_sense_cache)
89                         ret = -ENOMEM;
90         }
91
92         mutex_unlock(&scsi_sense_cache_mutex);
93         return ret;
94 }
95
96 /*
97  * When to reinvoke queueing after a resource shortage. It's 3 msecs to
98  * not change behaviour from the previous unplug mechanism, experimentation
99  * may prove this needs changing.
100  */
101 #define SCSI_QUEUE_DELAY        3
102
103 static void
104 scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
105 {
106         struct Scsi_Host *host = cmd->device->host;
107         struct scsi_device *device = cmd->device;
108         struct scsi_target *starget = scsi_target(device);
109
110         /*
111          * Set the appropriate busy bit for the device/host.
112          *
113          * If the host/device isn't busy, assume that something actually
114          * completed, and that we should be able to queue a command now.
115          *
116          * Note that the prior mid-layer assumption that any host could
117          * always queue at least one command is now broken.  The mid-layer
118          * will implement a user specifiable stall (see
119          * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
120          * if a command is requeued with no other commands outstanding
121          * either for the device or for the host.
122          */
123         switch (reason) {
124         case SCSI_MLQUEUE_HOST_BUSY:
125                 atomic_set(&host->host_blocked, host->max_host_blocked);
126                 break;
127         case SCSI_MLQUEUE_DEVICE_BUSY:
128         case SCSI_MLQUEUE_EH_RETRY:
129                 atomic_set(&device->device_blocked,
130                            device->max_device_blocked);
131                 break;
132         case SCSI_MLQUEUE_TARGET_BUSY:
133                 atomic_set(&starget->target_blocked,
134                            starget->max_target_blocked);
135                 break;
136         }
137 }
138
139 static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
140 {
141         struct scsi_device *sdev = cmd->device;
142
143         blk_mq_requeue_request(cmd->request, true);
144         put_device(&sdev->sdev_gendev);
145 }
146
147 /**
148  * __scsi_queue_insert - private queue insertion
149  * @cmd: The SCSI command being requeued
150  * @reason:  The reason for the requeue
151  * @unbusy: Whether the queue should be unbusied
152  *
153  * This is a private queue insertion.  The public interface
154  * scsi_queue_insert() always assumes the queue should be unbusied
155  * because it's always called before the completion.  This function is
156  * for a requeue after completion, which should only occur in this
157  * file.
158  */
159 static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
160 {
161         struct scsi_device *device = cmd->device;
162         struct request_queue *q = device->request_queue;
163         unsigned long flags;
164
165         SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
166                 "Inserting command %p into mlqueue\n", cmd));
167
168         scsi_set_blocked(cmd, reason);
169
170         /*
171          * Decrement the counters, since these commands are no longer
172          * active on the host/device.
173          */
174         if (unbusy)
175                 scsi_device_unbusy(device);
176
177         /*
178          * Requeue this command.  It will go before all other commands
179          * that are already in the queue. Schedule requeue work under
180          * lock such that the kblockd_schedule_work() call happens
181          * before blk_cleanup_queue() finishes.
182          */
183         cmd->result = 0;
184         if (q->mq_ops) {
185                 scsi_mq_requeue_cmd(cmd);
186                 return;
187         }
188         spin_lock_irqsave(q->queue_lock, flags);
189         blk_requeue_request(q, cmd->request);
190         kblockd_schedule_work(&device->requeue_work);
191         spin_unlock_irqrestore(q->queue_lock, flags);
192 }
193
194 /*
195  * Function:    scsi_queue_insert()
196  *
197  * Purpose:     Insert a command in the midlevel queue.
198  *
199  * Arguments:   cmd    - command that we are adding to queue.
200  *              reason - why we are inserting command to queue.
201  *
202  * Lock status: Assumed that lock is not held upon entry.
203  *
204  * Returns:     Nothing.
205  *
206  * Notes:       We do this for one of two cases.  Either the host is busy
207  *              and it cannot accept any more commands for the time being,
208  *              or the device returned QUEUE_FULL and can accept no more
209  *              commands.
210  * Notes:       This could be called either from an interrupt context or a
211  *              normal process context.
212  */
213 void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
214 {
215         __scsi_queue_insert(cmd, reason, 1);
216 }
217
218
219 /**
220  * scsi_execute - insert request and wait for the result
221  * @sdev:       scsi device
222  * @cmd:        scsi command
223  * @data_direction: data direction
224  * @buffer:     data buffer
225  * @bufflen:    len of buffer
226  * @sense:      optional sense buffer
227  * @sshdr:      optional decoded sense header
228  * @timeout:    request timeout in seconds
229  * @retries:    number of times to retry request
230  * @flags:      flags for ->cmd_flags
231  * @rq_flags:   flags for ->rq_flags
232  * @resid:      optional residual length
233  *
234  * Returns the scsi_cmnd result field if a command was executed, or a negative
235  * Linux error code if we didn't get that far.
236  */
237 int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
238                  int data_direction, void *buffer, unsigned bufflen,
239                  unsigned char *sense, struct scsi_sense_hdr *sshdr,
240                  int timeout, int retries, u64 flags, req_flags_t rq_flags,
241                  int *resid)
242 {
243         struct request *req;
244         struct scsi_request *rq;
245         int ret = DRIVER_ERROR << 24;
246
247         req = blk_get_request(sdev->request_queue,
248                         data_direction == DMA_TO_DEVICE ?
249                         REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, __GFP_RECLAIM);
250         if (IS_ERR(req))
251                 return ret;
252         rq = scsi_req(req);
253         scsi_req_init(req);
254
255         if (bufflen &&  blk_rq_map_kern(sdev->request_queue, req,
256                                         buffer, bufflen, __GFP_RECLAIM))
257                 goto out;
258
259         rq->cmd_len = COMMAND_SIZE(cmd[0]);
260         memcpy(rq->cmd, cmd, rq->cmd_len);
261         rq->retries = retries;
262         req->timeout = timeout;
263         req->cmd_flags |= flags;
264         req->rq_flags |= rq_flags | RQF_QUIET | RQF_PREEMPT;
265
266         /*
267          * head injection *required* here otherwise quiesce won't work
268          */
269         blk_execute_rq(req->q, NULL, req, 1);
270
271         /*
272          * Some devices (USB mass-storage in particular) may transfer
273          * garbage data together with a residue indicating that the data
274          * is invalid.  Prevent the garbage from being misinterpreted
275          * and prevent security leaks by zeroing out the excess data.
276          */
277         if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
278                 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
279
280         if (resid)
281                 *resid = rq->resid_len;
282         if (sense && rq->sense_len)
283                 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
284         if (sshdr)
285                 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
286         ret = rq->result;
287  out:
288         blk_put_request(req);
289
290         return ret;
291 }
292 EXPORT_SYMBOL(scsi_execute);
293
294 /*
295  * Function:    scsi_init_cmd_errh()
296  *
297  * Purpose:     Initialize cmd fields related to error handling.
298  *
299  * Arguments:   cmd     - command that is ready to be queued.
300  *
301  * Notes:       This function has the job of initializing a number of
302  *              fields related to error handling.   Typically this will
303  *              be called once for each command, as required.
304  */
305 static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
306 {
307         cmd->serial_number = 0;
308         scsi_set_resid(cmd, 0);
309         memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
310         if (cmd->cmd_len == 0)
311                 cmd->cmd_len = scsi_command_size(cmd->cmnd);
312 }
313
314 void scsi_device_unbusy(struct scsi_device *sdev)
315 {
316         struct Scsi_Host *shost = sdev->host;
317         struct scsi_target *starget = scsi_target(sdev);
318         unsigned long flags;
319
320         atomic_dec(&shost->host_busy);
321         if (starget->can_queue > 0)
322                 atomic_dec(&starget->target_busy);
323
324         if (unlikely(scsi_host_in_recovery(shost) &&
325                      (shost->host_failed || shost->host_eh_scheduled))) {
326                 spin_lock_irqsave(shost->host_lock, flags);
327                 scsi_eh_wakeup(shost);
328                 spin_unlock_irqrestore(shost->host_lock, flags);
329         }
330
331         atomic_dec(&sdev->device_busy);
332 }
333
334 static void scsi_kick_queue(struct request_queue *q)
335 {
336         if (q->mq_ops)
337                 blk_mq_start_hw_queues(q);
338         else
339                 blk_run_queue(q);
340 }
341
342 /*
343  * Called for single_lun devices on IO completion. Clear starget_sdev_user,
344  * and call blk_run_queue for all the scsi_devices on the target -
345  * including current_sdev first.
346  *
347  * Called with *no* scsi locks held.
348  */
349 static void scsi_single_lun_run(struct scsi_device *current_sdev)
350 {
351         struct Scsi_Host *shost = current_sdev->host;
352         struct scsi_device *sdev, *tmp;
353         struct scsi_target *starget = scsi_target(current_sdev);
354         unsigned long flags;
355
356         spin_lock_irqsave(shost->host_lock, flags);
357         starget->starget_sdev_user = NULL;
358         spin_unlock_irqrestore(shost->host_lock, flags);
359
360         /*
361          * Call blk_run_queue for all LUNs on the target, starting with
362          * current_sdev. We race with others (to set starget_sdev_user),
363          * but in most cases, we will be first. Ideally, each LU on the
364          * target would get some limited time or requests on the target.
365          */
366         scsi_kick_queue(current_sdev->request_queue);
367
368         spin_lock_irqsave(shost->host_lock, flags);
369         if (starget->starget_sdev_user)
370                 goto out;
371         list_for_each_entry_safe(sdev, tmp, &starget->devices,
372                         same_target_siblings) {
373                 if (sdev == current_sdev)
374                         continue;
375                 if (scsi_device_get(sdev))
376                         continue;
377
378                 spin_unlock_irqrestore(shost->host_lock, flags);
379                 scsi_kick_queue(sdev->request_queue);
380                 spin_lock_irqsave(shost->host_lock, flags);
381         
382                 scsi_device_put(sdev);
383         }
384  out:
385         spin_unlock_irqrestore(shost->host_lock, flags);
386 }
387
388 static inline bool scsi_device_is_busy(struct scsi_device *sdev)
389 {
390         if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
391                 return true;
392         if (atomic_read(&sdev->device_blocked) > 0)
393                 return true;
394         return false;
395 }
396
397 static inline bool scsi_target_is_busy(struct scsi_target *starget)
398 {
399         if (starget->can_queue > 0) {
400                 if (atomic_read(&starget->target_busy) >= starget->can_queue)
401                         return true;
402                 if (atomic_read(&starget->target_blocked) > 0)
403                         return true;
404         }
405         return false;
406 }
407
408 static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
409 {
410         if (shost->can_queue > 0 &&
411             atomic_read(&shost->host_busy) >= shost->can_queue)
412                 return true;
413         if (atomic_read(&shost->host_blocked) > 0)
414                 return true;
415         if (shost->host_self_blocked)
416                 return true;
417         return false;
418 }
419
420 static void scsi_starved_list_run(struct Scsi_Host *shost)
421 {
422         LIST_HEAD(starved_list);
423         struct scsi_device *sdev;
424         unsigned long flags;
425
426         spin_lock_irqsave(shost->host_lock, flags);
427         list_splice_init(&shost->starved_list, &starved_list);
428
429         while (!list_empty(&starved_list)) {
430                 struct request_queue *slq;
431
432                 /*
433                  * As long as shost is accepting commands and we have
434                  * starved queues, call blk_run_queue. scsi_request_fn
435                  * drops the queue_lock and can add us back to the
436                  * starved_list.
437                  *
438                  * host_lock protects the starved_list and starved_entry.
439                  * scsi_request_fn must get the host_lock before checking
440                  * or modifying starved_list or starved_entry.
441                  */
442                 if (scsi_host_is_busy(shost))
443                         break;
444
445                 sdev = list_entry(starved_list.next,
446                                   struct scsi_device, starved_entry);
447                 list_del_init(&sdev->starved_entry);
448                 if (scsi_target_is_busy(scsi_target(sdev))) {
449                         list_move_tail(&sdev->starved_entry,
450                                        &shost->starved_list);
451                         continue;
452                 }
453
454                 /*
455                  * Once we drop the host lock, a racing scsi_remove_device()
456                  * call may remove the sdev from the starved list and destroy
457                  * it and the queue.  Mitigate by taking a reference to the
458                  * queue and never touching the sdev again after we drop the
459                  * host lock.  Note: if __scsi_remove_device() invokes
460                  * blk_cleanup_queue() before the queue is run from this
461                  * function then blk_run_queue() will return immediately since
462                  * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
463                  */
464                 slq = sdev->request_queue;
465                 if (!blk_get_queue(slq))
466                         continue;
467                 spin_unlock_irqrestore(shost->host_lock, flags);
468
469                 scsi_kick_queue(slq);
470                 blk_put_queue(slq);
471
472                 spin_lock_irqsave(shost->host_lock, flags);
473         }
474         /* put any unprocessed entries back */
475         list_splice(&starved_list, &shost->starved_list);
476         spin_unlock_irqrestore(shost->host_lock, flags);
477 }
478
479 /*
480  * Function:   scsi_run_queue()
481  *
482  * Purpose:    Select a proper request queue to serve next
483  *
484  * Arguments:  q       - last request's queue
485  *
486  * Returns:     Nothing
487  *
488  * Notes:      The previous command was completely finished, start
489  *             a new one if possible.
490  */
491 static void scsi_run_queue(struct request_queue *q)
492 {
493         struct scsi_device *sdev = q->queuedata;
494
495         if (scsi_target(sdev)->single_lun)
496                 scsi_single_lun_run(sdev);
497         if (!list_empty(&sdev->host->starved_list))
498                 scsi_starved_list_run(sdev->host);
499
500         if (q->mq_ops)
501                 blk_mq_run_hw_queues(q, false);
502         else
503                 blk_run_queue(q);
504 }
505
506 void scsi_requeue_run_queue(struct work_struct *work)
507 {
508         struct scsi_device *sdev;
509         struct request_queue *q;
510
511         sdev = container_of(work, struct scsi_device, requeue_work);
512         q = sdev->request_queue;
513         scsi_run_queue(q);
514 }
515
516 /*
517  * Function:    scsi_requeue_command()
518  *
519  * Purpose:     Handle post-processing of completed commands.
520  *
521  * Arguments:   q       - queue to operate on
522  *              cmd     - command that may need to be requeued.
523  *
524  * Returns:     Nothing
525  *
526  * Notes:       After command completion, there may be blocks left
527  *              over which weren't finished by the previous command
528  *              this can be for a number of reasons - the main one is
529  *              I/O errors in the middle of the request, in which case
530  *              we need to request the blocks that come after the bad
531  *              sector.
532  * Notes:       Upon return, cmd is a stale pointer.
533  */
534 static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
535 {
536         struct scsi_device *sdev = cmd->device;
537         struct request *req = cmd->request;
538         unsigned long flags;
539
540         spin_lock_irqsave(q->queue_lock, flags);
541         blk_unprep_request(req);
542         req->special = NULL;
543         scsi_put_command(cmd);
544         blk_requeue_request(q, req);
545         spin_unlock_irqrestore(q->queue_lock, flags);
546
547         scsi_run_queue(q);
548
549         put_device(&sdev->sdev_gendev);
550 }
551
552 void scsi_run_host_queues(struct Scsi_Host *shost)
553 {
554         struct scsi_device *sdev;
555
556         shost_for_each_device(sdev, shost)
557                 scsi_run_queue(sdev->request_queue);
558 }
559
560 static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
561 {
562         if (!blk_rq_is_passthrough(cmd->request)) {
563                 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
564
565                 if (drv->uninit_command)
566                         drv->uninit_command(cmd);
567         }
568 }
569
570 static void scsi_mq_free_sgtables(struct scsi_cmnd *cmd)
571 {
572         struct scsi_data_buffer *sdb;
573
574         if (cmd->sdb.table.nents)
575                 sg_free_table_chained(&cmd->sdb.table, true);
576         if (cmd->request->next_rq) {
577                 sdb = cmd->request->next_rq->special;
578                 if (sdb)
579                         sg_free_table_chained(&sdb->table, true);
580         }
581         if (scsi_prot_sg_count(cmd))
582                 sg_free_table_chained(&cmd->prot_sdb->table, true);
583 }
584
585 static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
586 {
587         struct scsi_device *sdev = cmd->device;
588         struct Scsi_Host *shost = sdev->host;
589         unsigned long flags;
590
591         scsi_mq_free_sgtables(cmd);
592         scsi_uninit_cmd(cmd);
593
594         if (shost->use_cmd_list) {
595                 BUG_ON(list_empty(&cmd->list));
596                 spin_lock_irqsave(&sdev->list_lock, flags);
597                 list_del_init(&cmd->list);
598                 spin_unlock_irqrestore(&sdev->list_lock, flags);
599         }
600 }
601
602 /*
603  * Function:    scsi_release_buffers()
604  *
605  * Purpose:     Free resources allocate for a scsi_command.
606  *
607  * Arguments:   cmd     - command that we are bailing.
608  *
609  * Lock status: Assumed that no lock is held upon entry.
610  *
611  * Returns:     Nothing
612  *
613  * Notes:       In the event that an upper level driver rejects a
614  *              command, we must release resources allocated during
615  *              the __init_io() function.  Primarily this would involve
616  *              the scatter-gather table.
617  */
618 static void scsi_release_buffers(struct scsi_cmnd *cmd)
619 {
620         if (cmd->sdb.table.nents)
621                 sg_free_table_chained(&cmd->sdb.table, false);
622
623         memset(&cmd->sdb, 0, sizeof(cmd->sdb));
624
625         if (scsi_prot_sg_count(cmd))
626                 sg_free_table_chained(&cmd->prot_sdb->table, false);
627 }
628
629 static void scsi_release_bidi_buffers(struct scsi_cmnd *cmd)
630 {
631         struct scsi_data_buffer *bidi_sdb = cmd->request->next_rq->special;
632
633         sg_free_table_chained(&bidi_sdb->table, false);
634         kmem_cache_free(scsi_sdb_cache, bidi_sdb);
635         cmd->request->next_rq->special = NULL;
636 }
637
638 static bool scsi_end_request(struct request *req, blk_status_t error,
639                 unsigned int bytes, unsigned int bidi_bytes)
640 {
641         struct scsi_cmnd *cmd = req->special;
642         struct scsi_device *sdev = cmd->device;
643         struct request_queue *q = sdev->request_queue;
644
645         if (blk_update_request(req, error, bytes))
646                 return true;
647
648         /* Bidi request must be completed as a whole */
649         if (unlikely(bidi_bytes) &&
650             blk_update_request(req->next_rq, error, bidi_bytes))
651                 return true;
652
653         if (blk_queue_add_random(q))
654                 add_disk_randomness(req->rq_disk);
655
656         if (req->mq_ctx) {
657                 /*
658                  * In the MQ case the command gets freed by __blk_mq_end_request,
659                  * so we have to do all cleanup that depends on it earlier.
660                  *
661                  * We also can't kick the queues from irq context, so we
662                  * will have to defer it to a workqueue.
663                  */
664                 scsi_mq_uninit_cmd(cmd);
665
666                 __blk_mq_end_request(req, error);
667
668                 if (scsi_target(sdev)->single_lun ||
669                     !list_empty(&sdev->host->starved_list))
670                         kblockd_schedule_work(&sdev->requeue_work);
671                 else
672                         blk_mq_run_hw_queues(q, true);
673         } else {
674                 unsigned long flags;
675
676                 if (bidi_bytes)
677                         scsi_release_bidi_buffers(cmd);
678                 scsi_release_buffers(cmd);
679                 scsi_put_command(cmd);
680
681                 spin_lock_irqsave(q->queue_lock, flags);
682                 blk_finish_request(req, error);
683                 spin_unlock_irqrestore(q->queue_lock, flags);
684
685                 scsi_run_queue(q);
686         }
687
688         put_device(&sdev->sdev_gendev);
689         return false;
690 }
691
692 /**
693  * __scsi_error_from_host_byte - translate SCSI error code into errno
694  * @cmd:        SCSI command (unused)
695  * @result:     scsi error code
696  *
697  * Translate SCSI error code into block errors.
698  */
699 static blk_status_t __scsi_error_from_host_byte(struct scsi_cmnd *cmd,
700                 int result)
701 {
702         switch (host_byte(result)) {
703         case DID_TRANSPORT_FAILFAST:
704                 return BLK_STS_TRANSPORT;
705         case DID_TARGET_FAILURE:
706                 set_host_byte(cmd, DID_OK);
707                 return BLK_STS_TARGET;
708         case DID_NEXUS_FAILURE:
709                 return BLK_STS_NEXUS;
710         case DID_ALLOC_FAILURE:
711                 set_host_byte(cmd, DID_OK);
712                 return BLK_STS_NOSPC;
713         case DID_MEDIUM_ERROR:
714                 set_host_byte(cmd, DID_OK);
715                 return BLK_STS_MEDIUM;
716         default:
717                 return BLK_STS_IOERR;
718         }
719 }
720
721 /*
722  * Function:    scsi_io_completion()
723  *
724  * Purpose:     Completion processing for block device I/O requests.
725  *
726  * Arguments:   cmd   - command that is finished.
727  *
728  * Lock status: Assumed that no lock is held upon entry.
729  *
730  * Returns:     Nothing
731  *
732  * Notes:       We will finish off the specified number of sectors.  If we
733  *              are done, the command block will be released and the queue
734  *              function will be goosed.  If we are not done then we have to
735  *              figure out what to do next:
736  *
737  *              a) We can call scsi_requeue_command().  The request
738  *                 will be unprepared and put back on the queue.  Then
739  *                 a new command will be created for it.  This should
740  *                 be used if we made forward progress, or if we want
741  *                 to switch from READ(10) to READ(6) for example.
742  *
743  *              b) We can call __scsi_queue_insert().  The request will
744  *                 be put back on the queue and retried using the same
745  *                 command as before, possibly after a delay.
746  *
747  *              c) We can call scsi_end_request() with -EIO to fail
748  *                 the remainder of the request.
749  */
750 void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
751 {
752         int result = cmd->result;
753         struct request_queue *q = cmd->device->request_queue;
754         struct request *req = cmd->request;
755         blk_status_t error = BLK_STS_OK;
756         struct scsi_sense_hdr sshdr;
757         bool sense_valid = false;
758         int sense_deferred = 0, level = 0;
759         enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
760               ACTION_DELAYED_RETRY} action;
761         unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
762
763         if (result) {
764                 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
765                 if (sense_valid)
766                         sense_deferred = scsi_sense_is_deferred(&sshdr);
767         }
768
769         if (blk_rq_is_passthrough(req)) {
770                 if (result) {
771                         if (sense_valid) {
772                                 /*
773                                  * SG_IO wants current and deferred errors
774                                  */
775                                 scsi_req(req)->sense_len =
776                                         min(8 + cmd->sense_buffer[7],
777                                             SCSI_SENSE_BUFFERSIZE);
778                         }
779                         if (!sense_deferred)
780                                 error = __scsi_error_from_host_byte(cmd, result);
781                 }
782                 /*
783                  * __scsi_error_from_host_byte may have reset the host_byte
784                  */
785                 scsi_req(req)->result = cmd->result;
786                 scsi_req(req)->resid_len = scsi_get_resid(cmd);
787
788                 if (scsi_bidi_cmnd(cmd)) {
789                         /*
790                          * Bidi commands Must be complete as a whole,
791                          * both sides at once.
792                          */
793                         scsi_req(req->next_rq)->resid_len = scsi_in(cmd)->resid;
794                         if (scsi_end_request(req, BLK_STS_OK, blk_rq_bytes(req),
795                                         blk_rq_bytes(req->next_rq)))
796                                 BUG();
797                         return;
798                 }
799         } else if (blk_rq_bytes(req) == 0 && result && !sense_deferred) {
800                 /*
801                  * Flush commands do not transfers any data, and thus cannot use
802                  * good_bytes != blk_rq_bytes(req) as the signal for an error.
803                  * This sets the error explicitly for the problem case.
804                  */
805                 error = __scsi_error_from_host_byte(cmd, result);
806         }
807
808         /* no bidi support for !blk_rq_is_passthrough yet */
809         BUG_ON(blk_bidi_rq(req));
810
811         /*
812          * Next deal with any sectors which we were able to correctly
813          * handle.
814          */
815         SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
816                 "%u sectors total, %d bytes done.\n",
817                 blk_rq_sectors(req), good_bytes));
818
819         /*
820          * Recovered errors need reporting, but they're always treated as
821          * success, so fiddle the result code here.  For passthrough requests
822          * we already took a copy of the original into sreq->result which
823          * is what gets returned to the user
824          */
825         if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
826                 /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
827                  * print since caller wants ATA registers. Only occurs on
828                  * SCSI ATA PASS_THROUGH commands when CK_COND=1
829                  */
830                 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
831                         ;
832                 else if (!(req->rq_flags & RQF_QUIET))
833                         scsi_print_sense(cmd);
834                 result = 0;
835                 /* for passthrough error may be set */
836                 error = BLK_STS_OK;
837         }
838
839         /*
840          * special case: failed zero length commands always need to
841          * drop down into the retry code. Otherwise, if we finished
842          * all bytes in the request we are done now.
843          */
844         if (!(blk_rq_bytes(req) == 0 && error) &&
845             !scsi_end_request(req, error, good_bytes, 0))
846                 return;
847
848         /*
849          * Kill remainder if no retrys.
850          */
851         if (error && scsi_noretry_cmd(cmd)) {
852                 if (scsi_end_request(req, error, blk_rq_bytes(req), 0))
853                         BUG();
854                 return;
855         }
856
857         /*
858          * If there had been no error, but we have leftover bytes in the
859          * requeues just queue the command up again.
860          */
861         if (result == 0)
862                 goto requeue;
863
864         error = __scsi_error_from_host_byte(cmd, result);
865
866         if (host_byte(result) == DID_RESET) {
867                 /* Third party bus reset or reset for error recovery
868                  * reasons.  Just retry the command and see what
869                  * happens.
870                  */
871                 action = ACTION_RETRY;
872         } else if (sense_valid && !sense_deferred) {
873                 switch (sshdr.sense_key) {
874                 case UNIT_ATTENTION:
875                         if (cmd->device->removable) {
876                                 /* Detected disc change.  Set a bit
877                                  * and quietly refuse further access.
878                                  */
879                                 cmd->device->changed = 1;
880                                 action = ACTION_FAIL;
881                         } else {
882                                 /* Must have been a power glitch, or a
883                                  * bus reset.  Could not have been a
884                                  * media change, so we just retry the
885                                  * command and see what happens.
886                                  */
887                                 action = ACTION_RETRY;
888                         }
889                         break;
890                 case ILLEGAL_REQUEST:
891                         /* If we had an ILLEGAL REQUEST returned, then
892                          * we may have performed an unsupported
893                          * command.  The only thing this should be
894                          * would be a ten byte read where only a six
895                          * byte read was supported.  Also, on a system
896                          * where READ CAPACITY failed, we may have
897                          * read past the end of the disk.
898                          */
899                         if ((cmd->device->use_10_for_rw &&
900                             sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
901                             (cmd->cmnd[0] == READ_10 ||
902                              cmd->cmnd[0] == WRITE_10)) {
903                                 /* This will issue a new 6-byte command. */
904                                 cmd->device->use_10_for_rw = 0;
905                                 action = ACTION_REPREP;
906                         } else if (sshdr.asc == 0x10) /* DIX */ {
907                                 action = ACTION_FAIL;
908                                 error = BLK_STS_PROTECTION;
909                         /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
910                         } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
911                                 action = ACTION_FAIL;
912                                 error = BLK_STS_TARGET;
913                         } else
914                                 action = ACTION_FAIL;
915                         break;
916                 case ABORTED_COMMAND:
917                         action = ACTION_FAIL;
918                         if (sshdr.asc == 0x10) /* DIF */
919                                 error = BLK_STS_PROTECTION;
920                         break;
921                 case NOT_READY:
922                         /* If the device is in the process of becoming
923                          * ready, or has a temporary blockage, retry.
924                          */
925                         if (sshdr.asc == 0x04) {
926                                 switch (sshdr.ascq) {
927                                 case 0x01: /* becoming ready */
928                                 case 0x04: /* format in progress */
929                                 case 0x05: /* rebuild in progress */
930                                 case 0x06: /* recalculation in progress */
931                                 case 0x07: /* operation in progress */
932                                 case 0x08: /* Long write in progress */
933                                 case 0x09: /* self test in progress */
934                                 case 0x14: /* space allocation in progress */
935                                         action = ACTION_DELAYED_RETRY;
936                                         break;
937                                 default:
938                                         action = ACTION_FAIL;
939                                         break;
940                                 }
941                         } else
942                                 action = ACTION_FAIL;
943                         break;
944                 case VOLUME_OVERFLOW:
945                         /* See SSC3rXX or current. */
946                         action = ACTION_FAIL;
947                         break;
948                 default:
949                         action = ACTION_FAIL;
950                         break;
951                 }
952         } else
953                 action = ACTION_FAIL;
954
955         if (action != ACTION_FAIL &&
956             time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
957                 action = ACTION_FAIL;
958
959         switch (action) {
960         case ACTION_FAIL:
961                 /* Give up and fail the remainder of the request */
962                 if (!(req->rq_flags & RQF_QUIET)) {
963                         static DEFINE_RATELIMIT_STATE(_rs,
964                                         DEFAULT_RATELIMIT_INTERVAL,
965                                         DEFAULT_RATELIMIT_BURST);
966
967                         if (unlikely(scsi_logging_level))
968                                 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
969                                                        SCSI_LOG_MLCOMPLETE_BITS);
970
971                         /*
972                          * if logging is enabled the failure will be printed
973                          * in scsi_log_completion(), so avoid duplicate messages
974                          */
975                         if (!level && __ratelimit(&_rs)) {
976                                 scsi_print_result(cmd, NULL, FAILED);
977                                 if (driver_byte(result) & DRIVER_SENSE)
978                                         scsi_print_sense(cmd);
979                                 scsi_print_command(cmd);
980                         }
981                 }
982                 if (!scsi_end_request(req, error, blk_rq_err_bytes(req), 0))
983                         return;
984                 /*FALLTHRU*/
985         case ACTION_REPREP:
986         requeue:
987                 /* Unprep the request and put it back at the head of the queue.
988                  * A new command will be prepared and issued.
989                  */
990                 if (q->mq_ops) {
991                         cmd->request->rq_flags &= ~RQF_DONTPREP;
992                         scsi_mq_uninit_cmd(cmd);
993                         scsi_mq_requeue_cmd(cmd);
994                 } else {
995                         scsi_release_buffers(cmd);
996                         scsi_requeue_command(q, cmd);
997                 }
998                 break;
999         case ACTION_RETRY:
1000                 /* Retry the same command immediately */
1001                 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
1002                 break;
1003         case ACTION_DELAYED_RETRY:
1004                 /* Retry the same command after a delay */
1005                 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
1006                 break;
1007         }
1008 }
1009
1010 static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb)
1011 {
1012         int count;
1013
1014         /*
1015          * If sg table allocation fails, requeue request later.
1016          */
1017         if (unlikely(sg_alloc_table_chained(&sdb->table,
1018                         blk_rq_nr_phys_segments(req), sdb->table.sgl)))
1019                 return BLKPREP_DEFER;
1020
1021         /* 
1022          * Next, walk the list, and fill in the addresses and sizes of
1023          * each segment.
1024          */
1025         count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1026         BUG_ON(count > sdb->table.nents);
1027         sdb->table.nents = count;
1028         sdb->length = blk_rq_payload_bytes(req);
1029         return BLKPREP_OK;
1030 }
1031
1032 /*
1033  * Function:    scsi_init_io()
1034  *
1035  * Purpose:     SCSI I/O initialize function.
1036  *
1037  * Arguments:   cmd   - Command descriptor we wish to initialize
1038  *
1039  * Returns:     0 on success
1040  *              BLKPREP_DEFER if the failure is retryable
1041  *              BLKPREP_KILL if the failure is fatal
1042  */
1043 int scsi_init_io(struct scsi_cmnd *cmd)
1044 {
1045         struct scsi_device *sdev = cmd->device;
1046         struct request *rq = cmd->request;
1047         bool is_mq = (rq->mq_ctx != NULL);
1048         int error = BLKPREP_KILL;
1049
1050         if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
1051                 goto err_exit;
1052
1053         error = scsi_init_sgtable(rq, &cmd->sdb);
1054         if (error)
1055                 goto err_exit;
1056
1057         if (blk_bidi_rq(rq)) {
1058                 if (!rq->q->mq_ops) {
1059                         struct scsi_data_buffer *bidi_sdb =
1060                                 kmem_cache_zalloc(scsi_sdb_cache, GFP_ATOMIC);
1061                         if (!bidi_sdb) {
1062                                 error = BLKPREP_DEFER;
1063                                 goto err_exit;
1064                         }
1065
1066                         rq->next_rq->special = bidi_sdb;
1067                 }
1068
1069                 error = scsi_init_sgtable(rq->next_rq, rq->next_rq->special);
1070                 if (error)
1071                         goto err_exit;
1072         }
1073
1074         if (blk_integrity_rq(rq)) {
1075                 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1076                 int ivecs, count;
1077
1078                 if (prot_sdb == NULL) {
1079                         /*
1080                          * This can happen if someone (e.g. multipath)
1081                          * queues a command to a device on an adapter
1082                          * that does not support DIX.
1083                          */
1084                         WARN_ON_ONCE(1);
1085                         error = BLKPREP_KILL;
1086                         goto err_exit;
1087                 }
1088
1089                 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
1090
1091                 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
1092                                 prot_sdb->table.sgl)) {
1093                         error = BLKPREP_DEFER;
1094                         goto err_exit;
1095                 }
1096
1097                 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
1098                                                 prot_sdb->table.sgl);
1099                 BUG_ON(unlikely(count > ivecs));
1100                 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
1101
1102                 cmd->prot_sdb = prot_sdb;
1103                 cmd->prot_sdb->table.nents = count;
1104         }
1105
1106         return BLKPREP_OK;
1107 err_exit:
1108         if (is_mq) {
1109                 scsi_mq_free_sgtables(cmd);
1110         } else {
1111                 scsi_release_buffers(cmd);
1112                 cmd->request->special = NULL;
1113                 scsi_put_command(cmd);
1114                 put_device(&sdev->sdev_gendev);
1115         }
1116         return error;
1117 }
1118 EXPORT_SYMBOL(scsi_init_io);
1119
1120 void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
1121 {
1122         void *buf = cmd->sense_buffer;
1123         void *prot = cmd->prot_sdb;
1124         unsigned long flags;
1125
1126         /* zero out the cmd, except for the embedded scsi_request */
1127         memset((char *)cmd + sizeof(cmd->req), 0,
1128                 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
1129
1130         cmd->device = dev;
1131         cmd->sense_buffer = buf;
1132         cmd->prot_sdb = prot;
1133         INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1134         cmd->jiffies_at_alloc = jiffies;
1135
1136         spin_lock_irqsave(&dev->list_lock, flags);
1137         list_add_tail(&cmd->list, &dev->cmd_list);
1138         spin_unlock_irqrestore(&dev->list_lock, flags);
1139 }
1140
1141 static int scsi_setup_scsi_cmnd(struct scsi_device *sdev, struct request *req)
1142 {
1143         struct scsi_cmnd *cmd = req->special;
1144
1145         /*
1146          * Passthrough requests may transfer data, in which case they must
1147          * a bio attached to them.  Or they might contain a SCSI command
1148          * that does not transfer data, in which case they may optionally
1149          * submit a request without an attached bio.
1150          */
1151         if (req->bio) {
1152                 int ret = scsi_init_io(cmd);
1153                 if (unlikely(ret))
1154                         return ret;
1155         } else {
1156                 BUG_ON(blk_rq_bytes(req));
1157
1158                 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
1159         }
1160
1161         cmd->cmd_len = scsi_req(req)->cmd_len;
1162         cmd->cmnd = scsi_req(req)->cmd;
1163         cmd->transfersize = blk_rq_bytes(req);
1164         cmd->allowed = scsi_req(req)->retries;
1165         return BLKPREP_OK;
1166 }
1167
1168 /*
1169  * Setup a normal block command.  These are simple request from filesystems
1170  * that still need to be translated to SCSI CDBs from the ULD.
1171  */
1172 static int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
1173 {
1174         struct scsi_cmnd *cmd = req->special;
1175
1176         if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
1177                 int ret = sdev->handler->prep_fn(sdev, req);
1178                 if (ret != BLKPREP_OK)
1179                         return ret;
1180         }
1181
1182         cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
1183         memset(cmd->cmnd, 0, BLK_MAX_CDB);
1184         return scsi_cmd_to_driver(cmd)->init_command(cmd);
1185 }
1186
1187 static int scsi_setup_cmnd(struct scsi_device *sdev, struct request *req)
1188 {
1189         struct scsi_cmnd *cmd = req->special;
1190
1191         if (!blk_rq_bytes(req))
1192                 cmd->sc_data_direction = DMA_NONE;
1193         else if (rq_data_dir(req) == WRITE)
1194                 cmd->sc_data_direction = DMA_TO_DEVICE;
1195         else
1196                 cmd->sc_data_direction = DMA_FROM_DEVICE;
1197
1198         if (blk_rq_is_scsi(req))
1199                 return scsi_setup_scsi_cmnd(sdev, req);
1200         else
1201                 return scsi_setup_fs_cmnd(sdev, req);
1202 }
1203
1204 static int
1205 scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
1206 {
1207         int ret = BLKPREP_OK;
1208
1209         /*
1210          * If the device is not in running state we will reject some
1211          * or all commands.
1212          */
1213         if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1214                 switch (sdev->sdev_state) {
1215                 case SDEV_OFFLINE:
1216                 case SDEV_TRANSPORT_OFFLINE:
1217                         /*
1218                          * If the device is offline we refuse to process any
1219                          * commands.  The device must be brought online
1220                          * before trying any recovery commands.
1221                          */
1222                         sdev_printk(KERN_ERR, sdev,
1223                                     "rejecting I/O to offline device\n");
1224                         ret = BLKPREP_KILL;
1225                         break;
1226                 case SDEV_DEL:
1227                         /*
1228                          * If the device is fully deleted, we refuse to
1229                          * process any commands as well.
1230                          */
1231                         sdev_printk(KERN_ERR, sdev,
1232                                     "rejecting I/O to dead device\n");
1233                         ret = BLKPREP_KILL;
1234                         break;
1235                 case SDEV_BLOCK:
1236                 case SDEV_CREATED_BLOCK:
1237                         ret = BLKPREP_DEFER;
1238                         break;
1239                 case SDEV_QUIESCE:
1240                         /*
1241                          * If the devices is blocked we defer normal commands.
1242                          */
1243                         if (!(req->rq_flags & RQF_PREEMPT))
1244                                 ret = BLKPREP_DEFER;
1245                         break;
1246                 default:
1247                         /*
1248                          * For any other not fully online state we only allow
1249                          * special commands.  In particular any user initiated
1250                          * command is not allowed.
1251                          */
1252                         if (!(req->rq_flags & RQF_PREEMPT))
1253                                 ret = BLKPREP_KILL;
1254                         break;
1255                 }
1256         }
1257         return ret;
1258 }
1259
1260 static int
1261 scsi_prep_return(struct request_queue *q, struct request *req, int ret)
1262 {
1263         struct scsi_device *sdev = q->queuedata;
1264
1265         switch (ret) {
1266         case BLKPREP_KILL:
1267         case BLKPREP_INVALID:
1268                 scsi_req(req)->result = DID_NO_CONNECT << 16;
1269                 /* release the command and kill it */
1270                 if (req->special) {
1271                         struct scsi_cmnd *cmd = req->special;
1272                         scsi_release_buffers(cmd);
1273                         scsi_put_command(cmd);
1274                         put_device(&sdev->sdev_gendev);
1275                         req->special = NULL;
1276                 }
1277                 break;
1278         case BLKPREP_DEFER:
1279                 /*
1280                  * If we defer, the blk_peek_request() returns NULL, but the
1281                  * queue must be restarted, so we schedule a callback to happen
1282                  * shortly.
1283                  */
1284                 if (atomic_read(&sdev->device_busy) == 0)
1285                         blk_delay_queue(q, SCSI_QUEUE_DELAY);
1286                 break;
1287         default:
1288                 req->rq_flags |= RQF_DONTPREP;
1289         }
1290
1291         return ret;
1292 }
1293
1294 static int scsi_prep_fn(struct request_queue *q, struct request *req)
1295 {
1296         struct scsi_device *sdev = q->queuedata;
1297         struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1298         int ret;
1299
1300         ret = scsi_prep_state_check(sdev, req);
1301         if (ret != BLKPREP_OK)
1302                 goto out;
1303
1304         if (!req->special) {
1305                 /* Bail if we can't get a reference to the device */
1306                 if (unlikely(!get_device(&sdev->sdev_gendev))) {
1307                         ret = BLKPREP_DEFER;
1308                         goto out;
1309                 }
1310
1311                 scsi_init_command(sdev, cmd);
1312                 req->special = cmd;
1313         }
1314
1315         cmd->tag = req->tag;
1316         cmd->request = req;
1317         cmd->prot_op = SCSI_PROT_NORMAL;
1318
1319         ret = scsi_setup_cmnd(sdev, req);
1320 out:
1321         return scsi_prep_return(q, req, ret);
1322 }
1323
1324 static void scsi_unprep_fn(struct request_queue *q, struct request *req)
1325 {
1326         scsi_uninit_cmd(req->special);
1327 }
1328
1329 /*
1330  * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1331  * return 0.
1332  *
1333  * Called with the queue_lock held.
1334  */
1335 static inline int scsi_dev_queue_ready(struct request_queue *q,
1336                                   struct scsi_device *sdev)
1337 {
1338         unsigned int busy;
1339
1340         busy = atomic_inc_return(&sdev->device_busy) - 1;
1341         if (atomic_read(&sdev->device_blocked)) {
1342                 if (busy)
1343                         goto out_dec;
1344
1345                 /*
1346                  * unblock after device_blocked iterates to zero
1347                  */
1348                 if (atomic_dec_return(&sdev->device_blocked) > 0) {
1349                         /*
1350                          * For the MQ case we take care of this in the caller.
1351                          */
1352                         if (!q->mq_ops)
1353                                 blk_delay_queue(q, SCSI_QUEUE_DELAY);
1354                         goto out_dec;
1355                 }
1356                 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1357                                    "unblocking device at zero depth\n"));
1358         }
1359
1360         if (busy >= sdev->queue_depth)
1361                 goto out_dec;
1362
1363         return 1;
1364 out_dec:
1365         atomic_dec(&sdev->device_busy);
1366         return 0;
1367 }
1368
1369 /*
1370  * scsi_target_queue_ready: checks if there we can send commands to target
1371  * @sdev: scsi device on starget to check.
1372  */
1373 static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1374                                            struct scsi_device *sdev)
1375 {
1376         struct scsi_target *starget = scsi_target(sdev);
1377         unsigned int busy;
1378
1379         if (starget->single_lun) {
1380                 spin_lock_irq(shost->host_lock);
1381                 if (starget->starget_sdev_user &&
1382                     starget->starget_sdev_user != sdev) {
1383                         spin_unlock_irq(shost->host_lock);
1384                         return 0;
1385                 }
1386                 starget->starget_sdev_user = sdev;
1387                 spin_unlock_irq(shost->host_lock);
1388         }
1389
1390         if (starget->can_queue <= 0)
1391                 return 1;
1392
1393         busy = atomic_inc_return(&starget->target_busy) - 1;
1394         if (atomic_read(&starget->target_blocked) > 0) {
1395                 if (busy)
1396                         goto starved;
1397
1398                 /*
1399                  * unblock after target_blocked iterates to zero
1400                  */
1401                 if (atomic_dec_return(&starget->target_blocked) > 0)
1402                         goto out_dec;
1403
1404                 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1405                                  "unblocking target at zero depth\n"));
1406         }
1407
1408         if (busy >= starget->can_queue)
1409                 goto starved;
1410
1411         return 1;
1412
1413 starved:
1414         spin_lock_irq(shost->host_lock);
1415         list_move_tail(&sdev->starved_entry, &shost->starved_list);
1416         spin_unlock_irq(shost->host_lock);
1417 out_dec:
1418         if (starget->can_queue > 0)
1419                 atomic_dec(&starget->target_busy);
1420         return 0;
1421 }
1422
1423 /*
1424  * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1425  * return 0. We must end up running the queue again whenever 0 is
1426  * returned, else IO can hang.
1427  */
1428 static inline int scsi_host_queue_ready(struct request_queue *q,
1429                                    struct Scsi_Host *shost,
1430                                    struct scsi_device *sdev)
1431 {
1432         unsigned int busy;
1433
1434         if (scsi_host_in_recovery(shost))
1435                 return 0;
1436
1437         busy = atomic_inc_return(&shost->host_busy) - 1;
1438         if (atomic_read(&shost->host_blocked) > 0) {
1439                 if (busy)
1440                         goto starved;
1441
1442                 /*
1443                  * unblock after host_blocked iterates to zero
1444                  */
1445                 if (atomic_dec_return(&shost->host_blocked) > 0)
1446                         goto out_dec;
1447
1448                 SCSI_LOG_MLQUEUE(3,
1449                         shost_printk(KERN_INFO, shost,
1450                                      "unblocking host at zero depth\n"));
1451         }
1452
1453         if (shost->can_queue > 0 && busy >= shost->can_queue)
1454                 goto starved;
1455         if (shost->host_self_blocked)
1456                 goto starved;
1457
1458         /* We're OK to process the command, so we can't be starved */
1459         if (!list_empty(&sdev->starved_entry)) {
1460                 spin_lock_irq(shost->host_lock);
1461                 if (!list_empty(&sdev->starved_entry))
1462                         list_del_init(&sdev->starved_entry);
1463                 spin_unlock_irq(shost->host_lock);
1464         }
1465
1466         return 1;
1467
1468 starved:
1469         spin_lock_irq(shost->host_lock);
1470         if (list_empty(&sdev->starved_entry))
1471                 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1472         spin_unlock_irq(shost->host_lock);
1473 out_dec:
1474         atomic_dec(&shost->host_busy);
1475         return 0;
1476 }
1477
1478 /*
1479  * Busy state exporting function for request stacking drivers.
1480  *
1481  * For efficiency, no lock is taken to check the busy state of
1482  * shost/starget/sdev, since the returned value is not guaranteed and
1483  * may be changed after request stacking drivers call the function,
1484  * regardless of taking lock or not.
1485  *
1486  * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1487  * needs to return 'not busy'. Otherwise, request stacking drivers
1488  * may hold requests forever.
1489  */
1490 static int scsi_lld_busy(struct request_queue *q)
1491 {
1492         struct scsi_device *sdev = q->queuedata;
1493         struct Scsi_Host *shost;
1494
1495         if (blk_queue_dying(q))
1496                 return 0;
1497
1498         shost = sdev->host;
1499
1500         /*
1501          * Ignore host/starget busy state.
1502          * Since block layer does not have a concept of fairness across
1503          * multiple queues, congestion of host/starget needs to be handled
1504          * in SCSI layer.
1505          */
1506         if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
1507                 return 1;
1508
1509         return 0;
1510 }
1511
1512 /*
1513  * Kill a request for a dead device
1514  */
1515 static void scsi_kill_request(struct request *req, struct request_queue *q)
1516 {
1517         struct scsi_cmnd *cmd = req->special;
1518         struct scsi_device *sdev;
1519         struct scsi_target *starget;
1520         struct Scsi_Host *shost;
1521
1522         blk_start_request(req);
1523
1524         scmd_printk(KERN_INFO, cmd, "killing request\n");
1525
1526         sdev = cmd->device;
1527         starget = scsi_target(sdev);
1528         shost = sdev->host;
1529         scsi_init_cmd_errh(cmd);
1530         cmd->result = DID_NO_CONNECT << 16;
1531         atomic_inc(&cmd->device->iorequest_cnt);
1532
1533         /*
1534          * SCSI request completion path will do scsi_device_unbusy(),
1535          * bump busy counts.  To bump the counters, we need to dance
1536          * with the locks as normal issue path does.
1537          */
1538         atomic_inc(&sdev->device_busy);
1539         atomic_inc(&shost->host_busy);
1540         if (starget->can_queue > 0)
1541                 atomic_inc(&starget->target_busy);
1542
1543         blk_complete_request(req);
1544 }
1545
1546 static void scsi_softirq_done(struct request *rq)
1547 {
1548         struct scsi_cmnd *cmd = rq->special;
1549         unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
1550         int disposition;
1551
1552         INIT_LIST_HEAD(&cmd->eh_entry);
1553
1554         atomic_inc(&cmd->device->iodone_cnt);
1555         if (cmd->result)
1556                 atomic_inc(&cmd->device->ioerr_cnt);
1557
1558         disposition = scsi_decide_disposition(cmd);
1559         if (disposition != SUCCESS &&
1560             time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1561                 sdev_printk(KERN_ERR, cmd->device,
1562                             "timing out command, waited %lus\n",
1563                             wait_for/HZ);
1564                 disposition = SUCCESS;
1565         }
1566
1567         scsi_log_completion(cmd, disposition);
1568
1569         switch (disposition) {
1570                 case SUCCESS:
1571                         scsi_finish_command(cmd);
1572                         break;
1573                 case NEEDS_RETRY:
1574                         scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
1575                         break;
1576                 case ADD_TO_MLQUEUE:
1577                         scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1578                         break;
1579                 default:
1580                         scsi_eh_scmd_add(cmd);
1581                         break;
1582         }
1583 }
1584
1585 /**
1586  * scsi_dispatch_command - Dispatch a command to the low-level driver.
1587  * @cmd: command block we are dispatching.
1588  *
1589  * Return: nonzero return request was rejected and device's queue needs to be
1590  * plugged.
1591  */
1592 static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1593 {
1594         struct Scsi_Host *host = cmd->device->host;
1595         int rtn = 0;
1596
1597         atomic_inc(&cmd->device->iorequest_cnt);
1598
1599         /* check if the device is still usable */
1600         if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1601                 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1602                  * returns an immediate error upwards, and signals
1603                  * that the device is no longer present */
1604                 cmd->result = DID_NO_CONNECT << 16;
1605                 goto done;
1606         }
1607
1608         /* Check to see if the scsi lld made this device blocked. */
1609         if (unlikely(scsi_device_blocked(cmd->device))) {
1610                 /*
1611                  * in blocked state, the command is just put back on
1612                  * the device queue.  The suspend state has already
1613                  * blocked the queue so future requests should not
1614                  * occur until the device transitions out of the
1615                  * suspend state.
1616                  */
1617                 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1618                         "queuecommand : device blocked\n"));
1619                 return SCSI_MLQUEUE_DEVICE_BUSY;
1620         }
1621
1622         /* Store the LUN value in cmnd, if needed. */
1623         if (cmd->device->lun_in_cdb)
1624                 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1625                                (cmd->device->lun << 5 & 0xe0);
1626
1627         scsi_log_send(cmd);
1628
1629         /*
1630          * Before we queue this command, check if the command
1631          * length exceeds what the host adapter can handle.
1632          */
1633         if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1634                 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1635                                "queuecommand : command too long. "
1636                                "cdb_size=%d host->max_cmd_len=%d\n",
1637                                cmd->cmd_len, cmd->device->host->max_cmd_len));
1638                 cmd->result = (DID_ABORT << 16);
1639                 goto done;
1640         }
1641
1642         if (unlikely(host->shost_state == SHOST_DEL)) {
1643                 cmd->result = (DID_NO_CONNECT << 16);
1644                 goto done;
1645
1646         }
1647
1648         trace_scsi_dispatch_cmd_start(cmd);
1649         rtn = host->hostt->queuecommand(host, cmd);
1650         if (rtn) {
1651                 trace_scsi_dispatch_cmd_error(cmd, rtn);
1652                 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1653                     rtn != SCSI_MLQUEUE_TARGET_BUSY)
1654                         rtn = SCSI_MLQUEUE_HOST_BUSY;
1655
1656                 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1657                         "queuecommand : request rejected\n"));
1658         }
1659
1660         return rtn;
1661  done:
1662         cmd->scsi_done(cmd);
1663         return 0;
1664 }
1665
1666 /**
1667  * scsi_done - Invoke completion on finished SCSI command.
1668  * @cmd: The SCSI Command for which a low-level device driver (LLDD) gives
1669  * ownership back to SCSI Core -- i.e. the LLDD has finished with it.
1670  *
1671  * Description: This function is the mid-level's (SCSI Core) interrupt routine,
1672  * which regains ownership of the SCSI command (de facto) from a LLDD, and
1673  * calls blk_complete_request() for further processing.
1674  *
1675  * This function is interrupt context safe.
1676  */
1677 static void scsi_done(struct scsi_cmnd *cmd)
1678 {
1679         trace_scsi_dispatch_cmd_done(cmd);
1680         blk_complete_request(cmd->request);
1681 }
1682
1683 /*
1684  * Function:    scsi_request_fn()
1685  *
1686  * Purpose:     Main strategy routine for SCSI.
1687  *
1688  * Arguments:   q       - Pointer to actual queue.
1689  *
1690  * Returns:     Nothing
1691  *
1692  * Lock status: IO request lock assumed to be held when called.
1693  */
1694 static void scsi_request_fn(struct request_queue *q)
1695         __releases(q->queue_lock)
1696         __acquires(q->queue_lock)
1697 {
1698         struct scsi_device *sdev = q->queuedata;
1699         struct Scsi_Host *shost;
1700         struct scsi_cmnd *cmd;
1701         struct request *req;
1702
1703         /*
1704          * To start with, we keep looping until the queue is empty, or until
1705          * the host is no longer able to accept any more requests.
1706          */
1707         shost = sdev->host;
1708         for (;;) {
1709                 int rtn;
1710                 /*
1711                  * get next queueable request.  We do this early to make sure
1712                  * that the request is fully prepared even if we cannot
1713                  * accept it.
1714                  */
1715                 req = blk_peek_request(q);
1716                 if (!req)
1717                         break;
1718
1719                 if (unlikely(!scsi_device_online(sdev))) {
1720                         sdev_printk(KERN_ERR, sdev,
1721                                     "rejecting I/O to offline device\n");
1722                         scsi_kill_request(req, q);
1723                         continue;
1724                 }
1725
1726                 if (!scsi_dev_queue_ready(q, sdev))
1727                         break;
1728
1729                 /*
1730                  * Remove the request from the request list.
1731                  */
1732                 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
1733                         blk_start_request(req);
1734
1735                 spin_unlock_irq(q->queue_lock);
1736                 cmd = req->special;
1737                 if (unlikely(cmd == NULL)) {
1738                         printk(KERN_CRIT "impossible request in %s.\n"
1739                                          "please mail a stack trace to "
1740                                          "linux-scsi@vger.kernel.org\n",
1741                                          __func__);
1742                         blk_dump_rq_flags(req, "foo");
1743                         BUG();
1744                 }
1745
1746                 /*
1747                  * We hit this when the driver is using a host wide
1748                  * tag map. For device level tag maps the queue_depth check
1749                  * in the device ready fn would prevent us from trying
1750                  * to allocate a tag. Since the map is a shared host resource
1751                  * we add the dev to the starved list so it eventually gets
1752                  * a run when a tag is freed.
1753                  */
1754                 if (blk_queue_tagged(q) && !(req->rq_flags & RQF_QUEUED)) {
1755                         spin_lock_irq(shost->host_lock);
1756                         if (list_empty(&sdev->starved_entry))
1757                                 list_add_tail(&sdev->starved_entry,
1758                                               &shost->starved_list);
1759                         spin_unlock_irq(shost->host_lock);
1760                         goto not_ready;
1761                 }
1762
1763                 if (!scsi_target_queue_ready(shost, sdev))
1764                         goto not_ready;
1765
1766                 if (!scsi_host_queue_ready(q, shost, sdev))
1767                         goto host_not_ready;
1768         
1769                 if (sdev->simple_tags)
1770                         cmd->flags |= SCMD_TAGGED;
1771                 else
1772                         cmd->flags &= ~SCMD_TAGGED;
1773
1774                 /*
1775                  * Finally, initialize any error handling parameters, and set up
1776                  * the timers for timeouts.
1777                  */
1778                 scsi_init_cmd_errh(cmd);
1779
1780                 /*
1781                  * Dispatch the command to the low-level driver.
1782                  */
1783                 cmd->scsi_done = scsi_done;
1784                 rtn = scsi_dispatch_cmd(cmd);
1785                 if (rtn) {
1786                         scsi_queue_insert(cmd, rtn);
1787                         spin_lock_irq(q->queue_lock);
1788                         goto out_delay;
1789                 }
1790                 spin_lock_irq(q->queue_lock);
1791         }
1792
1793         return;
1794
1795  host_not_ready:
1796         if (scsi_target(sdev)->can_queue > 0)
1797                 atomic_dec(&scsi_target(sdev)->target_busy);
1798  not_ready:
1799         /*
1800          * lock q, handle tag, requeue req, and decrement device_busy. We
1801          * must return with queue_lock held.
1802          *
1803          * Decrementing device_busy without checking it is OK, as all such
1804          * cases (host limits or settings) should run the queue at some
1805          * later time.
1806          */
1807         spin_lock_irq(q->queue_lock);
1808         blk_requeue_request(q, req);
1809         atomic_dec(&sdev->device_busy);
1810 out_delay:
1811         if (!atomic_read(&sdev->device_busy) && !scsi_device_blocked(sdev))
1812                 blk_delay_queue(q, SCSI_QUEUE_DELAY);
1813 }
1814
1815 static inline int prep_to_mq(int ret)
1816 {
1817         switch (ret) {
1818         case BLKPREP_OK:
1819                 return BLK_MQ_RQ_QUEUE_OK;
1820         case BLKPREP_DEFER:
1821                 return BLK_MQ_RQ_QUEUE_BUSY;
1822         default:
1823                 return BLK_MQ_RQ_QUEUE_ERROR;
1824         }
1825 }
1826
1827 static int scsi_mq_prep_fn(struct request *req)
1828 {
1829         struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1830         struct scsi_device *sdev = req->q->queuedata;
1831         struct Scsi_Host *shost = sdev->host;
1832         unsigned char *sense_buf = cmd->sense_buffer;
1833         struct scatterlist *sg;
1834
1835         /* zero out the cmd, except for the embedded scsi_request */
1836         memset((char *)cmd + sizeof(cmd->req), 0,
1837                 sizeof(*cmd) - sizeof(cmd->req) + shost->hostt->cmd_size);
1838
1839         req->special = cmd;
1840
1841         cmd->request = req;
1842         cmd->device = sdev;
1843         cmd->sense_buffer = sense_buf;
1844
1845         cmd->tag = req->tag;
1846
1847         cmd->prot_op = SCSI_PROT_NORMAL;
1848
1849         INIT_LIST_HEAD(&cmd->list);
1850         INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1851         cmd->jiffies_at_alloc = jiffies;
1852
1853         if (shost->use_cmd_list) {
1854                 spin_lock_irq(&sdev->list_lock);
1855                 list_add_tail(&cmd->list, &sdev->cmd_list);
1856                 spin_unlock_irq(&sdev->list_lock);
1857         }
1858
1859         sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1860         cmd->sdb.table.sgl = sg;
1861
1862         if (scsi_host_get_prot(shost)) {
1863                 cmd->prot_sdb = (void *)sg +
1864                         min_t(unsigned int,
1865                               shost->sg_tablesize, SG_CHUNK_SIZE) *
1866                         sizeof(struct scatterlist);
1867                 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1868
1869                 cmd->prot_sdb->table.sgl =
1870                         (struct scatterlist *)(cmd->prot_sdb + 1);
1871         }
1872
1873         if (blk_bidi_rq(req)) {
1874                 struct request *next_rq = req->next_rq;
1875                 struct scsi_data_buffer *bidi_sdb = blk_mq_rq_to_pdu(next_rq);
1876
1877                 memset(bidi_sdb, 0, sizeof(struct scsi_data_buffer));
1878                 bidi_sdb->table.sgl =
1879                         (struct scatterlist *)(bidi_sdb + 1);
1880
1881                 next_rq->special = bidi_sdb;
1882         }
1883
1884         blk_mq_start_request(req);
1885
1886         return scsi_setup_cmnd(sdev, req);
1887 }
1888
1889 static void scsi_mq_done(struct scsi_cmnd *cmd)
1890 {
1891         trace_scsi_dispatch_cmd_done(cmd);
1892         blk_mq_complete_request(cmd->request);
1893 }
1894
1895 static int scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1896                          const struct blk_mq_queue_data *bd)
1897 {
1898         struct request *req = bd->rq;
1899         struct request_queue *q = req->q;
1900         struct scsi_device *sdev = q->queuedata;
1901         struct Scsi_Host *shost = sdev->host;
1902         struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1903         int ret;
1904         int reason;
1905
1906         ret = prep_to_mq(scsi_prep_state_check(sdev, req));
1907         if (ret != BLK_MQ_RQ_QUEUE_OK)
1908                 goto out;
1909
1910         ret = BLK_MQ_RQ_QUEUE_BUSY;
1911         if (!get_device(&sdev->sdev_gendev))
1912                 goto out;
1913
1914         if (!scsi_dev_queue_ready(q, sdev))
1915                 goto out_put_device;
1916         if (!scsi_target_queue_ready(shost, sdev))
1917                 goto out_dec_device_busy;
1918         if (!scsi_host_queue_ready(q, shost, sdev))
1919                 goto out_dec_target_busy;
1920
1921         if (!(req->rq_flags & RQF_DONTPREP)) {
1922                 ret = prep_to_mq(scsi_mq_prep_fn(req));
1923                 if (ret != BLK_MQ_RQ_QUEUE_OK)
1924                         goto out_dec_host_busy;
1925                 req->rq_flags |= RQF_DONTPREP;
1926         } else {
1927                 blk_mq_start_request(req);
1928         }
1929
1930         if (sdev->simple_tags)
1931                 cmd->flags |= SCMD_TAGGED;
1932         else
1933                 cmd->flags &= ~SCMD_TAGGED;
1934
1935         scsi_init_cmd_errh(cmd);
1936         cmd->scsi_done = scsi_mq_done;
1937
1938         reason = scsi_dispatch_cmd(cmd);
1939         if (reason) {
1940                 scsi_set_blocked(cmd, reason);
1941                 ret = BLK_MQ_RQ_QUEUE_BUSY;
1942                 goto out_dec_host_busy;
1943         }
1944
1945         return BLK_MQ_RQ_QUEUE_OK;
1946
1947 out_dec_host_busy:
1948         atomic_dec(&shost->host_busy);
1949 out_dec_target_busy:
1950         if (scsi_target(sdev)->can_queue > 0)
1951                 atomic_dec(&scsi_target(sdev)->target_busy);
1952 out_dec_device_busy:
1953         atomic_dec(&sdev->device_busy);
1954 out_put_device:
1955         put_device(&sdev->sdev_gendev);
1956 out:
1957         switch (ret) {
1958         case BLK_MQ_RQ_QUEUE_BUSY:
1959                 if (atomic_read(&sdev->device_busy) == 0 &&
1960                     !scsi_device_blocked(sdev))
1961                         blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
1962                 break;
1963         case BLK_MQ_RQ_QUEUE_ERROR:
1964                 /*
1965                  * Make sure to release all allocated ressources when
1966                  * we hit an error, as we will never see this command
1967                  * again.
1968                  */
1969                 if (req->rq_flags & RQF_DONTPREP)
1970                         scsi_mq_uninit_cmd(cmd);
1971                 break;
1972         default:
1973                 break;
1974         }
1975         return ret;
1976 }
1977
1978 static enum blk_eh_timer_return scsi_timeout(struct request *req,
1979                 bool reserved)
1980 {
1981         if (reserved)
1982                 return BLK_EH_RESET_TIMER;
1983         return scsi_times_out(req);
1984 }
1985
1986 static int scsi_init_request(struct blk_mq_tag_set *set, struct request *rq,
1987                 unsigned int hctx_idx, unsigned int numa_node)
1988 {
1989         struct Scsi_Host *shost = set->driver_data;
1990         struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1991
1992         cmd->sense_buffer =
1993                 scsi_alloc_sense_buffer(shost, GFP_KERNEL, numa_node);
1994         if (!cmd->sense_buffer)
1995                 return -ENOMEM;
1996         cmd->req.sense = cmd->sense_buffer;
1997         return 0;
1998 }
1999
2000 static void scsi_exit_request(struct blk_mq_tag_set *set, struct request *rq,
2001                 unsigned int hctx_idx)
2002 {
2003         struct Scsi_Host *shost = set->driver_data;
2004         struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2005
2006         scsi_free_sense_buffer(shost, cmd->sense_buffer);
2007 }
2008
2009 static int scsi_map_queues(struct blk_mq_tag_set *set)
2010 {
2011         struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
2012
2013         if (shost->hostt->map_queues)
2014                 return shost->hostt->map_queues(shost);
2015         return blk_mq_map_queues(set);
2016 }
2017
2018 static u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
2019 {
2020         struct device *host_dev;
2021         u64 bounce_limit = 0xffffffff;
2022
2023         if (shost->unchecked_isa_dma)
2024                 return BLK_BOUNCE_ISA;
2025         /*
2026          * Platforms with virtual-DMA translation
2027          * hardware have no practical limit.
2028          */
2029         if (!PCI_DMA_BUS_IS_PHYS)
2030                 return BLK_BOUNCE_ANY;
2031
2032         host_dev = scsi_get_device(shost);
2033         if (host_dev && host_dev->dma_mask)
2034                 bounce_limit = (u64)dma_max_pfn(host_dev) << PAGE_SHIFT;
2035
2036         return bounce_limit;
2037 }
2038
2039 void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
2040 {
2041         struct device *dev = shost->dma_dev;
2042
2043         queue_flag_set_unlocked(QUEUE_FLAG_SCSI_PASSTHROUGH, q);
2044
2045         /*
2046          * this limit is imposed by hardware restrictions
2047          */
2048         blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
2049                                         SG_MAX_SEGMENTS));
2050
2051         if (scsi_host_prot_dma(shost)) {
2052                 shost->sg_prot_tablesize =
2053                         min_not_zero(shost->sg_prot_tablesize,
2054                                      (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
2055                 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
2056                 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
2057         }
2058
2059         blk_queue_max_hw_sectors(q, shost->max_sectors);
2060         blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
2061         blk_queue_segment_boundary(q, shost->dma_boundary);
2062         dma_set_seg_boundary(dev, shost->dma_boundary);
2063
2064         blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
2065
2066         if (!shost->use_clustering)
2067                 q->limits.cluster = 0;
2068
2069         /*
2070          * set a reasonable default alignment on word boundaries: the
2071          * host and device may alter it using
2072          * blk_queue_update_dma_alignment() later.
2073          */
2074         blk_queue_dma_alignment(q, 0x03);
2075 }
2076 EXPORT_SYMBOL_GPL(__scsi_init_queue);
2077
2078 static int scsi_init_rq(struct request_queue *q, struct request *rq, gfp_t gfp)
2079 {
2080         struct Scsi_Host *shost = q->rq_alloc_data;
2081         struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2082
2083         memset(cmd, 0, sizeof(*cmd));
2084
2085         cmd->sense_buffer = scsi_alloc_sense_buffer(shost, gfp, NUMA_NO_NODE);
2086         if (!cmd->sense_buffer)
2087                 goto fail;
2088         cmd->req.sense = cmd->sense_buffer;
2089
2090         if (scsi_host_get_prot(shost) >= SHOST_DIX_TYPE0_PROTECTION) {
2091                 cmd->prot_sdb = kmem_cache_zalloc(scsi_sdb_cache, gfp);
2092                 if (!cmd->prot_sdb)
2093                         goto fail_free_sense;
2094         }
2095
2096         return 0;
2097
2098 fail_free_sense:
2099         scsi_free_sense_buffer(shost, cmd->sense_buffer);
2100 fail:
2101         return -ENOMEM;
2102 }
2103
2104 static void scsi_exit_rq(struct request_queue *q, struct request *rq)
2105 {
2106         struct Scsi_Host *shost = q->rq_alloc_data;
2107         struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2108
2109         if (cmd->prot_sdb)
2110                 kmem_cache_free(scsi_sdb_cache, cmd->prot_sdb);
2111         scsi_free_sense_buffer(shost, cmd->sense_buffer);
2112 }
2113
2114 struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
2115 {
2116         struct Scsi_Host *shost = sdev->host;
2117         struct request_queue *q;
2118
2119         q = blk_alloc_queue_node(GFP_KERNEL, NUMA_NO_NODE);
2120         if (!q)
2121                 return NULL;
2122         q->cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
2123         q->rq_alloc_data = shost;
2124         q->request_fn = scsi_request_fn;
2125         q->init_rq_fn = scsi_init_rq;
2126         q->exit_rq_fn = scsi_exit_rq;
2127
2128         if (blk_init_allocated_queue(q) < 0) {
2129                 blk_cleanup_queue(q);
2130                 return NULL;
2131         }
2132
2133         __scsi_init_queue(shost, q);
2134         blk_queue_prep_rq(q, scsi_prep_fn);
2135         blk_queue_unprep_rq(q, scsi_unprep_fn);
2136         blk_queue_softirq_done(q, scsi_softirq_done);
2137         blk_queue_rq_timed_out(q, scsi_times_out);
2138         blk_queue_lld_busy(q, scsi_lld_busy);
2139         return q;
2140 }
2141
2142 static const struct blk_mq_ops scsi_mq_ops = {
2143         .queue_rq       = scsi_queue_rq,
2144         .complete       = scsi_softirq_done,
2145         .timeout        = scsi_timeout,
2146 #ifdef CONFIG_BLK_DEBUG_FS
2147         .show_rq        = scsi_show_rq,
2148 #endif
2149         .init_request   = scsi_init_request,
2150         .exit_request   = scsi_exit_request,
2151         .map_queues     = scsi_map_queues,
2152 };
2153
2154 struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
2155 {
2156         sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
2157         if (IS_ERR(sdev->request_queue))
2158                 return NULL;
2159
2160         sdev->request_queue->queuedata = sdev;
2161         __scsi_init_queue(sdev->host, sdev->request_queue);
2162         return sdev->request_queue;
2163 }
2164
2165 int scsi_mq_setup_tags(struct Scsi_Host *shost)
2166 {
2167         unsigned int cmd_size, sgl_size, tbl_size;
2168
2169         tbl_size = shost->sg_tablesize;
2170         if (tbl_size > SG_CHUNK_SIZE)
2171                 tbl_size = SG_CHUNK_SIZE;
2172         sgl_size = tbl_size * sizeof(struct scatterlist);
2173         cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
2174         if (scsi_host_get_prot(shost))
2175                 cmd_size += sizeof(struct scsi_data_buffer) + sgl_size;
2176
2177         memset(&shost->tag_set, 0, sizeof(shost->tag_set));
2178         shost->tag_set.ops = &scsi_mq_ops;
2179         shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
2180         shost->tag_set.queue_depth = shost->can_queue;
2181         shost->tag_set.cmd_size = cmd_size;
2182         shost->tag_set.numa_node = NUMA_NO_NODE;
2183         shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
2184         shost->tag_set.flags |=
2185                 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
2186         shost->tag_set.driver_data = shost;
2187
2188         return blk_mq_alloc_tag_set(&shost->tag_set);
2189 }
2190
2191 void scsi_mq_destroy_tags(struct Scsi_Host *shost)
2192 {
2193         blk_mq_free_tag_set(&shost->tag_set);
2194 }
2195
2196 /**
2197  * scsi_device_from_queue - return sdev associated with a request_queue
2198  * @q: The request queue to return the sdev from
2199  *
2200  * Return the sdev associated with a request queue or NULL if the
2201  * request_queue does not reference a SCSI device.
2202  */
2203 struct scsi_device *scsi_device_from_queue(struct request_queue *q)
2204 {
2205         struct scsi_device *sdev = NULL;
2206
2207         if (q->mq_ops) {
2208                 if (q->mq_ops == &scsi_mq_ops)
2209                         sdev = q->queuedata;
2210         } else if (q->request_fn == scsi_request_fn)
2211                 sdev = q->queuedata;
2212         if (!sdev || !get_device(&sdev->sdev_gendev))
2213                 sdev = NULL;
2214
2215         return sdev;
2216 }
2217 EXPORT_SYMBOL_GPL(scsi_device_from_queue);
2218
2219 /*
2220  * Function:    scsi_block_requests()
2221  *
2222  * Purpose:     Utility function used by low-level drivers to prevent further
2223  *              commands from being queued to the device.
2224  *
2225  * Arguments:   shost       - Host in question
2226  *
2227  * Returns:     Nothing
2228  *
2229  * Lock status: No locks are assumed held.
2230  *
2231  * Notes:       There is no timer nor any other means by which the requests
2232  *              get unblocked other than the low-level driver calling
2233  *              scsi_unblock_requests().
2234  */
2235 void scsi_block_requests(struct Scsi_Host *shost)
2236 {
2237         shost->host_self_blocked = 1;
2238 }
2239 EXPORT_SYMBOL(scsi_block_requests);
2240
2241 /*
2242  * Function:    scsi_unblock_requests()
2243  *
2244  * Purpose:     Utility function used by low-level drivers to allow further
2245  *              commands from being queued to the device.
2246  *
2247  * Arguments:   shost       - Host in question
2248  *
2249  * Returns:     Nothing
2250  *
2251  * Lock status: No locks are assumed held.
2252  *
2253  * Notes:       There is no timer nor any other means by which the requests
2254  *              get unblocked other than the low-level driver calling
2255  *              scsi_unblock_requests().
2256  *
2257  *              This is done as an API function so that changes to the
2258  *              internals of the scsi mid-layer won't require wholesale
2259  *              changes to drivers that use this feature.
2260  */
2261 void scsi_unblock_requests(struct Scsi_Host *shost)
2262 {
2263         shost->host_self_blocked = 0;
2264         scsi_run_host_queues(shost);
2265 }
2266 EXPORT_SYMBOL(scsi_unblock_requests);
2267
2268 int __init scsi_init_queue(void)
2269 {
2270         scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
2271                                            sizeof(struct scsi_data_buffer),
2272                                            0, 0, NULL);
2273         if (!scsi_sdb_cache) {
2274                 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
2275                 return -ENOMEM;
2276         }
2277
2278         return 0;
2279 }
2280
2281 void scsi_exit_queue(void)
2282 {
2283         kmem_cache_destroy(scsi_sense_cache);
2284         kmem_cache_destroy(scsi_sense_isadma_cache);
2285         kmem_cache_destroy(scsi_sdb_cache);
2286 }
2287
2288 /**
2289  *      scsi_mode_select - issue a mode select
2290  *      @sdev:  SCSI device to be queried
2291  *      @pf:    Page format bit (1 == standard, 0 == vendor specific)
2292  *      @sp:    Save page bit (0 == don't save, 1 == save)
2293  *      @modepage: mode page being requested
2294  *      @buffer: request buffer (may not be smaller than eight bytes)
2295  *      @len:   length of request buffer.
2296  *      @timeout: command timeout
2297  *      @retries: number of retries before failing
2298  *      @data: returns a structure abstracting the mode header data
2299  *      @sshdr: place to put sense data (or NULL if no sense to be collected).
2300  *              must be SCSI_SENSE_BUFFERSIZE big.
2301  *
2302  *      Returns zero if successful; negative error number or scsi
2303  *      status on error
2304  *
2305  */
2306 int
2307 scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2308                  unsigned char *buffer, int len, int timeout, int retries,
2309                  struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2310 {
2311         unsigned char cmd[10];
2312         unsigned char *real_buffer;
2313         int ret;
2314
2315         memset(cmd, 0, sizeof(cmd));
2316         cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2317
2318         if (sdev->use_10_for_ms) {
2319                 if (len > 65535)
2320                         return -EINVAL;
2321                 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2322                 if (!real_buffer)
2323                         return -ENOMEM;
2324                 memcpy(real_buffer + 8, buffer, len);
2325                 len += 8;
2326                 real_buffer[0] = 0;
2327                 real_buffer[1] = 0;
2328                 real_buffer[2] = data->medium_type;
2329                 real_buffer[3] = data->device_specific;
2330                 real_buffer[4] = data->longlba ? 0x01 : 0;
2331                 real_buffer[5] = 0;
2332                 real_buffer[6] = data->block_descriptor_length >> 8;
2333                 real_buffer[7] = data->block_descriptor_length;
2334
2335                 cmd[0] = MODE_SELECT_10;
2336                 cmd[7] = len >> 8;
2337                 cmd[8] = len;
2338         } else {
2339                 if (len > 255 || data->block_descriptor_length > 255 ||
2340                     data->longlba)
2341                         return -EINVAL;
2342
2343                 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2344                 if (!real_buffer)
2345                         return -ENOMEM;
2346                 memcpy(real_buffer + 4, buffer, len);
2347                 len += 4;
2348                 real_buffer[0] = 0;
2349                 real_buffer[1] = data->medium_type;
2350                 real_buffer[2] = data->device_specific;
2351                 real_buffer[3] = data->block_descriptor_length;
2352                 
2353
2354                 cmd[0] = MODE_SELECT;
2355                 cmd[4] = len;
2356         }
2357
2358         ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
2359                                sshdr, timeout, retries, NULL);
2360         kfree(real_buffer);
2361         return ret;
2362 }
2363 EXPORT_SYMBOL_GPL(scsi_mode_select);
2364
2365 /**
2366  *      scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
2367  *      @sdev:  SCSI device to be queried
2368  *      @dbd:   set if mode sense will allow block descriptors to be returned
2369  *      @modepage: mode page being requested
2370  *      @buffer: request buffer (may not be smaller than eight bytes)
2371  *      @len:   length of request buffer.
2372  *      @timeout: command timeout
2373  *      @retries: number of retries before failing
2374  *      @data: returns a structure abstracting the mode header data
2375  *      @sshdr: place to put sense data (or NULL if no sense to be collected).
2376  *              must be SCSI_SENSE_BUFFERSIZE big.
2377  *
2378  *      Returns zero if unsuccessful, or the header offset (either 4
2379  *      or 8 depending on whether a six or ten byte command was
2380  *      issued) if successful.
2381  */
2382 int
2383 scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
2384                   unsigned char *buffer, int len, int timeout, int retries,
2385                   struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2386 {
2387         unsigned char cmd[12];
2388         int use_10_for_ms;
2389         int header_length;
2390         int result, retry_count = retries;
2391         struct scsi_sense_hdr my_sshdr;
2392
2393         memset(data, 0, sizeof(*data));
2394         memset(&cmd[0], 0, 12);
2395         cmd[1] = dbd & 0x18;    /* allows DBD and LLBA bits */
2396         cmd[2] = modepage;
2397
2398         /* caller might not be interested in sense, but we need it */
2399         if (!sshdr)
2400                 sshdr = &my_sshdr;
2401
2402  retry:
2403         use_10_for_ms = sdev->use_10_for_ms;
2404
2405         if (use_10_for_ms) {
2406                 if (len < 8)
2407                         len = 8;
2408
2409                 cmd[0] = MODE_SENSE_10;
2410                 cmd[8] = len;
2411                 header_length = 8;
2412         } else {
2413                 if (len < 4)
2414                         len = 4;
2415
2416                 cmd[0] = MODE_SENSE;
2417                 cmd[4] = len;
2418                 header_length = 4;
2419         }
2420
2421         memset(buffer, 0, len);
2422
2423         result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
2424                                   sshdr, timeout, retries, NULL);
2425
2426         /* This code looks awful: what it's doing is making sure an
2427          * ILLEGAL REQUEST sense return identifies the actual command
2428          * byte as the problem.  MODE_SENSE commands can return
2429          * ILLEGAL REQUEST if the code page isn't supported */
2430
2431         if (use_10_for_ms && !scsi_status_is_good(result) &&
2432             (driver_byte(result) & DRIVER_SENSE)) {
2433                 if (scsi_sense_valid(sshdr)) {
2434                         if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2435                             (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
2436                                 /* 
2437                                  * Invalid command operation code
2438                                  */
2439                                 sdev->use_10_for_ms = 0;
2440                                 goto retry;
2441                         }
2442                 }
2443         }
2444
2445         if(scsi_status_is_good(result)) {
2446                 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2447                              (modepage == 6 || modepage == 8))) {
2448                         /* Initio breakage? */
2449                         header_length = 0;
2450                         data->length = 13;
2451                         data->medium_type = 0;
2452                         data->device_specific = 0;
2453                         data->longlba = 0;
2454                         data->block_descriptor_length = 0;
2455                 } else if(use_10_for_ms) {
2456                         data->length = buffer[0]*256 + buffer[1] + 2;
2457                         data->medium_type = buffer[2];
2458                         data->device_specific = buffer[3];
2459                         data->longlba = buffer[4] & 0x01;
2460                         data->block_descriptor_length = buffer[6]*256
2461                                 + buffer[7];
2462                 } else {
2463                         data->length = buffer[0] + 1;
2464                         data->medium_type = buffer[1];
2465                         data->device_specific = buffer[2];
2466                         data->block_descriptor_length = buffer[3];
2467                 }
2468                 data->header_length = header_length;
2469         } else if ((status_byte(result) == CHECK_CONDITION) &&
2470                    scsi_sense_valid(sshdr) &&
2471                    sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2472                 retry_count--;
2473                 goto retry;
2474         }
2475
2476         return result;
2477 }
2478 EXPORT_SYMBOL(scsi_mode_sense);
2479
2480 /**
2481  *      scsi_test_unit_ready - test if unit is ready
2482  *      @sdev:  scsi device to change the state of.
2483  *      @timeout: command timeout
2484  *      @retries: number of retries before failing
2485  *      @sshdr: outpout pointer for decoded sense information.
2486  *
2487  *      Returns zero if unsuccessful or an error if TUR failed.  For
2488  *      removable media, UNIT_ATTENTION sets ->changed flag.
2489  **/
2490 int
2491 scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
2492                      struct scsi_sense_hdr *sshdr)
2493 {
2494         char cmd[] = {
2495                 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2496         };
2497         int result;
2498
2499         /* try to eat the UNIT_ATTENTION if there are enough retries */
2500         do {
2501                 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
2502                                           timeout, retries, NULL);
2503                 if (sdev->removable && scsi_sense_valid(sshdr) &&
2504                     sshdr->sense_key == UNIT_ATTENTION)
2505                         sdev->changed = 1;
2506         } while (scsi_sense_valid(sshdr) &&
2507                  sshdr->sense_key == UNIT_ATTENTION && --retries);
2508
2509         return result;
2510 }
2511 EXPORT_SYMBOL(scsi_test_unit_ready);
2512
2513 /**
2514  *      scsi_device_set_state - Take the given device through the device state model.
2515  *      @sdev:  scsi device to change the state of.
2516  *      @state: state to change to.
2517  *
2518  *      Returns zero if unsuccessful or an error if the requested 
2519  *      transition is illegal.
2520  */
2521 int
2522 scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2523 {
2524         enum scsi_device_state oldstate = sdev->sdev_state;
2525
2526         if (state == oldstate)
2527                 return 0;
2528
2529         switch (state) {
2530         case SDEV_CREATED:
2531                 switch (oldstate) {
2532                 case SDEV_CREATED_BLOCK:
2533                         break;
2534                 default:
2535                         goto illegal;
2536                 }
2537                 break;
2538                         
2539         case SDEV_RUNNING:
2540                 switch (oldstate) {
2541                 case SDEV_CREATED:
2542                 case SDEV_OFFLINE:
2543                 case SDEV_TRANSPORT_OFFLINE:
2544                 case SDEV_QUIESCE:
2545                 case SDEV_BLOCK:
2546                         break;
2547                 default:
2548                         goto illegal;
2549                 }
2550                 break;
2551
2552         case SDEV_QUIESCE:
2553                 switch (oldstate) {
2554                 case SDEV_RUNNING:
2555                 case SDEV_OFFLINE:
2556                 case SDEV_TRANSPORT_OFFLINE:
2557                         break;
2558                 default:
2559                         goto illegal;
2560                 }
2561                 break;
2562
2563         case SDEV_OFFLINE:
2564         case SDEV_TRANSPORT_OFFLINE:
2565                 switch (oldstate) {
2566                 case SDEV_CREATED:
2567                 case SDEV_RUNNING:
2568                 case SDEV_QUIESCE:
2569                 case SDEV_BLOCK:
2570                         break;
2571                 default:
2572                         goto illegal;
2573                 }
2574                 break;
2575
2576         case SDEV_BLOCK:
2577                 switch (oldstate) {
2578                 case SDEV_RUNNING:
2579                 case SDEV_CREATED_BLOCK:
2580                         break;
2581                 default:
2582                         goto illegal;
2583                 }
2584                 break;
2585
2586         case SDEV_CREATED_BLOCK:
2587                 switch (oldstate) {
2588                 case SDEV_CREATED:
2589                         break;
2590                 default:
2591                         goto illegal;
2592                 }
2593                 break;
2594
2595         case SDEV_CANCEL:
2596                 switch (oldstate) {
2597                 case SDEV_CREATED:
2598                 case SDEV_RUNNING:
2599                 case SDEV_QUIESCE:
2600                 case SDEV_OFFLINE:
2601                 case SDEV_TRANSPORT_OFFLINE:
2602                 case SDEV_BLOCK:
2603                         break;
2604                 default:
2605                         goto illegal;
2606                 }
2607                 break;
2608
2609         case SDEV_DEL:
2610                 switch (oldstate) {
2611                 case SDEV_CREATED:
2612                 case SDEV_RUNNING:
2613                 case SDEV_OFFLINE:
2614                 case SDEV_TRANSPORT_OFFLINE:
2615                 case SDEV_CANCEL:
2616                 case SDEV_CREATED_BLOCK:
2617                         break;
2618                 default:
2619                         goto illegal;
2620                 }
2621                 break;
2622
2623         }
2624         sdev->sdev_state = state;
2625         return 0;
2626
2627  illegal:
2628         SCSI_LOG_ERROR_RECOVERY(1,
2629                                 sdev_printk(KERN_ERR, sdev,
2630                                             "Illegal state transition %s->%s",
2631                                             scsi_device_state_name(oldstate),
2632                                             scsi_device_state_name(state))
2633                                 );
2634         return -EINVAL;
2635 }
2636 EXPORT_SYMBOL(scsi_device_set_state);
2637
2638 /**
2639  *      sdev_evt_emit - emit a single SCSI device uevent
2640  *      @sdev: associated SCSI device
2641  *      @evt: event to emit
2642  *
2643  *      Send a single uevent (scsi_event) to the associated scsi_device.
2644  */
2645 static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2646 {
2647         int idx = 0;
2648         char *envp[3];
2649
2650         switch (evt->evt_type) {
2651         case SDEV_EVT_MEDIA_CHANGE:
2652                 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2653                 break;
2654         case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2655                 scsi_rescan_device(&sdev->sdev_gendev);
2656                 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2657                 break;
2658         case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2659                 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2660                 break;
2661         case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2662                envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2663                 break;
2664         case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2665                 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2666                 break;
2667         case SDEV_EVT_LUN_CHANGE_REPORTED:
2668                 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2669                 break;
2670         case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2671                 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2672                 break;
2673         default:
2674                 /* do nothing */
2675                 break;
2676         }
2677
2678         envp[idx++] = NULL;
2679
2680         kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2681 }
2682
2683 /**
2684  *      sdev_evt_thread - send a uevent for each scsi event
2685  *      @work: work struct for scsi_device
2686  *
2687  *      Dispatch queued events to their associated scsi_device kobjects
2688  *      as uevents.
2689  */
2690 void scsi_evt_thread(struct work_struct *work)
2691 {
2692         struct scsi_device *sdev;
2693         enum scsi_device_event evt_type;
2694         LIST_HEAD(event_list);
2695
2696         sdev = container_of(work, struct scsi_device, event_work);
2697
2698         for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2699                 if (test_and_clear_bit(evt_type, sdev->pending_events))
2700                         sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2701
2702         while (1) {
2703                 struct scsi_event *evt;
2704                 struct list_head *this, *tmp;
2705                 unsigned long flags;
2706
2707                 spin_lock_irqsave(&sdev->list_lock, flags);
2708                 list_splice_init(&sdev->event_list, &event_list);
2709                 spin_unlock_irqrestore(&sdev->list_lock, flags);
2710
2711                 if (list_empty(&event_list))
2712                         break;
2713
2714                 list_for_each_safe(this, tmp, &event_list) {
2715                         evt = list_entry(this, struct scsi_event, node);
2716                         list_del(&evt->node);
2717                         scsi_evt_emit(sdev, evt);
2718                         kfree(evt);
2719                 }
2720         }
2721 }
2722
2723 /**
2724  *      sdev_evt_send - send asserted event to uevent thread
2725  *      @sdev: scsi_device event occurred on
2726  *      @evt: event to send
2727  *
2728  *      Assert scsi device event asynchronously.
2729  */
2730 void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2731 {
2732         unsigned long flags;
2733
2734 #if 0
2735         /* FIXME: currently this check eliminates all media change events
2736          * for polled devices.  Need to update to discriminate between AN
2737          * and polled events */
2738         if (!test_bit(evt->evt_type, sdev->supported_events)) {
2739                 kfree(evt);
2740                 return;
2741         }
2742 #endif
2743
2744         spin_lock_irqsave(&sdev->list_lock, flags);
2745         list_add_tail(&evt->node, &sdev->event_list);
2746         schedule_work(&sdev->event_work);
2747         spin_unlock_irqrestore(&sdev->list_lock, flags);
2748 }
2749 EXPORT_SYMBOL_GPL(sdev_evt_send);
2750
2751 /**
2752  *      sdev_evt_alloc - allocate a new scsi event
2753  *      @evt_type: type of event to allocate
2754  *      @gfpflags: GFP flags for allocation
2755  *
2756  *      Allocates and returns a new scsi_event.
2757  */
2758 struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2759                                   gfp_t gfpflags)
2760 {
2761         struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2762         if (!evt)
2763                 return NULL;
2764
2765         evt->evt_type = evt_type;
2766         INIT_LIST_HEAD(&evt->node);
2767
2768         /* evt_type-specific initialization, if any */
2769         switch (evt_type) {
2770         case SDEV_EVT_MEDIA_CHANGE:
2771         case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2772         case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2773         case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2774         case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2775         case SDEV_EVT_LUN_CHANGE_REPORTED:
2776         case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2777         default:
2778                 /* do nothing */
2779                 break;
2780         }
2781
2782         return evt;
2783 }
2784 EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2785
2786 /**
2787  *      sdev_evt_send_simple - send asserted event to uevent thread
2788  *      @sdev: scsi_device event occurred on
2789  *      @evt_type: type of event to send
2790  *      @gfpflags: GFP flags for allocation
2791  *
2792  *      Assert scsi device event asynchronously, given an event type.
2793  */
2794 void sdev_evt_send_simple(struct scsi_device *sdev,
2795                           enum scsi_device_event evt_type, gfp_t gfpflags)
2796 {
2797         struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2798         if (!evt) {
2799                 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2800                             evt_type);
2801                 return;
2802         }
2803
2804         sdev_evt_send(sdev, evt);
2805 }
2806 EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2807
2808 /**
2809  * scsi_request_fn_active() - number of kernel threads inside scsi_request_fn()
2810  * @sdev: SCSI device to count the number of scsi_request_fn() callers for.
2811  */
2812 static int scsi_request_fn_active(struct scsi_device *sdev)
2813 {
2814         struct request_queue *q = sdev->request_queue;
2815         int request_fn_active;
2816
2817         WARN_ON_ONCE(sdev->host->use_blk_mq);
2818
2819         spin_lock_irq(q->queue_lock);
2820         request_fn_active = q->request_fn_active;
2821         spin_unlock_irq(q->queue_lock);
2822
2823         return request_fn_active;
2824 }
2825
2826 /**
2827  * scsi_wait_for_queuecommand() - wait for ongoing queuecommand() calls
2828  * @sdev: SCSI device pointer.
2829  *
2830  * Wait until the ongoing shost->hostt->queuecommand() calls that are
2831  * invoked from scsi_request_fn() have finished.
2832  */
2833 static void scsi_wait_for_queuecommand(struct scsi_device *sdev)
2834 {
2835         WARN_ON_ONCE(sdev->host->use_blk_mq);
2836
2837         while (scsi_request_fn_active(sdev))
2838                 msleep(20);
2839 }
2840
2841 /**
2842  *      scsi_device_quiesce - Block user issued commands.
2843  *      @sdev:  scsi device to quiesce.
2844  *
2845  *      This works by trying to transition to the SDEV_QUIESCE state
2846  *      (which must be a legal transition).  When the device is in this
2847  *      state, only special requests will be accepted, all others will
2848  *      be deferred.  Since special requests may also be requeued requests,
2849  *      a successful return doesn't guarantee the device will be 
2850  *      totally quiescent.
2851  *
2852  *      Must be called with user context, may sleep.
2853  *
2854  *      Returns zero if unsuccessful or an error if not.
2855  */
2856 int
2857 scsi_device_quiesce(struct scsi_device *sdev)
2858 {
2859         int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2860         if (err)
2861                 return err;
2862
2863         scsi_run_queue(sdev->request_queue);
2864         while (atomic_read(&sdev->device_busy)) {
2865                 msleep_interruptible(200);
2866                 scsi_run_queue(sdev->request_queue);
2867         }
2868         return 0;
2869 }
2870 EXPORT_SYMBOL(scsi_device_quiesce);
2871
2872 /**
2873  *      scsi_device_resume - Restart user issued commands to a quiesced device.
2874  *      @sdev:  scsi device to resume.
2875  *
2876  *      Moves the device from quiesced back to running and restarts the
2877  *      queues.
2878  *
2879  *      Must be called with user context, may sleep.
2880  */
2881 void scsi_device_resume(struct scsi_device *sdev)
2882 {
2883         /* check if the device state was mutated prior to resume, and if
2884          * so assume the state is being managed elsewhere (for example
2885          * device deleted during suspend)
2886          */
2887         if (sdev->sdev_state != SDEV_QUIESCE ||
2888             scsi_device_set_state(sdev, SDEV_RUNNING))
2889                 return;
2890         scsi_run_queue(sdev->request_queue);
2891 }
2892 EXPORT_SYMBOL(scsi_device_resume);
2893
2894 static void
2895 device_quiesce_fn(struct scsi_device *sdev, void *data)
2896 {
2897         scsi_device_quiesce(sdev);
2898 }
2899
2900 void
2901 scsi_target_quiesce(struct scsi_target *starget)
2902 {
2903         starget_for_each_device(starget, NULL, device_quiesce_fn);
2904 }
2905 EXPORT_SYMBOL(scsi_target_quiesce);
2906
2907 static void
2908 device_resume_fn(struct scsi_device *sdev, void *data)
2909 {
2910         scsi_device_resume(sdev);
2911 }
2912
2913 void
2914 scsi_target_resume(struct scsi_target *starget)
2915 {
2916         starget_for_each_device(starget, NULL, device_resume_fn);
2917 }
2918 EXPORT_SYMBOL(scsi_target_resume);
2919
2920 /**
2921  * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
2922  * @sdev:       device to block
2923  * @wait:       Whether or not to wait until ongoing .queuecommand() /
2924  *              .queue_rq() calls have finished.
2925  *
2926  * Block request made by scsi lld's to temporarily stop all
2927  * scsi commands on the specified device. May sleep.
2928  *
2929  * Returns zero if successful or error if not
2930  *
2931  * Notes:       
2932  *      This routine transitions the device to the SDEV_BLOCK state
2933  *      (which must be a legal transition).  When the device is in this
2934  *      state, all commands are deferred until the scsi lld reenables
2935  *      the device with scsi_device_unblock or device_block_tmo fires.
2936  *
2937  * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
2938  * scsi_internal_device_block() has blocked a SCSI device and also
2939  * remove the rport mutex lock and unlock calls from srp_queuecommand().
2940  */
2941 int
2942 scsi_internal_device_block(struct scsi_device *sdev, bool wait)
2943 {
2944         struct request_queue *q = sdev->request_queue;
2945         unsigned long flags;
2946         int err = 0;
2947
2948         err = scsi_device_set_state(sdev, SDEV_BLOCK);
2949         if (err) {
2950                 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2951
2952                 if (err)
2953                         return err;
2954         }
2955
2956         /* 
2957          * The device has transitioned to SDEV_BLOCK.  Stop the
2958          * block layer from calling the midlayer with this device's
2959          * request queue. 
2960          */
2961         if (q->mq_ops) {
2962                 if (wait)
2963                         blk_mq_quiesce_queue(q);
2964                 else
2965                         blk_mq_stop_hw_queues(q);
2966         } else {
2967                 spin_lock_irqsave(q->queue_lock, flags);
2968                 blk_stop_queue(q);
2969                 spin_unlock_irqrestore(q->queue_lock, flags);
2970                 if (wait)
2971                         scsi_wait_for_queuecommand(sdev);
2972         }
2973
2974         return 0;
2975 }
2976 EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2977  
2978 /**
2979  * scsi_internal_device_unblock - resume a device after a block request
2980  * @sdev:       device to resume
2981  * @new_state:  state to set devices to after unblocking
2982  *
2983  * Called by scsi lld's or the midlayer to restart the device queue
2984  * for the previously suspended scsi device.  Called from interrupt or
2985  * normal process context.
2986  *
2987  * Returns zero if successful or error if not.
2988  *
2989  * Notes:       
2990  *      This routine transitions the device to the SDEV_RUNNING state
2991  *      or to one of the offline states (which must be a legal transition)
2992  *      allowing the midlayer to goose the queue for this device.
2993  */
2994 int
2995 scsi_internal_device_unblock(struct scsi_device *sdev,
2996                              enum scsi_device_state new_state)
2997 {
2998         struct request_queue *q = sdev->request_queue; 
2999         unsigned long flags;
3000
3001         /*
3002          * Try to transition the scsi device to SDEV_RUNNING or one of the
3003          * offlined states and goose the device queue if successful.
3004          */
3005         if ((sdev->sdev_state == SDEV_BLOCK) ||
3006             (sdev->sdev_state == SDEV_TRANSPORT_OFFLINE))
3007                 sdev->sdev_state = new_state;
3008         else if (sdev->sdev_state == SDEV_CREATED_BLOCK) {
3009                 if (new_state == SDEV_TRANSPORT_OFFLINE ||
3010                     new_state == SDEV_OFFLINE)
3011                         sdev->sdev_state = new_state;
3012                 else
3013                         sdev->sdev_state = SDEV_CREATED;
3014         } else if (sdev->sdev_state != SDEV_CANCEL &&
3015                  sdev->sdev_state != SDEV_OFFLINE)
3016                 return -EINVAL;
3017
3018         if (q->mq_ops) {
3019                 blk_mq_start_stopped_hw_queues(q, false);
3020         } else {
3021                 spin_lock_irqsave(q->queue_lock, flags);
3022                 blk_start_queue(q);
3023                 spin_unlock_irqrestore(q->queue_lock, flags);
3024         }
3025
3026         return 0;
3027 }
3028 EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
3029
3030 static void
3031 device_block(struct scsi_device *sdev, void *data)
3032 {
3033         scsi_internal_device_block(sdev, true);
3034 }
3035
3036 static int
3037 target_block(struct device *dev, void *data)
3038 {
3039         if (scsi_is_target_device(dev))
3040                 starget_for_each_device(to_scsi_target(dev), NULL,
3041                                         device_block);
3042         return 0;
3043 }
3044
3045 void
3046 scsi_target_block(struct device *dev)
3047 {
3048         if (scsi_is_target_device(dev))
3049                 starget_for_each_device(to_scsi_target(dev), NULL,
3050                                         device_block);
3051         else
3052                 device_for_each_child(dev, NULL, target_block);
3053 }
3054 EXPORT_SYMBOL_GPL(scsi_target_block);
3055
3056 static void
3057 device_unblock(struct scsi_device *sdev, void *data)
3058 {
3059         scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
3060 }
3061
3062 static int
3063 target_unblock(struct device *dev, void *data)
3064 {
3065         if (scsi_is_target_device(dev))
3066                 starget_for_each_device(to_scsi_target(dev), data,
3067                                         device_unblock);
3068         return 0;
3069 }
3070
3071 void
3072 scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
3073 {
3074         if (scsi_is_target_device(dev))
3075                 starget_for_each_device(to_scsi_target(dev), &new_state,
3076                                         device_unblock);
3077         else
3078                 device_for_each_child(dev, &new_state, target_unblock);
3079 }
3080 EXPORT_SYMBOL_GPL(scsi_target_unblock);
3081
3082 /**
3083  * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
3084  * @sgl:        scatter-gather list
3085  * @sg_count:   number of segments in sg
3086  * @offset:     offset in bytes into sg, on return offset into the mapped area
3087  * @len:        bytes to map, on return number of bytes mapped
3088  *
3089  * Returns virtual address of the start of the mapped page
3090  */
3091 void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
3092                           size_t *offset, size_t *len)
3093 {
3094         int i;
3095         size_t sg_len = 0, len_complete = 0;
3096         struct scatterlist *sg;
3097         struct page *page;
3098
3099         WARN_ON(!irqs_disabled());
3100
3101         for_each_sg(sgl, sg, sg_count, i) {
3102                 len_complete = sg_len; /* Complete sg-entries */
3103                 sg_len += sg->length;
3104                 if (sg_len > *offset)
3105                         break;
3106         }
3107
3108         if (unlikely(i == sg_count)) {
3109                 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
3110                         "elements %d\n",
3111                        __func__, sg_len, *offset, sg_count);
3112                 WARN_ON(1);
3113                 return NULL;
3114         }
3115
3116         /* Offset starting from the beginning of first page in this sg-entry */
3117         *offset = *offset - len_complete + sg->offset;
3118
3119         /* Assumption: contiguous pages can be accessed as "page + i" */
3120         page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
3121         *offset &= ~PAGE_MASK;
3122
3123         /* Bytes in this sg-entry from *offset to the end of the page */
3124         sg_len = PAGE_SIZE - *offset;
3125         if (*len > sg_len)
3126                 *len = sg_len;
3127
3128         return kmap_atomic(page);
3129 }
3130 EXPORT_SYMBOL(scsi_kmap_atomic_sg);
3131
3132 /**
3133  * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
3134  * @virt:       virtual address to be unmapped
3135  */
3136 void scsi_kunmap_atomic_sg(void *virt)
3137 {
3138         kunmap_atomic(virt);
3139 }
3140 EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
3141
3142 void sdev_disable_disk_events(struct scsi_device *sdev)
3143 {
3144         atomic_inc(&sdev->disk_events_disable_depth);
3145 }
3146 EXPORT_SYMBOL(sdev_disable_disk_events);
3147
3148 void sdev_enable_disk_events(struct scsi_device *sdev)
3149 {
3150         if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
3151                 return;
3152         atomic_dec(&sdev->disk_events_disable_depth);
3153 }
3154 EXPORT_SYMBOL(sdev_enable_disk_events);
3155
3156 /**
3157  * scsi_vpd_lun_id - return a unique device identification
3158  * @sdev: SCSI device
3159  * @id:   buffer for the identification
3160  * @id_len:  length of the buffer
3161  *
3162  * Copies a unique device identification into @id based
3163  * on the information in the VPD page 0x83 of the device.
3164  * The string will be formatted as a SCSI name string.
3165  *
3166  * Returns the length of the identification or error on failure.
3167  * If the identifier is longer than the supplied buffer the actual
3168  * identifier length is returned and the buffer is not zero-padded.
3169  */
3170 int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
3171 {
3172         u8 cur_id_type = 0xff;
3173         u8 cur_id_size = 0;
3174         unsigned char *d, *cur_id_str;
3175         unsigned char __rcu *vpd_pg83;
3176         int id_size = -EINVAL;
3177
3178         rcu_read_lock();
3179         vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3180         if (!vpd_pg83) {
3181                 rcu_read_unlock();
3182                 return -ENXIO;
3183         }
3184
3185         /*
3186          * Look for the correct descriptor.
3187          * Order of preference for lun descriptor:
3188          * - SCSI name string
3189          * - NAA IEEE Registered Extended
3190          * - EUI-64 based 16-byte
3191          * - EUI-64 based 12-byte
3192          * - NAA IEEE Registered
3193          * - NAA IEEE Extended
3194          * - T10 Vendor ID
3195          * as longer descriptors reduce the likelyhood
3196          * of identification clashes.
3197          */
3198
3199         /* The id string must be at least 20 bytes + terminating NULL byte */
3200         if (id_len < 21) {
3201                 rcu_read_unlock();
3202                 return -EINVAL;
3203         }
3204
3205         memset(id, 0, id_len);
3206         d = vpd_pg83 + 4;
3207         while (d < vpd_pg83 + sdev->vpd_pg83_len) {
3208                 /* Skip designators not referring to the LUN */
3209                 if ((d[1] & 0x30) != 0x00)
3210                         goto next_desig;
3211
3212                 switch (d[1] & 0xf) {
3213                 case 0x1:
3214                         /* T10 Vendor ID */
3215                         if (cur_id_size > d[3])
3216                                 break;
3217                         /* Prefer anything */
3218                         if (cur_id_type > 0x01 && cur_id_type != 0xff)
3219                                 break;
3220                         cur_id_size = d[3];
3221                         if (cur_id_size + 4 > id_len)
3222                                 cur_id_size = id_len - 4;
3223                         cur_id_str = d + 4;
3224                         cur_id_type = d[1] & 0xf;
3225                         id_size = snprintf(id, id_len, "t10.%*pE",
3226                                            cur_id_size, cur_id_str);
3227                         break;
3228                 case 0x2:
3229                         /* EUI-64 */
3230                         if (cur_id_size > d[3])
3231                                 break;
3232                         /* Prefer NAA IEEE Registered Extended */
3233                         if (cur_id_type == 0x3 &&
3234                             cur_id_size == d[3])
3235                                 break;
3236                         cur_id_size = d[3];
3237                         cur_id_str = d + 4;
3238                         cur_id_type = d[1] & 0xf;
3239                         switch (cur_id_size) {
3240                         case 8:
3241                                 id_size = snprintf(id, id_len,
3242                                                    "eui.%8phN",
3243                                                    cur_id_str);
3244                                 break;
3245                         case 12:
3246                                 id_size = snprintf(id, id_len,
3247                                                    "eui.%12phN",
3248                                                    cur_id_str);
3249                                 break;
3250                         case 16:
3251                                 id_size = snprintf(id, id_len,
3252                                                    "eui.%16phN",
3253                                                    cur_id_str);
3254                                 break;
3255                         default:
3256                                 cur_id_size = 0;
3257                                 break;
3258                         }
3259                         break;
3260                 case 0x3:
3261                         /* NAA */
3262                         if (cur_id_size > d[3])
3263                                 break;
3264                         cur_id_size = d[3];
3265                         cur_id_str = d + 4;
3266                         cur_id_type = d[1] & 0xf;
3267                         switch (cur_id_size) {
3268                         case 8:
3269                                 id_size = snprintf(id, id_len,
3270                                                    "naa.%8phN",
3271                                                    cur_id_str);
3272                                 break;
3273                         case 16:
3274                                 id_size = snprintf(id, id_len,
3275                                                    "naa.%16phN",
3276                                                    cur_id_str);
3277                                 break;
3278                         default:
3279                                 cur_id_size = 0;
3280                                 break;
3281                         }
3282                         break;
3283                 case 0x8:
3284                         /* SCSI name string */
3285                         if (cur_id_size + 4 > d[3])
3286                                 break;
3287                         /* Prefer others for truncated descriptor */
3288                         if (cur_id_size && d[3] > id_len)
3289                                 break;
3290                         cur_id_size = id_size = d[3];
3291                         cur_id_str = d + 4;
3292                         cur_id_type = d[1] & 0xf;
3293                         if (cur_id_size >= id_len)
3294                                 cur_id_size = id_len - 1;
3295                         memcpy(id, cur_id_str, cur_id_size);
3296                         /* Decrease priority for truncated descriptor */
3297                         if (cur_id_size != id_size)
3298                                 cur_id_size = 6;
3299                         break;
3300                 default:
3301                         break;
3302                 }
3303 next_desig:
3304                 d += d[3] + 4;
3305         }
3306         rcu_read_unlock();
3307
3308         return id_size;
3309 }
3310 EXPORT_SYMBOL(scsi_vpd_lun_id);
3311
3312 /*
3313  * scsi_vpd_tpg_id - return a target port group identifier
3314  * @sdev: SCSI device
3315  *
3316  * Returns the Target Port Group identifier from the information
3317  * froom VPD page 0x83 of the device.
3318  *
3319  * Returns the identifier or error on failure.
3320  */
3321 int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3322 {
3323         unsigned char *d;
3324         unsigned char __rcu *vpd_pg83;
3325         int group_id = -EAGAIN, rel_port = -1;
3326
3327         rcu_read_lock();
3328         vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3329         if (!vpd_pg83) {
3330                 rcu_read_unlock();
3331                 return -ENXIO;
3332         }
3333
3334         d = sdev->vpd_pg83 + 4;
3335         while (d < sdev->vpd_pg83 + sdev->vpd_pg83_len) {
3336                 switch (d[1] & 0xf) {
3337                 case 0x4:
3338                         /* Relative target port */
3339                         rel_port = get_unaligned_be16(&d[6]);
3340                         break;
3341                 case 0x5:
3342                         /* Target port group */
3343                         group_id = get_unaligned_be16(&d[6]);
3344                         break;
3345                 default:
3346                         break;
3347                 }
3348                 d += d[3] + 4;
3349         }
3350         rcu_read_unlock();
3351
3352         if (group_id >= 0 && rel_id && rel_port != -1)
3353                 *rel_id = rel_port;
3354
3355         return group_id;
3356 }
3357 EXPORT_SYMBOL(scsi_vpd_tpg_id);