blob: 550e29f903b746b121b2bb9daf3fce666243b451 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Christoph Hellwigd2852032014-01-17 12:06:53 +01002 * Copyright (C) 1999 Eric Youngdale
3 * Copyright (C) 2014 Christoph Hellwig
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 * SCSI queueing library.
6 * Initial versions: Eric Youngdale (eric@andante.org).
7 * Based upon conversations with large numbers
8 * of people at Linux Expo.
9 */
10
11#include <linux/bio.h>
James Bottomleyd3f46f32008-01-15 11:11:46 -060012#include <linux/bitops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/blkdev.h>
14#include <linux/completion.h>
15#include <linux/kernel.h>
Paul Gortmaker09703662011-05-27 09:37:25 -040016#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/init.h>
18#include <linux/pci.h>
19#include <linux/delay.h>
James Bottomleyfaead262006-02-14 10:42:07 -060020#include <linux/hardirq.h>
Jens Axboec6132da2007-10-16 11:08:49 +020021#include <linux/scatterlist.h>
Christoph Hellwigd2852032014-01-17 12:06:53 +010022#include <linux/blk-mq.h>
Hannes Reineckef1569ff2014-10-24 14:27:07 +020023#include <linux/ratelimit.h>
Hannes Reineckea8aa3972015-12-01 10:16:57 +010024#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020027#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <scsi/scsi_dbg.h>
29#include <scsi/scsi_device.h>
30#include <scsi/scsi_driver.h>
31#include <scsi/scsi_eh.h>
32#include <scsi/scsi_host.h>
Bart Van Assche7aa686d2017-05-02 10:45:03 -070033#include <scsi/scsi_transport.h> /* __scsi_init_queue() */
Christoph Hellwigee14c672015-08-27 14:16:59 +020034#include <scsi/scsi_dh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Christoph Hellwig3b5382c2014-05-06 12:25:40 +020036#include <trace/events/scsi.h>
37
Bart Van Assche0eebd002017-04-26 13:47:57 -070038#include "scsi_debugfs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include "scsi_priv.h"
40#include "scsi_logging.h"
41
Christoph Hellwige9c787e2017-01-02 21:55:26 +030042static struct kmem_cache *scsi_sdb_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030043static struct kmem_cache *scsi_sense_cache;
44static struct kmem_cache *scsi_sense_isadma_cache;
45static DEFINE_MUTEX(scsi_sense_cache_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030047static inline struct kmem_cache *
48scsi_select_sense_cache(struct Scsi_Host *shost)
49{
50 return shost->unchecked_isa_dma ?
51 scsi_sense_isadma_cache : scsi_sense_cache;
52}
53
Christoph Hellwige9c787e2017-01-02 21:55:26 +030054static void scsi_free_sense_buffer(struct Scsi_Host *shost,
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030055 unsigned char *sense_buffer)
56{
57 kmem_cache_free(scsi_select_sense_cache(shost), sense_buffer);
58}
59
Christoph Hellwige9c787e2017-01-02 21:55:26 +030060static unsigned char *scsi_alloc_sense_buffer(struct Scsi_Host *shost,
61 gfp_t gfp_mask, int numa_node)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030062{
63 return kmem_cache_alloc_node(scsi_select_sense_cache(shost), gfp_mask,
64 numa_node);
65}
66
67int scsi_init_sense_cache(struct Scsi_Host *shost)
68{
69 struct kmem_cache *cache;
70 int ret = 0;
71
72 cache = scsi_select_sense_cache(shost);
73 if (cache)
74 return 0;
75
76 mutex_lock(&scsi_sense_cache_mutex);
77 if (shost->unchecked_isa_dma) {
78 scsi_sense_isadma_cache =
79 kmem_cache_create("scsi_sense_cache(DMA)",
80 SCSI_SENSE_BUFFERSIZE, 0,
81 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
82 if (!scsi_sense_isadma_cache)
83 ret = -ENOMEM;
84 } else {
85 scsi_sense_cache =
86 kmem_cache_create("scsi_sense_cache",
87 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN, NULL);
88 if (!scsi_sense_cache)
89 ret = -ENOMEM;
90 }
91
92 mutex_unlock(&scsi_sense_cache_mutex);
93 return ret;
94}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +020095
Jens Axboea488e742010-04-16 21:13:15 +020096/*
97 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
98 * not change behaviour from the previous unplug mechanism, experimentation
99 * may prove this needs changing.
100 */
101#define SCSI_QUEUE_DELAY 3
102
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100103static void
104scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
106 struct Scsi_Host *host = cmd->device->host;
107 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500108 struct scsi_target *starget = scsi_target(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900111 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 *
113 * If the host/device isn't busy, assume that something actually
114 * completed, and that we should be able to queue a command now.
115 *
116 * Note that the prior mid-layer assumption that any host could
117 * always queue at least one command is now broken. The mid-layer
118 * will implement a user specifiable stall (see
119 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
120 * if a command is requeued with no other commands outstanding
121 * either for the device or for the host.
122 */
Mike Christief0c0a372008-08-17 15:24:38 -0500123 switch (reason) {
124 case SCSI_MLQUEUE_HOST_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100125 atomic_set(&host->host_blocked, host->max_host_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500126 break;
127 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400128 case SCSI_MLQUEUE_EH_RETRY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100129 atomic_set(&device->device_blocked,
130 device->max_device_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500131 break;
132 case SCSI_MLQUEUE_TARGET_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100133 atomic_set(&starget->target_blocked,
134 starget->max_target_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500135 break;
136 }
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100137}
138
Christoph Hellwigd2852032014-01-17 12:06:53 +0100139static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
140{
141 struct scsi_device *sdev = cmd->device;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100142
Bart Van Assche2b053ac2016-10-28 17:21:41 -0700143 blk_mq_requeue_request(cmd->request, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100144 put_device(&sdev->sdev_gendev);
145}
146
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100147/**
148 * __scsi_queue_insert - private queue insertion
149 * @cmd: The SCSI command being requeued
150 * @reason: The reason for the requeue
151 * @unbusy: Whether the queue should be unbusied
152 *
153 * This is a private queue insertion. The public interface
154 * scsi_queue_insert() always assumes the queue should be unbusied
155 * because it's always called before the completion. This function is
156 * for a requeue after completion, which should only occur in this
157 * file.
158 */
159static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
160{
161 struct scsi_device *device = cmd->device;
162 struct request_queue *q = device->request_queue;
163 unsigned long flags;
164
165 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
166 "Inserting command %p into mlqueue\n", cmd));
167
168 scsi_set_blocked(cmd, reason);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 * Decrement the counters, since these commands are no longer
172 * active on the host/device.
173 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600174 if (unbusy)
175 scsi_device_unbusy(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500178 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000179 * that are already in the queue. Schedule requeue work under
180 * lock such that the kblockd_schedule_work() call happens
181 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200182 */
Alan Stern644373a2014-03-28 10:51:15 -0700183 cmd->result = 0;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100184 if (q->mq_ops) {
185 scsi_mq_requeue_cmd(cmd);
186 return;
187 }
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500188 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley59897da2005-09-14 12:57:42 -0400189 blk_requeue_request(q, cmd->request);
Jens Axboe59c3d452014-04-08 09:15:35 -0600190 kblockd_schedule_work(&device->requeue_work);
Bart Van Asscheb4854622012-06-29 15:36:07 +0000191 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192}
193
James Bottomley4f5299a2009-01-02 10:42:21 -0600194/*
195 * Function: scsi_queue_insert()
196 *
197 * Purpose: Insert a command in the midlevel queue.
198 *
199 * Arguments: cmd - command that we are adding to queue.
200 * reason - why we are inserting command to queue.
201 *
202 * Lock status: Assumed that lock is not held upon entry.
203 *
204 * Returns: Nothing.
205 *
206 * Notes: We do this for one of two cases. Either the host is busy
207 * and it cannot accept any more commands for the time being,
208 * or the device returned QUEUE_FULL and can accept no more
209 * commands.
210 * Notes: This could be called either from an interrupt context or a
211 * normal process context.
212 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000213void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600214{
Bart Van Assche84feb162012-06-29 15:35:05 +0000215 __scsi_queue_insert(cmd, reason, 1);
James Bottomley4f5299a2009-01-02 10:42:21 -0600216}
Christoph Hellwige8064022016-10-20 15:12:13 +0200217
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100218
219/**
220 * scsi_execute - insert request and wait for the result
221 * @sdev: scsi device
222 * @cmd: scsi command
223 * @data_direction: data direction
224 * @buffer: data buffer
225 * @bufflen: len of buffer
226 * @sense: optional sense buffer
227 * @sshdr: optional decoded sense header
228 * @timeout: request timeout in seconds
229 * @retries: number of times to retry request
230 * @flags: flags for ->cmd_flags
231 * @rq_flags: flags for ->rq_flags
232 * @resid: optional residual length
233 *
Christoph Hellwig17d53632017-04-20 16:03:01 +0200234 * Returns the scsi_cmnd result field if a command was executed, or a negative
235 * Linux error code if we didn't get that far.
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100236 */
237int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500238 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100239 unsigned char *sense, struct scsi_sense_hdr *sshdr,
240 int timeout, int retries, u64 flags, req_flags_t rq_flags,
241 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500242{
243 struct request *req;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100244 struct scsi_request *rq;
James Bottomley39216032005-06-15 18:48:29 -0500245 int ret = DRIVER_ERROR << 24;
246
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100247 req = blk_get_request(sdev->request_queue,
248 data_direction == DMA_TO_DEVICE ?
249 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, __GFP_RECLAIM);
Joe Lawrencea492f072014-08-28 08:15:21 -0600250 if (IS_ERR(req))
James Bottomleybfe159a2011-07-07 15:45:40 -0500251 return ret;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100252 rq = scsi_req(req);
James Bottomley39216032005-06-15 18:48:29 -0500253
254 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
Mel Gorman71baba42015-11-06 16:28:28 -0800255 buffer, bufflen, __GFP_RECLAIM))
James Bottomley39216032005-06-15 18:48:29 -0500256 goto out;
257
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100258 rq->cmd_len = COMMAND_SIZE(cmd[0]);
259 memcpy(rq->cmd, cmd, rq->cmd_len);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200260 rq->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500261 req->timeout = timeout;
Christoph Hellwige8064022016-10-20 15:12:13 +0200262 req->cmd_flags |= flags;
263 req->rq_flags |= rq_flags | RQF_QUIET | RQF_PREEMPT;
James Bottomley39216032005-06-15 18:48:29 -0500264
265 /*
266 * head injection *required* here otherwise quiesce won't work
267 */
268 blk_execute_rq(req->q, NULL, req, 1);
269
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400270 /*
271 * Some devices (USB mass-storage in particular) may transfer
272 * garbage data together with a residue indicating that the data
273 * is invalid. Prevent the garbage from being misinterpreted
274 * and prevent security leaks by zeroing out the excess data.
275 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100276 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
277 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400278
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900279 if (resid)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100280 *resid = rq->resid_len;
281 if (sense && rq->sense_len)
282 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100283 if (sshdr)
284 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
Christoph Hellwig17d53632017-04-20 16:03:01 +0200285 ret = rq->result;
James Bottomley39216032005-06-15 18:48:29 -0500286 out:
287 blk_put_request(req);
288
289 return ret;
290}
James Bottomley33aa6872005-08-28 11:31:14 -0500291EXPORT_SYMBOL(scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293/*
294 * Function: scsi_init_cmd_errh()
295 *
296 * Purpose: Initialize cmd fields related to error handling.
297 *
298 * Arguments: cmd - command that is ready to be queued.
299 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 * Notes: This function has the job of initializing a number of
301 * fields related to error handling. Typically this will
302 * be called once for each command, as required.
303 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200304static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 cmd->serial_number = 0;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200307 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900308 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300310 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311}
312
313void scsi_device_unbusy(struct scsi_device *sdev)
314{
315 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500316 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 unsigned long flags;
318
Christoph Hellwig74665012014-01-22 15:29:29 +0100319 atomic_dec(&shost->host_busy);
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100320 if (starget->can_queue > 0)
321 atomic_dec(&starget->target_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +0100322
James Bottomley939647e2005-09-18 15:05:20 -0500323 if (unlikely(scsi_host_in_recovery(shost) &&
Christoph Hellwig74665012014-01-22 15:29:29 +0100324 (shost->host_failed || shost->host_eh_scheduled))) {
325 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 scsi_eh_wakeup(shost);
Christoph Hellwig74665012014-01-22 15:29:29 +0100327 spin_unlock_irqrestore(shost->host_lock, flags);
328 }
329
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200330 atomic_dec(&sdev->device_busy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331}
332
Christoph Hellwigd2852032014-01-17 12:06:53 +0100333static void scsi_kick_queue(struct request_queue *q)
334{
335 if (q->mq_ops)
336 blk_mq_start_hw_queues(q);
337 else
338 blk_run_queue(q);
339}
340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341/*
342 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
343 * and call blk_run_queue for all the scsi_devices on the target -
344 * including current_sdev first.
345 *
346 * Called with *no* scsi locks held.
347 */
348static void scsi_single_lun_run(struct scsi_device *current_sdev)
349{
350 struct Scsi_Host *shost = current_sdev->host;
351 struct scsi_device *sdev, *tmp;
352 struct scsi_target *starget = scsi_target(current_sdev);
353 unsigned long flags;
354
355 spin_lock_irqsave(shost->host_lock, flags);
356 starget->starget_sdev_user = NULL;
357 spin_unlock_irqrestore(shost->host_lock, flags);
358
359 /*
360 * Call blk_run_queue for all LUNs on the target, starting with
361 * current_sdev. We race with others (to set starget_sdev_user),
362 * but in most cases, we will be first. Ideally, each LU on the
363 * target would get some limited time or requests on the target.
364 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100365 scsi_kick_queue(current_sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
367 spin_lock_irqsave(shost->host_lock, flags);
368 if (starget->starget_sdev_user)
369 goto out;
370 list_for_each_entry_safe(sdev, tmp, &starget->devices,
371 same_target_siblings) {
372 if (sdev == current_sdev)
373 continue;
374 if (scsi_device_get(sdev))
375 continue;
376
377 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100378 scsi_kick_queue(sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 spin_lock_irqsave(shost->host_lock, flags);
380
381 scsi_device_put(sdev);
382 }
383 out:
384 spin_unlock_irqrestore(shost->host_lock, flags);
385}
386
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100387static inline bool scsi_device_is_busy(struct scsi_device *sdev)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400388{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100389 if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
390 return true;
391 if (atomic_read(&sdev->device_blocked) > 0)
392 return true;
393 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400394}
395
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100396static inline bool scsi_target_is_busy(struct scsi_target *starget)
Mike Christief0c0a372008-08-17 15:24:38 -0500397{
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100398 if (starget->can_queue > 0) {
399 if (atomic_read(&starget->target_busy) >= starget->can_queue)
400 return true;
401 if (atomic_read(&starget->target_blocked) > 0)
402 return true;
403 }
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100404 return false;
Mike Christief0c0a372008-08-17 15:24:38 -0500405}
406
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100407static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400408{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100409 if (shost->can_queue > 0 &&
410 atomic_read(&shost->host_busy) >= shost->can_queue)
411 return true;
412 if (atomic_read(&shost->host_blocked) > 0)
413 return true;
414 if (shost->host_self_blocked)
415 return true;
416 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400417}
418
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800419static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600421 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800422 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 unsigned long flags;
424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600426 list_splice_init(&shost->starved_list, &starved_list);
427
428 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200429 struct request_queue *slq;
430
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 /*
432 * As long as shost is accepting commands and we have
433 * starved queues, call blk_run_queue. scsi_request_fn
434 * drops the queue_lock and can add us back to the
435 * starved_list.
436 *
437 * host_lock protects the starved_list and starved_entry.
438 * scsi_request_fn must get the host_lock before checking
439 * or modifying starved_list or starved_entry.
440 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600441 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500442 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500443
Mike Christie2a3a59e2008-11-11 13:42:35 -0600444 sdev = list_entry(starved_list.next,
445 struct scsi_device, starved_entry);
446 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500447 if (scsi_target_is_busy(scsi_target(sdev))) {
448 list_move_tail(&sdev->starved_entry,
449 &shost->starved_list);
450 continue;
451 }
452
James Bottomleye2eb7242013-07-02 15:05:26 +0200453 /*
454 * Once we drop the host lock, a racing scsi_remove_device()
455 * call may remove the sdev from the starved list and destroy
456 * it and the queue. Mitigate by taking a reference to the
457 * queue and never touching the sdev again after we drop the
458 * host lock. Note: if __scsi_remove_device() invokes
459 * blk_cleanup_queue() before the queue is run from this
460 * function then blk_run_queue() will return immediately since
461 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
462 */
463 slq = sdev->request_queue;
464 if (!blk_get_queue(slq))
465 continue;
466 spin_unlock_irqrestore(shost->host_lock, flags);
467
Christoph Hellwigd2852032014-01-17 12:06:53 +0100468 scsi_kick_queue(slq);
James Bottomleye2eb7242013-07-02 15:05:26 +0200469 blk_put_queue(slq);
470
471 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600473 /* put any unprocessed entries back */
474 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800476}
477
478/*
479 * Function: scsi_run_queue()
480 *
481 * Purpose: Select a proper request queue to serve next
482 *
483 * Arguments: q - last request's queue
484 *
485 * Returns: Nothing
486 *
487 * Notes: The previous command was completely finished, start
488 * a new one if possible.
489 */
490static void scsi_run_queue(struct request_queue *q)
491{
492 struct scsi_device *sdev = q->queuedata;
493
494 if (scsi_target(sdev)->single_lun)
495 scsi_single_lun_run(sdev);
496 if (!list_empty(&sdev->host->starved_list))
497 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
Christoph Hellwigd2852032014-01-17 12:06:53 +0100499 if (q->mq_ops)
Bart Van Assche36e3cf22017-04-07 11:16:53 -0700500 blk_mq_run_hw_queues(q, false);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100501 else
502 blk_run_queue(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503}
504
Jens Axboe9937a5e2011-05-17 11:04:44 +0200505void scsi_requeue_run_queue(struct work_struct *work)
506{
507 struct scsi_device *sdev;
508 struct request_queue *q;
509
510 sdev = container_of(work, struct scsi_device, requeue_work);
511 q = sdev->request_queue;
512 scsi_run_queue(q);
513}
514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515/*
516 * Function: scsi_requeue_command()
517 *
518 * Purpose: Handle post-processing of completed commands.
519 *
520 * Arguments: q - queue to operate on
521 * cmd - command that may need to be requeued.
522 *
523 * Returns: Nothing
524 *
525 * Notes: After command completion, there may be blocks left
526 * over which weren't finished by the previous command
527 * this can be for a number of reasons - the main one is
528 * I/O errors in the middle of the request, in which case
529 * we need to request the blocks that come after the bad
530 * sector.
James Bottomleye91442b2005-09-09 10:44:16 -0500531 * Notes: Upon return, cmd is a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 */
533static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
534{
Bart Van Assche940f5d42012-06-29 15:34:26 +0000535 struct scsi_device *sdev = cmd->device;
James Bottomleye91442b2005-09-09 10:44:16 -0500536 struct request *req = cmd->request;
Tejun Heo 283369c2005-04-24 02:06:36 -0500537 unsigned long flags;
538
Tejun Heo 283369c2005-04-24 02:06:36 -0500539 spin_lock_irqsave(q->queue_lock, flags);
Christoph Hellwig134997a2014-02-20 14:20:58 -0800540 blk_unprep_request(req);
541 req->special = NULL;
542 scsi_put_command(cmd);
James Bottomleye91442b2005-09-09 10:44:16 -0500543 blk_requeue_request(q, req);
Tejun Heo 283369c2005-04-24 02:06:36 -0500544 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
546 scsi_run_queue(q);
Bart Van Assche940f5d42012-06-29 15:34:26 +0000547
548 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549}
550
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551void scsi_run_host_queues(struct Scsi_Host *shost)
552{
553 struct scsi_device *sdev;
554
555 shost_for_each_device(sdev, shost)
556 scsi_run_queue(sdev->request_queue);
557}
558
Christoph Hellwigd2852032014-01-17 12:06:53 +0100559static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
560{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100561 if (!blk_rq_is_passthrough(cmd->request)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100562 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
563
564 if (drv->uninit_command)
565 drv->uninit_command(cmd);
566 }
567}
568
569static void scsi_mq_free_sgtables(struct scsi_cmnd *cmd)
570{
Ming Lin91dbc082016-04-04 14:48:07 -0700571 struct scsi_data_buffer *sdb;
572
Christoph Hellwigd2852032014-01-17 12:06:53 +0100573 if (cmd->sdb.table.nents)
Ming Lin001d63b2016-04-04 14:48:09 -0700574 sg_free_table_chained(&cmd->sdb.table, true);
Ming Lin91dbc082016-04-04 14:48:07 -0700575 if (cmd->request->next_rq) {
576 sdb = cmd->request->next_rq->special;
577 if (sdb)
Ming Lin001d63b2016-04-04 14:48:09 -0700578 sg_free_table_chained(&sdb->table, true);
Ming Lin91dbc082016-04-04 14:48:07 -0700579 }
Christoph Hellwigd2852032014-01-17 12:06:53 +0100580 if (scsi_prot_sg_count(cmd))
Ming Lin001d63b2016-04-04 14:48:09 -0700581 sg_free_table_chained(&cmd->prot_sdb->table, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100582}
583
584static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
585{
586 struct scsi_device *sdev = cmd->device;
Kashyap.Desai@avagotech.com64bdcbc2014-08-20 19:24:33 +0530587 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100588 unsigned long flags;
589
Christoph Hellwigd2852032014-01-17 12:06:53 +0100590 scsi_mq_free_sgtables(cmd);
591 scsi_uninit_cmd(cmd);
592
Kashyap.Desai@avagotech.com64bdcbc2014-08-20 19:24:33 +0530593 if (shost->use_cmd_list) {
594 BUG_ON(list_empty(&cmd->list));
595 spin_lock_irqsave(&sdev->list_lock, flags);
596 list_del_init(&cmd->list);
597 spin_unlock_irqrestore(&sdev->list_lock, flags);
598 }
Christoph Hellwigd2852032014-01-17 12:06:53 +0100599}
600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601/*
602 * Function: scsi_release_buffers()
603 *
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200604 * Purpose: Free resources allocate for a scsi_command.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 *
606 * Arguments: cmd - command that we are bailing.
607 *
608 * Lock status: Assumed that no lock is held upon entry.
609 *
610 * Returns: Nothing
611 *
612 * Notes: In the event that an upper level driver rejects a
613 * command, we must release resources allocated during
614 * the __init_io() function. Primarily this would involve
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200615 * the scatter-gather table.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 */
Christoph Hellwigf1bea552014-04-15 12:26:54 +0200617static void scsi_release_buffers(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200619 if (cmd->sdb.table.nents)
Ming Lin001d63b2016-04-04 14:48:09 -0700620 sg_free_table_chained(&cmd->sdb.table, false);
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200621
622 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
623
624 if (scsi_prot_sg_count(cmd))
Ming Lin001d63b2016-04-04 14:48:09 -0700625 sg_free_table_chained(&cmd->prot_sdb->table, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626}
627
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200628static void scsi_release_bidi_buffers(struct scsi_cmnd *cmd)
629{
630 struct scsi_data_buffer *bidi_sdb = cmd->request->next_rq->special;
631
Ming Lin001d63b2016-04-04 14:48:09 -0700632 sg_free_table_chained(&bidi_sdb->table, false);
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200633 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
634 cmd->request->next_rq->special = NULL;
635}
636
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200637static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800638 unsigned int bytes, unsigned int bidi_bytes)
639{
640 struct scsi_cmnd *cmd = req->special;
641 struct scsi_device *sdev = cmd->device;
642 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800643
644 if (blk_update_request(req, error, bytes))
645 return true;
646
647 /* Bidi request must be completed as a whole */
648 if (unlikely(bidi_bytes) &&
649 blk_update_request(req->next_rq, error, bidi_bytes))
650 return true;
651
652 if (blk_queue_add_random(q))
653 add_disk_randomness(req->rq_disk);
654
Christoph Hellwigd2852032014-01-17 12:06:53 +0100655 if (req->mq_ctx) {
656 /*
Christoph Hellwigc8a446a2014-09-13 16:40:10 -0700657 * In the MQ case the command gets freed by __blk_mq_end_request,
Christoph Hellwigd2852032014-01-17 12:06:53 +0100658 * so we have to do all cleanup that depends on it earlier.
659 *
660 * We also can't kick the queues from irq context, so we
661 * will have to defer it to a workqueue.
662 */
663 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800664
Christoph Hellwigc8a446a2014-09-13 16:40:10 -0700665 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100666
667 if (scsi_target(sdev)->single_lun ||
668 !list_empty(&sdev->host->starved_list))
669 kblockd_schedule_work(&sdev->requeue_work);
670 else
Bart Van Assche36e3cf22017-04-07 11:16:53 -0700671 blk_mq_run_hw_queues(q, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100672 } else {
673 unsigned long flags;
674
Daniel Gryniewiczf81426a2014-09-16 10:41:13 -0400675 if (bidi_bytes)
676 scsi_release_bidi_buffers(cmd);
Christoph Hellwige9c787e2017-01-02 21:55:26 +0300677 scsi_release_buffers(cmd);
678 scsi_put_command(cmd);
Daniel Gryniewiczf81426a2014-09-16 10:41:13 -0400679
Christoph Hellwigd2852032014-01-17 12:06:53 +0100680 spin_lock_irqsave(q->queue_lock, flags);
681 blk_finish_request(req, error);
682 spin_unlock_irqrestore(q->queue_lock, flags);
683
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700684 scsi_run_queue(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100685 }
686
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700687 put_device(&sdev->sdev_gendev);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800688 return false;
689}
690
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200691/**
692 * __scsi_error_from_host_byte - translate SCSI error code into errno
693 * @cmd: SCSI command (unused)
694 * @result: scsi error code
695 *
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200696 * Translate SCSI error code into block errors.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200697 */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200698static blk_status_t __scsi_error_from_host_byte(struct scsi_cmnd *cmd,
699 int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100700{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200701 switch (host_byte(result)) {
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100702 case DID_TRANSPORT_FAILFAST:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200703 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100704 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000705 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200706 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100707 case DID_NEXUS_FAILURE:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200708 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200709 case DID_ALLOC_FAILURE:
710 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200711 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200712 case DID_MEDIUM_ERROR:
713 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200714 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100715 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200716 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100717 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100718}
719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720/*
721 * Function: scsi_io_completion()
722 *
723 * Purpose: Completion processing for block device I/O requests.
724 *
725 * Arguments: cmd - command that is finished.
726 *
727 * Lock status: Assumed that no lock is held upon entry.
728 *
729 * Returns: Nothing
730 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200731 * Notes: We will finish off the specified number of sectors. If we
732 * are done, the command block will be released and the queue
733 * function will be goosed. If we are not done then we have to
Alan Sternb60af5b2008-11-03 15:56:47 -0500734 * figure out what to do next:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500736 * a) We can call scsi_requeue_command(). The request
737 * will be unprepared and put back on the queue. Then
738 * a new command will be created for it. This should
739 * be used if we made forward progress, or if we want
740 * to switch from READ(10) to READ(6) for example.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200742 * b) We can call __scsi_queue_insert(). The request will
Alan Sternb60af5b2008-11-03 15:56:47 -0500743 * be put back on the queue and retried using the same
744 * command as before, possibly after a delay.
745 *
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800746 * c) We can call scsi_end_request() with -EIO to fail
Alan Sternb60af5b2008-11-03 15:56:47 -0500747 * the remainder of the request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 */
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700749void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750{
751 int result = cmd->result;
Jens Axboe165125e2007-07-24 09:28:11 +0200752 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 struct request *req = cmd->request;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200754 blk_status_t error = BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 struct scsi_sense_hdr sshdr;
Hannes Reinecke4753cbc2014-10-24 14:26:52 +0200756 bool sense_valid = false;
Hannes Reineckec11c0042014-10-24 14:27:01 +0200757 int sense_deferred = 0, level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500758 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
759 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900760 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 if (result) {
763 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
764 if (sense_valid)
765 sense_deferred = scsi_sense_is_deferred(&sshdr);
766 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200767
Christoph Hellwig57292b52017-01-31 16:57:29 +0100768 if (blk_rq_is_passthrough(req)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 if (result) {
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100770 if (sense_valid) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 /*
772 * SG_IO wants current and deferred errors
773 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100774 scsi_req(req)->sense_len =
775 min(8 + cmd->sense_buffer[7],
776 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 }
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500778 if (!sense_deferred)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100779 error = __scsi_error_from_host_byte(cmd, result);
Pete Wyckoffb22f6872007-03-13 16:53:28 -0400780 }
Mike Snitzer27c41972012-05-31 15:05:33 -0400781 /*
782 * __scsi_error_from_host_byte may have reset the host_byte
783 */
Christoph Hellwig17d53632017-04-20 16:03:01 +0200784 scsi_req(req)->result = cmd->result;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100785 scsi_req(req)->resid_len = scsi_get_resid(cmd);
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900786
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200787 if (scsi_bidi_cmnd(cmd)) {
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900788 /*
789 * Bidi commands Must be complete as a whole,
790 * both sides at once.
791 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100792 scsi_req(req->next_rq)->resid_len = scsi_in(cmd)->resid;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200793 if (scsi_end_request(req, BLK_STS_OK, blk_rq_bytes(req),
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800794 blk_rq_bytes(req->next_rq)))
795 BUG();
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200796 return;
797 }
James Bottomley89fb4cd2014-07-03 19:17:34 +0200798 } else if (blk_rq_bytes(req) == 0 && result && !sense_deferred) {
799 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100800 * Flush commands do not transfers any data, and thus cannot use
James Bottomley89fb4cd2014-07-03 19:17:34 +0200801 * good_bytes != blk_rq_bytes(req) as the signal for an error.
802 * This sets the error explicitly for the problem case.
803 */
804 error = __scsi_error_from_host_byte(cmd, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 }
806
Christoph Hellwig57292b52017-01-31 16:57:29 +0100807 /* no bidi support for !blk_rq_is_passthrough yet */
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200808 BUG_ON(blk_bidi_rq(req));
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 * Next deal with any sectors which we were able to correctly
812 * handle.
813 */
Hannes Reinecke91921e02014-06-25 16:39:59 +0200814 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
815 "%u sectors total, %d bytes done.\n",
816 blk_rq_sectors(req), good_bytes));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
James Bottomleya9bddd72009-03-30 16:55:51 +0000818 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100819 * Recovered errors need reporting, but they're always treated as
820 * success, so fiddle the result code here. For passthrough requests
Christoph Hellwig17d53632017-04-20 16:03:01 +0200821 * we already took a copy of the original into sreq->result which
James Bottomleya9bddd72009-03-30 16:55:51 +0000822 * is what gets returned to the user
823 */
Douglas Gilberte7efe592010-01-03 13:51:15 -0500824 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
825 /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
826 * print since caller wants ATA registers. Only occurs on
827 * SCSI ATA PASS_THROUGH commands when CK_COND=1
828 */
829 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
830 ;
Christoph Hellwige8064022016-10-20 15:12:13 +0200831 else if (!(req->rq_flags & RQF_QUIET))
Hannes Reinecked811b842014-10-24 14:26:45 +0200832 scsi_print_sense(cmd);
James Bottomleya9bddd72009-03-30 16:55:51 +0000833 result = 0;
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100834 /* for passthrough error may be set */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200835 error = BLK_STS_OK;
James Bottomleya9bddd72009-03-30 16:55:51 +0000836 }
837
838 /*
James Bottomleya621bac2016-05-13 12:04:06 -0700839 * special case: failed zero length commands always need to
840 * drop down into the retry code. Otherwise, if we finished
841 * all bytes in the request we are done now.
James Bottomleyd6b0c532006-07-02 10:06:28 -0500842 */
James Bottomleya621bac2016-05-13 12:04:06 -0700843 if (!(blk_rq_bytes(req) == 0 && error) &&
844 !scsi_end_request(req, error, good_bytes, 0))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800845 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200846
847 /*
848 * Kill remainder if no retrys.
849 */
850 if (error && scsi_noretry_cmd(cmd)) {
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800851 if (scsi_end_request(req, error, blk_rq_bytes(req), 0))
852 BUG();
853 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200854 }
855
856 /*
857 * If there had been no error, but we have leftover bytes in the
858 * requeues just queue the command up again.
859 */
860 if (result == 0)
861 goto requeue;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700862
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100863 error = __scsi_error_from_host_byte(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500864
Alan Sternb60af5b2008-11-03 15:56:47 -0500865 if (host_byte(result) == DID_RESET) {
866 /* Third party bus reset or reset for error recovery
867 * reasons. Just retry the command and see what
868 * happens.
869 */
870 action = ACTION_RETRY;
871 } else if (sense_valid && !sense_deferred) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 switch (sshdr.sense_key) {
873 case UNIT_ATTENTION:
874 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700875 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 * and quietly refuse further access.
877 */
878 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500879 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700881 /* Must have been a power glitch, or a
882 * bus reset. Could not have been a
883 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500884 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700885 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500886 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 }
888 break;
889 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700890 /* If we had an ILLEGAL REQUEST returned, then
891 * we may have performed an unsupported
892 * command. The only thing this should be
893 * would be a ten byte read where only a six
894 * byte read was supported. Also, on a system
895 * where READ CAPACITY failed, we may have
896 * read past the end of the disk.
897 */
Jens Axboe26a68012005-11-29 21:03:34 +0100898 if ((cmd->device->use_10_for_rw &&
899 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 (cmd->cmnd[0] == READ_10 ||
901 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500902 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500904 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500905 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500906 action = ACTION_FAIL;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200907 error = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500908 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400909 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500910 action = ACTION_FAIL;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200911 error = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500912 } else
913 action = ACTION_FAIL;
914 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400915 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000916 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200917 if (sshdr.asc == 0x10) /* DIF */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200918 error = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 break;
920 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700921 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500922 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500924 if (sshdr.asc == 0x04) {
925 switch (sshdr.ascq) {
926 case 0x01: /* becoming ready */
927 case 0x04: /* format in progress */
928 case 0x05: /* rebuild in progress */
929 case 0x06: /* recalculation in progress */
930 case 0x07: /* operation in progress */
931 case 0x08: /* Long write in progress */
932 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500933 case 0x14: /* space allocation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500934 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500935 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500936 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500937 action = ACTION_FAIL;
938 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500939 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200940 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500941 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500942 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700944 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500945 action = ACTION_FAIL;
946 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500948 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 break;
950 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200951 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500952 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500953
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900954 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200955 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900956 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900957
Alan Sternb60af5b2008-11-03 15:56:47 -0500958 switch (action) {
959 case ACTION_FAIL:
960 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200961 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200962 static DEFINE_RATELIMIT_STATE(_rs,
963 DEFAULT_RATELIMIT_INTERVAL,
964 DEFAULT_RATELIMIT_BURST);
965
966 if (unlikely(scsi_logging_level))
967 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
968 SCSI_LOG_MLCOMPLETE_BITS);
969
970 /*
971 * if logging is enabled the failure will be printed
972 * in scsi_log_completion(), so avoid duplicate messages
973 */
974 if (!level && __ratelimit(&_rs)) {
975 scsi_print_result(cmd, NULL, FAILED);
976 if (driver_byte(result) & DRIVER_SENSE)
977 scsi_print_sense(cmd);
978 scsi_print_command(cmd);
979 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500980 }
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800981 if (!scsi_end_request(req, error, blk_rq_err_bytes(req), 0))
982 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200983 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500984 case ACTION_REPREP:
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200985 requeue:
Alan Sternb60af5b2008-11-03 15:56:47 -0500986 /* Unprep the request and put it back at the head of the queue.
987 * A new command will be prepared and issued.
988 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100989 if (q->mq_ops) {
Christoph Hellwige8064022016-10-20 15:12:13 +0200990 cmd->request->rq_flags &= ~RQF_DONTPREP;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100991 scsi_mq_uninit_cmd(cmd);
992 scsi_mq_requeue_cmd(cmd);
993 } else {
994 scsi_release_buffers(cmd);
995 scsi_requeue_command(q, cmd);
996 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500997 break;
998 case ACTION_RETRY:
999 /* Retry the same command immediately */
James Bottomley4f5299a2009-01-02 10:42:21 -06001000 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001001 break;
1002 case ACTION_DELAYED_RETRY:
1003 /* Retry the same command after a delay */
James Bottomley4f5299a2009-01-02 10:42:21 -06001004 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001005 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 }
1007}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001009static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001011 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
1013 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001014 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001016 if (unlikely(sg_alloc_table_chained(&sdb->table,
1017 blk_rq_nr_phys_segments(req), sdb->table.sgl)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 return BLKPREP_DEFER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 /*
1021 * Next, walk the list, and fill in the addresses and sizes of
1022 * each segment.
1023 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001024 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1025 BUG_ON(count > sdb->table.nents);
1026 sdb->table.nents = count;
Christoph Hellwigfd102b12017-01-13 12:29:11 +01001027 sdb->length = blk_rq_payload_bytes(req);
Rusty Russell4a03d902007-11-19 11:28:48 +11001028 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001030
1031/*
1032 * Function: scsi_init_io()
1033 *
1034 * Purpose: SCSI I/O initialize function.
1035 *
1036 * Arguments: cmd - Command descriptor we wish to initialize
1037 *
1038 * Returns: 0 on success
1039 * BLKPREP_DEFER if the failure is retryable
1040 * BLKPREP_KILL if the failure is fatal
1041 */
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001042int scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001043{
Christoph Hellwig5e012aa2014-04-15 12:24:55 +02001044 struct scsi_device *sdev = cmd->device;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001045 struct request *rq = cmd->request;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001046 bool is_mq = (rq->mq_ctx != NULL);
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001047 int error = BLKPREP_KILL;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001048
Johannes Thumshirnfd3fc0b2017-01-31 10:16:00 +01001049 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001050 goto err_exit;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001051
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001052 error = scsi_init_sgtable(rq, &cmd->sdb);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001053 if (error)
1054 goto err_exit;
1055
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001056 if (blk_bidi_rq(rq)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001057 if (!rq->q->mq_ops) {
1058 struct scsi_data_buffer *bidi_sdb =
1059 kmem_cache_zalloc(scsi_sdb_cache, GFP_ATOMIC);
1060 if (!bidi_sdb) {
1061 error = BLKPREP_DEFER;
1062 goto err_exit;
1063 }
1064
1065 rq->next_rq->special = bidi_sdb;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001066 }
1067
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001068 error = scsi_init_sgtable(rq->next_rq, rq->next_rq->special);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001069 if (error)
1070 goto err_exit;
1071 }
1072
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001073 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001074 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1075 int ivecs, count;
1076
Ewan D. Milne91724c22015-01-15 10:02:12 -05001077 if (prot_sdb == NULL) {
1078 /*
1079 * This can happen if someone (e.g. multipath)
1080 * queues a command to a device on an adapter
1081 * that does not support DIX.
1082 */
1083 WARN_ON_ONCE(1);
1084 error = BLKPREP_KILL;
1085 goto err_exit;
1086 }
1087
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001088 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001089
Ming Lin001d63b2016-04-04 14:48:09 -07001090 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lin22cc3d42016-04-04 14:48:08 -07001091 prot_sdb->table.sgl)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001092 error = BLKPREP_DEFER;
1093 goto err_exit;
1094 }
1095
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001096 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001097 prot_sdb->table.sgl);
1098 BUG_ON(unlikely(count > ivecs));
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001099 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001100
1101 cmd->prot_sdb = prot_sdb;
1102 cmd->prot_sdb->table.nents = count;
1103 }
1104
Christoph Hellwigd2852032014-01-17 12:06:53 +01001105 return BLKPREP_OK;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001106err_exit:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001107 if (is_mq) {
1108 scsi_mq_free_sgtables(cmd);
1109 } else {
1110 scsi_release_buffers(cmd);
1111 cmd->request->special = NULL;
1112 scsi_put_command(cmd);
1113 put_device(&sdev->sdev_gendev);
1114 }
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001115 return error;
1116}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001117EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001119/**
1120 * scsi_initialize_rq - initialize struct scsi_cmnd.req
1121 *
1122 * Called from inside blk_get_request().
1123 */
1124void scsi_initialize_rq(struct request *rq)
1125{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001126 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1127
1128 scsi_req_init(&cmd->req);
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001129}
1130EXPORT_SYMBOL(scsi_initialize_rq);
1131
1132/* Called after a request has been started. */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001133void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001134{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001135 void *buf = cmd->sense_buffer;
1136 void *prot = cmd->prot_sdb;
1137 unsigned long flags;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001138
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001139 /* zero out the cmd, except for the embedded scsi_request */
1140 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001141 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001142
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001143 cmd->device = dev;
1144 cmd->sense_buffer = buf;
1145 cmd->prot_sdb = prot;
1146 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1147 cmd->jiffies_at_alloc = jiffies;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001148
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001149 spin_lock_irqsave(&dev->list_lock, flags);
1150 list_add_tail(&cmd->list, &dev->cmd_list);
1151 spin_unlock_irqrestore(&dev->list_lock, flags);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001152}
1153
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001154static int scsi_setup_scsi_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001155{
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001156 struct scsi_cmnd *cmd = req->special;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001157
1158 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001159 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001160 * a bio attached to them. Or they might contain a SCSI command
1161 * that does not transfer data, in which case they may optionally
1162 * submit a request without an attached bio.
1163 */
1164 if (req->bio) {
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001165 int ret = scsi_init_io(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001166 if (unlikely(ret))
1167 return ret;
1168 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001169 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001170
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001171 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001172 }
James Bottomley7b163182005-12-15 20:17:02 -06001173
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001174 cmd->cmd_len = scsi_req(req)->cmd_len;
1175 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001176 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001177 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001178 return BLKPREP_OK;
1179}
1180
1181/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001182 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001183 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001184 */
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001185static int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001186{
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001187 struct scsi_cmnd *cmd = req->special;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001188
Christoph Hellwigee14c672015-08-27 14:16:59 +02001189 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
1190 int ret = sdev->handler->prep_fn(sdev, req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001191 if (ret != BLKPREP_OK)
1192 return ret;
1193 }
1194
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001195 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001196 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001197 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001198}
James Bottomley7b163182005-12-15 20:17:02 -06001199
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001200static int scsi_setup_cmnd(struct scsi_device *sdev, struct request *req)
1201{
1202 struct scsi_cmnd *cmd = req->special;
1203
1204 if (!blk_rq_bytes(req))
1205 cmd->sc_data_direction = DMA_NONE;
1206 else if (rq_data_dir(req) == WRITE)
1207 cmd->sc_data_direction = DMA_TO_DEVICE;
1208 else
1209 cmd->sc_data_direction = DMA_FROM_DEVICE;
1210
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001211 if (blk_rq_is_scsi(req))
1212 return scsi_setup_scsi_cmnd(sdev, req);
1213 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001214 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001215}
1216
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001217static int
1218scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001220 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
1222 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001223 * If the device is not in running state we will reject some
1224 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001227 switch (sdev->sdev_state) {
1228 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05001229 case SDEV_TRANSPORT_OFFLINE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001230 /*
1231 * If the device is offline we refuse to process any
1232 * commands. The device must be brought online
1233 * before trying any recovery commands.
1234 */
1235 sdev_printk(KERN_ERR, sdev,
1236 "rejecting I/O to offline device\n");
1237 ret = BLKPREP_KILL;
1238 break;
1239 case SDEV_DEL:
1240 /*
1241 * If the device is fully deleted, we refuse to
1242 * process any commands as well.
1243 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001244 sdev_printk(KERN_ERR, sdev,
1245 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001246 ret = BLKPREP_KILL;
1247 break;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001248 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001249 case SDEV_CREATED_BLOCK:
Bart Van Asschebba0bdd2015-03-04 10:31:47 +01001250 ret = BLKPREP_DEFER;
1251 break;
1252 case SDEV_QUIESCE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001253 /*
1254 * If the devices is blocked we defer normal commands.
1255 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001256 if (!(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001257 ret = BLKPREP_DEFER;
1258 break;
1259 default:
1260 /*
1261 * For any other not fully online state we only allow
1262 * special commands. In particular any user initiated
1263 * command is not allowed.
1264 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001265 if (!(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001266 ret = BLKPREP_KILL;
1267 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001270 return ret;
1271}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001273static int
1274scsi_prep_return(struct request_queue *q, struct request *req, int ret)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001275{
1276 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
Christoph Hellwig3b003152006-11-04 20:10:55 +01001278 switch (ret) {
1279 case BLKPREP_KILL:
jiangyiwene1cd3912016-02-16 20:14:13 +08001280 case BLKPREP_INVALID:
Christoph Hellwig17d53632017-04-20 16:03:01 +02001281 scsi_req(req)->result = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001282 /* release the command and kill it */
1283 if (req->special) {
1284 struct scsi_cmnd *cmd = req->special;
1285 scsi_release_buffers(cmd);
1286 scsi_put_command(cmd);
Christoph Hellwig68c03d92014-04-15 12:24:56 +02001287 put_device(&sdev->sdev_gendev);
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001288 req->special = NULL;
1289 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001290 break;
1291 case BLKPREP_DEFER:
1292 /*
Tejun Heo9934c8c2009-05-08 11:54:16 +09001293 * If we defer, the blk_peek_request() returns NULL, but the
Jens Axboea488e742010-04-16 21:13:15 +02001294 * queue must be restarted, so we schedule a callback to happen
1295 * shortly.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001296 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001297 if (atomic_read(&sdev->device_busy) == 0)
Jens Axboea488e742010-04-16 21:13:15 +02001298 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001299 break;
1300 default:
Christoph Hellwige8064022016-10-20 15:12:13 +02001301 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001302 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
Christoph Hellwig3b003152006-11-04 20:10:55 +01001304 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001306
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001307static int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001308{
1309 struct scsi_device *sdev = q->queuedata;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001310 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001311 int ret;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001312
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001313 ret = scsi_prep_state_check(sdev, req);
1314 if (ret != BLKPREP_OK)
1315 goto out;
1316
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001317 if (!req->special) {
1318 /* Bail if we can't get a reference to the device */
1319 if (unlikely(!get_device(&sdev->sdev_gendev))) {
1320 ret = BLKPREP_DEFER;
1321 goto out;
1322 }
1323
1324 scsi_init_command(sdev, cmd);
1325 req->special = cmd;
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001326 }
1327
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001328 cmd->tag = req->tag;
1329 cmd->request = req;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001330 cmd->prot_op = SCSI_PROT_NORMAL;
1331
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001332 ret = scsi_setup_cmnd(sdev, req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001333out:
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001334 return scsi_prep_return(q, req, ret);
1335}
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001336
1337static void scsi_unprep_fn(struct request_queue *q, struct request *req)
1338{
Christoph Hellwigd2852032014-01-17 12:06:53 +01001339 scsi_uninit_cmd(req->special);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001340}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341
1342/*
1343 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1344 * return 0.
1345 *
1346 * Called with the queue_lock held.
1347 */
1348static inline int scsi_dev_queue_ready(struct request_queue *q,
1349 struct scsi_device *sdev)
1350{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001351 unsigned int busy;
1352
1353 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001354 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001355 if (busy)
1356 goto out_dec;
1357
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 /*
1359 * unblock after device_blocked iterates to zero
1360 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001361 if (atomic_dec_return(&sdev->device_blocked) > 0) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001362 /*
1363 * For the MQ case we take care of this in the caller.
1364 */
1365 if (!q->mq_ops)
1366 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001367 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001369 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1370 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001372
1373 if (busy >= sdev->queue_depth)
1374 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375
1376 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001377out_dec:
1378 atomic_dec(&sdev->device_busy);
1379 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380}
1381
Mike Christief0c0a372008-08-17 15:24:38 -05001382/*
1383 * scsi_target_queue_ready: checks if there we can send commands to target
1384 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001385 */
1386static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1387 struct scsi_device *sdev)
1388{
1389 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001390 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001391
1392 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001393 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001394 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001395 starget->starget_sdev_user != sdev) {
1396 spin_unlock_irq(shost->host_lock);
1397 return 0;
1398 }
Mike Christief0c0a372008-08-17 15:24:38 -05001399 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001400 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001401 }
1402
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001403 if (starget->can_queue <= 0)
1404 return 1;
1405
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001406 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001407 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001408 if (busy)
1409 goto starved;
1410
Mike Christief0c0a372008-08-17 15:24:38 -05001411 /*
1412 * unblock after target_blocked iterates to zero
1413 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001414 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001415 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001416
1417 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1418 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001419 }
1420
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001421 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001422 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001423
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001424 return 1;
1425
1426starved:
1427 spin_lock_irq(shost->host_lock);
1428 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001429 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001430out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001431 if (starget->can_queue > 0)
1432 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001433 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001434}
1435
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436/*
1437 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1438 * return 0. We must end up running the queue again whenever 0 is
1439 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 */
1441static inline int scsi_host_queue_ready(struct request_queue *q,
1442 struct Scsi_Host *shost,
1443 struct scsi_device *sdev)
1444{
Christoph Hellwig74665012014-01-22 15:29:29 +01001445 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001446
James Bottomley939647e2005-09-18 15:05:20 -05001447 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001448 return 0;
1449
1450 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001451 if (atomic_read(&shost->host_blocked) > 0) {
Christoph Hellwig74665012014-01-22 15:29:29 +01001452 if (busy)
1453 goto starved;
1454
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 /*
1456 * unblock after host_blocked iterates to zero
1457 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001458 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001459 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001460
1461 SCSI_LOG_MLQUEUE(3,
1462 shost_printk(KERN_INFO, shost,
1463 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001465
1466 if (shost->can_queue > 0 && busy >= shost->can_queue)
1467 goto starved;
1468 if (shost->host_self_blocked)
1469 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470
1471 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001472 if (!list_empty(&sdev->starved_entry)) {
1473 spin_lock_irq(shost->host_lock);
1474 if (!list_empty(&sdev->starved_entry))
1475 list_del_init(&sdev->starved_entry);
1476 spin_unlock_irq(shost->host_lock);
1477 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478
Christoph Hellwig74665012014-01-22 15:29:29 +01001479 return 1;
1480
1481starved:
1482 spin_lock_irq(shost->host_lock);
1483 if (list_empty(&sdev->starved_entry))
1484 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001485 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001486out_dec:
1487 atomic_dec(&shost->host_busy);
1488 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489}
1490
1491/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001492 * Busy state exporting function for request stacking drivers.
1493 *
1494 * For efficiency, no lock is taken to check the busy state of
1495 * shost/starget/sdev, since the returned value is not guaranteed and
1496 * may be changed after request stacking drivers call the function,
1497 * regardless of taking lock or not.
1498 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001499 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1500 * needs to return 'not busy'. Otherwise, request stacking drivers
1501 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001502 */
1503static int scsi_lld_busy(struct request_queue *q)
1504{
1505 struct scsi_device *sdev = q->queuedata;
1506 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001507
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001508 if (blk_queue_dying(q))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001509 return 0;
1510
1511 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001512
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001513 /*
1514 * Ignore host/starget busy state.
1515 * Since block layer does not have a concept of fairness across
1516 * multiple queues, congestion of host/starget needs to be handled
1517 * in SCSI layer.
1518 */
1519 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001520 return 1;
1521
1522 return 0;
1523}
1524
1525/*
James Bottomleye91442b2005-09-09 10:44:16 -05001526 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 */
Jens Axboe165125e2007-07-24 09:28:11 +02001528static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529{
James Bottomleye91442b2005-09-09 10:44:16 -05001530 struct scsi_cmnd *cmd = req->special;
Jiri Slaby03b14702009-09-23 16:15:35 +02001531 struct scsi_device *sdev;
1532 struct scsi_target *starget;
1533 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534
Tejun Heo9934c8c2009-05-08 11:54:16 +09001535 blk_start_request(req);
James Bottomley788ce432005-09-09 13:40:23 -05001536
Hannes Reinecke74571812011-11-09 08:39:24 +01001537 scmd_printk(KERN_INFO, cmd, "killing request\n");
1538
Jiri Slaby03b14702009-09-23 16:15:35 +02001539 sdev = cmd->device;
1540 starget = scsi_target(sdev);
1541 shost = sdev->host;
James Bottomleye91442b2005-09-09 10:44:16 -05001542 scsi_init_cmd_errh(cmd);
1543 cmd->result = DID_NO_CONNECT << 16;
1544 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001545
1546 /*
1547 * SCSI request completion path will do scsi_device_unbusy(),
1548 * bump busy counts. To bump the counters, we need to dance
1549 * with the locks as normal issue path does.
1550 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001551 atomic_inc(&sdev->device_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +01001552 atomic_inc(&shost->host_busy);
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001553 if (starget->can_queue > 0)
1554 atomic_inc(&starget->target_busy);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001555
Jens Axboe242f9dc2008-09-14 05:55:09 -07001556 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557}
1558
Jens Axboe1aea6432006-01-09 16:03:03 +01001559static void scsi_softirq_done(struct request *rq)
1560{
Jens Axboe242f9dc2008-09-14 05:55:09 -07001561 struct scsi_cmnd *cmd = rq->special;
1562 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001563 int disposition;
1564
1565 INIT_LIST_HEAD(&cmd->eh_entry);
1566
Jens Axboe242f9dc2008-09-14 05:55:09 -07001567 atomic_inc(&cmd->device->iodone_cnt);
1568 if (cmd->result)
1569 atomic_inc(&cmd->device->ioerr_cnt);
1570
Jens Axboe1aea6432006-01-09 16:03:03 +01001571 disposition = scsi_decide_disposition(cmd);
1572 if (disposition != SUCCESS &&
1573 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1574 sdev_printk(KERN_ERR, cmd->device,
1575 "timing out command, waited %lus\n",
1576 wait_for/HZ);
1577 disposition = SUCCESS;
1578 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001579
Jens Axboe1aea6432006-01-09 16:03:03 +01001580 scsi_log_completion(cmd, disposition);
1581
1582 switch (disposition) {
1583 case SUCCESS:
1584 scsi_finish_command(cmd);
1585 break;
1586 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001587 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001588 break;
1589 case ADD_TO_MLQUEUE:
1590 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1591 break;
1592 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001593 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001594 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001595 }
1596}
1597
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001598/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001599 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1600 * @cmd: command block we are dispatching.
1601 *
1602 * Return: nonzero return request was rejected and device's queue needs to be
1603 * plugged.
1604 */
1605static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1606{
1607 struct Scsi_Host *host = cmd->device->host;
1608 int rtn = 0;
1609
1610 atomic_inc(&cmd->device->iorequest_cnt);
1611
1612 /* check if the device is still usable */
1613 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1614 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1615 * returns an immediate error upwards, and signals
1616 * that the device is no longer present */
1617 cmd->result = DID_NO_CONNECT << 16;
1618 goto done;
1619 }
1620
1621 /* Check to see if the scsi lld made this device blocked. */
1622 if (unlikely(scsi_device_blocked(cmd->device))) {
1623 /*
1624 * in blocked state, the command is just put back on
1625 * the device queue. The suspend state has already
1626 * blocked the queue so future requests should not
1627 * occur until the device transitions out of the
1628 * suspend state.
1629 */
1630 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1631 "queuecommand : device blocked\n"));
1632 return SCSI_MLQUEUE_DEVICE_BUSY;
1633 }
1634
1635 /* Store the LUN value in cmnd, if needed. */
1636 if (cmd->device->lun_in_cdb)
1637 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1638 (cmd->device->lun << 5 & 0xe0);
1639
1640 scsi_log_send(cmd);
1641
1642 /*
1643 * Before we queue this command, check if the command
1644 * length exceeds what the host adapter can handle.
1645 */
1646 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1647 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1648 "queuecommand : command too long. "
1649 "cdb_size=%d host->max_cmd_len=%d\n",
1650 cmd->cmd_len, cmd->device->host->max_cmd_len));
1651 cmd->result = (DID_ABORT << 16);
1652 goto done;
1653 }
1654
1655 if (unlikely(host->shost_state == SHOST_DEL)) {
1656 cmd->result = (DID_NO_CONNECT << 16);
1657 goto done;
1658
1659 }
1660
1661 trace_scsi_dispatch_cmd_start(cmd);
1662 rtn = host->hostt->queuecommand(host, cmd);
1663 if (rtn) {
1664 trace_scsi_dispatch_cmd_error(cmd, rtn);
1665 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1666 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1667 rtn = SCSI_MLQUEUE_HOST_BUSY;
1668
1669 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1670 "queuecommand : request rejected\n"));
1671 }
1672
1673 return rtn;
1674 done:
1675 cmd->scsi_done(cmd);
1676 return 0;
1677}
1678
1679/**
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001680 * scsi_done - Invoke completion on finished SCSI command.
1681 * @cmd: The SCSI Command for which a low-level device driver (LLDD) gives
1682 * ownership back to SCSI Core -- i.e. the LLDD has finished with it.
1683 *
1684 * Description: This function is the mid-level's (SCSI Core) interrupt routine,
1685 * which regains ownership of the SCSI command (de facto) from a LLDD, and
1686 * calls blk_complete_request() for further processing.
1687 *
1688 * This function is interrupt context safe.
1689 */
1690static void scsi_done(struct scsi_cmnd *cmd)
1691{
1692 trace_scsi_dispatch_cmd_done(cmd);
1693 blk_complete_request(cmd->request);
1694}
1695
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696/*
1697 * Function: scsi_request_fn()
1698 *
1699 * Purpose: Main strategy routine for SCSI.
1700 *
1701 * Arguments: q - Pointer to actual queue.
1702 *
1703 * Returns: Nothing
1704 *
1705 * Lock status: IO request lock assumed to be held when called.
1706 */
1707static void scsi_request_fn(struct request_queue *q)
Bart Van Assche613be1f2014-02-20 14:20:56 -08001708 __releases(q->queue_lock)
1709 __acquires(q->queue_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710{
1711 struct scsi_device *sdev = q->queuedata;
1712 struct Scsi_Host *shost;
1713 struct scsi_cmnd *cmd;
1714 struct request *req;
1715
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 /*
1717 * To start with, we keep looping until the queue is empty, or until
1718 * the host is no longer able to accept any more requests.
1719 */
1720 shost = sdev->host;
Jens Axboea488e742010-04-16 21:13:15 +02001721 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 int rtn;
1723 /*
1724 * get next queueable request. We do this early to make sure
Hannes Reinecke91921e02014-06-25 16:39:59 +02001725 * that the request is fully prepared even if we cannot
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 * accept it.
1727 */
Tejun Heo9934c8c2009-05-08 11:54:16 +09001728 req = blk_peek_request(q);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001729 if (!req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 break;
1731
1732 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001733 sdev_printk(KERN_ERR, sdev,
1734 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001735 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 continue;
1737 }
1738
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001739 if (!scsi_dev_queue_ready(q, sdev))
1740 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741
1742 /*
1743 * Remove the request from the request list.
1744 */
1745 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
Tejun Heo9934c8c2009-05-08 11:54:16 +09001746 blk_start_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001748 spin_unlock_irq(q->queue_lock);
James Bottomleye91442b2005-09-09 10:44:16 -05001749 cmd = req->special;
1750 if (unlikely(cmd == NULL)) {
1751 printk(KERN_CRIT "impossible request in %s.\n"
1752 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001753 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001754 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001755 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001756 BUG();
1757 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758
Mike Christieecefe8a2008-07-11 19:50:35 -05001759 /*
1760 * We hit this when the driver is using a host wide
1761 * tag map. For device level tag maps the queue_depth check
1762 * in the device ready fn would prevent us from trying
1763 * to allocate a tag. Since the map is a shared host resource
1764 * we add the dev to the starved list so it eventually gets
1765 * a run when a tag is freed.
1766 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001767 if (blk_queue_tagged(q) && !(req->rq_flags & RQF_QUEUED)) {
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001768 spin_lock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001769 if (list_empty(&sdev->starved_entry))
1770 list_add_tail(&sdev->starved_entry,
1771 &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001772 spin_unlock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001773 goto not_ready;
1774 }
1775
Mike Christief0c0a372008-08-17 15:24:38 -05001776 if (!scsi_target_queue_ready(shost, sdev))
1777 goto not_ready;
1778
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 if (!scsi_host_queue_ready(q, shost, sdev))
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001780 goto host_not_ready;
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001781
1782 if (sdev->simple_tags)
1783 cmd->flags |= SCMD_TAGGED;
1784 else
1785 cmd->flags &= ~SCMD_TAGGED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787 /*
1788 * Finally, initialize any error handling parameters, and set up
1789 * the timers for timeouts.
1790 */
1791 scsi_init_cmd_errh(cmd);
1792
1793 /*
1794 * Dispatch the command to the low-level driver.
1795 */
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001796 cmd->scsi_done = scsi_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 rtn = scsi_dispatch_cmd(cmd);
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001798 if (rtn) {
1799 scsi_queue_insert(cmd, rtn);
1800 spin_lock_irq(q->queue_lock);
Jens Axboea488e742010-04-16 21:13:15 +02001801 goto out_delay;
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001802 }
1803 spin_lock_irq(q->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 }
1805
Bart Van Assche613be1f2014-02-20 14:20:56 -08001806 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001808 host_not_ready:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001809 if (scsi_target(sdev)->can_queue > 0)
1810 atomic_dec(&scsi_target(sdev)->target_busy);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001811 not_ready:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 /*
1813 * lock q, handle tag, requeue req, and decrement device_busy. We
1814 * must return with queue_lock held.
1815 *
1816 * Decrementing device_busy without checking it is OK, as all such
1817 * cases (host limits or settings) should run the queue at some
1818 * later time.
1819 */
1820 spin_lock_irq(q->queue_lock);
1821 blk_requeue_request(q, req);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001822 atomic_dec(&sdev->device_busy);
Jens Axboea488e742010-04-16 21:13:15 +02001823out_delay:
Guenter Roeck480cadc2014-08-10 05:54:25 -07001824 if (!atomic_read(&sdev->device_busy) && !scsi_device_blocked(sdev))
Jens Axboea488e742010-04-16 21:13:15 +02001825 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826}
1827
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001828static inline blk_status_t prep_to_mq(int ret)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001829{
1830 switch (ret) {
1831 case BLKPREP_OK:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001832 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001833 case BLKPREP_DEFER:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001834 return BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001835 default:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001836 return BLK_STS_IOERR;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001837 }
1838}
1839
1840static int scsi_mq_prep_fn(struct request *req)
1841{
1842 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1843 struct scsi_device *sdev = req->q->queuedata;
1844 struct Scsi_Host *shost = sdev->host;
1845 unsigned char *sense_buf = cmd->sense_buffer;
1846 struct scatterlist *sg;
1847
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001848 /* zero out the cmd, except for the embedded scsi_request */
1849 memset((char *)cmd + sizeof(cmd->req), 0,
Long Li1bad6c42017-05-18 15:40:05 -07001850 sizeof(*cmd) - sizeof(cmd->req) + shost->hostt->cmd_size);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001851
1852 req->special = cmd;
1853
1854 cmd->request = req;
1855 cmd->device = sdev;
1856 cmd->sense_buffer = sense_buf;
1857
1858 cmd->tag = req->tag;
1859
Christoph Hellwigd2852032014-01-17 12:06:53 +01001860 cmd->prot_op = SCSI_PROT_NORMAL;
1861
1862 INIT_LIST_HEAD(&cmd->list);
1863 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1864 cmd->jiffies_at_alloc = jiffies;
1865
Kashyap.Desai@avagotech.com64bdcbc2014-08-20 19:24:33 +05301866 if (shost->use_cmd_list) {
1867 spin_lock_irq(&sdev->list_lock);
1868 list_add_tail(&cmd->list, &sdev->cmd_list);
1869 spin_unlock_irq(&sdev->list_lock);
1870 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001871
1872 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1873 cmd->sdb.table.sgl = sg;
1874
1875 if (scsi_host_get_prot(shost)) {
1876 cmd->prot_sdb = (void *)sg +
Tony Battersby120bb3e2014-12-08 17:20:52 -05001877 min_t(unsigned int,
Ming Lin65e86172016-04-04 14:48:10 -07001878 shost->sg_tablesize, SG_CHUNK_SIZE) *
Tony Battersby120bb3e2014-12-08 17:20:52 -05001879 sizeof(struct scatterlist);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001880 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1881
1882 cmd->prot_sdb->table.sgl =
1883 (struct scatterlist *)(cmd->prot_sdb + 1);
1884 }
1885
1886 if (blk_bidi_rq(req)) {
1887 struct request *next_rq = req->next_rq;
1888 struct scsi_data_buffer *bidi_sdb = blk_mq_rq_to_pdu(next_rq);
1889
1890 memset(bidi_sdb, 0, sizeof(struct scsi_data_buffer));
1891 bidi_sdb->table.sgl =
1892 (struct scatterlist *)(bidi_sdb + 1);
1893
1894 next_rq->special = bidi_sdb;
1895 }
1896
Christoph Hellwigfe052522014-09-22 15:59:31 +02001897 blk_mq_start_request(req);
1898
Christoph Hellwigd2852032014-01-17 12:06:53 +01001899 return scsi_setup_cmnd(sdev, req);
1900}
1901
1902static void scsi_mq_done(struct scsi_cmnd *cmd)
1903{
1904 trace_scsi_dispatch_cmd_done(cmd);
Christoph Hellwig08e00292017-04-20 16:03:09 +02001905 blk_mq_complete_request(cmd->request);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001906}
1907
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001908static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
Jens Axboe74c45052014-10-29 11:14:52 -06001909 const struct blk_mq_queue_data *bd)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001910{
Jens Axboe74c45052014-10-29 11:14:52 -06001911 struct request *req = bd->rq;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001912 struct request_queue *q = req->q;
1913 struct scsi_device *sdev = q->queuedata;
1914 struct Scsi_Host *shost = sdev->host;
1915 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001916 blk_status_t ret;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001917 int reason;
1918
1919 ret = prep_to_mq(scsi_prep_state_check(sdev, req));
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001920 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001921 goto out;
1922
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001923 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001924 if (!get_device(&sdev->sdev_gendev))
1925 goto out;
1926
1927 if (!scsi_dev_queue_ready(q, sdev))
1928 goto out_put_device;
1929 if (!scsi_target_queue_ready(shost, sdev))
1930 goto out_dec_device_busy;
1931 if (!scsi_host_queue_ready(q, shost, sdev))
1932 goto out_dec_target_busy;
1933
Christoph Hellwige8064022016-10-20 15:12:13 +02001934 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001935 ret = prep_to_mq(scsi_mq_prep_fn(req));
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001936 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001937 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001938 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001939 } else {
1940 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001941 }
1942
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001943 if (sdev->simple_tags)
1944 cmd->flags |= SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001945 else
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001946 cmd->flags &= ~SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001947
Christoph Hellwigd2852032014-01-17 12:06:53 +01001948 scsi_init_cmd_errh(cmd);
1949 cmd->scsi_done = scsi_mq_done;
1950
1951 reason = scsi_dispatch_cmd(cmd);
1952 if (reason) {
1953 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001954 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001955 goto out_dec_host_busy;
1956 }
1957
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001958 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001959
1960out_dec_host_busy:
1961 atomic_dec(&shost->host_busy);
1962out_dec_target_busy:
1963 if (scsi_target(sdev)->can_queue > 0)
1964 atomic_dec(&scsi_target(sdev)->target_busy);
1965out_dec_device_busy:
1966 atomic_dec(&sdev->device_busy);
1967out_put_device:
1968 put_device(&sdev->sdev_gendev);
1969out:
1970 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001971 case BLK_STS_OK:
1972 break;
1973 case BLK_STS_RESOURCE:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001974 if (atomic_read(&sdev->device_busy) == 0 &&
1975 !scsi_device_blocked(sdev))
Bart Van Assche36e3cf22017-04-07 11:16:53 -07001976 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001977 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001978 default:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001979 /*
1980 * Make sure to release all allocated ressources when
1981 * we hit an error, as we will never see this command
1982 * again.
1983 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001984 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001985 scsi_mq_uninit_cmd(cmd);
1986 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001987 }
1988 return ret;
1989}
1990
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001991static enum blk_eh_timer_return scsi_timeout(struct request *req,
1992 bool reserved)
1993{
1994 if (reserved)
1995 return BLK_EH_RESET_TIMER;
1996 return scsi_times_out(req);
1997}
1998
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001999static int scsi_init_request(struct blk_mq_tag_set *set, struct request *rq,
2000 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002001{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002002 struct Scsi_Host *shost = set->driver_data;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002003 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2004
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002005 cmd->sense_buffer =
2006 scsi_alloc_sense_buffer(shost, GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002007 if (!cmd->sense_buffer)
2008 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002009 cmd->req.sense = cmd->sense_buffer;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002010 return 0;
2011}
2012
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002013static void scsi_exit_request(struct blk_mq_tag_set *set, struct request *rq,
2014 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002015{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002016 struct Scsi_Host *shost = set->driver_data;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002017 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2018
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002019 scsi_free_sense_buffer(shost, cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002020}
2021
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002022static int scsi_map_queues(struct blk_mq_tag_set *set)
2023{
2024 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
2025
2026 if (shost->hostt->map_queues)
2027 return shost->hostt->map_queues(shost);
2028 return blk_mq_map_queues(set);
2029}
2030
Christoph Hellwigf1bea552014-04-15 12:26:54 +02002031static u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032{
2033 struct device *host_dev;
2034 u64 bounce_limit = 0xffffffff;
2035
2036 if (shost->unchecked_isa_dma)
2037 return BLK_BOUNCE_ISA;
2038 /*
2039 * Platforms with virtual-DMA translation
2040 * hardware have no practical limit.
2041 */
2042 if (!PCI_DMA_BUS_IS_PHYS)
2043 return BLK_BOUNCE_ANY;
2044
2045 host_dev = scsi_get_device(shost);
2046 if (host_dev && host_dev->dma_mask)
Russell Kinge83b3662014-02-11 17:11:04 +00002047 bounce_limit = (u64)dma_max_pfn(host_dev) << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048
2049 return bounce_limit;
2050}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002052void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053{
Lin Ming6f381fa2012-04-12 13:50:38 +08002054 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055
Bart Van Assche9efc1602017-05-31 14:43:46 -07002056 queue_flag_set_unlocked(QUEUE_FLAG_SCSI_PASSTHROUGH, q);
2057
Jens Axboea8474ce2007-08-07 09:02:51 +02002058 /*
2059 * this limit is imposed by hardware restrictions
2060 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05002061 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07002062 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02002063
Martin K. Petersen13f05c82010-09-10 20:50:10 +02002064 if (scsi_host_prot_dma(shost)) {
2065 shost->sg_prot_tablesize =
2066 min_not_zero(shost->sg_prot_tablesize,
2067 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
2068 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
2069 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
2070 }
2071
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05002072 blk_queue_max_hw_sectors(q, shost->max_sectors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
2074 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08002075 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076
FUJITA Tomonori860ac562008-02-04 22:28:05 -08002077 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
2078
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01002080 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06002081
2082 /*
2083 * set a reasonable default alignment on word boundaries: the
2084 * host and device may alter it using
2085 * blk_queue_update_dma_alignment() later.
2086 */
2087 blk_queue_dma_alignment(q, 0x03);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002088}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002089EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06002090
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002091static int scsi_init_rq(struct request_queue *q, struct request *rq, gfp_t gfp)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002092{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002093 struct Scsi_Host *shost = q->rq_alloc_data;
2094 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002095
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002096 memset(cmd, 0, sizeof(*cmd));
2097
2098 cmd->sense_buffer = scsi_alloc_sense_buffer(shost, gfp, NUMA_NO_NODE);
2099 if (!cmd->sense_buffer)
2100 goto fail;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002101 cmd->req.sense = cmd->sense_buffer;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002102
2103 if (scsi_host_get_prot(shost) >= SHOST_DIX_TYPE0_PROTECTION) {
2104 cmd->prot_sdb = kmem_cache_zalloc(scsi_sdb_cache, gfp);
2105 if (!cmd->prot_sdb)
2106 goto fail_free_sense;
2107 }
2108
2109 return 0;
2110
2111fail_free_sense:
2112 scsi_free_sense_buffer(shost, cmd->sense_buffer);
2113fail:
2114 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115}
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002116
2117static void scsi_exit_rq(struct request_queue *q, struct request *rq)
2118{
2119 struct Scsi_Host *shost = q->rq_alloc_data;
2120 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2121
2122 if (cmd->prot_sdb)
2123 kmem_cache_free(scsi_sdb_cache, cmd->prot_sdb);
2124 scsi_free_sense_buffer(shost, cmd->sense_buffer);
2125}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002126
2127struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
2128{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002129 struct Scsi_Host *shost = sdev->host;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002130 struct request_queue *q;
2131
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002132 q = blk_alloc_queue_node(GFP_KERNEL, NUMA_NO_NODE);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002133 if (!q)
2134 return NULL;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002135 q->cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
2136 q->rq_alloc_data = shost;
2137 q->request_fn = scsi_request_fn;
2138 q->init_rq_fn = scsi_init_rq;
2139 q->exit_rq_fn = scsi_exit_rq;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07002140 q->initialize_rq_fn = scsi_initialize_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,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07002165 .initialize_rq_fn = scsi_initialize_rq,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002166 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01002167};
2168
2169struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
2170{
2171 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
2172 if (IS_ERR(sdev->request_queue))
2173 return NULL;
2174
2175 sdev->request_queue->queuedata = sdev;
2176 __scsi_init_queue(sdev->host, sdev->request_queue);
2177 return sdev->request_queue;
2178}
2179
2180int scsi_mq_setup_tags(struct Scsi_Host *shost)
2181{
2182 unsigned int cmd_size, sgl_size, tbl_size;
2183
2184 tbl_size = shost->sg_tablesize;
Ming Lin65e86172016-04-04 14:48:10 -07002185 if (tbl_size > SG_CHUNK_SIZE)
2186 tbl_size = SG_CHUNK_SIZE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002187 sgl_size = tbl_size * sizeof(struct scatterlist);
2188 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
2189 if (scsi_host_get_prot(shost))
2190 cmd_size += sizeof(struct scsi_data_buffer) + sgl_size;
2191
2192 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
2193 shost->tag_set.ops = &scsi_mq_ops;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01002194 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002195 shost->tag_set.queue_depth = shost->can_queue;
2196 shost->tag_set.cmd_size = cmd_size;
2197 shost->tag_set.numa_node = NUMA_NO_NODE;
2198 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07002199 shost->tag_set.flags |=
2200 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002201 shost->tag_set.driver_data = shost;
2202
2203 return blk_mq_alloc_tag_set(&shost->tag_set);
2204}
2205
2206void scsi_mq_destroy_tags(struct Scsi_Host *shost)
2207{
2208 blk_mq_free_tag_set(&shost->tag_set);
2209}
2210
Hannes Reinecke857de6e2017-02-17 09:02:45 +01002211/**
2212 * scsi_device_from_queue - return sdev associated with a request_queue
2213 * @q: The request queue to return the sdev from
2214 *
2215 * Return the sdev associated with a request queue or NULL if the
2216 * request_queue does not reference a SCSI device.
2217 */
2218struct scsi_device *scsi_device_from_queue(struct request_queue *q)
2219{
2220 struct scsi_device *sdev = NULL;
2221
2222 if (q->mq_ops) {
2223 if (q->mq_ops == &scsi_mq_ops)
2224 sdev = q->queuedata;
2225 } else if (q->request_fn == scsi_request_fn)
2226 sdev = q->queuedata;
2227 if (!sdev || !get_device(&sdev->sdev_gendev))
2228 sdev = NULL;
2229
2230 return sdev;
2231}
2232EXPORT_SYMBOL_GPL(scsi_device_from_queue);
2233
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234/*
2235 * Function: scsi_block_requests()
2236 *
2237 * Purpose: Utility function used by low-level drivers to prevent further
2238 * commands from being queued to the device.
2239 *
2240 * Arguments: shost - Host in question
2241 *
2242 * Returns: Nothing
2243 *
2244 * Lock status: No locks are assumed held.
2245 *
2246 * Notes: There is no timer nor any other means by which the requests
2247 * get unblocked other than the low-level driver calling
2248 * scsi_unblock_requests().
2249 */
2250void scsi_block_requests(struct Scsi_Host *shost)
2251{
2252 shost->host_self_blocked = 1;
2253}
2254EXPORT_SYMBOL(scsi_block_requests);
2255
2256/*
2257 * Function: scsi_unblock_requests()
2258 *
2259 * Purpose: Utility function used by low-level drivers to allow further
2260 * commands from being queued to the device.
2261 *
2262 * Arguments: shost - Host in question
2263 *
2264 * Returns: Nothing
2265 *
2266 * Lock status: No locks are assumed held.
2267 *
2268 * Notes: There is no timer nor any other means by which the requests
2269 * get unblocked other than the low-level driver calling
2270 * scsi_unblock_requests().
2271 *
2272 * This is done as an API function so that changes to the
2273 * internals of the scsi mid-layer won't require wholesale
2274 * changes to drivers that use this feature.
2275 */
2276void scsi_unblock_requests(struct Scsi_Host *shost)
2277{
2278 shost->host_self_blocked = 0;
2279 scsi_run_host_queues(shost);
2280}
2281EXPORT_SYMBOL(scsi_unblock_requests);
2282
2283int __init scsi_init_queue(void)
2284{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002285 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
2286 sizeof(struct scsi_data_buffer),
2287 0, 0, NULL);
2288 if (!scsi_sdb_cache) {
2289 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09002290 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02002291 }
2292
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 return 0;
2294}
2295
2296void scsi_exit_queue(void)
2297{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002298 kmem_cache_destroy(scsi_sense_cache);
2299 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002300 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301}
James Bottomley5baba832006-03-18 14:10:35 -06002302
2303/**
2304 * scsi_mode_select - issue a mode select
2305 * @sdev: SCSI device to be queried
2306 * @pf: Page format bit (1 == standard, 0 == vendor specific)
2307 * @sp: Save page bit (0 == don't save, 1 == save)
2308 * @modepage: mode page being requested
2309 * @buffer: request buffer (may not be smaller than eight bytes)
2310 * @len: length of request buffer.
2311 * @timeout: command timeout
2312 * @retries: number of retries before failing
2313 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002314 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06002315 * must be SCSI_SENSE_BUFFERSIZE big.
2316 *
2317 * Returns zero if successful; negative error number or scsi
2318 * status on error
2319 *
2320 */
2321int
2322scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2323 unsigned char *buffer, int len, int timeout, int retries,
2324 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2325{
2326 unsigned char cmd[10];
2327 unsigned char *real_buffer;
2328 int ret;
2329
2330 memset(cmd, 0, sizeof(cmd));
2331 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2332
2333 if (sdev->use_10_for_ms) {
2334 if (len > 65535)
2335 return -EINVAL;
2336 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2337 if (!real_buffer)
2338 return -ENOMEM;
2339 memcpy(real_buffer + 8, buffer, len);
2340 len += 8;
2341 real_buffer[0] = 0;
2342 real_buffer[1] = 0;
2343 real_buffer[2] = data->medium_type;
2344 real_buffer[3] = data->device_specific;
2345 real_buffer[4] = data->longlba ? 0x01 : 0;
2346 real_buffer[5] = 0;
2347 real_buffer[6] = data->block_descriptor_length >> 8;
2348 real_buffer[7] = data->block_descriptor_length;
2349
2350 cmd[0] = MODE_SELECT_10;
2351 cmd[7] = len >> 8;
2352 cmd[8] = len;
2353 } else {
2354 if (len > 255 || data->block_descriptor_length > 255 ||
2355 data->longlba)
2356 return -EINVAL;
2357
2358 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2359 if (!real_buffer)
2360 return -ENOMEM;
2361 memcpy(real_buffer + 4, buffer, len);
2362 len += 4;
2363 real_buffer[0] = 0;
2364 real_buffer[1] = data->medium_type;
2365 real_buffer[2] = data->device_specific;
2366 real_buffer[3] = data->block_descriptor_length;
2367
2368
2369 cmd[0] = MODE_SELECT;
2370 cmd[4] = len;
2371 }
2372
2373 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002374 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002375 kfree(real_buffer);
2376 return ret;
2377}
2378EXPORT_SYMBOL_GPL(scsi_mode_select);
2379
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380/**
Rob Landleyeb448202007-11-03 13:30:39 -05002381 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002382 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 * @dbd: set if mode sense will allow block descriptors to be returned
2384 * @modepage: mode page being requested
2385 * @buffer: request buffer (may not be smaller than eight bytes)
2386 * @len: length of request buffer.
2387 * @timeout: command timeout
2388 * @retries: number of retries before failing
2389 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002390 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002391 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 *
2393 * Returns zero if unsuccessful, or the header offset (either 4
2394 * or 8 depending on whether a six or ten byte command was
2395 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002396 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397int
James Bottomley1cf72692005-08-28 11:27:01 -05002398scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002400 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2401{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 unsigned char cmd[12];
2403 int use_10_for_ms;
2404 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002405 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002406 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407
2408 memset(data, 0, sizeof(*data));
2409 memset(&cmd[0], 0, 12);
2410 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2411 cmd[2] = modepage;
2412
James Bottomleyea73a9f2005-08-28 11:33:52 -05002413 /* caller might not be interested in sense, but we need it */
2414 if (!sshdr)
2415 sshdr = &my_sshdr;
2416
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002418 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419
2420 if (use_10_for_ms) {
2421 if (len < 8)
2422 len = 8;
2423
2424 cmd[0] = MODE_SENSE_10;
2425 cmd[8] = len;
2426 header_length = 8;
2427 } else {
2428 if (len < 4)
2429 len = 4;
2430
2431 cmd[0] = MODE_SENSE;
2432 cmd[4] = len;
2433 header_length = 4;
2434 }
2435
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436 memset(buffer, 0, len);
2437
James Bottomley1cf72692005-08-28 11:27:01 -05002438 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002439 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440
2441 /* This code looks awful: what it's doing is making sure an
2442 * ILLEGAL REQUEST sense return identifies the actual command
2443 * byte as the problem. MODE_SENSE commands can return
2444 * ILLEGAL REQUEST if the code page isn't supported */
2445
James Bottomley1cf72692005-08-28 11:27:01 -05002446 if (use_10_for_ms && !scsi_status_is_good(result) &&
2447 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002448 if (scsi_sense_valid(sshdr)) {
2449 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2450 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 /*
2452 * Invalid command operation code
2453 */
James Bottomley1cf72692005-08-28 11:27:01 -05002454 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 goto retry;
2456 }
2457 }
2458 }
2459
James Bottomley1cf72692005-08-28 11:27:01 -05002460 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002461 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2462 (modepage == 6 || modepage == 8))) {
2463 /* Initio breakage? */
2464 header_length = 0;
2465 data->length = 13;
2466 data->medium_type = 0;
2467 data->device_specific = 0;
2468 data->longlba = 0;
2469 data->block_descriptor_length = 0;
2470 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471 data->length = buffer[0]*256 + buffer[1] + 2;
2472 data->medium_type = buffer[2];
2473 data->device_specific = buffer[3];
2474 data->longlba = buffer[4] & 0x01;
2475 data->block_descriptor_length = buffer[6]*256
2476 + buffer[7];
2477 } else {
2478 data->length = buffer[0] + 1;
2479 data->medium_type = buffer[1];
2480 data->device_specific = buffer[2];
2481 data->block_descriptor_length = buffer[3];
2482 }
Al Viro6d73c852006-02-23 02:03:16 +01002483 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002484 } else if ((status_byte(result) == CHECK_CONDITION) &&
2485 scsi_sense_valid(sshdr) &&
2486 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2487 retry_count--;
2488 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 }
2490
James Bottomley1cf72692005-08-28 11:27:01 -05002491 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492}
2493EXPORT_SYMBOL(scsi_mode_sense);
2494
James Bottomley001aac22007-12-02 19:10:40 +02002495/**
2496 * scsi_test_unit_ready - test if unit is ready
2497 * @sdev: scsi device to change the state of.
2498 * @timeout: command timeout
2499 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002500 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002501 *
2502 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002503 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002504 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505int
James Bottomley001aac22007-12-02 19:10:40 +02002506scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002507 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509 char cmd[] = {
2510 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2511 };
2512 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002513
James Bottomley001aac22007-12-02 19:10:40 +02002514 /* try to eat the UNIT_ATTENTION if there are enough retries */
2515 do {
2516 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002517 timeout, retries, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002518 if (sdev->removable && scsi_sense_valid(sshdr) &&
2519 sshdr->sense_key == UNIT_ATTENTION)
2520 sdev->changed = 1;
2521 } while (scsi_sense_valid(sshdr) &&
2522 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002523
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524 return result;
2525}
2526EXPORT_SYMBOL(scsi_test_unit_ready);
2527
2528/**
Rob Landleyeb448202007-11-03 13:30:39 -05002529 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530 * @sdev: scsi device to change the state of.
2531 * @state: state to change to.
2532 *
2533 * Returns zero if unsuccessful or an error if the requested
2534 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002535 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536int
2537scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2538{
2539 enum scsi_device_state oldstate = sdev->sdev_state;
2540
2541 if (state == oldstate)
2542 return 0;
2543
2544 switch (state) {
2545 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002546 switch (oldstate) {
2547 case SDEV_CREATED_BLOCK:
2548 break;
2549 default:
2550 goto illegal;
2551 }
2552 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553
2554 case SDEV_RUNNING:
2555 switch (oldstate) {
2556 case SDEV_CREATED:
2557 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002558 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559 case SDEV_QUIESCE:
2560 case SDEV_BLOCK:
2561 break;
2562 default:
2563 goto illegal;
2564 }
2565 break;
2566
2567 case SDEV_QUIESCE:
2568 switch (oldstate) {
2569 case SDEV_RUNNING:
2570 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002571 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 break;
2573 default:
2574 goto illegal;
2575 }
2576 break;
2577
2578 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002579 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580 switch (oldstate) {
2581 case SDEV_CREATED:
2582 case SDEV_RUNNING:
2583 case SDEV_QUIESCE:
2584 case SDEV_BLOCK:
2585 break;
2586 default:
2587 goto illegal;
2588 }
2589 break;
2590
2591 case SDEV_BLOCK:
2592 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002594 case SDEV_CREATED_BLOCK:
2595 break;
2596 default:
2597 goto illegal;
2598 }
2599 break;
2600
2601 case SDEV_CREATED_BLOCK:
2602 switch (oldstate) {
2603 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604 break;
2605 default:
2606 goto illegal;
2607 }
2608 break;
2609
2610 case SDEV_CANCEL:
2611 switch (oldstate) {
2612 case SDEV_CREATED:
2613 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002614 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002615 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002616 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617 case SDEV_BLOCK:
2618 break;
2619 default:
2620 goto illegal;
2621 }
2622 break;
2623
2624 case SDEV_DEL:
2625 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002626 case SDEV_CREATED:
2627 case SDEV_RUNNING:
2628 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002629 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002630 case SDEV_CANCEL:
Bart Van Assche0516c082013-07-02 15:06:33 +02002631 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632 break;
2633 default:
2634 goto illegal;
2635 }
2636 break;
2637
2638 }
2639 sdev->sdev_state = state;
2640 return 0;
2641
2642 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002643 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002644 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002645 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002646 scsi_device_state_name(oldstate),
2647 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 );
2649 return -EINVAL;
2650}
2651EXPORT_SYMBOL(scsi_device_set_state);
2652
2653/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002654 * sdev_evt_emit - emit a single SCSI device uevent
2655 * @sdev: associated SCSI device
2656 * @evt: event to emit
2657 *
2658 * Send a single uevent (scsi_event) to the associated scsi_device.
2659 */
2660static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2661{
2662 int idx = 0;
2663 char *envp[3];
2664
2665 switch (evt->evt_type) {
2666 case SDEV_EVT_MEDIA_CHANGE:
2667 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2668 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002669 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002670 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002671 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2672 break;
2673 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2674 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2675 break;
2676 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2677 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2678 break;
2679 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2680 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2681 break;
2682 case SDEV_EVT_LUN_CHANGE_REPORTED:
2683 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2684 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002685 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2686 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2687 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002688 default:
2689 /* do nothing */
2690 break;
2691 }
2692
2693 envp[idx++] = NULL;
2694
2695 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2696}
2697
2698/**
2699 * sdev_evt_thread - send a uevent for each scsi event
2700 * @work: work struct for scsi_device
2701 *
2702 * Dispatch queued events to their associated scsi_device kobjects
2703 * as uevents.
2704 */
2705void scsi_evt_thread(struct work_struct *work)
2706{
2707 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002708 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002709 LIST_HEAD(event_list);
2710
2711 sdev = container_of(work, struct scsi_device, event_work);
2712
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002713 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2714 if (test_and_clear_bit(evt_type, sdev->pending_events))
2715 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2716
Jeff Garzika341cd02007-10-29 17:15:22 -04002717 while (1) {
2718 struct scsi_event *evt;
2719 struct list_head *this, *tmp;
2720 unsigned long flags;
2721
2722 spin_lock_irqsave(&sdev->list_lock, flags);
2723 list_splice_init(&sdev->event_list, &event_list);
2724 spin_unlock_irqrestore(&sdev->list_lock, flags);
2725
2726 if (list_empty(&event_list))
2727 break;
2728
2729 list_for_each_safe(this, tmp, &event_list) {
2730 evt = list_entry(this, struct scsi_event, node);
2731 list_del(&evt->node);
2732 scsi_evt_emit(sdev, evt);
2733 kfree(evt);
2734 }
2735 }
2736}
2737
2738/**
2739 * sdev_evt_send - send asserted event to uevent thread
2740 * @sdev: scsi_device event occurred on
2741 * @evt: event to send
2742 *
2743 * Assert scsi device event asynchronously.
2744 */
2745void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2746{
2747 unsigned long flags;
2748
Kay Sievers4d1566e2008-03-19 13:04:47 +01002749#if 0
2750 /* FIXME: currently this check eliminates all media change events
2751 * for polled devices. Need to update to discriminate between AN
2752 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002753 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2754 kfree(evt);
2755 return;
2756 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002757#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002758
2759 spin_lock_irqsave(&sdev->list_lock, flags);
2760 list_add_tail(&evt->node, &sdev->event_list);
2761 schedule_work(&sdev->event_work);
2762 spin_unlock_irqrestore(&sdev->list_lock, flags);
2763}
2764EXPORT_SYMBOL_GPL(sdev_evt_send);
2765
2766/**
2767 * sdev_evt_alloc - allocate a new scsi event
2768 * @evt_type: type of event to allocate
2769 * @gfpflags: GFP flags for allocation
2770 *
2771 * Allocates and returns a new scsi_event.
2772 */
2773struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2774 gfp_t gfpflags)
2775{
2776 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2777 if (!evt)
2778 return NULL;
2779
2780 evt->evt_type = evt_type;
2781 INIT_LIST_HEAD(&evt->node);
2782
2783 /* evt_type-specific initialization, if any */
2784 switch (evt_type) {
2785 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002786 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2787 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2788 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2789 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2790 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002791 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002792 default:
2793 /* do nothing */
2794 break;
2795 }
2796
2797 return evt;
2798}
2799EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2800
2801/**
2802 * sdev_evt_send_simple - send asserted event to uevent thread
2803 * @sdev: scsi_device event occurred on
2804 * @evt_type: type of event to send
2805 * @gfpflags: GFP flags for allocation
2806 *
2807 * Assert scsi device event asynchronously, given an event type.
2808 */
2809void sdev_evt_send_simple(struct scsi_device *sdev,
2810 enum scsi_device_event evt_type, gfp_t gfpflags)
2811{
2812 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2813 if (!evt) {
2814 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2815 evt_type);
2816 return;
2817 }
2818
2819 sdev_evt_send(sdev, evt);
2820}
2821EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2822
2823/**
Bart Van Assche669f0442016-11-22 16:17:13 -08002824 * scsi_request_fn_active() - number of kernel threads inside scsi_request_fn()
2825 * @sdev: SCSI device to count the number of scsi_request_fn() callers for.
2826 */
2827static int scsi_request_fn_active(struct scsi_device *sdev)
2828{
2829 struct request_queue *q = sdev->request_queue;
2830 int request_fn_active;
2831
2832 WARN_ON_ONCE(sdev->host->use_blk_mq);
2833
2834 spin_lock_irq(q->queue_lock);
2835 request_fn_active = q->request_fn_active;
2836 spin_unlock_irq(q->queue_lock);
2837
2838 return request_fn_active;
2839}
2840
2841/**
2842 * scsi_wait_for_queuecommand() - wait for ongoing queuecommand() calls
2843 * @sdev: SCSI device pointer.
2844 *
2845 * Wait until the ongoing shost->hostt->queuecommand() calls that are
2846 * invoked from scsi_request_fn() have finished.
2847 */
2848static void scsi_wait_for_queuecommand(struct scsi_device *sdev)
2849{
2850 WARN_ON_ONCE(sdev->host->use_blk_mq);
2851
2852 while (scsi_request_fn_active(sdev))
2853 msleep(20);
2854}
2855
2856/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002857 * scsi_device_quiesce - Block user issued commands.
2858 * @sdev: scsi device to quiesce.
2859 *
2860 * This works by trying to transition to the SDEV_QUIESCE state
2861 * (which must be a legal transition). When the device is in this
2862 * state, only special requests will be accepted, all others will
2863 * be deferred. Since special requests may also be requeued requests,
2864 * a successful return doesn't guarantee the device will be
2865 * totally quiescent.
2866 *
2867 * Must be called with user context, may sleep.
2868 *
2869 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002870 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002871int
2872scsi_device_quiesce(struct scsi_device *sdev)
2873{
2874 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2875 if (err)
2876 return err;
2877
2878 scsi_run_queue(sdev->request_queue);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02002879 while (atomic_read(&sdev->device_busy)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880 msleep_interruptible(200);
2881 scsi_run_queue(sdev->request_queue);
2882 }
2883 return 0;
2884}
2885EXPORT_SYMBOL(scsi_device_quiesce);
2886
2887/**
2888 * scsi_device_resume - Restart user issued commands to a quiesced device.
2889 * @sdev: scsi device to resume.
2890 *
2891 * Moves the device from quiesced back to running and restarts the
2892 * queues.
2893 *
2894 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002895 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002896void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002897{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002898 /* check if the device state was mutated prior to resume, and if
2899 * so assume the state is being managed elsewhere (for example
2900 * device deleted during suspend)
2901 */
2902 if (sdev->sdev_state != SDEV_QUIESCE ||
2903 scsi_device_set_state(sdev, SDEV_RUNNING))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904 return;
2905 scsi_run_queue(sdev->request_queue);
2906}
2907EXPORT_SYMBOL(scsi_device_resume);
2908
2909static void
2910device_quiesce_fn(struct scsi_device *sdev, void *data)
2911{
2912 scsi_device_quiesce(sdev);
2913}
2914
2915void
2916scsi_target_quiesce(struct scsi_target *starget)
2917{
2918 starget_for_each_device(starget, NULL, device_quiesce_fn);
2919}
2920EXPORT_SYMBOL(scsi_target_quiesce);
2921
2922static void
2923device_resume_fn(struct scsi_device *sdev, void *data)
2924{
2925 scsi_device_resume(sdev);
2926}
2927
2928void
2929scsi_target_resume(struct scsi_target *starget)
2930{
2931 starget_for_each_device(starget, NULL, device_resume_fn);
2932}
2933EXPORT_SYMBOL(scsi_target_resume);
2934
2935/**
Rob Landleyeb448202007-11-03 13:30:39 -05002936 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937 * @sdev: device to block
Bart Van Assche8893cf62017-03-01 09:00:36 -08002938 * @wait: Whether or not to wait until ongoing .queuecommand() /
2939 * .queue_rq() calls have finished.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940 *
2941 * Block request made by scsi lld's to temporarily stop all
Bart Van Assche669f0442016-11-22 16:17:13 -08002942 * scsi commands on the specified device. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002943 *
2944 * Returns zero if successful or error if not
2945 *
2946 * Notes:
2947 * This routine transitions the device to the SDEV_BLOCK state
2948 * (which must be a legal transition). When the device is in this
2949 * state, all commands are deferred until the scsi lld reenables
2950 * the device with scsi_device_unblock or device_block_tmo fires.
Bart Van Assche669f0442016-11-22 16:17:13 -08002951 *
2952 * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
2953 * scsi_internal_device_block() has blocked a SCSI device and also
2954 * remove the rport mutex lock and unlock calls from srp_queuecommand().
Rob Landleyeb448202007-11-03 13:30:39 -05002955 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002956int
Bart Van Assche8893cf62017-03-01 09:00:36 -08002957scsi_internal_device_block(struct scsi_device *sdev, bool wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002958{
Jens Axboe165125e2007-07-24 09:28:11 +02002959 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002960 unsigned long flags;
2961 int err = 0;
2962
2963 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002964 if (err) {
2965 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2966
2967 if (err)
2968 return err;
2969 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002970
2971 /*
2972 * The device has transitioned to SDEV_BLOCK. Stop the
2973 * block layer from calling the midlayer with this device's
2974 * request queue.
2975 */
Christoph Hellwigd2852032014-01-17 12:06:53 +01002976 if (q->mq_ops) {
Bart Van Assche8893cf62017-03-01 09:00:36 -08002977 if (wait)
2978 blk_mq_quiesce_queue(q);
2979 else
Ming Leif6601742017-06-06 23:22:04 +08002980 blk_mq_quiesce_queue_nowait(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002981 } else {
2982 spin_lock_irqsave(q->queue_lock, flags);
2983 blk_stop_queue(q);
2984 spin_unlock_irqrestore(q->queue_lock, flags);
Bart Van Assche8893cf62017-03-01 09:00:36 -08002985 if (wait)
2986 scsi_wait_for_queuecommand(sdev);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002987 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002988
2989 return 0;
2990}
2991EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2992
2993/**
2994 * scsi_internal_device_unblock - resume a device after a block request
2995 * @sdev: device to resume
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002996 * @new_state: state to set devices to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002997 *
2998 * Called by scsi lld's or the midlayer to restart the device queue
2999 * for the previously suspended scsi device. Called from interrupt or
3000 * normal process context.
3001 *
3002 * Returns zero if successful or error if not.
3003 *
3004 * Notes:
3005 * This routine transitions the device to the SDEV_RUNNING state
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003006 * or to one of the offline states (which must be a legal transition)
Mike Christied0754982012-05-17 23:56:58 -05003007 * allowing the midlayer to goose the queue for this device.
Rob Landleyeb448202007-11-03 13:30:39 -05003008 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003009int
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003010scsi_internal_device_unblock(struct scsi_device *sdev,
3011 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003012{
Jens Axboe165125e2007-07-24 09:28:11 +02003013 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003014 unsigned long flags;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003015
3016 /*
3017 * Try to transition the scsi device to SDEV_RUNNING or one of the
3018 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003019 */
Vikas Chaudhary0e580762012-08-09 04:51:30 -04003020 if ((sdev->sdev_state == SDEV_BLOCK) ||
3021 (sdev->sdev_state == SDEV_TRANSPORT_OFFLINE))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003022 sdev->sdev_state = new_state;
3023 else if (sdev->sdev_state == SDEV_CREATED_BLOCK) {
3024 if (new_state == SDEV_TRANSPORT_OFFLINE ||
3025 new_state == SDEV_OFFLINE)
3026 sdev->sdev_state = new_state;
3027 else
3028 sdev->sdev_state = SDEV_CREATED;
3029 } else if (sdev->sdev_state != SDEV_CANCEL &&
Mike Christie986fe6c2010-10-06 03:10:59 -05003030 sdev->sdev_state != SDEV_OFFLINE)
Takahiro Yasui5c10e632009-04-29 12:13:02 -04003031 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003032
Christoph Hellwigd2852032014-01-17 12:06:53 +01003033 if (q->mq_ops) {
Ming Leif6601742017-06-06 23:22:04 +08003034 blk_mq_unquiesce_queue(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +01003035 } else {
3036 spin_lock_irqsave(q->queue_lock, flags);
3037 blk_start_queue(q);
3038 spin_unlock_irqrestore(q->queue_lock, flags);
3039 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040
3041 return 0;
3042}
3043EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
3044
3045static void
3046device_block(struct scsi_device *sdev, void *data)
3047{
Bart Van Assche8893cf62017-03-01 09:00:36 -08003048 scsi_internal_device_block(sdev, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003049}
3050
3051static int
3052target_block(struct device *dev, void *data)
3053{
3054 if (scsi_is_target_device(dev))
3055 starget_for_each_device(to_scsi_target(dev), NULL,
3056 device_block);
3057 return 0;
3058}
3059
3060void
3061scsi_target_block(struct device *dev)
3062{
3063 if (scsi_is_target_device(dev))
3064 starget_for_each_device(to_scsi_target(dev), NULL,
3065 device_block);
3066 else
3067 device_for_each_child(dev, NULL, target_block);
3068}
3069EXPORT_SYMBOL_GPL(scsi_target_block);
3070
3071static void
3072device_unblock(struct scsi_device *sdev, void *data)
3073{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003074 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003075}
3076
3077static int
3078target_unblock(struct device *dev, void *data)
3079{
3080 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003081 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082 device_unblock);
3083 return 0;
3084}
3085
3086void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003087scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003088{
3089 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003090 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003091 device_unblock);
3092 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003093 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003094}
3095EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003096
3097/**
3098 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05003099 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003100 * @sg_count: number of segments in sg
3101 * @offset: offset in bytes into sg, on return offset into the mapped area
3102 * @len: bytes to map, on return number of bytes mapped
3103 *
3104 * Returns virtual address of the start of the mapped page
3105 */
Jens Axboec6132da2007-10-16 11:08:49 +02003106void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003107 size_t *offset, size_t *len)
3108{
3109 int i;
3110 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02003111 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003112 struct page *page;
3113
Andrew Morton22cfefb2007-02-05 16:39:03 -08003114 WARN_ON(!irqs_disabled());
3115
Jens Axboec6132da2007-10-16 11:08:49 +02003116 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003117 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02003118 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003119 if (sg_len > *offset)
3120 break;
3121 }
3122
3123 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07003124 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
3125 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07003126 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003127 WARN_ON(1);
3128 return NULL;
3129 }
3130
3131 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02003132 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003133
3134 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02003135 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003136 *offset &= ~PAGE_MASK;
3137
3138 /* Bytes in this sg-entry from *offset to the end of the page */
3139 sg_len = PAGE_SIZE - *offset;
3140 if (*len > sg_len)
3141 *len = sg_len;
3142
Cong Wang77dfce02011-11-25 23:14:23 +08003143 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003144}
3145EXPORT_SYMBOL(scsi_kmap_atomic_sg);
3146
3147/**
Rob Landleyeb448202007-11-03 13:30:39 -05003148 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003149 * @virt: virtual address to be unmapped
3150 */
3151void scsi_kunmap_atomic_sg(void *virt)
3152{
Cong Wang77dfce02011-11-25 23:14:23 +08003153 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003154}
3155EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08003156
3157void sdev_disable_disk_events(struct scsi_device *sdev)
3158{
3159 atomic_inc(&sdev->disk_events_disable_depth);
3160}
3161EXPORT_SYMBOL(sdev_disable_disk_events);
3162
3163void sdev_enable_disk_events(struct scsi_device *sdev)
3164{
3165 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
3166 return;
3167 atomic_dec(&sdev->disk_events_disable_depth);
3168}
3169EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003170
3171/**
3172 * scsi_vpd_lun_id - return a unique device identification
3173 * @sdev: SCSI device
3174 * @id: buffer for the identification
3175 * @id_len: length of the buffer
3176 *
3177 * Copies a unique device identification into @id based
3178 * on the information in the VPD page 0x83 of the device.
3179 * The string will be formatted as a SCSI name string.
3180 *
3181 * Returns the length of the identification or error on failure.
3182 * If the identifier is longer than the supplied buffer the actual
3183 * identifier length is returned and the buffer is not zero-padded.
3184 */
3185int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
3186{
3187 u8 cur_id_type = 0xff;
3188 u8 cur_id_size = 0;
3189 unsigned char *d, *cur_id_str;
3190 unsigned char __rcu *vpd_pg83;
3191 int id_size = -EINVAL;
3192
3193 rcu_read_lock();
3194 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3195 if (!vpd_pg83) {
3196 rcu_read_unlock();
3197 return -ENXIO;
3198 }
3199
3200 /*
3201 * Look for the correct descriptor.
3202 * Order of preference for lun descriptor:
3203 * - SCSI name string
3204 * - NAA IEEE Registered Extended
3205 * - EUI-64 based 16-byte
3206 * - EUI-64 based 12-byte
3207 * - NAA IEEE Registered
3208 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02003209 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003210 * as longer descriptors reduce the likelyhood
3211 * of identification clashes.
3212 */
3213
3214 /* The id string must be at least 20 bytes + terminating NULL byte */
3215 if (id_len < 21) {
3216 rcu_read_unlock();
3217 return -EINVAL;
3218 }
3219
3220 memset(id, 0, id_len);
3221 d = vpd_pg83 + 4;
3222 while (d < vpd_pg83 + sdev->vpd_pg83_len) {
3223 /* Skip designators not referring to the LUN */
3224 if ((d[1] & 0x30) != 0x00)
3225 goto next_desig;
3226
3227 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02003228 case 0x1:
3229 /* T10 Vendor ID */
3230 if (cur_id_size > d[3])
3231 break;
3232 /* Prefer anything */
3233 if (cur_id_type > 0x01 && cur_id_type != 0xff)
3234 break;
3235 cur_id_size = d[3];
3236 if (cur_id_size + 4 > id_len)
3237 cur_id_size = id_len - 4;
3238 cur_id_str = d + 4;
3239 cur_id_type = d[1] & 0xf;
3240 id_size = snprintf(id, id_len, "t10.%*pE",
3241 cur_id_size, cur_id_str);
3242 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003243 case 0x2:
3244 /* EUI-64 */
3245 if (cur_id_size > d[3])
3246 break;
3247 /* Prefer NAA IEEE Registered Extended */
3248 if (cur_id_type == 0x3 &&
3249 cur_id_size == d[3])
3250 break;
3251 cur_id_size = d[3];
3252 cur_id_str = d + 4;
3253 cur_id_type = d[1] & 0xf;
3254 switch (cur_id_size) {
3255 case 8:
3256 id_size = snprintf(id, id_len,
3257 "eui.%8phN",
3258 cur_id_str);
3259 break;
3260 case 12:
3261 id_size = snprintf(id, id_len,
3262 "eui.%12phN",
3263 cur_id_str);
3264 break;
3265 case 16:
3266 id_size = snprintf(id, id_len,
3267 "eui.%16phN",
3268 cur_id_str);
3269 break;
3270 default:
3271 cur_id_size = 0;
3272 break;
3273 }
3274 break;
3275 case 0x3:
3276 /* NAA */
3277 if (cur_id_size > d[3])
3278 break;
3279 cur_id_size = d[3];
3280 cur_id_str = d + 4;
3281 cur_id_type = d[1] & 0xf;
3282 switch (cur_id_size) {
3283 case 8:
3284 id_size = snprintf(id, id_len,
3285 "naa.%8phN",
3286 cur_id_str);
3287 break;
3288 case 16:
3289 id_size = snprintf(id, id_len,
3290 "naa.%16phN",
3291 cur_id_str);
3292 break;
3293 default:
3294 cur_id_size = 0;
3295 break;
3296 }
3297 break;
3298 case 0x8:
3299 /* SCSI name string */
3300 if (cur_id_size + 4 > d[3])
3301 break;
3302 /* Prefer others for truncated descriptor */
3303 if (cur_id_size && d[3] > id_len)
3304 break;
3305 cur_id_size = id_size = d[3];
3306 cur_id_str = d + 4;
3307 cur_id_type = d[1] & 0xf;
3308 if (cur_id_size >= id_len)
3309 cur_id_size = id_len - 1;
3310 memcpy(id, cur_id_str, cur_id_size);
3311 /* Decrease priority for truncated descriptor */
3312 if (cur_id_size != id_size)
3313 cur_id_size = 6;
3314 break;
3315 default:
3316 break;
3317 }
3318next_desig:
3319 d += d[3] + 4;
3320 }
3321 rcu_read_unlock();
3322
3323 return id_size;
3324}
3325EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003326
3327/*
3328 * scsi_vpd_tpg_id - return a target port group identifier
3329 * @sdev: SCSI device
3330 *
3331 * Returns the Target Port Group identifier from the information
3332 * froom VPD page 0x83 of the device.
3333 *
3334 * Returns the identifier or error on failure.
3335 */
3336int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3337{
3338 unsigned char *d;
3339 unsigned char __rcu *vpd_pg83;
3340 int group_id = -EAGAIN, rel_port = -1;
3341
3342 rcu_read_lock();
3343 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3344 if (!vpd_pg83) {
3345 rcu_read_unlock();
3346 return -ENXIO;
3347 }
3348
3349 d = sdev->vpd_pg83 + 4;
3350 while (d < sdev->vpd_pg83 + sdev->vpd_pg83_len) {
3351 switch (d[1] & 0xf) {
3352 case 0x4:
3353 /* Relative target port */
3354 rel_port = get_unaligned_be16(&d[6]);
3355 break;
3356 case 0x5:
3357 /* Target port group */
3358 group_id = get_unaligned_be16(&d[6]);
3359 break;
3360 default:
3361 break;
3362 }
3363 d += d[3] + 4;
3364 }
3365 rcu_read_unlock();
3366
3367 if (group_id >= 0 && rel_id && rel_port != -1)
3368 *rel_id = rel_port;
3369
3370 return group_id;
3371}
3372EXPORT_SYMBOL(scsi_vpd_tpg_id);