blob: 55a1a060cd11ff4462476c655dc8e2666572b55d [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 Hellwig0a6ac4e2017-01-03 08:28:41 +030055static struct kmem_cache *scsi_sense_cache;
56static struct kmem_cache *scsi_sense_isadma_cache;
57static DEFINE_MUTEX(scsi_sense_cache_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
Bart Van Asschea45a1f362017-08-30 16:58:42 -070059static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd);
60
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030061static inline struct kmem_cache *
Bart Van Assche8e688252017-06-02 14:21:52 -070062scsi_select_sense_cache(bool unchecked_isa_dma)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030063{
Bart Van Assche8e688252017-06-02 14:21:52 -070064 return unchecked_isa_dma ? scsi_sense_isadma_cache : scsi_sense_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030065}
66
Bart Van Assche8e688252017-06-02 14:21:52 -070067static void scsi_free_sense_buffer(bool unchecked_isa_dma,
68 unsigned char *sense_buffer)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030069{
Bart Van Assche8e688252017-06-02 14:21:52 -070070 kmem_cache_free(scsi_select_sense_cache(unchecked_isa_dma),
71 sense_buffer);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030072}
73
Bart Van Assche8e688252017-06-02 14:21:52 -070074static unsigned char *scsi_alloc_sense_buffer(bool unchecked_isa_dma,
Christoph Hellwige9c787e2017-01-02 21:55:26 +030075 gfp_t gfp_mask, int numa_node)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030076{
Bart Van Assche8e688252017-06-02 14:21:52 -070077 return kmem_cache_alloc_node(scsi_select_sense_cache(unchecked_isa_dma),
78 gfp_mask, numa_node);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030079}
80
81int scsi_init_sense_cache(struct Scsi_Host *shost)
82{
83 struct kmem_cache *cache;
84 int ret = 0;
85
Ming Leif9b05302019-07-12 10:08:19 +080086 mutex_lock(&scsi_sense_cache_mutex);
Bart Van Assche8e688252017-06-02 14:21:52 -070087 cache = scsi_select_sense_cache(shost->unchecked_isa_dma);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030088 if (cache)
Ming Leif9b05302019-07-12 10:08:19 +080089 goto exit;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030090
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030091 if (shost->unchecked_isa_dma) {
92 scsi_sense_isadma_cache =
93 kmem_cache_create("scsi_sense_cache(DMA)",
David Windsor0afe76e2017-06-10 22:50:45 -040094 SCSI_SENSE_BUFFERSIZE, 0,
95 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030096 if (!scsi_sense_isadma_cache)
97 ret = -ENOMEM;
98 } else {
99 scsi_sense_cache =
David Windsor0afe76e2017-06-10 22:50:45 -0400100 kmem_cache_create_usercopy("scsi_sense_cache",
101 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN,
102 0, SCSI_SENSE_BUFFERSIZE, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +0300103 if (!scsi_sense_cache)
104 ret = -ENOMEM;
105 }
Ming Leif9b05302019-07-12 10:08:19 +0800106 exit:
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +0300107 mutex_unlock(&scsi_sense_cache_mutex);
108 return ret;
109}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200110
Jens Axboea488e742010-04-16 21:13:15 +0200111/*
112 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
113 * not change behaviour from the previous unplug mechanism, experimentation
114 * may prove this needs changing.
115 */
116#define SCSI_QUEUE_DELAY 3
117
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100118static void
119scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120{
121 struct Scsi_Host *host = cmd->device->host;
122 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500123 struct scsi_target *starget = scsi_target(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900126 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 *
128 * If the host/device isn't busy, assume that something actually
129 * completed, and that we should be able to queue a command now.
130 *
131 * Note that the prior mid-layer assumption that any host could
132 * always queue at least one command is now broken. The mid-layer
133 * will implement a user specifiable stall (see
134 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
135 * if a command is requeued with no other commands outstanding
136 * either for the device or for the host.
137 */
Mike Christief0c0a372008-08-17 15:24:38 -0500138 switch (reason) {
139 case SCSI_MLQUEUE_HOST_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100140 atomic_set(&host->host_blocked, host->max_host_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500141 break;
142 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400143 case SCSI_MLQUEUE_EH_RETRY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100144 atomic_set(&device->device_blocked,
145 device->max_device_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500146 break;
147 case SCSI_MLQUEUE_TARGET_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100148 atomic_set(&starget->target_blocked,
149 starget->max_target_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500150 break;
151 }
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100152}
153
Christoph Hellwigd2852032014-01-17 12:06:53 +0100154static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
155{
Bart Van Asschea45a1f362017-08-30 16:58:42 -0700156 if (cmd->request->rq_flags & RQF_DONTPREP) {
157 cmd->request->rq_flags &= ~RQF_DONTPREP;
158 scsi_mq_uninit_cmd(cmd);
159 } else {
160 WARN_ON_ONCE(true);
161 }
Bart Van Assche2b053ac2016-10-28 17:21:41 -0700162 blk_mq_requeue_request(cmd->request, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100163}
164
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100165/**
166 * __scsi_queue_insert - private queue insertion
167 * @cmd: The SCSI command being requeued
168 * @reason: The reason for the requeue
169 * @unbusy: Whether the queue should be unbusied
170 *
171 * This is a private queue insertion. The public interface
172 * scsi_queue_insert() always assumes the queue should be unbusied
173 * because it's always called before the completion. This function is
174 * for a requeue after completion, which should only occur in this
175 * file.
176 */
Bart Van Assche08640e82018-01-10 14:41:45 -0800177static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, bool unbusy)
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100178{
179 struct scsi_device *device = cmd->device;
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100180
181 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
182 "Inserting command %p into mlqueue\n", cmd));
183
184 scsi_set_blocked(cmd, reason);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 * Decrement the counters, since these commands are no longer
188 * active on the host/device.
189 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600190 if (unbusy)
Ming Lei6eb045e2019-10-25 14:58:55 +0800191 scsi_device_unbusy(device, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
193 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500194 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000195 * that are already in the queue. Schedule requeue work under
196 * lock such that the kblockd_schedule_work() call happens
197 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200198 */
Alan Stern644373a2014-03-28 10:51:15 -0700199 cmd->result = 0;
Jens Axboef664a3c2018-11-01 16:36:27 -0600200
Jens Axboef664a3c2018-11-01 16:36:27 -0600201 blk_mq_requeue_request(cmd->request, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202}
203
André Almeidaea941012020-04-19 02:01:48 -0300204/**
205 * scsi_queue_insert - Reinsert a command in the queue.
206 * @cmd: command that we are adding to queue.
207 * @reason: why we are inserting command to queue.
James Bottomley4f5299a2009-01-02 10:42:21 -0600208 *
André Almeidaea941012020-04-19 02:01:48 -0300209 * We do this for one of two cases. Either the host is busy and it cannot accept
210 * any more commands for the time being, or the device returned QUEUE_FULL and
211 * can accept no more commands.
James Bottomley4f5299a2009-01-02 10:42:21 -0600212 *
André Almeidaea941012020-04-19 02:01:48 -0300213 * Context: This could be called either from an interrupt context or a normal
214 * process context.
James Bottomley4f5299a2009-01-02 10:42:21 -0600215 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000216void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600217{
Bart Van Assche08640e82018-01-10 14:41:45 -0800218 __scsi_queue_insert(cmd, reason, true);
James Bottomley4f5299a2009-01-02 10:42:21 -0600219}
Christoph Hellwige8064022016-10-20 15:12:13 +0200220
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100221
222/**
Kees Cook704f8392018-07-31 12:51:54 -0700223 * __scsi_execute - insert request and wait for the result
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100224 * @sdev: scsi device
225 * @cmd: scsi command
226 * @data_direction: data direction
227 * @buffer: data buffer
228 * @bufflen: len of buffer
229 * @sense: optional sense buffer
230 * @sshdr: optional decoded sense header
231 * @timeout: request timeout in seconds
232 * @retries: number of times to retry request
233 * @flags: flags for ->cmd_flags
234 * @rq_flags: flags for ->rq_flags
235 * @resid: optional residual length
236 *
Christoph Hellwig17d53632017-04-20 16:03:01 +0200237 * Returns the scsi_cmnd result field if a command was executed, or a negative
238 * Linux error code if we didn't get that far.
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100239 */
Kees Cook704f8392018-07-31 12:51:54 -0700240int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500241 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100242 unsigned char *sense, struct scsi_sense_hdr *sshdr,
243 int timeout, int retries, u64 flags, req_flags_t rq_flags,
244 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500245{
246 struct request *req;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100247 struct scsi_request *rq;
James Bottomley39216032005-06-15 18:48:29 -0500248 int ret = DRIVER_ERROR << 24;
249
Christoph Hellwigff005a02018-05-09 09:54:05 +0200250 req = blk_get_request(sdev->request_queue,
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100251 data_direction == DMA_TO_DEVICE ?
Bart Van Assche039c6352017-11-09 10:49:56 -0800252 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, BLK_MQ_REQ_PREEMPT);
Joe Lawrencea492f072014-08-28 08:15:21 -0600253 if (IS_ERR(req))
James Bottomleybfe159a2011-07-07 15:45:40 -0500254 return ret;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100255 rq = scsi_req(req);
James Bottomley39216032005-06-15 18:48:29 -0500256
257 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
Christoph Hellwig0eb0b632018-05-09 09:54:08 +0200258 buffer, bufflen, GFP_NOIO))
James Bottomley39216032005-06-15 18:48:29 -0500259 goto out;
260
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100261 rq->cmd_len = COMMAND_SIZE(cmd[0]);
262 memcpy(rq->cmd, cmd, rq->cmd_len);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200263 rq->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500264 req->timeout = timeout;
Christoph Hellwige8064022016-10-20 15:12:13 +0200265 req->cmd_flags |= flags;
Bart Van Assche039c6352017-11-09 10:49:56 -0800266 req->rq_flags |= rq_flags | RQF_QUIET;
James Bottomley39216032005-06-15 18:48:29 -0500267
268 /*
269 * head injection *required* here otherwise quiesce won't work
270 */
271 blk_execute_rq(req->q, NULL, req, 1);
272
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400273 /*
274 * Some devices (USB mass-storage in particular) may transfer
275 * garbage data together with a residue indicating that the data
276 * is invalid. Prevent the garbage from being misinterpreted
277 * and prevent security leaks by zeroing out the excess data.
278 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100279 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
280 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400281
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900282 if (resid)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100283 *resid = rq->resid_len;
284 if (sense && rq->sense_len)
285 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100286 if (sshdr)
287 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
Christoph Hellwig17d53632017-04-20 16:03:01 +0200288 ret = rq->result;
James Bottomley39216032005-06-15 18:48:29 -0500289 out:
290 blk_put_request(req);
291
292 return ret;
293}
Kees Cook704f8392018-07-31 12:51:54 -0700294EXPORT_SYMBOL(__scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500295
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800296/*
Ming Lei6eb045e2019-10-25 14:58:55 +0800297 * Wake up the error handler if necessary. Avoid as follows that the error
298 * handler is not woken up if host in-flight requests number ==
299 * shost->host_failed: use call_rcu() in scsi_eh_scmd_add() in combination
300 * with an RCU read lock in this function to ensure that this function in
301 * its entirety either finishes before scsi_eh_scmd_add() increases the
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800302 * host_failed counter or that it notices the shost state change made by
303 * scsi_eh_scmd_add().
304 */
Ming Lei6eb045e2019-10-25 14:58:55 +0800305static void scsi_dec_host_busy(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800306{
307 unsigned long flags;
308
309 rcu_read_lock();
Ming Lei6eb045e2019-10-25 14:58:55 +0800310 __clear_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800311 if (unlikely(scsi_host_in_recovery(shost))) {
312 spin_lock_irqsave(shost->host_lock, flags);
313 if (shost->host_failed || shost->host_eh_scheduled)
314 scsi_eh_wakeup(shost);
315 spin_unlock_irqrestore(shost->host_lock, flags);
316 }
317 rcu_read_unlock();
318}
319
Ming Lei6eb045e2019-10-25 14:58:55 +0800320void scsi_device_unbusy(struct scsi_device *sdev, struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321{
322 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500323 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
Ming Lei6eb045e2019-10-25 14:58:55 +0800325 scsi_dec_host_busy(shost, cmd);
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800326
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100327 if (starget->can_queue > 0)
328 atomic_dec(&starget->target_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +0100329
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200330 atomic_dec(&sdev->device_busy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331}
332
Christoph Hellwigd2852032014-01-17 12:06:53 +0100333static void scsi_kick_queue(struct request_queue *q)
334{
Jens Axboef664a3c2018-11-01 16:36:27 -0600335 blk_mq_run_hw_queues(q, false);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100336}
337
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338/*
339 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
340 * and call blk_run_queue for all the scsi_devices on the target -
341 * including current_sdev first.
342 *
343 * Called with *no* scsi locks held.
344 */
345static void scsi_single_lun_run(struct scsi_device *current_sdev)
346{
347 struct Scsi_Host *shost = current_sdev->host;
348 struct scsi_device *sdev, *tmp;
349 struct scsi_target *starget = scsi_target(current_sdev);
350 unsigned long flags;
351
352 spin_lock_irqsave(shost->host_lock, flags);
353 starget->starget_sdev_user = NULL;
354 spin_unlock_irqrestore(shost->host_lock, flags);
355
356 /*
357 * Call blk_run_queue for all LUNs on the target, starting with
358 * current_sdev. We race with others (to set starget_sdev_user),
359 * but in most cases, we will be first. Ideally, each LU on the
360 * target would get some limited time or requests on the target.
361 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100362 scsi_kick_queue(current_sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
364 spin_lock_irqsave(shost->host_lock, flags);
365 if (starget->starget_sdev_user)
366 goto out;
367 list_for_each_entry_safe(sdev, tmp, &starget->devices,
368 same_target_siblings) {
369 if (sdev == current_sdev)
370 continue;
371 if (scsi_device_get(sdev))
372 continue;
373
374 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100375 scsi_kick_queue(sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 spin_lock_irqsave(shost->host_lock, flags);
Bean Huo4c7b4d62020-06-19 17:41:17 +0200377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 scsi_device_put(sdev);
379 }
380 out:
381 spin_unlock_irqrestore(shost->host_lock, flags);
382}
383
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100384static inline bool scsi_device_is_busy(struct scsi_device *sdev)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400385{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100386 if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
387 return true;
388 if (atomic_read(&sdev->device_blocked) > 0)
389 return true;
390 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400391}
392
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100393static inline bool scsi_target_is_busy(struct scsi_target *starget)
Mike Christief0c0a372008-08-17 15:24:38 -0500394{
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100395 if (starget->can_queue > 0) {
396 if (atomic_read(&starget->target_busy) >= starget->can_queue)
397 return true;
398 if (atomic_read(&starget->target_blocked) > 0)
399 return true;
400 }
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100401 return false;
Mike Christief0c0a372008-08-17 15:24:38 -0500402}
403
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100404static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400405{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100406 if (atomic_read(&shost->host_blocked) > 0)
407 return true;
408 if (shost->host_self_blocked)
409 return true;
410 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400411}
412
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800413static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600415 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800416 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 unsigned long flags;
418
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600420 list_splice_init(&shost->starved_list, &starved_list);
421
422 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200423 struct request_queue *slq;
424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 /*
426 * As long as shost is accepting commands and we have
427 * starved queues, call blk_run_queue. scsi_request_fn
428 * drops the queue_lock and can add us back to the
429 * starved_list.
430 *
431 * host_lock protects the starved_list and starved_entry.
432 * scsi_request_fn must get the host_lock before checking
433 * or modifying starved_list or starved_entry.
434 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600435 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500436 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500437
Mike Christie2a3a59e2008-11-11 13:42:35 -0600438 sdev = list_entry(starved_list.next,
439 struct scsi_device, starved_entry);
440 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500441 if (scsi_target_is_busy(scsi_target(sdev))) {
442 list_move_tail(&sdev->starved_entry,
443 &shost->starved_list);
444 continue;
445 }
446
James Bottomleye2eb7242013-07-02 15:05:26 +0200447 /*
448 * Once we drop the host lock, a racing scsi_remove_device()
449 * call may remove the sdev from the starved list and destroy
450 * it and the queue. Mitigate by taking a reference to the
451 * queue and never touching the sdev again after we drop the
452 * host lock. Note: if __scsi_remove_device() invokes
453 * blk_cleanup_queue() before the queue is run from this
454 * function then blk_run_queue() will return immediately since
455 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
456 */
457 slq = sdev->request_queue;
458 if (!blk_get_queue(slq))
459 continue;
460 spin_unlock_irqrestore(shost->host_lock, flags);
461
Christoph Hellwigd2852032014-01-17 12:06:53 +0100462 scsi_kick_queue(slq);
James Bottomleye2eb7242013-07-02 15:05:26 +0200463 blk_put_queue(slq);
464
465 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600467 /* put any unprocessed entries back */
468 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800470}
471
André Almeidaea941012020-04-19 02:01:48 -0300472/**
473 * scsi_run_queue - Select a proper request queue to serve next.
474 * @q: last request's queue
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800475 *
André Almeidaea941012020-04-19 02:01:48 -0300476 * The previous command was completely finished, start a new one if possible.
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800477 */
478static void scsi_run_queue(struct request_queue *q)
479{
480 struct scsi_device *sdev = q->queuedata;
481
482 if (scsi_target(sdev)->single_lun)
483 scsi_single_lun_run(sdev);
484 if (!list_empty(&sdev->host->starved_list))
485 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
Jens Axboef664a3c2018-11-01 16:36:27 -0600487 blk_mq_run_hw_queues(q, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488}
489
Jens Axboe9937a5e2011-05-17 11:04:44 +0200490void scsi_requeue_run_queue(struct work_struct *work)
491{
492 struct scsi_device *sdev;
493 struct request_queue *q;
494
495 sdev = container_of(work, struct scsi_device, requeue_work);
496 q = sdev->request_queue;
497 scsi_run_queue(q);
498}
499
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500void scsi_run_host_queues(struct Scsi_Host *shost)
501{
502 struct scsi_device *sdev;
503
504 shost_for_each_device(sdev, shost)
505 scsi_run_queue(sdev->request_queue);
506}
507
Christoph Hellwigd2852032014-01-17 12:06:53 +0100508static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
509{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100510 if (!blk_rq_is_passthrough(cmd->request)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100511 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
512
513 if (drv->uninit_command)
514 drv->uninit_command(cmd);
515 }
516}
517
Christoph Hellwig7007e9d2020-10-05 10:41:28 +0200518void scsi_free_sgtables(struct scsi_cmnd *cmd)
Christoph Hellwigd2852032014-01-17 12:06:53 +0100519{
520 if (cmd->sdb.table.nents)
Ming Lei3dccdf52019-04-28 15:39:32 +0800521 sg_free_table_chained(&cmd->sdb.table,
522 SCSI_INLINE_SG_CNT);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100523 if (scsi_prot_sg_count(cmd))
Ming Lei92524fa2019-04-28 15:39:31 +0800524 sg_free_table_chained(&cmd->prot_sdb->table,
525 SCSI_INLINE_PROT_SG_CNT);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100526}
Christoph Hellwig7007e9d2020-10-05 10:41:28 +0200527EXPORT_SYMBOL_GPL(scsi_free_sgtables);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100528
529static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
530{
Johannes Thumshirn20a66f22020-04-28 19:45:55 +0900531 scsi_free_sgtables(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100532 scsi_uninit_cmd(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100533}
534
Ming Lei3f0dcfb2020-07-20 10:54:35 +0800535static void scsi_run_queue_async(struct scsi_device *sdev)
536{
537 if (scsi_target(sdev)->single_lun ||
Ming Leied5dd6a2020-09-10 15:50:56 +0800538 !list_empty(&sdev->host->starved_list)) {
Ming Lei3f0dcfb2020-07-20 10:54:35 +0800539 kblockd_schedule_work(&sdev->requeue_work);
Ming Leied5dd6a2020-09-10 15:50:56 +0800540 } else {
541 /*
542 * smp_mb() present in sbitmap_queue_clear() or implied in
543 * .end_io is for ordering writing .device_busy in
544 * scsi_device_unbusy() and reading sdev->restarts.
545 */
546 int old = atomic_read(&sdev->restarts);
547
548 /*
549 * ->restarts has to be kept as non-zero if new budget
550 * contention occurs.
551 *
552 * No need to run queue when either another re-run
553 * queue wins in updating ->restarts or a new budget
554 * contention occurs.
555 */
556 if (old && atomic_cmpxchg(&sdev->restarts, old, 0) == old)
557 blk_mq_run_hw_queues(sdev->request_queue, true);
558 }
Ming Lei3f0dcfb2020-07-20 10:54:35 +0800559}
560
Douglas Gilbert7e63b5a2018-06-23 12:22:14 +0200561/* Returns false when no more bytes to process, true if there are more */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200562static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100563 unsigned int bytes)
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800564{
Bart Van Asschebed22132017-08-25 13:46:32 -0700565 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800566 struct scsi_device *sdev = cmd->device;
567 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800568
569 if (blk_update_request(req, error, bytes))
570 return true;
571
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800572 if (blk_queue_add_random(q))
573 add_disk_randomness(req->rq_disk);
574
Bart Van Assche64104f72017-08-30 16:58:39 -0700575 if (!blk_rq_is_scsi(req)) {
576 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
577 cmd->flags &= ~SCMD_INITIALIZED;
578 }
579
Jens Axboef664a3c2018-11-01 16:36:27 -0600580 /*
Bart Van Asschedb983f62019-03-18 09:29:26 -0700581 * Calling rcu_barrier() is not necessary here because the
582 * SCSI error handler guarantees that the function called by
583 * call_rcu() has been called before scsi_end_request() is
584 * called.
585 */
586 destroy_rcu_head(&cmd->rcu);
587
588 /*
Jens Axboef664a3c2018-11-01 16:36:27 -0600589 * In the MQ case the command gets freed by __blk_mq_end_request,
590 * so we have to do all cleanup that depends on it earlier.
591 *
592 * We also can't kick the queues from irq context, so we
593 * will have to defer it to a workqueue.
594 */
595 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800596
Jens Axboea78b03b2018-11-18 15:46:03 -0700597 /*
598 * queue is still alive, so grab the ref for preventing it
599 * from being cleaned up during running queue.
600 */
601 percpu_ref_get(&q->q_usage_counter);
Ming Lei8dc765d2018-11-14 16:25:51 +0800602
Jens Axboef664a3c2018-11-01 16:36:27 -0600603 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100604
Ming Lei3f0dcfb2020-07-20 10:54:35 +0800605 scsi_run_queue_async(sdev);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100606
Jens Axboea78b03b2018-11-18 15:46:03 -0700607 percpu_ref_put(&q->q_usage_counter);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800608 return false;
609}
610
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200611/**
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700612 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
613 * @cmd: SCSI command
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200614 * @result: scsi error code
615 *
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700616 * Translate a SCSI result code into a blk_status_t value. May reset the host
617 * byte of @cmd->result.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200618 */
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700619static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100620{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200621 switch (host_byte(result)) {
Bart Van Asschef4abab32018-04-05 10:33:01 -0700622 case DID_OK:
623 /*
624 * Also check the other bytes than the status byte in result
625 * to handle the case when a SCSI LLD sets result to
626 * DRIVER_SENSE << 24 without setting SAM_STAT_CHECK_CONDITION.
627 */
628 if (scsi_status_is_good(result) && (result & ~0xff) == 0)
629 return BLK_STS_OK;
630 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100631 case DID_TRANSPORT_FAILFAST:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200632 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100633 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000634 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200635 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100636 case DID_NEXUS_FAILURE:
Martin Wilck4a067cf2019-02-14 22:57:41 +0100637 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200638 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200639 case DID_ALLOC_FAILURE:
640 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200641 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200642 case DID_MEDIUM_ERROR:
643 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200644 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100645 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200646 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100647 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100648}
649
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200650/* Helper for scsi_io_completion() when "reprep" action required. */
651static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
652 struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653{
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200654 /* A new command will be prepared and issued. */
Jens Axboef664a3c2018-11-01 16:36:27 -0600655 scsi_mq_requeue_cmd(cmd);
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200656}
657
Mike Christie2a242d52020-10-01 10:35:53 -0500658static bool scsi_cmd_runtime_exceeced(struct scsi_cmnd *cmd)
659{
660 struct request *req = cmd->request;
661 unsigned long wait_for;
662
663 if (cmd->allowed == SCSI_CMD_RETRIES_NO_LIMIT)
664 return false;
665
666 wait_for = (cmd->allowed + 1) * req->timeout;
667 if (time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
668 scmd_printk(KERN_ERR, cmd, "timing out command, waited %lus\n",
669 wait_for/HZ);
670 return true;
671 }
672 return false;
673}
674
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200675/* Helper for scsi_io_completion() when special action required. */
676static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
Douglas Gilbertab831082018-06-23 12:22:16 +0200677{
Jens Axboe165125e2007-07-24 09:28:11 +0200678 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 struct request *req = cmd->request;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200680 int level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500681 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
682 ACTION_DELAYED_RETRY} action;
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200683 struct scsi_sense_hdr sshdr;
684 bool sense_valid;
685 bool sense_current = true; /* false implies "deferred sense" */
686 blk_status_t blk_stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200688 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
689 if (sense_valid)
690 sense_current = !scsi_sense_is_deferred(&sshdr);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200691
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200692 blk_stat = scsi_result_to_blk_status(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500693
Alan Sternb60af5b2008-11-03 15:56:47 -0500694 if (host_byte(result) == DID_RESET) {
695 /* Third party bus reset or reset for error recovery
696 * reasons. Just retry the command and see what
697 * happens.
698 */
699 action = ACTION_RETRY;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200700 } else if (sense_valid && sense_current) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 switch (sshdr.sense_key) {
702 case UNIT_ATTENTION:
703 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700704 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 * and quietly refuse further access.
706 */
707 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500708 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700710 /* Must have been a power glitch, or a
711 * bus reset. Could not have been a
712 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500713 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700714 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500715 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 }
717 break;
718 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700719 /* If we had an ILLEGAL REQUEST returned, then
720 * we may have performed an unsupported
721 * command. The only thing this should be
722 * would be a ten byte read where only a six
723 * byte read was supported. Also, on a system
724 * where READ CAPACITY failed, we may have
725 * read past the end of the disk.
726 */
Jens Axboe26a68012005-11-29 21:03:34 +0100727 if ((cmd->device->use_10_for_rw &&
728 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 (cmd->cmnd[0] == READ_10 ||
730 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500731 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500733 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500734 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500735 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200736 blk_stat = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500737 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400738 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500739 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200740 blk_stat = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500741 } else
742 action = ACTION_FAIL;
743 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400744 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000745 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200746 if (sshdr.asc == 0x10) /* DIF */
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200747 blk_stat = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 break;
749 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700750 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500751 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500753 if (sshdr.asc == 0x04) {
754 switch (sshdr.ascq) {
755 case 0x01: /* becoming ready */
756 case 0x04: /* format in progress */
757 case 0x05: /* rebuild in progress */
758 case 0x06: /* recalculation in progress */
759 case 0x07: /* operation in progress */
760 case 0x08: /* Long write in progress */
761 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500762 case 0x14: /* space allocation in progress */
Douglas Gilberte37c7d92018-05-18 19:25:47 -0400763 case 0x1a: /* start stop unit in progress */
764 case 0x1b: /* sanitize in progress */
765 case 0x1d: /* configuration in progress */
766 case 0x24: /* depopulation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500767 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500768 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500769 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500770 action = ACTION_FAIL;
771 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500772 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200773 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500774 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500775 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700777 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500778 action = ACTION_FAIL;
779 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500781 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 break;
783 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200784 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500785 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500786
Mike Christie2a242d52020-10-01 10:35:53 -0500787 if (action != ACTION_FAIL && scsi_cmd_runtime_exceeced(cmd))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900788 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900789
Alan Sternb60af5b2008-11-03 15:56:47 -0500790 switch (action) {
791 case ACTION_FAIL:
792 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200793 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200794 static DEFINE_RATELIMIT_STATE(_rs,
795 DEFAULT_RATELIMIT_INTERVAL,
796 DEFAULT_RATELIMIT_BURST);
797
798 if (unlikely(scsi_logging_level))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200799 level =
800 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
801 SCSI_LOG_MLCOMPLETE_BITS);
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200802
803 /*
804 * if logging is enabled the failure will be printed
805 * in scsi_log_completion(), so avoid duplicate messages
806 */
807 if (!level && __ratelimit(&_rs)) {
808 scsi_print_result(cmd, NULL, FAILED);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +0200809 if (driver_byte(result) == DRIVER_SENSE)
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200810 scsi_print_sense(cmd);
811 scsi_print_command(cmd);
812 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500813 }
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100814 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req)))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800815 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200816 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500817 case ACTION_REPREP:
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200818 scsi_io_completion_reprep(cmd, q);
Alan Sternb60af5b2008-11-03 15:56:47 -0500819 break;
820 case ACTION_RETRY:
821 /* Retry the same command immediately */
Bart Van Assche08640e82018-01-10 14:41:45 -0800822 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500823 break;
824 case ACTION_DELAYED_RETRY:
825 /* Retry the same command after a delay */
Bart Van Assche08640e82018-01-10 14:41:45 -0800826 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500827 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 }
829}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200831/*
832 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
833 * new result that may suppress further error checking. Also modifies
834 * *blk_statp in some cases.
835 */
836static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
837 blk_status_t *blk_statp)
838{
839 bool sense_valid;
840 bool sense_current = true; /* false implies "deferred sense" */
841 struct request *req = cmd->request;
842 struct scsi_sense_hdr sshdr;
843
844 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
845 if (sense_valid)
846 sense_current = !scsi_sense_is_deferred(&sshdr);
847
848 if (blk_rq_is_passthrough(req)) {
849 if (sense_valid) {
850 /*
851 * SG_IO wants current and deferred errors
852 */
853 scsi_req(req)->sense_len =
854 min(8 + cmd->sense_buffer[7],
855 SCSI_SENSE_BUFFERSIZE);
856 }
857 if (sense_current)
858 *blk_statp = scsi_result_to_blk_status(cmd, result);
859 } else if (blk_rq_bytes(req) == 0 && sense_current) {
860 /*
861 * Flush commands do not transfers any data, and thus cannot use
862 * good_bytes != blk_rq_bytes(req) as the signal for an error.
863 * This sets *blk_statp explicitly for the problem case.
864 */
865 *blk_statp = scsi_result_to_blk_status(cmd, result);
866 }
867 /*
868 * Recovered errors need reporting, but they're always treated as
869 * success, so fiddle the result code here. For passthrough requests
870 * we already took a copy of the original into sreq->result which
871 * is what gets returned to the user
872 */
873 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
874 bool do_print = true;
875 /*
876 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
877 * skip print since caller wants ATA registers. Only occurs
878 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
879 */
880 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
881 do_print = false;
882 else if (req->rq_flags & RQF_QUIET)
883 do_print = false;
884 if (do_print)
885 scsi_print_sense(cmd);
886 result = 0;
887 /* for passthrough, *blk_statp may be set */
888 *blk_statp = BLK_STS_OK;
889 }
890 /*
891 * Another corner case: the SCSI status byte is non-zero but 'good'.
892 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
893 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
894 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
895 * intermediate statuses (both obsolete in SAM-4) as good.
896 */
897 if (status_byte(result) && scsi_status_is_good(result)) {
898 result = 0;
899 *blk_statp = BLK_STS_OK;
900 }
901 return result;
902}
903
André Almeidaea941012020-04-19 02:01:48 -0300904/**
905 * scsi_io_completion - Completion processing for SCSI commands.
906 * @cmd: command that is finished.
907 * @good_bytes: number of processed bytes.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200908 *
André Almeidaea941012020-04-19 02:01:48 -0300909 * We will finish off the specified number of sectors. If we are done, the
910 * command block will be released and the queue function will be goosed. If we
911 * are not done then we have to figure out what to do next:
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200912 *
André Almeidaea941012020-04-19 02:01:48 -0300913 * a) We can call scsi_io_completion_reprep(). The request will be
914 * unprepared and put back on the queue. Then a new command will
915 * be created for it. This should be used if we made forward
916 * progress, or if we want to switch from READ(10) to READ(6) for
917 * example.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200918 *
André Almeidaea941012020-04-19 02:01:48 -0300919 * b) We can call scsi_io_completion_action(). The request will be
920 * put back on the queue and retried using the same command as
921 * before, possibly after a delay.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200922 *
André Almeidaea941012020-04-19 02:01:48 -0300923 * c) We can call scsi_end_request() with blk_stat other than
924 * BLK_STS_OK, to fail the remainder of the request.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200925 */
926void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
927{
928 int result = cmd->result;
929 struct request_queue *q = cmd->device->request_queue;
930 struct request *req = cmd->request;
931 blk_status_t blk_stat = BLK_STS_OK;
932
Douglas Gilbert0d437902018-06-23 12:22:19 +0200933 if (unlikely(result)) /* a nz result may or may not be an error */
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200934 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
935
Douglas Gilbert0d437902018-06-23 12:22:19 +0200936 if (unlikely(blk_rq_is_passthrough(req))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200937 /*
938 * scsi_result_to_blk_status may have reset the host_byte
939 */
940 scsi_req(req)->result = cmd->result;
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200941 }
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200942
943 /*
944 * Next deal with any sectors which we were able to correctly
945 * handle.
946 */
947 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
948 "%u sectors total, %d bytes done.\n",
949 blk_rq_sectors(req), good_bytes));
950
951 /*
André Almeidaea941012020-04-19 02:01:48 -0300952 * Failed, zero length commands always need to drop down
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200953 * to retry code. Fast path should return in this block.
954 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200955 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100956 if (likely(!scsi_end_request(req, blk_stat, good_bytes)))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200957 return; /* no bytes remaining */
958 }
959
Douglas Gilbert0d437902018-06-23 12:22:19 +0200960 /* Kill remainder if no retries. */
961 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100962 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req)))
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200963 WARN_ONCE(true,
964 "Bytes remaining after failed, no-retry command");
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200965 return;
966 }
967
968 /*
969 * If there had been no error, but we have leftover bytes in the
970 * requeues just queue the command up again.
971 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200972 if (likely(result == 0))
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200973 scsi_io_completion_reprep(cmd, q);
974 else
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200975 scsi_io_completion_action(cmd, result);
976}
977
Christoph Hellwigcc979232020-04-14 09:42:24 +0200978static inline bool scsi_cmd_needs_dma_drain(struct scsi_device *sdev,
979 struct request *rq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980{
Christoph Hellwigcc979232020-04-14 09:42:24 +0200981 return sdev->dma_drain_len && blk_rq_is_passthrough(rq) &&
982 !op_is_write(req_op(rq)) &&
983 sdev->host->hostt->dma_need_drain(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200985
André Almeidaea941012020-04-19 02:01:48 -0300986/**
Christoph Hellwig7007e9d2020-10-05 10:41:28 +0200987 * scsi_alloc_sgtables - allocate S/G tables for a command
André Almeidaea941012020-04-19 02:01:48 -0300988 * @cmd: command descriptor we wish to initialize
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200989 *
André Almeidaea941012020-04-19 02:01:48 -0300990 * Returns:
991 * * BLK_STS_OK - on success
992 * * BLK_STS_RESOURCE - if the failure is retryable
993 * * BLK_STS_IOERR - if the failure is fatal
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200994 */
Christoph Hellwig7007e9d2020-10-05 10:41:28 +0200995blk_status_t scsi_alloc_sgtables(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200996{
Christoph Hellwigcc979232020-04-14 09:42:24 +0200997 struct scsi_device *sdev = cmd->device;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200998 struct request *rq = cmd->request;
Christoph Hellwigcc979232020-04-14 09:42:24 +0200999 unsigned short nr_segs = blk_rq_nr_phys_segments(rq);
1000 struct scatterlist *last_sg = NULL;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001001 blk_status_t ret;
Christoph Hellwigcc979232020-04-14 09:42:24 +02001002 bool need_drain = scsi_cmd_needs_dma_drain(sdev, rq);
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001003 int count;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001004
Christoph Hellwigcc979232020-04-14 09:42:24 +02001005 if (WARN_ON_ONCE(!nr_segs))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001006 return BLK_STS_IOERR;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001007
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001008 /*
Christoph Hellwigcc979232020-04-14 09:42:24 +02001009 * Make sure there is space for the drain. The driver must adjust
1010 * max_hw_segments to be prepared for this.
1011 */
1012 if (need_drain)
1013 nr_segs++;
1014
1015 /*
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001016 * If sg table allocation fails, requeue request later.
1017 */
Christoph Hellwigcc979232020-04-14 09:42:24 +02001018 if (unlikely(sg_alloc_table_chained(&cmd->sdb.table, nr_segs,
1019 cmd->sdb.table.sgl, SCSI_INLINE_SG_CNT)))
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001020 return BLK_STS_RESOURCE;
1021
1022 /*
1023 * Next, walk the list, and fill in the addresses and sizes of
1024 * each segment.
1025 */
Christoph Hellwigcc979232020-04-14 09:42:24 +02001026 count = __blk_rq_map_sg(rq->q, rq, cmd->sdb.table.sgl, &last_sg);
1027
Christoph Hellwigbdf87102020-04-14 09:42:25 +02001028 if (blk_rq_bytes(rq) & rq->q->dma_pad_mask) {
1029 unsigned int pad_len =
1030 (rq->q->dma_pad_mask & ~blk_rq_bytes(rq)) + 1;
1031
1032 last_sg->length += pad_len;
1033 cmd->extra_len += pad_len;
1034 }
1035
Christoph Hellwigcc979232020-04-14 09:42:24 +02001036 if (need_drain) {
1037 sg_unmark_end(last_sg);
1038 last_sg = sg_next(last_sg);
1039 sg_set_buf(last_sg, sdev->dma_drain_buf, sdev->dma_drain_len);
1040 sg_mark_end(last_sg);
1041
Christoph Hellwigbdf87102020-04-14 09:42:25 +02001042 cmd->extra_len += sdev->dma_drain_len;
Christoph Hellwigcc979232020-04-14 09:42:24 +02001043 count++;
1044 }
1045
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001046 BUG_ON(count > cmd->sdb.table.nents);
1047 cmd->sdb.table.nents = count;
1048 cmd->sdb.length = blk_rq_payload_bytes(rq);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001049
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001050 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001051 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001052 int ivecs;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001053
Christoph Hellwig14784562018-11-09 14:42:38 +01001054 if (WARN_ON_ONCE(!prot_sdb)) {
Ewan D. Milne91724c22015-01-15 10:02:12 -05001055 /*
1056 * This can happen if someone (e.g. multipath)
1057 * queues a command to a device on an adapter
1058 * that does not support DIX.
1059 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001060 ret = BLK_STS_IOERR;
Christoph Hellwig14784562018-11-09 14:42:38 +01001061 goto out_free_sgtables;
Ewan D. Milne91724c22015-01-15 10:02:12 -05001062 }
1063
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001064 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001065
Ming Lin001d63b2016-04-04 14:48:09 -07001066 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lei46358732019-04-28 15:39:30 +08001067 prot_sdb->table.sgl,
Ming Lei92524fa2019-04-28 15:39:31 +08001068 SCSI_INLINE_PROT_SG_CNT)) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001069 ret = BLK_STS_RESOURCE;
Christoph Hellwig14784562018-11-09 14:42:38 +01001070 goto out_free_sgtables;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001071 }
1072
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001073 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001074 prot_sdb->table.sgl);
Igor Stoppa6f1d8a52018-09-05 23:47:20 +03001075 BUG_ON(count > ivecs);
1076 BUG_ON(count > queue_max_integrity_segments(rq->q));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001077
1078 cmd->prot_sdb = prot_sdb;
1079 cmd->prot_sdb->table.nents = count;
1080 }
1081
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001082 return BLK_STS_OK;
Christoph Hellwig14784562018-11-09 14:42:38 +01001083out_free_sgtables:
Johannes Thumshirn20a66f22020-04-28 19:45:55 +09001084 scsi_free_sgtables(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001085 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001086}
Christoph Hellwig7007e9d2020-10-05 10:41:28 +02001087EXPORT_SYMBOL(scsi_alloc_sgtables);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001089/**
Bart Van Assche832889f2017-08-30 16:58:40 -07001090 * scsi_initialize_rq - initialize struct scsi_cmnd partially
Jonathan Corbet35c05062017-08-24 16:11:09 -06001091 * @rq: Request associated with the SCSI command to be initialized.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001092 *
Bart Van Assche832889f2017-08-30 16:58:40 -07001093 * This function initializes the members of struct scsi_cmnd that must be
1094 * initialized before request processing starts and that won't be
1095 * reinitialized if a SCSI command is requeued.
1096 *
Bart Van Assche64104f72017-08-30 16:58:39 -07001097 * Called from inside blk_get_request() for pass-through requests and from
1098 * inside scsi_init_command() for filesystem requests.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001099 */
Bart Van Asschee4c94702017-12-07 15:59:31 -08001100static void scsi_initialize_rq(struct request *rq)
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001101{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001102 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1103
1104 scsi_req_init(&cmd->req);
Bart Van Assche3be88282018-02-22 11:30:20 -08001105 init_rcu_head(&cmd->rcu);
Bart Van Assche832889f2017-08-30 16:58:40 -07001106 cmd->jiffies_at_alloc = jiffies;
1107 cmd->retries = 0;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001108}
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001109
Ming Leib7e9e1f2019-07-25 10:05:00 +08001110/*
1111 * Only called when the request isn't completed by SCSI, and not freed by
1112 * SCSI
1113 */
1114static void scsi_cleanup_rq(struct request *rq)
1115{
1116 if (rq->rq_flags & RQF_DONTPREP) {
1117 scsi_mq_uninit_cmd(blk_mq_rq_to_pdu(rq));
1118 rq->rq_flags &= ~RQF_DONTPREP;
1119 }
1120}
1121
Bart Van Assche65ca8462020-01-22 19:56:34 -08001122/* Called before a request is prepared. See also scsi_mq_prep_fn(). */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001123void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001124{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001125 void *buf = cmd->sense_buffer;
1126 void *prot = cmd->prot_sdb;
Bart Van Assche64104f72017-08-30 16:58:39 -07001127 struct request *rq = blk_mq_rq_from_pdu(cmd);
1128 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
Bart Van Assche832889f2017-08-30 16:58:40 -07001129 unsigned long jiffies_at_alloc;
Bart Van Assche65ca8462020-01-22 19:56:34 -08001130 int retries, to_clear;
Ming Lei6eb045e2019-10-25 14:58:55 +08001131 bool in_flight;
Bart Van Assche64104f72017-08-30 16:58:39 -07001132
1133 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1134 flags |= SCMD_INITIALIZED;
1135 scsi_initialize_rq(rq);
1136 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001137
Bart Van Assche832889f2017-08-30 16:58:40 -07001138 jiffies_at_alloc = cmd->jiffies_at_alloc;
1139 retries = cmd->retries;
Ming Lei6eb045e2019-10-25 14:58:55 +08001140 in_flight = test_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Bart Van Assche65ca8462020-01-22 19:56:34 -08001141 /*
1142 * Zero out the cmd, except for the embedded scsi_request. Only clear
1143 * the driver-private command data if the LLD does not supply a
1144 * function to initialize that data.
1145 */
1146 to_clear = sizeof(*cmd) - sizeof(cmd->req);
1147 if (!dev->host->hostt->init_cmd_priv)
1148 to_clear += dev->host->hostt->cmd_size;
1149 memset((char *)cmd + sizeof(cmd->req), 0, to_clear);
Christoph Hellwig04796332014-02-20 14:20:55 -08001150
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001151 cmd->device = dev;
1152 cmd->sense_buffer = buf;
1153 cmd->prot_sdb = prot;
Bart Van Assche64104f72017-08-30 16:58:39 -07001154 cmd->flags = flags;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001155 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
Bart Van Assche832889f2017-08-30 16:58:40 -07001156 cmd->jiffies_at_alloc = jiffies_at_alloc;
1157 cmd->retries = retries;
Ming Lei6eb045e2019-10-25 14:58:55 +08001158 if (in_flight)
1159 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001160
Christoph Hellwig3b003152006-11-04 20:10:55 +01001161}
1162
Christoph Hellwig785ba832018-11-09 14:42:37 +01001163static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1164 struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001165{
Bart Van Asschebed22132017-08-25 13:46:32 -07001166 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001167
1168 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001169 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001170 * a bio attached to them. Or they might contain a SCSI command
1171 * that does not transfer data, in which case they may optionally
1172 * submit a request without an attached bio.
1173 */
1174 if (req->bio) {
Christoph Hellwig7007e9d2020-10-05 10:41:28 +02001175 blk_status_t ret = scsi_alloc_sgtables(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001176 if (unlikely(ret != BLK_STS_OK))
1177 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001178 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001179 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001180
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001181 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001182 }
James Bottomley7b163182005-12-15 20:17:02 -06001183
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001184 cmd->cmd_len = scsi_req(req)->cmd_len;
Christoph Hellwig2ceda202020-10-05 10:41:23 +02001185 if (cmd->cmd_len == 0)
1186 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001187 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001188 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001189 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig785ba832018-11-09 14:42:37 +01001190 return BLK_STS_OK;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001191}
1192
1193/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001194 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001195 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001196 */
Christoph Hellwig785ba832018-11-09 14:42:37 +01001197static blk_status_t scsi_setup_fs_cmnd(struct scsi_device *sdev,
1198 struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001199{
Bart Van Asschebed22132017-08-25 13:46:32 -07001200 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001201
Christoph Hellwigee14c672015-08-27 14:16:59 +02001202 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
Christoph Hellwig4c1cb672018-11-09 14:42:40 +01001203 blk_status_t ret = sdev->handler->prep_fn(sdev, req);
1204 if (ret != BLK_STS_OK)
1205 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001206 }
1207
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001208 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001209 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001210 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001211}
James Bottomley7b163182005-12-15 20:17:02 -06001212
Christoph Hellwig785ba832018-11-09 14:42:37 +01001213static blk_status_t scsi_setup_cmnd(struct scsi_device *sdev,
1214 struct request *req)
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001215{
Bart Van Asschebed22132017-08-25 13:46:32 -07001216 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001217
Christoph Hellwig40b93832020-10-05 10:41:25 +02001218 cmd->sc_data_direction = rq_dma_dir(req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001219
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001220 if (blk_rq_is_scsi(req))
Christoph Hellwig7007e9d2020-10-05 10:41:28 +02001221 return scsi_setup_scsi_cmnd(sdev, req);
1222 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001223}
1224
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001225static blk_status_t
Christoph Hellwig822bd2d2020-10-05 10:41:26 +02001226scsi_device_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227{
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001228 switch (sdev->sdev_state) {
1229 case SDEV_OFFLINE:
1230 case SDEV_TRANSPORT_OFFLINE:
1231 /*
1232 * If the device is offline we refuse to process any
1233 * commands. The device must be brought online
1234 * before trying any recovery commands.
1235 */
Ewan D. Milneb0962c52020-03-11 10:39:30 -04001236 if (!sdev->offline_already) {
1237 sdev->offline_already = true;
1238 sdev_printk(KERN_ERR, sdev,
1239 "rejecting I/O to offline device\n");
1240 }
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001241 return BLK_STS_IOERR;
1242 case SDEV_DEL:
1243 /*
1244 * If the device is fully deleted, we refuse to
1245 * process any commands as well.
1246 */
1247 sdev_printk(KERN_ERR, sdev,
1248 "rejecting I/O to dead device\n");
1249 return BLK_STS_IOERR;
1250 case SDEV_BLOCK:
1251 case SDEV_CREATED_BLOCK:
1252 return BLK_STS_RESOURCE;
1253 case SDEV_QUIESCE:
1254 /*
1255 * If the devices is blocked we defer normal commands.
1256 */
1257 if (req && !(req->rq_flags & RQF_PREEMPT))
1258 return BLK_STS_RESOURCE;
1259 return BLK_STS_OK;
1260 default:
1261 /*
1262 * For any other not fully online state we only allow
1263 * special commands. In particular any user initiated
1264 * command is not allowed.
1265 */
1266 if (req && !(req->rq_flags & RQF_PREEMPT))
1267 return BLK_STS_IOERR;
1268 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001270}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272/*
1273 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1274 * return 0.
1275 *
1276 * Called with the queue_lock held.
1277 */
1278static inline int scsi_dev_queue_ready(struct request_queue *q,
1279 struct scsi_device *sdev)
1280{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001281 unsigned int busy;
1282
1283 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001284 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001285 if (busy)
1286 goto out_dec;
1287
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 /*
1289 * unblock after device_blocked iterates to zero
1290 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001291 if (atomic_dec_return(&sdev->device_blocked) > 0)
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001292 goto out_dec;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001293 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1294 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001296
1297 if (busy >= sdev->queue_depth)
1298 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299
1300 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001301out_dec:
1302 atomic_dec(&sdev->device_busy);
1303 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304}
1305
Mike Christief0c0a372008-08-17 15:24:38 -05001306/*
1307 * scsi_target_queue_ready: checks if there we can send commands to target
1308 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001309 */
1310static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1311 struct scsi_device *sdev)
1312{
1313 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001314 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001315
1316 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001317 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001318 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001319 starget->starget_sdev_user != sdev) {
1320 spin_unlock_irq(shost->host_lock);
1321 return 0;
1322 }
Mike Christief0c0a372008-08-17 15:24:38 -05001323 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001324 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001325 }
1326
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001327 if (starget->can_queue <= 0)
1328 return 1;
1329
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001330 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001331 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001332 if (busy)
1333 goto starved;
1334
Mike Christief0c0a372008-08-17 15:24:38 -05001335 /*
1336 * unblock after target_blocked iterates to zero
1337 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001338 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001339 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001340
1341 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1342 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001343 }
1344
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001345 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001346 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001347
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001348 return 1;
1349
1350starved:
1351 spin_lock_irq(shost->host_lock);
1352 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001353 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001354out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001355 if (starget->can_queue > 0)
1356 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001357 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001358}
1359
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360/*
1361 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1362 * return 0. We must end up running the queue again whenever 0 is
1363 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 */
1365static inline int scsi_host_queue_ready(struct request_queue *q,
1366 struct Scsi_Host *shost,
Ming Lei6eb045e2019-10-25 14:58:55 +08001367 struct scsi_device *sdev,
1368 struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369{
James Bottomley939647e2005-09-18 15:05:20 -05001370 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001371 return 0;
1372
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001373 if (atomic_read(&shost->host_blocked) > 0) {
Ming Lei6eb045e2019-10-25 14:58:55 +08001374 if (scsi_host_busy(shost) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001375 goto starved;
1376
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 /*
1378 * unblock after host_blocked iterates to zero
1379 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001380 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001381 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001382
1383 SCSI_LOG_MLQUEUE(3,
1384 shost_printk(KERN_INFO, shost,
1385 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001387
Christoph Hellwig74665012014-01-22 15:29:29 +01001388 if (shost->host_self_blocked)
1389 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
1391 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001392 if (!list_empty(&sdev->starved_entry)) {
1393 spin_lock_irq(shost->host_lock);
1394 if (!list_empty(&sdev->starved_entry))
1395 list_del_init(&sdev->starved_entry);
1396 spin_unlock_irq(shost->host_lock);
1397 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398
Ming Lei6eb045e2019-10-25 14:58:55 +08001399 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state);
1400
Christoph Hellwig74665012014-01-22 15:29:29 +01001401 return 1;
1402
1403starved:
1404 spin_lock_irq(shost->host_lock);
1405 if (list_empty(&sdev->starved_entry))
1406 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001407 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001408out_dec:
Ming Lei6eb045e2019-10-25 14:58:55 +08001409 scsi_dec_host_busy(shost, cmd);
Christoph Hellwig74665012014-01-22 15:29:29 +01001410 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411}
1412
1413/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001414 * Busy state exporting function for request stacking drivers.
1415 *
1416 * For efficiency, no lock is taken to check the busy state of
1417 * shost/starget/sdev, since the returned value is not guaranteed and
1418 * may be changed after request stacking drivers call the function,
1419 * regardless of taking lock or not.
1420 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001421 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1422 * needs to return 'not busy'. Otherwise, request stacking drivers
1423 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001424 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001425static bool scsi_mq_lld_busy(struct request_queue *q)
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001426{
1427 struct scsi_device *sdev = q->queuedata;
1428 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001429
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001430 if (blk_queue_dying(q))
Jens Axboef664a3c2018-11-01 16:36:27 -06001431 return false;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001432
1433 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001434
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001435 /*
1436 * Ignore host/starget busy state.
1437 * Since block layer does not have a concept of fairness across
1438 * multiple queues, congestion of host/starget needs to be handled
1439 * in SCSI layer.
1440 */
1441 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Jens Axboef664a3c2018-11-01 16:36:27 -06001442 return true;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001443
Jens Axboef664a3c2018-11-01 16:36:27 -06001444 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445}
1446
Jens Axboe1aea6432006-01-09 16:03:03 +01001447static void scsi_softirq_done(struct request *rq)
1448{
Bart Van Asschebed22132017-08-25 13:46:32 -07001449 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboe1aea6432006-01-09 16:03:03 +01001450 int disposition;
1451
1452 INIT_LIST_HEAD(&cmd->eh_entry);
1453
Jens Axboe242f9dc2008-09-14 05:55:09 -07001454 atomic_inc(&cmd->device->iodone_cnt);
1455 if (cmd->result)
1456 atomic_inc(&cmd->device->ioerr_cnt);
1457
Jens Axboe1aea6432006-01-09 16:03:03 +01001458 disposition = scsi_decide_disposition(cmd);
Mike Christie2a242d52020-10-01 10:35:53 -05001459 if (disposition != SUCCESS && scsi_cmd_runtime_exceeced(cmd))
Jens Axboe1aea6432006-01-09 16:03:03 +01001460 disposition = SUCCESS;
Hannes Reinecke91921e02014-06-25 16:39:59 +02001461
Jens Axboe1aea6432006-01-09 16:03:03 +01001462 scsi_log_completion(cmd, disposition);
1463
1464 switch (disposition) {
Bean Huo4c7b4d62020-06-19 17:41:17 +02001465 case SUCCESS:
1466 scsi_finish_command(cmd);
1467 break;
1468 case NEEDS_RETRY:
1469 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
1470 break;
1471 case ADD_TO_MLQUEUE:
1472 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1473 break;
1474 default:
1475 scsi_eh_scmd_add(cmd);
1476 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001477 }
1478}
1479
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001480/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001481 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1482 * @cmd: command block we are dispatching.
1483 *
1484 * Return: nonzero return request was rejected and device's queue needs to be
1485 * plugged.
1486 */
1487static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1488{
1489 struct Scsi_Host *host = cmd->device->host;
1490 int rtn = 0;
1491
1492 atomic_inc(&cmd->device->iorequest_cnt);
1493
1494 /* check if the device is still usable */
1495 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1496 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1497 * returns an immediate error upwards, and signals
1498 * that the device is no longer present */
1499 cmd->result = DID_NO_CONNECT << 16;
1500 goto done;
1501 }
1502
1503 /* Check to see if the scsi lld made this device blocked. */
1504 if (unlikely(scsi_device_blocked(cmd->device))) {
1505 /*
1506 * in blocked state, the command is just put back on
1507 * the device queue. The suspend state has already
1508 * blocked the queue so future requests should not
1509 * occur until the device transitions out of the
1510 * suspend state.
1511 */
1512 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1513 "queuecommand : device blocked\n"));
1514 return SCSI_MLQUEUE_DEVICE_BUSY;
1515 }
1516
1517 /* Store the LUN value in cmnd, if needed. */
1518 if (cmd->device->lun_in_cdb)
1519 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1520 (cmd->device->lun << 5 & 0xe0);
1521
1522 scsi_log_send(cmd);
1523
1524 /*
1525 * Before we queue this command, check if the command
1526 * length exceeds what the host adapter can handle.
1527 */
1528 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1529 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1530 "queuecommand : command too long. "
1531 "cdb_size=%d host->max_cmd_len=%d\n",
1532 cmd->cmd_len, cmd->device->host->max_cmd_len));
1533 cmd->result = (DID_ABORT << 16);
1534 goto done;
1535 }
1536
1537 if (unlikely(host->shost_state == SHOST_DEL)) {
1538 cmd->result = (DID_NO_CONNECT << 16);
1539 goto done;
1540
1541 }
1542
1543 trace_scsi_dispatch_cmd_start(cmd);
1544 rtn = host->hostt->queuecommand(host, cmd);
1545 if (rtn) {
1546 trace_scsi_dispatch_cmd_error(cmd, rtn);
1547 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1548 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1549 rtn = SCSI_MLQUEUE_HOST_BUSY;
1550
1551 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1552 "queuecommand : request rejected\n"));
1553 }
1554
1555 return rtn;
1556 done:
1557 cmd->scsi_done(cmd);
1558 return 0;
1559}
1560
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001561/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
Ming Lei3dccdf52019-04-28 15:39:32 +08001562static unsigned int scsi_mq_inline_sgl_size(struct Scsi_Host *shost)
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001563{
Ming Lei3dccdf52019-04-28 15:39:32 +08001564 return min_t(unsigned int, shost->sg_tablesize, SCSI_INLINE_SG_CNT) *
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001565 sizeof(struct scatterlist);
1566}
1567
Christoph Hellwig5843cc32020-10-05 10:41:27 +02001568static blk_status_t scsi_prepare_cmd(struct request *req)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001569{
1570 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1571 struct scsi_device *sdev = req->q->queuedata;
1572 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001573 struct scatterlist *sg;
1574
Bart Van Assche08f78432017-06-02 14:22:00 -07001575 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001576
Christoph Hellwigd2852032014-01-17 12:06:53 +01001577 cmd->request = req;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001578 cmd->tag = req->tag;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001579 cmd->prot_op = SCSI_PROT_NORMAL;
1580
Christoph Hellwigd2852032014-01-17 12:06:53 +01001581 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1582 cmd->sdb.table.sgl = sg;
1583
1584 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001585 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1586
1587 cmd->prot_sdb->table.sgl =
1588 (struct scatterlist *)(cmd->prot_sdb + 1);
1589 }
1590
Christoph Hellwigfe052522014-09-22 15:59:31 +02001591 blk_mq_start_request(req);
1592
Bart Van Assche8fe8ffb2017-10-20 11:46:45 -07001593 return scsi_setup_cmnd(sdev, req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001594}
1595
1596static void scsi_mq_done(struct scsi_cmnd *cmd)
1597{
Christoph Hellwig15f73f52020-06-11 08:44:47 +02001598 if (unlikely(blk_should_fake_timeout(cmd->request->q)))
1599 return;
Keith Buschf1342702018-11-26 09:54:29 -07001600 if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state)))
1601 return;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001602 trace_scsi_dispatch_cmd_done(cmd);
Christoph Hellwig15f73f52020-06-11 08:44:47 +02001603 blk_mq_complete_request(cmd->request);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001604}
1605
Ming Lei65c76362020-06-30 18:24:56 +08001606static void scsi_mq_put_budget(struct request_queue *q)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001607{
Christoph Hellwigd2852032014-01-17 12:06:53 +01001608 struct scsi_device *sdev = q->queuedata;
Ming Lei0df21c82017-10-14 17:22:32 +08001609
Ming Lei0df21c82017-10-14 17:22:32 +08001610 atomic_dec(&sdev->device_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001611}
1612
Ming Lei65c76362020-06-30 18:24:56 +08001613static bool scsi_mq_get_budget(struct request_queue *q)
Ming Lei0df21c82017-10-14 17:22:32 +08001614{
Ming Lei0df21c82017-10-14 17:22:32 +08001615 struct scsi_device *sdev = q->queuedata;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001616
Ming Leied5dd6a2020-09-10 15:50:56 +08001617 if (scsi_dev_queue_ready(q, sdev))
1618 return true;
1619
1620 atomic_inc(&sdev->restarts);
1621
1622 /*
1623 * Orders atomic_inc(&sdev->restarts) and atomic_read(&sdev->device_busy).
1624 * .restarts must be incremented before .device_busy is read because the
1625 * code in scsi_run_queue_async() depends on the order of these operations.
1626 */
1627 smp_mb__after_atomic();
1628
1629 /*
1630 * If all in-flight requests originated from this LUN are completed
1631 * before reading .device_busy, sdev->device_busy will be observed as
1632 * zero, then blk_mq_delay_run_hw_queues() will dispatch this request
1633 * soon. Otherwise, completion of one of these requests will observe
1634 * the .restarts flag, and the request queue will be run for handling
1635 * this request, see scsi_end_request().
1636 */
1637 if (unlikely(atomic_read(&sdev->device_busy) == 0 &&
1638 !scsi_device_blocked(sdev)))
1639 blk_mq_delay_run_hw_queues(sdev->request_queue, SCSI_QUEUE_DELAY);
1640 return false;
Ming Lei0df21c82017-10-14 17:22:32 +08001641}
1642
Christoph Hellwigd2852032014-01-17 12:06:53 +01001643static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1644 const struct blk_mq_queue_data *bd)
1645{
1646 struct request *req = bd->rq;
1647 struct request_queue *q = req->q;
1648 struct scsi_device *sdev = q->queuedata;
1649 struct Scsi_Host *shost = sdev->host;
1650 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1651 blk_status_t ret;
1652 int reason;
1653
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001654 /*
1655 * If the device is not in running state we will reject some or all
1656 * commands.
1657 */
1658 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig822bd2d2020-10-05 10:41:26 +02001659 ret = scsi_device_state_check(sdev, req);
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001660 if (ret != BLK_STS_OK)
1661 goto out_put_budget;
1662 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001663
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001664 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001665 if (!scsi_target_queue_ready(shost, sdev))
Ming Lei826a70a2017-11-04 09:55:34 +08001666 goto out_put_budget;
Ming Lei6eb045e2019-10-25 14:58:55 +08001667 if (!scsi_host_queue_ready(q, shost, sdev, cmd))
Christoph Hellwigd2852032014-01-17 12:06:53 +01001668 goto out_dec_target_busy;
1669
Christoph Hellwige8064022016-10-20 15:12:13 +02001670 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwig5843cc32020-10-05 10:41:27 +02001671 ret = scsi_prepare_cmd(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001672 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001673 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001674 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001675 } else {
Bart Van Asschecd464d82019-01-15 16:50:03 -08001676 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigfe052522014-09-22 15:59:31 +02001677 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001678 }
1679
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001680 cmd->flags &= SCMD_PRESERVED_FLAGS;
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001681 if (sdev->simple_tags)
1682 cmd->flags |= SCMD_TAGGED;
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001683 if (bd->last)
1684 cmd->flags |= SCMD_LAST;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001685
Christoph Hellwig3a8dc5b2020-10-05 10:41:22 +02001686 scsi_set_resid(cmd, 0);
1687 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001688 cmd->scsi_done = scsi_mq_done;
1689
1690 reason = scsi_dispatch_cmd(cmd);
1691 if (reason) {
1692 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001693 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001694 goto out_dec_host_busy;
1695 }
1696
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001697 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001698
1699out_dec_host_busy:
Ming Lei6eb045e2019-10-25 14:58:55 +08001700 scsi_dec_host_busy(shost, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001701out_dec_target_busy:
1702 if (scsi_target(sdev)->can_queue > 0)
1703 atomic_dec(&scsi_target(sdev)->target_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001704out_put_budget:
Ming Lei65c76362020-06-30 18:24:56 +08001705 scsi_mq_put_budget(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001706 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001707 case BLK_STS_OK:
1708 break;
1709 case BLK_STS_RESOURCE:
Keith Busch0512a752020-05-12 17:55:47 +09001710 case BLK_STS_ZONE_RESOURCE:
Ming Lei86ff7c22018-01-30 22:04:57 -05001711 if (atomic_read(&sdev->device_busy) ||
1712 scsi_device_blocked(sdev))
1713 ret = BLK_STS_DEV_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001714 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001715 default:
Jaesoo Leebe549d42019-04-09 17:02:22 -07001716 if (unlikely(!scsi_device_online(sdev)))
1717 scsi_req(req)->result = DID_NO_CONNECT << 16;
1718 else
1719 scsi_req(req)->result = DID_ERROR << 16;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001720 /*
Jaesoo Leebe549d42019-04-09 17:02:22 -07001721 * Make sure to release all allocated resources when
Christoph Hellwigd2852032014-01-17 12:06:53 +01001722 * we hit an error, as we will never see this command
1723 * again.
1724 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001725 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001726 scsi_mq_uninit_cmd(cmd);
Ming Lei3f0dcfb2020-07-20 10:54:35 +08001727 scsi_run_queue_async(sdev);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001728 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001729 }
1730 return ret;
1731}
1732
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001733static enum blk_eh_timer_return scsi_timeout(struct request *req,
1734 bool reserved)
1735{
1736 if (reserved)
1737 return BLK_EH_RESET_TIMER;
1738 return scsi_times_out(req);
1739}
1740
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001741static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1742 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001743{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001744 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07001745 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001746 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07001747 struct scatterlist *sg;
Bart Van Assche65ca8462020-01-22 19:56:34 -08001748 int ret = 0;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001749
Bart Van Assche8e688252017-06-02 14:21:52 -07001750 if (unchecked_isa_dma)
1751 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
1752 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
1753 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001754 if (!cmd->sense_buffer)
1755 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001756 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07001757
1758 if (scsi_host_get_prot(shost)) {
1759 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1760 shost->hostt->cmd_size;
Ming Lei3dccdf52019-04-28 15:39:32 +08001761 cmd->prot_sdb = (void *)sg + scsi_mq_inline_sgl_size(shost);
Bart Van Assche08f78432017-06-02 14:22:00 -07001762 }
1763
Bart Van Assche65ca8462020-01-22 19:56:34 -08001764 if (shost->hostt->init_cmd_priv) {
1765 ret = shost->hostt->init_cmd_priv(shost, cmd);
1766 if (ret < 0)
1767 scsi_free_sense_buffer(unchecked_isa_dma,
1768 cmd->sense_buffer);
1769 }
1770
1771 return ret;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001772}
1773
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001774static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
1775 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001776{
Bart Van Assche65ca8462020-01-22 19:56:34 -08001777 struct Scsi_Host *shost = set->driver_data;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001778 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1779
Bart Van Assche65ca8462020-01-22 19:56:34 -08001780 if (shost->hostt->exit_cmd_priv)
1781 shost->hostt->exit_cmd_priv(shost, cmd);
Bart Van Assche8e688252017-06-02 14:21:52 -07001782 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
1783 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001784}
1785
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001786static int scsi_map_queues(struct blk_mq_tag_set *set)
1787{
1788 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1789
1790 if (shost->hostt->map_queues)
1791 return shost->hostt->map_queues(shost);
Dongli Zhang99bbf482019-03-12 09:00:28 +08001792 return blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001793}
1794
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001795void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796{
Lin Ming6f381fa2012-04-12 13:50:38 +08001797 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798
Jens Axboea8474ce2007-08-07 09:02:51 +02001799 /*
1800 * this limit is imposed by hardware restrictions
1801 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001802 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07001803 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001804
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001805 if (scsi_host_prot_dma(shost)) {
1806 shost->sg_prot_tablesize =
1807 min_not_zero(shost->sg_prot_tablesize,
1808 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1809 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1810 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1811 }
1812
Christoph Hellwig1b5d9a62019-07-22 11:20:38 +02001813 if (dev->dma_mask) {
1814 shost->max_sectors = min_t(unsigned int, shost->max_sectors,
1815 dma_max_mapping_size(dev) >> SECTOR_SHIFT);
1816 }
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001817 blk_queue_max_hw_sectors(q, shost->max_sectors);
Christoph Hellwig21e07db2018-04-03 19:09:59 +02001818 if (shost->unchecked_isa_dma)
1819 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001821 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
Christoph Hellwiga8cf59a2019-01-16 17:12:15 +01001823 blk_queue_max_segment_size(q, shost->max_segment_size);
Christoph Hellwig7ad388d2019-06-17 14:19:53 +02001824 blk_queue_virt_boundary(q, shost->virt_boundary_mask);
1825 dma_set_max_seg_size(dev, queue_max_segment_size(q));
James Bottomley465ff312008-01-01 10:00:10 -06001826
1827 /*
Huacai Chen90addc62017-11-21 14:23:38 +01001828 * Set a reasonable default alignment: The larger of 32-byte (dword),
1829 * which is a common minimum for HBAs, and the minimum DMA alignment,
1830 * which is set by the platform.
1831 *
1832 * Devices that require a bigger alignment can increase it later.
James Bottomley465ff312008-01-01 10:00:10 -06001833 */
Huacai Chen90addc62017-11-21 14:23:38 +01001834 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001835}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001836EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06001837
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001838static const struct blk_mq_ops scsi_mq_ops_no_commit = {
1839 .get_budget = scsi_mq_get_budget,
1840 .put_budget = scsi_mq_put_budget,
1841 .queue_rq = scsi_queue_rq,
1842 .complete = scsi_softirq_done,
1843 .timeout = scsi_timeout,
1844#ifdef CONFIG_BLK_DEBUG_FS
1845 .show_rq = scsi_show_rq,
1846#endif
1847 .init_request = scsi_mq_init_request,
1848 .exit_request = scsi_mq_exit_request,
1849 .initialize_rq_fn = scsi_initialize_rq,
Steffen Maier82a9ac72019-08-07 16:49:47 +02001850 .cleanup_rq = scsi_cleanup_rq,
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001851 .busy = scsi_mq_lld_busy,
1852 .map_queues = scsi_map_queues,
1853};
1854
1855
1856static void scsi_commit_rqs(struct blk_mq_hw_ctx *hctx)
1857{
1858 struct request_queue *q = hctx->queue;
1859 struct scsi_device *sdev = q->queuedata;
1860 struct Scsi_Host *shost = sdev->host;
1861
1862 shost->hostt->commit_rqs(shost, hctx->queue_num);
1863}
1864
Eric Biggersf363b082017-03-30 13:39:16 -07001865static const struct blk_mq_ops scsi_mq_ops = {
Ming Lei0df21c82017-10-14 17:22:32 +08001866 .get_budget = scsi_mq_get_budget,
1867 .put_budget = scsi_mq_put_budget,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001868 .queue_rq = scsi_queue_rq,
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001869 .commit_rqs = scsi_commit_rqs,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001870 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001871 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07001872#ifdef CONFIG_BLK_DEBUG_FS
1873 .show_rq = scsi_show_rq,
1874#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001875 .init_request = scsi_mq_init_request,
1876 .exit_request = scsi_mq_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001877 .initialize_rq_fn = scsi_initialize_rq,
Ming Leib7e9e1f2019-07-25 10:05:00 +08001878 .cleanup_rq = scsi_cleanup_rq,
Jens Axboe3a7ea2c42018-10-29 10:17:28 -06001879 .busy = scsi_mq_lld_busy,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001880 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001881};
1882
1883struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
1884{
1885 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
1886 if (IS_ERR(sdev->request_queue))
1887 return NULL;
1888
1889 sdev->request_queue->queuedata = sdev;
1890 __scsi_init_queue(sdev->host, sdev->request_queue);
Christoph Hellwig17cb9602018-03-13 17:28:41 +01001891 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001892 return sdev->request_queue;
1893}
1894
1895int scsi_mq_setup_tags(struct Scsi_Host *shost)
1896{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001897 unsigned int cmd_size, sgl_size;
Ye Bin840e1b52020-05-18 15:47:32 +08001898 struct blk_mq_tag_set *tag_set = &shost->tag_set;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001899
Michael Schmitz9393c8de2019-11-05 15:49:10 +13001900 sgl_size = max_t(unsigned int, sizeof(struct scatterlist),
1901 scsi_mq_inline_sgl_size(shost));
Christoph Hellwigd2852032014-01-17 12:06:53 +01001902 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1903 if (scsi_host_get_prot(shost))
Ming Lei92524fa2019-04-28 15:39:31 +08001904 cmd_size += sizeof(struct scsi_data_buffer) +
1905 sizeof(struct scatterlist) * SCSI_INLINE_PROT_SG_CNT;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001906
Ye Bin840e1b52020-05-18 15:47:32 +08001907 memset(tag_set, 0, sizeof(*tag_set));
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001908 if (shost->hostt->commit_rqs)
Ye Bin840e1b52020-05-18 15:47:32 +08001909 tag_set->ops = &scsi_mq_ops;
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001910 else
Ye Bin840e1b52020-05-18 15:47:32 +08001911 tag_set->ops = &scsi_mq_ops_no_commit;
1912 tag_set->nr_hw_queues = shost->nr_hw_queues ? : 1;
1913 tag_set->queue_depth = shost->can_queue;
1914 tag_set->cmd_size = cmd_size;
1915 tag_set->numa_node = NUMA_NO_NODE;
1916 tag_set->flags = BLK_MQ_F_SHOULD_MERGE;
1917 tag_set->flags |=
Shaohua Li24391c02015-01-23 14:18:00 -07001918 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Ye Bin840e1b52020-05-18 15:47:32 +08001919 tag_set->driver_data = shost;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001920
Ye Bin840e1b52020-05-18 15:47:32 +08001921 return blk_mq_alloc_tag_set(tag_set);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001922}
1923
1924void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1925{
1926 blk_mq_free_tag_set(&shost->tag_set);
1927}
1928
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001929/**
1930 * scsi_device_from_queue - return sdev associated with a request_queue
1931 * @q: The request queue to return the sdev from
1932 *
1933 * Return the sdev associated with a request queue or NULL if the
1934 * request_queue does not reference a SCSI device.
1935 */
1936struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1937{
1938 struct scsi_device *sdev = NULL;
1939
Steffen Maier6b6fa7a2019-08-07 16:49:48 +02001940 if (q->mq_ops == &scsi_mq_ops_no_commit ||
1941 q->mq_ops == &scsi_mq_ops)
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001942 sdev = q->queuedata;
1943 if (!sdev || !get_device(&sdev->sdev_gendev))
1944 sdev = NULL;
1945
1946 return sdev;
1947}
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001948
André Almeidaea941012020-04-19 02:01:48 -03001949/**
1950 * scsi_block_requests - Utility function used by low-level drivers to prevent
1951 * further commands from being queued to the device.
1952 * @shost: host in question
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 *
André Almeidaea941012020-04-19 02:01:48 -03001954 * There is no timer nor any other means by which the requests get unblocked
1955 * other than the low-level driver calling scsi_unblock_requests().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 */
1957void scsi_block_requests(struct Scsi_Host *shost)
1958{
1959 shost->host_self_blocked = 1;
1960}
1961EXPORT_SYMBOL(scsi_block_requests);
1962
André Almeidaea941012020-04-19 02:01:48 -03001963/**
1964 * scsi_unblock_requests - Utility function used by low-level drivers to allow
1965 * further commands to be queued to the device.
1966 * @shost: host in question
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 *
André Almeidaea941012020-04-19 02:01:48 -03001968 * There is no timer nor any other means by which the requests get unblocked
1969 * other than the low-level driver calling scsi_unblock_requests(). This is done
1970 * as an API function so that changes to the internals of the scsi mid-layer
1971 * won't require wholesale changes to drivers that use this feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 */
1973void scsi_unblock_requests(struct Scsi_Host *shost)
1974{
1975 shost->host_self_blocked = 0;
1976 scsi_run_host_queues(shost);
1977}
1978EXPORT_SYMBOL(scsi_unblock_requests);
1979
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980void scsi_exit_queue(void)
1981{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03001982 kmem_cache_destroy(scsi_sense_cache);
1983 kmem_cache_destroy(scsi_sense_isadma_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984}
James Bottomley5baba832006-03-18 14:10:35 -06001985
1986/**
1987 * scsi_mode_select - issue a mode select
1988 * @sdev: SCSI device to be queried
1989 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1990 * @sp: Save page bit (0 == don't save, 1 == save)
1991 * @modepage: mode page being requested
1992 * @buffer: request buffer (may not be smaller than eight bytes)
1993 * @len: length of request buffer.
1994 * @timeout: command timeout
1995 * @retries: number of retries before failing
1996 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001997 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001998 * must be SCSI_SENSE_BUFFERSIZE big.
1999 *
2000 * Returns zero if successful; negative error number or scsi
2001 * status on error
2002 *
2003 */
2004int
2005scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2006 unsigned char *buffer, int len, int timeout, int retries,
2007 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2008{
2009 unsigned char cmd[10];
2010 unsigned char *real_buffer;
2011 int ret;
2012
2013 memset(cmd, 0, sizeof(cmd));
2014 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2015
2016 if (sdev->use_10_for_ms) {
2017 if (len > 65535)
2018 return -EINVAL;
2019 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2020 if (!real_buffer)
2021 return -ENOMEM;
2022 memcpy(real_buffer + 8, buffer, len);
2023 len += 8;
2024 real_buffer[0] = 0;
2025 real_buffer[1] = 0;
2026 real_buffer[2] = data->medium_type;
2027 real_buffer[3] = data->device_specific;
2028 real_buffer[4] = data->longlba ? 0x01 : 0;
2029 real_buffer[5] = 0;
2030 real_buffer[6] = data->block_descriptor_length >> 8;
2031 real_buffer[7] = data->block_descriptor_length;
2032
2033 cmd[0] = MODE_SELECT_10;
2034 cmd[7] = len >> 8;
2035 cmd[8] = len;
2036 } else {
2037 if (len > 255 || data->block_descriptor_length > 255 ||
2038 data->longlba)
2039 return -EINVAL;
2040
2041 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2042 if (!real_buffer)
2043 return -ENOMEM;
2044 memcpy(real_buffer + 4, buffer, len);
2045 len += 4;
2046 real_buffer[0] = 0;
2047 real_buffer[1] = data->medium_type;
2048 real_buffer[2] = data->device_specific;
2049 real_buffer[3] = data->block_descriptor_length;
James Bottomley5baba832006-03-18 14:10:35 -06002050
2051 cmd[0] = MODE_SELECT;
2052 cmd[4] = len;
2053 }
2054
2055 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002056 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002057 kfree(real_buffer);
2058 return ret;
2059}
2060EXPORT_SYMBOL_GPL(scsi_mode_select);
2061
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062/**
Rob Landleyeb448202007-11-03 13:30:39 -05002063 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002064 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 * @dbd: set if mode sense will allow block descriptors to be returned
2066 * @modepage: mode page being requested
2067 * @buffer: request buffer (may not be smaller than eight bytes)
2068 * @len: length of request buffer.
2069 * @timeout: command timeout
2070 * @retries: number of retries before failing
2071 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002072 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002073 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 *
2075 * Returns zero if unsuccessful, or the header offset (either 4
2076 * or 8 depending on whether a six or ten byte command was
2077 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002078 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079int
James Bottomley1cf72692005-08-28 11:27:01 -05002080scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002082 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2083{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 unsigned char cmd[12];
2085 int use_10_for_ms;
2086 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002087 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002088 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089
2090 memset(data, 0, sizeof(*data));
2091 memset(&cmd[0], 0, 12);
Can Guo0ec96912019-12-05 02:14:25 +00002092
2093 dbd = sdev->set_dbd_for_ms ? 8 : dbd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2095 cmd[2] = modepage;
2096
James Bottomleyea73a9f2005-08-28 11:33:52 -05002097 /* caller might not be interested in sense, but we need it */
2098 if (!sshdr)
2099 sshdr = &my_sshdr;
2100
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002102 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103
2104 if (use_10_for_ms) {
2105 if (len < 8)
2106 len = 8;
2107
2108 cmd[0] = MODE_SENSE_10;
2109 cmd[8] = len;
2110 header_length = 8;
2111 } else {
2112 if (len < 4)
2113 len = 4;
2114
2115 cmd[0] = MODE_SENSE;
2116 cmd[4] = len;
2117 header_length = 4;
2118 }
2119
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 memset(buffer, 0, len);
2121
James Bottomley1cf72692005-08-28 11:27:01 -05002122 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002123 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124
2125 /* This code looks awful: what it's doing is making sure an
2126 * ILLEGAL REQUEST sense return identifies the actual command
2127 * byte as the problem. MODE_SENSE commands can return
2128 * ILLEGAL REQUEST if the code page isn't supported */
2129
James Bottomley1cf72692005-08-28 11:27:01 -05002130 if (use_10_for_ms && !scsi_status_is_good(result) &&
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002131 driver_byte(result) == DRIVER_SENSE) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002132 if (scsi_sense_valid(sshdr)) {
2133 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2134 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Bean Huo4c7b4d62020-06-19 17:41:17 +02002135 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 * Invalid command operation code
2137 */
James Bottomley1cf72692005-08-28 11:27:01 -05002138 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 goto retry;
2140 }
2141 }
2142 }
2143
Bean Huo4c7b4d62020-06-19 17:41:17 +02002144 if (scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002145 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2146 (modepage == 6 || modepage == 8))) {
2147 /* Initio breakage? */
2148 header_length = 0;
2149 data->length = 13;
2150 data->medium_type = 0;
2151 data->device_specific = 0;
2152 data->longlba = 0;
2153 data->block_descriptor_length = 0;
Bean Huo4c7b4d62020-06-19 17:41:17 +02002154 } else if (use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 data->length = buffer[0]*256 + buffer[1] + 2;
2156 data->medium_type = buffer[2];
2157 data->device_specific = buffer[3];
2158 data->longlba = buffer[4] & 0x01;
2159 data->block_descriptor_length = buffer[6]*256
2160 + buffer[7];
2161 } else {
2162 data->length = buffer[0] + 1;
2163 data->medium_type = buffer[1];
2164 data->device_specific = buffer[2];
2165 data->block_descriptor_length = buffer[3];
2166 }
Al Viro6d73c852006-02-23 02:03:16 +01002167 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002168 } else if ((status_byte(result) == CHECK_CONDITION) &&
2169 scsi_sense_valid(sshdr) &&
2170 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2171 retry_count--;
2172 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 }
2174
James Bottomley1cf72692005-08-28 11:27:01 -05002175 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176}
2177EXPORT_SYMBOL(scsi_mode_sense);
2178
James Bottomley001aac22007-12-02 19:10:40 +02002179/**
2180 * scsi_test_unit_ready - test if unit is ready
2181 * @sdev: scsi device to change the state of.
2182 * @timeout: command timeout
2183 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002184 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002185 *
2186 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002187 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002188 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189int
James Bottomley001aac22007-12-02 19:10:40 +02002190scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002191 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 char cmd[] = {
2194 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2195 };
2196 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002197
James Bottomley001aac22007-12-02 19:10:40 +02002198 /* try to eat the UNIT_ATTENTION if there are enough retries */
2199 do {
2200 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
Bart Van Assche9b91fd32018-02-12 10:57:52 -08002201 timeout, 1, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002202 if (sdev->removable && scsi_sense_valid(sshdr) &&
2203 sshdr->sense_key == UNIT_ATTENTION)
2204 sdev->changed = 1;
2205 } while (scsi_sense_valid(sshdr) &&
2206 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002207
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 return result;
2209}
2210EXPORT_SYMBOL(scsi_test_unit_ready);
2211
2212/**
Rob Landleyeb448202007-11-03 13:30:39 -05002213 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 * @sdev: scsi device to change the state of.
2215 * @state: state to change to.
2216 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002217 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002219 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220int
2221scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2222{
2223 enum scsi_device_state oldstate = sdev->sdev_state;
2224
2225 if (state == oldstate)
2226 return 0;
2227
2228 switch (state) {
2229 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002230 switch (oldstate) {
2231 case SDEV_CREATED_BLOCK:
2232 break;
2233 default:
2234 goto illegal;
2235 }
2236 break;
Bean Huo4c7b4d62020-06-19 17:41:17 +02002237
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 case SDEV_RUNNING:
2239 switch (oldstate) {
2240 case SDEV_CREATED:
2241 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002242 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 case SDEV_QUIESCE:
2244 case SDEV_BLOCK:
2245 break;
2246 default:
2247 goto illegal;
2248 }
2249 break;
2250
2251 case SDEV_QUIESCE:
2252 switch (oldstate) {
2253 case SDEV_RUNNING:
2254 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002255 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 break;
2257 default:
2258 goto illegal;
2259 }
2260 break;
2261
2262 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002263 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 switch (oldstate) {
2265 case SDEV_CREATED:
2266 case SDEV_RUNNING:
2267 case SDEV_QUIESCE:
2268 case SDEV_BLOCK:
2269 break;
2270 default:
2271 goto illegal;
2272 }
2273 break;
2274
2275 case SDEV_BLOCK:
2276 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002278 case SDEV_CREATED_BLOCK:
Dexuan Cui6cbb7ae2020-04-17 17:40:45 -07002279 case SDEV_QUIESCE:
Hannes Reineckea33e5bf2018-10-07 10:35:35 +02002280 case SDEV_OFFLINE:
James Bottomley6f4267e2008-08-22 16:53:31 -05002281 break;
2282 default:
2283 goto illegal;
2284 }
2285 break;
2286
2287 case SDEV_CREATED_BLOCK:
2288 switch (oldstate) {
2289 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290 break;
2291 default:
2292 goto illegal;
2293 }
2294 break;
2295
2296 case SDEV_CANCEL:
2297 switch (oldstate) {
2298 case SDEV_CREATED:
2299 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002300 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002302 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 break;
2304 default:
2305 goto illegal;
2306 }
2307 break;
2308
2309 case SDEV_DEL:
2310 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002311 case SDEV_CREATED:
2312 case SDEV_RUNNING:
2313 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002314 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002316 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002317 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 break;
2319 default:
2320 goto illegal;
2321 }
2322 break;
2323
2324 }
Ewan D. Milneb0962c52020-03-11 10:39:30 -04002325 sdev->offline_already = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 sdev->sdev_state = state;
2327 return 0;
2328
2329 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002330 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002331 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002332 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002333 scsi_device_state_name(oldstate),
2334 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 );
2336 return -EINVAL;
2337}
2338EXPORT_SYMBOL(scsi_device_set_state);
2339
2340/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002341 * sdev_evt_emit - emit a single SCSI device uevent
2342 * @sdev: associated SCSI device
2343 * @evt: event to emit
2344 *
2345 * Send a single uevent (scsi_event) to the associated scsi_device.
2346 */
2347static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2348{
2349 int idx = 0;
2350 char *envp[3];
2351
2352 switch (evt->evt_type) {
2353 case SDEV_EVT_MEDIA_CHANGE:
2354 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2355 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002356 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002357 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002358 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2359 break;
2360 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2361 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2362 break;
2363 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2364 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2365 break;
2366 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2367 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2368 break;
2369 case SDEV_EVT_LUN_CHANGE_REPORTED:
2370 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2371 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002372 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2373 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2374 break;
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002375 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2376 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2377 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002378 default:
2379 /* do nothing */
2380 break;
2381 }
2382
2383 envp[idx++] = NULL;
2384
2385 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2386}
2387
2388/**
2389 * sdev_evt_thread - send a uevent for each scsi event
2390 * @work: work struct for scsi_device
2391 *
2392 * Dispatch queued events to their associated scsi_device kobjects
2393 * as uevents.
2394 */
2395void scsi_evt_thread(struct work_struct *work)
2396{
2397 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002398 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002399 LIST_HEAD(event_list);
2400
2401 sdev = container_of(work, struct scsi_device, event_work);
2402
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002403 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2404 if (test_and_clear_bit(evt_type, sdev->pending_events))
2405 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2406
Jeff Garzika341cd02007-10-29 17:15:22 -04002407 while (1) {
2408 struct scsi_event *evt;
2409 struct list_head *this, *tmp;
2410 unsigned long flags;
2411
2412 spin_lock_irqsave(&sdev->list_lock, flags);
2413 list_splice_init(&sdev->event_list, &event_list);
2414 spin_unlock_irqrestore(&sdev->list_lock, flags);
2415
2416 if (list_empty(&event_list))
2417 break;
2418
2419 list_for_each_safe(this, tmp, &event_list) {
2420 evt = list_entry(this, struct scsi_event, node);
2421 list_del(&evt->node);
2422 scsi_evt_emit(sdev, evt);
2423 kfree(evt);
2424 }
2425 }
2426}
2427
2428/**
2429 * sdev_evt_send - send asserted event to uevent thread
2430 * @sdev: scsi_device event occurred on
2431 * @evt: event to send
2432 *
2433 * Assert scsi device event asynchronously.
2434 */
2435void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2436{
2437 unsigned long flags;
2438
Kay Sievers4d1566e2008-03-19 13:04:47 +01002439#if 0
2440 /* FIXME: currently this check eliminates all media change events
2441 * for polled devices. Need to update to discriminate between AN
2442 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002443 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2444 kfree(evt);
2445 return;
2446 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002447#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002448
2449 spin_lock_irqsave(&sdev->list_lock, flags);
2450 list_add_tail(&evt->node, &sdev->event_list);
2451 schedule_work(&sdev->event_work);
2452 spin_unlock_irqrestore(&sdev->list_lock, flags);
2453}
2454EXPORT_SYMBOL_GPL(sdev_evt_send);
2455
2456/**
2457 * sdev_evt_alloc - allocate a new scsi event
2458 * @evt_type: type of event to allocate
2459 * @gfpflags: GFP flags for allocation
2460 *
2461 * Allocates and returns a new scsi_event.
2462 */
2463struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2464 gfp_t gfpflags)
2465{
2466 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2467 if (!evt)
2468 return NULL;
2469
2470 evt->evt_type = evt_type;
2471 INIT_LIST_HEAD(&evt->node);
2472
2473 /* evt_type-specific initialization, if any */
2474 switch (evt_type) {
2475 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002476 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2477 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2478 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2479 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2480 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002481 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002482 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002483 default:
2484 /* do nothing */
2485 break;
2486 }
2487
2488 return evt;
2489}
2490EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2491
2492/**
2493 * sdev_evt_send_simple - send asserted event to uevent thread
2494 * @sdev: scsi_device event occurred on
2495 * @evt_type: type of event to send
2496 * @gfpflags: GFP flags for allocation
2497 *
2498 * Assert scsi device event asynchronously, given an event type.
2499 */
2500void sdev_evt_send_simple(struct scsi_device *sdev,
2501 enum scsi_device_event evt_type, gfp_t gfpflags)
2502{
2503 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2504 if (!evt) {
2505 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2506 evt_type);
2507 return;
2508 }
2509
2510 sdev_evt_send(sdev, evt);
2511}
2512EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2513
2514/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 * scsi_device_quiesce - Block user issued commands.
2516 * @sdev: scsi device to quiesce.
2517 *
2518 * This works by trying to transition to the SDEV_QUIESCE state
2519 * (which must be a legal transition). When the device is in this
2520 * state, only special requests will be accepted, all others will
2521 * be deferred. Since special requests may also be requeued requests,
Bean Huo4c7b4d62020-06-19 17:41:17 +02002522 * a successful return doesn't guarantee the device will be
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523 * totally quiescent.
2524 *
2525 * Must be called with user context, may sleep.
2526 *
2527 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002528 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529int
2530scsi_device_quiesce(struct scsi_device *sdev)
2531{
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002532 struct request_queue *q = sdev->request_queue;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002533 int err;
2534
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002535 /*
2536 * It is allowed to call scsi_device_quiesce() multiple times from
2537 * the same context but concurrent scsi_device_quiesce() calls are
2538 * not allowed.
2539 */
2540 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2541
Bart Van Asschecd84a622018-09-26 14:01:04 -07002542 if (sdev->quiesced_by == current)
2543 return 0;
2544
2545 blk_set_pm_only(q);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002546
2547 blk_mq_freeze_queue(q);
2548 /*
Bart Van Asschecd84a622018-09-26 14:01:04 -07002549 * Ensure that the effect of blk_set_pm_only() will be visible
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002550 * for percpu_ref_tryget() callers that occur after the queue
2551 * unfreeze even if the queue was already frozen before this function
2552 * was called. See also https://lwn.net/Articles/573497/.
2553 */
2554 synchronize_rcu();
2555 blk_mq_unfreeze_queue(q);
2556
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002557 mutex_lock(&sdev->state_mutex);
2558 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002559 if (err == 0)
2560 sdev->quiesced_by = current;
2561 else
Bart Van Asschecd84a622018-09-26 14:01:04 -07002562 blk_clear_pm_only(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002563 mutex_unlock(&sdev->state_mutex);
2564
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002565 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566}
2567EXPORT_SYMBOL(scsi_device_quiesce);
2568
2569/**
2570 * scsi_device_resume - Restart user issued commands to a quiesced device.
2571 * @sdev: scsi device to resume.
2572 *
2573 * Moves the device from quiesced back to running and restarts the
2574 * queues.
2575 *
2576 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002577 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002578void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002580 /* check if the device state was mutated prior to resume, and if
2581 * so assume the state is being managed elsewhere (for example
2582 * device deleted during suspend)
2583 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002584 mutex_lock(&sdev->state_mutex);
Bart Van Assche17605af2019-03-15 16:27:58 -07002585 if (sdev->quiesced_by) {
2586 sdev->quiesced_by = NULL;
2587 blk_clear_pm_only(sdev->request_queue);
2588 }
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002589 if (sdev->sdev_state == SDEV_QUIESCE)
2590 scsi_device_set_state(sdev, SDEV_RUNNING);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002591 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592}
2593EXPORT_SYMBOL(scsi_device_resume);
2594
2595static void
2596device_quiesce_fn(struct scsi_device *sdev, void *data)
2597{
2598 scsi_device_quiesce(sdev);
2599}
2600
2601void
2602scsi_target_quiesce(struct scsi_target *starget)
2603{
2604 starget_for_each_device(starget, NULL, device_quiesce_fn);
2605}
2606EXPORT_SYMBOL(scsi_target_quiesce);
2607
2608static void
2609device_resume_fn(struct scsi_device *sdev, void *data)
2610{
2611 scsi_device_resume(sdev);
2612}
2613
2614void
2615scsi_target_resume(struct scsi_target *starget)
2616{
2617 starget_for_each_device(starget, NULL, device_resume_fn);
2618}
2619EXPORT_SYMBOL(scsi_target_resume);
2620
2621/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002622 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2623 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002625 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002627 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002628 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002629 * Notes:
2630 * This routine transitions the device to the SDEV_BLOCK state (which must be
2631 * a legal transition). When the device is in this state, command processing
2632 * is paused until the device leaves the SDEV_BLOCK state. See also
2633 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002634 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002635int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636{
Jens Axboe165125e2007-07-24 09:28:11 +02002637 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638 int err = 0;
2639
2640 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002641 if (err) {
2642 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2643
2644 if (err)
2645 return err;
2646 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647
Bean Huo4c7b4d62020-06-19 17:41:17 +02002648 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649 * The device has transitioned to SDEV_BLOCK. Stop the
2650 * block layer from calling the midlayer with this device's
Bean Huo4c7b4d62020-06-19 17:41:17 +02002651 * request queue.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652 */
Jens Axboef664a3c2018-11-01 16:36:27 -06002653 blk_mq_quiesce_queue_nowait(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 return 0;
2655}
Bart Van Assche551eb592017-06-02 14:21:53 -07002656EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2657
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002659 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2660 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002662 * Pause SCSI command processing on the specified device and wait until all
2663 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002665 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002667 * Note:
2668 * This routine transitions the device to the SDEV_BLOCK state (which must be
2669 * a legal transition). When the device is in this state, command processing
2670 * is paused until the device leaves the SDEV_BLOCK state. See also
2671 * scsi_internal_device_unblock().
Rob Landleyeb448202007-11-03 13:30:39 -05002672 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002673static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002674{
Bart Van Assche551eb592017-06-02 14:21:53 -07002675 struct request_queue *q = sdev->request_queue;
2676 int err;
2677
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002678 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07002679 err = scsi_internal_device_block_nowait(sdev);
Jens Axboef664a3c2018-11-01 16:36:27 -06002680 if (err == 0)
2681 blk_mq_quiesce_queue(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002682 mutex_unlock(&sdev->state_mutex);
2683
Bart Van Assche551eb592017-06-02 14:21:53 -07002684 return err;
2685}
Bean Huo4c7b4d62020-06-19 17:41:17 +02002686
Bart Van Assche66483a42017-06-02 14:21:56 -07002687void scsi_start_queue(struct scsi_device *sdev)
2688{
2689 struct request_queue *q = sdev->request_queue;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002690
Jens Axboef664a3c2018-11-01 16:36:27 -06002691 blk_mq_unquiesce_queue(q);
Bart Van Assche66483a42017-06-02 14:21:56 -07002692}
2693
Linus Torvalds1da177e2005-04-16 15:20:36 -07002694/**
Bart Van Assche43f75712017-06-02 14:21:54 -07002695 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07002697 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002698 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002699 * Restart the device queue for a previously suspended SCSI device. Does not
2700 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002702 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002704 * Notes:
2705 * This routine transitions the device to the SDEV_RUNNING state or to one of
2706 * the offline states (which must be a legal transition) allowing the midlayer
2707 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002708 */
Bart Van Assche43f75712017-06-02 14:21:54 -07002709int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2710 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711{
Bart Van Assche09addb12019-08-01 15:38:12 -07002712 switch (new_state) {
2713 case SDEV_RUNNING:
2714 case SDEV_TRANSPORT_OFFLINE:
2715 break;
2716 default:
2717 return -EINVAL;
2718 }
2719
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002720 /*
2721 * Try to transition the scsi device to SDEV_RUNNING or one of the
2722 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002724 switch (sdev->sdev_state) {
2725 case SDEV_BLOCK:
2726 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002727 sdev->sdev_state = new_state;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002728 break;
2729 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002730 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2731 new_state == SDEV_OFFLINE)
2732 sdev->sdev_state = new_state;
2733 else
2734 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002735 break;
2736 case SDEV_CANCEL:
2737 case SDEV_OFFLINE:
2738 break;
2739 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002740 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002741 }
Bart Van Assche66483a42017-06-02 14:21:56 -07002742 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002743
2744 return 0;
2745}
Bart Van Assche43f75712017-06-02 14:21:54 -07002746EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2747
2748/**
2749 * scsi_internal_device_unblock - resume a device after a block request
2750 * @sdev: device to resume
2751 * @new_state: state to set the device to after unblocking
2752 *
2753 * Restart the device queue for a previously suspended SCSI device. May sleep.
2754 *
2755 * Returns zero if successful or a negative error code upon failure.
2756 *
2757 * Notes:
2758 * This routine transitions the device to the SDEV_RUNNING state or to one of
2759 * the offline states (which must be a legal transition) allowing the midlayer
2760 * to goose the queue for this device.
2761 */
2762static int scsi_internal_device_unblock(struct scsi_device *sdev,
2763 enum scsi_device_state new_state)
2764{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002765 int ret;
2766
2767 mutex_lock(&sdev->state_mutex);
2768 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2769 mutex_unlock(&sdev->state_mutex);
2770
2771 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07002772}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773
2774static void
2775device_block(struct scsi_device *sdev, void *data)
2776{
Bart Van Assche94ef80a2019-08-01 15:38:13 -07002777 int ret;
2778
2779 ret = scsi_internal_device_block(sdev);
2780
2781 WARN_ONCE(ret, "scsi_internal_device_block(%s) failed: ret = %d\n",
2782 dev_name(&sdev->sdev_gendev), ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783}
2784
2785static int
2786target_block(struct device *dev, void *data)
2787{
2788 if (scsi_is_target_device(dev))
2789 starget_for_each_device(to_scsi_target(dev), NULL,
2790 device_block);
2791 return 0;
2792}
2793
2794void
2795scsi_target_block(struct device *dev)
2796{
2797 if (scsi_is_target_device(dev))
2798 starget_for_each_device(to_scsi_target(dev), NULL,
2799 device_block);
2800 else
2801 device_for_each_child(dev, NULL, target_block);
2802}
2803EXPORT_SYMBOL_GPL(scsi_target_block);
2804
2805static void
2806device_unblock(struct scsi_device *sdev, void *data)
2807{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002808 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809}
2810
2811static int
2812target_unblock(struct device *dev, void *data)
2813{
2814 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002815 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816 device_unblock);
2817 return 0;
2818}
2819
2820void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002821scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822{
2823 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002824 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002825 device_unblock);
2826 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002827 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828}
2829EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002830
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002831int
2832scsi_host_block(struct Scsi_Host *shost)
2833{
2834 struct scsi_device *sdev;
2835 int ret = 0;
2836
Ming Leif9836222020-04-23 10:07:13 +08002837 /*
2838 * Call scsi_internal_device_block_nowait so we can avoid
2839 * calling synchronize_rcu() for each LUN.
2840 */
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002841 shost_for_each_device(sdev, shost) {
Ming Leif9836222020-04-23 10:07:13 +08002842 mutex_lock(&sdev->state_mutex);
2843 ret = scsi_internal_device_block_nowait(sdev);
2844 mutex_unlock(&sdev->state_mutex);
Ye Binf30785d2020-07-17 17:09:20 +08002845 if (ret) {
2846 scsi_device_put(sdev);
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002847 break;
Ye Binf30785d2020-07-17 17:09:20 +08002848 }
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002849 }
Ming Leif9836222020-04-23 10:07:13 +08002850
2851 /*
2852 * SCSI never enables blk-mq's BLK_MQ_F_BLOCKING flag so
2853 * calling synchronize_rcu() once is enough.
2854 */
2855 WARN_ON_ONCE(shost->tag_set.flags & BLK_MQ_F_BLOCKING);
2856
2857 if (!ret)
2858 synchronize_rcu();
2859
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002860 return ret;
2861}
2862EXPORT_SYMBOL_GPL(scsi_host_block);
2863
2864int
2865scsi_host_unblock(struct Scsi_Host *shost, int new_state)
2866{
2867 struct scsi_device *sdev;
2868 int ret = 0;
2869
2870 shost_for_each_device(sdev, shost) {
2871 ret = scsi_internal_device_unblock(sdev, new_state);
Ye Bin4dea1702020-05-18 15:44:20 +08002872 if (ret) {
2873 scsi_device_put(sdev);
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002874 break;
Ye Bin4dea1702020-05-18 15:44:20 +08002875 }
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002876 }
2877 return ret;
2878}
2879EXPORT_SYMBOL_GPL(scsi_host_unblock);
2880
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002881/**
2882 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002883 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002884 * @sg_count: number of segments in sg
2885 * @offset: offset in bytes into sg, on return offset into the mapped area
2886 * @len: bytes to map, on return number of bytes mapped
2887 *
2888 * Returns virtual address of the start of the mapped page
2889 */
Jens Axboec6132da2007-10-16 11:08:49 +02002890void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002891 size_t *offset, size_t *len)
2892{
2893 int i;
2894 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002895 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002896 struct page *page;
2897
Andrew Morton22cfefb2007-02-05 16:39:03 -08002898 WARN_ON(!irqs_disabled());
2899
Jens Axboec6132da2007-10-16 11:08:49 +02002900 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002901 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002902 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002903 if (sg_len > *offset)
2904 break;
2905 }
2906
2907 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002908 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2909 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002910 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002911 WARN_ON(1);
2912 return NULL;
2913 }
2914
2915 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002916 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002917
2918 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002919 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002920 *offset &= ~PAGE_MASK;
2921
2922 /* Bytes in this sg-entry from *offset to the end of the page */
2923 sg_len = PAGE_SIZE - *offset;
2924 if (*len > sg_len)
2925 *len = sg_len;
2926
Cong Wang77dfce02011-11-25 23:14:23 +08002927 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002928}
2929EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2930
2931/**
Rob Landleyeb448202007-11-03 13:30:39 -05002932 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002933 * @virt: virtual address to be unmapped
2934 */
2935void scsi_kunmap_atomic_sg(void *virt)
2936{
Cong Wang77dfce02011-11-25 23:14:23 +08002937 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002938}
2939EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002940
2941void sdev_disable_disk_events(struct scsi_device *sdev)
2942{
2943 atomic_inc(&sdev->disk_events_disable_depth);
2944}
2945EXPORT_SYMBOL(sdev_disable_disk_events);
2946
2947void sdev_enable_disk_events(struct scsi_device *sdev)
2948{
2949 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2950 return;
2951 atomic_dec(&sdev->disk_events_disable_depth);
2952}
2953EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002954
2955/**
2956 * scsi_vpd_lun_id - return a unique device identification
2957 * @sdev: SCSI device
2958 * @id: buffer for the identification
2959 * @id_len: length of the buffer
2960 *
2961 * Copies a unique device identification into @id based
2962 * on the information in the VPD page 0x83 of the device.
2963 * The string will be formatted as a SCSI name string.
2964 *
2965 * Returns the length of the identification or error on failure.
2966 * If the identifier is longer than the supplied buffer the actual
2967 * identifier length is returned and the buffer is not zero-padded.
2968 */
2969int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
2970{
2971 u8 cur_id_type = 0xff;
2972 u8 cur_id_size = 0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002973 const unsigned char *d, *cur_id_str;
2974 const struct scsi_vpd *vpd_pg83;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002975 int id_size = -EINVAL;
2976
2977 rcu_read_lock();
2978 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
2979 if (!vpd_pg83) {
2980 rcu_read_unlock();
2981 return -ENXIO;
2982 }
2983
2984 /*
2985 * Look for the correct descriptor.
2986 * Order of preference for lun descriptor:
2987 * - SCSI name string
2988 * - NAA IEEE Registered Extended
2989 * - EUI-64 based 16-byte
2990 * - EUI-64 based 12-byte
2991 * - NAA IEEE Registered
2992 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02002993 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002994 * as longer descriptors reduce the likelyhood
2995 * of identification clashes.
2996 */
2997
2998 /* The id string must be at least 20 bytes + terminating NULL byte */
2999 if (id_len < 21) {
3000 rcu_read_unlock();
3001 return -EINVAL;
3002 }
3003
3004 memset(id, 0, id_len);
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003005 d = vpd_pg83->data + 4;
3006 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003007 /* Skip designators not referring to the LUN */
3008 if ((d[1] & 0x30) != 0x00)
3009 goto next_desig;
3010
3011 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02003012 case 0x1:
3013 /* T10 Vendor ID */
3014 if (cur_id_size > d[3])
3015 break;
3016 /* Prefer anything */
3017 if (cur_id_type > 0x01 && cur_id_type != 0xff)
3018 break;
3019 cur_id_size = d[3];
3020 if (cur_id_size + 4 > id_len)
3021 cur_id_size = id_len - 4;
3022 cur_id_str = d + 4;
3023 cur_id_type = d[1] & 0xf;
3024 id_size = snprintf(id, id_len, "t10.%*pE",
3025 cur_id_size, cur_id_str);
3026 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003027 case 0x2:
3028 /* EUI-64 */
3029 if (cur_id_size > d[3])
3030 break;
3031 /* Prefer NAA IEEE Registered Extended */
3032 if (cur_id_type == 0x3 &&
3033 cur_id_size == d[3])
3034 break;
3035 cur_id_size = d[3];
3036 cur_id_str = d + 4;
3037 cur_id_type = d[1] & 0xf;
3038 switch (cur_id_size) {
3039 case 8:
3040 id_size = snprintf(id, id_len,
3041 "eui.%8phN",
3042 cur_id_str);
3043 break;
3044 case 12:
3045 id_size = snprintf(id, id_len,
3046 "eui.%12phN",
3047 cur_id_str);
3048 break;
3049 case 16:
3050 id_size = snprintf(id, id_len,
3051 "eui.%16phN",
3052 cur_id_str);
3053 break;
3054 default:
3055 cur_id_size = 0;
3056 break;
3057 }
3058 break;
3059 case 0x3:
3060 /* NAA */
3061 if (cur_id_size > d[3])
3062 break;
3063 cur_id_size = d[3];
3064 cur_id_str = d + 4;
3065 cur_id_type = d[1] & 0xf;
3066 switch (cur_id_size) {
3067 case 8:
3068 id_size = snprintf(id, id_len,
3069 "naa.%8phN",
3070 cur_id_str);
3071 break;
3072 case 16:
3073 id_size = snprintf(id, id_len,
3074 "naa.%16phN",
3075 cur_id_str);
3076 break;
3077 default:
3078 cur_id_size = 0;
3079 break;
3080 }
3081 break;
3082 case 0x8:
3083 /* SCSI name string */
3084 if (cur_id_size + 4 > d[3])
3085 break;
3086 /* Prefer others for truncated descriptor */
3087 if (cur_id_size && d[3] > id_len)
3088 break;
3089 cur_id_size = id_size = d[3];
3090 cur_id_str = d + 4;
3091 cur_id_type = d[1] & 0xf;
3092 if (cur_id_size >= id_len)
3093 cur_id_size = id_len - 1;
3094 memcpy(id, cur_id_str, cur_id_size);
3095 /* Decrease priority for truncated descriptor */
3096 if (cur_id_size != id_size)
3097 cur_id_size = 6;
3098 break;
3099 default:
3100 break;
3101 }
3102next_desig:
3103 d += d[3] + 4;
3104 }
3105 rcu_read_unlock();
3106
3107 return id_size;
3108}
3109EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003110
3111/*
3112 * scsi_vpd_tpg_id - return a target port group identifier
3113 * @sdev: SCSI device
3114 *
3115 * Returns the Target Port Group identifier from the information
3116 * froom VPD page 0x83 of the device.
3117 *
3118 * Returns the identifier or error on failure.
3119 */
3120int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3121{
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003122 const unsigned char *d;
3123 const struct scsi_vpd *vpd_pg83;
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003124 int group_id = -EAGAIN, rel_port = -1;
3125
3126 rcu_read_lock();
3127 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3128 if (!vpd_pg83) {
3129 rcu_read_unlock();
3130 return -ENXIO;
3131 }
3132
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003133 d = vpd_pg83->data + 4;
3134 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003135 switch (d[1] & 0xf) {
3136 case 0x4:
3137 /* Relative target port */
3138 rel_port = get_unaligned_be16(&d[6]);
3139 break;
3140 case 0x5:
3141 /* Target port group */
3142 group_id = get_unaligned_be16(&d[6]);
3143 break;
3144 default:
3145 break;
3146 }
3147 d += d[3] + 4;
3148 }
3149 rcu_read_unlock();
3150
3151 if (group_id >= 0 && rel_id && rel_port != -1)
3152 *rel_id = rel_port;
3153
3154 return group_id;
3155}
3156EXPORT_SYMBOL(scsi_vpd_tpg_id);