blob: c115458c835e2c9eddc9083ffa667cf9e56421b5 [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
Ming Lei92524fa2019-04-28 15:39:31 +080042/*
43 * Size of integrity metadata is usually small, 1 inline sg should
44 * cover normal cases.
45 */
46#define SCSI_INLINE_PROT_SG_CNT 1
47
Christoph Hellwige9c787e2017-01-02 21:55:26 +030048static struct kmem_cache *scsi_sdb_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030049static struct kmem_cache *scsi_sense_cache;
50static struct kmem_cache *scsi_sense_isadma_cache;
51static DEFINE_MUTEX(scsi_sense_cache_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Bart Van Asschea45a1f362017-08-30 16:58:42 -070053static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd);
54
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030055static inline struct kmem_cache *
Bart Van Assche8e688252017-06-02 14:21:52 -070056scsi_select_sense_cache(bool unchecked_isa_dma)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030057{
Bart Van Assche8e688252017-06-02 14:21:52 -070058 return unchecked_isa_dma ? scsi_sense_isadma_cache : scsi_sense_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030059}
60
Bart Van Assche8e688252017-06-02 14:21:52 -070061static void scsi_free_sense_buffer(bool unchecked_isa_dma,
62 unsigned char *sense_buffer)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030063{
Bart Van Assche8e688252017-06-02 14:21:52 -070064 kmem_cache_free(scsi_select_sense_cache(unchecked_isa_dma),
65 sense_buffer);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030066}
67
Bart Van Assche8e688252017-06-02 14:21:52 -070068static unsigned char *scsi_alloc_sense_buffer(bool unchecked_isa_dma,
Christoph Hellwige9c787e2017-01-02 21:55:26 +030069 gfp_t gfp_mask, int numa_node)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030070{
Bart Van Assche8e688252017-06-02 14:21:52 -070071 return kmem_cache_alloc_node(scsi_select_sense_cache(unchecked_isa_dma),
72 gfp_mask, numa_node);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030073}
74
75int scsi_init_sense_cache(struct Scsi_Host *shost)
76{
77 struct kmem_cache *cache;
78 int ret = 0;
79
Bart Van Assche8e688252017-06-02 14:21:52 -070080 cache = scsi_select_sense_cache(shost->unchecked_isa_dma);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030081 if (cache)
82 return 0;
83
84 mutex_lock(&scsi_sense_cache_mutex);
85 if (shost->unchecked_isa_dma) {
86 scsi_sense_isadma_cache =
87 kmem_cache_create("scsi_sense_cache(DMA)",
David Windsor0afe76e2017-06-10 22:50:45 -040088 SCSI_SENSE_BUFFERSIZE, 0,
89 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030090 if (!scsi_sense_isadma_cache)
91 ret = -ENOMEM;
92 } else {
93 scsi_sense_cache =
David Windsor0afe76e2017-06-10 22:50:45 -040094 kmem_cache_create_usercopy("scsi_sense_cache",
95 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN,
96 0, SCSI_SENSE_BUFFERSIZE, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030097 if (!scsi_sense_cache)
98 ret = -ENOMEM;
99 }
100
101 mutex_unlock(&scsi_sense_cache_mutex);
102 return ret;
103}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200104
Jens Axboea488e742010-04-16 21:13:15 +0200105/*
106 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
107 * not change behaviour from the previous unplug mechanism, experimentation
108 * may prove this needs changing.
109 */
110#define SCSI_QUEUE_DELAY 3
111
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100112static void
113scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
115 struct Scsi_Host *host = cmd->device->host;
116 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500117 struct scsi_target *starget = scsi_target(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
119 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900120 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 *
122 * If the host/device isn't busy, assume that something actually
123 * completed, and that we should be able to queue a command now.
124 *
125 * Note that the prior mid-layer assumption that any host could
126 * always queue at least one command is now broken. The mid-layer
127 * will implement a user specifiable stall (see
128 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
129 * if a command is requeued with no other commands outstanding
130 * either for the device or for the host.
131 */
Mike Christief0c0a372008-08-17 15:24:38 -0500132 switch (reason) {
133 case SCSI_MLQUEUE_HOST_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100134 atomic_set(&host->host_blocked, host->max_host_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500135 break;
136 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400137 case SCSI_MLQUEUE_EH_RETRY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100138 atomic_set(&device->device_blocked,
139 device->max_device_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500140 break;
141 case SCSI_MLQUEUE_TARGET_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100142 atomic_set(&starget->target_blocked,
143 starget->max_target_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500144 break;
145 }
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100146}
147
Christoph Hellwigd2852032014-01-17 12:06:53 +0100148static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
149{
Bart Van Asschea45a1f362017-08-30 16:58:42 -0700150 if (cmd->request->rq_flags & RQF_DONTPREP) {
151 cmd->request->rq_flags &= ~RQF_DONTPREP;
152 scsi_mq_uninit_cmd(cmd);
153 } else {
154 WARN_ON_ONCE(true);
155 }
Bart Van Assche2b053ac2016-10-28 17:21:41 -0700156 blk_mq_requeue_request(cmd->request, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100157}
158
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100159/**
160 * __scsi_queue_insert - private queue insertion
161 * @cmd: The SCSI command being requeued
162 * @reason: The reason for the requeue
163 * @unbusy: Whether the queue should be unbusied
164 *
165 * This is a private queue insertion. The public interface
166 * scsi_queue_insert() always assumes the queue should be unbusied
167 * because it's always called before the completion. This function is
168 * for a requeue after completion, which should only occur in this
169 * file.
170 */
Bart Van Assche08640e82018-01-10 14:41:45 -0800171static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, bool unbusy)
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100172{
173 struct scsi_device *device = cmd->device;
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100174
175 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
176 "Inserting command %p into mlqueue\n", cmd));
177
178 scsi_set_blocked(cmd, reason);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
180 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 * Decrement the counters, since these commands are no longer
182 * active on the host/device.
183 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600184 if (unbusy)
185 scsi_device_unbusy(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500188 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000189 * that are already in the queue. Schedule requeue work under
190 * lock such that the kblockd_schedule_work() call happens
191 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200192 */
Alan Stern644373a2014-03-28 10:51:15 -0700193 cmd->result = 0;
Jens Axboef664a3c2018-11-01 16:36:27 -0600194
Jens Axboef664a3c2018-11-01 16:36:27 -0600195 blk_mq_requeue_request(cmd->request, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196}
197
James Bottomley4f5299a2009-01-02 10:42:21 -0600198/*
199 * Function: scsi_queue_insert()
200 *
201 * Purpose: Insert a command in the midlevel queue.
202 *
203 * Arguments: cmd - command that we are adding to queue.
204 * reason - why we are inserting command to queue.
205 *
206 * Lock status: Assumed that lock is not held upon entry.
207 *
208 * Returns: Nothing.
209 *
210 * Notes: We do this for one of two cases. Either the host is busy
211 * and it cannot accept any more commands for the time being,
212 * or the device returned QUEUE_FULL and can accept no more
213 * commands.
214 * Notes: This could be called either from an interrupt context or a
215 * normal process context.
216 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000217void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600218{
Bart Van Assche08640e82018-01-10 14:41:45 -0800219 __scsi_queue_insert(cmd, reason, true);
James Bottomley4f5299a2009-01-02 10:42:21 -0600220}
Christoph Hellwige8064022016-10-20 15:12:13 +0200221
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100222
223/**
Kees Cook704f8392018-07-31 12:51:54 -0700224 * __scsi_execute - insert request and wait for the result
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100225 * @sdev: scsi device
226 * @cmd: scsi command
227 * @data_direction: data direction
228 * @buffer: data buffer
229 * @bufflen: len of buffer
230 * @sense: optional sense buffer
231 * @sshdr: optional decoded sense header
232 * @timeout: request timeout in seconds
233 * @retries: number of times to retry request
234 * @flags: flags for ->cmd_flags
235 * @rq_flags: flags for ->rq_flags
236 * @resid: optional residual length
237 *
Christoph Hellwig17d53632017-04-20 16:03:01 +0200238 * Returns the scsi_cmnd result field if a command was executed, or a negative
239 * Linux error code if we didn't get that far.
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100240 */
Kees Cook704f8392018-07-31 12:51:54 -0700241int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500242 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100243 unsigned char *sense, struct scsi_sense_hdr *sshdr,
244 int timeout, int retries, u64 flags, req_flags_t rq_flags,
245 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500246{
247 struct request *req;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100248 struct scsi_request *rq;
James Bottomley39216032005-06-15 18:48:29 -0500249 int ret = DRIVER_ERROR << 24;
250
Christoph Hellwigff005a02018-05-09 09:54:05 +0200251 req = blk_get_request(sdev->request_queue,
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100252 data_direction == DMA_TO_DEVICE ?
Bart Van Assche039c6352017-11-09 10:49:56 -0800253 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, BLK_MQ_REQ_PREEMPT);
Joe Lawrencea492f072014-08-28 08:15:21 -0600254 if (IS_ERR(req))
James Bottomleybfe159a2011-07-07 15:45:40 -0500255 return ret;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100256 rq = scsi_req(req);
James Bottomley39216032005-06-15 18:48:29 -0500257
258 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
Christoph Hellwig0eb0b632018-05-09 09:54:08 +0200259 buffer, bufflen, GFP_NOIO))
James Bottomley39216032005-06-15 18:48:29 -0500260 goto out;
261
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100262 rq->cmd_len = COMMAND_SIZE(cmd[0]);
263 memcpy(rq->cmd, cmd, rq->cmd_len);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200264 rq->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500265 req->timeout = timeout;
Christoph Hellwige8064022016-10-20 15:12:13 +0200266 req->cmd_flags |= flags;
Bart Van Assche039c6352017-11-09 10:49:56 -0800267 req->rq_flags |= rq_flags | RQF_QUIET;
James Bottomley39216032005-06-15 18:48:29 -0500268
269 /*
270 * head injection *required* here otherwise quiesce won't work
271 */
272 blk_execute_rq(req->q, NULL, req, 1);
273
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400274 /*
275 * Some devices (USB mass-storage in particular) may transfer
276 * garbage data together with a residue indicating that the data
277 * is invalid. Prevent the garbage from being misinterpreted
278 * and prevent security leaks by zeroing out the excess data.
279 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100280 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
281 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400282
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900283 if (resid)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100284 *resid = rq->resid_len;
285 if (sense && rq->sense_len)
286 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100287 if (sshdr)
288 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
Christoph Hellwig17d53632017-04-20 16:03:01 +0200289 ret = rq->result;
James Bottomley39216032005-06-15 18:48:29 -0500290 out:
291 blk_put_request(req);
292
293 return ret;
294}
Kees Cook704f8392018-07-31 12:51:54 -0700295EXPORT_SYMBOL(__scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297/*
298 * Function: scsi_init_cmd_errh()
299 *
300 * Purpose: Initialize cmd fields related to error handling.
301 *
302 * Arguments: cmd - command that is ready to be queued.
303 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 * Notes: This function has the job of initializing a number of
305 * fields related to error handling. Typically this will
306 * be called once for each command, as required.
307 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200308static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200310 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900311 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300313 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314}
315
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800316/*
317 * Decrement the host_busy counter and wake up the error handler if necessary.
318 * Avoid as follows that the error handler is not woken up if shost->host_busy
319 * == shost->host_failed: use call_rcu() in scsi_eh_scmd_add() in combination
320 * with an RCU read lock in this function to ensure that this function in its
321 * entirety either finishes before scsi_eh_scmd_add() increases the
322 * host_failed counter or that it notices the shost state change made by
323 * scsi_eh_scmd_add().
324 */
325static void scsi_dec_host_busy(struct Scsi_Host *shost)
326{
327 unsigned long flags;
328
329 rcu_read_lock();
Ming Leid772a652018-08-27 15:24:43 +0800330 atomic_dec(&shost->host_busy);
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800331 if (unlikely(scsi_host_in_recovery(shost))) {
332 spin_lock_irqsave(shost->host_lock, flags);
333 if (shost->host_failed || shost->host_eh_scheduled)
334 scsi_eh_wakeup(shost);
335 spin_unlock_irqrestore(shost->host_lock, flags);
336 }
337 rcu_read_unlock();
338}
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340void scsi_device_unbusy(struct scsi_device *sdev)
341{
342 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500343 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800345 scsi_dec_host_busy(shost);
346
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100347 if (starget->can_queue > 0)
348 atomic_dec(&starget->target_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +0100349
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200350 atomic_dec(&sdev->device_busy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351}
352
Christoph Hellwigd2852032014-01-17 12:06:53 +0100353static void scsi_kick_queue(struct request_queue *q)
354{
Jens Axboef664a3c2018-11-01 16:36:27 -0600355 blk_mq_run_hw_queues(q, false);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100356}
357
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358/*
359 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
360 * and call blk_run_queue for all the scsi_devices on the target -
361 * including current_sdev first.
362 *
363 * Called with *no* scsi locks held.
364 */
365static void scsi_single_lun_run(struct scsi_device *current_sdev)
366{
367 struct Scsi_Host *shost = current_sdev->host;
368 struct scsi_device *sdev, *tmp;
369 struct scsi_target *starget = scsi_target(current_sdev);
370 unsigned long flags;
371
372 spin_lock_irqsave(shost->host_lock, flags);
373 starget->starget_sdev_user = NULL;
374 spin_unlock_irqrestore(shost->host_lock, flags);
375
376 /*
377 * Call blk_run_queue for all LUNs on the target, starting with
378 * current_sdev. We race with others (to set starget_sdev_user),
379 * but in most cases, we will be first. Ideally, each LU on the
380 * target would get some limited time or requests on the target.
381 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100382 scsi_kick_queue(current_sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
384 spin_lock_irqsave(shost->host_lock, flags);
385 if (starget->starget_sdev_user)
386 goto out;
387 list_for_each_entry_safe(sdev, tmp, &starget->devices,
388 same_target_siblings) {
389 if (sdev == current_sdev)
390 continue;
391 if (scsi_device_get(sdev))
392 continue;
393
394 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100395 scsi_kick_queue(sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 spin_lock_irqsave(shost->host_lock, flags);
397
398 scsi_device_put(sdev);
399 }
400 out:
401 spin_unlock_irqrestore(shost->host_lock, flags);
402}
403
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100404static inline bool scsi_device_is_busy(struct scsi_device *sdev)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400405{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100406 if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
407 return true;
408 if (atomic_read(&sdev->device_blocked) > 0)
409 return true;
410 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400411}
412
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100413static inline bool scsi_target_is_busy(struct scsi_target *starget)
Mike Christief0c0a372008-08-17 15:24:38 -0500414{
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100415 if (starget->can_queue > 0) {
416 if (atomic_read(&starget->target_busy) >= starget->can_queue)
417 return true;
418 if (atomic_read(&starget->target_blocked) > 0)
419 return true;
420 }
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100421 return false;
Mike Christief0c0a372008-08-17 15:24:38 -0500422}
423
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100424static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400425{
Ming Leid772a652018-08-27 15:24:43 +0800426 if (shost->can_queue > 0 &&
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100427 atomic_read(&shost->host_busy) >= shost->can_queue)
428 return true;
429 if (atomic_read(&shost->host_blocked) > 0)
430 return true;
431 if (shost->host_self_blocked)
432 return true;
433 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400434}
435
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800436static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600438 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800439 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 unsigned long flags;
441
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600443 list_splice_init(&shost->starved_list, &starved_list);
444
445 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200446 struct request_queue *slq;
447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 /*
449 * As long as shost is accepting commands and we have
450 * starved queues, call blk_run_queue. scsi_request_fn
451 * drops the queue_lock and can add us back to the
452 * starved_list.
453 *
454 * host_lock protects the starved_list and starved_entry.
455 * scsi_request_fn must get the host_lock before checking
456 * or modifying starved_list or starved_entry.
457 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600458 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500459 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500460
Mike Christie2a3a59e2008-11-11 13:42:35 -0600461 sdev = list_entry(starved_list.next,
462 struct scsi_device, starved_entry);
463 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500464 if (scsi_target_is_busy(scsi_target(sdev))) {
465 list_move_tail(&sdev->starved_entry,
466 &shost->starved_list);
467 continue;
468 }
469
James Bottomleye2eb7242013-07-02 15:05:26 +0200470 /*
471 * Once we drop the host lock, a racing scsi_remove_device()
472 * call may remove the sdev from the starved list and destroy
473 * it and the queue. Mitigate by taking a reference to the
474 * queue and never touching the sdev again after we drop the
475 * host lock. Note: if __scsi_remove_device() invokes
476 * blk_cleanup_queue() before the queue is run from this
477 * function then blk_run_queue() will return immediately since
478 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
479 */
480 slq = sdev->request_queue;
481 if (!blk_get_queue(slq))
482 continue;
483 spin_unlock_irqrestore(shost->host_lock, flags);
484
Christoph Hellwigd2852032014-01-17 12:06:53 +0100485 scsi_kick_queue(slq);
James Bottomleye2eb7242013-07-02 15:05:26 +0200486 blk_put_queue(slq);
487
488 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600490 /* put any unprocessed entries back */
491 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800493}
494
495/*
496 * Function: scsi_run_queue()
497 *
498 * Purpose: Select a proper request queue to serve next
499 *
500 * Arguments: q - last request's queue
501 *
502 * Returns: Nothing
503 *
504 * Notes: The previous command was completely finished, start
505 * a new one if possible.
506 */
507static void scsi_run_queue(struct request_queue *q)
508{
509 struct scsi_device *sdev = q->queuedata;
510
511 if (scsi_target(sdev)->single_lun)
512 scsi_single_lun_run(sdev);
513 if (!list_empty(&sdev->host->starved_list))
514 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Jens Axboef664a3c2018-11-01 16:36:27 -0600516 blk_mq_run_hw_queues(q, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517}
518
Jens Axboe9937a5e2011-05-17 11:04:44 +0200519void scsi_requeue_run_queue(struct work_struct *work)
520{
521 struct scsi_device *sdev;
522 struct request_queue *q;
523
524 sdev = container_of(work, struct scsi_device, requeue_work);
525 q = sdev->request_queue;
526 scsi_run_queue(q);
527}
528
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529void scsi_run_host_queues(struct Scsi_Host *shost)
530{
531 struct scsi_device *sdev;
532
533 shost_for_each_device(sdev, shost)
534 scsi_run_queue(sdev->request_queue);
535}
536
Christoph Hellwigd2852032014-01-17 12:06:53 +0100537static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
538{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100539 if (!blk_rq_is_passthrough(cmd->request)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100540 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
541
542 if (drv->uninit_command)
543 drv->uninit_command(cmd);
544 }
545}
546
547static void scsi_mq_free_sgtables(struct scsi_cmnd *cmd)
548{
549 if (cmd->sdb.table.nents)
Ming Lei46358732019-04-28 15:39:30 +0800550 sg_free_table_chained(&cmd->sdb.table, SG_CHUNK_SIZE);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100551 if (scsi_prot_sg_count(cmd))
Ming Lei92524fa2019-04-28 15:39:31 +0800552 sg_free_table_chained(&cmd->prot_sdb->table,
553 SCSI_INLINE_PROT_SG_CNT);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100554}
555
556static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
557{
Christoph Hellwigd2852032014-01-17 12:06:53 +0100558 scsi_mq_free_sgtables(cmd);
559 scsi_uninit_cmd(cmd);
Bart Van Assche2dd6fb52017-06-02 14:21:58 -0700560 scsi_del_cmd_from_list(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100561}
562
Douglas Gilbert7e63b5a2018-06-23 12:22:14 +0200563/* Returns false when no more bytes to process, true if there are more */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200564static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100565 unsigned int bytes)
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800566{
Bart Van Asschebed22132017-08-25 13:46:32 -0700567 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800568 struct scsi_device *sdev = cmd->device;
569 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800570
571 if (blk_update_request(req, error, bytes))
572 return true;
573
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800574 if (blk_queue_add_random(q))
575 add_disk_randomness(req->rq_disk);
576
Bart Van Assche64104f72017-08-30 16:58:39 -0700577 if (!blk_rq_is_scsi(req)) {
578 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
579 cmd->flags &= ~SCMD_INITIALIZED;
580 }
581
Jens Axboef664a3c2018-11-01 16:36:27 -0600582 /*
Bart Van Asschedb983f62019-03-18 09:29:26 -0700583 * Calling rcu_barrier() is not necessary here because the
584 * SCSI error handler guarantees that the function called by
585 * call_rcu() has been called before scsi_end_request() is
586 * called.
587 */
588 destroy_rcu_head(&cmd->rcu);
589
590 /*
Jens Axboef664a3c2018-11-01 16:36:27 -0600591 * In the MQ case the command gets freed by __blk_mq_end_request,
592 * so we have to do all cleanup that depends on it earlier.
593 *
594 * We also can't kick the queues from irq context, so we
595 * will have to defer it to a workqueue.
596 */
597 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800598
Jens Axboea78b03b2018-11-18 15:46:03 -0700599 /*
600 * queue is still alive, so grab the ref for preventing it
601 * from being cleaned up during running queue.
602 */
603 percpu_ref_get(&q->q_usage_counter);
Ming Lei8dc765d2018-11-14 16:25:51 +0800604
Jens Axboef664a3c2018-11-01 16:36:27 -0600605 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100606
Jens Axboef664a3c2018-11-01 16:36:27 -0600607 if (scsi_target(sdev)->single_lun ||
608 !list_empty(&sdev->host->starved_list))
609 kblockd_schedule_work(&sdev->requeue_work);
610 else
611 blk_mq_run_hw_queues(q, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100612
Jens Axboea78b03b2018-11-18 15:46:03 -0700613 percpu_ref_put(&q->q_usage_counter);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800614 return false;
615}
616
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200617/**
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700618 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
619 * @cmd: SCSI command
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200620 * @result: scsi error code
621 *
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700622 * Translate a SCSI result code into a blk_status_t value. May reset the host
623 * byte of @cmd->result.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200624 */
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700625static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100626{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200627 switch (host_byte(result)) {
Bart Van Asschef4abab32018-04-05 10:33:01 -0700628 case DID_OK:
629 /*
630 * Also check the other bytes than the status byte in result
631 * to handle the case when a SCSI LLD sets result to
632 * DRIVER_SENSE << 24 without setting SAM_STAT_CHECK_CONDITION.
633 */
634 if (scsi_status_is_good(result) && (result & ~0xff) == 0)
635 return BLK_STS_OK;
636 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100637 case DID_TRANSPORT_FAILFAST:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200638 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100639 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000640 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200641 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100642 case DID_NEXUS_FAILURE:
Martin Wilck4a067cf2019-02-14 22:57:41 +0100643 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200644 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200645 case DID_ALLOC_FAILURE:
646 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200647 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200648 case DID_MEDIUM_ERROR:
649 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200650 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100651 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200652 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100653 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100654}
655
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200656/* Helper for scsi_io_completion() when "reprep" action required. */
657static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
658 struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659{
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200660 /* A new command will be prepared and issued. */
Jens Axboef664a3c2018-11-01 16:36:27 -0600661 scsi_mq_requeue_cmd(cmd);
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200662}
663
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200664/* Helper for scsi_io_completion() when special action required. */
665static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
Douglas Gilbertab831082018-06-23 12:22:16 +0200666{
Jens Axboe165125e2007-07-24 09:28:11 +0200667 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 struct request *req = cmd->request;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200669 int level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500670 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
671 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900672 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200673 struct scsi_sense_hdr sshdr;
674 bool sense_valid;
675 bool sense_current = true; /* false implies "deferred sense" */
676 blk_status_t blk_stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200678 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
679 if (sense_valid)
680 sense_current = !scsi_sense_is_deferred(&sshdr);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200681
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200682 blk_stat = scsi_result_to_blk_status(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500683
Alan Sternb60af5b2008-11-03 15:56:47 -0500684 if (host_byte(result) == DID_RESET) {
685 /* Third party bus reset or reset for error recovery
686 * reasons. Just retry the command and see what
687 * happens.
688 */
689 action = ACTION_RETRY;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200690 } else if (sense_valid && sense_current) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 switch (sshdr.sense_key) {
692 case UNIT_ATTENTION:
693 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700694 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 * and quietly refuse further access.
696 */
697 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500698 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700700 /* Must have been a power glitch, or a
701 * bus reset. Could not have been a
702 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500703 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700704 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500705 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 }
707 break;
708 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700709 /* If we had an ILLEGAL REQUEST returned, then
710 * we may have performed an unsupported
711 * command. The only thing this should be
712 * would be a ten byte read where only a six
713 * byte read was supported. Also, on a system
714 * where READ CAPACITY failed, we may have
715 * read past the end of the disk.
716 */
Jens Axboe26a68012005-11-29 21:03:34 +0100717 if ((cmd->device->use_10_for_rw &&
718 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 (cmd->cmnd[0] == READ_10 ||
720 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500721 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500723 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500724 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500725 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200726 blk_stat = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500727 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400728 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500729 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200730 blk_stat = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500731 } else
732 action = ACTION_FAIL;
733 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400734 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000735 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200736 if (sshdr.asc == 0x10) /* DIF */
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200737 blk_stat = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 break;
739 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700740 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500741 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500743 if (sshdr.asc == 0x04) {
744 switch (sshdr.ascq) {
745 case 0x01: /* becoming ready */
746 case 0x04: /* format in progress */
747 case 0x05: /* rebuild in progress */
748 case 0x06: /* recalculation in progress */
749 case 0x07: /* operation in progress */
750 case 0x08: /* Long write in progress */
751 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500752 case 0x14: /* space allocation in progress */
Douglas Gilberte37c7d92018-05-18 19:25:47 -0400753 case 0x1a: /* start stop unit in progress */
754 case 0x1b: /* sanitize in progress */
755 case 0x1d: /* configuration in progress */
756 case 0x24: /* depopulation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500757 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500758 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500759 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500760 action = ACTION_FAIL;
761 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500762 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200763 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500764 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500765 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700767 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500768 action = ACTION_FAIL;
769 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500771 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 break;
773 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200774 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500775 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500776
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900777 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200778 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900779 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900780
Alan Sternb60af5b2008-11-03 15:56:47 -0500781 switch (action) {
782 case ACTION_FAIL:
783 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200784 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200785 static DEFINE_RATELIMIT_STATE(_rs,
786 DEFAULT_RATELIMIT_INTERVAL,
787 DEFAULT_RATELIMIT_BURST);
788
789 if (unlikely(scsi_logging_level))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200790 level =
791 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
792 SCSI_LOG_MLCOMPLETE_BITS);
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200793
794 /*
795 * if logging is enabled the failure will be printed
796 * in scsi_log_completion(), so avoid duplicate messages
797 */
798 if (!level && __ratelimit(&_rs)) {
799 scsi_print_result(cmd, NULL, FAILED);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +0200800 if (driver_byte(result) == DRIVER_SENSE)
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200801 scsi_print_sense(cmd);
802 scsi_print_command(cmd);
803 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500804 }
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100805 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req)))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800806 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200807 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500808 case ACTION_REPREP:
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200809 scsi_io_completion_reprep(cmd, q);
Alan Sternb60af5b2008-11-03 15:56:47 -0500810 break;
811 case ACTION_RETRY:
812 /* Retry the same command immediately */
Bart Van Assche08640e82018-01-10 14:41:45 -0800813 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500814 break;
815 case ACTION_DELAYED_RETRY:
816 /* Retry the same command after a delay */
Bart Van Assche08640e82018-01-10 14:41:45 -0800817 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500818 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 }
820}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200822/*
823 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
824 * new result that may suppress further error checking. Also modifies
825 * *blk_statp in some cases.
826 */
827static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
828 blk_status_t *blk_statp)
829{
830 bool sense_valid;
831 bool sense_current = true; /* false implies "deferred sense" */
832 struct request *req = cmd->request;
833 struct scsi_sense_hdr sshdr;
834
835 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
836 if (sense_valid)
837 sense_current = !scsi_sense_is_deferred(&sshdr);
838
839 if (blk_rq_is_passthrough(req)) {
840 if (sense_valid) {
841 /*
842 * SG_IO wants current and deferred errors
843 */
844 scsi_req(req)->sense_len =
845 min(8 + cmd->sense_buffer[7],
846 SCSI_SENSE_BUFFERSIZE);
847 }
848 if (sense_current)
849 *blk_statp = scsi_result_to_blk_status(cmd, result);
850 } else if (blk_rq_bytes(req) == 0 && sense_current) {
851 /*
852 * Flush commands do not transfers any data, and thus cannot use
853 * good_bytes != blk_rq_bytes(req) as the signal for an error.
854 * This sets *blk_statp explicitly for the problem case.
855 */
856 *blk_statp = scsi_result_to_blk_status(cmd, result);
857 }
858 /*
859 * Recovered errors need reporting, but they're always treated as
860 * success, so fiddle the result code here. For passthrough requests
861 * we already took a copy of the original into sreq->result which
862 * is what gets returned to the user
863 */
864 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
865 bool do_print = true;
866 /*
867 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
868 * skip print since caller wants ATA registers. Only occurs
869 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
870 */
871 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
872 do_print = false;
873 else if (req->rq_flags & RQF_QUIET)
874 do_print = false;
875 if (do_print)
876 scsi_print_sense(cmd);
877 result = 0;
878 /* for passthrough, *blk_statp may be set */
879 *blk_statp = BLK_STS_OK;
880 }
881 /*
882 * Another corner case: the SCSI status byte is non-zero but 'good'.
883 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
884 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
885 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
886 * intermediate statuses (both obsolete in SAM-4) as good.
887 */
888 if (status_byte(result) && scsi_status_is_good(result)) {
889 result = 0;
890 *blk_statp = BLK_STS_OK;
891 }
892 return result;
893}
894
895/*
896 * Function: scsi_io_completion()
897 *
898 * Purpose: Completion processing for block device I/O requests.
899 *
900 * Arguments: cmd - command that is finished.
901 *
902 * Lock status: Assumed that no lock is held upon entry.
903 *
904 * Returns: Nothing
905 *
906 * Notes: We will finish off the specified number of sectors. If we
907 * are done, the command block will be released and the queue
908 * function will be goosed. If we are not done then we have to
909 * figure out what to do next:
910 *
911 * a) We can call scsi_requeue_command(). The request
912 * will be unprepared and put back on the queue. Then
913 * a new command will be created for it. This should
914 * be used if we made forward progress, or if we want
915 * to switch from READ(10) to READ(6) for example.
916 *
917 * b) We can call __scsi_queue_insert(). The request will
918 * be put back on the queue and retried using the same
919 * command as before, possibly after a delay.
920 *
921 * c) We can call scsi_end_request() with blk_stat other than
922 * BLK_STS_OK, to fail the remainder of the request.
923 */
924void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
925{
926 int result = cmd->result;
927 struct request_queue *q = cmd->device->request_queue;
928 struct request *req = cmd->request;
929 blk_status_t blk_stat = BLK_STS_OK;
930
Douglas Gilbert0d437902018-06-23 12:22:19 +0200931 if (unlikely(result)) /* a nz result may or may not be an error */
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200932 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
933
Douglas Gilbert0d437902018-06-23 12:22:19 +0200934 if (unlikely(blk_rq_is_passthrough(req))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200935 /*
936 * scsi_result_to_blk_status may have reset the host_byte
937 */
938 scsi_req(req)->result = cmd->result;
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200939 }
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200940
941 /*
942 * Next deal with any sectors which we were able to correctly
943 * handle.
944 */
945 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
946 "%u sectors total, %d bytes done.\n",
947 blk_rq_sectors(req), good_bytes));
948
949 /*
950 * Next deal with any sectors which we were able to correctly
951 * handle. Failed, zero length commands always need to drop down
952 * to retry code. Fast path should return in this block.
953 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200954 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100955 if (likely(!scsi_end_request(req, blk_stat, good_bytes)))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200956 return; /* no bytes remaining */
957 }
958
Douglas Gilbert0d437902018-06-23 12:22:19 +0200959 /* Kill remainder if no retries. */
960 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100961 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req)))
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200962 WARN_ONCE(true,
963 "Bytes remaining after failed, no-retry command");
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200964 return;
965 }
966
967 /*
968 * If there had been no error, but we have leftover bytes in the
969 * requeues just queue the command up again.
970 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200971 if (likely(result == 0))
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200972 scsi_io_completion_reprep(cmd, q);
973 else
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200974 scsi_io_completion_action(cmd, result);
975}
976
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100977static blk_status_t scsi_init_sgtable(struct request *req,
978 struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200980 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981
982 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +0100983 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700985 if (unlikely(sg_alloc_table_chained(&sdb->table,
Ming Lei46358732019-04-28 15:39:30 +0800986 blk_rq_nr_phys_segments(req), sdb->table.sgl,
987 SG_CHUNK_SIZE)))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100988 return BLK_STS_RESOURCE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 /*
991 * Next, walk the list, and fill in the addresses and sizes of
992 * each segment.
993 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200994 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
995 BUG_ON(count > sdb->table.nents);
996 sdb->table.nents = count;
Christoph Hellwigfd102b12017-01-13 12:29:11 +0100997 sdb->length = blk_rq_payload_bytes(req);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100998 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001000
1001/*
1002 * Function: scsi_init_io()
1003 *
1004 * Purpose: SCSI I/O initialize function.
1005 *
1006 * Arguments: cmd - Command descriptor we wish to initialize
1007 *
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001008 * Returns: BLK_STS_OK on success
1009 * BLK_STS_RESOURCE if the failure is retryable
1010 * BLK_STS_IOERR if the failure is fatal
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001011 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001012blk_status_t scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001013{
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001014 struct request *rq = cmd->request;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001015 blk_status_t ret;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001016
Johannes Thumshirnfd3fc0b2017-01-31 10:16:00 +01001017 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001018 return BLK_STS_IOERR;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001019
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001020 ret = scsi_init_sgtable(rq, &cmd->sdb);
1021 if (ret)
1022 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001023
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001024 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001025 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1026 int ivecs, count;
1027
Christoph Hellwig14784562018-11-09 14:42:38 +01001028 if (WARN_ON_ONCE(!prot_sdb)) {
Ewan D. Milne91724c22015-01-15 10:02:12 -05001029 /*
1030 * This can happen if someone (e.g. multipath)
1031 * queues a command to a device on an adapter
1032 * that does not support DIX.
1033 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001034 ret = BLK_STS_IOERR;
Christoph Hellwig14784562018-11-09 14:42:38 +01001035 goto out_free_sgtables;
Ewan D. Milne91724c22015-01-15 10:02:12 -05001036 }
1037
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001038 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001039
Ming Lin001d63b2016-04-04 14:48:09 -07001040 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lei46358732019-04-28 15:39:30 +08001041 prot_sdb->table.sgl,
Ming Lei92524fa2019-04-28 15:39:31 +08001042 SCSI_INLINE_PROT_SG_CNT)) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001043 ret = BLK_STS_RESOURCE;
Christoph Hellwig14784562018-11-09 14:42:38 +01001044 goto out_free_sgtables;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001045 }
1046
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001047 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001048 prot_sdb->table.sgl);
Igor Stoppa6f1d8a52018-09-05 23:47:20 +03001049 BUG_ON(count > ivecs);
1050 BUG_ON(count > queue_max_integrity_segments(rq->q));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001051
1052 cmd->prot_sdb = prot_sdb;
1053 cmd->prot_sdb->table.nents = count;
1054 }
1055
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001056 return BLK_STS_OK;
Christoph Hellwig14784562018-11-09 14:42:38 +01001057out_free_sgtables:
Jens Axboef664a3c2018-11-01 16:36:27 -06001058 scsi_mq_free_sgtables(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001059 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001060}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001061EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001063/**
Bart Van Assche832889f2017-08-30 16:58:40 -07001064 * scsi_initialize_rq - initialize struct scsi_cmnd partially
Jonathan Corbet35c05062017-08-24 16:11:09 -06001065 * @rq: Request associated with the SCSI command to be initialized.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001066 *
Bart Van Assche832889f2017-08-30 16:58:40 -07001067 * This function initializes the members of struct scsi_cmnd that must be
1068 * initialized before request processing starts and that won't be
1069 * reinitialized if a SCSI command is requeued.
1070 *
Bart Van Assche64104f72017-08-30 16:58:39 -07001071 * Called from inside blk_get_request() for pass-through requests and from
1072 * inside scsi_init_command() for filesystem requests.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001073 */
Bart Van Asschee4c94702017-12-07 15:59:31 -08001074static void scsi_initialize_rq(struct request *rq)
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001075{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001076 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1077
1078 scsi_req_init(&cmd->req);
Bart Van Assche3be88282018-02-22 11:30:20 -08001079 init_rcu_head(&cmd->rcu);
Bart Van Assche832889f2017-08-30 16:58:40 -07001080 cmd->jiffies_at_alloc = jiffies;
1081 cmd->retries = 0;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001082}
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001083
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001084/* Add a command to the list used by the aacraid and dpt_i2o drivers */
1085void scsi_add_cmd_to_list(struct scsi_cmnd *cmd)
1086{
1087 struct scsi_device *sdev = cmd->device;
1088 struct Scsi_Host *shost = sdev->host;
1089 unsigned long flags;
1090
1091 if (shost->use_cmd_list) {
1092 spin_lock_irqsave(&sdev->list_lock, flags);
1093 list_add_tail(&cmd->list, &sdev->cmd_list);
1094 spin_unlock_irqrestore(&sdev->list_lock, flags);
1095 }
1096}
1097
1098/* Remove a command from the list used by the aacraid and dpt_i2o drivers */
1099void scsi_del_cmd_from_list(struct scsi_cmnd *cmd)
1100{
1101 struct scsi_device *sdev = cmd->device;
1102 struct Scsi_Host *shost = sdev->host;
1103 unsigned long flags;
1104
1105 if (shost->use_cmd_list) {
1106 spin_lock_irqsave(&sdev->list_lock, flags);
1107 BUG_ON(list_empty(&cmd->list));
1108 list_del_init(&cmd->list);
1109 spin_unlock_irqrestore(&sdev->list_lock, flags);
1110 }
1111}
1112
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001113/* Called after a request has been started. */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001114void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001115{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001116 void *buf = cmd->sense_buffer;
1117 void *prot = cmd->prot_sdb;
Bart Van Assche64104f72017-08-30 16:58:39 -07001118 struct request *rq = blk_mq_rq_from_pdu(cmd);
1119 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
Bart Van Assche832889f2017-08-30 16:58:40 -07001120 unsigned long jiffies_at_alloc;
1121 int retries;
Bart Van Assche64104f72017-08-30 16:58:39 -07001122
1123 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1124 flags |= SCMD_INITIALIZED;
1125 scsi_initialize_rq(rq);
1126 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001127
Bart Van Assche832889f2017-08-30 16:58:40 -07001128 jiffies_at_alloc = cmd->jiffies_at_alloc;
1129 retries = cmd->retries;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001130 /* zero out the cmd, except for the embedded scsi_request */
1131 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001132 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001133
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001134 cmd->device = dev;
1135 cmd->sense_buffer = buf;
1136 cmd->prot_sdb = prot;
Bart Van Assche64104f72017-08-30 16:58:39 -07001137 cmd->flags = flags;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001138 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
Bart Van Assche832889f2017-08-30 16:58:40 -07001139 cmd->jiffies_at_alloc = jiffies_at_alloc;
1140 cmd->retries = retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001141
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001142 scsi_add_cmd_to_list(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001143}
1144
Christoph Hellwig785ba832018-11-09 14:42:37 +01001145static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1146 struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001147{
Bart Van Asschebed22132017-08-25 13:46:32 -07001148 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001149
1150 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001151 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001152 * a bio attached to them. Or they might contain a SCSI command
1153 * that does not transfer data, in which case they may optionally
1154 * submit a request without an attached bio.
1155 */
1156 if (req->bio) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001157 blk_status_t ret = scsi_init_io(cmd);
1158 if (unlikely(ret != BLK_STS_OK))
1159 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001160 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001161 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001162
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001163 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001164 }
James Bottomley7b163182005-12-15 20:17:02 -06001165
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001166 cmd->cmd_len = scsi_req(req)->cmd_len;
1167 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001168 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001169 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig785ba832018-11-09 14:42:37 +01001170 return BLK_STS_OK;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001171}
1172
1173/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001174 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001175 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001176 */
Christoph Hellwig785ba832018-11-09 14:42:37 +01001177static blk_status_t scsi_setup_fs_cmnd(struct scsi_device *sdev,
1178 struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001179{
Bart Van Asschebed22132017-08-25 13:46:32 -07001180 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001181
Christoph Hellwigee14c672015-08-27 14:16:59 +02001182 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
Christoph Hellwig4c1cb672018-11-09 14:42:40 +01001183 blk_status_t ret = sdev->handler->prep_fn(sdev, req);
1184 if (ret != BLK_STS_OK)
1185 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001186 }
1187
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001188 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001189 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001190 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001191}
James Bottomley7b163182005-12-15 20:17:02 -06001192
Christoph Hellwig785ba832018-11-09 14:42:37 +01001193static blk_status_t scsi_setup_cmnd(struct scsi_device *sdev,
1194 struct request *req)
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001195{
Bart Van Asschebed22132017-08-25 13:46:32 -07001196 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001197
1198 if (!blk_rq_bytes(req))
1199 cmd->sc_data_direction = DMA_NONE;
1200 else if (rq_data_dir(req) == WRITE)
1201 cmd->sc_data_direction = DMA_TO_DEVICE;
1202 else
1203 cmd->sc_data_direction = DMA_FROM_DEVICE;
1204
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001205 if (blk_rq_is_scsi(req))
1206 return scsi_setup_scsi_cmnd(sdev, req);
1207 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001208 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001209}
1210
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001211static blk_status_t
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001212scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213{
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001214 switch (sdev->sdev_state) {
1215 case SDEV_OFFLINE:
1216 case SDEV_TRANSPORT_OFFLINE:
1217 /*
1218 * If the device is offline we refuse to process any
1219 * commands. The device must be brought online
1220 * before trying any recovery commands.
1221 */
1222 sdev_printk(KERN_ERR, sdev,
1223 "rejecting I/O to offline device\n");
1224 return BLK_STS_IOERR;
1225 case SDEV_DEL:
1226 /*
1227 * If the device is fully deleted, we refuse to
1228 * process any commands as well.
1229 */
1230 sdev_printk(KERN_ERR, sdev,
1231 "rejecting I/O to dead device\n");
1232 return BLK_STS_IOERR;
1233 case SDEV_BLOCK:
1234 case SDEV_CREATED_BLOCK:
1235 return BLK_STS_RESOURCE;
1236 case SDEV_QUIESCE:
1237 /*
1238 * If the devices is blocked we defer normal commands.
1239 */
1240 if (req && !(req->rq_flags & RQF_PREEMPT))
1241 return BLK_STS_RESOURCE;
1242 return BLK_STS_OK;
1243 default:
1244 /*
1245 * For any other not fully online state we only allow
1246 * special commands. In particular any user initiated
1247 * command is not allowed.
1248 */
1249 if (req && !(req->rq_flags & RQF_PREEMPT))
1250 return BLK_STS_IOERR;
1251 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001253}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255/*
1256 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1257 * return 0.
1258 *
1259 * Called with the queue_lock held.
1260 */
1261static inline int scsi_dev_queue_ready(struct request_queue *q,
1262 struct scsi_device *sdev)
1263{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001264 unsigned int busy;
1265
1266 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001267 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001268 if (busy)
1269 goto out_dec;
1270
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 /*
1272 * unblock after device_blocked iterates to zero
1273 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001274 if (atomic_dec_return(&sdev->device_blocked) > 0)
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001275 goto out_dec;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001276 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1277 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001279
1280 if (busy >= sdev->queue_depth)
1281 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
1283 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001284out_dec:
1285 atomic_dec(&sdev->device_busy);
1286 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287}
1288
Mike Christief0c0a372008-08-17 15:24:38 -05001289/*
1290 * scsi_target_queue_ready: checks if there we can send commands to target
1291 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001292 */
1293static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1294 struct scsi_device *sdev)
1295{
1296 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001297 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001298
1299 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001300 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001301 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001302 starget->starget_sdev_user != sdev) {
1303 spin_unlock_irq(shost->host_lock);
1304 return 0;
1305 }
Mike Christief0c0a372008-08-17 15:24:38 -05001306 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001307 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001308 }
1309
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001310 if (starget->can_queue <= 0)
1311 return 1;
1312
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001313 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001314 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001315 if (busy)
1316 goto starved;
1317
Mike Christief0c0a372008-08-17 15:24:38 -05001318 /*
1319 * unblock after target_blocked iterates to zero
1320 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001321 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001322 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001323
1324 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1325 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001326 }
1327
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001328 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001329 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001330
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001331 return 1;
1332
1333starved:
1334 spin_lock_irq(shost->host_lock);
1335 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001336 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001337out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001338 if (starget->can_queue > 0)
1339 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001340 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001341}
1342
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343/*
1344 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1345 * return 0. We must end up running the queue again whenever 0 is
1346 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 */
1348static inline int scsi_host_queue_ready(struct request_queue *q,
1349 struct Scsi_Host *shost,
1350 struct scsi_device *sdev)
1351{
Christoph Hellwig74665012014-01-22 15:29:29 +01001352 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001353
James Bottomley939647e2005-09-18 15:05:20 -05001354 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001355 return 0;
1356
Ming Leid772a652018-08-27 15:24:43 +08001357 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001358 if (atomic_read(&shost->host_blocked) > 0) {
Ming Leid772a652018-08-27 15:24:43 +08001359 if (busy)
Christoph Hellwig74665012014-01-22 15:29:29 +01001360 goto starved;
1361
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 /*
1363 * unblock after host_blocked iterates to zero
1364 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001365 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001366 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001367
1368 SCSI_LOG_MLQUEUE(3,
1369 shost_printk(KERN_INFO, shost,
1370 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001372
Ming Leid772a652018-08-27 15:24:43 +08001373 if (shost->can_queue > 0 && busy >= shost->can_queue)
Christoph Hellwig74665012014-01-22 15:29:29 +01001374 goto starved;
1375 if (shost->host_self_blocked)
1376 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377
1378 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001379 if (!list_empty(&sdev->starved_entry)) {
1380 spin_lock_irq(shost->host_lock);
1381 if (!list_empty(&sdev->starved_entry))
1382 list_del_init(&sdev->starved_entry);
1383 spin_unlock_irq(shost->host_lock);
1384 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
Christoph Hellwig74665012014-01-22 15:29:29 +01001386 return 1;
1387
1388starved:
1389 spin_lock_irq(shost->host_lock);
1390 if (list_empty(&sdev->starved_entry))
1391 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001392 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001393out_dec:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001394 scsi_dec_host_busy(shost);
Christoph Hellwig74665012014-01-22 15:29:29 +01001395 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396}
1397
1398/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001399 * Busy state exporting function for request stacking drivers.
1400 *
1401 * For efficiency, no lock is taken to check the busy state of
1402 * shost/starget/sdev, since the returned value is not guaranteed and
1403 * may be changed after request stacking drivers call the function,
1404 * regardless of taking lock or not.
1405 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001406 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1407 * needs to return 'not busy'. Otherwise, request stacking drivers
1408 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001409 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001410static bool scsi_mq_lld_busy(struct request_queue *q)
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001411{
1412 struct scsi_device *sdev = q->queuedata;
1413 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001414
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001415 if (blk_queue_dying(q))
Jens Axboef664a3c2018-11-01 16:36:27 -06001416 return false;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001417
1418 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001419
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001420 /*
1421 * Ignore host/starget busy state.
1422 * Since block layer does not have a concept of fairness across
1423 * multiple queues, congestion of host/starget needs to be handled
1424 * in SCSI layer.
1425 */
1426 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Jens Axboef664a3c2018-11-01 16:36:27 -06001427 return true;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001428
Jens Axboef664a3c2018-11-01 16:36:27 -06001429 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430}
1431
Jens Axboe1aea6432006-01-09 16:03:03 +01001432static void scsi_softirq_done(struct request *rq)
1433{
Bart Van Asschebed22132017-08-25 13:46:32 -07001434 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001435 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001436 int disposition;
1437
1438 INIT_LIST_HEAD(&cmd->eh_entry);
1439
Jens Axboe242f9dc2008-09-14 05:55:09 -07001440 atomic_inc(&cmd->device->iodone_cnt);
1441 if (cmd->result)
1442 atomic_inc(&cmd->device->ioerr_cnt);
1443
Jens Axboe1aea6432006-01-09 16:03:03 +01001444 disposition = scsi_decide_disposition(cmd);
1445 if (disposition != SUCCESS &&
1446 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1447 sdev_printk(KERN_ERR, cmd->device,
1448 "timing out command, waited %lus\n",
1449 wait_for/HZ);
1450 disposition = SUCCESS;
1451 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001452
Jens Axboe1aea6432006-01-09 16:03:03 +01001453 scsi_log_completion(cmd, disposition);
1454
1455 switch (disposition) {
1456 case SUCCESS:
1457 scsi_finish_command(cmd);
1458 break;
1459 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001460 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001461 break;
1462 case ADD_TO_MLQUEUE:
1463 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1464 break;
1465 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001466 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001467 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001468 }
1469}
1470
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001471/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001472 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1473 * @cmd: command block we are dispatching.
1474 *
1475 * Return: nonzero return request was rejected and device's queue needs to be
1476 * plugged.
1477 */
1478static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1479{
1480 struct Scsi_Host *host = cmd->device->host;
1481 int rtn = 0;
1482
1483 atomic_inc(&cmd->device->iorequest_cnt);
1484
1485 /* check if the device is still usable */
1486 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1487 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1488 * returns an immediate error upwards, and signals
1489 * that the device is no longer present */
1490 cmd->result = DID_NO_CONNECT << 16;
1491 goto done;
1492 }
1493
1494 /* Check to see if the scsi lld made this device blocked. */
1495 if (unlikely(scsi_device_blocked(cmd->device))) {
1496 /*
1497 * in blocked state, the command is just put back on
1498 * the device queue. The suspend state has already
1499 * blocked the queue so future requests should not
1500 * occur until the device transitions out of the
1501 * suspend state.
1502 */
1503 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1504 "queuecommand : device blocked\n"));
1505 return SCSI_MLQUEUE_DEVICE_BUSY;
1506 }
1507
1508 /* Store the LUN value in cmnd, if needed. */
1509 if (cmd->device->lun_in_cdb)
1510 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1511 (cmd->device->lun << 5 & 0xe0);
1512
1513 scsi_log_send(cmd);
1514
1515 /*
1516 * Before we queue this command, check if the command
1517 * length exceeds what the host adapter can handle.
1518 */
1519 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1520 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1521 "queuecommand : command too long. "
1522 "cdb_size=%d host->max_cmd_len=%d\n",
1523 cmd->cmd_len, cmd->device->host->max_cmd_len));
1524 cmd->result = (DID_ABORT << 16);
1525 goto done;
1526 }
1527
1528 if (unlikely(host->shost_state == SHOST_DEL)) {
1529 cmd->result = (DID_NO_CONNECT << 16);
1530 goto done;
1531
1532 }
1533
1534 trace_scsi_dispatch_cmd_start(cmd);
1535 rtn = host->hostt->queuecommand(host, cmd);
1536 if (rtn) {
1537 trace_scsi_dispatch_cmd_error(cmd, rtn);
1538 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1539 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1540 rtn = SCSI_MLQUEUE_HOST_BUSY;
1541
1542 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1543 "queuecommand : request rejected\n"));
1544 }
1545
1546 return rtn;
1547 done:
1548 cmd->scsi_done(cmd);
1549 return 0;
1550}
1551
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001552/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
1553static unsigned int scsi_mq_sgl_size(struct Scsi_Host *shost)
1554{
1555 return min_t(unsigned int, shost->sg_tablesize, SG_CHUNK_SIZE) *
1556 sizeof(struct scatterlist);
1557}
1558
Christoph Hellwig785ba832018-11-09 14:42:37 +01001559static blk_status_t scsi_mq_prep_fn(struct request *req)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001560{
1561 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1562 struct scsi_device *sdev = req->q->queuedata;
1563 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001564 struct scatterlist *sg;
1565
Bart Van Assche08f78432017-06-02 14:22:00 -07001566 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001567
Christoph Hellwigd2852032014-01-17 12:06:53 +01001568 cmd->request = req;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001569 cmd->tag = req->tag;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001570 cmd->prot_op = SCSI_PROT_NORMAL;
1571
Christoph Hellwigd2852032014-01-17 12:06:53 +01001572 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1573 cmd->sdb.table.sgl = sg;
1574
1575 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001576 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1577
1578 cmd->prot_sdb->table.sgl =
1579 (struct scatterlist *)(cmd->prot_sdb + 1);
1580 }
1581
Christoph Hellwigfe052522014-09-22 15:59:31 +02001582 blk_mq_start_request(req);
1583
Bart Van Assche8fe8ffb2017-10-20 11:46:45 -07001584 return scsi_setup_cmnd(sdev, req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001585}
1586
1587static void scsi_mq_done(struct scsi_cmnd *cmd)
1588{
Keith Buschf1342702018-11-26 09:54:29 -07001589 if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state)))
1590 return;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001591 trace_scsi_dispatch_cmd_done(cmd);
Keith Buschf1342702018-11-26 09:54:29 -07001592
1593 /*
1594 * If the block layer didn't complete the request due to a timeout
1595 * injection, scsi must clear its internal completed state so that the
1596 * timeout handler will see it needs to escalate its own error
1597 * recovery.
1598 */
1599 if (unlikely(!blk_mq_complete_request(cmd->request)))
1600 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001601}
1602
Ming Lei0df21c82017-10-14 17:22:32 +08001603static void scsi_mq_put_budget(struct blk_mq_hw_ctx *hctx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001604{
Ming Lei0df21c82017-10-14 17:22:32 +08001605 struct request_queue *q = hctx->queue;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001606 struct scsi_device *sdev = q->queuedata;
Ming Lei0df21c82017-10-14 17:22:32 +08001607
Ming Lei0df21c82017-10-14 17:22:32 +08001608 atomic_dec(&sdev->device_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001609}
1610
Ming Lei88022d72017-11-05 02:21:12 +08001611static bool scsi_mq_get_budget(struct blk_mq_hw_ctx *hctx)
Ming Lei0df21c82017-10-14 17:22:32 +08001612{
1613 struct request_queue *q = hctx->queue;
1614 struct scsi_device *sdev = q->queuedata;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001615
Ming Lei18c4f0a2019-04-12 11:30:32 +08001616 if (scsi_dev_queue_ready(q, sdev))
1617 return true;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001618
Ming Lei7e70aa72017-12-05 15:52:56 +08001619 if (atomic_read(&sdev->device_busy) == 0 && !scsi_device_blocked(sdev))
1620 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Ming Lei88022d72017-11-05 02:21:12 +08001621 return false;
Ming Lei0df21c82017-10-14 17:22:32 +08001622}
1623
Christoph Hellwigd2852032014-01-17 12:06:53 +01001624static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1625 const struct blk_mq_queue_data *bd)
1626{
1627 struct request *req = bd->rq;
1628 struct request_queue *q = req->q;
1629 struct scsi_device *sdev = q->queuedata;
1630 struct Scsi_Host *shost = sdev->host;
1631 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1632 blk_status_t ret;
1633 int reason;
1634
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001635 /*
1636 * If the device is not in running state we will reject some or all
1637 * commands.
1638 */
1639 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1640 ret = scsi_prep_state_check(sdev, req);
1641 if (ret != BLK_STS_OK)
1642 goto out_put_budget;
1643 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001644
1645 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001646 if (!scsi_target_queue_ready(shost, sdev))
Ming Lei826a70a2017-11-04 09:55:34 +08001647 goto out_put_budget;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001648 if (!scsi_host_queue_ready(q, shost, sdev))
1649 goto out_dec_target_busy;
1650
Christoph Hellwige8064022016-10-20 15:12:13 +02001651 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwig785ba832018-11-09 14:42:37 +01001652 ret = scsi_mq_prep_fn(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001653 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001654 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001655 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001656 } else {
Bart Van Asschecd464d82019-01-15 16:50:03 -08001657 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigfe052522014-09-22 15:59:31 +02001658 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001659 }
1660
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001661 if (sdev->simple_tags)
1662 cmd->flags |= SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001663 else
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001664 cmd->flags &= ~SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001665
Christoph Hellwigd2852032014-01-17 12:06:53 +01001666 scsi_init_cmd_errh(cmd);
1667 cmd->scsi_done = scsi_mq_done;
1668
1669 reason = scsi_dispatch_cmd(cmd);
1670 if (reason) {
1671 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001672 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001673 goto out_dec_host_busy;
1674 }
1675
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001676 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001677
1678out_dec_host_busy:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001679 scsi_dec_host_busy(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001680out_dec_target_busy:
1681 if (scsi_target(sdev)->can_queue > 0)
1682 atomic_dec(&scsi_target(sdev)->target_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001683out_put_budget:
1684 scsi_mq_put_budget(hctx);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001685 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001686 case BLK_STS_OK:
1687 break;
1688 case BLK_STS_RESOURCE:
Ming Lei86ff7c22018-01-30 22:04:57 -05001689 if (atomic_read(&sdev->device_busy) ||
1690 scsi_device_blocked(sdev))
1691 ret = BLK_STS_DEV_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001692 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001693 default:
Jaesoo Leebe549d42019-04-09 17:02:22 -07001694 if (unlikely(!scsi_device_online(sdev)))
1695 scsi_req(req)->result = DID_NO_CONNECT << 16;
1696 else
1697 scsi_req(req)->result = DID_ERROR << 16;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001698 /*
Jaesoo Leebe549d42019-04-09 17:02:22 -07001699 * Make sure to release all allocated resources when
Christoph Hellwigd2852032014-01-17 12:06:53 +01001700 * we hit an error, as we will never see this command
1701 * again.
1702 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001703 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001704 scsi_mq_uninit_cmd(cmd);
1705 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001706 }
1707 return ret;
1708}
1709
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001710static enum blk_eh_timer_return scsi_timeout(struct request *req,
1711 bool reserved)
1712{
1713 if (reserved)
1714 return BLK_EH_RESET_TIMER;
1715 return scsi_times_out(req);
1716}
1717
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001718static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1719 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001720{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001721 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07001722 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001723 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07001724 struct scatterlist *sg;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001725
Bart Van Assche8e688252017-06-02 14:21:52 -07001726 if (unchecked_isa_dma)
1727 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
1728 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
1729 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001730 if (!cmd->sense_buffer)
1731 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001732 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07001733
1734 if (scsi_host_get_prot(shost)) {
1735 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1736 shost->hostt->cmd_size;
1737 cmd->prot_sdb = (void *)sg + scsi_mq_sgl_size(shost);
1738 }
1739
Christoph Hellwigd2852032014-01-17 12:06:53 +01001740 return 0;
1741}
1742
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001743static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
1744 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001745{
1746 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1747
Bart Van Assche8e688252017-06-02 14:21:52 -07001748 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
1749 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001750}
1751
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001752static int scsi_map_queues(struct blk_mq_tag_set *set)
1753{
1754 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1755
1756 if (shost->hostt->map_queues)
1757 return shost->hostt->map_queues(shost);
Dongli Zhang99bbf482019-03-12 09:00:28 +08001758 return blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001759}
1760
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001761void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762{
Lin Ming6f381fa2012-04-12 13:50:38 +08001763 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764
Jens Axboea8474ce2007-08-07 09:02:51 +02001765 /*
1766 * this limit is imposed by hardware restrictions
1767 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001768 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07001769 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001770
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001771 if (scsi_host_prot_dma(shost)) {
1772 shost->sg_prot_tablesize =
1773 min_not_zero(shost->sg_prot_tablesize,
1774 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1775 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1776 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1777 }
1778
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001779 blk_queue_max_hw_sectors(q, shost->max_sectors);
Christoph Hellwig21e07db2018-04-03 19:09:59 +02001780 if (shost->unchecked_isa_dma)
1781 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001783 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784
Christoph Hellwiga8cf59a2019-01-16 17:12:15 +01001785 blk_queue_max_segment_size(q, shost->max_segment_size);
1786 dma_set_max_seg_size(dev, shost->max_segment_size);
James Bottomley465ff312008-01-01 10:00:10 -06001787
1788 /*
Huacai Chen90addc62017-11-21 14:23:38 +01001789 * Set a reasonable default alignment: The larger of 32-byte (dword),
1790 * which is a common minimum for HBAs, and the minimum DMA alignment,
1791 * which is set by the platform.
1792 *
1793 * Devices that require a bigger alignment can increase it later.
James Bottomley465ff312008-01-01 10:00:10 -06001794 */
Huacai Chen90addc62017-11-21 14:23:38 +01001795 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001796}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001797EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06001798
Eric Biggersf363b082017-03-30 13:39:16 -07001799static const struct blk_mq_ops scsi_mq_ops = {
Ming Lei0df21c82017-10-14 17:22:32 +08001800 .get_budget = scsi_mq_get_budget,
1801 .put_budget = scsi_mq_put_budget,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001802 .queue_rq = scsi_queue_rq,
1803 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001804 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07001805#ifdef CONFIG_BLK_DEBUG_FS
1806 .show_rq = scsi_show_rq,
1807#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001808 .init_request = scsi_mq_init_request,
1809 .exit_request = scsi_mq_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001810 .initialize_rq_fn = scsi_initialize_rq,
Jens Axboe3a7ea2c42018-10-29 10:17:28 -06001811 .busy = scsi_mq_lld_busy,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001812 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001813};
1814
1815struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
1816{
1817 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
1818 if (IS_ERR(sdev->request_queue))
1819 return NULL;
1820
1821 sdev->request_queue->queuedata = sdev;
1822 __scsi_init_queue(sdev->host, sdev->request_queue);
Christoph Hellwig17cb9602018-03-13 17:28:41 +01001823 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001824 return sdev->request_queue;
1825}
1826
1827int scsi_mq_setup_tags(struct Scsi_Host *shost)
1828{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001829 unsigned int cmd_size, sgl_size;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001830
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001831 sgl_size = scsi_mq_sgl_size(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001832 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1833 if (scsi_host_get_prot(shost))
Ming Lei92524fa2019-04-28 15:39:31 +08001834 cmd_size += sizeof(struct scsi_data_buffer) +
1835 sizeof(struct scatterlist) * SCSI_INLINE_PROT_SG_CNT;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001836
1837 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
1838 shost->tag_set.ops = &scsi_mq_ops;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01001839 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001840 shost->tag_set.queue_depth = shost->can_queue;
1841 shost->tag_set.cmd_size = cmd_size;
1842 shost->tag_set.numa_node = NUMA_NO_NODE;
Ming Lei56d18f62019-02-15 19:13:24 +08001843 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07001844 shost->tag_set.flags |=
1845 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001846 shost->tag_set.driver_data = shost;
1847
1848 return blk_mq_alloc_tag_set(&shost->tag_set);
1849}
1850
1851void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1852{
1853 blk_mq_free_tag_set(&shost->tag_set);
1854}
1855
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001856/**
1857 * scsi_device_from_queue - return sdev associated with a request_queue
1858 * @q: The request queue to return the sdev from
1859 *
1860 * Return the sdev associated with a request queue or NULL if the
1861 * request_queue does not reference a SCSI device.
1862 */
1863struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1864{
1865 struct scsi_device *sdev = NULL;
1866
Jens Axboef664a3c2018-11-01 16:36:27 -06001867 if (q->mq_ops == &scsi_mq_ops)
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001868 sdev = q->queuedata;
1869 if (!sdev || !get_device(&sdev->sdev_gendev))
1870 sdev = NULL;
1871
1872 return sdev;
1873}
1874EXPORT_SYMBOL_GPL(scsi_device_from_queue);
1875
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876/*
1877 * Function: scsi_block_requests()
1878 *
1879 * Purpose: Utility function used by low-level drivers to prevent further
1880 * commands from being queued to the device.
1881 *
1882 * Arguments: shost - Host in question
1883 *
1884 * Returns: Nothing
1885 *
1886 * Lock status: No locks are assumed held.
1887 *
1888 * Notes: There is no timer nor any other means by which the requests
1889 * get unblocked other than the low-level driver calling
1890 * scsi_unblock_requests().
1891 */
1892void scsi_block_requests(struct Scsi_Host *shost)
1893{
1894 shost->host_self_blocked = 1;
1895}
1896EXPORT_SYMBOL(scsi_block_requests);
1897
1898/*
1899 * Function: scsi_unblock_requests()
1900 *
1901 * Purpose: Utility function used by low-level drivers to allow further
1902 * commands from being queued to the device.
1903 *
1904 * Arguments: shost - Host in question
1905 *
1906 * Returns: Nothing
1907 *
1908 * Lock status: No locks are assumed held.
1909 *
1910 * Notes: There is no timer nor any other means by which the requests
1911 * get unblocked other than the low-level driver calling
1912 * scsi_unblock_requests().
1913 *
1914 * This is done as an API function so that changes to the
1915 * internals of the scsi mid-layer won't require wholesale
1916 * changes to drivers that use this feature.
1917 */
1918void scsi_unblock_requests(struct Scsi_Host *shost)
1919{
1920 shost->host_self_blocked = 0;
1921 scsi_run_host_queues(shost);
1922}
1923EXPORT_SYMBOL(scsi_unblock_requests);
1924
1925int __init scsi_init_queue(void)
1926{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001927 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1928 sizeof(struct scsi_data_buffer),
1929 0, 0, NULL);
1930 if (!scsi_sdb_cache) {
1931 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001932 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001933 }
1934
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 return 0;
1936}
1937
1938void scsi_exit_queue(void)
1939{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03001940 kmem_cache_destroy(scsi_sense_cache);
1941 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001942 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943}
James Bottomley5baba832006-03-18 14:10:35 -06001944
1945/**
1946 * scsi_mode_select - issue a mode select
1947 * @sdev: SCSI device to be queried
1948 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1949 * @sp: Save page bit (0 == don't save, 1 == save)
1950 * @modepage: mode page being requested
1951 * @buffer: request buffer (may not be smaller than eight bytes)
1952 * @len: length of request buffer.
1953 * @timeout: command timeout
1954 * @retries: number of retries before failing
1955 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001956 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001957 * must be SCSI_SENSE_BUFFERSIZE big.
1958 *
1959 * Returns zero if successful; negative error number or scsi
1960 * status on error
1961 *
1962 */
1963int
1964scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1965 unsigned char *buffer, int len, int timeout, int retries,
1966 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1967{
1968 unsigned char cmd[10];
1969 unsigned char *real_buffer;
1970 int ret;
1971
1972 memset(cmd, 0, sizeof(cmd));
1973 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
1974
1975 if (sdev->use_10_for_ms) {
1976 if (len > 65535)
1977 return -EINVAL;
1978 real_buffer = kmalloc(8 + len, GFP_KERNEL);
1979 if (!real_buffer)
1980 return -ENOMEM;
1981 memcpy(real_buffer + 8, buffer, len);
1982 len += 8;
1983 real_buffer[0] = 0;
1984 real_buffer[1] = 0;
1985 real_buffer[2] = data->medium_type;
1986 real_buffer[3] = data->device_specific;
1987 real_buffer[4] = data->longlba ? 0x01 : 0;
1988 real_buffer[5] = 0;
1989 real_buffer[6] = data->block_descriptor_length >> 8;
1990 real_buffer[7] = data->block_descriptor_length;
1991
1992 cmd[0] = MODE_SELECT_10;
1993 cmd[7] = len >> 8;
1994 cmd[8] = len;
1995 } else {
1996 if (len > 255 || data->block_descriptor_length > 255 ||
1997 data->longlba)
1998 return -EINVAL;
1999
2000 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2001 if (!real_buffer)
2002 return -ENOMEM;
2003 memcpy(real_buffer + 4, buffer, len);
2004 len += 4;
2005 real_buffer[0] = 0;
2006 real_buffer[1] = data->medium_type;
2007 real_buffer[2] = data->device_specific;
2008 real_buffer[3] = data->block_descriptor_length;
2009
2010
2011 cmd[0] = MODE_SELECT;
2012 cmd[4] = len;
2013 }
2014
2015 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002016 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002017 kfree(real_buffer);
2018 return ret;
2019}
2020EXPORT_SYMBOL_GPL(scsi_mode_select);
2021
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022/**
Rob Landleyeb448202007-11-03 13:30:39 -05002023 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002024 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 * @dbd: set if mode sense will allow block descriptors to be returned
2026 * @modepage: mode page being requested
2027 * @buffer: request buffer (may not be smaller than eight bytes)
2028 * @len: length of request buffer.
2029 * @timeout: command timeout
2030 * @retries: number of retries before failing
2031 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002032 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002033 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 *
2035 * Returns zero if unsuccessful, or the header offset (either 4
2036 * or 8 depending on whether a six or ten byte command was
2037 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002038 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039int
James Bottomley1cf72692005-08-28 11:27:01 -05002040scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002042 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2043{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 unsigned char cmd[12];
2045 int use_10_for_ms;
2046 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002047 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002048 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049
2050 memset(data, 0, sizeof(*data));
2051 memset(&cmd[0], 0, 12);
2052 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2053 cmd[2] = modepage;
2054
James Bottomleyea73a9f2005-08-28 11:33:52 -05002055 /* caller might not be interested in sense, but we need it */
2056 if (!sshdr)
2057 sshdr = &my_sshdr;
2058
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002060 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061
2062 if (use_10_for_ms) {
2063 if (len < 8)
2064 len = 8;
2065
2066 cmd[0] = MODE_SENSE_10;
2067 cmd[8] = len;
2068 header_length = 8;
2069 } else {
2070 if (len < 4)
2071 len = 4;
2072
2073 cmd[0] = MODE_SENSE;
2074 cmd[4] = len;
2075 header_length = 4;
2076 }
2077
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 memset(buffer, 0, len);
2079
James Bottomley1cf72692005-08-28 11:27:01 -05002080 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002081 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082
2083 /* This code looks awful: what it's doing is making sure an
2084 * ILLEGAL REQUEST sense return identifies the actual command
2085 * byte as the problem. MODE_SENSE commands can return
2086 * ILLEGAL REQUEST if the code page isn't supported */
2087
James Bottomley1cf72692005-08-28 11:27:01 -05002088 if (use_10_for_ms && !scsi_status_is_good(result) &&
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002089 driver_byte(result) == DRIVER_SENSE) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002090 if (scsi_sense_valid(sshdr)) {
2091 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2092 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 /*
2094 * Invalid command operation code
2095 */
James Bottomley1cf72692005-08-28 11:27:01 -05002096 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 goto retry;
2098 }
2099 }
2100 }
2101
James Bottomley1cf72692005-08-28 11:27:01 -05002102 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002103 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2104 (modepage == 6 || modepage == 8))) {
2105 /* Initio breakage? */
2106 header_length = 0;
2107 data->length = 13;
2108 data->medium_type = 0;
2109 data->device_specific = 0;
2110 data->longlba = 0;
2111 data->block_descriptor_length = 0;
2112 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 data->length = buffer[0]*256 + buffer[1] + 2;
2114 data->medium_type = buffer[2];
2115 data->device_specific = buffer[3];
2116 data->longlba = buffer[4] & 0x01;
2117 data->block_descriptor_length = buffer[6]*256
2118 + buffer[7];
2119 } else {
2120 data->length = buffer[0] + 1;
2121 data->medium_type = buffer[1];
2122 data->device_specific = buffer[2];
2123 data->block_descriptor_length = buffer[3];
2124 }
Al Viro6d73c852006-02-23 02:03:16 +01002125 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002126 } else if ((status_byte(result) == CHECK_CONDITION) &&
2127 scsi_sense_valid(sshdr) &&
2128 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2129 retry_count--;
2130 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 }
2132
James Bottomley1cf72692005-08-28 11:27:01 -05002133 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134}
2135EXPORT_SYMBOL(scsi_mode_sense);
2136
James Bottomley001aac22007-12-02 19:10:40 +02002137/**
2138 * scsi_test_unit_ready - test if unit is ready
2139 * @sdev: scsi device to change the state of.
2140 * @timeout: command timeout
2141 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002142 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002143 *
2144 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002145 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002146 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147int
James Bottomley001aac22007-12-02 19:10:40 +02002148scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002149 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 char cmd[] = {
2152 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2153 };
2154 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002155
James Bottomley001aac22007-12-02 19:10:40 +02002156 /* try to eat the UNIT_ATTENTION if there are enough retries */
2157 do {
2158 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
Bart Van Assche9b91fd32018-02-12 10:57:52 -08002159 timeout, 1, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002160 if (sdev->removable && scsi_sense_valid(sshdr) &&
2161 sshdr->sense_key == UNIT_ATTENTION)
2162 sdev->changed = 1;
2163 } while (scsi_sense_valid(sshdr) &&
2164 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002165
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 return result;
2167}
2168EXPORT_SYMBOL(scsi_test_unit_ready);
2169
2170/**
Rob Landleyeb448202007-11-03 13:30:39 -05002171 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 * @sdev: scsi device to change the state of.
2173 * @state: state to change to.
2174 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002175 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002177 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178int
2179scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2180{
2181 enum scsi_device_state oldstate = sdev->sdev_state;
2182
2183 if (state == oldstate)
2184 return 0;
2185
2186 switch (state) {
2187 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002188 switch (oldstate) {
2189 case SDEV_CREATED_BLOCK:
2190 break;
2191 default:
2192 goto illegal;
2193 }
2194 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195
2196 case SDEV_RUNNING:
2197 switch (oldstate) {
2198 case SDEV_CREATED:
2199 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002200 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 case SDEV_QUIESCE:
2202 case SDEV_BLOCK:
2203 break;
2204 default:
2205 goto illegal;
2206 }
2207 break;
2208
2209 case SDEV_QUIESCE:
2210 switch (oldstate) {
2211 case SDEV_RUNNING:
2212 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002213 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 break;
2215 default:
2216 goto illegal;
2217 }
2218 break;
2219
2220 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002221 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 switch (oldstate) {
2223 case SDEV_CREATED:
2224 case SDEV_RUNNING:
2225 case SDEV_QUIESCE:
2226 case SDEV_BLOCK:
2227 break;
2228 default:
2229 goto illegal;
2230 }
2231 break;
2232
2233 case SDEV_BLOCK:
2234 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002236 case SDEV_CREATED_BLOCK:
Hannes Reineckea33e5bf2018-10-07 10:35:35 +02002237 case SDEV_OFFLINE:
James Bottomley6f4267e2008-08-22 16:53:31 -05002238 break;
2239 default:
2240 goto illegal;
2241 }
2242 break;
2243
2244 case SDEV_CREATED_BLOCK:
2245 switch (oldstate) {
2246 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 break;
2248 default:
2249 goto illegal;
2250 }
2251 break;
2252
2253 case SDEV_CANCEL:
2254 switch (oldstate) {
2255 case SDEV_CREATED:
2256 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002257 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002259 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 break;
2261 default:
2262 goto illegal;
2263 }
2264 break;
2265
2266 case SDEV_DEL:
2267 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002268 case SDEV_CREATED:
2269 case SDEV_RUNNING:
2270 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002271 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002273 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002274 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 break;
2276 default:
2277 goto illegal;
2278 }
2279 break;
2280
2281 }
2282 sdev->sdev_state = state;
2283 return 0;
2284
2285 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002286 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002287 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002288 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002289 scsi_device_state_name(oldstate),
2290 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 );
2292 return -EINVAL;
2293}
2294EXPORT_SYMBOL(scsi_device_set_state);
2295
2296/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002297 * sdev_evt_emit - emit a single SCSI device uevent
2298 * @sdev: associated SCSI device
2299 * @evt: event to emit
2300 *
2301 * Send a single uevent (scsi_event) to the associated scsi_device.
2302 */
2303static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2304{
2305 int idx = 0;
2306 char *envp[3];
2307
2308 switch (evt->evt_type) {
2309 case SDEV_EVT_MEDIA_CHANGE:
2310 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2311 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002312 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002313 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002314 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2315 break;
2316 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2317 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2318 break;
2319 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2320 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2321 break;
2322 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2323 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2324 break;
2325 case SDEV_EVT_LUN_CHANGE_REPORTED:
2326 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2327 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002328 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2329 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2330 break;
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002331 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2332 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2333 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002334 default:
2335 /* do nothing */
2336 break;
2337 }
2338
2339 envp[idx++] = NULL;
2340
2341 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2342}
2343
2344/**
2345 * sdev_evt_thread - send a uevent for each scsi event
2346 * @work: work struct for scsi_device
2347 *
2348 * Dispatch queued events to their associated scsi_device kobjects
2349 * as uevents.
2350 */
2351void scsi_evt_thread(struct work_struct *work)
2352{
2353 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002354 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002355 LIST_HEAD(event_list);
2356
2357 sdev = container_of(work, struct scsi_device, event_work);
2358
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002359 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2360 if (test_and_clear_bit(evt_type, sdev->pending_events))
2361 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2362
Jeff Garzika341cd02007-10-29 17:15:22 -04002363 while (1) {
2364 struct scsi_event *evt;
2365 struct list_head *this, *tmp;
2366 unsigned long flags;
2367
2368 spin_lock_irqsave(&sdev->list_lock, flags);
2369 list_splice_init(&sdev->event_list, &event_list);
2370 spin_unlock_irqrestore(&sdev->list_lock, flags);
2371
2372 if (list_empty(&event_list))
2373 break;
2374
2375 list_for_each_safe(this, tmp, &event_list) {
2376 evt = list_entry(this, struct scsi_event, node);
2377 list_del(&evt->node);
2378 scsi_evt_emit(sdev, evt);
2379 kfree(evt);
2380 }
2381 }
2382}
2383
2384/**
2385 * sdev_evt_send - send asserted event to uevent thread
2386 * @sdev: scsi_device event occurred on
2387 * @evt: event to send
2388 *
2389 * Assert scsi device event asynchronously.
2390 */
2391void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2392{
2393 unsigned long flags;
2394
Kay Sievers4d1566e2008-03-19 13:04:47 +01002395#if 0
2396 /* FIXME: currently this check eliminates all media change events
2397 * for polled devices. Need to update to discriminate between AN
2398 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002399 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2400 kfree(evt);
2401 return;
2402 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002403#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002404
2405 spin_lock_irqsave(&sdev->list_lock, flags);
2406 list_add_tail(&evt->node, &sdev->event_list);
2407 schedule_work(&sdev->event_work);
2408 spin_unlock_irqrestore(&sdev->list_lock, flags);
2409}
2410EXPORT_SYMBOL_GPL(sdev_evt_send);
2411
2412/**
2413 * sdev_evt_alloc - allocate a new scsi event
2414 * @evt_type: type of event to allocate
2415 * @gfpflags: GFP flags for allocation
2416 *
2417 * Allocates and returns a new scsi_event.
2418 */
2419struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2420 gfp_t gfpflags)
2421{
2422 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2423 if (!evt)
2424 return NULL;
2425
2426 evt->evt_type = evt_type;
2427 INIT_LIST_HEAD(&evt->node);
2428
2429 /* evt_type-specific initialization, if any */
2430 switch (evt_type) {
2431 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002432 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2433 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2434 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2435 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2436 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002437 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002438 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002439 default:
2440 /* do nothing */
2441 break;
2442 }
2443
2444 return evt;
2445}
2446EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2447
2448/**
2449 * sdev_evt_send_simple - send asserted event to uevent thread
2450 * @sdev: scsi_device event occurred on
2451 * @evt_type: type of event to send
2452 * @gfpflags: GFP flags for allocation
2453 *
2454 * Assert scsi device event asynchronously, given an event type.
2455 */
2456void sdev_evt_send_simple(struct scsi_device *sdev,
2457 enum scsi_device_event evt_type, gfp_t gfpflags)
2458{
2459 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2460 if (!evt) {
2461 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2462 evt_type);
2463 return;
2464 }
2465
2466 sdev_evt_send(sdev, evt);
2467}
2468EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2469
2470/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471 * scsi_device_quiesce - Block user issued commands.
2472 * @sdev: scsi device to quiesce.
2473 *
2474 * This works by trying to transition to the SDEV_QUIESCE state
2475 * (which must be a legal transition). When the device is in this
2476 * state, only special requests will be accepted, all others will
2477 * be deferred. Since special requests may also be requeued requests,
2478 * a successful return doesn't guarantee the device will be
2479 * totally quiescent.
2480 *
2481 * Must be called with user context, may sleep.
2482 *
2483 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002484 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485int
2486scsi_device_quiesce(struct scsi_device *sdev)
2487{
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002488 struct request_queue *q = sdev->request_queue;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002489 int err;
2490
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002491 /*
2492 * It is allowed to call scsi_device_quiesce() multiple times from
2493 * the same context but concurrent scsi_device_quiesce() calls are
2494 * not allowed.
2495 */
2496 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2497
Bart Van Asschecd84a622018-09-26 14:01:04 -07002498 if (sdev->quiesced_by == current)
2499 return 0;
2500
2501 blk_set_pm_only(q);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002502
2503 blk_mq_freeze_queue(q);
2504 /*
Bart Van Asschecd84a622018-09-26 14:01:04 -07002505 * Ensure that the effect of blk_set_pm_only() will be visible
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002506 * for percpu_ref_tryget() callers that occur after the queue
2507 * unfreeze even if the queue was already frozen before this function
2508 * was called. See also https://lwn.net/Articles/573497/.
2509 */
2510 synchronize_rcu();
2511 blk_mq_unfreeze_queue(q);
2512
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002513 mutex_lock(&sdev->state_mutex);
2514 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002515 if (err == 0)
2516 sdev->quiesced_by = current;
2517 else
Bart Van Asschecd84a622018-09-26 14:01:04 -07002518 blk_clear_pm_only(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002519 mutex_unlock(&sdev->state_mutex);
2520
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002521 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522}
2523EXPORT_SYMBOL(scsi_device_quiesce);
2524
2525/**
2526 * scsi_device_resume - Restart user issued commands to a quiesced device.
2527 * @sdev: scsi device to resume.
2528 *
2529 * Moves the device from quiesced back to running and restarts the
2530 * queues.
2531 *
2532 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002533 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002534void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002536 /* check if the device state was mutated prior to resume, and if
2537 * so assume the state is being managed elsewhere (for example
2538 * device deleted during suspend)
2539 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002540 mutex_lock(&sdev->state_mutex);
Bart Van Assche17605af2019-03-15 16:27:58 -07002541 if (sdev->quiesced_by) {
2542 sdev->quiesced_by = NULL;
2543 blk_clear_pm_only(sdev->request_queue);
2544 }
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002545 if (sdev->sdev_state == SDEV_QUIESCE)
2546 scsi_device_set_state(sdev, SDEV_RUNNING);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002547 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548}
2549EXPORT_SYMBOL(scsi_device_resume);
2550
2551static void
2552device_quiesce_fn(struct scsi_device *sdev, void *data)
2553{
2554 scsi_device_quiesce(sdev);
2555}
2556
2557void
2558scsi_target_quiesce(struct scsi_target *starget)
2559{
2560 starget_for_each_device(starget, NULL, device_quiesce_fn);
2561}
2562EXPORT_SYMBOL(scsi_target_quiesce);
2563
2564static void
2565device_resume_fn(struct scsi_device *sdev, void *data)
2566{
2567 scsi_device_resume(sdev);
2568}
2569
2570void
2571scsi_target_resume(struct scsi_target *starget)
2572{
2573 starget_for_each_device(starget, NULL, device_resume_fn);
2574}
2575EXPORT_SYMBOL(scsi_target_resume);
2576
2577/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002578 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2579 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002581 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002583 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002585 * Notes:
2586 * This routine transitions the device to the SDEV_BLOCK state (which must be
2587 * a legal transition). When the device is in this state, command processing
2588 * is paused until the device leaves the SDEV_BLOCK state. See also
2589 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002590 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002591int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592{
Jens Axboe165125e2007-07-24 09:28:11 +02002593 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 int err = 0;
2595
2596 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002597 if (err) {
2598 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2599
2600 if (err)
2601 return err;
2602 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603
2604 /*
2605 * The device has transitioned to SDEV_BLOCK. Stop the
2606 * block layer from calling the midlayer with this device's
2607 * request queue.
2608 */
Jens Axboef664a3c2018-11-01 16:36:27 -06002609 blk_mq_quiesce_queue_nowait(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610 return 0;
2611}
Bart Van Assche551eb592017-06-02 14:21:53 -07002612EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2613
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002615 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2616 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002618 * Pause SCSI command processing on the specified device and wait until all
2619 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002621 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002623 * Note:
2624 * This routine transitions the device to the SDEV_BLOCK state (which must be
2625 * a legal transition). When the device is in this state, command processing
2626 * is paused until the device leaves the SDEV_BLOCK state. See also
2627 * scsi_internal_device_unblock().
2628 *
2629 * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
2630 * scsi_internal_device_block() has blocked a SCSI device and also
2631 * remove the rport mutex lock and unlock calls from srp_queuecommand().
Rob Landleyeb448202007-11-03 13:30:39 -05002632 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002633static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002634{
Bart Van Assche551eb592017-06-02 14:21:53 -07002635 struct request_queue *q = sdev->request_queue;
2636 int err;
2637
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002638 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07002639 err = scsi_internal_device_block_nowait(sdev);
Jens Axboef664a3c2018-11-01 16:36:27 -06002640 if (err == 0)
2641 blk_mq_quiesce_queue(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002642 mutex_unlock(&sdev->state_mutex);
2643
Bart Van Assche551eb592017-06-02 14:21:53 -07002644 return err;
2645}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646
Bart Van Assche66483a42017-06-02 14:21:56 -07002647void scsi_start_queue(struct scsi_device *sdev)
2648{
2649 struct request_queue *q = sdev->request_queue;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002650
Jens Axboef664a3c2018-11-01 16:36:27 -06002651 blk_mq_unquiesce_queue(q);
Bart Van Assche66483a42017-06-02 14:21:56 -07002652}
2653
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654/**
Bart Van Assche43f75712017-06-02 14:21:54 -07002655 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07002657 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002659 * Restart the device queue for a previously suspended SCSI device. Does not
2660 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002662 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002664 * Notes:
2665 * This routine transitions the device to the SDEV_RUNNING state or to one of
2666 * the offline states (which must be a legal transition) allowing the midlayer
2667 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002668 */
Bart Van Assche43f75712017-06-02 14:21:54 -07002669int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2670 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002672 /*
2673 * Try to transition the scsi device to SDEV_RUNNING or one of the
2674 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002675 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002676 switch (sdev->sdev_state) {
2677 case SDEV_BLOCK:
2678 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002679 sdev->sdev_state = new_state;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002680 break;
2681 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002682 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2683 new_state == SDEV_OFFLINE)
2684 sdev->sdev_state = new_state;
2685 else
2686 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002687 break;
2688 case SDEV_CANCEL:
2689 case SDEV_OFFLINE:
2690 break;
2691 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002692 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002693 }
Bart Van Assche66483a42017-06-02 14:21:56 -07002694 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695
2696 return 0;
2697}
Bart Van Assche43f75712017-06-02 14:21:54 -07002698EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2699
2700/**
2701 * scsi_internal_device_unblock - resume a device after a block request
2702 * @sdev: device to resume
2703 * @new_state: state to set the device to after unblocking
2704 *
2705 * Restart the device queue for a previously suspended SCSI device. May sleep.
2706 *
2707 * Returns zero if successful or a negative error code upon failure.
2708 *
2709 * Notes:
2710 * This routine transitions the device to the SDEV_RUNNING state or to one of
2711 * the offline states (which must be a legal transition) allowing the midlayer
2712 * to goose the queue for this device.
2713 */
2714static int scsi_internal_device_unblock(struct scsi_device *sdev,
2715 enum scsi_device_state new_state)
2716{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002717 int ret;
2718
2719 mutex_lock(&sdev->state_mutex);
2720 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2721 mutex_unlock(&sdev->state_mutex);
2722
2723 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07002724}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725
2726static void
2727device_block(struct scsi_device *sdev, void *data)
2728{
Bart Van Assche551eb592017-06-02 14:21:53 -07002729 scsi_internal_device_block(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730}
2731
2732static int
2733target_block(struct device *dev, void *data)
2734{
2735 if (scsi_is_target_device(dev))
2736 starget_for_each_device(to_scsi_target(dev), NULL,
2737 device_block);
2738 return 0;
2739}
2740
2741void
2742scsi_target_block(struct device *dev)
2743{
2744 if (scsi_is_target_device(dev))
2745 starget_for_each_device(to_scsi_target(dev), NULL,
2746 device_block);
2747 else
2748 device_for_each_child(dev, NULL, target_block);
2749}
2750EXPORT_SYMBOL_GPL(scsi_target_block);
2751
2752static void
2753device_unblock(struct scsi_device *sdev, void *data)
2754{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002755 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756}
2757
2758static int
2759target_unblock(struct device *dev, void *data)
2760{
2761 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002762 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763 device_unblock);
2764 return 0;
2765}
2766
2767void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002768scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769{
2770 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002771 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772 device_unblock);
2773 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002774 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775}
2776EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002777
2778/**
2779 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002780 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002781 * @sg_count: number of segments in sg
2782 * @offset: offset in bytes into sg, on return offset into the mapped area
2783 * @len: bytes to map, on return number of bytes mapped
2784 *
2785 * Returns virtual address of the start of the mapped page
2786 */
Jens Axboec6132da2007-10-16 11:08:49 +02002787void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002788 size_t *offset, size_t *len)
2789{
2790 int i;
2791 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002792 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002793 struct page *page;
2794
Andrew Morton22cfefb2007-02-05 16:39:03 -08002795 WARN_ON(!irqs_disabled());
2796
Jens Axboec6132da2007-10-16 11:08:49 +02002797 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002798 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002799 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002800 if (sg_len > *offset)
2801 break;
2802 }
2803
2804 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002805 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2806 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002807 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002808 WARN_ON(1);
2809 return NULL;
2810 }
2811
2812 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002813 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002814
2815 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002816 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002817 *offset &= ~PAGE_MASK;
2818
2819 /* Bytes in this sg-entry from *offset to the end of the page */
2820 sg_len = PAGE_SIZE - *offset;
2821 if (*len > sg_len)
2822 *len = sg_len;
2823
Cong Wang77dfce02011-11-25 23:14:23 +08002824 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002825}
2826EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2827
2828/**
Rob Landleyeb448202007-11-03 13:30:39 -05002829 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002830 * @virt: virtual address to be unmapped
2831 */
2832void scsi_kunmap_atomic_sg(void *virt)
2833{
Cong Wang77dfce02011-11-25 23:14:23 +08002834 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002835}
2836EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002837
2838void sdev_disable_disk_events(struct scsi_device *sdev)
2839{
2840 atomic_inc(&sdev->disk_events_disable_depth);
2841}
2842EXPORT_SYMBOL(sdev_disable_disk_events);
2843
2844void sdev_enable_disk_events(struct scsi_device *sdev)
2845{
2846 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2847 return;
2848 atomic_dec(&sdev->disk_events_disable_depth);
2849}
2850EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002851
2852/**
2853 * scsi_vpd_lun_id - return a unique device identification
2854 * @sdev: SCSI device
2855 * @id: buffer for the identification
2856 * @id_len: length of the buffer
2857 *
2858 * Copies a unique device identification into @id based
2859 * on the information in the VPD page 0x83 of the device.
2860 * The string will be formatted as a SCSI name string.
2861 *
2862 * Returns the length of the identification or error on failure.
2863 * If the identifier is longer than the supplied buffer the actual
2864 * identifier length is returned and the buffer is not zero-padded.
2865 */
2866int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
2867{
2868 u8 cur_id_type = 0xff;
2869 u8 cur_id_size = 0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002870 const unsigned char *d, *cur_id_str;
2871 const struct scsi_vpd *vpd_pg83;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002872 int id_size = -EINVAL;
2873
2874 rcu_read_lock();
2875 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
2876 if (!vpd_pg83) {
2877 rcu_read_unlock();
2878 return -ENXIO;
2879 }
2880
2881 /*
2882 * Look for the correct descriptor.
2883 * Order of preference for lun descriptor:
2884 * - SCSI name string
2885 * - NAA IEEE Registered Extended
2886 * - EUI-64 based 16-byte
2887 * - EUI-64 based 12-byte
2888 * - NAA IEEE Registered
2889 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02002890 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002891 * as longer descriptors reduce the likelyhood
2892 * of identification clashes.
2893 */
2894
2895 /* The id string must be at least 20 bytes + terminating NULL byte */
2896 if (id_len < 21) {
2897 rcu_read_unlock();
2898 return -EINVAL;
2899 }
2900
2901 memset(id, 0, id_len);
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002902 d = vpd_pg83->data + 4;
2903 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002904 /* Skip designators not referring to the LUN */
2905 if ((d[1] & 0x30) != 0x00)
2906 goto next_desig;
2907
2908 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02002909 case 0x1:
2910 /* T10 Vendor ID */
2911 if (cur_id_size > d[3])
2912 break;
2913 /* Prefer anything */
2914 if (cur_id_type > 0x01 && cur_id_type != 0xff)
2915 break;
2916 cur_id_size = d[3];
2917 if (cur_id_size + 4 > id_len)
2918 cur_id_size = id_len - 4;
2919 cur_id_str = d + 4;
2920 cur_id_type = d[1] & 0xf;
2921 id_size = snprintf(id, id_len, "t10.%*pE",
2922 cur_id_size, cur_id_str);
2923 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002924 case 0x2:
2925 /* EUI-64 */
2926 if (cur_id_size > d[3])
2927 break;
2928 /* Prefer NAA IEEE Registered Extended */
2929 if (cur_id_type == 0x3 &&
2930 cur_id_size == d[3])
2931 break;
2932 cur_id_size = d[3];
2933 cur_id_str = d + 4;
2934 cur_id_type = d[1] & 0xf;
2935 switch (cur_id_size) {
2936 case 8:
2937 id_size = snprintf(id, id_len,
2938 "eui.%8phN",
2939 cur_id_str);
2940 break;
2941 case 12:
2942 id_size = snprintf(id, id_len,
2943 "eui.%12phN",
2944 cur_id_str);
2945 break;
2946 case 16:
2947 id_size = snprintf(id, id_len,
2948 "eui.%16phN",
2949 cur_id_str);
2950 break;
2951 default:
2952 cur_id_size = 0;
2953 break;
2954 }
2955 break;
2956 case 0x3:
2957 /* NAA */
2958 if (cur_id_size > d[3])
2959 break;
2960 cur_id_size = d[3];
2961 cur_id_str = d + 4;
2962 cur_id_type = d[1] & 0xf;
2963 switch (cur_id_size) {
2964 case 8:
2965 id_size = snprintf(id, id_len,
2966 "naa.%8phN",
2967 cur_id_str);
2968 break;
2969 case 16:
2970 id_size = snprintf(id, id_len,
2971 "naa.%16phN",
2972 cur_id_str);
2973 break;
2974 default:
2975 cur_id_size = 0;
2976 break;
2977 }
2978 break;
2979 case 0x8:
2980 /* SCSI name string */
2981 if (cur_id_size + 4 > d[3])
2982 break;
2983 /* Prefer others for truncated descriptor */
2984 if (cur_id_size && d[3] > id_len)
2985 break;
2986 cur_id_size = id_size = d[3];
2987 cur_id_str = d + 4;
2988 cur_id_type = d[1] & 0xf;
2989 if (cur_id_size >= id_len)
2990 cur_id_size = id_len - 1;
2991 memcpy(id, cur_id_str, cur_id_size);
2992 /* Decrease priority for truncated descriptor */
2993 if (cur_id_size != id_size)
2994 cur_id_size = 6;
2995 break;
2996 default:
2997 break;
2998 }
2999next_desig:
3000 d += d[3] + 4;
3001 }
3002 rcu_read_unlock();
3003
3004 return id_size;
3005}
3006EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003007
3008/*
3009 * scsi_vpd_tpg_id - return a target port group identifier
3010 * @sdev: SCSI device
3011 *
3012 * Returns the Target Port Group identifier from the information
3013 * froom VPD page 0x83 of the device.
3014 *
3015 * Returns the identifier or error on failure.
3016 */
3017int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3018{
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003019 const unsigned char *d;
3020 const struct scsi_vpd *vpd_pg83;
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003021 int group_id = -EAGAIN, rel_port = -1;
3022
3023 rcu_read_lock();
3024 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3025 if (!vpd_pg83) {
3026 rcu_read_unlock();
3027 return -ENXIO;
3028 }
3029
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003030 d = vpd_pg83->data + 4;
3031 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003032 switch (d[1] & 0xf) {
3033 case 0x4:
3034 /* Relative target port */
3035 rel_port = get_unaligned_be16(&d[6]);
3036 break;
3037 case 0x5:
3038 /* Target port group */
3039 group_id = get_unaligned_be16(&d[6]);
3040 break;
3041 default:
3042 break;
3043 }
3044 d += d[3] + 4;
3045 }
3046 rcu_read_unlock();
3047
3048 if (group_id >= 0 && rel_id && rel_port != -1)
3049 *rel_id = rel_port;
3050
3051 return group_id;
3052}
3053EXPORT_SYMBOL(scsi_vpd_tpg_id);