blob: 88cac92fc1536199dec7e856ca2d85110a7b1e26 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Christoph Hellwigd2852032014-01-17 12:06:53 +01003 * Copyright (C) 1999 Eric Youngdale
4 * Copyright (C) 2014 Christoph Hellwig
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * SCSI queueing library.
7 * Initial versions: Eric Youngdale (eric@andante.org).
8 * Based upon conversations with large numbers
9 * of people at Linux Expo.
10 */
11
12#include <linux/bio.h>
James Bottomleyd3f46f32008-01-15 11:11:46 -060013#include <linux/bitops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/blkdev.h>
15#include <linux/completion.h>
16#include <linux/kernel.h>
Paul Gortmaker09703662011-05-27 09:37:25 -040017#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/init.h>
19#include <linux/pci.h>
20#include <linux/delay.h>
James Bottomleyfaead262006-02-14 10:42:07 -060021#include <linux/hardirq.h>
Jens Axboec6132da2007-10-16 11:08:49 +020022#include <linux/scatterlist.h>
Christoph Hellwigd2852032014-01-17 12:06:53 +010023#include <linux/blk-mq.h>
Hannes Reineckef1569ff2014-10-24 14:27:07 +020024#include <linux/ratelimit.h>
Hannes Reineckea8aa3972015-12-01 10:16:57 +010025#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020028#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <scsi/scsi_dbg.h>
30#include <scsi/scsi_device.h>
31#include <scsi/scsi_driver.h>
32#include <scsi/scsi_eh.h>
33#include <scsi/scsi_host.h>
Bart Van Assche7aa686d2017-05-02 10:45:03 -070034#include <scsi/scsi_transport.h> /* __scsi_init_queue() */
Christoph Hellwigee14c672015-08-27 14:16:59 +020035#include <scsi/scsi_dh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Christoph Hellwig3b5382c2014-05-06 12:25:40 +020037#include <trace/events/scsi.h>
38
Bart Van Assche0eebd002017-04-26 13:47:57 -070039#include "scsi_debugfs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include "scsi_priv.h"
41#include "scsi_logging.h"
42
Ming Lei92524fa2019-04-28 15:39:31 +080043/*
44 * Size of integrity metadata is usually small, 1 inline sg should
45 * cover normal cases.
46 */
Ming Lei3e99b3b2019-06-06 16:34:09 +080047#ifdef CONFIG_ARCH_NO_SG_CHAIN
48#define SCSI_INLINE_PROT_SG_CNT 0
49#define SCSI_INLINE_SG_CNT 0
50#else
Ming Lei92524fa2019-04-28 15:39:31 +080051#define SCSI_INLINE_PROT_SG_CNT 1
Ming Lei3dccdf52019-04-28 15:39:32 +080052#define SCSI_INLINE_SG_CNT 2
Ming Lei3e99b3b2019-06-06 16:34:09 +080053#endif
Ming Lei3dccdf52019-04-28 15:39:32 +080054
Christoph Hellwige9c787e2017-01-02 21:55:26 +030055static struct kmem_cache *scsi_sdb_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030056static struct kmem_cache *scsi_sense_cache;
57static struct kmem_cache *scsi_sense_isadma_cache;
58static DEFINE_MUTEX(scsi_sense_cache_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Bart Van Asschea45a1f362017-08-30 16:58:42 -070060static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd);
61
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030062static inline struct kmem_cache *
Bart Van Assche8e688252017-06-02 14:21:52 -070063scsi_select_sense_cache(bool unchecked_isa_dma)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030064{
Bart Van Assche8e688252017-06-02 14:21:52 -070065 return unchecked_isa_dma ? scsi_sense_isadma_cache : scsi_sense_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030066}
67
Bart Van Assche8e688252017-06-02 14:21:52 -070068static void scsi_free_sense_buffer(bool unchecked_isa_dma,
69 unsigned char *sense_buffer)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030070{
Bart Van Assche8e688252017-06-02 14:21:52 -070071 kmem_cache_free(scsi_select_sense_cache(unchecked_isa_dma),
72 sense_buffer);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030073}
74
Bart Van Assche8e688252017-06-02 14:21:52 -070075static unsigned char *scsi_alloc_sense_buffer(bool unchecked_isa_dma,
Christoph Hellwige9c787e2017-01-02 21:55:26 +030076 gfp_t gfp_mask, int numa_node)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030077{
Bart Van Assche8e688252017-06-02 14:21:52 -070078 return kmem_cache_alloc_node(scsi_select_sense_cache(unchecked_isa_dma),
79 gfp_mask, numa_node);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030080}
81
82int scsi_init_sense_cache(struct Scsi_Host *shost)
83{
84 struct kmem_cache *cache;
85 int ret = 0;
86
Ming Leif9b05302019-07-12 10:08:19 +080087 mutex_lock(&scsi_sense_cache_mutex);
Bart Van Assche8e688252017-06-02 14:21:52 -070088 cache = scsi_select_sense_cache(shost->unchecked_isa_dma);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030089 if (cache)
Ming Leif9b05302019-07-12 10:08:19 +080090 goto exit;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030091
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030092 if (shost->unchecked_isa_dma) {
93 scsi_sense_isadma_cache =
94 kmem_cache_create("scsi_sense_cache(DMA)",
David Windsor0afe76e2017-06-10 22:50:45 -040095 SCSI_SENSE_BUFFERSIZE, 0,
96 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030097 if (!scsi_sense_isadma_cache)
98 ret = -ENOMEM;
99 } else {
100 scsi_sense_cache =
David Windsor0afe76e2017-06-10 22:50:45 -0400101 kmem_cache_create_usercopy("scsi_sense_cache",
102 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN,
103 0, SCSI_SENSE_BUFFERSIZE, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +0300104 if (!scsi_sense_cache)
105 ret = -ENOMEM;
106 }
Ming Leif9b05302019-07-12 10:08:19 +0800107 exit:
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +0300108 mutex_unlock(&scsi_sense_cache_mutex);
109 return ret;
110}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200111
Jens Axboea488e742010-04-16 21:13:15 +0200112/*
113 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
114 * not change behaviour from the previous unplug mechanism, experimentation
115 * may prove this needs changing.
116 */
117#define SCSI_QUEUE_DELAY 3
118
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100119static void
120scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121{
122 struct Scsi_Host *host = cmd->device->host;
123 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500124 struct scsi_target *starget = scsi_target(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900127 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 *
129 * If the host/device isn't busy, assume that something actually
130 * completed, and that we should be able to queue a command now.
131 *
132 * Note that the prior mid-layer assumption that any host could
133 * always queue at least one command is now broken. The mid-layer
134 * will implement a user specifiable stall (see
135 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
136 * if a command is requeued with no other commands outstanding
137 * either for the device or for the host.
138 */
Mike Christief0c0a372008-08-17 15:24:38 -0500139 switch (reason) {
140 case SCSI_MLQUEUE_HOST_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100141 atomic_set(&host->host_blocked, host->max_host_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500142 break;
143 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400144 case SCSI_MLQUEUE_EH_RETRY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100145 atomic_set(&device->device_blocked,
146 device->max_device_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500147 break;
148 case SCSI_MLQUEUE_TARGET_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100149 atomic_set(&starget->target_blocked,
150 starget->max_target_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500151 break;
152 }
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100153}
154
Christoph Hellwigd2852032014-01-17 12:06:53 +0100155static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
156{
Bart Van Asschea45a1f362017-08-30 16:58:42 -0700157 if (cmd->request->rq_flags & RQF_DONTPREP) {
158 cmd->request->rq_flags &= ~RQF_DONTPREP;
159 scsi_mq_uninit_cmd(cmd);
160 } else {
161 WARN_ON_ONCE(true);
162 }
Bart Van Assche2b053ac2016-10-28 17:21:41 -0700163 blk_mq_requeue_request(cmd->request, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100164}
165
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100166/**
167 * __scsi_queue_insert - private queue insertion
168 * @cmd: The SCSI command being requeued
169 * @reason: The reason for the requeue
170 * @unbusy: Whether the queue should be unbusied
171 *
172 * This is a private queue insertion. The public interface
173 * scsi_queue_insert() always assumes the queue should be unbusied
174 * because it's always called before the completion. This function is
175 * for a requeue after completion, which should only occur in this
176 * file.
177 */
Bart Van Assche08640e82018-01-10 14:41:45 -0800178static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, bool unbusy)
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100179{
180 struct scsi_device *device = cmd->device;
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100181
182 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
183 "Inserting command %p into mlqueue\n", cmd));
184
185 scsi_set_blocked(cmd, reason);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 * Decrement the counters, since these commands are no longer
189 * active on the host/device.
190 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600191 if (unbusy)
Ming Lei6eb045e2019-10-25 14:58:55 +0800192 scsi_device_unbusy(device, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500195 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000196 * that are already in the queue. Schedule requeue work under
197 * lock such that the kblockd_schedule_work() call happens
198 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200199 */
Alan Stern644373a2014-03-28 10:51:15 -0700200 cmd->result = 0;
Jens Axboef664a3c2018-11-01 16:36:27 -0600201
Jens Axboef664a3c2018-11-01 16:36:27 -0600202 blk_mq_requeue_request(cmd->request, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203}
204
James Bottomley4f5299a2009-01-02 10:42:21 -0600205/*
206 * Function: scsi_queue_insert()
207 *
208 * Purpose: Insert a command in the midlevel queue.
209 *
210 * Arguments: cmd - command that we are adding to queue.
211 * reason - why we are inserting command to queue.
212 *
213 * Lock status: Assumed that lock is not held upon entry.
214 *
215 * Returns: Nothing.
216 *
217 * Notes: We do this for one of two cases. Either the host is busy
218 * and it cannot accept any more commands for the time being,
219 * or the device returned QUEUE_FULL and can accept no more
220 * commands.
221 * Notes: This could be called either from an interrupt context or a
222 * normal process context.
223 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000224void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600225{
Bart Van Assche08640e82018-01-10 14:41:45 -0800226 __scsi_queue_insert(cmd, reason, true);
James Bottomley4f5299a2009-01-02 10:42:21 -0600227}
Christoph Hellwige8064022016-10-20 15:12:13 +0200228
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100229
230/**
Kees Cook704f8392018-07-31 12:51:54 -0700231 * __scsi_execute - insert request and wait for the result
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100232 * @sdev: scsi device
233 * @cmd: scsi command
234 * @data_direction: data direction
235 * @buffer: data buffer
236 * @bufflen: len of buffer
237 * @sense: optional sense buffer
238 * @sshdr: optional decoded sense header
239 * @timeout: request timeout in seconds
240 * @retries: number of times to retry request
241 * @flags: flags for ->cmd_flags
242 * @rq_flags: flags for ->rq_flags
243 * @resid: optional residual length
244 *
Christoph Hellwig17d53632017-04-20 16:03:01 +0200245 * Returns the scsi_cmnd result field if a command was executed, or a negative
246 * Linux error code if we didn't get that far.
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100247 */
Kees Cook704f8392018-07-31 12:51:54 -0700248int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500249 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100250 unsigned char *sense, struct scsi_sense_hdr *sshdr,
251 int timeout, int retries, u64 flags, req_flags_t rq_flags,
252 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500253{
254 struct request *req;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100255 struct scsi_request *rq;
James Bottomley39216032005-06-15 18:48:29 -0500256 int ret = DRIVER_ERROR << 24;
257
Christoph Hellwigff005a02018-05-09 09:54:05 +0200258 req = blk_get_request(sdev->request_queue,
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100259 data_direction == DMA_TO_DEVICE ?
Bart Van Assche039c6352017-11-09 10:49:56 -0800260 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, BLK_MQ_REQ_PREEMPT);
Joe Lawrencea492f072014-08-28 08:15:21 -0600261 if (IS_ERR(req))
James Bottomleybfe159a2011-07-07 15:45:40 -0500262 return ret;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100263 rq = scsi_req(req);
James Bottomley39216032005-06-15 18:48:29 -0500264
265 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
Christoph Hellwig0eb0b632018-05-09 09:54:08 +0200266 buffer, bufflen, GFP_NOIO))
James Bottomley39216032005-06-15 18:48:29 -0500267 goto out;
268
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100269 rq->cmd_len = COMMAND_SIZE(cmd[0]);
270 memcpy(rq->cmd, cmd, rq->cmd_len);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200271 rq->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500272 req->timeout = timeout;
Christoph Hellwige8064022016-10-20 15:12:13 +0200273 req->cmd_flags |= flags;
Bart Van Assche039c6352017-11-09 10:49:56 -0800274 req->rq_flags |= rq_flags | RQF_QUIET;
James Bottomley39216032005-06-15 18:48:29 -0500275
276 /*
277 * head injection *required* here otherwise quiesce won't work
278 */
279 blk_execute_rq(req->q, NULL, req, 1);
280
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400281 /*
282 * Some devices (USB mass-storage in particular) may transfer
283 * garbage data together with a residue indicating that the data
284 * is invalid. Prevent the garbage from being misinterpreted
285 * and prevent security leaks by zeroing out the excess data.
286 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100287 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
288 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400289
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900290 if (resid)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100291 *resid = rq->resid_len;
292 if (sense && rq->sense_len)
293 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100294 if (sshdr)
295 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
Christoph Hellwig17d53632017-04-20 16:03:01 +0200296 ret = rq->result;
James Bottomley39216032005-06-15 18:48:29 -0500297 out:
298 blk_put_request(req);
299
300 return ret;
301}
Kees Cook704f8392018-07-31 12:51:54 -0700302EXPORT_SYMBOL(__scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500303
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304/*
305 * Function: scsi_init_cmd_errh()
306 *
307 * Purpose: Initialize cmd fields related to error handling.
308 *
309 * Arguments: cmd - command that is ready to be queued.
310 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 * Notes: This function has the job of initializing a number of
312 * fields related to error handling. Typically this will
313 * be called once for each command, as required.
314 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200315static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200317 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900318 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300320 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321}
322
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800323/*
Ming Lei6eb045e2019-10-25 14:58:55 +0800324 * Wake up the error handler if necessary. Avoid as follows that the error
325 * handler is not woken up if host in-flight requests number ==
326 * shost->host_failed: use call_rcu() in scsi_eh_scmd_add() in combination
327 * with an RCU read lock in this function to ensure that this function in
328 * its entirety either finishes before scsi_eh_scmd_add() increases the
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800329 * host_failed counter or that it notices the shost state change made by
330 * scsi_eh_scmd_add().
331 */
Ming Lei6eb045e2019-10-25 14:58:55 +0800332static void scsi_dec_host_busy(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800333{
334 unsigned long flags;
335
336 rcu_read_lock();
Ming Lei6eb045e2019-10-25 14:58:55 +0800337 __clear_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800338 if (unlikely(scsi_host_in_recovery(shost))) {
339 spin_lock_irqsave(shost->host_lock, flags);
340 if (shost->host_failed || shost->host_eh_scheduled)
341 scsi_eh_wakeup(shost);
342 spin_unlock_irqrestore(shost->host_lock, flags);
343 }
344 rcu_read_unlock();
345}
346
Ming Lei6eb045e2019-10-25 14:58:55 +0800347void scsi_device_unbusy(struct scsi_device *sdev, struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348{
349 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500350 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
Ming Lei6eb045e2019-10-25 14:58:55 +0800352 scsi_dec_host_busy(shost, cmd);
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800353
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100354 if (starget->can_queue > 0)
355 atomic_dec(&starget->target_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +0100356
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200357 atomic_dec(&sdev->device_busy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358}
359
Christoph Hellwigd2852032014-01-17 12:06:53 +0100360static void scsi_kick_queue(struct request_queue *q)
361{
Jens Axboef664a3c2018-11-01 16:36:27 -0600362 blk_mq_run_hw_queues(q, false);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100363}
364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365/*
366 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
367 * and call blk_run_queue for all the scsi_devices on the target -
368 * including current_sdev first.
369 *
370 * Called with *no* scsi locks held.
371 */
372static void scsi_single_lun_run(struct scsi_device *current_sdev)
373{
374 struct Scsi_Host *shost = current_sdev->host;
375 struct scsi_device *sdev, *tmp;
376 struct scsi_target *starget = scsi_target(current_sdev);
377 unsigned long flags;
378
379 spin_lock_irqsave(shost->host_lock, flags);
380 starget->starget_sdev_user = NULL;
381 spin_unlock_irqrestore(shost->host_lock, flags);
382
383 /*
384 * Call blk_run_queue for all LUNs on the target, starting with
385 * current_sdev. We race with others (to set starget_sdev_user),
386 * but in most cases, we will be first. Ideally, each LU on the
387 * target would get some limited time or requests on the target.
388 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100389 scsi_kick_queue(current_sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 spin_lock_irqsave(shost->host_lock, flags);
392 if (starget->starget_sdev_user)
393 goto out;
394 list_for_each_entry_safe(sdev, tmp, &starget->devices,
395 same_target_siblings) {
396 if (sdev == current_sdev)
397 continue;
398 if (scsi_device_get(sdev))
399 continue;
400
401 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100402 scsi_kick_queue(sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 spin_lock_irqsave(shost->host_lock, flags);
404
405 scsi_device_put(sdev);
406 }
407 out:
408 spin_unlock_irqrestore(shost->host_lock, flags);
409}
410
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100411static inline bool scsi_device_is_busy(struct scsi_device *sdev)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400412{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100413 if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
414 return true;
415 if (atomic_read(&sdev->device_blocked) > 0)
416 return true;
417 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400418}
419
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100420static inline bool scsi_target_is_busy(struct scsi_target *starget)
Mike Christief0c0a372008-08-17 15:24:38 -0500421{
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100422 if (starget->can_queue > 0) {
423 if (atomic_read(&starget->target_busy) >= starget->can_queue)
424 return true;
425 if (atomic_read(&starget->target_blocked) > 0)
426 return true;
427 }
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100428 return false;
Mike Christief0c0a372008-08-17 15:24:38 -0500429}
430
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100431static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400432{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100433 if (atomic_read(&shost->host_blocked) > 0)
434 return true;
435 if (shost->host_self_blocked)
436 return true;
437 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400438}
439
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800440static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600442 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800443 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 unsigned long flags;
445
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600447 list_splice_init(&shost->starved_list, &starved_list);
448
449 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200450 struct request_queue *slq;
451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 /*
453 * As long as shost is accepting commands and we have
454 * starved queues, call blk_run_queue. scsi_request_fn
455 * drops the queue_lock and can add us back to the
456 * starved_list.
457 *
458 * host_lock protects the starved_list and starved_entry.
459 * scsi_request_fn must get the host_lock before checking
460 * or modifying starved_list or starved_entry.
461 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600462 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500463 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500464
Mike Christie2a3a59e2008-11-11 13:42:35 -0600465 sdev = list_entry(starved_list.next,
466 struct scsi_device, starved_entry);
467 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500468 if (scsi_target_is_busy(scsi_target(sdev))) {
469 list_move_tail(&sdev->starved_entry,
470 &shost->starved_list);
471 continue;
472 }
473
James Bottomleye2eb7242013-07-02 15:05:26 +0200474 /*
475 * Once we drop the host lock, a racing scsi_remove_device()
476 * call may remove the sdev from the starved list and destroy
477 * it and the queue. Mitigate by taking a reference to the
478 * queue and never touching the sdev again after we drop the
479 * host lock. Note: if __scsi_remove_device() invokes
480 * blk_cleanup_queue() before the queue is run from this
481 * function then blk_run_queue() will return immediately since
482 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
483 */
484 slq = sdev->request_queue;
485 if (!blk_get_queue(slq))
486 continue;
487 spin_unlock_irqrestore(shost->host_lock, flags);
488
Christoph Hellwigd2852032014-01-17 12:06:53 +0100489 scsi_kick_queue(slq);
James Bottomleye2eb7242013-07-02 15:05:26 +0200490 blk_put_queue(slq);
491
492 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600494 /* put any unprocessed entries back */
495 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800497}
498
499/*
500 * Function: scsi_run_queue()
501 *
502 * Purpose: Select a proper request queue to serve next
503 *
504 * Arguments: q - last request's queue
505 *
506 * Returns: Nothing
507 *
508 * Notes: The previous command was completely finished, start
509 * a new one if possible.
510 */
511static void scsi_run_queue(struct request_queue *q)
512{
513 struct scsi_device *sdev = q->queuedata;
514
515 if (scsi_target(sdev)->single_lun)
516 scsi_single_lun_run(sdev);
517 if (!list_empty(&sdev->host->starved_list))
518 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Jens Axboef664a3c2018-11-01 16:36:27 -0600520 blk_mq_run_hw_queues(q, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521}
522
Jens Axboe9937a5e2011-05-17 11:04:44 +0200523void scsi_requeue_run_queue(struct work_struct *work)
524{
525 struct scsi_device *sdev;
526 struct request_queue *q;
527
528 sdev = container_of(work, struct scsi_device, requeue_work);
529 q = sdev->request_queue;
530 scsi_run_queue(q);
531}
532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533void scsi_run_host_queues(struct Scsi_Host *shost)
534{
535 struct scsi_device *sdev;
536
537 shost_for_each_device(sdev, shost)
538 scsi_run_queue(sdev->request_queue);
539}
540
Christoph Hellwigd2852032014-01-17 12:06:53 +0100541static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
542{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100543 if (!blk_rq_is_passthrough(cmd->request)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100544 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
545
546 if (drv->uninit_command)
547 drv->uninit_command(cmd);
548 }
549}
550
551static void scsi_mq_free_sgtables(struct scsi_cmnd *cmd)
552{
553 if (cmd->sdb.table.nents)
Ming Lei3dccdf52019-04-28 15:39:32 +0800554 sg_free_table_chained(&cmd->sdb.table,
555 SCSI_INLINE_SG_CNT);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100556 if (scsi_prot_sg_count(cmd))
Ming Lei92524fa2019-04-28 15:39:31 +0800557 sg_free_table_chained(&cmd->prot_sdb->table,
558 SCSI_INLINE_PROT_SG_CNT);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100559}
560
561static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
562{
Christoph Hellwigd2852032014-01-17 12:06:53 +0100563 scsi_mq_free_sgtables(cmd);
564 scsi_uninit_cmd(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100565}
566
Douglas Gilbert7e63b5a2018-06-23 12:22:14 +0200567/* Returns false when no more bytes to process, true if there are more */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200568static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100569 unsigned int bytes)
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800570{
Bart Van Asschebed22132017-08-25 13:46:32 -0700571 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800572 struct scsi_device *sdev = cmd->device;
573 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800574
575 if (blk_update_request(req, error, bytes))
576 return true;
577
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800578 if (blk_queue_add_random(q))
579 add_disk_randomness(req->rq_disk);
580
Bart Van Assche64104f72017-08-30 16:58:39 -0700581 if (!blk_rq_is_scsi(req)) {
582 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
583 cmd->flags &= ~SCMD_INITIALIZED;
584 }
585
Jens Axboef664a3c2018-11-01 16:36:27 -0600586 /*
Bart Van Asschedb983f62019-03-18 09:29:26 -0700587 * Calling rcu_barrier() is not necessary here because the
588 * SCSI error handler guarantees that the function called by
589 * call_rcu() has been called before scsi_end_request() is
590 * called.
591 */
592 destroy_rcu_head(&cmd->rcu);
593
594 /*
Jens Axboef664a3c2018-11-01 16:36:27 -0600595 * In the MQ case the command gets freed by __blk_mq_end_request,
596 * so we have to do all cleanup that depends on it earlier.
597 *
598 * We also can't kick the queues from irq context, so we
599 * will have to defer it to a workqueue.
600 */
601 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800602
Jens Axboea78b03b2018-11-18 15:46:03 -0700603 /*
604 * queue is still alive, so grab the ref for preventing it
605 * from being cleaned up during running queue.
606 */
607 percpu_ref_get(&q->q_usage_counter);
Ming Lei8dc765d2018-11-14 16:25:51 +0800608
Jens Axboef664a3c2018-11-01 16:36:27 -0600609 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100610
Jens Axboef664a3c2018-11-01 16:36:27 -0600611 if (scsi_target(sdev)->single_lun ||
612 !list_empty(&sdev->host->starved_list))
613 kblockd_schedule_work(&sdev->requeue_work);
614 else
615 blk_mq_run_hw_queues(q, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100616
Jens Axboea78b03b2018-11-18 15:46:03 -0700617 percpu_ref_put(&q->q_usage_counter);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800618 return false;
619}
620
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200621/**
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700622 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
623 * @cmd: SCSI command
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200624 * @result: scsi error code
625 *
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700626 * Translate a SCSI result code into a blk_status_t value. May reset the host
627 * byte of @cmd->result.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200628 */
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700629static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100630{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200631 switch (host_byte(result)) {
Bart Van Asschef4abab32018-04-05 10:33:01 -0700632 case DID_OK:
633 /*
634 * Also check the other bytes than the status byte in result
635 * to handle the case when a SCSI LLD sets result to
636 * DRIVER_SENSE << 24 without setting SAM_STAT_CHECK_CONDITION.
637 */
638 if (scsi_status_is_good(result) && (result & ~0xff) == 0)
639 return BLK_STS_OK;
640 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100641 case DID_TRANSPORT_FAILFAST:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200642 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100643 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000644 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200645 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100646 case DID_NEXUS_FAILURE:
Martin Wilck4a067cf2019-02-14 22:57:41 +0100647 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200648 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200649 case DID_ALLOC_FAILURE:
650 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200651 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200652 case DID_MEDIUM_ERROR:
653 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200654 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100655 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200656 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100657 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100658}
659
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200660/* Helper for scsi_io_completion() when "reprep" action required. */
661static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
662 struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663{
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200664 /* A new command will be prepared and issued. */
Jens Axboef664a3c2018-11-01 16:36:27 -0600665 scsi_mq_requeue_cmd(cmd);
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200666}
667
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200668/* Helper for scsi_io_completion() when special action required. */
669static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
Douglas Gilbertab831082018-06-23 12:22:16 +0200670{
Jens Axboe165125e2007-07-24 09:28:11 +0200671 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 struct request *req = cmd->request;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200673 int level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500674 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
675 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900676 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200677 struct scsi_sense_hdr sshdr;
678 bool sense_valid;
679 bool sense_current = true; /* false implies "deferred sense" */
680 blk_status_t blk_stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200682 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
683 if (sense_valid)
684 sense_current = !scsi_sense_is_deferred(&sshdr);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200685
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200686 blk_stat = scsi_result_to_blk_status(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500687
Alan Sternb60af5b2008-11-03 15:56:47 -0500688 if (host_byte(result) == DID_RESET) {
689 /* Third party bus reset or reset for error recovery
690 * reasons. Just retry the command and see what
691 * happens.
692 */
693 action = ACTION_RETRY;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200694 } else if (sense_valid && sense_current) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 switch (sshdr.sense_key) {
696 case UNIT_ATTENTION:
697 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700698 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 * and quietly refuse further access.
700 */
701 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500702 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700704 /* Must have been a power glitch, or a
705 * bus reset. Could not have been a
706 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500707 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700708 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500709 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 }
711 break;
712 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700713 /* If we had an ILLEGAL REQUEST returned, then
714 * we may have performed an unsupported
715 * command. The only thing this should be
716 * would be a ten byte read where only a six
717 * byte read was supported. Also, on a system
718 * where READ CAPACITY failed, we may have
719 * read past the end of the disk.
720 */
Jens Axboe26a68012005-11-29 21:03:34 +0100721 if ((cmd->device->use_10_for_rw &&
722 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 (cmd->cmnd[0] == READ_10 ||
724 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500725 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500727 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500728 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500729 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200730 blk_stat = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500731 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400732 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500733 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200734 blk_stat = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500735 } else
736 action = ACTION_FAIL;
737 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400738 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000739 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200740 if (sshdr.asc == 0x10) /* DIF */
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200741 blk_stat = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 break;
743 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700744 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500745 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500747 if (sshdr.asc == 0x04) {
748 switch (sshdr.ascq) {
749 case 0x01: /* becoming ready */
750 case 0x04: /* format in progress */
751 case 0x05: /* rebuild in progress */
752 case 0x06: /* recalculation in progress */
753 case 0x07: /* operation in progress */
754 case 0x08: /* Long write in progress */
755 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500756 case 0x14: /* space allocation in progress */
Douglas Gilberte37c7d92018-05-18 19:25:47 -0400757 case 0x1a: /* start stop unit in progress */
758 case 0x1b: /* sanitize in progress */
759 case 0x1d: /* configuration in progress */
760 case 0x24: /* depopulation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500761 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500762 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500763 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500764 action = ACTION_FAIL;
765 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500766 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200767 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500768 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500769 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700771 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500772 action = ACTION_FAIL;
773 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500775 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 break;
777 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200778 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500779 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500780
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900781 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200782 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900783 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900784
Alan Sternb60af5b2008-11-03 15:56:47 -0500785 switch (action) {
786 case ACTION_FAIL:
787 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200788 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200789 static DEFINE_RATELIMIT_STATE(_rs,
790 DEFAULT_RATELIMIT_INTERVAL,
791 DEFAULT_RATELIMIT_BURST);
792
793 if (unlikely(scsi_logging_level))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200794 level =
795 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
796 SCSI_LOG_MLCOMPLETE_BITS);
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200797
798 /*
799 * if logging is enabled the failure will be printed
800 * in scsi_log_completion(), so avoid duplicate messages
801 */
802 if (!level && __ratelimit(&_rs)) {
803 scsi_print_result(cmd, NULL, FAILED);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +0200804 if (driver_byte(result) == DRIVER_SENSE)
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200805 scsi_print_sense(cmd);
806 scsi_print_command(cmd);
807 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500808 }
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100809 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req)))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800810 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200811 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500812 case ACTION_REPREP:
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200813 scsi_io_completion_reprep(cmd, q);
Alan Sternb60af5b2008-11-03 15:56:47 -0500814 break;
815 case ACTION_RETRY:
816 /* Retry the same command immediately */
Bart Van Assche08640e82018-01-10 14:41:45 -0800817 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500818 break;
819 case ACTION_DELAYED_RETRY:
820 /* Retry the same command after a delay */
Bart Van Assche08640e82018-01-10 14:41:45 -0800821 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500822 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 }
824}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200826/*
827 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
828 * new result that may suppress further error checking. Also modifies
829 * *blk_statp in some cases.
830 */
831static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
832 blk_status_t *blk_statp)
833{
834 bool sense_valid;
835 bool sense_current = true; /* false implies "deferred sense" */
836 struct request *req = cmd->request;
837 struct scsi_sense_hdr sshdr;
838
839 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
840 if (sense_valid)
841 sense_current = !scsi_sense_is_deferred(&sshdr);
842
843 if (blk_rq_is_passthrough(req)) {
844 if (sense_valid) {
845 /*
846 * SG_IO wants current and deferred errors
847 */
848 scsi_req(req)->sense_len =
849 min(8 + cmd->sense_buffer[7],
850 SCSI_SENSE_BUFFERSIZE);
851 }
852 if (sense_current)
853 *blk_statp = scsi_result_to_blk_status(cmd, result);
854 } else if (blk_rq_bytes(req) == 0 && sense_current) {
855 /*
856 * Flush commands do not transfers any data, and thus cannot use
857 * good_bytes != blk_rq_bytes(req) as the signal for an error.
858 * This sets *blk_statp explicitly for the problem case.
859 */
860 *blk_statp = scsi_result_to_blk_status(cmd, result);
861 }
862 /*
863 * Recovered errors need reporting, but they're always treated as
864 * success, so fiddle the result code here. For passthrough requests
865 * we already took a copy of the original into sreq->result which
866 * is what gets returned to the user
867 */
868 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
869 bool do_print = true;
870 /*
871 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
872 * skip print since caller wants ATA registers. Only occurs
873 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
874 */
875 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
876 do_print = false;
877 else if (req->rq_flags & RQF_QUIET)
878 do_print = false;
879 if (do_print)
880 scsi_print_sense(cmd);
881 result = 0;
882 /* for passthrough, *blk_statp may be set */
883 *blk_statp = BLK_STS_OK;
884 }
885 /*
886 * Another corner case: the SCSI status byte is non-zero but 'good'.
887 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
888 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
889 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
890 * intermediate statuses (both obsolete in SAM-4) as good.
891 */
892 if (status_byte(result) && scsi_status_is_good(result)) {
893 result = 0;
894 *blk_statp = BLK_STS_OK;
895 }
896 return result;
897}
898
899/*
900 * Function: scsi_io_completion()
901 *
902 * Purpose: Completion processing for block device I/O requests.
903 *
904 * Arguments: cmd - command that is finished.
905 *
906 * Lock status: Assumed that no lock is held upon entry.
907 *
908 * Returns: Nothing
909 *
910 * Notes: We will finish off the specified number of sectors. If we
911 * are done, the command block will be released and the queue
912 * function will be goosed. If we are not done then we have to
913 * figure out what to do next:
914 *
915 * a) We can call scsi_requeue_command(). The request
916 * will be unprepared and put back on the queue. Then
917 * a new command will be created for it. This should
918 * be used if we made forward progress, or if we want
919 * to switch from READ(10) to READ(6) for example.
920 *
921 * b) We can call __scsi_queue_insert(). The request will
922 * be put back on the queue and retried using the same
923 * command as before, possibly after a delay.
924 *
925 * c) We can call scsi_end_request() with blk_stat other than
926 * BLK_STS_OK, to fail the remainder of the request.
927 */
928void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
929{
930 int result = cmd->result;
931 struct request_queue *q = cmd->device->request_queue;
932 struct request *req = cmd->request;
933 blk_status_t blk_stat = BLK_STS_OK;
934
Douglas Gilbert0d437902018-06-23 12:22:19 +0200935 if (unlikely(result)) /* a nz result may or may not be an error */
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200936 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
937
Douglas Gilbert0d437902018-06-23 12:22:19 +0200938 if (unlikely(blk_rq_is_passthrough(req))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200939 /*
940 * scsi_result_to_blk_status may have reset the host_byte
941 */
942 scsi_req(req)->result = cmd->result;
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200943 }
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200944
945 /*
946 * Next deal with any sectors which we were able to correctly
947 * handle.
948 */
949 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
950 "%u sectors total, %d bytes done.\n",
951 blk_rq_sectors(req), good_bytes));
952
953 /*
954 * Next deal with any sectors which we were able to correctly
955 * handle. Failed, zero length commands always need to drop down
956 * to retry code. Fast path should return in this block.
957 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200958 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100959 if (likely(!scsi_end_request(req, blk_stat, good_bytes)))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200960 return; /* no bytes remaining */
961 }
962
Douglas Gilbert0d437902018-06-23 12:22:19 +0200963 /* Kill remainder if no retries. */
964 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100965 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req)))
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200966 WARN_ONCE(true,
967 "Bytes remaining after failed, no-retry command");
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200968 return;
969 }
970
971 /*
972 * If there had been no error, but we have leftover bytes in the
973 * requeues just queue the command up again.
974 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200975 if (likely(result == 0))
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200976 scsi_io_completion_reprep(cmd, q);
977 else
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200978 scsi_io_completion_action(cmd, result);
979}
980
Christoph Hellwigcc979232020-04-14 09:42:24 +0200981static inline bool scsi_cmd_needs_dma_drain(struct scsi_device *sdev,
982 struct request *rq)
983{
984 return sdev->dma_drain_len && blk_rq_is_passthrough(rq) &&
985 !op_is_write(req_op(rq)) &&
986 sdev->host->hostt->dma_need_drain(rq);
987}
988
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200989/*
990 * Function: scsi_init_io()
991 *
992 * Purpose: SCSI I/O initialize function.
993 *
994 * Arguments: cmd - Command descriptor we wish to initialize
995 *
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100996 * Returns: BLK_STS_OK on success
997 * BLK_STS_RESOURCE if the failure is retryable
998 * BLK_STS_IOERR if the failure is fatal
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200999 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001000blk_status_t scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001001{
Christoph Hellwigcc979232020-04-14 09:42:24 +02001002 struct scsi_device *sdev = cmd->device;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001003 struct request *rq = cmd->request;
Christoph Hellwigcc979232020-04-14 09:42:24 +02001004 unsigned short nr_segs = blk_rq_nr_phys_segments(rq);
1005 struct scatterlist *last_sg = NULL;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001006 blk_status_t ret;
Christoph Hellwigcc979232020-04-14 09:42:24 +02001007 bool need_drain = scsi_cmd_needs_dma_drain(sdev, rq);
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001008 int count;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001009
Christoph Hellwigcc979232020-04-14 09:42:24 +02001010 if (WARN_ON_ONCE(!nr_segs))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001011 return BLK_STS_IOERR;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001012
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001013 /*
Christoph Hellwigcc979232020-04-14 09:42:24 +02001014 * Make sure there is space for the drain. The driver must adjust
1015 * max_hw_segments to be prepared for this.
1016 */
1017 if (need_drain)
1018 nr_segs++;
1019
1020 /*
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001021 * If sg table allocation fails, requeue request later.
1022 */
Christoph Hellwigcc979232020-04-14 09:42:24 +02001023 if (unlikely(sg_alloc_table_chained(&cmd->sdb.table, nr_segs,
1024 cmd->sdb.table.sgl, SCSI_INLINE_SG_CNT)))
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001025 return BLK_STS_RESOURCE;
1026
1027 /*
1028 * Next, walk the list, and fill in the addresses and sizes of
1029 * each segment.
1030 */
Christoph Hellwigcc979232020-04-14 09:42:24 +02001031 count = __blk_rq_map_sg(rq->q, rq, cmd->sdb.table.sgl, &last_sg);
1032
1033 if (need_drain) {
1034 sg_unmark_end(last_sg);
1035 last_sg = sg_next(last_sg);
1036 sg_set_buf(last_sg, sdev->dma_drain_buf, sdev->dma_drain_len);
1037 sg_mark_end(last_sg);
1038
1039 rq->extra_len += sdev->dma_drain_len;
1040 count++;
1041 }
1042
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001043 BUG_ON(count > cmd->sdb.table.nents);
1044 cmd->sdb.table.nents = count;
1045 cmd->sdb.length = blk_rq_payload_bytes(rq);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001046
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001047 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001048 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001049 int ivecs;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001050
Christoph Hellwig14784562018-11-09 14:42:38 +01001051 if (WARN_ON_ONCE(!prot_sdb)) {
Ewan D. Milne91724c22015-01-15 10:02:12 -05001052 /*
1053 * This can happen if someone (e.g. multipath)
1054 * queues a command to a device on an adapter
1055 * that does not support DIX.
1056 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001057 ret = BLK_STS_IOERR;
Christoph Hellwig14784562018-11-09 14:42:38 +01001058 goto out_free_sgtables;
Ewan D. Milne91724c22015-01-15 10:02:12 -05001059 }
1060
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001061 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001062
Ming Lin001d63b2016-04-04 14:48:09 -07001063 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lei46358732019-04-28 15:39:30 +08001064 prot_sdb->table.sgl,
Ming Lei92524fa2019-04-28 15:39:31 +08001065 SCSI_INLINE_PROT_SG_CNT)) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001066 ret = BLK_STS_RESOURCE;
Christoph Hellwig14784562018-11-09 14:42:38 +01001067 goto out_free_sgtables;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001068 }
1069
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001070 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001071 prot_sdb->table.sgl);
Igor Stoppa6f1d8a52018-09-05 23:47:20 +03001072 BUG_ON(count > ivecs);
1073 BUG_ON(count > queue_max_integrity_segments(rq->q));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001074
1075 cmd->prot_sdb = prot_sdb;
1076 cmd->prot_sdb->table.nents = count;
1077 }
1078
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001079 return BLK_STS_OK;
Christoph Hellwig14784562018-11-09 14:42:38 +01001080out_free_sgtables:
Jens Axboef664a3c2018-11-01 16:36:27 -06001081 scsi_mq_free_sgtables(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001082 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001083}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001084EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001086/**
Bart Van Assche832889f2017-08-30 16:58:40 -07001087 * scsi_initialize_rq - initialize struct scsi_cmnd partially
Jonathan Corbet35c05062017-08-24 16:11:09 -06001088 * @rq: Request associated with the SCSI command to be initialized.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001089 *
Bart Van Assche832889f2017-08-30 16:58:40 -07001090 * This function initializes the members of struct scsi_cmnd that must be
1091 * initialized before request processing starts and that won't be
1092 * reinitialized if a SCSI command is requeued.
1093 *
Bart Van Assche64104f72017-08-30 16:58:39 -07001094 * Called from inside blk_get_request() for pass-through requests and from
1095 * inside scsi_init_command() for filesystem requests.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001096 */
Bart Van Asschee4c94702017-12-07 15:59:31 -08001097static void scsi_initialize_rq(struct request *rq)
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001098{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001099 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1100
1101 scsi_req_init(&cmd->req);
Bart Van Assche3be88282018-02-22 11:30:20 -08001102 init_rcu_head(&cmd->rcu);
Bart Van Assche832889f2017-08-30 16:58:40 -07001103 cmd->jiffies_at_alloc = jiffies;
1104 cmd->retries = 0;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001105}
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001106
Ming Leib7e9e1f2019-07-25 10:05:00 +08001107/*
1108 * Only called when the request isn't completed by SCSI, and not freed by
1109 * SCSI
1110 */
1111static void scsi_cleanup_rq(struct request *rq)
1112{
1113 if (rq->rq_flags & RQF_DONTPREP) {
1114 scsi_mq_uninit_cmd(blk_mq_rq_to_pdu(rq));
1115 rq->rq_flags &= ~RQF_DONTPREP;
1116 }
1117}
1118
Bart Van Assche65ca8462020-01-22 19:56:34 -08001119/* Called before a request is prepared. See also scsi_mq_prep_fn(). */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001120void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001121{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001122 void *buf = cmd->sense_buffer;
1123 void *prot = cmd->prot_sdb;
Bart Van Assche64104f72017-08-30 16:58:39 -07001124 struct request *rq = blk_mq_rq_from_pdu(cmd);
1125 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
Bart Van Assche832889f2017-08-30 16:58:40 -07001126 unsigned long jiffies_at_alloc;
Bart Van Assche65ca8462020-01-22 19:56:34 -08001127 int retries, to_clear;
Ming Lei6eb045e2019-10-25 14:58:55 +08001128 bool in_flight;
Bart Van Assche64104f72017-08-30 16:58:39 -07001129
1130 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1131 flags |= SCMD_INITIALIZED;
1132 scsi_initialize_rq(rq);
1133 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001134
Bart Van Assche832889f2017-08-30 16:58:40 -07001135 jiffies_at_alloc = cmd->jiffies_at_alloc;
1136 retries = cmd->retries;
Ming Lei6eb045e2019-10-25 14:58:55 +08001137 in_flight = test_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Bart Van Assche65ca8462020-01-22 19:56:34 -08001138 /*
1139 * Zero out the cmd, except for the embedded scsi_request. Only clear
1140 * the driver-private command data if the LLD does not supply a
1141 * function to initialize that data.
1142 */
1143 to_clear = sizeof(*cmd) - sizeof(cmd->req);
1144 if (!dev->host->hostt->init_cmd_priv)
1145 to_clear += dev->host->hostt->cmd_size;
1146 memset((char *)cmd + sizeof(cmd->req), 0, to_clear);
Christoph Hellwig04796332014-02-20 14:20:55 -08001147
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001148 cmd->device = dev;
1149 cmd->sense_buffer = buf;
1150 cmd->prot_sdb = prot;
Bart Van Assche64104f72017-08-30 16:58:39 -07001151 cmd->flags = flags;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001152 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
Bart Van Assche832889f2017-08-30 16:58:40 -07001153 cmd->jiffies_at_alloc = jiffies_at_alloc;
1154 cmd->retries = retries;
Ming Lei6eb045e2019-10-25 14:58:55 +08001155 if (in_flight)
1156 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001157
Christoph Hellwig3b003152006-11-04 20:10:55 +01001158}
1159
Christoph Hellwig785ba832018-11-09 14:42:37 +01001160static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1161 struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001162{
Bart Van Asschebed22132017-08-25 13:46:32 -07001163 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001164
1165 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001166 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001167 * a bio attached to them. Or they might contain a SCSI command
1168 * that does not transfer data, in which case they may optionally
1169 * submit a request without an attached bio.
1170 */
1171 if (req->bio) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001172 blk_status_t ret = scsi_init_io(cmd);
1173 if (unlikely(ret != BLK_STS_OK))
1174 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001175 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001176 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001177
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001178 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001179 }
James Bottomley7b163182005-12-15 20:17:02 -06001180
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001181 cmd->cmd_len = scsi_req(req)->cmd_len;
1182 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001183 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001184 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig785ba832018-11-09 14:42:37 +01001185 return BLK_STS_OK;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001186}
1187
1188/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001189 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001190 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001191 */
Christoph Hellwig785ba832018-11-09 14:42:37 +01001192static blk_status_t scsi_setup_fs_cmnd(struct scsi_device *sdev,
1193 struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001194{
Bart Van Asschebed22132017-08-25 13:46:32 -07001195 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001196
Christoph Hellwigee14c672015-08-27 14:16:59 +02001197 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
Christoph Hellwig4c1cb672018-11-09 14:42:40 +01001198 blk_status_t ret = sdev->handler->prep_fn(sdev, req);
1199 if (ret != BLK_STS_OK)
1200 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001201 }
1202
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001203 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001204 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001205 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001206}
James Bottomley7b163182005-12-15 20:17:02 -06001207
Christoph Hellwig785ba832018-11-09 14:42:37 +01001208static blk_status_t scsi_setup_cmnd(struct scsi_device *sdev,
1209 struct request *req)
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001210{
Bart Van Asschebed22132017-08-25 13:46:32 -07001211 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001212
1213 if (!blk_rq_bytes(req))
1214 cmd->sc_data_direction = DMA_NONE;
1215 else if (rq_data_dir(req) == WRITE)
1216 cmd->sc_data_direction = DMA_TO_DEVICE;
1217 else
1218 cmd->sc_data_direction = DMA_FROM_DEVICE;
1219
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001220 if (blk_rq_is_scsi(req))
1221 return scsi_setup_scsi_cmnd(sdev, req);
1222 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001223 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001224}
1225
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001226static blk_status_t
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001227scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228{
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001229 switch (sdev->sdev_state) {
1230 case SDEV_OFFLINE:
1231 case SDEV_TRANSPORT_OFFLINE:
1232 /*
1233 * If the device is offline we refuse to process any
1234 * commands. The device must be brought online
1235 * before trying any recovery commands.
1236 */
Ewan D. Milneb0962c52020-03-11 10:39:30 -04001237 if (!sdev->offline_already) {
1238 sdev->offline_already = true;
1239 sdev_printk(KERN_ERR, sdev,
1240 "rejecting I/O to offline device\n");
1241 }
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001242 return BLK_STS_IOERR;
1243 case SDEV_DEL:
1244 /*
1245 * If the device is fully deleted, we refuse to
1246 * process any commands as well.
1247 */
1248 sdev_printk(KERN_ERR, sdev,
1249 "rejecting I/O to dead device\n");
1250 return BLK_STS_IOERR;
1251 case SDEV_BLOCK:
1252 case SDEV_CREATED_BLOCK:
1253 return BLK_STS_RESOURCE;
1254 case SDEV_QUIESCE:
1255 /*
1256 * If the devices is blocked we defer normal commands.
1257 */
1258 if (req && !(req->rq_flags & RQF_PREEMPT))
1259 return BLK_STS_RESOURCE;
1260 return BLK_STS_OK;
1261 default:
1262 /*
1263 * For any other not fully online state we only allow
1264 * special commands. In particular any user initiated
1265 * command is not allowed.
1266 */
1267 if (req && !(req->rq_flags & RQF_PREEMPT))
1268 return BLK_STS_IOERR;
1269 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001271}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273/*
1274 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1275 * return 0.
1276 *
1277 * Called with the queue_lock held.
1278 */
1279static inline int scsi_dev_queue_ready(struct request_queue *q,
1280 struct scsi_device *sdev)
1281{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001282 unsigned int busy;
1283
1284 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001285 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001286 if (busy)
1287 goto out_dec;
1288
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 /*
1290 * unblock after device_blocked iterates to zero
1291 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001292 if (atomic_dec_return(&sdev->device_blocked) > 0)
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001293 goto out_dec;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001294 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1295 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001297
1298 if (busy >= sdev->queue_depth)
1299 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300
1301 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001302out_dec:
1303 atomic_dec(&sdev->device_busy);
1304 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305}
1306
Mike Christief0c0a372008-08-17 15:24:38 -05001307/*
1308 * scsi_target_queue_ready: checks if there we can send commands to target
1309 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001310 */
1311static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1312 struct scsi_device *sdev)
1313{
1314 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001315 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001316
1317 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001318 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001319 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001320 starget->starget_sdev_user != sdev) {
1321 spin_unlock_irq(shost->host_lock);
1322 return 0;
1323 }
Mike Christief0c0a372008-08-17 15:24:38 -05001324 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001325 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001326 }
1327
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001328 if (starget->can_queue <= 0)
1329 return 1;
1330
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001331 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001332 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001333 if (busy)
1334 goto starved;
1335
Mike Christief0c0a372008-08-17 15:24:38 -05001336 /*
1337 * unblock after target_blocked iterates to zero
1338 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001339 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001340 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001341
1342 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1343 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001344 }
1345
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001346 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001347 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001348
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001349 return 1;
1350
1351starved:
1352 spin_lock_irq(shost->host_lock);
1353 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001354 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001355out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001356 if (starget->can_queue > 0)
1357 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001358 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001359}
1360
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361/*
1362 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1363 * return 0. We must end up running the queue again whenever 0 is
1364 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 */
1366static inline int scsi_host_queue_ready(struct request_queue *q,
1367 struct Scsi_Host *shost,
Ming Lei6eb045e2019-10-25 14:58:55 +08001368 struct scsi_device *sdev,
1369 struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370{
James Bottomley939647e2005-09-18 15:05:20 -05001371 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001372 return 0;
1373
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001374 if (atomic_read(&shost->host_blocked) > 0) {
Ming Lei6eb045e2019-10-25 14:58:55 +08001375 if (scsi_host_busy(shost) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001376 goto starved;
1377
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 /*
1379 * unblock after host_blocked iterates to zero
1380 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001381 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001382 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001383
1384 SCSI_LOG_MLQUEUE(3,
1385 shost_printk(KERN_INFO, shost,
1386 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001388
Christoph Hellwig74665012014-01-22 15:29:29 +01001389 if (shost->host_self_blocked)
1390 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391
1392 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001393 if (!list_empty(&sdev->starved_entry)) {
1394 spin_lock_irq(shost->host_lock);
1395 if (!list_empty(&sdev->starved_entry))
1396 list_del_init(&sdev->starved_entry);
1397 spin_unlock_irq(shost->host_lock);
1398 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399
Ming Lei6eb045e2019-10-25 14:58:55 +08001400 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state);
1401
Christoph Hellwig74665012014-01-22 15:29:29 +01001402 return 1;
1403
1404starved:
1405 spin_lock_irq(shost->host_lock);
1406 if (list_empty(&sdev->starved_entry))
1407 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001408 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001409out_dec:
Ming Lei6eb045e2019-10-25 14:58:55 +08001410 scsi_dec_host_busy(shost, cmd);
Christoph Hellwig74665012014-01-22 15:29:29 +01001411 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412}
1413
1414/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001415 * Busy state exporting function for request stacking drivers.
1416 *
1417 * For efficiency, no lock is taken to check the busy state of
1418 * shost/starget/sdev, since the returned value is not guaranteed and
1419 * may be changed after request stacking drivers call the function,
1420 * regardless of taking lock or not.
1421 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001422 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1423 * needs to return 'not busy'. Otherwise, request stacking drivers
1424 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001425 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001426static bool scsi_mq_lld_busy(struct request_queue *q)
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001427{
1428 struct scsi_device *sdev = q->queuedata;
1429 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001430
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001431 if (blk_queue_dying(q))
Jens Axboef664a3c2018-11-01 16:36:27 -06001432 return false;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001433
1434 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001435
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001436 /*
1437 * Ignore host/starget busy state.
1438 * Since block layer does not have a concept of fairness across
1439 * multiple queues, congestion of host/starget needs to be handled
1440 * in SCSI layer.
1441 */
1442 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Jens Axboef664a3c2018-11-01 16:36:27 -06001443 return true;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001444
Jens Axboef664a3c2018-11-01 16:36:27 -06001445 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446}
1447
Jens Axboe1aea6432006-01-09 16:03:03 +01001448static void scsi_softirq_done(struct request *rq)
1449{
Bart Van Asschebed22132017-08-25 13:46:32 -07001450 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001451 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001452 int disposition;
1453
1454 INIT_LIST_HEAD(&cmd->eh_entry);
1455
Jens Axboe242f9dc2008-09-14 05:55:09 -07001456 atomic_inc(&cmd->device->iodone_cnt);
1457 if (cmd->result)
1458 atomic_inc(&cmd->device->ioerr_cnt);
1459
Jens Axboe1aea6432006-01-09 16:03:03 +01001460 disposition = scsi_decide_disposition(cmd);
1461 if (disposition != SUCCESS &&
1462 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
Maurizio Lombardi463cdad82019-07-02 13:27:05 +02001463 scmd_printk(KERN_ERR, cmd,
Jens Axboe1aea6432006-01-09 16:03:03 +01001464 "timing out command, waited %lus\n",
1465 wait_for/HZ);
1466 disposition = SUCCESS;
1467 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001468
Jens Axboe1aea6432006-01-09 16:03:03 +01001469 scsi_log_completion(cmd, disposition);
1470
1471 switch (disposition) {
1472 case SUCCESS:
1473 scsi_finish_command(cmd);
1474 break;
1475 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001476 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001477 break;
1478 case ADD_TO_MLQUEUE:
1479 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1480 break;
1481 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001482 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001483 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001484 }
1485}
1486
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001487/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001488 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1489 * @cmd: command block we are dispatching.
1490 *
1491 * Return: nonzero return request was rejected and device's queue needs to be
1492 * plugged.
1493 */
1494static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1495{
1496 struct Scsi_Host *host = cmd->device->host;
1497 int rtn = 0;
1498
1499 atomic_inc(&cmd->device->iorequest_cnt);
1500
1501 /* check if the device is still usable */
1502 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1503 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1504 * returns an immediate error upwards, and signals
1505 * that the device is no longer present */
1506 cmd->result = DID_NO_CONNECT << 16;
1507 goto done;
1508 }
1509
1510 /* Check to see if the scsi lld made this device blocked. */
1511 if (unlikely(scsi_device_blocked(cmd->device))) {
1512 /*
1513 * in blocked state, the command is just put back on
1514 * the device queue. The suspend state has already
1515 * blocked the queue so future requests should not
1516 * occur until the device transitions out of the
1517 * suspend state.
1518 */
1519 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1520 "queuecommand : device blocked\n"));
1521 return SCSI_MLQUEUE_DEVICE_BUSY;
1522 }
1523
1524 /* Store the LUN value in cmnd, if needed. */
1525 if (cmd->device->lun_in_cdb)
1526 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1527 (cmd->device->lun << 5 & 0xe0);
1528
1529 scsi_log_send(cmd);
1530
1531 /*
1532 * Before we queue this command, check if the command
1533 * length exceeds what the host adapter can handle.
1534 */
1535 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1536 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1537 "queuecommand : command too long. "
1538 "cdb_size=%d host->max_cmd_len=%d\n",
1539 cmd->cmd_len, cmd->device->host->max_cmd_len));
1540 cmd->result = (DID_ABORT << 16);
1541 goto done;
1542 }
1543
1544 if (unlikely(host->shost_state == SHOST_DEL)) {
1545 cmd->result = (DID_NO_CONNECT << 16);
1546 goto done;
1547
1548 }
1549
1550 trace_scsi_dispatch_cmd_start(cmd);
1551 rtn = host->hostt->queuecommand(host, cmd);
1552 if (rtn) {
1553 trace_scsi_dispatch_cmd_error(cmd, rtn);
1554 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1555 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1556 rtn = SCSI_MLQUEUE_HOST_BUSY;
1557
1558 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1559 "queuecommand : request rejected\n"));
1560 }
1561
1562 return rtn;
1563 done:
1564 cmd->scsi_done(cmd);
1565 return 0;
1566}
1567
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001568/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
Ming Lei3dccdf52019-04-28 15:39:32 +08001569static unsigned int scsi_mq_inline_sgl_size(struct Scsi_Host *shost)
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001570{
Ming Lei3dccdf52019-04-28 15:39:32 +08001571 return min_t(unsigned int, shost->sg_tablesize, SCSI_INLINE_SG_CNT) *
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001572 sizeof(struct scatterlist);
1573}
1574
Christoph Hellwig785ba832018-11-09 14:42:37 +01001575static blk_status_t scsi_mq_prep_fn(struct request *req)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001576{
1577 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1578 struct scsi_device *sdev = req->q->queuedata;
1579 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001580 struct scatterlist *sg;
1581
Bart Van Assche08f78432017-06-02 14:22:00 -07001582 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001583
Christoph Hellwigd2852032014-01-17 12:06:53 +01001584 cmd->request = req;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001585 cmd->tag = req->tag;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001586 cmd->prot_op = SCSI_PROT_NORMAL;
1587
Christoph Hellwigd2852032014-01-17 12:06:53 +01001588 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1589 cmd->sdb.table.sgl = sg;
1590
1591 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001592 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1593
1594 cmd->prot_sdb->table.sgl =
1595 (struct scatterlist *)(cmd->prot_sdb + 1);
1596 }
1597
Christoph Hellwigfe052522014-09-22 15:59:31 +02001598 blk_mq_start_request(req);
1599
Bart Van Assche8fe8ffb2017-10-20 11:46:45 -07001600 return scsi_setup_cmnd(sdev, req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001601}
1602
1603static void scsi_mq_done(struct scsi_cmnd *cmd)
1604{
Keith Buschf1342702018-11-26 09:54:29 -07001605 if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state)))
1606 return;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001607 trace_scsi_dispatch_cmd_done(cmd);
Keith Buschf1342702018-11-26 09:54:29 -07001608
1609 /*
1610 * If the block layer didn't complete the request due to a timeout
1611 * injection, scsi must clear its internal completed state so that the
1612 * timeout handler will see it needs to escalate its own error
1613 * recovery.
1614 */
1615 if (unlikely(!blk_mq_complete_request(cmd->request)))
1616 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001617}
1618
Ming Lei0df21c82017-10-14 17:22:32 +08001619static void scsi_mq_put_budget(struct blk_mq_hw_ctx *hctx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001620{
Ming Lei0df21c82017-10-14 17:22:32 +08001621 struct request_queue *q = hctx->queue;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001622 struct scsi_device *sdev = q->queuedata;
Ming Lei0df21c82017-10-14 17:22:32 +08001623
Ming Lei0df21c82017-10-14 17:22:32 +08001624 atomic_dec(&sdev->device_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001625}
1626
Ming Lei88022d72017-11-05 02:21:12 +08001627static bool scsi_mq_get_budget(struct blk_mq_hw_ctx *hctx)
Ming Lei0df21c82017-10-14 17:22:32 +08001628{
1629 struct request_queue *q = hctx->queue;
1630 struct scsi_device *sdev = q->queuedata;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001631
Douglas Andersonb4fd63f2020-04-20 09:24:54 -07001632 return scsi_dev_queue_ready(q, sdev);
Ming Lei0df21c82017-10-14 17:22:32 +08001633}
1634
Christoph Hellwigd2852032014-01-17 12:06:53 +01001635static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1636 const struct blk_mq_queue_data *bd)
1637{
1638 struct request *req = bd->rq;
1639 struct request_queue *q = req->q;
1640 struct scsi_device *sdev = q->queuedata;
1641 struct Scsi_Host *shost = sdev->host;
1642 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1643 blk_status_t ret;
1644 int reason;
1645
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001646 /*
1647 * If the device is not in running state we will reject some or all
1648 * commands.
1649 */
1650 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1651 ret = scsi_prep_state_check(sdev, req);
1652 if (ret != BLK_STS_OK)
1653 goto out_put_budget;
1654 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001655
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001656 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001657 if (!scsi_target_queue_ready(shost, sdev))
Ming Lei826a70a2017-11-04 09:55:34 +08001658 goto out_put_budget;
Ming Lei6eb045e2019-10-25 14:58:55 +08001659 if (!scsi_host_queue_ready(q, shost, sdev, cmd))
Christoph Hellwigd2852032014-01-17 12:06:53 +01001660 goto out_dec_target_busy;
1661
Christoph Hellwige8064022016-10-20 15:12:13 +02001662 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwig785ba832018-11-09 14:42:37 +01001663 ret = scsi_mq_prep_fn(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001664 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001665 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001666 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001667 } else {
Bart Van Asschecd464d82019-01-15 16:50:03 -08001668 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigfe052522014-09-22 15:59:31 +02001669 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001670 }
1671
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001672 cmd->flags &= SCMD_PRESERVED_FLAGS;
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001673 if (sdev->simple_tags)
1674 cmd->flags |= SCMD_TAGGED;
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001675 if (bd->last)
1676 cmd->flags |= SCMD_LAST;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001677
Christoph Hellwigd2852032014-01-17 12:06:53 +01001678 scsi_init_cmd_errh(cmd);
1679 cmd->scsi_done = scsi_mq_done;
1680
1681 reason = scsi_dispatch_cmd(cmd);
1682 if (reason) {
1683 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001684 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001685 goto out_dec_host_busy;
1686 }
1687
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001688 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001689
1690out_dec_host_busy:
Ming Lei6eb045e2019-10-25 14:58:55 +08001691 scsi_dec_host_busy(shost, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001692out_dec_target_busy:
1693 if (scsi_target(sdev)->can_queue > 0)
1694 atomic_dec(&scsi_target(sdev)->target_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001695out_put_budget:
1696 scsi_mq_put_budget(hctx);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001697 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001698 case BLK_STS_OK:
1699 break;
1700 case BLK_STS_RESOURCE:
Ming Lei86ff7c22018-01-30 22:04:57 -05001701 if (atomic_read(&sdev->device_busy) ||
1702 scsi_device_blocked(sdev))
1703 ret = BLK_STS_DEV_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001704 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001705 default:
Jaesoo Leebe549d42019-04-09 17:02:22 -07001706 if (unlikely(!scsi_device_online(sdev)))
1707 scsi_req(req)->result = DID_NO_CONNECT << 16;
1708 else
1709 scsi_req(req)->result = DID_ERROR << 16;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001710 /*
Jaesoo Leebe549d42019-04-09 17:02:22 -07001711 * Make sure to release all allocated resources when
Christoph Hellwigd2852032014-01-17 12:06:53 +01001712 * we hit an error, as we will never see this command
1713 * again.
1714 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001715 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001716 scsi_mq_uninit_cmd(cmd);
1717 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001718 }
1719 return ret;
1720}
1721
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001722static enum blk_eh_timer_return scsi_timeout(struct request *req,
1723 bool reserved)
1724{
1725 if (reserved)
1726 return BLK_EH_RESET_TIMER;
1727 return scsi_times_out(req);
1728}
1729
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001730static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1731 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001732{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001733 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07001734 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001735 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07001736 struct scatterlist *sg;
Bart Van Assche65ca8462020-01-22 19:56:34 -08001737 int ret = 0;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001738
Bart Van Assche8e688252017-06-02 14:21:52 -07001739 if (unchecked_isa_dma)
1740 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
1741 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
1742 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001743 if (!cmd->sense_buffer)
1744 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001745 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07001746
1747 if (scsi_host_get_prot(shost)) {
1748 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1749 shost->hostt->cmd_size;
Ming Lei3dccdf52019-04-28 15:39:32 +08001750 cmd->prot_sdb = (void *)sg + scsi_mq_inline_sgl_size(shost);
Bart Van Assche08f78432017-06-02 14:22:00 -07001751 }
1752
Bart Van Assche65ca8462020-01-22 19:56:34 -08001753 if (shost->hostt->init_cmd_priv) {
1754 ret = shost->hostt->init_cmd_priv(shost, cmd);
1755 if (ret < 0)
1756 scsi_free_sense_buffer(unchecked_isa_dma,
1757 cmd->sense_buffer);
1758 }
1759
1760 return ret;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001761}
1762
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001763static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
1764 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001765{
Bart Van Assche65ca8462020-01-22 19:56:34 -08001766 struct Scsi_Host *shost = set->driver_data;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001767 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1768
Bart Van Assche65ca8462020-01-22 19:56:34 -08001769 if (shost->hostt->exit_cmd_priv)
1770 shost->hostt->exit_cmd_priv(shost, cmd);
Bart Van Assche8e688252017-06-02 14:21:52 -07001771 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
1772 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001773}
1774
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001775static int scsi_map_queues(struct blk_mq_tag_set *set)
1776{
1777 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1778
1779 if (shost->hostt->map_queues)
1780 return shost->hostt->map_queues(shost);
Dongli Zhang99bbf482019-03-12 09:00:28 +08001781 return blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001782}
1783
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001784void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785{
Lin Ming6f381fa2012-04-12 13:50:38 +08001786 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787
Jens Axboea8474ce2007-08-07 09:02:51 +02001788 /*
1789 * this limit is imposed by hardware restrictions
1790 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001791 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07001792 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001793
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001794 if (scsi_host_prot_dma(shost)) {
1795 shost->sg_prot_tablesize =
1796 min_not_zero(shost->sg_prot_tablesize,
1797 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1798 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1799 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1800 }
1801
Christoph Hellwig1b5d9a62019-07-22 11:20:38 +02001802 if (dev->dma_mask) {
1803 shost->max_sectors = min_t(unsigned int, shost->max_sectors,
1804 dma_max_mapping_size(dev) >> SECTOR_SHIFT);
1805 }
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001806 blk_queue_max_hw_sectors(q, shost->max_sectors);
Christoph Hellwig21e07db2018-04-03 19:09:59 +02001807 if (shost->unchecked_isa_dma)
1808 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001810 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
Christoph Hellwiga8cf59a2019-01-16 17:12:15 +01001812 blk_queue_max_segment_size(q, shost->max_segment_size);
Christoph Hellwig7ad388d2019-06-17 14:19:53 +02001813 blk_queue_virt_boundary(q, shost->virt_boundary_mask);
1814 dma_set_max_seg_size(dev, queue_max_segment_size(q));
James Bottomley465ff312008-01-01 10:00:10 -06001815
1816 /*
Huacai Chen90addc62017-11-21 14:23:38 +01001817 * Set a reasonable default alignment: The larger of 32-byte (dword),
1818 * which is a common minimum for HBAs, and the minimum DMA alignment,
1819 * which is set by the platform.
1820 *
1821 * Devices that require a bigger alignment can increase it later.
James Bottomley465ff312008-01-01 10:00:10 -06001822 */
Huacai Chen90addc62017-11-21 14:23:38 +01001823 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001824}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001825EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06001826
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001827static const struct blk_mq_ops scsi_mq_ops_no_commit = {
1828 .get_budget = scsi_mq_get_budget,
1829 .put_budget = scsi_mq_put_budget,
1830 .queue_rq = scsi_queue_rq,
1831 .complete = scsi_softirq_done,
1832 .timeout = scsi_timeout,
1833#ifdef CONFIG_BLK_DEBUG_FS
1834 .show_rq = scsi_show_rq,
1835#endif
1836 .init_request = scsi_mq_init_request,
1837 .exit_request = scsi_mq_exit_request,
1838 .initialize_rq_fn = scsi_initialize_rq,
Steffen Maier82a9ac72019-08-07 16:49:47 +02001839 .cleanup_rq = scsi_cleanup_rq,
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001840 .busy = scsi_mq_lld_busy,
1841 .map_queues = scsi_map_queues,
1842};
1843
1844
1845static void scsi_commit_rqs(struct blk_mq_hw_ctx *hctx)
1846{
1847 struct request_queue *q = hctx->queue;
1848 struct scsi_device *sdev = q->queuedata;
1849 struct Scsi_Host *shost = sdev->host;
1850
1851 shost->hostt->commit_rqs(shost, hctx->queue_num);
1852}
1853
Eric Biggersf363b082017-03-30 13:39:16 -07001854static const struct blk_mq_ops scsi_mq_ops = {
Ming Lei0df21c82017-10-14 17:22:32 +08001855 .get_budget = scsi_mq_get_budget,
1856 .put_budget = scsi_mq_put_budget,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001857 .queue_rq = scsi_queue_rq,
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001858 .commit_rqs = scsi_commit_rqs,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001859 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001860 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07001861#ifdef CONFIG_BLK_DEBUG_FS
1862 .show_rq = scsi_show_rq,
1863#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001864 .init_request = scsi_mq_init_request,
1865 .exit_request = scsi_mq_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001866 .initialize_rq_fn = scsi_initialize_rq,
Ming Leib7e9e1f2019-07-25 10:05:00 +08001867 .cleanup_rq = scsi_cleanup_rq,
Jens Axboe3a7ea2c42018-10-29 10:17:28 -06001868 .busy = scsi_mq_lld_busy,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001869 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001870};
1871
1872struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
1873{
1874 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
1875 if (IS_ERR(sdev->request_queue))
1876 return NULL;
1877
1878 sdev->request_queue->queuedata = sdev;
1879 __scsi_init_queue(sdev->host, sdev->request_queue);
Christoph Hellwig17cb9602018-03-13 17:28:41 +01001880 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001881 return sdev->request_queue;
1882}
1883
1884int scsi_mq_setup_tags(struct Scsi_Host *shost)
1885{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001886 unsigned int cmd_size, sgl_size;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001887
Michael Schmitz9393c8de2019-11-05 15:49:10 +13001888 sgl_size = max_t(unsigned int, sizeof(struct scatterlist),
1889 scsi_mq_inline_sgl_size(shost));
Christoph Hellwigd2852032014-01-17 12:06:53 +01001890 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1891 if (scsi_host_get_prot(shost))
Ming Lei92524fa2019-04-28 15:39:31 +08001892 cmd_size += sizeof(struct scsi_data_buffer) +
1893 sizeof(struct scatterlist) * SCSI_INLINE_PROT_SG_CNT;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001894
1895 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001896 if (shost->hostt->commit_rqs)
1897 shost->tag_set.ops = &scsi_mq_ops;
1898 else
1899 shost->tag_set.ops = &scsi_mq_ops_no_commit;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01001900 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001901 shost->tag_set.queue_depth = shost->can_queue;
1902 shost->tag_set.cmd_size = cmd_size;
1903 shost->tag_set.numa_node = NUMA_NO_NODE;
Ming Lei56d18f62019-02-15 19:13:24 +08001904 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07001905 shost->tag_set.flags |=
1906 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001907 shost->tag_set.driver_data = shost;
1908
1909 return blk_mq_alloc_tag_set(&shost->tag_set);
1910}
1911
1912void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1913{
1914 blk_mq_free_tag_set(&shost->tag_set);
1915}
1916
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001917/**
1918 * scsi_device_from_queue - return sdev associated with a request_queue
1919 * @q: The request queue to return the sdev from
1920 *
1921 * Return the sdev associated with a request queue or NULL if the
1922 * request_queue does not reference a SCSI device.
1923 */
1924struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1925{
1926 struct scsi_device *sdev = NULL;
1927
Steffen Maier6b6fa7a2019-08-07 16:49:48 +02001928 if (q->mq_ops == &scsi_mq_ops_no_commit ||
1929 q->mq_ops == &scsi_mq_ops)
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001930 sdev = q->queuedata;
1931 if (!sdev || !get_device(&sdev->sdev_gendev))
1932 sdev = NULL;
1933
1934 return sdev;
1935}
1936EXPORT_SYMBOL_GPL(scsi_device_from_queue);
1937
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938/*
1939 * Function: scsi_block_requests()
1940 *
1941 * Purpose: Utility function used by low-level drivers to prevent further
1942 * commands from being queued to the device.
1943 *
1944 * Arguments: shost - Host in question
1945 *
1946 * Returns: Nothing
1947 *
1948 * Lock status: No locks are assumed held.
1949 *
1950 * Notes: There is no timer nor any other means by which the requests
1951 * get unblocked other than the low-level driver calling
1952 * scsi_unblock_requests().
1953 */
1954void scsi_block_requests(struct Scsi_Host *shost)
1955{
1956 shost->host_self_blocked = 1;
1957}
1958EXPORT_SYMBOL(scsi_block_requests);
1959
1960/*
1961 * Function: scsi_unblock_requests()
1962 *
1963 * Purpose: Utility function used by low-level drivers to allow further
1964 * commands from being queued to the device.
1965 *
1966 * Arguments: shost - Host in question
1967 *
1968 * Returns: Nothing
1969 *
1970 * Lock status: No locks are assumed held.
1971 *
1972 * Notes: There is no timer nor any other means by which the requests
1973 * get unblocked other than the low-level driver calling
1974 * scsi_unblock_requests().
1975 *
1976 * This is done as an API function so that changes to the
1977 * internals of the scsi mid-layer won't require wholesale
1978 * changes to drivers that use this feature.
1979 */
1980void scsi_unblock_requests(struct Scsi_Host *shost)
1981{
1982 shost->host_self_blocked = 0;
1983 scsi_run_host_queues(shost);
1984}
1985EXPORT_SYMBOL(scsi_unblock_requests);
1986
1987int __init scsi_init_queue(void)
1988{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001989 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1990 sizeof(struct scsi_data_buffer),
1991 0, 0, NULL);
1992 if (!scsi_sdb_cache) {
1993 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001994 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001995 }
1996
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 return 0;
1998}
1999
2000void scsi_exit_queue(void)
2001{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002002 kmem_cache_destroy(scsi_sense_cache);
2003 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002004 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005}
James Bottomley5baba832006-03-18 14:10:35 -06002006
2007/**
2008 * scsi_mode_select - issue a mode select
2009 * @sdev: SCSI device to be queried
2010 * @pf: Page format bit (1 == standard, 0 == vendor specific)
2011 * @sp: Save page bit (0 == don't save, 1 == save)
2012 * @modepage: mode page being requested
2013 * @buffer: request buffer (may not be smaller than eight bytes)
2014 * @len: length of request buffer.
2015 * @timeout: command timeout
2016 * @retries: number of retries before failing
2017 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002018 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06002019 * must be SCSI_SENSE_BUFFERSIZE big.
2020 *
2021 * Returns zero if successful; negative error number or scsi
2022 * status on error
2023 *
2024 */
2025int
2026scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2027 unsigned char *buffer, int len, int timeout, int retries,
2028 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2029{
2030 unsigned char cmd[10];
2031 unsigned char *real_buffer;
2032 int ret;
2033
2034 memset(cmd, 0, sizeof(cmd));
2035 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2036
2037 if (sdev->use_10_for_ms) {
2038 if (len > 65535)
2039 return -EINVAL;
2040 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2041 if (!real_buffer)
2042 return -ENOMEM;
2043 memcpy(real_buffer + 8, buffer, len);
2044 len += 8;
2045 real_buffer[0] = 0;
2046 real_buffer[1] = 0;
2047 real_buffer[2] = data->medium_type;
2048 real_buffer[3] = data->device_specific;
2049 real_buffer[4] = data->longlba ? 0x01 : 0;
2050 real_buffer[5] = 0;
2051 real_buffer[6] = data->block_descriptor_length >> 8;
2052 real_buffer[7] = data->block_descriptor_length;
2053
2054 cmd[0] = MODE_SELECT_10;
2055 cmd[7] = len >> 8;
2056 cmd[8] = len;
2057 } else {
2058 if (len > 255 || data->block_descriptor_length > 255 ||
2059 data->longlba)
2060 return -EINVAL;
2061
2062 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2063 if (!real_buffer)
2064 return -ENOMEM;
2065 memcpy(real_buffer + 4, buffer, len);
2066 len += 4;
2067 real_buffer[0] = 0;
2068 real_buffer[1] = data->medium_type;
2069 real_buffer[2] = data->device_specific;
2070 real_buffer[3] = data->block_descriptor_length;
2071
2072
2073 cmd[0] = MODE_SELECT;
2074 cmd[4] = len;
2075 }
2076
2077 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002078 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002079 kfree(real_buffer);
2080 return ret;
2081}
2082EXPORT_SYMBOL_GPL(scsi_mode_select);
2083
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084/**
Rob Landleyeb448202007-11-03 13:30:39 -05002085 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002086 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 * @dbd: set if mode sense will allow block descriptors to be returned
2088 * @modepage: mode page being requested
2089 * @buffer: request buffer (may not be smaller than eight bytes)
2090 * @len: length of request buffer.
2091 * @timeout: command timeout
2092 * @retries: number of retries before failing
2093 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002094 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002095 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 *
2097 * Returns zero if unsuccessful, or the header offset (either 4
2098 * or 8 depending on whether a six or ten byte command was
2099 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002100 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101int
James Bottomley1cf72692005-08-28 11:27:01 -05002102scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002104 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2105{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 unsigned char cmd[12];
2107 int use_10_for_ms;
2108 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002109 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002110 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111
2112 memset(data, 0, sizeof(*data));
2113 memset(&cmd[0], 0, 12);
Can Guo0ec96912019-12-05 02:14:25 +00002114
2115 dbd = sdev->set_dbd_for_ms ? 8 : dbd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2117 cmd[2] = modepage;
2118
James Bottomleyea73a9f2005-08-28 11:33:52 -05002119 /* caller might not be interested in sense, but we need it */
2120 if (!sshdr)
2121 sshdr = &my_sshdr;
2122
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002124 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125
2126 if (use_10_for_ms) {
2127 if (len < 8)
2128 len = 8;
2129
2130 cmd[0] = MODE_SENSE_10;
2131 cmd[8] = len;
2132 header_length = 8;
2133 } else {
2134 if (len < 4)
2135 len = 4;
2136
2137 cmd[0] = MODE_SENSE;
2138 cmd[4] = len;
2139 header_length = 4;
2140 }
2141
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 memset(buffer, 0, len);
2143
James Bottomley1cf72692005-08-28 11:27:01 -05002144 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002145 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146
2147 /* This code looks awful: what it's doing is making sure an
2148 * ILLEGAL REQUEST sense return identifies the actual command
2149 * byte as the problem. MODE_SENSE commands can return
2150 * ILLEGAL REQUEST if the code page isn't supported */
2151
James Bottomley1cf72692005-08-28 11:27:01 -05002152 if (use_10_for_ms && !scsi_status_is_good(result) &&
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002153 driver_byte(result) == DRIVER_SENSE) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002154 if (scsi_sense_valid(sshdr)) {
2155 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2156 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 /*
2158 * Invalid command operation code
2159 */
James Bottomley1cf72692005-08-28 11:27:01 -05002160 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 goto retry;
2162 }
2163 }
2164 }
2165
James Bottomley1cf72692005-08-28 11:27:01 -05002166 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002167 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2168 (modepage == 6 || modepage == 8))) {
2169 /* Initio breakage? */
2170 header_length = 0;
2171 data->length = 13;
2172 data->medium_type = 0;
2173 data->device_specific = 0;
2174 data->longlba = 0;
2175 data->block_descriptor_length = 0;
2176 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 data->length = buffer[0]*256 + buffer[1] + 2;
2178 data->medium_type = buffer[2];
2179 data->device_specific = buffer[3];
2180 data->longlba = buffer[4] & 0x01;
2181 data->block_descriptor_length = buffer[6]*256
2182 + buffer[7];
2183 } else {
2184 data->length = buffer[0] + 1;
2185 data->medium_type = buffer[1];
2186 data->device_specific = buffer[2];
2187 data->block_descriptor_length = buffer[3];
2188 }
Al Viro6d73c852006-02-23 02:03:16 +01002189 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002190 } else if ((status_byte(result) == CHECK_CONDITION) &&
2191 scsi_sense_valid(sshdr) &&
2192 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2193 retry_count--;
2194 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 }
2196
James Bottomley1cf72692005-08-28 11:27:01 -05002197 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198}
2199EXPORT_SYMBOL(scsi_mode_sense);
2200
James Bottomley001aac22007-12-02 19:10:40 +02002201/**
2202 * scsi_test_unit_ready - test if unit is ready
2203 * @sdev: scsi device to change the state of.
2204 * @timeout: command timeout
2205 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002206 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002207 *
2208 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002209 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002210 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211int
James Bottomley001aac22007-12-02 19:10:40 +02002212scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002213 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 char cmd[] = {
2216 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2217 };
2218 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002219
James Bottomley001aac22007-12-02 19:10:40 +02002220 /* try to eat the UNIT_ATTENTION if there are enough retries */
2221 do {
2222 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
Bart Van Assche9b91fd32018-02-12 10:57:52 -08002223 timeout, 1, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002224 if (sdev->removable && scsi_sense_valid(sshdr) &&
2225 sshdr->sense_key == UNIT_ATTENTION)
2226 sdev->changed = 1;
2227 } while (scsi_sense_valid(sshdr) &&
2228 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002229
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 return result;
2231}
2232EXPORT_SYMBOL(scsi_test_unit_ready);
2233
2234/**
Rob Landleyeb448202007-11-03 13:30:39 -05002235 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 * @sdev: scsi device to change the state of.
2237 * @state: state to change to.
2238 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002239 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002241 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242int
2243scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2244{
2245 enum scsi_device_state oldstate = sdev->sdev_state;
2246
2247 if (state == oldstate)
2248 return 0;
2249
2250 switch (state) {
2251 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002252 switch (oldstate) {
2253 case SDEV_CREATED_BLOCK:
2254 break;
2255 default:
2256 goto illegal;
2257 }
2258 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259
2260 case SDEV_RUNNING:
2261 switch (oldstate) {
2262 case SDEV_CREATED:
2263 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002264 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 case SDEV_QUIESCE:
2266 case SDEV_BLOCK:
2267 break;
2268 default:
2269 goto illegal;
2270 }
2271 break;
2272
2273 case SDEV_QUIESCE:
2274 switch (oldstate) {
2275 case SDEV_RUNNING:
2276 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002277 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 break;
2279 default:
2280 goto illegal;
2281 }
2282 break;
2283
2284 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002285 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 switch (oldstate) {
2287 case SDEV_CREATED:
2288 case SDEV_RUNNING:
2289 case SDEV_QUIESCE:
2290 case SDEV_BLOCK:
2291 break;
2292 default:
2293 goto illegal;
2294 }
2295 break;
2296
2297 case SDEV_BLOCK:
2298 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002300 case SDEV_CREATED_BLOCK:
Hannes Reineckea33e5bf2018-10-07 10:35:35 +02002301 case SDEV_OFFLINE:
James Bottomley6f4267e2008-08-22 16:53:31 -05002302 break;
2303 default:
2304 goto illegal;
2305 }
2306 break;
2307
2308 case SDEV_CREATED_BLOCK:
2309 switch (oldstate) {
2310 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311 break;
2312 default:
2313 goto illegal;
2314 }
2315 break;
2316
2317 case SDEV_CANCEL:
2318 switch (oldstate) {
2319 case SDEV_CREATED:
2320 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002321 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002323 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 break;
2325 default:
2326 goto illegal;
2327 }
2328 break;
2329
2330 case SDEV_DEL:
2331 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002332 case SDEV_CREATED:
2333 case SDEV_RUNNING:
2334 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002335 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002337 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002338 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 break;
2340 default:
2341 goto illegal;
2342 }
2343 break;
2344
2345 }
Ewan D. Milneb0962c52020-03-11 10:39:30 -04002346 sdev->offline_already = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 sdev->sdev_state = state;
2348 return 0;
2349
2350 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002351 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002352 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002353 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002354 scsi_device_state_name(oldstate),
2355 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 );
2357 return -EINVAL;
2358}
2359EXPORT_SYMBOL(scsi_device_set_state);
2360
2361/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002362 * sdev_evt_emit - emit a single SCSI device uevent
2363 * @sdev: associated SCSI device
2364 * @evt: event to emit
2365 *
2366 * Send a single uevent (scsi_event) to the associated scsi_device.
2367 */
2368static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2369{
2370 int idx = 0;
2371 char *envp[3];
2372
2373 switch (evt->evt_type) {
2374 case SDEV_EVT_MEDIA_CHANGE:
2375 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2376 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002377 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002378 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002379 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2380 break;
2381 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2382 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2383 break;
2384 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2385 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2386 break;
2387 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2388 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2389 break;
2390 case SDEV_EVT_LUN_CHANGE_REPORTED:
2391 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2392 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002393 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2394 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2395 break;
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002396 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2397 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2398 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002399 default:
2400 /* do nothing */
2401 break;
2402 }
2403
2404 envp[idx++] = NULL;
2405
2406 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2407}
2408
2409/**
2410 * sdev_evt_thread - send a uevent for each scsi event
2411 * @work: work struct for scsi_device
2412 *
2413 * Dispatch queued events to their associated scsi_device kobjects
2414 * as uevents.
2415 */
2416void scsi_evt_thread(struct work_struct *work)
2417{
2418 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002419 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002420 LIST_HEAD(event_list);
2421
2422 sdev = container_of(work, struct scsi_device, event_work);
2423
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002424 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2425 if (test_and_clear_bit(evt_type, sdev->pending_events))
2426 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2427
Jeff Garzika341cd02007-10-29 17:15:22 -04002428 while (1) {
2429 struct scsi_event *evt;
2430 struct list_head *this, *tmp;
2431 unsigned long flags;
2432
2433 spin_lock_irqsave(&sdev->list_lock, flags);
2434 list_splice_init(&sdev->event_list, &event_list);
2435 spin_unlock_irqrestore(&sdev->list_lock, flags);
2436
2437 if (list_empty(&event_list))
2438 break;
2439
2440 list_for_each_safe(this, tmp, &event_list) {
2441 evt = list_entry(this, struct scsi_event, node);
2442 list_del(&evt->node);
2443 scsi_evt_emit(sdev, evt);
2444 kfree(evt);
2445 }
2446 }
2447}
2448
2449/**
2450 * sdev_evt_send - send asserted event to uevent thread
2451 * @sdev: scsi_device event occurred on
2452 * @evt: event to send
2453 *
2454 * Assert scsi device event asynchronously.
2455 */
2456void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2457{
2458 unsigned long flags;
2459
Kay Sievers4d1566e2008-03-19 13:04:47 +01002460#if 0
2461 /* FIXME: currently this check eliminates all media change events
2462 * for polled devices. Need to update to discriminate between AN
2463 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002464 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2465 kfree(evt);
2466 return;
2467 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002468#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002469
2470 spin_lock_irqsave(&sdev->list_lock, flags);
2471 list_add_tail(&evt->node, &sdev->event_list);
2472 schedule_work(&sdev->event_work);
2473 spin_unlock_irqrestore(&sdev->list_lock, flags);
2474}
2475EXPORT_SYMBOL_GPL(sdev_evt_send);
2476
2477/**
2478 * sdev_evt_alloc - allocate a new scsi event
2479 * @evt_type: type of event to allocate
2480 * @gfpflags: GFP flags for allocation
2481 *
2482 * Allocates and returns a new scsi_event.
2483 */
2484struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2485 gfp_t gfpflags)
2486{
2487 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2488 if (!evt)
2489 return NULL;
2490
2491 evt->evt_type = evt_type;
2492 INIT_LIST_HEAD(&evt->node);
2493
2494 /* evt_type-specific initialization, if any */
2495 switch (evt_type) {
2496 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002497 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2498 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2499 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2500 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2501 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002502 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002503 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002504 default:
2505 /* do nothing */
2506 break;
2507 }
2508
2509 return evt;
2510}
2511EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2512
2513/**
2514 * sdev_evt_send_simple - send asserted event to uevent thread
2515 * @sdev: scsi_device event occurred on
2516 * @evt_type: type of event to send
2517 * @gfpflags: GFP flags for allocation
2518 *
2519 * Assert scsi device event asynchronously, given an event type.
2520 */
2521void sdev_evt_send_simple(struct scsi_device *sdev,
2522 enum scsi_device_event evt_type, gfp_t gfpflags)
2523{
2524 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2525 if (!evt) {
2526 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2527 evt_type);
2528 return;
2529 }
2530
2531 sdev_evt_send(sdev, evt);
2532}
2533EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2534
2535/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536 * scsi_device_quiesce - Block user issued commands.
2537 * @sdev: scsi device to quiesce.
2538 *
2539 * This works by trying to transition to the SDEV_QUIESCE state
2540 * (which must be a legal transition). When the device is in this
2541 * state, only special requests will be accepted, all others will
2542 * be deferred. Since special requests may also be requeued requests,
2543 * a successful return doesn't guarantee the device will be
2544 * totally quiescent.
2545 *
2546 * Must be called with user context, may sleep.
2547 *
2548 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002549 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550int
2551scsi_device_quiesce(struct scsi_device *sdev)
2552{
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002553 struct request_queue *q = sdev->request_queue;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002554 int err;
2555
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002556 /*
2557 * It is allowed to call scsi_device_quiesce() multiple times from
2558 * the same context but concurrent scsi_device_quiesce() calls are
2559 * not allowed.
2560 */
2561 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2562
Bart Van Asschecd84a622018-09-26 14:01:04 -07002563 if (sdev->quiesced_by == current)
2564 return 0;
2565
2566 blk_set_pm_only(q);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002567
2568 blk_mq_freeze_queue(q);
2569 /*
Bart Van Asschecd84a622018-09-26 14:01:04 -07002570 * Ensure that the effect of blk_set_pm_only() will be visible
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002571 * for percpu_ref_tryget() callers that occur after the queue
2572 * unfreeze even if the queue was already frozen before this function
2573 * was called. See also https://lwn.net/Articles/573497/.
2574 */
2575 synchronize_rcu();
2576 blk_mq_unfreeze_queue(q);
2577
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002578 mutex_lock(&sdev->state_mutex);
2579 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002580 if (err == 0)
2581 sdev->quiesced_by = current;
2582 else
Bart Van Asschecd84a622018-09-26 14:01:04 -07002583 blk_clear_pm_only(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002584 mutex_unlock(&sdev->state_mutex);
2585
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002586 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587}
2588EXPORT_SYMBOL(scsi_device_quiesce);
2589
2590/**
2591 * scsi_device_resume - Restart user issued commands to a quiesced device.
2592 * @sdev: scsi device to resume.
2593 *
2594 * Moves the device from quiesced back to running and restarts the
2595 * queues.
2596 *
2597 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002598 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002599void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002601 /* check if the device state was mutated prior to resume, and if
2602 * so assume the state is being managed elsewhere (for example
2603 * device deleted during suspend)
2604 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002605 mutex_lock(&sdev->state_mutex);
Bart Van Assche17605af2019-03-15 16:27:58 -07002606 if (sdev->quiesced_by) {
2607 sdev->quiesced_by = NULL;
2608 blk_clear_pm_only(sdev->request_queue);
2609 }
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002610 if (sdev->sdev_state == SDEV_QUIESCE)
2611 scsi_device_set_state(sdev, SDEV_RUNNING);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002612 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613}
2614EXPORT_SYMBOL(scsi_device_resume);
2615
2616static void
2617device_quiesce_fn(struct scsi_device *sdev, void *data)
2618{
2619 scsi_device_quiesce(sdev);
2620}
2621
2622void
2623scsi_target_quiesce(struct scsi_target *starget)
2624{
2625 starget_for_each_device(starget, NULL, device_quiesce_fn);
2626}
2627EXPORT_SYMBOL(scsi_target_quiesce);
2628
2629static void
2630device_resume_fn(struct scsi_device *sdev, void *data)
2631{
2632 scsi_device_resume(sdev);
2633}
2634
2635void
2636scsi_target_resume(struct scsi_target *starget)
2637{
2638 starget_for_each_device(starget, NULL, device_resume_fn);
2639}
2640EXPORT_SYMBOL(scsi_target_resume);
2641
2642/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002643 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2644 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002646 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002648 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002650 * Notes:
2651 * This routine transitions the device to the SDEV_BLOCK state (which must be
2652 * a legal transition). When the device is in this state, command processing
2653 * is paused until the device leaves the SDEV_BLOCK state. See also
2654 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002655 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002656int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657{
Jens Axboe165125e2007-07-24 09:28:11 +02002658 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659 int err = 0;
2660
2661 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002662 if (err) {
2663 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2664
2665 if (err)
2666 return err;
2667 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002668
2669 /*
2670 * The device has transitioned to SDEV_BLOCK. Stop the
2671 * block layer from calling the midlayer with this device's
2672 * request queue.
2673 */
Jens Axboef664a3c2018-11-01 16:36:27 -06002674 blk_mq_quiesce_queue_nowait(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002675 return 0;
2676}
Bart Van Assche551eb592017-06-02 14:21:53 -07002677EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2678
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002680 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2681 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002683 * Pause SCSI command processing on the specified device and wait until all
2684 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002686 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002688 * Note:
2689 * This routine transitions the device to the SDEV_BLOCK state (which must be
2690 * a legal transition). When the device is in this state, command processing
2691 * is paused until the device leaves the SDEV_BLOCK state. See also
2692 * scsi_internal_device_unblock().
Rob Landleyeb448202007-11-03 13:30:39 -05002693 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002694static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695{
Bart Van Assche551eb592017-06-02 14:21:53 -07002696 struct request_queue *q = sdev->request_queue;
2697 int err;
2698
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002699 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07002700 err = scsi_internal_device_block_nowait(sdev);
Jens Axboef664a3c2018-11-01 16:36:27 -06002701 if (err == 0)
2702 blk_mq_quiesce_queue(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002703 mutex_unlock(&sdev->state_mutex);
2704
Bart Van Assche551eb592017-06-02 14:21:53 -07002705 return err;
2706}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002707
Bart Van Assche66483a42017-06-02 14:21:56 -07002708void scsi_start_queue(struct scsi_device *sdev)
2709{
2710 struct request_queue *q = sdev->request_queue;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002711
Jens Axboef664a3c2018-11-01 16:36:27 -06002712 blk_mq_unquiesce_queue(q);
Bart Van Assche66483a42017-06-02 14:21:56 -07002713}
2714
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715/**
Bart Van Assche43f75712017-06-02 14:21:54 -07002716 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07002718 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002719 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002720 * Restart the device queue for a previously suspended SCSI device. Does not
2721 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002723 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002725 * Notes:
2726 * This routine transitions the device to the SDEV_RUNNING state or to one of
2727 * the offline states (which must be a legal transition) allowing the midlayer
2728 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729 */
Bart Van Assche43f75712017-06-02 14:21:54 -07002730int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2731 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002732{
Bart Van Assche09addb12019-08-01 15:38:12 -07002733 switch (new_state) {
2734 case SDEV_RUNNING:
2735 case SDEV_TRANSPORT_OFFLINE:
2736 break;
2737 default:
2738 return -EINVAL;
2739 }
2740
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002741 /*
2742 * Try to transition the scsi device to SDEV_RUNNING or one of the
2743 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002744 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002745 switch (sdev->sdev_state) {
2746 case SDEV_BLOCK:
2747 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002748 sdev->sdev_state = new_state;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002749 break;
2750 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002751 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2752 new_state == SDEV_OFFLINE)
2753 sdev->sdev_state = new_state;
2754 else
2755 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002756 break;
2757 case SDEV_CANCEL:
2758 case SDEV_OFFLINE:
2759 break;
2760 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002761 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002762 }
Bart Van Assche66483a42017-06-02 14:21:56 -07002763 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764
2765 return 0;
2766}
Bart Van Assche43f75712017-06-02 14:21:54 -07002767EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2768
2769/**
2770 * scsi_internal_device_unblock - resume a device after a block request
2771 * @sdev: device to resume
2772 * @new_state: state to set the device to after unblocking
2773 *
2774 * Restart the device queue for a previously suspended SCSI device. May sleep.
2775 *
2776 * Returns zero if successful or a negative error code upon failure.
2777 *
2778 * Notes:
2779 * This routine transitions the device to the SDEV_RUNNING state or to one of
2780 * the offline states (which must be a legal transition) allowing the midlayer
2781 * to goose the queue for this device.
2782 */
2783static int scsi_internal_device_unblock(struct scsi_device *sdev,
2784 enum scsi_device_state new_state)
2785{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002786 int ret;
2787
2788 mutex_lock(&sdev->state_mutex);
2789 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2790 mutex_unlock(&sdev->state_mutex);
2791
2792 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07002793}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794
2795static void
2796device_block(struct scsi_device *sdev, void *data)
2797{
Bart Van Assche94ef80a2019-08-01 15:38:13 -07002798 int ret;
2799
2800 ret = scsi_internal_device_block(sdev);
2801
2802 WARN_ONCE(ret, "scsi_internal_device_block(%s) failed: ret = %d\n",
2803 dev_name(&sdev->sdev_gendev), ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804}
2805
2806static int
2807target_block(struct device *dev, void *data)
2808{
2809 if (scsi_is_target_device(dev))
2810 starget_for_each_device(to_scsi_target(dev), NULL,
2811 device_block);
2812 return 0;
2813}
2814
2815void
2816scsi_target_block(struct device *dev)
2817{
2818 if (scsi_is_target_device(dev))
2819 starget_for_each_device(to_scsi_target(dev), NULL,
2820 device_block);
2821 else
2822 device_for_each_child(dev, NULL, target_block);
2823}
2824EXPORT_SYMBOL_GPL(scsi_target_block);
2825
2826static void
2827device_unblock(struct scsi_device *sdev, void *data)
2828{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002829 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002830}
2831
2832static int
2833target_unblock(struct device *dev, void *data)
2834{
2835 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002836 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002837 device_unblock);
2838 return 0;
2839}
2840
2841void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002842scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843{
2844 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002845 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002846 device_unblock);
2847 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002848 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002849}
2850EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002851
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002852int
2853scsi_host_block(struct Scsi_Host *shost)
2854{
2855 struct scsi_device *sdev;
2856 int ret = 0;
2857
2858 shost_for_each_device(sdev, shost) {
2859 ret = scsi_internal_device_block(sdev);
2860 if (ret)
2861 break;
2862 }
2863 return ret;
2864}
2865EXPORT_SYMBOL_GPL(scsi_host_block);
2866
2867int
2868scsi_host_unblock(struct Scsi_Host *shost, int new_state)
2869{
2870 struct scsi_device *sdev;
2871 int ret = 0;
2872
2873 shost_for_each_device(sdev, shost) {
2874 ret = scsi_internal_device_unblock(sdev, new_state);
2875 if (ret)
2876 break;
2877 }
2878 return ret;
2879}
2880EXPORT_SYMBOL_GPL(scsi_host_unblock);
2881
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002882/**
2883 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002884 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002885 * @sg_count: number of segments in sg
2886 * @offset: offset in bytes into sg, on return offset into the mapped area
2887 * @len: bytes to map, on return number of bytes mapped
2888 *
2889 * Returns virtual address of the start of the mapped page
2890 */
Jens Axboec6132da2007-10-16 11:08:49 +02002891void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002892 size_t *offset, size_t *len)
2893{
2894 int i;
2895 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002896 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002897 struct page *page;
2898
Andrew Morton22cfefb2007-02-05 16:39:03 -08002899 WARN_ON(!irqs_disabled());
2900
Jens Axboec6132da2007-10-16 11:08:49 +02002901 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002902 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002903 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002904 if (sg_len > *offset)
2905 break;
2906 }
2907
2908 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002909 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2910 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002911 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002912 WARN_ON(1);
2913 return NULL;
2914 }
2915
2916 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002917 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002918
2919 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002920 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002921 *offset &= ~PAGE_MASK;
2922
2923 /* Bytes in this sg-entry from *offset to the end of the page */
2924 sg_len = PAGE_SIZE - *offset;
2925 if (*len > sg_len)
2926 *len = sg_len;
2927
Cong Wang77dfce02011-11-25 23:14:23 +08002928 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002929}
2930EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2931
2932/**
Rob Landleyeb448202007-11-03 13:30:39 -05002933 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002934 * @virt: virtual address to be unmapped
2935 */
2936void scsi_kunmap_atomic_sg(void *virt)
2937{
Cong Wang77dfce02011-11-25 23:14:23 +08002938 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002939}
2940EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002941
2942void sdev_disable_disk_events(struct scsi_device *sdev)
2943{
2944 atomic_inc(&sdev->disk_events_disable_depth);
2945}
2946EXPORT_SYMBOL(sdev_disable_disk_events);
2947
2948void sdev_enable_disk_events(struct scsi_device *sdev)
2949{
2950 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2951 return;
2952 atomic_dec(&sdev->disk_events_disable_depth);
2953}
2954EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002955
2956/**
2957 * scsi_vpd_lun_id - return a unique device identification
2958 * @sdev: SCSI device
2959 * @id: buffer for the identification
2960 * @id_len: length of the buffer
2961 *
2962 * Copies a unique device identification into @id based
2963 * on the information in the VPD page 0x83 of the device.
2964 * The string will be formatted as a SCSI name string.
2965 *
2966 * Returns the length of the identification or error on failure.
2967 * If the identifier is longer than the supplied buffer the actual
2968 * identifier length is returned and the buffer is not zero-padded.
2969 */
2970int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
2971{
2972 u8 cur_id_type = 0xff;
2973 u8 cur_id_size = 0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002974 const unsigned char *d, *cur_id_str;
2975 const struct scsi_vpd *vpd_pg83;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002976 int id_size = -EINVAL;
2977
2978 rcu_read_lock();
2979 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
2980 if (!vpd_pg83) {
2981 rcu_read_unlock();
2982 return -ENXIO;
2983 }
2984
2985 /*
2986 * Look for the correct descriptor.
2987 * Order of preference for lun descriptor:
2988 * - SCSI name string
2989 * - NAA IEEE Registered Extended
2990 * - EUI-64 based 16-byte
2991 * - EUI-64 based 12-byte
2992 * - NAA IEEE Registered
2993 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02002994 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002995 * as longer descriptors reduce the likelyhood
2996 * of identification clashes.
2997 */
2998
2999 /* The id string must be at least 20 bytes + terminating NULL byte */
3000 if (id_len < 21) {
3001 rcu_read_unlock();
3002 return -EINVAL;
3003 }
3004
3005 memset(id, 0, id_len);
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003006 d = vpd_pg83->data + 4;
3007 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003008 /* Skip designators not referring to the LUN */
3009 if ((d[1] & 0x30) != 0x00)
3010 goto next_desig;
3011
3012 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02003013 case 0x1:
3014 /* T10 Vendor ID */
3015 if (cur_id_size > d[3])
3016 break;
3017 /* Prefer anything */
3018 if (cur_id_type > 0x01 && cur_id_type != 0xff)
3019 break;
3020 cur_id_size = d[3];
3021 if (cur_id_size + 4 > id_len)
3022 cur_id_size = id_len - 4;
3023 cur_id_str = d + 4;
3024 cur_id_type = d[1] & 0xf;
3025 id_size = snprintf(id, id_len, "t10.%*pE",
3026 cur_id_size, cur_id_str);
3027 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003028 case 0x2:
3029 /* EUI-64 */
3030 if (cur_id_size > d[3])
3031 break;
3032 /* Prefer NAA IEEE Registered Extended */
3033 if (cur_id_type == 0x3 &&
3034 cur_id_size == d[3])
3035 break;
3036 cur_id_size = d[3];
3037 cur_id_str = d + 4;
3038 cur_id_type = d[1] & 0xf;
3039 switch (cur_id_size) {
3040 case 8:
3041 id_size = snprintf(id, id_len,
3042 "eui.%8phN",
3043 cur_id_str);
3044 break;
3045 case 12:
3046 id_size = snprintf(id, id_len,
3047 "eui.%12phN",
3048 cur_id_str);
3049 break;
3050 case 16:
3051 id_size = snprintf(id, id_len,
3052 "eui.%16phN",
3053 cur_id_str);
3054 break;
3055 default:
3056 cur_id_size = 0;
3057 break;
3058 }
3059 break;
3060 case 0x3:
3061 /* NAA */
3062 if (cur_id_size > d[3])
3063 break;
3064 cur_id_size = d[3];
3065 cur_id_str = d + 4;
3066 cur_id_type = d[1] & 0xf;
3067 switch (cur_id_size) {
3068 case 8:
3069 id_size = snprintf(id, id_len,
3070 "naa.%8phN",
3071 cur_id_str);
3072 break;
3073 case 16:
3074 id_size = snprintf(id, id_len,
3075 "naa.%16phN",
3076 cur_id_str);
3077 break;
3078 default:
3079 cur_id_size = 0;
3080 break;
3081 }
3082 break;
3083 case 0x8:
3084 /* SCSI name string */
3085 if (cur_id_size + 4 > d[3])
3086 break;
3087 /* Prefer others for truncated descriptor */
3088 if (cur_id_size && d[3] > id_len)
3089 break;
3090 cur_id_size = id_size = d[3];
3091 cur_id_str = d + 4;
3092 cur_id_type = d[1] & 0xf;
3093 if (cur_id_size >= id_len)
3094 cur_id_size = id_len - 1;
3095 memcpy(id, cur_id_str, cur_id_size);
3096 /* Decrease priority for truncated descriptor */
3097 if (cur_id_size != id_size)
3098 cur_id_size = 6;
3099 break;
3100 default:
3101 break;
3102 }
3103next_desig:
3104 d += d[3] + 4;
3105 }
3106 rcu_read_unlock();
3107
3108 return id_size;
3109}
3110EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003111
3112/*
3113 * scsi_vpd_tpg_id - return a target port group identifier
3114 * @sdev: SCSI device
3115 *
3116 * Returns the Target Port Group identifier from the information
3117 * froom VPD page 0x83 of the device.
3118 *
3119 * Returns the identifier or error on failure.
3120 */
3121int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3122{
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003123 const unsigned char *d;
3124 const struct scsi_vpd *vpd_pg83;
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003125 int group_id = -EAGAIN, rel_port = -1;
3126
3127 rcu_read_lock();
3128 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3129 if (!vpd_pg83) {
3130 rcu_read_unlock();
3131 return -ENXIO;
3132 }
3133
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003134 d = vpd_pg83->data + 4;
3135 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003136 switch (d[1] & 0xf) {
3137 case 0x4:
3138 /* Relative target port */
3139 rel_port = get_unaligned_be16(&d[6]);
3140 break;
3141 case 0x5:
3142 /* Target port group */
3143 group_id = get_unaligned_be16(&d[6]);
3144 break;
3145 default:
3146 break;
3147 }
3148 d += d[3] + 4;
3149 }
3150 rcu_read_unlock();
3151
3152 if (group_id >= 0 && rel_id && rel_port != -1)
3153 *rel_id = rel_port;
3154
3155 return group_id;
3156}
3157EXPORT_SYMBOL(scsi_vpd_tpg_id);