blob: 696d2eae0ba685eeaee6583c39108ca3de7bceb3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Christoph Hellwigd2852032014-01-17 12:06:53 +01002 * Copyright (C) 1999 Eric Youngdale
3 * Copyright (C) 2014 Christoph Hellwig
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 * SCSI queueing library.
6 * Initial versions: Eric Youngdale (eric@andante.org).
7 * Based upon conversations with large numbers
8 * of people at Linux Expo.
9 */
10
11#include <linux/bio.h>
James Bottomleyd3f46f32008-01-15 11:11:46 -060012#include <linux/bitops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/blkdev.h>
14#include <linux/completion.h>
15#include <linux/kernel.h>
Paul Gortmaker09703662011-05-27 09:37:25 -040016#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/init.h>
18#include <linux/pci.h>
19#include <linux/delay.h>
James Bottomleyfaead262006-02-14 10:42:07 -060020#include <linux/hardirq.h>
Jens Axboec6132da2007-10-16 11:08:49 +020021#include <linux/scatterlist.h>
Christoph Hellwigd2852032014-01-17 12:06:53 +010022#include <linux/blk-mq.h>
Hannes Reineckef1569ff2014-10-24 14:27:07 +020023#include <linux/ratelimit.h>
Hannes Reineckea8aa3972015-12-01 10:16:57 +010024#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020027#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <scsi/scsi_dbg.h>
29#include <scsi/scsi_device.h>
30#include <scsi/scsi_driver.h>
31#include <scsi/scsi_eh.h>
32#include <scsi/scsi_host.h>
Bart Van Assche7aa686d2017-05-02 10:45:03 -070033#include <scsi/scsi_transport.h> /* __scsi_init_queue() */
Christoph Hellwigee14c672015-08-27 14:16:59 +020034#include <scsi/scsi_dh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Christoph Hellwig3b5382c2014-05-06 12:25:40 +020036#include <trace/events/scsi.h>
37
Bart Van Assche0eebd002017-04-26 13:47:57 -070038#include "scsi_debugfs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include "scsi_priv.h"
40#include "scsi_logging.h"
41
Christoph Hellwige9c787e2017-01-02 21:55:26 +030042static struct kmem_cache *scsi_sdb_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030043static struct kmem_cache *scsi_sense_cache;
44static struct kmem_cache *scsi_sense_isadma_cache;
45static DEFINE_MUTEX(scsi_sense_cache_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030047static inline struct kmem_cache *
Bart Van Assche8e688252017-06-02 14:21:52 -070048scsi_select_sense_cache(bool unchecked_isa_dma)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030049{
Bart Van Assche8e688252017-06-02 14:21:52 -070050 return unchecked_isa_dma ? scsi_sense_isadma_cache : scsi_sense_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030051}
52
Bart Van Assche8e688252017-06-02 14:21:52 -070053static void scsi_free_sense_buffer(bool unchecked_isa_dma,
54 unsigned char *sense_buffer)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030055{
Bart Van Assche8e688252017-06-02 14:21:52 -070056 kmem_cache_free(scsi_select_sense_cache(unchecked_isa_dma),
57 sense_buffer);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030058}
59
Bart Van Assche8e688252017-06-02 14:21:52 -070060static unsigned char *scsi_alloc_sense_buffer(bool unchecked_isa_dma,
Christoph Hellwige9c787e2017-01-02 21:55:26 +030061 gfp_t gfp_mask, int numa_node)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030062{
Bart Van Assche8e688252017-06-02 14:21:52 -070063 return kmem_cache_alloc_node(scsi_select_sense_cache(unchecked_isa_dma),
64 gfp_mask, numa_node);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030065}
66
67int scsi_init_sense_cache(struct Scsi_Host *shost)
68{
69 struct kmem_cache *cache;
70 int ret = 0;
71
Bart Van Assche8e688252017-06-02 14:21:52 -070072 cache = scsi_select_sense_cache(shost->unchecked_isa_dma);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030073 if (cache)
74 return 0;
75
76 mutex_lock(&scsi_sense_cache_mutex);
77 if (shost->unchecked_isa_dma) {
78 scsi_sense_isadma_cache =
79 kmem_cache_create("scsi_sense_cache(DMA)",
80 SCSI_SENSE_BUFFERSIZE, 0,
81 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
82 if (!scsi_sense_isadma_cache)
83 ret = -ENOMEM;
84 } else {
85 scsi_sense_cache =
86 kmem_cache_create("scsi_sense_cache",
87 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN, NULL);
88 if (!scsi_sense_cache)
89 ret = -ENOMEM;
90 }
91
92 mutex_unlock(&scsi_sense_cache_mutex);
93 return ret;
94}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +020095
Jens Axboea488e742010-04-16 21:13:15 +020096/*
97 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
98 * not change behaviour from the previous unplug mechanism, experimentation
99 * may prove this needs changing.
100 */
101#define SCSI_QUEUE_DELAY 3
102
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100103static void
104scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
106 struct Scsi_Host *host = cmd->device->host;
107 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500108 struct scsi_target *starget = scsi_target(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900111 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 *
113 * If the host/device isn't busy, assume that something actually
114 * completed, and that we should be able to queue a command now.
115 *
116 * Note that the prior mid-layer assumption that any host could
117 * always queue at least one command is now broken. The mid-layer
118 * will implement a user specifiable stall (see
119 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
120 * if a command is requeued with no other commands outstanding
121 * either for the device or for the host.
122 */
Mike Christief0c0a372008-08-17 15:24:38 -0500123 switch (reason) {
124 case SCSI_MLQUEUE_HOST_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100125 atomic_set(&host->host_blocked, host->max_host_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500126 break;
127 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400128 case SCSI_MLQUEUE_EH_RETRY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100129 atomic_set(&device->device_blocked,
130 device->max_device_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500131 break;
132 case SCSI_MLQUEUE_TARGET_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100133 atomic_set(&starget->target_blocked,
134 starget->max_target_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500135 break;
136 }
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100137}
138
Christoph Hellwigd2852032014-01-17 12:06:53 +0100139static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
140{
141 struct scsi_device *sdev = cmd->device;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100142
Bart Van Assche2b053ac2016-10-28 17:21:41 -0700143 blk_mq_requeue_request(cmd->request, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100144 put_device(&sdev->sdev_gendev);
145}
146
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100147/**
148 * __scsi_queue_insert - private queue insertion
149 * @cmd: The SCSI command being requeued
150 * @reason: The reason for the requeue
151 * @unbusy: Whether the queue should be unbusied
152 *
153 * This is a private queue insertion. The public interface
154 * scsi_queue_insert() always assumes the queue should be unbusied
155 * because it's always called before the completion. This function is
156 * for a requeue after completion, which should only occur in this
157 * file.
158 */
159static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
160{
161 struct scsi_device *device = cmd->device;
162 struct request_queue *q = device->request_queue;
163 unsigned long flags;
164
165 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
166 "Inserting command %p into mlqueue\n", cmd));
167
168 scsi_set_blocked(cmd, reason);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 * Decrement the counters, since these commands are no longer
172 * active on the host/device.
173 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600174 if (unbusy)
175 scsi_device_unbusy(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500178 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000179 * that are already in the queue. Schedule requeue work under
180 * lock such that the kblockd_schedule_work() call happens
181 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200182 */
Alan Stern644373a2014-03-28 10:51:15 -0700183 cmd->result = 0;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100184 if (q->mq_ops) {
185 scsi_mq_requeue_cmd(cmd);
186 return;
187 }
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500188 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley59897da2005-09-14 12:57:42 -0400189 blk_requeue_request(q, cmd->request);
Jens Axboe59c3d452014-04-08 09:15:35 -0600190 kblockd_schedule_work(&device->requeue_work);
Bart Van Asscheb4854622012-06-29 15:36:07 +0000191 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192}
193
James Bottomley4f5299a2009-01-02 10:42:21 -0600194/*
195 * Function: scsi_queue_insert()
196 *
197 * Purpose: Insert a command in the midlevel queue.
198 *
199 * Arguments: cmd - command that we are adding to queue.
200 * reason - why we are inserting command to queue.
201 *
202 * Lock status: Assumed that lock is not held upon entry.
203 *
204 * Returns: Nothing.
205 *
206 * Notes: We do this for one of two cases. Either the host is busy
207 * and it cannot accept any more commands for the time being,
208 * or the device returned QUEUE_FULL and can accept no more
209 * commands.
210 * Notes: This could be called either from an interrupt context or a
211 * normal process context.
212 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000213void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600214{
Bart Van Assche84feb162012-06-29 15:35:05 +0000215 __scsi_queue_insert(cmd, reason, 1);
James Bottomley4f5299a2009-01-02 10:42:21 -0600216}
Christoph Hellwige8064022016-10-20 15:12:13 +0200217
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100218
219/**
220 * scsi_execute - insert request and wait for the result
221 * @sdev: scsi device
222 * @cmd: scsi command
223 * @data_direction: data direction
224 * @buffer: data buffer
225 * @bufflen: len of buffer
226 * @sense: optional sense buffer
227 * @sshdr: optional decoded sense header
228 * @timeout: request timeout in seconds
229 * @retries: number of times to retry request
230 * @flags: flags for ->cmd_flags
231 * @rq_flags: flags for ->rq_flags
232 * @resid: optional residual length
233 *
Christoph Hellwig17d53632017-04-20 16:03:01 +0200234 * Returns the scsi_cmnd result field if a command was executed, or a negative
235 * Linux error code if we didn't get that far.
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100236 */
237int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500238 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100239 unsigned char *sense, struct scsi_sense_hdr *sshdr,
240 int timeout, int retries, u64 flags, req_flags_t rq_flags,
241 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500242{
243 struct request *req;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100244 struct scsi_request *rq;
James Bottomley39216032005-06-15 18:48:29 -0500245 int ret = DRIVER_ERROR << 24;
246
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100247 req = blk_get_request(sdev->request_queue,
248 data_direction == DMA_TO_DEVICE ?
249 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, __GFP_RECLAIM);
Joe Lawrencea492f072014-08-28 08:15:21 -0600250 if (IS_ERR(req))
James Bottomleybfe159a2011-07-07 15:45:40 -0500251 return ret;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100252 rq = scsi_req(req);
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{
Christoph Hellwigd2852032014-01-17 12:06:53 +0100586 scsi_mq_free_sgtables(cmd);
587 scsi_uninit_cmd(cmd);
Bart Van Assche2dd6fb52017-06-02 14:21:58 -0700588 scsi_del_cmd_from_list(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100589}
590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591/*
592 * Function: scsi_release_buffers()
593 *
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200594 * Purpose: Free resources allocate for a scsi_command.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 *
596 * Arguments: cmd - command that we are bailing.
597 *
598 * Lock status: Assumed that no lock is held upon entry.
599 *
600 * Returns: Nothing
601 *
602 * Notes: In the event that an upper level driver rejects a
603 * command, we must release resources allocated during
604 * the __init_io() function. Primarily this would involve
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200605 * the scatter-gather table.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 */
Christoph Hellwigf1bea552014-04-15 12:26:54 +0200607static void scsi_release_buffers(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608{
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200609 if (cmd->sdb.table.nents)
Ming Lin001d63b2016-04-04 14:48:09 -0700610 sg_free_table_chained(&cmd->sdb.table, false);
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200611
612 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
613
614 if (scsi_prot_sg_count(cmd))
Ming Lin001d63b2016-04-04 14:48:09 -0700615 sg_free_table_chained(&cmd->prot_sdb->table, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616}
617
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200618static void scsi_release_bidi_buffers(struct scsi_cmnd *cmd)
619{
620 struct scsi_data_buffer *bidi_sdb = cmd->request->next_rq->special;
621
Ming Lin001d63b2016-04-04 14:48:09 -0700622 sg_free_table_chained(&bidi_sdb->table, false);
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200623 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
624 cmd->request->next_rq->special = NULL;
625}
626
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200627static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800628 unsigned int bytes, unsigned int bidi_bytes)
629{
Bart Van Asschebed22132017-08-25 13:46:32 -0700630 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800631 struct scsi_device *sdev = cmd->device;
632 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800633
634 if (blk_update_request(req, error, bytes))
635 return true;
636
637 /* Bidi request must be completed as a whole */
638 if (unlikely(bidi_bytes) &&
639 blk_update_request(req->next_rq, error, bidi_bytes))
640 return true;
641
642 if (blk_queue_add_random(q))
643 add_disk_randomness(req->rq_disk);
644
Christoph Hellwigd2852032014-01-17 12:06:53 +0100645 if (req->mq_ctx) {
646 /*
Christoph Hellwigc8a446a2014-09-13 16:40:10 -0700647 * In the MQ case the command gets freed by __blk_mq_end_request,
Christoph Hellwigd2852032014-01-17 12:06:53 +0100648 * so we have to do all cleanup that depends on it earlier.
649 *
650 * We also can't kick the queues from irq context, so we
651 * will have to defer it to a workqueue.
652 */
653 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800654
Christoph Hellwigc8a446a2014-09-13 16:40:10 -0700655 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100656
657 if (scsi_target(sdev)->single_lun ||
658 !list_empty(&sdev->host->starved_list))
659 kblockd_schedule_work(&sdev->requeue_work);
660 else
Bart Van Assche36e3cf22017-04-07 11:16:53 -0700661 blk_mq_run_hw_queues(q, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100662 } else {
663 unsigned long flags;
664
Daniel Gryniewiczf81426a2014-09-16 10:41:13 -0400665 if (bidi_bytes)
666 scsi_release_bidi_buffers(cmd);
Christoph Hellwige9c787e2017-01-02 21:55:26 +0300667 scsi_release_buffers(cmd);
668 scsi_put_command(cmd);
Daniel Gryniewiczf81426a2014-09-16 10:41:13 -0400669
Christoph Hellwigd2852032014-01-17 12:06:53 +0100670 spin_lock_irqsave(q->queue_lock, flags);
671 blk_finish_request(req, error);
672 spin_unlock_irqrestore(q->queue_lock, flags);
673
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700674 scsi_run_queue(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100675 }
676
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700677 put_device(&sdev->sdev_gendev);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800678 return false;
679}
680
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200681/**
682 * __scsi_error_from_host_byte - translate SCSI error code into errno
683 * @cmd: SCSI command (unused)
684 * @result: scsi error code
685 *
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200686 * Translate SCSI error code into block errors.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200687 */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200688static blk_status_t __scsi_error_from_host_byte(struct scsi_cmnd *cmd,
689 int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100690{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200691 switch (host_byte(result)) {
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100692 case DID_TRANSPORT_FAILFAST:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200693 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100694 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000695 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200696 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100697 case DID_NEXUS_FAILURE:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200698 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200699 case DID_ALLOC_FAILURE:
700 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200701 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200702 case DID_MEDIUM_ERROR:
703 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200704 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100705 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200706 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100707 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100708}
709
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710/*
711 * Function: scsi_io_completion()
712 *
713 * Purpose: Completion processing for block device I/O requests.
714 *
715 * Arguments: cmd - command that is finished.
716 *
717 * Lock status: Assumed that no lock is held upon entry.
718 *
719 * Returns: Nothing
720 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200721 * Notes: We will finish off the specified number of sectors. If we
722 * are done, the command block will be released and the queue
723 * function will be goosed. If we are not done then we have to
Alan Sternb60af5b2008-11-03 15:56:47 -0500724 * figure out what to do next:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500726 * a) We can call scsi_requeue_command(). The request
727 * will be unprepared and put back on the queue. Then
728 * a new command will be created for it. This should
729 * be used if we made forward progress, or if we want
730 * to switch from READ(10) to READ(6) for example.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200732 * b) We can call __scsi_queue_insert(). The request will
Alan Sternb60af5b2008-11-03 15:56:47 -0500733 * be put back on the queue and retried using the same
734 * command as before, possibly after a delay.
735 *
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800736 * c) We can call scsi_end_request() with -EIO to fail
Alan Sternb60af5b2008-11-03 15:56:47 -0500737 * the remainder of the request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 */
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700739void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740{
741 int result = cmd->result;
Jens Axboe165125e2007-07-24 09:28:11 +0200742 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 struct request *req = cmd->request;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200744 blk_status_t error = BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 struct scsi_sense_hdr sshdr;
Hannes Reinecke4753cbc2014-10-24 14:26:52 +0200746 bool sense_valid = false;
Hannes Reineckec11c0042014-10-24 14:27:01 +0200747 int sense_deferred = 0, level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500748 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
749 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900750 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 if (result) {
753 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
754 if (sense_valid)
755 sense_deferred = scsi_sense_is_deferred(&sshdr);
756 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200757
Christoph Hellwig57292b52017-01-31 16:57:29 +0100758 if (blk_rq_is_passthrough(req)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 if (result) {
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100760 if (sense_valid) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 /*
762 * SG_IO wants current and deferred errors
763 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100764 scsi_req(req)->sense_len =
765 min(8 + cmd->sense_buffer[7],
766 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 }
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500768 if (!sense_deferred)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100769 error = __scsi_error_from_host_byte(cmd, result);
Pete Wyckoffb22f6872007-03-13 16:53:28 -0400770 }
Mike Snitzer27c41972012-05-31 15:05:33 -0400771 /*
772 * __scsi_error_from_host_byte may have reset the host_byte
773 */
Christoph Hellwig17d53632017-04-20 16:03:01 +0200774 scsi_req(req)->result = cmd->result;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100775 scsi_req(req)->resid_len = scsi_get_resid(cmd);
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900776
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200777 if (scsi_bidi_cmnd(cmd)) {
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900778 /*
779 * Bidi commands Must be complete as a whole,
780 * both sides at once.
781 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100782 scsi_req(req->next_rq)->resid_len = scsi_in(cmd)->resid;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200783 if (scsi_end_request(req, BLK_STS_OK, blk_rq_bytes(req),
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800784 blk_rq_bytes(req->next_rq)))
785 BUG();
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200786 return;
787 }
James Bottomley89fb4cd2014-07-03 19:17:34 +0200788 } else if (blk_rq_bytes(req) == 0 && result && !sense_deferred) {
789 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100790 * Flush commands do not transfers any data, and thus cannot use
James Bottomley89fb4cd2014-07-03 19:17:34 +0200791 * good_bytes != blk_rq_bytes(req) as the signal for an error.
792 * This sets the error explicitly for the problem case.
793 */
794 error = __scsi_error_from_host_byte(cmd, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 }
796
Christoph Hellwig57292b52017-01-31 16:57:29 +0100797 /* no bidi support for !blk_rq_is_passthrough yet */
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200798 BUG_ON(blk_bidi_rq(req));
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200799
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 * Next deal with any sectors which we were able to correctly
802 * handle.
803 */
Hannes Reinecke91921e02014-06-25 16:39:59 +0200804 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
805 "%u sectors total, %d bytes done.\n",
806 blk_rq_sectors(req), good_bytes));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
James Bottomleya9bddd72009-03-30 16:55:51 +0000808 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100809 * Recovered errors need reporting, but they're always treated as
810 * success, so fiddle the result code here. For passthrough requests
Christoph Hellwig17d53632017-04-20 16:03:01 +0200811 * we already took a copy of the original into sreq->result which
James Bottomleya9bddd72009-03-30 16:55:51 +0000812 * is what gets returned to the user
813 */
Douglas Gilberte7efe592010-01-03 13:51:15 -0500814 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
815 /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
816 * print since caller wants ATA registers. Only occurs on
817 * SCSI ATA PASS_THROUGH commands when CK_COND=1
818 */
819 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
820 ;
Christoph Hellwige8064022016-10-20 15:12:13 +0200821 else if (!(req->rq_flags & RQF_QUIET))
Hannes Reinecked811b842014-10-24 14:26:45 +0200822 scsi_print_sense(cmd);
James Bottomleya9bddd72009-03-30 16:55:51 +0000823 result = 0;
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100824 /* for passthrough error may be set */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200825 error = BLK_STS_OK;
James Bottomleya9bddd72009-03-30 16:55:51 +0000826 }
827
828 /*
James Bottomleya621bac2016-05-13 12:04:06 -0700829 * special case: failed zero length commands always need to
830 * drop down into the retry code. Otherwise, if we finished
831 * all bytes in the request we are done now.
James Bottomleyd6b0c532006-07-02 10:06:28 -0500832 */
James Bottomleya621bac2016-05-13 12:04:06 -0700833 if (!(blk_rq_bytes(req) == 0 && error) &&
834 !scsi_end_request(req, error, good_bytes, 0))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800835 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200836
837 /*
838 * Kill remainder if no retrys.
839 */
840 if (error && scsi_noretry_cmd(cmd)) {
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800841 if (scsi_end_request(req, error, blk_rq_bytes(req), 0))
842 BUG();
843 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200844 }
845
846 /*
847 * If there had been no error, but we have leftover bytes in the
848 * requeues just queue the command up again.
849 */
850 if (result == 0)
851 goto requeue;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700852
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100853 error = __scsi_error_from_host_byte(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500854
Alan Sternb60af5b2008-11-03 15:56:47 -0500855 if (host_byte(result) == DID_RESET) {
856 /* Third party bus reset or reset for error recovery
857 * reasons. Just retry the command and see what
858 * happens.
859 */
860 action = ACTION_RETRY;
861 } else if (sense_valid && !sense_deferred) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 switch (sshdr.sense_key) {
863 case UNIT_ATTENTION:
864 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700865 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 * and quietly refuse further access.
867 */
868 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500869 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700871 /* Must have been a power glitch, or a
872 * bus reset. Could not have been a
873 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500874 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700875 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500876 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 }
878 break;
879 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700880 /* If we had an ILLEGAL REQUEST returned, then
881 * we may have performed an unsupported
882 * command. The only thing this should be
883 * would be a ten byte read where only a six
884 * byte read was supported. Also, on a system
885 * where READ CAPACITY failed, we may have
886 * read past the end of the disk.
887 */
Jens Axboe26a68012005-11-29 21:03:34 +0100888 if ((cmd->device->use_10_for_rw &&
889 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 (cmd->cmnd[0] == READ_10 ||
891 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500892 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500894 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500895 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500896 action = ACTION_FAIL;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200897 error = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500898 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400899 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500900 action = ACTION_FAIL;
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200901 error = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500902 } else
903 action = ACTION_FAIL;
904 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400905 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000906 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200907 if (sshdr.asc == 0x10) /* DIF */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200908 error = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 break;
910 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700911 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500912 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500914 if (sshdr.asc == 0x04) {
915 switch (sshdr.ascq) {
916 case 0x01: /* becoming ready */
917 case 0x04: /* format in progress */
918 case 0x05: /* rebuild in progress */
919 case 0x06: /* recalculation in progress */
920 case 0x07: /* operation in progress */
921 case 0x08: /* Long write in progress */
922 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500923 case 0x14: /* space allocation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500924 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500925 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500926 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500927 action = ACTION_FAIL;
928 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500929 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200930 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500931 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500932 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700934 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500935 action = ACTION_FAIL;
936 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500938 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 break;
940 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200941 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500942 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500943
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900944 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200945 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900946 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900947
Alan Sternb60af5b2008-11-03 15:56:47 -0500948 switch (action) {
949 case ACTION_FAIL:
950 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200951 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200952 static DEFINE_RATELIMIT_STATE(_rs,
953 DEFAULT_RATELIMIT_INTERVAL,
954 DEFAULT_RATELIMIT_BURST);
955
956 if (unlikely(scsi_logging_level))
957 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
958 SCSI_LOG_MLCOMPLETE_BITS);
959
960 /*
961 * if logging is enabled the failure will be printed
962 * in scsi_log_completion(), so avoid duplicate messages
963 */
964 if (!level && __ratelimit(&_rs)) {
965 scsi_print_result(cmd, NULL, FAILED);
966 if (driver_byte(result) & DRIVER_SENSE)
967 scsi_print_sense(cmd);
968 scsi_print_command(cmd);
969 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500970 }
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800971 if (!scsi_end_request(req, error, blk_rq_err_bytes(req), 0))
972 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200973 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500974 case ACTION_REPREP:
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200975 requeue:
Alan Sternb60af5b2008-11-03 15:56:47 -0500976 /* Unprep the request and put it back at the head of the queue.
977 * A new command will be prepared and issued.
978 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100979 if (q->mq_ops) {
Christoph Hellwige8064022016-10-20 15:12:13 +0200980 cmd->request->rq_flags &= ~RQF_DONTPREP;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100981 scsi_mq_uninit_cmd(cmd);
982 scsi_mq_requeue_cmd(cmd);
983 } else {
984 scsi_release_buffers(cmd);
985 scsi_requeue_command(q, cmd);
986 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500987 break;
988 case ACTION_RETRY:
989 /* Retry the same command immediately */
James Bottomley4f5299a2009-01-02 10:42:21 -0600990 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -0500991 break;
992 case ACTION_DELAYED_RETRY:
993 /* Retry the same command after a delay */
James Bottomley4f5299a2009-01-02 10:42:21 -0600994 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -0500995 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 }
997}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
Christoph Hellwig3c356bd2014-09-05 18:20:23 -0700999static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001001 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002
1003 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001004 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001006 if (unlikely(sg_alloc_table_chained(&sdb->table,
1007 blk_rq_nr_phys_segments(req), sdb->table.sgl)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 return BLKPREP_DEFER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 /*
1011 * Next, walk the list, and fill in the addresses and sizes of
1012 * each segment.
1013 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001014 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1015 BUG_ON(count > sdb->table.nents);
1016 sdb->table.nents = count;
Christoph Hellwigfd102b12017-01-13 12:29:11 +01001017 sdb->length = blk_rq_payload_bytes(req);
Rusty Russell4a03d902007-11-19 11:28:48 +11001018 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001020
1021/*
1022 * Function: scsi_init_io()
1023 *
1024 * Purpose: SCSI I/O initialize function.
1025 *
1026 * Arguments: cmd - Command descriptor we wish to initialize
1027 *
1028 * Returns: 0 on success
1029 * BLKPREP_DEFER if the failure is retryable
1030 * BLKPREP_KILL if the failure is fatal
1031 */
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001032int scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001033{
Christoph Hellwig5e012aa2014-04-15 12:24:55 +02001034 struct scsi_device *sdev = cmd->device;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001035 struct request *rq = cmd->request;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001036 bool is_mq = (rq->mq_ctx != NULL);
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001037 int error = BLKPREP_KILL;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001038
Johannes Thumshirnfd3fc0b2017-01-31 10:16:00 +01001039 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
Johannes Thumshirne7661a82017-04-12 09:21:19 +02001040 goto err_exit;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001041
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001042 error = scsi_init_sgtable(rq, &cmd->sdb);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001043 if (error)
1044 goto err_exit;
1045
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001046 if (blk_bidi_rq(rq)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001047 if (!rq->q->mq_ops) {
1048 struct scsi_data_buffer *bidi_sdb =
1049 kmem_cache_zalloc(scsi_sdb_cache, GFP_ATOMIC);
1050 if (!bidi_sdb) {
1051 error = BLKPREP_DEFER;
1052 goto err_exit;
1053 }
1054
1055 rq->next_rq->special = bidi_sdb;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001056 }
1057
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001058 error = scsi_init_sgtable(rq->next_rq, rq->next_rq->special);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001059 if (error)
1060 goto err_exit;
1061 }
1062
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001063 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001064 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1065 int ivecs, count;
1066
Ewan D. Milne91724c22015-01-15 10:02:12 -05001067 if (prot_sdb == NULL) {
1068 /*
1069 * This can happen if someone (e.g. multipath)
1070 * queues a command to a device on an adapter
1071 * that does not support DIX.
1072 */
1073 WARN_ON_ONCE(1);
1074 error = BLKPREP_KILL;
1075 goto err_exit;
1076 }
1077
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001078 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001079
Ming Lin001d63b2016-04-04 14:48:09 -07001080 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lin22cc3d42016-04-04 14:48:08 -07001081 prot_sdb->table.sgl)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001082 error = BLKPREP_DEFER;
1083 goto err_exit;
1084 }
1085
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001086 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001087 prot_sdb->table.sgl);
1088 BUG_ON(unlikely(count > ivecs));
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001089 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001090
1091 cmd->prot_sdb = prot_sdb;
1092 cmd->prot_sdb->table.nents = count;
1093 }
1094
Christoph Hellwigd2852032014-01-17 12:06:53 +01001095 return BLKPREP_OK;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001096err_exit:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001097 if (is_mq) {
1098 scsi_mq_free_sgtables(cmd);
1099 } else {
1100 scsi_release_buffers(cmd);
1101 cmd->request->special = NULL;
1102 scsi_put_command(cmd);
1103 put_device(&sdev->sdev_gendev);
1104 }
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001105 return error;
1106}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001107EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001109/**
1110 * scsi_initialize_rq - initialize struct scsi_cmnd.req
Jonathan Corbet35c05062017-08-24 16:11:09 -06001111 * @rq: Request associated with the SCSI command to be initialized.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001112 *
1113 * Called from inside blk_get_request().
1114 */
1115void scsi_initialize_rq(struct request *rq)
1116{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001117 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1118
1119 scsi_req_init(&cmd->req);
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001120}
1121EXPORT_SYMBOL(scsi_initialize_rq);
1122
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001123/* Add a command to the list used by the aacraid and dpt_i2o drivers */
1124void scsi_add_cmd_to_list(struct scsi_cmnd *cmd)
1125{
1126 struct scsi_device *sdev = cmd->device;
1127 struct Scsi_Host *shost = sdev->host;
1128 unsigned long flags;
1129
1130 if (shost->use_cmd_list) {
1131 spin_lock_irqsave(&sdev->list_lock, flags);
1132 list_add_tail(&cmd->list, &sdev->cmd_list);
1133 spin_unlock_irqrestore(&sdev->list_lock, flags);
1134 }
1135}
1136
1137/* Remove a command from the list used by the aacraid and dpt_i2o drivers */
1138void scsi_del_cmd_from_list(struct scsi_cmnd *cmd)
1139{
1140 struct scsi_device *sdev = cmd->device;
1141 struct Scsi_Host *shost = sdev->host;
1142 unsigned long flags;
1143
1144 if (shost->use_cmd_list) {
1145 spin_lock_irqsave(&sdev->list_lock, flags);
1146 BUG_ON(list_empty(&cmd->list));
1147 list_del_init(&cmd->list);
1148 spin_unlock_irqrestore(&sdev->list_lock, flags);
1149 }
1150}
1151
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001152/* Called after a request has been started. */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001153void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001154{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001155 void *buf = cmd->sense_buffer;
1156 void *prot = cmd->prot_sdb;
Bart Van Assche8e688252017-06-02 14:21:52 -07001157 unsigned int unchecked_isa_dma = cmd->flags & SCMD_UNCHECKED_ISA_DMA;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001158
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001159 /* zero out the cmd, except for the embedded scsi_request */
1160 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001161 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001162
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001163 cmd->device = dev;
1164 cmd->sense_buffer = buf;
1165 cmd->prot_sdb = prot;
Bart Van Assche8e688252017-06-02 14:21:52 -07001166 cmd->flags = unchecked_isa_dma;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001167 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1168 cmd->jiffies_at_alloc = jiffies;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001169
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001170 scsi_add_cmd_to_list(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001171}
1172
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001173static int scsi_setup_scsi_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001174{
Bart Van Asschebed22132017-08-25 13:46:32 -07001175 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001176
1177 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001178 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001179 * a bio attached to them. Or they might contain a SCSI command
1180 * that does not transfer data, in which case they may optionally
1181 * submit a request without an attached bio.
1182 */
1183 if (req->bio) {
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001184 int ret = scsi_init_io(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001185 if (unlikely(ret))
1186 return ret;
1187 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001188 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001189
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001190 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001191 }
James Bottomley7b163182005-12-15 20:17:02 -06001192
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001193 cmd->cmd_len = scsi_req(req)->cmd_len;
1194 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001195 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001196 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001197 return BLKPREP_OK;
1198}
1199
1200/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001201 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001202 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001203 */
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001204static int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001205{
Bart Van Asschebed22132017-08-25 13:46:32 -07001206 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001207
Christoph Hellwigee14c672015-08-27 14:16:59 +02001208 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
1209 int ret = sdev->handler->prep_fn(sdev, req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001210 if (ret != BLKPREP_OK)
1211 return ret;
1212 }
1213
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001214 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001215 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001216 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001217}
James Bottomley7b163182005-12-15 20:17:02 -06001218
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001219static int scsi_setup_cmnd(struct scsi_device *sdev, struct request *req)
1220{
Bart Van Asschebed22132017-08-25 13:46:32 -07001221 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001222
1223 if (!blk_rq_bytes(req))
1224 cmd->sc_data_direction = DMA_NONE;
1225 else if (rq_data_dir(req) == WRITE)
1226 cmd->sc_data_direction = DMA_TO_DEVICE;
1227 else
1228 cmd->sc_data_direction = DMA_FROM_DEVICE;
1229
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001230 if (blk_rq_is_scsi(req))
1231 return scsi_setup_scsi_cmnd(sdev, req);
1232 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001233 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001234}
1235
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001236static int
1237scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001239 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240
1241 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001242 * If the device is not in running state we will reject some
1243 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001246 switch (sdev->sdev_state) {
1247 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05001248 case SDEV_TRANSPORT_OFFLINE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001249 /*
1250 * If the device is offline we refuse to process any
1251 * commands. The device must be brought online
1252 * before trying any recovery commands.
1253 */
1254 sdev_printk(KERN_ERR, sdev,
1255 "rejecting I/O to offline device\n");
1256 ret = BLKPREP_KILL;
1257 break;
1258 case SDEV_DEL:
1259 /*
1260 * If the device is fully deleted, we refuse to
1261 * process any commands as well.
1262 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001263 sdev_printk(KERN_ERR, sdev,
1264 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001265 ret = BLKPREP_KILL;
1266 break;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001267 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001268 case SDEV_CREATED_BLOCK:
Bart Van Asschebba0bdd2015-03-04 10:31:47 +01001269 ret = BLKPREP_DEFER;
1270 break;
1271 case SDEV_QUIESCE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001272 /*
1273 * If the devices is blocked we defer normal commands.
1274 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001275 if (!(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001276 ret = BLKPREP_DEFER;
1277 break;
1278 default:
1279 /*
1280 * For any other not fully online state we only allow
1281 * special commands. In particular any user initiated
1282 * command is not allowed.
1283 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001284 if (!(req->rq_flags & RQF_PREEMPT))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001285 ret = BLKPREP_KILL;
1286 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001289 return ret;
1290}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001292static int
1293scsi_prep_return(struct request_queue *q, struct request *req, int ret)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001294{
1295 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296
Christoph Hellwig3b003152006-11-04 20:10:55 +01001297 switch (ret) {
1298 case BLKPREP_KILL:
jiangyiwene1cd3912016-02-16 20:14:13 +08001299 case BLKPREP_INVALID:
Christoph Hellwig17d53632017-04-20 16:03:01 +02001300 scsi_req(req)->result = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001301 /* release the command and kill it */
1302 if (req->special) {
1303 struct scsi_cmnd *cmd = req->special;
1304 scsi_release_buffers(cmd);
1305 scsi_put_command(cmd);
Christoph Hellwig68c03d92014-04-15 12:24:56 +02001306 put_device(&sdev->sdev_gendev);
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001307 req->special = NULL;
1308 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001309 break;
1310 case BLKPREP_DEFER:
1311 /*
Tejun Heo9934c8c2009-05-08 11:54:16 +09001312 * If we defer, the blk_peek_request() returns NULL, but the
Jens Axboea488e742010-04-16 21:13:15 +02001313 * queue must be restarted, so we schedule a callback to happen
1314 * shortly.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001315 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001316 if (atomic_read(&sdev->device_busy) == 0)
Jens Axboea488e742010-04-16 21:13:15 +02001317 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001318 break;
1319 default:
Christoph Hellwige8064022016-10-20 15:12:13 +02001320 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001321 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322
Christoph Hellwig3b003152006-11-04 20:10:55 +01001323 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001325
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001326static int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001327{
1328 struct scsi_device *sdev = q->queuedata;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001329 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001330 int ret;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001331
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001332 ret = scsi_prep_state_check(sdev, req);
1333 if (ret != BLKPREP_OK)
1334 goto out;
1335
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001336 if (!req->special) {
1337 /* Bail if we can't get a reference to the device */
1338 if (unlikely(!get_device(&sdev->sdev_gendev))) {
1339 ret = BLKPREP_DEFER;
1340 goto out;
1341 }
1342
1343 scsi_init_command(sdev, cmd);
1344 req->special = cmd;
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001345 }
1346
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001347 cmd->tag = req->tag;
1348 cmd->request = req;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001349 cmd->prot_op = SCSI_PROT_NORMAL;
1350
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001351 ret = scsi_setup_cmnd(sdev, req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001352out:
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001353 return scsi_prep_return(q, req, ret);
1354}
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001355
1356static void scsi_unprep_fn(struct request_queue *q, struct request *req)
1357{
Bart Van Asschebed22132017-08-25 13:46:32 -07001358 scsi_uninit_cmd(blk_mq_rq_to_pdu(req));
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001359}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360
1361/*
1362 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1363 * return 0.
1364 *
1365 * Called with the queue_lock held.
1366 */
1367static inline int scsi_dev_queue_ready(struct request_queue *q,
1368 struct scsi_device *sdev)
1369{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001370 unsigned int busy;
1371
1372 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001373 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001374 if (busy)
1375 goto out_dec;
1376
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 /*
1378 * unblock after device_blocked iterates to zero
1379 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001380 if (atomic_dec_return(&sdev->device_blocked) > 0) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001381 /*
1382 * For the MQ case we take care of this in the caller.
1383 */
1384 if (!q->mq_ops)
1385 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001386 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001388 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1389 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001391
1392 if (busy >= sdev->queue_depth)
1393 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394
1395 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001396out_dec:
1397 atomic_dec(&sdev->device_busy);
1398 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399}
1400
Mike Christief0c0a372008-08-17 15:24:38 -05001401/*
1402 * scsi_target_queue_ready: checks if there we can send commands to target
1403 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001404 */
1405static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1406 struct scsi_device *sdev)
1407{
1408 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001409 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001410
1411 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001412 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001413 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001414 starget->starget_sdev_user != sdev) {
1415 spin_unlock_irq(shost->host_lock);
1416 return 0;
1417 }
Mike Christief0c0a372008-08-17 15:24:38 -05001418 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001419 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001420 }
1421
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001422 if (starget->can_queue <= 0)
1423 return 1;
1424
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001425 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001426 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001427 if (busy)
1428 goto starved;
1429
Mike Christief0c0a372008-08-17 15:24:38 -05001430 /*
1431 * unblock after target_blocked iterates to zero
1432 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001433 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001434 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001435
1436 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1437 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001438 }
1439
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001440 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001441 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001442
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001443 return 1;
1444
1445starved:
1446 spin_lock_irq(shost->host_lock);
1447 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001448 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001449out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001450 if (starget->can_queue > 0)
1451 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001452 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001453}
1454
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455/*
1456 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1457 * return 0. We must end up running the queue again whenever 0 is
1458 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 */
1460static inline int scsi_host_queue_ready(struct request_queue *q,
1461 struct Scsi_Host *shost,
1462 struct scsi_device *sdev)
1463{
Christoph Hellwig74665012014-01-22 15:29:29 +01001464 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001465
James Bottomley939647e2005-09-18 15:05:20 -05001466 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001467 return 0;
1468
1469 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001470 if (atomic_read(&shost->host_blocked) > 0) {
Christoph Hellwig74665012014-01-22 15:29:29 +01001471 if (busy)
1472 goto starved;
1473
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 /*
1475 * unblock after host_blocked iterates to zero
1476 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001477 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001478 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001479
1480 SCSI_LOG_MLQUEUE(3,
1481 shost_printk(KERN_INFO, shost,
1482 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001484
1485 if (shost->can_queue > 0 && busy >= shost->can_queue)
1486 goto starved;
1487 if (shost->host_self_blocked)
1488 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489
1490 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001491 if (!list_empty(&sdev->starved_entry)) {
1492 spin_lock_irq(shost->host_lock);
1493 if (!list_empty(&sdev->starved_entry))
1494 list_del_init(&sdev->starved_entry);
1495 spin_unlock_irq(shost->host_lock);
1496 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497
Christoph Hellwig74665012014-01-22 15:29:29 +01001498 return 1;
1499
1500starved:
1501 spin_lock_irq(shost->host_lock);
1502 if (list_empty(&sdev->starved_entry))
1503 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001504 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001505out_dec:
1506 atomic_dec(&shost->host_busy);
1507 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508}
1509
1510/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001511 * Busy state exporting function for request stacking drivers.
1512 *
1513 * For efficiency, no lock is taken to check the busy state of
1514 * shost/starget/sdev, since the returned value is not guaranteed and
1515 * may be changed after request stacking drivers call the function,
1516 * regardless of taking lock or not.
1517 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001518 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1519 * needs to return 'not busy'. Otherwise, request stacking drivers
1520 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001521 */
1522static int scsi_lld_busy(struct request_queue *q)
1523{
1524 struct scsi_device *sdev = q->queuedata;
1525 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001526
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001527 if (blk_queue_dying(q))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001528 return 0;
1529
1530 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001531
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001532 /*
1533 * Ignore host/starget busy state.
1534 * Since block layer does not have a concept of fairness across
1535 * multiple queues, congestion of host/starget needs to be handled
1536 * in SCSI layer.
1537 */
1538 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001539 return 1;
1540
1541 return 0;
1542}
1543
1544/*
James Bottomleye91442b2005-09-09 10:44:16 -05001545 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 */
Jens Axboe165125e2007-07-24 09:28:11 +02001547static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548{
Bart Van Asschebed22132017-08-25 13:46:32 -07001549 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Jiri Slaby03b14702009-09-23 16:15:35 +02001550 struct scsi_device *sdev;
1551 struct scsi_target *starget;
1552 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553
Tejun Heo9934c8c2009-05-08 11:54:16 +09001554 blk_start_request(req);
James Bottomley788ce432005-09-09 13:40:23 -05001555
Hannes Reinecke74571812011-11-09 08:39:24 +01001556 scmd_printk(KERN_INFO, cmd, "killing request\n");
1557
Jiri Slaby03b14702009-09-23 16:15:35 +02001558 sdev = cmd->device;
1559 starget = scsi_target(sdev);
1560 shost = sdev->host;
James Bottomleye91442b2005-09-09 10:44:16 -05001561 scsi_init_cmd_errh(cmd);
1562 cmd->result = DID_NO_CONNECT << 16;
1563 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001564
1565 /*
1566 * SCSI request completion path will do scsi_device_unbusy(),
1567 * bump busy counts. To bump the counters, we need to dance
1568 * with the locks as normal issue path does.
1569 */
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001570 atomic_inc(&sdev->device_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +01001571 atomic_inc(&shost->host_busy);
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001572 if (starget->can_queue > 0)
1573 atomic_inc(&starget->target_busy);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001574
Jens Axboe242f9dc2008-09-14 05:55:09 -07001575 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576}
1577
Jens Axboe1aea6432006-01-09 16:03:03 +01001578static void scsi_softirq_done(struct request *rq)
1579{
Bart Van Asschebed22132017-08-25 13:46:32 -07001580 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001581 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001582 int disposition;
1583
1584 INIT_LIST_HEAD(&cmd->eh_entry);
1585
Jens Axboe242f9dc2008-09-14 05:55:09 -07001586 atomic_inc(&cmd->device->iodone_cnt);
1587 if (cmd->result)
1588 atomic_inc(&cmd->device->ioerr_cnt);
1589
Jens Axboe1aea6432006-01-09 16:03:03 +01001590 disposition = scsi_decide_disposition(cmd);
1591 if (disposition != SUCCESS &&
1592 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1593 sdev_printk(KERN_ERR, cmd->device,
1594 "timing out command, waited %lus\n",
1595 wait_for/HZ);
1596 disposition = SUCCESS;
1597 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001598
Jens Axboe1aea6432006-01-09 16:03:03 +01001599 scsi_log_completion(cmd, disposition);
1600
1601 switch (disposition) {
1602 case SUCCESS:
1603 scsi_finish_command(cmd);
1604 break;
1605 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001606 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001607 break;
1608 case ADD_TO_MLQUEUE:
1609 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1610 break;
1611 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001612 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001613 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001614 }
1615}
1616
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001617/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001618 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1619 * @cmd: command block we are dispatching.
1620 *
1621 * Return: nonzero return request was rejected and device's queue needs to be
1622 * plugged.
1623 */
1624static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1625{
1626 struct Scsi_Host *host = cmd->device->host;
1627 int rtn = 0;
1628
1629 atomic_inc(&cmd->device->iorequest_cnt);
1630
1631 /* check if the device is still usable */
1632 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1633 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1634 * returns an immediate error upwards, and signals
1635 * that the device is no longer present */
1636 cmd->result = DID_NO_CONNECT << 16;
1637 goto done;
1638 }
1639
1640 /* Check to see if the scsi lld made this device blocked. */
1641 if (unlikely(scsi_device_blocked(cmd->device))) {
1642 /*
1643 * in blocked state, the command is just put back on
1644 * the device queue. The suspend state has already
1645 * blocked the queue so future requests should not
1646 * occur until the device transitions out of the
1647 * suspend state.
1648 */
1649 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1650 "queuecommand : device blocked\n"));
1651 return SCSI_MLQUEUE_DEVICE_BUSY;
1652 }
1653
1654 /* Store the LUN value in cmnd, if needed. */
1655 if (cmd->device->lun_in_cdb)
1656 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1657 (cmd->device->lun << 5 & 0xe0);
1658
1659 scsi_log_send(cmd);
1660
1661 /*
1662 * Before we queue this command, check if the command
1663 * length exceeds what the host adapter can handle.
1664 */
1665 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1666 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1667 "queuecommand : command too long. "
1668 "cdb_size=%d host->max_cmd_len=%d\n",
1669 cmd->cmd_len, cmd->device->host->max_cmd_len));
1670 cmd->result = (DID_ABORT << 16);
1671 goto done;
1672 }
1673
1674 if (unlikely(host->shost_state == SHOST_DEL)) {
1675 cmd->result = (DID_NO_CONNECT << 16);
1676 goto done;
1677
1678 }
1679
1680 trace_scsi_dispatch_cmd_start(cmd);
1681 rtn = host->hostt->queuecommand(host, cmd);
1682 if (rtn) {
1683 trace_scsi_dispatch_cmd_error(cmd, rtn);
1684 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1685 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1686 rtn = SCSI_MLQUEUE_HOST_BUSY;
1687
1688 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1689 "queuecommand : request rejected\n"));
1690 }
1691
1692 return rtn;
1693 done:
1694 cmd->scsi_done(cmd);
1695 return 0;
1696}
1697
1698/**
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001699 * scsi_done - Invoke completion on finished SCSI command.
1700 * @cmd: The SCSI Command for which a low-level device driver (LLDD) gives
1701 * ownership back to SCSI Core -- i.e. the LLDD has finished with it.
1702 *
1703 * Description: This function is the mid-level's (SCSI Core) interrupt routine,
1704 * which regains ownership of the SCSI command (de facto) from a LLDD, and
1705 * calls blk_complete_request() for further processing.
1706 *
1707 * This function is interrupt context safe.
1708 */
1709static void scsi_done(struct scsi_cmnd *cmd)
1710{
1711 trace_scsi_dispatch_cmd_done(cmd);
1712 blk_complete_request(cmd->request);
1713}
1714
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715/*
1716 * Function: scsi_request_fn()
1717 *
1718 * Purpose: Main strategy routine for SCSI.
1719 *
1720 * Arguments: q - Pointer to actual queue.
1721 *
1722 * Returns: Nothing
1723 *
1724 * Lock status: IO request lock assumed to be held when called.
1725 */
1726static void scsi_request_fn(struct request_queue *q)
Bart Van Assche613be1f2014-02-20 14:20:56 -08001727 __releases(q->queue_lock)
1728 __acquires(q->queue_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729{
1730 struct scsi_device *sdev = q->queuedata;
1731 struct Scsi_Host *shost;
1732 struct scsi_cmnd *cmd;
1733 struct request *req;
1734
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 /*
1736 * To start with, we keep looping until the queue is empty, or until
1737 * the host is no longer able to accept any more requests.
1738 */
1739 shost = sdev->host;
Jens Axboea488e742010-04-16 21:13:15 +02001740 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 int rtn;
1742 /*
1743 * get next queueable request. We do this early to make sure
Hannes Reinecke91921e02014-06-25 16:39:59 +02001744 * that the request is fully prepared even if we cannot
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 * accept it.
1746 */
Tejun Heo9934c8c2009-05-08 11:54:16 +09001747 req = blk_peek_request(q);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001748 if (!req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 break;
1750
1751 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001752 sdev_printk(KERN_ERR, sdev,
1753 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001754 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 continue;
1756 }
1757
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001758 if (!scsi_dev_queue_ready(q, sdev))
1759 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760
1761 /*
1762 * Remove the request from the request list.
1763 */
1764 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
Tejun Heo9934c8c2009-05-08 11:54:16 +09001765 blk_start_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001767 spin_unlock_irq(q->queue_lock);
Bart Van Asschebed22132017-08-25 13:46:32 -07001768 cmd = blk_mq_rq_to_pdu(req);
1769 if (cmd != req->special) {
James Bottomleye91442b2005-09-09 10:44:16 -05001770 printk(KERN_CRIT "impossible request in %s.\n"
1771 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001772 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001773 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001774 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001775 BUG();
1776 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777
Mike Christieecefe8a2008-07-11 19:50:35 -05001778 /*
1779 * We hit this when the driver is using a host wide
1780 * tag map. For device level tag maps the queue_depth check
1781 * in the device ready fn would prevent us from trying
1782 * to allocate a tag. Since the map is a shared host resource
1783 * we add the dev to the starved list so it eventually gets
1784 * a run when a tag is freed.
1785 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001786 if (blk_queue_tagged(q) && !(req->rq_flags & RQF_QUEUED)) {
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001787 spin_lock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001788 if (list_empty(&sdev->starved_entry))
1789 list_add_tail(&sdev->starved_entry,
1790 &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001791 spin_unlock_irq(shost->host_lock);
Mike Christieecefe8a2008-07-11 19:50:35 -05001792 goto not_ready;
1793 }
1794
Mike Christief0c0a372008-08-17 15:24:38 -05001795 if (!scsi_target_queue_ready(shost, sdev))
1796 goto not_ready;
1797
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 if (!scsi_host_queue_ready(q, shost, sdev))
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001799 goto host_not_ready;
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001800
1801 if (sdev->simple_tags)
1802 cmd->flags |= SCMD_TAGGED;
1803 else
1804 cmd->flags &= ~SCMD_TAGGED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 /*
1807 * Finally, initialize any error handling parameters, and set up
1808 * the timers for timeouts.
1809 */
1810 scsi_init_cmd_errh(cmd);
1811
1812 /*
1813 * Dispatch the command to the low-level driver.
1814 */
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001815 cmd->scsi_done = scsi_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 rtn = scsi_dispatch_cmd(cmd);
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001817 if (rtn) {
1818 scsi_queue_insert(cmd, rtn);
1819 spin_lock_irq(q->queue_lock);
Jens Axboea488e742010-04-16 21:13:15 +02001820 goto out_delay;
Christoph Hellwigd0d3bbf2014-01-22 18:39:04 +01001821 }
1822 spin_lock_irq(q->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 }
1824
Bart Van Assche613be1f2014-02-20 14:20:56 -08001825 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001827 host_not_ready:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001828 if (scsi_target(sdev)->can_queue > 0)
1829 atomic_dec(&scsi_target(sdev)->target_busy);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001830 not_ready:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 /*
1832 * lock q, handle tag, requeue req, and decrement device_busy. We
1833 * must return with queue_lock held.
1834 *
1835 * Decrementing device_busy without checking it is OK, as all such
1836 * cases (host limits or settings) should run the queue at some
1837 * later time.
1838 */
1839 spin_lock_irq(q->queue_lock);
1840 blk_requeue_request(q, req);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001841 atomic_dec(&sdev->device_busy);
Jens Axboea488e742010-04-16 21:13:15 +02001842out_delay:
Guenter Roeck480cadc2014-08-10 05:54:25 -07001843 if (!atomic_read(&sdev->device_busy) && !scsi_device_blocked(sdev))
Jens Axboea488e742010-04-16 21:13:15 +02001844 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845}
1846
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001847static inline blk_status_t prep_to_mq(int ret)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001848{
1849 switch (ret) {
1850 case BLKPREP_OK:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001851 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001852 case BLKPREP_DEFER:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001853 return BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001854 default:
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001855 return BLK_STS_IOERR;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001856 }
1857}
1858
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001859/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
1860static unsigned int scsi_mq_sgl_size(struct Scsi_Host *shost)
1861{
1862 return min_t(unsigned int, shost->sg_tablesize, SG_CHUNK_SIZE) *
1863 sizeof(struct scatterlist);
1864}
1865
Christoph Hellwigd2852032014-01-17 12:06:53 +01001866static int scsi_mq_prep_fn(struct request *req)
1867{
1868 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1869 struct scsi_device *sdev = req->q->queuedata;
1870 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001871 struct scatterlist *sg;
1872
Bart Van Assche08f78432017-06-02 14:22:00 -07001873 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001874
1875 req->special = cmd;
1876
1877 cmd->request = req;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001878
1879 cmd->tag = req->tag;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001880 cmd->prot_op = SCSI_PROT_NORMAL;
1881
Christoph Hellwigd2852032014-01-17 12:06:53 +01001882 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1883 cmd->sdb.table.sgl = sg;
1884
1885 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001886 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1887
1888 cmd->prot_sdb->table.sgl =
1889 (struct scatterlist *)(cmd->prot_sdb + 1);
1890 }
1891
1892 if (blk_bidi_rq(req)) {
1893 struct request *next_rq = req->next_rq;
1894 struct scsi_data_buffer *bidi_sdb = blk_mq_rq_to_pdu(next_rq);
1895
1896 memset(bidi_sdb, 0, sizeof(struct scsi_data_buffer));
1897 bidi_sdb->table.sgl =
1898 (struct scatterlist *)(bidi_sdb + 1);
1899
1900 next_rq->special = bidi_sdb;
1901 }
1902
Christoph Hellwigfe052522014-09-22 15:59:31 +02001903 blk_mq_start_request(req);
1904
Christoph Hellwigd2852032014-01-17 12:06:53 +01001905 return scsi_setup_cmnd(sdev, req);
1906}
1907
1908static void scsi_mq_done(struct scsi_cmnd *cmd)
1909{
1910 trace_scsi_dispatch_cmd_done(cmd);
Christoph Hellwig08e00292017-04-20 16:03:09 +02001911 blk_mq_complete_request(cmd->request);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001912}
1913
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001914static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
Jens Axboe74c45052014-10-29 11:14:52 -06001915 const struct blk_mq_queue_data *bd)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001916{
Jens Axboe74c45052014-10-29 11:14:52 -06001917 struct request *req = bd->rq;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001918 struct request_queue *q = req->q;
1919 struct scsi_device *sdev = q->queuedata;
1920 struct Scsi_Host *shost = sdev->host;
1921 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001922 blk_status_t ret;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001923 int reason;
1924
1925 ret = prep_to_mq(scsi_prep_state_check(sdev, req));
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001926 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001927 goto out;
1928
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001929 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001930 if (!get_device(&sdev->sdev_gendev))
1931 goto out;
1932
1933 if (!scsi_dev_queue_ready(q, sdev))
1934 goto out_put_device;
1935 if (!scsi_target_queue_ready(shost, sdev))
1936 goto out_dec_device_busy;
1937 if (!scsi_host_queue_ready(q, shost, sdev))
1938 goto out_dec_target_busy;
1939
Christoph Hellwige8064022016-10-20 15:12:13 +02001940 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001941 ret = prep_to_mq(scsi_mq_prep_fn(req));
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001942 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001943 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001944 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001945 } else {
1946 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001947 }
1948
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001949 if (sdev->simple_tags)
1950 cmd->flags |= SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001951 else
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001952 cmd->flags &= ~SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001953
Christoph Hellwigd2852032014-01-17 12:06:53 +01001954 scsi_init_cmd_errh(cmd);
1955 cmd->scsi_done = scsi_mq_done;
1956
1957 reason = scsi_dispatch_cmd(cmd);
1958 if (reason) {
1959 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001960 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001961 goto out_dec_host_busy;
1962 }
1963
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001964 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001965
1966out_dec_host_busy:
1967 atomic_dec(&shost->host_busy);
1968out_dec_target_busy:
1969 if (scsi_target(sdev)->can_queue > 0)
1970 atomic_dec(&scsi_target(sdev)->target_busy);
1971out_dec_device_busy:
1972 atomic_dec(&sdev->device_busy);
1973out_put_device:
1974 put_device(&sdev->sdev_gendev);
1975out:
1976 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001977 case BLK_STS_OK:
1978 break;
1979 case BLK_STS_RESOURCE:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001980 if (atomic_read(&sdev->device_busy) == 0 &&
1981 !scsi_device_blocked(sdev))
Bart Van Assche36e3cf22017-04-07 11:16:53 -07001982 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001983 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001984 default:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001985 /*
1986 * Make sure to release all allocated ressources when
1987 * we hit an error, as we will never see this command
1988 * again.
1989 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001990 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001991 scsi_mq_uninit_cmd(cmd);
1992 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001993 }
1994 return ret;
1995}
1996
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001997static enum blk_eh_timer_return scsi_timeout(struct request *req,
1998 bool reserved)
1999{
2000 if (reserved)
2001 return BLK_EH_RESET_TIMER;
2002 return scsi_times_out(req);
2003}
2004
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002005static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
2006 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002007{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002008 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07002009 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002010 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07002011 struct scatterlist *sg;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002012
Bart Van Assche8e688252017-06-02 14:21:52 -07002013 if (unchecked_isa_dma)
2014 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
2015 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
2016 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002017 if (!cmd->sense_buffer)
2018 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002019 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07002020
2021 if (scsi_host_get_prot(shost)) {
2022 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
2023 shost->hostt->cmd_size;
2024 cmd->prot_sdb = (void *)sg + scsi_mq_sgl_size(shost);
2025 }
2026
Christoph Hellwigd2852032014-01-17 12:06:53 +01002027 return 0;
2028}
2029
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002030static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
2031 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002032{
2033 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2034
Bart Van Assche8e688252017-06-02 14:21:52 -07002035 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
2036 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002037}
2038
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002039static int scsi_map_queues(struct blk_mq_tag_set *set)
2040{
2041 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
2042
2043 if (shost->hostt->map_queues)
2044 return shost->hostt->map_queues(shost);
2045 return blk_mq_map_queues(set);
2046}
2047
Christoph Hellwigf1bea552014-04-15 12:26:54 +02002048static u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049{
2050 struct device *host_dev;
2051 u64 bounce_limit = 0xffffffff;
2052
2053 if (shost->unchecked_isa_dma)
2054 return BLK_BOUNCE_ISA;
2055 /*
2056 * Platforms with virtual-DMA translation
2057 * hardware have no practical limit.
2058 */
2059 if (!PCI_DMA_BUS_IS_PHYS)
2060 return BLK_BOUNCE_ANY;
2061
2062 host_dev = scsi_get_device(shost);
2063 if (host_dev && host_dev->dma_mask)
Russell Kinge83b3662014-02-11 17:11:04 +00002064 bounce_limit = (u64)dma_max_pfn(host_dev) << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065
2066 return bounce_limit;
2067}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002069void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070{
Lin Ming6f381fa2012-04-12 13:50:38 +08002071 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072
Bart Van Assche9efc1602017-05-31 14:43:46 -07002073 queue_flag_set_unlocked(QUEUE_FLAG_SCSI_PASSTHROUGH, q);
2074
Jens Axboea8474ce2007-08-07 09:02:51 +02002075 /*
2076 * this limit is imposed by hardware restrictions
2077 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05002078 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07002079 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02002080
Martin K. Petersen13f05c82010-09-10 20:50:10 +02002081 if (scsi_host_prot_dma(shost)) {
2082 shost->sg_prot_tablesize =
2083 min_not_zero(shost->sg_prot_tablesize,
2084 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
2085 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
2086 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
2087 }
2088
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05002089 blk_queue_max_hw_sectors(q, shost->max_sectors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
2091 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08002092 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093
FUJITA Tomonori860ac562008-02-04 22:28:05 -08002094 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
2095
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01002097 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06002098
2099 /*
2100 * set a reasonable default alignment on word boundaries: the
2101 * host and device may alter it using
2102 * blk_queue_update_dma_alignment() later.
2103 */
2104 blk_queue_dma_alignment(q, 0x03);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002105}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03002106EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06002107
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002108static int scsi_old_init_rq(struct request_queue *q, struct request *rq,
2109 gfp_t gfp)
Christoph Hellwigd2852032014-01-17 12:06:53 +01002110{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002111 struct Scsi_Host *shost = q->rq_alloc_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07002112 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002113 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002114
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002115 memset(cmd, 0, sizeof(*cmd));
2116
Bart Van Assche8e688252017-06-02 14:21:52 -07002117 if (unchecked_isa_dma)
2118 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
2119 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma, gfp,
2120 NUMA_NO_NODE);
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002121 if (!cmd->sense_buffer)
2122 goto fail;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01002123 cmd->req.sense = cmd->sense_buffer;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002124
2125 if (scsi_host_get_prot(shost) >= SHOST_DIX_TYPE0_PROTECTION) {
2126 cmd->prot_sdb = kmem_cache_zalloc(scsi_sdb_cache, gfp);
2127 if (!cmd->prot_sdb)
2128 goto fail_free_sense;
2129 }
2130
2131 return 0;
2132
2133fail_free_sense:
Bart Van Assche8e688252017-06-02 14:21:52 -07002134 scsi_free_sense_buffer(unchecked_isa_dma, cmd->sense_buffer);
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002135fail:
2136 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137}
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002138
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002139static void scsi_old_exit_rq(struct request_queue *q, struct request *rq)
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002140{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002141 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
2142
2143 if (cmd->prot_sdb)
2144 kmem_cache_free(scsi_sdb_cache, cmd->prot_sdb);
Bart Van Assche8e688252017-06-02 14:21:52 -07002145 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
2146 cmd->sense_buffer);
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002147}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002148
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002149struct request_queue *scsi_old_alloc_queue(struct scsi_device *sdev)
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002150{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002151 struct Scsi_Host *shost = sdev->host;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002152 struct request_queue *q;
2153
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002154 q = blk_alloc_queue_node(GFP_KERNEL, NUMA_NO_NODE);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002155 if (!q)
2156 return NULL;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002157 q->cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
2158 q->rq_alloc_data = shost;
2159 q->request_fn = scsi_request_fn;
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002160 q->init_rq_fn = scsi_old_init_rq;
2161 q->exit_rq_fn = scsi_old_exit_rq;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07002162 q->initialize_rq_fn = scsi_initialize_rq;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002163
Christoph Hellwige9c787e2017-01-02 21:55:26 +03002164 if (blk_init_allocated_queue(q) < 0) {
2165 blk_cleanup_queue(q);
2166 return NULL;
2167 }
2168
2169 __scsi_init_queue(shost, q);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002170 blk_queue_prep_rq(q, scsi_prep_fn);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02002171 blk_queue_unprep_rq(q, scsi_unprep_fn);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002172 blk_queue_softirq_done(q, scsi_softirq_done);
Jens Axboe242f9dc2008-09-14 05:55:09 -07002173 blk_queue_rq_timed_out(q, scsi_times_out);
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04002174 blk_queue_lld_busy(q, scsi_lld_busy);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09002175 return q;
2176}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177
Eric Biggersf363b082017-03-30 13:39:16 -07002178static const struct blk_mq_ops scsi_mq_ops = {
Christoph Hellwigd2852032014-01-17 12:06:53 +01002179 .queue_rq = scsi_queue_rq,
2180 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07002181 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07002182#ifdef CONFIG_BLK_DEBUG_FS
2183 .show_rq = scsi_show_rq,
2184#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07002185 .init_request = scsi_mq_init_request,
2186 .exit_request = scsi_mq_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07002187 .initialize_rq_fn = scsi_initialize_rq,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06002188 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01002189};
2190
2191struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
2192{
2193 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
2194 if (IS_ERR(sdev->request_queue))
2195 return NULL;
2196
2197 sdev->request_queue->queuedata = sdev;
2198 __scsi_init_queue(sdev->host, sdev->request_queue);
2199 return sdev->request_queue;
2200}
2201
2202int scsi_mq_setup_tags(struct Scsi_Host *shost)
2203{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07002204 unsigned int cmd_size, sgl_size;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002205
Bart Van Asschebe4c1862017-06-02 14:21:59 -07002206 sgl_size = scsi_mq_sgl_size(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002207 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
2208 if (scsi_host_get_prot(shost))
2209 cmd_size += sizeof(struct scsi_data_buffer) + sgl_size;
2210
2211 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
2212 shost->tag_set.ops = &scsi_mq_ops;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01002213 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01002214 shost->tag_set.queue_depth = shost->can_queue;
2215 shost->tag_set.cmd_size = cmd_size;
2216 shost->tag_set.numa_node = NUMA_NO_NODE;
2217 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07002218 shost->tag_set.flags |=
2219 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002220 shost->tag_set.driver_data = shost;
2221
2222 return blk_mq_alloc_tag_set(&shost->tag_set);
2223}
2224
2225void scsi_mq_destroy_tags(struct Scsi_Host *shost)
2226{
2227 blk_mq_free_tag_set(&shost->tag_set);
2228}
2229
Hannes Reinecke857de6e2017-02-17 09:02:45 +01002230/**
2231 * scsi_device_from_queue - return sdev associated with a request_queue
2232 * @q: The request queue to return the sdev from
2233 *
2234 * Return the sdev associated with a request queue or NULL if the
2235 * request_queue does not reference a SCSI device.
2236 */
2237struct scsi_device *scsi_device_from_queue(struct request_queue *q)
2238{
2239 struct scsi_device *sdev = NULL;
2240
2241 if (q->mq_ops) {
2242 if (q->mq_ops == &scsi_mq_ops)
2243 sdev = q->queuedata;
2244 } else if (q->request_fn == scsi_request_fn)
2245 sdev = q->queuedata;
2246 if (!sdev || !get_device(&sdev->sdev_gendev))
2247 sdev = NULL;
2248
2249 return sdev;
2250}
2251EXPORT_SYMBOL_GPL(scsi_device_from_queue);
2252
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253/*
2254 * Function: scsi_block_requests()
2255 *
2256 * Purpose: Utility function used by low-level drivers to prevent further
2257 * commands from being queued to the device.
2258 *
2259 * Arguments: shost - Host in question
2260 *
2261 * Returns: Nothing
2262 *
2263 * Lock status: No locks are assumed held.
2264 *
2265 * Notes: There is no timer nor any other means by which the requests
2266 * get unblocked other than the low-level driver calling
2267 * scsi_unblock_requests().
2268 */
2269void scsi_block_requests(struct Scsi_Host *shost)
2270{
2271 shost->host_self_blocked = 1;
2272}
2273EXPORT_SYMBOL(scsi_block_requests);
2274
2275/*
2276 * Function: scsi_unblock_requests()
2277 *
2278 * Purpose: Utility function used by low-level drivers to allow further
2279 * commands from being queued to the device.
2280 *
2281 * Arguments: shost - Host in question
2282 *
2283 * Returns: Nothing
2284 *
2285 * Lock status: No locks are assumed held.
2286 *
2287 * Notes: There is no timer nor any other means by which the requests
2288 * get unblocked other than the low-level driver calling
2289 * scsi_unblock_requests().
2290 *
2291 * This is done as an API function so that changes to the
2292 * internals of the scsi mid-layer won't require wholesale
2293 * changes to drivers that use this feature.
2294 */
2295void scsi_unblock_requests(struct Scsi_Host *shost)
2296{
2297 shost->host_self_blocked = 0;
2298 scsi_run_host_queues(shost);
2299}
2300EXPORT_SYMBOL(scsi_unblock_requests);
2301
2302int __init scsi_init_queue(void)
2303{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002304 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
2305 sizeof(struct scsi_data_buffer),
2306 0, 0, NULL);
2307 if (!scsi_sdb_cache) {
2308 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09002309 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02002310 }
2311
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 return 0;
2313}
2314
2315void scsi_exit_queue(void)
2316{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002317 kmem_cache_destroy(scsi_sense_cache);
2318 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002319 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320}
James Bottomley5baba832006-03-18 14:10:35 -06002321
2322/**
2323 * scsi_mode_select - issue a mode select
2324 * @sdev: SCSI device to be queried
2325 * @pf: Page format bit (1 == standard, 0 == vendor specific)
2326 * @sp: Save page bit (0 == don't save, 1 == save)
2327 * @modepage: mode page being requested
2328 * @buffer: request buffer (may not be smaller than eight bytes)
2329 * @len: length of request buffer.
2330 * @timeout: command timeout
2331 * @retries: number of retries before failing
2332 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002333 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06002334 * must be SCSI_SENSE_BUFFERSIZE big.
2335 *
2336 * Returns zero if successful; negative error number or scsi
2337 * status on error
2338 *
2339 */
2340int
2341scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2342 unsigned char *buffer, int len, int timeout, int retries,
2343 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2344{
2345 unsigned char cmd[10];
2346 unsigned char *real_buffer;
2347 int ret;
2348
2349 memset(cmd, 0, sizeof(cmd));
2350 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2351
2352 if (sdev->use_10_for_ms) {
2353 if (len > 65535)
2354 return -EINVAL;
2355 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2356 if (!real_buffer)
2357 return -ENOMEM;
2358 memcpy(real_buffer + 8, buffer, len);
2359 len += 8;
2360 real_buffer[0] = 0;
2361 real_buffer[1] = 0;
2362 real_buffer[2] = data->medium_type;
2363 real_buffer[3] = data->device_specific;
2364 real_buffer[4] = data->longlba ? 0x01 : 0;
2365 real_buffer[5] = 0;
2366 real_buffer[6] = data->block_descriptor_length >> 8;
2367 real_buffer[7] = data->block_descriptor_length;
2368
2369 cmd[0] = MODE_SELECT_10;
2370 cmd[7] = len >> 8;
2371 cmd[8] = len;
2372 } else {
2373 if (len > 255 || data->block_descriptor_length > 255 ||
2374 data->longlba)
2375 return -EINVAL;
2376
2377 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2378 if (!real_buffer)
2379 return -ENOMEM;
2380 memcpy(real_buffer + 4, buffer, len);
2381 len += 4;
2382 real_buffer[0] = 0;
2383 real_buffer[1] = data->medium_type;
2384 real_buffer[2] = data->device_specific;
2385 real_buffer[3] = data->block_descriptor_length;
2386
2387
2388 cmd[0] = MODE_SELECT;
2389 cmd[4] = len;
2390 }
2391
2392 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002393 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002394 kfree(real_buffer);
2395 return ret;
2396}
2397EXPORT_SYMBOL_GPL(scsi_mode_select);
2398
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399/**
Rob Landleyeb448202007-11-03 13:30:39 -05002400 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002401 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 * @dbd: set if mode sense will allow block descriptors to be returned
2403 * @modepage: mode page being requested
2404 * @buffer: request buffer (may not be smaller than eight bytes)
2405 * @len: length of request buffer.
2406 * @timeout: command timeout
2407 * @retries: number of retries before failing
2408 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002409 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002410 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 *
2412 * Returns zero if unsuccessful, or the header offset (either 4
2413 * or 8 depending on whether a six or ten byte command was
2414 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002415 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416int
James Bottomley1cf72692005-08-28 11:27:01 -05002417scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002419 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2420{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 unsigned char cmd[12];
2422 int use_10_for_ms;
2423 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002424 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002425 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426
2427 memset(data, 0, sizeof(*data));
2428 memset(&cmd[0], 0, 12);
2429 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2430 cmd[2] = modepage;
2431
James Bottomleyea73a9f2005-08-28 11:33:52 -05002432 /* caller might not be interested in sense, but we need it */
2433 if (!sshdr)
2434 sshdr = &my_sshdr;
2435
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002437 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438
2439 if (use_10_for_ms) {
2440 if (len < 8)
2441 len = 8;
2442
2443 cmd[0] = MODE_SENSE_10;
2444 cmd[8] = len;
2445 header_length = 8;
2446 } else {
2447 if (len < 4)
2448 len = 4;
2449
2450 cmd[0] = MODE_SENSE;
2451 cmd[4] = len;
2452 header_length = 4;
2453 }
2454
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 memset(buffer, 0, len);
2456
James Bottomley1cf72692005-08-28 11:27:01 -05002457 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002458 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459
2460 /* This code looks awful: what it's doing is making sure an
2461 * ILLEGAL REQUEST sense return identifies the actual command
2462 * byte as the problem. MODE_SENSE commands can return
2463 * ILLEGAL REQUEST if the code page isn't supported */
2464
James Bottomley1cf72692005-08-28 11:27:01 -05002465 if (use_10_for_ms && !scsi_status_is_good(result) &&
2466 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002467 if (scsi_sense_valid(sshdr)) {
2468 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2469 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470 /*
2471 * Invalid command operation code
2472 */
James Bottomley1cf72692005-08-28 11:27:01 -05002473 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 goto retry;
2475 }
2476 }
2477 }
2478
James Bottomley1cf72692005-08-28 11:27:01 -05002479 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002480 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2481 (modepage == 6 || modepage == 8))) {
2482 /* Initio breakage? */
2483 header_length = 0;
2484 data->length = 13;
2485 data->medium_type = 0;
2486 data->device_specific = 0;
2487 data->longlba = 0;
2488 data->block_descriptor_length = 0;
2489 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490 data->length = buffer[0]*256 + buffer[1] + 2;
2491 data->medium_type = buffer[2];
2492 data->device_specific = buffer[3];
2493 data->longlba = buffer[4] & 0x01;
2494 data->block_descriptor_length = buffer[6]*256
2495 + buffer[7];
2496 } else {
2497 data->length = buffer[0] + 1;
2498 data->medium_type = buffer[1];
2499 data->device_specific = buffer[2];
2500 data->block_descriptor_length = buffer[3];
2501 }
Al Viro6d73c852006-02-23 02:03:16 +01002502 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002503 } else if ((status_byte(result) == CHECK_CONDITION) &&
2504 scsi_sense_valid(sshdr) &&
2505 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2506 retry_count--;
2507 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508 }
2509
James Bottomley1cf72692005-08-28 11:27:01 -05002510 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511}
2512EXPORT_SYMBOL(scsi_mode_sense);
2513
James Bottomley001aac22007-12-02 19:10:40 +02002514/**
2515 * scsi_test_unit_ready - test if unit is ready
2516 * @sdev: scsi device to change the state of.
2517 * @timeout: command timeout
2518 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002519 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002520 *
2521 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002522 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002523 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524int
James Bottomley001aac22007-12-02 19:10:40 +02002525scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002526 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528 char cmd[] = {
2529 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2530 };
2531 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002532
James Bottomley001aac22007-12-02 19:10:40 +02002533 /* try to eat the UNIT_ATTENTION if there are enough retries */
2534 do {
2535 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002536 timeout, retries, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002537 if (sdev->removable && scsi_sense_valid(sshdr) &&
2538 sshdr->sense_key == UNIT_ATTENTION)
2539 sdev->changed = 1;
2540 } while (scsi_sense_valid(sshdr) &&
2541 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002542
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543 return result;
2544}
2545EXPORT_SYMBOL(scsi_test_unit_ready);
2546
2547/**
Rob Landleyeb448202007-11-03 13:30:39 -05002548 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549 * @sdev: scsi device to change the state of.
2550 * @state: state to change to.
2551 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002552 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002554 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555int
2556scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2557{
2558 enum scsi_device_state oldstate = sdev->sdev_state;
2559
2560 if (state == oldstate)
2561 return 0;
2562
2563 switch (state) {
2564 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002565 switch (oldstate) {
2566 case SDEV_CREATED_BLOCK:
2567 break;
2568 default:
2569 goto illegal;
2570 }
2571 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572
2573 case SDEV_RUNNING:
2574 switch (oldstate) {
2575 case SDEV_CREATED:
2576 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002577 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578 case SDEV_QUIESCE:
2579 case SDEV_BLOCK:
2580 break;
2581 default:
2582 goto illegal;
2583 }
2584 break;
2585
2586 case SDEV_QUIESCE:
2587 switch (oldstate) {
2588 case SDEV_RUNNING:
2589 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002590 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591 break;
2592 default:
2593 goto illegal;
2594 }
2595 break;
2596
2597 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002598 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599 switch (oldstate) {
2600 case SDEV_CREATED:
2601 case SDEV_RUNNING:
2602 case SDEV_QUIESCE:
2603 case SDEV_BLOCK:
2604 break;
2605 default:
2606 goto illegal;
2607 }
2608 break;
2609
2610 case SDEV_BLOCK:
2611 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002613 case SDEV_CREATED_BLOCK:
2614 break;
2615 default:
2616 goto illegal;
2617 }
2618 break;
2619
2620 case SDEV_CREATED_BLOCK:
2621 switch (oldstate) {
2622 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 break;
2624 default:
2625 goto illegal;
2626 }
2627 break;
2628
2629 case SDEV_CANCEL:
2630 switch (oldstate) {
2631 case SDEV_CREATED:
2632 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002633 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002634 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002635 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636 break;
2637 default:
2638 goto illegal;
2639 }
2640 break;
2641
2642 case SDEV_DEL:
2643 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002644 case SDEV_CREATED:
2645 case SDEV_RUNNING:
2646 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002647 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002649 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002650 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 break;
2652 default:
2653 goto illegal;
2654 }
2655 break;
2656
2657 }
2658 sdev->sdev_state = state;
Hannes Reinecke8a977122017-08-11 08:53:47 +02002659 sysfs_notify(&sdev->sdev_gendev.kobj, NULL, "state");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 return 0;
2661
2662 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002663 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002664 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002665 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002666 scsi_device_state_name(oldstate),
2667 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002668 );
2669 return -EINVAL;
2670}
2671EXPORT_SYMBOL(scsi_device_set_state);
2672
2673/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002674 * sdev_evt_emit - emit a single SCSI device uevent
2675 * @sdev: associated SCSI device
2676 * @evt: event to emit
2677 *
2678 * Send a single uevent (scsi_event) to the associated scsi_device.
2679 */
2680static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2681{
2682 int idx = 0;
2683 char *envp[3];
2684
2685 switch (evt->evt_type) {
2686 case SDEV_EVT_MEDIA_CHANGE:
2687 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2688 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002689 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002690 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002691 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2692 break;
2693 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2694 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2695 break;
2696 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2697 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2698 break;
2699 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2700 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2701 break;
2702 case SDEV_EVT_LUN_CHANGE_REPORTED:
2703 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2704 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002705 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2706 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2707 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002708 default:
2709 /* do nothing */
2710 break;
2711 }
2712
2713 envp[idx++] = NULL;
2714
2715 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2716}
2717
2718/**
2719 * sdev_evt_thread - send a uevent for each scsi event
2720 * @work: work struct for scsi_device
2721 *
2722 * Dispatch queued events to their associated scsi_device kobjects
2723 * as uevents.
2724 */
2725void scsi_evt_thread(struct work_struct *work)
2726{
2727 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002728 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002729 LIST_HEAD(event_list);
2730
2731 sdev = container_of(work, struct scsi_device, event_work);
2732
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002733 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2734 if (test_and_clear_bit(evt_type, sdev->pending_events))
2735 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2736
Jeff Garzika341cd02007-10-29 17:15:22 -04002737 while (1) {
2738 struct scsi_event *evt;
2739 struct list_head *this, *tmp;
2740 unsigned long flags;
2741
2742 spin_lock_irqsave(&sdev->list_lock, flags);
2743 list_splice_init(&sdev->event_list, &event_list);
2744 spin_unlock_irqrestore(&sdev->list_lock, flags);
2745
2746 if (list_empty(&event_list))
2747 break;
2748
2749 list_for_each_safe(this, tmp, &event_list) {
2750 evt = list_entry(this, struct scsi_event, node);
2751 list_del(&evt->node);
2752 scsi_evt_emit(sdev, evt);
2753 kfree(evt);
2754 }
2755 }
2756}
2757
2758/**
2759 * sdev_evt_send - send asserted event to uevent thread
2760 * @sdev: scsi_device event occurred on
2761 * @evt: event to send
2762 *
2763 * Assert scsi device event asynchronously.
2764 */
2765void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2766{
2767 unsigned long flags;
2768
Kay Sievers4d1566e2008-03-19 13:04:47 +01002769#if 0
2770 /* FIXME: currently this check eliminates all media change events
2771 * for polled devices. Need to update to discriminate between AN
2772 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002773 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2774 kfree(evt);
2775 return;
2776 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002777#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002778
2779 spin_lock_irqsave(&sdev->list_lock, flags);
2780 list_add_tail(&evt->node, &sdev->event_list);
2781 schedule_work(&sdev->event_work);
2782 spin_unlock_irqrestore(&sdev->list_lock, flags);
2783}
2784EXPORT_SYMBOL_GPL(sdev_evt_send);
2785
2786/**
2787 * sdev_evt_alloc - allocate a new scsi event
2788 * @evt_type: type of event to allocate
2789 * @gfpflags: GFP flags for allocation
2790 *
2791 * Allocates and returns a new scsi_event.
2792 */
2793struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2794 gfp_t gfpflags)
2795{
2796 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2797 if (!evt)
2798 return NULL;
2799
2800 evt->evt_type = evt_type;
2801 INIT_LIST_HEAD(&evt->node);
2802
2803 /* evt_type-specific initialization, if any */
2804 switch (evt_type) {
2805 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002806 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2807 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2808 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2809 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2810 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002811 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002812 default:
2813 /* do nothing */
2814 break;
2815 }
2816
2817 return evt;
2818}
2819EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2820
2821/**
2822 * sdev_evt_send_simple - send asserted event to uevent thread
2823 * @sdev: scsi_device event occurred on
2824 * @evt_type: type of event to send
2825 * @gfpflags: GFP flags for allocation
2826 *
2827 * Assert scsi device event asynchronously, given an event type.
2828 */
2829void sdev_evt_send_simple(struct scsi_device *sdev,
2830 enum scsi_device_event evt_type, gfp_t gfpflags)
2831{
2832 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2833 if (!evt) {
2834 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2835 evt_type);
2836 return;
2837 }
2838
2839 sdev_evt_send(sdev, evt);
2840}
2841EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2842
2843/**
Bart Van Assche669f0442016-11-22 16:17:13 -08002844 * scsi_request_fn_active() - number of kernel threads inside scsi_request_fn()
2845 * @sdev: SCSI device to count the number of scsi_request_fn() callers for.
2846 */
2847static int scsi_request_fn_active(struct scsi_device *sdev)
2848{
2849 struct request_queue *q = sdev->request_queue;
2850 int request_fn_active;
2851
2852 WARN_ON_ONCE(sdev->host->use_blk_mq);
2853
2854 spin_lock_irq(q->queue_lock);
2855 request_fn_active = q->request_fn_active;
2856 spin_unlock_irq(q->queue_lock);
2857
2858 return request_fn_active;
2859}
2860
2861/**
2862 * scsi_wait_for_queuecommand() - wait for ongoing queuecommand() calls
2863 * @sdev: SCSI device pointer.
2864 *
2865 * Wait until the ongoing shost->hostt->queuecommand() calls that are
2866 * invoked from scsi_request_fn() have finished.
2867 */
2868static void scsi_wait_for_queuecommand(struct scsi_device *sdev)
2869{
2870 WARN_ON_ONCE(sdev->host->use_blk_mq);
2871
2872 while (scsi_request_fn_active(sdev))
2873 msleep(20);
2874}
2875
2876/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877 * scsi_device_quiesce - Block user issued commands.
2878 * @sdev: scsi device to quiesce.
2879 *
2880 * This works by trying to transition to the SDEV_QUIESCE state
2881 * (which must be a legal transition). When the device is in this
2882 * state, only special requests will be accepted, all others will
2883 * be deferred. Since special requests may also be requeued requests,
2884 * a successful return doesn't guarantee the device will be
2885 * totally quiescent.
2886 *
2887 * Must be called with user context, may sleep.
2888 *
2889 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002890 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891int
2892scsi_device_quiesce(struct scsi_device *sdev)
2893{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002894 int err;
2895
2896 mutex_lock(&sdev->state_mutex);
2897 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2898 mutex_unlock(&sdev->state_mutex);
2899
Linus Torvalds1da177e2005-04-16 15:20:36 -07002900 if (err)
2901 return err;
2902
2903 scsi_run_queue(sdev->request_queue);
Christoph Hellwig71e75c92014-04-11 19:07:01 +02002904 while (atomic_read(&sdev->device_busy)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905 msleep_interruptible(200);
2906 scsi_run_queue(sdev->request_queue);
2907 }
2908 return 0;
2909}
2910EXPORT_SYMBOL(scsi_device_quiesce);
2911
2912/**
2913 * scsi_device_resume - Restart user issued commands to a quiesced device.
2914 * @sdev: scsi device to resume.
2915 *
2916 * Moves the device from quiesced back to running and restarts the
2917 * queues.
2918 *
2919 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002920 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002921void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002922{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002923 /* check if the device state was mutated prior to resume, and if
2924 * so assume the state is being managed elsewhere (for example
2925 * device deleted during suspend)
2926 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002927 mutex_lock(&sdev->state_mutex);
2928 if (sdev->sdev_state == SDEV_QUIESCE &&
2929 scsi_device_set_state(sdev, SDEV_RUNNING) == 0)
2930 scsi_run_queue(sdev->request_queue);
2931 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002932}
2933EXPORT_SYMBOL(scsi_device_resume);
2934
2935static void
2936device_quiesce_fn(struct scsi_device *sdev, void *data)
2937{
2938 scsi_device_quiesce(sdev);
2939}
2940
2941void
2942scsi_target_quiesce(struct scsi_target *starget)
2943{
2944 starget_for_each_device(starget, NULL, device_quiesce_fn);
2945}
2946EXPORT_SYMBOL(scsi_target_quiesce);
2947
2948static void
2949device_resume_fn(struct scsi_device *sdev, void *data)
2950{
2951 scsi_device_resume(sdev);
2952}
2953
2954void
2955scsi_target_resume(struct scsi_target *starget)
2956{
2957 starget_for_each_device(starget, NULL, device_resume_fn);
2958}
2959EXPORT_SYMBOL(scsi_target_resume);
2960
2961/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002962 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2963 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002965 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002966 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002967 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002968 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002969 * Notes:
2970 * This routine transitions the device to the SDEV_BLOCK state (which must be
2971 * a legal transition). When the device is in this state, command processing
2972 * is paused until the device leaves the SDEV_BLOCK state. See also
2973 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002974 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002975int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976{
Jens Axboe165125e2007-07-24 09:28:11 +02002977 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978 unsigned long flags;
2979 int err = 0;
2980
2981 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002982 if (err) {
2983 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2984
2985 if (err)
2986 return err;
2987 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002988
2989 /*
2990 * The device has transitioned to SDEV_BLOCK. Stop the
2991 * block layer from calling the midlayer with this device's
2992 * request queue.
2993 */
Christoph Hellwigd2852032014-01-17 12:06:53 +01002994 if (q->mq_ops) {
Linus Torvalds90311142017-07-06 12:10:33 -07002995 blk_mq_quiesce_queue_nowait(q);
Christoph Hellwigd2852032014-01-17 12:06:53 +01002996 } else {
2997 spin_lock_irqsave(q->queue_lock, flags);
2998 blk_stop_queue(q);
2999 spin_unlock_irqrestore(q->queue_lock, flags);
3000 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001
3002 return 0;
3003}
Bart Van Assche551eb592017-06-02 14:21:53 -07003004EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
3005
Linus Torvalds1da177e2005-04-16 15:20:36 -07003006/**
Bart Van Assche551eb592017-06-02 14:21:53 -07003007 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
3008 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07003009 *
Bart Van Assche551eb592017-06-02 14:21:53 -07003010 * Pause SCSI command processing on the specified device and wait until all
3011 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003012 *
Bart Van Assche551eb592017-06-02 14:21:53 -07003013 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003014 *
Bart Van Assche551eb592017-06-02 14:21:53 -07003015 * Note:
3016 * This routine transitions the device to the SDEV_BLOCK state (which must be
3017 * a legal transition). When the device is in this state, command processing
3018 * is paused until the device leaves the SDEV_BLOCK state. See also
3019 * scsi_internal_device_unblock().
3020 *
3021 * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
3022 * scsi_internal_device_block() has blocked a SCSI device and also
3023 * remove the rport mutex lock and unlock calls from srp_queuecommand().
Rob Landleyeb448202007-11-03 13:30:39 -05003024 */
Bart Van Assche551eb592017-06-02 14:21:53 -07003025static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026{
Bart Van Assche551eb592017-06-02 14:21:53 -07003027 struct request_queue *q = sdev->request_queue;
3028 int err;
3029
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003030 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07003031 err = scsi_internal_device_block_nowait(sdev);
3032 if (err == 0) {
3033 if (q->mq_ops)
3034 blk_mq_quiesce_queue(q);
3035 else
3036 scsi_wait_for_queuecommand(sdev);
3037 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003038 mutex_unlock(&sdev->state_mutex);
3039
Bart Van Assche551eb592017-06-02 14:21:53 -07003040 return err;
3041}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003042
Bart Van Assche66483a42017-06-02 14:21:56 -07003043void scsi_start_queue(struct scsi_device *sdev)
3044{
3045 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003046 unsigned long flags;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003047
Bart Van Assche66483a42017-06-02 14:21:56 -07003048 if (q->mq_ops) {
Linus Torvalds90311142017-07-06 12:10:33 -07003049 blk_mq_unquiesce_queue(q);
Bart Van Assche66483a42017-06-02 14:21:56 -07003050 } else {
3051 spin_lock_irqsave(q->queue_lock, flags);
3052 blk_start_queue(q);
3053 spin_unlock_irqrestore(q->queue_lock, flags);
3054 }
3055}
3056
Linus Torvalds1da177e2005-04-16 15:20:36 -07003057/**
Bart Van Assche43f75712017-06-02 14:21:54 -07003058 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07003060 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07003061 *
Bart Van Assche43f75712017-06-02 14:21:54 -07003062 * Restart the device queue for a previously suspended SCSI device. Does not
3063 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064 *
Bart Van Assche43f75712017-06-02 14:21:54 -07003065 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003066 *
Bart Van Assche43f75712017-06-02 14:21:54 -07003067 * Notes:
3068 * This routine transitions the device to the SDEV_RUNNING state or to one of
3069 * the offline states (which must be a legal transition) allowing the midlayer
3070 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003071 */
Bart Van Assche43f75712017-06-02 14:21:54 -07003072int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
3073 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003074{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003075 /*
3076 * Try to transition the scsi device to SDEV_RUNNING or one of the
3077 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003078 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02003079 switch (sdev->sdev_state) {
3080 case SDEV_BLOCK:
3081 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003082 sdev->sdev_state = new_state;
Hannes Reinecke8a977122017-08-11 08:53:47 +02003083 sysfs_notify(&sdev->sdev_gendev.kobj, NULL, "state");
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02003084 break;
3085 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003086 if (new_state == SDEV_TRANSPORT_OFFLINE ||
3087 new_state == SDEV_OFFLINE)
3088 sdev->sdev_state = new_state;
3089 else
3090 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8a977122017-08-11 08:53:47 +02003091 sysfs_notify(&sdev->sdev_gendev.kobj, NULL, "state");
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02003092 break;
3093 case SDEV_CANCEL:
3094 case SDEV_OFFLINE:
3095 break;
3096 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04003097 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02003098 }
Bart Van Assche66483a42017-06-02 14:21:56 -07003099 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003100
3101 return 0;
3102}
Bart Van Assche43f75712017-06-02 14:21:54 -07003103EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
3104
3105/**
3106 * scsi_internal_device_unblock - resume a device after a block request
3107 * @sdev: device to resume
3108 * @new_state: state to set the device to after unblocking
3109 *
3110 * Restart the device queue for a previously suspended SCSI device. May sleep.
3111 *
3112 * Returns zero if successful or a negative error code upon failure.
3113 *
3114 * Notes:
3115 * This routine transitions the device to the SDEV_RUNNING state or to one of
3116 * the offline states (which must be a legal transition) allowing the midlayer
3117 * to goose the queue for this device.
3118 */
3119static int scsi_internal_device_unblock(struct scsi_device *sdev,
3120 enum scsi_device_state new_state)
3121{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07003122 int ret;
3123
3124 mutex_lock(&sdev->state_mutex);
3125 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
3126 mutex_unlock(&sdev->state_mutex);
3127
3128 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07003129}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003130
3131static void
3132device_block(struct scsi_device *sdev, void *data)
3133{
Bart Van Assche551eb592017-06-02 14:21:53 -07003134 scsi_internal_device_block(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003135}
3136
3137static int
3138target_block(struct device *dev, void *data)
3139{
3140 if (scsi_is_target_device(dev))
3141 starget_for_each_device(to_scsi_target(dev), NULL,
3142 device_block);
3143 return 0;
3144}
3145
3146void
3147scsi_target_block(struct device *dev)
3148{
3149 if (scsi_is_target_device(dev))
3150 starget_for_each_device(to_scsi_target(dev), NULL,
3151 device_block);
3152 else
3153 device_for_each_child(dev, NULL, target_block);
3154}
3155EXPORT_SYMBOL_GPL(scsi_target_block);
3156
3157static void
3158device_unblock(struct scsi_device *sdev, void *data)
3159{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003160 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003161}
3162
3163static int
3164target_unblock(struct device *dev, void *data)
3165{
3166 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003167 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168 device_unblock);
3169 return 0;
3170}
3171
3172void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003173scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003174{
3175 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003176 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003177 device_unblock);
3178 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05003179 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003180}
3181EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003182
3183/**
3184 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05003185 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003186 * @sg_count: number of segments in sg
3187 * @offset: offset in bytes into sg, on return offset into the mapped area
3188 * @len: bytes to map, on return number of bytes mapped
3189 *
3190 * Returns virtual address of the start of the mapped page
3191 */
Jens Axboec6132da2007-10-16 11:08:49 +02003192void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003193 size_t *offset, size_t *len)
3194{
3195 int i;
3196 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02003197 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003198 struct page *page;
3199
Andrew Morton22cfefb2007-02-05 16:39:03 -08003200 WARN_ON(!irqs_disabled());
3201
Jens Axboec6132da2007-10-16 11:08:49 +02003202 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003203 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02003204 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003205 if (sg_len > *offset)
3206 break;
3207 }
3208
3209 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07003210 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
3211 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07003212 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003213 WARN_ON(1);
3214 return NULL;
3215 }
3216
3217 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02003218 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003219
3220 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02003221 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003222 *offset &= ~PAGE_MASK;
3223
3224 /* Bytes in this sg-entry from *offset to the end of the page */
3225 sg_len = PAGE_SIZE - *offset;
3226 if (*len > sg_len)
3227 *len = sg_len;
3228
Cong Wang77dfce02011-11-25 23:14:23 +08003229 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003230}
3231EXPORT_SYMBOL(scsi_kmap_atomic_sg);
3232
3233/**
Rob Landleyeb448202007-11-03 13:30:39 -05003234 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003235 * @virt: virtual address to be unmapped
3236 */
3237void scsi_kunmap_atomic_sg(void *virt)
3238{
Cong Wang77dfce02011-11-25 23:14:23 +08003239 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003240}
3241EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08003242
3243void sdev_disable_disk_events(struct scsi_device *sdev)
3244{
3245 atomic_inc(&sdev->disk_events_disable_depth);
3246}
3247EXPORT_SYMBOL(sdev_disable_disk_events);
3248
3249void sdev_enable_disk_events(struct scsi_device *sdev)
3250{
3251 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
3252 return;
3253 atomic_dec(&sdev->disk_events_disable_depth);
3254}
3255EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003256
3257/**
3258 * scsi_vpd_lun_id - return a unique device identification
3259 * @sdev: SCSI device
3260 * @id: buffer for the identification
3261 * @id_len: length of the buffer
3262 *
3263 * Copies a unique device identification into @id based
3264 * on the information in the VPD page 0x83 of the device.
3265 * The string will be formatted as a SCSI name string.
3266 *
3267 * Returns the length of the identification or error on failure.
3268 * If the identifier is longer than the supplied buffer the actual
3269 * identifier length is returned and the buffer is not zero-padded.
3270 */
3271int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
3272{
3273 u8 cur_id_type = 0xff;
3274 u8 cur_id_size = 0;
3275 unsigned char *d, *cur_id_str;
3276 unsigned char __rcu *vpd_pg83;
3277 int id_size = -EINVAL;
3278
3279 rcu_read_lock();
3280 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3281 if (!vpd_pg83) {
3282 rcu_read_unlock();
3283 return -ENXIO;
3284 }
3285
3286 /*
3287 * Look for the correct descriptor.
3288 * Order of preference for lun descriptor:
3289 * - SCSI name string
3290 * - NAA IEEE Registered Extended
3291 * - EUI-64 based 16-byte
3292 * - EUI-64 based 12-byte
3293 * - NAA IEEE Registered
3294 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02003295 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003296 * as longer descriptors reduce the likelyhood
3297 * of identification clashes.
3298 */
3299
3300 /* The id string must be at least 20 bytes + terminating NULL byte */
3301 if (id_len < 21) {
3302 rcu_read_unlock();
3303 return -EINVAL;
3304 }
3305
3306 memset(id, 0, id_len);
3307 d = vpd_pg83 + 4;
3308 while (d < vpd_pg83 + sdev->vpd_pg83_len) {
3309 /* Skip designators not referring to the LUN */
3310 if ((d[1] & 0x30) != 0x00)
3311 goto next_desig;
3312
3313 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02003314 case 0x1:
3315 /* T10 Vendor ID */
3316 if (cur_id_size > d[3])
3317 break;
3318 /* Prefer anything */
3319 if (cur_id_type > 0x01 && cur_id_type != 0xff)
3320 break;
3321 cur_id_size = d[3];
3322 if (cur_id_size + 4 > id_len)
3323 cur_id_size = id_len - 4;
3324 cur_id_str = d + 4;
3325 cur_id_type = d[1] & 0xf;
3326 id_size = snprintf(id, id_len, "t10.%*pE",
3327 cur_id_size, cur_id_str);
3328 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003329 case 0x2:
3330 /* EUI-64 */
3331 if (cur_id_size > d[3])
3332 break;
3333 /* Prefer NAA IEEE Registered Extended */
3334 if (cur_id_type == 0x3 &&
3335 cur_id_size == d[3])
3336 break;
3337 cur_id_size = d[3];
3338 cur_id_str = d + 4;
3339 cur_id_type = d[1] & 0xf;
3340 switch (cur_id_size) {
3341 case 8:
3342 id_size = snprintf(id, id_len,
3343 "eui.%8phN",
3344 cur_id_str);
3345 break;
3346 case 12:
3347 id_size = snprintf(id, id_len,
3348 "eui.%12phN",
3349 cur_id_str);
3350 break;
3351 case 16:
3352 id_size = snprintf(id, id_len,
3353 "eui.%16phN",
3354 cur_id_str);
3355 break;
3356 default:
3357 cur_id_size = 0;
3358 break;
3359 }
3360 break;
3361 case 0x3:
3362 /* NAA */
3363 if (cur_id_size > d[3])
3364 break;
3365 cur_id_size = d[3];
3366 cur_id_str = d + 4;
3367 cur_id_type = d[1] & 0xf;
3368 switch (cur_id_size) {
3369 case 8:
3370 id_size = snprintf(id, id_len,
3371 "naa.%8phN",
3372 cur_id_str);
3373 break;
3374 case 16:
3375 id_size = snprintf(id, id_len,
3376 "naa.%16phN",
3377 cur_id_str);
3378 break;
3379 default:
3380 cur_id_size = 0;
3381 break;
3382 }
3383 break;
3384 case 0x8:
3385 /* SCSI name string */
3386 if (cur_id_size + 4 > d[3])
3387 break;
3388 /* Prefer others for truncated descriptor */
3389 if (cur_id_size && d[3] > id_len)
3390 break;
3391 cur_id_size = id_size = d[3];
3392 cur_id_str = d + 4;
3393 cur_id_type = d[1] & 0xf;
3394 if (cur_id_size >= id_len)
3395 cur_id_size = id_len - 1;
3396 memcpy(id, cur_id_str, cur_id_size);
3397 /* Decrease priority for truncated descriptor */
3398 if (cur_id_size != id_size)
3399 cur_id_size = 6;
3400 break;
3401 default:
3402 break;
3403 }
3404next_desig:
3405 d += d[3] + 4;
3406 }
3407 rcu_read_unlock();
3408
3409 return id_size;
3410}
3411EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003412
3413/*
3414 * scsi_vpd_tpg_id - return a target port group identifier
3415 * @sdev: SCSI device
3416 *
3417 * Returns the Target Port Group identifier from the information
3418 * froom VPD page 0x83 of the device.
3419 *
3420 * Returns the identifier or error on failure.
3421 */
3422int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3423{
3424 unsigned char *d;
3425 unsigned char __rcu *vpd_pg83;
3426 int group_id = -EAGAIN, rel_port = -1;
3427
3428 rcu_read_lock();
3429 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3430 if (!vpd_pg83) {
3431 rcu_read_unlock();
3432 return -ENXIO;
3433 }
3434
3435 d = sdev->vpd_pg83 + 4;
3436 while (d < sdev->vpd_pg83 + sdev->vpd_pg83_len) {
3437 switch (d[1] & 0xf) {
3438 case 0x4:
3439 /* Relative target port */
3440 rel_port = get_unaligned_be16(&d[6]);
3441 break;
3442 case 0x5:
3443 /* Target port group */
3444 group_id = get_unaligned_be16(&d[6]);
3445 break;
3446 default:
3447 break;
3448 }
3449 d += d[3] + 4;
3450 }
3451 rcu_read_unlock();
3452
3453 if (group_id >= 0 && rel_id && rel_port != -1)
3454 *rel_id = rel_port;
3455
3456 return group_id;
3457}
3458EXPORT_SYMBOL(scsi_vpd_tpg_id);