blob: 0df15cb738d2bff71f7685df53cb36eb31ed38bb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Christoph Hellwigd2852032014-01-17 12:06:53 +01002 * Copyright (C) 1999 Eric Youngdale
3 * Copyright (C) 2014 Christoph Hellwig
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 * SCSI queueing library.
6 * Initial versions: Eric Youngdale (eric@andante.org).
7 * Based upon conversations with large numbers
8 * of people at Linux Expo.
9 */
10
11#include <linux/bio.h>
James Bottomleyd3f46f32008-01-15 11:11:46 -060012#include <linux/bitops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/blkdev.h>
14#include <linux/completion.h>
15#include <linux/kernel.h>
Paul Gortmaker09703662011-05-27 09:37:25 -040016#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/init.h>
18#include <linux/pci.h>
19#include <linux/delay.h>
James Bottomleyfaead262006-02-14 10:42:07 -060020#include <linux/hardirq.h>
Jens Axboec6132da2007-10-16 11:08:49 +020021#include <linux/scatterlist.h>
Christoph Hellwigd2852032014-01-17 12:06:53 +010022#include <linux/blk-mq.h>
Hannes Reineckef1569ff2014-10-24 14:27:07 +020023#include <linux/ratelimit.h>
Hannes Reineckea8aa3972015-12-01 10:16:57 +010024#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020027#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <scsi/scsi_dbg.h>
29#include <scsi/scsi_device.h>
30#include <scsi/scsi_driver.h>
31#include <scsi/scsi_eh.h>
32#include <scsi/scsi_host.h>
Bart Van Assche7aa686d2017-05-02 10:45:03 -070033#include <scsi/scsi_transport.h> /* __scsi_init_queue() */
Christoph Hellwigee14c672015-08-27 14:16:59 +020034#include <scsi/scsi_dh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Christoph Hellwig3b5382c2014-05-06 12:25:40 +020036#include <trace/events/scsi.h>
37
Bart Van Assche0eebd002017-04-26 13:47:57 -070038#include "scsi_debugfs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include "scsi_priv.h"
40#include "scsi_logging.h"
41
Christoph Hellwige9c787e2017-01-02 21:55:26 +030042static struct kmem_cache *scsi_sdb_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030043static struct kmem_cache *scsi_sense_cache;
44static struct kmem_cache *scsi_sense_isadma_cache;
45static DEFINE_MUTEX(scsi_sense_cache_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Bart Van Asschea45a1f362017-08-30 16:58:42 -070047static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd);
48
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030049static inline struct kmem_cache *
Bart Van Assche8e688252017-06-02 14:21:52 -070050scsi_select_sense_cache(bool unchecked_isa_dma)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030051{
Bart Van Assche8e688252017-06-02 14:21:52 -070052 return unchecked_isa_dma ? scsi_sense_isadma_cache : scsi_sense_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030053}
54
Bart Van Assche8e688252017-06-02 14:21:52 -070055static void scsi_free_sense_buffer(bool unchecked_isa_dma,
56 unsigned char *sense_buffer)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030057{
Bart Van Assche8e688252017-06-02 14:21:52 -070058 kmem_cache_free(scsi_select_sense_cache(unchecked_isa_dma),
59 sense_buffer);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030060}
61
Bart Van Assche8e688252017-06-02 14:21:52 -070062static unsigned char *scsi_alloc_sense_buffer(bool unchecked_isa_dma,
Christoph Hellwige9c787e2017-01-02 21:55:26 +030063 gfp_t gfp_mask, int numa_node)
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030064{
Bart Van Assche8e688252017-06-02 14:21:52 -070065 return kmem_cache_alloc_node(scsi_select_sense_cache(unchecked_isa_dma),
66 gfp_mask, numa_node);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030067}
68
69int scsi_init_sense_cache(struct Scsi_Host *shost)
70{
71 struct kmem_cache *cache;
72 int ret = 0;
73
Bart Van Assche8e688252017-06-02 14:21:52 -070074 cache = scsi_select_sense_cache(shost->unchecked_isa_dma);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030075 if (cache)
76 return 0;
77
78 mutex_lock(&scsi_sense_cache_mutex);
79 if (shost->unchecked_isa_dma) {
80 scsi_sense_isadma_cache =
81 kmem_cache_create("scsi_sense_cache(DMA)",
David Windsor0afe76e2017-06-10 22:50:45 -040082 SCSI_SENSE_BUFFERSIZE, 0,
83 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030084 if (!scsi_sense_isadma_cache)
85 ret = -ENOMEM;
86 } else {
87 scsi_sense_cache =
David Windsor0afe76e2017-06-10 22:50:45 -040088 kmem_cache_create_usercopy("scsi_sense_cache",
89 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN,
90 0, SCSI_SENSE_BUFFERSIZE, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030091 if (!scsi_sense_cache)
92 ret = -ENOMEM;
93 }
94
95 mutex_unlock(&scsi_sense_cache_mutex);
96 return ret;
97}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +020098
Jens Axboea488e742010-04-16 21:13:15 +020099/*
100 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
101 * not change behaviour from the previous unplug mechanism, experimentation
102 * may prove this needs changing.
103 */
104#define SCSI_QUEUE_DELAY 3
105
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100106static void
107scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108{
109 struct Scsi_Host *host = cmd->device->host;
110 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500111 struct scsi_target *starget = scsi_target(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900114 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 *
116 * If the host/device isn't busy, assume that something actually
117 * completed, and that we should be able to queue a command now.
118 *
119 * Note that the prior mid-layer assumption that any host could
120 * always queue at least one command is now broken. The mid-layer
121 * will implement a user specifiable stall (see
122 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
123 * if a command is requeued with no other commands outstanding
124 * either for the device or for the host.
125 */
Mike Christief0c0a372008-08-17 15:24:38 -0500126 switch (reason) {
127 case SCSI_MLQUEUE_HOST_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100128 atomic_set(&host->host_blocked, host->max_host_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500129 break;
130 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400131 case SCSI_MLQUEUE_EH_RETRY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100132 atomic_set(&device->device_blocked,
133 device->max_device_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500134 break;
135 case SCSI_MLQUEUE_TARGET_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100136 atomic_set(&starget->target_blocked,
137 starget->max_target_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500138 break;
139 }
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100140}
141
Christoph Hellwigd2852032014-01-17 12:06:53 +0100142static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
143{
144 struct scsi_device *sdev = cmd->device;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100145
Bart Van Asschea45a1f362017-08-30 16:58:42 -0700146 if (cmd->request->rq_flags & RQF_DONTPREP) {
147 cmd->request->rq_flags &= ~RQF_DONTPREP;
148 scsi_mq_uninit_cmd(cmd);
149 } else {
150 WARN_ON_ONCE(true);
151 }
Bart Van Assche2b053ac2016-10-28 17:21:41 -0700152 blk_mq_requeue_request(cmd->request, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100153 put_device(&sdev->sdev_gendev);
154}
155
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100156/**
157 * __scsi_queue_insert - private queue insertion
158 * @cmd: The SCSI command being requeued
159 * @reason: The reason for the requeue
160 * @unbusy: Whether the queue should be unbusied
161 *
162 * This is a private queue insertion. The public interface
163 * scsi_queue_insert() always assumes the queue should be unbusied
164 * because it's always called before the completion. This function is
165 * for a requeue after completion, which should only occur in this
166 * file.
167 */
Bart Van Assche08640e82018-01-10 14:41:45 -0800168static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, bool unbusy)
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100169{
170 struct scsi_device *device = cmd->device;
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100171
172 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
173 "Inserting command %p into mlqueue\n", cmd));
174
175 scsi_set_blocked(cmd, reason);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 * Decrement the counters, since these commands are no longer
179 * active on the host/device.
180 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600181 if (unbusy)
182 scsi_device_unbusy(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500185 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000186 * that are already in the queue. Schedule requeue work under
187 * lock such that the kblockd_schedule_work() call happens
188 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200189 */
Alan Stern644373a2014-03-28 10:51:15 -0700190 cmd->result = 0;
Jens Axboef664a3c2018-11-01 16:36:27 -0600191
192 /*
193 * Before a SCSI command is dispatched,
194 * get_device(&sdev->sdev_gendev) is called and the host,
195 * target and device busy counters are increased. Since
196 * requeuing a request causes these actions to be repeated and
197 * since scsi_device_unbusy() has already been called,
198 * put_device(&device->sdev_gendev) must still be called. Call
199 * put_device() after blk_mq_requeue_request() to avoid that
200 * removal of the SCSI device can start before requeueing has
201 * happened.
202 */
203 blk_mq_requeue_request(cmd->request, true);
204 put_device(&device->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205}
206
James Bottomley4f5299a2009-01-02 10:42:21 -0600207/*
208 * Function: scsi_queue_insert()
209 *
210 * Purpose: Insert a command in the midlevel queue.
211 *
212 * Arguments: cmd - command that we are adding to queue.
213 * reason - why we are inserting command to queue.
214 *
215 * Lock status: Assumed that lock is not held upon entry.
216 *
217 * Returns: Nothing.
218 *
219 * Notes: We do this for one of two cases. Either the host is busy
220 * and it cannot accept any more commands for the time being,
221 * or the device returned QUEUE_FULL and can accept no more
222 * commands.
223 * Notes: This could be called either from an interrupt context or a
224 * normal process context.
225 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000226void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600227{
Bart Van Assche08640e82018-01-10 14:41:45 -0800228 __scsi_queue_insert(cmd, reason, true);
James Bottomley4f5299a2009-01-02 10:42:21 -0600229}
Christoph Hellwige8064022016-10-20 15:12:13 +0200230
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100231
232/**
Kees Cook704f8392018-07-31 12:51:54 -0700233 * __scsi_execute - insert request and wait for the result
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100234 * @sdev: scsi device
235 * @cmd: scsi command
236 * @data_direction: data direction
237 * @buffer: data buffer
238 * @bufflen: len of buffer
239 * @sense: optional sense buffer
240 * @sshdr: optional decoded sense header
241 * @timeout: request timeout in seconds
242 * @retries: number of times to retry request
243 * @flags: flags for ->cmd_flags
244 * @rq_flags: flags for ->rq_flags
245 * @resid: optional residual length
246 *
Christoph Hellwig17d53632017-04-20 16:03:01 +0200247 * Returns the scsi_cmnd result field if a command was executed, or a negative
248 * Linux error code if we didn't get that far.
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100249 */
Kees Cook704f8392018-07-31 12:51:54 -0700250int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500251 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100252 unsigned char *sense, struct scsi_sense_hdr *sshdr,
253 int timeout, int retries, u64 flags, req_flags_t rq_flags,
254 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500255{
256 struct request *req;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100257 struct scsi_request *rq;
James Bottomley39216032005-06-15 18:48:29 -0500258 int ret = DRIVER_ERROR << 24;
259
Christoph Hellwigff005a02018-05-09 09:54:05 +0200260 req = blk_get_request(sdev->request_queue,
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100261 data_direction == DMA_TO_DEVICE ?
Bart Van Assche039c6352017-11-09 10:49:56 -0800262 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, BLK_MQ_REQ_PREEMPT);
Joe Lawrencea492f072014-08-28 08:15:21 -0600263 if (IS_ERR(req))
James Bottomleybfe159a2011-07-07 15:45:40 -0500264 return ret;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100265 rq = scsi_req(req);
James Bottomley39216032005-06-15 18:48:29 -0500266
267 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
Christoph Hellwig0eb0b632018-05-09 09:54:08 +0200268 buffer, bufflen, GFP_NOIO))
James Bottomley39216032005-06-15 18:48:29 -0500269 goto out;
270
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100271 rq->cmd_len = COMMAND_SIZE(cmd[0]);
272 memcpy(rq->cmd, cmd, rq->cmd_len);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200273 rq->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500274 req->timeout = timeout;
Christoph Hellwige8064022016-10-20 15:12:13 +0200275 req->cmd_flags |= flags;
Bart Van Assche039c6352017-11-09 10:49:56 -0800276 req->rq_flags |= rq_flags | RQF_QUIET;
James Bottomley39216032005-06-15 18:48:29 -0500277
278 /*
279 * head injection *required* here otherwise quiesce won't work
280 */
281 blk_execute_rq(req->q, NULL, req, 1);
282
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400283 /*
284 * Some devices (USB mass-storage in particular) may transfer
285 * garbage data together with a residue indicating that the data
286 * is invalid. Prevent the garbage from being misinterpreted
287 * and prevent security leaks by zeroing out the excess data.
288 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100289 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
290 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400291
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900292 if (resid)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100293 *resid = rq->resid_len;
294 if (sense && rq->sense_len)
295 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100296 if (sshdr)
297 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
Christoph Hellwig17d53632017-04-20 16:03:01 +0200298 ret = rq->result;
James Bottomley39216032005-06-15 18:48:29 -0500299 out:
300 blk_put_request(req);
301
302 return ret;
303}
Kees Cook704f8392018-07-31 12:51:54 -0700304EXPORT_SYMBOL(__scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306/*
307 * Function: scsi_init_cmd_errh()
308 *
309 * Purpose: Initialize cmd fields related to error handling.
310 *
311 * Arguments: cmd - command that is ready to be queued.
312 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 * Notes: This function has the job of initializing a number of
314 * fields related to error handling. Typically this will
315 * be called once for each command, as required.
316 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200317static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 cmd->serial_number = 0;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200320 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900321 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300323 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324}
325
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800326/*
327 * Decrement the host_busy counter and wake up the error handler if necessary.
328 * Avoid as follows that the error handler is not woken up if shost->host_busy
329 * == shost->host_failed: use call_rcu() in scsi_eh_scmd_add() in combination
330 * with an RCU read lock in this function to ensure that this function in its
331 * entirety either finishes before scsi_eh_scmd_add() increases the
332 * host_failed counter or that it notices the shost state change made by
333 * scsi_eh_scmd_add().
334 */
335static void scsi_dec_host_busy(struct Scsi_Host *shost)
336{
337 unsigned long flags;
338
339 rcu_read_lock();
Ming Leid772a652018-08-27 15:24:43 +0800340 atomic_dec(&shost->host_busy);
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800341 if (unlikely(scsi_host_in_recovery(shost))) {
342 spin_lock_irqsave(shost->host_lock, flags);
343 if (shost->host_failed || shost->host_eh_scheduled)
344 scsi_eh_wakeup(shost);
345 spin_unlock_irqrestore(shost->host_lock, flags);
346 }
347 rcu_read_unlock();
348}
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350void scsi_device_unbusy(struct scsi_device *sdev)
351{
352 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500353 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800355 scsi_dec_host_busy(shost);
356
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100357 if (starget->can_queue > 0)
358 atomic_dec(&starget->target_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +0100359
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200360 atomic_dec(&sdev->device_busy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361}
362
Christoph Hellwigd2852032014-01-17 12:06:53 +0100363static void scsi_kick_queue(struct request_queue *q)
364{
Jens Axboef664a3c2018-11-01 16:36:27 -0600365 blk_mq_run_hw_queues(q, false);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100366}
367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368/*
369 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
370 * and call blk_run_queue for all the scsi_devices on the target -
371 * including current_sdev first.
372 *
373 * Called with *no* scsi locks held.
374 */
375static void scsi_single_lun_run(struct scsi_device *current_sdev)
376{
377 struct Scsi_Host *shost = current_sdev->host;
378 struct scsi_device *sdev, *tmp;
379 struct scsi_target *starget = scsi_target(current_sdev);
380 unsigned long flags;
381
382 spin_lock_irqsave(shost->host_lock, flags);
383 starget->starget_sdev_user = NULL;
384 spin_unlock_irqrestore(shost->host_lock, flags);
385
386 /*
387 * Call blk_run_queue for all LUNs on the target, starting with
388 * current_sdev. We race with others (to set starget_sdev_user),
389 * but in most cases, we will be first. Ideally, each LU on the
390 * target would get some limited time or requests on the target.
391 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100392 scsi_kick_queue(current_sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
394 spin_lock_irqsave(shost->host_lock, flags);
395 if (starget->starget_sdev_user)
396 goto out;
397 list_for_each_entry_safe(sdev, tmp, &starget->devices,
398 same_target_siblings) {
399 if (sdev == current_sdev)
400 continue;
401 if (scsi_device_get(sdev))
402 continue;
403
404 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100405 scsi_kick_queue(sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 spin_lock_irqsave(shost->host_lock, flags);
407
408 scsi_device_put(sdev);
409 }
410 out:
411 spin_unlock_irqrestore(shost->host_lock, flags);
412}
413
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100414static inline bool scsi_device_is_busy(struct scsi_device *sdev)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400415{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100416 if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
417 return true;
418 if (atomic_read(&sdev->device_blocked) > 0)
419 return true;
420 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400421}
422
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100423static inline bool scsi_target_is_busy(struct scsi_target *starget)
Mike Christief0c0a372008-08-17 15:24:38 -0500424{
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100425 if (starget->can_queue > 0) {
426 if (atomic_read(&starget->target_busy) >= starget->can_queue)
427 return true;
428 if (atomic_read(&starget->target_blocked) > 0)
429 return true;
430 }
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100431 return false;
Mike Christief0c0a372008-08-17 15:24:38 -0500432}
433
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100434static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400435{
Ming Leid772a652018-08-27 15:24:43 +0800436 if (shost->can_queue > 0 &&
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100437 atomic_read(&shost->host_busy) >= shost->can_queue)
438 return true;
439 if (atomic_read(&shost->host_blocked) > 0)
440 return true;
441 if (shost->host_self_blocked)
442 return true;
443 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400444}
445
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800446static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600448 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800449 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 unsigned long flags;
451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600453 list_splice_init(&shost->starved_list, &starved_list);
454
455 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200456 struct request_queue *slq;
457
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 /*
459 * As long as shost is accepting commands and we have
460 * starved queues, call blk_run_queue. scsi_request_fn
461 * drops the queue_lock and can add us back to the
462 * starved_list.
463 *
464 * host_lock protects the starved_list and starved_entry.
465 * scsi_request_fn must get the host_lock before checking
466 * or modifying starved_list or starved_entry.
467 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600468 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500469 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500470
Mike Christie2a3a59e2008-11-11 13:42:35 -0600471 sdev = list_entry(starved_list.next,
472 struct scsi_device, starved_entry);
473 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500474 if (scsi_target_is_busy(scsi_target(sdev))) {
475 list_move_tail(&sdev->starved_entry,
476 &shost->starved_list);
477 continue;
478 }
479
James Bottomleye2eb7242013-07-02 15:05:26 +0200480 /*
481 * Once we drop the host lock, a racing scsi_remove_device()
482 * call may remove the sdev from the starved list and destroy
483 * it and the queue. Mitigate by taking a reference to the
484 * queue and never touching the sdev again after we drop the
485 * host lock. Note: if __scsi_remove_device() invokes
486 * blk_cleanup_queue() before the queue is run from this
487 * function then blk_run_queue() will return immediately since
488 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
489 */
490 slq = sdev->request_queue;
491 if (!blk_get_queue(slq))
492 continue;
493 spin_unlock_irqrestore(shost->host_lock, flags);
494
Christoph Hellwigd2852032014-01-17 12:06:53 +0100495 scsi_kick_queue(slq);
James Bottomleye2eb7242013-07-02 15:05:26 +0200496 blk_put_queue(slq);
497
498 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600500 /* put any unprocessed entries back */
501 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800503}
504
505/*
506 * Function: scsi_run_queue()
507 *
508 * Purpose: Select a proper request queue to serve next
509 *
510 * Arguments: q - last request's queue
511 *
512 * Returns: Nothing
513 *
514 * Notes: The previous command was completely finished, start
515 * a new one if possible.
516 */
517static void scsi_run_queue(struct request_queue *q)
518{
519 struct scsi_device *sdev = q->queuedata;
520
521 if (scsi_target(sdev)->single_lun)
522 scsi_single_lun_run(sdev);
523 if (!list_empty(&sdev->host->starved_list))
524 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Jens Axboef664a3c2018-11-01 16:36:27 -0600526 blk_mq_run_hw_queues(q, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527}
528
Jens Axboe9937a5e2011-05-17 11:04:44 +0200529void scsi_requeue_run_queue(struct work_struct *work)
530{
531 struct scsi_device *sdev;
532 struct request_queue *q;
533
534 sdev = container_of(work, struct scsi_device, requeue_work);
535 q = sdev->request_queue;
536 scsi_run_queue(q);
537}
538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539void scsi_run_host_queues(struct Scsi_Host *shost)
540{
541 struct scsi_device *sdev;
542
543 shost_for_each_device(sdev, shost)
544 scsi_run_queue(sdev->request_queue);
545}
546
Christoph Hellwigd2852032014-01-17 12:06:53 +0100547static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
548{
Christoph Hellwig57292b52017-01-31 16:57:29 +0100549 if (!blk_rq_is_passthrough(cmd->request)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100550 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
551
552 if (drv->uninit_command)
553 drv->uninit_command(cmd);
554 }
555}
556
557static void scsi_mq_free_sgtables(struct scsi_cmnd *cmd)
558{
Ming Lin91dbc082016-04-04 14:48:07 -0700559 struct scsi_data_buffer *sdb;
560
Christoph Hellwigd2852032014-01-17 12:06:53 +0100561 if (cmd->sdb.table.nents)
Ming Lin001d63b2016-04-04 14:48:09 -0700562 sg_free_table_chained(&cmd->sdb.table, true);
Ming Lin91dbc082016-04-04 14:48:07 -0700563 if (cmd->request->next_rq) {
564 sdb = cmd->request->next_rq->special;
565 if (sdb)
Ming Lin001d63b2016-04-04 14:48:09 -0700566 sg_free_table_chained(&sdb->table, true);
Ming Lin91dbc082016-04-04 14:48:07 -0700567 }
Christoph Hellwigd2852032014-01-17 12:06:53 +0100568 if (scsi_prot_sg_count(cmd))
Ming Lin001d63b2016-04-04 14:48:09 -0700569 sg_free_table_chained(&cmd->prot_sdb->table, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100570}
571
572static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
573{
Christoph Hellwigd2852032014-01-17 12:06:53 +0100574 scsi_mq_free_sgtables(cmd);
575 scsi_uninit_cmd(cmd);
Bart Van Assche2dd6fb52017-06-02 14:21:58 -0700576 scsi_del_cmd_from_list(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100577}
578
Douglas Gilbert7e63b5a2018-06-23 12:22:14 +0200579/* Returns false when no more bytes to process, true if there are more */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200580static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800581 unsigned int bytes, unsigned int bidi_bytes)
582{
Bart Van Asschebed22132017-08-25 13:46:32 -0700583 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800584 struct scsi_device *sdev = cmd->device;
585 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800586
587 if (blk_update_request(req, error, bytes))
588 return true;
589
590 /* Bidi request must be completed as a whole */
591 if (unlikely(bidi_bytes) &&
592 blk_update_request(req->next_rq, error, bidi_bytes))
593 return true;
594
595 if (blk_queue_add_random(q))
596 add_disk_randomness(req->rq_disk);
597
Bart Van Assche64104f72017-08-30 16:58:39 -0700598 if (!blk_rq_is_scsi(req)) {
599 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
600 cmd->flags &= ~SCMD_INITIALIZED;
Bart Van Assche3be88282018-02-22 11:30:20 -0800601 destroy_rcu_head(&cmd->rcu);
Bart Van Assche64104f72017-08-30 16:58:39 -0700602 }
603
Jens Axboef664a3c2018-11-01 16:36:27 -0600604 /*
605 * In the MQ case the command gets freed by __blk_mq_end_request,
606 * so we have to do all cleanup that depends on it earlier.
607 *
608 * We also can't kick the queues from irq context, so we
609 * will have to defer it to a workqueue.
610 */
611 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800612
Jens Axboea78b03b2018-11-18 15:46:03 -0700613 /*
614 * queue is still alive, so grab the ref for preventing it
615 * from being cleaned up during running queue.
616 */
617 percpu_ref_get(&q->q_usage_counter);
Ming Lei8dc765d2018-11-14 16:25:51 +0800618
Jens Axboef664a3c2018-11-01 16:36:27 -0600619 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100620
Jens Axboef664a3c2018-11-01 16:36:27 -0600621 if (scsi_target(sdev)->single_lun ||
622 !list_empty(&sdev->host->starved_list))
623 kblockd_schedule_work(&sdev->requeue_work);
624 else
625 blk_mq_run_hw_queues(q, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100626
Jens Axboea78b03b2018-11-18 15:46:03 -0700627 percpu_ref_put(&q->q_usage_counter);
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700628 put_device(&sdev->sdev_gendev);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800629 return false;
630}
631
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200632/**
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700633 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
634 * @cmd: SCSI command
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200635 * @result: scsi error code
636 *
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700637 * Translate a SCSI result code into a blk_status_t value. May reset the host
638 * byte of @cmd->result.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200639 */
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700640static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100641{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200642 switch (host_byte(result)) {
Bart Van Asschef4abab32018-04-05 10:33:01 -0700643 case DID_OK:
644 /*
645 * Also check the other bytes than the status byte in result
646 * to handle the case when a SCSI LLD sets result to
647 * DRIVER_SENSE << 24 without setting SAM_STAT_CHECK_CONDITION.
648 */
649 if (scsi_status_is_good(result) && (result & ~0xff) == 0)
650 return BLK_STS_OK;
651 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100652 case DID_TRANSPORT_FAILFAST:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200653 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100654 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000655 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200656 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100657 case DID_NEXUS_FAILURE:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200658 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200659 case DID_ALLOC_FAILURE:
660 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200661 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200662 case DID_MEDIUM_ERROR:
663 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200664 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100665 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200666 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100667 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100668}
669
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200670/* Helper for scsi_io_completion() when "reprep" action required. */
671static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
672 struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673{
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200674 /* A new command will be prepared and issued. */
Jens Axboef664a3c2018-11-01 16:36:27 -0600675 scsi_mq_requeue_cmd(cmd);
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200676}
677
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200678/* Helper for scsi_io_completion() when special action required. */
679static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
Douglas Gilbertab831082018-06-23 12:22:16 +0200680{
Jens Axboe165125e2007-07-24 09:28:11 +0200681 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 struct request *req = cmd->request;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200683 int level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500684 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
685 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900686 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200687 struct scsi_sense_hdr sshdr;
688 bool sense_valid;
689 bool sense_current = true; /* false implies "deferred sense" */
690 blk_status_t blk_stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200692 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
693 if (sense_valid)
694 sense_current = !scsi_sense_is_deferred(&sshdr);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200695
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200696 blk_stat = scsi_result_to_blk_status(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500697
Alan Sternb60af5b2008-11-03 15:56:47 -0500698 if (host_byte(result) == DID_RESET) {
699 /* Third party bus reset or reset for error recovery
700 * reasons. Just retry the command and see what
701 * happens.
702 */
703 action = ACTION_RETRY;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200704 } else if (sense_valid && sense_current) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 switch (sshdr.sense_key) {
706 case UNIT_ATTENTION:
707 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700708 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 * and quietly refuse further access.
710 */
711 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500712 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700714 /* Must have been a power glitch, or a
715 * bus reset. Could not have been a
716 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500717 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700718 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500719 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 }
721 break;
722 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700723 /* If we had an ILLEGAL REQUEST returned, then
724 * we may have performed an unsupported
725 * command. The only thing this should be
726 * would be a ten byte read where only a six
727 * byte read was supported. Also, on a system
728 * where READ CAPACITY failed, we may have
729 * read past the end of the disk.
730 */
Jens Axboe26a68012005-11-29 21:03:34 +0100731 if ((cmd->device->use_10_for_rw &&
732 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 (cmd->cmnd[0] == READ_10 ||
734 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500735 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500737 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500738 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500739 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200740 blk_stat = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500741 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400742 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500743 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200744 blk_stat = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500745 } else
746 action = ACTION_FAIL;
747 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400748 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000749 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200750 if (sshdr.asc == 0x10) /* DIF */
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200751 blk_stat = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 break;
753 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700754 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500755 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500757 if (sshdr.asc == 0x04) {
758 switch (sshdr.ascq) {
759 case 0x01: /* becoming ready */
760 case 0x04: /* format in progress */
761 case 0x05: /* rebuild in progress */
762 case 0x06: /* recalculation in progress */
763 case 0x07: /* operation in progress */
764 case 0x08: /* Long write in progress */
765 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500766 case 0x14: /* space allocation in progress */
Douglas Gilberte37c7d92018-05-18 19:25:47 -0400767 case 0x1a: /* start stop unit in progress */
768 case 0x1b: /* sanitize in progress */
769 case 0x1d: /* configuration in progress */
770 case 0x24: /* depopulation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500771 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500772 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500773 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500774 action = ACTION_FAIL;
775 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500776 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200777 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500778 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500779 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700781 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500782 action = ACTION_FAIL;
783 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500785 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 break;
787 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200788 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500789 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500790
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900791 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200792 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900793 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900794
Alan Sternb60af5b2008-11-03 15:56:47 -0500795 switch (action) {
796 case ACTION_FAIL:
797 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200798 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200799 static DEFINE_RATELIMIT_STATE(_rs,
800 DEFAULT_RATELIMIT_INTERVAL,
801 DEFAULT_RATELIMIT_BURST);
802
803 if (unlikely(scsi_logging_level))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200804 level =
805 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
806 SCSI_LOG_MLCOMPLETE_BITS);
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200807
808 /*
809 * if logging is enabled the failure will be printed
810 * in scsi_log_completion(), so avoid duplicate messages
811 */
812 if (!level && __ratelimit(&_rs)) {
813 scsi_print_result(cmd, NULL, FAILED);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +0200814 if (driver_byte(result) == DRIVER_SENSE)
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200815 scsi_print_sense(cmd);
816 scsi_print_command(cmd);
817 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500818 }
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200819 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req), 0))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800820 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200821 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500822 case ACTION_REPREP:
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200823 scsi_io_completion_reprep(cmd, q);
Alan Sternb60af5b2008-11-03 15:56:47 -0500824 break;
825 case ACTION_RETRY:
826 /* Retry the same command immediately */
Bart Van Assche08640e82018-01-10 14:41:45 -0800827 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500828 break;
829 case ACTION_DELAYED_RETRY:
830 /* Retry the same command after a delay */
Bart Van Assche08640e82018-01-10 14:41:45 -0800831 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500832 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 }
834}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200836/*
837 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
838 * new result that may suppress further error checking. Also modifies
839 * *blk_statp in some cases.
840 */
841static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
842 blk_status_t *blk_statp)
843{
844 bool sense_valid;
845 bool sense_current = true; /* false implies "deferred sense" */
846 struct request *req = cmd->request;
847 struct scsi_sense_hdr sshdr;
848
849 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
850 if (sense_valid)
851 sense_current = !scsi_sense_is_deferred(&sshdr);
852
853 if (blk_rq_is_passthrough(req)) {
854 if (sense_valid) {
855 /*
856 * SG_IO wants current and deferred errors
857 */
858 scsi_req(req)->sense_len =
859 min(8 + cmd->sense_buffer[7],
860 SCSI_SENSE_BUFFERSIZE);
861 }
862 if (sense_current)
863 *blk_statp = scsi_result_to_blk_status(cmd, result);
864 } else if (blk_rq_bytes(req) == 0 && sense_current) {
865 /*
866 * Flush commands do not transfers any data, and thus cannot use
867 * good_bytes != blk_rq_bytes(req) as the signal for an error.
868 * This sets *blk_statp explicitly for the problem case.
869 */
870 *blk_statp = scsi_result_to_blk_status(cmd, result);
871 }
872 /*
873 * Recovered errors need reporting, but they're always treated as
874 * success, so fiddle the result code here. For passthrough requests
875 * we already took a copy of the original into sreq->result which
876 * is what gets returned to the user
877 */
878 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
879 bool do_print = true;
880 /*
881 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
882 * skip print since caller wants ATA registers. Only occurs
883 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
884 */
885 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
886 do_print = false;
887 else if (req->rq_flags & RQF_QUIET)
888 do_print = false;
889 if (do_print)
890 scsi_print_sense(cmd);
891 result = 0;
892 /* for passthrough, *blk_statp may be set */
893 *blk_statp = BLK_STS_OK;
894 }
895 /*
896 * Another corner case: the SCSI status byte is non-zero but 'good'.
897 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
898 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
899 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
900 * intermediate statuses (both obsolete in SAM-4) as good.
901 */
902 if (status_byte(result) && scsi_status_is_good(result)) {
903 result = 0;
904 *blk_statp = BLK_STS_OK;
905 }
906 return result;
907}
908
909/*
910 * Function: scsi_io_completion()
911 *
912 * Purpose: Completion processing for block device I/O requests.
913 *
914 * Arguments: cmd - command that is finished.
915 *
916 * Lock status: Assumed that no lock is held upon entry.
917 *
918 * Returns: Nothing
919 *
920 * Notes: We will finish off the specified number of sectors. If we
921 * are done, the command block will be released and the queue
922 * function will be goosed. If we are not done then we have to
923 * figure out what to do next:
924 *
925 * a) We can call scsi_requeue_command(). The request
926 * will be unprepared and put back on the queue. Then
927 * a new command will be created for it. This should
928 * be used if we made forward progress, or if we want
929 * to switch from READ(10) to READ(6) for example.
930 *
931 * b) We can call __scsi_queue_insert(). The request will
932 * be put back on the queue and retried using the same
933 * command as before, possibly after a delay.
934 *
935 * c) We can call scsi_end_request() with blk_stat other than
936 * BLK_STS_OK, to fail the remainder of the request.
937 */
938void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
939{
940 int result = cmd->result;
941 struct request_queue *q = cmd->device->request_queue;
942 struct request *req = cmd->request;
943 blk_status_t blk_stat = BLK_STS_OK;
944
Douglas Gilbert0d437902018-06-23 12:22:19 +0200945 if (unlikely(result)) /* a nz result may or may not be an error */
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200946 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
947
Douglas Gilbert0d437902018-06-23 12:22:19 +0200948 if (unlikely(blk_rq_is_passthrough(req))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200949 /*
950 * scsi_result_to_blk_status may have reset the host_byte
951 */
952 scsi_req(req)->result = cmd->result;
953 scsi_req(req)->resid_len = scsi_get_resid(cmd);
954
Douglas Gilbert0d437902018-06-23 12:22:19 +0200955 if (unlikely(scsi_bidi_cmnd(cmd))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200956 /*
957 * Bidi commands Must be complete as a whole,
958 * both sides at once.
959 */
960 scsi_req(req->next_rq)->resid_len = scsi_in(cmd)->resid;
961 if (scsi_end_request(req, BLK_STS_OK, blk_rq_bytes(req),
962 blk_rq_bytes(req->next_rq)))
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200963 WARN_ONCE(true,
964 "Bidi command with remaining bytes");
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200965 return;
966 }
967 }
968
Douglas Gilbert0d437902018-06-23 12:22:19 +0200969 /* no bidi support yet, other than in pass-through */
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200970 if (unlikely(blk_bidi_rq(req))) {
971 WARN_ONCE(true, "Only support bidi command in passthrough");
972 scmd_printk(KERN_ERR, cmd, "Killing bidi command\n");
973 if (scsi_end_request(req, BLK_STS_IOERR, blk_rq_bytes(req),
974 blk_rq_bytes(req->next_rq)))
975 WARN_ONCE(true, "Bidi command with remaining bytes");
976 return;
977 }
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200978
979 /*
980 * Next deal with any sectors which we were able to correctly
981 * handle.
982 */
983 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
984 "%u sectors total, %d bytes done.\n",
985 blk_rq_sectors(req), good_bytes));
986
987 /*
988 * Next deal with any sectors which we were able to correctly
989 * handle. Failed, zero length commands always need to drop down
990 * to retry code. Fast path should return in this block.
991 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200992 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
993 if (likely(!scsi_end_request(req, blk_stat, good_bytes, 0)))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200994 return; /* no bytes remaining */
995 }
996
Douglas Gilbert0d437902018-06-23 12:22:19 +0200997 /* Kill remainder if no retries. */
998 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200999 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req), 0))
Douglas Gilbert8e1695a02018-06-23 12:22:20 +02001000 WARN_ONCE(true,
1001 "Bytes remaining after failed, no-retry command");
Douglas Gilbertda32bae2018-06-23 12:22:17 +02001002 return;
1003 }
1004
1005 /*
1006 * If there had been no error, but we have leftover bytes in the
1007 * requeues just queue the command up again.
1008 */
Douglas Gilbert0d437902018-06-23 12:22:19 +02001009 if (likely(result == 0))
Douglas Gilbert4ae61c62018-06-23 12:22:18 +02001010 scsi_io_completion_reprep(cmd, q);
1011 else
Douglas Gilbertda32bae2018-06-23 12:22:17 +02001012 scsi_io_completion_action(cmd, result);
1013}
1014
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001015static blk_status_t scsi_init_sgtable(struct request *req,
1016 struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001018 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
1020 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001021 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001023 if (unlikely(sg_alloc_table_chained(&sdb->table,
1024 blk_rq_nr_phys_segments(req), sdb->table.sgl)))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001025 return BLK_STS_RESOURCE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 /*
1028 * Next, walk the list, and fill in the addresses and sizes of
1029 * each segment.
1030 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001031 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1032 BUG_ON(count > sdb->table.nents);
1033 sdb->table.nents = count;
Christoph Hellwigfd102b12017-01-13 12:29:11 +01001034 sdb->length = blk_rq_payload_bytes(req);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001035 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001037
1038/*
1039 * Function: scsi_init_io()
1040 *
1041 * Purpose: SCSI I/O initialize function.
1042 *
1043 * Arguments: cmd - Command descriptor we wish to initialize
1044 *
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001045 * Returns: BLK_STS_OK on success
1046 * BLK_STS_RESOURCE if the failure is retryable
1047 * BLK_STS_IOERR if the failure is fatal
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001048 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001049blk_status_t scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001050{
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001051 struct request *rq = cmd->request;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001052 blk_status_t ret;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001053
Johannes Thumshirnfd3fc0b2017-01-31 10:16:00 +01001054 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001055 return BLK_STS_IOERR;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001056
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001057 ret = scsi_init_sgtable(rq, &cmd->sdb);
1058 if (ret)
1059 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001060
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001061 if (blk_bidi_rq(rq)) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001062 ret = scsi_init_sgtable(rq->next_rq, rq->next_rq->special);
1063 if (ret)
Christoph Hellwig14784562018-11-09 14:42:38 +01001064 goto out_free_sgtables;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001065 }
1066
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001067 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001068 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1069 int ivecs, count;
1070
Christoph Hellwig14784562018-11-09 14:42:38 +01001071 if (WARN_ON_ONCE(!prot_sdb)) {
Ewan D. Milne91724c22015-01-15 10:02:12 -05001072 /*
1073 * This can happen if someone (e.g. multipath)
1074 * queues a command to a device on an adapter
1075 * that does not support DIX.
1076 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001077 ret = BLK_STS_IOERR;
Christoph Hellwig14784562018-11-09 14:42:38 +01001078 goto out_free_sgtables;
Ewan D. Milne91724c22015-01-15 10:02:12 -05001079 }
1080
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001081 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001082
Ming Lin001d63b2016-04-04 14:48:09 -07001083 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lin22cc3d42016-04-04 14:48:08 -07001084 prot_sdb->table.sgl)) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001085 ret = BLK_STS_RESOURCE;
Christoph Hellwig14784562018-11-09 14:42:38 +01001086 goto out_free_sgtables;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001087 }
1088
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001089 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001090 prot_sdb->table.sgl);
Igor Stoppa6f1d8a52018-09-05 23:47:20 +03001091 BUG_ON(count > ivecs);
1092 BUG_ON(count > queue_max_integrity_segments(rq->q));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001093
1094 cmd->prot_sdb = prot_sdb;
1095 cmd->prot_sdb->table.nents = count;
1096 }
1097
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001098 return BLK_STS_OK;
Christoph Hellwig14784562018-11-09 14:42:38 +01001099out_free_sgtables:
Jens Axboef664a3c2018-11-01 16:36:27 -06001100 scsi_mq_free_sgtables(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001101 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001102}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001103EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001105/**
Bart Van Assche832889f2017-08-30 16:58:40 -07001106 * scsi_initialize_rq - initialize struct scsi_cmnd partially
Jonathan Corbet35c05062017-08-24 16:11:09 -06001107 * @rq: Request associated with the SCSI command to be initialized.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001108 *
Bart Van Assche832889f2017-08-30 16:58:40 -07001109 * This function initializes the members of struct scsi_cmnd that must be
1110 * initialized before request processing starts and that won't be
1111 * reinitialized if a SCSI command is requeued.
1112 *
Bart Van Assche64104f72017-08-30 16:58:39 -07001113 * Called from inside blk_get_request() for pass-through requests and from
1114 * inside scsi_init_command() for filesystem requests.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001115 */
Bart Van Asschee4c94702017-12-07 15:59:31 -08001116static void scsi_initialize_rq(struct request *rq)
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001117{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001118 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1119
1120 scsi_req_init(&cmd->req);
Bart Van Assche3be88282018-02-22 11:30:20 -08001121 init_rcu_head(&cmd->rcu);
Bart Van Assche832889f2017-08-30 16:58:40 -07001122 cmd->jiffies_at_alloc = jiffies;
1123 cmd->retries = 0;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001124}
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001125
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001126/* Add a command to the list used by the aacraid and dpt_i2o drivers */
1127void scsi_add_cmd_to_list(struct scsi_cmnd *cmd)
1128{
1129 struct scsi_device *sdev = cmd->device;
1130 struct Scsi_Host *shost = sdev->host;
1131 unsigned long flags;
1132
1133 if (shost->use_cmd_list) {
1134 spin_lock_irqsave(&sdev->list_lock, flags);
1135 list_add_tail(&cmd->list, &sdev->cmd_list);
1136 spin_unlock_irqrestore(&sdev->list_lock, flags);
1137 }
1138}
1139
1140/* Remove a command from the list used by the aacraid and dpt_i2o drivers */
1141void scsi_del_cmd_from_list(struct scsi_cmnd *cmd)
1142{
1143 struct scsi_device *sdev = cmd->device;
1144 struct Scsi_Host *shost = sdev->host;
1145 unsigned long flags;
1146
1147 if (shost->use_cmd_list) {
1148 spin_lock_irqsave(&sdev->list_lock, flags);
1149 BUG_ON(list_empty(&cmd->list));
1150 list_del_init(&cmd->list);
1151 spin_unlock_irqrestore(&sdev->list_lock, flags);
1152 }
1153}
1154
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001155/* Called after a request has been started. */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001156void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001157{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001158 void *buf = cmd->sense_buffer;
1159 void *prot = cmd->prot_sdb;
Bart Van Assche64104f72017-08-30 16:58:39 -07001160 struct request *rq = blk_mq_rq_from_pdu(cmd);
1161 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
Bart Van Assche832889f2017-08-30 16:58:40 -07001162 unsigned long jiffies_at_alloc;
1163 int retries;
Bart Van Assche64104f72017-08-30 16:58:39 -07001164
1165 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1166 flags |= SCMD_INITIALIZED;
1167 scsi_initialize_rq(rq);
1168 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001169
Bart Van Assche832889f2017-08-30 16:58:40 -07001170 jiffies_at_alloc = cmd->jiffies_at_alloc;
1171 retries = cmd->retries;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001172 /* zero out the cmd, except for the embedded scsi_request */
1173 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001174 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001175
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001176 cmd->device = dev;
1177 cmd->sense_buffer = buf;
1178 cmd->prot_sdb = prot;
Bart Van Assche64104f72017-08-30 16:58:39 -07001179 cmd->flags = flags;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001180 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
Bart Van Assche832889f2017-08-30 16:58:40 -07001181 cmd->jiffies_at_alloc = jiffies_at_alloc;
1182 cmd->retries = retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001183
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001184 scsi_add_cmd_to_list(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001185}
1186
Christoph Hellwig785ba832018-11-09 14:42:37 +01001187static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1188 struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001189{
Bart Van Asschebed22132017-08-25 13:46:32 -07001190 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001191
1192 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001193 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001194 * a bio attached to them. Or they might contain a SCSI command
1195 * that does not transfer data, in which case they may optionally
1196 * submit a request without an attached bio.
1197 */
1198 if (req->bio) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001199 blk_status_t ret = scsi_init_io(cmd);
1200 if (unlikely(ret != BLK_STS_OK))
1201 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001202 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001203 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001204
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001205 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001206 }
James Bottomley7b163182005-12-15 20:17:02 -06001207
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001208 cmd->cmd_len = scsi_req(req)->cmd_len;
1209 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001210 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001211 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig785ba832018-11-09 14:42:37 +01001212 return BLK_STS_OK;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001213}
1214
1215/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001216 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001217 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001218 */
Christoph Hellwig785ba832018-11-09 14:42:37 +01001219static blk_status_t scsi_setup_fs_cmnd(struct scsi_device *sdev,
1220 struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001221{
Bart Van Asschebed22132017-08-25 13:46:32 -07001222 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001223
Christoph Hellwigee14c672015-08-27 14:16:59 +02001224 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
Christoph Hellwig4c1cb672018-11-09 14:42:40 +01001225 blk_status_t ret = sdev->handler->prep_fn(sdev, req);
1226 if (ret != BLK_STS_OK)
1227 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001228 }
1229
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001230 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001231 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001232 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001233}
James Bottomley7b163182005-12-15 20:17:02 -06001234
Christoph Hellwig785ba832018-11-09 14:42:37 +01001235static blk_status_t scsi_setup_cmnd(struct scsi_device *sdev,
1236 struct request *req)
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001237{
Bart Van Asschebed22132017-08-25 13:46:32 -07001238 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001239
1240 if (!blk_rq_bytes(req))
1241 cmd->sc_data_direction = DMA_NONE;
1242 else if (rq_data_dir(req) == WRITE)
1243 cmd->sc_data_direction = DMA_TO_DEVICE;
1244 else
1245 cmd->sc_data_direction = DMA_FROM_DEVICE;
1246
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001247 if (blk_rq_is_scsi(req))
1248 return scsi_setup_scsi_cmnd(sdev, req);
1249 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001250 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001251}
1252
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001253static blk_status_t
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001254scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255{
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001256 switch (sdev->sdev_state) {
1257 case SDEV_OFFLINE:
1258 case SDEV_TRANSPORT_OFFLINE:
1259 /*
1260 * If the device is offline we refuse to process any
1261 * commands. The device must be brought online
1262 * before trying any recovery commands.
1263 */
1264 sdev_printk(KERN_ERR, sdev,
1265 "rejecting I/O to offline device\n");
1266 return BLK_STS_IOERR;
1267 case SDEV_DEL:
1268 /*
1269 * If the device is fully deleted, we refuse to
1270 * process any commands as well.
1271 */
1272 sdev_printk(KERN_ERR, sdev,
1273 "rejecting I/O to dead device\n");
1274 return BLK_STS_IOERR;
1275 case SDEV_BLOCK:
1276 case SDEV_CREATED_BLOCK:
1277 return BLK_STS_RESOURCE;
1278 case SDEV_QUIESCE:
1279 /*
1280 * If the devices is blocked we defer normal commands.
1281 */
1282 if (req && !(req->rq_flags & RQF_PREEMPT))
1283 return BLK_STS_RESOURCE;
1284 return BLK_STS_OK;
1285 default:
1286 /*
1287 * For any other not fully online state we only allow
1288 * special commands. In particular any user initiated
1289 * command is not allowed.
1290 */
1291 if (req && !(req->rq_flags & RQF_PREEMPT))
1292 return BLK_STS_IOERR;
1293 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001295}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297/*
1298 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1299 * return 0.
1300 *
1301 * Called with the queue_lock held.
1302 */
1303static inline int scsi_dev_queue_ready(struct request_queue *q,
1304 struct scsi_device *sdev)
1305{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001306 unsigned int busy;
1307
1308 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001309 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001310 if (busy)
1311 goto out_dec;
1312
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 /*
1314 * unblock after device_blocked iterates to zero
1315 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001316 if (atomic_dec_return(&sdev->device_blocked) > 0)
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001317 goto out_dec;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001318 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1319 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001321
1322 if (busy >= sdev->queue_depth)
1323 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324
1325 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001326out_dec:
1327 atomic_dec(&sdev->device_busy);
1328 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329}
1330
Mike Christief0c0a372008-08-17 15:24:38 -05001331/*
1332 * scsi_target_queue_ready: checks if there we can send commands to target
1333 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001334 */
1335static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1336 struct scsi_device *sdev)
1337{
1338 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001339 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001340
1341 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001342 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001343 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001344 starget->starget_sdev_user != sdev) {
1345 spin_unlock_irq(shost->host_lock);
1346 return 0;
1347 }
Mike Christief0c0a372008-08-17 15:24:38 -05001348 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001349 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001350 }
1351
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001352 if (starget->can_queue <= 0)
1353 return 1;
1354
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001355 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001356 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001357 if (busy)
1358 goto starved;
1359
Mike Christief0c0a372008-08-17 15:24:38 -05001360 /*
1361 * unblock after target_blocked iterates to zero
1362 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001363 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001364 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001365
1366 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1367 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001368 }
1369
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001370 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001371 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001372
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001373 return 1;
1374
1375starved:
1376 spin_lock_irq(shost->host_lock);
1377 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001378 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001379out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001380 if (starget->can_queue > 0)
1381 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001382 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001383}
1384
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385/*
1386 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1387 * return 0. We must end up running the queue again whenever 0 is
1388 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 */
1390static inline int scsi_host_queue_ready(struct request_queue *q,
1391 struct Scsi_Host *shost,
1392 struct scsi_device *sdev)
1393{
Christoph Hellwig74665012014-01-22 15:29:29 +01001394 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001395
James Bottomley939647e2005-09-18 15:05:20 -05001396 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001397 return 0;
1398
Ming Leid772a652018-08-27 15:24:43 +08001399 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001400 if (atomic_read(&shost->host_blocked) > 0) {
Ming Leid772a652018-08-27 15:24:43 +08001401 if (busy)
Christoph Hellwig74665012014-01-22 15:29:29 +01001402 goto starved;
1403
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 /*
1405 * unblock after host_blocked iterates to zero
1406 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001407 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001408 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001409
1410 SCSI_LOG_MLQUEUE(3,
1411 shost_printk(KERN_INFO, shost,
1412 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001414
Ming Leid772a652018-08-27 15:24:43 +08001415 if (shost->can_queue > 0 && busy >= shost->can_queue)
Christoph Hellwig74665012014-01-22 15:29:29 +01001416 goto starved;
1417 if (shost->host_self_blocked)
1418 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419
1420 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001421 if (!list_empty(&sdev->starved_entry)) {
1422 spin_lock_irq(shost->host_lock);
1423 if (!list_empty(&sdev->starved_entry))
1424 list_del_init(&sdev->starved_entry);
1425 spin_unlock_irq(shost->host_lock);
1426 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Christoph Hellwig74665012014-01-22 15:29:29 +01001428 return 1;
1429
1430starved:
1431 spin_lock_irq(shost->host_lock);
1432 if (list_empty(&sdev->starved_entry))
1433 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001434 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001435out_dec:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001436 scsi_dec_host_busy(shost);
Christoph Hellwig74665012014-01-22 15:29:29 +01001437 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438}
1439
1440/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001441 * Busy state exporting function for request stacking drivers.
1442 *
1443 * For efficiency, no lock is taken to check the busy state of
1444 * shost/starget/sdev, since the returned value is not guaranteed and
1445 * may be changed after request stacking drivers call the function,
1446 * regardless of taking lock or not.
1447 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001448 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1449 * needs to return 'not busy'. Otherwise, request stacking drivers
1450 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001451 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001452static bool scsi_mq_lld_busy(struct request_queue *q)
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001453{
1454 struct scsi_device *sdev = q->queuedata;
1455 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001456
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001457 if (blk_queue_dying(q))
Jens Axboef664a3c2018-11-01 16:36:27 -06001458 return false;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001459
1460 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001461
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001462 /*
1463 * Ignore host/starget busy state.
1464 * Since block layer does not have a concept of fairness across
1465 * multiple queues, congestion of host/starget needs to be handled
1466 * in SCSI layer.
1467 */
1468 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Jens Axboef664a3c2018-11-01 16:36:27 -06001469 return true;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001470
Jens Axboef664a3c2018-11-01 16:36:27 -06001471 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472}
1473
Jens Axboe1aea6432006-01-09 16:03:03 +01001474static void scsi_softirq_done(struct request *rq)
1475{
Bart Van Asschebed22132017-08-25 13:46:32 -07001476 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001477 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001478 int disposition;
1479
1480 INIT_LIST_HEAD(&cmd->eh_entry);
1481
Jens Axboe242f9dc2008-09-14 05:55:09 -07001482 atomic_inc(&cmd->device->iodone_cnt);
1483 if (cmd->result)
1484 atomic_inc(&cmd->device->ioerr_cnt);
1485
Jens Axboe1aea6432006-01-09 16:03:03 +01001486 disposition = scsi_decide_disposition(cmd);
1487 if (disposition != SUCCESS &&
1488 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1489 sdev_printk(KERN_ERR, cmd->device,
1490 "timing out command, waited %lus\n",
1491 wait_for/HZ);
1492 disposition = SUCCESS;
1493 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001494
Jens Axboe1aea6432006-01-09 16:03:03 +01001495 scsi_log_completion(cmd, disposition);
1496
1497 switch (disposition) {
1498 case SUCCESS:
1499 scsi_finish_command(cmd);
1500 break;
1501 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001502 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001503 break;
1504 case ADD_TO_MLQUEUE:
1505 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1506 break;
1507 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001508 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001509 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001510 }
1511}
1512
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001513/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001514 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1515 * @cmd: command block we are dispatching.
1516 *
1517 * Return: nonzero return request was rejected and device's queue needs to be
1518 * plugged.
1519 */
1520static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1521{
1522 struct Scsi_Host *host = cmd->device->host;
1523 int rtn = 0;
1524
1525 atomic_inc(&cmd->device->iorequest_cnt);
1526
1527 /* check if the device is still usable */
1528 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1529 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1530 * returns an immediate error upwards, and signals
1531 * that the device is no longer present */
1532 cmd->result = DID_NO_CONNECT << 16;
1533 goto done;
1534 }
1535
1536 /* Check to see if the scsi lld made this device blocked. */
1537 if (unlikely(scsi_device_blocked(cmd->device))) {
1538 /*
1539 * in blocked state, the command is just put back on
1540 * the device queue. The suspend state has already
1541 * blocked the queue so future requests should not
1542 * occur until the device transitions out of the
1543 * suspend state.
1544 */
1545 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1546 "queuecommand : device blocked\n"));
1547 return SCSI_MLQUEUE_DEVICE_BUSY;
1548 }
1549
1550 /* Store the LUN value in cmnd, if needed. */
1551 if (cmd->device->lun_in_cdb)
1552 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1553 (cmd->device->lun << 5 & 0xe0);
1554
1555 scsi_log_send(cmd);
1556
1557 /*
1558 * Before we queue this command, check if the command
1559 * length exceeds what the host adapter can handle.
1560 */
1561 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1562 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1563 "queuecommand : command too long. "
1564 "cdb_size=%d host->max_cmd_len=%d\n",
1565 cmd->cmd_len, cmd->device->host->max_cmd_len));
1566 cmd->result = (DID_ABORT << 16);
1567 goto done;
1568 }
1569
1570 if (unlikely(host->shost_state == SHOST_DEL)) {
1571 cmd->result = (DID_NO_CONNECT << 16);
1572 goto done;
1573
1574 }
1575
1576 trace_scsi_dispatch_cmd_start(cmd);
1577 rtn = host->hostt->queuecommand(host, cmd);
1578 if (rtn) {
1579 trace_scsi_dispatch_cmd_error(cmd, rtn);
1580 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1581 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1582 rtn = SCSI_MLQUEUE_HOST_BUSY;
1583
1584 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1585 "queuecommand : request rejected\n"));
1586 }
1587
1588 return rtn;
1589 done:
1590 cmd->scsi_done(cmd);
1591 return 0;
1592}
1593
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001594/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
1595static unsigned int scsi_mq_sgl_size(struct Scsi_Host *shost)
1596{
1597 return min_t(unsigned int, shost->sg_tablesize, SG_CHUNK_SIZE) *
1598 sizeof(struct scatterlist);
1599}
1600
Christoph Hellwig785ba832018-11-09 14:42:37 +01001601static blk_status_t scsi_mq_prep_fn(struct request *req)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001602{
1603 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1604 struct scsi_device *sdev = req->q->queuedata;
1605 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001606 struct scatterlist *sg;
1607
Bart Van Assche08f78432017-06-02 14:22:00 -07001608 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001609
1610 req->special = cmd;
1611
1612 cmd->request = req;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001613
1614 cmd->tag = req->tag;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001615 cmd->prot_op = SCSI_PROT_NORMAL;
1616
Christoph Hellwigd2852032014-01-17 12:06:53 +01001617 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1618 cmd->sdb.table.sgl = sg;
1619
1620 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001621 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1622
1623 cmd->prot_sdb->table.sgl =
1624 (struct scatterlist *)(cmd->prot_sdb + 1);
1625 }
1626
1627 if (blk_bidi_rq(req)) {
1628 struct request *next_rq = req->next_rq;
1629 struct scsi_data_buffer *bidi_sdb = blk_mq_rq_to_pdu(next_rq);
1630
1631 memset(bidi_sdb, 0, sizeof(struct scsi_data_buffer));
1632 bidi_sdb->table.sgl =
1633 (struct scatterlist *)(bidi_sdb + 1);
1634
1635 next_rq->special = bidi_sdb;
1636 }
1637
Christoph Hellwigfe052522014-09-22 15:59:31 +02001638 blk_mq_start_request(req);
1639
Bart Van Assche8fe8ffb2017-10-20 11:46:45 -07001640 return scsi_setup_cmnd(sdev, req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001641}
1642
1643static void scsi_mq_done(struct scsi_cmnd *cmd)
1644{
1645 trace_scsi_dispatch_cmd_done(cmd);
Christoph Hellwig08e00292017-04-20 16:03:09 +02001646 blk_mq_complete_request(cmd->request);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001647}
1648
Ming Lei0df21c82017-10-14 17:22:32 +08001649static void scsi_mq_put_budget(struct blk_mq_hw_ctx *hctx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001650{
Ming Lei0df21c82017-10-14 17:22:32 +08001651 struct request_queue *q = hctx->queue;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001652 struct scsi_device *sdev = q->queuedata;
Ming Lei0df21c82017-10-14 17:22:32 +08001653
Ming Lei0df21c82017-10-14 17:22:32 +08001654 atomic_dec(&sdev->device_busy);
1655 put_device(&sdev->sdev_gendev);
1656}
1657
Ming Lei88022d72017-11-05 02:21:12 +08001658static bool scsi_mq_get_budget(struct blk_mq_hw_ctx *hctx)
Ming Lei0df21c82017-10-14 17:22:32 +08001659{
1660 struct request_queue *q = hctx->queue;
1661 struct scsi_device *sdev = q->queuedata;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001662
Christoph Hellwigd2852032014-01-17 12:06:53 +01001663 if (!get_device(&sdev->sdev_gendev))
1664 goto out;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001665 if (!scsi_dev_queue_ready(q, sdev))
1666 goto out_put_device;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001667
Ming Lei88022d72017-11-05 02:21:12 +08001668 return true;
Ming Lei0df21c82017-10-14 17:22:32 +08001669
Ming Lei0df21c82017-10-14 17:22:32 +08001670out_put_device:
1671 put_device(&sdev->sdev_gendev);
1672out:
Ming Lei7e70aa72017-12-05 15:52:56 +08001673 if (atomic_read(&sdev->device_busy) == 0 && !scsi_device_blocked(sdev))
1674 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Ming Lei88022d72017-11-05 02:21:12 +08001675 return false;
Ming Lei0df21c82017-10-14 17:22:32 +08001676}
1677
Christoph Hellwigd2852032014-01-17 12:06:53 +01001678static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1679 const struct blk_mq_queue_data *bd)
1680{
1681 struct request *req = bd->rq;
1682 struct request_queue *q = req->q;
1683 struct scsi_device *sdev = q->queuedata;
1684 struct Scsi_Host *shost = sdev->host;
1685 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1686 blk_status_t ret;
1687 int reason;
1688
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001689 /*
1690 * If the device is not in running state we will reject some or all
1691 * commands.
1692 */
1693 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1694 ret = scsi_prep_state_check(sdev, req);
1695 if (ret != BLK_STS_OK)
1696 goto out_put_budget;
1697 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001698
1699 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001700 if (!scsi_target_queue_ready(shost, sdev))
Ming Lei826a70a2017-11-04 09:55:34 +08001701 goto out_put_budget;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001702 if (!scsi_host_queue_ready(q, shost, sdev))
1703 goto out_dec_target_busy;
1704
Christoph Hellwige8064022016-10-20 15:12:13 +02001705 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwig785ba832018-11-09 14:42:37 +01001706 ret = scsi_mq_prep_fn(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001707 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001708 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001709 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001710 } else {
1711 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001712 }
1713
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001714 if (sdev->simple_tags)
1715 cmd->flags |= SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001716 else
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001717 cmd->flags &= ~SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001718
Christoph Hellwigd2852032014-01-17 12:06:53 +01001719 scsi_init_cmd_errh(cmd);
1720 cmd->scsi_done = scsi_mq_done;
1721
1722 reason = scsi_dispatch_cmd(cmd);
1723 if (reason) {
1724 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001725 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001726 goto out_dec_host_busy;
1727 }
1728
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001729 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001730
1731out_dec_host_busy:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001732 scsi_dec_host_busy(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001733out_dec_target_busy:
1734 if (scsi_target(sdev)->can_queue > 0)
1735 atomic_dec(&scsi_target(sdev)->target_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001736out_put_budget:
1737 scsi_mq_put_budget(hctx);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001738 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001739 case BLK_STS_OK:
1740 break;
1741 case BLK_STS_RESOURCE:
Ming Lei86ff7c22018-01-30 22:04:57 -05001742 if (atomic_read(&sdev->device_busy) ||
1743 scsi_device_blocked(sdev))
1744 ret = BLK_STS_DEV_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001745 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001746 default:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001747 /*
1748 * Make sure to release all allocated ressources when
1749 * we hit an error, as we will never see this command
1750 * again.
1751 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001752 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001753 scsi_mq_uninit_cmd(cmd);
1754 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001755 }
1756 return ret;
1757}
1758
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001759static enum blk_eh_timer_return scsi_timeout(struct request *req,
1760 bool reserved)
1761{
1762 if (reserved)
1763 return BLK_EH_RESET_TIMER;
1764 return scsi_times_out(req);
1765}
1766
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001767static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1768 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001769{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001770 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07001771 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001772 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07001773 struct scatterlist *sg;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001774
Bart Van Assche8e688252017-06-02 14:21:52 -07001775 if (unchecked_isa_dma)
1776 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
1777 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
1778 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001779 if (!cmd->sense_buffer)
1780 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001781 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07001782
1783 if (scsi_host_get_prot(shost)) {
1784 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1785 shost->hostt->cmd_size;
1786 cmd->prot_sdb = (void *)sg + scsi_mq_sgl_size(shost);
1787 }
1788
Christoph Hellwigd2852032014-01-17 12:06:53 +01001789 return 0;
1790}
1791
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001792static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
1793 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001794{
1795 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1796
Bart Van Assche8e688252017-06-02 14:21:52 -07001797 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
1798 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001799}
1800
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001801static int scsi_map_queues(struct blk_mq_tag_set *set)
1802{
1803 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1804
1805 if (shost->hostt->map_queues)
1806 return shost->hostt->map_queues(shost);
Jens Axboeed76e322018-10-29 13:06:14 -06001807 return blk_mq_map_queues(&set->map[0]);
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001808}
1809
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001810void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811{
Lin Ming6f381fa2012-04-12 13:50:38 +08001812 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813
Jens Axboea8474ce2007-08-07 09:02:51 +02001814 /*
1815 * this limit is imposed by hardware restrictions
1816 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001817 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07001818 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001819
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001820 if (scsi_host_prot_dma(shost)) {
1821 shost->sg_prot_tablesize =
1822 min_not_zero(shost->sg_prot_tablesize,
1823 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1824 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1825 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1826 }
1827
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001828 blk_queue_max_hw_sectors(q, shost->max_sectors);
Christoph Hellwig21e07db2018-04-03 19:09:59 +02001829 if (shost->unchecked_isa_dma)
1830 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001832 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833
FUJITA Tomonori860ac562008-02-04 22:28:05 -08001834 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
1835
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01001837 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06001838
1839 /*
Huacai Chen90addc62017-11-21 14:23:38 +01001840 * Set a reasonable default alignment: The larger of 32-byte (dword),
1841 * which is a common minimum for HBAs, and the minimum DMA alignment,
1842 * which is set by the platform.
1843 *
1844 * Devices that require a bigger alignment can increase it later.
James Bottomley465ff312008-01-01 10:00:10 -06001845 */
Huacai Chen90addc62017-11-21 14:23:38 +01001846 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001847}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001848EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06001849
Eric Biggersf363b082017-03-30 13:39:16 -07001850static const struct blk_mq_ops scsi_mq_ops = {
Ming Lei0df21c82017-10-14 17:22:32 +08001851 .get_budget = scsi_mq_get_budget,
1852 .put_budget = scsi_mq_put_budget,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001853 .queue_rq = scsi_queue_rq,
1854 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001855 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07001856#ifdef CONFIG_BLK_DEBUG_FS
1857 .show_rq = scsi_show_rq,
1858#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001859 .init_request = scsi_mq_init_request,
1860 .exit_request = scsi_mq_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001861 .initialize_rq_fn = scsi_initialize_rq,
Jens Axboe3a7ea2c42018-10-29 10:17:28 -06001862 .busy = scsi_mq_lld_busy,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001863 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001864};
1865
1866struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
1867{
1868 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
1869 if (IS_ERR(sdev->request_queue))
1870 return NULL;
1871
1872 sdev->request_queue->queuedata = sdev;
1873 __scsi_init_queue(sdev->host, sdev->request_queue);
Christoph Hellwig17cb9602018-03-13 17:28:41 +01001874 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001875 return sdev->request_queue;
1876}
1877
1878int scsi_mq_setup_tags(struct Scsi_Host *shost)
1879{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001880 unsigned int cmd_size, sgl_size;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001881
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001882 sgl_size = scsi_mq_sgl_size(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001883 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1884 if (scsi_host_get_prot(shost))
1885 cmd_size += sizeof(struct scsi_data_buffer) + sgl_size;
1886
1887 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
1888 shost->tag_set.ops = &scsi_mq_ops;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01001889 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001890 shost->tag_set.queue_depth = shost->can_queue;
1891 shost->tag_set.cmd_size = cmd_size;
1892 shost->tag_set.numa_node = NUMA_NO_NODE;
1893 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07001894 shost->tag_set.flags |=
1895 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001896 shost->tag_set.driver_data = shost;
1897
1898 return blk_mq_alloc_tag_set(&shost->tag_set);
1899}
1900
1901void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1902{
1903 blk_mq_free_tag_set(&shost->tag_set);
1904}
1905
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001906/**
1907 * scsi_device_from_queue - return sdev associated with a request_queue
1908 * @q: The request queue to return the sdev from
1909 *
1910 * Return the sdev associated with a request queue or NULL if the
1911 * request_queue does not reference a SCSI device.
1912 */
1913struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1914{
1915 struct scsi_device *sdev = NULL;
1916
Jens Axboef664a3c2018-11-01 16:36:27 -06001917 if (q->mq_ops == &scsi_mq_ops)
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001918 sdev = q->queuedata;
1919 if (!sdev || !get_device(&sdev->sdev_gendev))
1920 sdev = NULL;
1921
1922 return sdev;
1923}
1924EXPORT_SYMBOL_GPL(scsi_device_from_queue);
1925
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926/*
1927 * Function: scsi_block_requests()
1928 *
1929 * Purpose: Utility function used by low-level drivers to prevent further
1930 * commands from being queued to the device.
1931 *
1932 * Arguments: shost - Host in question
1933 *
1934 * Returns: Nothing
1935 *
1936 * Lock status: No locks are assumed held.
1937 *
1938 * Notes: There is no timer nor any other means by which the requests
1939 * get unblocked other than the low-level driver calling
1940 * scsi_unblock_requests().
1941 */
1942void scsi_block_requests(struct Scsi_Host *shost)
1943{
1944 shost->host_self_blocked = 1;
1945}
1946EXPORT_SYMBOL(scsi_block_requests);
1947
1948/*
1949 * Function: scsi_unblock_requests()
1950 *
1951 * Purpose: Utility function used by low-level drivers to allow further
1952 * commands from being queued to the device.
1953 *
1954 * Arguments: shost - Host in question
1955 *
1956 * Returns: Nothing
1957 *
1958 * Lock status: No locks are assumed held.
1959 *
1960 * Notes: There is no timer nor any other means by which the requests
1961 * get unblocked other than the low-level driver calling
1962 * scsi_unblock_requests().
1963 *
1964 * This is done as an API function so that changes to the
1965 * internals of the scsi mid-layer won't require wholesale
1966 * changes to drivers that use this feature.
1967 */
1968void scsi_unblock_requests(struct Scsi_Host *shost)
1969{
1970 shost->host_self_blocked = 0;
1971 scsi_run_host_queues(shost);
1972}
1973EXPORT_SYMBOL(scsi_unblock_requests);
1974
1975int __init scsi_init_queue(void)
1976{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001977 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1978 sizeof(struct scsi_data_buffer),
1979 0, 0, NULL);
1980 if (!scsi_sdb_cache) {
1981 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001982 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001983 }
1984
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 return 0;
1986}
1987
1988void scsi_exit_queue(void)
1989{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03001990 kmem_cache_destroy(scsi_sense_cache);
1991 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001992 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993}
James Bottomley5baba832006-03-18 14:10:35 -06001994
1995/**
1996 * scsi_mode_select - issue a mode select
1997 * @sdev: SCSI device to be queried
1998 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1999 * @sp: Save page bit (0 == don't save, 1 == save)
2000 * @modepage: mode page being requested
2001 * @buffer: request buffer (may not be smaller than eight bytes)
2002 * @len: length of request buffer.
2003 * @timeout: command timeout
2004 * @retries: number of retries before failing
2005 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002006 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06002007 * must be SCSI_SENSE_BUFFERSIZE big.
2008 *
2009 * Returns zero if successful; negative error number or scsi
2010 * status on error
2011 *
2012 */
2013int
2014scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2015 unsigned char *buffer, int len, int timeout, int retries,
2016 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2017{
2018 unsigned char cmd[10];
2019 unsigned char *real_buffer;
2020 int ret;
2021
2022 memset(cmd, 0, sizeof(cmd));
2023 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2024
2025 if (sdev->use_10_for_ms) {
2026 if (len > 65535)
2027 return -EINVAL;
2028 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2029 if (!real_buffer)
2030 return -ENOMEM;
2031 memcpy(real_buffer + 8, buffer, len);
2032 len += 8;
2033 real_buffer[0] = 0;
2034 real_buffer[1] = 0;
2035 real_buffer[2] = data->medium_type;
2036 real_buffer[3] = data->device_specific;
2037 real_buffer[4] = data->longlba ? 0x01 : 0;
2038 real_buffer[5] = 0;
2039 real_buffer[6] = data->block_descriptor_length >> 8;
2040 real_buffer[7] = data->block_descriptor_length;
2041
2042 cmd[0] = MODE_SELECT_10;
2043 cmd[7] = len >> 8;
2044 cmd[8] = len;
2045 } else {
2046 if (len > 255 || data->block_descriptor_length > 255 ||
2047 data->longlba)
2048 return -EINVAL;
2049
2050 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2051 if (!real_buffer)
2052 return -ENOMEM;
2053 memcpy(real_buffer + 4, buffer, len);
2054 len += 4;
2055 real_buffer[0] = 0;
2056 real_buffer[1] = data->medium_type;
2057 real_buffer[2] = data->device_specific;
2058 real_buffer[3] = data->block_descriptor_length;
2059
2060
2061 cmd[0] = MODE_SELECT;
2062 cmd[4] = len;
2063 }
2064
2065 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002066 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002067 kfree(real_buffer);
2068 return ret;
2069}
2070EXPORT_SYMBOL_GPL(scsi_mode_select);
2071
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072/**
Rob Landleyeb448202007-11-03 13:30:39 -05002073 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002074 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 * @dbd: set if mode sense will allow block descriptors to be returned
2076 * @modepage: mode page being requested
2077 * @buffer: request buffer (may not be smaller than eight bytes)
2078 * @len: length of request buffer.
2079 * @timeout: command timeout
2080 * @retries: number of retries before failing
2081 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002082 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002083 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 *
2085 * Returns zero if unsuccessful, or the header offset (either 4
2086 * or 8 depending on whether a six or ten byte command was
2087 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002088 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089int
James Bottomley1cf72692005-08-28 11:27:01 -05002090scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002092 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2093{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 unsigned char cmd[12];
2095 int use_10_for_ms;
2096 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002097 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002098 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099
2100 memset(data, 0, sizeof(*data));
2101 memset(&cmd[0], 0, 12);
2102 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2103 cmd[2] = modepage;
2104
James Bottomleyea73a9f2005-08-28 11:33:52 -05002105 /* caller might not be interested in sense, but we need it */
2106 if (!sshdr)
2107 sshdr = &my_sshdr;
2108
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002110 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111
2112 if (use_10_for_ms) {
2113 if (len < 8)
2114 len = 8;
2115
2116 cmd[0] = MODE_SENSE_10;
2117 cmd[8] = len;
2118 header_length = 8;
2119 } else {
2120 if (len < 4)
2121 len = 4;
2122
2123 cmd[0] = MODE_SENSE;
2124 cmd[4] = len;
2125 header_length = 4;
2126 }
2127
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 memset(buffer, 0, len);
2129
James Bottomley1cf72692005-08-28 11:27:01 -05002130 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002131 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132
2133 /* This code looks awful: what it's doing is making sure an
2134 * ILLEGAL REQUEST sense return identifies the actual command
2135 * byte as the problem. MODE_SENSE commands can return
2136 * ILLEGAL REQUEST if the code page isn't supported */
2137
James Bottomley1cf72692005-08-28 11:27:01 -05002138 if (use_10_for_ms && !scsi_status_is_good(result) &&
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002139 driver_byte(result) == DRIVER_SENSE) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002140 if (scsi_sense_valid(sshdr)) {
2141 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2142 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 /*
2144 * Invalid command operation code
2145 */
James Bottomley1cf72692005-08-28 11:27:01 -05002146 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 goto retry;
2148 }
2149 }
2150 }
2151
James Bottomley1cf72692005-08-28 11:27:01 -05002152 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002153 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2154 (modepage == 6 || modepage == 8))) {
2155 /* Initio breakage? */
2156 header_length = 0;
2157 data->length = 13;
2158 data->medium_type = 0;
2159 data->device_specific = 0;
2160 data->longlba = 0;
2161 data->block_descriptor_length = 0;
2162 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 data->length = buffer[0]*256 + buffer[1] + 2;
2164 data->medium_type = buffer[2];
2165 data->device_specific = buffer[3];
2166 data->longlba = buffer[4] & 0x01;
2167 data->block_descriptor_length = buffer[6]*256
2168 + buffer[7];
2169 } else {
2170 data->length = buffer[0] + 1;
2171 data->medium_type = buffer[1];
2172 data->device_specific = buffer[2];
2173 data->block_descriptor_length = buffer[3];
2174 }
Al Viro6d73c852006-02-23 02:03:16 +01002175 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002176 } else if ((status_byte(result) == CHECK_CONDITION) &&
2177 scsi_sense_valid(sshdr) &&
2178 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2179 retry_count--;
2180 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 }
2182
James Bottomley1cf72692005-08-28 11:27:01 -05002183 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184}
2185EXPORT_SYMBOL(scsi_mode_sense);
2186
James Bottomley001aac22007-12-02 19:10:40 +02002187/**
2188 * scsi_test_unit_ready - test if unit is ready
2189 * @sdev: scsi device to change the state of.
2190 * @timeout: command timeout
2191 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002192 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002193 *
2194 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002195 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002196 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197int
James Bottomley001aac22007-12-02 19:10:40 +02002198scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002199 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 char cmd[] = {
2202 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2203 };
2204 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002205
James Bottomley001aac22007-12-02 19:10:40 +02002206 /* try to eat the UNIT_ATTENTION if there are enough retries */
2207 do {
2208 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
Bart Van Assche9b91fd32018-02-12 10:57:52 -08002209 timeout, 1, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002210 if (sdev->removable && scsi_sense_valid(sshdr) &&
2211 sshdr->sense_key == UNIT_ATTENTION)
2212 sdev->changed = 1;
2213 } while (scsi_sense_valid(sshdr) &&
2214 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002215
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 return result;
2217}
2218EXPORT_SYMBOL(scsi_test_unit_ready);
2219
2220/**
Rob Landleyeb448202007-11-03 13:30:39 -05002221 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 * @sdev: scsi device to change the state of.
2223 * @state: state to change to.
2224 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002225 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002227 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228int
2229scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2230{
2231 enum scsi_device_state oldstate = sdev->sdev_state;
2232
2233 if (state == oldstate)
2234 return 0;
2235
2236 switch (state) {
2237 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002238 switch (oldstate) {
2239 case SDEV_CREATED_BLOCK:
2240 break;
2241 default:
2242 goto illegal;
2243 }
2244 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245
2246 case SDEV_RUNNING:
2247 switch (oldstate) {
2248 case SDEV_CREATED:
2249 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002250 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 case SDEV_QUIESCE:
2252 case SDEV_BLOCK:
2253 break;
2254 default:
2255 goto illegal;
2256 }
2257 break;
2258
2259 case SDEV_QUIESCE:
2260 switch (oldstate) {
2261 case SDEV_RUNNING:
2262 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002263 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 break;
2265 default:
2266 goto illegal;
2267 }
2268 break;
2269
2270 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002271 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 switch (oldstate) {
2273 case SDEV_CREATED:
2274 case SDEV_RUNNING:
2275 case SDEV_QUIESCE:
2276 case SDEV_BLOCK:
2277 break;
2278 default:
2279 goto illegal;
2280 }
2281 break;
2282
2283 case SDEV_BLOCK:
2284 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002286 case SDEV_CREATED_BLOCK:
Hannes Reineckea33e5bf2018-10-07 10:35:35 +02002287 case SDEV_OFFLINE:
James Bottomley6f4267e2008-08-22 16:53:31 -05002288 break;
2289 default:
2290 goto illegal;
2291 }
2292 break;
2293
2294 case SDEV_CREATED_BLOCK:
2295 switch (oldstate) {
2296 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 break;
2298 default:
2299 goto illegal;
2300 }
2301 break;
2302
2303 case SDEV_CANCEL:
2304 switch (oldstate) {
2305 case SDEV_CREATED:
2306 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002307 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002309 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 break;
2311 default:
2312 goto illegal;
2313 }
2314 break;
2315
2316 case SDEV_DEL:
2317 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002318 case SDEV_CREATED:
2319 case SDEV_RUNNING:
2320 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002321 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002323 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002324 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 break;
2326 default:
2327 goto illegal;
2328 }
2329 break;
2330
2331 }
2332 sdev->sdev_state = state;
2333 return 0;
2334
2335 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002336 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002337 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002338 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002339 scsi_device_state_name(oldstate),
2340 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 );
2342 return -EINVAL;
2343}
2344EXPORT_SYMBOL(scsi_device_set_state);
2345
2346/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002347 * sdev_evt_emit - emit a single SCSI device uevent
2348 * @sdev: associated SCSI device
2349 * @evt: event to emit
2350 *
2351 * Send a single uevent (scsi_event) to the associated scsi_device.
2352 */
2353static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2354{
2355 int idx = 0;
2356 char *envp[3];
2357
2358 switch (evt->evt_type) {
2359 case SDEV_EVT_MEDIA_CHANGE:
2360 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2361 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002362 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002363 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002364 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2365 break;
2366 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2367 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2368 break;
2369 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2370 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2371 break;
2372 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2373 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2374 break;
2375 case SDEV_EVT_LUN_CHANGE_REPORTED:
2376 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2377 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002378 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2379 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2380 break;
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002381 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2382 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2383 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002384 default:
2385 /* do nothing */
2386 break;
2387 }
2388
2389 envp[idx++] = NULL;
2390
2391 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2392}
2393
2394/**
2395 * sdev_evt_thread - send a uevent for each scsi event
2396 * @work: work struct for scsi_device
2397 *
2398 * Dispatch queued events to their associated scsi_device kobjects
2399 * as uevents.
2400 */
2401void scsi_evt_thread(struct work_struct *work)
2402{
2403 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002404 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002405 LIST_HEAD(event_list);
2406
2407 sdev = container_of(work, struct scsi_device, event_work);
2408
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002409 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2410 if (test_and_clear_bit(evt_type, sdev->pending_events))
2411 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2412
Jeff Garzika341cd02007-10-29 17:15:22 -04002413 while (1) {
2414 struct scsi_event *evt;
2415 struct list_head *this, *tmp;
2416 unsigned long flags;
2417
2418 spin_lock_irqsave(&sdev->list_lock, flags);
2419 list_splice_init(&sdev->event_list, &event_list);
2420 spin_unlock_irqrestore(&sdev->list_lock, flags);
2421
2422 if (list_empty(&event_list))
2423 break;
2424
2425 list_for_each_safe(this, tmp, &event_list) {
2426 evt = list_entry(this, struct scsi_event, node);
2427 list_del(&evt->node);
2428 scsi_evt_emit(sdev, evt);
2429 kfree(evt);
2430 }
2431 }
2432}
2433
2434/**
2435 * sdev_evt_send - send asserted event to uevent thread
2436 * @sdev: scsi_device event occurred on
2437 * @evt: event to send
2438 *
2439 * Assert scsi device event asynchronously.
2440 */
2441void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2442{
2443 unsigned long flags;
2444
Kay Sievers4d1566e2008-03-19 13:04:47 +01002445#if 0
2446 /* FIXME: currently this check eliminates all media change events
2447 * for polled devices. Need to update to discriminate between AN
2448 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002449 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2450 kfree(evt);
2451 return;
2452 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002453#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002454
2455 spin_lock_irqsave(&sdev->list_lock, flags);
2456 list_add_tail(&evt->node, &sdev->event_list);
2457 schedule_work(&sdev->event_work);
2458 spin_unlock_irqrestore(&sdev->list_lock, flags);
2459}
2460EXPORT_SYMBOL_GPL(sdev_evt_send);
2461
2462/**
2463 * sdev_evt_alloc - allocate a new scsi event
2464 * @evt_type: type of event to allocate
2465 * @gfpflags: GFP flags for allocation
2466 *
2467 * Allocates and returns a new scsi_event.
2468 */
2469struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2470 gfp_t gfpflags)
2471{
2472 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2473 if (!evt)
2474 return NULL;
2475
2476 evt->evt_type = evt_type;
2477 INIT_LIST_HEAD(&evt->node);
2478
2479 /* evt_type-specific initialization, if any */
2480 switch (evt_type) {
2481 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002482 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2483 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2484 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2485 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2486 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002487 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002488 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002489 default:
2490 /* do nothing */
2491 break;
2492 }
2493
2494 return evt;
2495}
2496EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2497
2498/**
2499 * sdev_evt_send_simple - send asserted event to uevent thread
2500 * @sdev: scsi_device event occurred on
2501 * @evt_type: type of event to send
2502 * @gfpflags: GFP flags for allocation
2503 *
2504 * Assert scsi device event asynchronously, given an event type.
2505 */
2506void sdev_evt_send_simple(struct scsi_device *sdev,
2507 enum scsi_device_event evt_type, gfp_t gfpflags)
2508{
2509 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2510 if (!evt) {
2511 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2512 evt_type);
2513 return;
2514 }
2515
2516 sdev_evt_send(sdev, evt);
2517}
2518EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2519
2520/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521 * scsi_device_quiesce - Block user issued commands.
2522 * @sdev: scsi device to quiesce.
2523 *
2524 * This works by trying to transition to the SDEV_QUIESCE state
2525 * (which must be a legal transition). When the device is in this
2526 * state, only special requests will be accepted, all others will
2527 * be deferred. Since special requests may also be requeued requests,
2528 * a successful return doesn't guarantee the device will be
2529 * totally quiescent.
2530 *
2531 * Must be called with user context, may sleep.
2532 *
2533 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002534 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535int
2536scsi_device_quiesce(struct scsi_device *sdev)
2537{
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002538 struct request_queue *q = sdev->request_queue;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002539 int err;
2540
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002541 /*
2542 * It is allowed to call scsi_device_quiesce() multiple times from
2543 * the same context but concurrent scsi_device_quiesce() calls are
2544 * not allowed.
2545 */
2546 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2547
Bart Van Asschecd84a622018-09-26 14:01:04 -07002548 if (sdev->quiesced_by == current)
2549 return 0;
2550
2551 blk_set_pm_only(q);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002552
2553 blk_mq_freeze_queue(q);
2554 /*
Bart Van Asschecd84a622018-09-26 14:01:04 -07002555 * Ensure that the effect of blk_set_pm_only() will be visible
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002556 * for percpu_ref_tryget() callers that occur after the queue
2557 * unfreeze even if the queue was already frozen before this function
2558 * was called. See also https://lwn.net/Articles/573497/.
2559 */
2560 synchronize_rcu();
2561 blk_mq_unfreeze_queue(q);
2562
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002563 mutex_lock(&sdev->state_mutex);
2564 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002565 if (err == 0)
2566 sdev->quiesced_by = current;
2567 else
Bart Van Asschecd84a622018-09-26 14:01:04 -07002568 blk_clear_pm_only(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002569 mutex_unlock(&sdev->state_mutex);
2570
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002571 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572}
2573EXPORT_SYMBOL(scsi_device_quiesce);
2574
2575/**
2576 * scsi_device_resume - Restart user issued commands to a quiesced device.
2577 * @sdev: scsi device to resume.
2578 *
2579 * Moves the device from quiesced back to running and restarts the
2580 * queues.
2581 *
2582 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002583 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002584void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002586 /* check if the device state was mutated prior to resume, and if
2587 * so assume the state is being managed elsewhere (for example
2588 * device deleted during suspend)
2589 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002590 mutex_lock(&sdev->state_mutex);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002591 WARN_ON_ONCE(!sdev->quiesced_by);
2592 sdev->quiesced_by = NULL;
Bart Van Asschecd84a622018-09-26 14:01:04 -07002593 blk_clear_pm_only(sdev->request_queue);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002594 if (sdev->sdev_state == SDEV_QUIESCE)
2595 scsi_device_set_state(sdev, SDEV_RUNNING);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002596 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597}
2598EXPORT_SYMBOL(scsi_device_resume);
2599
2600static void
2601device_quiesce_fn(struct scsi_device *sdev, void *data)
2602{
2603 scsi_device_quiesce(sdev);
2604}
2605
2606void
2607scsi_target_quiesce(struct scsi_target *starget)
2608{
2609 starget_for_each_device(starget, NULL, device_quiesce_fn);
2610}
2611EXPORT_SYMBOL(scsi_target_quiesce);
2612
2613static void
2614device_resume_fn(struct scsi_device *sdev, void *data)
2615{
2616 scsi_device_resume(sdev);
2617}
2618
2619void
2620scsi_target_resume(struct scsi_target *starget)
2621{
2622 starget_for_each_device(starget, NULL, device_resume_fn);
2623}
2624EXPORT_SYMBOL(scsi_target_resume);
2625
2626/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002627 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2628 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002630 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002632 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002634 * Notes:
2635 * This routine transitions the device to the SDEV_BLOCK state (which must be
2636 * a legal transition). When the device is in this state, command processing
2637 * is paused until the device leaves the SDEV_BLOCK state. See also
2638 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002639 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002640int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641{
Jens Axboe165125e2007-07-24 09:28:11 +02002642 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 int err = 0;
2644
2645 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002646 if (err) {
2647 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2648
2649 if (err)
2650 return err;
2651 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652
2653 /*
2654 * The device has transitioned to SDEV_BLOCK. Stop the
2655 * block layer from calling the midlayer with this device's
2656 * request queue.
2657 */
Jens Axboef664a3c2018-11-01 16:36:27 -06002658 blk_mq_quiesce_queue_nowait(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659 return 0;
2660}
Bart Van Assche551eb592017-06-02 14:21:53 -07002661EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2662
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002664 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2665 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002667 * Pause SCSI command processing on the specified device and wait until all
2668 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002670 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002672 * Note:
2673 * This routine transitions the device to the SDEV_BLOCK state (which must be
2674 * a legal transition). When the device is in this state, command processing
2675 * is paused until the device leaves the SDEV_BLOCK state. See also
2676 * scsi_internal_device_unblock().
2677 *
2678 * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
2679 * scsi_internal_device_block() has blocked a SCSI device and also
2680 * remove the rport mutex lock and unlock calls from srp_queuecommand().
Rob Landleyeb448202007-11-03 13:30:39 -05002681 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002682static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683{
Bart Van Assche551eb592017-06-02 14:21:53 -07002684 struct request_queue *q = sdev->request_queue;
2685 int err;
2686
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002687 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07002688 err = scsi_internal_device_block_nowait(sdev);
Jens Axboef664a3c2018-11-01 16:36:27 -06002689 if (err == 0)
2690 blk_mq_quiesce_queue(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002691 mutex_unlock(&sdev->state_mutex);
2692
Bart Van Assche551eb592017-06-02 14:21:53 -07002693 return err;
2694}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695
Bart Van Assche66483a42017-06-02 14:21:56 -07002696void scsi_start_queue(struct scsi_device *sdev)
2697{
2698 struct request_queue *q = sdev->request_queue;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002699
Jens Axboef664a3c2018-11-01 16:36:27 -06002700 blk_mq_unquiesce_queue(q);
Bart Van Assche66483a42017-06-02 14:21:56 -07002701}
2702
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703/**
Bart Van Assche43f75712017-06-02 14:21:54 -07002704 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07002706 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002707 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002708 * Restart the device queue for a previously suspended SCSI device. Does not
2709 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002711 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002712 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002713 * Notes:
2714 * This routine transitions the device to the SDEV_RUNNING state or to one of
2715 * the offline states (which must be a legal transition) allowing the midlayer
2716 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717 */
Bart Van Assche43f75712017-06-02 14:21:54 -07002718int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2719 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002721 /*
2722 * Try to transition the scsi device to SDEV_RUNNING or one of the
2723 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002725 switch (sdev->sdev_state) {
2726 case SDEV_BLOCK:
2727 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002728 sdev->sdev_state = new_state;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002729 break;
2730 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002731 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2732 new_state == SDEV_OFFLINE)
2733 sdev->sdev_state = new_state;
2734 else
2735 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002736 break;
2737 case SDEV_CANCEL:
2738 case SDEV_OFFLINE:
2739 break;
2740 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002741 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002742 }
Bart Van Assche66483a42017-06-02 14:21:56 -07002743 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002744
2745 return 0;
2746}
Bart Van Assche43f75712017-06-02 14:21:54 -07002747EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2748
2749/**
2750 * scsi_internal_device_unblock - resume a device after a block request
2751 * @sdev: device to resume
2752 * @new_state: state to set the device to after unblocking
2753 *
2754 * Restart the device queue for a previously suspended SCSI device. May sleep.
2755 *
2756 * Returns zero if successful or a negative error code upon failure.
2757 *
2758 * Notes:
2759 * This routine transitions the device to the SDEV_RUNNING state or to one of
2760 * the offline states (which must be a legal transition) allowing the midlayer
2761 * to goose the queue for this device.
2762 */
2763static int scsi_internal_device_unblock(struct scsi_device *sdev,
2764 enum scsi_device_state new_state)
2765{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002766 int ret;
2767
2768 mutex_lock(&sdev->state_mutex);
2769 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2770 mutex_unlock(&sdev->state_mutex);
2771
2772 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07002773}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002774
2775static void
2776device_block(struct scsi_device *sdev, void *data)
2777{
Bart Van Assche551eb592017-06-02 14:21:53 -07002778 scsi_internal_device_block(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779}
2780
2781static int
2782target_block(struct device *dev, void *data)
2783{
2784 if (scsi_is_target_device(dev))
2785 starget_for_each_device(to_scsi_target(dev), NULL,
2786 device_block);
2787 return 0;
2788}
2789
2790void
2791scsi_target_block(struct device *dev)
2792{
2793 if (scsi_is_target_device(dev))
2794 starget_for_each_device(to_scsi_target(dev), NULL,
2795 device_block);
2796 else
2797 device_for_each_child(dev, NULL, target_block);
2798}
2799EXPORT_SYMBOL_GPL(scsi_target_block);
2800
2801static void
2802device_unblock(struct scsi_device *sdev, void *data)
2803{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002804 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805}
2806
2807static int
2808target_unblock(struct device *dev, void *data)
2809{
2810 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002811 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812 device_unblock);
2813 return 0;
2814}
2815
2816void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002817scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002818{
2819 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002820 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821 device_unblock);
2822 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002823 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824}
2825EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002826
2827/**
2828 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002829 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002830 * @sg_count: number of segments in sg
2831 * @offset: offset in bytes into sg, on return offset into the mapped area
2832 * @len: bytes to map, on return number of bytes mapped
2833 *
2834 * Returns virtual address of the start of the mapped page
2835 */
Jens Axboec6132da2007-10-16 11:08:49 +02002836void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002837 size_t *offset, size_t *len)
2838{
2839 int i;
2840 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002841 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002842 struct page *page;
2843
Andrew Morton22cfefb2007-02-05 16:39:03 -08002844 WARN_ON(!irqs_disabled());
2845
Jens Axboec6132da2007-10-16 11:08:49 +02002846 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002847 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002848 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002849 if (sg_len > *offset)
2850 break;
2851 }
2852
2853 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002854 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2855 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002856 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002857 WARN_ON(1);
2858 return NULL;
2859 }
2860
2861 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002862 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002863
2864 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002865 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002866 *offset &= ~PAGE_MASK;
2867
2868 /* Bytes in this sg-entry from *offset to the end of the page */
2869 sg_len = PAGE_SIZE - *offset;
2870 if (*len > sg_len)
2871 *len = sg_len;
2872
Cong Wang77dfce02011-11-25 23:14:23 +08002873 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002874}
2875EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2876
2877/**
Rob Landleyeb448202007-11-03 13:30:39 -05002878 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002879 * @virt: virtual address to be unmapped
2880 */
2881void scsi_kunmap_atomic_sg(void *virt)
2882{
Cong Wang77dfce02011-11-25 23:14:23 +08002883 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002884}
2885EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002886
2887void sdev_disable_disk_events(struct scsi_device *sdev)
2888{
2889 atomic_inc(&sdev->disk_events_disable_depth);
2890}
2891EXPORT_SYMBOL(sdev_disable_disk_events);
2892
2893void sdev_enable_disk_events(struct scsi_device *sdev)
2894{
2895 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2896 return;
2897 atomic_dec(&sdev->disk_events_disable_depth);
2898}
2899EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002900
2901/**
2902 * scsi_vpd_lun_id - return a unique device identification
2903 * @sdev: SCSI device
2904 * @id: buffer for the identification
2905 * @id_len: length of the buffer
2906 *
2907 * Copies a unique device identification into @id based
2908 * on the information in the VPD page 0x83 of the device.
2909 * The string will be formatted as a SCSI name string.
2910 *
2911 * Returns the length of the identification or error on failure.
2912 * If the identifier is longer than the supplied buffer the actual
2913 * identifier length is returned and the buffer is not zero-padded.
2914 */
2915int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
2916{
2917 u8 cur_id_type = 0xff;
2918 u8 cur_id_size = 0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002919 const unsigned char *d, *cur_id_str;
2920 const struct scsi_vpd *vpd_pg83;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002921 int id_size = -EINVAL;
2922
2923 rcu_read_lock();
2924 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
2925 if (!vpd_pg83) {
2926 rcu_read_unlock();
2927 return -ENXIO;
2928 }
2929
2930 /*
2931 * Look for the correct descriptor.
2932 * Order of preference for lun descriptor:
2933 * - SCSI name string
2934 * - NAA IEEE Registered Extended
2935 * - EUI-64 based 16-byte
2936 * - EUI-64 based 12-byte
2937 * - NAA IEEE Registered
2938 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02002939 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002940 * as longer descriptors reduce the likelyhood
2941 * of identification clashes.
2942 */
2943
2944 /* The id string must be at least 20 bytes + terminating NULL byte */
2945 if (id_len < 21) {
2946 rcu_read_unlock();
2947 return -EINVAL;
2948 }
2949
2950 memset(id, 0, id_len);
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002951 d = vpd_pg83->data + 4;
2952 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002953 /* Skip designators not referring to the LUN */
2954 if ((d[1] & 0x30) != 0x00)
2955 goto next_desig;
2956
2957 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02002958 case 0x1:
2959 /* T10 Vendor ID */
2960 if (cur_id_size > d[3])
2961 break;
2962 /* Prefer anything */
2963 if (cur_id_type > 0x01 && cur_id_type != 0xff)
2964 break;
2965 cur_id_size = d[3];
2966 if (cur_id_size + 4 > id_len)
2967 cur_id_size = id_len - 4;
2968 cur_id_str = d + 4;
2969 cur_id_type = d[1] & 0xf;
2970 id_size = snprintf(id, id_len, "t10.%*pE",
2971 cur_id_size, cur_id_str);
2972 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002973 case 0x2:
2974 /* EUI-64 */
2975 if (cur_id_size > d[3])
2976 break;
2977 /* Prefer NAA IEEE Registered Extended */
2978 if (cur_id_type == 0x3 &&
2979 cur_id_size == d[3])
2980 break;
2981 cur_id_size = d[3];
2982 cur_id_str = d + 4;
2983 cur_id_type = d[1] & 0xf;
2984 switch (cur_id_size) {
2985 case 8:
2986 id_size = snprintf(id, id_len,
2987 "eui.%8phN",
2988 cur_id_str);
2989 break;
2990 case 12:
2991 id_size = snprintf(id, id_len,
2992 "eui.%12phN",
2993 cur_id_str);
2994 break;
2995 case 16:
2996 id_size = snprintf(id, id_len,
2997 "eui.%16phN",
2998 cur_id_str);
2999 break;
3000 default:
3001 cur_id_size = 0;
3002 break;
3003 }
3004 break;
3005 case 0x3:
3006 /* NAA */
3007 if (cur_id_size > d[3])
3008 break;
3009 cur_id_size = d[3];
3010 cur_id_str = d + 4;
3011 cur_id_type = d[1] & 0xf;
3012 switch (cur_id_size) {
3013 case 8:
3014 id_size = snprintf(id, id_len,
3015 "naa.%8phN",
3016 cur_id_str);
3017 break;
3018 case 16:
3019 id_size = snprintf(id, id_len,
3020 "naa.%16phN",
3021 cur_id_str);
3022 break;
3023 default:
3024 cur_id_size = 0;
3025 break;
3026 }
3027 break;
3028 case 0x8:
3029 /* SCSI name string */
3030 if (cur_id_size + 4 > d[3])
3031 break;
3032 /* Prefer others for truncated descriptor */
3033 if (cur_id_size && d[3] > id_len)
3034 break;
3035 cur_id_size = id_size = d[3];
3036 cur_id_str = d + 4;
3037 cur_id_type = d[1] & 0xf;
3038 if (cur_id_size >= id_len)
3039 cur_id_size = id_len - 1;
3040 memcpy(id, cur_id_str, cur_id_size);
3041 /* Decrease priority for truncated descriptor */
3042 if (cur_id_size != id_size)
3043 cur_id_size = 6;
3044 break;
3045 default:
3046 break;
3047 }
3048next_desig:
3049 d += d[3] + 4;
3050 }
3051 rcu_read_unlock();
3052
3053 return id_size;
3054}
3055EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003056
3057/*
3058 * scsi_vpd_tpg_id - return a target port group identifier
3059 * @sdev: SCSI device
3060 *
3061 * Returns the Target Port Group identifier from the information
3062 * froom VPD page 0x83 of the device.
3063 *
3064 * Returns the identifier or error on failure.
3065 */
3066int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3067{
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003068 const unsigned char *d;
3069 const struct scsi_vpd *vpd_pg83;
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003070 int group_id = -EAGAIN, rel_port = -1;
3071
3072 rcu_read_lock();
3073 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3074 if (!vpd_pg83) {
3075 rcu_read_unlock();
3076 return -ENXIO;
3077 }
3078
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003079 d = vpd_pg83->data + 4;
3080 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003081 switch (d[1] & 0xf) {
3082 case 0x4:
3083 /* Relative target port */
3084 rel_port = get_unaligned_be16(&d[6]);
3085 break;
3086 case 0x5:
3087 /* Target port group */
3088 group_id = get_unaligned_be16(&d[6]);
3089 break;
3090 default:
3091 break;
3092 }
3093 d += d[3] + 4;
3094 }
3095 rcu_read_unlock();
3096
3097 if (group_id >= 0 && rel_id && rel_port != -1)
3098 *rel_id = rel_port;
3099
3100 return group_id;
3101}
3102EXPORT_SYMBOL(scsi_vpd_tpg_id);