blob: 301a7f706c9a2a416ba3383299ab8622dc1ce8bf [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 *
48scsi_select_sense_cache(struct Scsi_Host *shost)
49{
50 return shost->unchecked_isa_dma ?
51 scsi_sense_isadma_cache : scsi_sense_cache;
52}
53
Christoph Hellwige9c787e2017-01-02 21:55:26 +030054static void scsi_free_sense_buffer(struct Scsi_Host *shost,
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030055 unsigned char *sense_buffer)
56{
57 kmem_cache_free(scsi_select_sense_cache(shost), sense_buffer);
58}
59
Christoph Hellwige9c787e2017-01-02 21:55:26 +030060static unsigned char *scsi_alloc_sense_buffer(struct Scsi_Host *shost,
61 gfp_t gfp_mask, int numa_node)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030062{
63 return kmem_cache_alloc_node(scsi_select_sense_cache(shost), gfp_mask,
64 numa_node);
65}
66
67int scsi_init_sense_cache(struct Scsi_Host *shost)
68{
69 struct kmem_cache *cache;
70 int ret = 0;
71
72 cache = scsi_select_sense_cache(shost);
73 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);
James Bottomley39216032005-06-15 18:48:29 -0500253
254 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
Mel Gorman71baba42015-11-06 16:28:28 -0800255 buffer, bufflen, __GFP_RECLAIM))
James Bottomley39216032005-06-15 18:48:29 -0500256 goto out;
257
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100258 rq->cmd_len = COMMAND_SIZE(cmd[0]);
259 memcpy(rq->cmd, cmd, rq->cmd_len);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200260 rq->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500261 req->timeout = timeout;
Christoph Hellwige8064022016-10-20 15:12:13 +0200262 req->cmd_flags |= flags;
263 req->rq_flags |= rq_flags | RQF_QUIET | RQF_PREEMPT;
James Bottomley39216032005-06-15 18:48:29 -0500264
265 /*
266 * head injection *required* here otherwise quiesce won't work
267 */
268 blk_execute_rq(req->q, NULL, req, 1);
269
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400270 /*
271 * Some devices (USB mass-storage in particular) may transfer
272 * garbage data together with a residue indicating that the data
273 * is invalid. Prevent the garbage from being misinterpreted
274 * and prevent security leaks by zeroing out the excess data.
275 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100276 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
277 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400278
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900279 if (resid)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100280 *resid = rq->resid_len;
281 if (sense && rq->sense_len)
282 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100283 if (sshdr)
284 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
Christoph Hellwig17d53632017-04-20 16:03:01 +0200285 ret = rq->result;
James Bottomley39216032005-06-15 18:48:29 -0500286 out:
287 blk_put_request(req);
288
289 return ret;
290}
James Bottomley33aa6872005-08-28 11:31:14 -0500291EXPORT_SYMBOL(scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293/*
294 * Function: scsi_init_cmd_errh()
295 *
296 * Purpose: Initialize cmd fields related to error handling.
297 *
298 * Arguments: cmd - command that is ready to be queued.
299 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 * Notes: This function has the job of initializing a number of
301 * fields related to error handling. Typically this will
302 * be called once for each command, as required.
303 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200304static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 cmd->serial_number = 0;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200307 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900308 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300310 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311}
312
313void scsi_device_unbusy(struct scsi_device *sdev)
314{
315 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500316 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 unsigned long flags;
318
Christoph Hellwig74665012014-01-22 15:29:29 +0100319 atomic_dec(&shost->host_busy);
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100320 if (starget->can_queue > 0)
321 atomic_dec(&starget->target_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +0100322
James Bottomley939647e2005-09-18 15:05:20 -0500323 if (unlikely(scsi_host_in_recovery(shost) &&
Christoph Hellwig74665012014-01-22 15:29:29 +0100324 (shost->host_failed || shost->host_eh_scheduled))) {
325 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 scsi_eh_wakeup(shost);
Christoph Hellwig74665012014-01-22 15:29:29 +0100327 spin_unlock_irqrestore(shost->host_lock, flags);
328 }
329
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200330 atomic_dec(&sdev->device_busy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331}
332
Christoph Hellwigd2852032014-01-17 12:06:53 +0100333static void scsi_kick_queue(struct request_queue *q)
334{
335 if (q->mq_ops)
336 blk_mq_start_hw_queues(q);
337 else
338 blk_run_queue(q);
339}
340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341/*
342 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
343 * and call blk_run_queue for all the scsi_devices on the target -
344 * including current_sdev first.
345 *
346 * Called with *no* scsi locks held.
347 */
348static void scsi_single_lun_run(struct scsi_device *current_sdev)
349{
350 struct Scsi_Host *shost = current_sdev->host;
351 struct scsi_device *sdev, *tmp;
352 struct scsi_target *starget = scsi_target(current_sdev);
353 unsigned long flags;
354
355 spin_lock_irqsave(shost->host_lock, flags);
356 starget->starget_sdev_user = NULL;
357 spin_unlock_irqrestore(shost->host_lock, flags);
358
359 /*
360 * Call blk_run_queue for all LUNs on the target, starting with
361 * current_sdev. We race with others (to set starget_sdev_user),
362 * but in most cases, we will be first. Ideally, each LU on the
363 * target would get some limited time or requests on the target.
364 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100365 scsi_kick_queue(current_sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
367 spin_lock_irqsave(shost->host_lock, flags);
368 if (starget->starget_sdev_user)
369 goto out;
370 list_for_each_entry_safe(sdev, tmp, &starget->devices,
371 same_target_siblings) {
372 if (sdev == current_sdev)
373 continue;
374 if (scsi_device_get(sdev))
375 continue;
376
377 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100378 scsi_kick_queue(sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 spin_lock_irqsave(shost->host_lock, flags);
380
381 scsi_device_put(sdev);
382 }
383 out:
384 spin_unlock_irqrestore(shost->host_lock, flags);
385}
386
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100387static inline bool scsi_device_is_busy(struct scsi_device *sdev)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400388{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100389 if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
390 return true;
391 if (atomic_read(&sdev->device_blocked) > 0)
392 return true;
393 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400394}
395
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100396static inline bool scsi_target_is_busy(struct scsi_target *starget)
Mike Christief0c0a372008-08-17 15:24:38 -0500397{
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100398 if (starget->can_queue > 0) {
399 if (atomic_read(&starget->target_busy) >= starget->can_queue)
400 return true;
401 if (atomic_read(&starget->target_blocked) > 0)
402 return true;
403 }
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100404 return false;
Mike Christief0c0a372008-08-17 15:24:38 -0500405}
406
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100407static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400408{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100409 if (shost->can_queue > 0 &&
410 atomic_read(&shost->host_busy) >= shost->can_queue)
411 return true;
412 if (atomic_read(&shost->host_blocked) > 0)
413 return true;
414 if (shost->host_self_blocked)
415 return true;
416 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400417}
418
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800419static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600421 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800422 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 unsigned long flags;
424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600426 list_splice_init(&shost->starved_list, &starved_list);
427
428 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200429 struct request_queue *slq;
430
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 /*
432 * As long as shost is accepting commands and we have
433 * starved queues, call blk_run_queue. scsi_request_fn
434 * drops the queue_lock and can add us back to the
435 * starved_list.
436 *
437 * host_lock protects the starved_list and starved_entry.
438 * scsi_request_fn must get the host_lock before checking
439 * or modifying starved_list or starved_entry.
440 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600441 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500442 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500443
Mike Christie2a3a59e2008-11-11 13:42:35 -0600444 sdev = list_entry(starved_list.next,
445 struct scsi_device, starved_entry);
446 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500447 if (scsi_target_is_busy(scsi_target(sdev))) {
448 list_move_tail(&sdev->starved_entry,
449 &shost->starved_list);
450 continue;
451 }
452
James Bottomleye2eb7242013-07-02 15:05:26 +0200453 /*
454 * Once we drop the host lock, a racing scsi_remove_device()
455 * call may remove the sdev from the starved list and destroy
456 * it and the queue. Mitigate by taking a reference to the
457 * queue and never touching the sdev again after we drop the
458 * host lock. Note: if __scsi_remove_device() invokes
459 * blk_cleanup_queue() before the queue is run from this
460 * function then blk_run_queue() will return immediately since
461 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
462 */
463 slq = sdev->request_queue;
464 if (!blk_get_queue(slq))
465 continue;
466 spin_unlock_irqrestore(shost->host_lock, flags);
467
Christoph Hellwigd2852032014-01-17 12:06:53 +0100468 scsi_kick_queue(slq);
James Bottomleye2eb7242013-07-02 15:05:26 +0200469 blk_put_queue(slq);
470
471 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600473 /* put any unprocessed entries back */
474 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800476}
477
478/*
479 * Function: scsi_run_queue()
480 *
481 * Purpose: Select a proper request queue to serve next
482 *
483 * Arguments: q - last request's queue
484 *
485 * Returns: Nothing
486 *
487 * Notes: The previous command was completely finished, start
488 * a new one if possible.
489 */
490static void scsi_run_queue(struct request_queue *q)
491{
492 struct scsi_device *sdev = q->queuedata;
493
494 if (scsi_target(sdev)->single_lun)
495 scsi_single_lun_run(sdev);
496 if (!list_empty(&sdev->host->starved_list))
497 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
Christoph Hellwigd2852032014-01-17 12:06:53 +0100499 if (q->mq_ops)
Bart Van Assche36e3cf22017-04-07 11:16:53 -0700500 blk_mq_run_hw_queues(q, false);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100501 else
502 blk_run_queue(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503}
504
Jens Axboe9937a5e2011-05-17 11:04:44 +0200505void scsi_requeue_run_queue(struct work_struct *work)
506{
507 struct scsi_device *sdev;
508 struct request_queue *q;
509
510 sdev = container_of(work, struct scsi_device, requeue_work);
511 q = sdev->request_queue;
512 scsi_run_queue(q);
513}
514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515/*
516 * Function: scsi_requeue_command()
517 *
518 * Purpose: Handle post-processing of completed commands.
519 *
520 * Arguments: q - queue to operate on
521 * cmd - command that may need to be requeued.
522 *
523 * Returns: Nothing
524 *
525 * Notes: After command completion, there may be blocks left
526 * over which weren't finished by the previous command
527 * this can be for a number of reasons - the main one is
528 * I/O errors in the middle of the request, in which case
529 * we need to request the blocks that come after the bad
530 * sector.
James Bottomleye91442b2005-09-09 10:44:16 -0500531 * Notes: Upon return, cmd is a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 */
533static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
534{
Bart Van Assche940f5d42012-06-29 15:34:26 +0000535 struct scsi_device *sdev = cmd->device;
James Bottomleye91442b2005-09-09 10:44:16 -0500536 struct request *req = cmd->request;
Tejun Heo 283369c2005-04-24 02:06:36 -0500537 unsigned long flags;
538
Tejun Heo 283369c2005-04-24 02:06:36 -0500539 spin_lock_irqsave(q->queue_lock, flags);
Christoph Hellwig134997a2014-02-20 14:20:58 -0800540 blk_unprep_request(req);
541 req->special = NULL;
542 scsi_put_command(cmd);
James Bottomleye91442b2005-09-09 10:44:16 -0500543 blk_requeue_request(q, req);
Tejun Heo 283369c2005-04-24 02:06:36 -0500544 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
546 scsi_run_queue(q);
Bart Van Assche940f5d42012-06-29 15:34:26 +0000547
548 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549}
550
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551void scsi_run_host_queues(struct Scsi_Host *shost)
552{
553 struct scsi_device *sdev;
554
555 shost_for_each_device(sdev, shost)
556 scsi_run_queue(sdev->request_queue);
557}
558
Christoph Hellwigd2852032014-01-17 12:06:53 +0100559static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
560{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100561 if (!blk_rq_is_passthrough(cmd->request)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100562 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
563
564 if (drv->uninit_command)
565 drv->uninit_command(cmd);
566 }
567}
568
569static void scsi_mq_free_sgtables(struct scsi_cmnd *cmd)
570{
Ming Lin91dbc082016-04-04 14:48:07 -0700571 struct scsi_data_buffer *sdb;
572
Christoph Hellwigd2852032014-01-17 12:06:53 +0100573 if (cmd->sdb.table.nents)
Ming Lin001d63b2016-04-04 14:48:09 -0700574 sg_free_table_chained(&cmd->sdb.table, true);
Ming Lin91dbc082016-04-04 14:48:07 -0700575 if (cmd->request->next_rq) {
576 sdb = cmd->request->next_rq->special;
577 if (sdb)
Ming Lin001d63b2016-04-04 14:48:09 -0700578 sg_free_table_chained(&sdb->table, true);
Ming Lin91dbc082016-04-04 14:48:07 -0700579 }
Christoph Hellwigd2852032014-01-17 12:06:53 +0100580 if (scsi_prot_sg_count(cmd))
Ming Lin001d63b2016-04-04 14:48:09 -0700581 sg_free_table_chained(&cmd->prot_sdb->table, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100582}
583
584static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
585{
586 struct scsi_device *sdev = cmd->device;
Kashyap.Desai@avagotech.com64bdcbc2014-08-20 19:24:33 +0530587 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100588 unsigned long flags;
589
Christoph Hellwigd2852032014-01-17 12:06:53 +0100590 scsi_mq_free_sgtables(cmd);
591 scsi_uninit_cmd(cmd);
592
Kashyap.Desai@avagotech.com64bdcbc2014-08-20 19:24:33 +0530593 if (shost->use_cmd_list) {
594 BUG_ON(list_empty(&cmd->list));
595 spin_lock_irqsave(&sdev->list_lock, flags);
596 list_del_init(&cmd->list);
597 spin_unlock_irqrestore(&sdev->list_lock, flags);
598 }
Christoph Hellwigd2852032014-01-17 12:06:53 +0100599}
600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601/*
602 * Function: scsi_release_buffers()
603 *
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200604 * Purpose: Free resources allocate for a scsi_command.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 *
606 * Arguments: cmd - command that we are bailing.
607 *
608 * Lock status: Assumed that no lock is held upon entry.
609 *
610 * Returns: Nothing
611 *
612 * Notes: In the event that an upper level driver rejects a
613 * command, we must release resources allocated during
614 * the __init_io() function. Primarily this would involve
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200615 * the scatter-gather table.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 */
Christoph Hellwigf1bea552014-04-15 12:26:54 +0200617static void scsi_release_buffers(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200619 if (cmd->sdb.table.nents)
Ming Lin001d63b2016-04-04 14:48:09 -0700620 sg_free_table_chained(&cmd->sdb.table, false);
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200621
622 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
623
624 if (scsi_prot_sg_count(cmd))
Ming Lin001d63b2016-04-04 14:48:09 -0700625 sg_free_table_chained(&cmd->prot_sdb->table, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626}
627
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200628static void scsi_release_bidi_buffers(struct scsi_cmnd *cmd)
629{
630 struct scsi_data_buffer *bidi_sdb = cmd->request->next_rq->special;
631
Ming Lin001d63b2016-04-04 14:48:09 -0700632 sg_free_table_chained(&bidi_sdb->table, false);
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200633 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
634 cmd->request->next_rq->special = NULL;
635}
636
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200637static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800638 unsigned int bytes, unsigned int bidi_bytes)
639{
640 struct scsi_cmnd *cmd = req->special;
641 struct scsi_device *sdev = cmd->device;
642 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800643
644 if (blk_update_request(req, error, bytes))
645 return true;
646
647 /* Bidi request must be completed as a whole */
648 if (unlikely(bidi_bytes) &&
649 blk_update_request(req->next_rq, error, bidi_bytes))
650 return true;
651
652 if (blk_queue_add_random(q))
653 add_disk_randomness(req->rq_disk);
654
Christoph Hellwigd2852032014-01-17 12:06:53 +0100655 if (req->mq_ctx) {
656 /*
Christoph Hellwigc8a446a2014-09-13 16:40:10 -0700657 * In the MQ case the command gets freed by __blk_mq_end_request,
Christoph Hellwigd2852032014-01-17 12:06:53 +0100658 * so we have to do all cleanup that depends on it earlier.
659 *
660 * We also can't kick the queues from irq context, so we
661 * will have to defer it to a workqueue.
662 */
663 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800664
Christoph Hellwigc8a446a2014-09-13 16:40:10 -0700665 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100666
667 if (scsi_target(sdev)->single_lun ||
668 !list_empty(&sdev->host->starved_list))
669 kblockd_schedule_work(&sdev->requeue_work);
670 else
Bart Van Assche36e3cf22017-04-07 11:16:53 -0700671 blk_mq_run_hw_queues(q, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100672 } else {
673 unsigned long flags;
674
Daniel Gryniewiczf81426a2014-09-16 10:41:13 -0400675 if (bidi_bytes)
676 scsi_release_bidi_buffers(cmd);
Christoph Hellwige9c787e2017-01-02 21:55:26 +0300677 scsi_release_buffers(cmd);
678 scsi_put_command(cmd);
Daniel Gryniewiczf81426a2014-09-16 10:41:13 -0400679
Christoph Hellwigd2852032014-01-17 12:06:53 +0100680 spin_lock_irqsave(q->queue_lock, flags);
681 blk_finish_request(req, error);
682 spin_unlock_irqrestore(q->queue_lock, flags);
683
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700684 scsi_run_queue(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100685 }
686
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700687 put_device(&sdev->sdev_gendev);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800688 return false;
689}
690
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200691/**
692 * __scsi_error_from_host_byte - translate SCSI error code into errno
693 * @cmd: SCSI command (unused)
694 * @result: scsi error code
695 *
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200696 * Translate SCSI error code into block errors.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200697 */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200698static blk_status_t __scsi_error_from_host_byte(struct scsi_cmnd *cmd,
699 int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100700{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200701 switch (host_byte(result)) {
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100702 case DID_TRANSPORT_FAILFAST:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200703 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100704 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000705 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200706 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100707 case DID_NEXUS_FAILURE:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200708 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200709 case DID_ALLOC_FAILURE:
710 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200711 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200712 case DID_MEDIUM_ERROR:
713 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200714 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100715 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200716 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100717 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100718}
719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720/*
721 * Function: scsi_io_completion()
722 *
723 * Purpose: Completion processing for block device I/O requests.
724 *
725 * Arguments: cmd - command that is finished.
726 *
727 * Lock status: Assumed that no lock is held upon entry.
728 *
729 * Returns: Nothing
730 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200731 * Notes: We will finish off the specified number of sectors. If we
732 * are done, the command block will be released and the queue
733 * function will be goosed. If we are not done then we have to
Alan Sternb60af5b2008-11-03 15:56:47 -0500734 * figure out what to do next:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500736 * a) We can call scsi_requeue_command(). The request
737 * will be unprepared and put back on the queue. Then
738 * a new command will be created for it. This should
739 * be used if we made forward progress, or if we want
740 * to switch from READ(10) to READ(6) for example.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200742 * b) We can call __scsi_queue_insert(). The request will
Alan Sternb60af5b2008-11-03 15:56:47 -0500743 * be put back on the queue and retried using the same
744 * command as before, possibly after a delay.
745 *
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800746 * c) We can call scsi_end_request() with -EIO to fail
Alan Sternb60af5b2008-11-03 15:56:47 -0500747 * the remainder of the request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 */
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700749void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750{
751 int result = cmd->result;
Jens Axboe165125e2007-07-24 09:28:11 +0200752 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 struct request *req = cmd->request;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200754 blk_status_t error = BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 struct scsi_sense_hdr sshdr;
Hannes Reinecke4753cbc2014-10-24 14:26:52 +0200756 bool sense_valid = false;
Hannes Reineckec11c0042014-10-24 14:27:01 +0200757 int sense_deferred = 0, level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500758 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
759 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900760 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 if (result) {
763 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
764 if (sense_valid)
765 sense_deferred = scsi_sense_is_deferred(&sshdr);
766 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200767
Christoph Hellwig57292b52017-01-31 16:57:29 +0100768 if (blk_rq_is_passthrough(req)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 if (result) {
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100770 if (sense_valid) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 /*
772 * SG_IO wants current and deferred errors
773 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100774 scsi_req(req)->sense_len =
775 min(8 + cmd->sense_buffer[7],
776 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 }
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500778 if (!sense_deferred)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100779 error = __scsi_error_from_host_byte(cmd, result);
Pete Wyckoffb22f6872007-03-13 16:53:28 -0400780 }
Mike Snitzer27c41972012-05-31 15:05:33 -0400781 /*
782 * __scsi_error_from_host_byte may have reset the host_byte
783 */
Christoph Hellwig17d53632017-04-20 16:03:01 +0200784 scsi_req(req)->result = cmd->result;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100785 scsi_req(req)->resid_len = scsi_get_resid(cmd);
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900786
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200787 if (scsi_bidi_cmnd(cmd)) {
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900788 /*
789 * Bidi commands Must be complete as a whole,
790 * both sides at once.
791 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100792 scsi_req(req->next_rq)->resid_len = scsi_in(cmd)->resid;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200793 if (scsi_end_request(req, BLK_STS_OK, blk_rq_bytes(req),
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800794 blk_rq_bytes(req->next_rq)))
795 BUG();
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200796 return;
797 }
James Bottomley89fb4cd2014-07-03 19:17:34 +0200798 } else if (blk_rq_bytes(req) == 0 && result && !sense_deferred) {
799 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100800 * Flush commands do not transfers any data, and thus cannot use
James Bottomley89fb4cd2014-07-03 19:17:34 +0200801 * good_bytes != blk_rq_bytes(req) as the signal for an error.
802 * This sets the error explicitly for the problem case.
803 */
804 error = __scsi_error_from_host_byte(cmd, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 }
806
Christoph Hellwig57292b52017-01-31 16:57:29 +0100807 /* no bidi support for !blk_rq_is_passthrough yet */
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200808 BUG_ON(blk_bidi_rq(req));
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 * Next deal with any sectors which we were able to correctly
812 * handle.
813 */
Hannes Reinecke91921e02014-06-25 16:39:59 +0200814 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
815 "%u sectors total, %d bytes done.\n",
816 blk_rq_sectors(req), good_bytes));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
James Bottomleya9bddd72009-03-30 16:55:51 +0000818 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100819 * Recovered errors need reporting, but they're always treated as
820 * success, so fiddle the result code here. For passthrough requests
Christoph Hellwig17d53632017-04-20 16:03:01 +0200821 * we already took a copy of the original into sreq->result which
James Bottomleya9bddd72009-03-30 16:55:51 +0000822 * is what gets returned to the user
823 */
Douglas Gilberte7efe592010-01-03 13:51:15 -0500824 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
825 /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
826 * print since caller wants ATA registers. Only occurs on
827 * SCSI ATA PASS_THROUGH commands when CK_COND=1
828 */
829 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
830 ;
Christoph Hellwige8064022016-10-20 15:12:13 +0200831 else if (!(req->rq_flags & RQF_QUIET))
Hannes Reinecked811b842014-10-24 14:26:45 +0200832 scsi_print_sense(cmd);
James Bottomleya9bddd72009-03-30 16:55:51 +0000833 result = 0;
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100834 /* for passthrough error may be set */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200835 error = BLK_STS_OK;
James Bottomleya9bddd72009-03-30 16:55:51 +0000836 }
837
838 /*
James Bottomleya621bac2016-05-13 12:04:06 -0700839 * special case: failed zero length commands always need to
840 * drop down into the retry code. Otherwise, if we finished
841 * all bytes in the request we are done now.
James Bottomleyd6b0c532006-07-02 10:06:28 -0500842 */
James Bottomleya621bac2016-05-13 12:04:06 -0700843 if (!(blk_rq_bytes(req) == 0 && error) &&
844 !scsi_end_request(req, error, good_bytes, 0))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800845 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200846
847 /*
848 * Kill remainder if no retrys.
849 */
850 if (error && scsi_noretry_cmd(cmd)) {
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800851 if (scsi_end_request(req, error, blk_rq_bytes(req), 0))
852 BUG();
853 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200854 }
855
856 /*
857 * If there had been no error, but we have leftover bytes in the
858 * requeues just queue the command up again.
859 */
860 if (result == 0)
861 goto requeue;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700862
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100863 error = __scsi_error_from_host_byte(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500864
Alan Sternb60af5b2008-11-03 15:56:47 -0500865 if (host_byte(result) == DID_RESET) {
866 /* Third party bus reset or reset for error recovery
867 * reasons. Just retry the command and see what
868 * happens.
869 */
870 action = ACTION_RETRY;
871 } else if (sense_valid && !sense_deferred) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 switch (sshdr.sense_key) {
873 case UNIT_ATTENTION:
874 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700875 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 * and quietly refuse further access.
877 */
878 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500879 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700881 /* Must have been a power glitch, or a
882 * bus reset. Could not have been a
883 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500884 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700885 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500886 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 }
888 break;
889 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700890 /* If we had an ILLEGAL REQUEST returned, then
891 * we may have performed an unsupported
892 * command. The only thing this should be
893 * would be a ten byte read where only a six
894 * byte read was supported. Also, on a system
895 * where READ CAPACITY failed, we may have
896 * read past the end of the disk.
897 */
Jens Axboe26a68012005-11-29 21:03:34 +0100898 if ((cmd->device->use_10_for_rw &&
899 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 (cmd->cmnd[0] == READ_10 ||
901 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500902 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500904 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500905 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500906 action = ACTION_FAIL;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200907 error = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500908 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400909 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500910 action = ACTION_FAIL;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200911 error = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500912 } else
913 action = ACTION_FAIL;
914 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400915 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000916 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200917 if (sshdr.asc == 0x10) /* DIF */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200918 error = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 break;
920 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700921 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500922 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500924 if (sshdr.asc == 0x04) {
925 switch (sshdr.ascq) {
926 case 0x01: /* becoming ready */
927 case 0x04: /* format in progress */
928 case 0x05: /* rebuild in progress */
929 case 0x06: /* recalculation in progress */
930 case 0x07: /* operation in progress */
931 case 0x08: /* Long write in progress */
932 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500933 case 0x14: /* space allocation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500934 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500935 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500936 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500937 action = ACTION_FAIL;
938 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500939 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200940 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500941 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500942 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700944 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500945 action = ACTION_FAIL;
946 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500948 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 break;
950 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200951 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500952 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500953
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900954 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200955 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900956 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900957
Alan Sternb60af5b2008-11-03 15:56:47 -0500958 switch (action) {
959 case ACTION_FAIL:
960 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200961 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200962 static DEFINE_RATELIMIT_STATE(_rs,
963 DEFAULT_RATELIMIT_INTERVAL,
964 DEFAULT_RATELIMIT_BURST);
965
966 if (unlikely(scsi_logging_level))
967 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
968 SCSI_LOG_MLCOMPLETE_BITS);
969
970 /*
971 * if logging is enabled the failure will be printed
972 * in scsi_log_completion(), so avoid duplicate messages
973 */
974 if (!level && __ratelimit(&_rs)) {
975 scsi_print_result(cmd, NULL, FAILED);
976 if (driver_byte(result) & DRIVER_SENSE)
977 scsi_print_sense(cmd);
978 scsi_print_command(cmd);
979 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500980 }
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800981 if (!scsi_end_request(req, error, blk_rq_err_bytes(req), 0))
982 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200983 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500984 case ACTION_REPREP:
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200985 requeue:
Alan Sternb60af5b2008-11-03 15:56:47 -0500986 /* Unprep the request and put it back at the head of the queue.
987 * A new command will be prepared and issued.
988 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100989 if (q->mq_ops) {
Christoph Hellwige8064022016-10-20 15:12:13 +0200990 cmd->request->rq_flags &= ~RQF_DONTPREP;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100991 scsi_mq_uninit_cmd(cmd);
992 scsi_mq_requeue_cmd(cmd);
993 } else {
994 scsi_release_buffers(cmd);
995 scsi_requeue_command(q, cmd);
996 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500997 break;
998 case ACTION_RETRY:
999 /* Retry the same command immediately */
James Bottomley4f5299a2009-01-02 10:42:21 -06001000 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001001 break;
1002 case ACTION_DELAYED_RETRY:
1003 /* Retry the same command after a delay */
James Bottomley4f5299a2009-01-02 10:42:21 -06001004 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001005 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 }
1007}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001009static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001011 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
1013 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001014 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001016 if (unlikely(sg_alloc_table_chained(&sdb->table,
1017 blk_rq_nr_phys_segments(req), sdb->table.sgl)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 return BLKPREP_DEFER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 /*
1021 * Next, walk the list, and fill in the addresses and sizes of
1022 * each segment.
1023 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001024 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1025 BUG_ON(count > sdb->table.nents);
1026 sdb->table.nents = count;
Christoph Hellwigfd102b12017-01-13 12:29:11 +01001027 sdb->length = blk_rq_payload_bytes(req);
Rusty Russell4a03d902007-11-19 11:28:48 +11001028 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001030
1031/*
1032 * Function: scsi_init_io()
1033 *
1034 * Purpose: SCSI I/O initialize function.
1035 *
1036 * Arguments: cmd - Command descriptor we wish to initialize
1037 *
1038 * Returns: 0 on success
1039 * BLKPREP_DEFER if the failure is retryable
1040 * BLKPREP_KILL if the failure is fatal
1041 */
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001042int scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001043{
Christoph Hellwig5e012aa2014-04-15 12:24:55 +02001044 struct scsi_device *sdev = cmd->device;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001045 struct request *rq = cmd->request;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001046 bool is_mq = (rq->mq_ctx != NULL);
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001047 int error = BLKPREP_KILL;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001048
Johannes Thumshirnfd3fc0b2017-01-31 10:16:00 +01001049 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001050 goto err_exit;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001051
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001052 error = scsi_init_sgtable(rq, &cmd->sdb);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001053 if (error)
1054 goto err_exit;
1055
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001056 if (blk_bidi_rq(rq)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001057 if (!rq->q->mq_ops) {
1058 struct scsi_data_buffer *bidi_sdb =
1059 kmem_cache_zalloc(scsi_sdb_cache, GFP_ATOMIC);
1060 if (!bidi_sdb) {
1061 error = BLKPREP_DEFER;
1062 goto err_exit;
1063 }
1064
1065 rq->next_rq->special = bidi_sdb;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001066 }
1067
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001068 error = scsi_init_sgtable(rq->next_rq, rq->next_rq->special);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001069 if (error)
1070 goto err_exit;
1071 }
1072
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001073 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001074 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1075 int ivecs, count;
1076
Ewan D. Milne91724c22015-01-15 10:02:12 -05001077 if (prot_sdb == NULL) {
1078 /*
1079 * This can happen if someone (e.g. multipath)
1080 * queues a command to a device on an adapter
1081 * that does not support DIX.
1082 */
1083 WARN_ON_ONCE(1);
1084 error = BLKPREP_KILL;
1085 goto err_exit;
1086 }
1087
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001088 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001089
Ming Lin001d63b2016-04-04 14:48:09 -07001090 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lin22cc3d42016-04-04 14:48:08 -07001091 prot_sdb->table.sgl)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001092 error = BLKPREP_DEFER;
1093 goto err_exit;
1094 }
1095
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001096 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001097 prot_sdb->table.sgl);
1098 BUG_ON(unlikely(count > ivecs));
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001099 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001100
1101 cmd->prot_sdb = prot_sdb;
1102 cmd->prot_sdb->table.nents = count;
1103 }
1104
Christoph Hellwigd2852032014-01-17 12:06:53 +01001105 return BLKPREP_OK;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001106err_exit:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001107 if (is_mq) {
1108 scsi_mq_free_sgtables(cmd);
1109 } else {
1110 scsi_release_buffers(cmd);
1111 cmd->request->special = NULL;
1112 scsi_put_command(cmd);
1113 put_device(&sdev->sdev_gendev);
1114 }
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001115 return error;
1116}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001117EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001119/**
1120 * scsi_initialize_rq - initialize struct scsi_cmnd.req
1121 *
1122 * Called from inside blk_get_request().
1123 */
1124void scsi_initialize_rq(struct request *rq)
1125{
1126 scsi_req_init(rq);
1127}
1128EXPORT_SYMBOL(scsi_initialize_rq);
1129
1130/* Called after a request has been started. */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001131void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001132{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001133 void *buf = cmd->sense_buffer;
1134 void *prot = cmd->prot_sdb;
1135 unsigned long flags;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001136
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001137 /* zero out the cmd, except for the embedded scsi_request */
1138 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001139 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001140
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001141 cmd->device = dev;
1142 cmd->sense_buffer = buf;
1143 cmd->prot_sdb = prot;
1144 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1145 cmd->jiffies_at_alloc = jiffies;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001146
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001147 spin_lock_irqsave(&dev->list_lock, flags);
1148 list_add_tail(&cmd->list, &dev->cmd_list);
1149 spin_unlock_irqrestore(&dev->list_lock, flags);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001150}
1151
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001152static int scsi_setup_scsi_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001153{
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001154 struct scsi_cmnd *cmd = req->special;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001155
1156 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001157 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001158 * a bio attached to them. Or they might contain a SCSI command
1159 * that does not transfer data, in which case they may optionally
1160 * submit a request without an attached bio.
1161 */
1162 if (req->bio) {
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001163 int ret = scsi_init_io(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001164 if (unlikely(ret))
1165 return ret;
1166 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001167 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001168
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001169 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001170 }
James Bottomley7b163182005-12-15 20:17:02 -06001171
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001172 cmd->cmd_len = scsi_req(req)->cmd_len;
1173 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001174 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001175 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001176 return BLKPREP_OK;
1177}
1178
1179/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001180 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001181 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001182 */
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001183static int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001184{
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001185 struct scsi_cmnd *cmd = req->special;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001186
Christoph Hellwigee14c672015-08-27 14:16:59 +02001187 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
1188 int ret = sdev->handler->prep_fn(sdev, req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001189 if (ret != BLKPREP_OK)
1190 return ret;
1191 }
1192
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001193 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001194 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001195 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001196}
James Bottomley7b163182005-12-15 20:17:02 -06001197
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001198static int scsi_setup_cmnd(struct scsi_device *sdev, struct request *req)
1199{
1200 struct scsi_cmnd *cmd = req->special;
1201
1202 if (!blk_rq_bytes(req))
1203 cmd->sc_data_direction = DMA_NONE;
1204 else if (rq_data_dir(req) == WRITE)
1205 cmd->sc_data_direction = DMA_TO_DEVICE;
1206 else
1207 cmd->sc_data_direction = DMA_FROM_DEVICE;
1208
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001209 if (blk_rq_is_scsi(req))
1210 return scsi_setup_scsi_cmnd(sdev, req);
1211 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001212 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001213}
1214
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001215static int
1216scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001218 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219
1220 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001221 * If the device is not in running state we will reject some
1222 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001225 switch (sdev->sdev_state) {
1226 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05001227 case SDEV_TRANSPORT_OFFLINE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001228 /*
1229 * If the device is offline we refuse to process any
1230 * commands. The device must be brought online
1231 * before trying any recovery commands.
1232 */
1233 sdev_printk(KERN_ERR, sdev,
1234 "rejecting I/O to offline device\n");
1235 ret = BLKPREP_KILL;
1236 break;
1237 case SDEV_DEL:
1238 /*
1239 * If the device is fully deleted, we refuse to
1240 * process any commands as well.
1241 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001242 sdev_printk(KERN_ERR, sdev,
1243 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001244 ret = BLKPREP_KILL;
1245 break;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001246 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001247 case SDEV_CREATED_BLOCK:
Bart Van Asschebba0bdd2015-03-04 10:31:47 +01001248 ret = BLKPREP_DEFER;
1249 break;
1250 case SDEV_QUIESCE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001251 /*
1252 * If the devices is blocked we defer normal commands.
1253 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001254 if (!(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001255 ret = BLKPREP_DEFER;
1256 break;
1257 default:
1258 /*
1259 * For any other not fully online state we only allow
1260 * special commands. In particular any user initiated
1261 * command is not allowed.
1262 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001263 if (!(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001264 ret = BLKPREP_KILL;
1265 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001268 return ret;
1269}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001271static int
1272scsi_prep_return(struct request_queue *q, struct request *req, int ret)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001273{
1274 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275
Christoph Hellwig3b003152006-11-04 20:10:55 +01001276 switch (ret) {
1277 case BLKPREP_KILL:
jiangyiwene1cd3912016-02-16 20:14:13 +08001278 case BLKPREP_INVALID:
Christoph Hellwig17d53632017-04-20 16:03:01 +02001279 scsi_req(req)->result = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001280 /* release the command and kill it */
1281 if (req->special) {
1282 struct scsi_cmnd *cmd = req->special;
1283 scsi_release_buffers(cmd);
1284 scsi_put_command(cmd);
Christoph Hellwig68c03d92014-04-15 12:24:56 +02001285 put_device(&sdev->sdev_gendev);
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001286 req->special = NULL;
1287 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001288 break;
1289 case BLKPREP_DEFER:
1290 /*
Tejun Heo9934c8c2009-05-08 11:54:16 +09001291 * If we defer, the blk_peek_request() returns NULL, but the
Jens Axboea488e742010-04-16 21:13:15 +02001292 * queue must be restarted, so we schedule a callback to happen
1293 * shortly.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001294 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001295 if (atomic_read(&sdev->device_busy) == 0)
Jens Axboea488e742010-04-16 21:13:15 +02001296 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001297 break;
1298 default:
Christoph Hellwige8064022016-10-20 15:12:13 +02001299 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001300 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301
Christoph Hellwig3b003152006-11-04 20:10:55 +01001302 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001304
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001305static int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001306{
1307 struct scsi_device *sdev = q->queuedata;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001308 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001309 int ret;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001310
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001311 ret = scsi_prep_state_check(sdev, req);
1312 if (ret != BLKPREP_OK)
1313 goto out;
1314
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001315 if (!req->special) {
1316 /* Bail if we can't get a reference to the device */
1317 if (unlikely(!get_device(&sdev->sdev_gendev))) {
1318 ret = BLKPREP_DEFER;
1319 goto out;
1320 }
1321
1322 scsi_init_command(sdev, cmd);
1323 req->special = cmd;
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001324 }
1325
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001326 cmd->tag = req->tag;
1327 cmd->request = req;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001328 cmd->prot_op = SCSI_PROT_NORMAL;
1329
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001330 ret = scsi_setup_cmnd(sdev, req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001331out:
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001332 return scsi_prep_return(q, req, ret);
1333}
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001334
1335static void scsi_unprep_fn(struct request_queue *q, struct request *req)
1336{
Christoph Hellwigd2852032014-01-17 12:06:53 +01001337 scsi_uninit_cmd(req->special);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001338}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
1340/*
1341 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1342 * return 0.
1343 *
1344 * Called with the queue_lock held.
1345 */
1346static inline int scsi_dev_queue_ready(struct request_queue *q,
1347 struct scsi_device *sdev)
1348{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001349 unsigned int busy;
1350
1351 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001352 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001353 if (busy)
1354 goto out_dec;
1355
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 /*
1357 * unblock after device_blocked iterates to zero
1358 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001359 if (atomic_dec_return(&sdev->device_blocked) > 0) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001360 /*
1361 * For the MQ case we take care of this in the caller.
1362 */
1363 if (!q->mq_ops)
1364 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001365 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001367 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1368 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001370
1371 if (busy >= sdev->queue_depth)
1372 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373
1374 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001375out_dec:
1376 atomic_dec(&sdev->device_busy);
1377 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378}
1379
Mike Christief0c0a372008-08-17 15:24:38 -05001380/*
1381 * scsi_target_queue_ready: checks if there we can send commands to target
1382 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001383 */
1384static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1385 struct scsi_device *sdev)
1386{
1387 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001388 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001389
1390 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001391 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001392 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001393 starget->starget_sdev_user != sdev) {
1394 spin_unlock_irq(shost->host_lock);
1395 return 0;
1396 }
Mike Christief0c0a372008-08-17 15:24:38 -05001397 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001398 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001399 }
1400
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001401 if (starget->can_queue <= 0)
1402 return 1;
1403
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001404 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001405 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001406 if (busy)
1407 goto starved;
1408
Mike Christief0c0a372008-08-17 15:24:38 -05001409 /*
1410 * unblock after target_blocked iterates to zero
1411 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001412 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001413 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001414
1415 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1416 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001417 }
1418
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001419 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001420 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001421
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001422 return 1;
1423
1424starved:
1425 spin_lock_irq(shost->host_lock);
1426 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001427 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001428out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001429 if (starget->can_queue > 0)
1430 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001431 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001432}
1433
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434/*
1435 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1436 * return 0. We must end up running the queue again whenever 0 is
1437 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 */
1439static inline int scsi_host_queue_ready(struct request_queue *q,
1440 struct Scsi_Host *shost,
1441 struct scsi_device *sdev)
1442{
Christoph Hellwig74665012014-01-22 15:29:29 +01001443 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001444
James Bottomley939647e2005-09-18 15:05:20 -05001445 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001446 return 0;
1447
1448 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001449 if (atomic_read(&shost->host_blocked) > 0) {
Christoph Hellwig74665012014-01-22 15:29:29 +01001450 if (busy)
1451 goto starved;
1452
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 /*
1454 * unblock after host_blocked iterates to zero
1455 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001456 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001457 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001458
1459 SCSI_LOG_MLQUEUE(3,
1460 shost_printk(KERN_INFO, shost,
1461 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001463
1464 if (shost->can_queue > 0 && busy >= shost->can_queue)
1465 goto starved;
1466 if (shost->host_self_blocked)
1467 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468
1469 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001470 if (!list_empty(&sdev->starved_entry)) {
1471 spin_lock_irq(shost->host_lock);
1472 if (!list_empty(&sdev->starved_entry))
1473 list_del_init(&sdev->starved_entry);
1474 spin_unlock_irq(shost->host_lock);
1475 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476
Christoph Hellwig74665012014-01-22 15:29:29 +01001477 return 1;
1478
1479starved:
1480 spin_lock_irq(shost->host_lock);
1481 if (list_empty(&sdev->starved_entry))
1482 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001483 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001484out_dec:
1485 atomic_dec(&shost->host_busy);
1486 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487}
1488
1489/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001490 * Busy state exporting function for request stacking drivers.
1491 *
1492 * For efficiency, no lock is taken to check the busy state of
1493 * shost/starget/sdev, since the returned value is not guaranteed and
1494 * may be changed after request stacking drivers call the function,
1495 * regardless of taking lock or not.
1496 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001497 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1498 * needs to return 'not busy'. Otherwise, request stacking drivers
1499 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001500 */
1501static int scsi_lld_busy(struct request_queue *q)
1502{
1503 struct scsi_device *sdev = q->queuedata;
1504 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001505
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001506 if (blk_queue_dying(q))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001507 return 0;
1508
1509 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001510
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001511 /*
1512 * Ignore host/starget busy state.
1513 * Since block layer does not have a concept of fairness across
1514 * multiple queues, congestion of host/starget needs to be handled
1515 * in SCSI layer.
1516 */
1517 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001518 return 1;
1519
1520 return 0;
1521}
1522
1523/*
James Bottomleye91442b2005-09-09 10:44:16 -05001524 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 */
Jens Axboe165125e2007-07-24 09:28:11 +02001526static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527{
James Bottomleye91442b2005-09-09 10:44:16 -05001528 struct scsi_cmnd *cmd = req->special;
Jiri Slaby03b14702009-09-23 16:15:35 +02001529 struct scsi_device *sdev;
1530 struct scsi_target *starget;
1531 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Tejun Heo9934c8c2009-05-08 11:54:16 +09001533 blk_start_request(req);
James Bottomley788ce432005-09-09 13:40:23 -05001534
Hannes Reinecke74571812011-11-09 08:39:24 +01001535 scmd_printk(KERN_INFO, cmd, "killing request\n");
1536
Jiri Slaby03b14702009-09-23 16:15:35 +02001537 sdev = cmd->device;
1538 starget = scsi_target(sdev);
1539 shost = sdev->host;
James Bottomleye91442b2005-09-09 10:44:16 -05001540 scsi_init_cmd_errh(cmd);
1541 cmd->result = DID_NO_CONNECT << 16;
1542 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001543
1544 /*
1545 * SCSI request completion path will do scsi_device_unbusy(),
1546 * bump busy counts. To bump the counters, we need to dance
1547 * with the locks as normal issue path does.
1548 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001549 atomic_inc(&sdev->device_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +01001550 atomic_inc(&shost->host_busy);
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001551 if (starget->can_queue > 0)
1552 atomic_inc(&starget->target_busy);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001553
Jens Axboe242f9dc2008-09-14 05:55:09 -07001554 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555}
1556
Jens Axboe1aea6432006-01-09 16:03:03 +01001557static void scsi_softirq_done(struct request *rq)
1558{
Jens Axboe242f9dc2008-09-14 05:55:09 -07001559 struct scsi_cmnd *cmd = rq->special;
1560 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001561 int disposition;
1562
1563 INIT_LIST_HEAD(&cmd->eh_entry);
1564
Jens Axboe242f9dc2008-09-14 05:55:09 -07001565 atomic_inc(&cmd->device->iodone_cnt);
1566 if (cmd->result)
1567 atomic_inc(&cmd->device->ioerr_cnt);
1568
Jens Axboe1aea6432006-01-09 16:03:03 +01001569 disposition = scsi_decide_disposition(cmd);
1570 if (disposition != SUCCESS &&
1571 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1572 sdev_printk(KERN_ERR, cmd->device,
1573 "timing out command, waited %lus\n",
1574 wait_for/HZ);
1575 disposition = SUCCESS;
1576 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001577
Jens Axboe1aea6432006-01-09 16:03:03 +01001578 scsi_log_completion(cmd, disposition);
1579
1580 switch (disposition) {
1581 case SUCCESS:
1582 scsi_finish_command(cmd);
1583 break;
1584 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001585 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001586 break;
1587 case ADD_TO_MLQUEUE:
1588 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1589 break;
1590 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001591 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001592 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001593 }
1594}
1595
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001596/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001597 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1598 * @cmd: command block we are dispatching.
1599 *
1600 * Return: nonzero return request was rejected and device's queue needs to be
1601 * plugged.
1602 */
1603static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1604{
1605 struct Scsi_Host *host = cmd->device->host;
1606 int rtn = 0;
1607
1608 atomic_inc(&cmd->device->iorequest_cnt);
1609
1610 /* check if the device is still usable */
1611 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1612 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1613 * returns an immediate error upwards, and signals
1614 * that the device is no longer present */
1615 cmd->result = DID_NO_CONNECT << 16;
1616 goto done;
1617 }
1618
1619 /* Check to see if the scsi lld made this device blocked. */
1620 if (unlikely(scsi_device_blocked(cmd->device))) {
1621 /*
1622 * in blocked state, the command is just put back on
1623 * the device queue. The suspend state has already
1624 * blocked the queue so future requests should not
1625 * occur until the device transitions out of the
1626 * suspend state.
1627 */
1628 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1629 "queuecommand : device blocked\n"));
1630 return SCSI_MLQUEUE_DEVICE_BUSY;
1631 }
1632
1633 /* Store the LUN value in cmnd, if needed. */
1634 if (cmd->device->lun_in_cdb)
1635 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1636 (cmd->device->lun << 5 & 0xe0);
1637
1638 scsi_log_send(cmd);
1639
1640 /*
1641 * Before we queue this command, check if the command
1642 * length exceeds what the host adapter can handle.
1643 */
1644 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1645 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1646 "queuecommand : command too long. "
1647 "cdb_size=%d host->max_cmd_len=%d\n",
1648 cmd->cmd_len, cmd->device->host->max_cmd_len));
1649 cmd->result = (DID_ABORT << 16);
1650 goto done;
1651 }
1652
1653 if (unlikely(host->shost_state == SHOST_DEL)) {
1654 cmd->result = (DID_NO_CONNECT << 16);
1655 goto done;
1656
1657 }
1658
1659 trace_scsi_dispatch_cmd_start(cmd);
1660 rtn = host->hostt->queuecommand(host, cmd);
1661 if (rtn) {
1662 trace_scsi_dispatch_cmd_error(cmd, rtn);
1663 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1664 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1665 rtn = SCSI_MLQUEUE_HOST_BUSY;
1666
1667 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1668 "queuecommand : request rejected\n"));
1669 }
1670
1671 return rtn;
1672 done:
1673 cmd->scsi_done(cmd);
1674 return 0;
1675}
1676
1677/**
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001678 * scsi_done - Invoke completion on finished SCSI command.
1679 * @cmd: The SCSI Command for which a low-level device driver (LLDD) gives
1680 * ownership back to SCSI Core -- i.e. the LLDD has finished with it.
1681 *
1682 * Description: This function is the mid-level's (SCSI Core) interrupt routine,
1683 * which regains ownership of the SCSI command (de facto) from a LLDD, and
1684 * calls blk_complete_request() for further processing.
1685 *
1686 * This function is interrupt context safe.
1687 */
1688static void scsi_done(struct scsi_cmnd *cmd)
1689{
1690 trace_scsi_dispatch_cmd_done(cmd);
1691 blk_complete_request(cmd->request);
1692}
1693
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694/*
1695 * Function: scsi_request_fn()
1696 *
1697 * Purpose: Main strategy routine for SCSI.
1698 *
1699 * Arguments: q - Pointer to actual queue.
1700 *
1701 * Returns: Nothing
1702 *
1703 * Lock status: IO request lock assumed to be held when called.
1704 */
1705static void scsi_request_fn(struct request_queue *q)
Bart Van Assche613be1f2014-02-20 14:20:56 -08001706 __releases(q->queue_lock)
1707 __acquires(q->queue_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708{
1709 struct scsi_device *sdev = q->queuedata;
1710 struct Scsi_Host *shost;
1711 struct scsi_cmnd *cmd;
1712 struct request *req;
1713
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 /*
1715 * To start with, we keep looping until the queue is empty, or until
1716 * the host is no longer able to accept any more requests.
1717 */
1718 shost = sdev->host;
Jens Axboea488e742010-04-16 21:13:15 +02001719 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 int rtn;
1721 /*
1722 * get next queueable request. We do this early to make sure
Hannes Reinecke91921e02014-06-25 16:39:59 +02001723 * that the request is fully prepared even if we cannot
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 * accept it.
1725 */
Tejun Heo9934c8c2009-05-08 11:54:16 +09001726 req = blk_peek_request(q);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001727 if (!req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728 break;
1729
1730 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001731 sdev_printk(KERN_ERR, sdev,
1732 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001733 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 continue;
1735 }
1736
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001737 if (!scsi_dev_queue_ready(q, sdev))
1738 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739
1740 /*
1741 * Remove the request from the request list.
1742 */
1743 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
Tejun Heo9934c8c2009-05-08 11:54:16 +09001744 blk_start_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001746 spin_unlock_irq(q->queue_lock);
James Bottomleye91442b2005-09-09 10:44:16 -05001747 cmd = req->special;
1748 if (unlikely(cmd == NULL)) {
1749 printk(KERN_CRIT "impossible request in %s.\n"
1750 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001751 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001752 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001753 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001754 BUG();
1755 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756
Mike Christieecefe8a2008-07-11 19:50:35 -05001757 /*
1758 * We hit this when the driver is using a host wide
1759 * tag map. For device level tag maps the queue_depth check
1760 * in the device ready fn would prevent us from trying
1761 * to allocate a tag. Since the map is a shared host resource
1762 * we add the dev to the starved list so it eventually gets
1763 * a run when a tag is freed.
1764 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001765 if (blk_queue_tagged(q) && !(req->rq_flags & RQF_QUEUED)) {
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001766 spin_lock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001767 if (list_empty(&sdev->starved_entry))
1768 list_add_tail(&sdev->starved_entry,
1769 &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001770 spin_unlock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001771 goto not_ready;
1772 }
1773
Mike Christief0c0a372008-08-17 15:24:38 -05001774 if (!scsi_target_queue_ready(shost, sdev))
1775 goto not_ready;
1776
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 if (!scsi_host_queue_ready(q, shost, sdev))
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001778 goto host_not_ready;
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001779
1780 if (sdev->simple_tags)
1781 cmd->flags |= SCMD_TAGGED;
1782 else
1783 cmd->flags &= ~SCMD_TAGGED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 /*
1786 * Finally, initialize any error handling parameters, and set up
1787 * the timers for timeouts.
1788 */
1789 scsi_init_cmd_errh(cmd);
1790
1791 /*
1792 * Dispatch the command to the low-level driver.
1793 */
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001794 cmd->scsi_done = scsi_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 rtn = scsi_dispatch_cmd(cmd);
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001796 if (rtn) {
1797 scsi_queue_insert(cmd, rtn);
1798 spin_lock_irq(q->queue_lock);
Jens Axboea488e742010-04-16 21:13:15 +02001799 goto out_delay;
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001800 }
1801 spin_lock_irq(q->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 }
1803
Bart Van Assche613be1f2014-02-20 14:20:56 -08001804 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001806 host_not_ready:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001807 if (scsi_target(sdev)->can_queue > 0)
1808 atomic_dec(&scsi_target(sdev)->target_busy);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001809 not_ready:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 /*
1811 * lock q, handle tag, requeue req, and decrement device_busy. We
1812 * must return with queue_lock held.
1813 *
1814 * Decrementing device_busy without checking it is OK, as all such
1815 * cases (host limits or settings) should run the queue at some
1816 * later time.
1817 */
1818 spin_lock_irq(q->queue_lock);
1819 blk_requeue_request(q, req);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001820 atomic_dec(&sdev->device_busy);
Jens Axboea488e742010-04-16 21:13:15 +02001821out_delay:
Guenter Roeck480cadc2014-08-10 05:54:25 -07001822 if (!atomic_read(&sdev->device_busy) && !scsi_device_blocked(sdev))
Jens Axboea488e742010-04-16 21:13:15 +02001823 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824}
1825
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001826static inline blk_status_t prep_to_mq(int ret)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001827{
1828 switch (ret) {
1829 case BLKPREP_OK:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001830 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001831 case BLKPREP_DEFER:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001832 return BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001833 default:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001834 return BLK_STS_IOERR;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001835 }
1836}
1837
1838static int scsi_mq_prep_fn(struct request *req)
1839{
1840 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1841 struct scsi_device *sdev = req->q->queuedata;
1842 struct Scsi_Host *shost = sdev->host;
1843 unsigned char *sense_buf = cmd->sense_buffer;
1844 struct scatterlist *sg;
1845
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001846 /* zero out the cmd, except for the embedded scsi_request */
1847 memset((char *)cmd + sizeof(cmd->req), 0,
Long Li1bad6c42017-05-18 15:40:05 -07001848 sizeof(*cmd) - sizeof(cmd->req) + shost->hostt->cmd_size);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001849
1850 req->special = cmd;
1851
1852 cmd->request = req;
1853 cmd->device = sdev;
1854 cmd->sense_buffer = sense_buf;
1855
1856 cmd->tag = req->tag;
1857
Christoph Hellwigd2852032014-01-17 12:06:53 +01001858 cmd->prot_op = SCSI_PROT_NORMAL;
1859
1860 INIT_LIST_HEAD(&cmd->list);
1861 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1862 cmd->jiffies_at_alloc = jiffies;
1863
Kashyap.Desai@avagotech.com64bdcbc2014-08-20 19:24:33 +05301864 if (shost->use_cmd_list) {
1865 spin_lock_irq(&sdev->list_lock);
1866 list_add_tail(&cmd->list, &sdev->cmd_list);
1867 spin_unlock_irq(&sdev->list_lock);
1868 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001869
1870 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1871 cmd->sdb.table.sgl = sg;
1872
1873 if (scsi_host_get_prot(shost)) {
1874 cmd->prot_sdb = (void *)sg +
Tony Battersby120bb3e2014-12-08 17:20:52 -05001875 min_t(unsigned int,
Ming Lin65e86172016-04-04 14:48:10 -07001876 shost->sg_tablesize, SG_CHUNK_SIZE) *
Tony Battersby120bb3e2014-12-08 17:20:52 -05001877 sizeof(struct scatterlist);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001878 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1879
1880 cmd->prot_sdb->table.sgl =
1881 (struct scatterlist *)(cmd->prot_sdb + 1);
1882 }
1883
1884 if (blk_bidi_rq(req)) {
1885 struct request *next_rq = req->next_rq;
1886 struct scsi_data_buffer *bidi_sdb = blk_mq_rq_to_pdu(next_rq);
1887
1888 memset(bidi_sdb, 0, sizeof(struct scsi_data_buffer));
1889 bidi_sdb->table.sgl =
1890 (struct scatterlist *)(bidi_sdb + 1);
1891
1892 next_rq->special = bidi_sdb;
1893 }
1894
Christoph Hellwigfe052522014-09-22 15:59:31 +02001895 blk_mq_start_request(req);
1896
Christoph Hellwigd2852032014-01-17 12:06:53 +01001897 return scsi_setup_cmnd(sdev, req);
1898}
1899
1900static void scsi_mq_done(struct scsi_cmnd *cmd)
1901{
1902 trace_scsi_dispatch_cmd_done(cmd);
Christoph Hellwig08e00292017-04-20 16:03:09 +02001903 blk_mq_complete_request(cmd->request);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001904}
1905
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001906static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
Jens Axboe74c45052014-10-29 11:14:52 -06001907 const struct blk_mq_queue_data *bd)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001908{
Jens Axboe74c45052014-10-29 11:14:52 -06001909 struct request *req = bd->rq;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001910 struct request_queue *q = req->q;
1911 struct scsi_device *sdev = q->queuedata;
1912 struct Scsi_Host *shost = sdev->host;
1913 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001914 blk_status_t ret;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001915 int reason;
1916
1917 ret = prep_to_mq(scsi_prep_state_check(sdev, req));
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001918 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001919 goto out;
1920
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001921 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001922 if (!get_device(&sdev->sdev_gendev))
1923 goto out;
1924
1925 if (!scsi_dev_queue_ready(q, sdev))
1926 goto out_put_device;
1927 if (!scsi_target_queue_ready(shost, sdev))
1928 goto out_dec_device_busy;
1929 if (!scsi_host_queue_ready(q, shost, sdev))
1930 goto out_dec_target_busy;
1931
Christoph Hellwige8064022016-10-20 15:12:13 +02001932 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001933 ret = prep_to_mq(scsi_mq_prep_fn(req));
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001934 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001935 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001936 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001937 } else {
1938 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001939 }
1940
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001941 if (sdev->simple_tags)
1942 cmd->flags |= SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001943 else
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001944 cmd->flags &= ~SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001945
Christoph Hellwigd2852032014-01-17 12:06:53 +01001946 scsi_init_cmd_errh(cmd);
1947 cmd->scsi_done = scsi_mq_done;
1948
1949 reason = scsi_dispatch_cmd(cmd);
1950 if (reason) {
1951 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001952 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001953 goto out_dec_host_busy;
1954 }
1955
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001956 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001957
1958out_dec_host_busy:
1959 atomic_dec(&shost->host_busy);
1960out_dec_target_busy:
1961 if (scsi_target(sdev)->can_queue > 0)
1962 atomic_dec(&scsi_target(sdev)->target_busy);
1963out_dec_device_busy:
1964 atomic_dec(&sdev->device_busy);
1965out_put_device:
1966 put_device(&sdev->sdev_gendev);
1967out:
1968 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001969 case BLK_STS_OK:
1970 break;
1971 case BLK_STS_RESOURCE:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001972 if (atomic_read(&sdev->device_busy) == 0 &&
1973 !scsi_device_blocked(sdev))
Bart Van Assche36e3cf22017-04-07 11:16:53 -07001974 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001975 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001976 default:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001977 /*
1978 * Make sure to release all allocated ressources when
1979 * we hit an error, as we will never see this command
1980 * again.
1981 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001982 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001983 scsi_mq_uninit_cmd(cmd);
1984 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001985 }
1986 return ret;
1987}
1988
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001989static enum blk_eh_timer_return scsi_timeout(struct request *req,
1990 bool reserved)
1991{
1992 if (reserved)
1993 return BLK_EH_RESET_TIMER;
1994 return scsi_times_out(req);
1995}
1996
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001997static int scsi_init_request(struct blk_mq_tag_set *set, struct request *rq,
1998 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001999{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002000 struct Scsi_Host *shost = set->driver_data;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002001 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2002
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002003 cmd->sense_buffer =
2004 scsi_alloc_sense_buffer(shost, GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002005 if (!cmd->sense_buffer)
2006 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002007 cmd->req.sense = cmd->sense_buffer;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002008 return 0;
2009}
2010
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002011static void scsi_exit_request(struct blk_mq_tag_set *set, struct request *rq,
2012 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002013{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002014 struct Scsi_Host *shost = set->driver_data;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002015 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2016
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002017 scsi_free_sense_buffer(shost, cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002018}
2019
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002020static int scsi_map_queues(struct blk_mq_tag_set *set)
2021{
2022 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
2023
2024 if (shost->hostt->map_queues)
2025 return shost->hostt->map_queues(shost);
2026 return blk_mq_map_queues(set);
2027}
2028
Christoph Hellwigf1bea552014-04-15 12:26:54 +02002029static u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030{
2031 struct device *host_dev;
2032 u64 bounce_limit = 0xffffffff;
2033
2034 if (shost->unchecked_isa_dma)
2035 return BLK_BOUNCE_ISA;
2036 /*
2037 * Platforms with virtual-DMA translation
2038 * hardware have no practical limit.
2039 */
2040 if (!PCI_DMA_BUS_IS_PHYS)
2041 return BLK_BOUNCE_ANY;
2042
2043 host_dev = scsi_get_device(shost);
2044 if (host_dev && host_dev->dma_mask)
Russell Kinge83b3662014-02-11 17:11:04 +00002045 bounce_limit = (u64)dma_max_pfn(host_dev) << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046
2047 return bounce_limit;
2048}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002050void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051{
Lin Ming6f381fa2012-04-12 13:50:38 +08002052 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053
Bart Van Assche9efc1602017-05-31 14:43:46 -07002054 queue_flag_set_unlocked(QUEUE_FLAG_SCSI_PASSTHROUGH, q);
2055
Jens Axboea8474ce2007-08-07 09:02:51 +02002056 /*
2057 * this limit is imposed by hardware restrictions
2058 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05002059 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07002060 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02002061
Martin K. Petersen13f05c82010-09-10 20:50:10 +02002062 if (scsi_host_prot_dma(shost)) {
2063 shost->sg_prot_tablesize =
2064 min_not_zero(shost->sg_prot_tablesize,
2065 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
2066 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
2067 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
2068 }
2069
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05002070 blk_queue_max_hw_sectors(q, shost->max_sectors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
2072 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08002073 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074
FUJITA Tomonori860ac562008-02-04 22:28:05 -08002075 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
2076
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01002078 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06002079
2080 /*
2081 * set a reasonable default alignment on word boundaries: the
2082 * host and device may alter it using
2083 * blk_queue_update_dma_alignment() later.
2084 */
2085 blk_queue_dma_alignment(q, 0x03);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002086}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002087EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06002088
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002089static int scsi_init_rq(struct request_queue *q, struct request *rq, gfp_t gfp)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002090{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002091 struct Scsi_Host *shost = q->rq_alloc_data;
2092 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002093
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002094 memset(cmd, 0, sizeof(*cmd));
2095
2096 cmd->sense_buffer = scsi_alloc_sense_buffer(shost, gfp, NUMA_NO_NODE);
2097 if (!cmd->sense_buffer)
2098 goto fail;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002099 cmd->req.sense = cmd->sense_buffer;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002100
2101 if (scsi_host_get_prot(shost) >= SHOST_DIX_TYPE0_PROTECTION) {
2102 cmd->prot_sdb = kmem_cache_zalloc(scsi_sdb_cache, gfp);
2103 if (!cmd->prot_sdb)
2104 goto fail_free_sense;
2105 }
2106
2107 return 0;
2108
2109fail_free_sense:
2110 scsi_free_sense_buffer(shost, cmd->sense_buffer);
2111fail:
2112 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113}
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002114
2115static void scsi_exit_rq(struct request_queue *q, struct request *rq)
2116{
2117 struct Scsi_Host *shost = q->rq_alloc_data;
2118 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2119
2120 if (cmd->prot_sdb)
2121 kmem_cache_free(scsi_sdb_cache, cmd->prot_sdb);
2122 scsi_free_sense_buffer(shost, cmd->sense_buffer);
2123}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002124
2125struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
2126{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002127 struct Scsi_Host *shost = sdev->host;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002128 struct request_queue *q;
2129
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002130 q = blk_alloc_queue_node(GFP_KERNEL, NUMA_NO_NODE);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002131 if (!q)
2132 return NULL;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002133 q->cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
2134 q->rq_alloc_data = shost;
2135 q->request_fn = scsi_request_fn;
2136 q->init_rq_fn = scsi_init_rq;
2137 q->exit_rq_fn = scsi_exit_rq;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07002138 q->initialize_rq_fn = scsi_initialize_rq;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002139
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002140 if (blk_init_allocated_queue(q) < 0) {
2141 blk_cleanup_queue(q);
2142 return NULL;
2143 }
2144
2145 __scsi_init_queue(shost, q);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002146 blk_queue_prep_rq(q, scsi_prep_fn);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02002147 blk_queue_unprep_rq(q, scsi_unprep_fn);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002148 blk_queue_softirq_done(q, scsi_softirq_done);
Jens Axboe242f9dc2008-09-14 05:55:09 -07002149 blk_queue_rq_timed_out(q, scsi_times_out);
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04002150 blk_queue_lld_busy(q, scsi_lld_busy);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002151 return q;
2152}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153
Eric Biggersf363b082017-03-30 13:39:16 -07002154static const struct blk_mq_ops scsi_mq_ops = {
Christoph Hellwigd2852032014-01-17 12:06:53 +01002155 .queue_rq = scsi_queue_rq,
2156 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07002157 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07002158#ifdef CONFIG_BLK_DEBUG_FS
2159 .show_rq = scsi_show_rq,
2160#endif
Christoph Hellwigd2852032014-01-17 12:06:53 +01002161 .init_request = scsi_init_request,
2162 .exit_request = scsi_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07002163 .initialize_rq_fn = scsi_initialize_rq,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002164 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01002165};
2166
2167struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
2168{
2169 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
2170 if (IS_ERR(sdev->request_queue))
2171 return NULL;
2172
2173 sdev->request_queue->queuedata = sdev;
2174 __scsi_init_queue(sdev->host, sdev->request_queue);
2175 return sdev->request_queue;
2176}
2177
2178int scsi_mq_setup_tags(struct Scsi_Host *shost)
2179{
2180 unsigned int cmd_size, sgl_size, tbl_size;
2181
2182 tbl_size = shost->sg_tablesize;
Ming Lin65e86172016-04-04 14:48:10 -07002183 if (tbl_size > SG_CHUNK_SIZE)
2184 tbl_size = SG_CHUNK_SIZE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002185 sgl_size = tbl_size * sizeof(struct scatterlist);
2186 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
2187 if (scsi_host_get_prot(shost))
2188 cmd_size += sizeof(struct scsi_data_buffer) + sgl_size;
2189
2190 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
2191 shost->tag_set.ops = &scsi_mq_ops;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01002192 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002193 shost->tag_set.queue_depth = shost->can_queue;
2194 shost->tag_set.cmd_size = cmd_size;
2195 shost->tag_set.numa_node = NUMA_NO_NODE;
2196 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07002197 shost->tag_set.flags |=
2198 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002199 shost->tag_set.driver_data = shost;
2200
2201 return blk_mq_alloc_tag_set(&shost->tag_set);
2202}
2203
2204void scsi_mq_destroy_tags(struct Scsi_Host *shost)
2205{
2206 blk_mq_free_tag_set(&shost->tag_set);
2207}
2208
Hannes Reinecke857de6e2017-02-17 09:02:45 +01002209/**
2210 * scsi_device_from_queue - return sdev associated with a request_queue
2211 * @q: The request queue to return the sdev from
2212 *
2213 * Return the sdev associated with a request queue or NULL if the
2214 * request_queue does not reference a SCSI device.
2215 */
2216struct scsi_device *scsi_device_from_queue(struct request_queue *q)
2217{
2218 struct scsi_device *sdev = NULL;
2219
2220 if (q->mq_ops) {
2221 if (q->mq_ops == &scsi_mq_ops)
2222 sdev = q->queuedata;
2223 } else if (q->request_fn == scsi_request_fn)
2224 sdev = q->queuedata;
2225 if (!sdev || !get_device(&sdev->sdev_gendev))
2226 sdev = NULL;
2227
2228 return sdev;
2229}
2230EXPORT_SYMBOL_GPL(scsi_device_from_queue);
2231
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232/*
2233 * Function: scsi_block_requests()
2234 *
2235 * Purpose: Utility function used by low-level drivers to prevent further
2236 * commands from being queued to the device.
2237 *
2238 * Arguments: shost - Host in question
2239 *
2240 * Returns: Nothing
2241 *
2242 * Lock status: No locks are assumed held.
2243 *
2244 * Notes: There is no timer nor any other means by which the requests
2245 * get unblocked other than the low-level driver calling
2246 * scsi_unblock_requests().
2247 */
2248void scsi_block_requests(struct Scsi_Host *shost)
2249{
2250 shost->host_self_blocked = 1;
2251}
2252EXPORT_SYMBOL(scsi_block_requests);
2253
2254/*
2255 * Function: scsi_unblock_requests()
2256 *
2257 * Purpose: Utility function used by low-level drivers to allow further
2258 * commands from being queued to the device.
2259 *
2260 * Arguments: shost - Host in question
2261 *
2262 * Returns: Nothing
2263 *
2264 * Lock status: No locks are assumed held.
2265 *
2266 * Notes: There is no timer nor any other means by which the requests
2267 * get unblocked other than the low-level driver calling
2268 * scsi_unblock_requests().
2269 *
2270 * This is done as an API function so that changes to the
2271 * internals of the scsi mid-layer won't require wholesale
2272 * changes to drivers that use this feature.
2273 */
2274void scsi_unblock_requests(struct Scsi_Host *shost)
2275{
2276 shost->host_self_blocked = 0;
2277 scsi_run_host_queues(shost);
2278}
2279EXPORT_SYMBOL(scsi_unblock_requests);
2280
2281int __init scsi_init_queue(void)
2282{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002283 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
2284 sizeof(struct scsi_data_buffer),
2285 0, 0, NULL);
2286 if (!scsi_sdb_cache) {
2287 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09002288 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02002289 }
2290
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 return 0;
2292}
2293
2294void scsi_exit_queue(void)
2295{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002296 kmem_cache_destroy(scsi_sense_cache);
2297 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002298 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299}
James Bottomley5baba832006-03-18 14:10:35 -06002300
2301/**
2302 * scsi_mode_select - issue a mode select
2303 * @sdev: SCSI device to be queried
2304 * @pf: Page format bit (1 == standard, 0 == vendor specific)
2305 * @sp: Save page bit (0 == don't save, 1 == save)
2306 * @modepage: mode page being requested
2307 * @buffer: request buffer (may not be smaller than eight bytes)
2308 * @len: length of request buffer.
2309 * @timeout: command timeout
2310 * @retries: number of retries before failing
2311 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002312 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06002313 * must be SCSI_SENSE_BUFFERSIZE big.
2314 *
2315 * Returns zero if successful; negative error number or scsi
2316 * status on error
2317 *
2318 */
2319int
2320scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2321 unsigned char *buffer, int len, int timeout, int retries,
2322 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2323{
2324 unsigned char cmd[10];
2325 unsigned char *real_buffer;
2326 int ret;
2327
2328 memset(cmd, 0, sizeof(cmd));
2329 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2330
2331 if (sdev->use_10_for_ms) {
2332 if (len > 65535)
2333 return -EINVAL;
2334 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2335 if (!real_buffer)
2336 return -ENOMEM;
2337 memcpy(real_buffer + 8, buffer, len);
2338 len += 8;
2339 real_buffer[0] = 0;
2340 real_buffer[1] = 0;
2341 real_buffer[2] = data->medium_type;
2342 real_buffer[3] = data->device_specific;
2343 real_buffer[4] = data->longlba ? 0x01 : 0;
2344 real_buffer[5] = 0;
2345 real_buffer[6] = data->block_descriptor_length >> 8;
2346 real_buffer[7] = data->block_descriptor_length;
2347
2348 cmd[0] = MODE_SELECT_10;
2349 cmd[7] = len >> 8;
2350 cmd[8] = len;
2351 } else {
2352 if (len > 255 || data->block_descriptor_length > 255 ||
2353 data->longlba)
2354 return -EINVAL;
2355
2356 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2357 if (!real_buffer)
2358 return -ENOMEM;
2359 memcpy(real_buffer + 4, buffer, len);
2360 len += 4;
2361 real_buffer[0] = 0;
2362 real_buffer[1] = data->medium_type;
2363 real_buffer[2] = data->device_specific;
2364 real_buffer[3] = data->block_descriptor_length;
2365
2366
2367 cmd[0] = MODE_SELECT;
2368 cmd[4] = len;
2369 }
2370
2371 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002372 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002373 kfree(real_buffer);
2374 return ret;
2375}
2376EXPORT_SYMBOL_GPL(scsi_mode_select);
2377
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378/**
Rob Landleyeb448202007-11-03 13:30:39 -05002379 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002380 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 * @dbd: set if mode sense will allow block descriptors to be returned
2382 * @modepage: mode page being requested
2383 * @buffer: request buffer (may not be smaller than eight bytes)
2384 * @len: length of request buffer.
2385 * @timeout: command timeout
2386 * @retries: number of retries before failing
2387 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002388 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002389 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 *
2391 * Returns zero if unsuccessful, or the header offset (either 4
2392 * or 8 depending on whether a six or ten byte command was
2393 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002394 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395int
James Bottomley1cf72692005-08-28 11:27:01 -05002396scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002398 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2399{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 unsigned char cmd[12];
2401 int use_10_for_ms;
2402 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002403 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002404 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405
2406 memset(data, 0, sizeof(*data));
2407 memset(&cmd[0], 0, 12);
2408 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2409 cmd[2] = modepage;
2410
James Bottomleyea73a9f2005-08-28 11:33:52 -05002411 /* caller might not be interested in sense, but we need it */
2412 if (!sshdr)
2413 sshdr = &my_sshdr;
2414
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002416 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417
2418 if (use_10_for_ms) {
2419 if (len < 8)
2420 len = 8;
2421
2422 cmd[0] = MODE_SENSE_10;
2423 cmd[8] = len;
2424 header_length = 8;
2425 } else {
2426 if (len < 4)
2427 len = 4;
2428
2429 cmd[0] = MODE_SENSE;
2430 cmd[4] = len;
2431 header_length = 4;
2432 }
2433
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 memset(buffer, 0, len);
2435
James Bottomley1cf72692005-08-28 11:27:01 -05002436 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002437 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438
2439 /* This code looks awful: what it's doing is making sure an
2440 * ILLEGAL REQUEST sense return identifies the actual command
2441 * byte as the problem. MODE_SENSE commands can return
2442 * ILLEGAL REQUEST if the code page isn't supported */
2443
James Bottomley1cf72692005-08-28 11:27:01 -05002444 if (use_10_for_ms && !scsi_status_is_good(result) &&
2445 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002446 if (scsi_sense_valid(sshdr)) {
2447 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2448 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 /*
2450 * Invalid command operation code
2451 */
James Bottomley1cf72692005-08-28 11:27:01 -05002452 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453 goto retry;
2454 }
2455 }
2456 }
2457
James Bottomley1cf72692005-08-28 11:27:01 -05002458 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002459 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2460 (modepage == 6 || modepage == 8))) {
2461 /* Initio breakage? */
2462 header_length = 0;
2463 data->length = 13;
2464 data->medium_type = 0;
2465 data->device_specific = 0;
2466 data->longlba = 0;
2467 data->block_descriptor_length = 0;
2468 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 data->length = buffer[0]*256 + buffer[1] + 2;
2470 data->medium_type = buffer[2];
2471 data->device_specific = buffer[3];
2472 data->longlba = buffer[4] & 0x01;
2473 data->block_descriptor_length = buffer[6]*256
2474 + buffer[7];
2475 } else {
2476 data->length = buffer[0] + 1;
2477 data->medium_type = buffer[1];
2478 data->device_specific = buffer[2];
2479 data->block_descriptor_length = buffer[3];
2480 }
Al Viro6d73c852006-02-23 02:03:16 +01002481 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002482 } else if ((status_byte(result) == CHECK_CONDITION) &&
2483 scsi_sense_valid(sshdr) &&
2484 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2485 retry_count--;
2486 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487 }
2488
James Bottomley1cf72692005-08-28 11:27:01 -05002489 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490}
2491EXPORT_SYMBOL(scsi_mode_sense);
2492
James Bottomley001aac22007-12-02 19:10:40 +02002493/**
2494 * scsi_test_unit_ready - test if unit is ready
2495 * @sdev: scsi device to change the state of.
2496 * @timeout: command timeout
2497 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002498 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002499 *
2500 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002501 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002502 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503int
James Bottomley001aac22007-12-02 19:10:40 +02002504scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002505 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507 char cmd[] = {
2508 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2509 };
2510 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002511
James Bottomley001aac22007-12-02 19:10:40 +02002512 /* try to eat the UNIT_ATTENTION if there are enough retries */
2513 do {
2514 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002515 timeout, retries, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002516 if (sdev->removable && scsi_sense_valid(sshdr) &&
2517 sshdr->sense_key == UNIT_ATTENTION)
2518 sdev->changed = 1;
2519 } while (scsi_sense_valid(sshdr) &&
2520 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002521
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 return result;
2523}
2524EXPORT_SYMBOL(scsi_test_unit_ready);
2525
2526/**
Rob Landleyeb448202007-11-03 13:30:39 -05002527 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528 * @sdev: scsi device to change the state of.
2529 * @state: state to change to.
2530 *
2531 * Returns zero if unsuccessful or an error if the requested
2532 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002533 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534int
2535scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2536{
2537 enum scsi_device_state oldstate = sdev->sdev_state;
2538
2539 if (state == oldstate)
2540 return 0;
2541
2542 switch (state) {
2543 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002544 switch (oldstate) {
2545 case SDEV_CREATED_BLOCK:
2546 break;
2547 default:
2548 goto illegal;
2549 }
2550 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551
2552 case SDEV_RUNNING:
2553 switch (oldstate) {
2554 case SDEV_CREATED:
2555 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002556 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557 case SDEV_QUIESCE:
2558 case SDEV_BLOCK:
2559 break;
2560 default:
2561 goto illegal;
2562 }
2563 break;
2564
2565 case SDEV_QUIESCE:
2566 switch (oldstate) {
2567 case SDEV_RUNNING:
2568 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002569 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570 break;
2571 default:
2572 goto illegal;
2573 }
2574 break;
2575
2576 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002577 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578 switch (oldstate) {
2579 case SDEV_CREATED:
2580 case SDEV_RUNNING:
2581 case SDEV_QUIESCE:
2582 case SDEV_BLOCK:
2583 break;
2584 default:
2585 goto illegal;
2586 }
2587 break;
2588
2589 case SDEV_BLOCK:
2590 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002592 case SDEV_CREATED_BLOCK:
2593 break;
2594 default:
2595 goto illegal;
2596 }
2597 break;
2598
2599 case SDEV_CREATED_BLOCK:
2600 switch (oldstate) {
2601 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602 break;
2603 default:
2604 goto illegal;
2605 }
2606 break;
2607
2608 case SDEV_CANCEL:
2609 switch (oldstate) {
2610 case SDEV_CREATED:
2611 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002612 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002614 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002615 case SDEV_BLOCK:
2616 break;
2617 default:
2618 goto illegal;
2619 }
2620 break;
2621
2622 case SDEV_DEL:
2623 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002624 case SDEV_CREATED:
2625 case SDEV_RUNNING:
2626 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002627 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002628 case SDEV_CANCEL:
Bart Van Assche0516c082013-07-02 15:06:33 +02002629 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002630 break;
2631 default:
2632 goto illegal;
2633 }
2634 break;
2635
2636 }
2637 sdev->sdev_state = state;
2638 return 0;
2639
2640 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002641 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002642 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002643 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002644 scsi_device_state_name(oldstate),
2645 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646 );
2647 return -EINVAL;
2648}
2649EXPORT_SYMBOL(scsi_device_set_state);
2650
2651/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002652 * sdev_evt_emit - emit a single SCSI device uevent
2653 * @sdev: associated SCSI device
2654 * @evt: event to emit
2655 *
2656 * Send a single uevent (scsi_event) to the associated scsi_device.
2657 */
2658static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2659{
2660 int idx = 0;
2661 char *envp[3];
2662
2663 switch (evt->evt_type) {
2664 case SDEV_EVT_MEDIA_CHANGE:
2665 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2666 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002667 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002668 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002669 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2670 break;
2671 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2672 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2673 break;
2674 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2675 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2676 break;
2677 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2678 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2679 break;
2680 case SDEV_EVT_LUN_CHANGE_REPORTED:
2681 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2682 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002683 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2684 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2685 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002686 default:
2687 /* do nothing */
2688 break;
2689 }
2690
2691 envp[idx++] = NULL;
2692
2693 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2694}
2695
2696/**
2697 * sdev_evt_thread - send a uevent for each scsi event
2698 * @work: work struct for scsi_device
2699 *
2700 * Dispatch queued events to their associated scsi_device kobjects
2701 * as uevents.
2702 */
2703void scsi_evt_thread(struct work_struct *work)
2704{
2705 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002706 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002707 LIST_HEAD(event_list);
2708
2709 sdev = container_of(work, struct scsi_device, event_work);
2710
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002711 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2712 if (test_and_clear_bit(evt_type, sdev->pending_events))
2713 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2714
Jeff Garzika341cd02007-10-29 17:15:22 -04002715 while (1) {
2716 struct scsi_event *evt;
2717 struct list_head *this, *tmp;
2718 unsigned long flags;
2719
2720 spin_lock_irqsave(&sdev->list_lock, flags);
2721 list_splice_init(&sdev->event_list, &event_list);
2722 spin_unlock_irqrestore(&sdev->list_lock, flags);
2723
2724 if (list_empty(&event_list))
2725 break;
2726
2727 list_for_each_safe(this, tmp, &event_list) {
2728 evt = list_entry(this, struct scsi_event, node);
2729 list_del(&evt->node);
2730 scsi_evt_emit(sdev, evt);
2731 kfree(evt);
2732 }
2733 }
2734}
2735
2736/**
2737 * sdev_evt_send - send asserted event to uevent thread
2738 * @sdev: scsi_device event occurred on
2739 * @evt: event to send
2740 *
2741 * Assert scsi device event asynchronously.
2742 */
2743void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2744{
2745 unsigned long flags;
2746
Kay Sievers4d1566e2008-03-19 13:04:47 +01002747#if 0
2748 /* FIXME: currently this check eliminates all media change events
2749 * for polled devices. Need to update to discriminate between AN
2750 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002751 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2752 kfree(evt);
2753 return;
2754 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002755#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002756
2757 spin_lock_irqsave(&sdev->list_lock, flags);
2758 list_add_tail(&evt->node, &sdev->event_list);
2759 schedule_work(&sdev->event_work);
2760 spin_unlock_irqrestore(&sdev->list_lock, flags);
2761}
2762EXPORT_SYMBOL_GPL(sdev_evt_send);
2763
2764/**
2765 * sdev_evt_alloc - allocate a new scsi event
2766 * @evt_type: type of event to allocate
2767 * @gfpflags: GFP flags for allocation
2768 *
2769 * Allocates and returns a new scsi_event.
2770 */
2771struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2772 gfp_t gfpflags)
2773{
2774 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2775 if (!evt)
2776 return NULL;
2777
2778 evt->evt_type = evt_type;
2779 INIT_LIST_HEAD(&evt->node);
2780
2781 /* evt_type-specific initialization, if any */
2782 switch (evt_type) {
2783 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002784 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2785 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2786 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2787 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2788 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002789 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002790 default:
2791 /* do nothing */
2792 break;
2793 }
2794
2795 return evt;
2796}
2797EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2798
2799/**
2800 * sdev_evt_send_simple - send asserted event to uevent thread
2801 * @sdev: scsi_device event occurred on
2802 * @evt_type: type of event to send
2803 * @gfpflags: GFP flags for allocation
2804 *
2805 * Assert scsi device event asynchronously, given an event type.
2806 */
2807void sdev_evt_send_simple(struct scsi_device *sdev,
2808 enum scsi_device_event evt_type, gfp_t gfpflags)
2809{
2810 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2811 if (!evt) {
2812 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2813 evt_type);
2814 return;
2815 }
2816
2817 sdev_evt_send(sdev, evt);
2818}
2819EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2820
2821/**
Bart Van Assche669f0442016-11-22 16:17:13 -08002822 * scsi_request_fn_active() - number of kernel threads inside scsi_request_fn()
2823 * @sdev: SCSI device to count the number of scsi_request_fn() callers for.
2824 */
2825static int scsi_request_fn_active(struct scsi_device *sdev)
2826{
2827 struct request_queue *q = sdev->request_queue;
2828 int request_fn_active;
2829
2830 WARN_ON_ONCE(sdev->host->use_blk_mq);
2831
2832 spin_lock_irq(q->queue_lock);
2833 request_fn_active = q->request_fn_active;
2834 spin_unlock_irq(q->queue_lock);
2835
2836 return request_fn_active;
2837}
2838
2839/**
2840 * scsi_wait_for_queuecommand() - wait for ongoing queuecommand() calls
2841 * @sdev: SCSI device pointer.
2842 *
2843 * Wait until the ongoing shost->hostt->queuecommand() calls that are
2844 * invoked from scsi_request_fn() have finished.
2845 */
2846static void scsi_wait_for_queuecommand(struct scsi_device *sdev)
2847{
2848 WARN_ON_ONCE(sdev->host->use_blk_mq);
2849
2850 while (scsi_request_fn_active(sdev))
2851 msleep(20);
2852}
2853
2854/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002855 * scsi_device_quiesce - Block user issued commands.
2856 * @sdev: scsi device to quiesce.
2857 *
2858 * This works by trying to transition to the SDEV_QUIESCE state
2859 * (which must be a legal transition). When the device is in this
2860 * state, only special requests will be accepted, all others will
2861 * be deferred. Since special requests may also be requeued requests,
2862 * a successful return doesn't guarantee the device will be
2863 * totally quiescent.
2864 *
2865 * Must be called with user context, may sleep.
2866 *
2867 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002868 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002869int
2870scsi_device_quiesce(struct scsi_device *sdev)
2871{
2872 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2873 if (err)
2874 return err;
2875
2876 scsi_run_queue(sdev->request_queue);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02002877 while (atomic_read(&sdev->device_busy)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002878 msleep_interruptible(200);
2879 scsi_run_queue(sdev->request_queue);
2880 }
2881 return 0;
2882}
2883EXPORT_SYMBOL(scsi_device_quiesce);
2884
2885/**
2886 * scsi_device_resume - Restart user issued commands to a quiesced device.
2887 * @sdev: scsi device to resume.
2888 *
2889 * Moves the device from quiesced back to running and restarts the
2890 * queues.
2891 *
2892 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002893 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002894void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002896 /* check if the device state was mutated prior to resume, and if
2897 * so assume the state is being managed elsewhere (for example
2898 * device deleted during suspend)
2899 */
2900 if (sdev->sdev_state != SDEV_QUIESCE ||
2901 scsi_device_set_state(sdev, SDEV_RUNNING))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902 return;
2903 scsi_run_queue(sdev->request_queue);
2904}
2905EXPORT_SYMBOL(scsi_device_resume);
2906
2907static void
2908device_quiesce_fn(struct scsi_device *sdev, void *data)
2909{
2910 scsi_device_quiesce(sdev);
2911}
2912
2913void
2914scsi_target_quiesce(struct scsi_target *starget)
2915{
2916 starget_for_each_device(starget, NULL, device_quiesce_fn);
2917}
2918EXPORT_SYMBOL(scsi_target_quiesce);
2919
2920static void
2921device_resume_fn(struct scsi_device *sdev, void *data)
2922{
2923 scsi_device_resume(sdev);
2924}
2925
2926void
2927scsi_target_resume(struct scsi_target *starget)
2928{
2929 starget_for_each_device(starget, NULL, device_resume_fn);
2930}
2931EXPORT_SYMBOL(scsi_target_resume);
2932
2933/**
Rob Landleyeb448202007-11-03 13:30:39 -05002934 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
Linus Torvalds1da177e2005-04-16 15:20:36 -07002935 * @sdev: device to block
Bart Van Assche8893cf62017-03-01 09:00:36 -08002936 * @wait: Whether or not to wait until ongoing .queuecommand() /
2937 * .queue_rq() calls have finished.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002938 *
2939 * Block request made by scsi lld's to temporarily stop all
Bart Van Assche669f0442016-11-22 16:17:13 -08002940 * scsi commands on the specified device. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002941 *
2942 * Returns zero if successful or error if not
2943 *
2944 * Notes:
2945 * This routine transitions the device to the SDEV_BLOCK state
2946 * (which must be a legal transition). When the device is in this
2947 * state, all commands are deferred until the scsi lld reenables
2948 * the device with scsi_device_unblock or device_block_tmo fires.
Bart Van Assche669f0442016-11-22 16:17:13 -08002949 *
2950 * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
2951 * scsi_internal_device_block() has blocked a SCSI device and also
2952 * remove the rport mutex lock and unlock calls from srp_queuecommand().
Rob Landleyeb448202007-11-03 13:30:39 -05002953 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002954int
Bart Van Assche8893cf62017-03-01 09:00:36 -08002955scsi_internal_device_block(struct scsi_device *sdev, bool wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002956{
Jens Axboe165125e2007-07-24 09:28:11 +02002957 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002958 unsigned long flags;
2959 int err = 0;
2960
2961 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002962 if (err) {
2963 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2964
2965 if (err)
2966 return err;
2967 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002968
2969 /*
2970 * The device has transitioned to SDEV_BLOCK. Stop the
2971 * block layer from calling the midlayer with this device's
2972 * request queue.
2973 */
Christoph Hellwigd2852032014-01-17 12:06:53 +01002974 if (q->mq_ops) {
Bart Van Assche8893cf62017-03-01 09:00:36 -08002975 if (wait)
2976 blk_mq_quiesce_queue(q);
2977 else
Ming Leif6601742017-06-06 23:22:04 +08002978 blk_mq_quiesce_queue_nowait(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002979 } else {
2980 spin_lock_irqsave(q->queue_lock, flags);
2981 blk_stop_queue(q);
2982 spin_unlock_irqrestore(q->queue_lock, flags);
Bart Van Assche8893cf62017-03-01 09:00:36 -08002983 if (wait)
2984 scsi_wait_for_queuecommand(sdev);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002985 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002986
2987 return 0;
2988}
2989EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2990
2991/**
2992 * scsi_internal_device_unblock - resume a device after a block request
2993 * @sdev: device to resume
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002994 * @new_state: state to set devices to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995 *
2996 * Called by scsi lld's or the midlayer to restart the device queue
2997 * for the previously suspended scsi device. Called from interrupt or
2998 * normal process context.
2999 *
3000 * Returns zero if successful or error if not.
3001 *
3002 * Notes:
3003 * This routine transitions the device to the SDEV_RUNNING state
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003004 * or to one of the offline states (which must be a legal transition)
Mike Christied0754982012-05-17 23:56:58 -05003005 * allowing the midlayer to goose the queue for this device.
Rob Landleyeb448202007-11-03 13:30:39 -05003006 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003007int
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003008scsi_internal_device_unblock(struct scsi_device *sdev,
3009 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010{
Jens Axboe165125e2007-07-24 09:28:11 +02003011 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003012 unsigned long flags;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003013
3014 /*
3015 * Try to transition the scsi device to SDEV_RUNNING or one of the
3016 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003017 */
Vikas Chaudhary0e580762012-08-09 04:51:30 -04003018 if ((sdev->sdev_state == SDEV_BLOCK) ||
3019 (sdev->sdev_state == SDEV_TRANSPORT_OFFLINE))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003020 sdev->sdev_state = new_state;
3021 else if (sdev->sdev_state == SDEV_CREATED_BLOCK) {
3022 if (new_state == SDEV_TRANSPORT_OFFLINE ||
3023 new_state == SDEV_OFFLINE)
3024 sdev->sdev_state = new_state;
3025 else
3026 sdev->sdev_state = SDEV_CREATED;
3027 } else if (sdev->sdev_state != SDEV_CANCEL &&
Mike Christie986fe6c2010-10-06 03:10:59 -05003028 sdev->sdev_state != SDEV_OFFLINE)
Takahiro Yasui5c10e632009-04-29 12:13:02 -04003029 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030
Christoph Hellwigd2852032014-01-17 12:06:53 +01003031 if (q->mq_ops) {
Ming Leif6601742017-06-06 23:22:04 +08003032 blk_mq_unquiesce_queue(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +01003033 } else {
3034 spin_lock_irqsave(q->queue_lock, flags);
3035 blk_start_queue(q);
3036 spin_unlock_irqrestore(q->queue_lock, flags);
3037 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003038
3039 return 0;
3040}
3041EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
3042
3043static void
3044device_block(struct scsi_device *sdev, void *data)
3045{
Bart Van Assche8893cf62017-03-01 09:00:36 -08003046 scsi_internal_device_block(sdev, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003047}
3048
3049static int
3050target_block(struct device *dev, void *data)
3051{
3052 if (scsi_is_target_device(dev))
3053 starget_for_each_device(to_scsi_target(dev), NULL,
3054 device_block);
3055 return 0;
3056}
3057
3058void
3059scsi_target_block(struct device *dev)
3060{
3061 if (scsi_is_target_device(dev))
3062 starget_for_each_device(to_scsi_target(dev), NULL,
3063 device_block);
3064 else
3065 device_for_each_child(dev, NULL, target_block);
3066}
3067EXPORT_SYMBOL_GPL(scsi_target_block);
3068
3069static void
3070device_unblock(struct scsi_device *sdev, void *data)
3071{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003072 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003073}
3074
3075static int
3076target_unblock(struct device *dev, void *data)
3077{
3078 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003079 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003080 device_unblock);
3081 return 0;
3082}
3083
3084void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003085scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003086{
3087 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003088 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003089 device_unblock);
3090 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003091 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003092}
3093EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003094
3095/**
3096 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05003097 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003098 * @sg_count: number of segments in sg
3099 * @offset: offset in bytes into sg, on return offset into the mapped area
3100 * @len: bytes to map, on return number of bytes mapped
3101 *
3102 * Returns virtual address of the start of the mapped page
3103 */
Jens Axboec6132da2007-10-16 11:08:49 +02003104void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003105 size_t *offset, size_t *len)
3106{
3107 int i;
3108 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02003109 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003110 struct page *page;
3111
Andrew Morton22cfefb2007-02-05 16:39:03 -08003112 WARN_ON(!irqs_disabled());
3113
Jens Axboec6132da2007-10-16 11:08:49 +02003114 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003115 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02003116 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003117 if (sg_len > *offset)
3118 break;
3119 }
3120
3121 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07003122 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
3123 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07003124 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003125 WARN_ON(1);
3126 return NULL;
3127 }
3128
3129 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02003130 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003131
3132 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02003133 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003134 *offset &= ~PAGE_MASK;
3135
3136 /* Bytes in this sg-entry from *offset to the end of the page */
3137 sg_len = PAGE_SIZE - *offset;
3138 if (*len > sg_len)
3139 *len = sg_len;
3140
Cong Wang77dfce02011-11-25 23:14:23 +08003141 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003142}
3143EXPORT_SYMBOL(scsi_kmap_atomic_sg);
3144
3145/**
Rob Landleyeb448202007-11-03 13:30:39 -05003146 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003147 * @virt: virtual address to be unmapped
3148 */
3149void scsi_kunmap_atomic_sg(void *virt)
3150{
Cong Wang77dfce02011-11-25 23:14:23 +08003151 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003152}
3153EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08003154
3155void sdev_disable_disk_events(struct scsi_device *sdev)
3156{
3157 atomic_inc(&sdev->disk_events_disable_depth);
3158}
3159EXPORT_SYMBOL(sdev_disable_disk_events);
3160
3161void sdev_enable_disk_events(struct scsi_device *sdev)
3162{
3163 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
3164 return;
3165 atomic_dec(&sdev->disk_events_disable_depth);
3166}
3167EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003168
3169/**
3170 * scsi_vpd_lun_id - return a unique device identification
3171 * @sdev: SCSI device
3172 * @id: buffer for the identification
3173 * @id_len: length of the buffer
3174 *
3175 * Copies a unique device identification into @id based
3176 * on the information in the VPD page 0x83 of the device.
3177 * The string will be formatted as a SCSI name string.
3178 *
3179 * Returns the length of the identification or error on failure.
3180 * If the identifier is longer than the supplied buffer the actual
3181 * identifier length is returned and the buffer is not zero-padded.
3182 */
3183int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
3184{
3185 u8 cur_id_type = 0xff;
3186 u8 cur_id_size = 0;
3187 unsigned char *d, *cur_id_str;
3188 unsigned char __rcu *vpd_pg83;
3189 int id_size = -EINVAL;
3190
3191 rcu_read_lock();
3192 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3193 if (!vpd_pg83) {
3194 rcu_read_unlock();
3195 return -ENXIO;
3196 }
3197
3198 /*
3199 * Look for the correct descriptor.
3200 * Order of preference for lun descriptor:
3201 * - SCSI name string
3202 * - NAA IEEE Registered Extended
3203 * - EUI-64 based 16-byte
3204 * - EUI-64 based 12-byte
3205 * - NAA IEEE Registered
3206 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02003207 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003208 * as longer descriptors reduce the likelyhood
3209 * of identification clashes.
3210 */
3211
3212 /* The id string must be at least 20 bytes + terminating NULL byte */
3213 if (id_len < 21) {
3214 rcu_read_unlock();
3215 return -EINVAL;
3216 }
3217
3218 memset(id, 0, id_len);
3219 d = vpd_pg83 + 4;
3220 while (d < vpd_pg83 + sdev->vpd_pg83_len) {
3221 /* Skip designators not referring to the LUN */
3222 if ((d[1] & 0x30) != 0x00)
3223 goto next_desig;
3224
3225 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02003226 case 0x1:
3227 /* T10 Vendor ID */
3228 if (cur_id_size > d[3])
3229 break;
3230 /* Prefer anything */
3231 if (cur_id_type > 0x01 && cur_id_type != 0xff)
3232 break;
3233 cur_id_size = d[3];
3234 if (cur_id_size + 4 > id_len)
3235 cur_id_size = id_len - 4;
3236 cur_id_str = d + 4;
3237 cur_id_type = d[1] & 0xf;
3238 id_size = snprintf(id, id_len, "t10.%*pE",
3239 cur_id_size, cur_id_str);
3240 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003241 case 0x2:
3242 /* EUI-64 */
3243 if (cur_id_size > d[3])
3244 break;
3245 /* Prefer NAA IEEE Registered Extended */
3246 if (cur_id_type == 0x3 &&
3247 cur_id_size == d[3])
3248 break;
3249 cur_id_size = d[3];
3250 cur_id_str = d + 4;
3251 cur_id_type = d[1] & 0xf;
3252 switch (cur_id_size) {
3253 case 8:
3254 id_size = snprintf(id, id_len,
3255 "eui.%8phN",
3256 cur_id_str);
3257 break;
3258 case 12:
3259 id_size = snprintf(id, id_len,
3260 "eui.%12phN",
3261 cur_id_str);
3262 break;
3263 case 16:
3264 id_size = snprintf(id, id_len,
3265 "eui.%16phN",
3266 cur_id_str);
3267 break;
3268 default:
3269 cur_id_size = 0;
3270 break;
3271 }
3272 break;
3273 case 0x3:
3274 /* NAA */
3275 if (cur_id_size > d[3])
3276 break;
3277 cur_id_size = d[3];
3278 cur_id_str = d + 4;
3279 cur_id_type = d[1] & 0xf;
3280 switch (cur_id_size) {
3281 case 8:
3282 id_size = snprintf(id, id_len,
3283 "naa.%8phN",
3284 cur_id_str);
3285 break;
3286 case 16:
3287 id_size = snprintf(id, id_len,
3288 "naa.%16phN",
3289 cur_id_str);
3290 break;
3291 default:
3292 cur_id_size = 0;
3293 break;
3294 }
3295 break;
3296 case 0x8:
3297 /* SCSI name string */
3298 if (cur_id_size + 4 > d[3])
3299 break;
3300 /* Prefer others for truncated descriptor */
3301 if (cur_id_size && d[3] > id_len)
3302 break;
3303 cur_id_size = id_size = d[3];
3304 cur_id_str = d + 4;
3305 cur_id_type = d[1] & 0xf;
3306 if (cur_id_size >= id_len)
3307 cur_id_size = id_len - 1;
3308 memcpy(id, cur_id_str, cur_id_size);
3309 /* Decrease priority for truncated descriptor */
3310 if (cur_id_size != id_size)
3311 cur_id_size = 6;
3312 break;
3313 default:
3314 break;
3315 }
3316next_desig:
3317 d += d[3] + 4;
3318 }
3319 rcu_read_unlock();
3320
3321 return id_size;
3322}
3323EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003324
3325/*
3326 * scsi_vpd_tpg_id - return a target port group identifier
3327 * @sdev: SCSI device
3328 *
3329 * Returns the Target Port Group identifier from the information
3330 * froom VPD page 0x83 of the device.
3331 *
3332 * Returns the identifier or error on failure.
3333 */
3334int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3335{
3336 unsigned char *d;
3337 unsigned char __rcu *vpd_pg83;
3338 int group_id = -EAGAIN, rel_port = -1;
3339
3340 rcu_read_lock();
3341 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3342 if (!vpd_pg83) {
3343 rcu_read_unlock();
3344 return -ENXIO;
3345 }
3346
3347 d = sdev->vpd_pg83 + 4;
3348 while (d < sdev->vpd_pg83 + sdev->vpd_pg83_len) {
3349 switch (d[1] & 0xf) {
3350 case 0x4:
3351 /* Relative target port */
3352 rel_port = get_unaligned_be16(&d[6]);
3353 break;
3354 case 0x5:
3355 /* Target port group */
3356 group_id = get_unaligned_be16(&d[6]);
3357 break;
3358 default:
3359 break;
3360 }
3361 d += d[3] + 4;
3362 }
3363 rcu_read_unlock();
3364
3365 if (group_id >= 0 && rel_id && rel_port != -1)
3366 *rel_id = rel_port;
3367
3368 return group_id;
3369}
3370EXPORT_SYMBOL(scsi_vpd_tpg_id);