blob: 4e88d7e9cf9a31a38713457645c5ea77b78d5783 [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)
192 scsi_device_unbusy(device);
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/*
324 * Decrement the host_busy counter and wake up the error handler if necessary.
325 * Avoid as follows that the error handler is not woken up if shost->host_busy
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 its
328 * entirety either finishes before scsi_eh_scmd_add() increases the
329 * host_failed counter or that it notices the shost state change made by
330 * scsi_eh_scmd_add().
331 */
332static void scsi_dec_host_busy(struct Scsi_Host *shost)
333{
334 unsigned long flags;
335
336 rcu_read_lock();
Ming Leid772a652018-08-27 15:24:43 +0800337 atomic_dec(&shost->host_busy);
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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347void scsi_device_unbusy(struct scsi_device *sdev)
348{
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
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800352 scsi_dec_host_busy(shost);
353
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{
Ming Leid772a652018-08-27 15:24:43 +0800433 if (shost->can_queue > 0 &&
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100434 atomic_read(&shost->host_busy) >= shost->can_queue)
435 return true;
436 if (atomic_read(&shost->host_blocked) > 0)
437 return true;
438 if (shost->host_self_blocked)
439 return true;
440 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400441}
442
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800443static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600445 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800446 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 unsigned long flags;
448
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600450 list_splice_init(&shost->starved_list, &starved_list);
451
452 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200453 struct request_queue *slq;
454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 /*
456 * As long as shost is accepting commands and we have
457 * starved queues, call blk_run_queue. scsi_request_fn
458 * drops the queue_lock and can add us back to the
459 * starved_list.
460 *
461 * host_lock protects the starved_list and starved_entry.
462 * scsi_request_fn must get the host_lock before checking
463 * or modifying starved_list or starved_entry.
464 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600465 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500466 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500467
Mike Christie2a3a59e2008-11-11 13:42:35 -0600468 sdev = list_entry(starved_list.next,
469 struct scsi_device, starved_entry);
470 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500471 if (scsi_target_is_busy(scsi_target(sdev))) {
472 list_move_tail(&sdev->starved_entry,
473 &shost->starved_list);
474 continue;
475 }
476
James Bottomleye2eb7242013-07-02 15:05:26 +0200477 /*
478 * Once we drop the host lock, a racing scsi_remove_device()
479 * call may remove the sdev from the starved list and destroy
480 * it and the queue. Mitigate by taking a reference to the
481 * queue and never touching the sdev again after we drop the
482 * host lock. Note: if __scsi_remove_device() invokes
483 * blk_cleanup_queue() before the queue is run from this
484 * function then blk_run_queue() will return immediately since
485 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
486 */
487 slq = sdev->request_queue;
488 if (!blk_get_queue(slq))
489 continue;
490 spin_unlock_irqrestore(shost->host_lock, flags);
491
Christoph Hellwigd2852032014-01-17 12:06:53 +0100492 scsi_kick_queue(slq);
James Bottomleye2eb7242013-07-02 15:05:26 +0200493 blk_put_queue(slq);
494
495 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600497 /* put any unprocessed entries back */
498 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800500}
501
502/*
503 * Function: scsi_run_queue()
504 *
505 * Purpose: Select a proper request queue to serve next
506 *
507 * Arguments: q - last request's queue
508 *
509 * Returns: Nothing
510 *
511 * Notes: The previous command was completely finished, start
512 * a new one if possible.
513 */
514static void scsi_run_queue(struct request_queue *q)
515{
516 struct scsi_device *sdev = q->queuedata;
517
518 if (scsi_target(sdev)->single_lun)
519 scsi_single_lun_run(sdev);
520 if (!list_empty(&sdev->host->starved_list))
521 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
Jens Axboef664a3c2018-11-01 16:36:27 -0600523 blk_mq_run_hw_queues(q, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524}
525
Jens Axboe9937a5e2011-05-17 11:04:44 +0200526void scsi_requeue_run_queue(struct work_struct *work)
527{
528 struct scsi_device *sdev;
529 struct request_queue *q;
530
531 sdev = container_of(work, struct scsi_device, requeue_work);
532 q = sdev->request_queue;
533 scsi_run_queue(q);
534}
535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536void scsi_run_host_queues(struct Scsi_Host *shost)
537{
538 struct scsi_device *sdev;
539
540 shost_for_each_device(sdev, shost)
541 scsi_run_queue(sdev->request_queue);
542}
543
Christoph Hellwigd2852032014-01-17 12:06:53 +0100544static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
545{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100546 if (!blk_rq_is_passthrough(cmd->request)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100547 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
548
549 if (drv->uninit_command)
550 drv->uninit_command(cmd);
551 }
552}
553
554static void scsi_mq_free_sgtables(struct scsi_cmnd *cmd)
555{
556 if (cmd->sdb.table.nents)
Ming Lei3dccdf52019-04-28 15:39:32 +0800557 sg_free_table_chained(&cmd->sdb.table,
558 SCSI_INLINE_SG_CNT);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100559 if (scsi_prot_sg_count(cmd))
Ming Lei92524fa2019-04-28 15:39:31 +0800560 sg_free_table_chained(&cmd->prot_sdb->table,
561 SCSI_INLINE_PROT_SG_CNT);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100562}
563
564static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
565{
Christoph Hellwigd2852032014-01-17 12:06:53 +0100566 scsi_mq_free_sgtables(cmd);
567 scsi_uninit_cmd(cmd);
Bart Van Assche2dd6fb52017-06-02 14:21:58 -0700568 scsi_del_cmd_from_list(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100569}
570
Douglas Gilbert7e63b5a2018-06-23 12:22:14 +0200571/* Returns false when no more bytes to process, true if there are more */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200572static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100573 unsigned int bytes)
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800574{
Bart Van Asschebed22132017-08-25 13:46:32 -0700575 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800576 struct scsi_device *sdev = cmd->device;
577 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800578
579 if (blk_update_request(req, error, bytes))
580 return true;
581
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800582 if (blk_queue_add_random(q))
583 add_disk_randomness(req->rq_disk);
584
Bart Van Assche64104f72017-08-30 16:58:39 -0700585 if (!blk_rq_is_scsi(req)) {
586 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
587 cmd->flags &= ~SCMD_INITIALIZED;
588 }
589
Jens Axboef664a3c2018-11-01 16:36:27 -0600590 /*
Bart Van Asschedb983f62019-03-18 09:29:26 -0700591 * Calling rcu_barrier() is not necessary here because the
592 * SCSI error handler guarantees that the function called by
593 * call_rcu() has been called before scsi_end_request() is
594 * called.
595 */
596 destroy_rcu_head(&cmd->rcu);
597
598 /*
Jens Axboef664a3c2018-11-01 16:36:27 -0600599 * In the MQ case the command gets freed by __blk_mq_end_request,
600 * so we have to do all cleanup that depends on it earlier.
601 *
602 * We also can't kick the queues from irq context, so we
603 * will have to defer it to a workqueue.
604 */
605 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800606
Jens Axboea78b03b2018-11-18 15:46:03 -0700607 /*
608 * queue is still alive, so grab the ref for preventing it
609 * from being cleaned up during running queue.
610 */
611 percpu_ref_get(&q->q_usage_counter);
Ming Lei8dc765d2018-11-14 16:25:51 +0800612
Jens Axboef664a3c2018-11-01 16:36:27 -0600613 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100614
Jens Axboef664a3c2018-11-01 16:36:27 -0600615 if (scsi_target(sdev)->single_lun ||
616 !list_empty(&sdev->host->starved_list))
617 kblockd_schedule_work(&sdev->requeue_work);
618 else
619 blk_mq_run_hw_queues(q, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100620
Jens Axboea78b03b2018-11-18 15:46:03 -0700621 percpu_ref_put(&q->q_usage_counter);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800622 return false;
623}
624
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200625/**
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700626 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
627 * @cmd: SCSI command
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200628 * @result: scsi error code
629 *
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700630 * Translate a SCSI result code into a blk_status_t value. May reset the host
631 * byte of @cmd->result.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200632 */
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700633static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100634{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200635 switch (host_byte(result)) {
Bart Van Asschef4abab32018-04-05 10:33:01 -0700636 case DID_OK:
637 /*
638 * Also check the other bytes than the status byte in result
639 * to handle the case when a SCSI LLD sets result to
640 * DRIVER_SENSE << 24 without setting SAM_STAT_CHECK_CONDITION.
641 */
642 if (scsi_status_is_good(result) && (result & ~0xff) == 0)
643 return BLK_STS_OK;
644 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100645 case DID_TRANSPORT_FAILFAST:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200646 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100647 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000648 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200649 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100650 case DID_NEXUS_FAILURE:
Martin Wilck4a067cf2019-02-14 22:57:41 +0100651 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200652 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200653 case DID_ALLOC_FAILURE:
654 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200655 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200656 case DID_MEDIUM_ERROR:
657 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200658 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100659 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200660 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100661 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100662}
663
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200664/* Helper for scsi_io_completion() when "reprep" action required. */
665static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
666 struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667{
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200668 /* A new command will be prepared and issued. */
Jens Axboef664a3c2018-11-01 16:36:27 -0600669 scsi_mq_requeue_cmd(cmd);
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200670}
671
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200672/* Helper for scsi_io_completion() when special action required. */
673static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
Douglas Gilbertab831082018-06-23 12:22:16 +0200674{
Jens Axboe165125e2007-07-24 09:28:11 +0200675 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 struct request *req = cmd->request;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200677 int level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500678 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
679 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900680 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200681 struct scsi_sense_hdr sshdr;
682 bool sense_valid;
683 bool sense_current = true; /* false implies "deferred sense" */
684 blk_status_t blk_stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200686 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
687 if (sense_valid)
688 sense_current = !scsi_sense_is_deferred(&sshdr);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200689
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200690 blk_stat = scsi_result_to_blk_status(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500691
Alan Sternb60af5b2008-11-03 15:56:47 -0500692 if (host_byte(result) == DID_RESET) {
693 /* Third party bus reset or reset for error recovery
694 * reasons. Just retry the command and see what
695 * happens.
696 */
697 action = ACTION_RETRY;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200698 } else if (sense_valid && sense_current) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 switch (sshdr.sense_key) {
700 case UNIT_ATTENTION:
701 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700702 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 * and quietly refuse further access.
704 */
705 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500706 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700708 /* Must have been a power glitch, or a
709 * bus reset. Could not have been a
710 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500711 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700712 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500713 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 }
715 break;
716 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700717 /* If we had an ILLEGAL REQUEST returned, then
718 * we may have performed an unsupported
719 * command. The only thing this should be
720 * would be a ten byte read where only a six
721 * byte read was supported. Also, on a system
722 * where READ CAPACITY failed, we may have
723 * read past the end of the disk.
724 */
Jens Axboe26a68012005-11-29 21:03:34 +0100725 if ((cmd->device->use_10_for_rw &&
726 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 (cmd->cmnd[0] == READ_10 ||
728 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500729 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500731 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500732 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500733 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200734 blk_stat = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500735 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400736 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500737 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200738 blk_stat = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500739 } else
740 action = ACTION_FAIL;
741 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400742 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000743 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200744 if (sshdr.asc == 0x10) /* DIF */
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200745 blk_stat = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 break;
747 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700748 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500749 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500751 if (sshdr.asc == 0x04) {
752 switch (sshdr.ascq) {
753 case 0x01: /* becoming ready */
754 case 0x04: /* format in progress */
755 case 0x05: /* rebuild in progress */
756 case 0x06: /* recalculation in progress */
757 case 0x07: /* operation in progress */
758 case 0x08: /* Long write in progress */
759 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500760 case 0x14: /* space allocation in progress */
Douglas Gilberte37c7d92018-05-18 19:25:47 -0400761 case 0x1a: /* start stop unit in progress */
762 case 0x1b: /* sanitize in progress */
763 case 0x1d: /* configuration in progress */
764 case 0x24: /* depopulation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500765 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500766 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500767 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500768 action = ACTION_FAIL;
769 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500770 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200771 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500772 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500773 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700775 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500776 action = ACTION_FAIL;
777 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500779 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 break;
781 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200782 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500783 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500784
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900785 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200786 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900787 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900788
Alan Sternb60af5b2008-11-03 15:56:47 -0500789 switch (action) {
790 case ACTION_FAIL:
791 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200792 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200793 static DEFINE_RATELIMIT_STATE(_rs,
794 DEFAULT_RATELIMIT_INTERVAL,
795 DEFAULT_RATELIMIT_BURST);
796
797 if (unlikely(scsi_logging_level))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200798 level =
799 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
800 SCSI_LOG_MLCOMPLETE_BITS);
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200801
802 /*
803 * if logging is enabled the failure will be printed
804 * in scsi_log_completion(), so avoid duplicate messages
805 */
806 if (!level && __ratelimit(&_rs)) {
807 scsi_print_result(cmd, NULL, FAILED);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +0200808 if (driver_byte(result) == DRIVER_SENSE)
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200809 scsi_print_sense(cmd);
810 scsi_print_command(cmd);
811 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500812 }
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100813 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req)))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800814 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200815 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500816 case ACTION_REPREP:
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200817 scsi_io_completion_reprep(cmd, q);
Alan Sternb60af5b2008-11-03 15:56:47 -0500818 break;
819 case ACTION_RETRY:
820 /* Retry the same command immediately */
Bart Van Assche08640e82018-01-10 14:41:45 -0800821 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500822 break;
823 case ACTION_DELAYED_RETRY:
824 /* Retry the same command after a delay */
Bart Van Assche08640e82018-01-10 14:41:45 -0800825 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500826 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 }
828}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200830/*
831 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
832 * new result that may suppress further error checking. Also modifies
833 * *blk_statp in some cases.
834 */
835static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
836 blk_status_t *blk_statp)
837{
838 bool sense_valid;
839 bool sense_current = true; /* false implies "deferred sense" */
840 struct request *req = cmd->request;
841 struct scsi_sense_hdr sshdr;
842
843 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
844 if (sense_valid)
845 sense_current = !scsi_sense_is_deferred(&sshdr);
846
847 if (blk_rq_is_passthrough(req)) {
848 if (sense_valid) {
849 /*
850 * SG_IO wants current and deferred errors
851 */
852 scsi_req(req)->sense_len =
853 min(8 + cmd->sense_buffer[7],
854 SCSI_SENSE_BUFFERSIZE);
855 }
856 if (sense_current)
857 *blk_statp = scsi_result_to_blk_status(cmd, result);
858 } else if (blk_rq_bytes(req) == 0 && sense_current) {
859 /*
860 * Flush commands do not transfers any data, and thus cannot use
861 * good_bytes != blk_rq_bytes(req) as the signal for an error.
862 * This sets *blk_statp explicitly for the problem case.
863 */
864 *blk_statp = scsi_result_to_blk_status(cmd, result);
865 }
866 /*
867 * Recovered errors need reporting, but they're always treated as
868 * success, so fiddle the result code here. For passthrough requests
869 * we already took a copy of the original into sreq->result which
870 * is what gets returned to the user
871 */
872 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
873 bool do_print = true;
874 /*
875 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
876 * skip print since caller wants ATA registers. Only occurs
877 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
878 */
879 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
880 do_print = false;
881 else if (req->rq_flags & RQF_QUIET)
882 do_print = false;
883 if (do_print)
884 scsi_print_sense(cmd);
885 result = 0;
886 /* for passthrough, *blk_statp may be set */
887 *blk_statp = BLK_STS_OK;
888 }
889 /*
890 * Another corner case: the SCSI status byte is non-zero but 'good'.
891 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
892 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
893 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
894 * intermediate statuses (both obsolete in SAM-4) as good.
895 */
896 if (status_byte(result) && scsi_status_is_good(result)) {
897 result = 0;
898 *blk_statp = BLK_STS_OK;
899 }
900 return result;
901}
902
903/*
904 * Function: scsi_io_completion()
905 *
906 * Purpose: Completion processing for block device I/O requests.
907 *
908 * Arguments: cmd - command that is finished.
909 *
910 * Lock status: Assumed that no lock is held upon entry.
911 *
912 * Returns: Nothing
913 *
914 * Notes: We will finish off the specified number of sectors. If we
915 * are done, the command block will be released and the queue
916 * function will be goosed. If we are not done then we have to
917 * figure out what to do next:
918 *
919 * a) We can call scsi_requeue_command(). The request
920 * will be unprepared and put back on the queue. Then
921 * a new command will be created for it. This should
922 * be used if we made forward progress, or if we want
923 * to switch from READ(10) to READ(6) for example.
924 *
925 * b) We can call __scsi_queue_insert(). The request will
926 * be put back on the queue and retried using the same
927 * command as before, possibly after a delay.
928 *
929 * c) We can call scsi_end_request() with blk_stat other than
930 * BLK_STS_OK, to fail the remainder of the request.
931 */
932void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
933{
934 int result = cmd->result;
935 struct request_queue *q = cmd->device->request_queue;
936 struct request *req = cmd->request;
937 blk_status_t blk_stat = BLK_STS_OK;
938
Douglas Gilbert0d437902018-06-23 12:22:19 +0200939 if (unlikely(result)) /* a nz result may or may not be an error */
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200940 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
941
Douglas Gilbert0d437902018-06-23 12:22:19 +0200942 if (unlikely(blk_rq_is_passthrough(req))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200943 /*
944 * scsi_result_to_blk_status may have reset the host_byte
945 */
946 scsi_req(req)->result = cmd->result;
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200947 }
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200948
949 /*
950 * Next deal with any sectors which we were able to correctly
951 * handle.
952 */
953 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
954 "%u sectors total, %d bytes done.\n",
955 blk_rq_sectors(req), good_bytes));
956
957 /*
958 * Next deal with any sectors which we were able to correctly
959 * handle. Failed, zero length commands always need to drop down
960 * to retry code. Fast path should return in this block.
961 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200962 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100963 if (likely(!scsi_end_request(req, blk_stat, good_bytes)))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200964 return; /* no bytes remaining */
965 }
966
Douglas Gilbert0d437902018-06-23 12:22:19 +0200967 /* Kill remainder if no retries. */
968 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100969 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req)))
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200970 WARN_ONCE(true,
971 "Bytes remaining after failed, no-retry command");
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200972 return;
973 }
974
975 /*
976 * If there had been no error, but we have leftover bytes in the
977 * requeues just queue the command up again.
978 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200979 if (likely(result == 0))
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200980 scsi_io_completion_reprep(cmd, q);
981 else
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200982 scsi_io_completion_action(cmd, result);
983}
984
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100985static blk_status_t scsi_init_sgtable(struct request *req,
986 struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200988 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
990 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +0100991 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700993 if (unlikely(sg_alloc_table_chained(&sdb->table,
Ming Lei46358732019-04-28 15:39:30 +0800994 blk_rq_nr_phys_segments(req), sdb->table.sgl,
Ming Lei3dccdf52019-04-28 15:39:32 +0800995 SCSI_INLINE_SG_CNT)))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100996 return BLK_STS_RESOURCE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 /*
999 * Next, walk the list, and fill in the addresses and sizes of
1000 * each segment.
1001 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001002 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1003 BUG_ON(count > sdb->table.nents);
1004 sdb->table.nents = count;
Christoph Hellwigfd102b12017-01-13 12:29:11 +01001005 sdb->length = blk_rq_payload_bytes(req);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001006 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001008
1009/*
1010 * Function: scsi_init_io()
1011 *
1012 * Purpose: SCSI I/O initialize function.
1013 *
1014 * Arguments: cmd - Command descriptor we wish to initialize
1015 *
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001016 * Returns: BLK_STS_OK on success
1017 * BLK_STS_RESOURCE if the failure is retryable
1018 * BLK_STS_IOERR if the failure is fatal
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001019 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001020blk_status_t scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001021{
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001022 struct request *rq = cmd->request;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001023 blk_status_t ret;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001024
Johannes Thumshirnfd3fc0b2017-01-31 10:16:00 +01001025 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001026 return BLK_STS_IOERR;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001027
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001028 ret = scsi_init_sgtable(rq, &cmd->sdb);
1029 if (ret)
1030 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001031
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001032 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001033 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1034 int ivecs, count;
1035
Christoph Hellwig14784562018-11-09 14:42:38 +01001036 if (WARN_ON_ONCE(!prot_sdb)) {
Ewan D. Milne91724c22015-01-15 10:02:12 -05001037 /*
1038 * This can happen if someone (e.g. multipath)
1039 * queues a command to a device on an adapter
1040 * that does not support DIX.
1041 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001042 ret = BLK_STS_IOERR;
Christoph Hellwig14784562018-11-09 14:42:38 +01001043 goto out_free_sgtables;
Ewan D. Milne91724c22015-01-15 10:02:12 -05001044 }
1045
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001046 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001047
Ming Lin001d63b2016-04-04 14:48:09 -07001048 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lei46358732019-04-28 15:39:30 +08001049 prot_sdb->table.sgl,
Ming Lei92524fa2019-04-28 15:39:31 +08001050 SCSI_INLINE_PROT_SG_CNT)) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001051 ret = BLK_STS_RESOURCE;
Christoph Hellwig14784562018-11-09 14:42:38 +01001052 goto out_free_sgtables;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001053 }
1054
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001055 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001056 prot_sdb->table.sgl);
Igor Stoppa6f1d8a52018-09-05 23:47:20 +03001057 BUG_ON(count > ivecs);
1058 BUG_ON(count > queue_max_integrity_segments(rq->q));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001059
1060 cmd->prot_sdb = prot_sdb;
1061 cmd->prot_sdb->table.nents = count;
1062 }
1063
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001064 return BLK_STS_OK;
Christoph Hellwig14784562018-11-09 14:42:38 +01001065out_free_sgtables:
Jens Axboef664a3c2018-11-01 16:36:27 -06001066 scsi_mq_free_sgtables(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001067 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001068}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001069EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001071/**
Bart Van Assche832889f2017-08-30 16:58:40 -07001072 * scsi_initialize_rq - initialize struct scsi_cmnd partially
Jonathan Corbet35c05062017-08-24 16:11:09 -06001073 * @rq: Request associated with the SCSI command to be initialized.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001074 *
Bart Van Assche832889f2017-08-30 16:58:40 -07001075 * This function initializes the members of struct scsi_cmnd that must be
1076 * initialized before request processing starts and that won't be
1077 * reinitialized if a SCSI command is requeued.
1078 *
Bart Van Assche64104f72017-08-30 16:58:39 -07001079 * Called from inside blk_get_request() for pass-through requests and from
1080 * inside scsi_init_command() for filesystem requests.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001081 */
Bart Van Asschee4c94702017-12-07 15:59:31 -08001082static void scsi_initialize_rq(struct request *rq)
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001083{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001084 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1085
1086 scsi_req_init(&cmd->req);
Bart Van Assche3be88282018-02-22 11:30:20 -08001087 init_rcu_head(&cmd->rcu);
Bart Van Assche832889f2017-08-30 16:58:40 -07001088 cmd->jiffies_at_alloc = jiffies;
1089 cmd->retries = 0;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001090}
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001091
Ming Leib7e9e1f2019-07-25 10:05:00 +08001092/*
1093 * Only called when the request isn't completed by SCSI, and not freed by
1094 * SCSI
1095 */
1096static void scsi_cleanup_rq(struct request *rq)
1097{
1098 if (rq->rq_flags & RQF_DONTPREP) {
1099 scsi_mq_uninit_cmd(blk_mq_rq_to_pdu(rq));
1100 rq->rq_flags &= ~RQF_DONTPREP;
1101 }
1102}
1103
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001104/* Add a command to the list used by the aacraid and dpt_i2o drivers */
1105void scsi_add_cmd_to_list(struct scsi_cmnd *cmd)
1106{
1107 struct scsi_device *sdev = cmd->device;
1108 struct Scsi_Host *shost = sdev->host;
1109 unsigned long flags;
1110
1111 if (shost->use_cmd_list) {
1112 spin_lock_irqsave(&sdev->list_lock, flags);
1113 list_add_tail(&cmd->list, &sdev->cmd_list);
1114 spin_unlock_irqrestore(&sdev->list_lock, flags);
1115 }
1116}
1117
1118/* Remove a command from the list used by the aacraid and dpt_i2o drivers */
1119void scsi_del_cmd_from_list(struct scsi_cmnd *cmd)
1120{
1121 struct scsi_device *sdev = cmd->device;
1122 struct Scsi_Host *shost = sdev->host;
1123 unsigned long flags;
1124
1125 if (shost->use_cmd_list) {
1126 spin_lock_irqsave(&sdev->list_lock, flags);
1127 BUG_ON(list_empty(&cmd->list));
1128 list_del_init(&cmd->list);
1129 spin_unlock_irqrestore(&sdev->list_lock, flags);
1130 }
1131}
1132
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001133/* Called after a request has been started. */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001134void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001135{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001136 void *buf = cmd->sense_buffer;
1137 void *prot = cmd->prot_sdb;
Bart Van Assche64104f72017-08-30 16:58:39 -07001138 struct request *rq = blk_mq_rq_from_pdu(cmd);
1139 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
Bart Van Assche832889f2017-08-30 16:58:40 -07001140 unsigned long jiffies_at_alloc;
1141 int retries;
Bart Van Assche64104f72017-08-30 16:58:39 -07001142
1143 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1144 flags |= SCMD_INITIALIZED;
1145 scsi_initialize_rq(rq);
1146 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001147
Bart Van Assche832889f2017-08-30 16:58:40 -07001148 jiffies_at_alloc = cmd->jiffies_at_alloc;
1149 retries = cmd->retries;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001150 /* zero out the cmd, except for the embedded scsi_request */
1151 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001152 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001153
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001154 cmd->device = dev;
1155 cmd->sense_buffer = buf;
1156 cmd->prot_sdb = prot;
Bart Van Assche64104f72017-08-30 16:58:39 -07001157 cmd->flags = flags;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001158 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
Bart Van Assche832889f2017-08-30 16:58:40 -07001159 cmd->jiffies_at_alloc = jiffies_at_alloc;
1160 cmd->retries = retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001161
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001162 scsi_add_cmd_to_list(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001163}
1164
Christoph Hellwig785ba832018-11-09 14:42:37 +01001165static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1166 struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001167{
Bart Van Asschebed22132017-08-25 13:46:32 -07001168 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001169
1170 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001171 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001172 * a bio attached to them. Or they might contain a SCSI command
1173 * that does not transfer data, in which case they may optionally
1174 * submit a request without an attached bio.
1175 */
1176 if (req->bio) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001177 blk_status_t ret = scsi_init_io(cmd);
1178 if (unlikely(ret != BLK_STS_OK))
1179 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001180 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001181 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001182
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001183 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001184 }
James Bottomley7b163182005-12-15 20:17:02 -06001185
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001186 cmd->cmd_len = scsi_req(req)->cmd_len;
1187 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001188 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001189 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig785ba832018-11-09 14:42:37 +01001190 return BLK_STS_OK;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001191}
1192
1193/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001194 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001195 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001196 */
Christoph Hellwig785ba832018-11-09 14:42:37 +01001197static blk_status_t scsi_setup_fs_cmnd(struct scsi_device *sdev,
1198 struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001199{
Bart Van Asschebed22132017-08-25 13:46:32 -07001200 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001201
Christoph Hellwigee14c672015-08-27 14:16:59 +02001202 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
Christoph Hellwig4c1cb672018-11-09 14:42:40 +01001203 blk_status_t ret = sdev->handler->prep_fn(sdev, req);
1204 if (ret != BLK_STS_OK)
1205 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001206 }
1207
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001208 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001209 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001210 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001211}
James Bottomley7b163182005-12-15 20:17:02 -06001212
Christoph Hellwig785ba832018-11-09 14:42:37 +01001213static blk_status_t scsi_setup_cmnd(struct scsi_device *sdev,
1214 struct request *req)
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001215{
Bart Van Asschebed22132017-08-25 13:46:32 -07001216 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001217
1218 if (!blk_rq_bytes(req))
1219 cmd->sc_data_direction = DMA_NONE;
1220 else if (rq_data_dir(req) == WRITE)
1221 cmd->sc_data_direction = DMA_TO_DEVICE;
1222 else
1223 cmd->sc_data_direction = DMA_FROM_DEVICE;
1224
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001225 if (blk_rq_is_scsi(req))
1226 return scsi_setup_scsi_cmnd(sdev, req);
1227 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001228 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001229}
1230
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001231static blk_status_t
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001232scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233{
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001234 switch (sdev->sdev_state) {
1235 case SDEV_OFFLINE:
1236 case SDEV_TRANSPORT_OFFLINE:
1237 /*
1238 * If the device is offline we refuse to process any
1239 * commands. The device must be brought online
1240 * before trying any recovery commands.
1241 */
1242 sdev_printk(KERN_ERR, sdev,
1243 "rejecting I/O to offline device\n");
1244 return BLK_STS_IOERR;
1245 case SDEV_DEL:
1246 /*
1247 * If the device is fully deleted, we refuse to
1248 * process any commands as well.
1249 */
1250 sdev_printk(KERN_ERR, sdev,
1251 "rejecting I/O to dead device\n");
1252 return BLK_STS_IOERR;
1253 case SDEV_BLOCK:
1254 case SDEV_CREATED_BLOCK:
1255 return BLK_STS_RESOURCE;
1256 case SDEV_QUIESCE:
1257 /*
1258 * If the devices is blocked we defer normal commands.
1259 */
1260 if (req && !(req->rq_flags & RQF_PREEMPT))
1261 return BLK_STS_RESOURCE;
1262 return BLK_STS_OK;
1263 default:
1264 /*
1265 * For any other not fully online state we only allow
1266 * special commands. In particular any user initiated
1267 * command is not allowed.
1268 */
1269 if (req && !(req->rq_flags & RQF_PREEMPT))
1270 return BLK_STS_IOERR;
1271 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001273}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275/*
1276 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1277 * return 0.
1278 *
1279 * Called with the queue_lock held.
1280 */
1281static inline int scsi_dev_queue_ready(struct request_queue *q,
1282 struct scsi_device *sdev)
1283{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001284 unsigned int busy;
1285
1286 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001287 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001288 if (busy)
1289 goto out_dec;
1290
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 /*
1292 * unblock after device_blocked iterates to zero
1293 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001294 if (atomic_dec_return(&sdev->device_blocked) > 0)
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001295 goto out_dec;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001296 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1297 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001299
1300 if (busy >= sdev->queue_depth)
1301 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302
1303 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001304out_dec:
1305 atomic_dec(&sdev->device_busy);
1306 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307}
1308
Mike Christief0c0a372008-08-17 15:24:38 -05001309/*
1310 * scsi_target_queue_ready: checks if there we can send commands to target
1311 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001312 */
1313static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1314 struct scsi_device *sdev)
1315{
1316 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001317 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001318
1319 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001320 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001321 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001322 starget->starget_sdev_user != sdev) {
1323 spin_unlock_irq(shost->host_lock);
1324 return 0;
1325 }
Mike Christief0c0a372008-08-17 15:24:38 -05001326 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001327 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001328 }
1329
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001330 if (starget->can_queue <= 0)
1331 return 1;
1332
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001333 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001334 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001335 if (busy)
1336 goto starved;
1337
Mike Christief0c0a372008-08-17 15:24:38 -05001338 /*
1339 * unblock after target_blocked iterates to zero
1340 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001341 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001342 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001343
1344 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1345 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001346 }
1347
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001348 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001349 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001350
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001351 return 1;
1352
1353starved:
1354 spin_lock_irq(shost->host_lock);
1355 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001356 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001357out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001358 if (starget->can_queue > 0)
1359 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001360 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001361}
1362
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363/*
1364 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1365 * return 0. We must end up running the queue again whenever 0 is
1366 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 */
1368static inline int scsi_host_queue_ready(struct request_queue *q,
1369 struct Scsi_Host *shost,
1370 struct scsi_device *sdev)
1371{
Christoph Hellwig74665012014-01-22 15:29:29 +01001372 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001373
James Bottomley939647e2005-09-18 15:05:20 -05001374 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001375 return 0;
1376
Ming Leid772a652018-08-27 15:24:43 +08001377 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001378 if (atomic_read(&shost->host_blocked) > 0) {
Ming Leid772a652018-08-27 15:24:43 +08001379 if (busy)
Christoph Hellwig74665012014-01-22 15:29:29 +01001380 goto starved;
1381
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 /*
1383 * unblock after host_blocked iterates to zero
1384 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001385 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001386 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001387
1388 SCSI_LOG_MLQUEUE(3,
1389 shost_printk(KERN_INFO, shost,
1390 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001392
Ming Leid772a652018-08-27 15:24:43 +08001393 if (shost->can_queue > 0 && busy >= shost->can_queue)
Christoph Hellwig74665012014-01-22 15:29:29 +01001394 goto starved;
1395 if (shost->host_self_blocked)
1396 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397
1398 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001399 if (!list_empty(&sdev->starved_entry)) {
1400 spin_lock_irq(shost->host_lock);
1401 if (!list_empty(&sdev->starved_entry))
1402 list_del_init(&sdev->starved_entry);
1403 spin_unlock_irq(shost->host_lock);
1404 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
Christoph Hellwig74665012014-01-22 15:29:29 +01001406 return 1;
1407
1408starved:
1409 spin_lock_irq(shost->host_lock);
1410 if (list_empty(&sdev->starved_entry))
1411 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001412 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001413out_dec:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001414 scsi_dec_host_busy(shost);
Christoph Hellwig74665012014-01-22 15:29:29 +01001415 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416}
1417
1418/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001419 * Busy state exporting function for request stacking drivers.
1420 *
1421 * For efficiency, no lock is taken to check the busy state of
1422 * shost/starget/sdev, since the returned value is not guaranteed and
1423 * may be changed after request stacking drivers call the function,
1424 * regardless of taking lock or not.
1425 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001426 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1427 * needs to return 'not busy'. Otherwise, request stacking drivers
1428 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001429 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001430static bool scsi_mq_lld_busy(struct request_queue *q)
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001431{
1432 struct scsi_device *sdev = q->queuedata;
1433 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001434
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001435 if (blk_queue_dying(q))
Jens Axboef664a3c2018-11-01 16:36:27 -06001436 return false;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001437
1438 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001439
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001440 /*
1441 * Ignore host/starget busy state.
1442 * Since block layer does not have a concept of fairness across
1443 * multiple queues, congestion of host/starget needs to be handled
1444 * in SCSI layer.
1445 */
1446 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Jens Axboef664a3c2018-11-01 16:36:27 -06001447 return true;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001448
Jens Axboef664a3c2018-11-01 16:36:27 -06001449 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450}
1451
Jens Axboe1aea6432006-01-09 16:03:03 +01001452static void scsi_softirq_done(struct request *rq)
1453{
Bart Van Asschebed22132017-08-25 13:46:32 -07001454 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001455 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001456 int disposition;
1457
1458 INIT_LIST_HEAD(&cmd->eh_entry);
1459
Jens Axboe242f9dc2008-09-14 05:55:09 -07001460 atomic_inc(&cmd->device->iodone_cnt);
1461 if (cmd->result)
1462 atomic_inc(&cmd->device->ioerr_cnt);
1463
Jens Axboe1aea6432006-01-09 16:03:03 +01001464 disposition = scsi_decide_disposition(cmd);
1465 if (disposition != SUCCESS &&
1466 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
Maurizio Lombardi463cdad82019-07-02 13:27:05 +02001467 scmd_printk(KERN_ERR, cmd,
Jens Axboe1aea6432006-01-09 16:03:03 +01001468 "timing out command, waited %lus\n",
1469 wait_for/HZ);
1470 disposition = SUCCESS;
1471 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001472
Jens Axboe1aea6432006-01-09 16:03:03 +01001473 scsi_log_completion(cmd, disposition);
1474
1475 switch (disposition) {
1476 case SUCCESS:
1477 scsi_finish_command(cmd);
1478 break;
1479 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001480 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001481 break;
1482 case ADD_TO_MLQUEUE:
1483 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1484 break;
1485 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001486 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001487 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001488 }
1489}
1490
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001491/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001492 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1493 * @cmd: command block we are dispatching.
1494 *
1495 * Return: nonzero return request was rejected and device's queue needs to be
1496 * plugged.
1497 */
1498static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1499{
1500 struct Scsi_Host *host = cmd->device->host;
1501 int rtn = 0;
1502
1503 atomic_inc(&cmd->device->iorequest_cnt);
1504
1505 /* check if the device is still usable */
1506 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1507 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1508 * returns an immediate error upwards, and signals
1509 * that the device is no longer present */
1510 cmd->result = DID_NO_CONNECT << 16;
1511 goto done;
1512 }
1513
1514 /* Check to see if the scsi lld made this device blocked. */
1515 if (unlikely(scsi_device_blocked(cmd->device))) {
1516 /*
1517 * in blocked state, the command is just put back on
1518 * the device queue. The suspend state has already
1519 * blocked the queue so future requests should not
1520 * occur until the device transitions out of the
1521 * suspend state.
1522 */
1523 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1524 "queuecommand : device blocked\n"));
1525 return SCSI_MLQUEUE_DEVICE_BUSY;
1526 }
1527
1528 /* Store the LUN value in cmnd, if needed. */
1529 if (cmd->device->lun_in_cdb)
1530 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1531 (cmd->device->lun << 5 & 0xe0);
1532
1533 scsi_log_send(cmd);
1534
1535 /*
1536 * Before we queue this command, check if the command
1537 * length exceeds what the host adapter can handle.
1538 */
1539 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1540 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1541 "queuecommand : command too long. "
1542 "cdb_size=%d host->max_cmd_len=%d\n",
1543 cmd->cmd_len, cmd->device->host->max_cmd_len));
1544 cmd->result = (DID_ABORT << 16);
1545 goto done;
1546 }
1547
1548 if (unlikely(host->shost_state == SHOST_DEL)) {
1549 cmd->result = (DID_NO_CONNECT << 16);
1550 goto done;
1551
1552 }
1553
1554 trace_scsi_dispatch_cmd_start(cmd);
1555 rtn = host->hostt->queuecommand(host, cmd);
1556 if (rtn) {
1557 trace_scsi_dispatch_cmd_error(cmd, rtn);
1558 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1559 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1560 rtn = SCSI_MLQUEUE_HOST_BUSY;
1561
1562 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1563 "queuecommand : request rejected\n"));
1564 }
1565
1566 return rtn;
1567 done:
1568 cmd->scsi_done(cmd);
1569 return 0;
1570}
1571
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001572/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
Ming Lei3dccdf52019-04-28 15:39:32 +08001573static unsigned int scsi_mq_inline_sgl_size(struct Scsi_Host *shost)
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001574{
Ming Lei3dccdf52019-04-28 15:39:32 +08001575 return min_t(unsigned int, shost->sg_tablesize, SCSI_INLINE_SG_CNT) *
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001576 sizeof(struct scatterlist);
1577}
1578
Christoph Hellwig785ba832018-11-09 14:42:37 +01001579static blk_status_t scsi_mq_prep_fn(struct request *req)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001580{
1581 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1582 struct scsi_device *sdev = req->q->queuedata;
1583 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001584 struct scatterlist *sg;
1585
Bart Van Assche08f78432017-06-02 14:22:00 -07001586 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001587
Christoph Hellwigd2852032014-01-17 12:06:53 +01001588 cmd->request = req;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001589 cmd->tag = req->tag;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001590 cmd->prot_op = SCSI_PROT_NORMAL;
1591
Christoph Hellwigd2852032014-01-17 12:06:53 +01001592 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1593 cmd->sdb.table.sgl = sg;
1594
1595 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001596 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1597
1598 cmd->prot_sdb->table.sgl =
1599 (struct scatterlist *)(cmd->prot_sdb + 1);
1600 }
1601
Christoph Hellwigfe052522014-09-22 15:59:31 +02001602 blk_mq_start_request(req);
1603
Bart Van Assche8fe8ffb2017-10-20 11:46:45 -07001604 return scsi_setup_cmnd(sdev, req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001605}
1606
1607static void scsi_mq_done(struct scsi_cmnd *cmd)
1608{
Keith Buschf1342702018-11-26 09:54:29 -07001609 if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state)))
1610 return;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001611 trace_scsi_dispatch_cmd_done(cmd);
Keith Buschf1342702018-11-26 09:54:29 -07001612
1613 /*
1614 * If the block layer didn't complete the request due to a timeout
1615 * injection, scsi must clear its internal completed state so that the
1616 * timeout handler will see it needs to escalate its own error
1617 * recovery.
1618 */
1619 if (unlikely(!blk_mq_complete_request(cmd->request)))
1620 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001621}
1622
Ming Lei0df21c82017-10-14 17:22:32 +08001623static void scsi_mq_put_budget(struct blk_mq_hw_ctx *hctx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001624{
Ming Lei0df21c82017-10-14 17:22:32 +08001625 struct request_queue *q = hctx->queue;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001626 struct scsi_device *sdev = q->queuedata;
Ming Lei0df21c82017-10-14 17:22:32 +08001627
Ming Lei0df21c82017-10-14 17:22:32 +08001628 atomic_dec(&sdev->device_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001629}
1630
Ming Lei88022d72017-11-05 02:21:12 +08001631static bool scsi_mq_get_budget(struct blk_mq_hw_ctx *hctx)
Ming Lei0df21c82017-10-14 17:22:32 +08001632{
1633 struct request_queue *q = hctx->queue;
1634 struct scsi_device *sdev = q->queuedata;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001635
Ming Lei18c4f0a2019-04-12 11:30:32 +08001636 if (scsi_dev_queue_ready(q, sdev))
1637 return true;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001638
Ming Lei7e70aa72017-12-05 15:52:56 +08001639 if (atomic_read(&sdev->device_busy) == 0 && !scsi_device_blocked(sdev))
1640 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Ming Lei88022d72017-11-05 02:21:12 +08001641 return false;
Ming Lei0df21c82017-10-14 17:22:32 +08001642}
1643
Christoph Hellwigd2852032014-01-17 12:06:53 +01001644static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1645 const struct blk_mq_queue_data *bd)
1646{
1647 struct request *req = bd->rq;
1648 struct request_queue *q = req->q;
1649 struct scsi_device *sdev = q->queuedata;
1650 struct Scsi_Host *shost = sdev->host;
1651 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1652 blk_status_t ret;
1653 int reason;
1654
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001655 /*
1656 * If the device is not in running state we will reject some or all
1657 * commands.
1658 */
1659 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1660 ret = scsi_prep_state_check(sdev, req);
1661 if (ret != BLK_STS_OK)
1662 goto out_put_budget;
1663 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001664
1665 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001666 if (!scsi_target_queue_ready(shost, sdev))
Ming Lei826a70a2017-11-04 09:55:34 +08001667 goto out_put_budget;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001668 if (!scsi_host_queue_ready(q, shost, sdev))
1669 goto out_dec_target_busy;
1670
Christoph Hellwige8064022016-10-20 15:12:13 +02001671 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwig785ba832018-11-09 14:42:37 +01001672 ret = scsi_mq_prep_fn(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001673 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001674 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001675 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001676 } else {
Bart Van Asschecd464d82019-01-15 16:50:03 -08001677 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigfe052522014-09-22 15:59:31 +02001678 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001679 }
1680
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001681 if (sdev->simple_tags)
1682 cmd->flags |= SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001683 else
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001684 cmd->flags &= ~SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001685
Christoph Hellwigd2852032014-01-17 12:06:53 +01001686 scsi_init_cmd_errh(cmd);
1687 cmd->scsi_done = scsi_mq_done;
1688
1689 reason = scsi_dispatch_cmd(cmd);
1690 if (reason) {
1691 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001692 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001693 goto out_dec_host_busy;
1694 }
1695
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001696 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001697
1698out_dec_host_busy:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001699 scsi_dec_host_busy(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001700out_dec_target_busy:
1701 if (scsi_target(sdev)->can_queue > 0)
1702 atomic_dec(&scsi_target(sdev)->target_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001703out_put_budget:
1704 scsi_mq_put_budget(hctx);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001705 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001706 case BLK_STS_OK:
1707 break;
1708 case BLK_STS_RESOURCE:
Ming Lei86ff7c22018-01-30 22:04:57 -05001709 if (atomic_read(&sdev->device_busy) ||
1710 scsi_device_blocked(sdev))
1711 ret = BLK_STS_DEV_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001712 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001713 default:
Jaesoo Leebe549d42019-04-09 17:02:22 -07001714 if (unlikely(!scsi_device_online(sdev)))
1715 scsi_req(req)->result = DID_NO_CONNECT << 16;
1716 else
1717 scsi_req(req)->result = DID_ERROR << 16;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001718 /*
Jaesoo Leebe549d42019-04-09 17:02:22 -07001719 * Make sure to release all allocated resources when
Christoph Hellwigd2852032014-01-17 12:06:53 +01001720 * we hit an error, as we will never see this command
1721 * again.
1722 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001723 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001724 scsi_mq_uninit_cmd(cmd);
1725 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001726 }
1727 return ret;
1728}
1729
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001730static enum blk_eh_timer_return scsi_timeout(struct request *req,
1731 bool reserved)
1732{
1733 if (reserved)
1734 return BLK_EH_RESET_TIMER;
1735 return scsi_times_out(req);
1736}
1737
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001738static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1739 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001740{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001741 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07001742 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001743 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07001744 struct scatterlist *sg;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001745
Bart Van Assche8e688252017-06-02 14:21:52 -07001746 if (unchecked_isa_dma)
1747 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
1748 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
1749 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001750 if (!cmd->sense_buffer)
1751 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001752 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07001753
1754 if (scsi_host_get_prot(shost)) {
1755 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1756 shost->hostt->cmd_size;
Ming Lei3dccdf52019-04-28 15:39:32 +08001757 cmd->prot_sdb = (void *)sg + scsi_mq_inline_sgl_size(shost);
Bart Van Assche08f78432017-06-02 14:22:00 -07001758 }
1759
Christoph Hellwigd2852032014-01-17 12:06:53 +01001760 return 0;
1761}
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{
1766 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1767
Bart Van Assche8e688252017-06-02 14:21:52 -07001768 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
1769 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001770}
1771
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001772static int scsi_map_queues(struct blk_mq_tag_set *set)
1773{
1774 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1775
1776 if (shost->hostt->map_queues)
1777 return shost->hostt->map_queues(shost);
Dongli Zhang99bbf482019-03-12 09:00:28 +08001778 return blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001779}
1780
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001781void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782{
Lin Ming6f381fa2012-04-12 13:50:38 +08001783 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784
Jens Axboea8474ce2007-08-07 09:02:51 +02001785 /*
1786 * this limit is imposed by hardware restrictions
1787 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001788 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07001789 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001790
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001791 if (scsi_host_prot_dma(shost)) {
1792 shost->sg_prot_tablesize =
1793 min_not_zero(shost->sg_prot_tablesize,
1794 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1795 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1796 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1797 }
1798
Christoph Hellwig1b5d9a62019-07-22 11:20:38 +02001799 if (dev->dma_mask) {
1800 shost->max_sectors = min_t(unsigned int, shost->max_sectors,
1801 dma_max_mapping_size(dev) >> SECTOR_SHIFT);
1802 }
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001803 blk_queue_max_hw_sectors(q, shost->max_sectors);
Christoph Hellwig21e07db2018-04-03 19:09:59 +02001804 if (shost->unchecked_isa_dma)
1805 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001807 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808
Christoph Hellwiga8cf59a2019-01-16 17:12:15 +01001809 blk_queue_max_segment_size(q, shost->max_segment_size);
Christoph Hellwig7ad388d2019-06-17 14:19:53 +02001810 blk_queue_virt_boundary(q, shost->virt_boundary_mask);
1811 dma_set_max_seg_size(dev, queue_max_segment_size(q));
James Bottomley465ff312008-01-01 10:00:10 -06001812
1813 /*
Huacai Chen90addc62017-11-21 14:23:38 +01001814 * Set a reasonable default alignment: The larger of 32-byte (dword),
1815 * which is a common minimum for HBAs, and the minimum DMA alignment,
1816 * which is set by the platform.
1817 *
1818 * Devices that require a bigger alignment can increase it later.
James Bottomley465ff312008-01-01 10:00:10 -06001819 */
Huacai Chen90addc62017-11-21 14:23:38 +01001820 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001821}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001822EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06001823
Eric Biggersf363b082017-03-30 13:39:16 -07001824static const struct blk_mq_ops scsi_mq_ops = {
Ming Lei0df21c82017-10-14 17:22:32 +08001825 .get_budget = scsi_mq_get_budget,
1826 .put_budget = scsi_mq_put_budget,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001827 .queue_rq = scsi_queue_rq,
1828 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001829 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07001830#ifdef CONFIG_BLK_DEBUG_FS
1831 .show_rq = scsi_show_rq,
1832#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001833 .init_request = scsi_mq_init_request,
1834 .exit_request = scsi_mq_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001835 .initialize_rq_fn = scsi_initialize_rq,
Ming Leib7e9e1f2019-07-25 10:05:00 +08001836 .cleanup_rq = scsi_cleanup_rq,
Jens Axboe3a7ea2c42018-10-29 10:17:28 -06001837 .busy = scsi_mq_lld_busy,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001838 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001839};
1840
1841struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
1842{
1843 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
1844 if (IS_ERR(sdev->request_queue))
1845 return NULL;
1846
1847 sdev->request_queue->queuedata = sdev;
1848 __scsi_init_queue(sdev->host, sdev->request_queue);
Christoph Hellwig17cb9602018-03-13 17:28:41 +01001849 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001850 return sdev->request_queue;
1851}
1852
1853int scsi_mq_setup_tags(struct Scsi_Host *shost)
1854{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001855 unsigned int cmd_size, sgl_size;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001856
Ming Lei3dccdf52019-04-28 15:39:32 +08001857 sgl_size = scsi_mq_inline_sgl_size(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001858 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1859 if (scsi_host_get_prot(shost))
Ming Lei92524fa2019-04-28 15:39:31 +08001860 cmd_size += sizeof(struct scsi_data_buffer) +
1861 sizeof(struct scatterlist) * SCSI_INLINE_PROT_SG_CNT;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001862
1863 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
1864 shost->tag_set.ops = &scsi_mq_ops;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01001865 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001866 shost->tag_set.queue_depth = shost->can_queue;
1867 shost->tag_set.cmd_size = cmd_size;
1868 shost->tag_set.numa_node = NUMA_NO_NODE;
Ming Lei56d18f62019-02-15 19:13:24 +08001869 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07001870 shost->tag_set.flags |=
1871 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001872 shost->tag_set.driver_data = shost;
1873
1874 return blk_mq_alloc_tag_set(&shost->tag_set);
1875}
1876
1877void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1878{
1879 blk_mq_free_tag_set(&shost->tag_set);
1880}
1881
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001882/**
1883 * scsi_device_from_queue - return sdev associated with a request_queue
1884 * @q: The request queue to return the sdev from
1885 *
1886 * Return the sdev associated with a request queue or NULL if the
1887 * request_queue does not reference a SCSI device.
1888 */
1889struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1890{
1891 struct scsi_device *sdev = NULL;
1892
Jens Axboef664a3c2018-11-01 16:36:27 -06001893 if (q->mq_ops == &scsi_mq_ops)
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001894 sdev = q->queuedata;
1895 if (!sdev || !get_device(&sdev->sdev_gendev))
1896 sdev = NULL;
1897
1898 return sdev;
1899}
1900EXPORT_SYMBOL_GPL(scsi_device_from_queue);
1901
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902/*
1903 * Function: scsi_block_requests()
1904 *
1905 * Purpose: Utility function used by low-level drivers to prevent further
1906 * commands from being queued to the device.
1907 *
1908 * Arguments: shost - Host in question
1909 *
1910 * Returns: Nothing
1911 *
1912 * Lock status: No locks are assumed held.
1913 *
1914 * Notes: There is no timer nor any other means by which the requests
1915 * get unblocked other than the low-level driver calling
1916 * scsi_unblock_requests().
1917 */
1918void scsi_block_requests(struct Scsi_Host *shost)
1919{
1920 shost->host_self_blocked = 1;
1921}
1922EXPORT_SYMBOL(scsi_block_requests);
1923
1924/*
1925 * Function: scsi_unblock_requests()
1926 *
1927 * Purpose: Utility function used by low-level drivers to allow further
1928 * commands from being queued to the device.
1929 *
1930 * Arguments: shost - Host in question
1931 *
1932 * Returns: Nothing
1933 *
1934 * Lock status: No locks are assumed held.
1935 *
1936 * Notes: There is no timer nor any other means by which the requests
1937 * get unblocked other than the low-level driver calling
1938 * scsi_unblock_requests().
1939 *
1940 * This is done as an API function so that changes to the
1941 * internals of the scsi mid-layer won't require wholesale
1942 * changes to drivers that use this feature.
1943 */
1944void scsi_unblock_requests(struct Scsi_Host *shost)
1945{
1946 shost->host_self_blocked = 0;
1947 scsi_run_host_queues(shost);
1948}
1949EXPORT_SYMBOL(scsi_unblock_requests);
1950
1951int __init scsi_init_queue(void)
1952{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001953 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1954 sizeof(struct scsi_data_buffer),
1955 0, 0, NULL);
1956 if (!scsi_sdb_cache) {
1957 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001958 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001959 }
1960
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 return 0;
1962}
1963
1964void scsi_exit_queue(void)
1965{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03001966 kmem_cache_destroy(scsi_sense_cache);
1967 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001968 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969}
James Bottomley5baba832006-03-18 14:10:35 -06001970
1971/**
1972 * scsi_mode_select - issue a mode select
1973 * @sdev: SCSI device to be queried
1974 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1975 * @sp: Save page bit (0 == don't save, 1 == save)
1976 * @modepage: mode page being requested
1977 * @buffer: request buffer (may not be smaller than eight bytes)
1978 * @len: length of request buffer.
1979 * @timeout: command timeout
1980 * @retries: number of retries before failing
1981 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001982 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001983 * must be SCSI_SENSE_BUFFERSIZE big.
1984 *
1985 * Returns zero if successful; negative error number or scsi
1986 * status on error
1987 *
1988 */
1989int
1990scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1991 unsigned char *buffer, int len, int timeout, int retries,
1992 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1993{
1994 unsigned char cmd[10];
1995 unsigned char *real_buffer;
1996 int ret;
1997
1998 memset(cmd, 0, sizeof(cmd));
1999 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2000
2001 if (sdev->use_10_for_ms) {
2002 if (len > 65535)
2003 return -EINVAL;
2004 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2005 if (!real_buffer)
2006 return -ENOMEM;
2007 memcpy(real_buffer + 8, buffer, len);
2008 len += 8;
2009 real_buffer[0] = 0;
2010 real_buffer[1] = 0;
2011 real_buffer[2] = data->medium_type;
2012 real_buffer[3] = data->device_specific;
2013 real_buffer[4] = data->longlba ? 0x01 : 0;
2014 real_buffer[5] = 0;
2015 real_buffer[6] = data->block_descriptor_length >> 8;
2016 real_buffer[7] = data->block_descriptor_length;
2017
2018 cmd[0] = MODE_SELECT_10;
2019 cmd[7] = len >> 8;
2020 cmd[8] = len;
2021 } else {
2022 if (len > 255 || data->block_descriptor_length > 255 ||
2023 data->longlba)
2024 return -EINVAL;
2025
2026 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2027 if (!real_buffer)
2028 return -ENOMEM;
2029 memcpy(real_buffer + 4, buffer, len);
2030 len += 4;
2031 real_buffer[0] = 0;
2032 real_buffer[1] = data->medium_type;
2033 real_buffer[2] = data->device_specific;
2034 real_buffer[3] = data->block_descriptor_length;
2035
2036
2037 cmd[0] = MODE_SELECT;
2038 cmd[4] = len;
2039 }
2040
2041 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002042 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002043 kfree(real_buffer);
2044 return ret;
2045}
2046EXPORT_SYMBOL_GPL(scsi_mode_select);
2047
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048/**
Rob Landleyeb448202007-11-03 13:30:39 -05002049 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002050 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 * @dbd: set if mode sense will allow block descriptors to be returned
2052 * @modepage: mode page being requested
2053 * @buffer: request buffer (may not be smaller than eight bytes)
2054 * @len: length of request buffer.
2055 * @timeout: command timeout
2056 * @retries: number of retries before failing
2057 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002058 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002059 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 *
2061 * Returns zero if unsuccessful, or the header offset (either 4
2062 * or 8 depending on whether a six or ten byte command was
2063 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002064 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065int
James Bottomley1cf72692005-08-28 11:27:01 -05002066scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002068 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2069{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 unsigned char cmd[12];
2071 int use_10_for_ms;
2072 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002073 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002074 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075
2076 memset(data, 0, sizeof(*data));
2077 memset(&cmd[0], 0, 12);
2078 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2079 cmd[2] = modepage;
2080
James Bottomleyea73a9f2005-08-28 11:33:52 -05002081 /* caller might not be interested in sense, but we need it */
2082 if (!sshdr)
2083 sshdr = &my_sshdr;
2084
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002086 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087
2088 if (use_10_for_ms) {
2089 if (len < 8)
2090 len = 8;
2091
2092 cmd[0] = MODE_SENSE_10;
2093 cmd[8] = len;
2094 header_length = 8;
2095 } else {
2096 if (len < 4)
2097 len = 4;
2098
2099 cmd[0] = MODE_SENSE;
2100 cmd[4] = len;
2101 header_length = 4;
2102 }
2103
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 memset(buffer, 0, len);
2105
James Bottomley1cf72692005-08-28 11:27:01 -05002106 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002107 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108
2109 /* This code looks awful: what it's doing is making sure an
2110 * ILLEGAL REQUEST sense return identifies the actual command
2111 * byte as the problem. MODE_SENSE commands can return
2112 * ILLEGAL REQUEST if the code page isn't supported */
2113
James Bottomley1cf72692005-08-28 11:27:01 -05002114 if (use_10_for_ms && !scsi_status_is_good(result) &&
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002115 driver_byte(result) == DRIVER_SENSE) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002116 if (scsi_sense_valid(sshdr)) {
2117 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2118 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 /*
2120 * Invalid command operation code
2121 */
James Bottomley1cf72692005-08-28 11:27:01 -05002122 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 goto retry;
2124 }
2125 }
2126 }
2127
James Bottomley1cf72692005-08-28 11:27:01 -05002128 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002129 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2130 (modepage == 6 || modepage == 8))) {
2131 /* Initio breakage? */
2132 header_length = 0;
2133 data->length = 13;
2134 data->medium_type = 0;
2135 data->device_specific = 0;
2136 data->longlba = 0;
2137 data->block_descriptor_length = 0;
2138 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 data->length = buffer[0]*256 + buffer[1] + 2;
2140 data->medium_type = buffer[2];
2141 data->device_specific = buffer[3];
2142 data->longlba = buffer[4] & 0x01;
2143 data->block_descriptor_length = buffer[6]*256
2144 + buffer[7];
2145 } else {
2146 data->length = buffer[0] + 1;
2147 data->medium_type = buffer[1];
2148 data->device_specific = buffer[2];
2149 data->block_descriptor_length = buffer[3];
2150 }
Al Viro6d73c852006-02-23 02:03:16 +01002151 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002152 } else if ((status_byte(result) == CHECK_CONDITION) &&
2153 scsi_sense_valid(sshdr) &&
2154 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2155 retry_count--;
2156 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 }
2158
James Bottomley1cf72692005-08-28 11:27:01 -05002159 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160}
2161EXPORT_SYMBOL(scsi_mode_sense);
2162
James Bottomley001aac22007-12-02 19:10:40 +02002163/**
2164 * scsi_test_unit_ready - test if unit is ready
2165 * @sdev: scsi device to change the state of.
2166 * @timeout: command timeout
2167 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002168 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002169 *
2170 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002171 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002172 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173int
James Bottomley001aac22007-12-02 19:10:40 +02002174scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002175 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 char cmd[] = {
2178 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2179 };
2180 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002181
James Bottomley001aac22007-12-02 19:10:40 +02002182 /* try to eat the UNIT_ATTENTION if there are enough retries */
2183 do {
2184 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
Bart Van Assche9b91fd32018-02-12 10:57:52 -08002185 timeout, 1, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002186 if (sdev->removable && scsi_sense_valid(sshdr) &&
2187 sshdr->sense_key == UNIT_ATTENTION)
2188 sdev->changed = 1;
2189 } while (scsi_sense_valid(sshdr) &&
2190 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002191
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 return result;
2193}
2194EXPORT_SYMBOL(scsi_test_unit_ready);
2195
2196/**
Rob Landleyeb448202007-11-03 13:30:39 -05002197 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 * @sdev: scsi device to change the state of.
2199 * @state: state to change to.
2200 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002201 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002203 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204int
2205scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2206{
2207 enum scsi_device_state oldstate = sdev->sdev_state;
2208
2209 if (state == oldstate)
2210 return 0;
2211
2212 switch (state) {
2213 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002214 switch (oldstate) {
2215 case SDEV_CREATED_BLOCK:
2216 break;
2217 default:
2218 goto illegal;
2219 }
2220 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221
2222 case SDEV_RUNNING:
2223 switch (oldstate) {
2224 case SDEV_CREATED:
2225 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002226 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 case SDEV_QUIESCE:
2228 case SDEV_BLOCK:
2229 break;
2230 default:
2231 goto illegal;
2232 }
2233 break;
2234
2235 case SDEV_QUIESCE:
2236 switch (oldstate) {
2237 case SDEV_RUNNING:
2238 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002239 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 break;
2241 default:
2242 goto illegal;
2243 }
2244 break;
2245
2246 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002247 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 switch (oldstate) {
2249 case SDEV_CREATED:
2250 case SDEV_RUNNING:
2251 case SDEV_QUIESCE:
2252 case SDEV_BLOCK:
2253 break;
2254 default:
2255 goto illegal;
2256 }
2257 break;
2258
2259 case SDEV_BLOCK:
2260 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002262 case SDEV_CREATED_BLOCK:
Hannes Reineckea33e5bf2018-10-07 10:35:35 +02002263 case SDEV_OFFLINE:
James Bottomley6f4267e2008-08-22 16:53:31 -05002264 break;
2265 default:
2266 goto illegal;
2267 }
2268 break;
2269
2270 case SDEV_CREATED_BLOCK:
2271 switch (oldstate) {
2272 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 break;
2274 default:
2275 goto illegal;
2276 }
2277 break;
2278
2279 case SDEV_CANCEL:
2280 switch (oldstate) {
2281 case SDEV_CREATED:
2282 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002283 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002285 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 break;
2287 default:
2288 goto illegal;
2289 }
2290 break;
2291
2292 case SDEV_DEL:
2293 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002294 case SDEV_CREATED:
2295 case SDEV_RUNNING:
2296 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002297 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002299 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002300 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 break;
2302 default:
2303 goto illegal;
2304 }
2305 break;
2306
2307 }
2308 sdev->sdev_state = state;
2309 return 0;
2310
2311 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002312 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002313 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002314 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002315 scsi_device_state_name(oldstate),
2316 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 );
2318 return -EINVAL;
2319}
2320EXPORT_SYMBOL(scsi_device_set_state);
2321
2322/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002323 * sdev_evt_emit - emit a single SCSI device uevent
2324 * @sdev: associated SCSI device
2325 * @evt: event to emit
2326 *
2327 * Send a single uevent (scsi_event) to the associated scsi_device.
2328 */
2329static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2330{
2331 int idx = 0;
2332 char *envp[3];
2333
2334 switch (evt->evt_type) {
2335 case SDEV_EVT_MEDIA_CHANGE:
2336 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2337 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002338 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002339 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002340 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2341 break;
2342 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2343 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2344 break;
2345 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2346 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2347 break;
2348 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2349 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2350 break;
2351 case SDEV_EVT_LUN_CHANGE_REPORTED:
2352 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2353 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002354 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2355 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2356 break;
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002357 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2358 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2359 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002360 default:
2361 /* do nothing */
2362 break;
2363 }
2364
2365 envp[idx++] = NULL;
2366
2367 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2368}
2369
2370/**
2371 * sdev_evt_thread - send a uevent for each scsi event
2372 * @work: work struct for scsi_device
2373 *
2374 * Dispatch queued events to their associated scsi_device kobjects
2375 * as uevents.
2376 */
2377void scsi_evt_thread(struct work_struct *work)
2378{
2379 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002380 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002381 LIST_HEAD(event_list);
2382
2383 sdev = container_of(work, struct scsi_device, event_work);
2384
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002385 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2386 if (test_and_clear_bit(evt_type, sdev->pending_events))
2387 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2388
Jeff Garzika341cd02007-10-29 17:15:22 -04002389 while (1) {
2390 struct scsi_event *evt;
2391 struct list_head *this, *tmp;
2392 unsigned long flags;
2393
2394 spin_lock_irqsave(&sdev->list_lock, flags);
2395 list_splice_init(&sdev->event_list, &event_list);
2396 spin_unlock_irqrestore(&sdev->list_lock, flags);
2397
2398 if (list_empty(&event_list))
2399 break;
2400
2401 list_for_each_safe(this, tmp, &event_list) {
2402 evt = list_entry(this, struct scsi_event, node);
2403 list_del(&evt->node);
2404 scsi_evt_emit(sdev, evt);
2405 kfree(evt);
2406 }
2407 }
2408}
2409
2410/**
2411 * sdev_evt_send - send asserted event to uevent thread
2412 * @sdev: scsi_device event occurred on
2413 * @evt: event to send
2414 *
2415 * Assert scsi device event asynchronously.
2416 */
2417void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2418{
2419 unsigned long flags;
2420
Kay Sievers4d1566e2008-03-19 13:04:47 +01002421#if 0
2422 /* FIXME: currently this check eliminates all media change events
2423 * for polled devices. Need to update to discriminate between AN
2424 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002425 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2426 kfree(evt);
2427 return;
2428 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002429#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002430
2431 spin_lock_irqsave(&sdev->list_lock, flags);
2432 list_add_tail(&evt->node, &sdev->event_list);
2433 schedule_work(&sdev->event_work);
2434 spin_unlock_irqrestore(&sdev->list_lock, flags);
2435}
2436EXPORT_SYMBOL_GPL(sdev_evt_send);
2437
2438/**
2439 * sdev_evt_alloc - allocate a new scsi event
2440 * @evt_type: type of event to allocate
2441 * @gfpflags: GFP flags for allocation
2442 *
2443 * Allocates and returns a new scsi_event.
2444 */
2445struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2446 gfp_t gfpflags)
2447{
2448 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2449 if (!evt)
2450 return NULL;
2451
2452 evt->evt_type = evt_type;
2453 INIT_LIST_HEAD(&evt->node);
2454
2455 /* evt_type-specific initialization, if any */
2456 switch (evt_type) {
2457 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002458 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2459 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2460 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2461 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2462 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002463 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002464 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002465 default:
2466 /* do nothing */
2467 break;
2468 }
2469
2470 return evt;
2471}
2472EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2473
2474/**
2475 * sdev_evt_send_simple - send asserted event to uevent thread
2476 * @sdev: scsi_device event occurred on
2477 * @evt_type: type of event to send
2478 * @gfpflags: GFP flags for allocation
2479 *
2480 * Assert scsi device event asynchronously, given an event type.
2481 */
2482void sdev_evt_send_simple(struct scsi_device *sdev,
2483 enum scsi_device_event evt_type, gfp_t gfpflags)
2484{
2485 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2486 if (!evt) {
2487 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2488 evt_type);
2489 return;
2490 }
2491
2492 sdev_evt_send(sdev, evt);
2493}
2494EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2495
2496/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497 * scsi_device_quiesce - Block user issued commands.
2498 * @sdev: scsi device to quiesce.
2499 *
2500 * This works by trying to transition to the SDEV_QUIESCE state
2501 * (which must be a legal transition). When the device is in this
2502 * state, only special requests will be accepted, all others will
2503 * be deferred. Since special requests may also be requeued requests,
2504 * a successful return doesn't guarantee the device will be
2505 * totally quiescent.
2506 *
2507 * Must be called with user context, may sleep.
2508 *
2509 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002510 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511int
2512scsi_device_quiesce(struct scsi_device *sdev)
2513{
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002514 struct request_queue *q = sdev->request_queue;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002515 int err;
2516
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002517 /*
2518 * It is allowed to call scsi_device_quiesce() multiple times from
2519 * the same context but concurrent scsi_device_quiesce() calls are
2520 * not allowed.
2521 */
2522 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2523
Bart Van Asschecd84a622018-09-26 14:01:04 -07002524 if (sdev->quiesced_by == current)
2525 return 0;
2526
2527 blk_set_pm_only(q);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002528
2529 blk_mq_freeze_queue(q);
2530 /*
Bart Van Asschecd84a622018-09-26 14:01:04 -07002531 * Ensure that the effect of blk_set_pm_only() will be visible
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002532 * for percpu_ref_tryget() callers that occur after the queue
2533 * unfreeze even if the queue was already frozen before this function
2534 * was called. See also https://lwn.net/Articles/573497/.
2535 */
2536 synchronize_rcu();
2537 blk_mq_unfreeze_queue(q);
2538
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002539 mutex_lock(&sdev->state_mutex);
2540 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002541 if (err == 0)
2542 sdev->quiesced_by = current;
2543 else
Bart Van Asschecd84a622018-09-26 14:01:04 -07002544 blk_clear_pm_only(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002545 mutex_unlock(&sdev->state_mutex);
2546
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002547 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548}
2549EXPORT_SYMBOL(scsi_device_quiesce);
2550
2551/**
2552 * scsi_device_resume - Restart user issued commands to a quiesced device.
2553 * @sdev: scsi device to resume.
2554 *
2555 * Moves the device from quiesced back to running and restarts the
2556 * queues.
2557 *
2558 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002559 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002560void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002562 /* check if the device state was mutated prior to resume, and if
2563 * so assume the state is being managed elsewhere (for example
2564 * device deleted during suspend)
2565 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002566 mutex_lock(&sdev->state_mutex);
Bart Van Assche17605af2019-03-15 16:27:58 -07002567 if (sdev->quiesced_by) {
2568 sdev->quiesced_by = NULL;
2569 blk_clear_pm_only(sdev->request_queue);
2570 }
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002571 if (sdev->sdev_state == SDEV_QUIESCE)
2572 scsi_device_set_state(sdev, SDEV_RUNNING);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002573 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574}
2575EXPORT_SYMBOL(scsi_device_resume);
2576
2577static void
2578device_quiesce_fn(struct scsi_device *sdev, void *data)
2579{
2580 scsi_device_quiesce(sdev);
2581}
2582
2583void
2584scsi_target_quiesce(struct scsi_target *starget)
2585{
2586 starget_for_each_device(starget, NULL, device_quiesce_fn);
2587}
2588EXPORT_SYMBOL(scsi_target_quiesce);
2589
2590static void
2591device_resume_fn(struct scsi_device *sdev, void *data)
2592{
2593 scsi_device_resume(sdev);
2594}
2595
2596void
2597scsi_target_resume(struct scsi_target *starget)
2598{
2599 starget_for_each_device(starget, NULL, device_resume_fn);
2600}
2601EXPORT_SYMBOL(scsi_target_resume);
2602
2603/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002604 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2605 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002607 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002609 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002611 * Notes:
2612 * This routine transitions the device to the SDEV_BLOCK state (which must be
2613 * a legal transition). When the device is in this state, command processing
2614 * is paused until the device leaves the SDEV_BLOCK state. See also
2615 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002616 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002617int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618{
Jens Axboe165125e2007-07-24 09:28:11 +02002619 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620 int err = 0;
2621
2622 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002623 if (err) {
2624 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2625
2626 if (err)
2627 return err;
2628 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629
2630 /*
2631 * The device has transitioned to SDEV_BLOCK. Stop the
2632 * block layer from calling the midlayer with this device's
2633 * request queue.
2634 */
Jens Axboef664a3c2018-11-01 16:36:27 -06002635 blk_mq_quiesce_queue_nowait(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636 return 0;
2637}
Bart Van Assche551eb592017-06-02 14:21:53 -07002638EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2639
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002641 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2642 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002644 * Pause SCSI command processing on the specified device and wait until all
2645 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002647 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002649 * Note:
2650 * This routine transitions the device to the SDEV_BLOCK state (which must be
2651 * a legal transition). When the device is in this state, command processing
2652 * is paused until the device leaves the SDEV_BLOCK state. See also
2653 * scsi_internal_device_unblock().
Rob Landleyeb448202007-11-03 13:30:39 -05002654 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002655static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656{
Bart Van Assche551eb592017-06-02 14:21:53 -07002657 struct request_queue *q = sdev->request_queue;
2658 int err;
2659
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002660 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07002661 err = scsi_internal_device_block_nowait(sdev);
Jens Axboef664a3c2018-11-01 16:36:27 -06002662 if (err == 0)
2663 blk_mq_quiesce_queue(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002664 mutex_unlock(&sdev->state_mutex);
2665
Bart Van Assche551eb592017-06-02 14:21:53 -07002666 return err;
2667}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002668
Bart Van Assche66483a42017-06-02 14:21:56 -07002669void scsi_start_queue(struct scsi_device *sdev)
2670{
2671 struct request_queue *q = sdev->request_queue;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002672
Jens Axboef664a3c2018-11-01 16:36:27 -06002673 blk_mq_unquiesce_queue(q);
Bart Van Assche66483a42017-06-02 14:21:56 -07002674}
2675
Linus Torvalds1da177e2005-04-16 15:20:36 -07002676/**
Bart Van Assche43f75712017-06-02 14:21:54 -07002677 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07002678 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07002679 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002680 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002681 * Restart the device queue for a previously suspended SCSI device. Does not
2682 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002684 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002686 * Notes:
2687 * This routine transitions the device to the SDEV_RUNNING state or to one of
2688 * the offline states (which must be a legal transition) allowing the midlayer
2689 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690 */
Bart Van Assche43f75712017-06-02 14:21:54 -07002691int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2692 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002694 /*
2695 * Try to transition the scsi device to SDEV_RUNNING or one of the
2696 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002698 switch (sdev->sdev_state) {
2699 case SDEV_BLOCK:
2700 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002701 sdev->sdev_state = new_state;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002702 break;
2703 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002704 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2705 new_state == SDEV_OFFLINE)
2706 sdev->sdev_state = new_state;
2707 else
2708 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002709 break;
2710 case SDEV_CANCEL:
2711 case SDEV_OFFLINE:
2712 break;
2713 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002714 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002715 }
Bart Van Assche66483a42017-06-02 14:21:56 -07002716 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717
2718 return 0;
2719}
Bart Van Assche43f75712017-06-02 14:21:54 -07002720EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2721
2722/**
2723 * scsi_internal_device_unblock - resume a device after a block request
2724 * @sdev: device to resume
2725 * @new_state: state to set the device to after unblocking
2726 *
2727 * Restart the device queue for a previously suspended SCSI device. May sleep.
2728 *
2729 * Returns zero if successful or a negative error code upon failure.
2730 *
2731 * Notes:
2732 * This routine transitions the device to the SDEV_RUNNING state or to one of
2733 * the offline states (which must be a legal transition) allowing the midlayer
2734 * to goose the queue for this device.
2735 */
2736static int scsi_internal_device_unblock(struct scsi_device *sdev,
2737 enum scsi_device_state new_state)
2738{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002739 int ret;
2740
2741 mutex_lock(&sdev->state_mutex);
2742 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2743 mutex_unlock(&sdev->state_mutex);
2744
2745 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07002746}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747
2748static void
2749device_block(struct scsi_device *sdev, void *data)
2750{
Bart Van Assche551eb592017-06-02 14:21:53 -07002751 scsi_internal_device_block(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002752}
2753
2754static int
2755target_block(struct device *dev, void *data)
2756{
2757 if (scsi_is_target_device(dev))
2758 starget_for_each_device(to_scsi_target(dev), NULL,
2759 device_block);
2760 return 0;
2761}
2762
2763void
2764scsi_target_block(struct device *dev)
2765{
2766 if (scsi_is_target_device(dev))
2767 starget_for_each_device(to_scsi_target(dev), NULL,
2768 device_block);
2769 else
2770 device_for_each_child(dev, NULL, target_block);
2771}
2772EXPORT_SYMBOL_GPL(scsi_target_block);
2773
2774static void
2775device_unblock(struct scsi_device *sdev, void *data)
2776{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002777 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778}
2779
2780static int
2781target_unblock(struct device *dev, void *data)
2782{
2783 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002784 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785 device_unblock);
2786 return 0;
2787}
2788
2789void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002790scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002791{
2792 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002793 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794 device_unblock);
2795 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002796 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797}
2798EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002799
2800/**
2801 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002802 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002803 * @sg_count: number of segments in sg
2804 * @offset: offset in bytes into sg, on return offset into the mapped area
2805 * @len: bytes to map, on return number of bytes mapped
2806 *
2807 * Returns virtual address of the start of the mapped page
2808 */
Jens Axboec6132da2007-10-16 11:08:49 +02002809void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002810 size_t *offset, size_t *len)
2811{
2812 int i;
2813 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002814 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002815 struct page *page;
2816
Andrew Morton22cfefb2007-02-05 16:39:03 -08002817 WARN_ON(!irqs_disabled());
2818
Jens Axboec6132da2007-10-16 11:08:49 +02002819 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002820 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002821 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002822 if (sg_len > *offset)
2823 break;
2824 }
2825
2826 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002827 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2828 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002829 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002830 WARN_ON(1);
2831 return NULL;
2832 }
2833
2834 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002835 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002836
2837 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002838 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002839 *offset &= ~PAGE_MASK;
2840
2841 /* Bytes in this sg-entry from *offset to the end of the page */
2842 sg_len = PAGE_SIZE - *offset;
2843 if (*len > sg_len)
2844 *len = sg_len;
2845
Cong Wang77dfce02011-11-25 23:14:23 +08002846 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002847}
2848EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2849
2850/**
Rob Landleyeb448202007-11-03 13:30:39 -05002851 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002852 * @virt: virtual address to be unmapped
2853 */
2854void scsi_kunmap_atomic_sg(void *virt)
2855{
Cong Wang77dfce02011-11-25 23:14:23 +08002856 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002857}
2858EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002859
2860void sdev_disable_disk_events(struct scsi_device *sdev)
2861{
2862 atomic_inc(&sdev->disk_events_disable_depth);
2863}
2864EXPORT_SYMBOL(sdev_disable_disk_events);
2865
2866void sdev_enable_disk_events(struct scsi_device *sdev)
2867{
2868 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2869 return;
2870 atomic_dec(&sdev->disk_events_disable_depth);
2871}
2872EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002873
2874/**
2875 * scsi_vpd_lun_id - return a unique device identification
2876 * @sdev: SCSI device
2877 * @id: buffer for the identification
2878 * @id_len: length of the buffer
2879 *
2880 * Copies a unique device identification into @id based
2881 * on the information in the VPD page 0x83 of the device.
2882 * The string will be formatted as a SCSI name string.
2883 *
2884 * Returns the length of the identification or error on failure.
2885 * If the identifier is longer than the supplied buffer the actual
2886 * identifier length is returned and the buffer is not zero-padded.
2887 */
2888int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
2889{
2890 u8 cur_id_type = 0xff;
2891 u8 cur_id_size = 0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002892 const unsigned char *d, *cur_id_str;
2893 const struct scsi_vpd *vpd_pg83;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002894 int id_size = -EINVAL;
2895
2896 rcu_read_lock();
2897 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
2898 if (!vpd_pg83) {
2899 rcu_read_unlock();
2900 return -ENXIO;
2901 }
2902
2903 /*
2904 * Look for the correct descriptor.
2905 * Order of preference for lun descriptor:
2906 * - SCSI name string
2907 * - NAA IEEE Registered Extended
2908 * - EUI-64 based 16-byte
2909 * - EUI-64 based 12-byte
2910 * - NAA IEEE Registered
2911 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02002912 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002913 * as longer descriptors reduce the likelyhood
2914 * of identification clashes.
2915 */
2916
2917 /* The id string must be at least 20 bytes + terminating NULL byte */
2918 if (id_len < 21) {
2919 rcu_read_unlock();
2920 return -EINVAL;
2921 }
2922
2923 memset(id, 0, id_len);
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002924 d = vpd_pg83->data + 4;
2925 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002926 /* Skip designators not referring to the LUN */
2927 if ((d[1] & 0x30) != 0x00)
2928 goto next_desig;
2929
2930 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02002931 case 0x1:
2932 /* T10 Vendor ID */
2933 if (cur_id_size > d[3])
2934 break;
2935 /* Prefer anything */
2936 if (cur_id_type > 0x01 && cur_id_type != 0xff)
2937 break;
2938 cur_id_size = d[3];
2939 if (cur_id_size + 4 > id_len)
2940 cur_id_size = id_len - 4;
2941 cur_id_str = d + 4;
2942 cur_id_type = d[1] & 0xf;
2943 id_size = snprintf(id, id_len, "t10.%*pE",
2944 cur_id_size, cur_id_str);
2945 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002946 case 0x2:
2947 /* EUI-64 */
2948 if (cur_id_size > d[3])
2949 break;
2950 /* Prefer NAA IEEE Registered Extended */
2951 if (cur_id_type == 0x3 &&
2952 cur_id_size == d[3])
2953 break;
2954 cur_id_size = d[3];
2955 cur_id_str = d + 4;
2956 cur_id_type = d[1] & 0xf;
2957 switch (cur_id_size) {
2958 case 8:
2959 id_size = snprintf(id, id_len,
2960 "eui.%8phN",
2961 cur_id_str);
2962 break;
2963 case 12:
2964 id_size = snprintf(id, id_len,
2965 "eui.%12phN",
2966 cur_id_str);
2967 break;
2968 case 16:
2969 id_size = snprintf(id, id_len,
2970 "eui.%16phN",
2971 cur_id_str);
2972 break;
2973 default:
2974 cur_id_size = 0;
2975 break;
2976 }
2977 break;
2978 case 0x3:
2979 /* NAA */
2980 if (cur_id_size > d[3])
2981 break;
2982 cur_id_size = d[3];
2983 cur_id_str = d + 4;
2984 cur_id_type = d[1] & 0xf;
2985 switch (cur_id_size) {
2986 case 8:
2987 id_size = snprintf(id, id_len,
2988 "naa.%8phN",
2989 cur_id_str);
2990 break;
2991 case 16:
2992 id_size = snprintf(id, id_len,
2993 "naa.%16phN",
2994 cur_id_str);
2995 break;
2996 default:
2997 cur_id_size = 0;
2998 break;
2999 }
3000 break;
3001 case 0x8:
3002 /* SCSI name string */
3003 if (cur_id_size + 4 > d[3])
3004 break;
3005 /* Prefer others for truncated descriptor */
3006 if (cur_id_size && d[3] > id_len)
3007 break;
3008 cur_id_size = id_size = d[3];
3009 cur_id_str = d + 4;
3010 cur_id_type = d[1] & 0xf;
3011 if (cur_id_size >= id_len)
3012 cur_id_size = id_len - 1;
3013 memcpy(id, cur_id_str, cur_id_size);
3014 /* Decrease priority for truncated descriptor */
3015 if (cur_id_size != id_size)
3016 cur_id_size = 6;
3017 break;
3018 default:
3019 break;
3020 }
3021next_desig:
3022 d += d[3] + 4;
3023 }
3024 rcu_read_unlock();
3025
3026 return id_size;
3027}
3028EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003029
3030/*
3031 * scsi_vpd_tpg_id - return a target port group identifier
3032 * @sdev: SCSI device
3033 *
3034 * Returns the Target Port Group identifier from the information
3035 * froom VPD page 0x83 of the device.
3036 *
3037 * Returns the identifier or error on failure.
3038 */
3039int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3040{
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003041 const unsigned char *d;
3042 const struct scsi_vpd *vpd_pg83;
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003043 int group_id = -EAGAIN, rel_port = -1;
3044
3045 rcu_read_lock();
3046 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3047 if (!vpd_pg83) {
3048 rcu_read_unlock();
3049 return -ENXIO;
3050 }
3051
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003052 d = vpd_pg83->data + 4;
3053 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003054 switch (d[1] & 0xf) {
3055 case 0x4:
3056 /* Relative target port */
3057 rel_port = get_unaligned_be16(&d[6]);
3058 break;
3059 case 0x5:
3060 /* Target port group */
3061 group_id = get_unaligned_be16(&d[6]);
3062 break;
3063 default:
3064 break;
3065 }
3066 d += d[3] + 4;
3067 }
3068 rcu_read_unlock();
3069
3070 if (group_id >= 0 && rel_id && rel_port != -1)
3071 *rel_id = rel_port;
3072
3073 return group_id;
3074}
3075EXPORT_SYMBOL(scsi_vpd_tpg_id);