blob: f8d51c3d5582ca40a6a671468aab306285f5ff23 [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:
Martin Wilck4a067cf2019-02-14 22:57:41 +0100658 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200659 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200660 case DID_ALLOC_FAILURE:
661 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200662 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200663 case DID_MEDIUM_ERROR:
664 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200665 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100666 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200667 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100668 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100669}
670
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200671/* Helper for scsi_io_completion() when "reprep" action required. */
672static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
673 struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674{
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200675 /* A new command will be prepared and issued. */
Jens Axboef664a3c2018-11-01 16:36:27 -0600676 scsi_mq_requeue_cmd(cmd);
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200677}
678
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200679/* Helper for scsi_io_completion() when special action required. */
680static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
Douglas Gilbertab831082018-06-23 12:22:16 +0200681{
Jens Axboe165125e2007-07-24 09:28:11 +0200682 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 struct request *req = cmd->request;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200684 int level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500685 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
686 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900687 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200688 struct scsi_sense_hdr sshdr;
689 bool sense_valid;
690 bool sense_current = true; /* false implies "deferred sense" */
691 blk_status_t blk_stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200693 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
694 if (sense_valid)
695 sense_current = !scsi_sense_is_deferred(&sshdr);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200696
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200697 blk_stat = scsi_result_to_blk_status(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500698
Alan Sternb60af5b2008-11-03 15:56:47 -0500699 if (host_byte(result) == DID_RESET) {
700 /* Third party bus reset or reset for error recovery
701 * reasons. Just retry the command and see what
702 * happens.
703 */
704 action = ACTION_RETRY;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200705 } else if (sense_valid && sense_current) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 switch (sshdr.sense_key) {
707 case UNIT_ATTENTION:
708 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700709 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 * and quietly refuse further access.
711 */
712 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500713 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700715 /* Must have been a power glitch, or a
716 * bus reset. Could not have been a
717 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500718 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700719 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500720 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 }
722 break;
723 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700724 /* If we had an ILLEGAL REQUEST returned, then
725 * we may have performed an unsupported
726 * command. The only thing this should be
727 * would be a ten byte read where only a six
728 * byte read was supported. Also, on a system
729 * where READ CAPACITY failed, we may have
730 * read past the end of the disk.
731 */
Jens Axboe26a68012005-11-29 21:03:34 +0100732 if ((cmd->device->use_10_for_rw &&
733 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 (cmd->cmnd[0] == READ_10 ||
735 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500736 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500738 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500739 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500740 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200741 blk_stat = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500742 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400743 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500744 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200745 blk_stat = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500746 } else
747 action = ACTION_FAIL;
748 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400749 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000750 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200751 if (sshdr.asc == 0x10) /* DIF */
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200752 blk_stat = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 break;
754 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700755 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500756 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500758 if (sshdr.asc == 0x04) {
759 switch (sshdr.ascq) {
760 case 0x01: /* becoming ready */
761 case 0x04: /* format in progress */
762 case 0x05: /* rebuild in progress */
763 case 0x06: /* recalculation in progress */
764 case 0x07: /* operation in progress */
765 case 0x08: /* Long write in progress */
766 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500767 case 0x14: /* space allocation in progress */
Douglas Gilberte37c7d92018-05-18 19:25:47 -0400768 case 0x1a: /* start stop unit in progress */
769 case 0x1b: /* sanitize in progress */
770 case 0x1d: /* configuration in progress */
771 case 0x24: /* depopulation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500772 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500773 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500774 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500775 action = ACTION_FAIL;
776 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500777 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200778 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500779 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500780 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700782 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500783 action = ACTION_FAIL;
784 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500786 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 break;
788 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200789 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500790 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500791
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900792 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200793 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900794 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900795
Alan Sternb60af5b2008-11-03 15:56:47 -0500796 switch (action) {
797 case ACTION_FAIL:
798 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200799 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200800 static DEFINE_RATELIMIT_STATE(_rs,
801 DEFAULT_RATELIMIT_INTERVAL,
802 DEFAULT_RATELIMIT_BURST);
803
804 if (unlikely(scsi_logging_level))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200805 level =
806 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
807 SCSI_LOG_MLCOMPLETE_BITS);
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200808
809 /*
810 * if logging is enabled the failure will be printed
811 * in scsi_log_completion(), so avoid duplicate messages
812 */
813 if (!level && __ratelimit(&_rs)) {
814 scsi_print_result(cmd, NULL, FAILED);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +0200815 if (driver_byte(result) == DRIVER_SENSE)
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200816 scsi_print_sense(cmd);
817 scsi_print_command(cmd);
818 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500819 }
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200820 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req), 0))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800821 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200822 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500823 case ACTION_REPREP:
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200824 scsi_io_completion_reprep(cmd, q);
Alan Sternb60af5b2008-11-03 15:56:47 -0500825 break;
826 case ACTION_RETRY:
827 /* Retry the same command immediately */
Bart Van Assche08640e82018-01-10 14:41:45 -0800828 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500829 break;
830 case ACTION_DELAYED_RETRY:
831 /* Retry the same command after a delay */
Bart Van Assche08640e82018-01-10 14:41:45 -0800832 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500833 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 }
835}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200837/*
838 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
839 * new result that may suppress further error checking. Also modifies
840 * *blk_statp in some cases.
841 */
842static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
843 blk_status_t *blk_statp)
844{
845 bool sense_valid;
846 bool sense_current = true; /* false implies "deferred sense" */
847 struct request *req = cmd->request;
848 struct scsi_sense_hdr sshdr;
849
850 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
851 if (sense_valid)
852 sense_current = !scsi_sense_is_deferred(&sshdr);
853
854 if (blk_rq_is_passthrough(req)) {
855 if (sense_valid) {
856 /*
857 * SG_IO wants current and deferred errors
858 */
859 scsi_req(req)->sense_len =
860 min(8 + cmd->sense_buffer[7],
861 SCSI_SENSE_BUFFERSIZE);
862 }
863 if (sense_current)
864 *blk_statp = scsi_result_to_blk_status(cmd, result);
865 } else if (blk_rq_bytes(req) == 0 && sense_current) {
866 /*
867 * Flush commands do not transfers any data, and thus cannot use
868 * good_bytes != blk_rq_bytes(req) as the signal for an error.
869 * This sets *blk_statp explicitly for the problem case.
870 */
871 *blk_statp = scsi_result_to_blk_status(cmd, result);
872 }
873 /*
874 * Recovered errors need reporting, but they're always treated as
875 * success, so fiddle the result code here. For passthrough requests
876 * we already took a copy of the original into sreq->result which
877 * is what gets returned to the user
878 */
879 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
880 bool do_print = true;
881 /*
882 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
883 * skip print since caller wants ATA registers. Only occurs
884 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
885 */
886 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
887 do_print = false;
888 else if (req->rq_flags & RQF_QUIET)
889 do_print = false;
890 if (do_print)
891 scsi_print_sense(cmd);
892 result = 0;
893 /* for passthrough, *blk_statp may be set */
894 *blk_statp = BLK_STS_OK;
895 }
896 /*
897 * Another corner case: the SCSI status byte is non-zero but 'good'.
898 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
899 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
900 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
901 * intermediate statuses (both obsolete in SAM-4) as good.
902 */
903 if (status_byte(result) && scsi_status_is_good(result)) {
904 result = 0;
905 *blk_statp = BLK_STS_OK;
906 }
907 return result;
908}
909
910/*
911 * Function: scsi_io_completion()
912 *
913 * Purpose: Completion processing for block device I/O requests.
914 *
915 * Arguments: cmd - command that is finished.
916 *
917 * Lock status: Assumed that no lock is held upon entry.
918 *
919 * Returns: Nothing
920 *
921 * Notes: We will finish off the specified number of sectors. If we
922 * are done, the command block will be released and the queue
923 * function will be goosed. If we are not done then we have to
924 * figure out what to do next:
925 *
926 * a) We can call scsi_requeue_command(). The request
927 * will be unprepared and put back on the queue. Then
928 * a new command will be created for it. This should
929 * be used if we made forward progress, or if we want
930 * to switch from READ(10) to READ(6) for example.
931 *
932 * b) We can call __scsi_queue_insert(). The request will
933 * be put back on the queue and retried using the same
934 * command as before, possibly after a delay.
935 *
936 * c) We can call scsi_end_request() with blk_stat other than
937 * BLK_STS_OK, to fail the remainder of the request.
938 */
939void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
940{
941 int result = cmd->result;
942 struct request_queue *q = cmd->device->request_queue;
943 struct request *req = cmd->request;
944 blk_status_t blk_stat = BLK_STS_OK;
945
Douglas Gilbert0d437902018-06-23 12:22:19 +0200946 if (unlikely(result)) /* a nz result may or may not be an error */
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200947 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
948
Douglas Gilbert0d437902018-06-23 12:22:19 +0200949 if (unlikely(blk_rq_is_passthrough(req))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200950 /*
951 * scsi_result_to_blk_status may have reset the host_byte
952 */
953 scsi_req(req)->result = cmd->result;
954 scsi_req(req)->resid_len = scsi_get_resid(cmd);
955
Douglas Gilbert0d437902018-06-23 12:22:19 +0200956 if (unlikely(scsi_bidi_cmnd(cmd))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200957 /*
958 * Bidi commands Must be complete as a whole,
959 * both sides at once.
960 */
961 scsi_req(req->next_rq)->resid_len = scsi_in(cmd)->resid;
962 if (scsi_end_request(req, BLK_STS_OK, blk_rq_bytes(req),
963 blk_rq_bytes(req->next_rq)))
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200964 WARN_ONCE(true,
965 "Bidi command with remaining bytes");
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200966 return;
967 }
968 }
969
Douglas Gilbert0d437902018-06-23 12:22:19 +0200970 /* no bidi support yet, other than in pass-through */
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200971 if (unlikely(blk_bidi_rq(req))) {
972 WARN_ONCE(true, "Only support bidi command in passthrough");
973 scmd_printk(KERN_ERR, cmd, "Killing bidi command\n");
974 if (scsi_end_request(req, BLK_STS_IOERR, blk_rq_bytes(req),
975 blk_rq_bytes(req->next_rq)))
976 WARN_ONCE(true, "Bidi command with remaining bytes");
977 return;
978 }
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200979
980 /*
981 * Next deal with any sectors which we were able to correctly
982 * handle.
983 */
984 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
985 "%u sectors total, %d bytes done.\n",
986 blk_rq_sectors(req), good_bytes));
987
988 /*
989 * Next deal with any sectors which we were able to correctly
990 * handle. Failed, zero length commands always need to drop down
991 * to retry code. Fast path should return in this block.
992 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200993 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
994 if (likely(!scsi_end_request(req, blk_stat, good_bytes, 0)))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200995 return; /* no bytes remaining */
996 }
997
Douglas Gilbert0d437902018-06-23 12:22:19 +0200998 /* Kill remainder if no retries. */
999 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +02001000 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req), 0))
Douglas Gilbert8e1695a02018-06-23 12:22:20 +02001001 WARN_ONCE(true,
1002 "Bytes remaining after failed, no-retry command");
Douglas Gilbertda32bae2018-06-23 12:22:17 +02001003 return;
1004 }
1005
1006 /*
1007 * If there had been no error, but we have leftover bytes in the
1008 * requeues just queue the command up again.
1009 */
Douglas Gilbert0d437902018-06-23 12:22:19 +02001010 if (likely(result == 0))
Douglas Gilbert4ae61c62018-06-23 12:22:18 +02001011 scsi_io_completion_reprep(cmd, q);
1012 else
Douglas Gilbertda32bae2018-06-23 12:22:17 +02001013 scsi_io_completion_action(cmd, result);
1014}
1015
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001016static blk_status_t scsi_init_sgtable(struct request *req,
1017 struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001019 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
1021 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001022 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001024 if (unlikely(sg_alloc_table_chained(&sdb->table,
1025 blk_rq_nr_phys_segments(req), sdb->table.sgl)))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001026 return BLK_STS_RESOURCE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 /*
1029 * Next, walk the list, and fill in the addresses and sizes of
1030 * each segment.
1031 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001032 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1033 BUG_ON(count > sdb->table.nents);
1034 sdb->table.nents = count;
Christoph Hellwigfd102b12017-01-13 12:29:11 +01001035 sdb->length = blk_rq_payload_bytes(req);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001036 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001038
1039/*
1040 * Function: scsi_init_io()
1041 *
1042 * Purpose: SCSI I/O initialize function.
1043 *
1044 * Arguments: cmd - Command descriptor we wish to initialize
1045 *
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001046 * Returns: BLK_STS_OK on success
1047 * BLK_STS_RESOURCE if the failure is retryable
1048 * BLK_STS_IOERR if the failure is fatal
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001049 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001050blk_status_t scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001051{
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001052 struct request *rq = cmd->request;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001053 blk_status_t ret;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001054
Johannes Thumshirnfd3fc0b2017-01-31 10:16:00 +01001055 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001056 return BLK_STS_IOERR;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001057
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001058 ret = scsi_init_sgtable(rq, &cmd->sdb);
1059 if (ret)
1060 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001061
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001062 if (blk_bidi_rq(rq)) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001063 ret = scsi_init_sgtable(rq->next_rq, rq->next_rq->special);
1064 if (ret)
Christoph Hellwig14784562018-11-09 14:42:38 +01001065 goto out_free_sgtables;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001066 }
1067
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001068 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001069 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1070 int ivecs, count;
1071
Christoph Hellwig14784562018-11-09 14:42:38 +01001072 if (WARN_ON_ONCE(!prot_sdb)) {
Ewan D. Milne91724c22015-01-15 10:02:12 -05001073 /*
1074 * This can happen if someone (e.g. multipath)
1075 * queues a command to a device on an adapter
1076 * that does not support DIX.
1077 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001078 ret = BLK_STS_IOERR;
Christoph Hellwig14784562018-11-09 14:42:38 +01001079 goto out_free_sgtables;
Ewan D. Milne91724c22015-01-15 10:02:12 -05001080 }
1081
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001082 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001083
Ming Lin001d63b2016-04-04 14:48:09 -07001084 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lin22cc3d42016-04-04 14:48:08 -07001085 prot_sdb->table.sgl)) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001086 ret = BLK_STS_RESOURCE;
Christoph Hellwig14784562018-11-09 14:42:38 +01001087 goto out_free_sgtables;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001088 }
1089
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001090 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001091 prot_sdb->table.sgl);
Igor Stoppa6f1d8a52018-09-05 23:47:20 +03001092 BUG_ON(count > ivecs);
1093 BUG_ON(count > queue_max_integrity_segments(rq->q));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001094
1095 cmd->prot_sdb = prot_sdb;
1096 cmd->prot_sdb->table.nents = count;
1097 }
1098
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001099 return BLK_STS_OK;
Christoph Hellwig14784562018-11-09 14:42:38 +01001100out_free_sgtables:
Jens Axboef664a3c2018-11-01 16:36:27 -06001101 scsi_mq_free_sgtables(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001102 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001103}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001104EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001106/**
Bart Van Assche832889f2017-08-30 16:58:40 -07001107 * scsi_initialize_rq - initialize struct scsi_cmnd partially
Jonathan Corbet35c05062017-08-24 16:11:09 -06001108 * @rq: Request associated with the SCSI command to be initialized.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001109 *
Bart Van Assche832889f2017-08-30 16:58:40 -07001110 * This function initializes the members of struct scsi_cmnd that must be
1111 * initialized before request processing starts and that won't be
1112 * reinitialized if a SCSI command is requeued.
1113 *
Bart Van Assche64104f72017-08-30 16:58:39 -07001114 * Called from inside blk_get_request() for pass-through requests and from
1115 * inside scsi_init_command() for filesystem requests.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001116 */
Bart Van Asschee4c94702017-12-07 15:59:31 -08001117static void scsi_initialize_rq(struct request *rq)
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001118{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001119 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1120
1121 scsi_req_init(&cmd->req);
Bart Van Assche3be88282018-02-22 11:30:20 -08001122 init_rcu_head(&cmd->rcu);
Bart Van Assche832889f2017-08-30 16:58:40 -07001123 cmd->jiffies_at_alloc = jiffies;
1124 cmd->retries = 0;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001125}
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001126
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001127/* Add a command to the list used by the aacraid and dpt_i2o drivers */
1128void scsi_add_cmd_to_list(struct scsi_cmnd *cmd)
1129{
1130 struct scsi_device *sdev = cmd->device;
1131 struct Scsi_Host *shost = sdev->host;
1132 unsigned long flags;
1133
1134 if (shost->use_cmd_list) {
1135 spin_lock_irqsave(&sdev->list_lock, flags);
1136 list_add_tail(&cmd->list, &sdev->cmd_list);
1137 spin_unlock_irqrestore(&sdev->list_lock, flags);
1138 }
1139}
1140
1141/* Remove a command from the list used by the aacraid and dpt_i2o drivers */
1142void scsi_del_cmd_from_list(struct scsi_cmnd *cmd)
1143{
1144 struct scsi_device *sdev = cmd->device;
1145 struct Scsi_Host *shost = sdev->host;
1146 unsigned long flags;
1147
1148 if (shost->use_cmd_list) {
1149 spin_lock_irqsave(&sdev->list_lock, flags);
1150 BUG_ON(list_empty(&cmd->list));
1151 list_del_init(&cmd->list);
1152 spin_unlock_irqrestore(&sdev->list_lock, flags);
1153 }
1154}
1155
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001156/* Called after a request has been started. */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001157void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001158{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001159 void *buf = cmd->sense_buffer;
1160 void *prot = cmd->prot_sdb;
Bart Van Assche64104f72017-08-30 16:58:39 -07001161 struct request *rq = blk_mq_rq_from_pdu(cmd);
1162 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
Bart Van Assche832889f2017-08-30 16:58:40 -07001163 unsigned long jiffies_at_alloc;
1164 int retries;
Bart Van Assche64104f72017-08-30 16:58:39 -07001165
1166 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1167 flags |= SCMD_INITIALIZED;
1168 scsi_initialize_rq(rq);
1169 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001170
Bart Van Assche832889f2017-08-30 16:58:40 -07001171 jiffies_at_alloc = cmd->jiffies_at_alloc;
1172 retries = cmd->retries;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001173 /* zero out the cmd, except for the embedded scsi_request */
1174 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001175 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001176
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001177 cmd->device = dev;
1178 cmd->sense_buffer = buf;
1179 cmd->prot_sdb = prot;
Bart Van Assche64104f72017-08-30 16:58:39 -07001180 cmd->flags = flags;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001181 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
Bart Van Assche832889f2017-08-30 16:58:40 -07001182 cmd->jiffies_at_alloc = jiffies_at_alloc;
1183 cmd->retries = retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001184
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001185 scsi_add_cmd_to_list(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001186}
1187
Christoph Hellwig785ba832018-11-09 14:42:37 +01001188static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1189 struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001190{
Bart Van Asschebed22132017-08-25 13:46:32 -07001191 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001192
1193 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001194 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001195 * a bio attached to them. Or they might contain a SCSI command
1196 * that does not transfer data, in which case they may optionally
1197 * submit a request without an attached bio.
1198 */
1199 if (req->bio) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001200 blk_status_t ret = scsi_init_io(cmd);
1201 if (unlikely(ret != BLK_STS_OK))
1202 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001203 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001204 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001205
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001206 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001207 }
James Bottomley7b163182005-12-15 20:17:02 -06001208
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001209 cmd->cmd_len = scsi_req(req)->cmd_len;
1210 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001211 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001212 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig785ba832018-11-09 14:42:37 +01001213 return BLK_STS_OK;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001214}
1215
1216/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001217 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001218 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001219 */
Christoph Hellwig785ba832018-11-09 14:42:37 +01001220static blk_status_t scsi_setup_fs_cmnd(struct scsi_device *sdev,
1221 struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001222{
Bart Van Asschebed22132017-08-25 13:46:32 -07001223 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001224
Christoph Hellwigee14c672015-08-27 14:16:59 +02001225 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
Christoph Hellwig4c1cb672018-11-09 14:42:40 +01001226 blk_status_t ret = sdev->handler->prep_fn(sdev, req);
1227 if (ret != BLK_STS_OK)
1228 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001229 }
1230
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001231 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001232 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001233 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001234}
James Bottomley7b163182005-12-15 20:17:02 -06001235
Christoph Hellwig785ba832018-11-09 14:42:37 +01001236static blk_status_t scsi_setup_cmnd(struct scsi_device *sdev,
1237 struct request *req)
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001238{
Bart Van Asschebed22132017-08-25 13:46:32 -07001239 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001240
1241 if (!blk_rq_bytes(req))
1242 cmd->sc_data_direction = DMA_NONE;
1243 else if (rq_data_dir(req) == WRITE)
1244 cmd->sc_data_direction = DMA_TO_DEVICE;
1245 else
1246 cmd->sc_data_direction = DMA_FROM_DEVICE;
1247
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001248 if (blk_rq_is_scsi(req))
1249 return scsi_setup_scsi_cmnd(sdev, req);
1250 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001251 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001252}
1253
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001254static blk_status_t
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001255scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256{
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001257 switch (sdev->sdev_state) {
1258 case SDEV_OFFLINE:
1259 case SDEV_TRANSPORT_OFFLINE:
1260 /*
1261 * If the device is offline we refuse to process any
1262 * commands. The device must be brought online
1263 * before trying any recovery commands.
1264 */
1265 sdev_printk(KERN_ERR, sdev,
1266 "rejecting I/O to offline device\n");
1267 return BLK_STS_IOERR;
1268 case SDEV_DEL:
1269 /*
1270 * If the device is fully deleted, we refuse to
1271 * process any commands as well.
1272 */
1273 sdev_printk(KERN_ERR, sdev,
1274 "rejecting I/O to dead device\n");
1275 return BLK_STS_IOERR;
1276 case SDEV_BLOCK:
1277 case SDEV_CREATED_BLOCK:
1278 return BLK_STS_RESOURCE;
1279 case SDEV_QUIESCE:
1280 /*
1281 * If the devices is blocked we defer normal commands.
1282 */
1283 if (req && !(req->rq_flags & RQF_PREEMPT))
1284 return BLK_STS_RESOURCE;
1285 return BLK_STS_OK;
1286 default:
1287 /*
1288 * For any other not fully online state we only allow
1289 * special commands. In particular any user initiated
1290 * command is not allowed.
1291 */
1292 if (req && !(req->rq_flags & RQF_PREEMPT))
1293 return BLK_STS_IOERR;
1294 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001296}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298/*
1299 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1300 * return 0.
1301 *
1302 * Called with the queue_lock held.
1303 */
1304static inline int scsi_dev_queue_ready(struct request_queue *q,
1305 struct scsi_device *sdev)
1306{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001307 unsigned int busy;
1308
1309 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001310 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001311 if (busy)
1312 goto out_dec;
1313
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 /*
1315 * unblock after device_blocked iterates to zero
1316 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001317 if (atomic_dec_return(&sdev->device_blocked) > 0)
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001318 goto out_dec;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001319 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1320 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001322
1323 if (busy >= sdev->queue_depth)
1324 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
1326 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001327out_dec:
1328 atomic_dec(&sdev->device_busy);
1329 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330}
1331
Mike Christief0c0a372008-08-17 15:24:38 -05001332/*
1333 * scsi_target_queue_ready: checks if there we can send commands to target
1334 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001335 */
1336static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1337 struct scsi_device *sdev)
1338{
1339 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001340 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001341
1342 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001343 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001344 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001345 starget->starget_sdev_user != sdev) {
1346 spin_unlock_irq(shost->host_lock);
1347 return 0;
1348 }
Mike Christief0c0a372008-08-17 15:24:38 -05001349 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001350 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001351 }
1352
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001353 if (starget->can_queue <= 0)
1354 return 1;
1355
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001356 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001357 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001358 if (busy)
1359 goto starved;
1360
Mike Christief0c0a372008-08-17 15:24:38 -05001361 /*
1362 * unblock after target_blocked iterates to zero
1363 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001364 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001365 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001366
1367 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1368 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001369 }
1370
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001371 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001372 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001373
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001374 return 1;
1375
1376starved:
1377 spin_lock_irq(shost->host_lock);
1378 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001379 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001380out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001381 if (starget->can_queue > 0)
1382 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001383 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001384}
1385
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386/*
1387 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1388 * return 0. We must end up running the queue again whenever 0 is
1389 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 */
1391static inline int scsi_host_queue_ready(struct request_queue *q,
1392 struct Scsi_Host *shost,
1393 struct scsi_device *sdev)
1394{
Christoph Hellwig74665012014-01-22 15:29:29 +01001395 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001396
James Bottomley939647e2005-09-18 15:05:20 -05001397 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001398 return 0;
1399
Ming Leid772a652018-08-27 15:24:43 +08001400 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001401 if (atomic_read(&shost->host_blocked) > 0) {
Ming Leid772a652018-08-27 15:24:43 +08001402 if (busy)
Christoph Hellwig74665012014-01-22 15:29:29 +01001403 goto starved;
1404
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 /*
1406 * unblock after host_blocked iterates to zero
1407 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001408 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001409 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001410
1411 SCSI_LOG_MLQUEUE(3,
1412 shost_printk(KERN_INFO, shost,
1413 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001415
Ming Leid772a652018-08-27 15:24:43 +08001416 if (shost->can_queue > 0 && busy >= shost->can_queue)
Christoph Hellwig74665012014-01-22 15:29:29 +01001417 goto starved;
1418 if (shost->host_self_blocked)
1419 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
1421 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001422 if (!list_empty(&sdev->starved_entry)) {
1423 spin_lock_irq(shost->host_lock);
1424 if (!list_empty(&sdev->starved_entry))
1425 list_del_init(&sdev->starved_entry);
1426 spin_unlock_irq(shost->host_lock);
1427 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
Christoph Hellwig74665012014-01-22 15:29:29 +01001429 return 1;
1430
1431starved:
1432 spin_lock_irq(shost->host_lock);
1433 if (list_empty(&sdev->starved_entry))
1434 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001435 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001436out_dec:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001437 scsi_dec_host_busy(shost);
Christoph Hellwig74665012014-01-22 15:29:29 +01001438 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439}
1440
1441/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001442 * Busy state exporting function for request stacking drivers.
1443 *
1444 * For efficiency, no lock is taken to check the busy state of
1445 * shost/starget/sdev, since the returned value is not guaranteed and
1446 * may be changed after request stacking drivers call the function,
1447 * regardless of taking lock or not.
1448 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001449 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1450 * needs to return 'not busy'. Otherwise, request stacking drivers
1451 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001452 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001453static bool scsi_mq_lld_busy(struct request_queue *q)
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001454{
1455 struct scsi_device *sdev = q->queuedata;
1456 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001457
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001458 if (blk_queue_dying(q))
Jens Axboef664a3c2018-11-01 16:36:27 -06001459 return false;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001460
1461 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001462
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001463 /*
1464 * Ignore host/starget busy state.
1465 * Since block layer does not have a concept of fairness across
1466 * multiple queues, congestion of host/starget needs to be handled
1467 * in SCSI layer.
1468 */
1469 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Jens Axboef664a3c2018-11-01 16:36:27 -06001470 return true;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001471
Jens Axboef664a3c2018-11-01 16:36:27 -06001472 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473}
1474
Jens Axboe1aea6432006-01-09 16:03:03 +01001475static void scsi_softirq_done(struct request *rq)
1476{
Bart Van Asschebed22132017-08-25 13:46:32 -07001477 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001478 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001479 int disposition;
1480
1481 INIT_LIST_HEAD(&cmd->eh_entry);
1482
Jens Axboe242f9dc2008-09-14 05:55:09 -07001483 atomic_inc(&cmd->device->iodone_cnt);
1484 if (cmd->result)
1485 atomic_inc(&cmd->device->ioerr_cnt);
1486
Jens Axboe1aea6432006-01-09 16:03:03 +01001487 disposition = scsi_decide_disposition(cmd);
1488 if (disposition != SUCCESS &&
1489 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1490 sdev_printk(KERN_ERR, cmd->device,
1491 "timing out command, waited %lus\n",
1492 wait_for/HZ);
1493 disposition = SUCCESS;
1494 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001495
Jens Axboe1aea6432006-01-09 16:03:03 +01001496 scsi_log_completion(cmd, disposition);
1497
1498 switch (disposition) {
1499 case SUCCESS:
1500 scsi_finish_command(cmd);
1501 break;
1502 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001503 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001504 break;
1505 case ADD_TO_MLQUEUE:
1506 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1507 break;
1508 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001509 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001510 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001511 }
1512}
1513
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001514/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001515 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1516 * @cmd: command block we are dispatching.
1517 *
1518 * Return: nonzero return request was rejected and device's queue needs to be
1519 * plugged.
1520 */
1521static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1522{
1523 struct Scsi_Host *host = cmd->device->host;
1524 int rtn = 0;
1525
1526 atomic_inc(&cmd->device->iorequest_cnt);
1527
1528 /* check if the device is still usable */
1529 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1530 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1531 * returns an immediate error upwards, and signals
1532 * that the device is no longer present */
1533 cmd->result = DID_NO_CONNECT << 16;
1534 goto done;
1535 }
1536
1537 /* Check to see if the scsi lld made this device blocked. */
1538 if (unlikely(scsi_device_blocked(cmd->device))) {
1539 /*
1540 * in blocked state, the command is just put back on
1541 * the device queue. The suspend state has already
1542 * blocked the queue so future requests should not
1543 * occur until the device transitions out of the
1544 * suspend state.
1545 */
1546 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1547 "queuecommand : device blocked\n"));
1548 return SCSI_MLQUEUE_DEVICE_BUSY;
1549 }
1550
1551 /* Store the LUN value in cmnd, if needed. */
1552 if (cmd->device->lun_in_cdb)
1553 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1554 (cmd->device->lun << 5 & 0xe0);
1555
1556 scsi_log_send(cmd);
1557
1558 /*
1559 * Before we queue this command, check if the command
1560 * length exceeds what the host adapter can handle.
1561 */
1562 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1563 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1564 "queuecommand : command too long. "
1565 "cdb_size=%d host->max_cmd_len=%d\n",
1566 cmd->cmd_len, cmd->device->host->max_cmd_len));
1567 cmd->result = (DID_ABORT << 16);
1568 goto done;
1569 }
1570
1571 if (unlikely(host->shost_state == SHOST_DEL)) {
1572 cmd->result = (DID_NO_CONNECT << 16);
1573 goto done;
1574
1575 }
1576
1577 trace_scsi_dispatch_cmd_start(cmd);
1578 rtn = host->hostt->queuecommand(host, cmd);
1579 if (rtn) {
1580 trace_scsi_dispatch_cmd_error(cmd, rtn);
1581 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1582 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1583 rtn = SCSI_MLQUEUE_HOST_BUSY;
1584
1585 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1586 "queuecommand : request rejected\n"));
1587 }
1588
1589 return rtn;
1590 done:
1591 cmd->scsi_done(cmd);
1592 return 0;
1593}
1594
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001595/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
1596static unsigned int scsi_mq_sgl_size(struct Scsi_Host *shost)
1597{
1598 return min_t(unsigned int, shost->sg_tablesize, SG_CHUNK_SIZE) *
1599 sizeof(struct scatterlist);
1600}
1601
Christoph Hellwig785ba832018-11-09 14:42:37 +01001602static blk_status_t scsi_mq_prep_fn(struct request *req)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001603{
1604 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1605 struct scsi_device *sdev = req->q->queuedata;
1606 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001607 struct scatterlist *sg;
1608
Bart Van Assche08f78432017-06-02 14:22:00 -07001609 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001610
1611 req->special = cmd;
1612
1613 cmd->request = req;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001614
1615 cmd->tag = req->tag;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001616 cmd->prot_op = SCSI_PROT_NORMAL;
1617
Christoph Hellwigd2852032014-01-17 12:06:53 +01001618 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1619 cmd->sdb.table.sgl = sg;
1620
1621 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001622 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1623
1624 cmd->prot_sdb->table.sgl =
1625 (struct scatterlist *)(cmd->prot_sdb + 1);
1626 }
1627
1628 if (blk_bidi_rq(req)) {
1629 struct request *next_rq = req->next_rq;
1630 struct scsi_data_buffer *bidi_sdb = blk_mq_rq_to_pdu(next_rq);
1631
1632 memset(bidi_sdb, 0, sizeof(struct scsi_data_buffer));
1633 bidi_sdb->table.sgl =
1634 (struct scatterlist *)(bidi_sdb + 1);
1635
1636 next_rq->special = bidi_sdb;
1637 }
1638
Christoph Hellwigfe052522014-09-22 15:59:31 +02001639 blk_mq_start_request(req);
1640
Bart Van Assche8fe8ffb2017-10-20 11:46:45 -07001641 return scsi_setup_cmnd(sdev, req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001642}
1643
1644static void scsi_mq_done(struct scsi_cmnd *cmd)
1645{
Keith Buschf1342702018-11-26 09:54:29 -07001646 if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state)))
1647 return;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001648 trace_scsi_dispatch_cmd_done(cmd);
Keith Buschf1342702018-11-26 09:54:29 -07001649
1650 /*
1651 * If the block layer didn't complete the request due to a timeout
1652 * injection, scsi must clear its internal completed state so that the
1653 * timeout handler will see it needs to escalate its own error
1654 * recovery.
1655 */
1656 if (unlikely(!blk_mq_complete_request(cmd->request)))
1657 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001658}
1659
Ming Lei0df21c82017-10-14 17:22:32 +08001660static void scsi_mq_put_budget(struct blk_mq_hw_ctx *hctx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001661{
Ming Lei0df21c82017-10-14 17:22:32 +08001662 struct request_queue *q = hctx->queue;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001663 struct scsi_device *sdev = q->queuedata;
Ming Lei0df21c82017-10-14 17:22:32 +08001664
Ming Lei0df21c82017-10-14 17:22:32 +08001665 atomic_dec(&sdev->device_busy);
1666 put_device(&sdev->sdev_gendev);
1667}
1668
Ming Lei88022d72017-11-05 02:21:12 +08001669static bool scsi_mq_get_budget(struct blk_mq_hw_ctx *hctx)
Ming Lei0df21c82017-10-14 17:22:32 +08001670{
1671 struct request_queue *q = hctx->queue;
1672 struct scsi_device *sdev = q->queuedata;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001673
Christoph Hellwigd2852032014-01-17 12:06:53 +01001674 if (!get_device(&sdev->sdev_gendev))
1675 goto out;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001676 if (!scsi_dev_queue_ready(q, sdev))
1677 goto out_put_device;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001678
Ming Lei88022d72017-11-05 02:21:12 +08001679 return true;
Ming Lei0df21c82017-10-14 17:22:32 +08001680
Ming Lei0df21c82017-10-14 17:22:32 +08001681out_put_device:
1682 put_device(&sdev->sdev_gendev);
1683out:
Ming Lei7e70aa72017-12-05 15:52:56 +08001684 if (atomic_read(&sdev->device_busy) == 0 && !scsi_device_blocked(sdev))
1685 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Ming Lei88022d72017-11-05 02:21:12 +08001686 return false;
Ming Lei0df21c82017-10-14 17:22:32 +08001687}
1688
Christoph Hellwigd2852032014-01-17 12:06:53 +01001689static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1690 const struct blk_mq_queue_data *bd)
1691{
1692 struct request *req = bd->rq;
1693 struct request_queue *q = req->q;
1694 struct scsi_device *sdev = q->queuedata;
1695 struct Scsi_Host *shost = sdev->host;
1696 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1697 blk_status_t ret;
1698 int reason;
1699
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001700 /*
1701 * If the device is not in running state we will reject some or all
1702 * commands.
1703 */
1704 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1705 ret = scsi_prep_state_check(sdev, req);
1706 if (ret != BLK_STS_OK)
1707 goto out_put_budget;
1708 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001709
1710 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001711 if (!scsi_target_queue_ready(shost, sdev))
Ming Lei826a70a2017-11-04 09:55:34 +08001712 goto out_put_budget;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001713 if (!scsi_host_queue_ready(q, shost, sdev))
1714 goto out_dec_target_busy;
1715
Keith Buschf1342702018-11-26 09:54:29 -07001716 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwige8064022016-10-20 15:12:13 +02001717 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwig785ba832018-11-09 14:42:37 +01001718 ret = scsi_mq_prep_fn(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001719 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001720 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001721 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001722 } else {
1723 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001724 }
1725
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001726 if (sdev->simple_tags)
1727 cmd->flags |= SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001728 else
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001729 cmd->flags &= ~SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001730
Christoph Hellwigd2852032014-01-17 12:06:53 +01001731 scsi_init_cmd_errh(cmd);
1732 cmd->scsi_done = scsi_mq_done;
1733
1734 reason = scsi_dispatch_cmd(cmd);
1735 if (reason) {
1736 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001737 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001738 goto out_dec_host_busy;
1739 }
1740
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001741 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001742
1743out_dec_host_busy:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001744 scsi_dec_host_busy(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001745out_dec_target_busy:
1746 if (scsi_target(sdev)->can_queue > 0)
1747 atomic_dec(&scsi_target(sdev)->target_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001748out_put_budget:
1749 scsi_mq_put_budget(hctx);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001750 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001751 case BLK_STS_OK:
1752 break;
1753 case BLK_STS_RESOURCE:
Ming Lei86ff7c22018-01-30 22:04:57 -05001754 if (atomic_read(&sdev->device_busy) ||
1755 scsi_device_blocked(sdev))
1756 ret = BLK_STS_DEV_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001757 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001758 default:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001759 /*
1760 * Make sure to release all allocated ressources when
1761 * we hit an error, as we will never see this command
1762 * again.
1763 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001764 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001765 scsi_mq_uninit_cmd(cmd);
1766 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001767 }
1768 return ret;
1769}
1770
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001771static enum blk_eh_timer_return scsi_timeout(struct request *req,
1772 bool reserved)
1773{
1774 if (reserved)
1775 return BLK_EH_RESET_TIMER;
1776 return scsi_times_out(req);
1777}
1778
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001779static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1780 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001781{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001782 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07001783 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001784 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07001785 struct scatterlist *sg;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001786
Bart Van Assche8e688252017-06-02 14:21:52 -07001787 if (unchecked_isa_dma)
1788 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
1789 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
1790 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001791 if (!cmd->sense_buffer)
1792 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001793 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07001794
1795 if (scsi_host_get_prot(shost)) {
1796 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1797 shost->hostt->cmd_size;
1798 cmd->prot_sdb = (void *)sg + scsi_mq_sgl_size(shost);
1799 }
1800
Christoph Hellwigd2852032014-01-17 12:06:53 +01001801 return 0;
1802}
1803
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001804static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
1805 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001806{
1807 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1808
Bart Van Assche8e688252017-06-02 14:21:52 -07001809 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
1810 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001811}
1812
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001813static int scsi_map_queues(struct blk_mq_tag_set *set)
1814{
1815 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1816
1817 if (shost->hostt->map_queues)
1818 return shost->hostt->map_queues(shost);
Jens Axboeed76e322018-10-29 13:06:14 -06001819 return blk_mq_map_queues(&set->map[0]);
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001820}
1821
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001822void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823{
Lin Ming6f381fa2012-04-12 13:50:38 +08001824 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825
Jens Axboea8474ce2007-08-07 09:02:51 +02001826 /*
1827 * this limit is imposed by hardware restrictions
1828 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001829 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07001830 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001831
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001832 if (scsi_host_prot_dma(shost)) {
1833 shost->sg_prot_tablesize =
1834 min_not_zero(shost->sg_prot_tablesize,
1835 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1836 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1837 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1838 }
1839
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001840 blk_queue_max_hw_sectors(q, shost->max_sectors);
Christoph Hellwig21e07db2018-04-03 19:09:59 +02001841 if (shost->unchecked_isa_dma)
1842 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001844 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845
Christoph Hellwiga8cf59a2019-01-16 17:12:15 +01001846 blk_queue_max_segment_size(q, shost->max_segment_size);
1847 dma_set_max_seg_size(dev, shost->max_segment_size);
James Bottomley465ff312008-01-01 10:00:10 -06001848
1849 /*
Huacai Chen90addc62017-11-21 14:23:38 +01001850 * Set a reasonable default alignment: The larger of 32-byte (dword),
1851 * which is a common minimum for HBAs, and the minimum DMA alignment,
1852 * which is set by the platform.
1853 *
1854 * Devices that require a bigger alignment can increase it later.
James Bottomley465ff312008-01-01 10:00:10 -06001855 */
Huacai Chen90addc62017-11-21 14:23:38 +01001856 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001857}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001858EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06001859
Eric Biggersf363b082017-03-30 13:39:16 -07001860static const struct blk_mq_ops scsi_mq_ops = {
Ming Lei0df21c82017-10-14 17:22:32 +08001861 .get_budget = scsi_mq_get_budget,
1862 .put_budget = scsi_mq_put_budget,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001863 .queue_rq = scsi_queue_rq,
1864 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001865 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07001866#ifdef CONFIG_BLK_DEBUG_FS
1867 .show_rq = scsi_show_rq,
1868#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001869 .init_request = scsi_mq_init_request,
1870 .exit_request = scsi_mq_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001871 .initialize_rq_fn = scsi_initialize_rq,
Jens Axboe3a7ea2c42018-10-29 10:17:28 -06001872 .busy = scsi_mq_lld_busy,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001873 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001874};
1875
1876struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
1877{
1878 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
1879 if (IS_ERR(sdev->request_queue))
1880 return NULL;
1881
1882 sdev->request_queue->queuedata = sdev;
1883 __scsi_init_queue(sdev->host, sdev->request_queue);
Christoph Hellwig17cb9602018-03-13 17:28:41 +01001884 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001885 return sdev->request_queue;
1886}
1887
1888int scsi_mq_setup_tags(struct Scsi_Host *shost)
1889{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001890 unsigned int cmd_size, sgl_size;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001891
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001892 sgl_size = scsi_mq_sgl_size(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001893 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1894 if (scsi_host_get_prot(shost))
1895 cmd_size += sizeof(struct scsi_data_buffer) + sgl_size;
1896
1897 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
1898 shost->tag_set.ops = &scsi_mq_ops;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01001899 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001900 shost->tag_set.queue_depth = shost->can_queue;
1901 shost->tag_set.cmd_size = cmd_size;
1902 shost->tag_set.numa_node = NUMA_NO_NODE;
1903 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07001904 shost->tag_set.flags |=
1905 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001906 shost->tag_set.driver_data = shost;
1907
1908 return blk_mq_alloc_tag_set(&shost->tag_set);
1909}
1910
1911void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1912{
1913 blk_mq_free_tag_set(&shost->tag_set);
1914}
1915
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001916/**
1917 * scsi_device_from_queue - return sdev associated with a request_queue
1918 * @q: The request queue to return the sdev from
1919 *
1920 * Return the sdev associated with a request queue or NULL if the
1921 * request_queue does not reference a SCSI device.
1922 */
1923struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1924{
1925 struct scsi_device *sdev = NULL;
1926
Jens Axboef664a3c2018-11-01 16:36:27 -06001927 if (q->mq_ops == &scsi_mq_ops)
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001928 sdev = q->queuedata;
1929 if (!sdev || !get_device(&sdev->sdev_gendev))
1930 sdev = NULL;
1931
1932 return sdev;
1933}
1934EXPORT_SYMBOL_GPL(scsi_device_from_queue);
1935
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936/*
1937 * Function: scsi_block_requests()
1938 *
1939 * Purpose: Utility function used by low-level drivers to prevent further
1940 * commands from being queued to the device.
1941 *
1942 * Arguments: shost - Host in question
1943 *
1944 * Returns: Nothing
1945 *
1946 * Lock status: No locks are assumed held.
1947 *
1948 * Notes: There is no timer nor any other means by which the requests
1949 * get unblocked other than the low-level driver calling
1950 * scsi_unblock_requests().
1951 */
1952void scsi_block_requests(struct Scsi_Host *shost)
1953{
1954 shost->host_self_blocked = 1;
1955}
1956EXPORT_SYMBOL(scsi_block_requests);
1957
1958/*
1959 * Function: scsi_unblock_requests()
1960 *
1961 * Purpose: Utility function used by low-level drivers to allow further
1962 * commands from being queued to the device.
1963 *
1964 * Arguments: shost - Host in question
1965 *
1966 * Returns: Nothing
1967 *
1968 * Lock status: No locks are assumed held.
1969 *
1970 * Notes: There is no timer nor any other means by which the requests
1971 * get unblocked other than the low-level driver calling
1972 * scsi_unblock_requests().
1973 *
1974 * This is done as an API function so that changes to the
1975 * internals of the scsi mid-layer won't require wholesale
1976 * changes to drivers that use this feature.
1977 */
1978void scsi_unblock_requests(struct Scsi_Host *shost)
1979{
1980 shost->host_self_blocked = 0;
1981 scsi_run_host_queues(shost);
1982}
1983EXPORT_SYMBOL(scsi_unblock_requests);
1984
1985int __init scsi_init_queue(void)
1986{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001987 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1988 sizeof(struct scsi_data_buffer),
1989 0, 0, NULL);
1990 if (!scsi_sdb_cache) {
1991 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001992 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001993 }
1994
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 return 0;
1996}
1997
1998void scsi_exit_queue(void)
1999{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002000 kmem_cache_destroy(scsi_sense_cache);
2001 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04002002 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003}
James Bottomley5baba832006-03-18 14:10:35 -06002004
2005/**
2006 * scsi_mode_select - issue a mode select
2007 * @sdev: SCSI device to be queried
2008 * @pf: Page format bit (1 == standard, 0 == vendor specific)
2009 * @sp: Save page bit (0 == don't save, 1 == save)
2010 * @modepage: mode page being requested
2011 * @buffer: request buffer (may not be smaller than eight bytes)
2012 * @len: length of request buffer.
2013 * @timeout: command timeout
2014 * @retries: number of retries before failing
2015 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002016 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06002017 * must be SCSI_SENSE_BUFFERSIZE big.
2018 *
2019 * Returns zero if successful; negative error number or scsi
2020 * status on error
2021 *
2022 */
2023int
2024scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2025 unsigned char *buffer, int len, int timeout, int retries,
2026 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2027{
2028 unsigned char cmd[10];
2029 unsigned char *real_buffer;
2030 int ret;
2031
2032 memset(cmd, 0, sizeof(cmd));
2033 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2034
2035 if (sdev->use_10_for_ms) {
2036 if (len > 65535)
2037 return -EINVAL;
2038 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2039 if (!real_buffer)
2040 return -ENOMEM;
2041 memcpy(real_buffer + 8, buffer, len);
2042 len += 8;
2043 real_buffer[0] = 0;
2044 real_buffer[1] = 0;
2045 real_buffer[2] = data->medium_type;
2046 real_buffer[3] = data->device_specific;
2047 real_buffer[4] = data->longlba ? 0x01 : 0;
2048 real_buffer[5] = 0;
2049 real_buffer[6] = data->block_descriptor_length >> 8;
2050 real_buffer[7] = data->block_descriptor_length;
2051
2052 cmd[0] = MODE_SELECT_10;
2053 cmd[7] = len >> 8;
2054 cmd[8] = len;
2055 } else {
2056 if (len > 255 || data->block_descriptor_length > 255 ||
2057 data->longlba)
2058 return -EINVAL;
2059
2060 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2061 if (!real_buffer)
2062 return -ENOMEM;
2063 memcpy(real_buffer + 4, buffer, len);
2064 len += 4;
2065 real_buffer[0] = 0;
2066 real_buffer[1] = data->medium_type;
2067 real_buffer[2] = data->device_specific;
2068 real_buffer[3] = data->block_descriptor_length;
2069
2070
2071 cmd[0] = MODE_SELECT;
2072 cmd[4] = len;
2073 }
2074
2075 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002076 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002077 kfree(real_buffer);
2078 return ret;
2079}
2080EXPORT_SYMBOL_GPL(scsi_mode_select);
2081
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082/**
Rob Landleyeb448202007-11-03 13:30:39 -05002083 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002084 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 * @dbd: set if mode sense will allow block descriptors to be returned
2086 * @modepage: mode page being requested
2087 * @buffer: request buffer (may not be smaller than eight bytes)
2088 * @len: length of request buffer.
2089 * @timeout: command timeout
2090 * @retries: number of retries before failing
2091 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002092 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002093 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 *
2095 * Returns zero if unsuccessful, or the header offset (either 4
2096 * or 8 depending on whether a six or ten byte command was
2097 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002098 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099int
James Bottomley1cf72692005-08-28 11:27:01 -05002100scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002102 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2103{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 unsigned char cmd[12];
2105 int use_10_for_ms;
2106 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002107 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002108 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109
2110 memset(data, 0, sizeof(*data));
2111 memset(&cmd[0], 0, 12);
2112 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2113 cmd[2] = modepage;
2114
James Bottomleyea73a9f2005-08-28 11:33:52 -05002115 /* caller might not be interested in sense, but we need it */
2116 if (!sshdr)
2117 sshdr = &my_sshdr;
2118
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002120 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121
2122 if (use_10_for_ms) {
2123 if (len < 8)
2124 len = 8;
2125
2126 cmd[0] = MODE_SENSE_10;
2127 cmd[8] = len;
2128 header_length = 8;
2129 } else {
2130 if (len < 4)
2131 len = 4;
2132
2133 cmd[0] = MODE_SENSE;
2134 cmd[4] = len;
2135 header_length = 4;
2136 }
2137
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 memset(buffer, 0, len);
2139
James Bottomley1cf72692005-08-28 11:27:01 -05002140 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002141 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142
2143 /* This code looks awful: what it's doing is making sure an
2144 * ILLEGAL REQUEST sense return identifies the actual command
2145 * byte as the problem. MODE_SENSE commands can return
2146 * ILLEGAL REQUEST if the code page isn't supported */
2147
James Bottomley1cf72692005-08-28 11:27:01 -05002148 if (use_10_for_ms && !scsi_status_is_good(result) &&
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002149 driver_byte(result) == DRIVER_SENSE) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002150 if (scsi_sense_valid(sshdr)) {
2151 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2152 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 /*
2154 * Invalid command operation code
2155 */
James Bottomley1cf72692005-08-28 11:27:01 -05002156 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 goto retry;
2158 }
2159 }
2160 }
2161
James Bottomley1cf72692005-08-28 11:27:01 -05002162 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002163 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2164 (modepage == 6 || modepage == 8))) {
2165 /* Initio breakage? */
2166 header_length = 0;
2167 data->length = 13;
2168 data->medium_type = 0;
2169 data->device_specific = 0;
2170 data->longlba = 0;
2171 data->block_descriptor_length = 0;
2172 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 data->length = buffer[0]*256 + buffer[1] + 2;
2174 data->medium_type = buffer[2];
2175 data->device_specific = buffer[3];
2176 data->longlba = buffer[4] & 0x01;
2177 data->block_descriptor_length = buffer[6]*256
2178 + buffer[7];
2179 } else {
2180 data->length = buffer[0] + 1;
2181 data->medium_type = buffer[1];
2182 data->device_specific = buffer[2];
2183 data->block_descriptor_length = buffer[3];
2184 }
Al Viro6d73c852006-02-23 02:03:16 +01002185 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002186 } else if ((status_byte(result) == CHECK_CONDITION) &&
2187 scsi_sense_valid(sshdr) &&
2188 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2189 retry_count--;
2190 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 }
2192
James Bottomley1cf72692005-08-28 11:27:01 -05002193 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194}
2195EXPORT_SYMBOL(scsi_mode_sense);
2196
James Bottomley001aac22007-12-02 19:10:40 +02002197/**
2198 * scsi_test_unit_ready - test if unit is ready
2199 * @sdev: scsi device to change the state of.
2200 * @timeout: command timeout
2201 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002202 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002203 *
2204 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002205 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002206 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207int
James Bottomley001aac22007-12-02 19:10:40 +02002208scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002209 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211 char cmd[] = {
2212 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2213 };
2214 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002215
James Bottomley001aac22007-12-02 19:10:40 +02002216 /* try to eat the UNIT_ATTENTION if there are enough retries */
2217 do {
2218 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
Bart Van Assche9b91fd32018-02-12 10:57:52 -08002219 timeout, 1, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002220 if (sdev->removable && scsi_sense_valid(sshdr) &&
2221 sshdr->sense_key == UNIT_ATTENTION)
2222 sdev->changed = 1;
2223 } while (scsi_sense_valid(sshdr) &&
2224 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002225
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 return result;
2227}
2228EXPORT_SYMBOL(scsi_test_unit_ready);
2229
2230/**
Rob Landleyeb448202007-11-03 13:30:39 -05002231 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 * @sdev: scsi device to change the state of.
2233 * @state: state to change to.
2234 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002235 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002237 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238int
2239scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2240{
2241 enum scsi_device_state oldstate = sdev->sdev_state;
2242
2243 if (state == oldstate)
2244 return 0;
2245
2246 switch (state) {
2247 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002248 switch (oldstate) {
2249 case SDEV_CREATED_BLOCK:
2250 break;
2251 default:
2252 goto illegal;
2253 }
2254 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255
2256 case SDEV_RUNNING:
2257 switch (oldstate) {
2258 case SDEV_CREATED:
2259 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002260 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 case SDEV_QUIESCE:
2262 case SDEV_BLOCK:
2263 break;
2264 default:
2265 goto illegal;
2266 }
2267 break;
2268
2269 case SDEV_QUIESCE:
2270 switch (oldstate) {
2271 case SDEV_RUNNING:
2272 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002273 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 break;
2275 default:
2276 goto illegal;
2277 }
2278 break;
2279
2280 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002281 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282 switch (oldstate) {
2283 case SDEV_CREATED:
2284 case SDEV_RUNNING:
2285 case SDEV_QUIESCE:
2286 case SDEV_BLOCK:
2287 break;
2288 default:
2289 goto illegal;
2290 }
2291 break;
2292
2293 case SDEV_BLOCK:
2294 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002296 case SDEV_CREATED_BLOCK:
Hannes Reineckea33e5bf2018-10-07 10:35:35 +02002297 case SDEV_OFFLINE:
James Bottomley6f4267e2008-08-22 16:53:31 -05002298 break;
2299 default:
2300 goto illegal;
2301 }
2302 break;
2303
2304 case SDEV_CREATED_BLOCK:
2305 switch (oldstate) {
2306 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 break;
2308 default:
2309 goto illegal;
2310 }
2311 break;
2312
2313 case SDEV_CANCEL:
2314 switch (oldstate) {
2315 case SDEV_CREATED:
2316 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002317 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002319 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 break;
2321 default:
2322 goto illegal;
2323 }
2324 break;
2325
2326 case SDEV_DEL:
2327 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002328 case SDEV_CREATED:
2329 case SDEV_RUNNING:
2330 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002331 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002333 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002334 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 break;
2336 default:
2337 goto illegal;
2338 }
2339 break;
2340
2341 }
2342 sdev->sdev_state = state;
2343 return 0;
2344
2345 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002346 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002347 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002348 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002349 scsi_device_state_name(oldstate),
2350 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 );
2352 return -EINVAL;
2353}
2354EXPORT_SYMBOL(scsi_device_set_state);
2355
2356/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002357 * sdev_evt_emit - emit a single SCSI device uevent
2358 * @sdev: associated SCSI device
2359 * @evt: event to emit
2360 *
2361 * Send a single uevent (scsi_event) to the associated scsi_device.
2362 */
2363static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2364{
2365 int idx = 0;
2366 char *envp[3];
2367
2368 switch (evt->evt_type) {
2369 case SDEV_EVT_MEDIA_CHANGE:
2370 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2371 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002372 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002373 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002374 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2375 break;
2376 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2377 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2378 break;
2379 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2380 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2381 break;
2382 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2383 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2384 break;
2385 case SDEV_EVT_LUN_CHANGE_REPORTED:
2386 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2387 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002388 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2389 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2390 break;
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002391 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2392 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2393 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002394 default:
2395 /* do nothing */
2396 break;
2397 }
2398
2399 envp[idx++] = NULL;
2400
2401 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2402}
2403
2404/**
2405 * sdev_evt_thread - send a uevent for each scsi event
2406 * @work: work struct for scsi_device
2407 *
2408 * Dispatch queued events to their associated scsi_device kobjects
2409 * as uevents.
2410 */
2411void scsi_evt_thread(struct work_struct *work)
2412{
2413 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002414 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002415 LIST_HEAD(event_list);
2416
2417 sdev = container_of(work, struct scsi_device, event_work);
2418
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002419 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2420 if (test_and_clear_bit(evt_type, sdev->pending_events))
2421 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2422
Jeff Garzika341cd02007-10-29 17:15:22 -04002423 while (1) {
2424 struct scsi_event *evt;
2425 struct list_head *this, *tmp;
2426 unsigned long flags;
2427
2428 spin_lock_irqsave(&sdev->list_lock, flags);
2429 list_splice_init(&sdev->event_list, &event_list);
2430 spin_unlock_irqrestore(&sdev->list_lock, flags);
2431
2432 if (list_empty(&event_list))
2433 break;
2434
2435 list_for_each_safe(this, tmp, &event_list) {
2436 evt = list_entry(this, struct scsi_event, node);
2437 list_del(&evt->node);
2438 scsi_evt_emit(sdev, evt);
2439 kfree(evt);
2440 }
2441 }
2442}
2443
2444/**
2445 * sdev_evt_send - send asserted event to uevent thread
2446 * @sdev: scsi_device event occurred on
2447 * @evt: event to send
2448 *
2449 * Assert scsi device event asynchronously.
2450 */
2451void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2452{
2453 unsigned long flags;
2454
Kay Sievers4d1566e2008-03-19 13:04:47 +01002455#if 0
2456 /* FIXME: currently this check eliminates all media change events
2457 * for polled devices. Need to update to discriminate between AN
2458 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002459 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2460 kfree(evt);
2461 return;
2462 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002463#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002464
2465 spin_lock_irqsave(&sdev->list_lock, flags);
2466 list_add_tail(&evt->node, &sdev->event_list);
2467 schedule_work(&sdev->event_work);
2468 spin_unlock_irqrestore(&sdev->list_lock, flags);
2469}
2470EXPORT_SYMBOL_GPL(sdev_evt_send);
2471
2472/**
2473 * sdev_evt_alloc - allocate a new scsi event
2474 * @evt_type: type of event to allocate
2475 * @gfpflags: GFP flags for allocation
2476 *
2477 * Allocates and returns a new scsi_event.
2478 */
2479struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2480 gfp_t gfpflags)
2481{
2482 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2483 if (!evt)
2484 return NULL;
2485
2486 evt->evt_type = evt_type;
2487 INIT_LIST_HEAD(&evt->node);
2488
2489 /* evt_type-specific initialization, if any */
2490 switch (evt_type) {
2491 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002492 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2493 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2494 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2495 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2496 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002497 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002498 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002499 default:
2500 /* do nothing */
2501 break;
2502 }
2503
2504 return evt;
2505}
2506EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2507
2508/**
2509 * sdev_evt_send_simple - send asserted event to uevent thread
2510 * @sdev: scsi_device event occurred on
2511 * @evt_type: type of event to send
2512 * @gfpflags: GFP flags for allocation
2513 *
2514 * Assert scsi device event asynchronously, given an event type.
2515 */
2516void sdev_evt_send_simple(struct scsi_device *sdev,
2517 enum scsi_device_event evt_type, gfp_t gfpflags)
2518{
2519 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2520 if (!evt) {
2521 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2522 evt_type);
2523 return;
2524 }
2525
2526 sdev_evt_send(sdev, evt);
2527}
2528EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2529
2530/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 * scsi_device_quiesce - Block user issued commands.
2532 * @sdev: scsi device to quiesce.
2533 *
2534 * This works by trying to transition to the SDEV_QUIESCE state
2535 * (which must be a legal transition). When the device is in this
2536 * state, only special requests will be accepted, all others will
2537 * be deferred. Since special requests may also be requeued requests,
2538 * a successful return doesn't guarantee the device will be
2539 * totally quiescent.
2540 *
2541 * Must be called with user context, may sleep.
2542 *
2543 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002544 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545int
2546scsi_device_quiesce(struct scsi_device *sdev)
2547{
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002548 struct request_queue *q = sdev->request_queue;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002549 int err;
2550
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002551 /*
2552 * It is allowed to call scsi_device_quiesce() multiple times from
2553 * the same context but concurrent scsi_device_quiesce() calls are
2554 * not allowed.
2555 */
2556 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2557
Bart Van Asschecd84a622018-09-26 14:01:04 -07002558 if (sdev->quiesced_by == current)
2559 return 0;
2560
2561 blk_set_pm_only(q);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002562
2563 blk_mq_freeze_queue(q);
2564 /*
Bart Van Asschecd84a622018-09-26 14:01:04 -07002565 * Ensure that the effect of blk_set_pm_only() will be visible
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002566 * for percpu_ref_tryget() callers that occur after the queue
2567 * unfreeze even if the queue was already frozen before this function
2568 * was called. See also https://lwn.net/Articles/573497/.
2569 */
2570 synchronize_rcu();
2571 blk_mq_unfreeze_queue(q);
2572
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002573 mutex_lock(&sdev->state_mutex);
2574 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002575 if (err == 0)
2576 sdev->quiesced_by = current;
2577 else
Bart Van Asschecd84a622018-09-26 14:01:04 -07002578 blk_clear_pm_only(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002579 mutex_unlock(&sdev->state_mutex);
2580
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002581 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582}
2583EXPORT_SYMBOL(scsi_device_quiesce);
2584
2585/**
2586 * scsi_device_resume - Restart user issued commands to a quiesced device.
2587 * @sdev: scsi device to resume.
2588 *
2589 * Moves the device from quiesced back to running and restarts the
2590 * queues.
2591 *
2592 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002593 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002594void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002596 /* check if the device state was mutated prior to resume, and if
2597 * so assume the state is being managed elsewhere (for example
2598 * device deleted during suspend)
2599 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002600 mutex_lock(&sdev->state_mutex);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002601 WARN_ON_ONCE(!sdev->quiesced_by);
2602 sdev->quiesced_by = NULL;
Bart Van Asschecd84a622018-09-26 14:01:04 -07002603 blk_clear_pm_only(sdev->request_queue);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002604 if (sdev->sdev_state == SDEV_QUIESCE)
2605 scsi_device_set_state(sdev, SDEV_RUNNING);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002606 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607}
2608EXPORT_SYMBOL(scsi_device_resume);
2609
2610static void
2611device_quiesce_fn(struct scsi_device *sdev, void *data)
2612{
2613 scsi_device_quiesce(sdev);
2614}
2615
2616void
2617scsi_target_quiesce(struct scsi_target *starget)
2618{
2619 starget_for_each_device(starget, NULL, device_quiesce_fn);
2620}
2621EXPORT_SYMBOL(scsi_target_quiesce);
2622
2623static void
2624device_resume_fn(struct scsi_device *sdev, void *data)
2625{
2626 scsi_device_resume(sdev);
2627}
2628
2629void
2630scsi_target_resume(struct scsi_target *starget)
2631{
2632 starget_for_each_device(starget, NULL, device_resume_fn);
2633}
2634EXPORT_SYMBOL(scsi_target_resume);
2635
2636/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002637 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2638 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002640 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002642 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002644 * Notes:
2645 * This routine transitions the device to the SDEV_BLOCK state (which must be
2646 * a legal transition). When the device is in this state, command processing
2647 * is paused until the device leaves the SDEV_BLOCK state. See also
2648 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002649 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002650int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651{
Jens Axboe165125e2007-07-24 09:28:11 +02002652 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653 int err = 0;
2654
2655 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002656 if (err) {
2657 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2658
2659 if (err)
2660 return err;
2661 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662
2663 /*
2664 * The device has transitioned to SDEV_BLOCK. Stop the
2665 * block layer from calling the midlayer with this device's
2666 * request queue.
2667 */
Jens Axboef664a3c2018-11-01 16:36:27 -06002668 blk_mq_quiesce_queue_nowait(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669 return 0;
2670}
Bart Van Assche551eb592017-06-02 14:21:53 -07002671EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2672
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002674 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2675 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002676 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002677 * Pause SCSI command processing on the specified device and wait until all
2678 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002680 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002682 * Note:
2683 * This routine transitions the device to the SDEV_BLOCK state (which must be
2684 * a legal transition). When the device is in this state, command processing
2685 * is paused until the device leaves the SDEV_BLOCK state. See also
2686 * scsi_internal_device_unblock().
2687 *
2688 * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
2689 * scsi_internal_device_block() has blocked a SCSI device and also
2690 * remove the rport mutex lock and unlock calls from srp_queuecommand().
Rob Landleyeb448202007-11-03 13:30:39 -05002691 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002692static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693{
Bart Van Assche551eb592017-06-02 14:21:53 -07002694 struct request_queue *q = sdev->request_queue;
2695 int err;
2696
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002697 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07002698 err = scsi_internal_device_block_nowait(sdev);
Jens Axboef664a3c2018-11-01 16:36:27 -06002699 if (err == 0)
2700 blk_mq_quiesce_queue(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002701 mutex_unlock(&sdev->state_mutex);
2702
Bart Van Assche551eb592017-06-02 14:21:53 -07002703 return err;
2704}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705
Bart Van Assche66483a42017-06-02 14:21:56 -07002706void scsi_start_queue(struct scsi_device *sdev)
2707{
2708 struct request_queue *q = sdev->request_queue;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002709
Jens Axboef664a3c2018-11-01 16:36:27 -06002710 blk_mq_unquiesce_queue(q);
Bart Van Assche66483a42017-06-02 14:21:56 -07002711}
2712
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713/**
Bart Van Assche43f75712017-06-02 14:21:54 -07002714 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07002716 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002718 * Restart the device queue for a previously suspended SCSI device. Does not
2719 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002721 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002723 * Notes:
2724 * This routine transitions the device to the SDEV_RUNNING state or to one of
2725 * the offline states (which must be a legal transition) allowing the midlayer
2726 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727 */
Bart Van Assche43f75712017-06-02 14:21:54 -07002728int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2729 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002731 /*
2732 * Try to transition the scsi device to SDEV_RUNNING or one of the
2733 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002735 switch (sdev->sdev_state) {
2736 case SDEV_BLOCK:
2737 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002738 sdev->sdev_state = new_state;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002739 break;
2740 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002741 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2742 new_state == SDEV_OFFLINE)
2743 sdev->sdev_state = new_state;
2744 else
2745 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002746 break;
2747 case SDEV_CANCEL:
2748 case SDEV_OFFLINE:
2749 break;
2750 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002751 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002752 }
Bart Van Assche66483a42017-06-02 14:21:56 -07002753 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002754
2755 return 0;
2756}
Bart Van Assche43f75712017-06-02 14:21:54 -07002757EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2758
2759/**
2760 * scsi_internal_device_unblock - resume a device after a block request
2761 * @sdev: device to resume
2762 * @new_state: state to set the device to after unblocking
2763 *
2764 * Restart the device queue for a previously suspended SCSI device. May sleep.
2765 *
2766 * Returns zero if successful or a negative error code upon failure.
2767 *
2768 * Notes:
2769 * This routine transitions the device to the SDEV_RUNNING state or to one of
2770 * the offline states (which must be a legal transition) allowing the midlayer
2771 * to goose the queue for this device.
2772 */
2773static int scsi_internal_device_unblock(struct scsi_device *sdev,
2774 enum scsi_device_state new_state)
2775{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002776 int ret;
2777
2778 mutex_lock(&sdev->state_mutex);
2779 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2780 mutex_unlock(&sdev->state_mutex);
2781
2782 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07002783}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784
2785static void
2786device_block(struct scsi_device *sdev, void *data)
2787{
Bart Van Assche551eb592017-06-02 14:21:53 -07002788 scsi_internal_device_block(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789}
2790
2791static int
2792target_block(struct device *dev, void *data)
2793{
2794 if (scsi_is_target_device(dev))
2795 starget_for_each_device(to_scsi_target(dev), NULL,
2796 device_block);
2797 return 0;
2798}
2799
2800void
2801scsi_target_block(struct device *dev)
2802{
2803 if (scsi_is_target_device(dev))
2804 starget_for_each_device(to_scsi_target(dev), NULL,
2805 device_block);
2806 else
2807 device_for_each_child(dev, NULL, target_block);
2808}
2809EXPORT_SYMBOL_GPL(scsi_target_block);
2810
2811static void
2812device_unblock(struct scsi_device *sdev, void *data)
2813{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002814 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002815}
2816
2817static int
2818target_unblock(struct device *dev, void *data)
2819{
2820 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002821 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822 device_unblock);
2823 return 0;
2824}
2825
2826void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002827scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828{
2829 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002830 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002831 device_unblock);
2832 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002833 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002834}
2835EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002836
2837/**
2838 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002839 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002840 * @sg_count: number of segments in sg
2841 * @offset: offset in bytes into sg, on return offset into the mapped area
2842 * @len: bytes to map, on return number of bytes mapped
2843 *
2844 * Returns virtual address of the start of the mapped page
2845 */
Jens Axboec6132da2007-10-16 11:08:49 +02002846void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002847 size_t *offset, size_t *len)
2848{
2849 int i;
2850 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002851 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002852 struct page *page;
2853
Andrew Morton22cfefb2007-02-05 16:39:03 -08002854 WARN_ON(!irqs_disabled());
2855
Jens Axboec6132da2007-10-16 11:08:49 +02002856 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002857 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002858 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002859 if (sg_len > *offset)
2860 break;
2861 }
2862
2863 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002864 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2865 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002866 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002867 WARN_ON(1);
2868 return NULL;
2869 }
2870
2871 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002872 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002873
2874 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002875 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002876 *offset &= ~PAGE_MASK;
2877
2878 /* Bytes in this sg-entry from *offset to the end of the page */
2879 sg_len = PAGE_SIZE - *offset;
2880 if (*len > sg_len)
2881 *len = sg_len;
2882
Cong Wang77dfce02011-11-25 23:14:23 +08002883 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002884}
2885EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2886
2887/**
Rob Landleyeb448202007-11-03 13:30:39 -05002888 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002889 * @virt: virtual address to be unmapped
2890 */
2891void scsi_kunmap_atomic_sg(void *virt)
2892{
Cong Wang77dfce02011-11-25 23:14:23 +08002893 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002894}
2895EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002896
2897void sdev_disable_disk_events(struct scsi_device *sdev)
2898{
2899 atomic_inc(&sdev->disk_events_disable_depth);
2900}
2901EXPORT_SYMBOL(sdev_disable_disk_events);
2902
2903void sdev_enable_disk_events(struct scsi_device *sdev)
2904{
2905 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2906 return;
2907 atomic_dec(&sdev->disk_events_disable_depth);
2908}
2909EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002910
2911/**
2912 * scsi_vpd_lun_id - return a unique device identification
2913 * @sdev: SCSI device
2914 * @id: buffer for the identification
2915 * @id_len: length of the buffer
2916 *
2917 * Copies a unique device identification into @id based
2918 * on the information in the VPD page 0x83 of the device.
2919 * The string will be formatted as a SCSI name string.
2920 *
2921 * Returns the length of the identification or error on failure.
2922 * If the identifier is longer than the supplied buffer the actual
2923 * identifier length is returned and the buffer is not zero-padded.
2924 */
2925int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
2926{
2927 u8 cur_id_type = 0xff;
2928 u8 cur_id_size = 0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002929 const unsigned char *d, *cur_id_str;
2930 const struct scsi_vpd *vpd_pg83;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002931 int id_size = -EINVAL;
2932
2933 rcu_read_lock();
2934 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
2935 if (!vpd_pg83) {
2936 rcu_read_unlock();
2937 return -ENXIO;
2938 }
2939
2940 /*
2941 * Look for the correct descriptor.
2942 * Order of preference for lun descriptor:
2943 * - SCSI name string
2944 * - NAA IEEE Registered Extended
2945 * - EUI-64 based 16-byte
2946 * - EUI-64 based 12-byte
2947 * - NAA IEEE Registered
2948 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02002949 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002950 * as longer descriptors reduce the likelyhood
2951 * of identification clashes.
2952 */
2953
2954 /* The id string must be at least 20 bytes + terminating NULL byte */
2955 if (id_len < 21) {
2956 rcu_read_unlock();
2957 return -EINVAL;
2958 }
2959
2960 memset(id, 0, id_len);
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002961 d = vpd_pg83->data + 4;
2962 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002963 /* Skip designators not referring to the LUN */
2964 if ((d[1] & 0x30) != 0x00)
2965 goto next_desig;
2966
2967 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02002968 case 0x1:
2969 /* T10 Vendor ID */
2970 if (cur_id_size > d[3])
2971 break;
2972 /* Prefer anything */
2973 if (cur_id_type > 0x01 && cur_id_type != 0xff)
2974 break;
2975 cur_id_size = d[3];
2976 if (cur_id_size + 4 > id_len)
2977 cur_id_size = id_len - 4;
2978 cur_id_str = d + 4;
2979 cur_id_type = d[1] & 0xf;
2980 id_size = snprintf(id, id_len, "t10.%*pE",
2981 cur_id_size, cur_id_str);
2982 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002983 case 0x2:
2984 /* EUI-64 */
2985 if (cur_id_size > d[3])
2986 break;
2987 /* Prefer NAA IEEE Registered Extended */
2988 if (cur_id_type == 0x3 &&
2989 cur_id_size == d[3])
2990 break;
2991 cur_id_size = d[3];
2992 cur_id_str = d + 4;
2993 cur_id_type = d[1] & 0xf;
2994 switch (cur_id_size) {
2995 case 8:
2996 id_size = snprintf(id, id_len,
2997 "eui.%8phN",
2998 cur_id_str);
2999 break;
3000 case 12:
3001 id_size = snprintf(id, id_len,
3002 "eui.%12phN",
3003 cur_id_str);
3004 break;
3005 case 16:
3006 id_size = snprintf(id, id_len,
3007 "eui.%16phN",
3008 cur_id_str);
3009 break;
3010 default:
3011 cur_id_size = 0;
3012 break;
3013 }
3014 break;
3015 case 0x3:
3016 /* NAA */
3017 if (cur_id_size > d[3])
3018 break;
3019 cur_id_size = d[3];
3020 cur_id_str = d + 4;
3021 cur_id_type = d[1] & 0xf;
3022 switch (cur_id_size) {
3023 case 8:
3024 id_size = snprintf(id, id_len,
3025 "naa.%8phN",
3026 cur_id_str);
3027 break;
3028 case 16:
3029 id_size = snprintf(id, id_len,
3030 "naa.%16phN",
3031 cur_id_str);
3032 break;
3033 default:
3034 cur_id_size = 0;
3035 break;
3036 }
3037 break;
3038 case 0x8:
3039 /* SCSI name string */
3040 if (cur_id_size + 4 > d[3])
3041 break;
3042 /* Prefer others for truncated descriptor */
3043 if (cur_id_size && d[3] > id_len)
3044 break;
3045 cur_id_size = id_size = d[3];
3046 cur_id_str = d + 4;
3047 cur_id_type = d[1] & 0xf;
3048 if (cur_id_size >= id_len)
3049 cur_id_size = id_len - 1;
3050 memcpy(id, cur_id_str, cur_id_size);
3051 /* Decrease priority for truncated descriptor */
3052 if (cur_id_size != id_size)
3053 cur_id_size = 6;
3054 break;
3055 default:
3056 break;
3057 }
3058next_desig:
3059 d += d[3] + 4;
3060 }
3061 rcu_read_unlock();
3062
3063 return id_size;
3064}
3065EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003066
3067/*
3068 * scsi_vpd_tpg_id - return a target port group identifier
3069 * @sdev: SCSI device
3070 *
3071 * Returns the Target Port Group identifier from the information
3072 * froom VPD page 0x83 of the device.
3073 *
3074 * Returns the identifier or error on failure.
3075 */
3076int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3077{
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003078 const unsigned char *d;
3079 const struct scsi_vpd *vpd_pg83;
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003080 int group_id = -EAGAIN, rel_port = -1;
3081
3082 rcu_read_lock();
3083 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3084 if (!vpd_pg83) {
3085 rcu_read_unlock();
3086 return -ENXIO;
3087 }
3088
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003089 d = vpd_pg83->data + 4;
3090 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003091 switch (d[1] & 0xf) {
3092 case 0x4:
3093 /* Relative target port */
3094 rel_port = get_unaligned_be16(&d[6]);
3095 break;
3096 case 0x5:
3097 /* Target port group */
3098 group_id = get_unaligned_be16(&d[6]);
3099 break;
3100 default:
3101 break;
3102 }
3103 d += d[3] + 4;
3104 }
3105 rcu_read_unlock();
3106
3107 if (group_id >= 0 && rel_id && rel_port != -1)
3108 *rel_id = rel_port;
3109
3110 return group_id;
3111}
3112EXPORT_SYMBOL(scsi_vpd_tpg_id);