blob: 2667bb95a4410c3a2846280abeffd3e385719d67 [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{
559 if (cmd->sdb.table.nents)
Ming Lin001d63b2016-04-04 14:48:09 -0700560 sg_free_table_chained(&cmd->sdb.table, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100561 if (scsi_prot_sg_count(cmd))
Ming Lin001d63b2016-04-04 14:48:09 -0700562 sg_free_table_chained(&cmd->prot_sdb->table, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100563}
564
565static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
566{
Christoph Hellwigd2852032014-01-17 12:06:53 +0100567 scsi_mq_free_sgtables(cmd);
568 scsi_uninit_cmd(cmd);
Bart Van Assche2dd6fb52017-06-02 14:21:58 -0700569 scsi_del_cmd_from_list(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100570}
571
Douglas Gilbert7e63b5a2018-06-23 12:22:14 +0200572/* Returns false when no more bytes to process, true if there are more */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200573static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100574 unsigned int bytes)
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800575{
Bart Van Asschebed22132017-08-25 13:46:32 -0700576 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800577 struct scsi_device *sdev = cmd->device;
578 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800579
580 if (blk_update_request(req, error, bytes))
581 return true;
582
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800583 if (blk_queue_add_random(q))
584 add_disk_randomness(req->rq_disk);
585
Bart Van Assche64104f72017-08-30 16:58:39 -0700586 if (!blk_rq_is_scsi(req)) {
587 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
588 cmd->flags &= ~SCMD_INITIALIZED;
Bart Van Assche3be88282018-02-22 11:30:20 -0800589 destroy_rcu_head(&cmd->rcu);
Bart Van Assche64104f72017-08-30 16:58:39 -0700590 }
591
Jens Axboef664a3c2018-11-01 16:36:27 -0600592 /*
593 * In the MQ case the command gets freed by __blk_mq_end_request,
594 * so we have to do all cleanup that depends on it earlier.
595 *
596 * We also can't kick the queues from irq context, so we
597 * will have to defer it to a workqueue.
598 */
599 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800600
Jens Axboea78b03b2018-11-18 15:46:03 -0700601 /*
602 * queue is still alive, so grab the ref for preventing it
603 * from being cleaned up during running queue.
604 */
605 percpu_ref_get(&q->q_usage_counter);
Ming Lei8dc765d2018-11-14 16:25:51 +0800606
Jens Axboef664a3c2018-11-01 16:36:27 -0600607 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100608
Jens Axboef664a3c2018-11-01 16:36:27 -0600609 if (scsi_target(sdev)->single_lun ||
610 !list_empty(&sdev->host->starved_list))
611 kblockd_schedule_work(&sdev->requeue_work);
612 else
613 blk_mq_run_hw_queues(q, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100614
Jens Axboea78b03b2018-11-18 15:46:03 -0700615 percpu_ref_put(&q->q_usage_counter);
Christoph Hellwigbb3ec622014-09-05 18:02:09 -0700616 put_device(&sdev->sdev_gendev);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800617 return false;
618}
619
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200620/**
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700621 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
622 * @cmd: SCSI command
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200623 * @result: scsi error code
624 *
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700625 * Translate a SCSI result code into a blk_status_t value. May reset the host
626 * byte of @cmd->result.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200627 */
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700628static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100629{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200630 switch (host_byte(result)) {
Bart Van Asschef4abab32018-04-05 10:33:01 -0700631 case DID_OK:
632 /*
633 * Also check the other bytes than the status byte in result
634 * to handle the case when a SCSI LLD sets result to
635 * DRIVER_SENSE << 24 without setting SAM_STAT_CHECK_CONDITION.
636 */
637 if (scsi_status_is_good(result) && (result & ~0xff) == 0)
638 return BLK_STS_OK;
639 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100640 case DID_TRANSPORT_FAILFAST:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200641 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100642 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000643 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200644 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100645 case DID_NEXUS_FAILURE:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200646 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200647 case DID_ALLOC_FAILURE:
648 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200649 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200650 case DID_MEDIUM_ERROR:
651 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200652 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100653 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200654 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100655 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100656}
657
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200658/* Helper for scsi_io_completion() when "reprep" action required. */
659static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
660 struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661{
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200662 /* A new command will be prepared and issued. */
Jens Axboef664a3c2018-11-01 16:36:27 -0600663 scsi_mq_requeue_cmd(cmd);
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200664}
665
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200666/* Helper for scsi_io_completion() when special action required. */
667static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
Douglas Gilbertab831082018-06-23 12:22:16 +0200668{
Jens Axboe165125e2007-07-24 09:28:11 +0200669 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 struct request *req = cmd->request;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200671 int level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500672 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
673 ACTION_DELAYED_RETRY} action;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900674 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200675 struct scsi_sense_hdr sshdr;
676 bool sense_valid;
677 bool sense_current = true; /* false implies "deferred sense" */
678 blk_status_t blk_stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200680 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
681 if (sense_valid)
682 sense_current = !scsi_sense_is_deferred(&sshdr);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200683
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200684 blk_stat = scsi_result_to_blk_status(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500685
Alan Sternb60af5b2008-11-03 15:56:47 -0500686 if (host_byte(result) == DID_RESET) {
687 /* Third party bus reset or reset for error recovery
688 * reasons. Just retry the command and see what
689 * happens.
690 */
691 action = ACTION_RETRY;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200692 } else if (sense_valid && sense_current) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 switch (sshdr.sense_key) {
694 case UNIT_ATTENTION:
695 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700696 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 * and quietly refuse further access.
698 */
699 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500700 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700702 /* Must have been a power glitch, or a
703 * bus reset. Could not have been a
704 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500705 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700706 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500707 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 }
709 break;
710 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700711 /* If we had an ILLEGAL REQUEST returned, then
712 * we may have performed an unsupported
713 * command. The only thing this should be
714 * would be a ten byte read where only a six
715 * byte read was supported. Also, on a system
716 * where READ CAPACITY failed, we may have
717 * read past the end of the disk.
718 */
Jens Axboe26a68012005-11-29 21:03:34 +0100719 if ((cmd->device->use_10_for_rw &&
720 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 (cmd->cmnd[0] == READ_10 ||
722 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500723 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500725 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500726 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500727 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200728 blk_stat = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500729 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400730 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500731 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200732 blk_stat = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500733 } else
734 action = ACTION_FAIL;
735 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400736 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000737 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200738 if (sshdr.asc == 0x10) /* DIF */
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200739 blk_stat = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 break;
741 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700742 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500743 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500745 if (sshdr.asc == 0x04) {
746 switch (sshdr.ascq) {
747 case 0x01: /* becoming ready */
748 case 0x04: /* format in progress */
749 case 0x05: /* rebuild in progress */
750 case 0x06: /* recalculation in progress */
751 case 0x07: /* operation in progress */
752 case 0x08: /* Long write in progress */
753 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500754 case 0x14: /* space allocation in progress */
Douglas Gilberte37c7d92018-05-18 19:25:47 -0400755 case 0x1a: /* start stop unit in progress */
756 case 0x1b: /* sanitize in progress */
757 case 0x1d: /* configuration in progress */
758 case 0x24: /* depopulation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500759 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500760 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500761 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500762 action = ACTION_FAIL;
763 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500764 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200765 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500766 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500767 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700769 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500770 action = ACTION_FAIL;
771 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500773 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 break;
775 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200776 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500777 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500778
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900779 if (action != ACTION_FAIL &&
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200780 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900781 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900782
Alan Sternb60af5b2008-11-03 15:56:47 -0500783 switch (action) {
784 case ACTION_FAIL:
785 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200786 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200787 static DEFINE_RATELIMIT_STATE(_rs,
788 DEFAULT_RATELIMIT_INTERVAL,
789 DEFAULT_RATELIMIT_BURST);
790
791 if (unlikely(scsi_logging_level))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200792 level =
793 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
794 SCSI_LOG_MLCOMPLETE_BITS);
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200795
796 /*
797 * if logging is enabled the failure will be printed
798 * in scsi_log_completion(), so avoid duplicate messages
799 */
800 if (!level && __ratelimit(&_rs)) {
801 scsi_print_result(cmd, NULL, FAILED);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +0200802 if (driver_byte(result) == DRIVER_SENSE)
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200803 scsi_print_sense(cmd);
804 scsi_print_command(cmd);
805 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500806 }
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100807 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req)))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800808 return;
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200809 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500810 case ACTION_REPREP:
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200811 scsi_io_completion_reprep(cmd, q);
Alan Sternb60af5b2008-11-03 15:56:47 -0500812 break;
813 case ACTION_RETRY:
814 /* Retry the same command immediately */
Bart Van Assche08640e82018-01-10 14:41:45 -0800815 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500816 break;
817 case ACTION_DELAYED_RETRY:
818 /* Retry the same command after a delay */
Bart Van Assche08640e82018-01-10 14:41:45 -0800819 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500820 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 }
822}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200824/*
825 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
826 * new result that may suppress further error checking. Also modifies
827 * *blk_statp in some cases.
828 */
829static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
830 blk_status_t *blk_statp)
831{
832 bool sense_valid;
833 bool sense_current = true; /* false implies "deferred sense" */
834 struct request *req = cmd->request;
835 struct scsi_sense_hdr sshdr;
836
837 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
838 if (sense_valid)
839 sense_current = !scsi_sense_is_deferred(&sshdr);
840
841 if (blk_rq_is_passthrough(req)) {
842 if (sense_valid) {
843 /*
844 * SG_IO wants current and deferred errors
845 */
846 scsi_req(req)->sense_len =
847 min(8 + cmd->sense_buffer[7],
848 SCSI_SENSE_BUFFERSIZE);
849 }
850 if (sense_current)
851 *blk_statp = scsi_result_to_blk_status(cmd, result);
852 } else if (blk_rq_bytes(req) == 0 && sense_current) {
853 /*
854 * Flush commands do not transfers any data, and thus cannot use
855 * good_bytes != blk_rq_bytes(req) as the signal for an error.
856 * This sets *blk_statp explicitly for the problem case.
857 */
858 *blk_statp = scsi_result_to_blk_status(cmd, result);
859 }
860 /*
861 * Recovered errors need reporting, but they're always treated as
862 * success, so fiddle the result code here. For passthrough requests
863 * we already took a copy of the original into sreq->result which
864 * is what gets returned to the user
865 */
866 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
867 bool do_print = true;
868 /*
869 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
870 * skip print since caller wants ATA registers. Only occurs
871 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
872 */
873 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
874 do_print = false;
875 else if (req->rq_flags & RQF_QUIET)
876 do_print = false;
877 if (do_print)
878 scsi_print_sense(cmd);
879 result = 0;
880 /* for passthrough, *blk_statp may be set */
881 *blk_statp = BLK_STS_OK;
882 }
883 /*
884 * Another corner case: the SCSI status byte is non-zero but 'good'.
885 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
886 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
887 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
888 * intermediate statuses (both obsolete in SAM-4) as good.
889 */
890 if (status_byte(result) && scsi_status_is_good(result)) {
891 result = 0;
892 *blk_statp = BLK_STS_OK;
893 }
894 return result;
895}
896
897/*
898 * Function: scsi_io_completion()
899 *
900 * Purpose: Completion processing for block device I/O requests.
901 *
902 * Arguments: cmd - command that is finished.
903 *
904 * Lock status: Assumed that no lock is held upon entry.
905 *
906 * Returns: Nothing
907 *
908 * Notes: We will finish off the specified number of sectors. If we
909 * are done, the command block will be released and the queue
910 * function will be goosed. If we are not done then we have to
911 * figure out what to do next:
912 *
913 * a) We can call scsi_requeue_command(). The request
914 * will be unprepared and put back on the queue. Then
915 * a new command will be created for it. This should
916 * be used if we made forward progress, or if we want
917 * to switch from READ(10) to READ(6) for example.
918 *
919 * b) We can call __scsi_queue_insert(). The request will
920 * be put back on the queue and retried using the same
921 * command as before, possibly after a delay.
922 *
923 * c) We can call scsi_end_request() with blk_stat other than
924 * BLK_STS_OK, to fail the remainder of the request.
925 */
926void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
927{
928 int result = cmd->result;
929 struct request_queue *q = cmd->device->request_queue;
930 struct request *req = cmd->request;
931 blk_status_t blk_stat = BLK_STS_OK;
932
Douglas Gilbert0d437902018-06-23 12:22:19 +0200933 if (unlikely(result)) /* a nz result may or may not be an error */
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200934 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
935
Douglas Gilbert0d437902018-06-23 12:22:19 +0200936 if (unlikely(blk_rq_is_passthrough(req))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200937 /*
938 * scsi_result_to_blk_status may have reset the host_byte
939 */
940 scsi_req(req)->result = cmd->result;
941 scsi_req(req)->resid_len = scsi_get_resid(cmd);
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200942 }
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200943
944 /*
945 * Next deal with any sectors which we were able to correctly
946 * handle.
947 */
948 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
949 "%u sectors total, %d bytes done.\n",
950 blk_rq_sectors(req), good_bytes));
951
952 /*
953 * Next deal with any sectors which we were able to correctly
954 * handle. Failed, zero length commands always need to drop down
955 * to retry code. Fast path should return in this block.
956 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200957 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100958 if (likely(!scsi_end_request(req, blk_stat, good_bytes)))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200959 return; /* no bytes remaining */
960 }
961
Douglas Gilbert0d437902018-06-23 12:22:19 +0200962 /* Kill remainder if no retries. */
963 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100964 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req)))
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200965 WARN_ONCE(true,
966 "Bytes remaining after failed, no-retry command");
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200967 return;
968 }
969
970 /*
971 * If there had been no error, but we have leftover bytes in the
972 * requeues just queue the command up again.
973 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200974 if (likely(result == 0))
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200975 scsi_io_completion_reprep(cmd, q);
976 else
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200977 scsi_io_completion_action(cmd, result);
978}
979
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100980static blk_status_t scsi_init_sgtable(struct request *req,
981 struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200983 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
985 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +0100986 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 */
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700988 if (unlikely(sg_alloc_table_chained(&sdb->table,
989 blk_rq_nr_phys_segments(req), sdb->table.sgl)))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100990 return BLK_STS_RESOURCE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 /*
993 * Next, walk the list, and fill in the addresses and sizes of
994 * each segment.
995 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200996 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
997 BUG_ON(count > sdb->table.nents);
998 sdb->table.nents = count;
Christoph Hellwigfd102b12017-01-13 12:29:11 +0100999 sdb->length = blk_rq_payload_bytes(req);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001000 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001002
1003/*
1004 * Function: scsi_init_io()
1005 *
1006 * Purpose: SCSI I/O initialize function.
1007 *
1008 * Arguments: cmd - Command descriptor we wish to initialize
1009 *
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001010 * Returns: BLK_STS_OK on success
1011 * BLK_STS_RESOURCE if the failure is retryable
1012 * BLK_STS_IOERR if the failure is fatal
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001013 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001014blk_status_t scsi_init_io(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001015{
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001016 struct request *rq = cmd->request;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001017 blk_status_t ret;
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001018
Johannes Thumshirnfd3fc0b2017-01-31 10:16:00 +01001019 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001020 return BLK_STS_IOERR;
Christoph Hellwig635d98b2014-06-28 11:51:01 +02001021
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001022 ret = scsi_init_sgtable(rq, &cmd->sdb);
1023 if (ret)
1024 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001025
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001026 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001027 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1028 int ivecs, count;
1029
Christoph Hellwig14784562018-11-09 14:42:38 +01001030 if (WARN_ON_ONCE(!prot_sdb)) {
Ewan D. Milne91724c22015-01-15 10:02:12 -05001031 /*
1032 * This can happen if someone (e.g. multipath)
1033 * queues a command to a device on an adapter
1034 * that does not support DIX.
1035 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001036 ret = BLK_STS_IOERR;
Christoph Hellwig14784562018-11-09 14:42:38 +01001037 goto out_free_sgtables;
Ewan D. Milne91724c22015-01-15 10:02:12 -05001038 }
1039
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001040 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001041
Ming Lin001d63b2016-04-04 14:48:09 -07001042 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lin22cc3d42016-04-04 14:48:08 -07001043 prot_sdb->table.sgl)) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001044 ret = BLK_STS_RESOURCE;
Christoph Hellwig14784562018-11-09 14:42:38 +01001045 goto out_free_sgtables;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001046 }
1047
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001048 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001049 prot_sdb->table.sgl);
Igor Stoppa6f1d8a52018-09-05 23:47:20 +03001050 BUG_ON(count > ivecs);
1051 BUG_ON(count > queue_max_integrity_segments(rq->q));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001052
1053 cmd->prot_sdb = prot_sdb;
1054 cmd->prot_sdb->table.nents = count;
1055 }
1056
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001057 return BLK_STS_OK;
Christoph Hellwig14784562018-11-09 14:42:38 +01001058out_free_sgtables:
Jens Axboef664a3c2018-11-01 16:36:27 -06001059 scsi_mq_free_sgtables(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001060 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001061}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001062EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001064/**
Bart Van Assche832889f2017-08-30 16:58:40 -07001065 * scsi_initialize_rq - initialize struct scsi_cmnd partially
Jonathan Corbet35c05062017-08-24 16:11:09 -06001066 * @rq: Request associated with the SCSI command to be initialized.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001067 *
Bart Van Assche832889f2017-08-30 16:58:40 -07001068 * This function initializes the members of struct scsi_cmnd that must be
1069 * initialized before request processing starts and that won't be
1070 * reinitialized if a SCSI command is requeued.
1071 *
Bart Van Assche64104f72017-08-30 16:58:39 -07001072 * Called from inside blk_get_request() for pass-through requests and from
1073 * inside scsi_init_command() for filesystem requests.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001074 */
Bart Van Asschee4c94702017-12-07 15:59:31 -08001075static void scsi_initialize_rq(struct request *rq)
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001076{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001077 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1078
1079 scsi_req_init(&cmd->req);
Bart Van Assche3be88282018-02-22 11:30:20 -08001080 init_rcu_head(&cmd->rcu);
Bart Van Assche832889f2017-08-30 16:58:40 -07001081 cmd->jiffies_at_alloc = jiffies;
1082 cmd->retries = 0;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001083}
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001084
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001085/* Add a command to the list used by the aacraid and dpt_i2o drivers */
1086void scsi_add_cmd_to_list(struct scsi_cmnd *cmd)
1087{
1088 struct scsi_device *sdev = cmd->device;
1089 struct Scsi_Host *shost = sdev->host;
1090 unsigned long flags;
1091
1092 if (shost->use_cmd_list) {
1093 spin_lock_irqsave(&sdev->list_lock, flags);
1094 list_add_tail(&cmd->list, &sdev->cmd_list);
1095 spin_unlock_irqrestore(&sdev->list_lock, flags);
1096 }
1097}
1098
1099/* Remove a command from the list used by the aacraid and dpt_i2o drivers */
1100void scsi_del_cmd_from_list(struct scsi_cmnd *cmd)
1101{
1102 struct scsi_device *sdev = cmd->device;
1103 struct Scsi_Host *shost = sdev->host;
1104 unsigned long flags;
1105
1106 if (shost->use_cmd_list) {
1107 spin_lock_irqsave(&sdev->list_lock, flags);
1108 BUG_ON(list_empty(&cmd->list));
1109 list_del_init(&cmd->list);
1110 spin_unlock_irqrestore(&sdev->list_lock, flags);
1111 }
1112}
1113
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001114/* Called after a request has been started. */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001115void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001116{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001117 void *buf = cmd->sense_buffer;
1118 void *prot = cmd->prot_sdb;
Bart Van Assche64104f72017-08-30 16:58:39 -07001119 struct request *rq = blk_mq_rq_from_pdu(cmd);
1120 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
Bart Van Assche832889f2017-08-30 16:58:40 -07001121 unsigned long jiffies_at_alloc;
1122 int retries;
Bart Van Assche64104f72017-08-30 16:58:39 -07001123
1124 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1125 flags |= SCMD_INITIALIZED;
1126 scsi_initialize_rq(rq);
1127 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001128
Bart Van Assche832889f2017-08-30 16:58:40 -07001129 jiffies_at_alloc = cmd->jiffies_at_alloc;
1130 retries = cmd->retries;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001131 /* zero out the cmd, except for the embedded scsi_request */
1132 memset((char *)cmd + sizeof(cmd->req), 0,
Christoph Hellwigee524232017-02-21 10:04:55 +01001133 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
Christoph Hellwig04796332014-02-20 14:20:55 -08001134
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001135 cmd->device = dev;
1136 cmd->sense_buffer = buf;
1137 cmd->prot_sdb = prot;
Bart Van Assche64104f72017-08-30 16:58:39 -07001138 cmd->flags = flags;
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001139 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
Bart Van Assche832889f2017-08-30 16:58:40 -07001140 cmd->jiffies_at_alloc = jiffies_at_alloc;
1141 cmd->retries = retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001142
Bart Van Assche2dd6fb52017-06-02 14:21:58 -07001143 scsi_add_cmd_to_list(cmd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001144}
1145
Christoph Hellwig785ba832018-11-09 14:42:37 +01001146static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1147 struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001148{
Bart Van Asschebed22132017-08-25 13:46:32 -07001149 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001150
1151 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001152 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001153 * a bio attached to them. Or they might contain a SCSI command
1154 * that does not transfer data, in which case they may optionally
1155 * submit a request without an attached bio.
1156 */
1157 if (req->bio) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001158 blk_status_t ret = scsi_init_io(cmd);
1159 if (unlikely(ret != BLK_STS_OK))
1160 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001161 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001162 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001163
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001164 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001165 }
James Bottomley7b163182005-12-15 20:17:02 -06001166
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001167 cmd->cmd_len = scsi_req(req)->cmd_len;
1168 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001169 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001170 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig785ba832018-11-09 14:42:37 +01001171 return BLK_STS_OK;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001172}
1173
1174/*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001175 * Setup a normal block command. These are simple request from filesystems
Christoph Hellwig3868cf82014-06-28 11:58:42 +02001176 * that still need to be translated to SCSI CDBs from the ULD.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001177 */
Christoph Hellwig785ba832018-11-09 14:42:37 +01001178static blk_status_t scsi_setup_fs_cmnd(struct scsi_device *sdev,
1179 struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001180{
Bart Van Asschebed22132017-08-25 13:46:32 -07001181 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001182
Christoph Hellwigee14c672015-08-27 14:16:59 +02001183 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
Christoph Hellwig4c1cb672018-11-09 14:42:40 +01001184 blk_status_t ret = sdev->handler->prep_fn(sdev, req);
1185 if (ret != BLK_STS_OK)
1186 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001187 }
1188
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001189 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001190 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001191 return scsi_cmd_to_driver(cmd)->init_command(cmd);
James Bottomley7b163182005-12-15 20:17:02 -06001192}
James Bottomley7b163182005-12-15 20:17:02 -06001193
Christoph Hellwig785ba832018-11-09 14:42:37 +01001194static blk_status_t scsi_setup_cmnd(struct scsi_device *sdev,
1195 struct request *req)
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001196{
Bart Van Asschebed22132017-08-25 13:46:32 -07001197 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001198
1199 if (!blk_rq_bytes(req))
1200 cmd->sc_data_direction = DMA_NONE;
1201 else if (rq_data_dir(req) == WRITE)
1202 cmd->sc_data_direction = DMA_TO_DEVICE;
1203 else
1204 cmd->sc_data_direction = DMA_FROM_DEVICE;
1205
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001206 if (blk_rq_is_scsi(req))
1207 return scsi_setup_scsi_cmnd(sdev, req);
1208 else
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001209 return scsi_setup_fs_cmnd(sdev, req);
Christoph Hellwig6af7a4f2014-07-08 13:16:17 +02001210}
1211
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001212static blk_status_t
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001213scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214{
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001215 switch (sdev->sdev_state) {
1216 case SDEV_OFFLINE:
1217 case SDEV_TRANSPORT_OFFLINE:
1218 /*
1219 * If the device is offline we refuse to process any
1220 * commands. The device must be brought online
1221 * before trying any recovery commands.
1222 */
1223 sdev_printk(KERN_ERR, sdev,
1224 "rejecting I/O to offline device\n");
1225 return BLK_STS_IOERR;
1226 case SDEV_DEL:
1227 /*
1228 * If the device is fully deleted, we refuse to
1229 * process any commands as well.
1230 */
1231 sdev_printk(KERN_ERR, sdev,
1232 "rejecting I/O to dead device\n");
1233 return BLK_STS_IOERR;
1234 case SDEV_BLOCK:
1235 case SDEV_CREATED_BLOCK:
1236 return BLK_STS_RESOURCE;
1237 case SDEV_QUIESCE:
1238 /*
1239 * If the devices is blocked we defer normal commands.
1240 */
1241 if (req && !(req->rq_flags & RQF_PREEMPT))
1242 return BLK_STS_RESOURCE;
1243 return BLK_STS_OK;
1244 default:
1245 /*
1246 * For any other not fully online state we only allow
1247 * special commands. In particular any user initiated
1248 * command is not allowed.
1249 */
1250 if (req && !(req->rq_flags & RQF_PREEMPT))
1251 return BLK_STS_IOERR;
1252 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001254}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256/*
1257 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1258 * return 0.
1259 *
1260 * Called with the queue_lock held.
1261 */
1262static inline int scsi_dev_queue_ready(struct request_queue *q,
1263 struct scsi_device *sdev)
1264{
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001265 unsigned int busy;
1266
1267 busy = atomic_inc_return(&sdev->device_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001268 if (atomic_read(&sdev->device_blocked)) {
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001269 if (busy)
1270 goto out_dec;
1271
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 /*
1273 * unblock after device_blocked iterates to zero
1274 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001275 if (atomic_dec_return(&sdev->device_blocked) > 0)
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001276 goto out_dec;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001277 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1278 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001280
1281 if (busy >= sdev->queue_depth)
1282 goto out_dec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283
1284 return 1;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001285out_dec:
1286 atomic_dec(&sdev->device_busy);
1287 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288}
1289
Mike Christief0c0a372008-08-17 15:24:38 -05001290/*
1291 * scsi_target_queue_ready: checks if there we can send commands to target
1292 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001293 */
1294static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1295 struct scsi_device *sdev)
1296{
1297 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001298 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001299
1300 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001301 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001302 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001303 starget->starget_sdev_user != sdev) {
1304 spin_unlock_irq(shost->host_lock);
1305 return 0;
1306 }
Mike Christief0c0a372008-08-17 15:24:38 -05001307 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001308 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001309 }
1310
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001311 if (starget->can_queue <= 0)
1312 return 1;
1313
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001314 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001315 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001316 if (busy)
1317 goto starved;
1318
Mike Christief0c0a372008-08-17 15:24:38 -05001319 /*
1320 * unblock after target_blocked iterates to zero
1321 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001322 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001323 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001324
1325 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1326 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001327 }
1328
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001329 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001330 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001331
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001332 return 1;
1333
1334starved:
1335 spin_lock_irq(shost->host_lock);
1336 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001337 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001338out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001339 if (starget->can_queue > 0)
1340 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001341 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001342}
1343
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344/*
1345 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1346 * return 0. We must end up running the queue again whenever 0 is
1347 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 */
1349static inline int scsi_host_queue_ready(struct request_queue *q,
1350 struct Scsi_Host *shost,
1351 struct scsi_device *sdev)
1352{
Christoph Hellwig74665012014-01-22 15:29:29 +01001353 unsigned int busy;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001354
James Bottomley939647e2005-09-18 15:05:20 -05001355 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001356 return 0;
1357
Ming Leid772a652018-08-27 15:24:43 +08001358 busy = atomic_inc_return(&shost->host_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001359 if (atomic_read(&shost->host_blocked) > 0) {
Ming Leid772a652018-08-27 15:24:43 +08001360 if (busy)
Christoph Hellwig74665012014-01-22 15:29:29 +01001361 goto starved;
1362
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 /*
1364 * unblock after host_blocked iterates to zero
1365 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001366 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001367 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001368
1369 SCSI_LOG_MLQUEUE(3,
1370 shost_printk(KERN_INFO, shost,
1371 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001373
Ming Leid772a652018-08-27 15:24:43 +08001374 if (shost->can_queue > 0 && busy >= shost->can_queue)
Christoph Hellwig74665012014-01-22 15:29:29 +01001375 goto starved;
1376 if (shost->host_self_blocked)
1377 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
1379 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001380 if (!list_empty(&sdev->starved_entry)) {
1381 spin_lock_irq(shost->host_lock);
1382 if (!list_empty(&sdev->starved_entry))
1383 list_del_init(&sdev->starved_entry);
1384 spin_unlock_irq(shost->host_lock);
1385 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386
Christoph Hellwig74665012014-01-22 15:29:29 +01001387 return 1;
1388
1389starved:
1390 spin_lock_irq(shost->host_lock);
1391 if (list_empty(&sdev->starved_entry))
1392 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001393 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001394out_dec:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001395 scsi_dec_host_busy(shost);
Christoph Hellwig74665012014-01-22 15:29:29 +01001396 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397}
1398
1399/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001400 * Busy state exporting function for request stacking drivers.
1401 *
1402 * For efficiency, no lock is taken to check the busy state of
1403 * shost/starget/sdev, since the returned value is not guaranteed and
1404 * may be changed after request stacking drivers call the function,
1405 * regardless of taking lock or not.
1406 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001407 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1408 * needs to return 'not busy'. Otherwise, request stacking drivers
1409 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001410 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001411static bool scsi_mq_lld_busy(struct request_queue *q)
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001412{
1413 struct scsi_device *sdev = q->queuedata;
1414 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001415
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001416 if (blk_queue_dying(q))
Jens Axboef664a3c2018-11-01 16:36:27 -06001417 return false;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001418
1419 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001420
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001421 /*
1422 * Ignore host/starget busy state.
1423 * Since block layer does not have a concept of fairness across
1424 * multiple queues, congestion of host/starget needs to be handled
1425 * in SCSI layer.
1426 */
1427 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Jens Axboef664a3c2018-11-01 16:36:27 -06001428 return true;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001429
Jens Axboef664a3c2018-11-01 16:36:27 -06001430 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431}
1432
Jens Axboe1aea6432006-01-09 16:03:03 +01001433static void scsi_softirq_done(struct request *rq)
1434{
Bart Van Asschebed22132017-08-25 13:46:32 -07001435 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001436 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001437 int disposition;
1438
1439 INIT_LIST_HEAD(&cmd->eh_entry);
1440
Jens Axboe242f9dc2008-09-14 05:55:09 -07001441 atomic_inc(&cmd->device->iodone_cnt);
1442 if (cmd->result)
1443 atomic_inc(&cmd->device->ioerr_cnt);
1444
Jens Axboe1aea6432006-01-09 16:03:03 +01001445 disposition = scsi_decide_disposition(cmd);
1446 if (disposition != SUCCESS &&
1447 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1448 sdev_printk(KERN_ERR, cmd->device,
1449 "timing out command, waited %lus\n",
1450 wait_for/HZ);
1451 disposition = SUCCESS;
1452 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001453
Jens Axboe1aea6432006-01-09 16:03:03 +01001454 scsi_log_completion(cmd, disposition);
1455
1456 switch (disposition) {
1457 case SUCCESS:
1458 scsi_finish_command(cmd);
1459 break;
1460 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001461 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001462 break;
1463 case ADD_TO_MLQUEUE:
1464 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1465 break;
1466 default:
Hannes Reineckea0658632017-04-06 15:36:35 +02001467 scsi_eh_scmd_add(cmd);
Hannes Reinecke2171b6d2017-04-06 15:36:34 +02001468 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001469 }
1470}
1471
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001472/**
Christoph Hellwig82042a22014-09-05 18:23:07 -07001473 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1474 * @cmd: command block we are dispatching.
1475 *
1476 * Return: nonzero return request was rejected and device's queue needs to be
1477 * plugged.
1478 */
1479static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1480{
1481 struct Scsi_Host *host = cmd->device->host;
1482 int rtn = 0;
1483
1484 atomic_inc(&cmd->device->iorequest_cnt);
1485
1486 /* check if the device is still usable */
1487 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1488 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1489 * returns an immediate error upwards, and signals
1490 * that the device is no longer present */
1491 cmd->result = DID_NO_CONNECT << 16;
1492 goto done;
1493 }
1494
1495 /* Check to see if the scsi lld made this device blocked. */
1496 if (unlikely(scsi_device_blocked(cmd->device))) {
1497 /*
1498 * in blocked state, the command is just put back on
1499 * the device queue. The suspend state has already
1500 * blocked the queue so future requests should not
1501 * occur until the device transitions out of the
1502 * suspend state.
1503 */
1504 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1505 "queuecommand : device blocked\n"));
1506 return SCSI_MLQUEUE_DEVICE_BUSY;
1507 }
1508
1509 /* Store the LUN value in cmnd, if needed. */
1510 if (cmd->device->lun_in_cdb)
1511 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1512 (cmd->device->lun << 5 & 0xe0);
1513
1514 scsi_log_send(cmd);
1515
1516 /*
1517 * Before we queue this command, check if the command
1518 * length exceeds what the host adapter can handle.
1519 */
1520 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1521 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1522 "queuecommand : command too long. "
1523 "cdb_size=%d host->max_cmd_len=%d\n",
1524 cmd->cmd_len, cmd->device->host->max_cmd_len));
1525 cmd->result = (DID_ABORT << 16);
1526 goto done;
1527 }
1528
1529 if (unlikely(host->shost_state == SHOST_DEL)) {
1530 cmd->result = (DID_NO_CONNECT << 16);
1531 goto done;
1532
1533 }
1534
1535 trace_scsi_dispatch_cmd_start(cmd);
1536 rtn = host->hostt->queuecommand(host, cmd);
1537 if (rtn) {
1538 trace_scsi_dispatch_cmd_error(cmd, rtn);
1539 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1540 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1541 rtn = SCSI_MLQUEUE_HOST_BUSY;
1542
1543 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1544 "queuecommand : request rejected\n"));
1545 }
1546
1547 return rtn;
1548 done:
1549 cmd->scsi_done(cmd);
1550 return 0;
1551}
1552
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001553/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
1554static unsigned int scsi_mq_sgl_size(struct Scsi_Host *shost)
1555{
1556 return min_t(unsigned int, shost->sg_tablesize, SG_CHUNK_SIZE) *
1557 sizeof(struct scatterlist);
1558}
1559
Christoph Hellwig785ba832018-11-09 14:42:37 +01001560static blk_status_t scsi_mq_prep_fn(struct request *req)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001561{
1562 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1563 struct scsi_device *sdev = req->q->queuedata;
1564 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001565 struct scatterlist *sg;
1566
Bart Van Assche08f78432017-06-02 14:22:00 -07001567 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001568
1569 req->special = cmd;
1570
1571 cmd->request = req;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001572
1573 cmd->tag = req->tag;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001574 cmd->prot_op = SCSI_PROT_NORMAL;
1575
Christoph Hellwigd2852032014-01-17 12:06:53 +01001576 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1577 cmd->sdb.table.sgl = sg;
1578
1579 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001580 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1581
1582 cmd->prot_sdb->table.sgl =
1583 (struct scatterlist *)(cmd->prot_sdb + 1);
1584 }
1585
Christoph Hellwigfe052522014-09-22 15:59:31 +02001586 blk_mq_start_request(req);
1587
Bart Van Assche8fe8ffb2017-10-20 11:46:45 -07001588 return scsi_setup_cmnd(sdev, req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001589}
1590
1591static void scsi_mq_done(struct scsi_cmnd *cmd)
1592{
Keith Buschf1342702018-11-26 09:54:29 -07001593 if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state)))
1594 return;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001595 trace_scsi_dispatch_cmd_done(cmd);
Keith Buschf1342702018-11-26 09:54:29 -07001596
1597 /*
1598 * If the block layer didn't complete the request due to a timeout
1599 * injection, scsi must clear its internal completed state so that the
1600 * timeout handler will see it needs to escalate its own error
1601 * recovery.
1602 */
1603 if (unlikely(!blk_mq_complete_request(cmd->request)))
1604 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001605}
1606
Ming Lei0df21c82017-10-14 17:22:32 +08001607static void scsi_mq_put_budget(struct blk_mq_hw_ctx *hctx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001608{
Ming Lei0df21c82017-10-14 17:22:32 +08001609 struct request_queue *q = hctx->queue;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001610 struct scsi_device *sdev = q->queuedata;
Ming Lei0df21c82017-10-14 17:22:32 +08001611
Ming Lei0df21c82017-10-14 17:22:32 +08001612 atomic_dec(&sdev->device_busy);
1613 put_device(&sdev->sdev_gendev);
1614}
1615
Ming Lei88022d72017-11-05 02:21:12 +08001616static bool scsi_mq_get_budget(struct blk_mq_hw_ctx *hctx)
Ming Lei0df21c82017-10-14 17:22:32 +08001617{
1618 struct request_queue *q = hctx->queue;
1619 struct scsi_device *sdev = q->queuedata;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001620
Christoph Hellwigd2852032014-01-17 12:06:53 +01001621 if (!get_device(&sdev->sdev_gendev))
1622 goto out;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001623 if (!scsi_dev_queue_ready(q, sdev))
1624 goto out_put_device;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001625
Ming Lei88022d72017-11-05 02:21:12 +08001626 return true;
Ming Lei0df21c82017-10-14 17:22:32 +08001627
Ming Lei0df21c82017-10-14 17:22:32 +08001628out_put_device:
1629 put_device(&sdev->sdev_gendev);
1630out:
Ming Lei7e70aa72017-12-05 15:52:56 +08001631 if (atomic_read(&sdev->device_busy) == 0 && !scsi_device_blocked(sdev))
1632 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
Ming Lei88022d72017-11-05 02:21:12 +08001633 return false;
Ming Lei0df21c82017-10-14 17:22:32 +08001634}
1635
Christoph Hellwigd2852032014-01-17 12:06:53 +01001636static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1637 const struct blk_mq_queue_data *bd)
1638{
1639 struct request *req = bd->rq;
1640 struct request_queue *q = req->q;
1641 struct scsi_device *sdev = q->queuedata;
1642 struct Scsi_Host *shost = sdev->host;
1643 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1644 blk_status_t ret;
1645 int reason;
1646
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001647 /*
1648 * If the device is not in running state we will reject some or all
1649 * commands.
1650 */
1651 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1652 ret = scsi_prep_state_check(sdev, req);
1653 if (ret != BLK_STS_OK)
1654 goto out_put_budget;
1655 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001656
1657 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001658 if (!scsi_target_queue_ready(shost, sdev))
Ming Lei826a70a2017-11-04 09:55:34 +08001659 goto out_put_budget;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001660 if (!scsi_host_queue_ready(q, shost, sdev))
1661 goto out_dec_target_busy;
1662
Christoph Hellwige8064022016-10-20 15:12:13 +02001663 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwig785ba832018-11-09 14:42:37 +01001664 ret = scsi_mq_prep_fn(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001665 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001666 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001667 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001668 } else {
Bart Van Asschecd464d82019-01-15 16:50:03 -08001669 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigfe052522014-09-22 15:59:31 +02001670 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001671 }
1672
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001673 if (sdev->simple_tags)
1674 cmd->flags |= SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001675 else
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001676 cmd->flags &= ~SCMD_TAGGED;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001677
Christoph Hellwigd2852032014-01-17 12:06:53 +01001678 scsi_init_cmd_errh(cmd);
1679 cmd->scsi_done = scsi_mq_done;
1680
1681 reason = scsi_dispatch_cmd(cmd);
1682 if (reason) {
1683 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001684 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001685 goto out_dec_host_busy;
1686 }
1687
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001688 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001689
1690out_dec_host_busy:
Bart Van Assche3bd6f432017-12-04 10:06:23 -08001691 scsi_dec_host_busy(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001692out_dec_target_busy:
1693 if (scsi_target(sdev)->can_queue > 0)
1694 atomic_dec(&scsi_target(sdev)->target_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001695out_put_budget:
1696 scsi_mq_put_budget(hctx);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001697 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001698 case BLK_STS_OK:
1699 break;
1700 case BLK_STS_RESOURCE:
Ming Lei86ff7c22018-01-30 22:04:57 -05001701 if (atomic_read(&sdev->device_busy) ||
1702 scsi_device_blocked(sdev))
1703 ret = BLK_STS_DEV_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001704 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001705 default:
Christoph Hellwigd2852032014-01-17 12:06:53 +01001706 /*
1707 * Make sure to release all allocated ressources when
1708 * we hit an error, as we will never see this command
1709 * again.
1710 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001711 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001712 scsi_mq_uninit_cmd(cmd);
1713 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001714 }
1715 return ret;
1716}
1717
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001718static enum blk_eh_timer_return scsi_timeout(struct request *req,
1719 bool reserved)
1720{
1721 if (reserved)
1722 return BLK_EH_RESET_TIMER;
1723 return scsi_times_out(req);
1724}
1725
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001726static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1727 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001728{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001729 struct Scsi_Host *shost = set->driver_data;
Bart Van Assche8e688252017-06-02 14:21:52 -07001730 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001731 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07001732 struct scatterlist *sg;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001733
Bart Van Assche8e688252017-06-02 14:21:52 -07001734 if (unchecked_isa_dma)
1735 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
1736 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
1737 GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001738 if (!cmd->sense_buffer)
1739 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001740 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07001741
1742 if (scsi_host_get_prot(shost)) {
1743 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1744 shost->hostt->cmd_size;
1745 cmd->prot_sdb = (void *)sg + scsi_mq_sgl_size(shost);
1746 }
1747
Christoph Hellwigd2852032014-01-17 12:06:53 +01001748 return 0;
1749}
1750
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001751static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
1752 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001753{
1754 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1755
Bart Van Assche8e688252017-06-02 14:21:52 -07001756 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
1757 cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001758}
1759
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001760static int scsi_map_queues(struct blk_mq_tag_set *set)
1761{
1762 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1763
1764 if (shost->hostt->map_queues)
1765 return shost->hostt->map_queues(shost);
Jens Axboeed76e322018-10-29 13:06:14 -06001766 return blk_mq_map_queues(&set->map[0]);
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001767}
1768
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001769void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770{
Lin Ming6f381fa2012-04-12 13:50:38 +08001771 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
Jens Axboea8474ce2007-08-07 09:02:51 +02001773 /*
1774 * this limit is imposed by hardware restrictions
1775 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001776 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07001777 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001778
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001779 if (scsi_host_prot_dma(shost)) {
1780 shost->sg_prot_tablesize =
1781 min_not_zero(shost->sg_prot_tablesize,
1782 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1783 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1784 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1785 }
1786
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001787 blk_queue_max_hw_sectors(q, shost->max_sectors);
Christoph Hellwig21e07db2018-04-03 19:09:59 +02001788 if (shost->unchecked_isa_dma)
1789 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001791 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792
Christoph Hellwig50c2e912018-12-13 16:17:03 +01001793 blk_queue_max_segment_size(q,
1794 min(shost->max_segment_size, dma_get_max_seg_size(dev)));
James Bottomley465ff312008-01-01 10:00:10 -06001795
1796 /*
Huacai Chen90addc62017-11-21 14:23:38 +01001797 * Set a reasonable default alignment: The larger of 32-byte (dword),
1798 * which is a common minimum for HBAs, and the minimum DMA alignment,
1799 * which is set by the platform.
1800 *
1801 * Devices that require a bigger alignment can increase it later.
James Bottomley465ff312008-01-01 10:00:10 -06001802 */
Huacai Chen90addc62017-11-21 14:23:38 +01001803 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001804}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001805EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06001806
Eric Biggersf363b082017-03-30 13:39:16 -07001807static const struct blk_mq_ops scsi_mq_ops = {
Ming Lei0df21c82017-10-14 17:22:32 +08001808 .get_budget = scsi_mq_get_budget,
1809 .put_budget = scsi_mq_put_budget,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001810 .queue_rq = scsi_queue_rq,
1811 .complete = scsi_softirq_done,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001812 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07001813#ifdef CONFIG_BLK_DEBUG_FS
1814 .show_rq = scsi_show_rq,
1815#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001816 .init_request = scsi_mq_init_request,
1817 .exit_request = scsi_mq_exit_request,
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001818 .initialize_rq_fn = scsi_initialize_rq,
Jens Axboe3a7ea2c42018-10-29 10:17:28 -06001819 .busy = scsi_mq_lld_busy,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001820 .map_queues = scsi_map_queues,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001821};
1822
1823struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
1824{
1825 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
1826 if (IS_ERR(sdev->request_queue))
1827 return NULL;
1828
1829 sdev->request_queue->queuedata = sdev;
1830 __scsi_init_queue(sdev->host, sdev->request_queue);
Christoph Hellwig17cb9602018-03-13 17:28:41 +01001831 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001832 return sdev->request_queue;
1833}
1834
1835int scsi_mq_setup_tags(struct Scsi_Host *shost)
1836{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001837 unsigned int cmd_size, sgl_size;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001838
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001839 sgl_size = scsi_mq_sgl_size(shost);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001840 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1841 if (scsi_host_get_prot(shost))
1842 cmd_size += sizeof(struct scsi_data_buffer) + sgl_size;
1843
1844 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
1845 shost->tag_set.ops = &scsi_mq_ops;
Bart Van Asscheefec4b92014-10-30 14:45:36 +01001846 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001847 shost->tag_set.queue_depth = shost->can_queue;
1848 shost->tag_set.cmd_size = cmd_size;
1849 shost->tag_set.numa_node = NUMA_NO_NODE;
1850 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
Shaohua Li24391c02015-01-23 14:18:00 -07001851 shost->tag_set.flags |=
1852 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001853 shost->tag_set.driver_data = shost;
1854
1855 return blk_mq_alloc_tag_set(&shost->tag_set);
1856}
1857
1858void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1859{
1860 blk_mq_free_tag_set(&shost->tag_set);
1861}
1862
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001863/**
1864 * scsi_device_from_queue - return sdev associated with a request_queue
1865 * @q: The request queue to return the sdev from
1866 *
1867 * Return the sdev associated with a request queue or NULL if the
1868 * request_queue does not reference a SCSI device.
1869 */
1870struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1871{
1872 struct scsi_device *sdev = NULL;
1873
Jens Axboef664a3c2018-11-01 16:36:27 -06001874 if (q->mq_ops == &scsi_mq_ops)
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001875 sdev = q->queuedata;
1876 if (!sdev || !get_device(&sdev->sdev_gendev))
1877 sdev = NULL;
1878
1879 return sdev;
1880}
1881EXPORT_SYMBOL_GPL(scsi_device_from_queue);
1882
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883/*
1884 * Function: scsi_block_requests()
1885 *
1886 * Purpose: Utility function used by low-level drivers to prevent further
1887 * commands from being queued to the device.
1888 *
1889 * Arguments: shost - Host in question
1890 *
1891 * Returns: Nothing
1892 *
1893 * Lock status: No locks are assumed held.
1894 *
1895 * Notes: There is no timer nor any other means by which the requests
1896 * get unblocked other than the low-level driver calling
1897 * scsi_unblock_requests().
1898 */
1899void scsi_block_requests(struct Scsi_Host *shost)
1900{
1901 shost->host_self_blocked = 1;
1902}
1903EXPORT_SYMBOL(scsi_block_requests);
1904
1905/*
1906 * Function: scsi_unblock_requests()
1907 *
1908 * Purpose: Utility function used by low-level drivers to allow further
1909 * commands from being queued to the device.
1910 *
1911 * Arguments: shost - Host in question
1912 *
1913 * Returns: Nothing
1914 *
1915 * Lock status: No locks are assumed held.
1916 *
1917 * Notes: There is no timer nor any other means by which the requests
1918 * get unblocked other than the low-level driver calling
1919 * scsi_unblock_requests().
1920 *
1921 * This is done as an API function so that changes to the
1922 * internals of the scsi mid-layer won't require wholesale
1923 * changes to drivers that use this feature.
1924 */
1925void scsi_unblock_requests(struct Scsi_Host *shost)
1926{
1927 shost->host_self_blocked = 0;
1928 scsi_run_host_queues(shost);
1929}
1930EXPORT_SYMBOL(scsi_unblock_requests);
1931
1932int __init scsi_init_queue(void)
1933{
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001934 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1935 sizeof(struct scsi_data_buffer),
1936 0, 0, NULL);
1937 if (!scsi_sdb_cache) {
1938 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001939 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001940 }
1941
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 return 0;
1943}
1944
1945void scsi_exit_queue(void)
1946{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03001947 kmem_cache_destroy(scsi_sense_cache);
1948 kmem_cache_destroy(scsi_sense_isadma_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001949 kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950}
James Bottomley5baba832006-03-18 14:10:35 -06001951
1952/**
1953 * scsi_mode_select - issue a mode select
1954 * @sdev: SCSI device to be queried
1955 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1956 * @sp: Save page bit (0 == don't save, 1 == save)
1957 * @modepage: mode page being requested
1958 * @buffer: request buffer (may not be smaller than eight bytes)
1959 * @len: length of request buffer.
1960 * @timeout: command timeout
1961 * @retries: number of retries before failing
1962 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001963 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001964 * must be SCSI_SENSE_BUFFERSIZE big.
1965 *
1966 * Returns zero if successful; negative error number or scsi
1967 * status on error
1968 *
1969 */
1970int
1971scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1972 unsigned char *buffer, int len, int timeout, int retries,
1973 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1974{
1975 unsigned char cmd[10];
1976 unsigned char *real_buffer;
1977 int ret;
1978
1979 memset(cmd, 0, sizeof(cmd));
1980 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
1981
1982 if (sdev->use_10_for_ms) {
1983 if (len > 65535)
1984 return -EINVAL;
1985 real_buffer = kmalloc(8 + len, GFP_KERNEL);
1986 if (!real_buffer)
1987 return -ENOMEM;
1988 memcpy(real_buffer + 8, buffer, len);
1989 len += 8;
1990 real_buffer[0] = 0;
1991 real_buffer[1] = 0;
1992 real_buffer[2] = data->medium_type;
1993 real_buffer[3] = data->device_specific;
1994 real_buffer[4] = data->longlba ? 0x01 : 0;
1995 real_buffer[5] = 0;
1996 real_buffer[6] = data->block_descriptor_length >> 8;
1997 real_buffer[7] = data->block_descriptor_length;
1998
1999 cmd[0] = MODE_SELECT_10;
2000 cmd[7] = len >> 8;
2001 cmd[8] = len;
2002 } else {
2003 if (len > 255 || data->block_descriptor_length > 255 ||
2004 data->longlba)
2005 return -EINVAL;
2006
2007 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2008 if (!real_buffer)
2009 return -ENOMEM;
2010 memcpy(real_buffer + 4, buffer, len);
2011 len += 4;
2012 real_buffer[0] = 0;
2013 real_buffer[1] = data->medium_type;
2014 real_buffer[2] = data->device_specific;
2015 real_buffer[3] = data->block_descriptor_length;
2016
2017
2018 cmd[0] = MODE_SELECT;
2019 cmd[4] = len;
2020 }
2021
2022 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002023 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002024 kfree(real_buffer);
2025 return ret;
2026}
2027EXPORT_SYMBOL_GPL(scsi_mode_select);
2028
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029/**
Rob Landleyeb448202007-11-03 13:30:39 -05002030 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002031 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 * @dbd: set if mode sense will allow block descriptors to be returned
2033 * @modepage: mode page being requested
2034 * @buffer: request buffer (may not be smaller than eight bytes)
2035 * @len: length of request buffer.
2036 * @timeout: command timeout
2037 * @retries: number of retries before failing
2038 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002039 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002040 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 *
2042 * Returns zero if unsuccessful, or the header offset (either 4
2043 * or 8 depending on whether a six or ten byte command was
2044 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002045 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046int
James Bottomley1cf72692005-08-28 11:27:01 -05002047scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002049 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2050{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 unsigned char cmd[12];
2052 int use_10_for_ms;
2053 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002054 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002055 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056
2057 memset(data, 0, sizeof(*data));
2058 memset(&cmd[0], 0, 12);
2059 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2060 cmd[2] = modepage;
2061
James Bottomleyea73a9f2005-08-28 11:33:52 -05002062 /* caller might not be interested in sense, but we need it */
2063 if (!sshdr)
2064 sshdr = &my_sshdr;
2065
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002067 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068
2069 if (use_10_for_ms) {
2070 if (len < 8)
2071 len = 8;
2072
2073 cmd[0] = MODE_SENSE_10;
2074 cmd[8] = len;
2075 header_length = 8;
2076 } else {
2077 if (len < 4)
2078 len = 4;
2079
2080 cmd[0] = MODE_SENSE;
2081 cmd[4] = len;
2082 header_length = 4;
2083 }
2084
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 memset(buffer, 0, len);
2086
James Bottomley1cf72692005-08-28 11:27:01 -05002087 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002088 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089
2090 /* This code looks awful: what it's doing is making sure an
2091 * ILLEGAL REQUEST sense return identifies the actual command
2092 * byte as the problem. MODE_SENSE commands can return
2093 * ILLEGAL REQUEST if the code page isn't supported */
2094
James Bottomley1cf72692005-08-28 11:27:01 -05002095 if (use_10_for_ms && !scsi_status_is_good(result) &&
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002096 driver_byte(result) == DRIVER_SENSE) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002097 if (scsi_sense_valid(sshdr)) {
2098 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2099 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 /*
2101 * Invalid command operation code
2102 */
James Bottomley1cf72692005-08-28 11:27:01 -05002103 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 goto retry;
2105 }
2106 }
2107 }
2108
James Bottomley1cf72692005-08-28 11:27:01 -05002109 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002110 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2111 (modepage == 6 || modepage == 8))) {
2112 /* Initio breakage? */
2113 header_length = 0;
2114 data->length = 13;
2115 data->medium_type = 0;
2116 data->device_specific = 0;
2117 data->longlba = 0;
2118 data->block_descriptor_length = 0;
2119 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 data->length = buffer[0]*256 + buffer[1] + 2;
2121 data->medium_type = buffer[2];
2122 data->device_specific = buffer[3];
2123 data->longlba = buffer[4] & 0x01;
2124 data->block_descriptor_length = buffer[6]*256
2125 + buffer[7];
2126 } else {
2127 data->length = buffer[0] + 1;
2128 data->medium_type = buffer[1];
2129 data->device_specific = buffer[2];
2130 data->block_descriptor_length = buffer[3];
2131 }
Al Viro6d73c852006-02-23 02:03:16 +01002132 data->header_length = header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002133 } else if ((status_byte(result) == CHECK_CONDITION) &&
2134 scsi_sense_valid(sshdr) &&
2135 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2136 retry_count--;
2137 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 }
2139
James Bottomley1cf72692005-08-28 11:27:01 -05002140 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141}
2142EXPORT_SYMBOL(scsi_mode_sense);
2143
James Bottomley001aac22007-12-02 19:10:40 +02002144/**
2145 * scsi_test_unit_ready - test if unit is ready
2146 * @sdev: scsi device to change the state of.
2147 * @timeout: command timeout
2148 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002149 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002150 *
2151 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002152 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002153 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154int
James Bottomley001aac22007-12-02 19:10:40 +02002155scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002156 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 char cmd[] = {
2159 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2160 };
2161 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002162
James Bottomley001aac22007-12-02 19:10:40 +02002163 /* try to eat the UNIT_ATTENTION if there are enough retries */
2164 do {
2165 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
Bart Van Assche9b91fd32018-02-12 10:57:52 -08002166 timeout, 1, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002167 if (sdev->removable && scsi_sense_valid(sshdr) &&
2168 sshdr->sense_key == UNIT_ATTENTION)
2169 sdev->changed = 1;
2170 } while (scsi_sense_valid(sshdr) &&
2171 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002172
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 return result;
2174}
2175EXPORT_SYMBOL(scsi_test_unit_ready);
2176
2177/**
Rob Landleyeb448202007-11-03 13:30:39 -05002178 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 * @sdev: scsi device to change the state of.
2180 * @state: state to change to.
2181 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002182 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002184 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185int
2186scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2187{
2188 enum scsi_device_state oldstate = sdev->sdev_state;
2189
2190 if (state == oldstate)
2191 return 0;
2192
2193 switch (state) {
2194 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002195 switch (oldstate) {
2196 case SDEV_CREATED_BLOCK:
2197 break;
2198 default:
2199 goto illegal;
2200 }
2201 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202
2203 case SDEV_RUNNING:
2204 switch (oldstate) {
2205 case SDEV_CREATED:
2206 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002207 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 case SDEV_QUIESCE:
2209 case SDEV_BLOCK:
2210 break;
2211 default:
2212 goto illegal;
2213 }
2214 break;
2215
2216 case SDEV_QUIESCE:
2217 switch (oldstate) {
2218 case SDEV_RUNNING:
2219 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002220 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 break;
2222 default:
2223 goto illegal;
2224 }
2225 break;
2226
2227 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002228 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229 switch (oldstate) {
2230 case SDEV_CREATED:
2231 case SDEV_RUNNING:
2232 case SDEV_QUIESCE:
2233 case SDEV_BLOCK:
2234 break;
2235 default:
2236 goto illegal;
2237 }
2238 break;
2239
2240 case SDEV_BLOCK:
2241 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002243 case SDEV_CREATED_BLOCK:
Hannes Reineckea33e5bf2018-10-07 10:35:35 +02002244 case SDEV_OFFLINE:
James Bottomley6f4267e2008-08-22 16:53:31 -05002245 break;
2246 default:
2247 goto illegal;
2248 }
2249 break;
2250
2251 case SDEV_CREATED_BLOCK:
2252 switch (oldstate) {
2253 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 break;
2255 default:
2256 goto illegal;
2257 }
2258 break;
2259
2260 case SDEV_CANCEL:
2261 switch (oldstate) {
2262 case SDEV_CREATED:
2263 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002264 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002266 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 break;
2268 default:
2269 goto illegal;
2270 }
2271 break;
2272
2273 case SDEV_DEL:
2274 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002275 case SDEV_CREATED:
2276 case SDEV_RUNNING:
2277 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002278 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002280 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002281 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282 break;
2283 default:
2284 goto illegal;
2285 }
2286 break;
2287
2288 }
2289 sdev->sdev_state = state;
2290 return 0;
2291
2292 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002293 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002294 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002295 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002296 scsi_device_state_name(oldstate),
2297 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 );
2299 return -EINVAL;
2300}
2301EXPORT_SYMBOL(scsi_device_set_state);
2302
2303/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002304 * sdev_evt_emit - emit a single SCSI device uevent
2305 * @sdev: associated SCSI device
2306 * @evt: event to emit
2307 *
2308 * Send a single uevent (scsi_event) to the associated scsi_device.
2309 */
2310static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2311{
2312 int idx = 0;
2313 char *envp[3];
2314
2315 switch (evt->evt_type) {
2316 case SDEV_EVT_MEDIA_CHANGE:
2317 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2318 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002319 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002320 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002321 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2322 break;
2323 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2324 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2325 break;
2326 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2327 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2328 break;
2329 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2330 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2331 break;
2332 case SDEV_EVT_LUN_CHANGE_REPORTED:
2333 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2334 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002335 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2336 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2337 break;
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002338 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2339 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2340 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002341 default:
2342 /* do nothing */
2343 break;
2344 }
2345
2346 envp[idx++] = NULL;
2347
2348 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2349}
2350
2351/**
2352 * sdev_evt_thread - send a uevent for each scsi event
2353 * @work: work struct for scsi_device
2354 *
2355 * Dispatch queued events to their associated scsi_device kobjects
2356 * as uevents.
2357 */
2358void scsi_evt_thread(struct work_struct *work)
2359{
2360 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002361 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002362 LIST_HEAD(event_list);
2363
2364 sdev = container_of(work, struct scsi_device, event_work);
2365
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002366 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2367 if (test_and_clear_bit(evt_type, sdev->pending_events))
2368 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2369
Jeff Garzika341cd02007-10-29 17:15:22 -04002370 while (1) {
2371 struct scsi_event *evt;
2372 struct list_head *this, *tmp;
2373 unsigned long flags;
2374
2375 spin_lock_irqsave(&sdev->list_lock, flags);
2376 list_splice_init(&sdev->event_list, &event_list);
2377 spin_unlock_irqrestore(&sdev->list_lock, flags);
2378
2379 if (list_empty(&event_list))
2380 break;
2381
2382 list_for_each_safe(this, tmp, &event_list) {
2383 evt = list_entry(this, struct scsi_event, node);
2384 list_del(&evt->node);
2385 scsi_evt_emit(sdev, evt);
2386 kfree(evt);
2387 }
2388 }
2389}
2390
2391/**
2392 * sdev_evt_send - send asserted event to uevent thread
2393 * @sdev: scsi_device event occurred on
2394 * @evt: event to send
2395 *
2396 * Assert scsi device event asynchronously.
2397 */
2398void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2399{
2400 unsigned long flags;
2401
Kay Sievers4d1566e2008-03-19 13:04:47 +01002402#if 0
2403 /* FIXME: currently this check eliminates all media change events
2404 * for polled devices. Need to update to discriminate between AN
2405 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002406 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2407 kfree(evt);
2408 return;
2409 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002410#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002411
2412 spin_lock_irqsave(&sdev->list_lock, flags);
2413 list_add_tail(&evt->node, &sdev->event_list);
2414 schedule_work(&sdev->event_work);
2415 spin_unlock_irqrestore(&sdev->list_lock, flags);
2416}
2417EXPORT_SYMBOL_GPL(sdev_evt_send);
2418
2419/**
2420 * sdev_evt_alloc - allocate a new scsi event
2421 * @evt_type: type of event to allocate
2422 * @gfpflags: GFP flags for allocation
2423 *
2424 * Allocates and returns a new scsi_event.
2425 */
2426struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2427 gfp_t gfpflags)
2428{
2429 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2430 if (!evt)
2431 return NULL;
2432
2433 evt->evt_type = evt_type;
2434 INIT_LIST_HEAD(&evt->node);
2435
2436 /* evt_type-specific initialization, if any */
2437 switch (evt_type) {
2438 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002439 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2440 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2441 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2442 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2443 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002444 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002445 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002446 default:
2447 /* do nothing */
2448 break;
2449 }
2450
2451 return evt;
2452}
2453EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2454
2455/**
2456 * sdev_evt_send_simple - send asserted event to uevent thread
2457 * @sdev: scsi_device event occurred on
2458 * @evt_type: type of event to send
2459 * @gfpflags: GFP flags for allocation
2460 *
2461 * Assert scsi device event asynchronously, given an event type.
2462 */
2463void sdev_evt_send_simple(struct scsi_device *sdev,
2464 enum scsi_device_event evt_type, gfp_t gfpflags)
2465{
2466 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2467 if (!evt) {
2468 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2469 evt_type);
2470 return;
2471 }
2472
2473 sdev_evt_send(sdev, evt);
2474}
2475EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2476
2477/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 * scsi_device_quiesce - Block user issued commands.
2479 * @sdev: scsi device to quiesce.
2480 *
2481 * This works by trying to transition to the SDEV_QUIESCE state
2482 * (which must be a legal transition). When the device is in this
2483 * state, only special requests will be accepted, all others will
2484 * be deferred. Since special requests may also be requeued requests,
2485 * a successful return doesn't guarantee the device will be
2486 * totally quiescent.
2487 *
2488 * Must be called with user context, may sleep.
2489 *
2490 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002491 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492int
2493scsi_device_quiesce(struct scsi_device *sdev)
2494{
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002495 struct request_queue *q = sdev->request_queue;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002496 int err;
2497
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002498 /*
2499 * It is allowed to call scsi_device_quiesce() multiple times from
2500 * the same context but concurrent scsi_device_quiesce() calls are
2501 * not allowed.
2502 */
2503 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2504
Bart Van Asschecd84a622018-09-26 14:01:04 -07002505 if (sdev->quiesced_by == current)
2506 return 0;
2507
2508 blk_set_pm_only(q);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002509
2510 blk_mq_freeze_queue(q);
2511 /*
Bart Van Asschecd84a622018-09-26 14:01:04 -07002512 * Ensure that the effect of blk_set_pm_only() will be visible
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002513 * for percpu_ref_tryget() callers that occur after the queue
2514 * unfreeze even if the queue was already frozen before this function
2515 * was called. See also https://lwn.net/Articles/573497/.
2516 */
2517 synchronize_rcu();
2518 blk_mq_unfreeze_queue(q);
2519
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002520 mutex_lock(&sdev->state_mutex);
2521 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002522 if (err == 0)
2523 sdev->quiesced_by = current;
2524 else
Bart Van Asschecd84a622018-09-26 14:01:04 -07002525 blk_clear_pm_only(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002526 mutex_unlock(&sdev->state_mutex);
2527
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002528 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529}
2530EXPORT_SYMBOL(scsi_device_quiesce);
2531
2532/**
2533 * scsi_device_resume - Restart user issued commands to a quiesced device.
2534 * @sdev: scsi device to resume.
2535 *
2536 * Moves the device from quiesced back to running and restarts the
2537 * queues.
2538 *
2539 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002540 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002541void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002542{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002543 /* check if the device state was mutated prior to resume, and if
2544 * so assume the state is being managed elsewhere (for example
2545 * device deleted during suspend)
2546 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002547 mutex_lock(&sdev->state_mutex);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002548 WARN_ON_ONCE(!sdev->quiesced_by);
2549 sdev->quiesced_by = NULL;
Bart Van Asschecd84a622018-09-26 14:01:04 -07002550 blk_clear_pm_only(sdev->request_queue);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002551 if (sdev->sdev_state == SDEV_QUIESCE)
2552 scsi_device_set_state(sdev, SDEV_RUNNING);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002553 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002554}
2555EXPORT_SYMBOL(scsi_device_resume);
2556
2557static void
2558device_quiesce_fn(struct scsi_device *sdev, void *data)
2559{
2560 scsi_device_quiesce(sdev);
2561}
2562
2563void
2564scsi_target_quiesce(struct scsi_target *starget)
2565{
2566 starget_for_each_device(starget, NULL, device_quiesce_fn);
2567}
2568EXPORT_SYMBOL(scsi_target_quiesce);
2569
2570static void
2571device_resume_fn(struct scsi_device *sdev, void *data)
2572{
2573 scsi_device_resume(sdev);
2574}
2575
2576void
2577scsi_target_resume(struct scsi_target *starget)
2578{
2579 starget_for_each_device(starget, NULL, device_resume_fn);
2580}
2581EXPORT_SYMBOL(scsi_target_resume);
2582
2583/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002584 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2585 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002587 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002589 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002591 * Notes:
2592 * This routine transitions the device to the SDEV_BLOCK state (which must be
2593 * a legal transition). When the device is in this state, command processing
2594 * is paused until the device leaves the SDEV_BLOCK state. See also
2595 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002596 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002597int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598{
Jens Axboe165125e2007-07-24 09:28:11 +02002599 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 int err = 0;
2601
2602 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002603 if (err) {
2604 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2605
2606 if (err)
2607 return err;
2608 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609
2610 /*
2611 * The device has transitioned to SDEV_BLOCK. Stop the
2612 * block layer from calling the midlayer with this device's
2613 * request queue.
2614 */
Jens Axboef664a3c2018-11-01 16:36:27 -06002615 blk_mq_quiesce_queue_nowait(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616 return 0;
2617}
Bart Van Assche551eb592017-06-02 14:21:53 -07002618EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2619
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002621 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2622 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002624 * Pause SCSI command processing on the specified device and wait until all
2625 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002627 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002628 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002629 * Note:
2630 * This routine transitions the device to the SDEV_BLOCK state (which must be
2631 * a legal transition). When the device is in this state, command processing
2632 * is paused until the device leaves the SDEV_BLOCK state. See also
2633 * scsi_internal_device_unblock().
2634 *
2635 * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
2636 * scsi_internal_device_block() has blocked a SCSI device and also
2637 * remove the rport mutex lock and unlock calls from srp_queuecommand().
Rob Landleyeb448202007-11-03 13:30:39 -05002638 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002639static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640{
Bart Van Assche551eb592017-06-02 14:21:53 -07002641 struct request_queue *q = sdev->request_queue;
2642 int err;
2643
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002644 mutex_lock(&sdev->state_mutex);
Bart Van Assche551eb592017-06-02 14:21:53 -07002645 err = scsi_internal_device_block_nowait(sdev);
Jens Axboef664a3c2018-11-01 16:36:27 -06002646 if (err == 0)
2647 blk_mq_quiesce_queue(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002648 mutex_unlock(&sdev->state_mutex);
2649
Bart Van Assche551eb592017-06-02 14:21:53 -07002650 return err;
2651}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652
Bart Van Assche66483a42017-06-02 14:21:56 -07002653void scsi_start_queue(struct scsi_device *sdev)
2654{
2655 struct request_queue *q = sdev->request_queue;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002656
Jens Axboef664a3c2018-11-01 16:36:27 -06002657 blk_mq_unquiesce_queue(q);
Bart Van Assche66483a42017-06-02 14:21:56 -07002658}
2659
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660/**
Bart Van Assche43f75712017-06-02 14:21:54 -07002661 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07002663 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002665 * Restart the device queue for a previously suspended SCSI device. Does not
2666 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002668 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002670 * Notes:
2671 * This routine transitions the device to the SDEV_RUNNING state or to one of
2672 * the offline states (which must be a legal transition) allowing the midlayer
2673 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002674 */
Bart Van Assche43f75712017-06-02 14:21:54 -07002675int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2676 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002678 /*
2679 * Try to transition the scsi device to SDEV_RUNNING or one of the
2680 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002682 switch (sdev->sdev_state) {
2683 case SDEV_BLOCK:
2684 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002685 sdev->sdev_state = new_state;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002686 break;
2687 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002688 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2689 new_state == SDEV_OFFLINE)
2690 sdev->sdev_state = new_state;
2691 else
2692 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002693 break;
2694 case SDEV_CANCEL:
2695 case SDEV_OFFLINE:
2696 break;
2697 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002698 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002699 }
Bart Van Assche66483a42017-06-02 14:21:56 -07002700 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701
2702 return 0;
2703}
Bart Van Assche43f75712017-06-02 14:21:54 -07002704EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2705
2706/**
2707 * scsi_internal_device_unblock - resume a device after a block request
2708 * @sdev: device to resume
2709 * @new_state: state to set the device to after unblocking
2710 *
2711 * Restart the device queue for a previously suspended SCSI device. May sleep.
2712 *
2713 * Returns zero if successful or a negative error code upon failure.
2714 *
2715 * Notes:
2716 * This routine transitions the device to the SDEV_RUNNING state or to one of
2717 * the offline states (which must be a legal transition) allowing the midlayer
2718 * to goose the queue for this device.
2719 */
2720static int scsi_internal_device_unblock(struct scsi_device *sdev,
2721 enum scsi_device_state new_state)
2722{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002723 int ret;
2724
2725 mutex_lock(&sdev->state_mutex);
2726 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2727 mutex_unlock(&sdev->state_mutex);
2728
2729 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07002730}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731
2732static void
2733device_block(struct scsi_device *sdev, void *data)
2734{
Bart Van Assche551eb592017-06-02 14:21:53 -07002735 scsi_internal_device_block(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736}
2737
2738static int
2739target_block(struct device *dev, void *data)
2740{
2741 if (scsi_is_target_device(dev))
2742 starget_for_each_device(to_scsi_target(dev), NULL,
2743 device_block);
2744 return 0;
2745}
2746
2747void
2748scsi_target_block(struct device *dev)
2749{
2750 if (scsi_is_target_device(dev))
2751 starget_for_each_device(to_scsi_target(dev), NULL,
2752 device_block);
2753 else
2754 device_for_each_child(dev, NULL, target_block);
2755}
2756EXPORT_SYMBOL_GPL(scsi_target_block);
2757
2758static void
2759device_unblock(struct scsi_device *sdev, void *data)
2760{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002761 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762}
2763
2764static int
2765target_unblock(struct device *dev, void *data)
2766{
2767 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002768 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769 device_unblock);
2770 return 0;
2771}
2772
2773void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002774scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775{
2776 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002777 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778 device_unblock);
2779 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002780 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781}
2782EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002783
2784/**
2785 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002786 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002787 * @sg_count: number of segments in sg
2788 * @offset: offset in bytes into sg, on return offset into the mapped area
2789 * @len: bytes to map, on return number of bytes mapped
2790 *
2791 * Returns virtual address of the start of the mapped page
2792 */
Jens Axboec6132da2007-10-16 11:08:49 +02002793void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002794 size_t *offset, size_t *len)
2795{
2796 int i;
2797 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002798 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002799 struct page *page;
2800
Andrew Morton22cfefb2007-02-05 16:39:03 -08002801 WARN_ON(!irqs_disabled());
2802
Jens Axboec6132da2007-10-16 11:08:49 +02002803 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002804 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002805 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002806 if (sg_len > *offset)
2807 break;
2808 }
2809
2810 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002811 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2812 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002813 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002814 WARN_ON(1);
2815 return NULL;
2816 }
2817
2818 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002819 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002820
2821 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002822 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002823 *offset &= ~PAGE_MASK;
2824
2825 /* Bytes in this sg-entry from *offset to the end of the page */
2826 sg_len = PAGE_SIZE - *offset;
2827 if (*len > sg_len)
2828 *len = sg_len;
2829
Cong Wang77dfce02011-11-25 23:14:23 +08002830 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002831}
2832EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2833
2834/**
Rob Landleyeb448202007-11-03 13:30:39 -05002835 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002836 * @virt: virtual address to be unmapped
2837 */
2838void scsi_kunmap_atomic_sg(void *virt)
2839{
Cong Wang77dfce02011-11-25 23:14:23 +08002840 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002841}
2842EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002843
2844void sdev_disable_disk_events(struct scsi_device *sdev)
2845{
2846 atomic_inc(&sdev->disk_events_disable_depth);
2847}
2848EXPORT_SYMBOL(sdev_disable_disk_events);
2849
2850void sdev_enable_disk_events(struct scsi_device *sdev)
2851{
2852 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2853 return;
2854 atomic_dec(&sdev->disk_events_disable_depth);
2855}
2856EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002857
2858/**
2859 * scsi_vpd_lun_id - return a unique device identification
2860 * @sdev: SCSI device
2861 * @id: buffer for the identification
2862 * @id_len: length of the buffer
2863 *
2864 * Copies a unique device identification into @id based
2865 * on the information in the VPD page 0x83 of the device.
2866 * The string will be formatted as a SCSI name string.
2867 *
2868 * Returns the length of the identification or error on failure.
2869 * If the identifier is longer than the supplied buffer the actual
2870 * identifier length is returned and the buffer is not zero-padded.
2871 */
2872int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
2873{
2874 u8 cur_id_type = 0xff;
2875 u8 cur_id_size = 0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002876 const unsigned char *d, *cur_id_str;
2877 const struct scsi_vpd *vpd_pg83;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002878 int id_size = -EINVAL;
2879
2880 rcu_read_lock();
2881 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
2882 if (!vpd_pg83) {
2883 rcu_read_unlock();
2884 return -ENXIO;
2885 }
2886
2887 /*
2888 * Look for the correct descriptor.
2889 * Order of preference for lun descriptor:
2890 * - SCSI name string
2891 * - NAA IEEE Registered Extended
2892 * - EUI-64 based 16-byte
2893 * - EUI-64 based 12-byte
2894 * - NAA IEEE Registered
2895 * - NAA IEEE Extended
Hannes Reinecked2308232016-05-09 09:14:29 +02002896 * - T10 Vendor ID
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002897 * as longer descriptors reduce the likelyhood
2898 * of identification clashes.
2899 */
2900
2901 /* The id string must be at least 20 bytes + terminating NULL byte */
2902 if (id_len < 21) {
2903 rcu_read_unlock();
2904 return -EINVAL;
2905 }
2906
2907 memset(id, 0, id_len);
Bart Van Asscheccf1e002017-08-29 08:50:13 -07002908 d = vpd_pg83->data + 4;
2909 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002910 /* Skip designators not referring to the LUN */
2911 if ((d[1] & 0x30) != 0x00)
2912 goto next_desig;
2913
2914 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02002915 case 0x1:
2916 /* T10 Vendor ID */
2917 if (cur_id_size > d[3])
2918 break;
2919 /* Prefer anything */
2920 if (cur_id_type > 0x01 && cur_id_type != 0xff)
2921 break;
2922 cur_id_size = d[3];
2923 if (cur_id_size + 4 > id_len)
2924 cur_id_size = id_len - 4;
2925 cur_id_str = d + 4;
2926 cur_id_type = d[1] & 0xf;
2927 id_size = snprintf(id, id_len, "t10.%*pE",
2928 cur_id_size, cur_id_str);
2929 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01002930 case 0x2:
2931 /* EUI-64 */
2932 if (cur_id_size > d[3])
2933 break;
2934 /* Prefer NAA IEEE Registered Extended */
2935 if (cur_id_type == 0x3 &&
2936 cur_id_size == d[3])
2937 break;
2938 cur_id_size = d[3];
2939 cur_id_str = d + 4;
2940 cur_id_type = d[1] & 0xf;
2941 switch (cur_id_size) {
2942 case 8:
2943 id_size = snprintf(id, id_len,
2944 "eui.%8phN",
2945 cur_id_str);
2946 break;
2947 case 12:
2948 id_size = snprintf(id, id_len,
2949 "eui.%12phN",
2950 cur_id_str);
2951 break;
2952 case 16:
2953 id_size = snprintf(id, id_len,
2954 "eui.%16phN",
2955 cur_id_str);
2956 break;
2957 default:
2958 cur_id_size = 0;
2959 break;
2960 }
2961 break;
2962 case 0x3:
2963 /* NAA */
2964 if (cur_id_size > d[3])
2965 break;
2966 cur_id_size = d[3];
2967 cur_id_str = d + 4;
2968 cur_id_type = d[1] & 0xf;
2969 switch (cur_id_size) {
2970 case 8:
2971 id_size = snprintf(id, id_len,
2972 "naa.%8phN",
2973 cur_id_str);
2974 break;
2975 case 16:
2976 id_size = snprintf(id, id_len,
2977 "naa.%16phN",
2978 cur_id_str);
2979 break;
2980 default:
2981 cur_id_size = 0;
2982 break;
2983 }
2984 break;
2985 case 0x8:
2986 /* SCSI name string */
2987 if (cur_id_size + 4 > d[3])
2988 break;
2989 /* Prefer others for truncated descriptor */
2990 if (cur_id_size && d[3] > id_len)
2991 break;
2992 cur_id_size = id_size = d[3];
2993 cur_id_str = d + 4;
2994 cur_id_type = d[1] & 0xf;
2995 if (cur_id_size >= id_len)
2996 cur_id_size = id_len - 1;
2997 memcpy(id, cur_id_str, cur_id_size);
2998 /* Decrease priority for truncated descriptor */
2999 if (cur_id_size != id_size)
3000 cur_id_size = 6;
3001 break;
3002 default:
3003 break;
3004 }
3005next_desig:
3006 d += d[3] + 4;
3007 }
3008 rcu_read_unlock();
3009
3010 return id_size;
3011}
3012EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003013
3014/*
3015 * scsi_vpd_tpg_id - return a target port group identifier
3016 * @sdev: SCSI device
3017 *
3018 * Returns the Target Port Group identifier from the information
3019 * froom VPD page 0x83 of the device.
3020 *
3021 * Returns the identifier or error on failure.
3022 */
3023int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3024{
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003025 const unsigned char *d;
3026 const struct scsi_vpd *vpd_pg83;
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003027 int group_id = -EAGAIN, rel_port = -1;
3028
3029 rcu_read_lock();
3030 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3031 if (!vpd_pg83) {
3032 rcu_read_unlock();
3033 return -ENXIO;
3034 }
3035
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003036 d = vpd_pg83->data + 4;
3037 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003038 switch (d[1] & 0xf) {
3039 case 0x4:
3040 /* Relative target port */
3041 rel_port = get_unaligned_be16(&d[6]);
3042 break;
3043 case 0x5:
3044 /* Target port group */
3045 group_id = get_unaligned_be16(&d[6]);
3046 break;
3047 default:
3048 break;
3049 }
3050 d += d[3] + 4;
3051 }
3052 rcu_read_unlock();
3053
3054 if (group_id >= 0 && rel_id && rel_port != -1)
3055 *rel_id = rel_port;
3056
3057 return group_id;
3058}
3059EXPORT_SYMBOL(scsi_vpd_tpg_id);