blob: 621d841d819a379b8fac65a86a6c59267bedf4cd [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Christoph Hellwigd2852032014-01-17 12:06:53 +01003 * Copyright (C) 1999 Eric Youngdale
4 * Copyright (C) 2014 Christoph Hellwig
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * SCSI queueing library.
7 * Initial versions: Eric Youngdale (eric@andante.org).
8 * Based upon conversations with large numbers
9 * of people at Linux Expo.
10 */
11
12#include <linux/bio.h>
James Bottomleyd3f46f32008-01-15 11:11:46 -060013#include <linux/bitops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/blkdev.h>
15#include <linux/completion.h>
16#include <linux/kernel.h>
Paul Gortmaker09703662011-05-27 09:37:25 -040017#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/init.h>
19#include <linux/pci.h>
20#include <linux/delay.h>
James Bottomleyfaead262006-02-14 10:42:07 -060021#include <linux/hardirq.h>
Jens Axboec6132da2007-10-16 11:08:49 +020022#include <linux/scatterlist.h>
Christoph Hellwigd2852032014-01-17 12:06:53 +010023#include <linux/blk-mq.h>
Christoph Hellwigfe45e632021-09-20 14:33:27 +020024#include <linux/blk-integrity.h>
Hannes Reineckef1569ff2014-10-24 14:27:07 +020025#include <linux/ratelimit.h>
Hannes Reineckea8aa3972015-12-01 10:16:57 +010026#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
28#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020029#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <scsi/scsi_dbg.h>
31#include <scsi/scsi_device.h>
32#include <scsi/scsi_driver.h>
33#include <scsi/scsi_eh.h>
34#include <scsi/scsi_host.h>
Bart Van Assche7aa686d2017-05-02 10:45:03 -070035#include <scsi/scsi_transport.h> /* __scsi_init_queue() */
Christoph Hellwigee14c672015-08-27 14:16:59 +020036#include <scsi/scsi_dh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Christoph Hellwig3b5382c2014-05-06 12:25:40 +020038#include <trace/events/scsi.h>
39
Bart Van Assche0eebd002017-04-26 13:47:57 -070040#include "scsi_debugfs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#include "scsi_priv.h"
42#include "scsi_logging.h"
43
Ming Lei92524fa2019-04-28 15:39:31 +080044/*
45 * Size of integrity metadata is usually small, 1 inline sg should
46 * cover normal cases.
47 */
Ming Lei3e99b3b2019-06-06 16:34:09 +080048#ifdef CONFIG_ARCH_NO_SG_CHAIN
49#define SCSI_INLINE_PROT_SG_CNT 0
50#define SCSI_INLINE_SG_CNT 0
51#else
Ming Lei92524fa2019-04-28 15:39:31 +080052#define SCSI_INLINE_PROT_SG_CNT 1
Ming Lei3dccdf52019-04-28 15:39:32 +080053#define SCSI_INLINE_SG_CNT 2
Ming Lei3e99b3b2019-06-06 16:34:09 +080054#endif
Ming Lei3dccdf52019-04-28 15:39:32 +080055
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030056static struct kmem_cache *scsi_sense_cache;
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030057static DEFINE_MUTEX(scsi_sense_cache_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
Bart Van Asschea45a1f362017-08-30 16:58:42 -070059static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd);
60
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030061int scsi_init_sense_cache(struct Scsi_Host *shost)
62{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030063 int ret = 0;
64
Ming Leif9b05302019-07-12 10:08:19 +080065 mutex_lock(&scsi_sense_cache_mutex);
Christoph Hellwigaaff5eb2021-03-31 09:29:58 +020066 if (!scsi_sense_cache) {
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030067 scsi_sense_cache =
David Windsor0afe76e2017-06-10 22:50:45 -040068 kmem_cache_create_usercopy("scsi_sense_cache",
69 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN,
70 0, SCSI_SENSE_BUFFERSIZE, NULL);
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030071 if (!scsi_sense_cache)
72 ret = -ENOMEM;
73 }
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +030074 mutex_unlock(&scsi_sense_cache_mutex);
75 return ret;
76}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +020077
Jens Axboea488e742010-04-16 21:13:15 +020078/*
79 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
80 * not change behaviour from the previous unplug mechanism, experimentation
81 * may prove this needs changing.
82 */
83#define SCSI_QUEUE_DELAY 3
84
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +010085static void
86scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087{
88 struct Scsi_Host *host = cmd->device->host;
89 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -050090 struct scsi_target *starget = scsi_target(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
92 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +090093 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 *
95 * If the host/device isn't busy, assume that something actually
96 * completed, and that we should be able to queue a command now.
97 *
98 * Note that the prior mid-layer assumption that any host could
99 * always queue at least one command is now broken. The mid-layer
100 * will implement a user specifiable stall (see
101 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
102 * if a command is requeued with no other commands outstanding
103 * either for the device or for the host.
104 */
Mike Christief0c0a372008-08-17 15:24:38 -0500105 switch (reason) {
106 case SCSI_MLQUEUE_HOST_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100107 atomic_set(&host->host_blocked, host->max_host_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500108 break;
109 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400110 case SCSI_MLQUEUE_EH_RETRY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100111 atomic_set(&device->device_blocked,
112 device->max_device_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500113 break;
114 case SCSI_MLQUEUE_TARGET_BUSY:
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100115 atomic_set(&starget->target_blocked,
116 starget->max_target_blocked);
Mike Christief0c0a372008-08-17 15:24:38 -0500117 break;
118 }
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100119}
120
Christoph Hellwigd2852032014-01-17 12:06:53 +0100121static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
122{
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -0700123 struct request *rq = scsi_cmd_to_rq(cmd);
124
125 if (rq->rq_flags & RQF_DONTPREP) {
126 rq->rq_flags &= ~RQF_DONTPREP;
Bart Van Asschea45a1f362017-08-30 16:58:42 -0700127 scsi_mq_uninit_cmd(cmd);
128 } else {
129 WARN_ON_ONCE(true);
130 }
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -0700131 blk_mq_requeue_request(rq, true);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100132}
133
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100134/**
135 * __scsi_queue_insert - private queue insertion
136 * @cmd: The SCSI command being requeued
137 * @reason: The reason for the requeue
138 * @unbusy: Whether the queue should be unbusied
139 *
140 * This is a private queue insertion. The public interface
141 * scsi_queue_insert() always assumes the queue should be unbusied
142 * because it's always called before the completion. This function is
143 * for a requeue after completion, which should only occur in this
144 * file.
145 */
Bart Van Assche08640e82018-01-10 14:41:45 -0800146static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, bool unbusy)
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100147{
148 struct scsi_device *device = cmd->device;
Christoph Hellwigde3e8bf2014-01-23 13:55:38 +0100149
150 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
151 "Inserting command %p into mlqueue\n", cmd));
152
153 scsi_set_blocked(cmd, reason);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 * Decrement the counters, since these commands are no longer
157 * active on the host/device.
158 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600159 if (unbusy)
Ming Lei6eb045e2019-10-25 14:58:55 +0800160 scsi_device_unbusy(device, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500163 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000164 * that are already in the queue. Schedule requeue work under
165 * lock such that the kblockd_schedule_work() call happens
166 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200167 */
Alan Stern644373a2014-03-28 10:51:15 -0700168 cmd->result = 0;
Jens Axboef664a3c2018-11-01 16:36:27 -0600169
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -0700170 blk_mq_requeue_request(scsi_cmd_to_rq(cmd), true);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171}
172
André Almeidaea941012020-04-19 02:01:48 -0300173/**
174 * scsi_queue_insert - Reinsert a command in the queue.
175 * @cmd: command that we are adding to queue.
176 * @reason: why we are inserting command to queue.
James Bottomley4f5299a2009-01-02 10:42:21 -0600177 *
André Almeidaea941012020-04-19 02:01:48 -0300178 * We do this for one of two cases. Either the host is busy and it cannot accept
179 * any more commands for the time being, or the device returned QUEUE_FULL and
180 * can accept no more commands.
James Bottomley4f5299a2009-01-02 10:42:21 -0600181 *
André Almeidaea941012020-04-19 02:01:48 -0300182 * Context: This could be called either from an interrupt context or a normal
183 * process context.
James Bottomley4f5299a2009-01-02 10:42:21 -0600184 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000185void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600186{
Bart Van Assche08640e82018-01-10 14:41:45 -0800187 __scsi_queue_insert(cmd, reason, true);
James Bottomley4f5299a2009-01-02 10:42:21 -0600188}
Christoph Hellwige8064022016-10-20 15:12:13 +0200189
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100190
191/**
Kees Cook704f8392018-07-31 12:51:54 -0700192 * __scsi_execute - insert request and wait for the result
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100193 * @sdev: scsi device
194 * @cmd: scsi command
195 * @data_direction: data direction
196 * @buffer: data buffer
197 * @bufflen: len of buffer
198 * @sense: optional sense buffer
199 * @sshdr: optional decoded sense header
Bart Van Assche422969b2021-07-09 13:26:20 -0700200 * @timeout: request timeout in HZ
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100201 * @retries: number of times to retry request
202 * @flags: flags for ->cmd_flags
203 * @rq_flags: flags for ->rq_flags
204 * @resid: optional residual length
205 *
Christoph Hellwig17d53632017-04-20 16:03:01 +0200206 * Returns the scsi_cmnd result field if a command was executed, or a negative
207 * Linux error code if we didn't get that far.
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100208 */
Kees Cook704f8392018-07-31 12:51:54 -0700209int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500210 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100211 unsigned char *sense, struct scsi_sense_hdr *sshdr,
212 int timeout, int retries, u64 flags, req_flags_t rq_flags,
213 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500214{
215 struct request *req;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100216 struct scsi_request *rq;
Hannes Reineckeced202f72021-04-27 10:30:12 +0200217 int ret;
James Bottomley39216032005-06-15 18:48:29 -0500218
Christoph Hellwig68ec3b82021-10-21 08:06:05 +0200219 req = scsi_alloc_request(sdev->request_queue,
Christoph Hellwigaebf5262017-01-31 16:57:31 +0100220 data_direction == DMA_TO_DEVICE ?
Christoph Hellwigda6269d2021-06-24 14:39:34 +0200221 REQ_OP_DRV_OUT : REQ_OP_DRV_IN,
Bart Van Asschee6044f72020-12-08 21:29:49 -0800222 rq_flags & RQF_PM ? BLK_MQ_REQ_PM : 0);
Joe Lawrencea492f072014-08-28 08:15:21 -0600223 if (IS_ERR(req))
Hannes Reineckeced202f72021-04-27 10:30:12 +0200224 return PTR_ERR(req);
225
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100226 rq = scsi_req(req);
James Bottomley39216032005-06-15 18:48:29 -0500227
Hannes Reineckeced202f72021-04-27 10:30:12 +0200228 if (bufflen) {
229 ret = blk_rq_map_kern(sdev->request_queue, req,
230 buffer, bufflen, GFP_NOIO);
231 if (ret)
232 goto out;
233 }
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100234 rq->cmd_len = COMMAND_SIZE(cmd[0]);
235 memcpy(rq->cmd, cmd, rq->cmd_len);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200236 rq->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500237 req->timeout = timeout;
Christoph Hellwige8064022016-10-20 15:12:13 +0200238 req->cmd_flags |= flags;
Bart Van Assche039c6352017-11-09 10:49:56 -0800239 req->rq_flags |= rq_flags | RQF_QUIET;
James Bottomley39216032005-06-15 18:48:29 -0500240
241 /*
242 * head injection *required* here otherwise quiesce won't work
243 */
Guoqing Jiang684da762021-01-25 05:49:58 +0100244 blk_execute_rq(NULL, req, 1);
James Bottomley39216032005-06-15 18:48:29 -0500245
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400246 /*
247 * Some devices (USB mass-storage in particular) may transfer
248 * garbage data together with a residue indicating that the data
249 * is invalid. Prevent the garbage from being misinterpreted
250 * and prevent security leaks by zeroing out the excess data.
251 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100252 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
253 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400254
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900255 if (resid)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100256 *resid = rq->resid_len;
257 if (sense && rq->sense_len)
258 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
Christoph Hellwig3949e2f2017-02-14 20:15:58 +0100259 if (sshdr)
260 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
Christoph Hellwig17d53632017-04-20 16:03:01 +0200261 ret = rq->result;
James Bottomley39216032005-06-15 18:48:29 -0500262 out:
Christoph Hellwig0bf6d962021-10-25 09:05:07 +0200263 blk_mq_free_request(req);
James Bottomley39216032005-06-15 18:48:29 -0500264
265 return ret;
266}
Kees Cook704f8392018-07-31 12:51:54 -0700267EXPORT_SYMBOL(__scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500268
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800269/*
Ming Lei6eb045e2019-10-25 14:58:55 +0800270 * Wake up the error handler if necessary. Avoid as follows that the error
271 * handler is not woken up if host in-flight requests number ==
272 * shost->host_failed: use call_rcu() in scsi_eh_scmd_add() in combination
273 * with an RCU read lock in this function to ensure that this function in
274 * its entirety either finishes before scsi_eh_scmd_add() increases the
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800275 * host_failed counter or that it notices the shost state change made by
276 * scsi_eh_scmd_add().
277 */
Ming Lei6eb045e2019-10-25 14:58:55 +0800278static void scsi_dec_host_busy(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800279{
280 unsigned long flags;
281
282 rcu_read_lock();
Ming Lei6eb045e2019-10-25 14:58:55 +0800283 __clear_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800284 if (unlikely(scsi_host_in_recovery(shost))) {
285 spin_lock_irqsave(shost->host_lock, flags);
286 if (shost->host_failed || shost->host_eh_scheduled)
287 scsi_eh_wakeup(shost);
288 spin_unlock_irqrestore(shost->host_lock, flags);
289 }
290 rcu_read_unlock();
291}
292
Ming Lei6eb045e2019-10-25 14:58:55 +0800293void scsi_device_unbusy(struct scsi_device *sdev, struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294{
295 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500296 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Ming Lei6eb045e2019-10-25 14:58:55 +0800298 scsi_dec_host_busy(shost, cmd);
Bart Van Assche3bd6f432017-12-04 10:06:23 -0800299
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100300 if (starget->can_queue > 0)
301 atomic_dec(&starget->target_busy);
Christoph Hellwig74665012014-01-22 15:29:29 +0100302
Ming Lei020b0f02021-01-22 10:33:17 +0800303 sbitmap_put(&sdev->budget_map, cmd->budget_token);
Ming Lei2a5a24a2021-01-22 10:33:12 +0800304 cmd->budget_token = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305}
306
Christoph Hellwigd2852032014-01-17 12:06:53 +0100307static void scsi_kick_queue(struct request_queue *q)
308{
Jens Axboef664a3c2018-11-01 16:36:27 -0600309 blk_mq_run_hw_queues(q, false);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100310}
311
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312/*
313 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
314 * and call blk_run_queue for all the scsi_devices on the target -
315 * including current_sdev first.
316 *
317 * Called with *no* scsi locks held.
318 */
319static void scsi_single_lun_run(struct scsi_device *current_sdev)
320{
321 struct Scsi_Host *shost = current_sdev->host;
322 struct scsi_device *sdev, *tmp;
323 struct scsi_target *starget = scsi_target(current_sdev);
324 unsigned long flags;
325
326 spin_lock_irqsave(shost->host_lock, flags);
327 starget->starget_sdev_user = NULL;
328 spin_unlock_irqrestore(shost->host_lock, flags);
329
330 /*
331 * Call blk_run_queue for all LUNs on the target, starting with
332 * current_sdev. We race with others (to set starget_sdev_user),
333 * but in most cases, we will be first. Ideally, each LU on the
334 * target would get some limited time or requests on the target.
335 */
Christoph Hellwigd2852032014-01-17 12:06:53 +0100336 scsi_kick_queue(current_sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
338 spin_lock_irqsave(shost->host_lock, flags);
339 if (starget->starget_sdev_user)
340 goto out;
341 list_for_each_entry_safe(sdev, tmp, &starget->devices,
342 same_target_siblings) {
343 if (sdev == current_sdev)
344 continue;
345 if (scsi_device_get(sdev))
346 continue;
347
348 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100349 scsi_kick_queue(sdev->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 spin_lock_irqsave(shost->host_lock, flags);
Bean Huo4c7b4d62020-06-19 17:41:17 +0200351
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 scsi_device_put(sdev);
353 }
354 out:
355 spin_unlock_irqrestore(shost->host_lock, flags);
356}
357
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100358static inline bool scsi_device_is_busy(struct scsi_device *sdev)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400359{
Ming Lei82788072021-01-22 10:33:15 +0800360 if (scsi_device_busy(sdev) >= sdev->queue_depth)
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100361 return true;
362 if (atomic_read(&sdev->device_blocked) > 0)
363 return true;
364 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400365}
366
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100367static inline bool scsi_target_is_busy(struct scsi_target *starget)
Mike Christief0c0a372008-08-17 15:24:38 -0500368{
Christoph Hellwig2ccbb002014-03-26 10:35:00 +0100369 if (starget->can_queue > 0) {
370 if (atomic_read(&starget->target_busy) >= starget->can_queue)
371 return true;
372 if (atomic_read(&starget->target_blocked) > 0)
373 return true;
374 }
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100375 return false;
Mike Christief0c0a372008-08-17 15:24:38 -0500376}
377
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100378static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400379{
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100380 if (atomic_read(&shost->host_blocked) > 0)
381 return true;
382 if (shost->host_self_blocked)
383 return true;
384 return false;
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400385}
386
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800387static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600389 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800390 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 unsigned long flags;
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600394 list_splice_init(&shost->starved_list, &starved_list);
395
396 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200397 struct request_queue *slq;
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 /*
400 * As long as shost is accepting commands and we have
401 * starved queues, call blk_run_queue. scsi_request_fn
402 * drops the queue_lock and can add us back to the
403 * starved_list.
404 *
405 * host_lock protects the starved_list and starved_entry.
406 * scsi_request_fn must get the host_lock before checking
407 * or modifying starved_list or starved_entry.
408 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600409 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500410 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500411
Mike Christie2a3a59e2008-11-11 13:42:35 -0600412 sdev = list_entry(starved_list.next,
413 struct scsi_device, starved_entry);
414 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500415 if (scsi_target_is_busy(scsi_target(sdev))) {
416 list_move_tail(&sdev->starved_entry,
417 &shost->starved_list);
418 continue;
419 }
420
James Bottomleye2eb7242013-07-02 15:05:26 +0200421 /*
422 * Once we drop the host lock, a racing scsi_remove_device()
423 * call may remove the sdev from the starved list and destroy
424 * it and the queue. Mitigate by taking a reference to the
425 * queue and never touching the sdev again after we drop the
426 * host lock. Note: if __scsi_remove_device() invokes
427 * blk_cleanup_queue() before the queue is run from this
428 * function then blk_run_queue() will return immediately since
429 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
430 */
431 slq = sdev->request_queue;
432 if (!blk_get_queue(slq))
433 continue;
434 spin_unlock_irqrestore(shost->host_lock, flags);
435
Christoph Hellwigd2852032014-01-17 12:06:53 +0100436 scsi_kick_queue(slq);
James Bottomleye2eb7242013-07-02 15:05:26 +0200437 blk_put_queue(slq);
438
439 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600441 /* put any unprocessed entries back */
442 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800444}
445
André Almeidaea941012020-04-19 02:01:48 -0300446/**
447 * scsi_run_queue - Select a proper request queue to serve next.
448 * @q: last request's queue
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800449 *
André Almeidaea941012020-04-19 02:01:48 -0300450 * The previous command was completely finished, start a new one if possible.
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800451 */
452static void scsi_run_queue(struct request_queue *q)
453{
454 struct scsi_device *sdev = q->queuedata;
455
456 if (scsi_target(sdev)->single_lun)
457 scsi_single_lun_run(sdev);
458 if (!list_empty(&sdev->host->starved_list))
459 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
Jens Axboef664a3c2018-11-01 16:36:27 -0600461 blk_mq_run_hw_queues(q, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462}
463
Jens Axboe9937a5e2011-05-17 11:04:44 +0200464void scsi_requeue_run_queue(struct work_struct *work)
465{
466 struct scsi_device *sdev;
467 struct request_queue *q;
468
469 sdev = container_of(work, struct scsi_device, requeue_work);
470 q = sdev->request_queue;
471 scsi_run_queue(q);
472}
473
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474void scsi_run_host_queues(struct Scsi_Host *shost)
475{
476 struct scsi_device *sdev;
477
478 shost_for_each_device(sdev, shost)
479 scsi_run_queue(sdev->request_queue);
480}
481
Christoph Hellwigd2852032014-01-17 12:06:53 +0100482static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
483{
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -0700484 if (!blk_rq_is_passthrough(scsi_cmd_to_rq(cmd))) {
Christoph Hellwigd2852032014-01-17 12:06:53 +0100485 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
486
487 if (drv->uninit_command)
488 drv->uninit_command(cmd);
489 }
490}
491
Christoph Hellwig7007e9d2020-10-05 10:41:28 +0200492void scsi_free_sgtables(struct scsi_cmnd *cmd)
Christoph Hellwigd2852032014-01-17 12:06:53 +0100493{
494 if (cmd->sdb.table.nents)
Ming Lei3dccdf52019-04-28 15:39:32 +0800495 sg_free_table_chained(&cmd->sdb.table,
496 SCSI_INLINE_SG_CNT);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100497 if (scsi_prot_sg_count(cmd))
Ming Lei92524fa2019-04-28 15:39:31 +0800498 sg_free_table_chained(&cmd->prot_sdb->table,
499 SCSI_INLINE_PROT_SG_CNT);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100500}
Christoph Hellwig7007e9d2020-10-05 10:41:28 +0200501EXPORT_SYMBOL_GPL(scsi_free_sgtables);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100502
503static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
504{
Johannes Thumshirn20a66f22020-04-28 19:45:55 +0900505 scsi_free_sgtables(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100506 scsi_uninit_cmd(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100507}
508
Ming Lei3f0dcfb2020-07-20 10:54:35 +0800509static void scsi_run_queue_async(struct scsi_device *sdev)
510{
511 if (scsi_target(sdev)->single_lun ||
Ming Leied5dd6a2020-09-10 15:50:56 +0800512 !list_empty(&sdev->host->starved_list)) {
Ming Lei3f0dcfb2020-07-20 10:54:35 +0800513 kblockd_schedule_work(&sdev->requeue_work);
Ming Leied5dd6a2020-09-10 15:50:56 +0800514 } else {
515 /*
516 * smp_mb() present in sbitmap_queue_clear() or implied in
517 * .end_io is for ordering writing .device_busy in
518 * scsi_device_unbusy() and reading sdev->restarts.
519 */
520 int old = atomic_read(&sdev->restarts);
521
522 /*
523 * ->restarts has to be kept as non-zero if new budget
524 * contention occurs.
525 *
526 * No need to run queue when either another re-run
527 * queue wins in updating ->restarts or a new budget
528 * contention occurs.
529 */
530 if (old && atomic_cmpxchg(&sdev->restarts, old, 0) == old)
531 blk_mq_run_hw_queues(sdev->request_queue, true);
532 }
Ming Lei3f0dcfb2020-07-20 10:54:35 +0800533}
534
Douglas Gilbert7e63b5a2018-06-23 12:22:14 +0200535/* Returns false when no more bytes to process, true if there are more */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200536static bool scsi_end_request(struct request *req, blk_status_t error,
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100537 unsigned int bytes)
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800538{
Bart Van Asschebed22132017-08-25 13:46:32 -0700539 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800540 struct scsi_device *sdev = cmd->device;
541 struct request_queue *q = sdev->request_queue;
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800542
543 if (blk_update_request(req, error, bytes))
544 return true;
545
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800546 if (blk_queue_add_random(q))
547 add_disk_randomness(req->rq_disk);
548
Christoph Hellwigda6269d2021-06-24 14:39:34 +0200549 if (!blk_rq_is_passthrough(req)) {
Bart Van Assche64104f72017-08-30 16:58:39 -0700550 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
551 cmd->flags &= ~SCMD_INITIALIZED;
552 }
553
Jens Axboef664a3c2018-11-01 16:36:27 -0600554 /*
Bart Van Asschedb983f62019-03-18 09:29:26 -0700555 * Calling rcu_barrier() is not necessary here because the
556 * SCSI error handler guarantees that the function called by
557 * call_rcu() has been called before scsi_end_request() is
558 * called.
559 */
560 destroy_rcu_head(&cmd->rcu);
561
562 /*
Jens Axboef664a3c2018-11-01 16:36:27 -0600563 * In the MQ case the command gets freed by __blk_mq_end_request,
564 * so we have to do all cleanup that depends on it earlier.
565 *
566 * We also can't kick the queues from irq context, so we
567 * will have to defer it to a workqueue.
568 */
569 scsi_mq_uninit_cmd(cmd);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800570
Jens Axboea78b03b2018-11-18 15:46:03 -0700571 /*
572 * queue is still alive, so grab the ref for preventing it
573 * from being cleaned up during running queue.
574 */
575 percpu_ref_get(&q->q_usage_counter);
Ming Lei8dc765d2018-11-14 16:25:51 +0800576
Jens Axboef664a3c2018-11-01 16:36:27 -0600577 __blk_mq_end_request(req, error);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100578
Ming Lei3f0dcfb2020-07-20 10:54:35 +0800579 scsi_run_queue_async(sdev);
Christoph Hellwigd2852032014-01-17 12:06:53 +0100580
Jens Axboea78b03b2018-11-18 15:46:03 -0700581 percpu_ref_put(&q->q_usage_counter);
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800582 return false;
583}
584
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200585/**
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700586 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
587 * @cmd: SCSI command
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200588 * @result: scsi error code
589 *
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700590 * Translate a SCSI result code into a blk_status_t value. May reset the host
591 * byte of @cmd->result.
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200592 */
Bart Van Asschea77b32d82018-04-05 10:33:00 -0700593static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100594{
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200595 switch (host_byte(result)) {
Bart Van Asschef4abab32018-04-05 10:33:01 -0700596 case DID_OK:
Hannes Reineckea7479a82021-04-27 10:30:44 +0200597 if (scsi_status_is_good(result))
Bart Van Asschef4abab32018-04-05 10:33:01 -0700598 return BLK_STS_OK;
599 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100600 case DID_TRANSPORT_FAILFAST:
Muneendra Kumar962c8dc2021-01-07 03:19:04 +0530601 case DID_TRANSPORT_MARGINAL:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200602 return BLK_STS_TRANSPORT;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100603 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000604 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200605 return BLK_STS_TARGET;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100606 case DID_NEXUS_FAILURE:
Martin Wilck4a067cf2019-02-14 22:57:41 +0100607 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200608 return BLK_STS_NEXUS;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200609 case DID_ALLOC_FAILURE:
610 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200611 return BLK_STS_NOSPC;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200612 case DID_MEDIUM_ERROR:
613 set_host_byte(cmd, DID_OK);
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200614 return BLK_STS_MEDIUM;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100615 default:
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200616 return BLK_STS_IOERR;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100617 }
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100618}
619
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200620/* Helper for scsi_io_completion() when "reprep" action required. */
621static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
622 struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623{
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200624 /* A new command will be prepared and issued. */
Jens Axboef664a3c2018-11-01 16:36:27 -0600625 scsi_mq_requeue_cmd(cmd);
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200626}
627
Mike Christie2a242d52020-10-01 10:35:53 -0500628static bool scsi_cmd_runtime_exceeced(struct scsi_cmnd *cmd)
629{
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -0700630 struct request *req = scsi_cmd_to_rq(cmd);
Mike Christie2a242d52020-10-01 10:35:53 -0500631 unsigned long wait_for;
632
633 if (cmd->allowed == SCSI_CMD_RETRIES_NO_LIMIT)
634 return false;
635
636 wait_for = (cmd->allowed + 1) * req->timeout;
637 if (time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
638 scmd_printk(KERN_ERR, cmd, "timing out command, waited %lus\n",
639 wait_for/HZ);
640 return true;
641 }
642 return false;
643}
644
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200645/* Helper for scsi_io_completion() when special action required. */
646static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
Douglas Gilbertab831082018-06-23 12:22:16 +0200647{
Jens Axboe165125e2007-07-24 09:28:11 +0200648 struct request_queue *q = cmd->device->request_queue;
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -0700649 struct request *req = scsi_cmd_to_rq(cmd);
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200650 int level = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500651 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
652 ACTION_DELAYED_RETRY} action;
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200653 struct scsi_sense_hdr sshdr;
654 bool sense_valid;
655 bool sense_current = true; /* false implies "deferred sense" */
656 blk_status_t blk_stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200658 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
659 if (sense_valid)
660 sense_current = !scsi_sense_is_deferred(&sshdr);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200661
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200662 blk_stat = scsi_result_to_blk_status(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500663
Alan Sternb60af5b2008-11-03 15:56:47 -0500664 if (host_byte(result) == DID_RESET) {
665 /* Third party bus reset or reset for error recovery
666 * reasons. Just retry the command and see what
667 * happens.
668 */
669 action = ACTION_RETRY;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200670 } else if (sense_valid && sense_current) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 switch (sshdr.sense_key) {
672 case UNIT_ATTENTION:
673 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700674 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 * and quietly refuse further access.
676 */
677 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500678 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700680 /* Must have been a power glitch, or a
681 * bus reset. Could not have been a
682 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500683 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700684 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500685 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 }
687 break;
688 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700689 /* If we had an ILLEGAL REQUEST returned, then
690 * we may have performed an unsupported
691 * command. The only thing this should be
692 * would be a ten byte read where only a six
693 * byte read was supported. Also, on a system
694 * where READ CAPACITY failed, we may have
695 * read past the end of the disk.
696 */
Jens Axboe26a68012005-11-29 21:03:34 +0100697 if ((cmd->device->use_10_for_rw &&
698 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 (cmd->cmnd[0] == READ_10 ||
700 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500701 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500703 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500704 } else if (sshdr.asc == 0x10) /* DIX */ {
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500705 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200706 blk_stat = BLK_STS_PROTECTION;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500707 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400708 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500709 action = ACTION_FAIL;
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200710 blk_stat = BLK_STS_TARGET;
Alan Sternb60af5b2008-11-03 15:56:47 -0500711 } else
712 action = ACTION_FAIL;
713 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400714 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000715 action = ACTION_FAIL;
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200716 if (sshdr.asc == 0x10) /* DIF */
Douglas Gilbert1f7cbb82018-06-23 12:22:15 +0200717 blk_stat = BLK_STS_PROTECTION;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 break;
719 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700720 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500721 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500723 if (sshdr.asc == 0x04) {
724 switch (sshdr.ascq) {
725 case 0x01: /* becoming ready */
726 case 0x04: /* format in progress */
727 case 0x05: /* rebuild in progress */
728 case 0x06: /* recalculation in progress */
729 case 0x07: /* operation in progress */
730 case 0x08: /* Long write in progress */
731 case 0x09: /* self test in progress */
Quat Le104739a2021-06-29 08:58:26 -0700732 case 0x11: /* notify (enable spinup) required */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500733 case 0x14: /* space allocation in progress */
Douglas Gilberte37c7d92018-05-18 19:25:47 -0400734 case 0x1a: /* start stop unit in progress */
735 case 0x1b: /* sanitize in progress */
736 case 0x1d: /* configuration in progress */
737 case 0x24: /* depopulation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500738 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500739 break;
Hannes Reinecke0d882322020-09-30 10:02:56 +0200740 case 0x0a: /* ALUA state transition */
741 blk_stat = BLK_STS_AGAIN;
742 fallthrough;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500743 default:
Alan Stern3dbf6a52008-12-15 10:31:28 -0500744 action = ACTION_FAIL;
745 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500746 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200747 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500748 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500749 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700751 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500752 action = ACTION_FAIL;
753 break;
Damien Le Moald8f53b02020-09-24 13:53:30 -0700754 case DATA_PROTECT:
755 action = ACTION_FAIL;
756 if ((sshdr.asc == 0x0C && sshdr.ascq == 0x12) ||
757 (sshdr.asc == 0x55 &&
758 (sshdr.ascq == 0x0E || sshdr.ascq == 0x0F))) {
759 /* Insufficient zone resources */
760 blk_stat = BLK_STS_ZONE_OPEN_RESOURCE;
761 }
762 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500764 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 break;
766 }
Maurizio Lombardie6c11db2014-07-10 09:41:53 +0200767 } else
Alan Sternb60af5b2008-11-03 15:56:47 -0500768 action = ACTION_FAIL;
Alan Sternb60af5b2008-11-03 15:56:47 -0500769
Mike Christie2a242d52020-10-01 10:35:53 -0500770 if (action != ACTION_FAIL && scsi_cmd_runtime_exceeced(cmd))
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900771 action = ACTION_FAIL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900772
Alan Sternb60af5b2008-11-03 15:56:47 -0500773 switch (action) {
774 case ACTION_FAIL:
775 /* Give up and fail the remainder of the request */
Christoph Hellwige8064022016-10-20 15:12:13 +0200776 if (!(req->rq_flags & RQF_QUIET)) {
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200777 static DEFINE_RATELIMIT_STATE(_rs,
778 DEFAULT_RATELIMIT_INTERVAL,
779 DEFAULT_RATELIMIT_BURST);
780
781 if (unlikely(scsi_logging_level))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200782 level =
783 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
784 SCSI_LOG_MLCOMPLETE_BITS);
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200785
786 /*
787 * if logging is enabled the failure will be printed
788 * in scsi_log_completion(), so avoid duplicate messages
789 */
790 if (!level && __ratelimit(&_rs)) {
791 scsi_print_result(cmd, NULL, FAILED);
Hannes Reinecke464a00c2021-04-27 10:30:15 +0200792 if (sense_valid)
Hannes Reineckef1569ff2014-10-24 14:27:07 +0200793 scsi_print_sense(cmd);
794 scsi_print_command(cmd);
795 }
James Bottomley3173d8c2005-09-04 11:32:05 -0500796 }
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100797 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req)))
Christoph Hellwigf6d47e72014-02-16 06:16:13 -0800798 return;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500799 fallthrough;
Alan Sternb60af5b2008-11-03 15:56:47 -0500800 case ACTION_REPREP:
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200801 scsi_io_completion_reprep(cmd, q);
Alan Sternb60af5b2008-11-03 15:56:47 -0500802 break;
803 case ACTION_RETRY:
804 /* Retry the same command immediately */
Bart Van Assche08640e82018-01-10 14:41:45 -0800805 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500806 break;
807 case ACTION_DELAYED_RETRY:
808 /* Retry the same command after a delay */
Bart Van Assche08640e82018-01-10 14:41:45 -0800809 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
Alan Sternb60af5b2008-11-03 15:56:47 -0500810 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 }
812}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200814/*
815 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
816 * new result that may suppress further error checking. Also modifies
817 * *blk_statp in some cases.
818 */
819static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
820 blk_status_t *blk_statp)
821{
822 bool sense_valid;
823 bool sense_current = true; /* false implies "deferred sense" */
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -0700824 struct request *req = scsi_cmd_to_rq(cmd);
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200825 struct scsi_sense_hdr sshdr;
826
827 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
828 if (sense_valid)
829 sense_current = !scsi_sense_is_deferred(&sshdr);
830
831 if (blk_rq_is_passthrough(req)) {
832 if (sense_valid) {
833 /*
834 * SG_IO wants current and deferred errors
835 */
836 scsi_req(req)->sense_len =
837 min(8 + cmd->sense_buffer[7],
838 SCSI_SENSE_BUFFERSIZE);
839 }
840 if (sense_current)
841 *blk_statp = scsi_result_to_blk_status(cmd, result);
842 } else if (blk_rq_bytes(req) == 0 && sense_current) {
843 /*
844 * Flush commands do not transfers any data, and thus cannot use
845 * good_bytes != blk_rq_bytes(req) as the signal for an error.
846 * This sets *blk_statp explicitly for the problem case.
847 */
848 *blk_statp = scsi_result_to_blk_status(cmd, result);
849 }
850 /*
851 * Recovered errors need reporting, but they're always treated as
852 * success, so fiddle the result code here. For passthrough requests
853 * we already took a copy of the original into sreq->result which
854 * is what gets returned to the user
855 */
856 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
857 bool do_print = true;
858 /*
859 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
860 * skip print since caller wants ATA registers. Only occurs
861 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
862 */
863 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
864 do_print = false;
865 else if (req->rq_flags & RQF_QUIET)
866 do_print = false;
867 if (do_print)
868 scsi_print_sense(cmd);
869 result = 0;
870 /* for passthrough, *blk_statp may be set */
871 *blk_statp = BLK_STS_OK;
872 }
873 /*
874 * Another corner case: the SCSI status byte is non-zero but 'good'.
875 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
876 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
877 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
878 * intermediate statuses (both obsolete in SAM-4) as good.
879 */
Hannes Reinecke3d45cefc2021-04-27 10:30:46 +0200880 if ((result & 0xff) && scsi_status_is_good(result)) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200881 result = 0;
882 *blk_statp = BLK_STS_OK;
883 }
884 return result;
885}
886
André Almeidaea941012020-04-19 02:01:48 -0300887/**
888 * scsi_io_completion - Completion processing for SCSI commands.
889 * @cmd: command that is finished.
890 * @good_bytes: number of processed bytes.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200891 *
André Almeidaea941012020-04-19 02:01:48 -0300892 * We will finish off the specified number of sectors. If we are done, the
893 * command block will be released and the queue function will be goosed. If we
894 * are not done then we have to figure out what to do next:
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200895 *
André Almeidaea941012020-04-19 02:01:48 -0300896 * a) We can call scsi_io_completion_reprep(). The request will be
897 * unprepared and put back on the queue. Then a new command will
898 * be created for it. This should be used if we made forward
899 * progress, or if we want to switch from READ(10) to READ(6) for
900 * example.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200901 *
André Almeidaea941012020-04-19 02:01:48 -0300902 * b) We can call scsi_io_completion_action(). The request will be
903 * put back on the queue and retried using the same command as
904 * before, possibly after a delay.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200905 *
André Almeidaea941012020-04-19 02:01:48 -0300906 * c) We can call scsi_end_request() with blk_stat other than
907 * BLK_STS_OK, to fail the remainder of the request.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200908 */
909void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
910{
911 int result = cmd->result;
912 struct request_queue *q = cmd->device->request_queue;
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -0700913 struct request *req = scsi_cmd_to_rq(cmd);
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200914 blk_status_t blk_stat = BLK_STS_OK;
915
Douglas Gilbert0d437902018-06-23 12:22:19 +0200916 if (unlikely(result)) /* a nz result may or may not be an error */
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200917 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
918
Douglas Gilbert0d437902018-06-23 12:22:19 +0200919 if (unlikely(blk_rq_is_passthrough(req))) {
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200920 /*
921 * scsi_result_to_blk_status may have reset the host_byte
922 */
923 scsi_req(req)->result = cmd->result;
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200924 }
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200925
926 /*
927 * Next deal with any sectors which we were able to correctly
928 * handle.
929 */
930 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
931 "%u sectors total, %d bytes done.\n",
932 blk_rq_sectors(req), good_bytes));
933
934 /*
André Almeidaea941012020-04-19 02:01:48 -0300935 * Failed, zero length commands always need to drop down
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200936 * to retry code. Fast path should return in this block.
937 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200938 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100939 if (likely(!scsi_end_request(req, blk_stat, good_bytes)))
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200940 return; /* no bytes remaining */
941 }
942
Douglas Gilbert0d437902018-06-23 12:22:19 +0200943 /* Kill remainder if no retries. */
944 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100945 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req)))
Douglas Gilbert8e1695a02018-06-23 12:22:20 +0200946 WARN_ONCE(true,
947 "Bytes remaining after failed, no-retry command");
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200948 return;
949 }
950
951 /*
952 * If there had been no error, but we have leftover bytes in the
Bart Van Asschee9076e72021-09-29 11:23:18 -0700953 * request just queue the command up again.
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200954 */
Douglas Gilbert0d437902018-06-23 12:22:19 +0200955 if (likely(result == 0))
Douglas Gilbert4ae61c62018-06-23 12:22:18 +0200956 scsi_io_completion_reprep(cmd, q);
957 else
Douglas Gilbertda32bae2018-06-23 12:22:17 +0200958 scsi_io_completion_action(cmd, result);
959}
960
Christoph Hellwigcc979232020-04-14 09:42:24 +0200961static inline bool scsi_cmd_needs_dma_drain(struct scsi_device *sdev,
962 struct request *rq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963{
Christoph Hellwigcc979232020-04-14 09:42:24 +0200964 return sdev->dma_drain_len && blk_rq_is_passthrough(rq) &&
965 !op_is_write(req_op(rq)) &&
966 sdev->host->hostt->dma_need_drain(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200968
André Almeidaea941012020-04-19 02:01:48 -0300969/**
Bart Van Assche76fc0df2021-04-15 15:08:07 -0700970 * scsi_alloc_sgtables - Allocate and initialize data and integrity scatterlists
971 * @cmd: SCSI command data structure to initialize.
972 *
973 * Initializes @cmd->sdb and also @cmd->prot_sdb if data integrity is enabled
974 * for @cmd.
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200975 *
André Almeidaea941012020-04-19 02:01:48 -0300976 * Returns:
977 * * BLK_STS_OK - on success
978 * * BLK_STS_RESOURCE - if the failure is retryable
979 * * BLK_STS_IOERR - if the failure is fatal
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200980 */
Christoph Hellwig7007e9d2020-10-05 10:41:28 +0200981blk_status_t scsi_alloc_sgtables(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200982{
Christoph Hellwigcc979232020-04-14 09:42:24 +0200983 struct scsi_device *sdev = cmd->device;
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -0700984 struct request *rq = scsi_cmd_to_rq(cmd);
Christoph Hellwigcc979232020-04-14 09:42:24 +0200985 unsigned short nr_segs = blk_rq_nr_phys_segments(rq);
986 struct scatterlist *last_sg = NULL;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100987 blk_status_t ret;
Christoph Hellwigcc979232020-04-14 09:42:24 +0200988 bool need_drain = scsi_cmd_needs_dma_drain(sdev, rq);
Christoph Hellwig0475bd62020-04-14 09:42:23 +0200989 int count;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200990
Christoph Hellwigcc979232020-04-14 09:42:24 +0200991 if (WARN_ON_ONCE(!nr_segs))
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100992 return BLK_STS_IOERR;
Christoph Hellwig635d98b2014-06-28 11:51:01 +0200993
Christoph Hellwig0475bd62020-04-14 09:42:23 +0200994 /*
Christoph Hellwigcc979232020-04-14 09:42:24 +0200995 * Make sure there is space for the drain. The driver must adjust
996 * max_hw_segments to be prepared for this.
997 */
998 if (need_drain)
999 nr_segs++;
1000
1001 /*
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001002 * If sg table allocation fails, requeue request later.
1003 */
Christoph Hellwigcc979232020-04-14 09:42:24 +02001004 if (unlikely(sg_alloc_table_chained(&cmd->sdb.table, nr_segs,
1005 cmd->sdb.table.sgl, SCSI_INLINE_SG_CNT)))
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001006 return BLK_STS_RESOURCE;
1007
1008 /*
1009 * Next, walk the list, and fill in the addresses and sizes of
1010 * each segment.
1011 */
Christoph Hellwigcc979232020-04-14 09:42:24 +02001012 count = __blk_rq_map_sg(rq->q, rq, cmd->sdb.table.sgl, &last_sg);
1013
Christoph Hellwigbdf87102020-04-14 09:42:25 +02001014 if (blk_rq_bytes(rq) & rq->q->dma_pad_mask) {
1015 unsigned int pad_len =
1016 (rq->q->dma_pad_mask & ~blk_rq_bytes(rq)) + 1;
1017
1018 last_sg->length += pad_len;
1019 cmd->extra_len += pad_len;
1020 }
1021
Christoph Hellwigcc979232020-04-14 09:42:24 +02001022 if (need_drain) {
1023 sg_unmark_end(last_sg);
1024 last_sg = sg_next(last_sg);
1025 sg_set_buf(last_sg, sdev->dma_drain_buf, sdev->dma_drain_len);
1026 sg_mark_end(last_sg);
1027
Christoph Hellwigbdf87102020-04-14 09:42:25 +02001028 cmd->extra_len += sdev->dma_drain_len;
Christoph Hellwigcc979232020-04-14 09:42:24 +02001029 count++;
1030 }
1031
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001032 BUG_ON(count > cmd->sdb.table.nents);
1033 cmd->sdb.table.nents = count;
1034 cmd->sdb.length = blk_rq_payload_bytes(rq);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001035
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001036 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001037 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
Christoph Hellwig0475bd62020-04-14 09:42:23 +02001038 int ivecs;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001039
Christoph Hellwig14784562018-11-09 14:42:38 +01001040 if (WARN_ON_ONCE(!prot_sdb)) {
Ewan D. Milne91724c22015-01-15 10:02:12 -05001041 /*
1042 * This can happen if someone (e.g. multipath)
1043 * queues a command to a device on an adapter
1044 * that does not support DIX.
1045 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001046 ret = BLK_STS_IOERR;
Christoph Hellwig14784562018-11-09 14:42:38 +01001047 goto out_free_sgtables;
Ewan D. Milne91724c22015-01-15 10:02:12 -05001048 }
1049
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001050 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001051
Ming Lin001d63b2016-04-04 14:48:09 -07001052 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
Ming Lei46358732019-04-28 15:39:30 +08001053 prot_sdb->table.sgl,
Ming Lei92524fa2019-04-28 15:39:31 +08001054 SCSI_INLINE_PROT_SG_CNT)) {
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001055 ret = BLK_STS_RESOURCE;
Christoph Hellwig14784562018-11-09 14:42:38 +01001056 goto out_free_sgtables;
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001057 }
1058
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001059 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001060 prot_sdb->table.sgl);
Igor Stoppa6f1d8a52018-09-05 23:47:20 +03001061 BUG_ON(count > ivecs);
1062 BUG_ON(count > queue_max_integrity_segments(rq->q));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001063
1064 cmd->prot_sdb = prot_sdb;
1065 cmd->prot_sdb->table.nents = count;
1066 }
1067
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001068 return BLK_STS_OK;
Christoph Hellwig14784562018-11-09 14:42:38 +01001069out_free_sgtables:
Johannes Thumshirn20a66f22020-04-28 19:45:55 +09001070 scsi_free_sgtables(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001071 return ret;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001072}
Christoph Hellwig7007e9d2020-10-05 10:41:28 +02001073EXPORT_SYMBOL(scsi_alloc_sgtables);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001075/**
Bart Van Assche832889f2017-08-30 16:58:40 -07001076 * scsi_initialize_rq - initialize struct scsi_cmnd partially
Jonathan Corbet35c05062017-08-24 16:11:09 -06001077 * @rq: Request associated with the SCSI command to be initialized.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001078 *
Bart Van Assche832889f2017-08-30 16:58:40 -07001079 * This function initializes the members of struct scsi_cmnd that must be
1080 * initialized before request processing starts and that won't be
1081 * reinitialized if a SCSI command is requeued.
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001082 */
Bart Van Asschee4c94702017-12-07 15:59:31 -08001083static void scsi_initialize_rq(struct request *rq)
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001084{
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001085 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwig2cece372021-07-24 09:20:24 +02001086 struct scsi_request *req = &cmd->req;
Bart Van Asschec8d9cf22017-06-20 11:15:42 -07001087
Christoph Hellwig2cece372021-07-24 09:20:24 +02001088 memset(req->__cmd, 0, sizeof(req->__cmd));
1089 req->cmd = req->__cmd;
1090 req->cmd_len = BLK_MAX_CDB;
1091 req->sense_len = 0;
1092
Bart Van Assche3be88282018-02-22 11:30:20 -08001093 init_rcu_head(&cmd->rcu);
Bart Van Assche832889f2017-08-30 16:58:40 -07001094 cmd->jiffies_at_alloc = jiffies;
1095 cmd->retries = 0;
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001096}
Bart Van Asscheca18d6f2017-06-20 11:15:41 -07001097
Christoph Hellwig68ec3b82021-10-21 08:06:05 +02001098struct request *scsi_alloc_request(struct request_queue *q,
1099 unsigned int op, blk_mq_req_flags_t flags)
1100{
1101 struct request *rq;
1102
Christoph Hellwig0bf6d962021-10-25 09:05:07 +02001103 rq = blk_mq_alloc_request(q, op, flags);
Christoph Hellwig68ec3b82021-10-21 08:06:05 +02001104 if (!IS_ERR(rq))
1105 scsi_initialize_rq(rq);
1106 return rq;
1107}
1108EXPORT_SYMBOL_GPL(scsi_alloc_request);
1109
Ming Leib7e9e1f2019-07-25 10:05:00 +08001110/*
1111 * Only called when the request isn't completed by SCSI, and not freed by
1112 * SCSI
1113 */
1114static void scsi_cleanup_rq(struct request *rq)
1115{
1116 if (rq->rq_flags & RQF_DONTPREP) {
1117 scsi_mq_uninit_cmd(blk_mq_rq_to_pdu(rq));
1118 rq->rq_flags &= ~RQF_DONTPREP;
1119 }
1120}
1121
Bart Van Assche65ca8462020-01-22 19:56:34 -08001122/* Called before a request is prepared. See also scsi_mq_prep_fn(). */
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001123void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001124{
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001125 void *buf = cmd->sense_buffer;
1126 void *prot = cmd->prot_sdb;
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -07001127 struct request *rq = scsi_cmd_to_rq(cmd);
Bart Van Assche64104f72017-08-30 16:58:39 -07001128 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
Bart Van Assche832889f2017-08-30 16:58:40 -07001129 unsigned long jiffies_at_alloc;
Bart Van Assche65ca8462020-01-22 19:56:34 -08001130 int retries, to_clear;
Ming Lei6eb045e2019-10-25 14:58:55 +08001131 bool in_flight;
Ming Lei2a5a24a2021-01-22 10:33:12 +08001132 int budget_token = cmd->budget_token;
Bart Van Assche64104f72017-08-30 16:58:39 -07001133
Christoph Hellwigda6269d2021-06-24 14:39:34 +02001134 if (!blk_rq_is_passthrough(rq) && !(flags & SCMD_INITIALIZED)) {
Bart Van Assche64104f72017-08-30 16:58:39 -07001135 flags |= SCMD_INITIALIZED;
1136 scsi_initialize_rq(rq);
1137 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001138
Bart Van Assche832889f2017-08-30 16:58:40 -07001139 jiffies_at_alloc = cmd->jiffies_at_alloc;
1140 retries = cmd->retries;
Ming Lei6eb045e2019-10-25 14:58:55 +08001141 in_flight = test_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Bart Van Assche65ca8462020-01-22 19:56:34 -08001142 /*
1143 * Zero out the cmd, except for the embedded scsi_request. Only clear
1144 * the driver-private command data if the LLD does not supply a
1145 * function to initialize that data.
1146 */
1147 to_clear = sizeof(*cmd) - sizeof(cmd->req);
1148 if (!dev->host->hostt->init_cmd_priv)
1149 to_clear += dev->host->hostt->cmd_size;
1150 memset((char *)cmd + sizeof(cmd->req), 0, to_clear);
Christoph Hellwig04796332014-02-20 14:20:55 -08001151
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001152 cmd->device = dev;
1153 cmd->sense_buffer = buf;
1154 cmd->prot_sdb = prot;
Bart Van Assche64104f72017-08-30 16:58:39 -07001155 cmd->flags = flags;
Ewan D. Milne5ae17502021-10-29 15:43:10 -04001156 INIT_LIST_HEAD(&cmd->eh_entry);
Christoph Hellwige9c787e2017-01-02 21:55:26 +03001157 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
Bart Van Assche832889f2017-08-30 16:58:40 -07001158 cmd->jiffies_at_alloc = jiffies_at_alloc;
1159 cmd->retries = retries;
Ming Lei6eb045e2019-10-25 14:58:55 +08001160 if (in_flight)
1161 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state);
Ming Lei2a5a24a2021-01-22 10:33:12 +08001162 cmd->budget_token = budget_token;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001163
Christoph Hellwig3b003152006-11-04 20:10:55 +01001164}
1165
Christoph Hellwig785ba832018-11-09 14:42:37 +01001166static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1167 struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001168{
Bart Van Asschebed22132017-08-25 13:46:32 -07001169 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001170
1171 /*
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001172 * Passthrough requests may transfer data, in which case they must
Christoph Hellwig3b003152006-11-04 20:10:55 +01001173 * a bio attached to them. Or they might contain a SCSI command
1174 * that does not transfer data, in which case they may optionally
1175 * submit a request without an attached bio.
1176 */
1177 if (req->bio) {
Christoph Hellwig7007e9d2020-10-05 10:41:28 +02001178 blk_status_t ret = scsi_alloc_sgtables(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001179 if (unlikely(ret != BLK_STS_OK))
1180 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001181 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001182 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001183
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001184 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001185 }
James Bottomley7b163182005-12-15 20:17:02 -06001186
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001187 cmd->cmd_len = scsi_req(req)->cmd_len;
1188 cmd->cmnd = scsi_req(req)->cmd;
Tejun Heob0790412009-05-07 22:24:42 +09001189 cmd->transfersize = blk_rq_bytes(req);
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001190 cmd->allowed = scsi_req(req)->retries;
Christoph Hellwig785ba832018-11-09 14:42:37 +01001191 return BLK_STS_OK;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001192}
1193
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001194static blk_status_t
Christoph Hellwig822bd2d2020-10-05 10:41:26 +02001195scsi_device_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196{
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001197 switch (sdev->sdev_state) {
Bart Van Asschee6044f72020-12-08 21:29:49 -08001198 case SDEV_CREATED:
1199 return BLK_STS_OK;
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001200 case SDEV_OFFLINE:
1201 case SDEV_TRANSPORT_OFFLINE:
1202 /*
1203 * If the device is offline we refuse to process any
1204 * commands. The device must be brought online
1205 * before trying any recovery commands.
1206 */
Ewan D. Milneb0962c52020-03-11 10:39:30 -04001207 if (!sdev->offline_already) {
1208 sdev->offline_already = true;
1209 sdev_printk(KERN_ERR, sdev,
1210 "rejecting I/O to offline device\n");
1211 }
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001212 return BLK_STS_IOERR;
1213 case SDEV_DEL:
1214 /*
1215 * If the device is fully deleted, we refuse to
1216 * process any commands as well.
1217 */
1218 sdev_printk(KERN_ERR, sdev,
1219 "rejecting I/O to dead device\n");
1220 return BLK_STS_IOERR;
1221 case SDEV_BLOCK:
1222 case SDEV_CREATED_BLOCK:
1223 return BLK_STS_RESOURCE;
1224 case SDEV_QUIESCE:
1225 /*
Bart Van Asschee6044f72020-12-08 21:29:49 -08001226 * If the device is blocked we only accept power management
1227 * commands.
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001228 */
Bart Van Asschee6044f72020-12-08 21:29:49 -08001229 if (req && WARN_ON_ONCE(!(req->rq_flags & RQF_PM)))
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001230 return BLK_STS_RESOURCE;
1231 return BLK_STS_OK;
1232 default:
1233 /*
1234 * For any other not fully online state we only allow
Bart Van Asschee6044f72020-12-08 21:29:49 -08001235 * power management commands.
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001236 */
Bart Van Asschee6044f72020-12-08 21:29:49 -08001237 if (req && !(req->rq_flags & RQF_PM))
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001238 return BLK_STS_IOERR;
1239 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001241}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243/*
Ming Lei020b0f02021-01-22 10:33:17 +08001244 * scsi_dev_queue_ready: if we can send requests to sdev, assign one token
1245 * and return the token else return -1.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 */
1247static inline int scsi_dev_queue_ready(struct request_queue *q,
1248 struct scsi_device *sdev)
1249{
Ming Lei020b0f02021-01-22 10:33:17 +08001250 int token;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001251
Ming Lei020b0f02021-01-22 10:33:17 +08001252 token = sbitmap_get(&sdev->budget_map);
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001253 if (atomic_read(&sdev->device_blocked)) {
Ming Lei020b0f02021-01-22 10:33:17 +08001254 if (token < 0)
1255 goto out;
1256
1257 if (scsi_device_busy(sdev) > 1)
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001258 goto out_dec;
1259
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 /*
1261 * unblock after device_blocked iterates to zero
1262 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001263 if (atomic_dec_return(&sdev->device_blocked) > 0)
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001264 goto out_dec;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001265 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1266 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 }
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001268
Ming Lei020b0f02021-01-22 10:33:17 +08001269 return token;
Christoph Hellwig71e75c92014-04-11 19:07:01 +02001270out_dec:
Ming Lei020b0f02021-01-22 10:33:17 +08001271 if (token >= 0)
1272 sbitmap_put(&sdev->budget_map, token);
1273out:
1274 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275}
1276
Mike Christief0c0a372008-08-17 15:24:38 -05001277/*
1278 * scsi_target_queue_ready: checks if there we can send commands to target
1279 * @sdev: scsi device on starget to check.
Mike Christief0c0a372008-08-17 15:24:38 -05001280 */
1281static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1282 struct scsi_device *sdev)
1283{
1284 struct scsi_target *starget = scsi_target(sdev);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001285 unsigned int busy;
Mike Christief0c0a372008-08-17 15:24:38 -05001286
1287 if (starget->single_lun) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001288 spin_lock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001289 if (starget->starget_sdev_user &&
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001290 starget->starget_sdev_user != sdev) {
1291 spin_unlock_irq(shost->host_lock);
1292 return 0;
1293 }
Mike Christief0c0a372008-08-17 15:24:38 -05001294 starget->starget_sdev_user = sdev;
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001295 spin_unlock_irq(shost->host_lock);
Mike Christief0c0a372008-08-17 15:24:38 -05001296 }
1297
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001298 if (starget->can_queue <= 0)
1299 return 1;
1300
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001301 busy = atomic_inc_return(&starget->target_busy) - 1;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001302 if (atomic_read(&starget->target_blocked) > 0) {
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001303 if (busy)
1304 goto starved;
1305
Mike Christief0c0a372008-08-17 15:24:38 -05001306 /*
1307 * unblock after target_blocked iterates to zero
1308 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001309 if (atomic_dec_return(&starget->target_blocked) > 0)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001310 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001311
1312 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1313 "unblocking target at zero depth\n"));
Mike Christief0c0a372008-08-17 15:24:38 -05001314 }
1315
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001316 if (busy >= starget->can_queue)
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001317 goto starved;
Mike Christief0c0a372008-08-17 15:24:38 -05001318
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001319 return 1;
1320
1321starved:
1322 spin_lock_irq(shost->host_lock);
1323 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001324 spin_unlock_irq(shost->host_lock);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001325out_dec:
Christoph Hellwig2ccbb002014-03-26 10:35:00 +01001326 if (starget->can_queue > 0)
1327 atomic_dec(&starget->target_busy);
Christoph Hellwig7ae65c02014-01-22 14:49:41 +01001328 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001329}
1330
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331/*
1332 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1333 * return 0. We must end up running the queue again whenever 0 is
1334 * returned, else IO can hang.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 */
1336static inline int scsi_host_queue_ready(struct request_queue *q,
1337 struct Scsi_Host *shost,
Ming Lei6eb045e2019-10-25 14:58:55 +08001338 struct scsi_device *sdev,
1339 struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340{
James Bottomley939647e2005-09-18 15:05:20 -05001341 if (scsi_host_in_recovery(shost))
Christoph Hellwig74665012014-01-22 15:29:29 +01001342 return 0;
1343
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001344 if (atomic_read(&shost->host_blocked) > 0) {
Ming Lei6eb045e2019-10-25 14:58:55 +08001345 if (scsi_host_busy(shost) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001346 goto starved;
1347
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 /*
1349 * unblock after host_blocked iterates to zero
1350 */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +01001351 if (atomic_dec_return(&shost->host_blocked) > 0)
Christoph Hellwig74665012014-01-22 15:29:29 +01001352 goto out_dec;
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001353
1354 SCSI_LOG_MLQUEUE(3,
1355 shost_printk(KERN_INFO, shost,
1356 "unblocking host at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 }
Christoph Hellwig74665012014-01-22 15:29:29 +01001358
Christoph Hellwig74665012014-01-22 15:29:29 +01001359 if (shost->host_self_blocked)
1360 goto starved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
1362 /* We're OK to process the command, so we can't be starved */
Christoph Hellwig74665012014-01-22 15:29:29 +01001363 if (!list_empty(&sdev->starved_entry)) {
1364 spin_lock_irq(shost->host_lock);
1365 if (!list_empty(&sdev->starved_entry))
1366 list_del_init(&sdev->starved_entry);
1367 spin_unlock_irq(shost->host_lock);
1368 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
Ming Lei6eb045e2019-10-25 14:58:55 +08001370 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state);
1371
Christoph Hellwig74665012014-01-22 15:29:29 +01001372 return 1;
1373
1374starved:
1375 spin_lock_irq(shost->host_lock);
1376 if (list_empty(&sdev->starved_entry))
1377 list_add_tail(&sdev->starved_entry, &shost->starved_list);
Christoph Hellwigcf68d332014-01-22 14:36:32 +01001378 spin_unlock_irq(shost->host_lock);
Christoph Hellwig74665012014-01-22 15:29:29 +01001379out_dec:
Ming Lei6eb045e2019-10-25 14:58:55 +08001380 scsi_dec_host_busy(shost, cmd);
Christoph Hellwig74665012014-01-22 15:29:29 +01001381 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382}
1383
1384/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001385 * Busy state exporting function for request stacking drivers.
1386 *
1387 * For efficiency, no lock is taken to check the busy state of
1388 * shost/starget/sdev, since the returned value is not guaranteed and
1389 * may be changed after request stacking drivers call the function,
1390 * regardless of taking lock or not.
1391 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001392 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1393 * needs to return 'not busy'. Otherwise, request stacking drivers
1394 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001395 */
Jens Axboef664a3c2018-11-01 16:36:27 -06001396static bool scsi_mq_lld_busy(struct request_queue *q)
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001397{
1398 struct scsi_device *sdev = q->queuedata;
1399 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001400
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001401 if (blk_queue_dying(q))
Jens Axboef664a3c2018-11-01 16:36:27 -06001402 return false;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001403
1404 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001405
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001406 /*
1407 * Ignore host/starget busy state.
1408 * Since block layer does not have a concept of fairness across
1409 * multiple queues, congestion of host/starget needs to be handled
1410 * in SCSI layer.
1411 */
1412 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Jens Axboef664a3c2018-11-01 16:36:27 -06001413 return true;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001414
Jens Axboef664a3c2018-11-01 16:36:27 -06001415 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416}
1417
Bart Van Assche0d2810cd2021-04-15 15:08:09 -07001418/*
1419 * Block layer request completion callback. May be called from interrupt
1420 * context.
1421 */
1422static void scsi_complete(struct request *rq)
Jens Axboe1aea6432006-01-09 16:03:03 +01001423{
Bart Van Asschebed22132017-08-25 13:46:32 -07001424 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Asscheb8e162f2021-04-15 15:08:11 -07001425 enum scsi_disposition disposition;
Jens Axboe1aea6432006-01-09 16:03:03 +01001426
1427 INIT_LIST_HEAD(&cmd->eh_entry);
1428
Jens Axboe242f9dc2008-09-14 05:55:09 -07001429 atomic_inc(&cmd->device->iodone_cnt);
1430 if (cmd->result)
1431 atomic_inc(&cmd->device->ioerr_cnt);
1432
Jens Axboe1aea6432006-01-09 16:03:03 +01001433 disposition = scsi_decide_disposition(cmd);
Mike Christie2a242d52020-10-01 10:35:53 -05001434 if (disposition != SUCCESS && scsi_cmd_runtime_exceeced(cmd))
Jens Axboe1aea6432006-01-09 16:03:03 +01001435 disposition = SUCCESS;
Hannes Reinecke91921e02014-06-25 16:39:59 +02001436
Jens Axboe1aea6432006-01-09 16:03:03 +01001437 scsi_log_completion(cmd, disposition);
1438
1439 switch (disposition) {
Bean Huo4c7b4d62020-06-19 17:41:17 +02001440 case SUCCESS:
1441 scsi_finish_command(cmd);
1442 break;
1443 case NEEDS_RETRY:
1444 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
1445 break;
1446 case ADD_TO_MLQUEUE:
1447 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1448 break;
1449 default:
1450 scsi_eh_scmd_add(cmd);
1451 break;
Jens Axboe1aea6432006-01-09 16:03:03 +01001452 }
1453}
1454
Christoph Hellwig3b5382c2014-05-06 12:25:40 +02001455/**
Mauro Carvalho Chehabae6b4e62020-10-23 18:33:14 +02001456 * scsi_dispatch_cmd - Dispatch a command to the low-level driver.
Christoph Hellwig82042a22014-09-05 18:23:07 -07001457 * @cmd: command block we are dispatching.
1458 *
1459 * Return: nonzero return request was rejected and device's queue needs to be
1460 * plugged.
1461 */
1462static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1463{
1464 struct Scsi_Host *host = cmd->device->host;
1465 int rtn = 0;
1466
1467 atomic_inc(&cmd->device->iorequest_cnt);
1468
1469 /* check if the device is still usable */
1470 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1471 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1472 * returns an immediate error upwards, and signals
1473 * that the device is no longer present */
1474 cmd->result = DID_NO_CONNECT << 16;
1475 goto done;
1476 }
1477
1478 /* Check to see if the scsi lld made this device blocked. */
1479 if (unlikely(scsi_device_blocked(cmd->device))) {
1480 /*
1481 * in blocked state, the command is just put back on
1482 * the device queue. The suspend state has already
1483 * blocked the queue so future requests should not
1484 * occur until the device transitions out of the
1485 * suspend state.
1486 */
1487 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1488 "queuecommand : device blocked\n"));
1489 return SCSI_MLQUEUE_DEVICE_BUSY;
1490 }
1491
1492 /* Store the LUN value in cmnd, if needed. */
1493 if (cmd->device->lun_in_cdb)
1494 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1495 (cmd->device->lun << 5 & 0xe0);
1496
1497 scsi_log_send(cmd);
1498
1499 /*
1500 * Before we queue this command, check if the command
1501 * length exceeds what the host adapter can handle.
1502 */
1503 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1504 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1505 "queuecommand : command too long. "
1506 "cdb_size=%d host->max_cmd_len=%d\n",
1507 cmd->cmd_len, cmd->device->host->max_cmd_len));
1508 cmd->result = (DID_ABORT << 16);
1509 goto done;
1510 }
1511
1512 if (unlikely(host->shost_state == SHOST_DEL)) {
1513 cmd->result = (DID_NO_CONNECT << 16);
1514 goto done;
1515
1516 }
1517
1518 trace_scsi_dispatch_cmd_start(cmd);
1519 rtn = host->hostt->queuecommand(host, cmd);
1520 if (rtn) {
1521 trace_scsi_dispatch_cmd_error(cmd, rtn);
1522 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1523 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1524 rtn = SCSI_MLQUEUE_HOST_BUSY;
1525
1526 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1527 "queuecommand : request rejected\n"));
1528 }
1529
1530 return rtn;
1531 done:
Bart Van Assche11b68e32021-10-07 13:46:11 -07001532 scsi_done(cmd);
Christoph Hellwig82042a22014-09-05 18:23:07 -07001533 return 0;
1534}
1535
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001536/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
Ming Lei3dccdf52019-04-28 15:39:32 +08001537static unsigned int scsi_mq_inline_sgl_size(struct Scsi_Host *shost)
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001538{
Ming Lei3dccdf52019-04-28 15:39:32 +08001539 return min_t(unsigned int, shost->sg_tablesize, SCSI_INLINE_SG_CNT) *
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001540 sizeof(struct scatterlist);
1541}
1542
Christoph Hellwig5843cc32020-10-05 10:41:27 +02001543static blk_status_t scsi_prepare_cmd(struct request *req)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001544{
1545 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1546 struct scsi_device *sdev = req->q->queuedata;
1547 struct Scsi_Host *shost = sdev->host;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001548 struct scatterlist *sg;
1549
Bart Van Assche08f78432017-06-02 14:22:00 -07001550 scsi_init_command(sdev, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001551
Christoph Hellwigd2852032014-01-17 12:06:53 +01001552 cmd->prot_op = SCSI_PROT_NORMAL;
Christoph Hellwigb6ba9b02020-10-08 22:06:11 +02001553 if (blk_rq_bytes(req))
1554 cmd->sc_data_direction = rq_dma_dir(req);
1555 else
1556 cmd->sc_data_direction = DMA_NONE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001557
Christoph Hellwigd2852032014-01-17 12:06:53 +01001558 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1559 cmd->sdb.table.sgl = sg;
1560
1561 if (scsi_host_get_prot(shost)) {
Christoph Hellwigd2852032014-01-17 12:06:53 +01001562 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1563
1564 cmd->prot_sdb->table.sgl =
1565 (struct scatterlist *)(cmd->prot_sdb + 1);
1566 }
1567
Christoph Hellwig74e5e6c2020-10-05 10:41:29 +02001568 /*
1569 * Special handling for passthrough commands, which don't go to the ULP
1570 * at all:
1571 */
Christoph Hellwigda6269d2021-06-24 14:39:34 +02001572 if (blk_rq_is_passthrough(req))
Christoph Hellwig74e5e6c2020-10-05 10:41:29 +02001573 return scsi_setup_scsi_cmnd(sdev, req);
Christoph Hellwigfe052522014-09-22 15:59:31 +02001574
Christoph Hellwig74e5e6c2020-10-05 10:41:29 +02001575 if (sdev->handler && sdev->handler->prep_fn) {
1576 blk_status_t ret = sdev->handler->prep_fn(sdev, req);
1577
1578 if (ret != BLK_STS_OK)
1579 return ret;
1580 }
1581
1582 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
1583 memset(cmd->cmnd, 0, BLK_MAX_CDB);
1584 return scsi_cmd_to_driver(cmd)->init_command(cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001585}
1586
Bart Van Asschea710eac2021-10-07 13:27:57 -07001587void scsi_done(struct scsi_cmnd *cmd)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001588{
Bart Van Asschebf23e612021-10-07 13:27:56 -07001589 switch (cmd->submitter) {
1590 case SUBMITTED_BY_BLOCK_LAYER:
1591 break;
1592 case SUBMITTED_BY_SCSI_ERROR_HANDLER:
1593 return scsi_eh_done(cmd);
1594 case SUBMITTED_BY_SCSI_RESET_IOCTL:
1595 return;
1596 }
1597
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -07001598 if (unlikely(blk_should_fake_timeout(scsi_cmd_to_rq(cmd)->q)))
Christoph Hellwig15f73f52020-06-11 08:44:47 +02001599 return;
Keith Buschf1342702018-11-26 09:54:29 -07001600 if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state)))
1601 return;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001602 trace_scsi_dispatch_cmd_done(cmd);
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -07001603 blk_mq_complete_request(scsi_cmd_to_rq(cmd));
Christoph Hellwigd2852032014-01-17 12:06:53 +01001604}
Bart Van Asschea710eac2021-10-07 13:27:57 -07001605EXPORT_SYMBOL(scsi_done);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001606
Ming Lei2a5a24a2021-01-22 10:33:12 +08001607static void scsi_mq_put_budget(struct request_queue *q, int budget_token)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001608{
Christoph Hellwigd2852032014-01-17 12:06:53 +01001609 struct scsi_device *sdev = q->queuedata;
Ming Lei0df21c82017-10-14 17:22:32 +08001610
Ming Lei020b0f02021-01-22 10:33:17 +08001611 sbitmap_put(&sdev->budget_map, budget_token);
Ming Lei0df21c82017-10-14 17:22:32 +08001612}
1613
Ming Lei2a5a24a2021-01-22 10:33:12 +08001614static int scsi_mq_get_budget(struct request_queue *q)
Ming Lei0df21c82017-10-14 17:22:32 +08001615{
Ming Lei0df21c82017-10-14 17:22:32 +08001616 struct scsi_device *sdev = q->queuedata;
Ming Lei020b0f02021-01-22 10:33:17 +08001617 int token = scsi_dev_queue_ready(q, sdev);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001618
Ming Lei020b0f02021-01-22 10:33:17 +08001619 if (token >= 0)
1620 return token;
Ming Leied5dd6a2020-09-10 15:50:56 +08001621
1622 atomic_inc(&sdev->restarts);
1623
1624 /*
1625 * Orders atomic_inc(&sdev->restarts) and atomic_read(&sdev->device_busy).
1626 * .restarts must be incremented before .device_busy is read because the
1627 * code in scsi_run_queue_async() depends on the order of these operations.
1628 */
1629 smp_mb__after_atomic();
1630
1631 /*
1632 * If all in-flight requests originated from this LUN are completed
1633 * before reading .device_busy, sdev->device_busy will be observed as
1634 * zero, then blk_mq_delay_run_hw_queues() will dispatch this request
1635 * soon. Otherwise, completion of one of these requests will observe
1636 * the .restarts flag, and the request queue will be run for handling
1637 * this request, see scsi_end_request().
1638 */
Ming Lei82788072021-01-22 10:33:15 +08001639 if (unlikely(scsi_device_busy(sdev) == 0 &&
Ming Leied5dd6a2020-09-10 15:50:56 +08001640 !scsi_device_blocked(sdev)))
1641 blk_mq_delay_run_hw_queues(sdev->request_queue, SCSI_QUEUE_DELAY);
Ming Lei2a5a24a2021-01-22 10:33:12 +08001642 return -1;
Ming Lei0df21c82017-10-14 17:22:32 +08001643}
1644
Ming Leid022d182021-01-22 10:33:11 +08001645static void scsi_mq_set_rq_budget_token(struct request *req, int token)
1646{
1647 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1648
1649 cmd->budget_token = token;
1650}
1651
1652static int scsi_mq_get_rq_budget_token(struct request *req)
1653{
1654 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1655
1656 return cmd->budget_token;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001657}
1658
1659static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1660 const struct blk_mq_queue_data *bd)
1661{
1662 struct request *req = bd->rq;
1663 struct request_queue *q = req->q;
1664 struct scsi_device *sdev = q->queuedata;
1665 struct Scsi_Host *shost = sdev->host;
1666 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1667 blk_status_t ret;
1668 int reason;
1669
Ming Lei2a5a24a2021-01-22 10:33:12 +08001670 WARN_ON_ONCE(cmd->budget_token < 0);
1671
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001672 /*
1673 * If the device is not in running state we will reject some or all
1674 * commands.
1675 */
1676 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig822bd2d2020-10-05 10:41:26 +02001677 ret = scsi_device_state_check(sdev, req);
Christoph Hellwigc092d4e2018-11-09 14:42:36 +01001678 if (ret != BLK_STS_OK)
1679 goto out_put_budget;
1680 }
Christoph Hellwigd2852032014-01-17 12:06:53 +01001681
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001682 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001683 if (!scsi_target_queue_ready(shost, sdev))
Ming Lei826a70a2017-11-04 09:55:34 +08001684 goto out_put_budget;
Ming Lei6eb045e2019-10-25 14:58:55 +08001685 if (!scsi_host_queue_ready(q, shost, sdev, cmd))
Christoph Hellwigd2852032014-01-17 12:06:53 +01001686 goto out_dec_target_busy;
1687
Christoph Hellwige8064022016-10-20 15:12:13 +02001688 if (!(req->rq_flags & RQF_DONTPREP)) {
Christoph Hellwig5843cc32020-10-05 10:41:27 +02001689 ret = scsi_prepare_cmd(req);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001690 if (ret != BLK_STS_OK)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001691 goto out_dec_host_busy;
Christoph Hellwige8064022016-10-20 15:12:13 +02001692 req->rq_flags |= RQF_DONTPREP;
Christoph Hellwigfe052522014-09-22 15:59:31 +02001693 } else {
Bart Van Asschecd464d82019-01-15 16:50:03 -08001694 clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001695 }
1696
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001697 cmd->flags &= SCMD_PRESERVED_FLAGS;
Christoph Hellwig125c99b2014-11-03 12:47:47 +01001698 if (sdev->simple_tags)
1699 cmd->flags |= SCMD_TAGGED;
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001700 if (bd->last)
1701 cmd->flags |= SCMD_LAST;
Christoph Hellwigb1dd2aa2014-10-19 17:13:58 +02001702
Christoph Hellwig3a8dc5b2020-10-05 10:41:22 +02001703 scsi_set_resid(cmd, 0);
1704 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Bart Van Asschebf23e612021-10-07 13:27:56 -07001705 cmd->submitter = SUBMITTED_BY_BLOCK_LAYER;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001706
Christoph Hellwiged7fb2d2020-10-05 10:41:30 +02001707 blk_mq_start_request(req);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001708 reason = scsi_dispatch_cmd(cmd);
1709 if (reason) {
1710 scsi_set_blocked(cmd, reason);
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001711 ret = BLK_STS_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001712 goto out_dec_host_busy;
1713 }
1714
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001715 return BLK_STS_OK;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001716
1717out_dec_host_busy:
Ming Lei6eb045e2019-10-25 14:58:55 +08001718 scsi_dec_host_busy(shost, cmd);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001719out_dec_target_busy:
1720 if (scsi_target(sdev)->can_queue > 0)
1721 atomic_dec(&scsi_target(sdev)->target_busy);
Ming Lei0df21c82017-10-14 17:22:32 +08001722out_put_budget:
Ming Lei2a5a24a2021-01-22 10:33:12 +08001723 scsi_mq_put_budget(q, cmd->budget_token);
1724 cmd->budget_token = -1;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001725 switch (ret) {
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001726 case BLK_STS_OK:
1727 break;
1728 case BLK_STS_RESOURCE:
Keith Busch0512a752020-05-12 17:55:47 +09001729 case BLK_STS_ZONE_RESOURCE:
Ming Lei673235f2020-12-02 18:04:19 +08001730 if (scsi_device_blocked(sdev))
Ming Lei86ff7c22018-01-30 22:04:57 -05001731 ret = BLK_STS_DEV_RESOURCE;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001732 break;
Hannes Reinecke268940b2020-09-30 10:02:54 +02001733 case BLK_STS_AGAIN:
1734 scsi_req(req)->result = DID_BUS_BUSY << 16;
1735 if (req->rq_flags & RQF_DONTPREP)
1736 scsi_mq_uninit_cmd(cmd);
1737 break;
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001738 default:
Jaesoo Leebe549d42019-04-09 17:02:22 -07001739 if (unlikely(!scsi_device_online(sdev)))
1740 scsi_req(req)->result = DID_NO_CONNECT << 16;
1741 else
1742 scsi_req(req)->result = DID_ERROR << 16;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001743 /*
Jaesoo Leebe549d42019-04-09 17:02:22 -07001744 * Make sure to release all allocated resources when
Christoph Hellwigd2852032014-01-17 12:06:53 +01001745 * we hit an error, as we will never see this command
1746 * again.
1747 */
Christoph Hellwige8064022016-10-20 15:12:13 +02001748 if (req->rq_flags & RQF_DONTPREP)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001749 scsi_mq_uninit_cmd(cmd);
Ming Lei3f0dcfb2020-07-20 10:54:35 +08001750 scsi_run_queue_async(sdev);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001751 break;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001752 }
1753 return ret;
1754}
1755
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001756static enum blk_eh_timer_return scsi_timeout(struct request *req,
1757 bool reserved)
1758{
1759 if (reserved)
1760 return BLK_EH_RESET_TIMER;
1761 return scsi_times_out(req);
1762}
1763
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001764static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1765 unsigned int hctx_idx, unsigned int numa_node)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001766{
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001767 struct Scsi_Host *shost = set->driver_data;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001768 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
Bart Van Assche08f78432017-06-02 14:22:00 -07001769 struct scatterlist *sg;
Bart Van Assche65ca8462020-01-22 19:56:34 -08001770 int ret = 0;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001771
Christoph Hellwigaaff5eb2021-03-31 09:29:58 +02001772 cmd->sense_buffer =
1773 kmem_cache_alloc_node(scsi_sense_cache, GFP_KERNEL, numa_node);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001774 if (!cmd->sense_buffer)
1775 return -ENOMEM;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001776 cmd->req.sense = cmd->sense_buffer;
Bart Van Assche08f78432017-06-02 14:22:00 -07001777
1778 if (scsi_host_get_prot(shost)) {
1779 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1780 shost->hostt->cmd_size;
Ming Lei3dccdf52019-04-28 15:39:32 +08001781 cmd->prot_sdb = (void *)sg + scsi_mq_inline_sgl_size(shost);
Bart Van Assche08f78432017-06-02 14:22:00 -07001782 }
1783
Bart Van Assche65ca8462020-01-22 19:56:34 -08001784 if (shost->hostt->init_cmd_priv) {
1785 ret = shost->hostt->init_cmd_priv(shost, cmd);
1786 if (ret < 0)
Christoph Hellwigaaff5eb2021-03-31 09:29:58 +02001787 kmem_cache_free(scsi_sense_cache, cmd->sense_buffer);
Bart Van Assche65ca8462020-01-22 19:56:34 -08001788 }
1789
1790 return ret;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001791}
1792
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001793static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
1794 unsigned int hctx_idx)
Christoph Hellwigd2852032014-01-17 12:06:53 +01001795{
Bart Van Assche65ca8462020-01-22 19:56:34 -08001796 struct Scsi_Host *shost = set->driver_data;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001797 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1798
Bart Van Assche65ca8462020-01-22 19:56:34 -08001799 if (shost->hostt->exit_cmd_priv)
1800 shost->hostt->exit_cmd_priv(shost, cmd);
Christoph Hellwigaaff5eb2021-03-31 09:29:58 +02001801 kmem_cache_free(scsi_sense_cache, cmd->sense_buffer);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001802}
1803
Kashyap Desaiaf183092021-02-15 13:10:44 +05301804
Jens Axboe5a72e892021-10-12 09:24:29 -06001805static int scsi_mq_poll(struct blk_mq_hw_ctx *hctx, struct io_comp_batch *iob)
Kashyap Desaiaf183092021-02-15 13:10:44 +05301806{
Kashyap Desai4309ea72021-02-15 13:10:48 +05301807 struct Scsi_Host *shost = hctx->driver_data;
Kashyap Desaiaf183092021-02-15 13:10:44 +05301808
1809 if (shost->hostt->mq_poll)
1810 return shost->hostt->mq_poll(shost, hctx->queue_num);
1811
1812 return 0;
1813}
1814
Kashyap Desai4309ea72021-02-15 13:10:48 +05301815static int scsi_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
1816 unsigned int hctx_idx)
1817{
1818 struct Scsi_Host *shost = data;
1819
1820 hctx->driver_data = shost;
1821 return 0;
1822}
1823
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001824static int scsi_map_queues(struct blk_mq_tag_set *set)
1825{
1826 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1827
1828 if (shost->hostt->map_queues)
1829 return shost->hostt->map_queues(shost);
Dongli Zhang99bbf482019-03-12 09:00:28 +08001830 return blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001831}
1832
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001833void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834{
Lin Ming6f381fa2012-04-12 13:50:38 +08001835 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836
Jens Axboea8474ce2007-08-07 09:02:51 +02001837 /*
1838 * this limit is imposed by hardware restrictions
1839 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001840 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
Ming Lin65e86172016-04-04 14:48:10 -07001841 SG_MAX_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001842
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001843 if (scsi_host_prot_dma(shost)) {
1844 shost->sg_prot_tablesize =
1845 min_not_zero(shost->sg_prot_tablesize,
1846 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1847 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1848 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1849 }
1850
Christoph Hellwig1b5d9a62019-07-22 11:20:38 +02001851 if (dev->dma_mask) {
1852 shost->max_sectors = min_t(unsigned int, shost->max_sectors,
1853 dma_max_mapping_size(dev) >> SECTOR_SHIFT);
1854 }
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001855 blk_queue_max_hw_sectors(q, shost->max_sectors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001857 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858
Christoph Hellwiga8cf59a2019-01-16 17:12:15 +01001859 blk_queue_max_segment_size(q, shost->max_segment_size);
Christoph Hellwig7ad388d2019-06-17 14:19:53 +02001860 blk_queue_virt_boundary(q, shost->virt_boundary_mask);
1861 dma_set_max_seg_size(dev, queue_max_segment_size(q));
James Bottomley465ff312008-01-01 10:00:10 -06001862
1863 /*
Huacai Chen90addc62017-11-21 14:23:38 +01001864 * Set a reasonable default alignment: The larger of 32-byte (dword),
1865 * which is a common minimum for HBAs, and the minimum DMA alignment,
1866 * which is set by the platform.
1867 *
1868 * Devices that require a bigger alignment can increase it later.
James Bottomley465ff312008-01-01 10:00:10 -06001869 */
Huacai Chen90addc62017-11-21 14:23:38 +01001870 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001871}
Christoph Hellwigd48777a62017-01-02 21:52:10 +03001872EXPORT_SYMBOL_GPL(__scsi_init_queue);
James Bottomley465ff312008-01-01 10:00:10 -06001873
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001874static const struct blk_mq_ops scsi_mq_ops_no_commit = {
1875 .get_budget = scsi_mq_get_budget,
1876 .put_budget = scsi_mq_put_budget,
1877 .queue_rq = scsi_queue_rq,
Bart Van Assche0d2810cd2021-04-15 15:08:09 -07001878 .complete = scsi_complete,
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001879 .timeout = scsi_timeout,
1880#ifdef CONFIG_BLK_DEBUG_FS
1881 .show_rq = scsi_show_rq,
1882#endif
1883 .init_request = scsi_mq_init_request,
1884 .exit_request = scsi_mq_exit_request,
Steffen Maier82a9ac72019-08-07 16:49:47 +02001885 .cleanup_rq = scsi_cleanup_rq,
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001886 .busy = scsi_mq_lld_busy,
1887 .map_queues = scsi_map_queues,
Kashyap Desai4309ea72021-02-15 13:10:48 +05301888 .init_hctx = scsi_init_hctx,
Kashyap Desaiaf183092021-02-15 13:10:44 +05301889 .poll = scsi_mq_poll,
Ming Leid022d182021-01-22 10:33:11 +08001890 .set_rq_budget_token = scsi_mq_set_rq_budget_token,
1891 .get_rq_budget_token = scsi_mq_get_rq_budget_token,
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001892};
1893
1894
1895static void scsi_commit_rqs(struct blk_mq_hw_ctx *hctx)
1896{
Kashyap Desai4309ea72021-02-15 13:10:48 +05301897 struct Scsi_Host *shost = hctx->driver_data;
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001898
1899 shost->hostt->commit_rqs(shost, hctx->queue_num);
1900}
1901
Eric Biggersf363b082017-03-30 13:39:16 -07001902static const struct blk_mq_ops scsi_mq_ops = {
Ming Lei0df21c82017-10-14 17:22:32 +08001903 .get_budget = scsi_mq_get_budget,
1904 .put_budget = scsi_mq_put_budget,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001905 .queue_rq = scsi_queue_rq,
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001906 .commit_rqs = scsi_commit_rqs,
Bart Van Assche0d2810cd2021-04-15 15:08:09 -07001907 .complete = scsi_complete,
Christoph Hellwig0152fb62014-09-13 16:40:13 -07001908 .timeout = scsi_timeout,
Bart Van Assche0eebd002017-04-26 13:47:57 -07001909#ifdef CONFIG_BLK_DEBUG_FS
1910 .show_rq = scsi_show_rq,
1911#endif
Bart Van Asschee7008ff2017-08-25 13:46:31 -07001912 .init_request = scsi_mq_init_request,
1913 .exit_request = scsi_mq_exit_request,
Ming Leib7e9e1f2019-07-25 10:05:00 +08001914 .cleanup_rq = scsi_cleanup_rq,
Jens Axboe3a7ea2c42018-10-29 10:17:28 -06001915 .busy = scsi_mq_lld_busy,
Christoph Hellwig2d9c5c22016-11-01 08:12:48 -06001916 .map_queues = scsi_map_queues,
Kashyap Desai4309ea72021-02-15 13:10:48 +05301917 .init_hctx = scsi_init_hctx,
Kashyap Desaiaf183092021-02-15 13:10:44 +05301918 .poll = scsi_mq_poll,
Ming Leid022d182021-01-22 10:33:11 +08001919 .set_rq_budget_token = scsi_mq_set_rq_budget_token,
1920 .get_rq_budget_token = scsi_mq_get_rq_budget_token,
Christoph Hellwigd2852032014-01-17 12:06:53 +01001921};
1922
Christoph Hellwigd2852032014-01-17 12:06:53 +01001923int scsi_mq_setup_tags(struct Scsi_Host *shost)
1924{
Bart Van Asschebe4c1862017-06-02 14:21:59 -07001925 unsigned int cmd_size, sgl_size;
Ye Bin840e1b52020-05-18 15:47:32 +08001926 struct blk_mq_tag_set *tag_set = &shost->tag_set;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001927
Michael Schmitz9393c8de2019-11-05 15:49:10 +13001928 sgl_size = max_t(unsigned int, sizeof(struct scatterlist),
1929 scsi_mq_inline_sgl_size(shost));
Christoph Hellwigd2852032014-01-17 12:06:53 +01001930 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1931 if (scsi_host_get_prot(shost))
Ming Lei92524fa2019-04-28 15:39:31 +08001932 cmd_size += sizeof(struct scsi_data_buffer) +
1933 sizeof(struct scatterlist) * SCSI_INLINE_PROT_SG_CNT;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001934
Ye Bin840e1b52020-05-18 15:47:32 +08001935 memset(tag_set, 0, sizeof(*tag_set));
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001936 if (shost->hostt->commit_rqs)
Ye Bin840e1b52020-05-18 15:47:32 +08001937 tag_set->ops = &scsi_mq_ops;
Paolo Bonzini8930a6c2019-05-30 13:28:10 +02001938 else
Ye Bin840e1b52020-05-18 15:47:32 +08001939 tag_set->ops = &scsi_mq_ops_no_commit;
1940 tag_set->nr_hw_queues = shost->nr_hw_queues ? : 1;
Kashyap Desaiaf183092021-02-15 13:10:44 +05301941 tag_set->nr_maps = shost->nr_maps ? : 1;
Ye Bin840e1b52020-05-18 15:47:32 +08001942 tag_set->queue_depth = shost->can_queue;
1943 tag_set->cmd_size = cmd_size;
1944 tag_set->numa_node = NUMA_NO_NODE;
1945 tag_set->flags = BLK_MQ_F_SHOULD_MERGE;
1946 tag_set->flags |=
Shaohua Li24391c02015-01-23 14:18:00 -07001947 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
Ye Bin840e1b52020-05-18 15:47:32 +08001948 tag_set->driver_data = shost;
Hannes Reineckebdb01302020-08-19 23:20:30 +08001949 if (shost->host_tagset)
1950 tag_set->flags |= BLK_MQ_F_TAG_HCTX_SHARED;
Christoph Hellwigd2852032014-01-17 12:06:53 +01001951
Ye Bin840e1b52020-05-18 15:47:32 +08001952 return blk_mq_alloc_tag_set(tag_set);
Christoph Hellwigd2852032014-01-17 12:06:53 +01001953}
1954
1955void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1956{
1957 blk_mq_free_tag_set(&shost->tag_set);
1958}
1959
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001960/**
1961 * scsi_device_from_queue - return sdev associated with a request_queue
1962 * @q: The request queue to return the sdev from
1963 *
1964 * Return the sdev associated with a request queue or NULL if the
1965 * request_queue does not reference a SCSI device.
1966 */
1967struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1968{
1969 struct scsi_device *sdev = NULL;
1970
Steffen Maier6b6fa7a2019-08-07 16:49:48 +02001971 if (q->mq_ops == &scsi_mq_ops_no_commit ||
1972 q->mq_ops == &scsi_mq_ops)
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001973 sdev = q->queuedata;
1974 if (!sdev || !get_device(&sdev->sdev_gendev))
1975 sdev = NULL;
1976
1977 return sdev;
1978}
Christoph Hellwig48450122021-10-21 08:06:07 +02001979/*
1980 * pktcdvd should have been integrated into the SCSI layers, but for historical
1981 * reasons like the old IDE driver it isn't. This export allows it to safely
1982 * probe if a given device is a SCSI one and only attach to that.
1983 */
1984#ifdef CONFIG_CDROM_PKTCDVD_MODULE
1985EXPORT_SYMBOL_GPL(scsi_device_from_queue);
1986#endif
Hannes Reinecke857de6e2017-02-17 09:02:45 +01001987
André Almeidaea941012020-04-19 02:01:48 -03001988/**
1989 * scsi_block_requests - Utility function used by low-level drivers to prevent
1990 * further commands from being queued to the device.
1991 * @shost: host in question
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 *
André Almeidaea941012020-04-19 02:01:48 -03001993 * There is no timer nor any other means by which the requests get unblocked
1994 * other than the low-level driver calling scsi_unblock_requests().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 */
1996void scsi_block_requests(struct Scsi_Host *shost)
1997{
1998 shost->host_self_blocked = 1;
1999}
2000EXPORT_SYMBOL(scsi_block_requests);
2001
André Almeidaea941012020-04-19 02:01:48 -03002002/**
2003 * scsi_unblock_requests - Utility function used by low-level drivers to allow
2004 * further commands to be queued to the device.
2005 * @shost: host in question
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 *
André Almeidaea941012020-04-19 02:01:48 -03002007 * There is no timer nor any other means by which the requests get unblocked
2008 * other than the low-level driver calling scsi_unblock_requests(). This is done
2009 * as an API function so that changes to the internals of the scsi mid-layer
2010 * won't require wholesale changes to drivers that use this feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 */
2012void scsi_unblock_requests(struct Scsi_Host *shost)
2013{
2014 shost->host_self_blocked = 0;
2015 scsi_run_host_queues(shost);
2016}
2017EXPORT_SYMBOL(scsi_unblock_requests);
2018
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019void scsi_exit_queue(void)
2020{
Christoph Hellwig0a6ac4e2017-01-03 08:28:41 +03002021 kmem_cache_destroy(scsi_sense_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022}
James Bottomley5baba832006-03-18 14:10:35 -06002023
2024/**
2025 * scsi_mode_select - issue a mode select
2026 * @sdev: SCSI device to be queried
2027 * @pf: Page format bit (1 == standard, 0 == vendor specific)
2028 * @sp: Save page bit (0 == don't save, 1 == save)
2029 * @modepage: mode page being requested
2030 * @buffer: request buffer (may not be smaller than eight bytes)
2031 * @len: length of request buffer.
2032 * @timeout: command timeout
2033 * @retries: number of retries before failing
2034 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002035 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06002036 * must be SCSI_SENSE_BUFFERSIZE big.
2037 *
2038 * Returns zero if successful; negative error number or scsi
2039 * status on error
2040 *
2041 */
2042int
2043scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2044 unsigned char *buffer, int len, int timeout, int retries,
2045 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2046{
2047 unsigned char cmd[10];
2048 unsigned char *real_buffer;
2049 int ret;
2050
2051 memset(cmd, 0, sizeof(cmd));
2052 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2053
Damien Le Moala7d68402021-08-20 16:02:54 +09002054 /*
2055 * Use MODE SELECT(10) if the device asked for it or if the mode page
2056 * and the mode select header cannot fit within the maximumm 255 bytes
2057 * of the MODE SELECT(6) command.
2058 */
2059 if (sdev->use_10_for_ms ||
2060 len + 4 > 255 ||
2061 data->block_descriptor_length > 255) {
2062 if (len > 65535 - 8)
James Bottomley5baba832006-03-18 14:10:35 -06002063 return -EINVAL;
2064 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2065 if (!real_buffer)
2066 return -ENOMEM;
2067 memcpy(real_buffer + 8, buffer, len);
2068 len += 8;
2069 real_buffer[0] = 0;
2070 real_buffer[1] = 0;
2071 real_buffer[2] = data->medium_type;
2072 real_buffer[3] = data->device_specific;
2073 real_buffer[4] = data->longlba ? 0x01 : 0;
2074 real_buffer[5] = 0;
Damien Le Moala7d68402021-08-20 16:02:54 +09002075 put_unaligned_be16(data->block_descriptor_length,
2076 &real_buffer[6]);
James Bottomley5baba832006-03-18 14:10:35 -06002077
2078 cmd[0] = MODE_SELECT_10;
Damien Le Moala7d68402021-08-20 16:02:54 +09002079 put_unaligned_be16(len, &cmd[7]);
James Bottomley5baba832006-03-18 14:10:35 -06002080 } else {
Damien Le Moala7d68402021-08-20 16:02:54 +09002081 if (data->longlba)
James Bottomley5baba832006-03-18 14:10:35 -06002082 return -EINVAL;
2083
2084 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2085 if (!real_buffer)
2086 return -ENOMEM;
2087 memcpy(real_buffer + 4, buffer, len);
2088 len += 4;
2089 real_buffer[0] = 0;
2090 real_buffer[1] = data->medium_type;
2091 real_buffer[2] = data->device_specific;
2092 real_buffer[3] = data->block_descriptor_length;
James Bottomley5baba832006-03-18 14:10:35 -06002093
2094 cmd[0] = MODE_SELECT;
2095 cmd[4] = len;
2096 }
2097
2098 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002099 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002100 kfree(real_buffer);
2101 return ret;
2102}
2103EXPORT_SYMBOL_GPL(scsi_mode_select);
2104
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105/**
Rob Landleyeb448202007-11-03 13:30:39 -05002106 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002107 * @sdev: SCSI device to be queried
Damien Le Moal17b49bc2021-08-20 16:02:53 +09002108 * @dbd: set to prevent mode sense from returning block descriptors
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 * @modepage: mode page being requested
2110 * @buffer: request buffer (may not be smaller than eight bytes)
2111 * @len: length of request buffer.
2112 * @timeout: command timeout
2113 * @retries: number of retries before failing
2114 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002115 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002116 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 *
Hannes Reinecke87936132021-04-27 10:30:09 +02002118 * Returns zero if successful, or a negative error number on failure
Rob Landleyeb448202007-11-03 13:30:39 -05002119 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120int
James Bottomley1cf72692005-08-28 11:27:01 -05002121scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002123 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2124{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 unsigned char cmd[12];
2126 int use_10_for_ms;
2127 int header_length;
Hannes Reinecke0ae80ba2015-06-12 16:12:48 +02002128 int result, retry_count = retries;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002129 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
2131 memset(data, 0, sizeof(*data));
2132 memset(&cmd[0], 0, 12);
Can Guo0ec96912019-12-05 02:14:25 +00002133
2134 dbd = sdev->set_dbd_for_ms ? 8 : dbd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2136 cmd[2] = modepage;
2137
James Bottomleyea73a9f2005-08-28 11:33:52 -05002138 /* caller might not be interested in sense, but we need it */
2139 if (!sshdr)
2140 sshdr = &my_sshdr;
2141
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 retry:
Damien Le Moal17b49bc2021-08-20 16:02:53 +09002143 use_10_for_ms = sdev->use_10_for_ms || len > 255;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144
2145 if (use_10_for_ms) {
Damien Le Moal17b49bc2021-08-20 16:02:53 +09002146 if (len < 8 || len > 65535)
2147 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148
2149 cmd[0] = MODE_SENSE_10;
Damien Le Moal17b49bc2021-08-20 16:02:53 +09002150 put_unaligned_be16(len, &cmd[7]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 header_length = 8;
2152 } else {
2153 if (len < 4)
Damien Le Moal17b49bc2021-08-20 16:02:53 +09002154 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155
2156 cmd[0] = MODE_SENSE;
2157 cmd[4] = len;
2158 header_length = 4;
2159 }
2160
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 memset(buffer, 0, len);
2162
James Bottomley1cf72692005-08-28 11:27:01 -05002163 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002164 sshdr, timeout, retries, NULL);
Hannes Reinecke87936132021-04-27 10:30:09 +02002165 if (result < 0)
2166 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167
2168 /* This code looks awful: what it's doing is making sure an
2169 * ILLEGAL REQUEST sense return identifies the actual command
2170 * byte as the problem. MODE_SENSE commands can return
2171 * ILLEGAL REQUEST if the code page isn't supported */
2172
Hannes Reinecke64aaa3d2021-04-27 10:30:10 +02002173 if (!scsi_status_is_good(result)) {
Hannes Reinecke464a00c2021-04-27 10:30:15 +02002174 if (scsi_sense_valid(sshdr)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002175 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2176 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Bean Huo4c7b4d62020-06-19 17:41:17 +02002177 /*
Damien Le Moal17b49bc2021-08-20 16:02:53 +09002178 * Invalid command operation code: retry using
2179 * MODE SENSE(6) if this was a MODE SENSE(10)
2180 * request, except if the request mode page is
2181 * too large for MODE SENSE single byte
2182 * allocation length field.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 */
Hannes Reinecke64aaa3d2021-04-27 10:30:10 +02002184 if (use_10_for_ms) {
Damien Le Moal17b49bc2021-08-20 16:02:53 +09002185 if (len > 255)
2186 return -EIO;
Hannes Reinecke64aaa3d2021-04-27 10:30:10 +02002187 sdev->use_10_for_ms = 0;
2188 goto retry;
2189 }
2190 }
Hannes Reinecked0672a02021-04-27 10:30:14 +02002191 if (scsi_status_is_check_condition(result) &&
Hannes Reinecke64aaa3d2021-04-27 10:30:10 +02002192 sshdr->sense_key == UNIT_ATTENTION &&
2193 retry_count) {
2194 retry_count--;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 goto retry;
2196 }
2197 }
Hannes Reinecke64aaa3d2021-04-27 10:30:10 +02002198 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 }
Hannes Reinecke64aaa3d2021-04-27 10:30:10 +02002200 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2201 (modepage == 6 || modepage == 8))) {
2202 /* Initio breakage? */
2203 header_length = 0;
2204 data->length = 13;
2205 data->medium_type = 0;
2206 data->device_specific = 0;
2207 data->longlba = 0;
2208 data->block_descriptor_length = 0;
2209 } else if (use_10_for_ms) {
Damien Le Moal17b49bc2021-08-20 16:02:53 +09002210 data->length = get_unaligned_be16(&buffer[0]) + 2;
Hannes Reinecke64aaa3d2021-04-27 10:30:10 +02002211 data->medium_type = buffer[2];
2212 data->device_specific = buffer[3];
2213 data->longlba = buffer[4] & 0x01;
Damien Le Moal17b49bc2021-08-20 16:02:53 +09002214 data->block_descriptor_length = get_unaligned_be16(&buffer[6]);
Hannes Reinecke64aaa3d2021-04-27 10:30:10 +02002215 } else {
2216 data->length = buffer[0] + 1;
2217 data->medium_type = buffer[1];
2218 data->device_specific = buffer[2];
2219 data->block_descriptor_length = buffer[3];
2220 }
2221 data->header_length = header_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222
Hannes Reinecke64aaa3d2021-04-27 10:30:10 +02002223 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224}
2225EXPORT_SYMBOL(scsi_mode_sense);
2226
James Bottomley001aac22007-12-02 19:10:40 +02002227/**
2228 * scsi_test_unit_ready - test if unit is ready
2229 * @sdev: scsi device to change the state of.
2230 * @timeout: command timeout
2231 * @retries: number of retries before failing
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002232 * @sshdr: outpout pointer for decoded sense information.
James Bottomley001aac22007-12-02 19:10:40 +02002233 *
2234 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002235 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002236 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237int
James Bottomley001aac22007-12-02 19:10:40 +02002238scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
Christoph Hellwig74a78eb2017-02-14 20:15:57 +01002239 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 char cmd[] = {
2242 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2243 };
2244 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002245
James Bottomley001aac22007-12-02 19:10:40 +02002246 /* try to eat the UNIT_ATTENTION if there are enough retries */
2247 do {
2248 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
Bart Van Assche9b91fd32018-02-12 10:57:52 -08002249 timeout, 1, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002250 if (sdev->removable && scsi_sense_valid(sshdr) &&
2251 sshdr->sense_key == UNIT_ATTENTION)
2252 sdev->changed = 1;
2253 } while (scsi_sense_valid(sshdr) &&
2254 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002255
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 return result;
2257}
2258EXPORT_SYMBOL(scsi_test_unit_ready);
2259
2260/**
Rob Landleyeb448202007-11-03 13:30:39 -05002261 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 * @sdev: scsi device to change the state of.
2263 * @state: state to change to.
2264 *
Hannes Reinecke23cb27f2017-08-25 13:56:56 +02002265 * Returns zero if successful or an error if the requested
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002267 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268int
2269scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2270{
2271 enum scsi_device_state oldstate = sdev->sdev_state;
2272
2273 if (state == oldstate)
2274 return 0;
2275
2276 switch (state) {
2277 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002278 switch (oldstate) {
2279 case SDEV_CREATED_BLOCK:
2280 break;
2281 default:
2282 goto illegal;
2283 }
2284 break;
Bean Huo4c7b4d62020-06-19 17:41:17 +02002285
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 case SDEV_RUNNING:
2287 switch (oldstate) {
2288 case SDEV_CREATED:
2289 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002290 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 case SDEV_QUIESCE:
2292 case SDEV_BLOCK:
2293 break;
2294 default:
2295 goto illegal;
2296 }
2297 break;
2298
2299 case SDEV_QUIESCE:
2300 switch (oldstate) {
2301 case SDEV_RUNNING:
2302 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002303 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 break;
2305 default:
2306 goto illegal;
2307 }
2308 break;
2309
2310 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002311 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 switch (oldstate) {
2313 case SDEV_CREATED:
2314 case SDEV_RUNNING:
2315 case SDEV_QUIESCE:
2316 case SDEV_BLOCK:
2317 break;
2318 default:
2319 goto illegal;
2320 }
2321 break;
2322
2323 case SDEV_BLOCK:
2324 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002326 case SDEV_CREATED_BLOCK:
Dexuan Cui6cbb7ae2020-04-17 17:40:45 -07002327 case SDEV_QUIESCE:
Hannes Reineckea33e5bf2018-10-07 10:35:35 +02002328 case SDEV_OFFLINE:
James Bottomley6f4267e2008-08-22 16:53:31 -05002329 break;
2330 default:
2331 goto illegal;
2332 }
2333 break;
2334
2335 case SDEV_CREATED_BLOCK:
2336 switch (oldstate) {
2337 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 break;
2339 default:
2340 goto illegal;
2341 }
2342 break;
2343
2344 case SDEV_CANCEL:
2345 switch (oldstate) {
2346 case SDEV_CREATED:
2347 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002348 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002350 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 break;
2352 default:
2353 goto illegal;
2354 }
2355 break;
2356
2357 case SDEV_DEL:
2358 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002359 case SDEV_CREATED:
2360 case SDEV_RUNNING:
2361 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002362 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363 case SDEV_CANCEL:
Bart Van Assche255ee932017-06-02 14:21:57 -07002364 case SDEV_BLOCK:
Bart Van Assche0516c082013-07-02 15:06:33 +02002365 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 break;
2367 default:
2368 goto illegal;
2369 }
2370 break;
2371
2372 }
Ewan D. Milneb0962c52020-03-11 10:39:30 -04002373 sdev->offline_already = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 sdev->sdev_state = state;
2375 return 0;
2376
2377 illegal:
Hannes Reinecke91921e02014-06-25 16:39:59 +02002378 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002379 sdev_printk(KERN_ERR, sdev,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002380 "Illegal state transition %s->%s",
James Bottomley9ccfc752005-10-02 11:45:08 -05002381 scsi_device_state_name(oldstate),
2382 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 );
2384 return -EINVAL;
2385}
2386EXPORT_SYMBOL(scsi_device_set_state);
2387
2388/**
Mauro Carvalho Chehabae6b4e62020-10-23 18:33:14 +02002389 * scsi_evt_emit - emit a single SCSI device uevent
Jeff Garzika341cd02007-10-29 17:15:22 -04002390 * @sdev: associated SCSI device
2391 * @evt: event to emit
2392 *
2393 * Send a single uevent (scsi_event) to the associated scsi_device.
2394 */
2395static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2396{
2397 int idx = 0;
2398 char *envp[3];
2399
2400 switch (evt->evt_type) {
2401 case SDEV_EVT_MEDIA_CHANGE:
2402 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2403 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002404 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
Hannes Reinecked3d32892016-02-19 09:17:16 +01002405 scsi_rescan_device(&sdev->sdev_gendev);
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002406 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2407 break;
2408 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2409 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2410 break;
2411 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2412 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2413 break;
2414 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2415 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2416 break;
2417 case SDEV_EVT_LUN_CHANGE_REPORTED:
2418 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2419 break;
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002420 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2421 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2422 break;
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002423 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2424 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2425 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002426 default:
2427 /* do nothing */
2428 break;
2429 }
2430
2431 envp[idx++] = NULL;
2432
2433 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2434}
2435
2436/**
Mauro Carvalho Chehabae6b4e62020-10-23 18:33:14 +02002437 * scsi_evt_thread - send a uevent for each scsi event
Jeff Garzika341cd02007-10-29 17:15:22 -04002438 * @work: work struct for scsi_device
2439 *
2440 * Dispatch queued events to their associated scsi_device kobjects
2441 * as uevents.
2442 */
2443void scsi_evt_thread(struct work_struct *work)
2444{
2445 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002446 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002447 LIST_HEAD(event_list);
2448
2449 sdev = container_of(work, struct scsi_device, event_work);
2450
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002451 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2452 if (test_and_clear_bit(evt_type, sdev->pending_events))
2453 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2454
Jeff Garzika341cd02007-10-29 17:15:22 -04002455 while (1) {
2456 struct scsi_event *evt;
2457 struct list_head *this, *tmp;
2458 unsigned long flags;
2459
2460 spin_lock_irqsave(&sdev->list_lock, flags);
2461 list_splice_init(&sdev->event_list, &event_list);
2462 spin_unlock_irqrestore(&sdev->list_lock, flags);
2463
2464 if (list_empty(&event_list))
2465 break;
2466
2467 list_for_each_safe(this, tmp, &event_list) {
2468 evt = list_entry(this, struct scsi_event, node);
2469 list_del(&evt->node);
2470 scsi_evt_emit(sdev, evt);
2471 kfree(evt);
2472 }
2473 }
2474}
2475
2476/**
2477 * sdev_evt_send - send asserted event to uevent thread
2478 * @sdev: scsi_device event occurred on
2479 * @evt: event to send
2480 *
2481 * Assert scsi device event asynchronously.
2482 */
2483void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2484{
2485 unsigned long flags;
2486
Kay Sievers4d1566e2008-03-19 13:04:47 +01002487#if 0
2488 /* FIXME: currently this check eliminates all media change events
2489 * for polled devices. Need to update to discriminate between AN
2490 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002491 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2492 kfree(evt);
2493 return;
2494 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002495#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002496
2497 spin_lock_irqsave(&sdev->list_lock, flags);
2498 list_add_tail(&evt->node, &sdev->event_list);
2499 schedule_work(&sdev->event_work);
2500 spin_unlock_irqrestore(&sdev->list_lock, flags);
2501}
2502EXPORT_SYMBOL_GPL(sdev_evt_send);
2503
2504/**
2505 * sdev_evt_alloc - allocate a new scsi event
2506 * @evt_type: type of event to allocate
2507 * @gfpflags: GFP flags for allocation
2508 *
2509 * Allocates and returns a new scsi_event.
2510 */
2511struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2512 gfp_t gfpflags)
2513{
2514 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2515 if (!evt)
2516 return NULL;
2517
2518 evt->evt_type = evt_type;
2519 INIT_LIST_HEAD(&evt->node);
2520
2521 /* evt_type-specific initialization, if any */
2522 switch (evt_type) {
2523 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002524 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2525 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2526 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2527 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2528 case SDEV_EVT_LUN_CHANGE_REPORTED:
Hannes Reinecke14c3e672015-07-06 13:41:53 +02002529 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
Hannes Reineckecf3431b2017-10-17 09:11:24 +02002530 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002531 default:
2532 /* do nothing */
2533 break;
2534 }
2535
2536 return evt;
2537}
2538EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2539
2540/**
2541 * sdev_evt_send_simple - send asserted event to uevent thread
2542 * @sdev: scsi_device event occurred on
2543 * @evt_type: type of event to send
2544 * @gfpflags: GFP flags for allocation
2545 *
2546 * Assert scsi device event asynchronously, given an event type.
2547 */
2548void sdev_evt_send_simple(struct scsi_device *sdev,
2549 enum scsi_device_event evt_type, gfp_t gfpflags)
2550{
2551 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2552 if (!evt) {
2553 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2554 evt_type);
2555 return;
2556 }
2557
2558 sdev_evt_send(sdev, evt);
2559}
2560EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2561
2562/**
Bart Van Asschee6044f72020-12-08 21:29:49 -08002563 * scsi_device_quiesce - Block all commands except power management.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564 * @sdev: scsi device to quiesce.
2565 *
2566 * This works by trying to transition to the SDEV_QUIESCE state
2567 * (which must be a legal transition). When the device is in this
Bart Van Asschee6044f72020-12-08 21:29:49 -08002568 * state, only power management requests will be accepted, all others will
2569 * be deferred.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570 *
2571 * Must be called with user context, may sleep.
2572 *
2573 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002574 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575int
2576scsi_device_quiesce(struct scsi_device *sdev)
2577{
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002578 struct request_queue *q = sdev->request_queue;
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002579 int err;
2580
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002581 /*
2582 * It is allowed to call scsi_device_quiesce() multiple times from
2583 * the same context but concurrent scsi_device_quiesce() calls are
2584 * not allowed.
2585 */
2586 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2587
Bart Van Asschecd84a622018-09-26 14:01:04 -07002588 if (sdev->quiesced_by == current)
2589 return 0;
2590
2591 blk_set_pm_only(q);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002592
2593 blk_mq_freeze_queue(q);
2594 /*
Bart Van Asschecd84a622018-09-26 14:01:04 -07002595 * Ensure that the effect of blk_set_pm_only() will be visible
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002596 * for percpu_ref_tryget() callers that occur after the queue
2597 * unfreeze even if the queue was already frozen before this function
2598 * was called. See also https://lwn.net/Articles/573497/.
2599 */
2600 synchronize_rcu();
2601 blk_mq_unfreeze_queue(q);
2602
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002603 mutex_lock(&sdev->state_mutex);
2604 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002605 if (err == 0)
2606 sdev->quiesced_by = current;
2607 else
Bart Van Asschecd84a622018-09-26 14:01:04 -07002608 blk_clear_pm_only(q);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002609 mutex_unlock(&sdev->state_mutex);
2610
Bart Van Assche3a0a5292017-11-09 10:49:58 -08002611 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612}
2613EXPORT_SYMBOL(scsi_device_quiesce);
2614
2615/**
2616 * scsi_device_resume - Restart user issued commands to a quiesced device.
2617 * @sdev: scsi device to resume.
2618 *
2619 * Moves the device from quiesced back to running and restarts the
2620 * queues.
2621 *
2622 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002623 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002624void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002626 /* check if the device state was mutated prior to resume, and if
2627 * so assume the state is being managed elsewhere (for example
2628 * device deleted during suspend)
2629 */
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002630 mutex_lock(&sdev->state_mutex);
Bart Van Asschee6044f72020-12-08 21:29:49 -08002631 if (sdev->sdev_state == SDEV_QUIESCE)
2632 scsi_device_set_state(sdev, SDEV_RUNNING);
Bart Van Assche17605af2019-03-15 16:27:58 -07002633 if (sdev->quiesced_by) {
2634 sdev->quiesced_by = NULL;
2635 blk_clear_pm_only(sdev->request_queue);
2636 }
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002637 mutex_unlock(&sdev->state_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638}
2639EXPORT_SYMBOL(scsi_device_resume);
2640
2641static void
2642device_quiesce_fn(struct scsi_device *sdev, void *data)
2643{
2644 scsi_device_quiesce(sdev);
2645}
2646
2647void
2648scsi_target_quiesce(struct scsi_target *starget)
2649{
2650 starget_for_each_device(starget, NULL, device_quiesce_fn);
2651}
2652EXPORT_SYMBOL(scsi_target_quiesce);
2653
2654static void
2655device_resume_fn(struct scsi_device *sdev, void *data)
2656{
2657 scsi_device_resume(sdev);
2658}
2659
2660void
2661scsi_target_resume(struct scsi_target *starget)
2662{
2663 starget_for_each_device(starget, NULL, device_resume_fn);
2664}
2665EXPORT_SYMBOL(scsi_target_resume);
2666
Ming Leid2b9f12b2021-11-09 15:11:42 +08002667static int __scsi_internal_device_block_nowait(struct scsi_device *sdev)
2668{
2669 if (scsi_device_set_state(sdev, SDEV_BLOCK))
2670 return scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2671
2672 return 0;
2673}
2674
Ming Lei93542fb2021-11-09 15:11:43 +08002675void scsi_start_queue(struct scsi_device *sdev)
2676{
2677 if (cmpxchg(&sdev->queue_stopped, 1, 0))
2678 blk_mq_unquiesce_queue(sdev->request_queue);
2679}
2680
2681static void scsi_stop_queue(struct scsi_device *sdev, bool nowait)
2682{
2683 /*
2684 * The atomic variable of ->queue_stopped covers that
2685 * blk_mq_quiesce_queue* is balanced with blk_mq_unquiesce_queue.
2686 *
2687 * However, we still need to wait until quiesce is done
2688 * in case that queue has been stopped.
2689 */
2690 if (!cmpxchg(&sdev->queue_stopped, 0, 1)) {
2691 if (nowait)
2692 blk_mq_quiesce_queue_nowait(sdev->request_queue);
2693 else
2694 blk_mq_quiesce_queue(sdev->request_queue);
2695 } else {
2696 if (!nowait)
2697 blk_mq_wait_quiesce_done(sdev->request_queue);
2698 }
2699}
2700
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002702 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2703 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002704 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002705 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002706 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002707 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002708 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002709 * Notes:
2710 * This routine transitions the device to the SDEV_BLOCK state (which must be
2711 * a legal transition). When the device is in this state, command processing
2712 * is paused until the device leaves the SDEV_BLOCK state. See also
2713 * scsi_internal_device_unblock_nowait().
Rob Landleyeb448202007-11-03 13:30:39 -05002714 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002715int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716{
Ming Leid2b9f12b2021-11-09 15:11:42 +08002717 int ret = __scsi_internal_device_block_nowait(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002718
Bean Huo4c7b4d62020-06-19 17:41:17 +02002719 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720 * The device has transitioned to SDEV_BLOCK. Stop the
2721 * block layer from calling the midlayer with this device's
Bean Huo4c7b4d62020-06-19 17:41:17 +02002722 * request queue.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723 */
Ming Leid2b9f12b2021-11-09 15:11:42 +08002724 if (!ret)
Ming Lei93542fb2021-11-09 15:11:43 +08002725 scsi_stop_queue(sdev, true);
Ming Leid2b9f12b2021-11-09 15:11:42 +08002726 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727}
Bart Van Assche551eb592017-06-02 14:21:53 -07002728EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2729
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730/**
Bart Van Assche551eb592017-06-02 14:21:53 -07002731 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2732 * @sdev: device to block
Linus Torvalds1da177e2005-04-16 15:20:36 -07002733 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002734 * Pause SCSI command processing on the specified device and wait until all
2735 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002737 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738 *
Bart Van Assche551eb592017-06-02 14:21:53 -07002739 * Note:
2740 * This routine transitions the device to the SDEV_BLOCK state (which must be
2741 * a legal transition). When the device is in this state, command processing
2742 * is paused until the device leaves the SDEV_BLOCK state. See also
2743 * scsi_internal_device_unblock().
Rob Landleyeb448202007-11-03 13:30:39 -05002744 */
Bart Van Assche551eb592017-06-02 14:21:53 -07002745static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746{
Bart Van Assche551eb592017-06-02 14:21:53 -07002747 int err;
2748
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002749 mutex_lock(&sdev->state_mutex);
Ming Leid2b9f12b2021-11-09 15:11:42 +08002750 err = __scsi_internal_device_block_nowait(sdev);
Jens Axboef664a3c2018-11-01 16:36:27 -06002751 if (err == 0)
Ming Lei93542fb2021-11-09 15:11:43 +08002752 scsi_stop_queue(sdev, false);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002753 mutex_unlock(&sdev->state_mutex);
2754
Bart Van Assche551eb592017-06-02 14:21:53 -07002755 return err;
2756}
Bean Huo4c7b4d62020-06-19 17:41:17 +02002757
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758/**
Bart Van Assche43f75712017-06-02 14:21:54 -07002759 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760 * @sdev: device to resume
Bart Van Assche43f75712017-06-02 14:21:54 -07002761 * @new_state: state to set the device to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002763 * Restart the device queue for a previously suspended SCSI device. Does not
2764 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002766 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767 *
Bart Van Assche43f75712017-06-02 14:21:54 -07002768 * Notes:
2769 * This routine transitions the device to the SDEV_RUNNING state or to one of
2770 * the offline states (which must be a legal transition) allowing the midlayer
2771 * to goose the queue for this device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772 */
Bart Van Assche43f75712017-06-02 14:21:54 -07002773int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2774 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775{
Bart Van Assche09addb12019-08-01 15:38:12 -07002776 switch (new_state) {
2777 case SDEV_RUNNING:
2778 case SDEV_TRANSPORT_OFFLINE:
2779 break;
2780 default:
2781 return -EINVAL;
2782 }
2783
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002784 /*
2785 * Try to transition the scsi device to SDEV_RUNNING or one of the
2786 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787 */
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002788 switch (sdev->sdev_state) {
2789 case SDEV_BLOCK:
2790 case SDEV_TRANSPORT_OFFLINE:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002791 sdev->sdev_state = new_state;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002792 break;
2793 case SDEV_CREATED_BLOCK:
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002794 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2795 new_state == SDEV_OFFLINE)
2796 sdev->sdev_state = new_state;
2797 else
2798 sdev->sdev_state = SDEV_CREATED;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002799 break;
2800 case SDEV_CANCEL:
2801 case SDEV_OFFLINE:
2802 break;
2803 default:
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002804 return -EINVAL;
Hannes Reinecke8cd1ec72017-08-11 08:53:46 +02002805 }
Bart Van Assche66483a42017-06-02 14:21:56 -07002806 scsi_start_queue(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807
2808 return 0;
2809}
Bart Van Assche43f75712017-06-02 14:21:54 -07002810EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2811
2812/**
2813 * scsi_internal_device_unblock - resume a device after a block request
2814 * @sdev: device to resume
2815 * @new_state: state to set the device to after unblocking
2816 *
2817 * Restart the device queue for a previously suspended SCSI device. May sleep.
2818 *
2819 * Returns zero if successful or a negative error code upon failure.
2820 *
2821 * Notes:
2822 * This routine transitions the device to the SDEV_RUNNING state or to one of
2823 * the offline states (which must be a legal transition) allowing the midlayer
2824 * to goose the queue for this device.
2825 */
2826static int scsi_internal_device_unblock(struct scsi_device *sdev,
2827 enum scsi_device_state new_state)
2828{
Bart Van Assche0db6ca82017-06-02 14:21:55 -07002829 int ret;
2830
2831 mutex_lock(&sdev->state_mutex);
2832 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2833 mutex_unlock(&sdev->state_mutex);
2834
2835 return ret;
Bart Van Assche43f75712017-06-02 14:21:54 -07002836}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002837
2838static void
2839device_block(struct scsi_device *sdev, void *data)
2840{
Bart Van Assche94ef80a2019-08-01 15:38:13 -07002841 int ret;
2842
2843 ret = scsi_internal_device_block(sdev);
2844
2845 WARN_ONCE(ret, "scsi_internal_device_block(%s) failed: ret = %d\n",
2846 dev_name(&sdev->sdev_gendev), ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847}
2848
2849static int
2850target_block(struct device *dev, void *data)
2851{
2852 if (scsi_is_target_device(dev))
2853 starget_for_each_device(to_scsi_target(dev), NULL,
2854 device_block);
2855 return 0;
2856}
2857
2858void
2859scsi_target_block(struct device *dev)
2860{
2861 if (scsi_is_target_device(dev))
2862 starget_for_each_device(to_scsi_target(dev), NULL,
2863 device_block);
2864 else
2865 device_for_each_child(dev, NULL, target_block);
2866}
2867EXPORT_SYMBOL_GPL(scsi_target_block);
2868
2869static void
2870device_unblock(struct scsi_device *sdev, void *data)
2871{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002872 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873}
2874
2875static int
2876target_unblock(struct device *dev, void *data)
2877{
2878 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002879 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880 device_unblock);
2881 return 0;
2882}
2883
2884void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002885scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002886{
2887 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002888 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002889 device_unblock);
2890 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002891 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002892}
2893EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002894
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002895int
2896scsi_host_block(struct Scsi_Host *shost)
2897{
2898 struct scsi_device *sdev;
2899 int ret = 0;
2900
Ming Leif9836222020-04-23 10:07:13 +08002901 /*
2902 * Call scsi_internal_device_block_nowait so we can avoid
2903 * calling synchronize_rcu() for each LUN.
2904 */
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002905 shost_for_each_device(sdev, shost) {
Ming Leif9836222020-04-23 10:07:13 +08002906 mutex_lock(&sdev->state_mutex);
2907 ret = scsi_internal_device_block_nowait(sdev);
2908 mutex_unlock(&sdev->state_mutex);
Ye Binf30785d2020-07-17 17:09:20 +08002909 if (ret) {
2910 scsi_device_put(sdev);
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002911 break;
Ye Binf30785d2020-07-17 17:09:20 +08002912 }
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002913 }
Ming Leif9836222020-04-23 10:07:13 +08002914
2915 /*
2916 * SCSI never enables blk-mq's BLK_MQ_F_BLOCKING flag so
2917 * calling synchronize_rcu() once is enough.
2918 */
2919 WARN_ON_ONCE(shost->tag_set.flags & BLK_MQ_F_BLOCKING);
2920
2921 if (!ret)
2922 synchronize_rcu();
2923
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002924 return ret;
2925}
2926EXPORT_SYMBOL_GPL(scsi_host_block);
2927
2928int
2929scsi_host_unblock(struct Scsi_Host *shost, int new_state)
2930{
2931 struct scsi_device *sdev;
2932 int ret = 0;
2933
2934 shost_for_each_device(sdev, shost) {
2935 ret = scsi_internal_device_unblock(sdev, new_state);
Ye Bin4dea1702020-05-18 15:44:20 +08002936 if (ret) {
2937 scsi_device_put(sdev);
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002938 break;
Ye Bin4dea1702020-05-18 15:44:20 +08002939 }
Hannes Reinecke2bb95582020-02-28 08:53:13 +01002940 }
2941 return ret;
2942}
2943EXPORT_SYMBOL_GPL(scsi_host_unblock);
2944
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002945/**
2946 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002947 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002948 * @sg_count: number of segments in sg
2949 * @offset: offset in bytes into sg, on return offset into the mapped area
2950 * @len: bytes to map, on return number of bytes mapped
2951 *
2952 * Returns virtual address of the start of the mapped page
2953 */
Jens Axboec6132da2007-10-16 11:08:49 +02002954void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002955 size_t *offset, size_t *len)
2956{
2957 int i;
2958 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002959 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002960 struct page *page;
2961
Andrew Morton22cfefb2007-02-05 16:39:03 -08002962 WARN_ON(!irqs_disabled());
2963
Jens Axboec6132da2007-10-16 11:08:49 +02002964 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002965 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002966 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002967 if (sg_len > *offset)
2968 break;
2969 }
2970
2971 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002972 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2973 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002974 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002975 WARN_ON(1);
2976 return NULL;
2977 }
2978
2979 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002980 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002981
2982 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002983 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002984 *offset &= ~PAGE_MASK;
2985
2986 /* Bytes in this sg-entry from *offset to the end of the page */
2987 sg_len = PAGE_SIZE - *offset;
2988 if (*len > sg_len)
2989 *len = sg_len;
2990
Cong Wang77dfce02011-11-25 23:14:23 +08002991 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002992}
2993EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2994
2995/**
Rob Landleyeb448202007-11-03 13:30:39 -05002996 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002997 * @virt: virtual address to be unmapped
2998 */
2999void scsi_kunmap_atomic_sg(void *virt)
3000{
Cong Wang77dfce02011-11-25 23:14:23 +08003001 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02003002}
3003EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08003004
3005void sdev_disable_disk_events(struct scsi_device *sdev)
3006{
3007 atomic_inc(&sdev->disk_events_disable_depth);
3008}
3009EXPORT_SYMBOL(sdev_disable_disk_events);
3010
3011void sdev_enable_disk_events(struct scsi_device *sdev)
3012{
3013 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
3014 return;
3015 atomic_dec(&sdev->disk_events_disable_depth);
3016}
3017EXPORT_SYMBOL(sdev_enable_disk_events);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003018
Martin Wilck2e4209b2020-10-29 18:08:45 +01003019static unsigned char designator_prio(const unsigned char *d)
3020{
3021 if (d[1] & 0x30)
3022 /* not associated with LUN */
3023 return 0;
3024
3025 if (d[3] == 0)
3026 /* invalid length */
3027 return 0;
3028
3029 /*
3030 * Order of preference for lun descriptor:
3031 * - SCSI name string
3032 * - NAA IEEE Registered Extended
3033 * - EUI-64 based 16-byte
3034 * - EUI-64 based 12-byte
3035 * - NAA IEEE Registered
3036 * - NAA IEEE Extended
3037 * - EUI-64 based 8-byte
3038 * - SCSI name string (truncated)
3039 * - T10 Vendor ID
3040 * as longer descriptors reduce the likelyhood
3041 * of identification clashes.
3042 */
3043
3044 switch (d[1] & 0xf) {
3045 case 8:
3046 /* SCSI name string, variable-length UTF-8 */
3047 return 9;
3048 case 3:
3049 switch (d[4] >> 4) {
3050 case 6:
3051 /* NAA registered extended */
3052 return 8;
3053 case 5:
3054 /* NAA registered */
3055 return 5;
3056 case 4:
3057 /* NAA extended */
3058 return 4;
3059 case 3:
3060 /* NAA locally assigned */
3061 return 1;
3062 default:
3063 break;
3064 }
3065 break;
3066 case 2:
3067 switch (d[3]) {
3068 case 16:
3069 /* EUI64-based, 16 byte */
3070 return 7;
3071 case 12:
3072 /* EUI64-based, 12 byte */
3073 return 6;
3074 case 8:
3075 /* EUI64-based, 8 byte */
3076 return 3;
3077 default:
3078 break;
3079 }
3080 break;
3081 case 1:
3082 /* T10 vendor ID */
3083 return 1;
3084 default:
3085 break;
3086 }
3087
3088 return 0;
3089}
3090
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003091/**
3092 * scsi_vpd_lun_id - return a unique device identification
3093 * @sdev: SCSI device
3094 * @id: buffer for the identification
3095 * @id_len: length of the buffer
3096 *
3097 * Copies a unique device identification into @id based
3098 * on the information in the VPD page 0x83 of the device.
3099 * The string will be formatted as a SCSI name string.
3100 *
3101 * Returns the length of the identification or error on failure.
3102 * If the identifier is longer than the supplied buffer the actual
3103 * identifier length is returned and the buffer is not zero-padded.
3104 */
3105int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
3106{
Martin Wilck2e4209b2020-10-29 18:08:45 +01003107 u8 cur_id_prio = 0;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003108 u8 cur_id_size = 0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003109 const unsigned char *d, *cur_id_str;
3110 const struct scsi_vpd *vpd_pg83;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003111 int id_size = -EINVAL;
3112
3113 rcu_read_lock();
3114 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3115 if (!vpd_pg83) {
3116 rcu_read_unlock();
3117 return -ENXIO;
3118 }
3119
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003120 /* The id string must be at least 20 bytes + terminating NULL byte */
3121 if (id_len < 21) {
3122 rcu_read_unlock();
3123 return -EINVAL;
3124 }
3125
3126 memset(id, 0, id_len);
Martin Wilck16d63172020-10-29 18:08:46 +01003127 for (d = vpd_pg83->data + 4;
3128 d < vpd_pg83->data + vpd_pg83->len;
3129 d += d[3] + 4) {
Martin Wilck2e4209b2020-10-29 18:08:45 +01003130 u8 prio = designator_prio(d);
3131
3132 if (prio == 0 || cur_id_prio > prio)
Martin Wilck16d63172020-10-29 18:08:46 +01003133 continue;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003134
3135 switch (d[1] & 0xf) {
Hannes Reinecked2308232016-05-09 09:14:29 +02003136 case 0x1:
3137 /* T10 Vendor ID */
3138 if (cur_id_size > d[3])
3139 break;
Martin Wilck2e4209b2020-10-29 18:08:45 +01003140 cur_id_prio = prio;
Hannes Reinecked2308232016-05-09 09:14:29 +02003141 cur_id_size = d[3];
3142 if (cur_id_size + 4 > id_len)
3143 cur_id_size = id_len - 4;
3144 cur_id_str = d + 4;
Hannes Reinecked2308232016-05-09 09:14:29 +02003145 id_size = snprintf(id, id_len, "t10.%*pE",
3146 cur_id_size, cur_id_str);
3147 break;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003148 case 0x2:
3149 /* EUI-64 */
Martin Wilck2e4209b2020-10-29 18:08:45 +01003150 cur_id_prio = prio;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003151 cur_id_size = d[3];
3152 cur_id_str = d + 4;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003153 switch (cur_id_size) {
3154 case 8:
3155 id_size = snprintf(id, id_len,
3156 "eui.%8phN",
3157 cur_id_str);
3158 break;
3159 case 12:
3160 id_size = snprintf(id, id_len,
3161 "eui.%12phN",
3162 cur_id_str);
3163 break;
3164 case 16:
3165 id_size = snprintf(id, id_len,
3166 "eui.%16phN",
3167 cur_id_str);
3168 break;
3169 default:
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003170 break;
3171 }
3172 break;
3173 case 0x3:
3174 /* NAA */
Martin Wilck2e4209b2020-10-29 18:08:45 +01003175 cur_id_prio = prio;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003176 cur_id_size = d[3];
3177 cur_id_str = d + 4;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003178 switch (cur_id_size) {
3179 case 8:
3180 id_size = snprintf(id, id_len,
3181 "naa.%8phN",
3182 cur_id_str);
3183 break;
3184 case 16:
3185 id_size = snprintf(id, id_len,
3186 "naa.%16phN",
3187 cur_id_str);
3188 break;
3189 default:
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003190 break;
3191 }
3192 break;
3193 case 0x8:
3194 /* SCSI name string */
Martin Wilck2e4209b2020-10-29 18:08:45 +01003195 if (cur_id_size > d[3])
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003196 break;
3197 /* Prefer others for truncated descriptor */
Martin Wilck2e4209b2020-10-29 18:08:45 +01003198 if (d[3] > id_len) {
3199 prio = 2;
3200 if (cur_id_prio > prio)
3201 break;
3202 }
3203 cur_id_prio = prio;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003204 cur_id_size = id_size = d[3];
3205 cur_id_str = d + 4;
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003206 if (cur_id_size >= id_len)
3207 cur_id_size = id_len - 1;
3208 memcpy(id, cur_id_str, cur_id_size);
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003209 break;
3210 default:
3211 break;
3212 }
Hannes Reinecke9983bed2015-12-01 10:16:55 +01003213 }
3214 rcu_read_unlock();
3215
3216 return id_size;
3217}
3218EXPORT_SYMBOL(scsi_vpd_lun_id);
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003219
3220/*
3221 * scsi_vpd_tpg_id - return a target port group identifier
3222 * @sdev: SCSI device
3223 *
3224 * Returns the Target Port Group identifier from the information
3225 * froom VPD page 0x83 of the device.
3226 *
3227 * Returns the identifier or error on failure.
3228 */
3229int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3230{
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003231 const unsigned char *d;
3232 const struct scsi_vpd *vpd_pg83;
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003233 int group_id = -EAGAIN, rel_port = -1;
3234
3235 rcu_read_lock();
3236 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3237 if (!vpd_pg83) {
3238 rcu_read_unlock();
3239 return -ENXIO;
3240 }
3241
Bart Van Asscheccf1e002017-08-29 08:50:13 -07003242 d = vpd_pg83->data + 4;
3243 while (d < vpd_pg83->data + vpd_pg83->len) {
Hannes Reineckea8aa3972015-12-01 10:16:57 +01003244 switch (d[1] & 0xf) {
3245 case 0x4:
3246 /* Relative target port */
3247 rel_port = get_unaligned_be16(&d[6]);
3248 break;
3249 case 0x5:
3250 /* Target port group */
3251 group_id = get_unaligned_be16(&d[6]);
3252 break;
3253 default:
3254 break;
3255 }
3256 d += d[3] + 4;
3257 }
3258 rcu_read_unlock();
3259
3260 if (group_id >= 0 && rel_id && rel_port != -1)
3261 *rel_id = rel_port;
3262
3263 return group_id;
3264}
3265EXPORT_SYMBOL(scsi_vpd_tpg_id);
Hannes Reineckef2b1e9c2021-04-27 10:30:13 +02003266
3267/**
3268 * scsi_build_sense - build sense data for a command
3269 * @scmd: scsi command for which the sense should be formatted
3270 * @desc: Sense format (non-zero == descriptor format,
3271 * 0 == fixed format)
3272 * @key: Sense key
3273 * @asc: Additional sense code
3274 * @ascq: Additional sense code qualifier
3275 *
3276 **/
3277void scsi_build_sense(struct scsi_cmnd *scmd, int desc, u8 key, u8 asc, u8 ascq)
3278{
3279 scsi_build_sense_buffer(desc, scmd->sense_buffer, key, asc, ascq);
Hannes Reinecke464a00c2021-04-27 10:30:15 +02003280 scmd->result = SAM_STAT_CHECK_CONDITION;
Hannes Reineckef2b1e9c2021-04-27 10:30:13 +02003281}
3282EXPORT_SYMBOL_GPL(scsi_build_sense);