blob: 06056e9ec3335bdead7ea49cbd749b24941e2e72 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Christoph Hellwigd2852032014-01-17 12:06:53 +01003 * Copyright (C) 1999 Eric Youngdale
4 * Copyright (C) 2014 Christoph Hellwig
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
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.
10 */
11
12#include <linux/bio.h>
James Bottomleyd3f46f32008-01-15 11:11:46 -060013#include <linux/bitops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/blkdev.h>
15#include <linux/completion.h>
16#include <linux/kernel.h>
Paul Gortmaker09703662011-05-27 09:37:25 -040017#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/init.h>
19#include <linux/pci.h>
20#include <linux/delay.h>
James Bottomleyfaead262006-02-14 10:42:07 -060021#include <linux/hardirq.h>
Jens Axboec6132da2007-10-16 11:08:49 +020022#include <linux/scatterlist.h>
Christoph Hellwigd2852032014-01-17 12:06:53 +010023#include <linux/blk-mq.h>
Hannes Reineckef1569ff2014-10-24 14:27:07 +020024#include <linux/ratelimit.h>
Hannes Reineckea8aa3972015-12-01 10:16:57 +010025#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020028#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#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>
Bart Van Assche7aa686d2017-05-02 10:45:03 -070034#include <scsi/scsi_transport.h> /* __scsi_init_queue() */
Christoph Hellwigee14c672015-08-27 14:16:59 +020035#include <scsi/scsi_dh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Christoph Hellwig3b5382c2014-05-06 12:25:40 +020037#include <trace/events/scsi.h>
38
Bart Van Assche0eebd002017-04-26 13:47:57 -070039#include "scsi_debugfs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include "scsi_priv.h"
41#include "scsi_logging.h"
42
Ming Lei92524fa2019-04-28 15:39:31 +080043/*
44 * Size of integrity metadata is usually small, 1 inline sg should
45 * cover normal cases.
46 */
Ming Lei3e99b3b2019-06-06 16:34:09 +080047#ifdef CONFIG_ARCH_NO_SG_CHAIN
48#define SCSI_INLINE_PROT_SG_CNT 0
49#define SCSI_INLINE_SG_CNT 0
50#else
Ming Lei92524fa2019-04-28 15:39:31 +080051#define SCSI_INLINE_PROT_SG_CNT 1
Ming Lei3dccdf52019-04-28 15:39:32 +080052#define SCSI_INLINE_SG_CNT 2
Ming Lei3e99b3b2019-06-06 16:34:09 +080053#endif
Ming Lei3dccdf52019-04-28 15:39:32 +080054
Christoph Hellwige9c787e2017-01-02 21:55:26 +030055static struct kmem_cache *scsi_sdb_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030056static struct kmem_cache *scsi_sense_cache;
57static struct kmem_cache *scsi_sense_isadma_cache;
58static DEFINE_MUTEX(scsi_sense_cache_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Bart Van Asschea45a1f362017-08-30 16:58:42 -070060static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd);
61
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030062static inline struct kmem_cache *
Bart Van Assche8e688252017-06-02 14:21:52 -070063scsi_select_sense_cache(bool unchecked_isa_dma)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030064{
Bart Van Assche8e688252017-06-02 14:21:52 -070065 return unchecked_isa_dma ? scsi_sense_isadma_cache : scsi_sense_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030066}
67
Bart Van Assche8e688252017-06-02 14:21:52 -070068static void scsi_free_sense_buffer(bool unchecked_isa_dma,
69 unsigned char *sense_buffer)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030070{
Bart Van Assche8e688252017-06-02 14:21:52 -070071 kmem_cache_free(scsi_select_sense_cache(unchecked_isa_dma),
72 sense_buffer);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030073}
74
Bart Van Assche8e688252017-06-02 14:21:52 -070075static unsigned char *scsi_alloc_sense_buffer(bool unchecked_isa_dma,
Christoph Hellwige9c787e2017-01-02 21:55:26 +030076 gfp_t gfp_mask, int numa_node)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030077{
Bart Van Assche8e688252017-06-02 14:21:52 -070078 return kmem_cache_alloc_node(scsi_select_sense_cache(unchecked_isa_dma),
79 gfp_mask, numa_node);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030080}
81
82int scsi_init_sense_cache(struct Scsi_Host *shost)
83{
84 struct kmem_cache *cache;
85 int ret = 0;
86
Ming Leif9b05302019-07-12 10:08:19 +080087 mutex_lock(&scsi_sense_cache_mutex);
Bart Van Assche8e688252017-06-02 14:21:52 -070088 cache = scsi_select_sense_cache(shost->unchecked_isa_dma);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030089 if (cache)
Ming Leif9b05302019-07-12 10:08:19 +080090 goto exit;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030091
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030092 if (shost->unchecked_isa_dma) {
93 scsi_sense_isadma_cache =
94 kmem_cache_create("scsi_sense_cache(DMA)",
David Windsor0afe76e2017-06-10 22:50:45 -040095 SCSI_SENSE_BUFFERSIZE, 0,
96 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030097 if (!scsi_sense_isadma_cache)
98 ret = -ENOMEM;
99 } else {
100 scsi_sense_cache =
David Windsor0afe76e2017-06-10 22:50:45 -0400101 kmem_cache_create_usercopy("scsi_sense_cache",
102 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN,
103 0, SCSI_SENSE_BUFFERSIZE, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +0300104 if (!scsi_sense_cache)
105 ret = -ENOMEM;
106 }
Ming Leif9b05302019-07-12 10:08:19 +0800107 exit:
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +0300108 mutex_unlock(&scsi_sense_cache_mutex);
109 return ret;
110}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200111
Jens Axboea488e742010-04-16 21:13:15 +0200112/*
113 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
114 * not change behaviour from the previous unplug mechanism, experimentation
115 * may prove this needs changing.
116 */
117#define SCSI_QUEUE_DELAY 3
118
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100119static void
120scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121{
122 struct Scsi_Host *host = cmd->device->host;
123 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500124 struct scsi_target *starget = scsi_target(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900127 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 *
129 * If the host/device isn't busy, assume that something actually
130 * completed, and that we should be able to queue a command now.
131 *
132 * Note that the prior mid-layer assumption that any host could
133 * always queue at least one command is now broken. The mid-layer
134 * will implement a user specifiable stall (see
135 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
136 * if a command is requeued with no other commands outstanding
137 * either for the device or for the host.
138 */
Mike Christief0c0a372008-08-17 15:24:38 -0500139 switch (reason) {
140 case SCSI_MLQUEUE_HOST_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100141 atomic_set(&host->host_blocked, host->max_host_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500142 break;
143 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400144 case SCSI_MLQUEUE_EH_RETRY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100145 atomic_set(&device->device_blocked,
146 device->max_device_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500147 break;
148 case SCSI_MLQUEUE_TARGET_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100149 atomic_set(&starget->target_blocked,
150 starget->max_target_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500151 break;
152 }
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100153}
154
Christoph Hellwigd2852032014-01-17 12:06:53 +0100155static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
156{
Bart Van Asschea45a1f362017-08-30 16:58:42 -0700157 if (cmd->request->rq_flags & RQF_DONTPREP) {
158 cmd->request->rq_flags &= ~RQF_DONTPREP;
159 scsi_mq_uninit_cmd(cmd);
160 } else {
161 WARN_ON_ONCE(true);
162 }
Bart Van Assche2b053ac2016-10-28 17:21:41 -0700163 blk_mq_requeue_request(cmd->request, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100164}
165
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100166/**
167 * __scsi_queue_insert - private queue insertion
168 * @cmd: The SCSI command being requeued
169 * @reason: The reason for the requeue
170 * @unbusy: Whether the queue should be unbusied
171 *
172 * This is a private queue insertion. The public interface
173 * scsi_queue_insert() always assumes the queue should be unbusied
174 * because it's always called before the completion. This function is
175 * for a requeue after completion, which should only occur in this
176 * file.
177 */
Bart Van Assche08640e82018-01-10 14:41:45 -0800178static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, bool unbusy)
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100179{
180 struct scsi_device *device = cmd->device;
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100181
182 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
183 "Inserting command %p into mlqueue\n", cmd));
184
185 scsi_set_blocked(cmd, reason);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 * Decrement the counters, since these commands are no longer
189 * active on the host/device.
190 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600191 if (unbusy)
Ming Lei6eb045e2019-10-25 14:58:55 +0800192 scsi_device_unbusy(device, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500195 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000196 * that are already in the queue. Schedule requeue work under
197 * lock such that the kblockd_schedule_work() call happens
198 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200199 */
Alan Stern644373a2014-03-28 10:51:15 -0700200 cmd->result = 0;
Jens Axboef664a3c2018-11-01 16:36:27 -0600201
Jens Axboef664a3c2018-11-01 16:36:27 -0600202 blk_mq_requeue_request(cmd->request, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203}
204
André Almeidaea941012020-04-19 02:01:48 -0300205/**
206 * scsi_queue_insert - Reinsert a command in the queue.
207 * @cmd: command that we are adding to queue.
208 * @reason: why we are inserting command to queue.
James Bottomley4f5299a2009-01-02 10:42:21 -0600209 *
André Almeidaea941012020-04-19 02:01:48 -0300210 * We do this for one of two cases. Either the host is busy and it cannot accept
211 * any more commands for the time being, or the device returned QUEUE_FULL and
212 * can accept no more commands.
James Bottomley4f5299a2009-01-02 10:42:21 -0600213 *
André Almeidaea941012020-04-19 02:01:48 -0300214 * Context: This could be called either from an interrupt context or a normal
215 * process context.
James Bottomley4f5299a2009-01-02 10:42:21 -0600216 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000217void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600218{
Bart Van Assche08640e82018-01-10 14:41:45 -0800219 __scsi_queue_insert(cmd, reason, true);
James Bottomley4f5299a2009-01-02 10:42:21 -0600220}
Christoph Hellwige8064022016-10-20 15:12:13 +0200221
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100222
223/**
Kees Cook704f8392018-07-31 12:51:54 -0700224 * __scsi_execute - insert request and wait for the result
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100225 * @sdev: scsi device
226 * @cmd: scsi command
227 * @data_direction: data direction
228 * @buffer: data buffer
229 * @bufflen: len of buffer
230 * @sense: optional sense buffer
231 * @sshdr: optional decoded sense header
232 * @timeout: request timeout in seconds
233 * @retries: number of times to retry request
234 * @flags: flags for ->cmd_flags
235 * @rq_flags: flags for ->rq_flags
236 * @resid: optional residual length
237 *
Christoph Hellwig17d53632017-04-20 16:03:01 +0200238 * Returns the scsi_cmnd result field if a command was executed, or a negative
239 * Linux error code if we didn't get that far.
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100240 */
Kees Cook704f8392018-07-31 12:51:54 -0700241int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500242 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100243 unsigned char *sense, struct scsi_sense_hdr *sshdr,
244 int timeout, int retries, u64 flags, req_flags_t rq_flags,
245 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500246{
247 struct request *req;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100248 struct scsi_request *rq;
James Bottomley39216032005-06-15 18:48:29 -0500249 int ret = DRIVER_ERROR << 24;
250
Christoph Hellwigff005a02018-05-09 09:54:05 +0200251 req = blk_get_request(sdev->request_queue,
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100252 data_direction == DMA_TO_DEVICE ?
Bart Van Assche039c6352017-11-09 10:49:56 -0800253 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, BLK_MQ_REQ_PREEMPT);
Joe Lawrencea492f072014-08-28 08:15:21 -0600254 if (IS_ERR(req))
James Bottomleybfe159a2011-07-07 15:45:40 -0500255 return ret;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100256 rq = scsi_req(req);
James Bottomley39216032005-06-15 18:48:29 -0500257
258 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
Christoph Hellwig0eb0b632018-05-09 09:54:08 +0200259 buffer, bufflen, GFP_NOIO))
James Bottomley39216032005-06-15 18:48:29 -0500260 goto out;
261
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100262 rq->cmd_len = COMMAND_SIZE(cmd[0]);
263 memcpy(rq->cmd, cmd, rq->cmd_len);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200264 rq->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500265 req->timeout = timeout;
Christoph Hellwige8064022016-10-20 15:12:13 +0200266 req->cmd_flags |= flags;
Bart Van Assche039c6352017-11-09 10:49:56 -0800267 req->rq_flags |= rq_flags | RQF_QUIET;
James Bottomley39216032005-06-15 18:48:29 -0500268
269 /*
270 * head injection *required* here otherwise quiesce won't work
271 */
272 blk_execute_rq(req->q, NULL, req, 1);
273
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400274 /*
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.
279 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100280 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
281 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400282
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900283 if (resid)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100284 *resid = rq->resid_len;
285 if (sense && rq->sense_len)
286 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100287 if (sshdr)
288 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
Christoph Hellwig17d53632017-04-20 16:03:01 +0200289 ret = rq->result;
James Bottomley39216032005-06-15 18:48:29 -0500290 out:
291 blk_put_request(req);
292
293 return ret;
294}
Kees Cook704f8392018-07-31 12:51:54 -0700295EXPORT_SYMBOL(__scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500296
André Almeidaea941012020-04-19 02:01:48 -0300297/**
298 * scsi_init_cmd_errh - Initialize cmd fields related to error handling.
299 * @cmd: command that is ready to be queued.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 *
André Almeidaea941012020-04-19 02:01:48 -0300301 * This function has the job of initializing a number of fields related to error
302 * handling. Typically this will be called once for each command, as required.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200304static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200306 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900307 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300309 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310}
311
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800312/*
Ming Lei6eb045e2019-10-25 14:58:55 +0800313 * Wake up the error handler if necessary. Avoid as follows that the error
314 * handler is not woken up if host in-flight requests number ==
315 * shost->host_failed: use call_rcu() in scsi_eh_scmd_add() in combination
316 * with an RCU read lock in this function to ensure that this function in
317 * its entirety either finishes before scsi_eh_scmd_add() increases the
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800318 * host_failed counter or that it notices the shost state change made by
319 * scsi_eh_scmd_add().
320 */
Ming Lei6eb045e2019-10-25 14:58:55 +0800321static void scsi_dec_host_busy(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800322{
323 unsigned long flags;
324
325 rcu_read_lock();
Ming Lei6eb045e2019-10-25 14:58:55 +0800326 __clear_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800327 if (unlikely(scsi_host_in_recovery(shost))) {
328 spin_lock_irqsave(shost->host_lock, flags);
329 if (shost->host_failed || shost->host_eh_scheduled)
330 scsi_eh_wakeup(shost);
331 spin_unlock_irqrestore(shost->host_lock, flags);
332 }
333 rcu_read_unlock();
334}
335
Ming Lei6eb045e2019-10-25 14:58:55 +0800336void scsi_device_unbusy(struct scsi_device *sdev, struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337{
338 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500339 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
Ming Lei6eb045e2019-10-25 14:58:55 +0800341 scsi_dec_host_busy(shost, cmd);
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800342
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100343 if (starget->can_queue > 0)
344 atomic_dec(&starget->target_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +0100345
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200346 atomic_dec(&sdev->device_busy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347}
348
Christoph Hellwigd2852032014-01-17 12:06:53 +0100349static void scsi_kick_queue(struct request_queue *q)
350{
Jens Axboef664a3c2018-11-01 16:36:27 -0600351 blk_mq_run_hw_queues(q, false);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100352}
353
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354/*
355 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
356 * and call blk_run_queue for all the scsi_devices on the target -
357 * including current_sdev first.
358 *
359 * Called with *no* scsi locks held.
360 */
361static void scsi_single_lun_run(struct scsi_device *current_sdev)
362{
363 struct Scsi_Host *shost = current_sdev->host;
364 struct scsi_device *sdev, *tmp;
365 struct scsi_target *starget = scsi_target(current_sdev);
366 unsigned long flags;
367
368 spin_lock_irqsave(shost->host_lock, flags);
369 starget->starget_sdev_user = NULL;
370 spin_unlock_irqrestore(shost->host_lock, flags);
371
372 /*
373 * Call blk_run_queue for all LUNs on the target, starting with
374 * current_sdev. We race with others (to set starget_sdev_user),
375 * but in most cases, we will be first. Ideally, each LU on the
376 * target would get some limited time or requests on the target.
377 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100378 scsi_kick_queue(current_sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380 spin_lock_irqsave(shost->host_lock, flags);
381 if (starget->starget_sdev_user)
382 goto out;
383 list_for_each_entry_safe(sdev, tmp, &starget->devices,
384 same_target_siblings) {
385 if (sdev == current_sdev)
386 continue;
387 if (scsi_device_get(sdev))
388 continue;
389
390 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100391 scsi_kick_queue(sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 spin_lock_irqsave(shost->host_lock, flags);
393
394 scsi_device_put(sdev);
395 }
396 out:
397 spin_unlock_irqrestore(shost->host_lock, flags);
398}
399
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100400static inline bool scsi_device_is_busy(struct scsi_device *sdev)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400401{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100402 if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
403 return true;
404 if (atomic_read(&sdev->device_blocked) > 0)
405 return true;
406 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400407}
408
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100409static inline bool scsi_target_is_busy(struct scsi_target *starget)
Mike Christief0c0a372008-08-17 15:24:38 -0500410{
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100411 if (starget->can_queue > 0) {
412 if (atomic_read(&starget->target_busy) >= starget->can_queue)
413 return true;
414 if (atomic_read(&starget->target_blocked) > 0)
415 return true;
416 }
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100417 return false;
Mike Christief0c0a372008-08-17 15:24:38 -0500418}
419
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100420static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400421{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100422 if (atomic_read(&shost->host_blocked) > 0)
423 return true;
424 if (shost->host_self_blocked)
425 return true;
426 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400427}
428
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800429static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600431 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800432 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 unsigned long flags;
434
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600436 list_splice_init(&shost->starved_list, &starved_list);
437
438 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200439 struct request_queue *slq;
440
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 /*
442 * As long as shost is accepting commands and we have
443 * starved queues, call blk_run_queue. scsi_request_fn
444 * drops the queue_lock and can add us back to the
445 * starved_list.
446 *
447 * host_lock protects the starved_list and starved_entry.
448 * scsi_request_fn must get the host_lock before checking
449 * or modifying starved_list or starved_entry.
450 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600451 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500452 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500453
Mike Christie2a3a59e2008-11-11 13:42:35 -0600454 sdev = list_entry(starved_list.next,
455 struct scsi_device, starved_entry);
456 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500457 if (scsi_target_is_busy(scsi_target(sdev))) {
458 list_move_tail(&sdev->starved_entry,
459 &shost->starved_list);
460 continue;
461 }
462
James Bottomleye2eb7242013-07-02 15:05:26 +0200463 /*
464 * Once we drop the host lock, a racing scsi_remove_device()
465 * call may remove the sdev from the starved list and destroy
466 * it and the queue. Mitigate by taking a reference to the
467 * queue and never touching the sdev again after we drop the
468 * host lock. Note: if __scsi_remove_device() invokes
469 * blk_cleanup_queue() before the queue is run from this
470 * function then blk_run_queue() will return immediately since
471 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
472 */
473 slq = sdev->request_queue;
474 if (!blk_get_queue(slq))
475 continue;
476 spin_unlock_irqrestore(shost->host_lock, flags);
477
Christoph Hellwigd2852032014-01-17 12:06:53 +0100478 scsi_kick_queue(slq);
James Bottomleye2eb7242013-07-02 15:05:26 +0200479 blk_put_queue(slq);
480
481 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600483 /* put any unprocessed entries back */
484 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800486}
487
André Almeidaea941012020-04-19 02:01:48 -0300488/**
489 * scsi_run_queue - Select a proper request queue to serve next.
490 * @q: last request's queue
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800491 *
André Almeidaea941012020-04-19 02:01:48 -0300492 * The previous command was completely finished, start a new one if possible.
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800493 */
494static void scsi_run_queue(struct request_queue *q)
495{
496 struct scsi_device *sdev = q->queuedata;
497
498 if (scsi_target(sdev)->single_lun)
499 scsi_single_lun_run(sdev);
500 if (!list_empty(&sdev->host->starved_list))
501 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Jens Axboef664a3c2018-11-01 16:36:27 -0600503 blk_mq_run_hw_queues(q, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504}
505
Jens Axboe9937a5e2011-05-17 11:04:44 +0200506void 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516void scsi_run_host_queues(struct Scsi_Host *shost)
517{
518 struct scsi_device *sdev;
519
520 shost_for_each_device(sdev, shost)
521 scsi_run_queue(sdev->request_queue);
522}
523
Christoph Hellwigd2852032014-01-17 12:06:53 +0100524static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
525{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100526 if (!blk_rq_is_passthrough(cmd->request)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100527 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
528
529 if (drv->uninit_command)
530 drv->uninit_command(cmd);
531 }
532}
533
Johannes Thumshirn20a66f22020-04-28 19:45:55 +0900534static void scsi_free_sgtables(struct scsi_cmnd *cmd)
Christoph Hellwigd2852032014-01-17 12:06:53 +0100535{
536 if (cmd->sdb.table.nents)
Ming Lei3dccdf52019-04-28 15:39:32 +0800537 sg_free_table_chained(&cmd->sdb.table,
538 SCSI_INLINE_SG_CNT);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100539 if (scsi_prot_sg_count(cmd))
Ming Lei92524fa2019-04-28 15:39:31 +0800540 sg_free_table_chained(&cmd->prot_sdb->table,
541 SCSI_INLINE_PROT_SG_CNT);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100542}
543
544static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
545{
Johannes Thumshirn20a66f22020-04-28 19:45:55 +0900546 scsi_free_sgtables(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100547 scsi_uninit_cmd(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100548}
549
Ming Lei3f0dcfb2020-07-20 10:54:35 +0800550static void scsi_run_queue_async(struct scsi_device *sdev)
551{
552 if (scsi_target(sdev)->single_lun ||
553 !list_empty(&sdev->host->starved_list))
554 kblockd_schedule_work(&sdev->requeue_work);
555 else
556 blk_mq_run_hw_queues(sdev->request_queue, true);
557}
558
Douglas Gilbert7e63b5a2018-06-23 12:22:14 +0200559/* Returns false when no more bytes to process, true if there are more */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200560static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100561 unsigned int bytes)
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800562{
Bart Van Asschebed22132017-08-25 13:46:32 -0700563 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800564 struct scsi_device *sdev = cmd->device;
565 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800566
567 if (blk_update_request(req, error, bytes))
568 return true;
569
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800570 if (blk_queue_add_random(q))
571 add_disk_randomness(req->rq_disk);
572
Bart Van Assche64104f72017-08-30 16:58:39 -0700573 if (!blk_rq_is_scsi(req)) {
574 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
575 cmd->flags &= ~SCMD_INITIALIZED;
576 }
577
Jens Axboef664a3c2018-11-01 16:36:27 -0600578 /*
Bart Van Asschedb983f62019-03-18 09:29:26 -0700579 * Calling rcu_barrier() is not necessary here because the
580 * SCSI error handler guarantees that the function called by
581 * call_rcu() has been called before scsi_end_request() is
582 * called.
583 */
584 destroy_rcu_head(&cmd->rcu);
585
586 /*
Jens Axboef664a3c2018-11-01 16:36:27 -0600587 * In the MQ case the command gets freed by __blk_mq_end_request,
588 * so we have to do all cleanup that depends on it earlier.
589 *
590 * We also can't kick the queues from irq context, so we
591 * will have to defer it to a workqueue.
592 */
593 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800594
Jens Axboea78b03b2018-11-18 15:46:03 -0700595 /*
596 * queue is still alive, so grab the ref for preventing it
597 * from being cleaned up during running queue.
598 */
599 percpu_ref_get(&q->q_usage_counter);
Ming Lei8dc765d2018-11-14 16:25:51 +0800600
Jens Axboef664a3c2018-11-01 16:36:27 -0600601 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100602
Ming Lei3f0dcfb2020-07-20 10:54:35 +0800603 scsi_run_queue_async(sdev);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100604
Jens Axboea78b03b2018-11-18 15:46:03 -0700605 percpu_ref_put(&q->q_usage_counter);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800606 return false;
607}
608
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200609/**
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700610 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
611 * @cmd: SCSI command
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200612 * @result: scsi error code
613 *
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700614 * Translate a SCSI result code into a blk_status_t value. May reset the host
615 * byte of @cmd->result.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200616 */
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700617static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100618{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200619 switch (host_byte(result)) {
Bart Van Asschef4abab32018-04-05 10:33:01 -0700620 case DID_OK:
621 /*
622 * Also check the other bytes than the status byte in result
623 * to handle the case when a SCSI LLD sets result to
624 * DRIVER_SENSE << 24 without setting SAM_STAT_CHECK_CONDITION.
625 */
626 if (scsi_status_is_good(result) && (result & ~0xff) == 0)
627 return BLK_STS_OK;
628 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100629 case DID_TRANSPORT_FAILFAST:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200630 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100631 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000632 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200633 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100634 case DID_NEXUS_FAILURE:
Martin Wilck4a067cf2019-02-14 22:57:41 +0100635 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200636 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200637 case DID_ALLOC_FAILURE:
638 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200639 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200640 case DID_MEDIUM_ERROR:
641 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200642 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100643 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200644 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100645 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100646}
647
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200648/* Helper for scsi_io_completion() when "reprep" action required. */
649static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
650 struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651{
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200652 /* A new command will be prepared and issued. */
Jens Axboef664a3c2018-11-01 16:36:27 -0600653 scsi_mq_requeue_cmd(cmd);
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200654}
655
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200656/* Helper for scsi_io_completion() when special action required. */
657static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
Douglas Gilbertab831082018-06-23 12:22:16 +0200658{
Jens Axboe165125e2007-07-24 09:28:11 +0200659 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 struct request *req = cmd->request;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200661 int level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500662 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
663 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900664 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200665 struct scsi_sense_hdr sshdr;
666 bool sense_valid;
667 bool sense_current = true; /* false implies "deferred sense" */
668 blk_status_t blk_stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200670 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
671 if (sense_valid)
672 sense_current = !scsi_sense_is_deferred(&sshdr);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200673
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200674 blk_stat = scsi_result_to_blk_status(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500675
Alan Sternb60af5b2008-11-03 15:56:47 -0500676 if (host_byte(result) == DID_RESET) {
677 /* Third party bus reset or reset for error recovery
678 * reasons. Just retry the command and see what
679 * happens.
680 */
681 action = ACTION_RETRY;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200682 } else if (sense_valid && sense_current) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 switch (sshdr.sense_key) {
684 case UNIT_ATTENTION:
685 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700686 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 * and quietly refuse further access.
688 */
689 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500690 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700692 /* Must have been a power glitch, or a
693 * bus reset. Could not have been a
694 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500695 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700696 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500697 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 }
699 break;
700 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700701 /* If we had an ILLEGAL REQUEST returned, then
702 * we may have performed an unsupported
703 * command. The only thing this should be
704 * would be a ten byte read where only a six
705 * byte read was supported. Also, on a system
706 * where READ CAPACITY failed, we may have
707 * read past the end of the disk.
708 */
Jens Axboe26a68012005-11-29 21:03:34 +0100709 if ((cmd->device->use_10_for_rw &&
710 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 (cmd->cmnd[0] == READ_10 ||
712 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500713 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500715 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500716 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500717 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200718 blk_stat = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500719 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400720 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500721 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200722 blk_stat = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500723 } else
724 action = ACTION_FAIL;
725 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400726 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000727 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200728 if (sshdr.asc == 0x10) /* DIF */
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200729 blk_stat = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 break;
731 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700732 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500733 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500735 if (sshdr.asc == 0x04) {
736 switch (sshdr.ascq) {
737 case 0x01: /* becoming ready */
738 case 0x04: /* format in progress */
739 case 0x05: /* rebuild in progress */
740 case 0x06: /* recalculation in progress */
741 case 0x07: /* operation in progress */
742 case 0x08: /* Long write in progress */
743 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500744 case 0x14: /* space allocation in progress */
Douglas Gilberte37c7d92018-05-18 19:25:47 -0400745 case 0x1a: /* start stop unit in progress */
746 case 0x1b: /* sanitize in progress */
747 case 0x1d: /* configuration in progress */
748 case 0x24: /* depopulation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500749 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500750 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500751 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500752 action = ACTION_FAIL;
753 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500754 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200755 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500756 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500757 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700759 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500760 action = ACTION_FAIL;
761 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500763 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 break;
765 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200766 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500767 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500768
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900769 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200770 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900771 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900772
Alan Sternb60af5b2008-11-03 15:56:47 -0500773 switch (action) {
774 case ACTION_FAIL:
775 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200776 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200777 static DEFINE_RATELIMIT_STATE(_rs,
778 DEFAULT_RATELIMIT_INTERVAL,
779 DEFAULT_RATELIMIT_BURST);
780
781 if (unlikely(scsi_logging_level))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200782 level =
783 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
784 SCSI_LOG_MLCOMPLETE_BITS);
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200785
786 /*
787 * if logging is enabled the failure will be printed
788 * in scsi_log_completion(), so avoid duplicate messages
789 */
790 if (!level && __ratelimit(&_rs)) {
791 scsi_print_result(cmd, NULL, FAILED);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +0200792 if (driver_byte(result) == DRIVER_SENSE)
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200793 scsi_print_sense(cmd);
794 scsi_print_command(cmd);
795 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500796 }
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100797 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req)))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800798 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200799 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500800 case ACTION_REPREP:
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200801 scsi_io_completion_reprep(cmd, q);
Alan Sternb60af5b2008-11-03 15:56:47 -0500802 break;
803 case ACTION_RETRY:
804 /* Retry the same command immediately */
Bart Van Assche08640e82018-01-10 14:41:45 -0800805 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500806 break;
807 case ACTION_DELAYED_RETRY:
808 /* Retry the same command after a delay */
Bart Van Assche08640e82018-01-10 14:41:45 -0800809 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500810 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 }
812}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200814/*
815 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
816 * new result that may suppress further error checking. Also modifies
817 * *blk_statp in some cases.
818 */
819static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
820 blk_status_t *blk_statp)
821{
822 bool sense_valid;
823 bool sense_current = true; /* false implies "deferred sense" */
824 struct request *req = cmd->request;
825 struct scsi_sense_hdr sshdr;
826
827 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
828 if (sense_valid)
829 sense_current = !scsi_sense_is_deferred(&sshdr);
830
831 if (blk_rq_is_passthrough(req)) {
832 if (sense_valid) {
833 /*
834 * SG_IO wants current and deferred errors
835 */
836 scsi_req(req)->sense_len =
837 min(8 + cmd->sense_buffer[7],
838 SCSI_SENSE_BUFFERSIZE);
839 }
840 if (sense_current)
841 *blk_statp = scsi_result_to_blk_status(cmd, result);
842 } else if (blk_rq_bytes(req) == 0 && sense_current) {
843 /*
844 * Flush commands do not transfers any data, and thus cannot use
845 * good_bytes != blk_rq_bytes(req) as the signal for an error.
846 * This sets *blk_statp explicitly for the problem case.
847 */
848 *blk_statp = scsi_result_to_blk_status(cmd, result);
849 }
850 /*
851 * Recovered errors need reporting, but they're always treated as
852 * success, so fiddle the result code here. For passthrough requests
853 * we already took a copy of the original into sreq->result which
854 * is what gets returned to the user
855 */
856 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
857 bool do_print = true;
858 /*
859 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
860 * skip print since caller wants ATA registers. Only occurs
861 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
862 */
863 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
864 do_print = false;
865 else if (req->rq_flags & RQF_QUIET)
866 do_print = false;
867 if (do_print)
868 scsi_print_sense(cmd);
869 result = 0;
870 /* for passthrough, *blk_statp may be set */
871 *blk_statp = BLK_STS_OK;
872 }
873 /*
874 * Another corner case: the SCSI status byte is non-zero but 'good'.
875 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
876 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
877 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
878 * intermediate statuses (both obsolete in SAM-4) as good.
879 */
880 if (status_byte(result) && scsi_status_is_good(result)) {
881 result = 0;
882 *blk_statp = BLK_STS_OK;
883 }
884 return result;
885}
886
André Almeidaea941012020-04-19 02:01:48 -0300887/**
888 * scsi_io_completion - Completion processing for SCSI commands.
889 * @cmd: command that is finished.
890 * @good_bytes: number of processed bytes.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200891 *
André Almeidaea941012020-04-19 02:01:48 -0300892 * We will finish off the specified number of sectors. If we are done, the
893 * command block will be released and the queue function will be goosed. If we
894 * are not done then we have to figure out what to do next:
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200895 *
André Almeidaea941012020-04-19 02:01:48 -0300896 * a) We can call scsi_io_completion_reprep(). The request will be
897 * unprepared and put back on the queue. Then a new command will
898 * be created for it. This should be used if we made forward
899 * progress, or if we want to switch from READ(10) to READ(6) for
900 * example.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200901 *
André Almeidaea941012020-04-19 02:01:48 -0300902 * b) We can call scsi_io_completion_action(). The request will be
903 * put back on the queue and retried using the same command as
904 * before, possibly after a delay.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200905 *
André Almeidaea941012020-04-19 02:01:48 -0300906 * c) We can call scsi_end_request() with blk_stat other than
907 * BLK_STS_OK, to fail the remainder of the request.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200908 */
909void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
910{
911 int result = cmd->result;
912 struct request_queue *q = cmd->device->request_queue;
913 struct request *req = cmd->request;
914 blk_status_t blk_stat = BLK_STS_OK;
915
Douglas Gilbert0d437902018-06-23 12:22:19 +0200916 if (unlikely(result)) /* a nz result may or may not be an error */
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200917 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
918
Douglas Gilbert0d437902018-06-23 12:22:19 +0200919 if (unlikely(blk_rq_is_passthrough(req))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200920 /*
921 * scsi_result_to_blk_status may have reset the host_byte
922 */
923 scsi_req(req)->result = cmd->result;
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200924 }
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200925
926 /*
927 * Next deal with any sectors which we were able to correctly
928 * handle.
929 */
930 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
931 "%u sectors total, %d bytes done.\n",
932 blk_rq_sectors(req), good_bytes));
933
934 /*
André Almeidaea941012020-04-19 02:01:48 -0300935 * Failed, zero length commands always need to drop down
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200936 * to retry code. Fast path should return in this block.
937 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200938 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100939 if (likely(!scsi_end_request(req, blk_stat, good_bytes)))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200940 return; /* no bytes remaining */
941 }
942
Douglas Gilbert0d437902018-06-23 12:22:19 +0200943 /* Kill remainder if no retries. */
944 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100945 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req)))
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200946 WARN_ONCE(true,
947 "Bytes remaining after failed, no-retry command");
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200948 return;
949 }
950
951 /*
952 * If there had been no error, but we have leftover bytes in the
953 * requeues just queue the command up again.
954 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200955 if (likely(result == 0))
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200956 scsi_io_completion_reprep(cmd, q);
957 else
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200958 scsi_io_completion_action(cmd, result);
959}
960
Christoph Hellwigcc979232020-04-14 09:42:24 +0200961static inline bool scsi_cmd_needs_dma_drain(struct scsi_device *sdev,
962 struct request *rq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963{
Christoph Hellwigcc979232020-04-14 09:42:24 +0200964 return sdev->dma_drain_len && blk_rq_is_passthrough(rq) &&
965 !op_is_write(req_op(rq)) &&
966 sdev->host->hostt->dma_need_drain(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200968
André Almeidaea941012020-04-19 02:01:48 -0300969/**
970 * scsi_init_io - SCSI I/O initialization function.
971 * @cmd: command descriptor we wish to initialize
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200972 *
André Almeidaea941012020-04-19 02:01:48 -0300973 * Returns:
974 * * BLK_STS_OK - on success
975 * * BLK_STS_RESOURCE - if the failure is retryable
976 * * BLK_STS_IOERR - if the failure is fatal
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200977 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100978blk_status_t scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200979{
Christoph Hellwigcc979232020-04-14 09:42:24 +0200980 struct scsi_device *sdev = cmd->device;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200981 struct request *rq = cmd->request;
Christoph Hellwigcc979232020-04-14 09:42:24 +0200982 unsigned short nr_segs = blk_rq_nr_phys_segments(rq);
983 struct scatterlist *last_sg = NULL;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100984 blk_status_t ret;
Christoph Hellwigcc979232020-04-14 09:42:24 +0200985 bool need_drain = scsi_cmd_needs_dma_drain(sdev, rq);
Christoph Hellwig0475bd62020-04-14 09:42:23 +0200986 int count;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200987
Christoph Hellwigcc979232020-04-14 09:42:24 +0200988 if (WARN_ON_ONCE(!nr_segs))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100989 return BLK_STS_IOERR;
Christoph Hellwig635d98b2014-06-28 11:51:01 +0200990
Christoph Hellwig0475bd62020-04-14 09:42:23 +0200991 /*
Christoph Hellwigcc979232020-04-14 09:42:24 +0200992 * Make sure there is space for the drain. The driver must adjust
993 * max_hw_segments to be prepared for this.
994 */
995 if (need_drain)
996 nr_segs++;
997
998 /*
Christoph Hellwig0475bd62020-04-14 09:42:23 +0200999 * If sg table allocation fails, requeue request later.
1000 */
Christoph Hellwigcc979232020-04-14 09:42:24 +02001001 if (unlikely(sg_alloc_table_chained(&cmd->sdb.table, nr_segs,
1002 cmd->sdb.table.sgl, SCSI_INLINE_SG_CNT)))
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001003 return BLK_STS_RESOURCE;
1004
1005 /*
1006 * Next, walk the list, and fill in the addresses and sizes of
1007 * each segment.
1008 */
Christoph Hellwigcc979232020-04-14 09:42:24 +02001009 count = __blk_rq_map_sg(rq->q, rq, cmd->sdb.table.sgl, &last_sg);
1010
Christoph Hellwigbdf87102020-04-14 09:42:25 +02001011 if (blk_rq_bytes(rq) & rq->q->dma_pad_mask) {
1012 unsigned int pad_len =
1013 (rq->q->dma_pad_mask & ~blk_rq_bytes(rq)) + 1;
1014
1015 last_sg->length += pad_len;
1016 cmd->extra_len += pad_len;
1017 }
1018
Christoph Hellwigcc979232020-04-14 09:42:24 +02001019 if (need_drain) {
1020 sg_unmark_end(last_sg);
1021 last_sg = sg_next(last_sg);
1022 sg_set_buf(last_sg, sdev->dma_drain_buf, sdev->dma_drain_len);
1023 sg_mark_end(last_sg);
1024
Christoph Hellwigbdf87102020-04-14 09:42:25 +02001025 cmd->extra_len += sdev->dma_drain_len;
Christoph Hellwigcc979232020-04-14 09:42:24 +02001026 count++;
1027 }
1028
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001029 BUG_ON(count > cmd->sdb.table.nents);
1030 cmd->sdb.table.nents = count;
1031 cmd->sdb.length = blk_rq_payload_bytes(rq);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001032
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001033 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001034 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001035 int ivecs;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001036
Christoph Hellwig14784562018-11-09 14:42:38 +01001037 if (WARN_ON_ONCE(!prot_sdb)) {
Ewan D. Milne91724c22015-01-15 10:02:12 -05001038 /*
1039 * This can happen if someone (e.g. multipath)
1040 * queues a command to a device on an adapter
1041 * that does not support DIX.
1042 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001043 ret = BLK_STS_IOERR;
Christoph Hellwig14784562018-11-09 14:42:38 +01001044 goto out_free_sgtables;
Ewan D. Milne91724c22015-01-15 10:02:12 -05001045 }
1046
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001047 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001048
Ming Lin001d63b2016-04-04 14:48:09 -07001049 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lei46358732019-04-28 15:39:30 +08001050 prot_sdb->table.sgl,
Ming Lei92524fa2019-04-28 15:39:31 +08001051 SCSI_INLINE_PROT_SG_CNT)) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001052 ret = BLK_STS_RESOURCE;
Christoph Hellwig14784562018-11-09 14:42:38 +01001053 goto out_free_sgtables;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001054 }
1055
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001056 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001057 prot_sdb->table.sgl);
Igor Stoppa6f1d8a52018-09-05 23:47:20 +03001058 BUG_ON(count > ivecs);
1059 BUG_ON(count > queue_max_integrity_segments(rq->q));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001060
1061 cmd->prot_sdb = prot_sdb;
1062 cmd->prot_sdb->table.nents = count;
1063 }
1064
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001065 return BLK_STS_OK;
Christoph Hellwig14784562018-11-09 14:42:38 +01001066out_free_sgtables:
Johannes Thumshirn20a66f22020-04-28 19:45:55 +09001067 scsi_free_sgtables(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001068 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001069}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001070EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001072/**
Bart Van Assche832889f2017-08-30 16:58:40 -07001073 * scsi_initialize_rq - initialize struct scsi_cmnd partially
Jonathan Corbet35c05062017-08-24 16:11:09 -06001074 * @rq: Request associated with the SCSI command to be initialized.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001075 *
Bart Van Assche832889f2017-08-30 16:58:40 -07001076 * This function initializes the members of struct scsi_cmnd that must be
1077 * initialized before request processing starts and that won't be
1078 * reinitialized if a SCSI command is requeued.
1079 *
Bart Van Assche64104f72017-08-30 16:58:39 -07001080 * Called from inside blk_get_request() for pass-through requests and from
1081 * inside scsi_init_command() for filesystem requests.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001082 */
Bart Van Asschee4c94702017-12-07 15:59:31 -08001083static void scsi_initialize_rq(struct request *rq)
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001084{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001085 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1086
1087 scsi_req_init(&cmd->req);
Bart Van Assche3be88282018-02-22 11:30:20 -08001088 init_rcu_head(&cmd->rcu);
Bart Van Assche832889f2017-08-30 16:58:40 -07001089 cmd->jiffies_at_alloc = jiffies;
1090 cmd->retries = 0;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001091}
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001092
Ming Leib7e9e1f2019-07-25 10:05:00 +08001093/*
1094 * Only called when the request isn't completed by SCSI, and not freed by
1095 * SCSI
1096 */
1097static void scsi_cleanup_rq(struct request *rq)
1098{
1099 if (rq->rq_flags & RQF_DONTPREP) {
1100 scsi_mq_uninit_cmd(blk_mq_rq_to_pdu(rq));
1101 rq->rq_flags &= ~RQF_DONTPREP;
1102 }
1103}
1104
Bart Van Assche65ca8462020-01-22 19:56:34 -08001105/* Called before a request is prepared. See also scsi_mq_prep_fn(). */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001106void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001107{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001108 void *buf = cmd->sense_buffer;
1109 void *prot = cmd->prot_sdb;
Bart Van Assche64104f72017-08-30 16:58:39 -07001110 struct request *rq = blk_mq_rq_from_pdu(cmd);
1111 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
Bart Van Assche832889f2017-08-30 16:58:40 -07001112 unsigned long jiffies_at_alloc;
Bart Van Assche65ca8462020-01-22 19:56:34 -08001113 int retries, to_clear;
Ming Lei6eb045e2019-10-25 14:58:55 +08001114 bool in_flight;
Bart Van Assche64104f72017-08-30 16:58:39 -07001115
1116 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1117 flags |= SCMD_INITIALIZED;
1118 scsi_initialize_rq(rq);
1119 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001120
Bart Van Assche832889f2017-08-30 16:58:40 -07001121 jiffies_at_alloc = cmd->jiffies_at_alloc;
1122 retries = cmd->retries;
Ming Lei6eb045e2019-10-25 14:58:55 +08001123 in_flight = test_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Bart Van Assche65ca8462020-01-22 19:56:34 -08001124 /*
1125 * Zero out the cmd, except for the embedded scsi_request. Only clear
1126 * the driver-private command data if the LLD does not supply a
1127 * function to initialize that data.
1128 */
1129 to_clear = sizeof(*cmd) - sizeof(cmd->req);
1130 if (!dev->host->hostt->init_cmd_priv)
1131 to_clear += dev->host->hostt->cmd_size;
1132 memset((char *)cmd + sizeof(cmd->req), 0, to_clear);
Christoph Hellwig04796332014-02-20 14:20:55 -08001133
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001134 cmd->device = dev;
1135 cmd->sense_buffer = buf;
1136 cmd->prot_sdb = prot;
Bart Van Assche64104f72017-08-30 16:58:39 -07001137 cmd->flags = flags;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001138 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
Bart Van Assche832889f2017-08-30 16:58:40 -07001139 cmd->jiffies_at_alloc = jiffies_at_alloc;
1140 cmd->retries = retries;
Ming Lei6eb045e2019-10-25 14:58:55 +08001141 if (in_flight)
1142 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001143
Christoph Hellwig3b003152006-11-04 20:10:55 +01001144}
1145
Christoph Hellwig785ba832018-11-09 14:42:37 +01001146static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1147 struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001148{
Bart Van Asschebed22132017-08-25 13:46:32 -07001149 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001150
1151 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001152 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001153 * a bio attached to them. Or they might contain a SCSI command
1154 * that does not transfer data, in which case they may optionally
1155 * submit a request without an attached bio.
1156 */
1157 if (req->bio) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001158 blk_status_t ret = scsi_init_io(cmd);
1159 if (unlikely(ret != BLK_STS_OK))
1160 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001161 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001162 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001163
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001164 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001165 }
James Bottomley7b163182005-12-15 20:17:02 -06001166
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001167 cmd->cmd_len = scsi_req(req)->cmd_len;
1168 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001169 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001170 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig785ba832018-11-09 14:42:37 +01001171 return BLK_STS_OK;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001172}
1173
1174/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001175 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001176 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001177 */
Christoph Hellwig785ba832018-11-09 14:42:37 +01001178static blk_status_t scsi_setup_fs_cmnd(struct scsi_device *sdev,
1179 struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001180{
Bart Van Asschebed22132017-08-25 13:46:32 -07001181 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001182
Christoph Hellwigee14c672015-08-27 14:16:59 +02001183 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
Christoph Hellwig4c1cb672018-11-09 14:42:40 +01001184 blk_status_t ret = sdev->handler->prep_fn(sdev, req);
1185 if (ret != BLK_STS_OK)
1186 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001187 }
1188
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001189 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001190 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001191 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001192}
James Bottomley7b163182005-12-15 20:17:02 -06001193
Christoph Hellwig785ba832018-11-09 14:42:37 +01001194static blk_status_t scsi_setup_cmnd(struct scsi_device *sdev,
1195 struct request *req)
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001196{
Bart Van Asschebed22132017-08-25 13:46:32 -07001197 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Johannes Thumshirn20a66f22020-04-28 19:45:55 +09001198 blk_status_t ret;
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001199
1200 if (!blk_rq_bytes(req))
1201 cmd->sc_data_direction = DMA_NONE;
1202 else if (rq_data_dir(req) == WRITE)
1203 cmd->sc_data_direction = DMA_TO_DEVICE;
1204 else
1205 cmd->sc_data_direction = DMA_FROM_DEVICE;
1206
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001207 if (blk_rq_is_scsi(req))
Johannes Thumshirn20a66f22020-04-28 19:45:55 +09001208 ret = scsi_setup_scsi_cmnd(sdev, req);
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001209 else
Johannes Thumshirn20a66f22020-04-28 19:45:55 +09001210 ret = scsi_setup_fs_cmnd(sdev, req);
1211
1212 if (ret != BLK_STS_OK)
1213 scsi_free_sgtables(cmd);
1214
1215 return ret;
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001216}
1217
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001218static blk_status_t
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001219scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220{
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001221 switch (sdev->sdev_state) {
1222 case SDEV_OFFLINE:
1223 case SDEV_TRANSPORT_OFFLINE:
1224 /*
1225 * If the device is offline we refuse to process any
1226 * commands. The device must be brought online
1227 * before trying any recovery commands.
1228 */
Ewan D. Milneb0962c52020-03-11 10:39:30 -04001229 if (!sdev->offline_already) {
1230 sdev->offline_already = true;
1231 sdev_printk(KERN_ERR, sdev,
1232 "rejecting I/O to offline device\n");
1233 }
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001234 return BLK_STS_IOERR;
1235 case SDEV_DEL:
1236 /*
1237 * If the device is fully deleted, we refuse to
1238 * process any commands as well.
1239 */
1240 sdev_printk(KERN_ERR, sdev,
1241 "rejecting I/O to dead device\n");
1242 return BLK_STS_IOERR;
1243 case SDEV_BLOCK:
1244 case SDEV_CREATED_BLOCK:
1245 return BLK_STS_RESOURCE;
1246 case SDEV_QUIESCE:
1247 /*
1248 * If the devices is blocked we defer normal commands.
1249 */
1250 if (req && !(req->rq_flags & RQF_PREEMPT))
1251 return BLK_STS_RESOURCE;
1252 return BLK_STS_OK;
1253 default:
1254 /*
1255 * For any other not fully online state we only allow
1256 * special commands. In particular any user initiated
1257 * command is not allowed.
1258 */
1259 if (req && !(req->rq_flags & RQF_PREEMPT))
1260 return BLK_STS_IOERR;
1261 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001263}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265/*
1266 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1267 * return 0.
1268 *
1269 * Called with the queue_lock held.
1270 */
1271static inline int scsi_dev_queue_ready(struct request_queue *q,
1272 struct scsi_device *sdev)
1273{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001274 unsigned int busy;
1275
1276 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001277 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001278 if (busy)
1279 goto out_dec;
1280
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 /*
1282 * unblock after device_blocked iterates to zero
1283 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001284 if (atomic_dec_return(&sdev->device_blocked) > 0)
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001285 goto out_dec;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001286 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1287 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001289
1290 if (busy >= sdev->queue_depth)
1291 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
1293 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001294out_dec:
1295 atomic_dec(&sdev->device_busy);
1296 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297}
1298
Mike Christief0c0a372008-08-17 15:24:38 -05001299/*
1300 * scsi_target_queue_ready: checks if there we can send commands to target
1301 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001302 */
1303static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1304 struct scsi_device *sdev)
1305{
1306 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001307 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001308
1309 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001310 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001311 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001312 starget->starget_sdev_user != sdev) {
1313 spin_unlock_irq(shost->host_lock);
1314 return 0;
1315 }
Mike Christief0c0a372008-08-17 15:24:38 -05001316 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001317 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001318 }
1319
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001320 if (starget->can_queue <= 0)
1321 return 1;
1322
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001323 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001324 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001325 if (busy)
1326 goto starved;
1327
Mike Christief0c0a372008-08-17 15:24:38 -05001328 /*
1329 * unblock after target_blocked iterates to zero
1330 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001331 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001332 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001333
1334 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1335 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001336 }
1337
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001338 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001339 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001340
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001341 return 1;
1342
1343starved:
1344 spin_lock_irq(shost->host_lock);
1345 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001346 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001347out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001348 if (starget->can_queue > 0)
1349 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001350 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001351}
1352
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353/*
1354 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1355 * return 0. We must end up running the queue again whenever 0 is
1356 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 */
1358static inline int scsi_host_queue_ready(struct request_queue *q,
1359 struct Scsi_Host *shost,
Ming Lei6eb045e2019-10-25 14:58:55 +08001360 struct scsi_device *sdev,
1361 struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362{
James Bottomley939647e2005-09-18 15:05:20 -05001363 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001364 return 0;
1365
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001366 if (atomic_read(&shost->host_blocked) > 0) {
Ming Lei6eb045e2019-10-25 14:58:55 +08001367 if (scsi_host_busy(shost) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001368 goto starved;
1369
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 /*
1371 * unblock after host_blocked iterates to zero
1372 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001373 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001374 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001375
1376 SCSI_LOG_MLQUEUE(3,
1377 shost_printk(KERN_INFO, shost,
1378 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001380
Christoph Hellwig74665012014-01-22 15:29:29 +01001381 if (shost->host_self_blocked)
1382 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383
1384 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001385 if (!list_empty(&sdev->starved_entry)) {
1386 spin_lock_irq(shost->host_lock);
1387 if (!list_empty(&sdev->starved_entry))
1388 list_del_init(&sdev->starved_entry);
1389 spin_unlock_irq(shost->host_lock);
1390 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391
Ming Lei6eb045e2019-10-25 14:58:55 +08001392 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state);
1393
Christoph Hellwig74665012014-01-22 15:29:29 +01001394 return 1;
1395
1396starved:
1397 spin_lock_irq(shost->host_lock);
1398 if (list_empty(&sdev->starved_entry))
1399 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001400 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001401out_dec:
Ming Lei6eb045e2019-10-25 14:58:55 +08001402 scsi_dec_host_busy(shost, cmd);
Christoph Hellwig74665012014-01-22 15:29:29 +01001403 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404}
1405
1406/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001407 * Busy state exporting function for request stacking drivers.
1408 *
1409 * For efficiency, no lock is taken to check the busy state of
1410 * shost/starget/sdev, since the returned value is not guaranteed and
1411 * may be changed after request stacking drivers call the function,
1412 * regardless of taking lock or not.
1413 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001414 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1415 * needs to return 'not busy'. Otherwise, request stacking drivers
1416 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001417 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001418static bool scsi_mq_lld_busy(struct request_queue *q)
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001419{
1420 struct scsi_device *sdev = q->queuedata;
1421 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001422
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001423 if (blk_queue_dying(q))
Jens Axboef664a3c2018-11-01 16:36:27 -06001424 return false;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001425
1426 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001427
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001428 /*
1429 * Ignore host/starget busy state.
1430 * Since block layer does not have a concept of fairness across
1431 * multiple queues, congestion of host/starget needs to be handled
1432 * in SCSI layer.
1433 */
1434 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Jens Axboef664a3c2018-11-01 16:36:27 -06001435 return true;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001436
Jens Axboef664a3c2018-11-01 16:36:27 -06001437 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438}
1439
Jens Axboe1aea6432006-01-09 16:03:03 +01001440static void scsi_softirq_done(struct request *rq)
1441{
Bart Van Asschebed22132017-08-25 13:46:32 -07001442 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001443 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001444 int disposition;
1445
1446 INIT_LIST_HEAD(&cmd->eh_entry);
1447
Jens Axboe242f9dc2008-09-14 05:55:09 -07001448 atomic_inc(&cmd->device->iodone_cnt);
1449 if (cmd->result)
1450 atomic_inc(&cmd->device->ioerr_cnt);
1451
Jens Axboe1aea6432006-01-09 16:03:03 +01001452 disposition = scsi_decide_disposition(cmd);
1453 if (disposition != SUCCESS &&
1454 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
Maurizio Lombardi463cdad82019-07-02 13:27:05 +02001455 scmd_printk(KERN_ERR, cmd,
Jens Axboe1aea6432006-01-09 16:03:03 +01001456 "timing out command, waited %lus\n",
1457 wait_for/HZ);
1458 disposition = SUCCESS;
1459 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001460
Jens Axboe1aea6432006-01-09 16:03:03 +01001461 scsi_log_completion(cmd, disposition);
1462
1463 switch (disposition) {
1464 case SUCCESS:
1465 scsi_finish_command(cmd);
1466 break;
1467 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001468 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001469 break;
1470 case ADD_TO_MLQUEUE:
1471 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1472 break;
1473 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001474 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001475 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001476 }
1477}
1478
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001479/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001480 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1481 * @cmd: command block we are dispatching.
1482 *
1483 * Return: nonzero return request was rejected and device's queue needs to be
1484 * plugged.
1485 */
1486static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1487{
1488 struct Scsi_Host *host = cmd->device->host;
1489 int rtn = 0;
1490
1491 atomic_inc(&cmd->device->iorequest_cnt);
1492
1493 /* check if the device is still usable */
1494 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1495 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1496 * returns an immediate error upwards, and signals
1497 * that the device is no longer present */
1498 cmd->result = DID_NO_CONNECT << 16;
1499 goto done;
1500 }
1501
1502 /* Check to see if the scsi lld made this device blocked. */
1503 if (unlikely(scsi_device_blocked(cmd->device))) {
1504 /*
1505 * in blocked state, the command is just put back on
1506 * the device queue. The suspend state has already
1507 * blocked the queue so future requests should not
1508 * occur until the device transitions out of the
1509 * suspend state.
1510 */
1511 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1512 "queuecommand : device blocked\n"));
1513 return SCSI_MLQUEUE_DEVICE_BUSY;
1514 }
1515
1516 /* Store the LUN value in cmnd, if needed. */
1517 if (cmd->device->lun_in_cdb)
1518 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1519 (cmd->device->lun << 5 & 0xe0);
1520
1521 scsi_log_send(cmd);
1522
1523 /*
1524 * Before we queue this command, check if the command
1525 * length exceeds what the host adapter can handle.
1526 */
1527 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1528 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1529 "queuecommand : command too long. "
1530 "cdb_size=%d host->max_cmd_len=%d\n",
1531 cmd->cmd_len, cmd->device->host->max_cmd_len));
1532 cmd->result = (DID_ABORT << 16);
1533 goto done;
1534 }
1535
1536 if (unlikely(host->shost_state == SHOST_DEL)) {
1537 cmd->result = (DID_NO_CONNECT << 16);
1538 goto done;
1539
1540 }
1541
1542 trace_scsi_dispatch_cmd_start(cmd);
1543 rtn = host->hostt->queuecommand(host, cmd);
1544 if (rtn) {
1545 trace_scsi_dispatch_cmd_error(cmd, rtn);
1546 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1547 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1548 rtn = SCSI_MLQUEUE_HOST_BUSY;
1549
1550 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1551 "queuecommand : request rejected\n"));
1552 }
1553
1554 return rtn;
1555 done:
1556 cmd->scsi_done(cmd);
1557 return 0;
1558}
1559
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001560/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
Ming Lei3dccdf52019-04-28 15:39:32 +08001561static unsigned int scsi_mq_inline_sgl_size(struct Scsi_Host *shost)
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001562{
Ming Lei3dccdf52019-04-28 15:39:32 +08001563 return min_t(unsigned int, shost->sg_tablesize, SCSI_INLINE_SG_CNT) *
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001564 sizeof(struct scatterlist);
1565}
1566
Christoph Hellwig785ba832018-11-09 14:42:37 +01001567static blk_status_t scsi_mq_prep_fn(struct request *req)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001568{
1569 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1570 struct scsi_device *sdev = req->q->queuedata;
1571 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001572 struct scatterlist *sg;
1573
Bart Van Assche08f78432017-06-02 14:22:00 -07001574 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001575
Christoph Hellwigd2852032014-01-17 12:06:53 +01001576 cmd->request = req;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001577 cmd->tag = req->tag;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001578 cmd->prot_op = SCSI_PROT_NORMAL;
1579
Christoph Hellwigd2852032014-01-17 12:06:53 +01001580 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1581 cmd->sdb.table.sgl = sg;
1582
1583 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001584 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1585
1586 cmd->prot_sdb->table.sgl =
1587 (struct scatterlist *)(cmd->prot_sdb + 1);
1588 }
1589
Christoph Hellwigfe052522014-09-22 15:59:31 +02001590 blk_mq_start_request(req);
1591
Bart Van Assche8fe8ffb2017-10-20 11:46:45 -07001592 return scsi_setup_cmnd(sdev, req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001593}
1594
1595static void scsi_mq_done(struct scsi_cmnd *cmd)
1596{
Keith Buschf1342702018-11-26 09:54:29 -07001597 if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state)))
1598 return;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001599 trace_scsi_dispatch_cmd_done(cmd);
Keith Buschf1342702018-11-26 09:54:29 -07001600
1601 /*
1602 * If the block layer didn't complete the request due to a timeout
1603 * injection, scsi must clear its internal completed state so that the
1604 * timeout handler will see it needs to escalate its own error
1605 * recovery.
1606 */
1607 if (unlikely(!blk_mq_complete_request(cmd->request)))
1608 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001609}
1610
Ming Lei0df21c82017-10-14 17:22:32 +08001611static void scsi_mq_put_budget(struct blk_mq_hw_ctx *hctx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001612{
Ming Lei0df21c82017-10-14 17:22:32 +08001613 struct request_queue *q = hctx->queue;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001614 struct scsi_device *sdev = q->queuedata;
Ming Lei0df21c82017-10-14 17:22:32 +08001615
Ming Lei0df21c82017-10-14 17:22:32 +08001616 atomic_dec(&sdev->device_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001617}
1618
Ming Lei88022d72017-11-05 02:21:12 +08001619static bool scsi_mq_get_budget(struct blk_mq_hw_ctx *hctx)
Ming Lei0df21c82017-10-14 17:22:32 +08001620{
1621 struct request_queue *q = hctx->queue;
1622 struct scsi_device *sdev = q->queuedata;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001623
Douglas Andersonb4fd63f2020-04-20 09:24:54 -07001624 return scsi_dev_queue_ready(q, sdev);
Ming Lei0df21c82017-10-14 17:22:32 +08001625}
1626
Christoph Hellwigd2852032014-01-17 12:06:53 +01001627static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1628 const struct blk_mq_queue_data *bd)
1629{
1630 struct request *req = bd->rq;
1631 struct request_queue *q = req->q;
1632 struct scsi_device *sdev = q->queuedata;
1633 struct Scsi_Host *shost = sdev->host;
1634 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1635 blk_status_t ret;
1636 int reason;
1637
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001638 /*
1639 * If the device is not in running state we will reject some or all
1640 * commands.
1641 */
1642 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1643 ret = scsi_prep_state_check(sdev, req);
1644 if (ret != BLK_STS_OK)
1645 goto out_put_budget;
1646 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001647
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001648 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001649 if (!scsi_target_queue_ready(shost, sdev))
Ming Lei826a70a2017-11-04 09:55:34 +08001650 goto out_put_budget;
Ming Lei6eb045e2019-10-25 14:58:55 +08001651 if (!scsi_host_queue_ready(q, shost, sdev, cmd))
Christoph Hellwigd2852032014-01-17 12:06:53 +01001652 goto out_dec_target_busy;
1653
Christoph Hellwige8064022016-10-20 15:12:13 +02001654 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwig785ba832018-11-09 14:42:37 +01001655 ret = scsi_mq_prep_fn(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001656 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001657 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001658 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001659 } else {
Bart Van Asschecd464d82019-01-15 16:50:03 -08001660 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigfe052522014-09-22 15:59:31 +02001661 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001662 }
1663
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001664 cmd->flags &= SCMD_PRESERVED_FLAGS;
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001665 if (sdev->simple_tags)
1666 cmd->flags |= SCMD_TAGGED;
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001667 if (bd->last)
1668 cmd->flags |= SCMD_LAST;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001669
Christoph Hellwigd2852032014-01-17 12:06:53 +01001670 scsi_init_cmd_errh(cmd);
1671 cmd->scsi_done = scsi_mq_done;
1672
1673 reason = scsi_dispatch_cmd(cmd);
1674 if (reason) {
1675 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001676 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001677 goto out_dec_host_busy;
1678 }
1679
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001680 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001681
1682out_dec_host_busy:
Ming Lei6eb045e2019-10-25 14:58:55 +08001683 scsi_dec_host_busy(shost, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001684out_dec_target_busy:
1685 if (scsi_target(sdev)->can_queue > 0)
1686 atomic_dec(&scsi_target(sdev)->target_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001687out_put_budget:
1688 scsi_mq_put_budget(hctx);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001689 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001690 case BLK_STS_OK:
1691 break;
1692 case BLK_STS_RESOURCE:
Keith Busch0512a752020-05-12 17:55:47 +09001693 case BLK_STS_ZONE_RESOURCE:
Ming Lei86ff7c22018-01-30 22:04:57 -05001694 if (atomic_read(&sdev->device_busy) ||
1695 scsi_device_blocked(sdev))
1696 ret = BLK_STS_DEV_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001697 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001698 default:
Jaesoo Leebe549d42019-04-09 17:02:22 -07001699 if (unlikely(!scsi_device_online(sdev)))
1700 scsi_req(req)->result = DID_NO_CONNECT << 16;
1701 else
1702 scsi_req(req)->result = DID_ERROR << 16;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001703 /*
Jaesoo Leebe549d42019-04-09 17:02:22 -07001704 * Make sure to release all allocated resources when
Christoph Hellwigd2852032014-01-17 12:06:53 +01001705 * we hit an error, as we will never see this command
1706 * again.
1707 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001708 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001709 scsi_mq_uninit_cmd(cmd);
Ming Lei3f0dcfb2020-07-20 10:54:35 +08001710 scsi_run_queue_async(sdev);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001711 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001712 }
1713 return ret;
1714}
1715
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001716static enum blk_eh_timer_return scsi_timeout(struct request *req,
1717 bool reserved)
1718{
1719 if (reserved)
1720 return BLK_EH_RESET_TIMER;
1721 return scsi_times_out(req);
1722}
1723
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001724static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1725 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001726{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001727 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07001728 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001729 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07001730 struct scatterlist *sg;
Bart Van Assche65ca8462020-01-22 19:56:34 -08001731 int ret = 0;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001732
Bart Van Assche8e688252017-06-02 14:21:52 -07001733 if (unchecked_isa_dma)
1734 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
1735 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
1736 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001737 if (!cmd->sense_buffer)
1738 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001739 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07001740
1741 if (scsi_host_get_prot(shost)) {
1742 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1743 shost->hostt->cmd_size;
Ming Lei3dccdf52019-04-28 15:39:32 +08001744 cmd->prot_sdb = (void *)sg + scsi_mq_inline_sgl_size(shost);
Bart Van Assche08f78432017-06-02 14:22:00 -07001745 }
1746
Bart Van Assche65ca8462020-01-22 19:56:34 -08001747 if (shost->hostt->init_cmd_priv) {
1748 ret = shost->hostt->init_cmd_priv(shost, cmd);
1749 if (ret < 0)
1750 scsi_free_sense_buffer(unchecked_isa_dma,
1751 cmd->sense_buffer);
1752 }
1753
1754 return ret;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001755}
1756
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001757static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
1758 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001759{
Bart Van Assche65ca8462020-01-22 19:56:34 -08001760 struct Scsi_Host *shost = set->driver_data;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001761 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1762
Bart Van Assche65ca8462020-01-22 19:56:34 -08001763 if (shost->hostt->exit_cmd_priv)
1764 shost->hostt->exit_cmd_priv(shost, cmd);
Bart Van Assche8e688252017-06-02 14:21:52 -07001765 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
1766 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001767}
1768
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001769static int scsi_map_queues(struct blk_mq_tag_set *set)
1770{
1771 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1772
1773 if (shost->hostt->map_queues)
1774 return shost->hostt->map_queues(shost);
Dongli Zhang99bbf482019-03-12 09:00:28 +08001775 return blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001776}
1777
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001778void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779{
Lin Ming6f381fa2012-04-12 13:50:38 +08001780 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781
Jens Axboea8474ce2007-08-07 09:02:51 +02001782 /*
1783 * this limit is imposed by hardware restrictions
1784 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001785 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07001786 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001787
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001788 if (scsi_host_prot_dma(shost)) {
1789 shost->sg_prot_tablesize =
1790 min_not_zero(shost->sg_prot_tablesize,
1791 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1792 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1793 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1794 }
1795
Christoph Hellwig1b5d9a62019-07-22 11:20:38 +02001796 if (dev->dma_mask) {
1797 shost->max_sectors = min_t(unsigned int, shost->max_sectors,
1798 dma_max_mapping_size(dev) >> SECTOR_SHIFT);
1799 }
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001800 blk_queue_max_hw_sectors(q, shost->max_sectors);
Christoph Hellwig21e07db2018-04-03 19:09:59 +02001801 if (shost->unchecked_isa_dma)
1802 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001804 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805
Christoph Hellwiga8cf59a2019-01-16 17:12:15 +01001806 blk_queue_max_segment_size(q, shost->max_segment_size);
Christoph Hellwig7ad388d2019-06-17 14:19:53 +02001807 blk_queue_virt_boundary(q, shost->virt_boundary_mask);
1808 dma_set_max_seg_size(dev, queue_max_segment_size(q));
James Bottomley465ff312008-01-01 10:00:10 -06001809
1810 /*
Huacai Chen90addc62017-11-21 14:23:38 +01001811 * Set a reasonable default alignment: The larger of 32-byte (dword),
1812 * which is a common minimum for HBAs, and the minimum DMA alignment,
1813 * which is set by the platform.
1814 *
1815 * Devices that require a bigger alignment can increase it later.
James Bottomley465ff312008-01-01 10:00:10 -06001816 */
Huacai Chen90addc62017-11-21 14:23:38 +01001817 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001818}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001819EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06001820
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001821static const struct blk_mq_ops scsi_mq_ops_no_commit = {
1822 .get_budget = scsi_mq_get_budget,
1823 .put_budget = scsi_mq_put_budget,
1824 .queue_rq = scsi_queue_rq,
1825 .complete = scsi_softirq_done,
1826 .timeout = scsi_timeout,
1827#ifdef CONFIG_BLK_DEBUG_FS
1828 .show_rq = scsi_show_rq,
1829#endif
1830 .init_request = scsi_mq_init_request,
1831 .exit_request = scsi_mq_exit_request,
1832 .initialize_rq_fn = scsi_initialize_rq,
Steffen Maier82a9ac72019-08-07 16:49:47 +02001833 .cleanup_rq = scsi_cleanup_rq,
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001834 .busy = scsi_mq_lld_busy,
1835 .map_queues = scsi_map_queues,
1836};
1837
1838
1839static void scsi_commit_rqs(struct blk_mq_hw_ctx *hctx)
1840{
1841 struct request_queue *q = hctx->queue;
1842 struct scsi_device *sdev = q->queuedata;
1843 struct Scsi_Host *shost = sdev->host;
1844
1845 shost->hostt->commit_rqs(shost, hctx->queue_num);
1846}
1847
Eric Biggersf363b082017-03-30 13:39:16 -07001848static const struct blk_mq_ops scsi_mq_ops = {
Ming Lei0df21c82017-10-14 17:22:32 +08001849 .get_budget = scsi_mq_get_budget,
1850 .put_budget = scsi_mq_put_budget,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001851 .queue_rq = scsi_queue_rq,
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001852 .commit_rqs = scsi_commit_rqs,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001853 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001854 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07001855#ifdef CONFIG_BLK_DEBUG_FS
1856 .show_rq = scsi_show_rq,
1857#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001858 .init_request = scsi_mq_init_request,
1859 .exit_request = scsi_mq_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001860 .initialize_rq_fn = scsi_initialize_rq,
Ming Leib7e9e1f2019-07-25 10:05:00 +08001861 .cleanup_rq = scsi_cleanup_rq,
Jens Axboe3a7ea2c42018-10-29 10:17:28 -06001862 .busy = scsi_mq_lld_busy,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001863 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001864};
1865
1866struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
1867{
1868 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
1869 if (IS_ERR(sdev->request_queue))
1870 return NULL;
1871
1872 sdev->request_queue->queuedata = sdev;
1873 __scsi_init_queue(sdev->host, sdev->request_queue);
Christoph Hellwig17cb9602018-03-13 17:28:41 +01001874 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001875 return sdev->request_queue;
1876}
1877
1878int scsi_mq_setup_tags(struct Scsi_Host *shost)
1879{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001880 unsigned int cmd_size, sgl_size;
Ye Bin840e1b52020-05-18 15:47:32 +08001881 struct blk_mq_tag_set *tag_set = &shost->tag_set;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001882
Michael Schmitz9393c8de2019-11-05 15:49:10 +13001883 sgl_size = max_t(unsigned int, sizeof(struct scatterlist),
1884 scsi_mq_inline_sgl_size(shost));
Christoph Hellwigd2852032014-01-17 12:06:53 +01001885 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1886 if (scsi_host_get_prot(shost))
Ming Lei92524fa2019-04-28 15:39:31 +08001887 cmd_size += sizeof(struct scsi_data_buffer) +
1888 sizeof(struct scatterlist) * SCSI_INLINE_PROT_SG_CNT;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001889
Ye Bin840e1b52020-05-18 15:47:32 +08001890 memset(tag_set, 0, sizeof(*tag_set));
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001891 if (shost->hostt->commit_rqs)
Ye Bin840e1b52020-05-18 15:47:32 +08001892 tag_set->ops = &scsi_mq_ops;
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001893 else
Ye Bin840e1b52020-05-18 15:47:32 +08001894 tag_set->ops = &scsi_mq_ops_no_commit;
1895 tag_set->nr_hw_queues = shost->nr_hw_queues ? : 1;
1896 tag_set->queue_depth = shost->can_queue;
1897 tag_set->cmd_size = cmd_size;
1898 tag_set->numa_node = NUMA_NO_NODE;
1899 tag_set->flags = BLK_MQ_F_SHOULD_MERGE;
1900 tag_set->flags |=
Shaohua Li24391c02015-01-23 14:18:00 -07001901 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Ye Bin840e1b52020-05-18 15:47:32 +08001902 tag_set->driver_data = shost;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001903
Ye Bin840e1b52020-05-18 15:47:32 +08001904 return blk_mq_alloc_tag_set(tag_set);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001905}
1906
1907void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1908{
1909 blk_mq_free_tag_set(&shost->tag_set);
1910}
1911
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001912/**
1913 * scsi_device_from_queue - return sdev associated with a request_queue
1914 * @q: The request queue to return the sdev from
1915 *
1916 * Return the sdev associated with a request queue or NULL if the
1917 * request_queue does not reference a SCSI device.
1918 */
1919struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1920{
1921 struct scsi_device *sdev = NULL;
1922
Steffen Maier6b6fa7a2019-08-07 16:49:48 +02001923 if (q->mq_ops == &scsi_mq_ops_no_commit ||
1924 q->mq_ops == &scsi_mq_ops)
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001925 sdev = q->queuedata;
1926 if (!sdev || !get_device(&sdev->sdev_gendev))
1927 sdev = NULL;
1928
1929 return sdev;
1930}
1931EXPORT_SYMBOL_GPL(scsi_device_from_queue);
1932
André Almeidaea941012020-04-19 02:01:48 -03001933/**
1934 * scsi_block_requests - Utility function used by low-level drivers to prevent
1935 * further commands from being queued to the device.
1936 * @shost: host in question
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 *
André Almeidaea941012020-04-19 02:01:48 -03001938 * There is no timer nor any other means by which the requests get unblocked
1939 * other than the low-level driver calling scsi_unblock_requests().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 */
1941void scsi_block_requests(struct Scsi_Host *shost)
1942{
1943 shost->host_self_blocked = 1;
1944}
1945EXPORT_SYMBOL(scsi_block_requests);
1946
André Almeidaea941012020-04-19 02:01:48 -03001947/**
1948 * scsi_unblock_requests - Utility function used by low-level drivers to allow
1949 * further commands to be queued to the device.
1950 * @shost: host in question
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 *
André Almeidaea941012020-04-19 02:01:48 -03001952 * There is no timer nor any other means by which the requests get unblocked
1953 * other than the low-level driver calling scsi_unblock_requests(). This is done
1954 * as an API function so that changes to the internals of the scsi mid-layer
1955 * won't require wholesale changes to drivers that use this feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 */
1957void scsi_unblock_requests(struct Scsi_Host *shost)
1958{
1959 shost->host_self_blocked = 0;
1960 scsi_run_host_queues(shost);
1961}
1962EXPORT_SYMBOL(scsi_unblock_requests);
1963
1964int __init scsi_init_queue(void)
1965{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001966 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1967 sizeof(struct scsi_data_buffer),
1968 0, 0, NULL);
1969 if (!scsi_sdb_cache) {
1970 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001971 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001972 }
1973
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 return 0;
1975}
1976
1977void scsi_exit_queue(void)
1978{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03001979 kmem_cache_destroy(scsi_sense_cache);
1980 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001981 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982}
James Bottomley5baba832006-03-18 14:10:35 -06001983
1984/**
1985 * scsi_mode_select - issue a mode select
1986 * @sdev: SCSI device to be queried
1987 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1988 * @sp: Save page bit (0 == don't save, 1 == save)
1989 * @modepage: mode page being requested
1990 * @buffer: request buffer (may not be smaller than eight bytes)
1991 * @len: length of request buffer.
1992 * @timeout: command timeout
1993 * @retries: number of retries before failing
1994 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001995 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001996 * must be SCSI_SENSE_BUFFERSIZE big.
1997 *
1998 * Returns zero if successful; negative error number or scsi
1999 * status on error
2000 *
2001 */
2002int
2003scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2004 unsigned char *buffer, int len, int timeout, int retries,
2005 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2006{
2007 unsigned char cmd[10];
2008 unsigned char *real_buffer;
2009 int ret;
2010
2011 memset(cmd, 0, sizeof(cmd));
2012 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2013
2014 if (sdev->use_10_for_ms) {
2015 if (len > 65535)
2016 return -EINVAL;
2017 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2018 if (!real_buffer)
2019 return -ENOMEM;
2020 memcpy(real_buffer + 8, buffer, len);
2021 len += 8;
2022 real_buffer[0] = 0;
2023 real_buffer[1] = 0;
2024 real_buffer[2] = data->medium_type;
2025 real_buffer[3] = data->device_specific;
2026 real_buffer[4] = data->longlba ? 0x01 : 0;
2027 real_buffer[5] = 0;
2028 real_buffer[6] = data->block_descriptor_length >> 8;
2029 real_buffer[7] = data->block_descriptor_length;
2030
2031 cmd[0] = MODE_SELECT_10;
2032 cmd[7] = len >> 8;
2033 cmd[8] = len;
2034 } else {
2035 if (len > 255 || data->block_descriptor_length > 255 ||
2036 data->longlba)
2037 return -EINVAL;
2038
2039 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2040 if (!real_buffer)
2041 return -ENOMEM;
2042 memcpy(real_buffer + 4, buffer, len);
2043 len += 4;
2044 real_buffer[0] = 0;
2045 real_buffer[1] = data->medium_type;
2046 real_buffer[2] = data->device_specific;
2047 real_buffer[3] = data->block_descriptor_length;
2048
2049
2050 cmd[0] = MODE_SELECT;
2051 cmd[4] = len;
2052 }
2053
2054 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002055 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002056 kfree(real_buffer);
2057 return ret;
2058}
2059EXPORT_SYMBOL_GPL(scsi_mode_select);
2060
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061/**
Rob Landleyeb448202007-11-03 13:30:39 -05002062 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002063 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 * @dbd: set if mode sense will allow block descriptors to be returned
2065 * @modepage: mode page being requested
2066 * @buffer: request buffer (may not be smaller than eight bytes)
2067 * @len: length of request buffer.
2068 * @timeout: command timeout
2069 * @retries: number of retries before failing
2070 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002071 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002072 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 *
2074 * Returns zero if unsuccessful, or the header offset (either 4
2075 * or 8 depending on whether a six or ten byte command was
2076 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002077 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078int
James Bottomley1cf72692005-08-28 11:27:01 -05002079scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002081 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2082{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 unsigned char cmd[12];
2084 int use_10_for_ms;
2085 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002086 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002087 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088
2089 memset(data, 0, sizeof(*data));
2090 memset(&cmd[0], 0, 12);
Can Guo0ec96912019-12-05 02:14:25 +00002091
2092 dbd = sdev->set_dbd_for_ms ? 8 : dbd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2094 cmd[2] = modepage;
2095
James Bottomleyea73a9f2005-08-28 11:33:52 -05002096 /* caller might not be interested in sense, but we need it */
2097 if (!sshdr)
2098 sshdr = &my_sshdr;
2099
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002101 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102
2103 if (use_10_for_ms) {
2104 if (len < 8)
2105 len = 8;
2106
2107 cmd[0] = MODE_SENSE_10;
2108 cmd[8] = len;
2109 header_length = 8;
2110 } else {
2111 if (len < 4)
2112 len = 4;
2113
2114 cmd[0] = MODE_SENSE;
2115 cmd[4] = len;
2116 header_length = 4;
2117 }
2118
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 memset(buffer, 0, len);
2120
James Bottomley1cf72692005-08-28 11:27:01 -05002121 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002122 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123
2124 /* This code looks awful: what it's doing is making sure an
2125 * ILLEGAL REQUEST sense return identifies the actual command
2126 * byte as the problem. MODE_SENSE commands can return
2127 * ILLEGAL REQUEST if the code page isn't supported */
2128
James Bottomley1cf72692005-08-28 11:27:01 -05002129 if (use_10_for_ms && !scsi_status_is_good(result) &&
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002130 driver_byte(result) == DRIVER_SENSE) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002131 if (scsi_sense_valid(sshdr)) {
2132 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2133 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 /*
2135 * Invalid command operation code
2136 */
James Bottomley1cf72692005-08-28 11:27:01 -05002137 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 goto retry;
2139 }
2140 }
2141 }
2142
James Bottomley1cf72692005-08-28 11:27:01 -05002143 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002144 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2145 (modepage == 6 || modepage == 8))) {
2146 /* Initio breakage? */
2147 header_length = 0;
2148 data->length = 13;
2149 data->medium_type = 0;
2150 data->device_specific = 0;
2151 data->longlba = 0;
2152 data->block_descriptor_length = 0;
2153 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 data->length = buffer[0]*256 + buffer[1] + 2;
2155 data->medium_type = buffer[2];
2156 data->device_specific = buffer[3];
2157 data->longlba = buffer[4] & 0x01;
2158 data->block_descriptor_length = buffer[6]*256
2159 + buffer[7];
2160 } else {
2161 data->length = buffer[0] + 1;
2162 data->medium_type = buffer[1];
2163 data->device_specific = buffer[2];
2164 data->block_descriptor_length = buffer[3];
2165 }
Al Viro6d73c852006-02-23 02:03:16 +01002166 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002167 } else if ((status_byte(result) == CHECK_CONDITION) &&
2168 scsi_sense_valid(sshdr) &&
2169 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2170 retry_count--;
2171 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 }
2173
James Bottomley1cf72692005-08-28 11:27:01 -05002174 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175}
2176EXPORT_SYMBOL(scsi_mode_sense);
2177
James Bottomley001aac22007-12-02 19:10:40 +02002178/**
2179 * scsi_test_unit_ready - test if unit is ready
2180 * @sdev: scsi device to change the state of.
2181 * @timeout: command timeout
2182 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002183 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002184 *
2185 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002186 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002187 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188int
James Bottomley001aac22007-12-02 19:10:40 +02002189scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002190 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 char cmd[] = {
2193 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2194 };
2195 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002196
James Bottomley001aac22007-12-02 19:10:40 +02002197 /* try to eat the UNIT_ATTENTION if there are enough retries */
2198 do {
2199 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
Bart Van Assche9b91fd32018-02-12 10:57:52 -08002200 timeout, 1, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002201 if (sdev->removable && scsi_sense_valid(sshdr) &&
2202 sshdr->sense_key == UNIT_ATTENTION)
2203 sdev->changed = 1;
2204 } while (scsi_sense_valid(sshdr) &&
2205 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002206
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 return result;
2208}
2209EXPORT_SYMBOL(scsi_test_unit_ready);
2210
2211/**
Rob Landleyeb448202007-11-03 13:30:39 -05002212 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 * @sdev: scsi device to change the state of.
2214 * @state: state to change to.
2215 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002216 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002218 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219int
2220scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2221{
2222 enum scsi_device_state oldstate = sdev->sdev_state;
2223
2224 if (state == oldstate)
2225 return 0;
2226
2227 switch (state) {
2228 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002229 switch (oldstate) {
2230 case SDEV_CREATED_BLOCK:
2231 break;
2232 default:
2233 goto illegal;
2234 }
2235 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236
2237 case SDEV_RUNNING:
2238 switch (oldstate) {
2239 case SDEV_CREATED:
2240 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002241 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 case SDEV_QUIESCE:
2243 case SDEV_BLOCK:
2244 break;
2245 default:
2246 goto illegal;
2247 }
2248 break;
2249
2250 case SDEV_QUIESCE:
2251 switch (oldstate) {
2252 case SDEV_RUNNING:
2253 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002254 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255 break;
2256 default:
2257 goto illegal;
2258 }
2259 break;
2260
2261 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002262 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 switch (oldstate) {
2264 case SDEV_CREATED:
2265 case SDEV_RUNNING:
2266 case SDEV_QUIESCE:
2267 case SDEV_BLOCK:
2268 break;
2269 default:
2270 goto illegal;
2271 }
2272 break;
2273
2274 case SDEV_BLOCK:
2275 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002277 case SDEV_CREATED_BLOCK:
Dexuan Cui6cbb7ae2020-04-17 17:40:45 -07002278 case SDEV_QUIESCE:
Hannes Reineckea33e5bf2018-10-07 10:35:35 +02002279 case SDEV_OFFLINE:
James Bottomley6f4267e2008-08-22 16:53:31 -05002280 break;
2281 default:
2282 goto illegal;
2283 }
2284 break;
2285
2286 case SDEV_CREATED_BLOCK:
2287 switch (oldstate) {
2288 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 break;
2290 default:
2291 goto illegal;
2292 }
2293 break;
2294
2295 case SDEV_CANCEL:
2296 switch (oldstate) {
2297 case SDEV_CREATED:
2298 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002299 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002301 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 break;
2303 default:
2304 goto illegal;
2305 }
2306 break;
2307
2308 case SDEV_DEL:
2309 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002310 case SDEV_CREATED:
2311 case SDEV_RUNNING:
2312 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002313 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002315 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002316 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 break;
2318 default:
2319 goto illegal;
2320 }
2321 break;
2322
2323 }
Ewan D. Milneb0962c52020-03-11 10:39:30 -04002324 sdev->offline_already = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 sdev->sdev_state = state;
2326 return 0;
2327
2328 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002329 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002330 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002331 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002332 scsi_device_state_name(oldstate),
2333 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 );
2335 return -EINVAL;
2336}
2337EXPORT_SYMBOL(scsi_device_set_state);
2338
2339/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002340 * sdev_evt_emit - emit a single SCSI device uevent
2341 * @sdev: associated SCSI device
2342 * @evt: event to emit
2343 *
2344 * Send a single uevent (scsi_event) to the associated scsi_device.
2345 */
2346static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2347{
2348 int idx = 0;
2349 char *envp[3];
2350
2351 switch (evt->evt_type) {
2352 case SDEV_EVT_MEDIA_CHANGE:
2353 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2354 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002355 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002356 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002357 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2358 break;
2359 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2360 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2361 break;
2362 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2363 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2364 break;
2365 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2366 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2367 break;
2368 case SDEV_EVT_LUN_CHANGE_REPORTED:
2369 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2370 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002371 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2372 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2373 break;
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002374 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2375 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2376 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002377 default:
2378 /* do nothing */
2379 break;
2380 }
2381
2382 envp[idx++] = NULL;
2383
2384 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2385}
2386
2387/**
2388 * sdev_evt_thread - send a uevent for each scsi event
2389 * @work: work struct for scsi_device
2390 *
2391 * Dispatch queued events to their associated scsi_device kobjects
2392 * as uevents.
2393 */
2394void scsi_evt_thread(struct work_struct *work)
2395{
2396 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002397 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002398 LIST_HEAD(event_list);
2399
2400 sdev = container_of(work, struct scsi_device, event_work);
2401
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002402 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2403 if (test_and_clear_bit(evt_type, sdev->pending_events))
2404 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2405
Jeff Garzika341cd02007-10-29 17:15:22 -04002406 while (1) {
2407 struct scsi_event *evt;
2408 struct list_head *this, *tmp;
2409 unsigned long flags;
2410
2411 spin_lock_irqsave(&sdev->list_lock, flags);
2412 list_splice_init(&sdev->event_list, &event_list);
2413 spin_unlock_irqrestore(&sdev->list_lock, flags);
2414
2415 if (list_empty(&event_list))
2416 break;
2417
2418 list_for_each_safe(this, tmp, &event_list) {
2419 evt = list_entry(this, struct scsi_event, node);
2420 list_del(&evt->node);
2421 scsi_evt_emit(sdev, evt);
2422 kfree(evt);
2423 }
2424 }
2425}
2426
2427/**
2428 * sdev_evt_send - send asserted event to uevent thread
2429 * @sdev: scsi_device event occurred on
2430 * @evt: event to send
2431 *
2432 * Assert scsi device event asynchronously.
2433 */
2434void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2435{
2436 unsigned long flags;
2437
Kay Sievers4d1566e2008-03-19 13:04:47 +01002438#if 0
2439 /* FIXME: currently this check eliminates all media change events
2440 * for polled devices. Need to update to discriminate between AN
2441 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002442 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2443 kfree(evt);
2444 return;
2445 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002446#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002447
2448 spin_lock_irqsave(&sdev->list_lock, flags);
2449 list_add_tail(&evt->node, &sdev->event_list);
2450 schedule_work(&sdev->event_work);
2451 spin_unlock_irqrestore(&sdev->list_lock, flags);
2452}
2453EXPORT_SYMBOL_GPL(sdev_evt_send);
2454
2455/**
2456 * sdev_evt_alloc - allocate a new scsi event
2457 * @evt_type: type of event to allocate
2458 * @gfpflags: GFP flags for allocation
2459 *
2460 * Allocates and returns a new scsi_event.
2461 */
2462struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2463 gfp_t gfpflags)
2464{
2465 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2466 if (!evt)
2467 return NULL;
2468
2469 evt->evt_type = evt_type;
2470 INIT_LIST_HEAD(&evt->node);
2471
2472 /* evt_type-specific initialization, if any */
2473 switch (evt_type) {
2474 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002475 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2476 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2477 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2478 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2479 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002480 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002481 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002482 default:
2483 /* do nothing */
2484 break;
2485 }
2486
2487 return evt;
2488}
2489EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2490
2491/**
2492 * sdev_evt_send_simple - send asserted event to uevent thread
2493 * @sdev: scsi_device event occurred on
2494 * @evt_type: type of event to send
2495 * @gfpflags: GFP flags for allocation
2496 *
2497 * Assert scsi device event asynchronously, given an event type.
2498 */
2499void sdev_evt_send_simple(struct scsi_device *sdev,
2500 enum scsi_device_event evt_type, gfp_t gfpflags)
2501{
2502 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2503 if (!evt) {
2504 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2505 evt_type);
2506 return;
2507 }
2508
2509 sdev_evt_send(sdev, evt);
2510}
2511EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2512
2513/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 * scsi_device_quiesce - Block user issued commands.
2515 * @sdev: scsi device to quiesce.
2516 *
2517 * This works by trying to transition to the SDEV_QUIESCE state
2518 * (which must be a legal transition). When the device is in this
2519 * state, only special requests will be accepted, all others will
2520 * be deferred. Since special requests may also be requeued requests,
2521 * a successful return doesn't guarantee the device will be
2522 * totally quiescent.
2523 *
2524 * Must be called with user context, may sleep.
2525 *
2526 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002527 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528int
2529scsi_device_quiesce(struct scsi_device *sdev)
2530{
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002531 struct request_queue *q = sdev->request_queue;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002532 int err;
2533
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002534 /*
2535 * It is allowed to call scsi_device_quiesce() multiple times from
2536 * the same context but concurrent scsi_device_quiesce() calls are
2537 * not allowed.
2538 */
2539 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2540
Bart Van Asschecd84a622018-09-26 14:01:04 -07002541 if (sdev->quiesced_by == current)
2542 return 0;
2543
2544 blk_set_pm_only(q);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002545
2546 blk_mq_freeze_queue(q);
2547 /*
Bart Van Asschecd84a622018-09-26 14:01:04 -07002548 * Ensure that the effect of blk_set_pm_only() will be visible
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002549 * for percpu_ref_tryget() callers that occur after the queue
2550 * unfreeze even if the queue was already frozen before this function
2551 * was called. See also https://lwn.net/Articles/573497/.
2552 */
2553 synchronize_rcu();
2554 blk_mq_unfreeze_queue(q);
2555
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002556 mutex_lock(&sdev->state_mutex);
2557 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002558 if (err == 0)
2559 sdev->quiesced_by = current;
2560 else
Bart Van Asschecd84a622018-09-26 14:01:04 -07002561 blk_clear_pm_only(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002562 mutex_unlock(&sdev->state_mutex);
2563
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002564 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565}
2566EXPORT_SYMBOL(scsi_device_quiesce);
2567
2568/**
2569 * scsi_device_resume - Restart user issued commands to a quiesced device.
2570 * @sdev: scsi device to resume.
2571 *
2572 * Moves the device from quiesced back to running and restarts the
2573 * queues.
2574 *
2575 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002576 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002577void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002579 /* check if the device state was mutated prior to resume, and if
2580 * so assume the state is being managed elsewhere (for example
2581 * device deleted during suspend)
2582 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002583 mutex_lock(&sdev->state_mutex);
Bart Van Assche17605af2019-03-15 16:27:58 -07002584 if (sdev->quiesced_by) {
2585 sdev->quiesced_by = NULL;
2586 blk_clear_pm_only(sdev->request_queue);
2587 }
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002588 if (sdev->sdev_state == SDEV_QUIESCE)
2589 scsi_device_set_state(sdev, SDEV_RUNNING);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002590 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591}
2592EXPORT_SYMBOL(scsi_device_resume);
2593
2594static void
2595device_quiesce_fn(struct scsi_device *sdev, void *data)
2596{
2597 scsi_device_quiesce(sdev);
2598}
2599
2600void
2601scsi_target_quiesce(struct scsi_target *starget)
2602{
2603 starget_for_each_device(starget, NULL, device_quiesce_fn);
2604}
2605EXPORT_SYMBOL(scsi_target_quiesce);
2606
2607static void
2608device_resume_fn(struct scsi_device *sdev, void *data)
2609{
2610 scsi_device_resume(sdev);
2611}
2612
2613void
2614scsi_target_resume(struct scsi_target *starget)
2615{
2616 starget_for_each_device(starget, NULL, device_resume_fn);
2617}
2618EXPORT_SYMBOL(scsi_target_resume);
2619
2620/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002621 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2622 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002624 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002626 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002628 * Notes:
2629 * This routine transitions the device to the SDEV_BLOCK state (which must be
2630 * a legal transition). When the device is in this state, command processing
2631 * is paused until the device leaves the SDEV_BLOCK state. See also
2632 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002633 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002634int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635{
Jens Axboe165125e2007-07-24 09:28:11 +02002636 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002637 int err = 0;
2638
2639 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002640 if (err) {
2641 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2642
2643 if (err)
2644 return err;
2645 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646
2647 /*
2648 * The device has transitioned to SDEV_BLOCK. Stop the
2649 * block layer from calling the midlayer with this device's
2650 * request queue.
2651 */
Jens Axboef664a3c2018-11-01 16:36:27 -06002652 blk_mq_quiesce_queue_nowait(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653 return 0;
2654}
Bart Van Assche551eb592017-06-02 14:21:53 -07002655EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2656
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002658 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2659 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002661 * Pause SCSI command processing on the specified device and wait until all
2662 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002664 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002666 * Note:
2667 * This routine transitions the device to the SDEV_BLOCK state (which must be
2668 * a legal transition). When the device is in this state, command processing
2669 * is paused until the device leaves the SDEV_BLOCK state. See also
2670 * scsi_internal_device_unblock().
Rob Landleyeb448202007-11-03 13:30:39 -05002671 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002672static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673{
Bart Van Assche551eb592017-06-02 14:21:53 -07002674 struct request_queue *q = sdev->request_queue;
2675 int err;
2676
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002677 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07002678 err = scsi_internal_device_block_nowait(sdev);
Jens Axboef664a3c2018-11-01 16:36:27 -06002679 if (err == 0)
2680 blk_mq_quiesce_queue(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002681 mutex_unlock(&sdev->state_mutex);
2682
Bart Van Assche551eb592017-06-02 14:21:53 -07002683 return err;
2684}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685
Bart Van Assche66483a42017-06-02 14:21:56 -07002686void scsi_start_queue(struct scsi_device *sdev)
2687{
2688 struct request_queue *q = sdev->request_queue;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002689
Jens Axboef664a3c2018-11-01 16:36:27 -06002690 blk_mq_unquiesce_queue(q);
Bart Van Assche66483a42017-06-02 14:21:56 -07002691}
2692
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693/**
Bart Van Assche43f75712017-06-02 14:21:54 -07002694 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07002696 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002698 * Restart the device queue for a previously suspended SCSI device. Does not
2699 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002701 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002703 * Notes:
2704 * This routine transitions the device to the SDEV_RUNNING state or to one of
2705 * the offline states (which must be a legal transition) allowing the midlayer
2706 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002707 */
Bart Van Assche43f75712017-06-02 14:21:54 -07002708int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2709 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710{
Bart Van Assche09addb12019-08-01 15:38:12 -07002711 switch (new_state) {
2712 case SDEV_RUNNING:
2713 case SDEV_TRANSPORT_OFFLINE:
2714 break;
2715 default:
2716 return -EINVAL;
2717 }
2718
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002719 /*
2720 * Try to transition the scsi device to SDEV_RUNNING or one of the
2721 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002723 switch (sdev->sdev_state) {
2724 case SDEV_BLOCK:
2725 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002726 sdev->sdev_state = new_state;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002727 break;
2728 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002729 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2730 new_state == SDEV_OFFLINE)
2731 sdev->sdev_state = new_state;
2732 else
2733 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002734 break;
2735 case SDEV_CANCEL:
2736 case SDEV_OFFLINE:
2737 break;
2738 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002739 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002740 }
Bart Van Assche66483a42017-06-02 14:21:56 -07002741 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742
2743 return 0;
2744}
Bart Van Assche43f75712017-06-02 14:21:54 -07002745EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2746
2747/**
2748 * scsi_internal_device_unblock - resume a device after a block request
2749 * @sdev: device to resume
2750 * @new_state: state to set the device to after unblocking
2751 *
2752 * Restart the device queue for a previously suspended SCSI device. May sleep.
2753 *
2754 * Returns zero if successful or a negative error code upon failure.
2755 *
2756 * Notes:
2757 * This routine transitions the device to the SDEV_RUNNING state or to one of
2758 * the offline states (which must be a legal transition) allowing the midlayer
2759 * to goose the queue for this device.
2760 */
2761static int scsi_internal_device_unblock(struct scsi_device *sdev,
2762 enum scsi_device_state new_state)
2763{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002764 int ret;
2765
2766 mutex_lock(&sdev->state_mutex);
2767 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2768 mutex_unlock(&sdev->state_mutex);
2769
2770 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07002771}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772
2773static void
2774device_block(struct scsi_device *sdev, void *data)
2775{
Bart Van Assche94ef80a2019-08-01 15:38:13 -07002776 int ret;
2777
2778 ret = scsi_internal_device_block(sdev);
2779
2780 WARN_ONCE(ret, "scsi_internal_device_block(%s) failed: ret = %d\n",
2781 dev_name(&sdev->sdev_gendev), ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002782}
2783
2784static int
2785target_block(struct device *dev, void *data)
2786{
2787 if (scsi_is_target_device(dev))
2788 starget_for_each_device(to_scsi_target(dev), NULL,
2789 device_block);
2790 return 0;
2791}
2792
2793void
2794scsi_target_block(struct device *dev)
2795{
2796 if (scsi_is_target_device(dev))
2797 starget_for_each_device(to_scsi_target(dev), NULL,
2798 device_block);
2799 else
2800 device_for_each_child(dev, NULL, target_block);
2801}
2802EXPORT_SYMBOL_GPL(scsi_target_block);
2803
2804static void
2805device_unblock(struct scsi_device *sdev, void *data)
2806{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002807 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808}
2809
2810static int
2811target_unblock(struct device *dev, void *data)
2812{
2813 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002814 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002815 device_unblock);
2816 return 0;
2817}
2818
2819void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002820scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821{
2822 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002823 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824 device_unblock);
2825 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002826 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827}
2828EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002829
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002830int
2831scsi_host_block(struct Scsi_Host *shost)
2832{
2833 struct scsi_device *sdev;
2834 int ret = 0;
2835
Ming Leif9836222020-04-23 10:07:13 +08002836 /*
2837 * Call scsi_internal_device_block_nowait so we can avoid
2838 * calling synchronize_rcu() for each LUN.
2839 */
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002840 shost_for_each_device(sdev, shost) {
Ming Leif9836222020-04-23 10:07:13 +08002841 mutex_lock(&sdev->state_mutex);
2842 ret = scsi_internal_device_block_nowait(sdev);
2843 mutex_unlock(&sdev->state_mutex);
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002844 if (ret)
2845 break;
2846 }
Ming Leif9836222020-04-23 10:07:13 +08002847
2848 /*
2849 * SCSI never enables blk-mq's BLK_MQ_F_BLOCKING flag so
2850 * calling synchronize_rcu() once is enough.
2851 */
2852 WARN_ON_ONCE(shost->tag_set.flags & BLK_MQ_F_BLOCKING);
2853
2854 if (!ret)
2855 synchronize_rcu();
2856
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002857 return ret;
2858}
2859EXPORT_SYMBOL_GPL(scsi_host_block);
2860
2861int
2862scsi_host_unblock(struct Scsi_Host *shost, int new_state)
2863{
2864 struct scsi_device *sdev;
2865 int ret = 0;
2866
2867 shost_for_each_device(sdev, shost) {
2868 ret = scsi_internal_device_unblock(sdev, new_state);
Ye Bin4dea1702020-05-18 15:44:20 +08002869 if (ret) {
2870 scsi_device_put(sdev);
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002871 break;
Ye Bin4dea1702020-05-18 15:44:20 +08002872 }
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002873 }
2874 return ret;
2875}
2876EXPORT_SYMBOL_GPL(scsi_host_unblock);
2877
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002878/**
2879 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002880 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002881 * @sg_count: number of segments in sg
2882 * @offset: offset in bytes into sg, on return offset into the mapped area
2883 * @len: bytes to map, on return number of bytes mapped
2884 *
2885 * Returns virtual address of the start of the mapped page
2886 */
Jens Axboec6132da2007-10-16 11:08:49 +02002887void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002888 size_t *offset, size_t *len)
2889{
2890 int i;
2891 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002892 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002893 struct page *page;
2894
Andrew Morton22cfefb2007-02-05 16:39:03 -08002895 WARN_ON(!irqs_disabled());
2896
Jens Axboec6132da2007-10-16 11:08:49 +02002897 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002898 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002899 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002900 if (sg_len > *offset)
2901 break;
2902 }
2903
2904 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002905 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2906 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002907 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002908 WARN_ON(1);
2909 return NULL;
2910 }
2911
2912 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002913 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002914
2915 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002916 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002917 *offset &= ~PAGE_MASK;
2918
2919 /* Bytes in this sg-entry from *offset to the end of the page */
2920 sg_len = PAGE_SIZE - *offset;
2921 if (*len > sg_len)
2922 *len = sg_len;
2923
Cong Wang77dfce02011-11-25 23:14:23 +08002924 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002925}
2926EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2927
2928/**
Rob Landleyeb448202007-11-03 13:30:39 -05002929 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002930 * @virt: virtual address to be unmapped
2931 */
2932void scsi_kunmap_atomic_sg(void *virt)
2933{
Cong Wang77dfce02011-11-25 23:14:23 +08002934 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002935}
2936EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002937
2938void sdev_disable_disk_events(struct scsi_device *sdev)
2939{
2940 atomic_inc(&sdev->disk_events_disable_depth);
2941}
2942EXPORT_SYMBOL(sdev_disable_disk_events);
2943
2944void sdev_enable_disk_events(struct scsi_device *sdev)
2945{
2946 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2947 return;
2948 atomic_dec(&sdev->disk_events_disable_depth);
2949}
2950EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002951
2952/**
2953 * scsi_vpd_lun_id - return a unique device identification
2954 * @sdev: SCSI device
2955 * @id: buffer for the identification
2956 * @id_len: length of the buffer
2957 *
2958 * Copies a unique device identification into @id based
2959 * on the information in the VPD page 0x83 of the device.
2960 * The string will be formatted as a SCSI name string.
2961 *
2962 * Returns the length of the identification or error on failure.
2963 * If the identifier is longer than the supplied buffer the actual
2964 * identifier length is returned and the buffer is not zero-padded.
2965 */
2966int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
2967{
2968 u8 cur_id_type = 0xff;
2969 u8 cur_id_size = 0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002970 const unsigned char *d, *cur_id_str;
2971 const struct scsi_vpd *vpd_pg83;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002972 int id_size = -EINVAL;
2973
2974 rcu_read_lock();
2975 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
2976 if (!vpd_pg83) {
2977 rcu_read_unlock();
2978 return -ENXIO;
2979 }
2980
2981 /*
2982 * Look for the correct descriptor.
2983 * Order of preference for lun descriptor:
2984 * - SCSI name string
2985 * - NAA IEEE Registered Extended
2986 * - EUI-64 based 16-byte
2987 * - EUI-64 based 12-byte
2988 * - NAA IEEE Registered
2989 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02002990 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002991 * as longer descriptors reduce the likelyhood
2992 * of identification clashes.
2993 */
2994
2995 /* The id string must be at least 20 bytes + terminating NULL byte */
2996 if (id_len < 21) {
2997 rcu_read_unlock();
2998 return -EINVAL;
2999 }
3000
3001 memset(id, 0, id_len);
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003002 d = vpd_pg83->data + 4;
3003 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003004 /* Skip designators not referring to the LUN */
3005 if ((d[1] & 0x30) != 0x00)
3006 goto next_desig;
3007
3008 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02003009 case 0x1:
3010 /* T10 Vendor ID */
3011 if (cur_id_size > d[3])
3012 break;
3013 /* Prefer anything */
3014 if (cur_id_type > 0x01 && cur_id_type != 0xff)
3015 break;
3016 cur_id_size = d[3];
3017 if (cur_id_size + 4 > id_len)
3018 cur_id_size = id_len - 4;
3019 cur_id_str = d + 4;
3020 cur_id_type = d[1] & 0xf;
3021 id_size = snprintf(id, id_len, "t10.%*pE",
3022 cur_id_size, cur_id_str);
3023 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003024 case 0x2:
3025 /* EUI-64 */
3026 if (cur_id_size > d[3])
3027 break;
3028 /* Prefer NAA IEEE Registered Extended */
3029 if (cur_id_type == 0x3 &&
3030 cur_id_size == d[3])
3031 break;
3032 cur_id_size = d[3];
3033 cur_id_str = d + 4;
3034 cur_id_type = d[1] & 0xf;
3035 switch (cur_id_size) {
3036 case 8:
3037 id_size = snprintf(id, id_len,
3038 "eui.%8phN",
3039 cur_id_str);
3040 break;
3041 case 12:
3042 id_size = snprintf(id, id_len,
3043 "eui.%12phN",
3044 cur_id_str);
3045 break;
3046 case 16:
3047 id_size = snprintf(id, id_len,
3048 "eui.%16phN",
3049 cur_id_str);
3050 break;
3051 default:
3052 cur_id_size = 0;
3053 break;
3054 }
3055 break;
3056 case 0x3:
3057 /* NAA */
3058 if (cur_id_size > d[3])
3059 break;
3060 cur_id_size = d[3];
3061 cur_id_str = d + 4;
3062 cur_id_type = d[1] & 0xf;
3063 switch (cur_id_size) {
3064 case 8:
3065 id_size = snprintf(id, id_len,
3066 "naa.%8phN",
3067 cur_id_str);
3068 break;
3069 case 16:
3070 id_size = snprintf(id, id_len,
3071 "naa.%16phN",
3072 cur_id_str);
3073 break;
3074 default:
3075 cur_id_size = 0;
3076 break;
3077 }
3078 break;
3079 case 0x8:
3080 /* SCSI name string */
3081 if (cur_id_size + 4 > d[3])
3082 break;
3083 /* Prefer others for truncated descriptor */
3084 if (cur_id_size && d[3] > id_len)
3085 break;
3086 cur_id_size = id_size = d[3];
3087 cur_id_str = d + 4;
3088 cur_id_type = d[1] & 0xf;
3089 if (cur_id_size >= id_len)
3090 cur_id_size = id_len - 1;
3091 memcpy(id, cur_id_str, cur_id_size);
3092 /* Decrease priority for truncated descriptor */
3093 if (cur_id_size != id_size)
3094 cur_id_size = 6;
3095 break;
3096 default:
3097 break;
3098 }
3099next_desig:
3100 d += d[3] + 4;
3101 }
3102 rcu_read_unlock();
3103
3104 return id_size;
3105}
3106EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003107
3108/*
3109 * scsi_vpd_tpg_id - return a target port group identifier
3110 * @sdev: SCSI device
3111 *
3112 * Returns the Target Port Group identifier from the information
3113 * froom VPD page 0x83 of the device.
3114 *
3115 * Returns the identifier or error on failure.
3116 */
3117int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3118{
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003119 const unsigned char *d;
3120 const struct scsi_vpd *vpd_pg83;
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003121 int group_id = -EAGAIN, rel_port = -1;
3122
3123 rcu_read_lock();
3124 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3125 if (!vpd_pg83) {
3126 rcu_read_unlock();
3127 return -ENXIO;
3128 }
3129
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003130 d = vpd_pg83->data + 4;
3131 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003132 switch (d[1] & 0xf) {
3133 case 0x4:
3134 /* Relative target port */
3135 rel_port = get_unaligned_be16(&d[6]);
3136 break;
3137 case 0x5:
3138 /* Target port group */
3139 group_id = get_unaligned_be16(&d[6]);
3140 break;
3141 default:
3142 break;
3143 }
3144 d += d[3] + 4;
3145 }
3146 rcu_read_unlock();
3147
3148 if (group_id >= 0 && rel_id && rel_port != -1)
3149 *rel_id = rel_port;
3150
3151 return group_id;
3152}
3153EXPORT_SYMBOL(scsi_vpd_tpg_id);