blob: 1470c93a87e7f4024618fed3a8ee0570ade04485 [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
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030047static inline struct kmem_cache *
Bart Van Assche8e688252017-06-02 14:21:52 -070048scsi_select_sense_cache(bool unchecked_isa_dma)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030049{
Bart Van Assche8e688252017-06-02 14:21:52 -070050 return unchecked_isa_dma ? scsi_sense_isadma_cache : scsi_sense_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030051}
52
Bart Van Assche8e688252017-06-02 14:21:52 -070053static void scsi_free_sense_buffer(bool unchecked_isa_dma,
54 unsigned char *sense_buffer)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030055{
Bart Van Assche8e688252017-06-02 14:21:52 -070056 kmem_cache_free(scsi_select_sense_cache(unchecked_isa_dma),
57 sense_buffer);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030058}
59
Bart Van Assche8e688252017-06-02 14:21:52 -070060static unsigned char *scsi_alloc_sense_buffer(bool unchecked_isa_dma,
Christoph Hellwige9c787e2017-01-02 21:55:26 +030061 gfp_t gfp_mask, int numa_node)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030062{
Bart Van Assche8e688252017-06-02 14:21:52 -070063 return kmem_cache_alloc_node(scsi_select_sense_cache(unchecked_isa_dma),
64 gfp_mask, numa_node);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030065}
66
67int scsi_init_sense_cache(struct Scsi_Host *shost)
68{
69 struct kmem_cache *cache;
70 int ret = 0;
71
Bart Van Assche8e688252017-06-02 14:21:52 -070072 cache = scsi_select_sense_cache(shost->unchecked_isa_dma);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030073 if (cache)
74 return 0;
75
76 mutex_lock(&scsi_sense_cache_mutex);
77 if (shost->unchecked_isa_dma) {
78 scsi_sense_isadma_cache =
79 kmem_cache_create("scsi_sense_cache(DMA)",
80 SCSI_SENSE_BUFFERSIZE, 0,
81 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
82 if (!scsi_sense_isadma_cache)
83 ret = -ENOMEM;
84 } else {
85 scsi_sense_cache =
86 kmem_cache_create("scsi_sense_cache",
87 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN, NULL);
88 if (!scsi_sense_cache)
89 ret = -ENOMEM;
90 }
91
92 mutex_unlock(&scsi_sense_cache_mutex);
93 return ret;
94}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +020095
Jens Axboea488e742010-04-16 21:13:15 +020096/*
97 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
98 * not change behaviour from the previous unplug mechanism, experimentation
99 * may prove this needs changing.
100 */
101#define SCSI_QUEUE_DELAY 3
102
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100103static void
104scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
106 struct Scsi_Host *host = cmd->device->host;
107 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500108 struct scsi_target *starget = scsi_target(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900111 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 *
113 * If the host/device isn't busy, assume that something actually
114 * completed, and that we should be able to queue a command now.
115 *
116 * Note that the prior mid-layer assumption that any host could
117 * always queue at least one command is now broken. The mid-layer
118 * will implement a user specifiable stall (see
119 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
120 * if a command is requeued with no other commands outstanding
121 * either for the device or for the host.
122 */
Mike Christief0c0a372008-08-17 15:24:38 -0500123 switch (reason) {
124 case SCSI_MLQUEUE_HOST_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100125 atomic_set(&host->host_blocked, host->max_host_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500126 break;
127 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400128 case SCSI_MLQUEUE_EH_RETRY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100129 atomic_set(&device->device_blocked,
130 device->max_device_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500131 break;
132 case SCSI_MLQUEUE_TARGET_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100133 atomic_set(&starget->target_blocked,
134 starget->max_target_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500135 break;
136 }
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100137}
138
Christoph Hellwigd2852032014-01-17 12:06:53 +0100139static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
140{
141 struct scsi_device *sdev = cmd->device;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100142
Bart Van Assche2b053ac2016-10-28 17:21:41 -0700143 blk_mq_requeue_request(cmd->request, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100144 put_device(&sdev->sdev_gendev);
145}
146
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100147/**
148 * __scsi_queue_insert - private queue insertion
149 * @cmd: The SCSI command being requeued
150 * @reason: The reason for the requeue
151 * @unbusy: Whether the queue should be unbusied
152 *
153 * This is a private queue insertion. The public interface
154 * scsi_queue_insert() always assumes the queue should be unbusied
155 * because it's always called before the completion. This function is
156 * for a requeue after completion, which should only occur in this
157 * file.
158 */
159static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
160{
161 struct scsi_device *device = cmd->device;
162 struct request_queue *q = device->request_queue;
163 unsigned long flags;
164
165 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
166 "Inserting command %p into mlqueue\n", cmd));
167
168 scsi_set_blocked(cmd, reason);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 * Decrement the counters, since these commands are no longer
172 * active on the host/device.
173 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600174 if (unbusy)
175 scsi_device_unbusy(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500178 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000179 * that are already in the queue. Schedule requeue work under
180 * lock such that the kblockd_schedule_work() call happens
181 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200182 */
Alan Stern644373a2014-03-28 10:51:15 -0700183 cmd->result = 0;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100184 if (q->mq_ops) {
185 scsi_mq_requeue_cmd(cmd);
186 return;
187 }
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500188 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley59897da2005-09-14 12:57:42 -0400189 blk_requeue_request(q, cmd->request);
Jens Axboe59c3d452014-04-08 09:15:35 -0600190 kblockd_schedule_work(&device->requeue_work);
Bart Van Asscheb4854622012-06-29 15:36:07 +0000191 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192}
193
James Bottomley4f5299a2009-01-02 10:42:21 -0600194/*
195 * Function: scsi_queue_insert()
196 *
197 * Purpose: Insert a command in the midlevel queue.
198 *
199 * Arguments: cmd - command that we are adding to queue.
200 * reason - why we are inserting command to queue.
201 *
202 * Lock status: Assumed that lock is not held upon entry.
203 *
204 * Returns: Nothing.
205 *
206 * Notes: We do this for one of two cases. Either the host is busy
207 * and it cannot accept any more commands for the time being,
208 * or the device returned QUEUE_FULL and can accept no more
209 * commands.
210 * Notes: This could be called either from an interrupt context or a
211 * normal process context.
212 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000213void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600214{
Bart Van Assche84feb162012-06-29 15:35:05 +0000215 __scsi_queue_insert(cmd, reason, 1);
James Bottomley4f5299a2009-01-02 10:42:21 -0600216}
Christoph Hellwige8064022016-10-20 15:12:13 +0200217
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100218
219/**
220 * scsi_execute - insert request and wait for the result
221 * @sdev: scsi device
222 * @cmd: scsi command
223 * @data_direction: data direction
224 * @buffer: data buffer
225 * @bufflen: len of buffer
226 * @sense: optional sense buffer
227 * @sshdr: optional decoded sense header
228 * @timeout: request timeout in seconds
229 * @retries: number of times to retry request
230 * @flags: flags for ->cmd_flags
231 * @rq_flags: flags for ->rq_flags
232 * @resid: optional residual length
233 *
Christoph Hellwig17d53632017-04-20 16:03:01 +0200234 * Returns the scsi_cmnd result field if a command was executed, or a negative
235 * Linux error code if we didn't get that far.
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100236 */
237int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500238 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100239 unsigned char *sense, struct scsi_sense_hdr *sshdr,
240 int timeout, int retries, u64 flags, req_flags_t rq_flags,
241 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500242{
243 struct request *req;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100244 struct scsi_request *rq;
James Bottomley39216032005-06-15 18:48:29 -0500245 int ret = DRIVER_ERROR << 24;
246
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100247 req = blk_get_request(sdev->request_queue,
248 data_direction == DMA_TO_DEVICE ?
249 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, __GFP_RECLAIM);
Joe Lawrencea492f072014-08-28 08:15:21 -0600250 if (IS_ERR(req))
James Bottomleybfe159a2011-07-07 15:45:40 -0500251 return ret;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100252 rq = scsi_req(req);
253 scsi_req_init(req);
James Bottomley39216032005-06-15 18:48:29 -0500254
255 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
Mel Gorman71baba42015-11-06 16:28:28 -0800256 buffer, bufflen, __GFP_RECLAIM))
James Bottomley39216032005-06-15 18:48:29 -0500257 goto out;
258
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100259 rq->cmd_len = COMMAND_SIZE(cmd[0]);
260 memcpy(rq->cmd, cmd, rq->cmd_len);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200261 rq->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500262 req->timeout = timeout;
Christoph Hellwige8064022016-10-20 15:12:13 +0200263 req->cmd_flags |= flags;
264 req->rq_flags |= rq_flags | RQF_QUIET | RQF_PREEMPT;
James Bottomley39216032005-06-15 18:48:29 -0500265
266 /*
267 * head injection *required* here otherwise quiesce won't work
268 */
269 blk_execute_rq(req->q, NULL, req, 1);
270
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400271 /*
272 * Some devices (USB mass-storage in particular) may transfer
273 * garbage data together with a residue indicating that the data
274 * is invalid. Prevent the garbage from being misinterpreted
275 * and prevent security leaks by zeroing out the excess data.
276 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100277 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
278 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400279
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900280 if (resid)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100281 *resid = rq->resid_len;
282 if (sense && rq->sense_len)
283 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100284 if (sshdr)
285 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
Christoph Hellwig17d53632017-04-20 16:03:01 +0200286 ret = rq->result;
James Bottomley39216032005-06-15 18:48:29 -0500287 out:
288 blk_put_request(req);
289
290 return ret;
291}
James Bottomley33aa6872005-08-28 11:31:14 -0500292EXPORT_SYMBOL(scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294/*
295 * Function: scsi_init_cmd_errh()
296 *
297 * Purpose: Initialize cmd fields related to error handling.
298 *
299 * Arguments: cmd - command that is ready to be queued.
300 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 * Notes: This function has the job of initializing a number of
302 * fields related to error handling. Typically this will
303 * be called once for each command, as required.
304 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200305static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 cmd->serial_number = 0;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200308 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900309 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300311 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312}
313
314void scsi_device_unbusy(struct scsi_device *sdev)
315{
316 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500317 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 unsigned long flags;
319
Christoph Hellwig74665012014-01-22 15:29:29 +0100320 atomic_dec(&shost->host_busy);
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100321 if (starget->can_queue > 0)
322 atomic_dec(&starget->target_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +0100323
James Bottomley939647e2005-09-18 15:05:20 -0500324 if (unlikely(scsi_host_in_recovery(shost) &&
Christoph Hellwig74665012014-01-22 15:29:29 +0100325 (shost->host_failed || shost->host_eh_scheduled))) {
326 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 scsi_eh_wakeup(shost);
Christoph Hellwig74665012014-01-22 15:29:29 +0100328 spin_unlock_irqrestore(shost->host_lock, flags);
329 }
330
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200331 atomic_dec(&sdev->device_busy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332}
333
Christoph Hellwigd2852032014-01-17 12:06:53 +0100334static void scsi_kick_queue(struct request_queue *q)
335{
336 if (q->mq_ops)
337 blk_mq_start_hw_queues(q);
338 else
339 blk_run_queue(q);
340}
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342/*
343 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
344 * and call blk_run_queue for all the scsi_devices on the target -
345 * including current_sdev first.
346 *
347 * Called with *no* scsi locks held.
348 */
349static void scsi_single_lun_run(struct scsi_device *current_sdev)
350{
351 struct Scsi_Host *shost = current_sdev->host;
352 struct scsi_device *sdev, *tmp;
353 struct scsi_target *starget = scsi_target(current_sdev);
354 unsigned long flags;
355
356 spin_lock_irqsave(shost->host_lock, flags);
357 starget->starget_sdev_user = NULL;
358 spin_unlock_irqrestore(shost->host_lock, flags);
359
360 /*
361 * Call blk_run_queue for all LUNs on the target, starting with
362 * current_sdev. We race with others (to set starget_sdev_user),
363 * but in most cases, we will be first. Ideally, each LU on the
364 * target would get some limited time or requests on the target.
365 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100366 scsi_kick_queue(current_sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
368 spin_lock_irqsave(shost->host_lock, flags);
369 if (starget->starget_sdev_user)
370 goto out;
371 list_for_each_entry_safe(sdev, tmp, &starget->devices,
372 same_target_siblings) {
373 if (sdev == current_sdev)
374 continue;
375 if (scsi_device_get(sdev))
376 continue;
377
378 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100379 scsi_kick_queue(sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 spin_lock_irqsave(shost->host_lock, flags);
381
382 scsi_device_put(sdev);
383 }
384 out:
385 spin_unlock_irqrestore(shost->host_lock, flags);
386}
387
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100388static inline bool scsi_device_is_busy(struct scsi_device *sdev)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400389{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100390 if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
391 return true;
392 if (atomic_read(&sdev->device_blocked) > 0)
393 return true;
394 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400395}
396
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100397static inline bool scsi_target_is_busy(struct scsi_target *starget)
Mike Christief0c0a372008-08-17 15:24:38 -0500398{
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100399 if (starget->can_queue > 0) {
400 if (atomic_read(&starget->target_busy) >= starget->can_queue)
401 return true;
402 if (atomic_read(&starget->target_blocked) > 0)
403 return true;
404 }
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100405 return false;
Mike Christief0c0a372008-08-17 15:24:38 -0500406}
407
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100408static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400409{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100410 if (shost->can_queue > 0 &&
411 atomic_read(&shost->host_busy) >= shost->can_queue)
412 return true;
413 if (atomic_read(&shost->host_blocked) > 0)
414 return true;
415 if (shost->host_self_blocked)
416 return true;
417 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400418}
419
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800420static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600422 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800423 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 unsigned long flags;
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600427 list_splice_init(&shost->starved_list, &starved_list);
428
429 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200430 struct request_queue *slq;
431
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 /*
433 * As long as shost is accepting commands and we have
434 * starved queues, call blk_run_queue. scsi_request_fn
435 * drops the queue_lock and can add us back to the
436 * starved_list.
437 *
438 * host_lock protects the starved_list and starved_entry.
439 * scsi_request_fn must get the host_lock before checking
440 * or modifying starved_list or starved_entry.
441 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600442 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500443 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500444
Mike Christie2a3a59e2008-11-11 13:42:35 -0600445 sdev = list_entry(starved_list.next,
446 struct scsi_device, starved_entry);
447 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500448 if (scsi_target_is_busy(scsi_target(sdev))) {
449 list_move_tail(&sdev->starved_entry,
450 &shost->starved_list);
451 continue;
452 }
453
James Bottomleye2eb7242013-07-02 15:05:26 +0200454 /*
455 * Once we drop the host lock, a racing scsi_remove_device()
456 * call may remove the sdev from the starved list and destroy
457 * it and the queue. Mitigate by taking a reference to the
458 * queue and never touching the sdev again after we drop the
459 * host lock. Note: if __scsi_remove_device() invokes
460 * blk_cleanup_queue() before the queue is run from this
461 * function then blk_run_queue() will return immediately since
462 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
463 */
464 slq = sdev->request_queue;
465 if (!blk_get_queue(slq))
466 continue;
467 spin_unlock_irqrestore(shost->host_lock, flags);
468
Christoph Hellwigd2852032014-01-17 12:06:53 +0100469 scsi_kick_queue(slq);
James Bottomleye2eb7242013-07-02 15:05:26 +0200470 blk_put_queue(slq);
471
472 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600474 /* put any unprocessed entries back */
475 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800477}
478
479/*
480 * Function: scsi_run_queue()
481 *
482 * Purpose: Select a proper request queue to serve next
483 *
484 * Arguments: q - last request's queue
485 *
486 * Returns: Nothing
487 *
488 * Notes: The previous command was completely finished, start
489 * a new one if possible.
490 */
491static void scsi_run_queue(struct request_queue *q)
492{
493 struct scsi_device *sdev = q->queuedata;
494
495 if (scsi_target(sdev)->single_lun)
496 scsi_single_lun_run(sdev);
497 if (!list_empty(&sdev->host->starved_list))
498 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
Christoph Hellwigd2852032014-01-17 12:06:53 +0100500 if (q->mq_ops)
Bart Van Assche36e3cf22017-04-07 11:16:53 -0700501 blk_mq_run_hw_queues(q, false);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100502 else
503 blk_run_queue(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504}
505
Jens Axboe9937a5e2011-05-17 11:04:44 +0200506void scsi_requeue_run_queue(struct work_struct *work)
507{
508 struct scsi_device *sdev;
509 struct request_queue *q;
510
511 sdev = container_of(work, struct scsi_device, requeue_work);
512 q = sdev->request_queue;
513 scsi_run_queue(q);
514}
515
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516/*
517 * Function: scsi_requeue_command()
518 *
519 * Purpose: Handle post-processing of completed commands.
520 *
521 * Arguments: q - queue to operate on
522 * cmd - command that may need to be requeued.
523 *
524 * Returns: Nothing
525 *
526 * Notes: After command completion, there may be blocks left
527 * over which weren't finished by the previous command
528 * this can be for a number of reasons - the main one is
529 * I/O errors in the middle of the request, in which case
530 * we need to request the blocks that come after the bad
531 * sector.
James Bottomleye91442b2005-09-09 10:44:16 -0500532 * Notes: Upon return, cmd is a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 */
534static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
535{
Bart Van Assche940f5d42012-06-29 15:34:26 +0000536 struct scsi_device *sdev = cmd->device;
James Bottomleye91442b2005-09-09 10:44:16 -0500537 struct request *req = cmd->request;
Tejun Heo 283369c2005-04-24 02:06:36 -0500538 unsigned long flags;
539
Tejun Heo 283369c2005-04-24 02:06:36 -0500540 spin_lock_irqsave(q->queue_lock, flags);
Christoph Hellwig134997a2014-02-20 14:20:58 -0800541 blk_unprep_request(req);
542 req->special = NULL;
543 scsi_put_command(cmd);
James Bottomleye91442b2005-09-09 10:44:16 -0500544 blk_requeue_request(q, req);
Tejun Heo 283369c2005-04-24 02:06:36 -0500545 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
547 scsi_run_queue(q);
Bart Van Assche940f5d42012-06-29 15:34:26 +0000548
549 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550}
551
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552void scsi_run_host_queues(struct Scsi_Host *shost)
553{
554 struct scsi_device *sdev;
555
556 shost_for_each_device(sdev, shost)
557 scsi_run_queue(sdev->request_queue);
558}
559
Christoph Hellwigd2852032014-01-17 12:06:53 +0100560static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
561{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100562 if (!blk_rq_is_passthrough(cmd->request)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100563 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
564
565 if (drv->uninit_command)
566 drv->uninit_command(cmd);
567 }
568}
569
570static void scsi_mq_free_sgtables(struct scsi_cmnd *cmd)
571{
Ming Lin91dbc082016-04-04 14:48:07 -0700572 struct scsi_data_buffer *sdb;
573
Christoph Hellwigd2852032014-01-17 12:06:53 +0100574 if (cmd->sdb.table.nents)
Ming Lin001d63b2016-04-04 14:48:09 -0700575 sg_free_table_chained(&cmd->sdb.table, true);
Ming Lin91dbc082016-04-04 14:48:07 -0700576 if (cmd->request->next_rq) {
577 sdb = cmd->request->next_rq->special;
578 if (sdb)
Ming Lin001d63b2016-04-04 14:48:09 -0700579 sg_free_table_chained(&sdb->table, true);
Ming Lin91dbc082016-04-04 14:48:07 -0700580 }
Christoph Hellwigd2852032014-01-17 12:06:53 +0100581 if (scsi_prot_sg_count(cmd))
Ming Lin001d63b2016-04-04 14:48:09 -0700582 sg_free_table_chained(&cmd->prot_sdb->table, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100583}
584
585static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
586{
Christoph Hellwigd2852032014-01-17 12:06:53 +0100587 scsi_mq_free_sgtables(cmd);
588 scsi_uninit_cmd(cmd);
Bart Van Assche2dd6fb52017-06-02 14:21:58 -0700589 scsi_del_cmd_from_list(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100590}
591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592/*
593 * Function: scsi_release_buffers()
594 *
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200595 * Purpose: Free resources allocate for a scsi_command.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 *
597 * Arguments: cmd - command that we are bailing.
598 *
599 * Lock status: Assumed that no lock is held upon entry.
600 *
601 * Returns: Nothing
602 *
603 * Notes: In the event that an upper level driver rejects a
604 * command, we must release resources allocated during
605 * the __init_io() function. Primarily this would involve
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200606 * the scatter-gather table.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 */
Christoph Hellwigf1bea552014-04-15 12:26:54 +0200608static void scsi_release_buffers(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609{
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200610 if (cmd->sdb.table.nents)
Ming Lin001d63b2016-04-04 14:48:09 -0700611 sg_free_table_chained(&cmd->sdb.table, false);
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200612
613 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
614
615 if (scsi_prot_sg_count(cmd))
Ming Lin001d63b2016-04-04 14:48:09 -0700616 sg_free_table_chained(&cmd->prot_sdb->table, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617}
618
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200619static void scsi_release_bidi_buffers(struct scsi_cmnd *cmd)
620{
621 struct scsi_data_buffer *bidi_sdb = cmd->request->next_rq->special;
622
Ming Lin001d63b2016-04-04 14:48:09 -0700623 sg_free_table_chained(&bidi_sdb->table, false);
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200624 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
625 cmd->request->next_rq->special = NULL;
626}
627
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800628static bool scsi_end_request(struct request *req, int error,
629 unsigned int bytes, unsigned int bidi_bytes)
630{
631 struct scsi_cmnd *cmd = req->special;
632 struct scsi_device *sdev = cmd->device;
633 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800634
635 if (blk_update_request(req, error, bytes))
636 return true;
637
638 /* Bidi request must be completed as a whole */
639 if (unlikely(bidi_bytes) &&
640 blk_update_request(req->next_rq, error, bidi_bytes))
641 return true;
642
643 if (blk_queue_add_random(q))
644 add_disk_randomness(req->rq_disk);
645
Christoph Hellwigd2852032014-01-17 12:06:53 +0100646 if (req->mq_ctx) {
647 /*
Christoph Hellwigc8a446a2014-09-13 16:40:10 -0700648 * In the MQ case the command gets freed by __blk_mq_end_request,
Christoph Hellwigd2852032014-01-17 12:06:53 +0100649 * so we have to do all cleanup that depends on it earlier.
650 *
651 * We also can't kick the queues from irq context, so we
652 * will have to defer it to a workqueue.
653 */
654 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800655
Christoph Hellwigc8a446a2014-09-13 16:40:10 -0700656 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100657
658 if (scsi_target(sdev)->single_lun ||
659 !list_empty(&sdev->host->starved_list))
660 kblockd_schedule_work(&sdev->requeue_work);
661 else
Bart Van Assche36e3cf22017-04-07 11:16:53 -0700662 blk_mq_run_hw_queues(q, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100663 } else {
664 unsigned long flags;
665
Daniel Gryniewiczf81426a2014-09-16 10:41:13 -0400666 if (bidi_bytes)
667 scsi_release_bidi_buffers(cmd);
Christoph Hellwige9c787e2017-01-02 21:55:26 +0300668 scsi_release_buffers(cmd);
669 scsi_put_command(cmd);
Daniel Gryniewiczf81426a2014-09-16 10:41:13 -0400670
Christoph Hellwigd2852032014-01-17 12:06:53 +0100671 spin_lock_irqsave(q->queue_lock, flags);
672 blk_finish_request(req, error);
673 spin_unlock_irqrestore(q->queue_lock, flags);
674
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700675 scsi_run_queue(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100676 }
677
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700678 put_device(&sdev->sdev_gendev);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800679 return false;
680}
681
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200682/**
683 * __scsi_error_from_host_byte - translate SCSI error code into errno
684 * @cmd: SCSI command (unused)
685 * @result: scsi error code
686 *
687 * Translate SCSI error code into standard UNIX errno.
688 * Return values:
689 * -ENOLINK temporary transport failure
690 * -EREMOTEIO permanent target failure, do not retry
691 * -EBADE permanent nexus failure, retry on other path
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200692 * -ENOSPC No write space available
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200693 * -ENODATA Medium error
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200694 * -EIO unspecified I/O error
695 */
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100696static int __scsi_error_from_host_byte(struct scsi_cmnd *cmd, int result)
697{
698 int error = 0;
699
700 switch(host_byte(result)) {
701 case DID_TRANSPORT_FAILFAST:
702 error = -ENOLINK;
703 break;
704 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000705 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100706 error = -EREMOTEIO;
707 break;
708 case DID_NEXUS_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000709 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100710 error = -EBADE;
711 break;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200712 case DID_ALLOC_FAILURE:
713 set_host_byte(cmd, DID_OK);
714 error = -ENOSPC;
715 break;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200716 case DID_MEDIUM_ERROR:
717 set_host_byte(cmd, DID_OK);
718 error = -ENODATA;
719 break;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100720 default:
721 error = -EIO;
722 break;
723 }
724
725 return error;
726}
727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728/*
729 * Function: scsi_io_completion()
730 *
731 * Purpose: Completion processing for block device I/O requests.
732 *
733 * Arguments: cmd - command that is finished.
734 *
735 * Lock status: Assumed that no lock is held upon entry.
736 *
737 * Returns: Nothing
738 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200739 * Notes: We will finish off the specified number of sectors. If we
740 * are done, the command block will be released and the queue
741 * function will be goosed. If we are not done then we have to
Alan Sternb60af5b2008-11-03 15:56:47 -0500742 * figure out what to do next:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500744 * a) We can call scsi_requeue_command(). The request
745 * will be unprepared and put back on the queue. Then
746 * a new command will be created for it. This should
747 * be used if we made forward progress, or if we want
748 * to switch from READ(10) to READ(6) for example.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200750 * b) We can call __scsi_queue_insert(). The request will
Alan Sternb60af5b2008-11-03 15:56:47 -0500751 * be put back on the queue and retried using the same
752 * command as before, possibly after a delay.
753 *
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800754 * c) We can call scsi_end_request() with -EIO to fail
Alan Sternb60af5b2008-11-03 15:56:47 -0500755 * the remainder of the request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 */
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700757void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758{
759 int result = cmd->result;
Jens Axboe165125e2007-07-24 09:28:11 +0200760 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 struct request *req = cmd->request;
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500762 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 struct scsi_sense_hdr sshdr;
Hannes Reinecke4753cbc2014-10-24 14:26:52 +0200764 bool sense_valid = false;
Hannes Reineckec11c0042014-10-24 14:27:01 +0200765 int sense_deferred = 0, level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500766 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
767 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900768 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 if (result) {
771 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
772 if (sense_valid)
773 sense_deferred = scsi_sense_is_deferred(&sshdr);
774 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200775
Christoph Hellwig57292b52017-01-31 16:57:29 +0100776 if (blk_rq_is_passthrough(req)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 if (result) {
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100778 if (sense_valid) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 /*
780 * SG_IO wants current and deferred errors
781 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100782 scsi_req(req)->sense_len =
783 min(8 + cmd->sense_buffer[7],
784 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 }
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500786 if (!sense_deferred)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100787 error = __scsi_error_from_host_byte(cmd, result);
Pete Wyckoffb22f6872007-03-13 16:53:28 -0400788 }
Mike Snitzer27c41972012-05-31 15:05:33 -0400789 /*
790 * __scsi_error_from_host_byte may have reset the host_byte
791 */
Christoph Hellwig17d53632017-04-20 16:03:01 +0200792 scsi_req(req)->result = cmd->result;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100793 scsi_req(req)->resid_len = scsi_get_resid(cmd);
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900794
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200795 if (scsi_bidi_cmnd(cmd)) {
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900796 /*
797 * Bidi commands Must be complete as a whole,
798 * both sides at once.
799 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100800 scsi_req(req->next_rq)->resid_len = scsi_in(cmd)->resid;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800801 if (scsi_end_request(req, 0, blk_rq_bytes(req),
802 blk_rq_bytes(req->next_rq)))
803 BUG();
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200804 return;
805 }
James Bottomley89fb4cd2014-07-03 19:17:34 +0200806 } else if (blk_rq_bytes(req) == 0 && result && !sense_deferred) {
807 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100808 * Flush commands do not transfers any data, and thus cannot use
James Bottomley89fb4cd2014-07-03 19:17:34 +0200809 * good_bytes != blk_rq_bytes(req) as the signal for an error.
810 * This sets the error explicitly for the problem case.
811 */
812 error = __scsi_error_from_host_byte(cmd, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 }
814
Christoph Hellwig57292b52017-01-31 16:57:29 +0100815 /* no bidi support for !blk_rq_is_passthrough yet */
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200816 BUG_ON(blk_bidi_rq(req));
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200817
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 * Next deal with any sectors which we were able to correctly
820 * handle.
821 */
Hannes Reinecke91921e02014-06-25 16:39:59 +0200822 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
823 "%u sectors total, %d bytes done.\n",
824 blk_rq_sectors(req), good_bytes));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
James Bottomleya9bddd72009-03-30 16:55:51 +0000826 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100827 * Recovered errors need reporting, but they're always treated as
828 * success, so fiddle the result code here. For passthrough requests
Christoph Hellwig17d53632017-04-20 16:03:01 +0200829 * we already took a copy of the original into sreq->result which
James Bottomleya9bddd72009-03-30 16:55:51 +0000830 * is what gets returned to the user
831 */
Douglas Gilberte7efe592010-01-03 13:51:15 -0500832 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
833 /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
834 * print since caller wants ATA registers. Only occurs on
835 * SCSI ATA PASS_THROUGH commands when CK_COND=1
836 */
837 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
838 ;
Christoph Hellwige8064022016-10-20 15:12:13 +0200839 else if (!(req->rq_flags & RQF_QUIET))
Hannes Reinecked811b842014-10-24 14:26:45 +0200840 scsi_print_sense(cmd);
James Bottomleya9bddd72009-03-30 16:55:51 +0000841 result = 0;
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100842 /* for passthrough error may be set */
James Bottomleya9bddd72009-03-30 16:55:51 +0000843 error = 0;
844 }
845
846 /*
James Bottomleya621bac2016-05-13 12:04:06 -0700847 * special case: failed zero length commands always need to
848 * drop down into the retry code. Otherwise, if we finished
849 * all bytes in the request we are done now.
James Bottomleyd6b0c532006-07-02 10:06:28 -0500850 */
James Bottomleya621bac2016-05-13 12:04:06 -0700851 if (!(blk_rq_bytes(req) == 0 && error) &&
852 !scsi_end_request(req, error, good_bytes, 0))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800853 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200854
855 /*
856 * Kill remainder if no retrys.
857 */
858 if (error && scsi_noretry_cmd(cmd)) {
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800859 if (scsi_end_request(req, error, blk_rq_bytes(req), 0))
860 BUG();
861 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200862 }
863
864 /*
865 * If there had been no error, but we have leftover bytes in the
866 * requeues just queue the command up again.
867 */
868 if (result == 0)
869 goto requeue;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700870
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100871 error = __scsi_error_from_host_byte(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500872
Alan Sternb60af5b2008-11-03 15:56:47 -0500873 if (host_byte(result) == DID_RESET) {
874 /* Third party bus reset or reset for error recovery
875 * reasons. Just retry the command and see what
876 * happens.
877 */
878 action = ACTION_RETRY;
879 } else if (sense_valid && !sense_deferred) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 switch (sshdr.sense_key) {
881 case UNIT_ATTENTION:
882 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700883 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 * and quietly refuse further access.
885 */
886 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500887 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700889 /* Must have been a power glitch, or a
890 * bus reset. Could not have been a
891 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500892 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700893 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500894 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 }
896 break;
897 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700898 /* If we had an ILLEGAL REQUEST returned, then
899 * we may have performed an unsupported
900 * command. The only thing this should be
901 * would be a ten byte read where only a six
902 * byte read was supported. Also, on a system
903 * where READ CAPACITY failed, we may have
904 * read past the end of the disk.
905 */
Jens Axboe26a68012005-11-29 21:03:34 +0100906 if ((cmd->device->use_10_for_rw &&
907 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 (cmd->cmnd[0] == READ_10 ||
909 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500910 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500912 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500913 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500914 action = ACTION_FAIL;
915 error = -EILSEQ;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500916 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400917 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500918 action = ACTION_FAIL;
Martin K. Petersen66a651a2012-02-13 15:38:22 -0500919 error = -EREMOTEIO;
Alan Sternb60af5b2008-11-03 15:56:47 -0500920 } else
921 action = ACTION_FAIL;
922 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400923 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000924 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200925 if (sshdr.asc == 0x10) /* DIF */
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500926 error = -EILSEQ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 break;
928 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700929 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500930 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500932 if (sshdr.asc == 0x04) {
933 switch (sshdr.ascq) {
934 case 0x01: /* becoming ready */
935 case 0x04: /* format in progress */
936 case 0x05: /* rebuild in progress */
937 case 0x06: /* recalculation in progress */
938 case 0x07: /* operation in progress */
939 case 0x08: /* Long write in progress */
940 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500941 case 0x14: /* space allocation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500942 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500943 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500944 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500945 action = ACTION_FAIL;
946 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500947 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200948 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500949 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500950 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700952 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500953 action = ACTION_FAIL;
954 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500956 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 break;
958 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200959 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500960 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500961
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900962 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200963 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900964 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900965
Alan Sternb60af5b2008-11-03 15:56:47 -0500966 switch (action) {
967 case ACTION_FAIL:
968 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200969 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200970 static DEFINE_RATELIMIT_STATE(_rs,
971 DEFAULT_RATELIMIT_INTERVAL,
972 DEFAULT_RATELIMIT_BURST);
973
974 if (unlikely(scsi_logging_level))
975 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
976 SCSI_LOG_MLCOMPLETE_BITS);
977
978 /*
979 * if logging is enabled the failure will be printed
980 * in scsi_log_completion(), so avoid duplicate messages
981 */
982 if (!level && __ratelimit(&_rs)) {
983 scsi_print_result(cmd, NULL, FAILED);
984 if (driver_byte(result) & DRIVER_SENSE)
985 scsi_print_sense(cmd);
986 scsi_print_command(cmd);
987 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500988 }
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800989 if (!scsi_end_request(req, error, blk_rq_err_bytes(req), 0))
990 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200991 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500992 case ACTION_REPREP:
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200993 requeue:
Alan Sternb60af5b2008-11-03 15:56:47 -0500994 /* Unprep the request and put it back at the head of the queue.
995 * A new command will be prepared and issued.
996 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100997 if (q->mq_ops) {
Christoph Hellwige8064022016-10-20 15:12:13 +0200998 cmd->request->rq_flags &= ~RQF_DONTPREP;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100999 scsi_mq_uninit_cmd(cmd);
1000 scsi_mq_requeue_cmd(cmd);
1001 } else {
1002 scsi_release_buffers(cmd);
1003 scsi_requeue_command(q, cmd);
1004 }
Alan Sternb60af5b2008-11-03 15:56:47 -05001005 break;
1006 case ACTION_RETRY:
1007 /* Retry the same command immediately */
James Bottomley4f5299a2009-01-02 10:42:21 -06001008 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001009 break;
1010 case ACTION_DELAYED_RETRY:
1011 /* Retry the same command after a delay */
James Bottomley4f5299a2009-01-02 10:42:21 -06001012 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001013 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 }
1015}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001017static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001019 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
1021 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001022 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001024 if (unlikely(sg_alloc_table_chained(&sdb->table,
1025 blk_rq_nr_phys_segments(req), sdb->table.sgl)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 return BLKPREP_DEFER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 /*
1029 * Next, walk the list, and fill in the addresses and sizes of
1030 * each segment.
1031 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001032 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1033 BUG_ON(count > sdb->table.nents);
1034 sdb->table.nents = count;
Christoph Hellwigfd102b12017-01-13 12:29:11 +01001035 sdb->length = blk_rq_payload_bytes(req);
Rusty Russell4a03d902007-11-19 11:28:48 +11001036 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001038
1039/*
1040 * Function: scsi_init_io()
1041 *
1042 * Purpose: SCSI I/O initialize function.
1043 *
1044 * Arguments: cmd - Command descriptor we wish to initialize
1045 *
1046 * Returns: 0 on success
1047 * BLKPREP_DEFER if the failure is retryable
1048 * BLKPREP_KILL if the failure is fatal
1049 */
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001050int scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001051{
Christoph Hellwig5e012aa2014-04-15 12:24:55 +02001052 struct scsi_device *sdev = cmd->device;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001053 struct request *rq = cmd->request;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001054 bool is_mq = (rq->mq_ctx != NULL);
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001055 int error = BLKPREP_KILL;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001056
Johannes Thumshirnfd3fc0b2017-01-31 10:16:00 +01001057 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001058 goto err_exit;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001059
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001060 error = scsi_init_sgtable(rq, &cmd->sdb);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001061 if (error)
1062 goto err_exit;
1063
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001064 if (blk_bidi_rq(rq)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001065 if (!rq->q->mq_ops) {
1066 struct scsi_data_buffer *bidi_sdb =
1067 kmem_cache_zalloc(scsi_sdb_cache, GFP_ATOMIC);
1068 if (!bidi_sdb) {
1069 error = BLKPREP_DEFER;
1070 goto err_exit;
1071 }
1072
1073 rq->next_rq->special = bidi_sdb;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001074 }
1075
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001076 error = scsi_init_sgtable(rq->next_rq, rq->next_rq->special);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001077 if (error)
1078 goto err_exit;
1079 }
1080
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001081 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001082 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1083 int ivecs, count;
1084
Ewan D. Milne91724c22015-01-15 10:02:12 -05001085 if (prot_sdb == NULL) {
1086 /*
1087 * This can happen if someone (e.g. multipath)
1088 * queues a command to a device on an adapter
1089 * that does not support DIX.
1090 */
1091 WARN_ON_ONCE(1);
1092 error = BLKPREP_KILL;
1093 goto err_exit;
1094 }
1095
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001096 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001097
Ming Lin001d63b2016-04-04 14:48:09 -07001098 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lin22cc3d42016-04-04 14:48:08 -07001099 prot_sdb->table.sgl)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001100 error = BLKPREP_DEFER;
1101 goto err_exit;
1102 }
1103
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001104 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001105 prot_sdb->table.sgl);
1106 BUG_ON(unlikely(count > ivecs));
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001107 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001108
1109 cmd->prot_sdb = prot_sdb;
1110 cmd->prot_sdb->table.nents = count;
1111 }
1112
Christoph Hellwigd2852032014-01-17 12:06:53 +01001113 return BLKPREP_OK;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001114err_exit:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001115 if (is_mq) {
1116 scsi_mq_free_sgtables(cmd);
1117 } else {
1118 scsi_release_buffers(cmd);
1119 cmd->request->special = NULL;
1120 scsi_put_command(cmd);
1121 put_device(&sdev->sdev_gendev);
1122 }
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001123 return error;
1124}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001125EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001127/* Add a command to the list used by the aacraid and dpt_i2o drivers */
1128void scsi_add_cmd_to_list(struct scsi_cmnd *cmd)
1129{
1130 struct scsi_device *sdev = cmd->device;
1131 struct Scsi_Host *shost = sdev->host;
1132 unsigned long flags;
1133
1134 if (shost->use_cmd_list) {
1135 spin_lock_irqsave(&sdev->list_lock, flags);
1136 list_add_tail(&cmd->list, &sdev->cmd_list);
1137 spin_unlock_irqrestore(&sdev->list_lock, flags);
1138 }
1139}
1140
1141/* Remove a command from the list used by the aacraid and dpt_i2o drivers */
1142void scsi_del_cmd_from_list(struct scsi_cmnd *cmd)
1143{
1144 struct scsi_device *sdev = cmd->device;
1145 struct Scsi_Host *shost = sdev->host;
1146 unsigned long flags;
1147
1148 if (shost->use_cmd_list) {
1149 spin_lock_irqsave(&sdev->list_lock, flags);
1150 BUG_ON(list_empty(&cmd->list));
1151 list_del_init(&cmd->list);
1152 spin_unlock_irqrestore(&sdev->list_lock, flags);
1153 }
1154}
1155
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001156void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001157{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001158 void *buf = cmd->sense_buffer;
1159 void *prot = cmd->prot_sdb;
Bart Van Assche8e688252017-06-02 14:21:52 -07001160 unsigned int unchecked_isa_dma = cmd->flags & SCMD_UNCHECKED_ISA_DMA;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001161
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001162 /* zero out the cmd, except for the embedded scsi_request */
1163 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001164 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001165
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001166 cmd->device = dev;
1167 cmd->sense_buffer = buf;
1168 cmd->prot_sdb = prot;
Bart Van Assche8e688252017-06-02 14:21:52 -07001169 cmd->flags = unchecked_isa_dma;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001170 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1171 cmd->jiffies_at_alloc = jiffies;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001172
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001173 scsi_add_cmd_to_list(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001174}
1175
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001176static int scsi_setup_scsi_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001177{
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001178 struct scsi_cmnd *cmd = req->special;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001179
1180 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001181 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001182 * a bio attached to them. Or they might contain a SCSI command
1183 * that does not transfer data, in which case they may optionally
1184 * submit a request without an attached bio.
1185 */
1186 if (req->bio) {
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001187 int ret = scsi_init_io(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001188 if (unlikely(ret))
1189 return ret;
1190 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001191 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001192
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001193 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001194 }
James Bottomley7b163182005-12-15 20:17:02 -06001195
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001196 cmd->cmd_len = scsi_req(req)->cmd_len;
1197 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001198 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001199 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001200 return BLKPREP_OK;
1201}
1202
1203/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001204 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001205 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001206 */
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001207static int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001208{
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001209 struct scsi_cmnd *cmd = req->special;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001210
Christoph Hellwigee14c672015-08-27 14:16:59 +02001211 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
1212 int ret = sdev->handler->prep_fn(sdev, req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001213 if (ret != BLKPREP_OK)
1214 return ret;
1215 }
1216
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001217 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001218 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001219 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001220}
James Bottomley7b163182005-12-15 20:17:02 -06001221
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001222static int scsi_setup_cmnd(struct scsi_device *sdev, struct request *req)
1223{
1224 struct scsi_cmnd *cmd = req->special;
1225
1226 if (!blk_rq_bytes(req))
1227 cmd->sc_data_direction = DMA_NONE;
1228 else if (rq_data_dir(req) == WRITE)
1229 cmd->sc_data_direction = DMA_TO_DEVICE;
1230 else
1231 cmd->sc_data_direction = DMA_FROM_DEVICE;
1232
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001233 if (blk_rq_is_scsi(req))
1234 return scsi_setup_scsi_cmnd(sdev, req);
1235 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001236 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001237}
1238
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001239static int
1240scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001242 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243
1244 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001245 * If the device is not in running state we will reject some
1246 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001249 switch (sdev->sdev_state) {
1250 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05001251 case SDEV_TRANSPORT_OFFLINE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001252 /*
1253 * If the device is offline we refuse to process any
1254 * commands. The device must be brought online
1255 * before trying any recovery commands.
1256 */
1257 sdev_printk(KERN_ERR, sdev,
1258 "rejecting I/O to offline device\n");
1259 ret = BLKPREP_KILL;
1260 break;
1261 case SDEV_DEL:
1262 /*
1263 * If the device is fully deleted, we refuse to
1264 * process any commands as well.
1265 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001266 sdev_printk(KERN_ERR, sdev,
1267 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001268 ret = BLKPREP_KILL;
1269 break;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001270 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001271 case SDEV_CREATED_BLOCK:
Bart Van Asschebba0bdd2015-03-04 10:31:47 +01001272 ret = BLKPREP_DEFER;
1273 break;
1274 case SDEV_QUIESCE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001275 /*
1276 * If the devices is blocked we defer normal commands.
1277 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001278 if (!(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001279 ret = BLKPREP_DEFER;
1280 break;
1281 default:
1282 /*
1283 * For any other not fully online state we only allow
1284 * special commands. In particular any user initiated
1285 * command is not allowed.
1286 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001287 if (!(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001288 ret = BLKPREP_KILL;
1289 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001292 return ret;
1293}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001295static int
1296scsi_prep_return(struct request_queue *q, struct request *req, int ret)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001297{
1298 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299
Christoph Hellwig3b003152006-11-04 20:10:55 +01001300 switch (ret) {
1301 case BLKPREP_KILL:
jiangyiwene1cd3912016-02-16 20:14:13 +08001302 case BLKPREP_INVALID:
Christoph Hellwig17d53632017-04-20 16:03:01 +02001303 scsi_req(req)->result = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001304 /* release the command and kill it */
1305 if (req->special) {
1306 struct scsi_cmnd *cmd = req->special;
1307 scsi_release_buffers(cmd);
1308 scsi_put_command(cmd);
Christoph Hellwig68c03d92014-04-15 12:24:56 +02001309 put_device(&sdev->sdev_gendev);
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001310 req->special = NULL;
1311 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001312 break;
1313 case BLKPREP_DEFER:
1314 /*
Tejun Heo9934c8c2009-05-08 11:54:16 +09001315 * If we defer, the blk_peek_request() returns NULL, but the
Jens Axboea488e742010-04-16 21:13:15 +02001316 * queue must be restarted, so we schedule a callback to happen
1317 * shortly.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001318 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001319 if (atomic_read(&sdev->device_busy) == 0)
Jens Axboea488e742010-04-16 21:13:15 +02001320 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001321 break;
1322 default:
Christoph Hellwige8064022016-10-20 15:12:13 +02001323 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001324 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
Christoph Hellwig3b003152006-11-04 20:10:55 +01001326 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001328
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001329static int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001330{
1331 struct scsi_device *sdev = q->queuedata;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001332 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001333 int ret;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001334
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001335 ret = scsi_prep_state_check(sdev, req);
1336 if (ret != BLKPREP_OK)
1337 goto out;
1338
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001339 if (!req->special) {
1340 /* Bail if we can't get a reference to the device */
1341 if (unlikely(!get_device(&sdev->sdev_gendev))) {
1342 ret = BLKPREP_DEFER;
1343 goto out;
1344 }
1345
1346 scsi_init_command(sdev, cmd);
1347 req->special = cmd;
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001348 }
1349
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001350 cmd->tag = req->tag;
1351 cmd->request = req;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001352 cmd->prot_op = SCSI_PROT_NORMAL;
1353
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001354 ret = scsi_setup_cmnd(sdev, req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001355out:
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001356 return scsi_prep_return(q, req, ret);
1357}
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001358
1359static void scsi_unprep_fn(struct request_queue *q, struct request *req)
1360{
Christoph Hellwigd2852032014-01-17 12:06:53 +01001361 scsi_uninit_cmd(req->special);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001362}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363
1364/*
1365 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1366 * return 0.
1367 *
1368 * Called with the queue_lock held.
1369 */
1370static inline int scsi_dev_queue_ready(struct request_queue *q,
1371 struct scsi_device *sdev)
1372{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001373 unsigned int busy;
1374
1375 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001376 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001377 if (busy)
1378 goto out_dec;
1379
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 /*
1381 * unblock after device_blocked iterates to zero
1382 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001383 if (atomic_dec_return(&sdev->device_blocked) > 0) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001384 /*
1385 * For the MQ case we take care of this in the caller.
1386 */
1387 if (!q->mq_ops)
1388 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001389 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001391 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1392 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001394
1395 if (busy >= sdev->queue_depth)
1396 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397
1398 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001399out_dec:
1400 atomic_dec(&sdev->device_busy);
1401 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402}
1403
Mike Christief0c0a372008-08-17 15:24:38 -05001404/*
1405 * scsi_target_queue_ready: checks if there we can send commands to target
1406 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001407 */
1408static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1409 struct scsi_device *sdev)
1410{
1411 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001412 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001413
1414 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001415 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001416 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001417 starget->starget_sdev_user != sdev) {
1418 spin_unlock_irq(shost->host_lock);
1419 return 0;
1420 }
Mike Christief0c0a372008-08-17 15:24:38 -05001421 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001422 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001423 }
1424
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001425 if (starget->can_queue <= 0)
1426 return 1;
1427
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001428 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001429 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001430 if (busy)
1431 goto starved;
1432
Mike Christief0c0a372008-08-17 15:24:38 -05001433 /*
1434 * unblock after target_blocked iterates to zero
1435 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001436 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001437 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001438
1439 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1440 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001441 }
1442
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001443 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001444 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001445
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001446 return 1;
1447
1448starved:
1449 spin_lock_irq(shost->host_lock);
1450 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001451 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001452out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001453 if (starget->can_queue > 0)
1454 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001455 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001456}
1457
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458/*
1459 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1460 * return 0. We must end up running the queue again whenever 0 is
1461 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 */
1463static inline int scsi_host_queue_ready(struct request_queue *q,
1464 struct Scsi_Host *shost,
1465 struct scsi_device *sdev)
1466{
Christoph Hellwig74665012014-01-22 15:29:29 +01001467 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001468
James Bottomley939647e2005-09-18 15:05:20 -05001469 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001470 return 0;
1471
1472 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001473 if (atomic_read(&shost->host_blocked) > 0) {
Christoph Hellwig74665012014-01-22 15:29:29 +01001474 if (busy)
1475 goto starved;
1476
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 /*
1478 * unblock after host_blocked iterates to zero
1479 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001480 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001481 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001482
1483 SCSI_LOG_MLQUEUE(3,
1484 shost_printk(KERN_INFO, shost,
1485 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001487
1488 if (shost->can_queue > 0 && busy >= shost->can_queue)
1489 goto starved;
1490 if (shost->host_self_blocked)
1491 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492
1493 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001494 if (!list_empty(&sdev->starved_entry)) {
1495 spin_lock_irq(shost->host_lock);
1496 if (!list_empty(&sdev->starved_entry))
1497 list_del_init(&sdev->starved_entry);
1498 spin_unlock_irq(shost->host_lock);
1499 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500
Christoph Hellwig74665012014-01-22 15:29:29 +01001501 return 1;
1502
1503starved:
1504 spin_lock_irq(shost->host_lock);
1505 if (list_empty(&sdev->starved_entry))
1506 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001507 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001508out_dec:
1509 atomic_dec(&shost->host_busy);
1510 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511}
1512
1513/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001514 * Busy state exporting function for request stacking drivers.
1515 *
1516 * For efficiency, no lock is taken to check the busy state of
1517 * shost/starget/sdev, since the returned value is not guaranteed and
1518 * may be changed after request stacking drivers call the function,
1519 * regardless of taking lock or not.
1520 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001521 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1522 * needs to return 'not busy'. Otherwise, request stacking drivers
1523 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001524 */
1525static int scsi_lld_busy(struct request_queue *q)
1526{
1527 struct scsi_device *sdev = q->queuedata;
1528 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001529
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001530 if (blk_queue_dying(q))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001531 return 0;
1532
1533 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001534
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001535 /*
1536 * Ignore host/starget busy state.
1537 * Since block layer does not have a concept of fairness across
1538 * multiple queues, congestion of host/starget needs to be handled
1539 * in SCSI layer.
1540 */
1541 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001542 return 1;
1543
1544 return 0;
1545}
1546
1547/*
James Bottomleye91442b2005-09-09 10:44:16 -05001548 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 */
Jens Axboe165125e2007-07-24 09:28:11 +02001550static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551{
James Bottomleye91442b2005-09-09 10:44:16 -05001552 struct scsi_cmnd *cmd = req->special;
Jiri Slaby03b14702009-09-23 16:15:35 +02001553 struct scsi_device *sdev;
1554 struct scsi_target *starget;
1555 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
Tejun Heo9934c8c2009-05-08 11:54:16 +09001557 blk_start_request(req);
James Bottomley788ce432005-09-09 13:40:23 -05001558
Hannes Reinecke74571812011-11-09 08:39:24 +01001559 scmd_printk(KERN_INFO, cmd, "killing request\n");
1560
Jiri Slaby03b14702009-09-23 16:15:35 +02001561 sdev = cmd->device;
1562 starget = scsi_target(sdev);
1563 shost = sdev->host;
James Bottomleye91442b2005-09-09 10:44:16 -05001564 scsi_init_cmd_errh(cmd);
1565 cmd->result = DID_NO_CONNECT << 16;
1566 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001567
1568 /*
1569 * SCSI request completion path will do scsi_device_unbusy(),
1570 * bump busy counts. To bump the counters, we need to dance
1571 * with the locks as normal issue path does.
1572 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001573 atomic_inc(&sdev->device_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +01001574 atomic_inc(&shost->host_busy);
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001575 if (starget->can_queue > 0)
1576 atomic_inc(&starget->target_busy);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001577
Jens Axboe242f9dc2008-09-14 05:55:09 -07001578 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579}
1580
Jens Axboe1aea6432006-01-09 16:03:03 +01001581static void scsi_softirq_done(struct request *rq)
1582{
Jens Axboe242f9dc2008-09-14 05:55:09 -07001583 struct scsi_cmnd *cmd = rq->special;
1584 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001585 int disposition;
1586
1587 INIT_LIST_HEAD(&cmd->eh_entry);
1588
Jens Axboe242f9dc2008-09-14 05:55:09 -07001589 atomic_inc(&cmd->device->iodone_cnt);
1590 if (cmd->result)
1591 atomic_inc(&cmd->device->ioerr_cnt);
1592
Jens Axboe1aea6432006-01-09 16:03:03 +01001593 disposition = scsi_decide_disposition(cmd);
1594 if (disposition != SUCCESS &&
1595 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1596 sdev_printk(KERN_ERR, cmd->device,
1597 "timing out command, waited %lus\n",
1598 wait_for/HZ);
1599 disposition = SUCCESS;
1600 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001601
Jens Axboe1aea6432006-01-09 16:03:03 +01001602 scsi_log_completion(cmd, disposition);
1603
1604 switch (disposition) {
1605 case SUCCESS:
1606 scsi_finish_command(cmd);
1607 break;
1608 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001609 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001610 break;
1611 case ADD_TO_MLQUEUE:
1612 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1613 break;
1614 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001615 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001616 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001617 }
1618}
1619
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001620/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001621 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1622 * @cmd: command block we are dispatching.
1623 *
1624 * Return: nonzero return request was rejected and device's queue needs to be
1625 * plugged.
1626 */
1627static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1628{
1629 struct Scsi_Host *host = cmd->device->host;
1630 int rtn = 0;
1631
1632 atomic_inc(&cmd->device->iorequest_cnt);
1633
1634 /* check if the device is still usable */
1635 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1636 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1637 * returns an immediate error upwards, and signals
1638 * that the device is no longer present */
1639 cmd->result = DID_NO_CONNECT << 16;
1640 goto done;
1641 }
1642
1643 /* Check to see if the scsi lld made this device blocked. */
1644 if (unlikely(scsi_device_blocked(cmd->device))) {
1645 /*
1646 * in blocked state, the command is just put back on
1647 * the device queue. The suspend state has already
1648 * blocked the queue so future requests should not
1649 * occur until the device transitions out of the
1650 * suspend state.
1651 */
1652 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1653 "queuecommand : device blocked\n"));
1654 return SCSI_MLQUEUE_DEVICE_BUSY;
1655 }
1656
1657 /* Store the LUN value in cmnd, if needed. */
1658 if (cmd->device->lun_in_cdb)
1659 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1660 (cmd->device->lun << 5 & 0xe0);
1661
1662 scsi_log_send(cmd);
1663
1664 /*
1665 * Before we queue this command, check if the command
1666 * length exceeds what the host adapter can handle.
1667 */
1668 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1669 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1670 "queuecommand : command too long. "
1671 "cdb_size=%d host->max_cmd_len=%d\n",
1672 cmd->cmd_len, cmd->device->host->max_cmd_len));
1673 cmd->result = (DID_ABORT << 16);
1674 goto done;
1675 }
1676
1677 if (unlikely(host->shost_state == SHOST_DEL)) {
1678 cmd->result = (DID_NO_CONNECT << 16);
1679 goto done;
1680
1681 }
1682
1683 trace_scsi_dispatch_cmd_start(cmd);
1684 rtn = host->hostt->queuecommand(host, cmd);
1685 if (rtn) {
1686 trace_scsi_dispatch_cmd_error(cmd, rtn);
1687 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1688 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1689 rtn = SCSI_MLQUEUE_HOST_BUSY;
1690
1691 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1692 "queuecommand : request rejected\n"));
1693 }
1694
1695 return rtn;
1696 done:
1697 cmd->scsi_done(cmd);
1698 return 0;
1699}
1700
1701/**
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001702 * scsi_done - Invoke completion on finished SCSI command.
1703 * @cmd: The SCSI Command for which a low-level device driver (LLDD) gives
1704 * ownership back to SCSI Core -- i.e. the LLDD has finished with it.
1705 *
1706 * Description: This function is the mid-level's (SCSI Core) interrupt routine,
1707 * which regains ownership of the SCSI command (de facto) from a LLDD, and
1708 * calls blk_complete_request() for further processing.
1709 *
1710 * This function is interrupt context safe.
1711 */
1712static void scsi_done(struct scsi_cmnd *cmd)
1713{
1714 trace_scsi_dispatch_cmd_done(cmd);
1715 blk_complete_request(cmd->request);
1716}
1717
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718/*
1719 * Function: scsi_request_fn()
1720 *
1721 * Purpose: Main strategy routine for SCSI.
1722 *
1723 * Arguments: q - Pointer to actual queue.
1724 *
1725 * Returns: Nothing
1726 *
1727 * Lock status: IO request lock assumed to be held when called.
1728 */
1729static void scsi_request_fn(struct request_queue *q)
Bart Van Assche613be1f2014-02-20 14:20:56 -08001730 __releases(q->queue_lock)
1731 __acquires(q->queue_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732{
1733 struct scsi_device *sdev = q->queuedata;
1734 struct Scsi_Host *shost;
1735 struct scsi_cmnd *cmd;
1736 struct request *req;
1737
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 /*
1739 * To start with, we keep looping until the queue is empty, or until
1740 * the host is no longer able to accept any more requests.
1741 */
1742 shost = sdev->host;
Jens Axboea488e742010-04-16 21:13:15 +02001743 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 int rtn;
1745 /*
1746 * get next queueable request. We do this early to make sure
Hannes Reinecke91921e02014-06-25 16:39:59 +02001747 * that the request is fully prepared even if we cannot
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 * accept it.
1749 */
Tejun Heo9934c8c2009-05-08 11:54:16 +09001750 req = blk_peek_request(q);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001751 if (!req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 break;
1753
1754 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001755 sdev_printk(KERN_ERR, sdev,
1756 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001757 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 continue;
1759 }
1760
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001761 if (!scsi_dev_queue_ready(q, sdev))
1762 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
1764 /*
1765 * Remove the request from the request list.
1766 */
1767 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
Tejun Heo9934c8c2009-05-08 11:54:16 +09001768 blk_start_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001770 spin_unlock_irq(q->queue_lock);
James Bottomleye91442b2005-09-09 10:44:16 -05001771 cmd = req->special;
1772 if (unlikely(cmd == NULL)) {
1773 printk(KERN_CRIT "impossible request in %s.\n"
1774 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001775 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001776 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001777 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001778 BUG();
1779 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780
Mike Christieecefe8a2008-07-11 19:50:35 -05001781 /*
1782 * We hit this when the driver is using a host wide
1783 * tag map. For device level tag maps the queue_depth check
1784 * in the device ready fn would prevent us from trying
1785 * to allocate a tag. Since the map is a shared host resource
1786 * we add the dev to the starved list so it eventually gets
1787 * a run when a tag is freed.
1788 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001789 if (blk_queue_tagged(q) && !(req->rq_flags & RQF_QUEUED)) {
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001790 spin_lock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001791 if (list_empty(&sdev->starved_entry))
1792 list_add_tail(&sdev->starved_entry,
1793 &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001794 spin_unlock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001795 goto not_ready;
1796 }
1797
Mike Christief0c0a372008-08-17 15:24:38 -05001798 if (!scsi_target_queue_ready(shost, sdev))
1799 goto not_ready;
1800
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 if (!scsi_host_queue_ready(q, shost, sdev))
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001802 goto host_not_ready;
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001803
1804 if (sdev->simple_tags)
1805 cmd->flags |= SCMD_TAGGED;
1806 else
1807 cmd->flags &= ~SCMD_TAGGED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 /*
1810 * Finally, initialize any error handling parameters, and set up
1811 * the timers for timeouts.
1812 */
1813 scsi_init_cmd_errh(cmd);
1814
1815 /*
1816 * Dispatch the command to the low-level driver.
1817 */
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001818 cmd->scsi_done = scsi_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 rtn = scsi_dispatch_cmd(cmd);
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001820 if (rtn) {
1821 scsi_queue_insert(cmd, rtn);
1822 spin_lock_irq(q->queue_lock);
Jens Axboea488e742010-04-16 21:13:15 +02001823 goto out_delay;
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001824 }
1825 spin_lock_irq(q->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 }
1827
Bart Van Assche613be1f2014-02-20 14:20:56 -08001828 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001830 host_not_ready:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001831 if (scsi_target(sdev)->can_queue > 0)
1832 atomic_dec(&scsi_target(sdev)->target_busy);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001833 not_ready:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 /*
1835 * lock q, handle tag, requeue req, and decrement device_busy. We
1836 * must return with queue_lock held.
1837 *
1838 * Decrementing device_busy without checking it is OK, as all such
1839 * cases (host limits or settings) should run the queue at some
1840 * later time.
1841 */
1842 spin_lock_irq(q->queue_lock);
1843 blk_requeue_request(q, req);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001844 atomic_dec(&sdev->device_busy);
Jens Axboea488e742010-04-16 21:13:15 +02001845out_delay:
Guenter Roeck480cadc2014-08-10 05:54:25 -07001846 if (!atomic_read(&sdev->device_busy) && !scsi_device_blocked(sdev))
Jens Axboea488e742010-04-16 21:13:15 +02001847 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848}
1849
Christoph Hellwigd2852032014-01-17 12:06:53 +01001850static inline int prep_to_mq(int ret)
1851{
1852 switch (ret) {
1853 case BLKPREP_OK:
Omar Sandoval2868f132016-11-15 11:11:59 -08001854 return BLK_MQ_RQ_QUEUE_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001855 case BLKPREP_DEFER:
1856 return BLK_MQ_RQ_QUEUE_BUSY;
1857 default:
1858 return BLK_MQ_RQ_QUEUE_ERROR;
1859 }
1860}
1861
1862static int scsi_mq_prep_fn(struct request *req)
1863{
1864 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1865 struct scsi_device *sdev = req->q->queuedata;
1866 struct Scsi_Host *shost = sdev->host;
1867 unsigned char *sense_buf = cmd->sense_buffer;
Bart Van Assche8e688252017-06-02 14:21:52 -07001868 unsigned int unchecked_isa_dma = cmd->flags & SCMD_UNCHECKED_ISA_DMA;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001869 struct scatterlist *sg;
1870
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001871 /* zero out the cmd, except for the embedded scsi_request */
1872 memset((char *)cmd + sizeof(cmd->req), 0,
Long Li1bad6c42017-05-18 15:40:05 -07001873 sizeof(*cmd) - sizeof(cmd->req) + shost->hostt->cmd_size);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001874
1875 req->special = cmd;
1876
1877 cmd->request = req;
1878 cmd->device = sdev;
1879 cmd->sense_buffer = sense_buf;
Bart Van Assche8e688252017-06-02 14:21:52 -07001880 cmd->flags = unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001881
1882 cmd->tag = req->tag;
1883
Christoph Hellwigd2852032014-01-17 12:06:53 +01001884 cmd->prot_op = SCSI_PROT_NORMAL;
1885
1886 INIT_LIST_HEAD(&cmd->list);
1887 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1888 cmd->jiffies_at_alloc = jiffies;
1889
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001890 scsi_add_cmd_to_list(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001891
1892 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1893 cmd->sdb.table.sgl = sg;
1894
1895 if (scsi_host_get_prot(shost)) {
1896 cmd->prot_sdb = (void *)sg +
Tony Battersby120bb3e2014-12-08 17:20:52 -05001897 min_t(unsigned int,
Ming Lin65e86172016-04-04 14:48:10 -07001898 shost->sg_tablesize, SG_CHUNK_SIZE) *
Tony Battersby120bb3e2014-12-08 17:20:52 -05001899 sizeof(struct scatterlist);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001900 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1901
1902 cmd->prot_sdb->table.sgl =
1903 (struct scatterlist *)(cmd->prot_sdb + 1);
1904 }
1905
1906 if (blk_bidi_rq(req)) {
1907 struct request *next_rq = req->next_rq;
1908 struct scsi_data_buffer *bidi_sdb = blk_mq_rq_to_pdu(next_rq);
1909
1910 memset(bidi_sdb, 0, sizeof(struct scsi_data_buffer));
1911 bidi_sdb->table.sgl =
1912 (struct scatterlist *)(bidi_sdb + 1);
1913
1914 next_rq->special = bidi_sdb;
1915 }
1916
Christoph Hellwigfe052522014-09-22 15:59:31 +02001917 blk_mq_start_request(req);
1918
Christoph Hellwigd2852032014-01-17 12:06:53 +01001919 return scsi_setup_cmnd(sdev, req);
1920}
1921
1922static void scsi_mq_done(struct scsi_cmnd *cmd)
1923{
1924 trace_scsi_dispatch_cmd_done(cmd);
Christoph Hellwig08e00292017-04-20 16:03:09 +02001925 blk_mq_complete_request(cmd->request);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001926}
1927
Jens Axboe74c45052014-10-29 11:14:52 -06001928static int scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1929 const struct blk_mq_queue_data *bd)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001930{
Jens Axboe74c45052014-10-29 11:14:52 -06001931 struct request *req = bd->rq;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001932 struct request_queue *q = req->q;
1933 struct scsi_device *sdev = q->queuedata;
1934 struct Scsi_Host *shost = sdev->host;
1935 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1936 int ret;
1937 int reason;
1938
1939 ret = prep_to_mq(scsi_prep_state_check(sdev, req));
Omar Sandoval2868f132016-11-15 11:11:59 -08001940 if (ret != BLK_MQ_RQ_QUEUE_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001941 goto out;
1942
1943 ret = BLK_MQ_RQ_QUEUE_BUSY;
1944 if (!get_device(&sdev->sdev_gendev))
1945 goto out;
1946
1947 if (!scsi_dev_queue_ready(q, sdev))
1948 goto out_put_device;
1949 if (!scsi_target_queue_ready(shost, sdev))
1950 goto out_dec_device_busy;
1951 if (!scsi_host_queue_ready(q, shost, sdev))
1952 goto out_dec_target_busy;
1953
Christoph Hellwige8064022016-10-20 15:12:13 +02001954 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001955 ret = prep_to_mq(scsi_mq_prep_fn(req));
Omar Sandoval2868f132016-11-15 11:11:59 -08001956 if (ret != BLK_MQ_RQ_QUEUE_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001957 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001958 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001959 } else {
1960 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001961 }
1962
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001963 if (sdev->simple_tags)
1964 cmd->flags |= SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001965 else
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001966 cmd->flags &= ~SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001967
Christoph Hellwigd2852032014-01-17 12:06:53 +01001968 scsi_init_cmd_errh(cmd);
1969 cmd->scsi_done = scsi_mq_done;
1970
1971 reason = scsi_dispatch_cmd(cmd);
1972 if (reason) {
1973 scsi_set_blocked(cmd, reason);
1974 ret = BLK_MQ_RQ_QUEUE_BUSY;
1975 goto out_dec_host_busy;
1976 }
1977
1978 return BLK_MQ_RQ_QUEUE_OK;
1979
1980out_dec_host_busy:
1981 atomic_dec(&shost->host_busy);
1982out_dec_target_busy:
1983 if (scsi_target(sdev)->can_queue > 0)
1984 atomic_dec(&scsi_target(sdev)->target_busy);
1985out_dec_device_busy:
1986 atomic_dec(&sdev->device_busy);
1987out_put_device:
1988 put_device(&sdev->sdev_gendev);
1989out:
1990 switch (ret) {
1991 case BLK_MQ_RQ_QUEUE_BUSY:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001992 if (atomic_read(&sdev->device_busy) == 0 &&
1993 !scsi_device_blocked(sdev))
Bart Van Assche36e3cf22017-04-07 11:16:53 -07001994 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001995 break;
1996 case BLK_MQ_RQ_QUEUE_ERROR:
1997 /*
1998 * Make sure to release all allocated ressources when
1999 * we hit an error, as we will never see this command
2000 * again.
2001 */
Christoph Hellwige8064022016-10-20 15:12:13 +02002002 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002003 scsi_mq_uninit_cmd(cmd);
2004 break;
2005 default:
2006 break;
2007 }
2008 return ret;
2009}
2010
Christoph Hellwig0152fb62014-09-13 16:40:13 -07002011static enum blk_eh_timer_return scsi_timeout(struct request *req,
2012 bool reserved)
2013{
2014 if (reserved)
2015 return BLK_EH_RESET_TIMER;
2016 return scsi_times_out(req);
2017}
2018
Christoph Hellwigd6296d32017-05-01 10:19:08 -06002019static int scsi_init_request(struct blk_mq_tag_set *set, struct request *rq,
2020 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002021{
Christoph Hellwigd6296d32017-05-01 10:19:08 -06002022 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07002023 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002024 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2025
Bart Van Assche8e688252017-06-02 14:21:52 -07002026 if (unchecked_isa_dma)
2027 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
2028 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
2029 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002030 if (!cmd->sense_buffer)
2031 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002032 cmd->req.sense = cmd->sense_buffer;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002033 return 0;
2034}
2035
Christoph Hellwigd6296d32017-05-01 10:19:08 -06002036static void scsi_exit_request(struct blk_mq_tag_set *set, struct request *rq,
2037 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002038{
2039 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2040
Bart Van Assche8e688252017-06-02 14:21:52 -07002041 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
2042 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002043}
2044
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002045static int scsi_map_queues(struct blk_mq_tag_set *set)
2046{
2047 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
2048
2049 if (shost->hostt->map_queues)
2050 return shost->hostt->map_queues(shost);
2051 return blk_mq_map_queues(set);
2052}
2053
Christoph Hellwigf1bea552014-04-15 12:26:54 +02002054static u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055{
2056 struct device *host_dev;
2057 u64 bounce_limit = 0xffffffff;
2058
2059 if (shost->unchecked_isa_dma)
2060 return BLK_BOUNCE_ISA;
2061 /*
2062 * Platforms with virtual-DMA translation
2063 * hardware have no practical limit.
2064 */
2065 if (!PCI_DMA_BUS_IS_PHYS)
2066 return BLK_BOUNCE_ANY;
2067
2068 host_dev = scsi_get_device(shost);
2069 if (host_dev && host_dev->dma_mask)
Russell Kinge83b3662014-02-11 17:11:04 +00002070 bounce_limit = (u64)dma_max_pfn(host_dev) << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071
2072 return bounce_limit;
2073}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002075void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076{
Lin Ming6f381fa2012-04-12 13:50:38 +08002077 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078
Jens Axboea8474ce2007-08-07 09:02:51 +02002079 /*
2080 * this limit is imposed by hardware restrictions
2081 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05002082 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07002083 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02002084
Martin K. Petersen13f05c82010-09-10 20:50:10 +02002085 if (scsi_host_prot_dma(shost)) {
2086 shost->sg_prot_tablesize =
2087 min_not_zero(shost->sg_prot_tablesize,
2088 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
2089 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
2090 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
2091 }
2092
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05002093 blk_queue_max_hw_sectors(q, shost->max_sectors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
2095 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08002096 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097
FUJITA Tomonori860ac562008-02-04 22:28:05 -08002098 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
2099
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01002101 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06002102
2103 /*
2104 * set a reasonable default alignment on word boundaries: the
2105 * host and device may alter it using
2106 * blk_queue_update_dma_alignment() later.
2107 */
2108 blk_queue_dma_alignment(q, 0x03);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002109}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002110EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06002111
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002112static int scsi_init_rq(struct request_queue *q, struct request *rq, gfp_t gfp)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002113{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002114 struct Scsi_Host *shost = q->rq_alloc_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07002115 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002116 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002117
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002118 memset(cmd, 0, sizeof(*cmd));
2119
Bart Van Assche8e688252017-06-02 14:21:52 -07002120 if (unchecked_isa_dma)
2121 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
2122 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma, gfp,
2123 NUMA_NO_NODE);
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002124 if (!cmd->sense_buffer)
2125 goto fail;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002126 cmd->req.sense = cmd->sense_buffer;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002127
2128 if (scsi_host_get_prot(shost) >= SHOST_DIX_TYPE0_PROTECTION) {
2129 cmd->prot_sdb = kmem_cache_zalloc(scsi_sdb_cache, gfp);
2130 if (!cmd->prot_sdb)
2131 goto fail_free_sense;
2132 }
2133
2134 return 0;
2135
2136fail_free_sense:
Bart Van Assche8e688252017-06-02 14:21:52 -07002137 scsi_free_sense_buffer(unchecked_isa_dma, cmd->sense_buffer);
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002138fail:
2139 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140}
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002141
2142static void scsi_exit_rq(struct request_queue *q, struct request *rq)
2143{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002144 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2145
2146 if (cmd->prot_sdb)
2147 kmem_cache_free(scsi_sdb_cache, cmd->prot_sdb);
Bart Van Assche8e688252017-06-02 14:21:52 -07002148 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
2149 cmd->sense_buffer);
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002150}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002151
2152struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
2153{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002154 struct Scsi_Host *shost = sdev->host;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002155 struct request_queue *q;
2156
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002157 q = blk_alloc_queue_node(GFP_KERNEL, NUMA_NO_NODE);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002158 if (!q)
2159 return NULL;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002160 q->cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
2161 q->rq_alloc_data = shost;
2162 q->request_fn = scsi_request_fn;
2163 q->init_rq_fn = scsi_init_rq;
2164 q->exit_rq_fn = scsi_exit_rq;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002165
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002166 if (blk_init_allocated_queue(q) < 0) {
2167 blk_cleanup_queue(q);
2168 return NULL;
2169 }
2170
2171 __scsi_init_queue(shost, q);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002172 blk_queue_prep_rq(q, scsi_prep_fn);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02002173 blk_queue_unprep_rq(q, scsi_unprep_fn);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002174 blk_queue_softirq_done(q, scsi_softirq_done);
Jens Axboe242f9dc2008-09-14 05:55:09 -07002175 blk_queue_rq_timed_out(q, scsi_times_out);
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04002176 blk_queue_lld_busy(q, scsi_lld_busy);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002177 return q;
2178}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179
Eric Biggersf363b082017-03-30 13:39:16 -07002180static const struct blk_mq_ops scsi_mq_ops = {
Christoph Hellwigd2852032014-01-17 12:06:53 +01002181 .queue_rq = scsi_queue_rq,
2182 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07002183 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07002184#ifdef CONFIG_BLK_DEBUG_FS
2185 .show_rq = scsi_show_rq,
2186#endif
Christoph Hellwigd2852032014-01-17 12:06:53 +01002187 .init_request = scsi_init_request,
2188 .exit_request = scsi_exit_request,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002189 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01002190};
2191
2192struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
2193{
2194 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
2195 if (IS_ERR(sdev->request_queue))
2196 return NULL;
2197
2198 sdev->request_queue->queuedata = sdev;
2199 __scsi_init_queue(sdev->host, sdev->request_queue);
2200 return sdev->request_queue;
2201}
2202
2203int scsi_mq_setup_tags(struct Scsi_Host *shost)
2204{
2205 unsigned int cmd_size, sgl_size, tbl_size;
2206
2207 tbl_size = shost->sg_tablesize;
Ming Lin65e86172016-04-04 14:48:10 -07002208 if (tbl_size > SG_CHUNK_SIZE)
2209 tbl_size = SG_CHUNK_SIZE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002210 sgl_size = tbl_size * sizeof(struct scatterlist);
2211 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
2212 if (scsi_host_get_prot(shost))
2213 cmd_size += sizeof(struct scsi_data_buffer) + sgl_size;
2214
2215 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
2216 shost->tag_set.ops = &scsi_mq_ops;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01002217 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002218 shost->tag_set.queue_depth = shost->can_queue;
2219 shost->tag_set.cmd_size = cmd_size;
2220 shost->tag_set.numa_node = NUMA_NO_NODE;
2221 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07002222 shost->tag_set.flags |=
2223 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002224 shost->tag_set.driver_data = shost;
2225
2226 return blk_mq_alloc_tag_set(&shost->tag_set);
2227}
2228
2229void scsi_mq_destroy_tags(struct Scsi_Host *shost)
2230{
2231 blk_mq_free_tag_set(&shost->tag_set);
2232}
2233
Hannes Reinecke857de6e2017-02-17 09:02:45 +01002234/**
2235 * scsi_device_from_queue - return sdev associated with a request_queue
2236 * @q: The request queue to return the sdev from
2237 *
2238 * Return the sdev associated with a request queue or NULL if the
2239 * request_queue does not reference a SCSI device.
2240 */
2241struct scsi_device *scsi_device_from_queue(struct request_queue *q)
2242{
2243 struct scsi_device *sdev = NULL;
2244
2245 if (q->mq_ops) {
2246 if (q->mq_ops == &scsi_mq_ops)
2247 sdev = q->queuedata;
2248 } else if (q->request_fn == scsi_request_fn)
2249 sdev = q->queuedata;
2250 if (!sdev || !get_device(&sdev->sdev_gendev))
2251 sdev = NULL;
2252
2253 return sdev;
2254}
2255EXPORT_SYMBOL_GPL(scsi_device_from_queue);
2256
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257/*
2258 * Function: scsi_block_requests()
2259 *
2260 * Purpose: Utility function used by low-level drivers to prevent further
2261 * commands from being queued to the device.
2262 *
2263 * Arguments: shost - Host in question
2264 *
2265 * Returns: Nothing
2266 *
2267 * Lock status: No locks are assumed held.
2268 *
2269 * Notes: There is no timer nor any other means by which the requests
2270 * get unblocked other than the low-level driver calling
2271 * scsi_unblock_requests().
2272 */
2273void scsi_block_requests(struct Scsi_Host *shost)
2274{
2275 shost->host_self_blocked = 1;
2276}
2277EXPORT_SYMBOL(scsi_block_requests);
2278
2279/*
2280 * Function: scsi_unblock_requests()
2281 *
2282 * Purpose: Utility function used by low-level drivers to allow further
2283 * commands from being queued to the device.
2284 *
2285 * Arguments: shost - Host in question
2286 *
2287 * Returns: Nothing
2288 *
2289 * Lock status: No locks are assumed held.
2290 *
2291 * Notes: There is no timer nor any other means by which the requests
2292 * get unblocked other than the low-level driver calling
2293 * scsi_unblock_requests().
2294 *
2295 * This is done as an API function so that changes to the
2296 * internals of the scsi mid-layer won't require wholesale
2297 * changes to drivers that use this feature.
2298 */
2299void scsi_unblock_requests(struct Scsi_Host *shost)
2300{
2301 shost->host_self_blocked = 0;
2302 scsi_run_host_queues(shost);
2303}
2304EXPORT_SYMBOL(scsi_unblock_requests);
2305
2306int __init scsi_init_queue(void)
2307{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002308 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
2309 sizeof(struct scsi_data_buffer),
2310 0, 0, NULL);
2311 if (!scsi_sdb_cache) {
2312 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09002313 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02002314 }
2315
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316 return 0;
2317}
2318
2319void scsi_exit_queue(void)
2320{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002321 kmem_cache_destroy(scsi_sense_cache);
2322 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002323 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324}
James Bottomley5baba832006-03-18 14:10:35 -06002325
2326/**
2327 * scsi_mode_select - issue a mode select
2328 * @sdev: SCSI device to be queried
2329 * @pf: Page format bit (1 == standard, 0 == vendor specific)
2330 * @sp: Save page bit (0 == don't save, 1 == save)
2331 * @modepage: mode page being requested
2332 * @buffer: request buffer (may not be smaller than eight bytes)
2333 * @len: length of request buffer.
2334 * @timeout: command timeout
2335 * @retries: number of retries before failing
2336 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002337 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06002338 * must be SCSI_SENSE_BUFFERSIZE big.
2339 *
2340 * Returns zero if successful; negative error number or scsi
2341 * status on error
2342 *
2343 */
2344int
2345scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2346 unsigned char *buffer, int len, int timeout, int retries,
2347 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2348{
2349 unsigned char cmd[10];
2350 unsigned char *real_buffer;
2351 int ret;
2352
2353 memset(cmd, 0, sizeof(cmd));
2354 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2355
2356 if (sdev->use_10_for_ms) {
2357 if (len > 65535)
2358 return -EINVAL;
2359 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2360 if (!real_buffer)
2361 return -ENOMEM;
2362 memcpy(real_buffer + 8, buffer, len);
2363 len += 8;
2364 real_buffer[0] = 0;
2365 real_buffer[1] = 0;
2366 real_buffer[2] = data->medium_type;
2367 real_buffer[3] = data->device_specific;
2368 real_buffer[4] = data->longlba ? 0x01 : 0;
2369 real_buffer[5] = 0;
2370 real_buffer[6] = data->block_descriptor_length >> 8;
2371 real_buffer[7] = data->block_descriptor_length;
2372
2373 cmd[0] = MODE_SELECT_10;
2374 cmd[7] = len >> 8;
2375 cmd[8] = len;
2376 } else {
2377 if (len > 255 || data->block_descriptor_length > 255 ||
2378 data->longlba)
2379 return -EINVAL;
2380
2381 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2382 if (!real_buffer)
2383 return -ENOMEM;
2384 memcpy(real_buffer + 4, buffer, len);
2385 len += 4;
2386 real_buffer[0] = 0;
2387 real_buffer[1] = data->medium_type;
2388 real_buffer[2] = data->device_specific;
2389 real_buffer[3] = data->block_descriptor_length;
2390
2391
2392 cmd[0] = MODE_SELECT;
2393 cmd[4] = len;
2394 }
2395
2396 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002397 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002398 kfree(real_buffer);
2399 return ret;
2400}
2401EXPORT_SYMBOL_GPL(scsi_mode_select);
2402
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403/**
Rob Landleyeb448202007-11-03 13:30:39 -05002404 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002405 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406 * @dbd: set if mode sense will allow block descriptors to be returned
2407 * @modepage: mode page being requested
2408 * @buffer: request buffer (may not be smaller than eight bytes)
2409 * @len: length of request buffer.
2410 * @timeout: command timeout
2411 * @retries: number of retries before failing
2412 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002413 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002414 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415 *
2416 * Returns zero if unsuccessful, or the header offset (either 4
2417 * or 8 depending on whether a six or ten byte command was
2418 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002419 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420int
James Bottomley1cf72692005-08-28 11:27:01 -05002421scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002423 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2424{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 unsigned char cmd[12];
2426 int use_10_for_ms;
2427 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002428 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002429 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430
2431 memset(data, 0, sizeof(*data));
2432 memset(&cmd[0], 0, 12);
2433 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2434 cmd[2] = modepage;
2435
James Bottomleyea73a9f2005-08-28 11:33:52 -05002436 /* caller might not be interested in sense, but we need it */
2437 if (!sshdr)
2438 sshdr = &my_sshdr;
2439
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002441 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442
2443 if (use_10_for_ms) {
2444 if (len < 8)
2445 len = 8;
2446
2447 cmd[0] = MODE_SENSE_10;
2448 cmd[8] = len;
2449 header_length = 8;
2450 } else {
2451 if (len < 4)
2452 len = 4;
2453
2454 cmd[0] = MODE_SENSE;
2455 cmd[4] = len;
2456 header_length = 4;
2457 }
2458
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 memset(buffer, 0, len);
2460
James Bottomley1cf72692005-08-28 11:27:01 -05002461 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002462 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463
2464 /* This code looks awful: what it's doing is making sure an
2465 * ILLEGAL REQUEST sense return identifies the actual command
2466 * byte as the problem. MODE_SENSE commands can return
2467 * ILLEGAL REQUEST if the code page isn't supported */
2468
James Bottomley1cf72692005-08-28 11:27:01 -05002469 if (use_10_for_ms && !scsi_status_is_good(result) &&
2470 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002471 if (scsi_sense_valid(sshdr)) {
2472 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2473 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 /*
2475 * Invalid command operation code
2476 */
James Bottomley1cf72692005-08-28 11:27:01 -05002477 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 goto retry;
2479 }
2480 }
2481 }
2482
James Bottomley1cf72692005-08-28 11:27:01 -05002483 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002484 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2485 (modepage == 6 || modepage == 8))) {
2486 /* Initio breakage? */
2487 header_length = 0;
2488 data->length = 13;
2489 data->medium_type = 0;
2490 data->device_specific = 0;
2491 data->longlba = 0;
2492 data->block_descriptor_length = 0;
2493 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494 data->length = buffer[0]*256 + buffer[1] + 2;
2495 data->medium_type = buffer[2];
2496 data->device_specific = buffer[3];
2497 data->longlba = buffer[4] & 0x01;
2498 data->block_descriptor_length = buffer[6]*256
2499 + buffer[7];
2500 } else {
2501 data->length = buffer[0] + 1;
2502 data->medium_type = buffer[1];
2503 data->device_specific = buffer[2];
2504 data->block_descriptor_length = buffer[3];
2505 }
Al Viro6d73c852006-02-23 02:03:16 +01002506 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002507 } else if ((status_byte(result) == CHECK_CONDITION) &&
2508 scsi_sense_valid(sshdr) &&
2509 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2510 retry_count--;
2511 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512 }
2513
James Bottomley1cf72692005-08-28 11:27:01 -05002514 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515}
2516EXPORT_SYMBOL(scsi_mode_sense);
2517
James Bottomley001aac22007-12-02 19:10:40 +02002518/**
2519 * scsi_test_unit_ready - test if unit is ready
2520 * @sdev: scsi device to change the state of.
2521 * @timeout: command timeout
2522 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002523 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002524 *
2525 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002526 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002527 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528int
James Bottomley001aac22007-12-02 19:10:40 +02002529scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002530 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532 char cmd[] = {
2533 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2534 };
2535 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002536
James Bottomley001aac22007-12-02 19:10:40 +02002537 /* try to eat the UNIT_ATTENTION if there are enough retries */
2538 do {
2539 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002540 timeout, retries, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002541 if (sdev->removable && scsi_sense_valid(sshdr) &&
2542 sshdr->sense_key == UNIT_ATTENTION)
2543 sdev->changed = 1;
2544 } while (scsi_sense_valid(sshdr) &&
2545 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002546
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 return result;
2548}
2549EXPORT_SYMBOL(scsi_test_unit_ready);
2550
2551/**
Rob Landleyeb448202007-11-03 13:30:39 -05002552 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553 * @sdev: scsi device to change the state of.
2554 * @state: state to change to.
2555 *
2556 * Returns zero if unsuccessful or an error if the requested
2557 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002558 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559int
2560scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2561{
2562 enum scsi_device_state oldstate = sdev->sdev_state;
2563
2564 if (state == oldstate)
2565 return 0;
2566
2567 switch (state) {
2568 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002569 switch (oldstate) {
2570 case SDEV_CREATED_BLOCK:
2571 break;
2572 default:
2573 goto illegal;
2574 }
2575 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576
2577 case SDEV_RUNNING:
2578 switch (oldstate) {
2579 case SDEV_CREATED:
2580 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002581 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582 case SDEV_QUIESCE:
2583 case SDEV_BLOCK:
2584 break;
2585 default:
2586 goto illegal;
2587 }
2588 break;
2589
2590 case SDEV_QUIESCE:
2591 switch (oldstate) {
2592 case SDEV_RUNNING:
2593 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002594 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595 break;
2596 default:
2597 goto illegal;
2598 }
2599 break;
2600
2601 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002602 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 switch (oldstate) {
2604 case SDEV_CREATED:
2605 case SDEV_RUNNING:
2606 case SDEV_QUIESCE:
2607 case SDEV_BLOCK:
2608 break;
2609 default:
2610 goto illegal;
2611 }
2612 break;
2613
2614 case SDEV_BLOCK:
2615 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002617 case SDEV_CREATED_BLOCK:
2618 break;
2619 default:
2620 goto illegal;
2621 }
2622 break;
2623
2624 case SDEV_CREATED_BLOCK:
2625 switch (oldstate) {
2626 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627 break;
2628 default:
2629 goto illegal;
2630 }
2631 break;
2632
2633 case SDEV_CANCEL:
2634 switch (oldstate) {
2635 case SDEV_CREATED:
2636 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002637 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002639 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640 break;
2641 default:
2642 goto illegal;
2643 }
2644 break;
2645
2646 case SDEV_DEL:
2647 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002648 case SDEV_CREATED:
2649 case SDEV_RUNNING:
2650 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002651 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002653 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002654 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655 break;
2656 default:
2657 goto illegal;
2658 }
2659 break;
2660
2661 }
2662 sdev->sdev_state = state;
2663 return 0;
2664
2665 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002666 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002667 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002668 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002669 scsi_device_state_name(oldstate),
2670 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671 );
2672 return -EINVAL;
2673}
2674EXPORT_SYMBOL(scsi_device_set_state);
2675
2676/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002677 * sdev_evt_emit - emit a single SCSI device uevent
2678 * @sdev: associated SCSI device
2679 * @evt: event to emit
2680 *
2681 * Send a single uevent (scsi_event) to the associated scsi_device.
2682 */
2683static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2684{
2685 int idx = 0;
2686 char *envp[3];
2687
2688 switch (evt->evt_type) {
2689 case SDEV_EVT_MEDIA_CHANGE:
2690 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2691 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002692 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002693 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002694 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2695 break;
2696 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2697 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2698 break;
2699 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2700 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2701 break;
2702 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2703 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2704 break;
2705 case SDEV_EVT_LUN_CHANGE_REPORTED:
2706 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2707 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002708 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2709 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2710 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002711 default:
2712 /* do nothing */
2713 break;
2714 }
2715
2716 envp[idx++] = NULL;
2717
2718 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2719}
2720
2721/**
2722 * sdev_evt_thread - send a uevent for each scsi event
2723 * @work: work struct for scsi_device
2724 *
2725 * Dispatch queued events to their associated scsi_device kobjects
2726 * as uevents.
2727 */
2728void scsi_evt_thread(struct work_struct *work)
2729{
2730 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002731 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002732 LIST_HEAD(event_list);
2733
2734 sdev = container_of(work, struct scsi_device, event_work);
2735
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002736 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2737 if (test_and_clear_bit(evt_type, sdev->pending_events))
2738 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2739
Jeff Garzika341cd02007-10-29 17:15:22 -04002740 while (1) {
2741 struct scsi_event *evt;
2742 struct list_head *this, *tmp;
2743 unsigned long flags;
2744
2745 spin_lock_irqsave(&sdev->list_lock, flags);
2746 list_splice_init(&sdev->event_list, &event_list);
2747 spin_unlock_irqrestore(&sdev->list_lock, flags);
2748
2749 if (list_empty(&event_list))
2750 break;
2751
2752 list_for_each_safe(this, tmp, &event_list) {
2753 evt = list_entry(this, struct scsi_event, node);
2754 list_del(&evt->node);
2755 scsi_evt_emit(sdev, evt);
2756 kfree(evt);
2757 }
2758 }
2759}
2760
2761/**
2762 * sdev_evt_send - send asserted event to uevent thread
2763 * @sdev: scsi_device event occurred on
2764 * @evt: event to send
2765 *
2766 * Assert scsi device event asynchronously.
2767 */
2768void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2769{
2770 unsigned long flags;
2771
Kay Sievers4d1566e2008-03-19 13:04:47 +01002772#if 0
2773 /* FIXME: currently this check eliminates all media change events
2774 * for polled devices. Need to update to discriminate between AN
2775 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002776 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2777 kfree(evt);
2778 return;
2779 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002780#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002781
2782 spin_lock_irqsave(&sdev->list_lock, flags);
2783 list_add_tail(&evt->node, &sdev->event_list);
2784 schedule_work(&sdev->event_work);
2785 spin_unlock_irqrestore(&sdev->list_lock, flags);
2786}
2787EXPORT_SYMBOL_GPL(sdev_evt_send);
2788
2789/**
2790 * sdev_evt_alloc - allocate a new scsi event
2791 * @evt_type: type of event to allocate
2792 * @gfpflags: GFP flags for allocation
2793 *
2794 * Allocates and returns a new scsi_event.
2795 */
2796struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2797 gfp_t gfpflags)
2798{
2799 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2800 if (!evt)
2801 return NULL;
2802
2803 evt->evt_type = evt_type;
2804 INIT_LIST_HEAD(&evt->node);
2805
2806 /* evt_type-specific initialization, if any */
2807 switch (evt_type) {
2808 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002809 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2810 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2811 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2812 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2813 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002814 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002815 default:
2816 /* do nothing */
2817 break;
2818 }
2819
2820 return evt;
2821}
2822EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2823
2824/**
2825 * sdev_evt_send_simple - send asserted event to uevent thread
2826 * @sdev: scsi_device event occurred on
2827 * @evt_type: type of event to send
2828 * @gfpflags: GFP flags for allocation
2829 *
2830 * Assert scsi device event asynchronously, given an event type.
2831 */
2832void sdev_evt_send_simple(struct scsi_device *sdev,
2833 enum scsi_device_event evt_type, gfp_t gfpflags)
2834{
2835 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2836 if (!evt) {
2837 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2838 evt_type);
2839 return;
2840 }
2841
2842 sdev_evt_send(sdev, evt);
2843}
2844EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2845
2846/**
Bart Van Assche669f0442016-11-22 16:17:13 -08002847 * scsi_request_fn_active() - number of kernel threads inside scsi_request_fn()
2848 * @sdev: SCSI device to count the number of scsi_request_fn() callers for.
2849 */
2850static int scsi_request_fn_active(struct scsi_device *sdev)
2851{
2852 struct request_queue *q = sdev->request_queue;
2853 int request_fn_active;
2854
2855 WARN_ON_ONCE(sdev->host->use_blk_mq);
2856
2857 spin_lock_irq(q->queue_lock);
2858 request_fn_active = q->request_fn_active;
2859 spin_unlock_irq(q->queue_lock);
2860
2861 return request_fn_active;
2862}
2863
2864/**
2865 * scsi_wait_for_queuecommand() - wait for ongoing queuecommand() calls
2866 * @sdev: SCSI device pointer.
2867 *
2868 * Wait until the ongoing shost->hostt->queuecommand() calls that are
2869 * invoked from scsi_request_fn() have finished.
2870 */
2871static void scsi_wait_for_queuecommand(struct scsi_device *sdev)
2872{
2873 WARN_ON_ONCE(sdev->host->use_blk_mq);
2874
2875 while (scsi_request_fn_active(sdev))
2876 msleep(20);
2877}
2878
2879/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880 * scsi_device_quiesce - Block user issued commands.
2881 * @sdev: scsi device to quiesce.
2882 *
2883 * This works by trying to transition to the SDEV_QUIESCE state
2884 * (which must be a legal transition). When the device is in this
2885 * state, only special requests will be accepted, all others will
2886 * be deferred. Since special requests may also be requeued requests,
2887 * a successful return doesn't guarantee the device will be
2888 * totally quiescent.
2889 *
2890 * Must be called with user context, may sleep.
2891 *
2892 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002893 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894int
2895scsi_device_quiesce(struct scsi_device *sdev)
2896{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002897 int err;
2898
2899 mutex_lock(&sdev->state_mutex);
2900 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2901 mutex_unlock(&sdev->state_mutex);
2902
Linus Torvalds1da177e2005-04-16 15:20:36 -07002903 if (err)
2904 return err;
2905
2906 scsi_run_queue(sdev->request_queue);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02002907 while (atomic_read(&sdev->device_busy)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002908 msleep_interruptible(200);
2909 scsi_run_queue(sdev->request_queue);
2910 }
2911 return 0;
2912}
2913EXPORT_SYMBOL(scsi_device_quiesce);
2914
2915/**
2916 * scsi_device_resume - Restart user issued commands to a quiesced device.
2917 * @sdev: scsi device to resume.
2918 *
2919 * Moves the device from quiesced back to running and restarts the
2920 * queues.
2921 *
2922 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002923 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002924void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002926 /* check if the device state was mutated prior to resume, and if
2927 * so assume the state is being managed elsewhere (for example
2928 * device deleted during suspend)
2929 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002930 mutex_lock(&sdev->state_mutex);
2931 if (sdev->sdev_state == SDEV_QUIESCE &&
2932 scsi_device_set_state(sdev, SDEV_RUNNING) == 0)
2933 scsi_run_queue(sdev->request_queue);
2934 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002935}
2936EXPORT_SYMBOL(scsi_device_resume);
2937
2938static void
2939device_quiesce_fn(struct scsi_device *sdev, void *data)
2940{
2941 scsi_device_quiesce(sdev);
2942}
2943
2944void
2945scsi_target_quiesce(struct scsi_target *starget)
2946{
2947 starget_for_each_device(starget, NULL, device_quiesce_fn);
2948}
2949EXPORT_SYMBOL(scsi_target_quiesce);
2950
2951static void
2952device_resume_fn(struct scsi_device *sdev, void *data)
2953{
2954 scsi_device_resume(sdev);
2955}
2956
2957void
2958scsi_target_resume(struct scsi_target *starget)
2959{
2960 starget_for_each_device(starget, NULL, device_resume_fn);
2961}
2962EXPORT_SYMBOL(scsi_target_resume);
2963
2964/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002965 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2966 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002967 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002968 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002969 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002970 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002972 * Notes:
2973 * This routine transitions the device to the SDEV_BLOCK state (which must be
2974 * a legal transition). When the device is in this state, command processing
2975 * is paused until the device leaves the SDEV_BLOCK state. See also
2976 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002977 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002978int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002979{
Jens Axboe165125e2007-07-24 09:28:11 +02002980 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002981 unsigned long flags;
2982 int err = 0;
2983
2984 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002985 if (err) {
2986 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2987
2988 if (err)
2989 return err;
2990 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991
2992 /*
2993 * The device has transitioned to SDEV_BLOCK. Stop the
2994 * block layer from calling the midlayer with this device's
2995 * request queue.
2996 */
Christoph Hellwigd2852032014-01-17 12:06:53 +01002997 if (q->mq_ops) {
Bart Van Assche551eb592017-06-02 14:21:53 -07002998 blk_mq_stop_hw_queues(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002999 } else {
3000 spin_lock_irqsave(q->queue_lock, flags);
3001 blk_stop_queue(q);
3002 spin_unlock_irqrestore(q->queue_lock, flags);
3003 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003004
3005 return 0;
3006}
Bart Van Assche551eb592017-06-02 14:21:53 -07003007EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
3008
3009/**
3010 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
3011 * @sdev: device to block
3012 *
3013 * Pause SCSI command processing on the specified device and wait until all
3014 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
3015 *
3016 * Returns zero if successful or a negative error code upon failure.
3017 *
3018 * Note:
3019 * This routine transitions the device to the SDEV_BLOCK state (which must be
3020 * a legal transition). When the device is in this state, command processing
3021 * is paused until the device leaves the SDEV_BLOCK state. See also
3022 * scsi_internal_device_unblock().
3023 *
3024 * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
3025 * scsi_internal_device_block() has blocked a SCSI device and also
3026 * remove the rport mutex lock and unlock calls from srp_queuecommand().
3027 */
3028static int scsi_internal_device_block(struct scsi_device *sdev)
3029{
3030 struct request_queue *q = sdev->request_queue;
3031 int err;
3032
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003033 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07003034 err = scsi_internal_device_block_nowait(sdev);
3035 if (err == 0) {
3036 if (q->mq_ops)
3037 blk_mq_quiesce_queue(q);
3038 else
3039 scsi_wait_for_queuecommand(sdev);
3040 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003041 mutex_unlock(&sdev->state_mutex);
3042
Bart Van Assche551eb592017-06-02 14:21:53 -07003043 return err;
3044}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045
Bart Van Assche66483a42017-06-02 14:21:56 -07003046void scsi_start_queue(struct scsi_device *sdev)
3047{
3048 struct request_queue *q = sdev->request_queue;
3049 unsigned long flags;
3050
3051 if (q->mq_ops) {
3052 blk_mq_start_stopped_hw_queues(q, false);
3053 } else {
3054 spin_lock_irqsave(q->queue_lock, flags);
3055 blk_start_queue(q);
3056 spin_unlock_irqrestore(q->queue_lock, flags);
3057 }
3058}
3059
Linus Torvalds1da177e2005-04-16 15:20:36 -07003060/**
Bart Van Assche43f75712017-06-02 14:21:54 -07003061 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07003062 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07003063 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064 *
Bart Van Assche43f75712017-06-02 14:21:54 -07003065 * Restart the device queue for a previously suspended SCSI device. Does not
3066 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003067 *
Bart Van Assche43f75712017-06-02 14:21:54 -07003068 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003069 *
Bart Van Assche43f75712017-06-02 14:21:54 -07003070 * Notes:
3071 * This routine transitions the device to the SDEV_RUNNING state or to one of
3072 * the offline states (which must be a legal transition) allowing the midlayer
3073 * to goose the queue for this device.
Rob Landleyeb448202007-11-03 13:30:39 -05003074 */
Bart Van Assche43f75712017-06-02 14:21:54 -07003075int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
3076 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003077{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003078 /*
3079 * Try to transition the scsi device to SDEV_RUNNING or one of the
3080 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003081 */
Vikas Chaudhary0e580762012-08-09 04:51:30 -04003082 if ((sdev->sdev_state == SDEV_BLOCK) ||
3083 (sdev->sdev_state == SDEV_TRANSPORT_OFFLINE))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003084 sdev->sdev_state = new_state;
3085 else if (sdev->sdev_state == SDEV_CREATED_BLOCK) {
3086 if (new_state == SDEV_TRANSPORT_OFFLINE ||
3087 new_state == SDEV_OFFLINE)
3088 sdev->sdev_state = new_state;
3089 else
3090 sdev->sdev_state = SDEV_CREATED;
3091 } else if (sdev->sdev_state != SDEV_CANCEL &&
Mike Christie986fe6c2010-10-06 03:10:59 -05003092 sdev->sdev_state != SDEV_OFFLINE)
Takahiro Yasui5c10e632009-04-29 12:13:02 -04003093 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003094
Bart Van Assche66483a42017-06-02 14:21:56 -07003095 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003096
3097 return 0;
3098}
Bart Van Assche43f75712017-06-02 14:21:54 -07003099EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
3100
3101/**
3102 * scsi_internal_device_unblock - resume a device after a block request
3103 * @sdev: device to resume
3104 * @new_state: state to set the device to after unblocking
3105 *
3106 * Restart the device queue for a previously suspended SCSI device. May sleep.
3107 *
3108 * Returns zero if successful or a negative error code upon failure.
3109 *
3110 * Notes:
3111 * This routine transitions the device to the SDEV_RUNNING state or to one of
3112 * the offline states (which must be a legal transition) allowing the midlayer
3113 * to goose the queue for this device.
3114 */
3115static int scsi_internal_device_unblock(struct scsi_device *sdev,
3116 enum scsi_device_state new_state)
3117{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003118 int ret;
3119
3120 mutex_lock(&sdev->state_mutex);
3121 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
3122 mutex_unlock(&sdev->state_mutex);
3123
3124 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07003125}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003126
3127static void
3128device_block(struct scsi_device *sdev, void *data)
3129{
Bart Van Assche551eb592017-06-02 14:21:53 -07003130 scsi_internal_device_block(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003131}
3132
3133static int
3134target_block(struct device *dev, void *data)
3135{
3136 if (scsi_is_target_device(dev))
3137 starget_for_each_device(to_scsi_target(dev), NULL,
3138 device_block);
3139 return 0;
3140}
3141
3142void
3143scsi_target_block(struct device *dev)
3144{
3145 if (scsi_is_target_device(dev))
3146 starget_for_each_device(to_scsi_target(dev), NULL,
3147 device_block);
3148 else
3149 device_for_each_child(dev, NULL, target_block);
3150}
3151EXPORT_SYMBOL_GPL(scsi_target_block);
3152
3153static void
3154device_unblock(struct scsi_device *sdev, void *data)
3155{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003156 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003157}
3158
3159static int
3160target_unblock(struct device *dev, void *data)
3161{
3162 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003163 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003164 device_unblock);
3165 return 0;
3166}
3167
3168void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003169scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170{
3171 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003172 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003173 device_unblock);
3174 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003175 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003176}
3177EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003178
3179/**
3180 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05003181 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003182 * @sg_count: number of segments in sg
3183 * @offset: offset in bytes into sg, on return offset into the mapped area
3184 * @len: bytes to map, on return number of bytes mapped
3185 *
3186 * Returns virtual address of the start of the mapped page
3187 */
Jens Axboec6132da2007-10-16 11:08:49 +02003188void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003189 size_t *offset, size_t *len)
3190{
3191 int i;
3192 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02003193 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003194 struct page *page;
3195
Andrew Morton22cfefb2007-02-05 16:39:03 -08003196 WARN_ON(!irqs_disabled());
3197
Jens Axboec6132da2007-10-16 11:08:49 +02003198 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003199 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02003200 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003201 if (sg_len > *offset)
3202 break;
3203 }
3204
3205 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07003206 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
3207 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07003208 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003209 WARN_ON(1);
3210 return NULL;
3211 }
3212
3213 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02003214 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003215
3216 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02003217 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003218 *offset &= ~PAGE_MASK;
3219
3220 /* Bytes in this sg-entry from *offset to the end of the page */
3221 sg_len = PAGE_SIZE - *offset;
3222 if (*len > sg_len)
3223 *len = sg_len;
3224
Cong Wang77dfce02011-11-25 23:14:23 +08003225 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003226}
3227EXPORT_SYMBOL(scsi_kmap_atomic_sg);
3228
3229/**
Rob Landleyeb448202007-11-03 13:30:39 -05003230 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003231 * @virt: virtual address to be unmapped
3232 */
3233void scsi_kunmap_atomic_sg(void *virt)
3234{
Cong Wang77dfce02011-11-25 23:14:23 +08003235 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003236}
3237EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08003238
3239void sdev_disable_disk_events(struct scsi_device *sdev)
3240{
3241 atomic_inc(&sdev->disk_events_disable_depth);
3242}
3243EXPORT_SYMBOL(sdev_disable_disk_events);
3244
3245void sdev_enable_disk_events(struct scsi_device *sdev)
3246{
3247 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
3248 return;
3249 atomic_dec(&sdev->disk_events_disable_depth);
3250}
3251EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003252
3253/**
3254 * scsi_vpd_lun_id - return a unique device identification
3255 * @sdev: SCSI device
3256 * @id: buffer for the identification
3257 * @id_len: length of the buffer
3258 *
3259 * Copies a unique device identification into @id based
3260 * on the information in the VPD page 0x83 of the device.
3261 * The string will be formatted as a SCSI name string.
3262 *
3263 * Returns the length of the identification or error on failure.
3264 * If the identifier is longer than the supplied buffer the actual
3265 * identifier length is returned and the buffer is not zero-padded.
3266 */
3267int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
3268{
3269 u8 cur_id_type = 0xff;
3270 u8 cur_id_size = 0;
3271 unsigned char *d, *cur_id_str;
3272 unsigned char __rcu *vpd_pg83;
3273 int id_size = -EINVAL;
3274
3275 rcu_read_lock();
3276 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3277 if (!vpd_pg83) {
3278 rcu_read_unlock();
3279 return -ENXIO;
3280 }
3281
3282 /*
3283 * Look for the correct descriptor.
3284 * Order of preference for lun descriptor:
3285 * - SCSI name string
3286 * - NAA IEEE Registered Extended
3287 * - EUI-64 based 16-byte
3288 * - EUI-64 based 12-byte
3289 * - NAA IEEE Registered
3290 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02003291 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003292 * as longer descriptors reduce the likelyhood
3293 * of identification clashes.
3294 */
3295
3296 /* The id string must be at least 20 bytes + terminating NULL byte */
3297 if (id_len < 21) {
3298 rcu_read_unlock();
3299 return -EINVAL;
3300 }
3301
3302 memset(id, 0, id_len);
3303 d = vpd_pg83 + 4;
3304 while (d < vpd_pg83 + sdev->vpd_pg83_len) {
3305 /* Skip designators not referring to the LUN */
3306 if ((d[1] & 0x30) != 0x00)
3307 goto next_desig;
3308
3309 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02003310 case 0x1:
3311 /* T10 Vendor ID */
3312 if (cur_id_size > d[3])
3313 break;
3314 /* Prefer anything */
3315 if (cur_id_type > 0x01 && cur_id_type != 0xff)
3316 break;
3317 cur_id_size = d[3];
3318 if (cur_id_size + 4 > id_len)
3319 cur_id_size = id_len - 4;
3320 cur_id_str = d + 4;
3321 cur_id_type = d[1] & 0xf;
3322 id_size = snprintf(id, id_len, "t10.%*pE",
3323 cur_id_size, cur_id_str);
3324 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003325 case 0x2:
3326 /* EUI-64 */
3327 if (cur_id_size > d[3])
3328 break;
3329 /* Prefer NAA IEEE Registered Extended */
3330 if (cur_id_type == 0x3 &&
3331 cur_id_size == d[3])
3332 break;
3333 cur_id_size = d[3];
3334 cur_id_str = d + 4;
3335 cur_id_type = d[1] & 0xf;
3336 switch (cur_id_size) {
3337 case 8:
3338 id_size = snprintf(id, id_len,
3339 "eui.%8phN",
3340 cur_id_str);
3341 break;
3342 case 12:
3343 id_size = snprintf(id, id_len,
3344 "eui.%12phN",
3345 cur_id_str);
3346 break;
3347 case 16:
3348 id_size = snprintf(id, id_len,
3349 "eui.%16phN",
3350 cur_id_str);
3351 break;
3352 default:
3353 cur_id_size = 0;
3354 break;
3355 }
3356 break;
3357 case 0x3:
3358 /* NAA */
3359 if (cur_id_size > d[3])
3360 break;
3361 cur_id_size = d[3];
3362 cur_id_str = d + 4;
3363 cur_id_type = d[1] & 0xf;
3364 switch (cur_id_size) {
3365 case 8:
3366 id_size = snprintf(id, id_len,
3367 "naa.%8phN",
3368 cur_id_str);
3369 break;
3370 case 16:
3371 id_size = snprintf(id, id_len,
3372 "naa.%16phN",
3373 cur_id_str);
3374 break;
3375 default:
3376 cur_id_size = 0;
3377 break;
3378 }
3379 break;
3380 case 0x8:
3381 /* SCSI name string */
3382 if (cur_id_size + 4 > d[3])
3383 break;
3384 /* Prefer others for truncated descriptor */
3385 if (cur_id_size && d[3] > id_len)
3386 break;
3387 cur_id_size = id_size = d[3];
3388 cur_id_str = d + 4;
3389 cur_id_type = d[1] & 0xf;
3390 if (cur_id_size >= id_len)
3391 cur_id_size = id_len - 1;
3392 memcpy(id, cur_id_str, cur_id_size);
3393 /* Decrease priority for truncated descriptor */
3394 if (cur_id_size != id_size)
3395 cur_id_size = 6;
3396 break;
3397 default:
3398 break;
3399 }
3400next_desig:
3401 d += d[3] + 4;
3402 }
3403 rcu_read_unlock();
3404
3405 return id_size;
3406}
3407EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003408
3409/*
3410 * scsi_vpd_tpg_id - return a target port group identifier
3411 * @sdev: SCSI device
3412 *
3413 * Returns the Target Port Group identifier from the information
3414 * froom VPD page 0x83 of the device.
3415 *
3416 * Returns the identifier or error on failure.
3417 */
3418int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3419{
3420 unsigned char *d;
3421 unsigned char __rcu *vpd_pg83;
3422 int group_id = -EAGAIN, rel_port = -1;
3423
3424 rcu_read_lock();
3425 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3426 if (!vpd_pg83) {
3427 rcu_read_unlock();
3428 return -ENXIO;
3429 }
3430
3431 d = sdev->vpd_pg83 + 4;
3432 while (d < sdev->vpd_pg83 + sdev->vpd_pg83_len) {
3433 switch (d[1] & 0xf) {
3434 case 0x4:
3435 /* Relative target port */
3436 rel_port = get_unaligned_be16(&d[6]);
3437 break;
3438 case 0x5:
3439 /* Target port group */
3440 group_id = get_unaligned_be16(&d[6]);
3441 break;
3442 default:
3443 break;
3444 }
3445 d += d[3] + 4;
3446 }
3447 rcu_read_unlock();
3448
3449 if (group_id >= 0 && rel_id && rel_port != -1)
3450 *rel_id = rel_port;
3451
3452 return group_id;
3453}
3454EXPORT_SYMBOL(scsi_vpd_tpg_id);