blob: 7a4ac7a8e907fb2340fdc046e041c38a57df7c01 [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
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001092/* Add a command to the list used by the aacraid and dpt_i2o drivers */
1093void scsi_add_cmd_to_list(struct scsi_cmnd *cmd)
1094{
1095 struct scsi_device *sdev = cmd->device;
1096 struct Scsi_Host *shost = sdev->host;
1097 unsigned long flags;
1098
1099 if (shost->use_cmd_list) {
1100 spin_lock_irqsave(&sdev->list_lock, flags);
1101 list_add_tail(&cmd->list, &sdev->cmd_list);
1102 spin_unlock_irqrestore(&sdev->list_lock, flags);
1103 }
1104}
1105
1106/* Remove a command from the list used by the aacraid and dpt_i2o drivers */
1107void scsi_del_cmd_from_list(struct scsi_cmnd *cmd)
1108{
1109 struct scsi_device *sdev = cmd->device;
1110 struct Scsi_Host *shost = sdev->host;
1111 unsigned long flags;
1112
1113 if (shost->use_cmd_list) {
1114 spin_lock_irqsave(&sdev->list_lock, flags);
1115 BUG_ON(list_empty(&cmd->list));
1116 list_del_init(&cmd->list);
1117 spin_unlock_irqrestore(&sdev->list_lock, flags);
1118 }
1119}
1120
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001121/* Called after a request has been started. */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001122void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001123{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001124 void *buf = cmd->sense_buffer;
1125 void *prot = cmd->prot_sdb;
Bart Van Assche64104f72017-08-30 16:58:39 -07001126 struct request *rq = blk_mq_rq_from_pdu(cmd);
1127 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
Bart Van Assche832889f2017-08-30 16:58:40 -07001128 unsigned long jiffies_at_alloc;
1129 int retries;
Bart Van Assche64104f72017-08-30 16:58:39 -07001130
1131 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1132 flags |= SCMD_INITIALIZED;
1133 scsi_initialize_rq(rq);
1134 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001135
Bart Van Assche832889f2017-08-30 16:58:40 -07001136 jiffies_at_alloc = cmd->jiffies_at_alloc;
1137 retries = cmd->retries;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001138 /* zero out the cmd, except for the embedded scsi_request */
1139 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001140 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001141
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001142 cmd->device = dev;
1143 cmd->sense_buffer = buf;
1144 cmd->prot_sdb = prot;
Bart Van Assche64104f72017-08-30 16:58:39 -07001145 cmd->flags = flags;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001146 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
Bart Van Assche832889f2017-08-30 16:58:40 -07001147 cmd->jiffies_at_alloc = jiffies_at_alloc;
1148 cmd->retries = retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001149
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001150 scsi_add_cmd_to_list(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001151}
1152
Christoph Hellwig785ba832018-11-09 14:42:37 +01001153static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1154 struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001155{
Bart Van Asschebed22132017-08-25 13:46:32 -07001156 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001157
1158 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001159 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001160 * a bio attached to them. Or they might contain a SCSI command
1161 * that does not transfer data, in which case they may optionally
1162 * submit a request without an attached bio.
1163 */
1164 if (req->bio) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001165 blk_status_t ret = scsi_init_io(cmd);
1166 if (unlikely(ret != BLK_STS_OK))
1167 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001168 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001169 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001170
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001171 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001172 }
James Bottomley7b163182005-12-15 20:17:02 -06001173
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001174 cmd->cmd_len = scsi_req(req)->cmd_len;
1175 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001176 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001177 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig785ba832018-11-09 14:42:37 +01001178 return BLK_STS_OK;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001179}
1180
1181/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001182 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001183 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001184 */
Christoph Hellwig785ba832018-11-09 14:42:37 +01001185static blk_status_t scsi_setup_fs_cmnd(struct scsi_device *sdev,
1186 struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001187{
Bart Van Asschebed22132017-08-25 13:46:32 -07001188 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001189
Christoph Hellwigee14c672015-08-27 14:16:59 +02001190 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
Christoph Hellwig4c1cb672018-11-09 14:42:40 +01001191 blk_status_t ret = sdev->handler->prep_fn(sdev, req);
1192 if (ret != BLK_STS_OK)
1193 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001194 }
1195
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001196 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001197 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001198 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001199}
James Bottomley7b163182005-12-15 20:17:02 -06001200
Christoph Hellwig785ba832018-11-09 14:42:37 +01001201static blk_status_t scsi_setup_cmnd(struct scsi_device *sdev,
1202 struct request *req)
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001203{
Bart Van Asschebed22132017-08-25 13:46:32 -07001204 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001205
1206 if (!blk_rq_bytes(req))
1207 cmd->sc_data_direction = DMA_NONE;
1208 else if (rq_data_dir(req) == WRITE)
1209 cmd->sc_data_direction = DMA_TO_DEVICE;
1210 else
1211 cmd->sc_data_direction = DMA_FROM_DEVICE;
1212
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001213 if (blk_rq_is_scsi(req))
1214 return scsi_setup_scsi_cmnd(sdev, req);
1215 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001216 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001217}
1218
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001219static blk_status_t
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001220scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221{
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001222 switch (sdev->sdev_state) {
1223 case SDEV_OFFLINE:
1224 case SDEV_TRANSPORT_OFFLINE:
1225 /*
1226 * If the device is offline we refuse to process any
1227 * commands. The device must be brought online
1228 * before trying any recovery commands.
1229 */
1230 sdev_printk(KERN_ERR, sdev,
1231 "rejecting I/O to offline device\n");
1232 return BLK_STS_IOERR;
1233 case SDEV_DEL:
1234 /*
1235 * If the device is fully deleted, we refuse to
1236 * process any commands as well.
1237 */
1238 sdev_printk(KERN_ERR, sdev,
1239 "rejecting I/O to dead device\n");
1240 return BLK_STS_IOERR;
1241 case SDEV_BLOCK:
1242 case SDEV_CREATED_BLOCK:
1243 return BLK_STS_RESOURCE;
1244 case SDEV_QUIESCE:
1245 /*
1246 * If the devices is blocked we defer normal commands.
1247 */
1248 if (req && !(req->rq_flags & RQF_PREEMPT))
1249 return BLK_STS_RESOURCE;
1250 return BLK_STS_OK;
1251 default:
1252 /*
1253 * For any other not fully online state we only allow
1254 * special commands. In particular any user initiated
1255 * command is not allowed.
1256 */
1257 if (req && !(req->rq_flags & RQF_PREEMPT))
1258 return BLK_STS_IOERR;
1259 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001261}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263/*
1264 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1265 * return 0.
1266 *
1267 * Called with the queue_lock held.
1268 */
1269static inline int scsi_dev_queue_ready(struct request_queue *q,
1270 struct scsi_device *sdev)
1271{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001272 unsigned int busy;
1273
1274 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001275 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001276 if (busy)
1277 goto out_dec;
1278
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 /*
1280 * unblock after device_blocked iterates to zero
1281 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001282 if (atomic_dec_return(&sdev->device_blocked) > 0)
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001283 goto out_dec;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001284 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1285 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001287
1288 if (busy >= sdev->queue_depth)
1289 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290
1291 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001292out_dec:
1293 atomic_dec(&sdev->device_busy);
1294 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295}
1296
Mike Christief0c0a372008-08-17 15:24:38 -05001297/*
1298 * scsi_target_queue_ready: checks if there we can send commands to target
1299 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001300 */
1301static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1302 struct scsi_device *sdev)
1303{
1304 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001305 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001306
1307 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001308 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001309 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001310 starget->starget_sdev_user != sdev) {
1311 spin_unlock_irq(shost->host_lock);
1312 return 0;
1313 }
Mike Christief0c0a372008-08-17 15:24:38 -05001314 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001315 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001316 }
1317
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001318 if (starget->can_queue <= 0)
1319 return 1;
1320
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001321 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001322 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001323 if (busy)
1324 goto starved;
1325
Mike Christief0c0a372008-08-17 15:24:38 -05001326 /*
1327 * unblock after target_blocked iterates to zero
1328 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001329 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001330 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001331
1332 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1333 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001334 }
1335
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001336 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001337 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001338
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001339 return 1;
1340
1341starved:
1342 spin_lock_irq(shost->host_lock);
1343 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001344 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001345out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001346 if (starget->can_queue > 0)
1347 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001348 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001349}
1350
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351/*
1352 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1353 * return 0. We must end up running the queue again whenever 0 is
1354 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 */
1356static inline int scsi_host_queue_ready(struct request_queue *q,
1357 struct Scsi_Host *shost,
1358 struct scsi_device *sdev)
1359{
Christoph Hellwig74665012014-01-22 15:29:29 +01001360 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001361
James Bottomley939647e2005-09-18 15:05:20 -05001362 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001363 return 0;
1364
Ming Leid772a652018-08-27 15:24:43 +08001365 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001366 if (atomic_read(&shost->host_blocked) > 0) {
Ming Leid772a652018-08-27 15:24:43 +08001367 if (busy)
Christoph Hellwig74665012014-01-22 15:29:29 +01001368 goto starved;
1369
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 /*
1371 * unblock after host_blocked iterates to zero
1372 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001373 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001374 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001375
1376 SCSI_LOG_MLQUEUE(3,
1377 shost_printk(KERN_INFO, shost,
1378 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001380
Ming Leid772a652018-08-27 15:24:43 +08001381 if (shost->can_queue > 0 && busy >= shost->can_queue)
Christoph Hellwig74665012014-01-22 15:29:29 +01001382 goto starved;
1383 if (shost->host_self_blocked)
1384 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
1386 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001387 if (!list_empty(&sdev->starved_entry)) {
1388 spin_lock_irq(shost->host_lock);
1389 if (!list_empty(&sdev->starved_entry))
1390 list_del_init(&sdev->starved_entry);
1391 spin_unlock_irq(shost->host_lock);
1392 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
Christoph Hellwig74665012014-01-22 15:29:29 +01001394 return 1;
1395
1396starved:
1397 spin_lock_irq(shost->host_lock);
1398 if (list_empty(&sdev->starved_entry))
1399 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001400 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001401out_dec:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001402 scsi_dec_host_busy(shost);
Christoph Hellwig74665012014-01-22 15:29:29 +01001403 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404}
1405
1406/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001407 * Busy state exporting function for request stacking drivers.
1408 *
1409 * For efficiency, no lock is taken to check the busy state of
1410 * shost/starget/sdev, since the returned value is not guaranteed and
1411 * may be changed after request stacking drivers call the function,
1412 * regardless of taking lock or not.
1413 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001414 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1415 * needs to return 'not busy'. Otherwise, request stacking drivers
1416 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001417 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001418static bool scsi_mq_lld_busy(struct request_queue *q)
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001419{
1420 struct scsi_device *sdev = q->queuedata;
1421 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001422
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001423 if (blk_queue_dying(q))
Jens Axboef664a3c2018-11-01 16:36:27 -06001424 return false;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001425
1426 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001427
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001428 /*
1429 * Ignore host/starget busy state.
1430 * Since block layer does not have a concept of fairness across
1431 * multiple queues, congestion of host/starget needs to be handled
1432 * in SCSI layer.
1433 */
1434 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Jens Axboef664a3c2018-11-01 16:36:27 -06001435 return true;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001436
Jens Axboef664a3c2018-11-01 16:36:27 -06001437 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438}
1439
Jens Axboe1aea6432006-01-09 16:03:03 +01001440static void scsi_softirq_done(struct request *rq)
1441{
Bart Van Asschebed22132017-08-25 13:46:32 -07001442 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001443 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001444 int disposition;
1445
1446 INIT_LIST_HEAD(&cmd->eh_entry);
1447
Jens Axboe242f9dc2008-09-14 05:55:09 -07001448 atomic_inc(&cmd->device->iodone_cnt);
1449 if (cmd->result)
1450 atomic_inc(&cmd->device->ioerr_cnt);
1451
Jens Axboe1aea6432006-01-09 16:03:03 +01001452 disposition = scsi_decide_disposition(cmd);
1453 if (disposition != SUCCESS &&
1454 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
Maurizio Lombardi463cdad82019-07-02 13:27:05 +02001455 scmd_printk(KERN_ERR, cmd,
Jens Axboe1aea6432006-01-09 16:03:03 +01001456 "timing out command, waited %lus\n",
1457 wait_for/HZ);
1458 disposition = SUCCESS;
1459 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001460
Jens Axboe1aea6432006-01-09 16:03:03 +01001461 scsi_log_completion(cmd, disposition);
1462
1463 switch (disposition) {
1464 case SUCCESS:
1465 scsi_finish_command(cmd);
1466 break;
1467 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001468 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001469 break;
1470 case ADD_TO_MLQUEUE:
1471 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1472 break;
1473 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001474 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001475 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001476 }
1477}
1478
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001479/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001480 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1481 * @cmd: command block we are dispatching.
1482 *
1483 * Return: nonzero return request was rejected and device's queue needs to be
1484 * plugged.
1485 */
1486static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1487{
1488 struct Scsi_Host *host = cmd->device->host;
1489 int rtn = 0;
1490
1491 atomic_inc(&cmd->device->iorequest_cnt);
1492
1493 /* check if the device is still usable */
1494 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1495 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1496 * returns an immediate error upwards, and signals
1497 * that the device is no longer present */
1498 cmd->result = DID_NO_CONNECT << 16;
1499 goto done;
1500 }
1501
1502 /* Check to see if the scsi lld made this device blocked. */
1503 if (unlikely(scsi_device_blocked(cmd->device))) {
1504 /*
1505 * in blocked state, the command is just put back on
1506 * the device queue. The suspend state has already
1507 * blocked the queue so future requests should not
1508 * occur until the device transitions out of the
1509 * suspend state.
1510 */
1511 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1512 "queuecommand : device blocked\n"));
1513 return SCSI_MLQUEUE_DEVICE_BUSY;
1514 }
1515
1516 /* Store the LUN value in cmnd, if needed. */
1517 if (cmd->device->lun_in_cdb)
1518 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1519 (cmd->device->lun << 5 & 0xe0);
1520
1521 scsi_log_send(cmd);
1522
1523 /*
1524 * Before we queue this command, check if the command
1525 * length exceeds what the host adapter can handle.
1526 */
1527 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1528 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1529 "queuecommand : command too long. "
1530 "cdb_size=%d host->max_cmd_len=%d\n",
1531 cmd->cmd_len, cmd->device->host->max_cmd_len));
1532 cmd->result = (DID_ABORT << 16);
1533 goto done;
1534 }
1535
1536 if (unlikely(host->shost_state == SHOST_DEL)) {
1537 cmd->result = (DID_NO_CONNECT << 16);
1538 goto done;
1539
1540 }
1541
1542 trace_scsi_dispatch_cmd_start(cmd);
1543 rtn = host->hostt->queuecommand(host, cmd);
1544 if (rtn) {
1545 trace_scsi_dispatch_cmd_error(cmd, rtn);
1546 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1547 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1548 rtn = SCSI_MLQUEUE_HOST_BUSY;
1549
1550 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1551 "queuecommand : request rejected\n"));
1552 }
1553
1554 return rtn;
1555 done:
1556 cmd->scsi_done(cmd);
1557 return 0;
1558}
1559
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001560/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
Ming Lei3dccdf52019-04-28 15:39:32 +08001561static unsigned int scsi_mq_inline_sgl_size(struct Scsi_Host *shost)
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001562{
Ming Lei3dccdf52019-04-28 15:39:32 +08001563 return min_t(unsigned int, shost->sg_tablesize, SCSI_INLINE_SG_CNT) *
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001564 sizeof(struct scatterlist);
1565}
1566
Christoph Hellwig785ba832018-11-09 14:42:37 +01001567static blk_status_t scsi_mq_prep_fn(struct request *req)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001568{
1569 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1570 struct scsi_device *sdev = req->q->queuedata;
1571 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001572 struct scatterlist *sg;
1573
Bart Van Assche08f78432017-06-02 14:22:00 -07001574 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001575
Christoph Hellwigd2852032014-01-17 12:06:53 +01001576 cmd->request = req;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001577 cmd->tag = req->tag;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001578 cmd->prot_op = SCSI_PROT_NORMAL;
1579
Christoph Hellwigd2852032014-01-17 12:06:53 +01001580 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1581 cmd->sdb.table.sgl = sg;
1582
1583 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001584 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1585
1586 cmd->prot_sdb->table.sgl =
1587 (struct scatterlist *)(cmd->prot_sdb + 1);
1588 }
1589
Christoph Hellwigfe052522014-09-22 15:59:31 +02001590 blk_mq_start_request(req);
1591
Bart Van Assche8fe8ffb2017-10-20 11:46:45 -07001592 return scsi_setup_cmnd(sdev, req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001593}
1594
1595static void scsi_mq_done(struct scsi_cmnd *cmd)
1596{
Keith Buschf1342702018-11-26 09:54:29 -07001597 if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state)))
1598 return;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001599 trace_scsi_dispatch_cmd_done(cmd);
Keith Buschf1342702018-11-26 09:54:29 -07001600
1601 /*
1602 * If the block layer didn't complete the request due to a timeout
1603 * injection, scsi must clear its internal completed state so that the
1604 * timeout handler will see it needs to escalate its own error
1605 * recovery.
1606 */
1607 if (unlikely(!blk_mq_complete_request(cmd->request)))
1608 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001609}
1610
Ming Lei0df21c82017-10-14 17:22:32 +08001611static void scsi_mq_put_budget(struct blk_mq_hw_ctx *hctx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001612{
Ming Lei0df21c82017-10-14 17:22:32 +08001613 struct request_queue *q = hctx->queue;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001614 struct scsi_device *sdev = q->queuedata;
Ming Lei0df21c82017-10-14 17:22:32 +08001615
Ming Lei0df21c82017-10-14 17:22:32 +08001616 atomic_dec(&sdev->device_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001617}
1618
Ming Lei88022d72017-11-05 02:21:12 +08001619static bool scsi_mq_get_budget(struct blk_mq_hw_ctx *hctx)
Ming Lei0df21c82017-10-14 17:22:32 +08001620{
1621 struct request_queue *q = hctx->queue;
1622 struct scsi_device *sdev = q->queuedata;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001623
Ming Lei18c4f0a2019-04-12 11:30:32 +08001624 if (scsi_dev_queue_ready(q, sdev))
1625 return true;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001626
Ming Lei7e70aa72017-12-05 15:52:56 +08001627 if (atomic_read(&sdev->device_busy) == 0 && !scsi_device_blocked(sdev))
1628 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Ming Lei88022d72017-11-05 02:21:12 +08001629 return false;
Ming Lei0df21c82017-10-14 17:22:32 +08001630}
1631
Christoph Hellwigd2852032014-01-17 12:06:53 +01001632static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1633 const struct blk_mq_queue_data *bd)
1634{
1635 struct request *req = bd->rq;
1636 struct request_queue *q = req->q;
1637 struct scsi_device *sdev = q->queuedata;
1638 struct Scsi_Host *shost = sdev->host;
1639 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1640 blk_status_t ret;
1641 int reason;
1642
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001643 /*
1644 * If the device is not in running state we will reject some or all
1645 * commands.
1646 */
1647 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1648 ret = scsi_prep_state_check(sdev, req);
1649 if (ret != BLK_STS_OK)
1650 goto out_put_budget;
1651 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001652
1653 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001654 if (!scsi_target_queue_ready(shost, sdev))
Ming Lei826a70a2017-11-04 09:55:34 +08001655 goto out_put_budget;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001656 if (!scsi_host_queue_ready(q, shost, sdev))
1657 goto out_dec_target_busy;
1658
Christoph Hellwige8064022016-10-20 15:12:13 +02001659 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwig785ba832018-11-09 14:42:37 +01001660 ret = scsi_mq_prep_fn(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001661 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001662 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001663 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001664 } else {
Bart Van Asschecd464d82019-01-15 16:50:03 -08001665 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigfe052522014-09-22 15:59:31 +02001666 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001667 }
1668
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001669 cmd->flags &= SCMD_PRESERVED_FLAGS;
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001670 if (sdev->simple_tags)
1671 cmd->flags |= SCMD_TAGGED;
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001672 if (bd->last)
1673 cmd->flags |= SCMD_LAST;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001674
Christoph Hellwigd2852032014-01-17 12:06:53 +01001675 scsi_init_cmd_errh(cmd);
1676 cmd->scsi_done = scsi_mq_done;
1677
1678 reason = scsi_dispatch_cmd(cmd);
1679 if (reason) {
1680 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001681 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001682 goto out_dec_host_busy;
1683 }
1684
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001685 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001686
1687out_dec_host_busy:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001688 scsi_dec_host_busy(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001689out_dec_target_busy:
1690 if (scsi_target(sdev)->can_queue > 0)
1691 atomic_dec(&scsi_target(sdev)->target_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001692out_put_budget:
1693 scsi_mq_put_budget(hctx);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001694 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001695 case BLK_STS_OK:
1696 break;
1697 case BLK_STS_RESOURCE:
Ming Lei86ff7c22018-01-30 22:04:57 -05001698 if (atomic_read(&sdev->device_busy) ||
1699 scsi_device_blocked(sdev))
1700 ret = BLK_STS_DEV_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001701 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001702 default:
Jaesoo Leebe549d42019-04-09 17:02:22 -07001703 if (unlikely(!scsi_device_online(sdev)))
1704 scsi_req(req)->result = DID_NO_CONNECT << 16;
1705 else
1706 scsi_req(req)->result = DID_ERROR << 16;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001707 /*
Jaesoo Leebe549d42019-04-09 17:02:22 -07001708 * Make sure to release all allocated resources when
Christoph Hellwigd2852032014-01-17 12:06:53 +01001709 * we hit an error, as we will never see this command
1710 * again.
1711 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001712 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001713 scsi_mq_uninit_cmd(cmd);
1714 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001715 }
1716 return ret;
1717}
1718
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001719static enum blk_eh_timer_return scsi_timeout(struct request *req,
1720 bool reserved)
1721{
1722 if (reserved)
1723 return BLK_EH_RESET_TIMER;
1724 return scsi_times_out(req);
1725}
1726
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001727static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1728 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001729{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001730 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07001731 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001732 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07001733 struct scatterlist *sg;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001734
Bart Van Assche8e688252017-06-02 14:21:52 -07001735 if (unchecked_isa_dma)
1736 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
1737 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
1738 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001739 if (!cmd->sense_buffer)
1740 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001741 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07001742
1743 if (scsi_host_get_prot(shost)) {
1744 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1745 shost->hostt->cmd_size;
Ming Lei3dccdf52019-04-28 15:39:32 +08001746 cmd->prot_sdb = (void *)sg + scsi_mq_inline_sgl_size(shost);
Bart Van Assche08f78432017-06-02 14:22:00 -07001747 }
1748
Christoph Hellwigd2852032014-01-17 12:06:53 +01001749 return 0;
1750}
1751
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001752static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
1753 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001754{
1755 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1756
Bart Van Assche8e688252017-06-02 14:21:52 -07001757 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
1758 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001759}
1760
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001761static int scsi_map_queues(struct blk_mq_tag_set *set)
1762{
1763 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1764
1765 if (shost->hostt->map_queues)
1766 return shost->hostt->map_queues(shost);
Dongli Zhang99bbf482019-03-12 09:00:28 +08001767 return blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001768}
1769
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001770void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771{
Lin Ming6f381fa2012-04-12 13:50:38 +08001772 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
Jens Axboea8474ce2007-08-07 09:02:51 +02001774 /*
1775 * this limit is imposed by hardware restrictions
1776 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001777 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07001778 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001779
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001780 if (scsi_host_prot_dma(shost)) {
1781 shost->sg_prot_tablesize =
1782 min_not_zero(shost->sg_prot_tablesize,
1783 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1784 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1785 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1786 }
1787
Christoph Hellwigbdd17bd2019-06-17 14:19:54 +02001788 shost->max_sectors = min_t(unsigned int, shost->max_sectors,
1789 dma_max_mapping_size(dev) << SECTOR_SHIFT);
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001790 blk_queue_max_hw_sectors(q, shost->max_sectors);
Christoph Hellwig21e07db2018-04-03 19:09:59 +02001791 if (shost->unchecked_isa_dma)
1792 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001794 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795
Christoph Hellwiga8cf59a2019-01-16 17:12:15 +01001796 blk_queue_max_segment_size(q, shost->max_segment_size);
Christoph Hellwig7ad388d2019-06-17 14:19:53 +02001797 blk_queue_virt_boundary(q, shost->virt_boundary_mask);
1798 dma_set_max_seg_size(dev, queue_max_segment_size(q));
James Bottomley465ff312008-01-01 10:00:10 -06001799
1800 /*
Huacai Chen90addc62017-11-21 14:23:38 +01001801 * Set a reasonable default alignment: The larger of 32-byte (dword),
1802 * which is a common minimum for HBAs, and the minimum DMA alignment,
1803 * which is set by the platform.
1804 *
1805 * Devices that require a bigger alignment can increase it later.
James Bottomley465ff312008-01-01 10:00:10 -06001806 */
Huacai Chen90addc62017-11-21 14:23:38 +01001807 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001808}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001809EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06001810
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001811static const struct blk_mq_ops scsi_mq_ops_no_commit = {
1812 .get_budget = scsi_mq_get_budget,
1813 .put_budget = scsi_mq_put_budget,
1814 .queue_rq = scsi_queue_rq,
1815 .complete = scsi_softirq_done,
1816 .timeout = scsi_timeout,
1817#ifdef CONFIG_BLK_DEBUG_FS
1818 .show_rq = scsi_show_rq,
1819#endif
1820 .init_request = scsi_mq_init_request,
1821 .exit_request = scsi_mq_exit_request,
1822 .initialize_rq_fn = scsi_initialize_rq,
1823 .busy = scsi_mq_lld_busy,
1824 .map_queues = scsi_map_queues,
1825};
1826
1827
1828static void scsi_commit_rqs(struct blk_mq_hw_ctx *hctx)
1829{
1830 struct request_queue *q = hctx->queue;
1831 struct scsi_device *sdev = q->queuedata;
1832 struct Scsi_Host *shost = sdev->host;
1833
1834 shost->hostt->commit_rqs(shost, hctx->queue_num);
1835}
1836
Eric Biggersf363b082017-03-30 13:39:16 -07001837static const struct blk_mq_ops scsi_mq_ops = {
Ming Lei0df21c82017-10-14 17:22:32 +08001838 .get_budget = scsi_mq_get_budget,
1839 .put_budget = scsi_mq_put_budget,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001840 .queue_rq = scsi_queue_rq,
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001841 .commit_rqs = scsi_commit_rqs,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001842 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001843 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07001844#ifdef CONFIG_BLK_DEBUG_FS
1845 .show_rq = scsi_show_rq,
1846#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001847 .init_request = scsi_mq_init_request,
1848 .exit_request = scsi_mq_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001849 .initialize_rq_fn = scsi_initialize_rq,
Jens Axboe3a7ea2c42018-10-29 10:17:28 -06001850 .busy = scsi_mq_lld_busy,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001851 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001852};
1853
1854struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
1855{
1856 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
1857 if (IS_ERR(sdev->request_queue))
1858 return NULL;
1859
1860 sdev->request_queue->queuedata = sdev;
1861 __scsi_init_queue(sdev->host, sdev->request_queue);
Christoph Hellwig17cb9602018-03-13 17:28:41 +01001862 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001863 return sdev->request_queue;
1864}
1865
1866int scsi_mq_setup_tags(struct Scsi_Host *shost)
1867{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001868 unsigned int cmd_size, sgl_size;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001869
Ming Lei3dccdf52019-04-28 15:39:32 +08001870 sgl_size = scsi_mq_inline_sgl_size(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001871 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1872 if (scsi_host_get_prot(shost))
Ming Lei92524fa2019-04-28 15:39:31 +08001873 cmd_size += sizeof(struct scsi_data_buffer) +
1874 sizeof(struct scatterlist) * SCSI_INLINE_PROT_SG_CNT;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001875
1876 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001877 if (shost->hostt->commit_rqs)
1878 shost->tag_set.ops = &scsi_mq_ops;
1879 else
1880 shost->tag_set.ops = &scsi_mq_ops_no_commit;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01001881 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001882 shost->tag_set.queue_depth = shost->can_queue;
1883 shost->tag_set.cmd_size = cmd_size;
1884 shost->tag_set.numa_node = NUMA_NO_NODE;
Ming Lei56d18f62019-02-15 19:13:24 +08001885 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07001886 shost->tag_set.flags |=
1887 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001888 shost->tag_set.driver_data = shost;
1889
1890 return blk_mq_alloc_tag_set(&shost->tag_set);
1891}
1892
1893void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1894{
1895 blk_mq_free_tag_set(&shost->tag_set);
1896}
1897
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001898/**
1899 * scsi_device_from_queue - return sdev associated with a request_queue
1900 * @q: The request queue to return the sdev from
1901 *
1902 * Return the sdev associated with a request queue or NULL if the
1903 * request_queue does not reference a SCSI device.
1904 */
1905struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1906{
1907 struct scsi_device *sdev = NULL;
1908
Jens Axboef664a3c2018-11-01 16:36:27 -06001909 if (q->mq_ops == &scsi_mq_ops)
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001910 sdev = q->queuedata;
1911 if (!sdev || !get_device(&sdev->sdev_gendev))
1912 sdev = NULL;
1913
1914 return sdev;
1915}
1916EXPORT_SYMBOL_GPL(scsi_device_from_queue);
1917
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918/*
1919 * Function: scsi_block_requests()
1920 *
1921 * Purpose: Utility function used by low-level drivers to prevent further
1922 * commands from being queued to the device.
1923 *
1924 * Arguments: shost - Host in question
1925 *
1926 * Returns: Nothing
1927 *
1928 * Lock status: No locks are assumed held.
1929 *
1930 * Notes: There is no timer nor any other means by which the requests
1931 * get unblocked other than the low-level driver calling
1932 * scsi_unblock_requests().
1933 */
1934void scsi_block_requests(struct Scsi_Host *shost)
1935{
1936 shost->host_self_blocked = 1;
1937}
1938EXPORT_SYMBOL(scsi_block_requests);
1939
1940/*
1941 * Function: scsi_unblock_requests()
1942 *
1943 * Purpose: Utility function used by low-level drivers to allow further
1944 * commands from being queued to the device.
1945 *
1946 * Arguments: shost - Host in question
1947 *
1948 * Returns: Nothing
1949 *
1950 * Lock status: No locks are assumed held.
1951 *
1952 * Notes: There is no timer nor any other means by which the requests
1953 * get unblocked other than the low-level driver calling
1954 * scsi_unblock_requests().
1955 *
1956 * This is done as an API function so that changes to the
1957 * internals of the scsi mid-layer won't require wholesale
1958 * changes to drivers that use this feature.
1959 */
1960void scsi_unblock_requests(struct Scsi_Host *shost)
1961{
1962 shost->host_self_blocked = 0;
1963 scsi_run_host_queues(shost);
1964}
1965EXPORT_SYMBOL(scsi_unblock_requests);
1966
1967int __init scsi_init_queue(void)
1968{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001969 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1970 sizeof(struct scsi_data_buffer),
1971 0, 0, NULL);
1972 if (!scsi_sdb_cache) {
1973 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001974 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001975 }
1976
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 return 0;
1978}
1979
1980void scsi_exit_queue(void)
1981{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03001982 kmem_cache_destroy(scsi_sense_cache);
1983 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001984 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985}
James Bottomley5baba832006-03-18 14:10:35 -06001986
1987/**
1988 * scsi_mode_select - issue a mode select
1989 * @sdev: SCSI device to be queried
1990 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1991 * @sp: Save page bit (0 == don't save, 1 == save)
1992 * @modepage: mode page being requested
1993 * @buffer: request buffer (may not be smaller than eight bytes)
1994 * @len: length of request buffer.
1995 * @timeout: command timeout
1996 * @retries: number of retries before failing
1997 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001998 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001999 * must be SCSI_SENSE_BUFFERSIZE big.
2000 *
2001 * Returns zero if successful; negative error number or scsi
2002 * status on error
2003 *
2004 */
2005int
2006scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2007 unsigned char *buffer, int len, int timeout, int retries,
2008 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2009{
2010 unsigned char cmd[10];
2011 unsigned char *real_buffer;
2012 int ret;
2013
2014 memset(cmd, 0, sizeof(cmd));
2015 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2016
2017 if (sdev->use_10_for_ms) {
2018 if (len > 65535)
2019 return -EINVAL;
2020 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2021 if (!real_buffer)
2022 return -ENOMEM;
2023 memcpy(real_buffer + 8, buffer, len);
2024 len += 8;
2025 real_buffer[0] = 0;
2026 real_buffer[1] = 0;
2027 real_buffer[2] = data->medium_type;
2028 real_buffer[3] = data->device_specific;
2029 real_buffer[4] = data->longlba ? 0x01 : 0;
2030 real_buffer[5] = 0;
2031 real_buffer[6] = data->block_descriptor_length >> 8;
2032 real_buffer[7] = data->block_descriptor_length;
2033
2034 cmd[0] = MODE_SELECT_10;
2035 cmd[7] = len >> 8;
2036 cmd[8] = len;
2037 } else {
2038 if (len > 255 || data->block_descriptor_length > 255 ||
2039 data->longlba)
2040 return -EINVAL;
2041
2042 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2043 if (!real_buffer)
2044 return -ENOMEM;
2045 memcpy(real_buffer + 4, buffer, len);
2046 len += 4;
2047 real_buffer[0] = 0;
2048 real_buffer[1] = data->medium_type;
2049 real_buffer[2] = data->device_specific;
2050 real_buffer[3] = data->block_descriptor_length;
2051
2052
2053 cmd[0] = MODE_SELECT;
2054 cmd[4] = len;
2055 }
2056
2057 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002058 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002059 kfree(real_buffer);
2060 return ret;
2061}
2062EXPORT_SYMBOL_GPL(scsi_mode_select);
2063
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064/**
Rob Landleyeb448202007-11-03 13:30:39 -05002065 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002066 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 * @dbd: set if mode sense will allow block descriptors to be returned
2068 * @modepage: mode page being requested
2069 * @buffer: request buffer (may not be smaller than eight bytes)
2070 * @len: length of request buffer.
2071 * @timeout: command timeout
2072 * @retries: number of retries before failing
2073 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002074 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002075 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 *
2077 * Returns zero if unsuccessful, or the header offset (either 4
2078 * or 8 depending on whether a six or ten byte command was
2079 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002080 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081int
James Bottomley1cf72692005-08-28 11:27:01 -05002082scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002084 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2085{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 unsigned char cmd[12];
2087 int use_10_for_ms;
2088 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002089 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002090 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091
2092 memset(data, 0, sizeof(*data));
2093 memset(&cmd[0], 0, 12);
2094 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2095 cmd[2] = modepage;
2096
James Bottomleyea73a9f2005-08-28 11:33:52 -05002097 /* caller might not be interested in sense, but we need it */
2098 if (!sshdr)
2099 sshdr = &my_sshdr;
2100
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002102 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103
2104 if (use_10_for_ms) {
2105 if (len < 8)
2106 len = 8;
2107
2108 cmd[0] = MODE_SENSE_10;
2109 cmd[8] = len;
2110 header_length = 8;
2111 } else {
2112 if (len < 4)
2113 len = 4;
2114
2115 cmd[0] = MODE_SENSE;
2116 cmd[4] = len;
2117 header_length = 4;
2118 }
2119
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 memset(buffer, 0, len);
2121
James Bottomley1cf72692005-08-28 11:27:01 -05002122 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002123 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124
2125 /* This code looks awful: what it's doing is making sure an
2126 * ILLEGAL REQUEST sense return identifies the actual command
2127 * byte as the problem. MODE_SENSE commands can return
2128 * ILLEGAL REQUEST if the code page isn't supported */
2129
James Bottomley1cf72692005-08-28 11:27:01 -05002130 if (use_10_for_ms && !scsi_status_is_good(result) &&
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002131 driver_byte(result) == DRIVER_SENSE) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002132 if (scsi_sense_valid(sshdr)) {
2133 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2134 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 /*
2136 * Invalid command operation code
2137 */
James Bottomley1cf72692005-08-28 11:27:01 -05002138 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 goto retry;
2140 }
2141 }
2142 }
2143
James Bottomley1cf72692005-08-28 11:27:01 -05002144 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002145 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2146 (modepage == 6 || modepage == 8))) {
2147 /* Initio breakage? */
2148 header_length = 0;
2149 data->length = 13;
2150 data->medium_type = 0;
2151 data->device_specific = 0;
2152 data->longlba = 0;
2153 data->block_descriptor_length = 0;
2154 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 data->length = buffer[0]*256 + buffer[1] + 2;
2156 data->medium_type = buffer[2];
2157 data->device_specific = buffer[3];
2158 data->longlba = buffer[4] & 0x01;
2159 data->block_descriptor_length = buffer[6]*256
2160 + buffer[7];
2161 } else {
2162 data->length = buffer[0] + 1;
2163 data->medium_type = buffer[1];
2164 data->device_specific = buffer[2];
2165 data->block_descriptor_length = buffer[3];
2166 }
Al Viro6d73c852006-02-23 02:03:16 +01002167 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002168 } else if ((status_byte(result) == CHECK_CONDITION) &&
2169 scsi_sense_valid(sshdr) &&
2170 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2171 retry_count--;
2172 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 }
2174
James Bottomley1cf72692005-08-28 11:27:01 -05002175 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176}
2177EXPORT_SYMBOL(scsi_mode_sense);
2178
James Bottomley001aac22007-12-02 19:10:40 +02002179/**
2180 * scsi_test_unit_ready - test if unit is ready
2181 * @sdev: scsi device to change the state of.
2182 * @timeout: command timeout
2183 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002184 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002185 *
2186 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002187 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002188 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189int
James Bottomley001aac22007-12-02 19:10:40 +02002190scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002191 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 char cmd[] = {
2194 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2195 };
2196 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002197
James Bottomley001aac22007-12-02 19:10:40 +02002198 /* try to eat the UNIT_ATTENTION if there are enough retries */
2199 do {
2200 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
Bart Van Assche9b91fd32018-02-12 10:57:52 -08002201 timeout, 1, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002202 if (sdev->removable && scsi_sense_valid(sshdr) &&
2203 sshdr->sense_key == UNIT_ATTENTION)
2204 sdev->changed = 1;
2205 } while (scsi_sense_valid(sshdr) &&
2206 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002207
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 return result;
2209}
2210EXPORT_SYMBOL(scsi_test_unit_ready);
2211
2212/**
Rob Landleyeb448202007-11-03 13:30:39 -05002213 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 * @sdev: scsi device to change the state of.
2215 * @state: state to change to.
2216 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002217 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002219 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220int
2221scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2222{
2223 enum scsi_device_state oldstate = sdev->sdev_state;
2224
2225 if (state == oldstate)
2226 return 0;
2227
2228 switch (state) {
2229 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002230 switch (oldstate) {
2231 case SDEV_CREATED_BLOCK:
2232 break;
2233 default:
2234 goto illegal;
2235 }
2236 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237
2238 case SDEV_RUNNING:
2239 switch (oldstate) {
2240 case SDEV_CREATED:
2241 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002242 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 case SDEV_QUIESCE:
2244 case SDEV_BLOCK:
2245 break;
2246 default:
2247 goto illegal;
2248 }
2249 break;
2250
2251 case SDEV_QUIESCE:
2252 switch (oldstate) {
2253 case SDEV_RUNNING:
2254 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002255 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 break;
2257 default:
2258 goto illegal;
2259 }
2260 break;
2261
2262 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002263 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 switch (oldstate) {
2265 case SDEV_CREATED:
2266 case SDEV_RUNNING:
2267 case SDEV_QUIESCE:
2268 case SDEV_BLOCK:
2269 break;
2270 default:
2271 goto illegal;
2272 }
2273 break;
2274
2275 case SDEV_BLOCK:
2276 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002278 case SDEV_CREATED_BLOCK:
Hannes Reineckea33e5bf2018-10-07 10:35:35 +02002279 case SDEV_OFFLINE:
James Bottomley6f4267e2008-08-22 16:53:31 -05002280 break;
2281 default:
2282 goto illegal;
2283 }
2284 break;
2285
2286 case SDEV_CREATED_BLOCK:
2287 switch (oldstate) {
2288 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 break;
2290 default:
2291 goto illegal;
2292 }
2293 break;
2294
2295 case SDEV_CANCEL:
2296 switch (oldstate) {
2297 case SDEV_CREATED:
2298 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002299 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002301 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 break;
2303 default:
2304 goto illegal;
2305 }
2306 break;
2307
2308 case SDEV_DEL:
2309 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002310 case SDEV_CREATED:
2311 case SDEV_RUNNING:
2312 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002313 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002315 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002316 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 break;
2318 default:
2319 goto illegal;
2320 }
2321 break;
2322
2323 }
2324 sdev->sdev_state = state;
2325 return 0;
2326
2327 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002328 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002329 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002330 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002331 scsi_device_state_name(oldstate),
2332 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 );
2334 return -EINVAL;
2335}
2336EXPORT_SYMBOL(scsi_device_set_state);
2337
2338/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002339 * sdev_evt_emit - emit a single SCSI device uevent
2340 * @sdev: associated SCSI device
2341 * @evt: event to emit
2342 *
2343 * Send a single uevent (scsi_event) to the associated scsi_device.
2344 */
2345static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2346{
2347 int idx = 0;
2348 char *envp[3];
2349
2350 switch (evt->evt_type) {
2351 case SDEV_EVT_MEDIA_CHANGE:
2352 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2353 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002354 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002355 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002356 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2357 break;
2358 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2359 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2360 break;
2361 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2362 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2363 break;
2364 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2365 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2366 break;
2367 case SDEV_EVT_LUN_CHANGE_REPORTED:
2368 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2369 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002370 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2371 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2372 break;
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002373 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2374 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2375 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002376 default:
2377 /* do nothing */
2378 break;
2379 }
2380
2381 envp[idx++] = NULL;
2382
2383 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2384}
2385
2386/**
2387 * sdev_evt_thread - send a uevent for each scsi event
2388 * @work: work struct for scsi_device
2389 *
2390 * Dispatch queued events to their associated scsi_device kobjects
2391 * as uevents.
2392 */
2393void scsi_evt_thread(struct work_struct *work)
2394{
2395 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002396 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002397 LIST_HEAD(event_list);
2398
2399 sdev = container_of(work, struct scsi_device, event_work);
2400
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002401 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2402 if (test_and_clear_bit(evt_type, sdev->pending_events))
2403 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2404
Jeff Garzika341cd02007-10-29 17:15:22 -04002405 while (1) {
2406 struct scsi_event *evt;
2407 struct list_head *this, *tmp;
2408 unsigned long flags;
2409
2410 spin_lock_irqsave(&sdev->list_lock, flags);
2411 list_splice_init(&sdev->event_list, &event_list);
2412 spin_unlock_irqrestore(&sdev->list_lock, flags);
2413
2414 if (list_empty(&event_list))
2415 break;
2416
2417 list_for_each_safe(this, tmp, &event_list) {
2418 evt = list_entry(this, struct scsi_event, node);
2419 list_del(&evt->node);
2420 scsi_evt_emit(sdev, evt);
2421 kfree(evt);
2422 }
2423 }
2424}
2425
2426/**
2427 * sdev_evt_send - send asserted event to uevent thread
2428 * @sdev: scsi_device event occurred on
2429 * @evt: event to send
2430 *
2431 * Assert scsi device event asynchronously.
2432 */
2433void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2434{
2435 unsigned long flags;
2436
Kay Sievers4d1566e2008-03-19 13:04:47 +01002437#if 0
2438 /* FIXME: currently this check eliminates all media change events
2439 * for polled devices. Need to update to discriminate between AN
2440 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002441 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2442 kfree(evt);
2443 return;
2444 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002445#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002446
2447 spin_lock_irqsave(&sdev->list_lock, flags);
2448 list_add_tail(&evt->node, &sdev->event_list);
2449 schedule_work(&sdev->event_work);
2450 spin_unlock_irqrestore(&sdev->list_lock, flags);
2451}
2452EXPORT_SYMBOL_GPL(sdev_evt_send);
2453
2454/**
2455 * sdev_evt_alloc - allocate a new scsi event
2456 * @evt_type: type of event to allocate
2457 * @gfpflags: GFP flags for allocation
2458 *
2459 * Allocates and returns a new scsi_event.
2460 */
2461struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2462 gfp_t gfpflags)
2463{
2464 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2465 if (!evt)
2466 return NULL;
2467
2468 evt->evt_type = evt_type;
2469 INIT_LIST_HEAD(&evt->node);
2470
2471 /* evt_type-specific initialization, if any */
2472 switch (evt_type) {
2473 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002474 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2475 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2476 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2477 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2478 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002479 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002480 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002481 default:
2482 /* do nothing */
2483 break;
2484 }
2485
2486 return evt;
2487}
2488EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2489
2490/**
2491 * sdev_evt_send_simple - send asserted event to uevent thread
2492 * @sdev: scsi_device event occurred on
2493 * @evt_type: type of event to send
2494 * @gfpflags: GFP flags for allocation
2495 *
2496 * Assert scsi device event asynchronously, given an event type.
2497 */
2498void sdev_evt_send_simple(struct scsi_device *sdev,
2499 enum scsi_device_event evt_type, gfp_t gfpflags)
2500{
2501 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2502 if (!evt) {
2503 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2504 evt_type);
2505 return;
2506 }
2507
2508 sdev_evt_send(sdev, evt);
2509}
2510EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2511
2512/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513 * scsi_device_quiesce - Block user issued commands.
2514 * @sdev: scsi device to quiesce.
2515 *
2516 * This works by trying to transition to the SDEV_QUIESCE state
2517 * (which must be a legal transition). When the device is in this
2518 * state, only special requests will be accepted, all others will
2519 * be deferred. Since special requests may also be requeued requests,
2520 * a successful return doesn't guarantee the device will be
2521 * totally quiescent.
2522 *
2523 * Must be called with user context, may sleep.
2524 *
2525 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002526 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527int
2528scsi_device_quiesce(struct scsi_device *sdev)
2529{
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002530 struct request_queue *q = sdev->request_queue;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002531 int err;
2532
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002533 /*
2534 * It is allowed to call scsi_device_quiesce() multiple times from
2535 * the same context but concurrent scsi_device_quiesce() calls are
2536 * not allowed.
2537 */
2538 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2539
Bart Van Asschecd84a622018-09-26 14:01:04 -07002540 if (sdev->quiesced_by == current)
2541 return 0;
2542
2543 blk_set_pm_only(q);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002544
2545 blk_mq_freeze_queue(q);
2546 /*
Bart Van Asschecd84a622018-09-26 14:01:04 -07002547 * Ensure that the effect of blk_set_pm_only() will be visible
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002548 * for percpu_ref_tryget() callers that occur after the queue
2549 * unfreeze even if the queue was already frozen before this function
2550 * was called. See also https://lwn.net/Articles/573497/.
2551 */
2552 synchronize_rcu();
2553 blk_mq_unfreeze_queue(q);
2554
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002555 mutex_lock(&sdev->state_mutex);
2556 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002557 if (err == 0)
2558 sdev->quiesced_by = current;
2559 else
Bart Van Asschecd84a622018-09-26 14:01:04 -07002560 blk_clear_pm_only(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002561 mutex_unlock(&sdev->state_mutex);
2562
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002563 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564}
2565EXPORT_SYMBOL(scsi_device_quiesce);
2566
2567/**
2568 * scsi_device_resume - Restart user issued commands to a quiesced device.
2569 * @sdev: scsi device to resume.
2570 *
2571 * Moves the device from quiesced back to running and restarts the
2572 * queues.
2573 *
2574 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002575 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002576void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002578 /* check if the device state was mutated prior to resume, and if
2579 * so assume the state is being managed elsewhere (for example
2580 * device deleted during suspend)
2581 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002582 mutex_lock(&sdev->state_mutex);
Bart Van Assche17605af2019-03-15 16:27:58 -07002583 if (sdev->quiesced_by) {
2584 sdev->quiesced_by = NULL;
2585 blk_clear_pm_only(sdev->request_queue);
2586 }
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002587 if (sdev->sdev_state == SDEV_QUIESCE)
2588 scsi_device_set_state(sdev, SDEV_RUNNING);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002589 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590}
2591EXPORT_SYMBOL(scsi_device_resume);
2592
2593static void
2594device_quiesce_fn(struct scsi_device *sdev, void *data)
2595{
2596 scsi_device_quiesce(sdev);
2597}
2598
2599void
2600scsi_target_quiesce(struct scsi_target *starget)
2601{
2602 starget_for_each_device(starget, NULL, device_quiesce_fn);
2603}
2604EXPORT_SYMBOL(scsi_target_quiesce);
2605
2606static void
2607device_resume_fn(struct scsi_device *sdev, void *data)
2608{
2609 scsi_device_resume(sdev);
2610}
2611
2612void
2613scsi_target_resume(struct scsi_target *starget)
2614{
2615 starget_for_each_device(starget, NULL, device_resume_fn);
2616}
2617EXPORT_SYMBOL(scsi_target_resume);
2618
2619/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002620 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2621 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002623 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002625 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002627 * Notes:
2628 * This routine transitions the device to the SDEV_BLOCK state (which must be
2629 * a legal transition). When the device is in this state, command processing
2630 * is paused until the device leaves the SDEV_BLOCK state. See also
2631 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002632 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002633int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002634{
Jens Axboe165125e2007-07-24 09:28:11 +02002635 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636 int err = 0;
2637
2638 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002639 if (err) {
2640 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2641
2642 if (err)
2643 return err;
2644 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645
2646 /*
2647 * The device has transitioned to SDEV_BLOCK. Stop the
2648 * block layer from calling the midlayer with this device's
2649 * request queue.
2650 */
Jens Axboef664a3c2018-11-01 16:36:27 -06002651 blk_mq_quiesce_queue_nowait(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652 return 0;
2653}
Bart Van Assche551eb592017-06-02 14:21:53 -07002654EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2655
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002657 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2658 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002660 * Pause SCSI command processing on the specified device and wait until all
2661 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002663 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002665 * Note:
2666 * This routine transitions the device to the SDEV_BLOCK state (which must be
2667 * a legal transition). When the device is in this state, command processing
2668 * is paused until the device leaves the SDEV_BLOCK state. See also
2669 * scsi_internal_device_unblock().
Rob Landleyeb448202007-11-03 13:30:39 -05002670 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002671static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672{
Bart Van Assche551eb592017-06-02 14:21:53 -07002673 struct request_queue *q = sdev->request_queue;
2674 int err;
2675
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002676 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07002677 err = scsi_internal_device_block_nowait(sdev);
Jens Axboef664a3c2018-11-01 16:36:27 -06002678 if (err == 0)
2679 blk_mq_quiesce_queue(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002680 mutex_unlock(&sdev->state_mutex);
2681
Bart Van Assche551eb592017-06-02 14:21:53 -07002682 return err;
2683}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002684
Bart Van Assche66483a42017-06-02 14:21:56 -07002685void scsi_start_queue(struct scsi_device *sdev)
2686{
2687 struct request_queue *q = sdev->request_queue;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002688
Jens Axboef664a3c2018-11-01 16:36:27 -06002689 blk_mq_unquiesce_queue(q);
Bart Van Assche66483a42017-06-02 14:21:56 -07002690}
2691
Linus Torvalds1da177e2005-04-16 15:20:36 -07002692/**
Bart Van Assche43f75712017-06-02 14:21:54 -07002693 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07002694 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07002695 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002697 * Restart the device queue for a previously suspended SCSI device. Does not
2698 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002699 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002700 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002702 * Notes:
2703 * This routine transitions the device to the SDEV_RUNNING state or to one of
2704 * the offline states (which must be a legal transition) allowing the midlayer
2705 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002706 */
Bart Van Assche43f75712017-06-02 14:21:54 -07002707int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2708 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709{
Bart Van Assche09addb12019-08-01 15:38:12 -07002710 switch (new_state) {
2711 case SDEV_RUNNING:
2712 case SDEV_TRANSPORT_OFFLINE:
2713 break;
2714 default:
2715 return -EINVAL;
2716 }
2717
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002718 /*
2719 * Try to transition the scsi device to SDEV_RUNNING or one of the
2720 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002721 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002722 switch (sdev->sdev_state) {
2723 case SDEV_BLOCK:
2724 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002725 sdev->sdev_state = new_state;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002726 break;
2727 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002728 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2729 new_state == SDEV_OFFLINE)
2730 sdev->sdev_state = new_state;
2731 else
2732 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002733 break;
2734 case SDEV_CANCEL:
2735 case SDEV_OFFLINE:
2736 break;
2737 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002738 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002739 }
Bart Van Assche66483a42017-06-02 14:21:56 -07002740 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002741
2742 return 0;
2743}
Bart Van Assche43f75712017-06-02 14:21:54 -07002744EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2745
2746/**
2747 * scsi_internal_device_unblock - resume a device after a block request
2748 * @sdev: device to resume
2749 * @new_state: state to set the device to after unblocking
2750 *
2751 * Restart the device queue for a previously suspended SCSI device. May sleep.
2752 *
2753 * Returns zero if successful or a negative error code upon failure.
2754 *
2755 * Notes:
2756 * This routine transitions the device to the SDEV_RUNNING state or to one of
2757 * the offline states (which must be a legal transition) allowing the midlayer
2758 * to goose the queue for this device.
2759 */
2760static int scsi_internal_device_unblock(struct scsi_device *sdev,
2761 enum scsi_device_state new_state)
2762{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002763 int ret;
2764
2765 mutex_lock(&sdev->state_mutex);
2766 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2767 mutex_unlock(&sdev->state_mutex);
2768
2769 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07002770}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771
2772static void
2773device_block(struct scsi_device *sdev, void *data)
2774{
Bart Van Assche551eb592017-06-02 14:21:53 -07002775 scsi_internal_device_block(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002776}
2777
2778static int
2779target_block(struct device *dev, void *data)
2780{
2781 if (scsi_is_target_device(dev))
2782 starget_for_each_device(to_scsi_target(dev), NULL,
2783 device_block);
2784 return 0;
2785}
2786
2787void
2788scsi_target_block(struct device *dev)
2789{
2790 if (scsi_is_target_device(dev))
2791 starget_for_each_device(to_scsi_target(dev), NULL,
2792 device_block);
2793 else
2794 device_for_each_child(dev, NULL, target_block);
2795}
2796EXPORT_SYMBOL_GPL(scsi_target_block);
2797
2798static void
2799device_unblock(struct scsi_device *sdev, void *data)
2800{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002801 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802}
2803
2804static int
2805target_unblock(struct device *dev, void *data)
2806{
2807 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002808 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809 device_unblock);
2810 return 0;
2811}
2812
2813void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002814scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002815{
2816 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002817 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002818 device_unblock);
2819 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002820 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821}
2822EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002823
2824/**
2825 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002826 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002827 * @sg_count: number of segments in sg
2828 * @offset: offset in bytes into sg, on return offset into the mapped area
2829 * @len: bytes to map, on return number of bytes mapped
2830 *
2831 * Returns virtual address of the start of the mapped page
2832 */
Jens Axboec6132da2007-10-16 11:08:49 +02002833void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002834 size_t *offset, size_t *len)
2835{
2836 int i;
2837 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002838 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002839 struct page *page;
2840
Andrew Morton22cfefb2007-02-05 16:39:03 -08002841 WARN_ON(!irqs_disabled());
2842
Jens Axboec6132da2007-10-16 11:08:49 +02002843 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002844 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002845 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002846 if (sg_len > *offset)
2847 break;
2848 }
2849
2850 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002851 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2852 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002853 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002854 WARN_ON(1);
2855 return NULL;
2856 }
2857
2858 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002859 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002860
2861 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002862 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002863 *offset &= ~PAGE_MASK;
2864
2865 /* Bytes in this sg-entry from *offset to the end of the page */
2866 sg_len = PAGE_SIZE - *offset;
2867 if (*len > sg_len)
2868 *len = sg_len;
2869
Cong Wang77dfce02011-11-25 23:14:23 +08002870 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002871}
2872EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2873
2874/**
Rob Landleyeb448202007-11-03 13:30:39 -05002875 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002876 * @virt: virtual address to be unmapped
2877 */
2878void scsi_kunmap_atomic_sg(void *virt)
2879{
Cong Wang77dfce02011-11-25 23:14:23 +08002880 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002881}
2882EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002883
2884void sdev_disable_disk_events(struct scsi_device *sdev)
2885{
2886 atomic_inc(&sdev->disk_events_disable_depth);
2887}
2888EXPORT_SYMBOL(sdev_disable_disk_events);
2889
2890void sdev_enable_disk_events(struct scsi_device *sdev)
2891{
2892 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2893 return;
2894 atomic_dec(&sdev->disk_events_disable_depth);
2895}
2896EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002897
2898/**
2899 * scsi_vpd_lun_id - return a unique device identification
2900 * @sdev: SCSI device
2901 * @id: buffer for the identification
2902 * @id_len: length of the buffer
2903 *
2904 * Copies a unique device identification into @id based
2905 * on the information in the VPD page 0x83 of the device.
2906 * The string will be formatted as a SCSI name string.
2907 *
2908 * Returns the length of the identification or error on failure.
2909 * If the identifier is longer than the supplied buffer the actual
2910 * identifier length is returned and the buffer is not zero-padded.
2911 */
2912int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
2913{
2914 u8 cur_id_type = 0xff;
2915 u8 cur_id_size = 0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002916 const unsigned char *d, *cur_id_str;
2917 const struct scsi_vpd *vpd_pg83;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002918 int id_size = -EINVAL;
2919
2920 rcu_read_lock();
2921 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
2922 if (!vpd_pg83) {
2923 rcu_read_unlock();
2924 return -ENXIO;
2925 }
2926
2927 /*
2928 * Look for the correct descriptor.
2929 * Order of preference for lun descriptor:
2930 * - SCSI name string
2931 * - NAA IEEE Registered Extended
2932 * - EUI-64 based 16-byte
2933 * - EUI-64 based 12-byte
2934 * - NAA IEEE Registered
2935 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02002936 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002937 * as longer descriptors reduce the likelyhood
2938 * of identification clashes.
2939 */
2940
2941 /* The id string must be at least 20 bytes + terminating NULL byte */
2942 if (id_len < 21) {
2943 rcu_read_unlock();
2944 return -EINVAL;
2945 }
2946
2947 memset(id, 0, id_len);
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002948 d = vpd_pg83->data + 4;
2949 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002950 /* Skip designators not referring to the LUN */
2951 if ((d[1] & 0x30) != 0x00)
2952 goto next_desig;
2953
2954 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02002955 case 0x1:
2956 /* T10 Vendor ID */
2957 if (cur_id_size > d[3])
2958 break;
2959 /* Prefer anything */
2960 if (cur_id_type > 0x01 && cur_id_type != 0xff)
2961 break;
2962 cur_id_size = d[3];
2963 if (cur_id_size + 4 > id_len)
2964 cur_id_size = id_len - 4;
2965 cur_id_str = d + 4;
2966 cur_id_type = d[1] & 0xf;
2967 id_size = snprintf(id, id_len, "t10.%*pE",
2968 cur_id_size, cur_id_str);
2969 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002970 case 0x2:
2971 /* EUI-64 */
2972 if (cur_id_size > d[3])
2973 break;
2974 /* Prefer NAA IEEE Registered Extended */
2975 if (cur_id_type == 0x3 &&
2976 cur_id_size == d[3])
2977 break;
2978 cur_id_size = d[3];
2979 cur_id_str = d + 4;
2980 cur_id_type = d[1] & 0xf;
2981 switch (cur_id_size) {
2982 case 8:
2983 id_size = snprintf(id, id_len,
2984 "eui.%8phN",
2985 cur_id_str);
2986 break;
2987 case 12:
2988 id_size = snprintf(id, id_len,
2989 "eui.%12phN",
2990 cur_id_str);
2991 break;
2992 case 16:
2993 id_size = snprintf(id, id_len,
2994 "eui.%16phN",
2995 cur_id_str);
2996 break;
2997 default:
2998 cur_id_size = 0;
2999 break;
3000 }
3001 break;
3002 case 0x3:
3003 /* NAA */
3004 if (cur_id_size > d[3])
3005 break;
3006 cur_id_size = d[3];
3007 cur_id_str = d + 4;
3008 cur_id_type = d[1] & 0xf;
3009 switch (cur_id_size) {
3010 case 8:
3011 id_size = snprintf(id, id_len,
3012 "naa.%8phN",
3013 cur_id_str);
3014 break;
3015 case 16:
3016 id_size = snprintf(id, id_len,
3017 "naa.%16phN",
3018 cur_id_str);
3019 break;
3020 default:
3021 cur_id_size = 0;
3022 break;
3023 }
3024 break;
3025 case 0x8:
3026 /* SCSI name string */
3027 if (cur_id_size + 4 > d[3])
3028 break;
3029 /* Prefer others for truncated descriptor */
3030 if (cur_id_size && d[3] > id_len)
3031 break;
3032 cur_id_size = id_size = d[3];
3033 cur_id_str = d + 4;
3034 cur_id_type = d[1] & 0xf;
3035 if (cur_id_size >= id_len)
3036 cur_id_size = id_len - 1;
3037 memcpy(id, cur_id_str, cur_id_size);
3038 /* Decrease priority for truncated descriptor */
3039 if (cur_id_size != id_size)
3040 cur_id_size = 6;
3041 break;
3042 default:
3043 break;
3044 }
3045next_desig:
3046 d += d[3] + 4;
3047 }
3048 rcu_read_unlock();
3049
3050 return id_size;
3051}
3052EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003053
3054/*
3055 * scsi_vpd_tpg_id - return a target port group identifier
3056 * @sdev: SCSI device
3057 *
3058 * Returns the Target Port Group identifier from the information
3059 * froom VPD page 0x83 of the device.
3060 *
3061 * Returns the identifier or error on failure.
3062 */
3063int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3064{
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003065 const unsigned char *d;
3066 const struct scsi_vpd *vpd_pg83;
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003067 int group_id = -EAGAIN, rel_port = -1;
3068
3069 rcu_read_lock();
3070 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3071 if (!vpd_pg83) {
3072 rcu_read_unlock();
3073 return -ENXIO;
3074 }
3075
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003076 d = vpd_pg83->data + 4;
3077 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003078 switch (d[1] & 0xf) {
3079 case 0x4:
3080 /* Relative target port */
3081 rel_port = get_unaligned_be16(&d[6]);
3082 break;
3083 case 0x5:
3084 /* Target port group */
3085 group_id = get_unaligned_be16(&d[6]);
3086 break;
3087 default:
3088 break;
3089 }
3090 d += d[3] + 4;
3091 }
3092 rcu_read_unlock();
3093
3094 if (group_id >= 0 && rel_id && rel_port != -1)
3095 *rel_id = rel_port;
3096
3097 return group_id;
3098}
3099EXPORT_SYMBOL(scsi_vpd_tpg_id);