blob: 63dcb2a94e5d1edf7cc2782f78c75141d6957142 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Christoph Hellwigd2852032014-01-17 12:06:53 +01002 * Copyright (C) 1999 Eric Youngdale
3 * Copyright (C) 2014 Christoph Hellwig
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 * SCSI queueing library.
6 * Initial versions: Eric Youngdale (eric@andante.org).
7 * Based upon conversations with large numbers
8 * of people at Linux Expo.
9 */
10
11#include <linux/bio.h>
James Bottomleyd3f46f32008-01-15 11:11:46 -060012#include <linux/bitops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/blkdev.h>
14#include <linux/completion.h>
15#include <linux/kernel.h>
Paul Gortmaker09703662011-05-27 09:37:25 -040016#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/init.h>
18#include <linux/pci.h>
19#include <linux/delay.h>
James Bottomleyfaead262006-02-14 10:42:07 -060020#include <linux/hardirq.h>
Jens Axboec6132da2007-10-16 11:08:49 +020021#include <linux/scatterlist.h>
Christoph Hellwigd2852032014-01-17 12:06:53 +010022#include <linux/blk-mq.h>
Hannes Reineckef1569ff2014-10-24 14:27:07 +020023#include <linux/ratelimit.h>
Hannes Reineckea8aa3972015-12-01 10:16:57 +010024#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020027#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <scsi/scsi_dbg.h>
29#include <scsi/scsi_device.h>
30#include <scsi/scsi_driver.h>
31#include <scsi/scsi_eh.h>
32#include <scsi/scsi_host.h>
Bart Van Assche7aa686d2017-05-02 10:45:03 -070033#include <scsi/scsi_transport.h> /* __scsi_init_queue() */
Christoph Hellwigee14c672015-08-27 14:16:59 +020034#include <scsi/scsi_dh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Christoph Hellwig3b5382c2014-05-06 12:25:40 +020036#include <trace/events/scsi.h>
37
Bart Van Assche0eebd002017-04-26 13:47:57 -070038#include "scsi_debugfs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include "scsi_priv.h"
40#include "scsi_logging.h"
41
Christoph Hellwige9c787e2017-01-02 21:55:26 +030042static struct kmem_cache *scsi_sdb_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030043static struct kmem_cache *scsi_sense_cache;
44static struct kmem_cache *scsi_sense_isadma_cache;
45static DEFINE_MUTEX(scsi_sense_cache_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Bart Van Asschea45a1f362017-08-30 16:58:42 -070047static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd);
48
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030049static inline struct kmem_cache *
Bart Van Assche8e688252017-06-02 14:21:52 -070050scsi_select_sense_cache(bool unchecked_isa_dma)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030051{
Bart Van Assche8e688252017-06-02 14:21:52 -070052 return unchecked_isa_dma ? scsi_sense_isadma_cache : scsi_sense_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030053}
54
Bart Van Assche8e688252017-06-02 14:21:52 -070055static void scsi_free_sense_buffer(bool unchecked_isa_dma,
56 unsigned char *sense_buffer)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030057{
Bart Van Assche8e688252017-06-02 14:21:52 -070058 kmem_cache_free(scsi_select_sense_cache(unchecked_isa_dma),
59 sense_buffer);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030060}
61
Bart Van Assche8e688252017-06-02 14:21:52 -070062static unsigned char *scsi_alloc_sense_buffer(bool unchecked_isa_dma,
Christoph Hellwige9c787e2017-01-02 21:55:26 +030063 gfp_t gfp_mask, int numa_node)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030064{
Bart Van Assche8e688252017-06-02 14:21:52 -070065 return kmem_cache_alloc_node(scsi_select_sense_cache(unchecked_isa_dma),
66 gfp_mask, numa_node);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030067}
68
69int scsi_init_sense_cache(struct Scsi_Host *shost)
70{
71 struct kmem_cache *cache;
72 int ret = 0;
73
Bart Van Assche8e688252017-06-02 14:21:52 -070074 cache = scsi_select_sense_cache(shost->unchecked_isa_dma);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030075 if (cache)
76 return 0;
77
78 mutex_lock(&scsi_sense_cache_mutex);
79 if (shost->unchecked_isa_dma) {
80 scsi_sense_isadma_cache =
81 kmem_cache_create("scsi_sense_cache(DMA)",
David Windsor0afe76e2017-06-10 22:50:45 -040082 SCSI_SENSE_BUFFERSIZE, 0,
83 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030084 if (!scsi_sense_isadma_cache)
85 ret = -ENOMEM;
86 } else {
87 scsi_sense_cache =
David Windsor0afe76e2017-06-10 22:50:45 -040088 kmem_cache_create_usercopy("scsi_sense_cache",
89 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN,
90 0, SCSI_SENSE_BUFFERSIZE, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030091 if (!scsi_sense_cache)
92 ret = -ENOMEM;
93 }
94
95 mutex_unlock(&scsi_sense_cache_mutex);
96 return ret;
97}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +020098
Jens Axboea488e742010-04-16 21:13:15 +020099/*
100 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
101 * not change behaviour from the previous unplug mechanism, experimentation
102 * may prove this needs changing.
103 */
104#define SCSI_QUEUE_DELAY 3
105
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100106static void
107scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108{
109 struct Scsi_Host *host = cmd->device->host;
110 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500111 struct scsi_target *starget = scsi_target(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900114 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 *
116 * If the host/device isn't busy, assume that something actually
117 * completed, and that we should be able to queue a command now.
118 *
119 * Note that the prior mid-layer assumption that any host could
120 * always queue at least one command is now broken. The mid-layer
121 * will implement a user specifiable stall (see
122 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
123 * if a command is requeued with no other commands outstanding
124 * either for the device or for the host.
125 */
Mike Christief0c0a372008-08-17 15:24:38 -0500126 switch (reason) {
127 case SCSI_MLQUEUE_HOST_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100128 atomic_set(&host->host_blocked, host->max_host_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500129 break;
130 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400131 case SCSI_MLQUEUE_EH_RETRY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100132 atomic_set(&device->device_blocked,
133 device->max_device_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500134 break;
135 case SCSI_MLQUEUE_TARGET_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100136 atomic_set(&starget->target_blocked,
137 starget->max_target_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500138 break;
139 }
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100140}
141
Christoph Hellwigd2852032014-01-17 12:06:53 +0100142static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
143{
144 struct scsi_device *sdev = cmd->device;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100145
Bart Van Asschea45a1f362017-08-30 16:58:42 -0700146 if (cmd->request->rq_flags & RQF_DONTPREP) {
147 cmd->request->rq_flags &= ~RQF_DONTPREP;
148 scsi_mq_uninit_cmd(cmd);
149 } else {
150 WARN_ON_ONCE(true);
151 }
Bart Van Assche2b053ac2016-10-28 17:21:41 -0700152 blk_mq_requeue_request(cmd->request, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100153 put_device(&sdev->sdev_gendev);
154}
155
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100156/**
157 * __scsi_queue_insert - private queue insertion
158 * @cmd: The SCSI command being requeued
159 * @reason: The reason for the requeue
160 * @unbusy: Whether the queue should be unbusied
161 *
162 * This is a private queue insertion. The public interface
163 * scsi_queue_insert() always assumes the queue should be unbusied
164 * because it's always called before the completion. This function is
165 * for a requeue after completion, which should only occur in this
166 * file.
167 */
Bart Van Assche08640e82018-01-10 14:41:45 -0800168static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, bool unbusy)
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100169{
170 struct scsi_device *device = cmd->device;
171 struct request_queue *q = device->request_queue;
172 unsigned long flags;
173
174 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
175 "Inserting command %p into mlqueue\n", cmd));
176
177 scsi_set_blocked(cmd, reason);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 * Decrement the counters, since these commands are no longer
181 * active on the host/device.
182 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600183 if (unbusy)
184 scsi_device_unbusy(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500187 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000188 * that are already in the queue. Schedule requeue work under
189 * lock such that the kblockd_schedule_work() call happens
190 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200191 */
Alan Stern644373a2014-03-28 10:51:15 -0700192 cmd->result = 0;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100193 if (q->mq_ops) {
Jianchao Wang2f793a22018-03-03 09:54:09 +0800194 /*
195 * Before a SCSI command is dispatched,
196 * get_device(&sdev->sdev_gendev) is called and the host,
197 * target and device busy counters are increased. Since
198 * requeuing a request causes these actions to be repeated and
199 * since scsi_device_unbusy() has already been called,
200 * put_device(&device->sdev_gendev) must still be called. Call
201 * put_device() after blk_mq_requeue_request() to avoid that
202 * removal of the SCSI device can start before requeueing has
203 * happened.
204 */
205 blk_mq_requeue_request(cmd->request, true);
206 put_device(&device->sdev_gendev);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100207 return;
208 }
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500209 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley59897da2005-09-14 12:57:42 -0400210 blk_requeue_request(q, cmd->request);
Jens Axboe59c3d452014-04-08 09:15:35 -0600211 kblockd_schedule_work(&device->requeue_work);
Bart Van Asscheb4854622012-06-29 15:36:07 +0000212 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213}
214
James Bottomley4f5299a2009-01-02 10:42:21 -0600215/*
216 * Function: scsi_queue_insert()
217 *
218 * Purpose: Insert a command in the midlevel queue.
219 *
220 * Arguments: cmd - command that we are adding to queue.
221 * reason - why we are inserting command to queue.
222 *
223 * Lock status: Assumed that lock is not held upon entry.
224 *
225 * Returns: Nothing.
226 *
227 * Notes: We do this for one of two cases. Either the host is busy
228 * and it cannot accept any more commands for the time being,
229 * or the device returned QUEUE_FULL and can accept no more
230 * commands.
231 * Notes: This could be called either from an interrupt context or a
232 * normal process context.
233 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000234void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600235{
Bart Van Assche08640e82018-01-10 14:41:45 -0800236 __scsi_queue_insert(cmd, reason, true);
James Bottomley4f5299a2009-01-02 10:42:21 -0600237}
Christoph Hellwige8064022016-10-20 15:12:13 +0200238
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100239
240/**
241 * scsi_execute - insert request and wait for the result
242 * @sdev: scsi device
243 * @cmd: scsi command
244 * @data_direction: data direction
245 * @buffer: data buffer
246 * @bufflen: len of buffer
247 * @sense: optional sense buffer
248 * @sshdr: optional decoded sense header
249 * @timeout: request timeout in seconds
250 * @retries: number of times to retry request
251 * @flags: flags for ->cmd_flags
252 * @rq_flags: flags for ->rq_flags
253 * @resid: optional residual length
254 *
Christoph Hellwig17d53632017-04-20 16:03:01 +0200255 * Returns the scsi_cmnd result field if a command was executed, or a negative
256 * Linux error code if we didn't get that far.
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100257 */
258int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500259 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100260 unsigned char *sense, struct scsi_sense_hdr *sshdr,
261 int timeout, int retries, u64 flags, req_flags_t rq_flags,
262 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500263{
264 struct request *req;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100265 struct scsi_request *rq;
James Bottomley39216032005-06-15 18:48:29 -0500266 int ret = DRIVER_ERROR << 24;
267
Christoph Hellwigff005a02018-05-09 09:54:05 +0200268 req = blk_get_request(sdev->request_queue,
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100269 data_direction == DMA_TO_DEVICE ?
Bart Van Assche039c6352017-11-09 10:49:56 -0800270 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, BLK_MQ_REQ_PREEMPT);
Joe Lawrencea492f072014-08-28 08:15:21 -0600271 if (IS_ERR(req))
James Bottomleybfe159a2011-07-07 15:45:40 -0500272 return ret;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100273 rq = scsi_req(req);
James Bottomley39216032005-06-15 18:48:29 -0500274
275 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
Christoph Hellwig0eb0b632018-05-09 09:54:08 +0200276 buffer, bufflen, GFP_NOIO))
James Bottomley39216032005-06-15 18:48:29 -0500277 goto out;
278
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100279 rq->cmd_len = COMMAND_SIZE(cmd[0]);
280 memcpy(rq->cmd, cmd, rq->cmd_len);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200281 rq->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500282 req->timeout = timeout;
Christoph Hellwige8064022016-10-20 15:12:13 +0200283 req->cmd_flags |= flags;
Bart Van Assche039c6352017-11-09 10:49:56 -0800284 req->rq_flags |= rq_flags | RQF_QUIET;
James Bottomley39216032005-06-15 18:48:29 -0500285
286 /*
287 * head injection *required* here otherwise quiesce won't work
288 */
289 blk_execute_rq(req->q, NULL, req, 1);
290
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400291 /*
292 * Some devices (USB mass-storage in particular) may transfer
293 * garbage data together with a residue indicating that the data
294 * is invalid. Prevent the garbage from being misinterpreted
295 * and prevent security leaks by zeroing out the excess data.
296 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100297 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
298 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400299
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900300 if (resid)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100301 *resid = rq->resid_len;
302 if (sense && rq->sense_len)
303 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100304 if (sshdr)
305 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
Christoph Hellwig17d53632017-04-20 16:03:01 +0200306 ret = rq->result;
James Bottomley39216032005-06-15 18:48:29 -0500307 out:
308 blk_put_request(req);
309
310 return ret;
311}
James Bottomley33aa6872005-08-28 11:31:14 -0500312EXPORT_SYMBOL(scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500313
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314/*
315 * Function: scsi_init_cmd_errh()
316 *
317 * Purpose: Initialize cmd fields related to error handling.
318 *
319 * Arguments: cmd - command that is ready to be queued.
320 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 * Notes: This function has the job of initializing a number of
322 * fields related to error handling. Typically this will
323 * be called once for each command, as required.
324 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200325static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 cmd->serial_number = 0;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200328 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900329 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300331 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332}
333
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800334/*
335 * Decrement the host_busy counter and wake up the error handler if necessary.
336 * Avoid as follows that the error handler is not woken up if shost->host_busy
337 * == shost->host_failed: use call_rcu() in scsi_eh_scmd_add() in combination
338 * with an RCU read lock in this function to ensure that this function in its
339 * entirety either finishes before scsi_eh_scmd_add() increases the
340 * host_failed counter or that it notices the shost state change made by
341 * scsi_eh_scmd_add().
342 */
343static void scsi_dec_host_busy(struct Scsi_Host *shost)
344{
345 unsigned long flags;
346
347 rcu_read_lock();
348 atomic_dec(&shost->host_busy);
349 if (unlikely(scsi_host_in_recovery(shost))) {
350 spin_lock_irqsave(shost->host_lock, flags);
351 if (shost->host_failed || shost->host_eh_scheduled)
352 scsi_eh_wakeup(shost);
353 spin_unlock_irqrestore(shost->host_lock, flags);
354 }
355 rcu_read_unlock();
356}
357
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358void scsi_device_unbusy(struct scsi_device *sdev)
359{
360 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500361 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800363 scsi_dec_host_busy(shost);
364
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100365 if (starget->can_queue > 0)
366 atomic_dec(&starget->target_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +0100367
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200368 atomic_dec(&sdev->device_busy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369}
370
Christoph Hellwigd2852032014-01-17 12:06:53 +0100371static void scsi_kick_queue(struct request_queue *q)
372{
373 if (q->mq_ops)
374 blk_mq_start_hw_queues(q);
375 else
376 blk_run_queue(q);
377}
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379/*
380 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
381 * and call blk_run_queue for all the scsi_devices on the target -
382 * including current_sdev first.
383 *
384 * Called with *no* scsi locks held.
385 */
386static void scsi_single_lun_run(struct scsi_device *current_sdev)
387{
388 struct Scsi_Host *shost = current_sdev->host;
389 struct scsi_device *sdev, *tmp;
390 struct scsi_target *starget = scsi_target(current_sdev);
391 unsigned long flags;
392
393 spin_lock_irqsave(shost->host_lock, flags);
394 starget->starget_sdev_user = NULL;
395 spin_unlock_irqrestore(shost->host_lock, flags);
396
397 /*
398 * Call blk_run_queue for all LUNs on the target, starting with
399 * current_sdev. We race with others (to set starget_sdev_user),
400 * but in most cases, we will be first. Ideally, each LU on the
401 * target would get some limited time or requests on the target.
402 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100403 scsi_kick_queue(current_sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405 spin_lock_irqsave(shost->host_lock, flags);
406 if (starget->starget_sdev_user)
407 goto out;
408 list_for_each_entry_safe(sdev, tmp, &starget->devices,
409 same_target_siblings) {
410 if (sdev == current_sdev)
411 continue;
412 if (scsi_device_get(sdev))
413 continue;
414
415 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100416 scsi_kick_queue(sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 spin_lock_irqsave(shost->host_lock, flags);
418
419 scsi_device_put(sdev);
420 }
421 out:
422 spin_unlock_irqrestore(shost->host_lock, flags);
423}
424
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100425static inline bool scsi_device_is_busy(struct scsi_device *sdev)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400426{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100427 if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
428 return true;
429 if (atomic_read(&sdev->device_blocked) > 0)
430 return true;
431 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400432}
433
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100434static inline bool scsi_target_is_busy(struct scsi_target *starget)
Mike Christief0c0a372008-08-17 15:24:38 -0500435{
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100436 if (starget->can_queue > 0) {
437 if (atomic_read(&starget->target_busy) >= starget->can_queue)
438 return true;
439 if (atomic_read(&starget->target_blocked) > 0)
440 return true;
441 }
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100442 return false;
Mike Christief0c0a372008-08-17 15:24:38 -0500443}
444
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100445static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400446{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100447 if (shost->can_queue > 0 &&
448 atomic_read(&shost->host_busy) >= shost->can_queue)
449 return true;
450 if (atomic_read(&shost->host_blocked) > 0)
451 return true;
452 if (shost->host_self_blocked)
453 return true;
454 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400455}
456
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800457static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600459 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800460 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 unsigned long flags;
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600464 list_splice_init(&shost->starved_list, &starved_list);
465
466 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200467 struct request_queue *slq;
468
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 /*
470 * As long as shost is accepting commands and we have
471 * starved queues, call blk_run_queue. scsi_request_fn
472 * drops the queue_lock and can add us back to the
473 * starved_list.
474 *
475 * host_lock protects the starved_list and starved_entry.
476 * scsi_request_fn must get the host_lock before checking
477 * or modifying starved_list or starved_entry.
478 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600479 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500480 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500481
Mike Christie2a3a59e2008-11-11 13:42:35 -0600482 sdev = list_entry(starved_list.next,
483 struct scsi_device, starved_entry);
484 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500485 if (scsi_target_is_busy(scsi_target(sdev))) {
486 list_move_tail(&sdev->starved_entry,
487 &shost->starved_list);
488 continue;
489 }
490
James Bottomleye2eb7242013-07-02 15:05:26 +0200491 /*
492 * Once we drop the host lock, a racing scsi_remove_device()
493 * call may remove the sdev from the starved list and destroy
494 * it and the queue. Mitigate by taking a reference to the
495 * queue and never touching the sdev again after we drop the
496 * host lock. Note: if __scsi_remove_device() invokes
497 * blk_cleanup_queue() before the queue is run from this
498 * function then blk_run_queue() will return immediately since
499 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
500 */
501 slq = sdev->request_queue;
502 if (!blk_get_queue(slq))
503 continue;
504 spin_unlock_irqrestore(shost->host_lock, flags);
505
Christoph Hellwigd2852032014-01-17 12:06:53 +0100506 scsi_kick_queue(slq);
James Bottomleye2eb7242013-07-02 15:05:26 +0200507 blk_put_queue(slq);
508
509 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600511 /* put any unprocessed entries back */
512 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800514}
515
516/*
517 * Function: scsi_run_queue()
518 *
519 * Purpose: Select a proper request queue to serve next
520 *
521 * Arguments: q - last request's queue
522 *
523 * Returns: Nothing
524 *
525 * Notes: The previous command was completely finished, start
526 * a new one if possible.
527 */
528static void scsi_run_queue(struct request_queue *q)
529{
530 struct scsi_device *sdev = q->queuedata;
531
532 if (scsi_target(sdev)->single_lun)
533 scsi_single_lun_run(sdev);
534 if (!list_empty(&sdev->host->starved_list))
535 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
Christoph Hellwigd2852032014-01-17 12:06:53 +0100537 if (q->mq_ops)
Bart Van Assche36e3cf22017-04-07 11:16:53 -0700538 blk_mq_run_hw_queues(q, false);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100539 else
540 blk_run_queue(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541}
542
Jens Axboe9937a5e2011-05-17 11:04:44 +0200543void scsi_requeue_run_queue(struct work_struct *work)
544{
545 struct scsi_device *sdev;
546 struct request_queue *q;
547
548 sdev = container_of(work, struct scsi_device, requeue_work);
549 q = sdev->request_queue;
550 scsi_run_queue(q);
551}
552
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553/*
554 * Function: scsi_requeue_command()
555 *
556 * Purpose: Handle post-processing of completed commands.
557 *
558 * Arguments: q - queue to operate on
559 * cmd - command that may need to be requeued.
560 *
561 * Returns: Nothing
562 *
563 * Notes: After command completion, there may be blocks left
564 * over which weren't finished by the previous command
565 * this can be for a number of reasons - the main one is
566 * I/O errors in the middle of the request, in which case
567 * we need to request the blocks that come after the bad
568 * sector.
James Bottomleye91442b2005-09-09 10:44:16 -0500569 * Notes: Upon return, cmd is a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 */
571static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
572{
Bart Van Assche940f5d42012-06-29 15:34:26 +0000573 struct scsi_device *sdev = cmd->device;
James Bottomleye91442b2005-09-09 10:44:16 -0500574 struct request *req = cmd->request;
Tejun Heo 283369c2005-04-24 02:06:36 -0500575 unsigned long flags;
576
Tejun Heo 283369c2005-04-24 02:06:36 -0500577 spin_lock_irqsave(q->queue_lock, flags);
Christoph Hellwig134997a2014-02-20 14:20:58 -0800578 blk_unprep_request(req);
579 req->special = NULL;
580 scsi_put_command(cmd);
James Bottomleye91442b2005-09-09 10:44:16 -0500581 blk_requeue_request(q, req);
Tejun Heo 283369c2005-04-24 02:06:36 -0500582 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
584 scsi_run_queue(q);
Bart Van Assche940f5d42012-06-29 15:34:26 +0000585
586 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587}
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589void scsi_run_host_queues(struct Scsi_Host *shost)
590{
591 struct scsi_device *sdev;
592
593 shost_for_each_device(sdev, shost)
594 scsi_run_queue(sdev->request_queue);
595}
596
Christoph Hellwigd2852032014-01-17 12:06:53 +0100597static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
598{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100599 if (!blk_rq_is_passthrough(cmd->request)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100600 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
601
602 if (drv->uninit_command)
603 drv->uninit_command(cmd);
604 }
605}
606
607static void scsi_mq_free_sgtables(struct scsi_cmnd *cmd)
608{
Ming Lin91dbc082016-04-04 14:48:07 -0700609 struct scsi_data_buffer *sdb;
610
Christoph Hellwigd2852032014-01-17 12:06:53 +0100611 if (cmd->sdb.table.nents)
Ming Lin001d63b2016-04-04 14:48:09 -0700612 sg_free_table_chained(&cmd->sdb.table, true);
Ming Lin91dbc082016-04-04 14:48:07 -0700613 if (cmd->request->next_rq) {
614 sdb = cmd->request->next_rq->special;
615 if (sdb)
Ming Lin001d63b2016-04-04 14:48:09 -0700616 sg_free_table_chained(&sdb->table, true);
Ming Lin91dbc082016-04-04 14:48:07 -0700617 }
Christoph Hellwigd2852032014-01-17 12:06:53 +0100618 if (scsi_prot_sg_count(cmd))
Ming Lin001d63b2016-04-04 14:48:09 -0700619 sg_free_table_chained(&cmd->prot_sdb->table, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100620}
621
622static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
623{
Christoph Hellwigd2852032014-01-17 12:06:53 +0100624 scsi_mq_free_sgtables(cmd);
625 scsi_uninit_cmd(cmd);
Bart Van Assche2dd6fb52017-06-02 14:21:58 -0700626 scsi_del_cmd_from_list(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100627}
628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629/*
630 * Function: scsi_release_buffers()
631 *
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200632 * Purpose: Free resources allocate for a scsi_command.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 *
634 * Arguments: cmd - command that we are bailing.
635 *
636 * Lock status: Assumed that no lock is held upon entry.
637 *
638 * Returns: Nothing
639 *
640 * Notes: In the event that an upper level driver rejects a
641 * command, we must release resources allocated during
642 * the __init_io() function. Primarily this would involve
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200643 * the scatter-gather table.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 */
Christoph Hellwigf1bea552014-04-15 12:26:54 +0200645static void scsi_release_buffers(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646{
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200647 if (cmd->sdb.table.nents)
Ming Lin001d63b2016-04-04 14:48:09 -0700648 sg_free_table_chained(&cmd->sdb.table, false);
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200649
650 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
651
652 if (scsi_prot_sg_count(cmd))
Ming Lin001d63b2016-04-04 14:48:09 -0700653 sg_free_table_chained(&cmd->prot_sdb->table, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654}
655
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200656static void scsi_release_bidi_buffers(struct scsi_cmnd *cmd)
657{
658 struct scsi_data_buffer *bidi_sdb = cmd->request->next_rq->special;
659
Ming Lin001d63b2016-04-04 14:48:09 -0700660 sg_free_table_chained(&bidi_sdb->table, false);
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200661 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
662 cmd->request->next_rq->special = NULL;
663}
664
Douglas Gilbert7e63b5a2018-06-23 12:22:14 +0200665/* Returns false when no more bytes to process, true if there are more */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200666static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800667 unsigned int bytes, unsigned int bidi_bytes)
668{
Bart Van Asschebed22132017-08-25 13:46:32 -0700669 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800670 struct scsi_device *sdev = cmd->device;
671 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800672
673 if (blk_update_request(req, error, bytes))
674 return true;
675
676 /* Bidi request must be completed as a whole */
677 if (unlikely(bidi_bytes) &&
678 blk_update_request(req->next_rq, error, bidi_bytes))
679 return true;
680
681 if (blk_queue_add_random(q))
682 add_disk_randomness(req->rq_disk);
683
Bart Van Assche64104f72017-08-30 16:58:39 -0700684 if (!blk_rq_is_scsi(req)) {
685 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
686 cmd->flags &= ~SCMD_INITIALIZED;
Bart Van Assche3be88282018-02-22 11:30:20 -0800687 destroy_rcu_head(&cmd->rcu);
Bart Van Assche64104f72017-08-30 16:58:39 -0700688 }
689
Christoph Hellwigd2852032014-01-17 12:06:53 +0100690 if (req->mq_ctx) {
691 /*
Christoph Hellwigc8a446a2014-09-13 16:40:10 -0700692 * In the MQ case the command gets freed by __blk_mq_end_request,
Christoph Hellwigd2852032014-01-17 12:06:53 +0100693 * so we have to do all cleanup that depends on it earlier.
694 *
695 * We also can't kick the queues from irq context, so we
696 * will have to defer it to a workqueue.
697 */
698 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800699
Christoph Hellwigc8a446a2014-09-13 16:40:10 -0700700 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100701
702 if (scsi_target(sdev)->single_lun ||
703 !list_empty(&sdev->host->starved_list))
704 kblockd_schedule_work(&sdev->requeue_work);
705 else
Bart Van Assche36e3cf22017-04-07 11:16:53 -0700706 blk_mq_run_hw_queues(q, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100707 } else {
708 unsigned long flags;
709
Daniel Gryniewiczf81426a2014-09-16 10:41:13 -0400710 if (bidi_bytes)
711 scsi_release_bidi_buffers(cmd);
Christoph Hellwige9c787e2017-01-02 21:55:26 +0300712 scsi_release_buffers(cmd);
713 scsi_put_command(cmd);
Daniel Gryniewiczf81426a2014-09-16 10:41:13 -0400714
Christoph Hellwigd2852032014-01-17 12:06:53 +0100715 spin_lock_irqsave(q->queue_lock, flags);
716 blk_finish_request(req, error);
717 spin_unlock_irqrestore(q->queue_lock, flags);
718
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700719 scsi_run_queue(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100720 }
721
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700722 put_device(&sdev->sdev_gendev);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800723 return false;
724}
725
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200726/**
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700727 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
728 * @cmd: SCSI command
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200729 * @result: scsi error code
730 *
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700731 * Translate a SCSI result code into a blk_status_t value. May reset the host
732 * byte of @cmd->result.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200733 */
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700734static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100735{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200736 switch (host_byte(result)) {
Bart Van Asschef4abab32018-04-05 10:33:01 -0700737 case DID_OK:
738 /*
739 * Also check the other bytes than the status byte in result
740 * to handle the case when a SCSI LLD sets result to
741 * DRIVER_SENSE << 24 without setting SAM_STAT_CHECK_CONDITION.
742 */
743 if (scsi_status_is_good(result) && (result & ~0xff) == 0)
744 return BLK_STS_OK;
745 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100746 case DID_TRANSPORT_FAILFAST:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200747 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100748 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000749 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200750 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100751 case DID_NEXUS_FAILURE:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200752 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200753 case DID_ALLOC_FAILURE:
754 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200755 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200756 case DID_MEDIUM_ERROR:
757 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200758 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100759 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200760 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100761 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100762}
763
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200764/* Helper for scsi_io_completion() when "reprep" action required. */
765static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
766 struct request_queue *q)
767{
768 /* A new command will be prepared and issued. */
769 if (q->mq_ops) {
770 scsi_mq_requeue_cmd(cmd);
771 } else {
772 /* Unprep request and put it back at head of the queue. */
773 scsi_release_buffers(cmd);
774 scsi_requeue_command(q, cmd);
775 }
776}
777
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200778/* Helper for scsi_io_completion() when special action required. */
779static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
Douglas Gilbertab831082018-06-23 12:22:16 +0200780{
Jens Axboe165125e2007-07-24 09:28:11 +0200781 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 struct request *req = cmd->request;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200783 int level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500784 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
785 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900786 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200787 struct scsi_sense_hdr sshdr;
788 bool sense_valid;
789 bool sense_current = true; /* false implies "deferred sense" */
790 blk_status_t blk_stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200792 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
793 if (sense_valid)
794 sense_current = !scsi_sense_is_deferred(&sshdr);
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700795
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200796 blk_stat = scsi_result_to_blk_status(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500797
Alan Sternb60af5b2008-11-03 15:56:47 -0500798 if (host_byte(result) == DID_RESET) {
799 /* Third party bus reset or reset for error recovery
800 * reasons. Just retry the command and see what
801 * happens.
802 */
803 action = ACTION_RETRY;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200804 } else if (sense_valid && sense_current) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 switch (sshdr.sense_key) {
806 case UNIT_ATTENTION:
807 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700808 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 * and quietly refuse further access.
810 */
811 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500812 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700814 /* Must have been a power glitch, or a
815 * bus reset. Could not have been a
816 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500817 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700818 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500819 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 }
821 break;
822 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700823 /* If we had an ILLEGAL REQUEST returned, then
824 * we may have performed an unsupported
825 * command. The only thing this should be
826 * would be a ten byte read where only a six
827 * byte read was supported. Also, on a system
828 * where READ CAPACITY failed, we may have
829 * read past the end of the disk.
830 */
Jens Axboe26a68012005-11-29 21:03:34 +0100831 if ((cmd->device->use_10_for_rw &&
832 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 (cmd->cmnd[0] == READ_10 ||
834 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500835 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500837 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500838 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500839 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200840 blk_stat = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500841 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400842 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500843 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200844 blk_stat = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500845 } else
846 action = ACTION_FAIL;
847 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400848 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000849 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200850 if (sshdr.asc == 0x10) /* DIF */
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200851 blk_stat = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 break;
853 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700854 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500855 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500857 if (sshdr.asc == 0x04) {
858 switch (sshdr.ascq) {
859 case 0x01: /* becoming ready */
860 case 0x04: /* format in progress */
861 case 0x05: /* rebuild in progress */
862 case 0x06: /* recalculation in progress */
863 case 0x07: /* operation in progress */
864 case 0x08: /* Long write in progress */
865 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500866 case 0x14: /* space allocation in progress */
Douglas Gilberte37c7d92018-05-18 19:25:47 -0400867 case 0x1a: /* start stop unit in progress */
868 case 0x1b: /* sanitize in progress */
869 case 0x1d: /* configuration in progress */
870 case 0x24: /* depopulation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500871 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500872 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500873 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500874 action = ACTION_FAIL;
875 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500876 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200877 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500878 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500879 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700881 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500882 action = ACTION_FAIL;
883 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500885 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 break;
887 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200888 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500889 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500890
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900891 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200892 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900893 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900894
Alan Sternb60af5b2008-11-03 15:56:47 -0500895 switch (action) {
896 case ACTION_FAIL:
897 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200898 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200899 static DEFINE_RATELIMIT_STATE(_rs,
900 DEFAULT_RATELIMIT_INTERVAL,
901 DEFAULT_RATELIMIT_BURST);
902
903 if (unlikely(scsi_logging_level))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200904 level =
905 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
906 SCSI_LOG_MLCOMPLETE_BITS);
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200907
908 /*
909 * if logging is enabled the failure will be printed
910 * in scsi_log_completion(), so avoid duplicate messages
911 */
912 if (!level && __ratelimit(&_rs)) {
913 scsi_print_result(cmd, NULL, FAILED);
914 if (driver_byte(result) & DRIVER_SENSE)
915 scsi_print_sense(cmd);
916 scsi_print_command(cmd);
917 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500918 }
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200919 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req), 0))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800920 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200921 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500922 case ACTION_REPREP:
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200923 scsi_io_completion_reprep(cmd, q);
Alan Sternb60af5b2008-11-03 15:56:47 -0500924 break;
925 case ACTION_RETRY:
926 /* Retry the same command immediately */
Bart Van Assche08640e82018-01-10 14:41:45 -0800927 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500928 break;
929 case ACTION_DELAYED_RETRY:
930 /* Retry the same command after a delay */
Bart Van Assche08640e82018-01-10 14:41:45 -0800931 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500932 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 }
934}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200936/*
937 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
938 * new result that may suppress further error checking. Also modifies
939 * *blk_statp in some cases.
940 */
941static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
942 blk_status_t *blk_statp)
943{
944 bool sense_valid;
945 bool sense_current = true; /* false implies "deferred sense" */
946 struct request *req = cmd->request;
947 struct scsi_sense_hdr sshdr;
948
949 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
950 if (sense_valid)
951 sense_current = !scsi_sense_is_deferred(&sshdr);
952
953 if (blk_rq_is_passthrough(req)) {
954 if (sense_valid) {
955 /*
956 * SG_IO wants current and deferred errors
957 */
958 scsi_req(req)->sense_len =
959 min(8 + cmd->sense_buffer[7],
960 SCSI_SENSE_BUFFERSIZE);
961 }
962 if (sense_current)
963 *blk_statp = scsi_result_to_blk_status(cmd, result);
964 } else if (blk_rq_bytes(req) == 0 && sense_current) {
965 /*
966 * Flush commands do not transfers any data, and thus cannot use
967 * good_bytes != blk_rq_bytes(req) as the signal for an error.
968 * This sets *blk_statp explicitly for the problem case.
969 */
970 *blk_statp = scsi_result_to_blk_status(cmd, result);
971 }
972 /*
973 * Recovered errors need reporting, but they're always treated as
974 * success, so fiddle the result code here. For passthrough requests
975 * we already took a copy of the original into sreq->result which
976 * is what gets returned to the user
977 */
978 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
979 bool do_print = true;
980 /*
981 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
982 * skip print since caller wants ATA registers. Only occurs
983 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
984 */
985 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
986 do_print = false;
987 else if (req->rq_flags & RQF_QUIET)
988 do_print = false;
989 if (do_print)
990 scsi_print_sense(cmd);
991 result = 0;
992 /* for passthrough, *blk_statp may be set */
993 *blk_statp = BLK_STS_OK;
994 }
995 /*
996 * Another corner case: the SCSI status byte is non-zero but 'good'.
997 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
998 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
999 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
1000 * intermediate statuses (both obsolete in SAM-4) as good.
1001 */
1002 if (status_byte(result) && scsi_status_is_good(result)) {
1003 result = 0;
1004 *blk_statp = BLK_STS_OK;
1005 }
1006 return result;
1007}
1008
1009/*
1010 * Function: scsi_io_completion()
1011 *
1012 * Purpose: Completion processing for block device I/O requests.
1013 *
1014 * Arguments: cmd - command that is finished.
1015 *
1016 * Lock status: Assumed that no lock is held upon entry.
1017 *
1018 * Returns: Nothing
1019 *
1020 * Notes: We will finish off the specified number of sectors. If we
1021 * are done, the command block will be released and the queue
1022 * function will be goosed. If we are not done then we have to
1023 * figure out what to do next:
1024 *
1025 * a) We can call scsi_requeue_command(). The request
1026 * will be unprepared and put back on the queue. Then
1027 * a new command will be created for it. This should
1028 * be used if we made forward progress, or if we want
1029 * to switch from READ(10) to READ(6) for example.
1030 *
1031 * b) We can call __scsi_queue_insert(). The request will
1032 * be put back on the queue and retried using the same
1033 * command as before, possibly after a delay.
1034 *
1035 * c) We can call scsi_end_request() with blk_stat other than
1036 * BLK_STS_OK, to fail the remainder of the request.
1037 */
1038void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
1039{
1040 int result = cmd->result;
1041 struct request_queue *q = cmd->device->request_queue;
1042 struct request *req = cmd->request;
1043 blk_status_t blk_stat = BLK_STS_OK;
1044
1045 if (result) /* does not necessarily mean there is an error */
1046 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
1047
1048 if (blk_rq_is_passthrough(req)) {
1049 /*
1050 * scsi_result_to_blk_status may have reset the host_byte
1051 */
1052 scsi_req(req)->result = cmd->result;
1053 scsi_req(req)->resid_len = scsi_get_resid(cmd);
1054
1055 if (scsi_bidi_cmnd(cmd)) {
1056 /*
1057 * Bidi commands Must be complete as a whole,
1058 * both sides at once.
1059 */
1060 scsi_req(req->next_rq)->resid_len = scsi_in(cmd)->resid;
1061 if (scsi_end_request(req, BLK_STS_OK, blk_rq_bytes(req),
1062 blk_rq_bytes(req->next_rq)))
1063 BUG();
1064 return;
1065 }
1066 }
1067
1068 /* no bidi support for !blk_rq_is_passthrough yet */
1069 BUG_ON(blk_bidi_rq(req));
1070
1071 /*
1072 * Next deal with any sectors which we were able to correctly
1073 * handle.
1074 */
1075 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
1076 "%u sectors total, %d bytes done.\n",
1077 blk_rq_sectors(req), good_bytes));
1078
1079 /*
1080 * Next deal with any sectors which we were able to correctly
1081 * handle. Failed, zero length commands always need to drop down
1082 * to retry code. Fast path should return in this block.
1083 */
1084 if (blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK) {
1085 if (!scsi_end_request(req, blk_stat, good_bytes, 0))
1086 return; /* no bytes remaining */
1087 }
1088
1089 /* Kill remainder if no retries. */
1090 if (blk_stat && scsi_noretry_cmd(cmd)) {
1091 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req), 0))
1092 BUG();
1093 return;
1094 }
1095
1096 /*
1097 * If there had been no error, but we have leftover bytes in the
1098 * requeues just queue the command up again.
1099 */
Douglas Gilbert4ae61c62018-06-23 12:22:18 +02001100 if (result == 0)
1101 scsi_io_completion_reprep(cmd, q);
1102 else
Douglas Gilbertda32bae2018-06-23 12:22:17 +02001103 scsi_io_completion_action(cmd, result);
1104}
1105
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001106static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001108 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
1110 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001111 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001113 if (unlikely(sg_alloc_table_chained(&sdb->table,
1114 blk_rq_nr_phys_segments(req), sdb->table.sgl)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 return BLKPREP_DEFER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 /*
1118 * Next, walk the list, and fill in the addresses and sizes of
1119 * each segment.
1120 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001121 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1122 BUG_ON(count > sdb->table.nents);
1123 sdb->table.nents = count;
Christoph Hellwigfd102b12017-01-13 12:29:11 +01001124 sdb->length = blk_rq_payload_bytes(req);
Rusty Russell4a03d902007-11-19 11:28:48 +11001125 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001127
1128/*
1129 * Function: scsi_init_io()
1130 *
1131 * Purpose: SCSI I/O initialize function.
1132 *
1133 * Arguments: cmd - Command descriptor we wish to initialize
1134 *
1135 * Returns: 0 on success
1136 * BLKPREP_DEFER if the failure is retryable
1137 * BLKPREP_KILL if the failure is fatal
1138 */
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001139int scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001140{
Christoph Hellwig5e012aa2014-04-15 12:24:55 +02001141 struct scsi_device *sdev = cmd->device;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001142 struct request *rq = cmd->request;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001143 bool is_mq = (rq->mq_ctx != NULL);
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001144 int error = BLKPREP_KILL;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001145
Johannes Thumshirnfd3fc0b2017-01-31 10:16:00 +01001146 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001147 goto err_exit;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001148
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001149 error = scsi_init_sgtable(rq, &cmd->sdb);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001150 if (error)
1151 goto err_exit;
1152
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001153 if (blk_bidi_rq(rq)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001154 if (!rq->q->mq_ops) {
1155 struct scsi_data_buffer *bidi_sdb =
1156 kmem_cache_zalloc(scsi_sdb_cache, GFP_ATOMIC);
1157 if (!bidi_sdb) {
1158 error = BLKPREP_DEFER;
1159 goto err_exit;
1160 }
1161
1162 rq->next_rq->special = bidi_sdb;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001163 }
1164
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001165 error = scsi_init_sgtable(rq->next_rq, rq->next_rq->special);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001166 if (error)
1167 goto err_exit;
1168 }
1169
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001170 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001171 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1172 int ivecs, count;
1173
Ewan D. Milne91724c22015-01-15 10:02:12 -05001174 if (prot_sdb == NULL) {
1175 /*
1176 * This can happen if someone (e.g. multipath)
1177 * queues a command to a device on an adapter
1178 * that does not support DIX.
1179 */
1180 WARN_ON_ONCE(1);
1181 error = BLKPREP_KILL;
1182 goto err_exit;
1183 }
1184
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001185 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001186
Ming Lin001d63b2016-04-04 14:48:09 -07001187 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lin22cc3d42016-04-04 14:48:08 -07001188 prot_sdb->table.sgl)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001189 error = BLKPREP_DEFER;
1190 goto err_exit;
1191 }
1192
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001193 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001194 prot_sdb->table.sgl);
1195 BUG_ON(unlikely(count > ivecs));
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001196 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001197
1198 cmd->prot_sdb = prot_sdb;
1199 cmd->prot_sdb->table.nents = count;
1200 }
1201
Christoph Hellwigd2852032014-01-17 12:06:53 +01001202 return BLKPREP_OK;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001203err_exit:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001204 if (is_mq) {
1205 scsi_mq_free_sgtables(cmd);
1206 } else {
1207 scsi_release_buffers(cmd);
1208 cmd->request->special = NULL;
1209 scsi_put_command(cmd);
1210 put_device(&sdev->sdev_gendev);
1211 }
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001212 return error;
1213}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001214EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001216/**
Bart Van Assche832889f2017-08-30 16:58:40 -07001217 * scsi_initialize_rq - initialize struct scsi_cmnd partially
Jonathan Corbet35c05062017-08-24 16:11:09 -06001218 * @rq: Request associated with the SCSI command to be initialized.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001219 *
Bart Van Assche832889f2017-08-30 16:58:40 -07001220 * This function initializes the members of struct scsi_cmnd that must be
1221 * initialized before request processing starts and that won't be
1222 * reinitialized if a SCSI command is requeued.
1223 *
Bart Van Assche64104f72017-08-30 16:58:39 -07001224 * Called from inside blk_get_request() for pass-through requests and from
1225 * inside scsi_init_command() for filesystem requests.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001226 */
Bart Van Asschee4c94702017-12-07 15:59:31 -08001227static void scsi_initialize_rq(struct request *rq)
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001228{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001229 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1230
1231 scsi_req_init(&cmd->req);
Bart Van Assche3be88282018-02-22 11:30:20 -08001232 init_rcu_head(&cmd->rcu);
Bart Van Assche832889f2017-08-30 16:58:40 -07001233 cmd->jiffies_at_alloc = jiffies;
1234 cmd->retries = 0;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001235}
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001236
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001237/* Add a command to the list used by the aacraid and dpt_i2o drivers */
1238void scsi_add_cmd_to_list(struct scsi_cmnd *cmd)
1239{
1240 struct scsi_device *sdev = cmd->device;
1241 struct Scsi_Host *shost = sdev->host;
1242 unsigned long flags;
1243
1244 if (shost->use_cmd_list) {
1245 spin_lock_irqsave(&sdev->list_lock, flags);
1246 list_add_tail(&cmd->list, &sdev->cmd_list);
1247 spin_unlock_irqrestore(&sdev->list_lock, flags);
1248 }
1249}
1250
1251/* Remove a command from the list used by the aacraid and dpt_i2o drivers */
1252void scsi_del_cmd_from_list(struct scsi_cmnd *cmd)
1253{
1254 struct scsi_device *sdev = cmd->device;
1255 struct Scsi_Host *shost = sdev->host;
1256 unsigned long flags;
1257
1258 if (shost->use_cmd_list) {
1259 spin_lock_irqsave(&sdev->list_lock, flags);
1260 BUG_ON(list_empty(&cmd->list));
1261 list_del_init(&cmd->list);
1262 spin_unlock_irqrestore(&sdev->list_lock, flags);
1263 }
1264}
1265
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001266/* Called after a request has been started. */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001267void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001268{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001269 void *buf = cmd->sense_buffer;
1270 void *prot = cmd->prot_sdb;
Bart Van Assche64104f72017-08-30 16:58:39 -07001271 struct request *rq = blk_mq_rq_from_pdu(cmd);
1272 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
Bart Van Assche832889f2017-08-30 16:58:40 -07001273 unsigned long jiffies_at_alloc;
1274 int retries;
Bart Van Assche64104f72017-08-30 16:58:39 -07001275
1276 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1277 flags |= SCMD_INITIALIZED;
1278 scsi_initialize_rq(rq);
1279 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001280
Bart Van Assche832889f2017-08-30 16:58:40 -07001281 jiffies_at_alloc = cmd->jiffies_at_alloc;
1282 retries = cmd->retries;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001283 /* zero out the cmd, except for the embedded scsi_request */
1284 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001285 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001286
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001287 cmd->device = dev;
1288 cmd->sense_buffer = buf;
1289 cmd->prot_sdb = prot;
Bart Van Assche64104f72017-08-30 16:58:39 -07001290 cmd->flags = flags;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001291 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
Bart Van Assche832889f2017-08-30 16:58:40 -07001292 cmd->jiffies_at_alloc = jiffies_at_alloc;
1293 cmd->retries = retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001294
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001295 scsi_add_cmd_to_list(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001296}
1297
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001298static int scsi_setup_scsi_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001299{
Bart Van Asschebed22132017-08-25 13:46:32 -07001300 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001301
1302 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001303 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001304 * a bio attached to them. Or they might contain a SCSI command
1305 * that does not transfer data, in which case they may optionally
1306 * submit a request without an attached bio.
1307 */
1308 if (req->bio) {
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001309 int ret = scsi_init_io(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001310 if (unlikely(ret))
1311 return ret;
1312 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001313 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001314
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001315 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001316 }
James Bottomley7b163182005-12-15 20:17:02 -06001317
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001318 cmd->cmd_len = scsi_req(req)->cmd_len;
1319 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001320 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001321 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001322 return BLKPREP_OK;
1323}
1324
1325/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001326 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001327 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001328 */
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001329static int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001330{
Bart Van Asschebed22132017-08-25 13:46:32 -07001331 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001332
Christoph Hellwigee14c672015-08-27 14:16:59 +02001333 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
1334 int ret = sdev->handler->prep_fn(sdev, req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001335 if (ret != BLKPREP_OK)
1336 return ret;
1337 }
1338
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001339 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001340 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001341 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001342}
James Bottomley7b163182005-12-15 20:17:02 -06001343
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001344static int scsi_setup_cmnd(struct scsi_device *sdev, struct request *req)
1345{
Bart Van Asschebed22132017-08-25 13:46:32 -07001346 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001347
1348 if (!blk_rq_bytes(req))
1349 cmd->sc_data_direction = DMA_NONE;
1350 else if (rq_data_dir(req) == WRITE)
1351 cmd->sc_data_direction = DMA_TO_DEVICE;
1352 else
1353 cmd->sc_data_direction = DMA_FROM_DEVICE;
1354
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001355 if (blk_rq_is_scsi(req))
1356 return scsi_setup_scsi_cmnd(sdev, req);
1357 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001358 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001359}
1360
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001361static int
1362scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001364 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365
1366 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001367 * If the device is not in running state we will reject some
1368 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001371 switch (sdev->sdev_state) {
1372 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05001373 case SDEV_TRANSPORT_OFFLINE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001374 /*
1375 * If the device is offline we refuse to process any
1376 * commands. The device must be brought online
1377 * before trying any recovery commands.
1378 */
1379 sdev_printk(KERN_ERR, sdev,
1380 "rejecting I/O to offline device\n");
1381 ret = BLKPREP_KILL;
1382 break;
1383 case SDEV_DEL:
1384 /*
1385 * If the device is fully deleted, we refuse to
1386 * process any commands as well.
1387 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001388 sdev_printk(KERN_ERR, sdev,
1389 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001390 ret = BLKPREP_KILL;
1391 break;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001392 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001393 case SDEV_CREATED_BLOCK:
Bart Van Asschebba0bdd2015-03-04 10:31:47 +01001394 ret = BLKPREP_DEFER;
1395 break;
1396 case SDEV_QUIESCE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001397 /*
1398 * If the devices is blocked we defer normal commands.
1399 */
Ming Leiaeec7762017-10-14 17:22:31 +08001400 if (req && !(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001401 ret = BLKPREP_DEFER;
1402 break;
1403 default:
1404 /*
1405 * For any other not fully online state we only allow
1406 * special commands. In particular any user initiated
1407 * command is not allowed.
1408 */
Ming Leiaeec7762017-10-14 17:22:31 +08001409 if (req && !(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001410 ret = BLKPREP_KILL;
1411 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001414 return ret;
1415}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001417static int
1418scsi_prep_return(struct request_queue *q, struct request *req, int ret)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001419{
1420 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421
Christoph Hellwig3b003152006-11-04 20:10:55 +01001422 switch (ret) {
1423 case BLKPREP_KILL:
jiangyiwene1cd3912016-02-16 20:14:13 +08001424 case BLKPREP_INVALID:
Christoph Hellwig17d53632017-04-20 16:03:01 +02001425 scsi_req(req)->result = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001426 /* release the command and kill it */
1427 if (req->special) {
1428 struct scsi_cmnd *cmd = req->special;
1429 scsi_release_buffers(cmd);
1430 scsi_put_command(cmd);
Christoph Hellwig68c03d92014-04-15 12:24:56 +02001431 put_device(&sdev->sdev_gendev);
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001432 req->special = NULL;
1433 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001434 break;
1435 case BLKPREP_DEFER:
1436 /*
Tejun Heo9934c8c2009-05-08 11:54:16 +09001437 * If we defer, the blk_peek_request() returns NULL, but the
Jens Axboea488e742010-04-16 21:13:15 +02001438 * queue must be restarted, so we schedule a callback to happen
1439 * shortly.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001440 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001441 if (atomic_read(&sdev->device_busy) == 0)
Jens Axboea488e742010-04-16 21:13:15 +02001442 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001443 break;
1444 default:
Christoph Hellwige8064022016-10-20 15:12:13 +02001445 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001446 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447
Christoph Hellwig3b003152006-11-04 20:10:55 +01001448 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001450
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001451static int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001452{
1453 struct scsi_device *sdev = q->queuedata;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001454 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001455 int ret;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001456
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001457 ret = scsi_prep_state_check(sdev, req);
1458 if (ret != BLKPREP_OK)
1459 goto out;
1460
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001461 if (!req->special) {
1462 /* Bail if we can't get a reference to the device */
1463 if (unlikely(!get_device(&sdev->sdev_gendev))) {
1464 ret = BLKPREP_DEFER;
1465 goto out;
1466 }
1467
1468 scsi_init_command(sdev, cmd);
1469 req->special = cmd;
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001470 }
1471
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001472 cmd->tag = req->tag;
1473 cmd->request = req;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001474 cmd->prot_op = SCSI_PROT_NORMAL;
1475
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001476 ret = scsi_setup_cmnd(sdev, req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001477out:
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001478 return scsi_prep_return(q, req, ret);
1479}
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001480
1481static void scsi_unprep_fn(struct request_queue *q, struct request *req)
1482{
Bart Van Asschebed22132017-08-25 13:46:32 -07001483 scsi_uninit_cmd(blk_mq_rq_to_pdu(req));
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001484}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485
1486/*
1487 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1488 * return 0.
1489 *
1490 * Called with the queue_lock held.
1491 */
1492static inline int scsi_dev_queue_ready(struct request_queue *q,
1493 struct scsi_device *sdev)
1494{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001495 unsigned int busy;
1496
1497 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001498 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001499 if (busy)
1500 goto out_dec;
1501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 /*
1503 * unblock after device_blocked iterates to zero
1504 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001505 if (atomic_dec_return(&sdev->device_blocked) > 0) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001506 /*
1507 * For the MQ case we take care of this in the caller.
1508 */
1509 if (!q->mq_ops)
1510 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001511 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001513 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1514 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001516
1517 if (busy >= sdev->queue_depth)
1518 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519
1520 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001521out_dec:
1522 atomic_dec(&sdev->device_busy);
1523 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524}
1525
Mike Christief0c0a372008-08-17 15:24:38 -05001526/*
1527 * scsi_target_queue_ready: checks if there we can send commands to target
1528 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001529 */
1530static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1531 struct scsi_device *sdev)
1532{
1533 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001534 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001535
1536 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001537 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001538 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001539 starget->starget_sdev_user != sdev) {
1540 spin_unlock_irq(shost->host_lock);
1541 return 0;
1542 }
Mike Christief0c0a372008-08-17 15:24:38 -05001543 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001544 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001545 }
1546
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001547 if (starget->can_queue <= 0)
1548 return 1;
1549
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001550 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001551 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001552 if (busy)
1553 goto starved;
1554
Mike Christief0c0a372008-08-17 15:24:38 -05001555 /*
1556 * unblock after target_blocked iterates to zero
1557 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001558 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001559 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001560
1561 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1562 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001563 }
1564
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001565 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001566 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001567
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001568 return 1;
1569
1570starved:
1571 spin_lock_irq(shost->host_lock);
1572 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001573 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001574out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001575 if (starget->can_queue > 0)
1576 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001577 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001578}
1579
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580/*
1581 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1582 * return 0. We must end up running the queue again whenever 0 is
1583 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 */
1585static inline int scsi_host_queue_ready(struct request_queue *q,
1586 struct Scsi_Host *shost,
1587 struct scsi_device *sdev)
1588{
Christoph Hellwig74665012014-01-22 15:29:29 +01001589 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001590
James Bottomley939647e2005-09-18 15:05:20 -05001591 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001592 return 0;
1593
1594 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001595 if (atomic_read(&shost->host_blocked) > 0) {
Christoph Hellwig74665012014-01-22 15:29:29 +01001596 if (busy)
1597 goto starved;
1598
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 /*
1600 * unblock after host_blocked iterates to zero
1601 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001602 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001603 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001604
1605 SCSI_LOG_MLQUEUE(3,
1606 shost_printk(KERN_INFO, shost,
1607 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001609
1610 if (shost->can_queue > 0 && busy >= shost->can_queue)
1611 goto starved;
1612 if (shost->host_self_blocked)
1613 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614
1615 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001616 if (!list_empty(&sdev->starved_entry)) {
1617 spin_lock_irq(shost->host_lock);
1618 if (!list_empty(&sdev->starved_entry))
1619 list_del_init(&sdev->starved_entry);
1620 spin_unlock_irq(shost->host_lock);
1621 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
Christoph Hellwig74665012014-01-22 15:29:29 +01001623 return 1;
1624
1625starved:
1626 spin_lock_irq(shost->host_lock);
1627 if (list_empty(&sdev->starved_entry))
1628 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001629 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001630out_dec:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001631 scsi_dec_host_busy(shost);
Christoph Hellwig74665012014-01-22 15:29:29 +01001632 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633}
1634
1635/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001636 * Busy state exporting function for request stacking drivers.
1637 *
1638 * For efficiency, no lock is taken to check the busy state of
1639 * shost/starget/sdev, since the returned value is not guaranteed and
1640 * may be changed after request stacking drivers call the function,
1641 * regardless of taking lock or not.
1642 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001643 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1644 * needs to return 'not busy'. Otherwise, request stacking drivers
1645 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001646 */
1647static int scsi_lld_busy(struct request_queue *q)
1648{
1649 struct scsi_device *sdev = q->queuedata;
1650 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001651
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001652 if (blk_queue_dying(q))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001653 return 0;
1654
1655 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001656
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001657 /*
1658 * Ignore host/starget busy state.
1659 * Since block layer does not have a concept of fairness across
1660 * multiple queues, congestion of host/starget needs to be handled
1661 * in SCSI layer.
1662 */
1663 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001664 return 1;
1665
1666 return 0;
1667}
1668
1669/*
James Bottomleye91442b2005-09-09 10:44:16 -05001670 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 */
Jens Axboe165125e2007-07-24 09:28:11 +02001672static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673{
Bart Van Asschebed22132017-08-25 13:46:32 -07001674 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Jiri Slaby03b14702009-09-23 16:15:35 +02001675 struct scsi_device *sdev;
1676 struct scsi_target *starget;
1677 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678
Tejun Heo9934c8c2009-05-08 11:54:16 +09001679 blk_start_request(req);
James Bottomley788ce432005-09-09 13:40:23 -05001680
Hannes Reinecke74571812011-11-09 08:39:24 +01001681 scmd_printk(KERN_INFO, cmd, "killing request\n");
1682
Jiri Slaby03b14702009-09-23 16:15:35 +02001683 sdev = cmd->device;
1684 starget = scsi_target(sdev);
1685 shost = sdev->host;
James Bottomleye91442b2005-09-09 10:44:16 -05001686 scsi_init_cmd_errh(cmd);
1687 cmd->result = DID_NO_CONNECT << 16;
1688 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001689
1690 /*
1691 * SCSI request completion path will do scsi_device_unbusy(),
1692 * bump busy counts. To bump the counters, we need to dance
1693 * with the locks as normal issue path does.
1694 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001695 atomic_inc(&sdev->device_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +01001696 atomic_inc(&shost->host_busy);
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001697 if (starget->can_queue > 0)
1698 atomic_inc(&starget->target_busy);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001699
Jens Axboe242f9dc2008-09-14 05:55:09 -07001700 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701}
1702
Jens Axboe1aea6432006-01-09 16:03:03 +01001703static void scsi_softirq_done(struct request *rq)
1704{
Bart Van Asschebed22132017-08-25 13:46:32 -07001705 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001706 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001707 int disposition;
1708
1709 INIT_LIST_HEAD(&cmd->eh_entry);
1710
Jens Axboe242f9dc2008-09-14 05:55:09 -07001711 atomic_inc(&cmd->device->iodone_cnt);
1712 if (cmd->result)
1713 atomic_inc(&cmd->device->ioerr_cnt);
1714
Jens Axboe1aea6432006-01-09 16:03:03 +01001715 disposition = scsi_decide_disposition(cmd);
1716 if (disposition != SUCCESS &&
1717 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1718 sdev_printk(KERN_ERR, cmd->device,
1719 "timing out command, waited %lus\n",
1720 wait_for/HZ);
1721 disposition = SUCCESS;
1722 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001723
Jens Axboe1aea6432006-01-09 16:03:03 +01001724 scsi_log_completion(cmd, disposition);
1725
1726 switch (disposition) {
1727 case SUCCESS:
1728 scsi_finish_command(cmd);
1729 break;
1730 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001731 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001732 break;
1733 case ADD_TO_MLQUEUE:
1734 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1735 break;
1736 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001737 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001738 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001739 }
1740}
1741
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001742/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001743 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1744 * @cmd: command block we are dispatching.
1745 *
1746 * Return: nonzero return request was rejected and device's queue needs to be
1747 * plugged.
1748 */
1749static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1750{
1751 struct Scsi_Host *host = cmd->device->host;
1752 int rtn = 0;
1753
1754 atomic_inc(&cmd->device->iorequest_cnt);
1755
1756 /* check if the device is still usable */
1757 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1758 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1759 * returns an immediate error upwards, and signals
1760 * that the device is no longer present */
1761 cmd->result = DID_NO_CONNECT << 16;
1762 goto done;
1763 }
1764
1765 /* Check to see if the scsi lld made this device blocked. */
1766 if (unlikely(scsi_device_blocked(cmd->device))) {
1767 /*
1768 * in blocked state, the command is just put back on
1769 * the device queue. The suspend state has already
1770 * blocked the queue so future requests should not
1771 * occur until the device transitions out of the
1772 * suspend state.
1773 */
1774 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1775 "queuecommand : device blocked\n"));
1776 return SCSI_MLQUEUE_DEVICE_BUSY;
1777 }
1778
1779 /* Store the LUN value in cmnd, if needed. */
1780 if (cmd->device->lun_in_cdb)
1781 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1782 (cmd->device->lun << 5 & 0xe0);
1783
1784 scsi_log_send(cmd);
1785
1786 /*
1787 * Before we queue this command, check if the command
1788 * length exceeds what the host adapter can handle.
1789 */
1790 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1791 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1792 "queuecommand : command too long. "
1793 "cdb_size=%d host->max_cmd_len=%d\n",
1794 cmd->cmd_len, cmd->device->host->max_cmd_len));
1795 cmd->result = (DID_ABORT << 16);
1796 goto done;
1797 }
1798
1799 if (unlikely(host->shost_state == SHOST_DEL)) {
1800 cmd->result = (DID_NO_CONNECT << 16);
1801 goto done;
1802
1803 }
1804
1805 trace_scsi_dispatch_cmd_start(cmd);
1806 rtn = host->hostt->queuecommand(host, cmd);
1807 if (rtn) {
1808 trace_scsi_dispatch_cmd_error(cmd, rtn);
1809 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1810 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1811 rtn = SCSI_MLQUEUE_HOST_BUSY;
1812
1813 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1814 "queuecommand : request rejected\n"));
1815 }
1816
1817 return rtn;
1818 done:
1819 cmd->scsi_done(cmd);
1820 return 0;
1821}
1822
1823/**
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001824 * scsi_done - Invoke completion on finished SCSI command.
1825 * @cmd: The SCSI Command for which a low-level device driver (LLDD) gives
1826 * ownership back to SCSI Core -- i.e. the LLDD has finished with it.
1827 *
1828 * Description: This function is the mid-level's (SCSI Core) interrupt routine,
1829 * which regains ownership of the SCSI command (de facto) from a LLDD, and
1830 * calls blk_complete_request() for further processing.
1831 *
1832 * This function is interrupt context safe.
1833 */
1834static void scsi_done(struct scsi_cmnd *cmd)
1835{
1836 trace_scsi_dispatch_cmd_done(cmd);
1837 blk_complete_request(cmd->request);
1838}
1839
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840/*
1841 * Function: scsi_request_fn()
1842 *
1843 * Purpose: Main strategy routine for SCSI.
1844 *
1845 * Arguments: q - Pointer to actual queue.
1846 *
1847 * Returns: Nothing
1848 *
Damien Le Moale98f42b2017-10-11 05:54:22 +09001849 * Lock status: request queue lock assumed to be held when called.
1850 *
1851 * Note: See sd_zbc.c sd_zbc_write_lock_zone() for write order
1852 * protection for ZBC disks.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 */
1854static void scsi_request_fn(struct request_queue *q)
Bart Van Assche613be1f2014-02-20 14:20:56 -08001855 __releases(q->queue_lock)
1856 __acquires(q->queue_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857{
1858 struct scsi_device *sdev = q->queuedata;
1859 struct Scsi_Host *shost;
1860 struct scsi_cmnd *cmd;
1861 struct request *req;
1862
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 /*
1864 * To start with, we keep looping until the queue is empty, or until
1865 * the host is no longer able to accept any more requests.
1866 */
1867 shost = sdev->host;
Jens Axboea488e742010-04-16 21:13:15 +02001868 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 int rtn;
1870 /*
1871 * get next queueable request. We do this early to make sure
Hannes Reinecke91921e02014-06-25 16:39:59 +02001872 * that the request is fully prepared even if we cannot
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 * accept it.
1874 */
Tejun Heo9934c8c2009-05-08 11:54:16 +09001875 req = blk_peek_request(q);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001876 if (!req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 break;
1878
1879 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001880 sdev_printk(KERN_ERR, sdev,
1881 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001882 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 continue;
1884 }
1885
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001886 if (!scsi_dev_queue_ready(q, sdev))
1887 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888
1889 /*
1890 * Remove the request from the request list.
1891 */
1892 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
Tejun Heo9934c8c2009-05-08 11:54:16 +09001893 blk_start_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001895 spin_unlock_irq(q->queue_lock);
Bart Van Asschebed22132017-08-25 13:46:32 -07001896 cmd = blk_mq_rq_to_pdu(req);
1897 if (cmd != req->special) {
James Bottomleye91442b2005-09-09 10:44:16 -05001898 printk(KERN_CRIT "impossible request in %s.\n"
1899 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001900 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001901 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001902 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001903 BUG();
1904 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905
Mike Christieecefe8a2008-07-11 19:50:35 -05001906 /*
1907 * We hit this when the driver is using a host wide
1908 * tag map. For device level tag maps the queue_depth check
1909 * in the device ready fn would prevent us from trying
1910 * to allocate a tag. Since the map is a shared host resource
1911 * we add the dev to the starved list so it eventually gets
1912 * a run when a tag is freed.
1913 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001914 if (blk_queue_tagged(q) && !(req->rq_flags & RQF_QUEUED)) {
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001915 spin_lock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001916 if (list_empty(&sdev->starved_entry))
1917 list_add_tail(&sdev->starved_entry,
1918 &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001919 spin_unlock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001920 goto not_ready;
1921 }
1922
Mike Christief0c0a372008-08-17 15:24:38 -05001923 if (!scsi_target_queue_ready(shost, sdev))
1924 goto not_ready;
1925
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 if (!scsi_host_queue_ready(q, shost, sdev))
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001927 goto host_not_ready;
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001928
1929 if (sdev->simple_tags)
1930 cmd->flags |= SCMD_TAGGED;
1931 else
1932 cmd->flags &= ~SCMD_TAGGED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 /*
1935 * Finally, initialize any error handling parameters, and set up
1936 * the timers for timeouts.
1937 */
1938 scsi_init_cmd_errh(cmd);
1939
1940 /*
1941 * Dispatch the command to the low-level driver.
1942 */
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001943 cmd->scsi_done = scsi_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 rtn = scsi_dispatch_cmd(cmd);
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001945 if (rtn) {
1946 scsi_queue_insert(cmd, rtn);
1947 spin_lock_irq(q->queue_lock);
Jens Axboea488e742010-04-16 21:13:15 +02001948 goto out_delay;
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001949 }
1950 spin_lock_irq(q->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 }
1952
Bart Van Assche613be1f2014-02-20 14:20:56 -08001953 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001955 host_not_ready:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001956 if (scsi_target(sdev)->can_queue > 0)
1957 atomic_dec(&scsi_target(sdev)->target_busy);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001958 not_ready:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 /*
1960 * lock q, handle tag, requeue req, and decrement device_busy. We
1961 * must return with queue_lock held.
1962 *
1963 * Decrementing device_busy without checking it is OK, as all such
1964 * cases (host limits or settings) should run the queue at some
1965 * later time.
1966 */
1967 spin_lock_irq(q->queue_lock);
1968 blk_requeue_request(q, req);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001969 atomic_dec(&sdev->device_busy);
Jens Axboea488e742010-04-16 21:13:15 +02001970out_delay:
Guenter Roeck480cadc2014-08-10 05:54:25 -07001971 if (!atomic_read(&sdev->device_busy) && !scsi_device_blocked(sdev))
Jens Axboea488e742010-04-16 21:13:15 +02001972 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973}
1974
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001975static inline blk_status_t prep_to_mq(int ret)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001976{
1977 switch (ret) {
1978 case BLKPREP_OK:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001979 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001980 case BLKPREP_DEFER:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001981 return BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001982 default:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001983 return BLK_STS_IOERR;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001984 }
1985}
1986
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001987/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
1988static unsigned int scsi_mq_sgl_size(struct Scsi_Host *shost)
1989{
1990 return min_t(unsigned int, shost->sg_tablesize, SG_CHUNK_SIZE) *
1991 sizeof(struct scatterlist);
1992}
1993
Christoph Hellwigd2852032014-01-17 12:06:53 +01001994static int scsi_mq_prep_fn(struct request *req)
1995{
1996 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1997 struct scsi_device *sdev = req->q->queuedata;
1998 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001999 struct scatterlist *sg;
2000
Bart Van Assche08f78432017-06-02 14:22:00 -07002001 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002002
2003 req->special = cmd;
2004
2005 cmd->request = req;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002006
2007 cmd->tag = req->tag;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002008 cmd->prot_op = SCSI_PROT_NORMAL;
2009
Christoph Hellwigd2852032014-01-17 12:06:53 +01002010 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
2011 cmd->sdb.table.sgl = sg;
2012
2013 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01002014 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
2015
2016 cmd->prot_sdb->table.sgl =
2017 (struct scatterlist *)(cmd->prot_sdb + 1);
2018 }
2019
2020 if (blk_bidi_rq(req)) {
2021 struct request *next_rq = req->next_rq;
2022 struct scsi_data_buffer *bidi_sdb = blk_mq_rq_to_pdu(next_rq);
2023
2024 memset(bidi_sdb, 0, sizeof(struct scsi_data_buffer));
2025 bidi_sdb->table.sgl =
2026 (struct scatterlist *)(bidi_sdb + 1);
2027
2028 next_rq->special = bidi_sdb;
2029 }
2030
Christoph Hellwigfe052522014-09-22 15:59:31 +02002031 blk_mq_start_request(req);
2032
Bart Van Assche8fe8ffb2017-10-20 11:46:45 -07002033 return scsi_setup_cmnd(sdev, req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002034}
2035
2036static void scsi_mq_done(struct scsi_cmnd *cmd)
2037{
2038 trace_scsi_dispatch_cmd_done(cmd);
Christoph Hellwig08e00292017-04-20 16:03:09 +02002039 blk_mq_complete_request(cmd->request);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002040}
2041
Ming Lei0df21c82017-10-14 17:22:32 +08002042static void scsi_mq_put_budget(struct blk_mq_hw_ctx *hctx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002043{
Ming Lei0df21c82017-10-14 17:22:32 +08002044 struct request_queue *q = hctx->queue;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002045 struct scsi_device *sdev = q->queuedata;
Ming Lei0df21c82017-10-14 17:22:32 +08002046
Ming Lei0df21c82017-10-14 17:22:32 +08002047 atomic_dec(&sdev->device_busy);
2048 put_device(&sdev->sdev_gendev);
2049}
2050
Ming Lei88022d72017-11-05 02:21:12 +08002051static bool scsi_mq_get_budget(struct blk_mq_hw_ctx *hctx)
Ming Lei0df21c82017-10-14 17:22:32 +08002052{
2053 struct request_queue *q = hctx->queue;
2054 struct scsi_device *sdev = q->queuedata;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002055
Christoph Hellwigd2852032014-01-17 12:06:53 +01002056 if (!get_device(&sdev->sdev_gendev))
2057 goto out;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002058 if (!scsi_dev_queue_ready(q, sdev))
2059 goto out_put_device;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002060
Ming Lei88022d72017-11-05 02:21:12 +08002061 return true;
Ming Lei0df21c82017-10-14 17:22:32 +08002062
Ming Lei0df21c82017-10-14 17:22:32 +08002063out_put_device:
2064 put_device(&sdev->sdev_gendev);
2065out:
Ming Lei7e70aa72017-12-05 15:52:56 +08002066 if (atomic_read(&sdev->device_busy) == 0 && !scsi_device_blocked(sdev))
2067 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Ming Lei88022d72017-11-05 02:21:12 +08002068 return false;
Ming Lei0df21c82017-10-14 17:22:32 +08002069}
2070
Christoph Hellwigd2852032014-01-17 12:06:53 +01002071static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
2072 const struct blk_mq_queue_data *bd)
2073{
2074 struct request *req = bd->rq;
2075 struct request_queue *q = req->q;
2076 struct scsi_device *sdev = q->queuedata;
2077 struct Scsi_Host *shost = sdev->host;
2078 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
2079 blk_status_t ret;
2080 int reason;
2081
2082 ret = prep_to_mq(scsi_prep_state_check(sdev, req));
2083 if (ret != BLK_STS_OK)
Ming Lei0df21c82017-10-14 17:22:32 +08002084 goto out_put_budget;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002085
2086 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002087 if (!scsi_target_queue_ready(shost, sdev))
Ming Lei826a70a2017-11-04 09:55:34 +08002088 goto out_put_budget;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002089 if (!scsi_host_queue_ready(q, shost, sdev))
2090 goto out_dec_target_busy;
2091
Christoph Hellwige8064022016-10-20 15:12:13 +02002092 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01002093 ret = prep_to_mq(scsi_mq_prep_fn(req));
Christoph Hellwigfc17b652017-06-03 09:38:05 +02002094 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002095 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02002096 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02002097 } else {
2098 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002099 }
2100
Christoph Hellwig125c99b2014-11-03 12:47:47 +01002101 if (sdev->simple_tags)
2102 cmd->flags |= SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02002103 else
Christoph Hellwig125c99b2014-11-03 12:47:47 +01002104 cmd->flags &= ~SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02002105
Christoph Hellwigd2852032014-01-17 12:06:53 +01002106 scsi_init_cmd_errh(cmd);
2107 cmd->scsi_done = scsi_mq_done;
2108
2109 reason = scsi_dispatch_cmd(cmd);
2110 if (reason) {
2111 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02002112 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002113 goto out_dec_host_busy;
2114 }
2115
Christoph Hellwigfc17b652017-06-03 09:38:05 +02002116 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002117
2118out_dec_host_busy:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08002119 scsi_dec_host_busy(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002120out_dec_target_busy:
2121 if (scsi_target(sdev)->can_queue > 0)
2122 atomic_dec(&scsi_target(sdev)->target_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08002123out_put_budget:
2124 scsi_mq_put_budget(hctx);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002125 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02002126 case BLK_STS_OK:
2127 break;
2128 case BLK_STS_RESOURCE:
Ming Lei86ff7c22018-01-30 22:04:57 -05002129 if (atomic_read(&sdev->device_busy) ||
2130 scsi_device_blocked(sdev))
2131 ret = BLK_STS_DEV_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002132 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02002133 default:
Christoph Hellwigd2852032014-01-17 12:06:53 +01002134 /*
2135 * Make sure to release all allocated ressources when
2136 * we hit an error, as we will never see this command
2137 * again.
2138 */
Christoph Hellwige8064022016-10-20 15:12:13 +02002139 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002140 scsi_mq_uninit_cmd(cmd);
2141 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002142 }
2143 return ret;
2144}
2145
Christoph Hellwig0152fb62014-09-13 16:40:13 -07002146static enum blk_eh_timer_return scsi_timeout(struct request *req,
2147 bool reserved)
2148{
2149 if (reserved)
2150 return BLK_EH_RESET_TIMER;
2151 return scsi_times_out(req);
2152}
2153
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002154static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
2155 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002156{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002157 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07002158 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002159 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07002160 struct scatterlist *sg;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002161
Bart Van Assche8e688252017-06-02 14:21:52 -07002162 if (unchecked_isa_dma)
2163 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
2164 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
2165 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002166 if (!cmd->sense_buffer)
2167 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002168 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07002169
2170 if (scsi_host_get_prot(shost)) {
2171 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
2172 shost->hostt->cmd_size;
2173 cmd->prot_sdb = (void *)sg + scsi_mq_sgl_size(shost);
2174 }
2175
Christoph Hellwigd2852032014-01-17 12:06:53 +01002176 return 0;
2177}
2178
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002179static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
2180 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002181{
2182 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2183
Bart Van Assche8e688252017-06-02 14:21:52 -07002184 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
2185 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002186}
2187
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002188static int scsi_map_queues(struct blk_mq_tag_set *set)
2189{
2190 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
2191
2192 if (shost->hostt->map_queues)
2193 return shost->hostt->map_queues(shost);
2194 return blk_mq_map_queues(set);
2195}
2196
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002197void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198{
Lin Ming6f381fa2012-04-12 13:50:38 +08002199 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200
Jens Axboea8474ce2007-08-07 09:02:51 +02002201 /*
2202 * this limit is imposed by hardware restrictions
2203 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05002204 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07002205 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02002206
Martin K. Petersen13f05c82010-09-10 20:50:10 +02002207 if (scsi_host_prot_dma(shost)) {
2208 shost->sg_prot_tablesize =
2209 min_not_zero(shost->sg_prot_tablesize,
2210 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
2211 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
2212 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
2213 }
2214
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05002215 blk_queue_max_hw_sectors(q, shost->max_sectors);
Christoph Hellwig21e07db2018-04-03 19:09:59 +02002216 if (shost->unchecked_isa_dma)
2217 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08002219 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220
FUJITA Tomonori860ac562008-02-04 22:28:05 -08002221 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
2222
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01002224 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06002225
2226 /*
Huacai Chen90addc62017-11-21 14:23:38 +01002227 * Set a reasonable default alignment: The larger of 32-byte (dword),
2228 * which is a common minimum for HBAs, and the minimum DMA alignment,
2229 * which is set by the platform.
2230 *
2231 * Devices that require a bigger alignment can increase it later.
James Bottomley465ff312008-01-01 10:00:10 -06002232 */
Huacai Chen90addc62017-11-21 14:23:38 +01002233 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002234}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002235EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06002236
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002237static int scsi_old_init_rq(struct request_queue *q, struct request *rq,
2238 gfp_t gfp)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002239{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002240 struct Scsi_Host *shost = q->rq_alloc_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07002241 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002242 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002243
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002244 memset(cmd, 0, sizeof(*cmd));
2245
Bart Van Assche8e688252017-06-02 14:21:52 -07002246 if (unchecked_isa_dma)
2247 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
2248 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma, gfp,
2249 NUMA_NO_NODE);
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002250 if (!cmd->sense_buffer)
2251 goto fail;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002252 cmd->req.sense = cmd->sense_buffer;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002253
2254 if (scsi_host_get_prot(shost) >= SHOST_DIX_TYPE0_PROTECTION) {
2255 cmd->prot_sdb = kmem_cache_zalloc(scsi_sdb_cache, gfp);
2256 if (!cmd->prot_sdb)
2257 goto fail_free_sense;
2258 }
2259
2260 return 0;
2261
2262fail_free_sense:
Bart Van Assche8e688252017-06-02 14:21:52 -07002263 scsi_free_sense_buffer(unchecked_isa_dma, cmd->sense_buffer);
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002264fail:
2265 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266}
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002267
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002268static void scsi_old_exit_rq(struct request_queue *q, struct request *rq)
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002269{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002270 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2271
2272 if (cmd->prot_sdb)
2273 kmem_cache_free(scsi_sdb_cache, cmd->prot_sdb);
Bart Van Assche8e688252017-06-02 14:21:52 -07002274 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
2275 cmd->sense_buffer);
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002276}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002277
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002278struct request_queue *scsi_old_alloc_queue(struct scsi_device *sdev)
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002279{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002280 struct Scsi_Host *shost = sdev->host;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002281 struct request_queue *q;
2282
Bart Van Assche5ee05242018-02-28 10:15:31 -08002283 q = blk_alloc_queue_node(GFP_KERNEL, NUMA_NO_NODE, NULL);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002284 if (!q)
2285 return NULL;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002286 q->cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
2287 q->rq_alloc_data = shost;
2288 q->request_fn = scsi_request_fn;
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002289 q->init_rq_fn = scsi_old_init_rq;
2290 q->exit_rq_fn = scsi_old_exit_rq;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07002291 q->initialize_rq_fn = scsi_initialize_rq;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002292
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002293 if (blk_init_allocated_queue(q) < 0) {
2294 blk_cleanup_queue(q);
2295 return NULL;
2296 }
2297
2298 __scsi_init_queue(shost, q);
Christoph Hellwig17cb9602018-03-13 17:28:41 +01002299 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, q);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002300 blk_queue_prep_rq(q, scsi_prep_fn);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02002301 blk_queue_unprep_rq(q, scsi_unprep_fn);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002302 blk_queue_softirq_done(q, scsi_softirq_done);
Jens Axboe242f9dc2008-09-14 05:55:09 -07002303 blk_queue_rq_timed_out(q, scsi_times_out);
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04002304 blk_queue_lld_busy(q, scsi_lld_busy);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002305 return q;
2306}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307
Eric Biggersf363b082017-03-30 13:39:16 -07002308static const struct blk_mq_ops scsi_mq_ops = {
Ming Lei0df21c82017-10-14 17:22:32 +08002309 .get_budget = scsi_mq_get_budget,
2310 .put_budget = scsi_mq_put_budget,
Christoph Hellwigd2852032014-01-17 12:06:53 +01002311 .queue_rq = scsi_queue_rq,
2312 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07002313 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07002314#ifdef CONFIG_BLK_DEBUG_FS
2315 .show_rq = scsi_show_rq,
2316#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002317 .init_request = scsi_mq_init_request,
2318 .exit_request = scsi_mq_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07002319 .initialize_rq_fn = scsi_initialize_rq,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002320 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01002321};
2322
2323struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
2324{
2325 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
2326 if (IS_ERR(sdev->request_queue))
2327 return NULL;
2328
2329 sdev->request_queue->queuedata = sdev;
2330 __scsi_init_queue(sdev->host, sdev->request_queue);
Christoph Hellwig17cb9602018-03-13 17:28:41 +01002331 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002332 return sdev->request_queue;
2333}
2334
2335int scsi_mq_setup_tags(struct Scsi_Host *shost)
2336{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07002337 unsigned int cmd_size, sgl_size;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002338
Bart Van Asschebe4c1862017-06-02 14:21:59 -07002339 sgl_size = scsi_mq_sgl_size(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002340 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
2341 if (scsi_host_get_prot(shost))
2342 cmd_size += sizeof(struct scsi_data_buffer) + sgl_size;
2343
2344 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
2345 shost->tag_set.ops = &scsi_mq_ops;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01002346 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002347 shost->tag_set.queue_depth = shost->can_queue;
2348 shost->tag_set.cmd_size = cmd_size;
2349 shost->tag_set.numa_node = NUMA_NO_NODE;
2350 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07002351 shost->tag_set.flags |=
2352 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002353 shost->tag_set.driver_data = shost;
2354
2355 return blk_mq_alloc_tag_set(&shost->tag_set);
2356}
2357
2358void scsi_mq_destroy_tags(struct Scsi_Host *shost)
2359{
2360 blk_mq_free_tag_set(&shost->tag_set);
2361}
2362
Hannes Reinecke857de6e2017-02-17 09:02:45 +01002363/**
2364 * scsi_device_from_queue - return sdev associated with a request_queue
2365 * @q: The request queue to return the sdev from
2366 *
2367 * Return the sdev associated with a request queue or NULL if the
2368 * request_queue does not reference a SCSI device.
2369 */
2370struct scsi_device *scsi_device_from_queue(struct request_queue *q)
2371{
2372 struct scsi_device *sdev = NULL;
2373
2374 if (q->mq_ops) {
2375 if (q->mq_ops == &scsi_mq_ops)
2376 sdev = q->queuedata;
2377 } else if (q->request_fn == scsi_request_fn)
2378 sdev = q->queuedata;
2379 if (!sdev || !get_device(&sdev->sdev_gendev))
2380 sdev = NULL;
2381
2382 return sdev;
2383}
2384EXPORT_SYMBOL_GPL(scsi_device_from_queue);
2385
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386/*
2387 * Function: scsi_block_requests()
2388 *
2389 * Purpose: Utility function used by low-level drivers to prevent further
2390 * commands from being queued to the device.
2391 *
2392 * Arguments: shost - Host in question
2393 *
2394 * Returns: Nothing
2395 *
2396 * Lock status: No locks are assumed held.
2397 *
2398 * Notes: There is no timer nor any other means by which the requests
2399 * get unblocked other than the low-level driver calling
2400 * scsi_unblock_requests().
2401 */
2402void scsi_block_requests(struct Scsi_Host *shost)
2403{
2404 shost->host_self_blocked = 1;
2405}
2406EXPORT_SYMBOL(scsi_block_requests);
2407
2408/*
2409 * Function: scsi_unblock_requests()
2410 *
2411 * Purpose: Utility function used by low-level drivers to allow further
2412 * commands from being queued to the device.
2413 *
2414 * Arguments: shost - Host in question
2415 *
2416 * Returns: Nothing
2417 *
2418 * Lock status: No locks are assumed held.
2419 *
2420 * Notes: There is no timer nor any other means by which the requests
2421 * get unblocked other than the low-level driver calling
2422 * scsi_unblock_requests().
2423 *
2424 * This is done as an API function so that changes to the
2425 * internals of the scsi mid-layer won't require wholesale
2426 * changes to drivers that use this feature.
2427 */
2428void scsi_unblock_requests(struct Scsi_Host *shost)
2429{
2430 shost->host_self_blocked = 0;
2431 scsi_run_host_queues(shost);
2432}
2433EXPORT_SYMBOL(scsi_unblock_requests);
2434
2435int __init scsi_init_queue(void)
2436{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002437 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
2438 sizeof(struct scsi_data_buffer),
2439 0, 0, NULL);
2440 if (!scsi_sdb_cache) {
2441 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09002442 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02002443 }
2444
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445 return 0;
2446}
2447
2448void scsi_exit_queue(void)
2449{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002450 kmem_cache_destroy(scsi_sense_cache);
2451 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002452 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453}
James Bottomley5baba832006-03-18 14:10:35 -06002454
2455/**
2456 * scsi_mode_select - issue a mode select
2457 * @sdev: SCSI device to be queried
2458 * @pf: Page format bit (1 == standard, 0 == vendor specific)
2459 * @sp: Save page bit (0 == don't save, 1 == save)
2460 * @modepage: mode page being requested
2461 * @buffer: request buffer (may not be smaller than eight bytes)
2462 * @len: length of request buffer.
2463 * @timeout: command timeout
2464 * @retries: number of retries before failing
2465 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002466 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06002467 * must be SCSI_SENSE_BUFFERSIZE big.
2468 *
2469 * Returns zero if successful; negative error number or scsi
2470 * status on error
2471 *
2472 */
2473int
2474scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2475 unsigned char *buffer, int len, int timeout, int retries,
2476 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2477{
2478 unsigned char cmd[10];
2479 unsigned char *real_buffer;
2480 int ret;
2481
2482 memset(cmd, 0, sizeof(cmd));
2483 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2484
2485 if (sdev->use_10_for_ms) {
2486 if (len > 65535)
2487 return -EINVAL;
2488 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2489 if (!real_buffer)
2490 return -ENOMEM;
2491 memcpy(real_buffer + 8, buffer, len);
2492 len += 8;
2493 real_buffer[0] = 0;
2494 real_buffer[1] = 0;
2495 real_buffer[2] = data->medium_type;
2496 real_buffer[3] = data->device_specific;
2497 real_buffer[4] = data->longlba ? 0x01 : 0;
2498 real_buffer[5] = 0;
2499 real_buffer[6] = data->block_descriptor_length >> 8;
2500 real_buffer[7] = data->block_descriptor_length;
2501
2502 cmd[0] = MODE_SELECT_10;
2503 cmd[7] = len >> 8;
2504 cmd[8] = len;
2505 } else {
2506 if (len > 255 || data->block_descriptor_length > 255 ||
2507 data->longlba)
2508 return -EINVAL;
2509
2510 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2511 if (!real_buffer)
2512 return -ENOMEM;
2513 memcpy(real_buffer + 4, buffer, len);
2514 len += 4;
2515 real_buffer[0] = 0;
2516 real_buffer[1] = data->medium_type;
2517 real_buffer[2] = data->device_specific;
2518 real_buffer[3] = data->block_descriptor_length;
2519
2520
2521 cmd[0] = MODE_SELECT;
2522 cmd[4] = len;
2523 }
2524
2525 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002526 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002527 kfree(real_buffer);
2528 return ret;
2529}
2530EXPORT_SYMBOL_GPL(scsi_mode_select);
2531
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532/**
Rob Landleyeb448202007-11-03 13:30:39 -05002533 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002534 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535 * @dbd: set if mode sense will allow block descriptors to be returned
2536 * @modepage: mode page being requested
2537 * @buffer: request buffer (may not be smaller than eight bytes)
2538 * @len: length of request buffer.
2539 * @timeout: command timeout
2540 * @retries: number of retries before failing
2541 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002542 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002543 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544 *
2545 * Returns zero if unsuccessful, or the header offset (either 4
2546 * or 8 depending on whether a six or ten byte command was
2547 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002548 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549int
James Bottomley1cf72692005-08-28 11:27:01 -05002550scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002552 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2553{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002554 unsigned char cmd[12];
2555 int use_10_for_ms;
2556 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002557 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002558 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559
2560 memset(data, 0, sizeof(*data));
2561 memset(&cmd[0], 0, 12);
2562 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2563 cmd[2] = modepage;
2564
James Bottomleyea73a9f2005-08-28 11:33:52 -05002565 /* caller might not be interested in sense, but we need it */
2566 if (!sshdr)
2567 sshdr = &my_sshdr;
2568
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002570 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571
2572 if (use_10_for_ms) {
2573 if (len < 8)
2574 len = 8;
2575
2576 cmd[0] = MODE_SENSE_10;
2577 cmd[8] = len;
2578 header_length = 8;
2579 } else {
2580 if (len < 4)
2581 len = 4;
2582
2583 cmd[0] = MODE_SENSE;
2584 cmd[4] = len;
2585 header_length = 4;
2586 }
2587
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588 memset(buffer, 0, len);
2589
James Bottomley1cf72692005-08-28 11:27:01 -05002590 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002591 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592
2593 /* This code looks awful: what it's doing is making sure an
2594 * ILLEGAL REQUEST sense return identifies the actual command
2595 * byte as the problem. MODE_SENSE commands can return
2596 * ILLEGAL REQUEST if the code page isn't supported */
2597
James Bottomley1cf72692005-08-28 11:27:01 -05002598 if (use_10_for_ms && !scsi_status_is_good(result) &&
2599 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002600 if (scsi_sense_valid(sshdr)) {
2601 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2602 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 /*
2604 * Invalid command operation code
2605 */
James Bottomley1cf72692005-08-28 11:27:01 -05002606 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 goto retry;
2608 }
2609 }
2610 }
2611
James Bottomley1cf72692005-08-28 11:27:01 -05002612 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002613 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2614 (modepage == 6 || modepage == 8))) {
2615 /* Initio breakage? */
2616 header_length = 0;
2617 data->length = 13;
2618 data->medium_type = 0;
2619 data->device_specific = 0;
2620 data->longlba = 0;
2621 data->block_descriptor_length = 0;
2622 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 data->length = buffer[0]*256 + buffer[1] + 2;
2624 data->medium_type = buffer[2];
2625 data->device_specific = buffer[3];
2626 data->longlba = buffer[4] & 0x01;
2627 data->block_descriptor_length = buffer[6]*256
2628 + buffer[7];
2629 } else {
2630 data->length = buffer[0] + 1;
2631 data->medium_type = buffer[1];
2632 data->device_specific = buffer[2];
2633 data->block_descriptor_length = buffer[3];
2634 }
Al Viro6d73c852006-02-23 02:03:16 +01002635 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002636 } else if ((status_byte(result) == CHECK_CONDITION) &&
2637 scsi_sense_valid(sshdr) &&
2638 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2639 retry_count--;
2640 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641 }
2642
James Bottomley1cf72692005-08-28 11:27:01 -05002643 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644}
2645EXPORT_SYMBOL(scsi_mode_sense);
2646
James Bottomley001aac22007-12-02 19:10:40 +02002647/**
2648 * scsi_test_unit_ready - test if unit is ready
2649 * @sdev: scsi device to change the state of.
2650 * @timeout: command timeout
2651 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002652 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002653 *
2654 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002655 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002656 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657int
James Bottomley001aac22007-12-02 19:10:40 +02002658scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002659 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661 char cmd[] = {
2662 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2663 };
2664 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002665
James Bottomley001aac22007-12-02 19:10:40 +02002666 /* try to eat the UNIT_ATTENTION if there are enough retries */
2667 do {
2668 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
Bart Van Assche9b91fd32018-02-12 10:57:52 -08002669 timeout, 1, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002670 if (sdev->removable && scsi_sense_valid(sshdr) &&
2671 sshdr->sense_key == UNIT_ATTENTION)
2672 sdev->changed = 1;
2673 } while (scsi_sense_valid(sshdr) &&
2674 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002675
Linus Torvalds1da177e2005-04-16 15:20:36 -07002676 return result;
2677}
2678EXPORT_SYMBOL(scsi_test_unit_ready);
2679
2680/**
Rob Landleyeb448202007-11-03 13:30:39 -05002681 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682 * @sdev: scsi device to change the state of.
2683 * @state: state to change to.
2684 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002685 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002687 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002688int
2689scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2690{
2691 enum scsi_device_state oldstate = sdev->sdev_state;
2692
2693 if (state == oldstate)
2694 return 0;
2695
2696 switch (state) {
2697 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002698 switch (oldstate) {
2699 case SDEV_CREATED_BLOCK:
2700 break;
2701 default:
2702 goto illegal;
2703 }
2704 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705
2706 case SDEV_RUNNING:
2707 switch (oldstate) {
2708 case SDEV_CREATED:
2709 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002710 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711 case SDEV_QUIESCE:
2712 case SDEV_BLOCK:
2713 break;
2714 default:
2715 goto illegal;
2716 }
2717 break;
2718
2719 case SDEV_QUIESCE:
2720 switch (oldstate) {
2721 case SDEV_RUNNING:
2722 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002723 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724 break;
2725 default:
2726 goto illegal;
2727 }
2728 break;
2729
2730 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002731 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002732 switch (oldstate) {
2733 case SDEV_CREATED:
2734 case SDEV_RUNNING:
2735 case SDEV_QUIESCE:
2736 case SDEV_BLOCK:
2737 break;
2738 default:
2739 goto illegal;
2740 }
2741 break;
2742
2743 case SDEV_BLOCK:
2744 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002745 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002746 case SDEV_CREATED_BLOCK:
2747 break;
2748 default:
2749 goto illegal;
2750 }
2751 break;
2752
2753 case SDEV_CREATED_BLOCK:
2754 switch (oldstate) {
2755 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756 break;
2757 default:
2758 goto illegal;
2759 }
2760 break;
2761
2762 case SDEV_CANCEL:
2763 switch (oldstate) {
2764 case SDEV_CREATED:
2765 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002766 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002768 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769 break;
2770 default:
2771 goto illegal;
2772 }
2773 break;
2774
2775 case SDEV_DEL:
2776 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002777 case SDEV_CREATED:
2778 case SDEV_RUNNING:
2779 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002780 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002782 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002783 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784 break;
2785 default:
2786 goto illegal;
2787 }
2788 break;
2789
2790 }
2791 sdev->sdev_state = state;
2792 return 0;
2793
2794 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002795 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002796 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002797 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002798 scsi_device_state_name(oldstate),
2799 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800 );
2801 return -EINVAL;
2802}
2803EXPORT_SYMBOL(scsi_device_set_state);
2804
2805/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002806 * sdev_evt_emit - emit a single SCSI device uevent
2807 * @sdev: associated SCSI device
2808 * @evt: event to emit
2809 *
2810 * Send a single uevent (scsi_event) to the associated scsi_device.
2811 */
2812static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2813{
2814 int idx = 0;
2815 char *envp[3];
2816
2817 switch (evt->evt_type) {
2818 case SDEV_EVT_MEDIA_CHANGE:
2819 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2820 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002821 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002822 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002823 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2824 break;
2825 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2826 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2827 break;
2828 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2829 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2830 break;
2831 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2832 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2833 break;
2834 case SDEV_EVT_LUN_CHANGE_REPORTED:
2835 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2836 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002837 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2838 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2839 break;
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002840 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2841 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2842 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002843 default:
2844 /* do nothing */
2845 break;
2846 }
2847
2848 envp[idx++] = NULL;
2849
2850 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2851}
2852
2853/**
2854 * sdev_evt_thread - send a uevent for each scsi event
2855 * @work: work struct for scsi_device
2856 *
2857 * Dispatch queued events to their associated scsi_device kobjects
2858 * as uevents.
2859 */
2860void scsi_evt_thread(struct work_struct *work)
2861{
2862 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002863 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002864 LIST_HEAD(event_list);
2865
2866 sdev = container_of(work, struct scsi_device, event_work);
2867
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002868 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2869 if (test_and_clear_bit(evt_type, sdev->pending_events))
2870 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2871
Jeff Garzika341cd02007-10-29 17:15:22 -04002872 while (1) {
2873 struct scsi_event *evt;
2874 struct list_head *this, *tmp;
2875 unsigned long flags;
2876
2877 spin_lock_irqsave(&sdev->list_lock, flags);
2878 list_splice_init(&sdev->event_list, &event_list);
2879 spin_unlock_irqrestore(&sdev->list_lock, flags);
2880
2881 if (list_empty(&event_list))
2882 break;
2883
2884 list_for_each_safe(this, tmp, &event_list) {
2885 evt = list_entry(this, struct scsi_event, node);
2886 list_del(&evt->node);
2887 scsi_evt_emit(sdev, evt);
2888 kfree(evt);
2889 }
2890 }
2891}
2892
2893/**
2894 * sdev_evt_send - send asserted event to uevent thread
2895 * @sdev: scsi_device event occurred on
2896 * @evt: event to send
2897 *
2898 * Assert scsi device event asynchronously.
2899 */
2900void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2901{
2902 unsigned long flags;
2903
Kay Sievers4d1566e2008-03-19 13:04:47 +01002904#if 0
2905 /* FIXME: currently this check eliminates all media change events
2906 * for polled devices. Need to update to discriminate between AN
2907 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002908 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2909 kfree(evt);
2910 return;
2911 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002912#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002913
2914 spin_lock_irqsave(&sdev->list_lock, flags);
2915 list_add_tail(&evt->node, &sdev->event_list);
2916 schedule_work(&sdev->event_work);
2917 spin_unlock_irqrestore(&sdev->list_lock, flags);
2918}
2919EXPORT_SYMBOL_GPL(sdev_evt_send);
2920
2921/**
2922 * sdev_evt_alloc - allocate a new scsi event
2923 * @evt_type: type of event to allocate
2924 * @gfpflags: GFP flags for allocation
2925 *
2926 * Allocates and returns a new scsi_event.
2927 */
2928struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2929 gfp_t gfpflags)
2930{
2931 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2932 if (!evt)
2933 return NULL;
2934
2935 evt->evt_type = evt_type;
2936 INIT_LIST_HEAD(&evt->node);
2937
2938 /* evt_type-specific initialization, if any */
2939 switch (evt_type) {
2940 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002941 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2942 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2943 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2944 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2945 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002946 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002947 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002948 default:
2949 /* do nothing */
2950 break;
2951 }
2952
2953 return evt;
2954}
2955EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2956
2957/**
2958 * sdev_evt_send_simple - send asserted event to uevent thread
2959 * @sdev: scsi_device event occurred on
2960 * @evt_type: type of event to send
2961 * @gfpflags: GFP flags for allocation
2962 *
2963 * Assert scsi device event asynchronously, given an event type.
2964 */
2965void sdev_evt_send_simple(struct scsi_device *sdev,
2966 enum scsi_device_event evt_type, gfp_t gfpflags)
2967{
2968 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2969 if (!evt) {
2970 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2971 evt_type);
2972 return;
2973 }
2974
2975 sdev_evt_send(sdev, evt);
2976}
2977EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2978
2979/**
Bart Van Assche669f0442016-11-22 16:17:13 -08002980 * scsi_request_fn_active() - number of kernel threads inside scsi_request_fn()
2981 * @sdev: SCSI device to count the number of scsi_request_fn() callers for.
2982 */
2983static int scsi_request_fn_active(struct scsi_device *sdev)
2984{
2985 struct request_queue *q = sdev->request_queue;
2986 int request_fn_active;
2987
2988 WARN_ON_ONCE(sdev->host->use_blk_mq);
2989
2990 spin_lock_irq(q->queue_lock);
2991 request_fn_active = q->request_fn_active;
2992 spin_unlock_irq(q->queue_lock);
2993
2994 return request_fn_active;
2995}
2996
2997/**
2998 * scsi_wait_for_queuecommand() - wait for ongoing queuecommand() calls
2999 * @sdev: SCSI device pointer.
3000 *
3001 * Wait until the ongoing shost->hostt->queuecommand() calls that are
3002 * invoked from scsi_request_fn() have finished.
3003 */
3004static void scsi_wait_for_queuecommand(struct scsi_device *sdev)
3005{
3006 WARN_ON_ONCE(sdev->host->use_blk_mq);
3007
3008 while (scsi_request_fn_active(sdev))
3009 msleep(20);
3010}
3011
3012/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013 * scsi_device_quiesce - Block user issued commands.
3014 * @sdev: scsi device to quiesce.
3015 *
3016 * This works by trying to transition to the SDEV_QUIESCE state
3017 * (which must be a legal transition). When the device is in this
3018 * state, only special requests will be accepted, all others will
3019 * be deferred. Since special requests may also be requeued requests,
3020 * a successful return doesn't guarantee the device will be
3021 * totally quiescent.
3022 *
3023 * Must be called with user context, may sleep.
3024 *
3025 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05003026 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003027int
3028scsi_device_quiesce(struct scsi_device *sdev)
3029{
Bart Van Assche3a0a5292017-11-09 10:49:58 -08003030 struct request_queue *q = sdev->request_queue;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003031 int err;
3032
Bart Van Assche3a0a5292017-11-09 10:49:58 -08003033 /*
3034 * It is allowed to call scsi_device_quiesce() multiple times from
3035 * the same context but concurrent scsi_device_quiesce() calls are
3036 * not allowed.
3037 */
3038 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
3039
3040 blk_set_preempt_only(q);
3041
3042 blk_mq_freeze_queue(q);
3043 /*
3044 * Ensure that the effect of blk_set_preempt_only() will be visible
3045 * for percpu_ref_tryget() callers that occur after the queue
3046 * unfreeze even if the queue was already frozen before this function
3047 * was called. See also https://lwn.net/Articles/573497/.
3048 */
3049 synchronize_rcu();
3050 blk_mq_unfreeze_queue(q);
3051
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003052 mutex_lock(&sdev->state_mutex);
3053 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08003054 if (err == 0)
3055 sdev->quiesced_by = current;
3056 else
3057 blk_clear_preempt_only(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003058 mutex_unlock(&sdev->state_mutex);
3059
Bart Van Assche3a0a5292017-11-09 10:49:58 -08003060 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003061}
3062EXPORT_SYMBOL(scsi_device_quiesce);
3063
3064/**
3065 * scsi_device_resume - Restart user issued commands to a quiesced device.
3066 * @sdev: scsi device to resume.
3067 *
3068 * Moves the device from quiesced back to running and restarts the
3069 * queues.
3070 *
3071 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05003072 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07003073void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003074{
Dan Williamsa7a20d12012-03-22 17:05:11 -07003075 /* check if the device state was mutated prior to resume, and if
3076 * so assume the state is being managed elsewhere (for example
3077 * device deleted during suspend)
3078 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003079 mutex_lock(&sdev->state_mutex);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08003080 WARN_ON_ONCE(!sdev->quiesced_by);
3081 sdev->quiesced_by = NULL;
3082 blk_clear_preempt_only(sdev->request_queue);
3083 if (sdev->sdev_state == SDEV_QUIESCE)
3084 scsi_device_set_state(sdev, SDEV_RUNNING);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003085 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003086}
3087EXPORT_SYMBOL(scsi_device_resume);
3088
3089static void
3090device_quiesce_fn(struct scsi_device *sdev, void *data)
3091{
3092 scsi_device_quiesce(sdev);
3093}
3094
3095void
3096scsi_target_quiesce(struct scsi_target *starget)
3097{
3098 starget_for_each_device(starget, NULL, device_quiesce_fn);
3099}
3100EXPORT_SYMBOL(scsi_target_quiesce);
3101
3102static void
3103device_resume_fn(struct scsi_device *sdev, void *data)
3104{
3105 scsi_device_resume(sdev);
3106}
3107
3108void
3109scsi_target_resume(struct scsi_target *starget)
3110{
3111 starget_for_each_device(starget, NULL, device_resume_fn);
3112}
3113EXPORT_SYMBOL(scsi_target_resume);
3114
3115/**
Bart Van Assche551eb592017-06-02 14:21:53 -07003116 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
3117 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07003118 *
Bart Van Assche551eb592017-06-02 14:21:53 -07003119 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003120 *
Bart Van Assche551eb592017-06-02 14:21:53 -07003121 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003122 *
Bart Van Assche551eb592017-06-02 14:21:53 -07003123 * Notes:
3124 * This routine transitions the device to the SDEV_BLOCK state (which must be
3125 * a legal transition). When the device is in this state, command processing
3126 * is paused until the device leaves the SDEV_BLOCK state. See also
3127 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05003128 */
Bart Van Assche551eb592017-06-02 14:21:53 -07003129int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003130{
Jens Axboe165125e2007-07-24 09:28:11 +02003131 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003132 unsigned long flags;
3133 int err = 0;
3134
3135 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05003136 if (err) {
3137 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
3138
3139 if (err)
3140 return err;
3141 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003142
3143 /*
3144 * The device has transitioned to SDEV_BLOCK. Stop the
3145 * block layer from calling the midlayer with this device's
3146 * request queue.
3147 */
Christoph Hellwigd2852032014-01-17 12:06:53 +01003148 if (q->mq_ops) {
Linus Torvalds90311142017-07-06 12:10:33 -07003149 blk_mq_quiesce_queue_nowait(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +01003150 } else {
3151 spin_lock_irqsave(q->queue_lock, flags);
3152 blk_stop_queue(q);
3153 spin_unlock_irqrestore(q->queue_lock, flags);
3154 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003155
3156 return 0;
3157}
Bart Van Assche551eb592017-06-02 14:21:53 -07003158EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
3159
Linus Torvalds1da177e2005-04-16 15:20:36 -07003160/**
Bart Van Assche551eb592017-06-02 14:21:53 -07003161 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
3162 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07003163 *
Bart Van Assche551eb592017-06-02 14:21:53 -07003164 * Pause SCSI command processing on the specified device and wait until all
3165 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166 *
Bart Van Assche551eb592017-06-02 14:21:53 -07003167 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168 *
Bart Van Assche551eb592017-06-02 14:21:53 -07003169 * Note:
3170 * This routine transitions the device to the SDEV_BLOCK state (which must be
3171 * a legal transition). When the device is in this state, command processing
3172 * is paused until the device leaves the SDEV_BLOCK state. See also
3173 * scsi_internal_device_unblock().
3174 *
3175 * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
3176 * scsi_internal_device_block() has blocked a SCSI device and also
3177 * remove the rport mutex lock and unlock calls from srp_queuecommand().
Rob Landleyeb448202007-11-03 13:30:39 -05003178 */
Bart Van Assche551eb592017-06-02 14:21:53 -07003179static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003180{
Bart Van Assche551eb592017-06-02 14:21:53 -07003181 struct request_queue *q = sdev->request_queue;
3182 int err;
3183
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003184 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07003185 err = scsi_internal_device_block_nowait(sdev);
3186 if (err == 0) {
3187 if (q->mq_ops)
3188 blk_mq_quiesce_queue(q);
3189 else
3190 scsi_wait_for_queuecommand(sdev);
3191 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003192 mutex_unlock(&sdev->state_mutex);
3193
Bart Van Assche551eb592017-06-02 14:21:53 -07003194 return err;
3195}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003196
Bart Van Assche66483a42017-06-02 14:21:56 -07003197void scsi_start_queue(struct scsi_device *sdev)
3198{
3199 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003200 unsigned long flags;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003201
Bart Van Assche66483a42017-06-02 14:21:56 -07003202 if (q->mq_ops) {
Linus Torvalds90311142017-07-06 12:10:33 -07003203 blk_mq_unquiesce_queue(q);
Bart Van Assche66483a42017-06-02 14:21:56 -07003204 } else {
3205 spin_lock_irqsave(q->queue_lock, flags);
3206 blk_start_queue(q);
3207 spin_unlock_irqrestore(q->queue_lock, flags);
3208 }
3209}
3210
Linus Torvalds1da177e2005-04-16 15:20:36 -07003211/**
Bart Van Assche43f75712017-06-02 14:21:54 -07003212 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07003213 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07003214 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215 *
Bart Van Assche43f75712017-06-02 14:21:54 -07003216 * Restart the device queue for a previously suspended SCSI device. Does not
3217 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003218 *
Bart Van Assche43f75712017-06-02 14:21:54 -07003219 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220 *
Bart Van Assche43f75712017-06-02 14:21:54 -07003221 * Notes:
3222 * This routine transitions the device to the SDEV_RUNNING state or to one of
3223 * the offline states (which must be a legal transition) allowing the midlayer
3224 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225 */
Bart Van Assche43f75712017-06-02 14:21:54 -07003226int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
3227 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003228{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003229 /*
3230 * Try to transition the scsi device to SDEV_RUNNING or one of the
3231 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003232 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02003233 switch (sdev->sdev_state) {
3234 case SDEV_BLOCK:
3235 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003236 sdev->sdev_state = new_state;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02003237 break;
3238 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003239 if (new_state == SDEV_TRANSPORT_OFFLINE ||
3240 new_state == SDEV_OFFLINE)
3241 sdev->sdev_state = new_state;
3242 else
3243 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02003244 break;
3245 case SDEV_CANCEL:
3246 case SDEV_OFFLINE:
3247 break;
3248 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04003249 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02003250 }
Bart Van Assche66483a42017-06-02 14:21:56 -07003251 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003252
3253 return 0;
3254}
Bart Van Assche43f75712017-06-02 14:21:54 -07003255EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
3256
3257/**
3258 * scsi_internal_device_unblock - resume a device after a block request
3259 * @sdev: device to resume
3260 * @new_state: state to set the device to after unblocking
3261 *
3262 * Restart the device queue for a previously suspended SCSI device. May sleep.
3263 *
3264 * Returns zero if successful or a negative error code upon failure.
3265 *
3266 * Notes:
3267 * This routine transitions the device to the SDEV_RUNNING state or to one of
3268 * the offline states (which must be a legal transition) allowing the midlayer
3269 * to goose the queue for this device.
3270 */
3271static int scsi_internal_device_unblock(struct scsi_device *sdev,
3272 enum scsi_device_state new_state)
3273{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003274 int ret;
3275
3276 mutex_lock(&sdev->state_mutex);
3277 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
3278 mutex_unlock(&sdev->state_mutex);
3279
3280 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07003281}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003282
3283static void
3284device_block(struct scsi_device *sdev, void *data)
3285{
Bart Van Assche551eb592017-06-02 14:21:53 -07003286 scsi_internal_device_block(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003287}
3288
3289static int
3290target_block(struct device *dev, void *data)
3291{
3292 if (scsi_is_target_device(dev))
3293 starget_for_each_device(to_scsi_target(dev), NULL,
3294 device_block);
3295 return 0;
3296}
3297
3298void
3299scsi_target_block(struct device *dev)
3300{
3301 if (scsi_is_target_device(dev))
3302 starget_for_each_device(to_scsi_target(dev), NULL,
3303 device_block);
3304 else
3305 device_for_each_child(dev, NULL, target_block);
3306}
3307EXPORT_SYMBOL_GPL(scsi_target_block);
3308
3309static void
3310device_unblock(struct scsi_device *sdev, void *data)
3311{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003312 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003313}
3314
3315static int
3316target_unblock(struct device *dev, void *data)
3317{
3318 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003319 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003320 device_unblock);
3321 return 0;
3322}
3323
3324void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003325scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003326{
3327 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003328 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003329 device_unblock);
3330 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003331 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003332}
3333EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003334
3335/**
3336 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05003337 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003338 * @sg_count: number of segments in sg
3339 * @offset: offset in bytes into sg, on return offset into the mapped area
3340 * @len: bytes to map, on return number of bytes mapped
3341 *
3342 * Returns virtual address of the start of the mapped page
3343 */
Jens Axboec6132da2007-10-16 11:08:49 +02003344void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003345 size_t *offset, size_t *len)
3346{
3347 int i;
3348 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02003349 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003350 struct page *page;
3351
Andrew Morton22cfefb2007-02-05 16:39:03 -08003352 WARN_ON(!irqs_disabled());
3353
Jens Axboec6132da2007-10-16 11:08:49 +02003354 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003355 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02003356 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003357 if (sg_len > *offset)
3358 break;
3359 }
3360
3361 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07003362 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
3363 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07003364 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003365 WARN_ON(1);
3366 return NULL;
3367 }
3368
3369 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02003370 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003371
3372 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02003373 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003374 *offset &= ~PAGE_MASK;
3375
3376 /* Bytes in this sg-entry from *offset to the end of the page */
3377 sg_len = PAGE_SIZE - *offset;
3378 if (*len > sg_len)
3379 *len = sg_len;
3380
Cong Wang77dfce02011-11-25 23:14:23 +08003381 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003382}
3383EXPORT_SYMBOL(scsi_kmap_atomic_sg);
3384
3385/**
Rob Landleyeb448202007-11-03 13:30:39 -05003386 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003387 * @virt: virtual address to be unmapped
3388 */
3389void scsi_kunmap_atomic_sg(void *virt)
3390{
Cong Wang77dfce02011-11-25 23:14:23 +08003391 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003392}
3393EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08003394
3395void sdev_disable_disk_events(struct scsi_device *sdev)
3396{
3397 atomic_inc(&sdev->disk_events_disable_depth);
3398}
3399EXPORT_SYMBOL(sdev_disable_disk_events);
3400
3401void sdev_enable_disk_events(struct scsi_device *sdev)
3402{
3403 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
3404 return;
3405 atomic_dec(&sdev->disk_events_disable_depth);
3406}
3407EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003408
3409/**
3410 * scsi_vpd_lun_id - return a unique device identification
3411 * @sdev: SCSI device
3412 * @id: buffer for the identification
3413 * @id_len: length of the buffer
3414 *
3415 * Copies a unique device identification into @id based
3416 * on the information in the VPD page 0x83 of the device.
3417 * The string will be formatted as a SCSI name string.
3418 *
3419 * Returns the length of the identification or error on failure.
3420 * If the identifier is longer than the supplied buffer the actual
3421 * identifier length is returned and the buffer is not zero-padded.
3422 */
3423int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
3424{
3425 u8 cur_id_type = 0xff;
3426 u8 cur_id_size = 0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003427 const unsigned char *d, *cur_id_str;
3428 const struct scsi_vpd *vpd_pg83;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003429 int id_size = -EINVAL;
3430
3431 rcu_read_lock();
3432 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3433 if (!vpd_pg83) {
3434 rcu_read_unlock();
3435 return -ENXIO;
3436 }
3437
3438 /*
3439 * Look for the correct descriptor.
3440 * Order of preference for lun descriptor:
3441 * - SCSI name string
3442 * - NAA IEEE Registered Extended
3443 * - EUI-64 based 16-byte
3444 * - EUI-64 based 12-byte
3445 * - NAA IEEE Registered
3446 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02003447 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003448 * as longer descriptors reduce the likelyhood
3449 * of identification clashes.
3450 */
3451
3452 /* The id string must be at least 20 bytes + terminating NULL byte */
3453 if (id_len < 21) {
3454 rcu_read_unlock();
3455 return -EINVAL;
3456 }
3457
3458 memset(id, 0, id_len);
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003459 d = vpd_pg83->data + 4;
3460 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003461 /* Skip designators not referring to the LUN */
3462 if ((d[1] & 0x30) != 0x00)
3463 goto next_desig;
3464
3465 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02003466 case 0x1:
3467 /* T10 Vendor ID */
3468 if (cur_id_size > d[3])
3469 break;
3470 /* Prefer anything */
3471 if (cur_id_type > 0x01 && cur_id_type != 0xff)
3472 break;
3473 cur_id_size = d[3];
3474 if (cur_id_size + 4 > id_len)
3475 cur_id_size = id_len - 4;
3476 cur_id_str = d + 4;
3477 cur_id_type = d[1] & 0xf;
3478 id_size = snprintf(id, id_len, "t10.%*pE",
3479 cur_id_size, cur_id_str);
3480 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003481 case 0x2:
3482 /* EUI-64 */
3483 if (cur_id_size > d[3])
3484 break;
3485 /* Prefer NAA IEEE Registered Extended */
3486 if (cur_id_type == 0x3 &&
3487 cur_id_size == d[3])
3488 break;
3489 cur_id_size = d[3];
3490 cur_id_str = d + 4;
3491 cur_id_type = d[1] & 0xf;
3492 switch (cur_id_size) {
3493 case 8:
3494 id_size = snprintf(id, id_len,
3495 "eui.%8phN",
3496 cur_id_str);
3497 break;
3498 case 12:
3499 id_size = snprintf(id, id_len,
3500 "eui.%12phN",
3501 cur_id_str);
3502 break;
3503 case 16:
3504 id_size = snprintf(id, id_len,
3505 "eui.%16phN",
3506 cur_id_str);
3507 break;
3508 default:
3509 cur_id_size = 0;
3510 break;
3511 }
3512 break;
3513 case 0x3:
3514 /* NAA */
3515 if (cur_id_size > d[3])
3516 break;
3517 cur_id_size = d[3];
3518 cur_id_str = d + 4;
3519 cur_id_type = d[1] & 0xf;
3520 switch (cur_id_size) {
3521 case 8:
3522 id_size = snprintf(id, id_len,
3523 "naa.%8phN",
3524 cur_id_str);
3525 break;
3526 case 16:
3527 id_size = snprintf(id, id_len,
3528 "naa.%16phN",
3529 cur_id_str);
3530 break;
3531 default:
3532 cur_id_size = 0;
3533 break;
3534 }
3535 break;
3536 case 0x8:
3537 /* SCSI name string */
3538 if (cur_id_size + 4 > d[3])
3539 break;
3540 /* Prefer others for truncated descriptor */
3541 if (cur_id_size && d[3] > id_len)
3542 break;
3543 cur_id_size = id_size = d[3];
3544 cur_id_str = d + 4;
3545 cur_id_type = d[1] & 0xf;
3546 if (cur_id_size >= id_len)
3547 cur_id_size = id_len - 1;
3548 memcpy(id, cur_id_str, cur_id_size);
3549 /* Decrease priority for truncated descriptor */
3550 if (cur_id_size != id_size)
3551 cur_id_size = 6;
3552 break;
3553 default:
3554 break;
3555 }
3556next_desig:
3557 d += d[3] + 4;
3558 }
3559 rcu_read_unlock();
3560
3561 return id_size;
3562}
3563EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003564
3565/*
3566 * scsi_vpd_tpg_id - return a target port group identifier
3567 * @sdev: SCSI device
3568 *
3569 * Returns the Target Port Group identifier from the information
3570 * froom VPD page 0x83 of the device.
3571 *
3572 * Returns the identifier or error on failure.
3573 */
3574int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3575{
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003576 const unsigned char *d;
3577 const struct scsi_vpd *vpd_pg83;
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003578 int group_id = -EAGAIN, rel_port = -1;
3579
3580 rcu_read_lock();
3581 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3582 if (!vpd_pg83) {
3583 rcu_read_unlock();
3584 return -ENXIO;
3585 }
3586
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003587 d = vpd_pg83->data + 4;
3588 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003589 switch (d[1] & 0xf) {
3590 case 0x4:
3591 /* Relative target port */
3592 rel_port = get_unaligned_be16(&d[6]);
3593 break;
3594 case 0x5:
3595 /* Target port group */
3596 group_id = get_unaligned_be16(&d[6]);
3597 break;
3598 default:
3599 break;
3600 }
3601 d += d[3] + 4;
3602 }
3603 rcu_read_unlock();
3604
3605 if (group_id >= 0 && rel_id && rel_port != -1)
3606 *rel_id = rel_port;
3607
3608 return group_id;
3609}
3610EXPORT_SYMBOL(scsi_vpd_tpg_id);