blob: 814a4bd8405dca1a4897edd7f4cb66a163cb2545 [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>
Christoph Hellwigee14c672015-08-27 14:16:59 +020033#include <scsi/scsi_dh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
Christoph Hellwig3b5382c2014-05-06 12:25:40 +020035#include <trace/events/scsi.h>
36
Bart Van Assche0eebd002017-04-26 13:47:57 -070037#include "scsi_debugfs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include "scsi_priv.h"
39#include "scsi_logging.h"
40
Christoph Hellwige9c787e2017-01-02 21:55:26 +030041static struct kmem_cache *scsi_sdb_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030042static struct kmem_cache *scsi_sense_cache;
43static struct kmem_cache *scsi_sense_isadma_cache;
44static DEFINE_MUTEX(scsi_sense_cache_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030046static inline struct kmem_cache *
47scsi_select_sense_cache(struct Scsi_Host *shost)
48{
49 return shost->unchecked_isa_dma ?
50 scsi_sense_isadma_cache : scsi_sense_cache;
51}
52
Christoph Hellwige9c787e2017-01-02 21:55:26 +030053static void scsi_free_sense_buffer(struct Scsi_Host *shost,
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030054 unsigned char *sense_buffer)
55{
56 kmem_cache_free(scsi_select_sense_cache(shost), sense_buffer);
57}
58
Christoph Hellwige9c787e2017-01-02 21:55:26 +030059static unsigned char *scsi_alloc_sense_buffer(struct Scsi_Host *shost,
60 gfp_t gfp_mask, int numa_node)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030061{
62 return kmem_cache_alloc_node(scsi_select_sense_cache(shost), gfp_mask,
63 numa_node);
64}
65
66int scsi_init_sense_cache(struct Scsi_Host *shost)
67{
68 struct kmem_cache *cache;
69 int ret = 0;
70
71 cache = scsi_select_sense_cache(shost);
72 if (cache)
73 return 0;
74
75 mutex_lock(&scsi_sense_cache_mutex);
76 if (shost->unchecked_isa_dma) {
77 scsi_sense_isadma_cache =
78 kmem_cache_create("scsi_sense_cache(DMA)",
79 SCSI_SENSE_BUFFERSIZE, 0,
80 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
81 if (!scsi_sense_isadma_cache)
82 ret = -ENOMEM;
83 } else {
84 scsi_sense_cache =
85 kmem_cache_create("scsi_sense_cache",
86 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN, NULL);
87 if (!scsi_sense_cache)
88 ret = -ENOMEM;
89 }
90
91 mutex_unlock(&scsi_sense_cache_mutex);
92 return ret;
93}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +020094
Jens Axboea488e742010-04-16 21:13:15 +020095/*
96 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
97 * not change behaviour from the previous unplug mechanism, experimentation
98 * may prove this needs changing.
99 */
100#define SCSI_QUEUE_DELAY 3
101
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100102static void
103scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104{
105 struct Scsi_Host *host = cmd->device->host;
106 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500107 struct scsi_target *starget = scsi_target(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900110 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 *
112 * If the host/device isn't busy, assume that something actually
113 * completed, and that we should be able to queue a command now.
114 *
115 * Note that the prior mid-layer assumption that any host could
116 * always queue at least one command is now broken. The mid-layer
117 * will implement a user specifiable stall (see
118 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
119 * if a command is requeued with no other commands outstanding
120 * either for the device or for the host.
121 */
Mike Christief0c0a372008-08-17 15:24:38 -0500122 switch (reason) {
123 case SCSI_MLQUEUE_HOST_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100124 atomic_set(&host->host_blocked, host->max_host_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500125 break;
126 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400127 case SCSI_MLQUEUE_EH_RETRY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100128 atomic_set(&device->device_blocked,
129 device->max_device_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500130 break;
131 case SCSI_MLQUEUE_TARGET_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100132 atomic_set(&starget->target_blocked,
133 starget->max_target_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500134 break;
135 }
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100136}
137
Christoph Hellwigd2852032014-01-17 12:06:53 +0100138static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
139{
140 struct scsi_device *sdev = cmd->device;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100141
Bart Van Assche2b053ac2016-10-28 17:21:41 -0700142 blk_mq_requeue_request(cmd->request, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100143 put_device(&sdev->sdev_gendev);
144}
145
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100146/**
147 * __scsi_queue_insert - private queue insertion
148 * @cmd: The SCSI command being requeued
149 * @reason: The reason for the requeue
150 * @unbusy: Whether the queue should be unbusied
151 *
152 * This is a private queue insertion. The public interface
153 * scsi_queue_insert() always assumes the queue should be unbusied
154 * because it's always called before the completion. This function is
155 * for a requeue after completion, which should only occur in this
156 * file.
157 */
158static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
159{
160 struct scsi_device *device = cmd->device;
161 struct request_queue *q = device->request_queue;
162 unsigned long flags;
163
164 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
165 "Inserting command %p into mlqueue\n", cmd));
166
167 scsi_set_blocked(cmd, reason);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 * Decrement the counters, since these commands are no longer
171 * active on the host/device.
172 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600173 if (unbusy)
174 scsi_device_unbusy(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500177 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000178 * that are already in the queue. Schedule requeue work under
179 * lock such that the kblockd_schedule_work() call happens
180 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200181 */
Alan Stern644373a2014-03-28 10:51:15 -0700182 cmd->result = 0;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100183 if (q->mq_ops) {
184 scsi_mq_requeue_cmd(cmd);
185 return;
186 }
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500187 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley59897da2005-09-14 12:57:42 -0400188 blk_requeue_request(q, cmd->request);
Jens Axboe59c3d452014-04-08 09:15:35 -0600189 kblockd_schedule_work(&device->requeue_work);
Bart Van Asscheb4854622012-06-29 15:36:07 +0000190 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191}
192
James Bottomley4f5299a2009-01-02 10:42:21 -0600193/*
194 * Function: scsi_queue_insert()
195 *
196 * Purpose: Insert a command in the midlevel queue.
197 *
198 * Arguments: cmd - command that we are adding to queue.
199 * reason - why we are inserting command to queue.
200 *
201 * Lock status: Assumed that lock is not held upon entry.
202 *
203 * Returns: Nothing.
204 *
205 * Notes: We do this for one of two cases. Either the host is busy
206 * and it cannot accept any more commands for the time being,
207 * or the device returned QUEUE_FULL and can accept no more
208 * commands.
209 * Notes: This could be called either from an interrupt context or a
210 * normal process context.
211 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000212void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600213{
Bart Van Assche84feb162012-06-29 15:35:05 +0000214 __scsi_queue_insert(cmd, reason, 1);
James Bottomley4f5299a2009-01-02 10:42:21 -0600215}
Christoph Hellwige8064022016-10-20 15:12:13 +0200216
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100217
218/**
219 * scsi_execute - insert request and wait for the result
220 * @sdev: scsi device
221 * @cmd: scsi command
222 * @data_direction: data direction
223 * @buffer: data buffer
224 * @bufflen: len of buffer
225 * @sense: optional sense buffer
226 * @sshdr: optional decoded sense header
227 * @timeout: request timeout in seconds
228 * @retries: number of times to retry request
229 * @flags: flags for ->cmd_flags
230 * @rq_flags: flags for ->rq_flags
231 * @resid: optional residual length
232 *
Christoph Hellwig17d53632017-04-20 16:03:01 +0200233 * Returns the scsi_cmnd result field if a command was executed, or a negative
234 * Linux error code if we didn't get that far.
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100235 */
236int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500237 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100238 unsigned char *sense, struct scsi_sense_hdr *sshdr,
239 int timeout, int retries, u64 flags, req_flags_t rq_flags,
240 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500241{
242 struct request *req;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100243 struct scsi_request *rq;
James Bottomley39216032005-06-15 18:48:29 -0500244 int ret = DRIVER_ERROR << 24;
245
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100246 req = blk_get_request(sdev->request_queue,
247 data_direction == DMA_TO_DEVICE ?
248 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, __GFP_RECLAIM);
Joe Lawrencea492f072014-08-28 08:15:21 -0600249 if (IS_ERR(req))
James Bottomleybfe159a2011-07-07 15:45:40 -0500250 return ret;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100251 rq = scsi_req(req);
252 scsi_req_init(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 Hellwigf6d47e72014-02-16 06:16:13 -0800637static bool scsi_end_request(struct request *req, int error,
638 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 *
696 * Translate SCSI error code into standard UNIX errno.
697 * Return values:
698 * -ENOLINK temporary transport failure
699 * -EREMOTEIO permanent target failure, do not retry
700 * -EBADE permanent nexus failure, retry on other path
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200701 * -ENOSPC No write space available
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200702 * -ENODATA Medium error
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200703 * -EIO unspecified I/O error
704 */
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100705static int __scsi_error_from_host_byte(struct scsi_cmnd *cmd, int result)
706{
707 int error = 0;
708
709 switch(host_byte(result)) {
710 case DID_TRANSPORT_FAILFAST:
711 error = -ENOLINK;
712 break;
713 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000714 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100715 error = -EREMOTEIO;
716 break;
717 case DID_NEXUS_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000718 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100719 error = -EBADE;
720 break;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200721 case DID_ALLOC_FAILURE:
722 set_host_byte(cmd, DID_OK);
723 error = -ENOSPC;
724 break;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200725 case DID_MEDIUM_ERROR:
726 set_host_byte(cmd, DID_OK);
727 error = -ENODATA;
728 break;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100729 default:
730 error = -EIO;
731 break;
732 }
733
734 return error;
735}
736
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737/*
738 * Function: scsi_io_completion()
739 *
740 * Purpose: Completion processing for block device I/O requests.
741 *
742 * Arguments: cmd - command that is finished.
743 *
744 * Lock status: Assumed that no lock is held upon entry.
745 *
746 * Returns: Nothing
747 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200748 * Notes: We will finish off the specified number of sectors. If we
749 * are done, the command block will be released and the queue
750 * function will be goosed. If we are not done then we have to
Alan Sternb60af5b2008-11-03 15:56:47 -0500751 * figure out what to do next:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500753 * a) We can call scsi_requeue_command(). The request
754 * will be unprepared and put back on the queue. Then
755 * a new command will be created for it. This should
756 * be used if we made forward progress, or if we want
757 * to switch from READ(10) to READ(6) for example.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200759 * b) We can call __scsi_queue_insert(). The request will
Alan Sternb60af5b2008-11-03 15:56:47 -0500760 * be put back on the queue and retried using the same
761 * command as before, possibly after a delay.
762 *
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800763 * c) We can call scsi_end_request() with -EIO to fail
Alan Sternb60af5b2008-11-03 15:56:47 -0500764 * the remainder of the request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 */
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700766void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767{
768 int result = cmd->result;
Jens Axboe165125e2007-07-24 09:28:11 +0200769 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 struct request *req = cmd->request;
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500771 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 struct scsi_sense_hdr sshdr;
Hannes Reinecke4753cbc2014-10-24 14:26:52 +0200773 bool sense_valid = false;
Hannes Reineckec11c0042014-10-24 14:27:01 +0200774 int sense_deferred = 0, level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500775 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
776 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900777 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 if (result) {
780 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
781 if (sense_valid)
782 sense_deferred = scsi_sense_is_deferred(&sshdr);
783 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200784
Christoph Hellwig57292b52017-01-31 16:57:29 +0100785 if (blk_rq_is_passthrough(req)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 if (result) {
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100787 if (sense_valid) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 /*
789 * SG_IO wants current and deferred errors
790 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100791 scsi_req(req)->sense_len =
792 min(8 + cmd->sense_buffer[7],
793 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 }
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500795 if (!sense_deferred)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100796 error = __scsi_error_from_host_byte(cmd, result);
Pete Wyckoffb22f6872007-03-13 16:53:28 -0400797 }
Mike Snitzer27c41972012-05-31 15:05:33 -0400798 /*
799 * __scsi_error_from_host_byte may have reset the host_byte
800 */
Christoph Hellwig17d53632017-04-20 16:03:01 +0200801 scsi_req(req)->result = cmd->result;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100802 scsi_req(req)->resid_len = scsi_get_resid(cmd);
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900803
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200804 if (scsi_bidi_cmnd(cmd)) {
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900805 /*
806 * Bidi commands Must be complete as a whole,
807 * both sides at once.
808 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100809 scsi_req(req->next_rq)->resid_len = scsi_in(cmd)->resid;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800810 if (scsi_end_request(req, 0, blk_rq_bytes(req),
811 blk_rq_bytes(req->next_rq)))
812 BUG();
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200813 return;
814 }
James Bottomley89fb4cd2014-07-03 19:17:34 +0200815 } else if (blk_rq_bytes(req) == 0 && result && !sense_deferred) {
816 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100817 * Flush commands do not transfers any data, and thus cannot use
James Bottomley89fb4cd2014-07-03 19:17:34 +0200818 * good_bytes != blk_rq_bytes(req) as the signal for an error.
819 * This sets the error explicitly for the problem case.
820 */
821 error = __scsi_error_from_host_byte(cmd, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 }
823
Christoph Hellwig57292b52017-01-31 16:57:29 +0100824 /* no bidi support for !blk_rq_is_passthrough yet */
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200825 BUG_ON(blk_bidi_rq(req));
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200826
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 * Next deal with any sectors which we were able to correctly
829 * handle.
830 */
Hannes Reinecke91921e02014-06-25 16:39:59 +0200831 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
832 "%u sectors total, %d bytes done.\n",
833 blk_rq_sectors(req), good_bytes));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
James Bottomleya9bddd72009-03-30 16:55:51 +0000835 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100836 * Recovered errors need reporting, but they're always treated as
837 * success, so fiddle the result code here. For passthrough requests
Christoph Hellwig17d53632017-04-20 16:03:01 +0200838 * we already took a copy of the original into sreq->result which
James Bottomleya9bddd72009-03-30 16:55:51 +0000839 * is what gets returned to the user
840 */
Douglas Gilberte7efe592010-01-03 13:51:15 -0500841 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
842 /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
843 * print since caller wants ATA registers. Only occurs on
844 * SCSI ATA PASS_THROUGH commands when CK_COND=1
845 */
846 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
847 ;
Christoph Hellwige8064022016-10-20 15:12:13 +0200848 else if (!(req->rq_flags & RQF_QUIET))
Hannes Reinecked811b842014-10-24 14:26:45 +0200849 scsi_print_sense(cmd);
James Bottomleya9bddd72009-03-30 16:55:51 +0000850 result = 0;
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100851 /* for passthrough error may be set */
James Bottomleya9bddd72009-03-30 16:55:51 +0000852 error = 0;
853 }
854
855 /*
James Bottomleya621bac2016-05-13 12:04:06 -0700856 * special case: failed zero length commands always need to
857 * drop down into the retry code. Otherwise, if we finished
858 * all bytes in the request we are done now.
James Bottomleyd6b0c532006-07-02 10:06:28 -0500859 */
James Bottomleya621bac2016-05-13 12:04:06 -0700860 if (!(blk_rq_bytes(req) == 0 && error) &&
861 !scsi_end_request(req, error, good_bytes, 0))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800862 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200863
864 /*
865 * Kill remainder if no retrys.
866 */
867 if (error && scsi_noretry_cmd(cmd)) {
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800868 if (scsi_end_request(req, error, blk_rq_bytes(req), 0))
869 BUG();
870 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200871 }
872
873 /*
874 * If there had been no error, but we have leftover bytes in the
875 * requeues just queue the command up again.
876 */
877 if (result == 0)
878 goto requeue;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700879
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100880 error = __scsi_error_from_host_byte(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500881
Alan Sternb60af5b2008-11-03 15:56:47 -0500882 if (host_byte(result) == DID_RESET) {
883 /* Third party bus reset or reset for error recovery
884 * reasons. Just retry the command and see what
885 * happens.
886 */
887 action = ACTION_RETRY;
888 } else if (sense_valid && !sense_deferred) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 switch (sshdr.sense_key) {
890 case UNIT_ATTENTION:
891 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700892 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 * and quietly refuse further access.
894 */
895 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500896 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700898 /* Must have been a power glitch, or a
899 * bus reset. Could not have been a
900 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500901 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700902 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500903 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 }
905 break;
906 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700907 /* If we had an ILLEGAL REQUEST returned, then
908 * we may have performed an unsupported
909 * command. The only thing this should be
910 * would be a ten byte read where only a six
911 * byte read was supported. Also, on a system
912 * where READ CAPACITY failed, we may have
913 * read past the end of the disk.
914 */
Jens Axboe26a68012005-11-29 21:03:34 +0100915 if ((cmd->device->use_10_for_rw &&
916 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 (cmd->cmnd[0] == READ_10 ||
918 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500919 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500921 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500922 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500923 action = ACTION_FAIL;
924 error = -EILSEQ;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500925 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400926 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500927 action = ACTION_FAIL;
Martin K. Petersen66a651a2012-02-13 15:38:22 -0500928 error = -EREMOTEIO;
Alan Sternb60af5b2008-11-03 15:56:47 -0500929 } else
930 action = ACTION_FAIL;
931 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400932 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000933 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200934 if (sshdr.asc == 0x10) /* DIF */
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500935 error = -EILSEQ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 break;
937 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700938 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500939 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500941 if (sshdr.asc == 0x04) {
942 switch (sshdr.ascq) {
943 case 0x01: /* becoming ready */
944 case 0x04: /* format in progress */
945 case 0x05: /* rebuild in progress */
946 case 0x06: /* recalculation in progress */
947 case 0x07: /* operation in progress */
948 case 0x08: /* Long write in progress */
949 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500950 case 0x14: /* space allocation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500951 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500952 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500953 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500954 action = ACTION_FAIL;
955 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500956 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200957 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500958 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500959 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700961 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500962 action = ACTION_FAIL;
963 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500965 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 break;
967 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200968 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500969 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500970
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900971 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200972 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900973 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900974
Alan Sternb60af5b2008-11-03 15:56:47 -0500975 switch (action) {
976 case ACTION_FAIL:
977 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200978 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200979 static DEFINE_RATELIMIT_STATE(_rs,
980 DEFAULT_RATELIMIT_INTERVAL,
981 DEFAULT_RATELIMIT_BURST);
982
983 if (unlikely(scsi_logging_level))
984 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
985 SCSI_LOG_MLCOMPLETE_BITS);
986
987 /*
988 * if logging is enabled the failure will be printed
989 * in scsi_log_completion(), so avoid duplicate messages
990 */
991 if (!level && __ratelimit(&_rs)) {
992 scsi_print_result(cmd, NULL, FAILED);
993 if (driver_byte(result) & DRIVER_SENSE)
994 scsi_print_sense(cmd);
995 scsi_print_command(cmd);
996 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500997 }
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800998 if (!scsi_end_request(req, error, blk_rq_err_bytes(req), 0))
999 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +02001000 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -05001001 case ACTION_REPREP:
Christoph Hellwigbc85dc52014-05-01 16:51:03 +02001002 requeue:
Alan Sternb60af5b2008-11-03 15:56:47 -05001003 /* Unprep the request and put it back at the head of the queue.
1004 * A new command will be prepared and issued.
1005 */
Christoph Hellwigd2852032014-01-17 12:06:53 +01001006 if (q->mq_ops) {
Christoph Hellwige8064022016-10-20 15:12:13 +02001007 cmd->request->rq_flags &= ~RQF_DONTPREP;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001008 scsi_mq_uninit_cmd(cmd);
1009 scsi_mq_requeue_cmd(cmd);
1010 } else {
1011 scsi_release_buffers(cmd);
1012 scsi_requeue_command(q, cmd);
1013 }
Alan Sternb60af5b2008-11-03 15:56:47 -05001014 break;
1015 case ACTION_RETRY:
1016 /* Retry the same command immediately */
James Bottomley4f5299a2009-01-02 10:42:21 -06001017 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001018 break;
1019 case ACTION_DELAYED_RETRY:
1020 /* Retry the same command after a delay */
James Bottomley4f5299a2009-01-02 10:42:21 -06001021 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001022 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 }
1024}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001026static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001028 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
1030 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001031 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001033 if (unlikely(sg_alloc_table_chained(&sdb->table,
1034 blk_rq_nr_phys_segments(req), sdb->table.sgl)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 return BLKPREP_DEFER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 /*
1038 * Next, walk the list, and fill in the addresses and sizes of
1039 * each segment.
1040 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001041 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1042 BUG_ON(count > sdb->table.nents);
1043 sdb->table.nents = count;
Christoph Hellwigfd102b12017-01-13 12:29:11 +01001044 sdb->length = blk_rq_payload_bytes(req);
Rusty Russell4a03d902007-11-19 11:28:48 +11001045 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001047
1048/*
1049 * Function: scsi_init_io()
1050 *
1051 * Purpose: SCSI I/O initialize function.
1052 *
1053 * Arguments: cmd - Command descriptor we wish to initialize
1054 *
1055 * Returns: 0 on success
1056 * BLKPREP_DEFER if the failure is retryable
1057 * BLKPREP_KILL if the failure is fatal
1058 */
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001059int scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001060{
Christoph Hellwig5e012aa2014-04-15 12:24:55 +02001061 struct scsi_device *sdev = cmd->device;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001062 struct request *rq = cmd->request;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001063 bool is_mq = (rq->mq_ctx != NULL);
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001064 int error = BLKPREP_KILL;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001065
Johannes Thumshirnfd3fc0b2017-01-31 10:16:00 +01001066 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001067 goto err_exit;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001068
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001069 error = scsi_init_sgtable(rq, &cmd->sdb);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001070 if (error)
1071 goto err_exit;
1072
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001073 if (blk_bidi_rq(rq)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001074 if (!rq->q->mq_ops) {
1075 struct scsi_data_buffer *bidi_sdb =
1076 kmem_cache_zalloc(scsi_sdb_cache, GFP_ATOMIC);
1077 if (!bidi_sdb) {
1078 error = BLKPREP_DEFER;
1079 goto err_exit;
1080 }
1081
1082 rq->next_rq->special = bidi_sdb;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001083 }
1084
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001085 error = scsi_init_sgtable(rq->next_rq, rq->next_rq->special);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001086 if (error)
1087 goto err_exit;
1088 }
1089
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001090 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001091 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1092 int ivecs, count;
1093
Ewan D. Milne91724c22015-01-15 10:02:12 -05001094 if (prot_sdb == NULL) {
1095 /*
1096 * This can happen if someone (e.g. multipath)
1097 * queues a command to a device on an adapter
1098 * that does not support DIX.
1099 */
1100 WARN_ON_ONCE(1);
1101 error = BLKPREP_KILL;
1102 goto err_exit;
1103 }
1104
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001105 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001106
Ming Lin001d63b2016-04-04 14:48:09 -07001107 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lin22cc3d42016-04-04 14:48:08 -07001108 prot_sdb->table.sgl)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001109 error = BLKPREP_DEFER;
1110 goto err_exit;
1111 }
1112
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001113 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001114 prot_sdb->table.sgl);
1115 BUG_ON(unlikely(count > ivecs));
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001116 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001117
1118 cmd->prot_sdb = prot_sdb;
1119 cmd->prot_sdb->table.nents = count;
1120 }
1121
Christoph Hellwigd2852032014-01-17 12:06:53 +01001122 return BLKPREP_OK;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001123err_exit:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001124 if (is_mq) {
1125 scsi_mq_free_sgtables(cmd);
1126 } else {
1127 scsi_release_buffers(cmd);
1128 cmd->request->special = NULL;
1129 scsi_put_command(cmd);
1130 put_device(&sdev->sdev_gendev);
1131 }
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001132 return error;
1133}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001134EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001136void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001137{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001138 void *buf = cmd->sense_buffer;
1139 void *prot = cmd->prot_sdb;
1140 unsigned long flags;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001141
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001142 /* zero out the cmd, except for the embedded scsi_request */
1143 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001144 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001145
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001146 cmd->device = dev;
1147 cmd->sense_buffer = buf;
1148 cmd->prot_sdb = prot;
1149 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1150 cmd->jiffies_at_alloc = jiffies;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001151
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001152 spin_lock_irqsave(&dev->list_lock, flags);
1153 list_add_tail(&cmd->list, &dev->cmd_list);
1154 spin_unlock_irqrestore(&dev->list_lock, flags);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001155}
1156
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001157static int scsi_setup_scsi_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001158{
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001159 struct scsi_cmnd *cmd = req->special;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001160
1161 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001162 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001163 * a bio attached to them. Or they might contain a SCSI command
1164 * that does not transfer data, in which case they may optionally
1165 * submit a request without an attached bio.
1166 */
1167 if (req->bio) {
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001168 int ret = scsi_init_io(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001169 if (unlikely(ret))
1170 return ret;
1171 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001172 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001173
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001174 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001175 }
James Bottomley7b163182005-12-15 20:17:02 -06001176
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001177 cmd->cmd_len = scsi_req(req)->cmd_len;
1178 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001179 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001180 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001181 return BLKPREP_OK;
1182}
1183
1184/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001185 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001186 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001187 */
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001188static int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001189{
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001190 struct scsi_cmnd *cmd = req->special;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001191
Christoph Hellwigee14c672015-08-27 14:16:59 +02001192 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
1193 int ret = sdev->handler->prep_fn(sdev, req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001194 if (ret != BLKPREP_OK)
1195 return ret;
1196 }
1197
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001198 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001199 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001200 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001201}
James Bottomley7b163182005-12-15 20:17:02 -06001202
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001203static int scsi_setup_cmnd(struct scsi_device *sdev, struct request *req)
1204{
1205 struct scsi_cmnd *cmd = req->special;
1206
1207 if (!blk_rq_bytes(req))
1208 cmd->sc_data_direction = DMA_NONE;
1209 else if (rq_data_dir(req) == WRITE)
1210 cmd->sc_data_direction = DMA_TO_DEVICE;
1211 else
1212 cmd->sc_data_direction = DMA_FROM_DEVICE;
1213
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001214 if (blk_rq_is_scsi(req))
1215 return scsi_setup_scsi_cmnd(sdev, req);
1216 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001217 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001218}
1219
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001220static int
1221scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001223 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224
1225 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001226 * If the device is not in running state we will reject some
1227 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001230 switch (sdev->sdev_state) {
1231 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05001232 case SDEV_TRANSPORT_OFFLINE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001233 /*
1234 * If the device is offline we refuse to process any
1235 * commands. The device must be brought online
1236 * before trying any recovery commands.
1237 */
1238 sdev_printk(KERN_ERR, sdev,
1239 "rejecting I/O to offline device\n");
1240 ret = BLKPREP_KILL;
1241 break;
1242 case SDEV_DEL:
1243 /*
1244 * If the device is fully deleted, we refuse to
1245 * process any commands as well.
1246 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001247 sdev_printk(KERN_ERR, sdev,
1248 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001249 ret = BLKPREP_KILL;
1250 break;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001251 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001252 case SDEV_CREATED_BLOCK:
Bart Van Asschebba0bdd2015-03-04 10:31:47 +01001253 ret = BLKPREP_DEFER;
1254 break;
1255 case SDEV_QUIESCE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001256 /*
1257 * If the devices is blocked we defer normal commands.
1258 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001259 if (!(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001260 ret = BLKPREP_DEFER;
1261 break;
1262 default:
1263 /*
1264 * For any other not fully online state we only allow
1265 * special commands. In particular any user initiated
1266 * command is not allowed.
1267 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001268 if (!(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001269 ret = BLKPREP_KILL;
1270 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001273 return ret;
1274}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001276static int
1277scsi_prep_return(struct request_queue *q, struct request *req, int ret)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001278{
1279 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
Christoph Hellwig3b003152006-11-04 20:10:55 +01001281 switch (ret) {
1282 case BLKPREP_KILL:
jiangyiwene1cd3912016-02-16 20:14:13 +08001283 case BLKPREP_INVALID:
Christoph Hellwig17d53632017-04-20 16:03:01 +02001284 scsi_req(req)->result = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001285 /* release the command and kill it */
1286 if (req->special) {
1287 struct scsi_cmnd *cmd = req->special;
1288 scsi_release_buffers(cmd);
1289 scsi_put_command(cmd);
Christoph Hellwig68c03d92014-04-15 12:24:56 +02001290 put_device(&sdev->sdev_gendev);
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001291 req->special = NULL;
1292 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001293 break;
1294 case BLKPREP_DEFER:
1295 /*
Tejun Heo9934c8c2009-05-08 11:54:16 +09001296 * If we defer, the blk_peek_request() returns NULL, but the
Jens Axboea488e742010-04-16 21:13:15 +02001297 * queue must be restarted, so we schedule a callback to happen
1298 * shortly.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001299 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001300 if (atomic_read(&sdev->device_busy) == 0)
Jens Axboea488e742010-04-16 21:13:15 +02001301 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001302 break;
1303 default:
Christoph Hellwige8064022016-10-20 15:12:13 +02001304 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001305 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
Christoph Hellwig3b003152006-11-04 20:10:55 +01001307 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001309
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001310static int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001311{
1312 struct scsi_device *sdev = q->queuedata;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001313 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001314 int ret;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001315
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001316 ret = scsi_prep_state_check(sdev, req);
1317 if (ret != BLKPREP_OK)
1318 goto out;
1319
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001320 if (!req->special) {
1321 /* Bail if we can't get a reference to the device */
1322 if (unlikely(!get_device(&sdev->sdev_gendev))) {
1323 ret = BLKPREP_DEFER;
1324 goto out;
1325 }
1326
1327 scsi_init_command(sdev, cmd);
1328 req->special = cmd;
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001329 }
1330
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001331 cmd->tag = req->tag;
1332 cmd->request = req;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001333 cmd->prot_op = SCSI_PROT_NORMAL;
1334
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001335 ret = scsi_setup_cmnd(sdev, req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001336out:
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001337 return scsi_prep_return(q, req, ret);
1338}
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001339
1340static void scsi_unprep_fn(struct request_queue *q, struct request *req)
1341{
Christoph Hellwigd2852032014-01-17 12:06:53 +01001342 scsi_uninit_cmd(req->special);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001343}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
1345/*
1346 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1347 * return 0.
1348 *
1349 * Called with the queue_lock held.
1350 */
1351static inline int scsi_dev_queue_ready(struct request_queue *q,
1352 struct scsi_device *sdev)
1353{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001354 unsigned int busy;
1355
1356 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001357 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001358 if (busy)
1359 goto out_dec;
1360
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 /*
1362 * unblock after device_blocked iterates to zero
1363 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001364 if (atomic_dec_return(&sdev->device_blocked) > 0) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001365 /*
1366 * For the MQ case we take care of this in the caller.
1367 */
1368 if (!q->mq_ops)
1369 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001370 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001372 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1373 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001375
1376 if (busy >= sdev->queue_depth)
1377 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
1379 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001380out_dec:
1381 atomic_dec(&sdev->device_busy);
1382 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383}
1384
Mike Christief0c0a372008-08-17 15:24:38 -05001385/*
1386 * scsi_target_queue_ready: checks if there we can send commands to target
1387 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001388 */
1389static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1390 struct scsi_device *sdev)
1391{
1392 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001393 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001394
1395 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001396 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001397 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001398 starget->starget_sdev_user != sdev) {
1399 spin_unlock_irq(shost->host_lock);
1400 return 0;
1401 }
Mike Christief0c0a372008-08-17 15:24:38 -05001402 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001403 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001404 }
1405
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001406 if (starget->can_queue <= 0)
1407 return 1;
1408
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001409 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001410 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001411 if (busy)
1412 goto starved;
1413
Mike Christief0c0a372008-08-17 15:24:38 -05001414 /*
1415 * unblock after target_blocked iterates to zero
1416 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001417 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001418 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001419
1420 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1421 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001422 }
1423
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001424 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001425 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001426
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001427 return 1;
1428
1429starved:
1430 spin_lock_irq(shost->host_lock);
1431 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001432 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001433out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001434 if (starget->can_queue > 0)
1435 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001436 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001437}
1438
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439/*
1440 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1441 * return 0. We must end up running the queue again whenever 0 is
1442 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 */
1444static inline int scsi_host_queue_ready(struct request_queue *q,
1445 struct Scsi_Host *shost,
1446 struct scsi_device *sdev)
1447{
Christoph Hellwig74665012014-01-22 15:29:29 +01001448 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001449
James Bottomley939647e2005-09-18 15:05:20 -05001450 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001451 return 0;
1452
1453 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001454 if (atomic_read(&shost->host_blocked) > 0) {
Christoph Hellwig74665012014-01-22 15:29:29 +01001455 if (busy)
1456 goto starved;
1457
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 /*
1459 * unblock after host_blocked iterates to zero
1460 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001461 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001462 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001463
1464 SCSI_LOG_MLQUEUE(3,
1465 shost_printk(KERN_INFO, shost,
1466 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001468
1469 if (shost->can_queue > 0 && busy >= shost->can_queue)
1470 goto starved;
1471 if (shost->host_self_blocked)
1472 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
1474 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001475 if (!list_empty(&sdev->starved_entry)) {
1476 spin_lock_irq(shost->host_lock);
1477 if (!list_empty(&sdev->starved_entry))
1478 list_del_init(&sdev->starved_entry);
1479 spin_unlock_irq(shost->host_lock);
1480 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481
Christoph Hellwig74665012014-01-22 15:29:29 +01001482 return 1;
1483
1484starved:
1485 spin_lock_irq(shost->host_lock);
1486 if (list_empty(&sdev->starved_entry))
1487 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001488 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001489out_dec:
1490 atomic_dec(&shost->host_busy);
1491 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492}
1493
1494/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001495 * Busy state exporting function for request stacking drivers.
1496 *
1497 * For efficiency, no lock is taken to check the busy state of
1498 * shost/starget/sdev, since the returned value is not guaranteed and
1499 * may be changed after request stacking drivers call the function,
1500 * regardless of taking lock or not.
1501 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001502 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1503 * needs to return 'not busy'. Otherwise, request stacking drivers
1504 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001505 */
1506static int scsi_lld_busy(struct request_queue *q)
1507{
1508 struct scsi_device *sdev = q->queuedata;
1509 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001510
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001511 if (blk_queue_dying(q))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001512 return 0;
1513
1514 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001515
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001516 /*
1517 * Ignore host/starget busy state.
1518 * Since block layer does not have a concept of fairness across
1519 * multiple queues, congestion of host/starget needs to be handled
1520 * in SCSI layer.
1521 */
1522 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001523 return 1;
1524
1525 return 0;
1526}
1527
1528/*
James Bottomleye91442b2005-09-09 10:44:16 -05001529 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 */
Jens Axboe165125e2007-07-24 09:28:11 +02001531static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532{
James Bottomleye91442b2005-09-09 10:44:16 -05001533 struct scsi_cmnd *cmd = req->special;
Jiri Slaby03b14702009-09-23 16:15:35 +02001534 struct scsi_device *sdev;
1535 struct scsi_target *starget;
1536 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537
Tejun Heo9934c8c2009-05-08 11:54:16 +09001538 blk_start_request(req);
James Bottomley788ce432005-09-09 13:40:23 -05001539
Hannes Reinecke74571812011-11-09 08:39:24 +01001540 scmd_printk(KERN_INFO, cmd, "killing request\n");
1541
Jiri Slaby03b14702009-09-23 16:15:35 +02001542 sdev = cmd->device;
1543 starget = scsi_target(sdev);
1544 shost = sdev->host;
James Bottomleye91442b2005-09-09 10:44:16 -05001545 scsi_init_cmd_errh(cmd);
1546 cmd->result = DID_NO_CONNECT << 16;
1547 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001548
1549 /*
1550 * SCSI request completion path will do scsi_device_unbusy(),
1551 * bump busy counts. To bump the counters, we need to dance
1552 * with the locks as normal issue path does.
1553 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001554 atomic_inc(&sdev->device_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +01001555 atomic_inc(&shost->host_busy);
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001556 if (starget->can_queue > 0)
1557 atomic_inc(&starget->target_busy);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001558
Jens Axboe242f9dc2008-09-14 05:55:09 -07001559 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560}
1561
Jens Axboe1aea6432006-01-09 16:03:03 +01001562static void scsi_softirq_done(struct request *rq)
1563{
Jens Axboe242f9dc2008-09-14 05:55:09 -07001564 struct scsi_cmnd *cmd = rq->special;
1565 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001566 int disposition;
1567
1568 INIT_LIST_HEAD(&cmd->eh_entry);
1569
Jens Axboe242f9dc2008-09-14 05:55:09 -07001570 atomic_inc(&cmd->device->iodone_cnt);
1571 if (cmd->result)
1572 atomic_inc(&cmd->device->ioerr_cnt);
1573
Jens Axboe1aea6432006-01-09 16:03:03 +01001574 disposition = scsi_decide_disposition(cmd);
1575 if (disposition != SUCCESS &&
1576 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1577 sdev_printk(KERN_ERR, cmd->device,
1578 "timing out command, waited %lus\n",
1579 wait_for/HZ);
1580 disposition = SUCCESS;
1581 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001582
Jens Axboe1aea6432006-01-09 16:03:03 +01001583 scsi_log_completion(cmd, disposition);
1584
1585 switch (disposition) {
1586 case SUCCESS:
1587 scsi_finish_command(cmd);
1588 break;
1589 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001590 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001591 break;
1592 case ADD_TO_MLQUEUE:
1593 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1594 break;
1595 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001596 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001597 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001598 }
1599}
1600
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001601/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001602 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1603 * @cmd: command block we are dispatching.
1604 *
1605 * Return: nonzero return request was rejected and device's queue needs to be
1606 * plugged.
1607 */
1608static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1609{
1610 struct Scsi_Host *host = cmd->device->host;
1611 int rtn = 0;
1612
1613 atomic_inc(&cmd->device->iorequest_cnt);
1614
1615 /* check if the device is still usable */
1616 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1617 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1618 * returns an immediate error upwards, and signals
1619 * that the device is no longer present */
1620 cmd->result = DID_NO_CONNECT << 16;
1621 goto done;
1622 }
1623
1624 /* Check to see if the scsi lld made this device blocked. */
1625 if (unlikely(scsi_device_blocked(cmd->device))) {
1626 /*
1627 * in blocked state, the command is just put back on
1628 * the device queue. The suspend state has already
1629 * blocked the queue so future requests should not
1630 * occur until the device transitions out of the
1631 * suspend state.
1632 */
1633 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1634 "queuecommand : device blocked\n"));
1635 return SCSI_MLQUEUE_DEVICE_BUSY;
1636 }
1637
1638 /* Store the LUN value in cmnd, if needed. */
1639 if (cmd->device->lun_in_cdb)
1640 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1641 (cmd->device->lun << 5 & 0xe0);
1642
1643 scsi_log_send(cmd);
1644
1645 /*
1646 * Before we queue this command, check if the command
1647 * length exceeds what the host adapter can handle.
1648 */
1649 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1650 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1651 "queuecommand : command too long. "
1652 "cdb_size=%d host->max_cmd_len=%d\n",
1653 cmd->cmd_len, cmd->device->host->max_cmd_len));
1654 cmd->result = (DID_ABORT << 16);
1655 goto done;
1656 }
1657
1658 if (unlikely(host->shost_state == SHOST_DEL)) {
1659 cmd->result = (DID_NO_CONNECT << 16);
1660 goto done;
1661
1662 }
1663
1664 trace_scsi_dispatch_cmd_start(cmd);
1665 rtn = host->hostt->queuecommand(host, cmd);
1666 if (rtn) {
1667 trace_scsi_dispatch_cmd_error(cmd, rtn);
1668 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1669 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1670 rtn = SCSI_MLQUEUE_HOST_BUSY;
1671
1672 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1673 "queuecommand : request rejected\n"));
1674 }
1675
1676 return rtn;
1677 done:
1678 cmd->scsi_done(cmd);
1679 return 0;
1680}
1681
1682/**
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001683 * scsi_done - Invoke completion on finished SCSI command.
1684 * @cmd: The SCSI Command for which a low-level device driver (LLDD) gives
1685 * ownership back to SCSI Core -- i.e. the LLDD has finished with it.
1686 *
1687 * Description: This function is the mid-level's (SCSI Core) interrupt routine,
1688 * which regains ownership of the SCSI command (de facto) from a LLDD, and
1689 * calls blk_complete_request() for further processing.
1690 *
1691 * This function is interrupt context safe.
1692 */
1693static void scsi_done(struct scsi_cmnd *cmd)
1694{
1695 trace_scsi_dispatch_cmd_done(cmd);
1696 blk_complete_request(cmd->request);
1697}
1698
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699/*
1700 * Function: scsi_request_fn()
1701 *
1702 * Purpose: Main strategy routine for SCSI.
1703 *
1704 * Arguments: q - Pointer to actual queue.
1705 *
1706 * Returns: Nothing
1707 *
1708 * Lock status: IO request lock assumed to be held when called.
1709 */
1710static void scsi_request_fn(struct request_queue *q)
Bart Van Assche613be1f2014-02-20 14:20:56 -08001711 __releases(q->queue_lock)
1712 __acquires(q->queue_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713{
1714 struct scsi_device *sdev = q->queuedata;
1715 struct Scsi_Host *shost;
1716 struct scsi_cmnd *cmd;
1717 struct request *req;
1718
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 /*
1720 * To start with, we keep looping until the queue is empty, or until
1721 * the host is no longer able to accept any more requests.
1722 */
1723 shost = sdev->host;
Jens Axboea488e742010-04-16 21:13:15 +02001724 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 int rtn;
1726 /*
1727 * get next queueable request. We do this early to make sure
Hannes Reinecke91921e02014-06-25 16:39:59 +02001728 * that the request is fully prepared even if we cannot
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 * accept it.
1730 */
Tejun Heo9934c8c2009-05-08 11:54:16 +09001731 req = blk_peek_request(q);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001732 if (!req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 break;
1734
1735 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001736 sdev_printk(KERN_ERR, sdev,
1737 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001738 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 continue;
1740 }
1741
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001742 if (!scsi_dev_queue_ready(q, sdev))
1743 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744
1745 /*
1746 * Remove the request from the request list.
1747 */
1748 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
Tejun Heo9934c8c2009-05-08 11:54:16 +09001749 blk_start_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001751 spin_unlock_irq(q->queue_lock);
James Bottomleye91442b2005-09-09 10:44:16 -05001752 cmd = req->special;
1753 if (unlikely(cmd == NULL)) {
1754 printk(KERN_CRIT "impossible request in %s.\n"
1755 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001756 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001757 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001758 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001759 BUG();
1760 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761
Mike Christieecefe8a2008-07-11 19:50:35 -05001762 /*
1763 * We hit this when the driver is using a host wide
1764 * tag map. For device level tag maps the queue_depth check
1765 * in the device ready fn would prevent us from trying
1766 * to allocate a tag. Since the map is a shared host resource
1767 * we add the dev to the starved list so it eventually gets
1768 * a run when a tag is freed.
1769 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001770 if (blk_queue_tagged(q) && !(req->rq_flags & RQF_QUEUED)) {
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001771 spin_lock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001772 if (list_empty(&sdev->starved_entry))
1773 list_add_tail(&sdev->starved_entry,
1774 &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001775 spin_unlock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001776 goto not_ready;
1777 }
1778
Mike Christief0c0a372008-08-17 15:24:38 -05001779 if (!scsi_target_queue_ready(shost, sdev))
1780 goto not_ready;
1781
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 if (!scsi_host_queue_ready(q, shost, sdev))
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001783 goto host_not_ready;
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001784
1785 if (sdev->simple_tags)
1786 cmd->flags |= SCMD_TAGGED;
1787 else
1788 cmd->flags &= ~SCMD_TAGGED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 /*
1791 * Finally, initialize any error handling parameters, and set up
1792 * the timers for timeouts.
1793 */
1794 scsi_init_cmd_errh(cmd);
1795
1796 /*
1797 * Dispatch the command to the low-level driver.
1798 */
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001799 cmd->scsi_done = scsi_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 rtn = scsi_dispatch_cmd(cmd);
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001801 if (rtn) {
1802 scsi_queue_insert(cmd, rtn);
1803 spin_lock_irq(q->queue_lock);
Jens Axboea488e742010-04-16 21:13:15 +02001804 goto out_delay;
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001805 }
1806 spin_lock_irq(q->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 }
1808
Bart Van Assche613be1f2014-02-20 14:20:56 -08001809 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001811 host_not_ready:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001812 if (scsi_target(sdev)->can_queue > 0)
1813 atomic_dec(&scsi_target(sdev)->target_busy);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001814 not_ready:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 /*
1816 * lock q, handle tag, requeue req, and decrement device_busy. We
1817 * must return with queue_lock held.
1818 *
1819 * Decrementing device_busy without checking it is OK, as all such
1820 * cases (host limits or settings) should run the queue at some
1821 * later time.
1822 */
1823 spin_lock_irq(q->queue_lock);
1824 blk_requeue_request(q, req);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001825 atomic_dec(&sdev->device_busy);
Jens Axboea488e742010-04-16 21:13:15 +02001826out_delay:
Guenter Roeck480cadc2014-08-10 05:54:25 -07001827 if (!atomic_read(&sdev->device_busy) && !scsi_device_blocked(sdev))
Jens Axboea488e742010-04-16 21:13:15 +02001828 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829}
1830
Christoph Hellwigd2852032014-01-17 12:06:53 +01001831static inline int prep_to_mq(int ret)
1832{
1833 switch (ret) {
1834 case BLKPREP_OK:
Omar Sandoval2868f132016-11-15 11:11:59 -08001835 return BLK_MQ_RQ_QUEUE_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001836 case BLKPREP_DEFER:
1837 return BLK_MQ_RQ_QUEUE_BUSY;
1838 default:
1839 return BLK_MQ_RQ_QUEUE_ERROR;
1840 }
1841}
1842
1843static int scsi_mq_prep_fn(struct request *req)
1844{
1845 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1846 struct scsi_device *sdev = req->q->queuedata;
1847 struct Scsi_Host *shost = sdev->host;
1848 unsigned char *sense_buf = cmd->sense_buffer;
1849 struct scatterlist *sg;
1850
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001851 /* zero out the cmd, except for the embedded scsi_request */
1852 memset((char *)cmd + sizeof(cmd->req), 0,
1853 sizeof(*cmd) - sizeof(cmd->req));
Christoph Hellwigd2852032014-01-17 12:06:53 +01001854
1855 req->special = cmd;
1856
1857 cmd->request = req;
1858 cmd->device = sdev;
1859 cmd->sense_buffer = sense_buf;
1860
1861 cmd->tag = req->tag;
1862
Christoph Hellwigd2852032014-01-17 12:06:53 +01001863 cmd->prot_op = SCSI_PROT_NORMAL;
1864
1865 INIT_LIST_HEAD(&cmd->list);
1866 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1867 cmd->jiffies_at_alloc = jiffies;
1868
Kashyap.Desai@avagotech.com64bdcbc2014-08-20 19:24:33 +05301869 if (shost->use_cmd_list) {
1870 spin_lock_irq(&sdev->list_lock);
1871 list_add_tail(&cmd->list, &sdev->cmd_list);
1872 spin_unlock_irq(&sdev->list_lock);
1873 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001874
1875 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1876 cmd->sdb.table.sgl = sg;
1877
1878 if (scsi_host_get_prot(shost)) {
1879 cmd->prot_sdb = (void *)sg +
Tony Battersby120bb3e2014-12-08 17:20:52 -05001880 min_t(unsigned int,
Ming Lin65e86172016-04-04 14:48:10 -07001881 shost->sg_tablesize, SG_CHUNK_SIZE) *
Tony Battersby120bb3e2014-12-08 17:20:52 -05001882 sizeof(struct scatterlist);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001883 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1884
1885 cmd->prot_sdb->table.sgl =
1886 (struct scatterlist *)(cmd->prot_sdb + 1);
1887 }
1888
1889 if (blk_bidi_rq(req)) {
1890 struct request *next_rq = req->next_rq;
1891 struct scsi_data_buffer *bidi_sdb = blk_mq_rq_to_pdu(next_rq);
1892
1893 memset(bidi_sdb, 0, sizeof(struct scsi_data_buffer));
1894 bidi_sdb->table.sgl =
1895 (struct scatterlist *)(bidi_sdb + 1);
1896
1897 next_rq->special = bidi_sdb;
1898 }
1899
Christoph Hellwigfe052522014-09-22 15:59:31 +02001900 blk_mq_start_request(req);
1901
Christoph Hellwigd2852032014-01-17 12:06:53 +01001902 return scsi_setup_cmnd(sdev, req);
1903}
1904
1905static void scsi_mq_done(struct scsi_cmnd *cmd)
1906{
1907 trace_scsi_dispatch_cmd_done(cmd);
Christoph Hellwig08e00292017-04-20 16:03:09 +02001908 blk_mq_complete_request(cmd->request);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001909}
1910
Jens Axboe74c45052014-10-29 11:14:52 -06001911static int scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1912 const struct blk_mq_queue_data *bd)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001913{
Jens Axboe74c45052014-10-29 11:14:52 -06001914 struct request *req = bd->rq;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001915 struct request_queue *q = req->q;
1916 struct scsi_device *sdev = q->queuedata;
1917 struct Scsi_Host *shost = sdev->host;
1918 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1919 int ret;
1920 int reason;
1921
1922 ret = prep_to_mq(scsi_prep_state_check(sdev, req));
Omar Sandoval2868f132016-11-15 11:11:59 -08001923 if (ret != BLK_MQ_RQ_QUEUE_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001924 goto out;
1925
1926 ret = BLK_MQ_RQ_QUEUE_BUSY;
1927 if (!get_device(&sdev->sdev_gendev))
1928 goto out;
1929
1930 if (!scsi_dev_queue_ready(q, sdev))
1931 goto out_put_device;
1932 if (!scsi_target_queue_ready(shost, sdev))
1933 goto out_dec_device_busy;
1934 if (!scsi_host_queue_ready(q, shost, sdev))
1935 goto out_dec_target_busy;
1936
Christoph Hellwige8064022016-10-20 15:12:13 +02001937 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001938 ret = prep_to_mq(scsi_mq_prep_fn(req));
Omar Sandoval2868f132016-11-15 11:11:59 -08001939 if (ret != BLK_MQ_RQ_QUEUE_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001940 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001941 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001942 } else {
1943 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001944 }
1945
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001946 if (sdev->simple_tags)
1947 cmd->flags |= SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001948 else
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001949 cmd->flags &= ~SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001950
Christoph Hellwigd2852032014-01-17 12:06:53 +01001951 scsi_init_cmd_errh(cmd);
1952 cmd->scsi_done = scsi_mq_done;
1953
1954 reason = scsi_dispatch_cmd(cmd);
1955 if (reason) {
1956 scsi_set_blocked(cmd, reason);
1957 ret = BLK_MQ_RQ_QUEUE_BUSY;
1958 goto out_dec_host_busy;
1959 }
1960
1961 return BLK_MQ_RQ_QUEUE_OK;
1962
1963out_dec_host_busy:
1964 atomic_dec(&shost->host_busy);
1965out_dec_target_busy:
1966 if (scsi_target(sdev)->can_queue > 0)
1967 atomic_dec(&scsi_target(sdev)->target_busy);
1968out_dec_device_busy:
1969 atomic_dec(&sdev->device_busy);
1970out_put_device:
1971 put_device(&sdev->sdev_gendev);
1972out:
1973 switch (ret) {
1974 case BLK_MQ_RQ_QUEUE_BUSY:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001975 if (atomic_read(&sdev->device_busy) == 0 &&
1976 !scsi_device_blocked(sdev))
Bart Van Assche36e3cf22017-04-07 11:16:53 -07001977 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001978 break;
1979 case BLK_MQ_RQ_QUEUE_ERROR:
1980 /*
1981 * Make sure to release all allocated ressources when
1982 * we hit an error, as we will never see this command
1983 * again.
1984 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001985 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001986 scsi_mq_uninit_cmd(cmd);
1987 break;
1988 default:
1989 break;
1990 }
1991 return ret;
1992}
1993
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001994static enum blk_eh_timer_return scsi_timeout(struct request *req,
1995 bool reserved)
1996{
1997 if (reserved)
1998 return BLK_EH_RESET_TIMER;
1999 return scsi_times_out(req);
2000}
2001
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002002static int scsi_init_request(struct blk_mq_tag_set *set, struct request *rq,
2003 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002004{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002005 struct Scsi_Host *shost = set->driver_data;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002006 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2007
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002008 cmd->sense_buffer =
2009 scsi_alloc_sense_buffer(shost, GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002010 if (!cmd->sense_buffer)
2011 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002012 cmd->req.sense = cmd->sense_buffer;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002013 return 0;
2014}
2015
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002016static void scsi_exit_request(struct blk_mq_tag_set *set, struct request *rq,
2017 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002018{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002019 struct Scsi_Host *shost = set->driver_data;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002020 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2021
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002022 scsi_free_sense_buffer(shost, cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002023}
2024
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002025static int scsi_map_queues(struct blk_mq_tag_set *set)
2026{
2027 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
2028
2029 if (shost->hostt->map_queues)
2030 return shost->hostt->map_queues(shost);
2031 return blk_mq_map_queues(set);
2032}
2033
Christoph Hellwigf1bea552014-04-15 12:26:54 +02002034static u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035{
2036 struct device *host_dev;
2037 u64 bounce_limit = 0xffffffff;
2038
2039 if (shost->unchecked_isa_dma)
2040 return BLK_BOUNCE_ISA;
2041 /*
2042 * Platforms with virtual-DMA translation
2043 * hardware have no practical limit.
2044 */
2045 if (!PCI_DMA_BUS_IS_PHYS)
2046 return BLK_BOUNCE_ANY;
2047
2048 host_dev = scsi_get_device(shost);
2049 if (host_dev && host_dev->dma_mask)
Russell Kinge83b3662014-02-11 17:11:04 +00002050 bounce_limit = (u64)dma_max_pfn(host_dev) << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051
2052 return bounce_limit;
2053}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002055void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056{
Lin Ming6f381fa2012-04-12 13:50:38 +08002057 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058
Jens Axboea8474ce2007-08-07 09:02:51 +02002059 /*
2060 * this limit is imposed by hardware restrictions
2061 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05002062 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07002063 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02002064
Martin K. Petersen13f05c82010-09-10 20:50:10 +02002065 if (scsi_host_prot_dma(shost)) {
2066 shost->sg_prot_tablesize =
2067 min_not_zero(shost->sg_prot_tablesize,
2068 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
2069 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
2070 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
2071 }
2072
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05002073 blk_queue_max_hw_sectors(q, shost->max_sectors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
2075 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08002076 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077
FUJITA Tomonori860ac562008-02-04 22:28:05 -08002078 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
2079
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01002081 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06002082
2083 /*
2084 * set a reasonable default alignment on word boundaries: the
2085 * host and device may alter it using
2086 * blk_queue_update_dma_alignment() later.
2087 */
2088 blk_queue_dma_alignment(q, 0x03);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002089}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002090EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06002091
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002092static int scsi_init_rq(struct request_queue *q, struct request *rq, gfp_t gfp)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002093{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002094 struct Scsi_Host *shost = q->rq_alloc_data;
2095 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002096
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002097 memset(cmd, 0, sizeof(*cmd));
2098
2099 cmd->sense_buffer = scsi_alloc_sense_buffer(shost, gfp, NUMA_NO_NODE);
2100 if (!cmd->sense_buffer)
2101 goto fail;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002102 cmd->req.sense = cmd->sense_buffer;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002103
2104 if (scsi_host_get_prot(shost) >= SHOST_DIX_TYPE0_PROTECTION) {
2105 cmd->prot_sdb = kmem_cache_zalloc(scsi_sdb_cache, gfp);
2106 if (!cmd->prot_sdb)
2107 goto fail_free_sense;
2108 }
2109
2110 return 0;
2111
2112fail_free_sense:
2113 scsi_free_sense_buffer(shost, cmd->sense_buffer);
2114fail:
2115 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116}
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002117
2118static void scsi_exit_rq(struct request_queue *q, struct request *rq)
2119{
2120 struct Scsi_Host *shost = q->rq_alloc_data;
2121 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2122
2123 if (cmd->prot_sdb)
2124 kmem_cache_free(scsi_sdb_cache, cmd->prot_sdb);
2125 scsi_free_sense_buffer(shost, cmd->sense_buffer);
2126}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002127
2128struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
2129{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002130 struct Scsi_Host *shost = sdev->host;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002131 struct request_queue *q;
2132
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002133 q = blk_alloc_queue_node(GFP_KERNEL, NUMA_NO_NODE);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002134 if (!q)
2135 return NULL;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002136 q->cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
2137 q->rq_alloc_data = shost;
2138 q->request_fn = scsi_request_fn;
2139 q->init_rq_fn = scsi_init_rq;
2140 q->exit_rq_fn = scsi_exit_rq;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002141
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002142 if (blk_init_allocated_queue(q) < 0) {
2143 blk_cleanup_queue(q);
2144 return NULL;
2145 }
2146
2147 __scsi_init_queue(shost, q);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002148 blk_queue_prep_rq(q, scsi_prep_fn);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02002149 blk_queue_unprep_rq(q, scsi_unprep_fn);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002150 blk_queue_softirq_done(q, scsi_softirq_done);
Jens Axboe242f9dc2008-09-14 05:55:09 -07002151 blk_queue_rq_timed_out(q, scsi_times_out);
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04002152 blk_queue_lld_busy(q, scsi_lld_busy);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002153 return q;
2154}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155
Eric Biggersf363b082017-03-30 13:39:16 -07002156static const struct blk_mq_ops scsi_mq_ops = {
Christoph Hellwigd2852032014-01-17 12:06:53 +01002157 .queue_rq = scsi_queue_rq,
2158 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07002159 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07002160#ifdef CONFIG_BLK_DEBUG_FS
2161 .show_rq = scsi_show_rq,
2162#endif
Christoph Hellwigd2852032014-01-17 12:06:53 +01002163 .init_request = scsi_init_request,
2164 .exit_request = scsi_exit_request,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002165 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01002166};
2167
2168struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
2169{
2170 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
2171 if (IS_ERR(sdev->request_queue))
2172 return NULL;
2173
2174 sdev->request_queue->queuedata = sdev;
2175 __scsi_init_queue(sdev->host, sdev->request_queue);
2176 return sdev->request_queue;
2177}
2178
2179int scsi_mq_setup_tags(struct Scsi_Host *shost)
2180{
2181 unsigned int cmd_size, sgl_size, tbl_size;
2182
2183 tbl_size = shost->sg_tablesize;
Ming Lin65e86172016-04-04 14:48:10 -07002184 if (tbl_size > SG_CHUNK_SIZE)
2185 tbl_size = SG_CHUNK_SIZE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002186 sgl_size = tbl_size * sizeof(struct scatterlist);
2187 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
2188 if (scsi_host_get_prot(shost))
2189 cmd_size += sizeof(struct scsi_data_buffer) + sgl_size;
2190
2191 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
2192 shost->tag_set.ops = &scsi_mq_ops;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01002193 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002194 shost->tag_set.queue_depth = shost->can_queue;
2195 shost->tag_set.cmd_size = cmd_size;
2196 shost->tag_set.numa_node = NUMA_NO_NODE;
2197 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07002198 shost->tag_set.flags |=
2199 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002200 shost->tag_set.driver_data = shost;
2201
2202 return blk_mq_alloc_tag_set(&shost->tag_set);
2203}
2204
2205void scsi_mq_destroy_tags(struct Scsi_Host *shost)
2206{
2207 blk_mq_free_tag_set(&shost->tag_set);
2208}
2209
Hannes Reinecke857de6e2017-02-17 09:02:45 +01002210/**
2211 * scsi_device_from_queue - return sdev associated with a request_queue
2212 * @q: The request queue to return the sdev from
2213 *
2214 * Return the sdev associated with a request queue or NULL if the
2215 * request_queue does not reference a SCSI device.
2216 */
2217struct scsi_device *scsi_device_from_queue(struct request_queue *q)
2218{
2219 struct scsi_device *sdev = NULL;
2220
2221 if (q->mq_ops) {
2222 if (q->mq_ops == &scsi_mq_ops)
2223 sdev = q->queuedata;
2224 } else if (q->request_fn == scsi_request_fn)
2225 sdev = q->queuedata;
2226 if (!sdev || !get_device(&sdev->sdev_gendev))
2227 sdev = NULL;
2228
2229 return sdev;
2230}
2231EXPORT_SYMBOL_GPL(scsi_device_from_queue);
2232
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233/*
2234 * Function: scsi_block_requests()
2235 *
2236 * Purpose: Utility function used by low-level drivers to prevent further
2237 * commands from being queued to the device.
2238 *
2239 * Arguments: shost - Host in question
2240 *
2241 * Returns: Nothing
2242 *
2243 * Lock status: No locks are assumed held.
2244 *
2245 * Notes: There is no timer nor any other means by which the requests
2246 * get unblocked other than the low-level driver calling
2247 * scsi_unblock_requests().
2248 */
2249void scsi_block_requests(struct Scsi_Host *shost)
2250{
2251 shost->host_self_blocked = 1;
2252}
2253EXPORT_SYMBOL(scsi_block_requests);
2254
2255/*
2256 * Function: scsi_unblock_requests()
2257 *
2258 * Purpose: Utility function used by low-level drivers to allow further
2259 * commands from being queued to the device.
2260 *
2261 * Arguments: shost - Host in question
2262 *
2263 * Returns: Nothing
2264 *
2265 * Lock status: No locks are assumed held.
2266 *
2267 * Notes: There is no timer nor any other means by which the requests
2268 * get unblocked other than the low-level driver calling
2269 * scsi_unblock_requests().
2270 *
2271 * This is done as an API function so that changes to the
2272 * internals of the scsi mid-layer won't require wholesale
2273 * changes to drivers that use this feature.
2274 */
2275void scsi_unblock_requests(struct Scsi_Host *shost)
2276{
2277 shost->host_self_blocked = 0;
2278 scsi_run_host_queues(shost);
2279}
2280EXPORT_SYMBOL(scsi_unblock_requests);
2281
2282int __init scsi_init_queue(void)
2283{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002284 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
2285 sizeof(struct scsi_data_buffer),
2286 0, 0, NULL);
2287 if (!scsi_sdb_cache) {
2288 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09002289 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02002290 }
2291
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 return 0;
2293}
2294
2295void scsi_exit_queue(void)
2296{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002297 kmem_cache_destroy(scsi_sense_cache);
2298 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002299 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300}
James Bottomley5baba832006-03-18 14:10:35 -06002301
2302/**
2303 * scsi_mode_select - issue a mode select
2304 * @sdev: SCSI device to be queried
2305 * @pf: Page format bit (1 == standard, 0 == vendor specific)
2306 * @sp: Save page bit (0 == don't save, 1 == save)
2307 * @modepage: mode page being requested
2308 * @buffer: request buffer (may not be smaller than eight bytes)
2309 * @len: length of request buffer.
2310 * @timeout: command timeout
2311 * @retries: number of retries before failing
2312 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002313 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06002314 * must be SCSI_SENSE_BUFFERSIZE big.
2315 *
2316 * Returns zero if successful; negative error number or scsi
2317 * status on error
2318 *
2319 */
2320int
2321scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2322 unsigned char *buffer, int len, int timeout, int retries,
2323 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2324{
2325 unsigned char cmd[10];
2326 unsigned char *real_buffer;
2327 int ret;
2328
2329 memset(cmd, 0, sizeof(cmd));
2330 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2331
2332 if (sdev->use_10_for_ms) {
2333 if (len > 65535)
2334 return -EINVAL;
2335 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2336 if (!real_buffer)
2337 return -ENOMEM;
2338 memcpy(real_buffer + 8, buffer, len);
2339 len += 8;
2340 real_buffer[0] = 0;
2341 real_buffer[1] = 0;
2342 real_buffer[2] = data->medium_type;
2343 real_buffer[3] = data->device_specific;
2344 real_buffer[4] = data->longlba ? 0x01 : 0;
2345 real_buffer[5] = 0;
2346 real_buffer[6] = data->block_descriptor_length >> 8;
2347 real_buffer[7] = data->block_descriptor_length;
2348
2349 cmd[0] = MODE_SELECT_10;
2350 cmd[7] = len >> 8;
2351 cmd[8] = len;
2352 } else {
2353 if (len > 255 || data->block_descriptor_length > 255 ||
2354 data->longlba)
2355 return -EINVAL;
2356
2357 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2358 if (!real_buffer)
2359 return -ENOMEM;
2360 memcpy(real_buffer + 4, buffer, len);
2361 len += 4;
2362 real_buffer[0] = 0;
2363 real_buffer[1] = data->medium_type;
2364 real_buffer[2] = data->device_specific;
2365 real_buffer[3] = data->block_descriptor_length;
2366
2367
2368 cmd[0] = MODE_SELECT;
2369 cmd[4] = len;
2370 }
2371
2372 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002373 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002374 kfree(real_buffer);
2375 return ret;
2376}
2377EXPORT_SYMBOL_GPL(scsi_mode_select);
2378
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379/**
Rob Landleyeb448202007-11-03 13:30:39 -05002380 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002381 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 * @dbd: set if mode sense will allow block descriptors to be returned
2383 * @modepage: mode page being requested
2384 * @buffer: request buffer (may not be smaller than eight bytes)
2385 * @len: length of request buffer.
2386 * @timeout: command timeout
2387 * @retries: number of retries before failing
2388 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002389 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002390 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391 *
2392 * Returns zero if unsuccessful, or the header offset (either 4
2393 * or 8 depending on whether a six or ten byte command was
2394 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002395 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396int
James Bottomley1cf72692005-08-28 11:27:01 -05002397scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002399 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2400{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401 unsigned char cmd[12];
2402 int use_10_for_ms;
2403 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002404 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002405 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406
2407 memset(data, 0, sizeof(*data));
2408 memset(&cmd[0], 0, 12);
2409 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2410 cmd[2] = modepage;
2411
James Bottomleyea73a9f2005-08-28 11:33:52 -05002412 /* caller might not be interested in sense, but we need it */
2413 if (!sshdr)
2414 sshdr = &my_sshdr;
2415
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002417 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418
2419 if (use_10_for_ms) {
2420 if (len < 8)
2421 len = 8;
2422
2423 cmd[0] = MODE_SENSE_10;
2424 cmd[8] = len;
2425 header_length = 8;
2426 } else {
2427 if (len < 4)
2428 len = 4;
2429
2430 cmd[0] = MODE_SENSE;
2431 cmd[4] = len;
2432 header_length = 4;
2433 }
2434
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435 memset(buffer, 0, len);
2436
James Bottomley1cf72692005-08-28 11:27:01 -05002437 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002438 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439
2440 /* This code looks awful: what it's doing is making sure an
2441 * ILLEGAL REQUEST sense return identifies the actual command
2442 * byte as the problem. MODE_SENSE commands can return
2443 * ILLEGAL REQUEST if the code page isn't supported */
2444
James Bottomley1cf72692005-08-28 11:27:01 -05002445 if (use_10_for_ms && !scsi_status_is_good(result) &&
2446 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002447 if (scsi_sense_valid(sshdr)) {
2448 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2449 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 /*
2451 * Invalid command operation code
2452 */
James Bottomley1cf72692005-08-28 11:27:01 -05002453 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454 goto retry;
2455 }
2456 }
2457 }
2458
James Bottomley1cf72692005-08-28 11:27:01 -05002459 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002460 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2461 (modepage == 6 || modepage == 8))) {
2462 /* Initio breakage? */
2463 header_length = 0;
2464 data->length = 13;
2465 data->medium_type = 0;
2466 data->device_specific = 0;
2467 data->longlba = 0;
2468 data->block_descriptor_length = 0;
2469 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470 data->length = buffer[0]*256 + buffer[1] + 2;
2471 data->medium_type = buffer[2];
2472 data->device_specific = buffer[3];
2473 data->longlba = buffer[4] & 0x01;
2474 data->block_descriptor_length = buffer[6]*256
2475 + buffer[7];
2476 } else {
2477 data->length = buffer[0] + 1;
2478 data->medium_type = buffer[1];
2479 data->device_specific = buffer[2];
2480 data->block_descriptor_length = buffer[3];
2481 }
Al Viro6d73c852006-02-23 02:03:16 +01002482 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002483 } else if ((status_byte(result) == CHECK_CONDITION) &&
2484 scsi_sense_valid(sshdr) &&
2485 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2486 retry_count--;
2487 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488 }
2489
James Bottomley1cf72692005-08-28 11:27:01 -05002490 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491}
2492EXPORT_SYMBOL(scsi_mode_sense);
2493
James Bottomley001aac22007-12-02 19:10:40 +02002494/**
2495 * scsi_test_unit_ready - test if unit is ready
2496 * @sdev: scsi device to change the state of.
2497 * @timeout: command timeout
2498 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002499 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002500 *
2501 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002502 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002503 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504int
James Bottomley001aac22007-12-02 19:10:40 +02002505scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002506 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508 char cmd[] = {
2509 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2510 };
2511 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002512
James Bottomley001aac22007-12-02 19:10:40 +02002513 /* try to eat the UNIT_ATTENTION if there are enough retries */
2514 do {
2515 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002516 timeout, retries, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002517 if (sdev->removable && scsi_sense_valid(sshdr) &&
2518 sshdr->sense_key == UNIT_ATTENTION)
2519 sdev->changed = 1;
2520 } while (scsi_sense_valid(sshdr) &&
2521 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002522
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523 return result;
2524}
2525EXPORT_SYMBOL(scsi_test_unit_ready);
2526
2527/**
Rob Landleyeb448202007-11-03 13:30:39 -05002528 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529 * @sdev: scsi device to change the state of.
2530 * @state: state to change to.
2531 *
2532 * Returns zero if unsuccessful or an error if the requested
2533 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002534 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535int
2536scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2537{
2538 enum scsi_device_state oldstate = sdev->sdev_state;
2539
2540 if (state == oldstate)
2541 return 0;
2542
2543 switch (state) {
2544 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002545 switch (oldstate) {
2546 case SDEV_CREATED_BLOCK:
2547 break;
2548 default:
2549 goto illegal;
2550 }
2551 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002552
2553 case SDEV_RUNNING:
2554 switch (oldstate) {
2555 case SDEV_CREATED:
2556 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002557 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558 case SDEV_QUIESCE:
2559 case SDEV_BLOCK:
2560 break;
2561 default:
2562 goto illegal;
2563 }
2564 break;
2565
2566 case SDEV_QUIESCE:
2567 switch (oldstate) {
2568 case SDEV_RUNNING:
2569 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002570 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571 break;
2572 default:
2573 goto illegal;
2574 }
2575 break;
2576
2577 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002578 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 switch (oldstate) {
2580 case SDEV_CREATED:
2581 case SDEV_RUNNING:
2582 case SDEV_QUIESCE:
2583 case SDEV_BLOCK:
2584 break;
2585 default:
2586 goto illegal;
2587 }
2588 break;
2589
2590 case SDEV_BLOCK:
2591 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002593 case SDEV_CREATED_BLOCK:
2594 break;
2595 default:
2596 goto illegal;
2597 }
2598 break;
2599
2600 case SDEV_CREATED_BLOCK:
2601 switch (oldstate) {
2602 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 break;
2604 default:
2605 goto illegal;
2606 }
2607 break;
2608
2609 case SDEV_CANCEL:
2610 switch (oldstate) {
2611 case SDEV_CREATED:
2612 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002613 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002615 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616 case SDEV_BLOCK:
2617 break;
2618 default:
2619 goto illegal;
2620 }
2621 break;
2622
2623 case SDEV_DEL:
2624 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002625 case SDEV_CREATED:
2626 case SDEV_RUNNING:
2627 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002628 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629 case SDEV_CANCEL:
Bart Van Assche0516c082013-07-02 15:06:33 +02002630 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631 break;
2632 default:
2633 goto illegal;
2634 }
2635 break;
2636
2637 }
2638 sdev->sdev_state = state;
2639 return 0;
2640
2641 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002642 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002643 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002644 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002645 scsi_device_state_name(oldstate),
2646 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647 );
2648 return -EINVAL;
2649}
2650EXPORT_SYMBOL(scsi_device_set_state);
2651
2652/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002653 * sdev_evt_emit - emit a single SCSI device uevent
2654 * @sdev: associated SCSI device
2655 * @evt: event to emit
2656 *
2657 * Send a single uevent (scsi_event) to the associated scsi_device.
2658 */
2659static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2660{
2661 int idx = 0;
2662 char *envp[3];
2663
2664 switch (evt->evt_type) {
2665 case SDEV_EVT_MEDIA_CHANGE:
2666 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2667 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002668 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002669 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002670 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2671 break;
2672 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2673 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2674 break;
2675 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2676 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2677 break;
2678 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2679 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2680 break;
2681 case SDEV_EVT_LUN_CHANGE_REPORTED:
2682 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2683 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002684 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2685 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2686 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002687 default:
2688 /* do nothing */
2689 break;
2690 }
2691
2692 envp[idx++] = NULL;
2693
2694 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2695}
2696
2697/**
2698 * sdev_evt_thread - send a uevent for each scsi event
2699 * @work: work struct for scsi_device
2700 *
2701 * Dispatch queued events to their associated scsi_device kobjects
2702 * as uevents.
2703 */
2704void scsi_evt_thread(struct work_struct *work)
2705{
2706 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002707 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002708 LIST_HEAD(event_list);
2709
2710 sdev = container_of(work, struct scsi_device, event_work);
2711
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002712 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2713 if (test_and_clear_bit(evt_type, sdev->pending_events))
2714 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2715
Jeff Garzika341cd02007-10-29 17:15:22 -04002716 while (1) {
2717 struct scsi_event *evt;
2718 struct list_head *this, *tmp;
2719 unsigned long flags;
2720
2721 spin_lock_irqsave(&sdev->list_lock, flags);
2722 list_splice_init(&sdev->event_list, &event_list);
2723 spin_unlock_irqrestore(&sdev->list_lock, flags);
2724
2725 if (list_empty(&event_list))
2726 break;
2727
2728 list_for_each_safe(this, tmp, &event_list) {
2729 evt = list_entry(this, struct scsi_event, node);
2730 list_del(&evt->node);
2731 scsi_evt_emit(sdev, evt);
2732 kfree(evt);
2733 }
2734 }
2735}
2736
2737/**
2738 * sdev_evt_send - send asserted event to uevent thread
2739 * @sdev: scsi_device event occurred on
2740 * @evt: event to send
2741 *
2742 * Assert scsi device event asynchronously.
2743 */
2744void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2745{
2746 unsigned long flags;
2747
Kay Sievers4d1566e2008-03-19 13:04:47 +01002748#if 0
2749 /* FIXME: currently this check eliminates all media change events
2750 * for polled devices. Need to update to discriminate between AN
2751 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002752 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2753 kfree(evt);
2754 return;
2755 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002756#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002757
2758 spin_lock_irqsave(&sdev->list_lock, flags);
2759 list_add_tail(&evt->node, &sdev->event_list);
2760 schedule_work(&sdev->event_work);
2761 spin_unlock_irqrestore(&sdev->list_lock, flags);
2762}
2763EXPORT_SYMBOL_GPL(sdev_evt_send);
2764
2765/**
2766 * sdev_evt_alloc - allocate a new scsi event
2767 * @evt_type: type of event to allocate
2768 * @gfpflags: GFP flags for allocation
2769 *
2770 * Allocates and returns a new scsi_event.
2771 */
2772struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2773 gfp_t gfpflags)
2774{
2775 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2776 if (!evt)
2777 return NULL;
2778
2779 evt->evt_type = evt_type;
2780 INIT_LIST_HEAD(&evt->node);
2781
2782 /* evt_type-specific initialization, if any */
2783 switch (evt_type) {
2784 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002785 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2786 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2787 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2788 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2789 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002790 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002791 default:
2792 /* do nothing */
2793 break;
2794 }
2795
2796 return evt;
2797}
2798EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2799
2800/**
2801 * sdev_evt_send_simple - send asserted event to uevent thread
2802 * @sdev: scsi_device event occurred on
2803 * @evt_type: type of event to send
2804 * @gfpflags: GFP flags for allocation
2805 *
2806 * Assert scsi device event asynchronously, given an event type.
2807 */
2808void sdev_evt_send_simple(struct scsi_device *sdev,
2809 enum scsi_device_event evt_type, gfp_t gfpflags)
2810{
2811 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2812 if (!evt) {
2813 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2814 evt_type);
2815 return;
2816 }
2817
2818 sdev_evt_send(sdev, evt);
2819}
2820EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2821
2822/**
Bart Van Assche669f0442016-11-22 16:17:13 -08002823 * scsi_request_fn_active() - number of kernel threads inside scsi_request_fn()
2824 * @sdev: SCSI device to count the number of scsi_request_fn() callers for.
2825 */
2826static int scsi_request_fn_active(struct scsi_device *sdev)
2827{
2828 struct request_queue *q = sdev->request_queue;
2829 int request_fn_active;
2830
2831 WARN_ON_ONCE(sdev->host->use_blk_mq);
2832
2833 spin_lock_irq(q->queue_lock);
2834 request_fn_active = q->request_fn_active;
2835 spin_unlock_irq(q->queue_lock);
2836
2837 return request_fn_active;
2838}
2839
2840/**
2841 * scsi_wait_for_queuecommand() - wait for ongoing queuecommand() calls
2842 * @sdev: SCSI device pointer.
2843 *
2844 * Wait until the ongoing shost->hostt->queuecommand() calls that are
2845 * invoked from scsi_request_fn() have finished.
2846 */
2847static void scsi_wait_for_queuecommand(struct scsi_device *sdev)
2848{
2849 WARN_ON_ONCE(sdev->host->use_blk_mq);
2850
2851 while (scsi_request_fn_active(sdev))
2852 msleep(20);
2853}
2854
2855/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002856 * scsi_device_quiesce - Block user issued commands.
2857 * @sdev: scsi device to quiesce.
2858 *
2859 * This works by trying to transition to the SDEV_QUIESCE state
2860 * (which must be a legal transition). When the device is in this
2861 * state, only special requests will be accepted, all others will
2862 * be deferred. Since special requests may also be requeued requests,
2863 * a successful return doesn't guarantee the device will be
2864 * totally quiescent.
2865 *
2866 * Must be called with user context, may sleep.
2867 *
2868 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002869 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870int
2871scsi_device_quiesce(struct scsi_device *sdev)
2872{
2873 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2874 if (err)
2875 return err;
2876
2877 scsi_run_queue(sdev->request_queue);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02002878 while (atomic_read(&sdev->device_busy)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002879 msleep_interruptible(200);
2880 scsi_run_queue(sdev->request_queue);
2881 }
2882 return 0;
2883}
2884EXPORT_SYMBOL(scsi_device_quiesce);
2885
2886/**
2887 * scsi_device_resume - Restart user issued commands to a quiesced device.
2888 * @sdev: scsi device to resume.
2889 *
2890 * Moves the device from quiesced back to running and restarts the
2891 * queues.
2892 *
2893 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002894 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002895void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002896{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002897 /* check if the device state was mutated prior to resume, and if
2898 * so assume the state is being managed elsewhere (for example
2899 * device deleted during suspend)
2900 */
2901 if (sdev->sdev_state != SDEV_QUIESCE ||
2902 scsi_device_set_state(sdev, SDEV_RUNNING))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002903 return;
2904 scsi_run_queue(sdev->request_queue);
2905}
2906EXPORT_SYMBOL(scsi_device_resume);
2907
2908static void
2909device_quiesce_fn(struct scsi_device *sdev, void *data)
2910{
2911 scsi_device_quiesce(sdev);
2912}
2913
2914void
2915scsi_target_quiesce(struct scsi_target *starget)
2916{
2917 starget_for_each_device(starget, NULL, device_quiesce_fn);
2918}
2919EXPORT_SYMBOL(scsi_target_quiesce);
2920
2921static void
2922device_resume_fn(struct scsi_device *sdev, void *data)
2923{
2924 scsi_device_resume(sdev);
2925}
2926
2927void
2928scsi_target_resume(struct scsi_target *starget)
2929{
2930 starget_for_each_device(starget, NULL, device_resume_fn);
2931}
2932EXPORT_SYMBOL(scsi_target_resume);
2933
2934/**
Rob Landleyeb448202007-11-03 13:30:39 -05002935 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
Linus Torvalds1da177e2005-04-16 15:20:36 -07002936 * @sdev: device to block
Bart Van Assche8893cf62017-03-01 09:00:36 -08002937 * @wait: Whether or not to wait until ongoing .queuecommand() /
2938 * .queue_rq() calls have finished.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002939 *
2940 * Block request made by scsi lld's to temporarily stop all
Bart Van Assche669f0442016-11-22 16:17:13 -08002941 * scsi commands on the specified device. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942 *
2943 * Returns zero if successful or error if not
2944 *
2945 * Notes:
2946 * This routine transitions the device to the SDEV_BLOCK state
2947 * (which must be a legal transition). When the device is in this
2948 * state, all commands are deferred until the scsi lld reenables
2949 * the device with scsi_device_unblock or device_block_tmo fires.
Bart Van Assche669f0442016-11-22 16:17:13 -08002950 *
2951 * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
2952 * scsi_internal_device_block() has blocked a SCSI device and also
2953 * remove the rport mutex lock and unlock calls from srp_queuecommand().
Rob Landleyeb448202007-11-03 13:30:39 -05002954 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002955int
Bart Van Assche8893cf62017-03-01 09:00:36 -08002956scsi_internal_device_block(struct scsi_device *sdev, bool wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957{
Jens Axboe165125e2007-07-24 09:28:11 +02002958 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959 unsigned long flags;
2960 int err = 0;
2961
2962 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002963 if (err) {
2964 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2965
2966 if (err)
2967 return err;
2968 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002969
2970 /*
2971 * The device has transitioned to SDEV_BLOCK. Stop the
2972 * block layer from calling the midlayer with this device's
2973 * request queue.
2974 */
Christoph Hellwigd2852032014-01-17 12:06:53 +01002975 if (q->mq_ops) {
Bart Van Assche8893cf62017-03-01 09:00:36 -08002976 if (wait)
2977 blk_mq_quiesce_queue(q);
2978 else
2979 blk_mq_stop_hw_queues(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002980 } else {
2981 spin_lock_irqsave(q->queue_lock, flags);
2982 blk_stop_queue(q);
2983 spin_unlock_irqrestore(q->queue_lock, flags);
Bart Van Assche8893cf62017-03-01 09:00:36 -08002984 if (wait)
2985 scsi_wait_for_queuecommand(sdev);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002986 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987
2988 return 0;
2989}
2990EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2991
2992/**
2993 * scsi_internal_device_unblock - resume a device after a block request
2994 * @sdev: device to resume
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002995 * @new_state: state to set devices to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002996 *
2997 * Called by scsi lld's or the midlayer to restart the device queue
2998 * for the previously suspended scsi device. Called from interrupt or
2999 * normal process context.
3000 *
3001 * Returns zero if successful or error if not.
3002 *
3003 * Notes:
3004 * This routine transitions the device to the SDEV_RUNNING state
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003005 * or to one of the offline states (which must be a legal transition)
Mike Christied0754982012-05-17 23:56:58 -05003006 * allowing the midlayer to goose the queue for this device.
Rob Landleyeb448202007-11-03 13:30:39 -05003007 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008int
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003009scsi_internal_device_unblock(struct scsi_device *sdev,
3010 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011{
Jens Axboe165125e2007-07-24 09:28:11 +02003012 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013 unsigned long flags;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003014
3015 /*
3016 * Try to transition the scsi device to SDEV_RUNNING or one of the
3017 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018 */
Vikas Chaudhary0e580762012-08-09 04:51:30 -04003019 if ((sdev->sdev_state == SDEV_BLOCK) ||
3020 (sdev->sdev_state == SDEV_TRANSPORT_OFFLINE))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003021 sdev->sdev_state = new_state;
3022 else if (sdev->sdev_state == SDEV_CREATED_BLOCK) {
3023 if (new_state == SDEV_TRANSPORT_OFFLINE ||
3024 new_state == SDEV_OFFLINE)
3025 sdev->sdev_state = new_state;
3026 else
3027 sdev->sdev_state = SDEV_CREATED;
3028 } else if (sdev->sdev_state != SDEV_CANCEL &&
Mike Christie986fe6c2010-10-06 03:10:59 -05003029 sdev->sdev_state != SDEV_OFFLINE)
Takahiro Yasui5c10e632009-04-29 12:13:02 -04003030 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031
Christoph Hellwigd2852032014-01-17 12:06:53 +01003032 if (q->mq_ops) {
3033 blk_mq_start_stopped_hw_queues(q, false);
3034 } else {
3035 spin_lock_irqsave(q->queue_lock, flags);
3036 blk_start_queue(q);
3037 spin_unlock_irqrestore(q->queue_lock, flags);
3038 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003039
3040 return 0;
3041}
3042EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
3043
3044static void
3045device_block(struct scsi_device *sdev, void *data)
3046{
Bart Van Assche8893cf62017-03-01 09:00:36 -08003047 scsi_internal_device_block(sdev, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003048}
3049
3050static int
3051target_block(struct device *dev, void *data)
3052{
3053 if (scsi_is_target_device(dev))
3054 starget_for_each_device(to_scsi_target(dev), NULL,
3055 device_block);
3056 return 0;
3057}
3058
3059void
3060scsi_target_block(struct device *dev)
3061{
3062 if (scsi_is_target_device(dev))
3063 starget_for_each_device(to_scsi_target(dev), NULL,
3064 device_block);
3065 else
3066 device_for_each_child(dev, NULL, target_block);
3067}
3068EXPORT_SYMBOL_GPL(scsi_target_block);
3069
3070static void
3071device_unblock(struct scsi_device *sdev, void *data)
3072{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003073 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003074}
3075
3076static int
3077target_unblock(struct device *dev, void *data)
3078{
3079 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003080 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003081 device_unblock);
3082 return 0;
3083}
3084
3085void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003086scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003087{
3088 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003089 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003090 device_unblock);
3091 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003092 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003093}
3094EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003095
3096/**
3097 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05003098 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003099 * @sg_count: number of segments in sg
3100 * @offset: offset in bytes into sg, on return offset into the mapped area
3101 * @len: bytes to map, on return number of bytes mapped
3102 *
3103 * Returns virtual address of the start of the mapped page
3104 */
Jens Axboec6132da2007-10-16 11:08:49 +02003105void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003106 size_t *offset, size_t *len)
3107{
3108 int i;
3109 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02003110 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003111 struct page *page;
3112
Andrew Morton22cfefb2007-02-05 16:39:03 -08003113 WARN_ON(!irqs_disabled());
3114
Jens Axboec6132da2007-10-16 11:08:49 +02003115 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003116 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02003117 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003118 if (sg_len > *offset)
3119 break;
3120 }
3121
3122 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07003123 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
3124 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07003125 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003126 WARN_ON(1);
3127 return NULL;
3128 }
3129
3130 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02003131 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003132
3133 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02003134 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003135 *offset &= ~PAGE_MASK;
3136
3137 /* Bytes in this sg-entry from *offset to the end of the page */
3138 sg_len = PAGE_SIZE - *offset;
3139 if (*len > sg_len)
3140 *len = sg_len;
3141
Cong Wang77dfce02011-11-25 23:14:23 +08003142 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003143}
3144EXPORT_SYMBOL(scsi_kmap_atomic_sg);
3145
3146/**
Rob Landleyeb448202007-11-03 13:30:39 -05003147 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003148 * @virt: virtual address to be unmapped
3149 */
3150void scsi_kunmap_atomic_sg(void *virt)
3151{
Cong Wang77dfce02011-11-25 23:14:23 +08003152 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003153}
3154EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08003155
3156void sdev_disable_disk_events(struct scsi_device *sdev)
3157{
3158 atomic_inc(&sdev->disk_events_disable_depth);
3159}
3160EXPORT_SYMBOL(sdev_disable_disk_events);
3161
3162void sdev_enable_disk_events(struct scsi_device *sdev)
3163{
3164 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
3165 return;
3166 atomic_dec(&sdev->disk_events_disable_depth);
3167}
3168EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003169
3170/**
3171 * scsi_vpd_lun_id - return a unique device identification
3172 * @sdev: SCSI device
3173 * @id: buffer for the identification
3174 * @id_len: length of the buffer
3175 *
3176 * Copies a unique device identification into @id based
3177 * on the information in the VPD page 0x83 of the device.
3178 * The string will be formatted as a SCSI name string.
3179 *
3180 * Returns the length of the identification or error on failure.
3181 * If the identifier is longer than the supplied buffer the actual
3182 * identifier length is returned and the buffer is not zero-padded.
3183 */
3184int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
3185{
3186 u8 cur_id_type = 0xff;
3187 u8 cur_id_size = 0;
3188 unsigned char *d, *cur_id_str;
3189 unsigned char __rcu *vpd_pg83;
3190 int id_size = -EINVAL;
3191
3192 rcu_read_lock();
3193 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3194 if (!vpd_pg83) {
3195 rcu_read_unlock();
3196 return -ENXIO;
3197 }
3198
3199 /*
3200 * Look for the correct descriptor.
3201 * Order of preference for lun descriptor:
3202 * - SCSI name string
3203 * - NAA IEEE Registered Extended
3204 * - EUI-64 based 16-byte
3205 * - EUI-64 based 12-byte
3206 * - NAA IEEE Registered
3207 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02003208 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003209 * as longer descriptors reduce the likelyhood
3210 * of identification clashes.
3211 */
3212
3213 /* The id string must be at least 20 bytes + terminating NULL byte */
3214 if (id_len < 21) {
3215 rcu_read_unlock();
3216 return -EINVAL;
3217 }
3218
3219 memset(id, 0, id_len);
3220 d = vpd_pg83 + 4;
3221 while (d < vpd_pg83 + sdev->vpd_pg83_len) {
3222 /* Skip designators not referring to the LUN */
3223 if ((d[1] & 0x30) != 0x00)
3224 goto next_desig;
3225
3226 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02003227 case 0x1:
3228 /* T10 Vendor ID */
3229 if (cur_id_size > d[3])
3230 break;
3231 /* Prefer anything */
3232 if (cur_id_type > 0x01 && cur_id_type != 0xff)
3233 break;
3234 cur_id_size = d[3];
3235 if (cur_id_size + 4 > id_len)
3236 cur_id_size = id_len - 4;
3237 cur_id_str = d + 4;
3238 cur_id_type = d[1] & 0xf;
3239 id_size = snprintf(id, id_len, "t10.%*pE",
3240 cur_id_size, cur_id_str);
3241 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003242 case 0x2:
3243 /* EUI-64 */
3244 if (cur_id_size > d[3])
3245 break;
3246 /* Prefer NAA IEEE Registered Extended */
3247 if (cur_id_type == 0x3 &&
3248 cur_id_size == d[3])
3249 break;
3250 cur_id_size = d[3];
3251 cur_id_str = d + 4;
3252 cur_id_type = d[1] & 0xf;
3253 switch (cur_id_size) {
3254 case 8:
3255 id_size = snprintf(id, id_len,
3256 "eui.%8phN",
3257 cur_id_str);
3258 break;
3259 case 12:
3260 id_size = snprintf(id, id_len,
3261 "eui.%12phN",
3262 cur_id_str);
3263 break;
3264 case 16:
3265 id_size = snprintf(id, id_len,
3266 "eui.%16phN",
3267 cur_id_str);
3268 break;
3269 default:
3270 cur_id_size = 0;
3271 break;
3272 }
3273 break;
3274 case 0x3:
3275 /* NAA */
3276 if (cur_id_size > d[3])
3277 break;
3278 cur_id_size = d[3];
3279 cur_id_str = d + 4;
3280 cur_id_type = d[1] & 0xf;
3281 switch (cur_id_size) {
3282 case 8:
3283 id_size = snprintf(id, id_len,
3284 "naa.%8phN",
3285 cur_id_str);
3286 break;
3287 case 16:
3288 id_size = snprintf(id, id_len,
3289 "naa.%16phN",
3290 cur_id_str);
3291 break;
3292 default:
3293 cur_id_size = 0;
3294 break;
3295 }
3296 break;
3297 case 0x8:
3298 /* SCSI name string */
3299 if (cur_id_size + 4 > d[3])
3300 break;
3301 /* Prefer others for truncated descriptor */
3302 if (cur_id_size && d[3] > id_len)
3303 break;
3304 cur_id_size = id_size = d[3];
3305 cur_id_str = d + 4;
3306 cur_id_type = d[1] & 0xf;
3307 if (cur_id_size >= id_len)
3308 cur_id_size = id_len - 1;
3309 memcpy(id, cur_id_str, cur_id_size);
3310 /* Decrease priority for truncated descriptor */
3311 if (cur_id_size != id_size)
3312 cur_id_size = 6;
3313 break;
3314 default:
3315 break;
3316 }
3317next_desig:
3318 d += d[3] + 4;
3319 }
3320 rcu_read_unlock();
3321
3322 return id_size;
3323}
3324EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003325
3326/*
3327 * scsi_vpd_tpg_id - return a target port group identifier
3328 * @sdev: SCSI device
3329 *
3330 * Returns the Target Port Group identifier from the information
3331 * froom VPD page 0x83 of the device.
3332 *
3333 * Returns the identifier or error on failure.
3334 */
3335int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3336{
3337 unsigned char *d;
3338 unsigned char __rcu *vpd_pg83;
3339 int group_id = -EAGAIN, rel_port = -1;
3340
3341 rcu_read_lock();
3342 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3343 if (!vpd_pg83) {
3344 rcu_read_unlock();
3345 return -ENXIO;
3346 }
3347
3348 d = sdev->vpd_pg83 + 4;
3349 while (d < sdev->vpd_pg83 + sdev->vpd_pg83_len) {
3350 switch (d[1] & 0xf) {
3351 case 0x4:
3352 /* Relative target port */
3353 rel_port = get_unaligned_be16(&d[6]);
3354 break;
3355 case 0x5:
3356 /* Target port group */
3357 group_id = get_unaligned_be16(&d[6]);
3358 break;
3359 default:
3360 break;
3361 }
3362 d += d[3] + 4;
3363 }
3364 rcu_read_unlock();
3365
3366 if (group_id >= 0 && rel_id && rel_port != -1)
3367 *rel_id = rel_port;
3368
3369 return group_id;
3370}
3371EXPORT_SYMBOL(scsi_vpd_tpg_id);