1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 1999 Eric Youngdale
4 * Copyright (C) 2014 Christoph Hellwig
6 * SCSI queueing library.
7 * Initial versions: Eric Youngdale (eric@andante.org).
8 * Based upon conversations with large numbers
9 * of people at Linux Expo.
12 #include <linux/bio.h>
13 #include <linux/bitops.h>
14 #include <linux/blkdev.h>
15 #include <linux/completion.h>
16 #include <linux/kernel.h>
17 #include <linux/export.h>
18 #include <linux/init.h>
19 #include <linux/pci.h>
20 #include <linux/delay.h>
21 #include <linux/hardirq.h>
22 #include <linux/scatterlist.h>
23 #include <linux/blk-mq.h>
24 #include <linux/ratelimit.h>
25 #include <asm/unaligned.h>
27 #include <scsi/scsi.h>
28 #include <scsi/scsi_cmnd.h>
29 #include <scsi/scsi_dbg.h>
30 #include <scsi/scsi_device.h>
31 #include <scsi/scsi_driver.h>
32 #include <scsi/scsi_eh.h>
33 #include <scsi/scsi_host.h>
34 #include <scsi/scsi_transport.h> /* __scsi_init_queue() */
35 #include <scsi/scsi_dh.h>
37 #include <trace/events/scsi.h>
39 #include "scsi_debugfs.h"
40 #include "scsi_priv.h"
41 #include "scsi_logging.h"
44 * Size of integrity metadata is usually small, 1 inline sg should
47 #ifdef CONFIG_ARCH_NO_SG_CHAIN
48 #define SCSI_INLINE_PROT_SG_CNT 0
49 #define SCSI_INLINE_SG_CNT 0
51 #define SCSI_INLINE_PROT_SG_CNT 1
52 #define SCSI_INLINE_SG_CNT 2
55 static struct kmem_cache *scsi_sense_cache;
56 static struct kmem_cache *scsi_sense_isadma_cache;
57 static DEFINE_MUTEX(scsi_sense_cache_mutex);
59 static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd);
61 static inline struct kmem_cache *
62 scsi_select_sense_cache(bool unchecked_isa_dma)
64 return unchecked_isa_dma ? scsi_sense_isadma_cache : scsi_sense_cache;
67 static void scsi_free_sense_buffer(bool unchecked_isa_dma,
68 unsigned char *sense_buffer)
70 kmem_cache_free(scsi_select_sense_cache(unchecked_isa_dma),
74 static unsigned char *scsi_alloc_sense_buffer(bool unchecked_isa_dma,
75 gfp_t gfp_mask, int numa_node)
77 return kmem_cache_alloc_node(scsi_select_sense_cache(unchecked_isa_dma),
81 int scsi_init_sense_cache(struct Scsi_Host *shost)
83 struct kmem_cache *cache;
86 mutex_lock(&scsi_sense_cache_mutex);
87 cache = scsi_select_sense_cache(shost->unchecked_isa_dma);
91 if (shost->unchecked_isa_dma) {
92 scsi_sense_isadma_cache =
93 kmem_cache_create("scsi_sense_cache(DMA)",
94 SCSI_SENSE_BUFFERSIZE, 0,
95 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
96 if (!scsi_sense_isadma_cache)
100 kmem_cache_create_usercopy("scsi_sense_cache",
101 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN,
102 0, SCSI_SENSE_BUFFERSIZE, NULL);
103 if (!scsi_sense_cache)
107 mutex_unlock(&scsi_sense_cache_mutex);
112 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
113 * not change behaviour from the previous unplug mechanism, experimentation
114 * may prove this needs changing.
116 #define SCSI_QUEUE_DELAY 3
119 scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
121 struct Scsi_Host *host = cmd->device->host;
122 struct scsi_device *device = cmd->device;
123 struct scsi_target *starget = scsi_target(device);
126 * Set the appropriate busy bit for the device/host.
128 * If the host/device isn't busy, assume that something actually
129 * completed, and that we should be able to queue a command now.
131 * Note that the prior mid-layer assumption that any host could
132 * always queue at least one command is now broken. The mid-layer
133 * will implement a user specifiable stall (see
134 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
135 * if a command is requeued with no other commands outstanding
136 * either for the device or for the host.
139 case SCSI_MLQUEUE_HOST_BUSY:
140 atomic_set(&host->host_blocked, host->max_host_blocked);
142 case SCSI_MLQUEUE_DEVICE_BUSY:
143 case SCSI_MLQUEUE_EH_RETRY:
144 atomic_set(&device->device_blocked,
145 device->max_device_blocked);
147 case SCSI_MLQUEUE_TARGET_BUSY:
148 atomic_set(&starget->target_blocked,
149 starget->max_target_blocked);
154 static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
156 if (cmd->request->rq_flags & RQF_DONTPREP) {
157 cmd->request->rq_flags &= ~RQF_DONTPREP;
158 scsi_mq_uninit_cmd(cmd);
162 blk_mq_requeue_request(cmd->request, true);
166 * __scsi_queue_insert - private queue insertion
167 * @cmd: The SCSI command being requeued
168 * @reason: The reason for the requeue
169 * @unbusy: Whether the queue should be unbusied
171 * This is a private queue insertion. The public interface
172 * scsi_queue_insert() always assumes the queue should be unbusied
173 * because it's always called before the completion. This function is
174 * for a requeue after completion, which should only occur in this
177 static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, bool unbusy)
179 struct scsi_device *device = cmd->device;
181 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
182 "Inserting command %p into mlqueue\n", cmd));
184 scsi_set_blocked(cmd, reason);
187 * Decrement the counters, since these commands are no longer
188 * active on the host/device.
191 scsi_device_unbusy(device, cmd);
194 * Requeue this command. It will go before all other commands
195 * that are already in the queue. Schedule requeue work under
196 * lock such that the kblockd_schedule_work() call happens
197 * before blk_cleanup_queue() finishes.
201 blk_mq_requeue_request(cmd->request, true);
205 * scsi_queue_insert - Reinsert a command in the queue.
206 * @cmd: command that we are adding to queue.
207 * @reason: why we are inserting command to queue.
209 * We do this for one of two cases. Either the host is busy and it cannot accept
210 * any more commands for the time being, or the device returned QUEUE_FULL and
211 * can accept no more commands.
213 * Context: This could be called either from an interrupt context or a normal
216 void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
218 __scsi_queue_insert(cmd, reason, true);
223 * __scsi_execute - insert request and wait for the result
226 * @data_direction: data direction
227 * @buffer: data buffer
228 * @bufflen: len of buffer
229 * @sense: optional sense buffer
230 * @sshdr: optional decoded sense header
231 * @timeout: request timeout in seconds
232 * @retries: number of times to retry request
233 * @flags: flags for ->cmd_flags
234 * @rq_flags: flags for ->rq_flags
235 * @resid: optional residual length
237 * Returns the scsi_cmnd result field if a command was executed, or a negative
238 * Linux error code if we didn't get that far.
240 int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
241 int data_direction, void *buffer, unsigned bufflen,
242 unsigned char *sense, struct scsi_sense_hdr *sshdr,
243 int timeout, int retries, u64 flags, req_flags_t rq_flags,
247 struct scsi_request *rq;
248 int ret = DRIVER_ERROR << 24;
250 req = blk_get_request(sdev->request_queue,
251 data_direction == DMA_TO_DEVICE ?
252 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN,
253 rq_flags & RQF_PM ? BLK_MQ_REQ_PM : 0);
258 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
259 buffer, bufflen, GFP_NOIO))
262 rq->cmd_len = COMMAND_SIZE(cmd[0]);
263 memcpy(rq->cmd, cmd, rq->cmd_len);
264 rq->retries = retries;
265 req->timeout = timeout;
266 req->cmd_flags |= flags;
267 req->rq_flags |= rq_flags | RQF_QUIET;
270 * head injection *required* here otherwise quiesce won't work
272 blk_execute_rq(NULL, req, 1);
275 * Some devices (USB mass-storage in particular) may transfer
276 * garbage data together with a residue indicating that the data
277 * is invalid. Prevent the garbage from being misinterpreted
278 * and prevent security leaks by zeroing out the excess data.
280 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
281 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
284 *resid = rq->resid_len;
285 if (sense && rq->sense_len)
286 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
288 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
291 blk_put_request(req);
295 EXPORT_SYMBOL(__scsi_execute);
298 * Wake up the error handler if necessary. Avoid as follows that the error
299 * handler is not woken up if host in-flight requests number ==
300 * shost->host_failed: use call_rcu() in scsi_eh_scmd_add() in combination
301 * with an RCU read lock in this function to ensure that this function in
302 * its entirety either finishes before scsi_eh_scmd_add() increases the
303 * host_failed counter or that it notices the shost state change made by
304 * scsi_eh_scmd_add().
306 static void scsi_dec_host_busy(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
311 __clear_bit(SCMD_STATE_INFLIGHT, &cmd->state);
312 if (unlikely(scsi_host_in_recovery(shost))) {
313 spin_lock_irqsave(shost->host_lock, flags);
314 if (shost->host_failed || shost->host_eh_scheduled)
315 scsi_eh_wakeup(shost);
316 spin_unlock_irqrestore(shost->host_lock, flags);
321 void scsi_device_unbusy(struct scsi_device *sdev, struct scsi_cmnd *cmd)
323 struct Scsi_Host *shost = sdev->host;
324 struct scsi_target *starget = scsi_target(sdev);
326 scsi_dec_host_busy(shost, cmd);
328 if (starget->can_queue > 0)
329 atomic_dec(&starget->target_busy);
331 sbitmap_put(&sdev->budget_map, cmd->budget_token);
332 cmd->budget_token = -1;
335 static void scsi_kick_queue(struct request_queue *q)
337 blk_mq_run_hw_queues(q, false);
341 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
342 * and call blk_run_queue for all the scsi_devices on the target -
343 * including current_sdev first.
345 * Called with *no* scsi locks held.
347 static void scsi_single_lun_run(struct scsi_device *current_sdev)
349 struct Scsi_Host *shost = current_sdev->host;
350 struct scsi_device *sdev, *tmp;
351 struct scsi_target *starget = scsi_target(current_sdev);
354 spin_lock_irqsave(shost->host_lock, flags);
355 starget->starget_sdev_user = NULL;
356 spin_unlock_irqrestore(shost->host_lock, flags);
359 * Call blk_run_queue for all LUNs on the target, starting with
360 * current_sdev. We race with others (to set starget_sdev_user),
361 * but in most cases, we will be first. Ideally, each LU on the
362 * target would get some limited time or requests on the target.
364 scsi_kick_queue(current_sdev->request_queue);
366 spin_lock_irqsave(shost->host_lock, flags);
367 if (starget->starget_sdev_user)
369 list_for_each_entry_safe(sdev, tmp, &starget->devices,
370 same_target_siblings) {
371 if (sdev == current_sdev)
373 if (scsi_device_get(sdev))
376 spin_unlock_irqrestore(shost->host_lock, flags);
377 scsi_kick_queue(sdev->request_queue);
378 spin_lock_irqsave(shost->host_lock, flags);
380 scsi_device_put(sdev);
383 spin_unlock_irqrestore(shost->host_lock, flags);
386 static inline bool scsi_device_is_busy(struct scsi_device *sdev)
388 if (scsi_device_busy(sdev) >= sdev->queue_depth)
390 if (atomic_read(&sdev->device_blocked) > 0)
395 static inline bool scsi_target_is_busy(struct scsi_target *starget)
397 if (starget->can_queue > 0) {
398 if (atomic_read(&starget->target_busy) >= starget->can_queue)
400 if (atomic_read(&starget->target_blocked) > 0)
406 static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
408 if (atomic_read(&shost->host_blocked) > 0)
410 if (shost->host_self_blocked)
415 static void scsi_starved_list_run(struct Scsi_Host *shost)
417 LIST_HEAD(starved_list);
418 struct scsi_device *sdev;
421 spin_lock_irqsave(shost->host_lock, flags);
422 list_splice_init(&shost->starved_list, &starved_list);
424 while (!list_empty(&starved_list)) {
425 struct request_queue *slq;
428 * As long as shost is accepting commands and we have
429 * starved queues, call blk_run_queue. scsi_request_fn
430 * drops the queue_lock and can add us back to the
433 * host_lock protects the starved_list and starved_entry.
434 * scsi_request_fn must get the host_lock before checking
435 * or modifying starved_list or starved_entry.
437 if (scsi_host_is_busy(shost))
440 sdev = list_entry(starved_list.next,
441 struct scsi_device, starved_entry);
442 list_del_init(&sdev->starved_entry);
443 if (scsi_target_is_busy(scsi_target(sdev))) {
444 list_move_tail(&sdev->starved_entry,
445 &shost->starved_list);
450 * Once we drop the host lock, a racing scsi_remove_device()
451 * call may remove the sdev from the starved list and destroy
452 * it and the queue. Mitigate by taking a reference to the
453 * queue and never touching the sdev again after we drop the
454 * host lock. Note: if __scsi_remove_device() invokes
455 * blk_cleanup_queue() before the queue is run from this
456 * function then blk_run_queue() will return immediately since
457 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
459 slq = sdev->request_queue;
460 if (!blk_get_queue(slq))
462 spin_unlock_irqrestore(shost->host_lock, flags);
464 scsi_kick_queue(slq);
467 spin_lock_irqsave(shost->host_lock, flags);
469 /* put any unprocessed entries back */
470 list_splice(&starved_list, &shost->starved_list);
471 spin_unlock_irqrestore(shost->host_lock, flags);
475 * scsi_run_queue - Select a proper request queue to serve next.
476 * @q: last request's queue
478 * The previous command was completely finished, start a new one if possible.
480 static void scsi_run_queue(struct request_queue *q)
482 struct scsi_device *sdev = q->queuedata;
484 if (scsi_target(sdev)->single_lun)
485 scsi_single_lun_run(sdev);
486 if (!list_empty(&sdev->host->starved_list))
487 scsi_starved_list_run(sdev->host);
489 blk_mq_run_hw_queues(q, false);
492 void scsi_requeue_run_queue(struct work_struct *work)
494 struct scsi_device *sdev;
495 struct request_queue *q;
497 sdev = container_of(work, struct scsi_device, requeue_work);
498 q = sdev->request_queue;
502 void scsi_run_host_queues(struct Scsi_Host *shost)
504 struct scsi_device *sdev;
506 shost_for_each_device(sdev, shost)
507 scsi_run_queue(sdev->request_queue);
510 static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
512 if (!blk_rq_is_passthrough(cmd->request)) {
513 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
515 if (drv->uninit_command)
516 drv->uninit_command(cmd);
520 void scsi_free_sgtables(struct scsi_cmnd *cmd)
522 if (cmd->sdb.table.nents)
523 sg_free_table_chained(&cmd->sdb.table,
525 if (scsi_prot_sg_count(cmd))
526 sg_free_table_chained(&cmd->prot_sdb->table,
527 SCSI_INLINE_PROT_SG_CNT);
529 EXPORT_SYMBOL_GPL(scsi_free_sgtables);
531 static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
533 scsi_free_sgtables(cmd);
534 scsi_uninit_cmd(cmd);
537 static void scsi_run_queue_async(struct scsi_device *sdev)
539 if (scsi_target(sdev)->single_lun ||
540 !list_empty(&sdev->host->starved_list)) {
541 kblockd_schedule_work(&sdev->requeue_work);
544 * smp_mb() present in sbitmap_queue_clear() or implied in
545 * .end_io is for ordering writing .device_busy in
546 * scsi_device_unbusy() and reading sdev->restarts.
548 int old = atomic_read(&sdev->restarts);
551 * ->restarts has to be kept as non-zero if new budget
554 * No need to run queue when either another re-run
555 * queue wins in updating ->restarts or a new budget
558 if (old && atomic_cmpxchg(&sdev->restarts, old, 0) == old)
559 blk_mq_run_hw_queues(sdev->request_queue, true);
563 /* Returns false when no more bytes to process, true if there are more */
564 static bool scsi_end_request(struct request *req, blk_status_t error,
567 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
568 struct scsi_device *sdev = cmd->device;
569 struct request_queue *q = sdev->request_queue;
571 if (blk_update_request(req, error, bytes))
574 if (blk_queue_add_random(q))
575 add_disk_randomness(req->rq_disk);
577 if (!blk_rq_is_scsi(req)) {
578 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
579 cmd->flags &= ~SCMD_INITIALIZED;
583 * Calling rcu_barrier() is not necessary here because the
584 * SCSI error handler guarantees that the function called by
585 * call_rcu() has been called before scsi_end_request() is
588 destroy_rcu_head(&cmd->rcu);
591 * In the MQ case the command gets freed by __blk_mq_end_request,
592 * so we have to do all cleanup that depends on it earlier.
594 * We also can't kick the queues from irq context, so we
595 * will have to defer it to a workqueue.
597 scsi_mq_uninit_cmd(cmd);
600 * queue is still alive, so grab the ref for preventing it
601 * from being cleaned up during running queue.
603 percpu_ref_get(&q->q_usage_counter);
605 __blk_mq_end_request(req, error);
607 scsi_run_queue_async(sdev);
609 percpu_ref_put(&q->q_usage_counter);
614 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
616 * @result: scsi error code
618 * Translate a SCSI result code into a blk_status_t value. May reset the host
619 * byte of @cmd->result.
621 static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
623 switch (host_byte(result)) {
626 * Also check the other bytes than the status byte in result
627 * to handle the case when a SCSI LLD sets result to
628 * DRIVER_SENSE << 24 without setting SAM_STAT_CHECK_CONDITION.
630 if (scsi_status_is_good(result) && (result & ~0xff) == 0)
632 return BLK_STS_IOERR;
633 case DID_TRANSPORT_FAILFAST:
634 case DID_TRANSPORT_MARGINAL:
635 return BLK_STS_TRANSPORT;
636 case DID_TARGET_FAILURE:
637 set_host_byte(cmd, DID_OK);
638 return BLK_STS_TARGET;
639 case DID_NEXUS_FAILURE:
640 set_host_byte(cmd, DID_OK);
641 return BLK_STS_NEXUS;
642 case DID_ALLOC_FAILURE:
643 set_host_byte(cmd, DID_OK);
644 return BLK_STS_NOSPC;
645 case DID_MEDIUM_ERROR:
646 set_host_byte(cmd, DID_OK);
647 return BLK_STS_MEDIUM;
649 return BLK_STS_IOERR;
653 /* Helper for scsi_io_completion() when "reprep" action required. */
654 static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
655 struct request_queue *q)
657 /* A new command will be prepared and issued. */
658 scsi_mq_requeue_cmd(cmd);
661 static bool scsi_cmd_runtime_exceeced(struct scsi_cmnd *cmd)
663 struct request *req = cmd->request;
664 unsigned long wait_for;
666 if (cmd->allowed == SCSI_CMD_RETRIES_NO_LIMIT)
669 wait_for = (cmd->allowed + 1) * req->timeout;
670 if (time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
671 scmd_printk(KERN_ERR, cmd, "timing out command, waited %lus\n",
678 /* Helper for scsi_io_completion() when special action required. */
679 static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
681 struct request_queue *q = cmd->device->request_queue;
682 struct request *req = cmd->request;
684 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
685 ACTION_DELAYED_RETRY} action;
686 struct scsi_sense_hdr sshdr;
688 bool sense_current = true; /* false implies "deferred sense" */
689 blk_status_t blk_stat;
691 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
693 sense_current = !scsi_sense_is_deferred(&sshdr);
695 blk_stat = scsi_result_to_blk_status(cmd, result);
697 if (host_byte(result) == DID_RESET) {
698 /* Third party bus reset or reset for error recovery
699 * reasons. Just retry the command and see what
702 action = ACTION_RETRY;
703 } else if (sense_valid && sense_current) {
704 switch (sshdr.sense_key) {
706 if (cmd->device->removable) {
707 /* Detected disc change. Set a bit
708 * and quietly refuse further access.
710 cmd->device->changed = 1;
711 action = ACTION_FAIL;
713 /* Must have been a power glitch, or a
714 * bus reset. Could not have been a
715 * media change, so we just retry the
716 * command and see what happens.
718 action = ACTION_RETRY;
721 case ILLEGAL_REQUEST:
722 /* If we had an ILLEGAL REQUEST returned, then
723 * we may have performed an unsupported
724 * command. The only thing this should be
725 * would be a ten byte read where only a six
726 * byte read was supported. Also, on a system
727 * where READ CAPACITY failed, we may have
728 * read past the end of the disk.
730 if ((cmd->device->use_10_for_rw &&
731 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
732 (cmd->cmnd[0] == READ_10 ||
733 cmd->cmnd[0] == WRITE_10)) {
734 /* This will issue a new 6-byte command. */
735 cmd->device->use_10_for_rw = 0;
736 action = ACTION_REPREP;
737 } else if (sshdr.asc == 0x10) /* DIX */ {
738 action = ACTION_FAIL;
739 blk_stat = BLK_STS_PROTECTION;
740 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
741 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
742 action = ACTION_FAIL;
743 blk_stat = BLK_STS_TARGET;
745 action = ACTION_FAIL;
747 case ABORTED_COMMAND:
748 action = ACTION_FAIL;
749 if (sshdr.asc == 0x10) /* DIF */
750 blk_stat = BLK_STS_PROTECTION;
753 /* If the device is in the process of becoming
754 * ready, or has a temporary blockage, retry.
756 if (sshdr.asc == 0x04) {
757 switch (sshdr.ascq) {
758 case 0x01: /* becoming ready */
759 case 0x04: /* format in progress */
760 case 0x05: /* rebuild in progress */
761 case 0x06: /* recalculation in progress */
762 case 0x07: /* operation in progress */
763 case 0x08: /* Long write in progress */
764 case 0x09: /* self test in progress */
765 case 0x14: /* space allocation in progress */
766 case 0x1a: /* start stop unit in progress */
767 case 0x1b: /* sanitize in progress */
768 case 0x1d: /* configuration in progress */
769 case 0x24: /* depopulation in progress */
770 action = ACTION_DELAYED_RETRY;
772 case 0x0a: /* ALUA state transition */
773 blk_stat = BLK_STS_AGAIN;
776 action = ACTION_FAIL;
780 action = ACTION_FAIL;
782 case VOLUME_OVERFLOW:
783 /* See SSC3rXX or current. */
784 action = ACTION_FAIL;
787 action = ACTION_FAIL;
788 if ((sshdr.asc == 0x0C && sshdr.ascq == 0x12) ||
789 (sshdr.asc == 0x55 &&
790 (sshdr.ascq == 0x0E || sshdr.ascq == 0x0F))) {
791 /* Insufficient zone resources */
792 blk_stat = BLK_STS_ZONE_OPEN_RESOURCE;
796 action = ACTION_FAIL;
800 action = ACTION_FAIL;
802 if (action != ACTION_FAIL && scsi_cmd_runtime_exceeced(cmd))
803 action = ACTION_FAIL;
807 /* Give up and fail the remainder of the request */
808 if (!(req->rq_flags & RQF_QUIET)) {
809 static DEFINE_RATELIMIT_STATE(_rs,
810 DEFAULT_RATELIMIT_INTERVAL,
811 DEFAULT_RATELIMIT_BURST);
813 if (unlikely(scsi_logging_level))
815 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
816 SCSI_LOG_MLCOMPLETE_BITS);
819 * if logging is enabled the failure will be printed
820 * in scsi_log_completion(), so avoid duplicate messages
822 if (!level && __ratelimit(&_rs)) {
823 scsi_print_result(cmd, NULL, FAILED);
824 if (driver_byte(result) == DRIVER_SENSE)
825 scsi_print_sense(cmd);
826 scsi_print_command(cmd);
829 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req)))
833 scsi_io_completion_reprep(cmd, q);
836 /* Retry the same command immediately */
837 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
839 case ACTION_DELAYED_RETRY:
840 /* Retry the same command after a delay */
841 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
847 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
848 * new result that may suppress further error checking. Also modifies
849 * *blk_statp in some cases.
851 static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
852 blk_status_t *blk_statp)
855 bool sense_current = true; /* false implies "deferred sense" */
856 struct request *req = cmd->request;
857 struct scsi_sense_hdr sshdr;
859 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
861 sense_current = !scsi_sense_is_deferred(&sshdr);
863 if (blk_rq_is_passthrough(req)) {
866 * SG_IO wants current and deferred errors
868 scsi_req(req)->sense_len =
869 min(8 + cmd->sense_buffer[7],
870 SCSI_SENSE_BUFFERSIZE);
873 *blk_statp = scsi_result_to_blk_status(cmd, result);
874 } else if (blk_rq_bytes(req) == 0 && sense_current) {
876 * Flush commands do not transfers any data, and thus cannot use
877 * good_bytes != blk_rq_bytes(req) as the signal for an error.
878 * This sets *blk_statp explicitly for the problem case.
880 *blk_statp = scsi_result_to_blk_status(cmd, result);
883 * Recovered errors need reporting, but they're always treated as
884 * success, so fiddle the result code here. For passthrough requests
885 * we already took a copy of the original into sreq->result which
886 * is what gets returned to the user
888 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
889 bool do_print = true;
891 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
892 * skip print since caller wants ATA registers. Only occurs
893 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
895 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
897 else if (req->rq_flags & RQF_QUIET)
900 scsi_print_sense(cmd);
902 /* for passthrough, *blk_statp may be set */
903 *blk_statp = BLK_STS_OK;
906 * Another corner case: the SCSI status byte is non-zero but 'good'.
907 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
908 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
909 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
910 * intermediate statuses (both obsolete in SAM-4) as good.
912 if (status_byte(result) && scsi_status_is_good(result)) {
914 *blk_statp = BLK_STS_OK;
920 * scsi_io_completion - Completion processing for SCSI commands.
921 * @cmd: command that is finished.
922 * @good_bytes: number of processed bytes.
924 * We will finish off the specified number of sectors. If we are done, the
925 * command block will be released and the queue function will be goosed. If we
926 * are not done then we have to figure out what to do next:
928 * a) We can call scsi_io_completion_reprep(). The request will be
929 * unprepared and put back on the queue. Then a new command will
930 * be created for it. This should be used if we made forward
931 * progress, or if we want to switch from READ(10) to READ(6) for
934 * b) We can call scsi_io_completion_action(). The request will be
935 * put back on the queue and retried using the same command as
936 * before, possibly after a delay.
938 * c) We can call scsi_end_request() with blk_stat other than
939 * BLK_STS_OK, to fail the remainder of the request.
941 void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
943 int result = cmd->result;
944 struct request_queue *q = cmd->device->request_queue;
945 struct request *req = cmd->request;
946 blk_status_t blk_stat = BLK_STS_OK;
948 if (unlikely(result)) /* a nz result may or may not be an error */
949 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
951 if (unlikely(blk_rq_is_passthrough(req))) {
953 * scsi_result_to_blk_status may have reset the host_byte
955 scsi_req(req)->result = cmd->result;
959 * Next deal with any sectors which we were able to correctly
962 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
963 "%u sectors total, %d bytes done.\n",
964 blk_rq_sectors(req), good_bytes));
967 * Failed, zero length commands always need to drop down
968 * to retry code. Fast path should return in this block.
970 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
971 if (likely(!scsi_end_request(req, blk_stat, good_bytes)))
972 return; /* no bytes remaining */
975 /* Kill remainder if no retries. */
976 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
977 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req)))
979 "Bytes remaining after failed, no-retry command");
984 * If there had been no error, but we have leftover bytes in the
985 * requeues just queue the command up again.
987 if (likely(result == 0))
988 scsi_io_completion_reprep(cmd, q);
990 scsi_io_completion_action(cmd, result);
993 static inline bool scsi_cmd_needs_dma_drain(struct scsi_device *sdev,
996 return sdev->dma_drain_len && blk_rq_is_passthrough(rq) &&
997 !op_is_write(req_op(rq)) &&
998 sdev->host->hostt->dma_need_drain(rq);
1002 * scsi_alloc_sgtables - allocate S/G tables for a command
1003 * @cmd: command descriptor we wish to initialize
1006 * * BLK_STS_OK - on success
1007 * * BLK_STS_RESOURCE - if the failure is retryable
1008 * * BLK_STS_IOERR - if the failure is fatal
1010 blk_status_t scsi_alloc_sgtables(struct scsi_cmnd *cmd)
1012 struct scsi_device *sdev = cmd->device;
1013 struct request *rq = cmd->request;
1014 unsigned short nr_segs = blk_rq_nr_phys_segments(rq);
1015 struct scatterlist *last_sg = NULL;
1017 bool need_drain = scsi_cmd_needs_dma_drain(sdev, rq);
1020 if (WARN_ON_ONCE(!nr_segs))
1021 return BLK_STS_IOERR;
1024 * Make sure there is space for the drain. The driver must adjust
1025 * max_hw_segments to be prepared for this.
1031 * If sg table allocation fails, requeue request later.
1033 if (unlikely(sg_alloc_table_chained(&cmd->sdb.table, nr_segs,
1034 cmd->sdb.table.sgl, SCSI_INLINE_SG_CNT)))
1035 return BLK_STS_RESOURCE;
1038 * Next, walk the list, and fill in the addresses and sizes of
1041 count = __blk_rq_map_sg(rq->q, rq, cmd->sdb.table.sgl, &last_sg);
1043 if (blk_rq_bytes(rq) & rq->q->dma_pad_mask) {
1044 unsigned int pad_len =
1045 (rq->q->dma_pad_mask & ~blk_rq_bytes(rq)) + 1;
1047 last_sg->length += pad_len;
1048 cmd->extra_len += pad_len;
1052 sg_unmark_end(last_sg);
1053 last_sg = sg_next(last_sg);
1054 sg_set_buf(last_sg, sdev->dma_drain_buf, sdev->dma_drain_len);
1055 sg_mark_end(last_sg);
1057 cmd->extra_len += sdev->dma_drain_len;
1061 BUG_ON(count > cmd->sdb.table.nents);
1062 cmd->sdb.table.nents = count;
1063 cmd->sdb.length = blk_rq_payload_bytes(rq);
1065 if (blk_integrity_rq(rq)) {
1066 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1069 if (WARN_ON_ONCE(!prot_sdb)) {
1071 * This can happen if someone (e.g. multipath)
1072 * queues a command to a device on an adapter
1073 * that does not support DIX.
1075 ret = BLK_STS_IOERR;
1076 goto out_free_sgtables;
1079 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
1081 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
1082 prot_sdb->table.sgl,
1083 SCSI_INLINE_PROT_SG_CNT)) {
1084 ret = BLK_STS_RESOURCE;
1085 goto out_free_sgtables;
1088 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
1089 prot_sdb->table.sgl);
1090 BUG_ON(count > ivecs);
1091 BUG_ON(count > queue_max_integrity_segments(rq->q));
1093 cmd->prot_sdb = prot_sdb;
1094 cmd->prot_sdb->table.nents = count;
1099 scsi_free_sgtables(cmd);
1102 EXPORT_SYMBOL(scsi_alloc_sgtables);
1105 * scsi_initialize_rq - initialize struct scsi_cmnd partially
1106 * @rq: Request associated with the SCSI command to be initialized.
1108 * This function initializes the members of struct scsi_cmnd that must be
1109 * initialized before request processing starts and that won't be
1110 * reinitialized if a SCSI command is requeued.
1112 * Called from inside blk_get_request() for pass-through requests and from
1113 * inside scsi_init_command() for filesystem requests.
1115 static void scsi_initialize_rq(struct request *rq)
1117 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1119 scsi_req_init(&cmd->req);
1120 init_rcu_head(&cmd->rcu);
1121 cmd->jiffies_at_alloc = jiffies;
1126 * Only called when the request isn't completed by SCSI, and not freed by
1129 static void scsi_cleanup_rq(struct request *rq)
1131 if (rq->rq_flags & RQF_DONTPREP) {
1132 scsi_mq_uninit_cmd(blk_mq_rq_to_pdu(rq));
1133 rq->rq_flags &= ~RQF_DONTPREP;
1137 /* Called before a request is prepared. See also scsi_mq_prep_fn(). */
1138 void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
1140 void *buf = cmd->sense_buffer;
1141 void *prot = cmd->prot_sdb;
1142 struct request *rq = blk_mq_rq_from_pdu(cmd);
1143 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
1144 unsigned long jiffies_at_alloc;
1145 int retries, to_clear;
1147 int budget_token = cmd->budget_token;
1149 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1150 flags |= SCMD_INITIALIZED;
1151 scsi_initialize_rq(rq);
1154 jiffies_at_alloc = cmd->jiffies_at_alloc;
1155 retries = cmd->retries;
1156 in_flight = test_bit(SCMD_STATE_INFLIGHT, &cmd->state);
1158 * Zero out the cmd, except for the embedded scsi_request. Only clear
1159 * the driver-private command data if the LLD does not supply a
1160 * function to initialize that data.
1162 to_clear = sizeof(*cmd) - sizeof(cmd->req);
1163 if (!dev->host->hostt->init_cmd_priv)
1164 to_clear += dev->host->hostt->cmd_size;
1165 memset((char *)cmd + sizeof(cmd->req), 0, to_clear);
1168 cmd->sense_buffer = buf;
1169 cmd->prot_sdb = prot;
1171 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1172 cmd->jiffies_at_alloc = jiffies_at_alloc;
1173 cmd->retries = retries;
1175 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state);
1176 cmd->budget_token = budget_token;
1180 static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1181 struct request *req)
1183 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1186 * Passthrough requests may transfer data, in which case they must
1187 * a bio attached to them. Or they might contain a SCSI command
1188 * that does not transfer data, in which case they may optionally
1189 * submit a request without an attached bio.
1192 blk_status_t ret = scsi_alloc_sgtables(cmd);
1193 if (unlikely(ret != BLK_STS_OK))
1196 BUG_ON(blk_rq_bytes(req));
1198 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
1201 cmd->cmd_len = scsi_req(req)->cmd_len;
1202 if (cmd->cmd_len == 0)
1203 cmd->cmd_len = scsi_command_size(cmd->cmnd);
1204 cmd->cmnd = scsi_req(req)->cmd;
1205 cmd->transfersize = blk_rq_bytes(req);
1206 cmd->allowed = scsi_req(req)->retries;
1211 scsi_device_state_check(struct scsi_device *sdev, struct request *req)
1213 switch (sdev->sdev_state) {
1217 case SDEV_TRANSPORT_OFFLINE:
1219 * If the device is offline we refuse to process any
1220 * commands. The device must be brought online
1221 * before trying any recovery commands.
1223 if (!sdev->offline_already) {
1224 sdev->offline_already = true;
1225 sdev_printk(KERN_ERR, sdev,
1226 "rejecting I/O to offline device\n");
1228 return BLK_STS_IOERR;
1231 * If the device is fully deleted, we refuse to
1232 * process any commands as well.
1234 sdev_printk(KERN_ERR, sdev,
1235 "rejecting I/O to dead device\n");
1236 return BLK_STS_IOERR;
1238 case SDEV_CREATED_BLOCK:
1239 return BLK_STS_RESOURCE;
1242 * If the device is blocked we only accept power management
1245 if (req && WARN_ON_ONCE(!(req->rq_flags & RQF_PM)))
1246 return BLK_STS_RESOURCE;
1250 * For any other not fully online state we only allow
1251 * power management commands.
1253 if (req && !(req->rq_flags & RQF_PM))
1254 return BLK_STS_IOERR;
1260 * scsi_dev_queue_ready: if we can send requests to sdev, assign one token
1261 * and return the token else return -1.
1263 static inline int scsi_dev_queue_ready(struct request_queue *q,
1264 struct scsi_device *sdev)
1268 token = sbitmap_get(&sdev->budget_map);
1269 if (atomic_read(&sdev->device_blocked)) {
1273 if (scsi_device_busy(sdev) > 1)
1277 * unblock after device_blocked iterates to zero
1279 if (atomic_dec_return(&sdev->device_blocked) > 0)
1281 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1282 "unblocking device at zero depth\n"));
1288 sbitmap_put(&sdev->budget_map, token);
1294 * scsi_target_queue_ready: checks if there we can send commands to target
1295 * @sdev: scsi device on starget to check.
1297 static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1298 struct scsi_device *sdev)
1300 struct scsi_target *starget = scsi_target(sdev);
1303 if (starget->single_lun) {
1304 spin_lock_irq(shost->host_lock);
1305 if (starget->starget_sdev_user &&
1306 starget->starget_sdev_user != sdev) {
1307 spin_unlock_irq(shost->host_lock);
1310 starget->starget_sdev_user = sdev;
1311 spin_unlock_irq(shost->host_lock);
1314 if (starget->can_queue <= 0)
1317 busy = atomic_inc_return(&starget->target_busy) - 1;
1318 if (atomic_read(&starget->target_blocked) > 0) {
1323 * unblock after target_blocked iterates to zero
1325 if (atomic_dec_return(&starget->target_blocked) > 0)
1328 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1329 "unblocking target at zero depth\n"));
1332 if (busy >= starget->can_queue)
1338 spin_lock_irq(shost->host_lock);
1339 list_move_tail(&sdev->starved_entry, &shost->starved_list);
1340 spin_unlock_irq(shost->host_lock);
1342 if (starget->can_queue > 0)
1343 atomic_dec(&starget->target_busy);
1348 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1349 * return 0. We must end up running the queue again whenever 0 is
1350 * returned, else IO can hang.
1352 static inline int scsi_host_queue_ready(struct request_queue *q,
1353 struct Scsi_Host *shost,
1354 struct scsi_device *sdev,
1355 struct scsi_cmnd *cmd)
1357 if (scsi_host_in_recovery(shost))
1360 if (atomic_read(&shost->host_blocked) > 0) {
1361 if (scsi_host_busy(shost) > 0)
1365 * unblock after host_blocked iterates to zero
1367 if (atomic_dec_return(&shost->host_blocked) > 0)
1371 shost_printk(KERN_INFO, shost,
1372 "unblocking host at zero depth\n"));
1375 if (shost->host_self_blocked)
1378 /* We're OK to process the command, so we can't be starved */
1379 if (!list_empty(&sdev->starved_entry)) {
1380 spin_lock_irq(shost->host_lock);
1381 if (!list_empty(&sdev->starved_entry))
1382 list_del_init(&sdev->starved_entry);
1383 spin_unlock_irq(shost->host_lock);
1386 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state);
1391 spin_lock_irq(shost->host_lock);
1392 if (list_empty(&sdev->starved_entry))
1393 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1394 spin_unlock_irq(shost->host_lock);
1396 scsi_dec_host_busy(shost, cmd);
1401 * Busy state exporting function for request stacking drivers.
1403 * For efficiency, no lock is taken to check the busy state of
1404 * shost/starget/sdev, since the returned value is not guaranteed and
1405 * may be changed after request stacking drivers call the function,
1406 * regardless of taking lock or not.
1408 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1409 * needs to return 'not busy'. Otherwise, request stacking drivers
1410 * may hold requests forever.
1412 static bool scsi_mq_lld_busy(struct request_queue *q)
1414 struct scsi_device *sdev = q->queuedata;
1415 struct Scsi_Host *shost;
1417 if (blk_queue_dying(q))
1423 * Ignore host/starget busy state.
1424 * Since block layer does not have a concept of fairness across
1425 * multiple queues, congestion of host/starget needs to be handled
1428 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
1434 static void scsi_softirq_done(struct request *rq)
1436 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1439 INIT_LIST_HEAD(&cmd->eh_entry);
1441 atomic_inc(&cmd->device->iodone_cnt);
1443 atomic_inc(&cmd->device->ioerr_cnt);
1445 disposition = scsi_decide_disposition(cmd);
1446 if (disposition != SUCCESS && scsi_cmd_runtime_exceeced(cmd))
1447 disposition = SUCCESS;
1449 scsi_log_completion(cmd, disposition);
1451 switch (disposition) {
1453 scsi_finish_command(cmd);
1456 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
1458 case ADD_TO_MLQUEUE:
1459 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1462 scsi_eh_scmd_add(cmd);
1468 * scsi_dispatch_cmd - Dispatch a command to the low-level driver.
1469 * @cmd: command block we are dispatching.
1471 * Return: nonzero return request was rejected and device's queue needs to be
1474 static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1476 struct Scsi_Host *host = cmd->device->host;
1479 atomic_inc(&cmd->device->iorequest_cnt);
1481 /* check if the device is still usable */
1482 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1483 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1484 * returns an immediate error upwards, and signals
1485 * that the device is no longer present */
1486 cmd->result = DID_NO_CONNECT << 16;
1490 /* Check to see if the scsi lld made this device blocked. */
1491 if (unlikely(scsi_device_blocked(cmd->device))) {
1493 * in blocked state, the command is just put back on
1494 * the device queue. The suspend state has already
1495 * blocked the queue so future requests should not
1496 * occur until the device transitions out of the
1499 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1500 "queuecommand : device blocked\n"));
1501 return SCSI_MLQUEUE_DEVICE_BUSY;
1504 /* Store the LUN value in cmnd, if needed. */
1505 if (cmd->device->lun_in_cdb)
1506 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1507 (cmd->device->lun << 5 & 0xe0);
1512 * Before we queue this command, check if the command
1513 * length exceeds what the host adapter can handle.
1515 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1516 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1517 "queuecommand : command too long. "
1518 "cdb_size=%d host->max_cmd_len=%d\n",
1519 cmd->cmd_len, cmd->device->host->max_cmd_len));
1520 cmd->result = (DID_ABORT << 16);
1524 if (unlikely(host->shost_state == SHOST_DEL)) {
1525 cmd->result = (DID_NO_CONNECT << 16);
1530 trace_scsi_dispatch_cmd_start(cmd);
1531 rtn = host->hostt->queuecommand(host, cmd);
1533 trace_scsi_dispatch_cmd_error(cmd, rtn);
1534 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1535 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1536 rtn = SCSI_MLQUEUE_HOST_BUSY;
1538 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1539 "queuecommand : request rejected\n"));
1544 cmd->scsi_done(cmd);
1548 /* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
1549 static unsigned int scsi_mq_inline_sgl_size(struct Scsi_Host *shost)
1551 return min_t(unsigned int, shost->sg_tablesize, SCSI_INLINE_SG_CNT) *
1552 sizeof(struct scatterlist);
1555 static blk_status_t scsi_prepare_cmd(struct request *req)
1557 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1558 struct scsi_device *sdev = req->q->queuedata;
1559 struct Scsi_Host *shost = sdev->host;
1560 struct scatterlist *sg;
1562 scsi_init_command(sdev, cmd);
1565 cmd->tag = req->tag;
1566 cmd->prot_op = SCSI_PROT_NORMAL;
1567 if (blk_rq_bytes(req))
1568 cmd->sc_data_direction = rq_dma_dir(req);
1570 cmd->sc_data_direction = DMA_NONE;
1572 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1573 cmd->sdb.table.sgl = sg;
1575 if (scsi_host_get_prot(shost)) {
1576 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1578 cmd->prot_sdb->table.sgl =
1579 (struct scatterlist *)(cmd->prot_sdb + 1);
1583 * Special handling for passthrough commands, which don't go to the ULP
1586 if (blk_rq_is_scsi(req))
1587 return scsi_setup_scsi_cmnd(sdev, req);
1589 if (sdev->handler && sdev->handler->prep_fn) {
1590 blk_status_t ret = sdev->handler->prep_fn(sdev, req);
1592 if (ret != BLK_STS_OK)
1596 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
1597 memset(cmd->cmnd, 0, BLK_MAX_CDB);
1598 return scsi_cmd_to_driver(cmd)->init_command(cmd);
1601 static void scsi_mq_done(struct scsi_cmnd *cmd)
1603 if (unlikely(blk_should_fake_timeout(cmd->request->q)))
1605 if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state)))
1607 trace_scsi_dispatch_cmd_done(cmd);
1608 blk_mq_complete_request(cmd->request);
1611 static void scsi_mq_put_budget(struct request_queue *q, int budget_token)
1613 struct scsi_device *sdev = q->queuedata;
1615 sbitmap_put(&sdev->budget_map, budget_token);
1618 static int scsi_mq_get_budget(struct request_queue *q)
1620 struct scsi_device *sdev = q->queuedata;
1621 int token = scsi_dev_queue_ready(q, sdev);
1626 atomic_inc(&sdev->restarts);
1629 * Orders atomic_inc(&sdev->restarts) and atomic_read(&sdev->device_busy).
1630 * .restarts must be incremented before .device_busy is read because the
1631 * code in scsi_run_queue_async() depends on the order of these operations.
1633 smp_mb__after_atomic();
1636 * If all in-flight requests originated from this LUN are completed
1637 * before reading .device_busy, sdev->device_busy will be observed as
1638 * zero, then blk_mq_delay_run_hw_queues() will dispatch this request
1639 * soon. Otherwise, completion of one of these requests will observe
1640 * the .restarts flag, and the request queue will be run for handling
1641 * this request, see scsi_end_request().
1643 if (unlikely(scsi_device_busy(sdev) == 0 &&
1644 !scsi_device_blocked(sdev)))
1645 blk_mq_delay_run_hw_queues(sdev->request_queue, SCSI_QUEUE_DELAY);
1649 static void scsi_mq_set_rq_budget_token(struct request *req, int token)
1651 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1653 cmd->budget_token = token;
1656 static int scsi_mq_get_rq_budget_token(struct request *req)
1658 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1660 return cmd->budget_token;
1663 static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1664 const struct blk_mq_queue_data *bd)
1666 struct request *req = bd->rq;
1667 struct request_queue *q = req->q;
1668 struct scsi_device *sdev = q->queuedata;
1669 struct Scsi_Host *shost = sdev->host;
1670 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1674 WARN_ON_ONCE(cmd->budget_token < 0);
1677 * If the device is not in running state we will reject some or all
1680 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1681 ret = scsi_device_state_check(sdev, req);
1682 if (ret != BLK_STS_OK)
1683 goto out_put_budget;
1686 ret = BLK_STS_RESOURCE;
1687 if (!scsi_target_queue_ready(shost, sdev))
1688 goto out_put_budget;
1689 if (!scsi_host_queue_ready(q, shost, sdev, cmd))
1690 goto out_dec_target_busy;
1692 if (!(req->rq_flags & RQF_DONTPREP)) {
1693 ret = scsi_prepare_cmd(req);
1694 if (ret != BLK_STS_OK)
1695 goto out_dec_host_busy;
1696 req->rq_flags |= RQF_DONTPREP;
1698 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
1701 cmd->flags &= SCMD_PRESERVED_FLAGS;
1702 if (sdev->simple_tags)
1703 cmd->flags |= SCMD_TAGGED;
1705 cmd->flags |= SCMD_LAST;
1707 scsi_set_resid(cmd, 0);
1708 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1709 cmd->scsi_done = scsi_mq_done;
1711 blk_mq_start_request(req);
1712 reason = scsi_dispatch_cmd(cmd);
1714 scsi_set_blocked(cmd, reason);
1715 ret = BLK_STS_RESOURCE;
1716 goto out_dec_host_busy;
1722 scsi_dec_host_busy(shost, cmd);
1723 out_dec_target_busy:
1724 if (scsi_target(sdev)->can_queue > 0)
1725 atomic_dec(&scsi_target(sdev)->target_busy);
1727 scsi_mq_put_budget(q, cmd->budget_token);
1728 cmd->budget_token = -1;
1732 case BLK_STS_RESOURCE:
1733 case BLK_STS_ZONE_RESOURCE:
1734 if (scsi_device_blocked(sdev))
1735 ret = BLK_STS_DEV_RESOURCE;
1738 scsi_req(req)->result = DID_BUS_BUSY << 16;
1739 if (req->rq_flags & RQF_DONTPREP)
1740 scsi_mq_uninit_cmd(cmd);
1743 if (unlikely(!scsi_device_online(sdev)))
1744 scsi_req(req)->result = DID_NO_CONNECT << 16;
1746 scsi_req(req)->result = DID_ERROR << 16;
1748 * Make sure to release all allocated resources when
1749 * we hit an error, as we will never see this command
1752 if (req->rq_flags & RQF_DONTPREP)
1753 scsi_mq_uninit_cmd(cmd);
1754 scsi_run_queue_async(sdev);
1760 static enum blk_eh_timer_return scsi_timeout(struct request *req,
1764 return BLK_EH_RESET_TIMER;
1765 return scsi_times_out(req);
1768 static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1769 unsigned int hctx_idx, unsigned int numa_node)
1771 struct Scsi_Host *shost = set->driver_data;
1772 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
1773 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1774 struct scatterlist *sg;
1777 if (unchecked_isa_dma)
1778 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
1779 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
1780 GFP_KERNEL, numa_node);
1781 if (!cmd->sense_buffer)
1783 cmd->req.sense = cmd->sense_buffer;
1785 if (scsi_host_get_prot(shost)) {
1786 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1787 shost->hostt->cmd_size;
1788 cmd->prot_sdb = (void *)sg + scsi_mq_inline_sgl_size(shost);
1791 if (shost->hostt->init_cmd_priv) {
1792 ret = shost->hostt->init_cmd_priv(shost, cmd);
1794 scsi_free_sense_buffer(unchecked_isa_dma,
1801 static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
1802 unsigned int hctx_idx)
1804 struct Scsi_Host *shost = set->driver_data;
1805 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1807 if (shost->hostt->exit_cmd_priv)
1808 shost->hostt->exit_cmd_priv(shost, cmd);
1809 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
1813 static int scsi_map_queues(struct blk_mq_tag_set *set)
1815 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1817 if (shost->hostt->map_queues)
1818 return shost->hostt->map_queues(shost);
1819 return blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
1822 void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
1824 struct device *dev = shost->dma_dev;
1827 * this limit is imposed by hardware restrictions
1829 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
1832 if (scsi_host_prot_dma(shost)) {
1833 shost->sg_prot_tablesize =
1834 min_not_zero(shost->sg_prot_tablesize,
1835 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1836 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1837 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1840 if (dev->dma_mask) {
1841 shost->max_sectors = min_t(unsigned int, shost->max_sectors,
1842 dma_max_mapping_size(dev) >> SECTOR_SHIFT);
1844 blk_queue_max_hw_sectors(q, shost->max_sectors);
1845 if (shost->unchecked_isa_dma)
1846 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
1847 blk_queue_segment_boundary(q, shost->dma_boundary);
1848 dma_set_seg_boundary(dev, shost->dma_boundary);
1850 blk_queue_max_segment_size(q, shost->max_segment_size);
1851 blk_queue_virt_boundary(q, shost->virt_boundary_mask);
1852 dma_set_max_seg_size(dev, queue_max_segment_size(q));
1855 * Set a reasonable default alignment: The larger of 32-byte (dword),
1856 * which is a common minimum for HBAs, and the minimum DMA alignment,
1857 * which is set by the platform.
1859 * Devices that require a bigger alignment can increase it later.
1861 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
1863 EXPORT_SYMBOL_GPL(__scsi_init_queue);
1865 static const struct blk_mq_ops scsi_mq_ops_no_commit = {
1866 .get_budget = scsi_mq_get_budget,
1867 .put_budget = scsi_mq_put_budget,
1868 .queue_rq = scsi_queue_rq,
1869 .complete = scsi_softirq_done,
1870 .timeout = scsi_timeout,
1871 #ifdef CONFIG_BLK_DEBUG_FS
1872 .show_rq = scsi_show_rq,
1874 .init_request = scsi_mq_init_request,
1875 .exit_request = scsi_mq_exit_request,
1876 .initialize_rq_fn = scsi_initialize_rq,
1877 .cleanup_rq = scsi_cleanup_rq,
1878 .busy = scsi_mq_lld_busy,
1879 .map_queues = scsi_map_queues,
1880 .set_rq_budget_token = scsi_mq_set_rq_budget_token,
1881 .get_rq_budget_token = scsi_mq_get_rq_budget_token,
1885 static void scsi_commit_rqs(struct blk_mq_hw_ctx *hctx)
1887 struct request_queue *q = hctx->queue;
1888 struct scsi_device *sdev = q->queuedata;
1889 struct Scsi_Host *shost = sdev->host;
1891 shost->hostt->commit_rqs(shost, hctx->queue_num);
1894 static const struct blk_mq_ops scsi_mq_ops = {
1895 .get_budget = scsi_mq_get_budget,
1896 .put_budget = scsi_mq_put_budget,
1897 .queue_rq = scsi_queue_rq,
1898 .commit_rqs = scsi_commit_rqs,
1899 .complete = scsi_softirq_done,
1900 .timeout = scsi_timeout,
1901 #ifdef CONFIG_BLK_DEBUG_FS
1902 .show_rq = scsi_show_rq,
1904 .init_request = scsi_mq_init_request,
1905 .exit_request = scsi_mq_exit_request,
1906 .initialize_rq_fn = scsi_initialize_rq,
1907 .cleanup_rq = scsi_cleanup_rq,
1908 .busy = scsi_mq_lld_busy,
1909 .map_queues = scsi_map_queues,
1910 .set_rq_budget_token = scsi_mq_set_rq_budget_token,
1911 .get_rq_budget_token = scsi_mq_get_rq_budget_token,
1914 struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
1916 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
1917 if (IS_ERR(sdev->request_queue))
1920 sdev->request_queue->queuedata = sdev;
1921 __scsi_init_queue(sdev->host, sdev->request_queue);
1922 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
1923 return sdev->request_queue;
1926 int scsi_mq_setup_tags(struct Scsi_Host *shost)
1928 unsigned int cmd_size, sgl_size;
1929 struct blk_mq_tag_set *tag_set = &shost->tag_set;
1931 sgl_size = max_t(unsigned int, sizeof(struct scatterlist),
1932 scsi_mq_inline_sgl_size(shost));
1933 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1934 if (scsi_host_get_prot(shost))
1935 cmd_size += sizeof(struct scsi_data_buffer) +
1936 sizeof(struct scatterlist) * SCSI_INLINE_PROT_SG_CNT;
1938 memset(tag_set, 0, sizeof(*tag_set));
1939 if (shost->hostt->commit_rqs)
1940 tag_set->ops = &scsi_mq_ops;
1942 tag_set->ops = &scsi_mq_ops_no_commit;
1943 tag_set->nr_hw_queues = shost->nr_hw_queues ? : 1;
1944 tag_set->queue_depth = shost->can_queue;
1945 tag_set->cmd_size = cmd_size;
1946 tag_set->numa_node = NUMA_NO_NODE;
1947 tag_set->flags = BLK_MQ_F_SHOULD_MERGE;
1949 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
1950 tag_set->driver_data = shost;
1951 if (shost->host_tagset)
1952 tag_set->flags |= BLK_MQ_F_TAG_HCTX_SHARED;
1954 return blk_mq_alloc_tag_set(tag_set);
1957 void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1959 blk_mq_free_tag_set(&shost->tag_set);
1963 * scsi_device_from_queue - return sdev associated with a request_queue
1964 * @q: The request queue to return the sdev from
1966 * Return the sdev associated with a request queue or NULL if the
1967 * request_queue does not reference a SCSI device.
1969 struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1971 struct scsi_device *sdev = NULL;
1973 if (q->mq_ops == &scsi_mq_ops_no_commit ||
1974 q->mq_ops == &scsi_mq_ops)
1975 sdev = q->queuedata;
1976 if (!sdev || !get_device(&sdev->sdev_gendev))
1983 * scsi_block_requests - Utility function used by low-level drivers to prevent
1984 * further commands from being queued to the device.
1985 * @shost: host in question
1987 * There is no timer nor any other means by which the requests get unblocked
1988 * other than the low-level driver calling scsi_unblock_requests().
1990 void scsi_block_requests(struct Scsi_Host *shost)
1992 shost->host_self_blocked = 1;
1994 EXPORT_SYMBOL(scsi_block_requests);
1997 * scsi_unblock_requests - Utility function used by low-level drivers to allow
1998 * further commands to be queued to the device.
1999 * @shost: host in question
2001 * There is no timer nor any other means by which the requests get unblocked
2002 * other than the low-level driver calling scsi_unblock_requests(). This is done
2003 * as an API function so that changes to the internals of the scsi mid-layer
2004 * won't require wholesale changes to drivers that use this feature.
2006 void scsi_unblock_requests(struct Scsi_Host *shost)
2008 shost->host_self_blocked = 0;
2009 scsi_run_host_queues(shost);
2011 EXPORT_SYMBOL(scsi_unblock_requests);
2013 void scsi_exit_queue(void)
2015 kmem_cache_destroy(scsi_sense_cache);
2016 kmem_cache_destroy(scsi_sense_isadma_cache);
2020 * scsi_mode_select - issue a mode select
2021 * @sdev: SCSI device to be queried
2022 * @pf: Page format bit (1 == standard, 0 == vendor specific)
2023 * @sp: Save page bit (0 == don't save, 1 == save)
2024 * @modepage: mode page being requested
2025 * @buffer: request buffer (may not be smaller than eight bytes)
2026 * @len: length of request buffer.
2027 * @timeout: command timeout
2028 * @retries: number of retries before failing
2029 * @data: returns a structure abstracting the mode header data
2030 * @sshdr: place to put sense data (or NULL if no sense to be collected).
2031 * must be SCSI_SENSE_BUFFERSIZE big.
2033 * Returns zero if successful; negative error number or scsi
2038 scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2039 unsigned char *buffer, int len, int timeout, int retries,
2040 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2042 unsigned char cmd[10];
2043 unsigned char *real_buffer;
2046 memset(cmd, 0, sizeof(cmd));
2047 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2049 if (sdev->use_10_for_ms) {
2052 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2055 memcpy(real_buffer + 8, buffer, len);
2059 real_buffer[2] = data->medium_type;
2060 real_buffer[3] = data->device_specific;
2061 real_buffer[4] = data->longlba ? 0x01 : 0;
2063 real_buffer[6] = data->block_descriptor_length >> 8;
2064 real_buffer[7] = data->block_descriptor_length;
2066 cmd[0] = MODE_SELECT_10;
2070 if (len > 255 || data->block_descriptor_length > 255 ||
2074 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2077 memcpy(real_buffer + 4, buffer, len);
2080 real_buffer[1] = data->medium_type;
2081 real_buffer[2] = data->device_specific;
2082 real_buffer[3] = data->block_descriptor_length;
2084 cmd[0] = MODE_SELECT;
2088 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
2089 sshdr, timeout, retries, NULL);
2093 EXPORT_SYMBOL_GPL(scsi_mode_select);
2096 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
2097 * @sdev: SCSI device to be queried
2098 * @dbd: set if mode sense will allow block descriptors to be returned
2099 * @modepage: mode page being requested
2100 * @buffer: request buffer (may not be smaller than eight bytes)
2101 * @len: length of request buffer.
2102 * @timeout: command timeout
2103 * @retries: number of retries before failing
2104 * @data: returns a structure abstracting the mode header data
2105 * @sshdr: place to put sense data (or NULL if no sense to be collected).
2106 * must be SCSI_SENSE_BUFFERSIZE big.
2108 * Returns zero if unsuccessful, or the header offset (either 4
2109 * or 8 depending on whether a six or ten byte command was
2110 * issued) if successful.
2113 scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
2114 unsigned char *buffer, int len, int timeout, int retries,
2115 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2117 unsigned char cmd[12];
2120 int result, retry_count = retries;
2121 struct scsi_sense_hdr my_sshdr;
2123 memset(data, 0, sizeof(*data));
2124 memset(&cmd[0], 0, 12);
2126 dbd = sdev->set_dbd_for_ms ? 8 : dbd;
2127 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2130 /* caller might not be interested in sense, but we need it */
2135 use_10_for_ms = sdev->use_10_for_ms;
2137 if (use_10_for_ms) {
2141 cmd[0] = MODE_SENSE_10;
2148 cmd[0] = MODE_SENSE;
2153 memset(buffer, 0, len);
2155 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
2156 sshdr, timeout, retries, NULL);
2158 /* This code looks awful: what it's doing is making sure an
2159 * ILLEGAL REQUEST sense return identifies the actual command
2160 * byte as the problem. MODE_SENSE commands can return
2161 * ILLEGAL REQUEST if the code page isn't supported */
2163 if (use_10_for_ms && !scsi_status_is_good(result) &&
2164 driver_byte(result) == DRIVER_SENSE) {
2165 if (scsi_sense_valid(sshdr)) {
2166 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2167 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
2169 * Invalid command operation code
2171 sdev->use_10_for_ms = 0;
2177 if (scsi_status_is_good(result)) {
2178 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2179 (modepage == 6 || modepage == 8))) {
2180 /* Initio breakage? */
2183 data->medium_type = 0;
2184 data->device_specific = 0;
2186 data->block_descriptor_length = 0;
2187 } else if (use_10_for_ms) {
2188 data->length = buffer[0]*256 + buffer[1] + 2;
2189 data->medium_type = buffer[2];
2190 data->device_specific = buffer[3];
2191 data->longlba = buffer[4] & 0x01;
2192 data->block_descriptor_length = buffer[6]*256
2195 data->length = buffer[0] + 1;
2196 data->medium_type = buffer[1];
2197 data->device_specific = buffer[2];
2198 data->block_descriptor_length = buffer[3];
2200 data->header_length = header_length;
2201 } else if ((status_byte(result) == CHECK_CONDITION) &&
2202 scsi_sense_valid(sshdr) &&
2203 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2210 EXPORT_SYMBOL(scsi_mode_sense);
2213 * scsi_test_unit_ready - test if unit is ready
2214 * @sdev: scsi device to change the state of.
2215 * @timeout: command timeout
2216 * @retries: number of retries before failing
2217 * @sshdr: outpout pointer for decoded sense information.
2219 * Returns zero if unsuccessful or an error if TUR failed. For
2220 * removable media, UNIT_ATTENTION sets ->changed flag.
2223 scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
2224 struct scsi_sense_hdr *sshdr)
2227 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2231 /* try to eat the UNIT_ATTENTION if there are enough retries */
2233 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
2235 if (sdev->removable && scsi_sense_valid(sshdr) &&
2236 sshdr->sense_key == UNIT_ATTENTION)
2238 } while (scsi_sense_valid(sshdr) &&
2239 sshdr->sense_key == UNIT_ATTENTION && --retries);
2243 EXPORT_SYMBOL(scsi_test_unit_ready);
2246 * scsi_device_set_state - Take the given device through the device state model.
2247 * @sdev: scsi device to change the state of.
2248 * @state: state to change to.
2250 * Returns zero if successful or an error if the requested
2251 * transition is illegal.
2254 scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2256 enum scsi_device_state oldstate = sdev->sdev_state;
2258 if (state == oldstate)
2264 case SDEV_CREATED_BLOCK:
2275 case SDEV_TRANSPORT_OFFLINE:
2288 case SDEV_TRANSPORT_OFFLINE:
2296 case SDEV_TRANSPORT_OFFLINE:
2311 case SDEV_CREATED_BLOCK:
2320 case SDEV_CREATED_BLOCK:
2335 case SDEV_TRANSPORT_OFFLINE:
2347 case SDEV_TRANSPORT_OFFLINE:
2350 case SDEV_CREATED_BLOCK:
2358 sdev->offline_already = false;
2359 sdev->sdev_state = state;
2363 SCSI_LOG_ERROR_RECOVERY(1,
2364 sdev_printk(KERN_ERR, sdev,
2365 "Illegal state transition %s->%s",
2366 scsi_device_state_name(oldstate),
2367 scsi_device_state_name(state))
2371 EXPORT_SYMBOL(scsi_device_set_state);
2374 * scsi_evt_emit - emit a single SCSI device uevent
2375 * @sdev: associated SCSI device
2376 * @evt: event to emit
2378 * Send a single uevent (scsi_event) to the associated scsi_device.
2380 static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2385 switch (evt->evt_type) {
2386 case SDEV_EVT_MEDIA_CHANGE:
2387 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2389 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2390 scsi_rescan_device(&sdev->sdev_gendev);
2391 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2393 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2394 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2396 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2397 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2399 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2400 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2402 case SDEV_EVT_LUN_CHANGE_REPORTED:
2403 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2405 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2406 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2408 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2409 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2418 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2422 * scsi_evt_thread - send a uevent for each scsi event
2423 * @work: work struct for scsi_device
2425 * Dispatch queued events to their associated scsi_device kobjects
2428 void scsi_evt_thread(struct work_struct *work)
2430 struct scsi_device *sdev;
2431 enum scsi_device_event evt_type;
2432 LIST_HEAD(event_list);
2434 sdev = container_of(work, struct scsi_device, event_work);
2436 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2437 if (test_and_clear_bit(evt_type, sdev->pending_events))
2438 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2441 struct scsi_event *evt;
2442 struct list_head *this, *tmp;
2443 unsigned long flags;
2445 spin_lock_irqsave(&sdev->list_lock, flags);
2446 list_splice_init(&sdev->event_list, &event_list);
2447 spin_unlock_irqrestore(&sdev->list_lock, flags);
2449 if (list_empty(&event_list))
2452 list_for_each_safe(this, tmp, &event_list) {
2453 evt = list_entry(this, struct scsi_event, node);
2454 list_del(&evt->node);
2455 scsi_evt_emit(sdev, evt);
2462 * sdev_evt_send - send asserted event to uevent thread
2463 * @sdev: scsi_device event occurred on
2464 * @evt: event to send
2466 * Assert scsi device event asynchronously.
2468 void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2470 unsigned long flags;
2473 /* FIXME: currently this check eliminates all media change events
2474 * for polled devices. Need to update to discriminate between AN
2475 * and polled events */
2476 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2482 spin_lock_irqsave(&sdev->list_lock, flags);
2483 list_add_tail(&evt->node, &sdev->event_list);
2484 schedule_work(&sdev->event_work);
2485 spin_unlock_irqrestore(&sdev->list_lock, flags);
2487 EXPORT_SYMBOL_GPL(sdev_evt_send);
2490 * sdev_evt_alloc - allocate a new scsi event
2491 * @evt_type: type of event to allocate
2492 * @gfpflags: GFP flags for allocation
2494 * Allocates and returns a new scsi_event.
2496 struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2499 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2503 evt->evt_type = evt_type;
2504 INIT_LIST_HEAD(&evt->node);
2506 /* evt_type-specific initialization, if any */
2508 case SDEV_EVT_MEDIA_CHANGE:
2509 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2510 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2511 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2512 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2513 case SDEV_EVT_LUN_CHANGE_REPORTED:
2514 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2515 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2523 EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2526 * sdev_evt_send_simple - send asserted event to uevent thread
2527 * @sdev: scsi_device event occurred on
2528 * @evt_type: type of event to send
2529 * @gfpflags: GFP flags for allocation
2531 * Assert scsi device event asynchronously, given an event type.
2533 void sdev_evt_send_simple(struct scsi_device *sdev,
2534 enum scsi_device_event evt_type, gfp_t gfpflags)
2536 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2538 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2543 sdev_evt_send(sdev, evt);
2545 EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2548 * scsi_device_quiesce - Block all commands except power management.
2549 * @sdev: scsi device to quiesce.
2551 * This works by trying to transition to the SDEV_QUIESCE state
2552 * (which must be a legal transition). When the device is in this
2553 * state, only power management requests will be accepted, all others will
2556 * Must be called with user context, may sleep.
2558 * Returns zero if unsuccessful or an error if not.
2561 scsi_device_quiesce(struct scsi_device *sdev)
2563 struct request_queue *q = sdev->request_queue;
2567 * It is allowed to call scsi_device_quiesce() multiple times from
2568 * the same context but concurrent scsi_device_quiesce() calls are
2571 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2573 if (sdev->quiesced_by == current)
2578 blk_mq_freeze_queue(q);
2580 * Ensure that the effect of blk_set_pm_only() will be visible
2581 * for percpu_ref_tryget() callers that occur after the queue
2582 * unfreeze even if the queue was already frozen before this function
2583 * was called. See also https://lwn.net/Articles/573497/.
2586 blk_mq_unfreeze_queue(q);
2588 mutex_lock(&sdev->state_mutex);
2589 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2591 sdev->quiesced_by = current;
2593 blk_clear_pm_only(q);
2594 mutex_unlock(&sdev->state_mutex);
2598 EXPORT_SYMBOL(scsi_device_quiesce);
2601 * scsi_device_resume - Restart user issued commands to a quiesced device.
2602 * @sdev: scsi device to resume.
2604 * Moves the device from quiesced back to running and restarts the
2607 * Must be called with user context, may sleep.
2609 void scsi_device_resume(struct scsi_device *sdev)
2611 /* check if the device state was mutated prior to resume, and if
2612 * so assume the state is being managed elsewhere (for example
2613 * device deleted during suspend)
2615 mutex_lock(&sdev->state_mutex);
2616 if (sdev->sdev_state == SDEV_QUIESCE)
2617 scsi_device_set_state(sdev, SDEV_RUNNING);
2618 if (sdev->quiesced_by) {
2619 sdev->quiesced_by = NULL;
2620 blk_clear_pm_only(sdev->request_queue);
2622 mutex_unlock(&sdev->state_mutex);
2624 EXPORT_SYMBOL(scsi_device_resume);
2627 device_quiesce_fn(struct scsi_device *sdev, void *data)
2629 scsi_device_quiesce(sdev);
2633 scsi_target_quiesce(struct scsi_target *starget)
2635 starget_for_each_device(starget, NULL, device_quiesce_fn);
2637 EXPORT_SYMBOL(scsi_target_quiesce);
2640 device_resume_fn(struct scsi_device *sdev, void *data)
2642 scsi_device_resume(sdev);
2646 scsi_target_resume(struct scsi_target *starget)
2648 starget_for_each_device(starget, NULL, device_resume_fn);
2650 EXPORT_SYMBOL(scsi_target_resume);
2653 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2654 * @sdev: device to block
2656 * Pause SCSI command processing on the specified device. Does not sleep.
2658 * Returns zero if successful or a negative error code upon failure.
2661 * This routine transitions the device to the SDEV_BLOCK state (which must be
2662 * a legal transition). When the device is in this state, command processing
2663 * is paused until the device leaves the SDEV_BLOCK state. See also
2664 * scsi_internal_device_unblock_nowait().
2666 int scsi_internal_device_block_nowait(struct scsi_device *sdev)
2668 struct request_queue *q = sdev->request_queue;
2671 err = scsi_device_set_state(sdev, SDEV_BLOCK);
2673 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2680 * The device has transitioned to SDEV_BLOCK. Stop the
2681 * block layer from calling the midlayer with this device's
2684 blk_mq_quiesce_queue_nowait(q);
2687 EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2690 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2691 * @sdev: device to block
2693 * Pause SCSI command processing on the specified device and wait until all
2694 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
2696 * Returns zero if successful or a negative error code upon failure.
2699 * This routine transitions the device to the SDEV_BLOCK state (which must be
2700 * a legal transition). When the device is in this state, command processing
2701 * is paused until the device leaves the SDEV_BLOCK state. See also
2702 * scsi_internal_device_unblock().
2704 static int scsi_internal_device_block(struct scsi_device *sdev)
2706 struct request_queue *q = sdev->request_queue;
2709 mutex_lock(&sdev->state_mutex);
2710 err = scsi_internal_device_block_nowait(sdev);
2712 blk_mq_quiesce_queue(q);
2713 mutex_unlock(&sdev->state_mutex);
2718 void scsi_start_queue(struct scsi_device *sdev)
2720 struct request_queue *q = sdev->request_queue;
2722 blk_mq_unquiesce_queue(q);
2726 * scsi_internal_device_unblock_nowait - resume a device after a block request
2727 * @sdev: device to resume
2728 * @new_state: state to set the device to after unblocking
2730 * Restart the device queue for a previously suspended SCSI device. Does not
2733 * Returns zero if successful or a negative error code upon failure.
2736 * This routine transitions the device to the SDEV_RUNNING state or to one of
2737 * the offline states (which must be a legal transition) allowing the midlayer
2738 * to goose the queue for this device.
2740 int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2741 enum scsi_device_state new_state)
2743 switch (new_state) {
2745 case SDEV_TRANSPORT_OFFLINE:
2752 * Try to transition the scsi device to SDEV_RUNNING or one of the
2753 * offlined states and goose the device queue if successful.
2755 switch (sdev->sdev_state) {
2757 case SDEV_TRANSPORT_OFFLINE:
2758 sdev->sdev_state = new_state;
2760 case SDEV_CREATED_BLOCK:
2761 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2762 new_state == SDEV_OFFLINE)
2763 sdev->sdev_state = new_state;
2765 sdev->sdev_state = SDEV_CREATED;
2773 scsi_start_queue(sdev);
2777 EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2780 * scsi_internal_device_unblock - resume a device after a block request
2781 * @sdev: device to resume
2782 * @new_state: state to set the device to after unblocking
2784 * Restart the device queue for a previously suspended SCSI device. May sleep.
2786 * Returns zero if successful or a negative error code upon failure.
2789 * This routine transitions the device to the SDEV_RUNNING state or to one of
2790 * the offline states (which must be a legal transition) allowing the midlayer
2791 * to goose the queue for this device.
2793 static int scsi_internal_device_unblock(struct scsi_device *sdev,
2794 enum scsi_device_state new_state)
2798 mutex_lock(&sdev->state_mutex);
2799 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2800 mutex_unlock(&sdev->state_mutex);
2806 device_block(struct scsi_device *sdev, void *data)
2810 ret = scsi_internal_device_block(sdev);
2812 WARN_ONCE(ret, "scsi_internal_device_block(%s) failed: ret = %d\n",
2813 dev_name(&sdev->sdev_gendev), ret);
2817 target_block(struct device *dev, void *data)
2819 if (scsi_is_target_device(dev))
2820 starget_for_each_device(to_scsi_target(dev), NULL,
2826 scsi_target_block(struct device *dev)
2828 if (scsi_is_target_device(dev))
2829 starget_for_each_device(to_scsi_target(dev), NULL,
2832 device_for_each_child(dev, NULL, target_block);
2834 EXPORT_SYMBOL_GPL(scsi_target_block);
2837 device_unblock(struct scsi_device *sdev, void *data)
2839 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
2843 target_unblock(struct device *dev, void *data)
2845 if (scsi_is_target_device(dev))
2846 starget_for_each_device(to_scsi_target(dev), data,
2852 scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
2854 if (scsi_is_target_device(dev))
2855 starget_for_each_device(to_scsi_target(dev), &new_state,
2858 device_for_each_child(dev, &new_state, target_unblock);
2860 EXPORT_SYMBOL_GPL(scsi_target_unblock);
2863 scsi_host_block(struct Scsi_Host *shost)
2865 struct scsi_device *sdev;
2869 * Call scsi_internal_device_block_nowait so we can avoid
2870 * calling synchronize_rcu() for each LUN.
2872 shost_for_each_device(sdev, shost) {
2873 mutex_lock(&sdev->state_mutex);
2874 ret = scsi_internal_device_block_nowait(sdev);
2875 mutex_unlock(&sdev->state_mutex);
2877 scsi_device_put(sdev);
2883 * SCSI never enables blk-mq's BLK_MQ_F_BLOCKING flag so
2884 * calling synchronize_rcu() once is enough.
2886 WARN_ON_ONCE(shost->tag_set.flags & BLK_MQ_F_BLOCKING);
2893 EXPORT_SYMBOL_GPL(scsi_host_block);
2896 scsi_host_unblock(struct Scsi_Host *shost, int new_state)
2898 struct scsi_device *sdev;
2901 shost_for_each_device(sdev, shost) {
2902 ret = scsi_internal_device_unblock(sdev, new_state);
2904 scsi_device_put(sdev);
2910 EXPORT_SYMBOL_GPL(scsi_host_unblock);
2913 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
2914 * @sgl: scatter-gather list
2915 * @sg_count: number of segments in sg
2916 * @offset: offset in bytes into sg, on return offset into the mapped area
2917 * @len: bytes to map, on return number of bytes mapped
2919 * Returns virtual address of the start of the mapped page
2921 void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
2922 size_t *offset, size_t *len)
2925 size_t sg_len = 0, len_complete = 0;
2926 struct scatterlist *sg;
2929 WARN_ON(!irqs_disabled());
2931 for_each_sg(sgl, sg, sg_count, i) {
2932 len_complete = sg_len; /* Complete sg-entries */
2933 sg_len += sg->length;
2934 if (sg_len > *offset)
2938 if (unlikely(i == sg_count)) {
2939 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2941 __func__, sg_len, *offset, sg_count);
2946 /* Offset starting from the beginning of first page in this sg-entry */
2947 *offset = *offset - len_complete + sg->offset;
2949 /* Assumption: contiguous pages can be accessed as "page + i" */
2950 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
2951 *offset &= ~PAGE_MASK;
2953 /* Bytes in this sg-entry from *offset to the end of the page */
2954 sg_len = PAGE_SIZE - *offset;
2958 return kmap_atomic(page);
2960 EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2963 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
2964 * @virt: virtual address to be unmapped
2966 void scsi_kunmap_atomic_sg(void *virt)
2968 kunmap_atomic(virt);
2970 EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
2972 void sdev_disable_disk_events(struct scsi_device *sdev)
2974 atomic_inc(&sdev->disk_events_disable_depth);
2976 EXPORT_SYMBOL(sdev_disable_disk_events);
2978 void sdev_enable_disk_events(struct scsi_device *sdev)
2980 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2982 atomic_dec(&sdev->disk_events_disable_depth);
2984 EXPORT_SYMBOL(sdev_enable_disk_events);
2986 static unsigned char designator_prio(const unsigned char *d)
2989 /* not associated with LUN */
2993 /* invalid length */
2997 * Order of preference for lun descriptor:
2998 * - SCSI name string
2999 * - NAA IEEE Registered Extended
3000 * - EUI-64 based 16-byte
3001 * - EUI-64 based 12-byte
3002 * - NAA IEEE Registered
3003 * - NAA IEEE Extended
3004 * - EUI-64 based 8-byte
3005 * - SCSI name string (truncated)
3007 * as longer descriptors reduce the likelyhood
3008 * of identification clashes.
3011 switch (d[1] & 0xf) {
3013 /* SCSI name string, variable-length UTF-8 */
3016 switch (d[4] >> 4) {
3018 /* NAA registered extended */
3021 /* NAA registered */
3027 /* NAA locally assigned */
3036 /* EUI64-based, 16 byte */
3039 /* EUI64-based, 12 byte */
3042 /* EUI64-based, 8 byte */
3059 * scsi_vpd_lun_id - return a unique device identification
3060 * @sdev: SCSI device
3061 * @id: buffer for the identification
3062 * @id_len: length of the buffer
3064 * Copies a unique device identification into @id based
3065 * on the information in the VPD page 0x83 of the device.
3066 * The string will be formatted as a SCSI name string.
3068 * Returns the length of the identification or error on failure.
3069 * If the identifier is longer than the supplied buffer the actual
3070 * identifier length is returned and the buffer is not zero-padded.
3072 int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
3076 const unsigned char *d, *cur_id_str;
3077 const struct scsi_vpd *vpd_pg83;
3078 int id_size = -EINVAL;
3081 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3087 /* The id string must be at least 20 bytes + terminating NULL byte */
3093 memset(id, 0, id_len);
3094 for (d = vpd_pg83->data + 4;
3095 d < vpd_pg83->data + vpd_pg83->len;
3097 u8 prio = designator_prio(d);
3099 if (prio == 0 || cur_id_prio > prio)
3102 switch (d[1] & 0xf) {
3105 if (cur_id_size > d[3])
3109 if (cur_id_size + 4 > id_len)
3110 cur_id_size = id_len - 4;
3112 id_size = snprintf(id, id_len, "t10.%*pE",
3113 cur_id_size, cur_id_str);
3120 switch (cur_id_size) {
3122 id_size = snprintf(id, id_len,
3127 id_size = snprintf(id, id_len,
3132 id_size = snprintf(id, id_len,
3145 switch (cur_id_size) {
3147 id_size = snprintf(id, id_len,
3152 id_size = snprintf(id, id_len,
3161 /* SCSI name string */
3162 if (cur_id_size > d[3])
3164 /* Prefer others for truncated descriptor */
3165 if (d[3] > id_len) {
3167 if (cur_id_prio > prio)
3171 cur_id_size = id_size = d[3];
3173 if (cur_id_size >= id_len)
3174 cur_id_size = id_len - 1;
3175 memcpy(id, cur_id_str, cur_id_size);
3185 EXPORT_SYMBOL(scsi_vpd_lun_id);
3188 * scsi_vpd_tpg_id - return a target port group identifier
3189 * @sdev: SCSI device
3191 * Returns the Target Port Group identifier from the information
3192 * froom VPD page 0x83 of the device.
3194 * Returns the identifier or error on failure.
3196 int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3198 const unsigned char *d;
3199 const struct scsi_vpd *vpd_pg83;
3200 int group_id = -EAGAIN, rel_port = -1;
3203 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3209 d = vpd_pg83->data + 4;
3210 while (d < vpd_pg83->data + vpd_pg83->len) {
3211 switch (d[1] & 0xf) {
3213 /* Relative target port */
3214 rel_port = get_unaligned_be16(&d[6]);
3217 /* Target port group */
3218 group_id = get_unaligned_be16(&d[6]);
3227 if (group_id >= 0 && rel_id && rel_port != -1)
3232 EXPORT_SYMBOL(scsi_vpd_tpg_id);