scsi: clean up error handling in scsi_init_io
[linux-2.6-block.git] / drivers / scsi / scsi_lib.c
CommitLineData
1da177e4 1/*
d285203c
CH
2 * Copyright (C) 1999 Eric Youngdale
3 * Copyright (C) 2014 Christoph Hellwig
1da177e4
LT
4 *
5 * SCSI queueing library.
6 * Initial versions: Eric Youngdale (eric@andante.org).
7 * Based upon conversations with large numbers
8 * of people at Linux Expo.
9 */
10
11#include <linux/bio.h>
d3f46f39 12#include <linux/bitops.h>
1da177e4
LT
13#include <linux/blkdev.h>
14#include <linux/completion.h>
15#include <linux/kernel.h>
09703660 16#include <linux/export.h>
1da177e4
LT
17#include <linux/init.h>
18#include <linux/pci.h>
19#include <linux/delay.h>
faead26d 20#include <linux/hardirq.h>
c6132da1 21#include <linux/scatterlist.h>
d285203c 22#include <linux/blk-mq.h>
f1569ff1 23#include <linux/ratelimit.h>
a8aa3978 24#include <asm/unaligned.h>
1da177e4
LT
25
26#include <scsi/scsi.h>
beb40487 27#include <scsi/scsi_cmnd.h>
1da177e4
LT
28#include <scsi/scsi_dbg.h>
29#include <scsi/scsi_device.h>
30#include <scsi/scsi_driver.h>
31#include <scsi/scsi_eh.h>
32#include <scsi/scsi_host.h>
7aa686d3 33#include <scsi/scsi_transport.h> /* __scsi_init_queue() */
ee14c674 34#include <scsi/scsi_dh.h>
1da177e4 35
3b5382c4
CH
36#include <trace/events/scsi.h>
37
0eebd005 38#include "scsi_debugfs.h"
1da177e4
LT
39#include "scsi_priv.h"
40#include "scsi_logging.h"
41
e9c787e6 42static struct kmem_cache *scsi_sdb_cache;
0a6ac4ee
CH
43static struct kmem_cache *scsi_sense_cache;
44static struct kmem_cache *scsi_sense_isadma_cache;
45static DEFINE_MUTEX(scsi_sense_cache_mutex);
1da177e4 46
a45a1f36
BVA
47static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd);
48
0a6ac4ee 49static inline struct kmem_cache *
8e688254 50scsi_select_sense_cache(bool unchecked_isa_dma)
0a6ac4ee 51{
8e688254 52 return unchecked_isa_dma ? scsi_sense_isadma_cache : scsi_sense_cache;
0a6ac4ee
CH
53}
54
8e688254
BVA
55static void scsi_free_sense_buffer(bool unchecked_isa_dma,
56 unsigned char *sense_buffer)
0a6ac4ee 57{
8e688254
BVA
58 kmem_cache_free(scsi_select_sense_cache(unchecked_isa_dma),
59 sense_buffer);
0a6ac4ee
CH
60}
61
8e688254 62static unsigned char *scsi_alloc_sense_buffer(bool unchecked_isa_dma,
e9c787e6 63 gfp_t gfp_mask, int numa_node)
0a6ac4ee 64{
8e688254
BVA
65 return kmem_cache_alloc_node(scsi_select_sense_cache(unchecked_isa_dma),
66 gfp_mask, numa_node);
0a6ac4ee
CH
67}
68
69int scsi_init_sense_cache(struct Scsi_Host *shost)
70{
71 struct kmem_cache *cache;
72 int ret = 0;
73
8e688254 74 cache = scsi_select_sense_cache(shost->unchecked_isa_dma);
0a6ac4ee
CH
75 if (cache)
76 return 0;
77
78 mutex_lock(&scsi_sense_cache_mutex);
79 if (shost->unchecked_isa_dma) {
80 scsi_sense_isadma_cache =
81 kmem_cache_create("scsi_sense_cache(DMA)",
0afe76e8
DW
82 SCSI_SENSE_BUFFERSIZE, 0,
83 SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
0a6ac4ee
CH
84 if (!scsi_sense_isadma_cache)
85 ret = -ENOMEM;
86 } else {
87 scsi_sense_cache =
0afe76e8
DW
88 kmem_cache_create_usercopy("scsi_sense_cache",
89 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN,
90 0, SCSI_SENSE_BUFFERSIZE, NULL);
0a6ac4ee
CH
91 if (!scsi_sense_cache)
92 ret = -ENOMEM;
93 }
94
95 mutex_unlock(&scsi_sense_cache_mutex);
96 return ret;
97}
6f9a35e2 98
a488e749
JA
99/*
100 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
101 * not change behaviour from the previous unplug mechanism, experimentation
102 * may prove this needs changing.
103 */
104#define SCSI_QUEUE_DELAY 3
105
de3e8bf3
CH
106static void
107scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
1da177e4
LT
108{
109 struct Scsi_Host *host = cmd->device->host;
110 struct scsi_device *device = cmd->device;
f0c0a376 111 struct scsi_target *starget = scsi_target(device);
1da177e4
LT
112
113 /*
d8c37e7b 114 * Set the appropriate busy bit for the device/host.
1da177e4
LT
115 *
116 * If the host/device isn't busy, assume that something actually
117 * completed, and that we should be able to queue a command now.
118 *
119 * Note that the prior mid-layer assumption that any host could
120 * always queue at least one command is now broken. The mid-layer
121 * will implement a user specifiable stall (see
122 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
123 * if a command is requeued with no other commands outstanding
124 * either for the device or for the host.
125 */
f0c0a376
MC
126 switch (reason) {
127 case SCSI_MLQUEUE_HOST_BUSY:
cd9070c9 128 atomic_set(&host->host_blocked, host->max_host_blocked);
f0c0a376
MC
129 break;
130 case SCSI_MLQUEUE_DEVICE_BUSY:
573e5913 131 case SCSI_MLQUEUE_EH_RETRY:
cd9070c9
CH
132 atomic_set(&device->device_blocked,
133 device->max_device_blocked);
f0c0a376
MC
134 break;
135 case SCSI_MLQUEUE_TARGET_BUSY:
cd9070c9
CH
136 atomic_set(&starget->target_blocked,
137 starget->max_target_blocked);
f0c0a376
MC
138 break;
139 }
de3e8bf3
CH
140}
141
d285203c
CH
142static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
143{
144 struct scsi_device *sdev = cmd->device;
d285203c 145
a45a1f36
BVA
146 if (cmd->request->rq_flags & RQF_DONTPREP) {
147 cmd->request->rq_flags &= ~RQF_DONTPREP;
148 scsi_mq_uninit_cmd(cmd);
149 } else {
150 WARN_ON_ONCE(true);
151 }
2b053aca 152 blk_mq_requeue_request(cmd->request, true);
d285203c
CH
153 put_device(&sdev->sdev_gendev);
154}
155
de3e8bf3
CH
156/**
157 * __scsi_queue_insert - private queue insertion
158 * @cmd: The SCSI command being requeued
159 * @reason: The reason for the requeue
160 * @unbusy: Whether the queue should be unbusied
161 *
162 * This is a private queue insertion. The public interface
163 * scsi_queue_insert() always assumes the queue should be unbusied
164 * because it's always called before the completion. This function is
165 * for a requeue after completion, which should only occur in this
166 * file.
167 */
08640e81 168static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, bool unbusy)
de3e8bf3
CH
169{
170 struct scsi_device *device = cmd->device;
de3e8bf3
CH
171
172 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
173 "Inserting command %p into mlqueue\n", cmd));
174
175 scsi_set_blocked(cmd, reason);
1da177e4 176
1da177e4
LT
177 /*
178 * Decrement the counters, since these commands are no longer
179 * active on the host/device.
180 */
4f5299ac
JB
181 if (unbusy)
182 scsi_device_unbusy(device);
1da177e4
LT
183
184 /*
a1bf9d1d 185 * Requeue this command. It will go before all other commands
b485462a
BVA
186 * that are already in the queue. Schedule requeue work under
187 * lock such that the kblockd_schedule_work() call happens
188 * before blk_cleanup_queue() finishes.
a488e749 189 */
644373a4 190 cmd->result = 0;
f664a3cc
JA
191
192 /*
193 * Before a SCSI command is dispatched,
194 * get_device(&sdev->sdev_gendev) is called and the host,
195 * target and device busy counters are increased. Since
196 * requeuing a request causes these actions to be repeated and
197 * since scsi_device_unbusy() has already been called,
198 * put_device(&device->sdev_gendev) must still be called. Call
199 * put_device() after blk_mq_requeue_request() to avoid that
200 * removal of the SCSI device can start before requeueing has
201 * happened.
202 */
203 blk_mq_requeue_request(cmd->request, true);
204 put_device(&device->sdev_gendev);
1da177e4
LT
205}
206
4f5299ac
JB
207/*
208 * Function: scsi_queue_insert()
209 *
210 * Purpose: Insert a command in the midlevel queue.
211 *
212 * Arguments: cmd - command that we are adding to queue.
213 * reason - why we are inserting command to queue.
214 *
215 * Lock status: Assumed that lock is not held upon entry.
216 *
217 * Returns: Nothing.
218 *
219 * Notes: We do this for one of two cases. Either the host is busy
220 * and it cannot accept any more commands for the time being,
221 * or the device returned QUEUE_FULL and can accept no more
222 * commands.
223 * Notes: This could be called either from an interrupt context or a
224 * normal process context.
225 */
84feb166 226void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
4f5299ac 227{
08640e81 228 __scsi_queue_insert(cmd, reason, true);
4f5299ac 229}
e8064021 230
76aaf87b
CH
231
232/**
704f8392 233 * __scsi_execute - insert request and wait for the result
76aaf87b
CH
234 * @sdev: scsi device
235 * @cmd: scsi command
236 * @data_direction: data direction
237 * @buffer: data buffer
238 * @bufflen: len of buffer
239 * @sense: optional sense buffer
240 * @sshdr: optional decoded sense header
241 * @timeout: request timeout in seconds
242 * @retries: number of times to retry request
243 * @flags: flags for ->cmd_flags
244 * @rq_flags: flags for ->rq_flags
245 * @resid: optional residual length
246 *
17d5363b
CH
247 * Returns the scsi_cmnd result field if a command was executed, or a negative
248 * Linux error code if we didn't get that far.
76aaf87b 249 */
704f8392 250int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
33aa687d 251 int data_direction, void *buffer, unsigned bufflen,
3949e2f0
CH
252 unsigned char *sense, struct scsi_sense_hdr *sshdr,
253 int timeout, int retries, u64 flags, req_flags_t rq_flags,
254 int *resid)
39216033
JB
255{
256 struct request *req;
82ed4db4 257 struct scsi_request *rq;
39216033
JB
258 int ret = DRIVER_ERROR << 24;
259
ff005a06 260 req = blk_get_request(sdev->request_queue,
aebf526b 261 data_direction == DMA_TO_DEVICE ?
039c635f 262 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, BLK_MQ_REQ_PREEMPT);
a492f075 263 if (IS_ERR(req))
bfe159a5 264 return ret;
82ed4db4 265 rq = scsi_req(req);
39216033
JB
266
267 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
0eb0b63c 268 buffer, bufflen, GFP_NOIO))
39216033
JB
269 goto out;
270
82ed4db4
CH
271 rq->cmd_len = COMMAND_SIZE(cmd[0]);
272 memcpy(rq->cmd, cmd, rq->cmd_len);
64c7f1d1 273 rq->retries = retries;
39216033 274 req->timeout = timeout;
e8064021 275 req->cmd_flags |= flags;
039c635f 276 req->rq_flags |= rq_flags | RQF_QUIET;
39216033
JB
277
278 /*
279 * head injection *required* here otherwise quiesce won't work
280 */
281 blk_execute_rq(req->q, NULL, req, 1);
282
bdb2b8ca
AS
283 /*
284 * Some devices (USB mass-storage in particular) may transfer
285 * garbage data together with a residue indicating that the data
286 * is invalid. Prevent the garbage from being misinterpreted
287 * and prevent security leaks by zeroing out the excess data.
288 */
82ed4db4
CH
289 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
290 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
bdb2b8ca 291
f4f4e47e 292 if (resid)
82ed4db4
CH
293 *resid = rq->resid_len;
294 if (sense && rq->sense_len)
295 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
3949e2f0
CH
296 if (sshdr)
297 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
17d5363b 298 ret = rq->result;
39216033
JB
299 out:
300 blk_put_request(req);
301
302 return ret;
303}
704f8392 304EXPORT_SYMBOL(__scsi_execute);
39216033 305
1da177e4
LT
306/*
307 * Function: scsi_init_cmd_errh()
308 *
309 * Purpose: Initialize cmd fields related to error handling.
310 *
311 * Arguments: cmd - command that is ready to be queued.
312 *
1da177e4
LT
313 * Notes: This function has the job of initializing a number of
314 * fields related to error handling. Typically this will
315 * be called once for each command, as required.
316 */
631c228c 317static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
1da177e4 318{
1da177e4 319 cmd->serial_number = 0;
30b0c37b 320 scsi_set_resid(cmd, 0);
b80ca4f7 321 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1da177e4 322 if (cmd->cmd_len == 0)
db4742dd 323 cmd->cmd_len = scsi_command_size(cmd->cmnd);
1da177e4
LT
324}
325
3bd6f43f
BVA
326/*
327 * Decrement the host_busy counter and wake up the error handler if necessary.
328 * Avoid as follows that the error handler is not woken up if shost->host_busy
329 * == shost->host_failed: use call_rcu() in scsi_eh_scmd_add() in combination
330 * with an RCU read lock in this function to ensure that this function in its
331 * entirety either finishes before scsi_eh_scmd_add() increases the
332 * host_failed counter or that it notices the shost state change made by
333 * scsi_eh_scmd_add().
334 */
335static void scsi_dec_host_busy(struct Scsi_Host *shost)
1da177e4 336{
1da177e4
LT
337 unsigned long flags;
338
3bd6f43f 339 rcu_read_lock();
d772a65d 340 atomic_dec(&shost->host_busy);
3bd6f43f 341 if (unlikely(scsi_host_in_recovery(shost))) {
74665016 342 spin_lock_irqsave(shost->host_lock, flags);
3bd6f43f
BVA
343 if (shost->host_failed || shost->host_eh_scheduled)
344 scsi_eh_wakeup(shost);
74665016
CH
345 spin_unlock_irqrestore(shost->host_lock, flags);
346 }
3bd6f43f
BVA
347 rcu_read_unlock();
348}
349
350void scsi_device_unbusy(struct scsi_device *sdev)
351{
352 struct Scsi_Host *shost = sdev->host;
353 struct scsi_target *starget = scsi_target(sdev);
354
355 scsi_dec_host_busy(shost);
356
357 if (starget->can_queue > 0)
358 atomic_dec(&starget->target_busy);
74665016 359
71e75c97 360 atomic_dec(&sdev->device_busy);
1da177e4
LT
361}
362
d285203c
CH
363static void scsi_kick_queue(struct request_queue *q)
364{
f664a3cc 365 blk_mq_run_hw_queues(q, false);
d285203c
CH
366}
367
1da177e4
LT
368/*
369 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
370 * and call blk_run_queue for all the scsi_devices on the target -
371 * including current_sdev first.
372 *
373 * Called with *no* scsi locks held.
374 */
375static void scsi_single_lun_run(struct scsi_device *current_sdev)
376{
377 struct Scsi_Host *shost = current_sdev->host;
378 struct scsi_device *sdev, *tmp;
379 struct scsi_target *starget = scsi_target(current_sdev);
380 unsigned long flags;
381
382 spin_lock_irqsave(shost->host_lock, flags);
383 starget->starget_sdev_user = NULL;
384 spin_unlock_irqrestore(shost->host_lock, flags);
385
386 /*
387 * Call blk_run_queue for all LUNs on the target, starting with
388 * current_sdev. We race with others (to set starget_sdev_user),
389 * but in most cases, we will be first. Ideally, each LU on the
390 * target would get some limited time or requests on the target.
391 */
d285203c 392 scsi_kick_queue(current_sdev->request_queue);
1da177e4
LT
393
394 spin_lock_irqsave(shost->host_lock, flags);
395 if (starget->starget_sdev_user)
396 goto out;
397 list_for_each_entry_safe(sdev, tmp, &starget->devices,
398 same_target_siblings) {
399 if (sdev == current_sdev)
400 continue;
401 if (scsi_device_get(sdev))
402 continue;
403
404 spin_unlock_irqrestore(shost->host_lock, flags);
d285203c 405 scsi_kick_queue(sdev->request_queue);
1da177e4
LT
406 spin_lock_irqsave(shost->host_lock, flags);
407
408 scsi_device_put(sdev);
409 }
410 out:
411 spin_unlock_irqrestore(shost->host_lock, flags);
412}
413
cd9070c9 414static inline bool scsi_device_is_busy(struct scsi_device *sdev)
9d112517 415{
cd9070c9
CH
416 if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
417 return true;
418 if (atomic_read(&sdev->device_blocked) > 0)
419 return true;
420 return false;
9d112517
KU
421}
422
cd9070c9 423static inline bool scsi_target_is_busy(struct scsi_target *starget)
f0c0a376 424{
2ccbb008
CH
425 if (starget->can_queue > 0) {
426 if (atomic_read(&starget->target_busy) >= starget->can_queue)
427 return true;
428 if (atomic_read(&starget->target_blocked) > 0)
429 return true;
430 }
cd9070c9 431 return false;
f0c0a376
MC
432}
433
cd9070c9 434static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
9d112517 435{
d772a65d 436 if (shost->can_queue > 0 &&
cd9070c9
CH
437 atomic_read(&shost->host_busy) >= shost->can_queue)
438 return true;
439 if (atomic_read(&shost->host_blocked) > 0)
440 return true;
441 if (shost->host_self_blocked)
442 return true;
443 return false;
9d112517
KU
444}
445
21a05df5 446static void scsi_starved_list_run(struct Scsi_Host *shost)
1da177e4 447{
2a3a59e5 448 LIST_HEAD(starved_list);
21a05df5 449 struct scsi_device *sdev;
1da177e4
LT
450 unsigned long flags;
451
1da177e4 452 spin_lock_irqsave(shost->host_lock, flags);
2a3a59e5
MC
453 list_splice_init(&shost->starved_list, &starved_list);
454
455 while (!list_empty(&starved_list)) {
e2eb7244
JB
456 struct request_queue *slq;
457
1da177e4
LT
458 /*
459 * As long as shost is accepting commands and we have
460 * starved queues, call blk_run_queue. scsi_request_fn
461 * drops the queue_lock and can add us back to the
462 * starved_list.
463 *
464 * host_lock protects the starved_list and starved_entry.
465 * scsi_request_fn must get the host_lock before checking
466 * or modifying starved_list or starved_entry.
467 */
2a3a59e5 468 if (scsi_host_is_busy(shost))
f0c0a376 469 break;
f0c0a376 470
2a3a59e5
MC
471 sdev = list_entry(starved_list.next,
472 struct scsi_device, starved_entry);
473 list_del_init(&sdev->starved_entry);
f0c0a376
MC
474 if (scsi_target_is_busy(scsi_target(sdev))) {
475 list_move_tail(&sdev->starved_entry,
476 &shost->starved_list);
477 continue;
478 }
479
e2eb7244
JB
480 /*
481 * Once we drop the host lock, a racing scsi_remove_device()
482 * call may remove the sdev from the starved list and destroy
483 * it and the queue. Mitigate by taking a reference to the
484 * queue and never touching the sdev again after we drop the
485 * host lock. Note: if __scsi_remove_device() invokes
486 * blk_cleanup_queue() before the queue is run from this
487 * function then blk_run_queue() will return immediately since
488 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
489 */
490 slq = sdev->request_queue;
491 if (!blk_get_queue(slq))
492 continue;
493 spin_unlock_irqrestore(shost->host_lock, flags);
494
d285203c 495 scsi_kick_queue(slq);
e2eb7244
JB
496 blk_put_queue(slq);
497
498 spin_lock_irqsave(shost->host_lock, flags);
1da177e4 499 }
2a3a59e5
MC
500 /* put any unprocessed entries back */
501 list_splice(&starved_list, &shost->starved_list);
1da177e4 502 spin_unlock_irqrestore(shost->host_lock, flags);
21a05df5
CH
503}
504
505/*
506 * Function: scsi_run_queue()
507 *
508 * Purpose: Select a proper request queue to serve next
509 *
510 * Arguments: q - last request's queue
511 *
512 * Returns: Nothing
513 *
514 * Notes: The previous command was completely finished, start
515 * a new one if possible.
516 */
517static void scsi_run_queue(struct request_queue *q)
518{
519 struct scsi_device *sdev = q->queuedata;
520
521 if (scsi_target(sdev)->single_lun)
522 scsi_single_lun_run(sdev);
523 if (!list_empty(&sdev->host->starved_list))
524 scsi_starved_list_run(sdev->host);
1da177e4 525
f664a3cc 526 blk_mq_run_hw_queues(q, false);
1da177e4
LT
527}
528
9937a5e2
JA
529void scsi_requeue_run_queue(struct work_struct *work)
530{
531 struct scsi_device *sdev;
532 struct request_queue *q;
533
534 sdev = container_of(work, struct scsi_device, requeue_work);
535 q = sdev->request_queue;
536 scsi_run_queue(q);
537}
538
1da177e4
LT
539void scsi_run_host_queues(struct Scsi_Host *shost)
540{
541 struct scsi_device *sdev;
542
543 shost_for_each_device(sdev, shost)
544 scsi_run_queue(sdev->request_queue);
545}
546
d285203c
CH
547static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
548{
57292b58 549 if (!blk_rq_is_passthrough(cmd->request)) {
d285203c
CH
550 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
551
552 if (drv->uninit_command)
553 drv->uninit_command(cmd);
554 }
555}
556
557static void scsi_mq_free_sgtables(struct scsi_cmnd *cmd)
558{
91dbc08d
ML
559 struct scsi_data_buffer *sdb;
560
d285203c 561 if (cmd->sdb.table.nents)
001d63be 562 sg_free_table_chained(&cmd->sdb.table, true);
91dbc08d
ML
563 if (cmd->request->next_rq) {
564 sdb = cmd->request->next_rq->special;
565 if (sdb)
001d63be 566 sg_free_table_chained(&sdb->table, true);
91dbc08d 567 }
d285203c 568 if (scsi_prot_sg_count(cmd))
001d63be 569 sg_free_table_chained(&cmd->prot_sdb->table, true);
d285203c
CH
570}
571
572static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
573{
d285203c
CH
574 scsi_mq_free_sgtables(cmd);
575 scsi_uninit_cmd(cmd);
2dd6fb59 576 scsi_del_cmd_from_list(cmd);
d285203c
CH
577}
578
7e63b5a4 579/* Returns false when no more bytes to process, true if there are more */
2a842aca 580static bool scsi_end_request(struct request *req, blk_status_t error,
f6d47e74
CH
581 unsigned int bytes, unsigned int bidi_bytes)
582{
bed2213d 583 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
f6d47e74
CH
584 struct scsi_device *sdev = cmd->device;
585 struct request_queue *q = sdev->request_queue;
f6d47e74
CH
586
587 if (blk_update_request(req, error, bytes))
588 return true;
589
590 /* Bidi request must be completed as a whole */
591 if (unlikely(bidi_bytes) &&
592 blk_update_request(req->next_rq, error, bidi_bytes))
593 return true;
594
595 if (blk_queue_add_random(q))
596 add_disk_randomness(req->rq_disk);
597
64104f70
BVA
598 if (!blk_rq_is_scsi(req)) {
599 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
600 cmd->flags &= ~SCMD_INITIALIZED;
3be8828f 601 destroy_rcu_head(&cmd->rcu);
64104f70
BVA
602 }
603
f664a3cc
JA
604 /*
605 * In the MQ case the command gets freed by __blk_mq_end_request,
606 * so we have to do all cleanup that depends on it earlier.
607 *
608 * We also can't kick the queues from irq context, so we
609 * will have to defer it to a workqueue.
610 */
611 scsi_mq_uninit_cmd(cmd);
f81426a8 612
f664a3cc 613 __blk_mq_end_request(req, error);
d285203c 614
f664a3cc
JA
615 if (scsi_target(sdev)->single_lun ||
616 !list_empty(&sdev->host->starved_list))
617 kblockd_schedule_work(&sdev->requeue_work);
618 else
619 blk_mq_run_hw_queues(q, true);
f6d47e74 620
bb3ec62a 621 put_device(&sdev->sdev_gendev);
f6d47e74
CH
622 return false;
623}
624
0f7f6234 625/**
a77b32d8
BVA
626 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
627 * @cmd: SCSI command
0f7f6234
HR
628 * @result: scsi error code
629 *
a77b32d8
BVA
630 * Translate a SCSI result code into a blk_status_t value. May reset the host
631 * byte of @cmd->result.
0f7f6234 632 */
a77b32d8 633static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
63583cca 634{
2a842aca 635 switch (host_byte(result)) {
f4abab3f
BVA
636 case DID_OK:
637 /*
638 * Also check the other bytes than the status byte in result
639 * to handle the case when a SCSI LLD sets result to
640 * DRIVER_SENSE << 24 without setting SAM_STAT_CHECK_CONDITION.
641 */
642 if (scsi_status_is_good(result) && (result & ~0xff) == 0)
643 return BLK_STS_OK;
644 return BLK_STS_IOERR;
63583cca 645 case DID_TRANSPORT_FAILFAST:
2a842aca 646 return BLK_STS_TRANSPORT;
63583cca 647 case DID_TARGET_FAILURE:
2082ebc4 648 set_host_byte(cmd, DID_OK);
2a842aca 649 return BLK_STS_TARGET;
63583cca 650 case DID_NEXUS_FAILURE:
2a842aca 651 return BLK_STS_NEXUS;
a9d6ceb8
HR
652 case DID_ALLOC_FAILURE:
653 set_host_byte(cmd, DID_OK);
2a842aca 654 return BLK_STS_NOSPC;
7e782af5
HR
655 case DID_MEDIUM_ERROR:
656 set_host_byte(cmd, DID_OK);
2a842aca 657 return BLK_STS_MEDIUM;
63583cca 658 default:
2a842aca 659 return BLK_STS_IOERR;
63583cca 660 }
63583cca
HR
661}
662
4ae61c68
DG
663/* Helper for scsi_io_completion() when "reprep" action required. */
664static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
665 struct request_queue *q)
666{
667 /* A new command will be prepared and issued. */
f664a3cc 668 scsi_mq_requeue_cmd(cmd);
4ae61c68
DG
669}
670
da32baea
DG
671/* Helper for scsi_io_completion() when special action required. */
672static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
1da177e4 673{
165125e1 674 struct request_queue *q = cmd->device->request_queue;
1da177e4 675 struct request *req = cmd->request;
da32baea 676 int level = 0;
b60af5b0
AS
677 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
678 ACTION_DELAYED_RETRY} action;
ee60b2c5 679 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
da32baea
DG
680 struct scsi_sense_hdr sshdr;
681 bool sense_valid;
682 bool sense_current = true; /* false implies "deferred sense" */
683 blk_status_t blk_stat;
1da177e4 684
da32baea
DG
685 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
686 if (sense_valid)
687 sense_current = !scsi_sense_is_deferred(&sshdr);
03aba2f7 688
da32baea 689 blk_stat = scsi_result_to_blk_status(cmd, result);
3e695f89 690
b60af5b0
AS
691 if (host_byte(result) == DID_RESET) {
692 /* Third party bus reset or reset for error recovery
693 * reasons. Just retry the command and see what
694 * happens.
695 */
696 action = ACTION_RETRY;
da32baea 697 } else if (sense_valid && sense_current) {
1da177e4
LT
698 switch (sshdr.sense_key) {
699 case UNIT_ATTENTION:
700 if (cmd->device->removable) {
03aba2f7 701 /* Detected disc change. Set a bit
1da177e4
LT
702 * and quietly refuse further access.
703 */
704 cmd->device->changed = 1;
b60af5b0 705 action = ACTION_FAIL;
1da177e4 706 } else {
03aba2f7
LT
707 /* Must have been a power glitch, or a
708 * bus reset. Could not have been a
709 * media change, so we just retry the
b60af5b0 710 * command and see what happens.
03aba2f7 711 */
b60af5b0 712 action = ACTION_RETRY;
1da177e4
LT
713 }
714 break;
715 case ILLEGAL_REQUEST:
03aba2f7
LT
716 /* If we had an ILLEGAL REQUEST returned, then
717 * we may have performed an unsupported
718 * command. The only thing this should be
719 * would be a ten byte read where only a six
720 * byte read was supported. Also, on a system
721 * where READ CAPACITY failed, we may have
722 * read past the end of the disk.
723 */
26a68019
JA
724 if ((cmd->device->use_10_for_rw &&
725 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
1da177e4
LT
726 (cmd->cmnd[0] == READ_10 ||
727 cmd->cmnd[0] == WRITE_10)) {
b60af5b0 728 /* This will issue a new 6-byte command. */
1da177e4 729 cmd->device->use_10_for_rw = 0;
b60af5b0 730 action = ACTION_REPREP;
3e695f89 731 } else if (sshdr.asc == 0x10) /* DIX */ {
3e695f89 732 action = ACTION_FAIL;
da32baea 733 blk_stat = BLK_STS_PROTECTION;
c98a0eb0 734 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
5db44863 735 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
c98a0eb0 736 action = ACTION_FAIL;
da32baea 737 blk_stat = BLK_STS_TARGET;
b60af5b0
AS
738 } else
739 action = ACTION_FAIL;
740 break;
511e44f4 741 case ABORTED_COMMAND:
126c0982 742 action = ACTION_FAIL;
e6c11dbb 743 if (sshdr.asc == 0x10) /* DIF */
da32baea 744 blk_stat = BLK_STS_PROTECTION;
1da177e4
LT
745 break;
746 case NOT_READY:
03aba2f7 747 /* If the device is in the process of becoming
f3e93f73 748 * ready, or has a temporary blockage, retry.
1da177e4 749 */
f3e93f73
JB
750 if (sshdr.asc == 0x04) {
751 switch (sshdr.ascq) {
752 case 0x01: /* becoming ready */
753 case 0x04: /* format in progress */
754 case 0x05: /* rebuild in progress */
755 case 0x06: /* recalculation in progress */
756 case 0x07: /* operation in progress */
757 case 0x08: /* Long write in progress */
758 case 0x09: /* self test in progress */
d8705f11 759 case 0x14: /* space allocation in progress */
e37c7d9a
DG
760 case 0x1a: /* start stop unit in progress */
761 case 0x1b: /* sanitize in progress */
762 case 0x1d: /* configuration in progress */
763 case 0x24: /* depopulation in progress */
b60af5b0 764 action = ACTION_DELAYED_RETRY;
f3e93f73 765 break;
3dbf6a54 766 default:
3dbf6a54
AS
767 action = ACTION_FAIL;
768 break;
f3e93f73 769 }
e6c11dbb 770 } else
b60af5b0 771 action = ACTION_FAIL;
b60af5b0 772 break;
1da177e4 773 case VOLUME_OVERFLOW:
03aba2f7 774 /* See SSC3rXX or current. */
b60af5b0
AS
775 action = ACTION_FAIL;
776 break;
1da177e4 777 default:
b60af5b0 778 action = ACTION_FAIL;
1da177e4
LT
779 break;
780 }
e6c11dbb 781 } else
b60af5b0 782 action = ACTION_FAIL;
b60af5b0 783
ee60b2c5 784 if (action != ACTION_FAIL &&
e6c11dbb 785 time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
ee60b2c5 786 action = ACTION_FAIL;
ee60b2c5 787
b60af5b0
AS
788 switch (action) {
789 case ACTION_FAIL:
790 /* Give up and fail the remainder of the request */
e8064021 791 if (!(req->rq_flags & RQF_QUIET)) {
f1569ff1
HR
792 static DEFINE_RATELIMIT_STATE(_rs,
793 DEFAULT_RATELIMIT_INTERVAL,
794 DEFAULT_RATELIMIT_BURST);
795
796 if (unlikely(scsi_logging_level))
da32baea
DG
797 level =
798 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
799 SCSI_LOG_MLCOMPLETE_BITS);
f1569ff1
HR
800
801 /*
802 * if logging is enabled the failure will be printed
803 * in scsi_log_completion(), so avoid duplicate messages
804 */
805 if (!level && __ratelimit(&_rs)) {
806 scsi_print_result(cmd, NULL, FAILED);
c65be1a6 807 if (driver_byte(result) == DRIVER_SENSE)
f1569ff1
HR
808 scsi_print_sense(cmd);
809 scsi_print_command(cmd);
810 }
3173d8c3 811 }
da32baea 812 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req), 0))
f6d47e74 813 return;
bc85dc50 814 /*FALLTHRU*/
b60af5b0 815 case ACTION_REPREP:
4ae61c68 816 scsi_io_completion_reprep(cmd, q);
b60af5b0
AS
817 break;
818 case ACTION_RETRY:
819 /* Retry the same command immediately */
08640e81 820 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
b60af5b0
AS
821 break;
822 case ACTION_DELAYED_RETRY:
823 /* Retry the same command after a delay */
08640e81 824 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
b60af5b0 825 break;
1da177e4
LT
826 }
827}
1da177e4 828
ab831084
DG
829/*
830 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
831 * new result that may suppress further error checking. Also modifies
832 * *blk_statp in some cases.
833 */
834static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
835 blk_status_t *blk_statp)
836{
837 bool sense_valid;
838 bool sense_current = true; /* false implies "deferred sense" */
839 struct request *req = cmd->request;
840 struct scsi_sense_hdr sshdr;
841
842 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
843 if (sense_valid)
844 sense_current = !scsi_sense_is_deferred(&sshdr);
845
846 if (blk_rq_is_passthrough(req)) {
847 if (sense_valid) {
848 /*
849 * SG_IO wants current and deferred errors
850 */
851 scsi_req(req)->sense_len =
852 min(8 + cmd->sense_buffer[7],
853 SCSI_SENSE_BUFFERSIZE);
854 }
855 if (sense_current)
856 *blk_statp = scsi_result_to_blk_status(cmd, result);
857 } else if (blk_rq_bytes(req) == 0 && sense_current) {
858 /*
859 * Flush commands do not transfers any data, and thus cannot use
860 * good_bytes != blk_rq_bytes(req) as the signal for an error.
861 * This sets *blk_statp explicitly for the problem case.
862 */
863 *blk_statp = scsi_result_to_blk_status(cmd, result);
864 }
865 /*
866 * Recovered errors need reporting, but they're always treated as
867 * success, so fiddle the result code here. For passthrough requests
868 * we already took a copy of the original into sreq->result which
869 * is what gets returned to the user
870 */
871 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
872 bool do_print = true;
873 /*
874 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
875 * skip print since caller wants ATA registers. Only occurs
876 * on SCSI ATA PASS_THROUGH commands when CK_COND=1
877 */
878 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
879 do_print = false;
880 else if (req->rq_flags & RQF_QUIET)
881 do_print = false;
882 if (do_print)
883 scsi_print_sense(cmd);
884 result = 0;
885 /* for passthrough, *blk_statp may be set */
886 *blk_statp = BLK_STS_OK;
887 }
888 /*
889 * Another corner case: the SCSI status byte is non-zero but 'good'.
890 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
891 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
892 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
893 * intermediate statuses (both obsolete in SAM-4) as good.
894 */
895 if (status_byte(result) && scsi_status_is_good(result)) {
896 result = 0;
897 *blk_statp = BLK_STS_OK;
898 }
899 return result;
900}
901
1da177e4
LT
902/*
903 * Function: scsi_io_completion()
904 *
905 * Purpose: Completion processing for block device I/O requests.
906 *
907 * Arguments: cmd - command that is finished.
908 *
909 * Lock status: Assumed that no lock is held upon entry.
910 *
911 * Returns: Nothing
912 *
bc85dc50
CH
913 * Notes: We will finish off the specified number of sectors. If we
914 * are done, the command block will be released and the queue
915 * function will be goosed. If we are not done then we have to
b60af5b0 916 * figure out what to do next:
1da177e4 917 *
b60af5b0
AS
918 * a) We can call scsi_requeue_command(). The request
919 * will be unprepared and put back on the queue. Then
920 * a new command will be created for it. This should
921 * be used if we made forward progress, or if we want
922 * to switch from READ(10) to READ(6) for example.
1da177e4 923 *
bc85dc50 924 * b) We can call __scsi_queue_insert(). The request will
b60af5b0
AS
925 * be put back on the queue and retried using the same
926 * command as before, possibly after a delay.
927 *
1f7cbb8e
DG
928 * c) We can call scsi_end_request() with blk_stat other than
929 * BLK_STS_OK, to fail the remainder of the request.
1da177e4 930 */
03aba2f7 931void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
1da177e4
LT
932{
933 int result = cmd->result;
165125e1 934 struct request_queue *q = cmd->device->request_queue;
1da177e4 935 struct request *req = cmd->request;
1f7cbb8e 936 blk_status_t blk_stat = BLK_STS_OK;
1da177e4 937
0d437906 938 if (unlikely(result)) /* a nz result may or may not be an error */
ab831084 939 result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
631c228c 940
0d437906 941 if (unlikely(blk_rq_is_passthrough(req))) {
27c41973 942 /*
a77b32d8 943 * scsi_result_to_blk_status may have reset the host_byte
27c41973 944 */
17d5363b 945 scsi_req(req)->result = cmd->result;
82ed4db4 946 scsi_req(req)->resid_len = scsi_get_resid(cmd);
e6bb7a96 947
0d437906 948 if (unlikely(scsi_bidi_cmnd(cmd))) {
e6bb7a96
FT
949 /*
950 * Bidi commands Must be complete as a whole,
951 * both sides at once.
952 */
82ed4db4 953 scsi_req(req->next_rq)->resid_len = scsi_in(cmd)->resid;
2a842aca 954 if (scsi_end_request(req, BLK_STS_OK, blk_rq_bytes(req),
f6d47e74 955 blk_rq_bytes(req->next_rq)))
8e1695a0
DG
956 WARN_ONCE(true,
957 "Bidi command with remaining bytes");
6f9a35e2
BH
958 return;
959 }
1da177e4
LT
960 }
961
0d437906 962 /* no bidi support yet, other than in pass-through */
8e1695a0
DG
963 if (unlikely(blk_bidi_rq(req))) {
964 WARN_ONCE(true, "Only support bidi command in passthrough");
965 scmd_printk(KERN_ERR, cmd, "Killing bidi command\n");
966 if (scsi_end_request(req, BLK_STS_IOERR, blk_rq_bytes(req),
967 blk_rq_bytes(req->next_rq)))
968 WARN_ONCE(true, "Bidi command with remaining bytes");
969 return;
970 }
30b0c37b 971
1da177e4
LT
972 /*
973 * Next deal with any sectors which we were able to correctly
974 * handle.
975 */
91921e01
HR
976 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
977 "%u sectors total, %d bytes done.\n",
978 blk_rq_sectors(req), good_bytes));
d6b0c537 979
a9bddd74 980 /*
1f7cbb8e
DG
981 * Next deal with any sectors which we were able to correctly
982 * handle. Failed, zero length commands always need to drop down
983 * to retry code. Fast path should return in this block.
d6b0c537 984 */
0d437906
DG
985 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
986 if (likely(!scsi_end_request(req, blk_stat, good_bytes, 0)))
1f7cbb8e
DG
987 return; /* no bytes remaining */
988 }
bc85dc50 989
0d437906
DG
990 /* Kill remainder if no retries. */
991 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
1f7cbb8e 992 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req), 0))
8e1695a0
DG
993 WARN_ONCE(true,
994 "Bytes remaining after failed, no-retry command");
f6d47e74 995 return;
bc85dc50
CH
996 }
997
998 /*
999 * If there had been no error, but we have leftover bytes in the
1000 * requeues just queue the command up again.
d6b0c537 1001 */
0d437906 1002 if (likely(result == 0))
4ae61c68
DG
1003 scsi_io_completion_reprep(cmd, q);
1004 else
da32baea 1005 scsi_io_completion_action(cmd, result);
1da177e4 1006}
1da177e4 1007
3c356bde 1008static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb)
1da177e4 1009{
6f9a35e2 1010 int count;
1da177e4
LT
1011
1012 /*
3b003157 1013 * If sg table allocation fails, requeue request later.
1da177e4 1014 */
f9d03f96
CH
1015 if (unlikely(sg_alloc_table_chained(&sdb->table,
1016 blk_rq_nr_phys_segments(req), sdb->table.sgl)))
1da177e4 1017 return BLKPREP_DEFER;
1da177e4 1018
1da177e4
LT
1019 /*
1020 * Next, walk the list, and fill in the addresses and sizes of
1021 * each segment.
1022 */
30b0c37b
BH
1023 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1024 BUG_ON(count > sdb->table.nents);
1025 sdb->table.nents = count;
fd102b12 1026 sdb->length = blk_rq_payload_bytes(req);
4a03d90e 1027 return BLKPREP_OK;
1da177e4 1028}
6f9a35e2
BH
1029
1030/*
1031 * Function: scsi_init_io()
1032 *
1033 * Purpose: SCSI I/O initialize function.
1034 *
1035 * Arguments: cmd - Command descriptor we wish to initialize
1036 *
1037 * Returns: 0 on success
1038 * BLKPREP_DEFER if the failure is retryable
1039 * BLKPREP_KILL if the failure is fatal
1040 */
3c356bde 1041int scsi_init_io(struct scsi_cmnd *cmd)
6f9a35e2 1042{
13f05c8d 1043 struct request *rq = cmd->request;
e7661a8e 1044 int error = BLKPREP_KILL;
13f05c8d 1045
fd3fc0b4 1046 if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
14784565 1047 return BLKPREP_KILL;
635d98b1 1048
3c356bde 1049 error = scsi_init_sgtable(rq, &cmd->sdb);
6f9a35e2 1050 if (error)
14784565 1051 return error;
6f9a35e2 1052
13f05c8d 1053 if (blk_bidi_rq(rq)) {
3c356bde 1054 error = scsi_init_sgtable(rq->next_rq, rq->next_rq->special);
6f9a35e2 1055 if (error)
14784565 1056 goto out_free_sgtables;
6f9a35e2
BH
1057 }
1058
13f05c8d 1059 if (blk_integrity_rq(rq)) {
7027ad72
MP
1060 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1061 int ivecs, count;
1062
14784565 1063 if (WARN_ON_ONCE(!prot_sdb)) {
91724c20
EM
1064 /*
1065 * This can happen if someone (e.g. multipath)
1066 * queues a command to a device on an adapter
1067 * that does not support DIX.
1068 */
91724c20 1069 error = BLKPREP_KILL;
14784565 1070 goto out_free_sgtables;
91724c20
EM
1071 }
1072
13f05c8d 1073 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
7027ad72 1074
001d63be 1075 if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
22cc3d4c 1076 prot_sdb->table.sgl)) {
7027ad72 1077 error = BLKPREP_DEFER;
14784565 1078 goto out_free_sgtables;
7027ad72
MP
1079 }
1080
13f05c8d 1081 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
7027ad72 1082 prot_sdb->table.sgl);
6f1d8a53
IS
1083 BUG_ON(count > ivecs);
1084 BUG_ON(count > queue_max_integrity_segments(rq->q));
7027ad72
MP
1085
1086 cmd->prot_sdb = prot_sdb;
1087 cmd->prot_sdb->table.nents = count;
1088 }
1089
d285203c 1090 return BLKPREP_OK;
14784565 1091out_free_sgtables:
f664a3cc 1092 scsi_mq_free_sgtables(cmd);
6f9a35e2
BH
1093 return error;
1094}
bb52d82f 1095EXPORT_SYMBOL(scsi_init_io);
1da177e4 1096
ca18d6f7 1097/**
832889f5 1098 * scsi_initialize_rq - initialize struct scsi_cmnd partially
35c0506f 1099 * @rq: Request associated with the SCSI command to be initialized.
ca18d6f7 1100 *
832889f5
BVA
1101 * This function initializes the members of struct scsi_cmnd that must be
1102 * initialized before request processing starts and that won't be
1103 * reinitialized if a SCSI command is requeued.
1104 *
64104f70
BVA
1105 * Called from inside blk_get_request() for pass-through requests and from
1106 * inside scsi_init_command() for filesystem requests.
ca18d6f7 1107 */
e4c9470b 1108static void scsi_initialize_rq(struct request *rq)
ca18d6f7 1109{
c8d9cf22
BVA
1110 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1111
1112 scsi_req_init(&cmd->req);
3be8828f 1113 init_rcu_head(&cmd->rcu);
832889f5
BVA
1114 cmd->jiffies_at_alloc = jiffies;
1115 cmd->retries = 0;
ca18d6f7 1116}
ca18d6f7 1117
2dd6fb59
BVA
1118/* Add a command to the list used by the aacraid and dpt_i2o drivers */
1119void scsi_add_cmd_to_list(struct scsi_cmnd *cmd)
1120{
1121 struct scsi_device *sdev = cmd->device;
1122 struct Scsi_Host *shost = sdev->host;
1123 unsigned long flags;
1124
1125 if (shost->use_cmd_list) {
1126 spin_lock_irqsave(&sdev->list_lock, flags);
1127 list_add_tail(&cmd->list, &sdev->cmd_list);
1128 spin_unlock_irqrestore(&sdev->list_lock, flags);
1129 }
1130}
1131
1132/* Remove a command from the list used by the aacraid and dpt_i2o drivers */
1133void scsi_del_cmd_from_list(struct scsi_cmnd *cmd)
1134{
1135 struct scsi_device *sdev = cmd->device;
1136 struct Scsi_Host *shost = sdev->host;
1137 unsigned long flags;
1138
1139 if (shost->use_cmd_list) {
1140 spin_lock_irqsave(&sdev->list_lock, flags);
1141 BUG_ON(list_empty(&cmd->list));
1142 list_del_init(&cmd->list);
1143 spin_unlock_irqrestore(&sdev->list_lock, flags);
1144 }
1145}
1146
ca18d6f7 1147/* Called after a request has been started. */
e9c787e6 1148void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
3b003157 1149{
e9c787e6
CH
1150 void *buf = cmd->sense_buffer;
1151 void *prot = cmd->prot_sdb;
64104f70
BVA
1152 struct request *rq = blk_mq_rq_from_pdu(cmd);
1153 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
832889f5
BVA
1154 unsigned long jiffies_at_alloc;
1155 int retries;
64104f70
BVA
1156
1157 if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
1158 flags |= SCMD_INITIALIZED;
1159 scsi_initialize_rq(rq);
1160 }
3b003157 1161
832889f5
BVA
1162 jiffies_at_alloc = cmd->jiffies_at_alloc;
1163 retries = cmd->retries;
82ed4db4
CH
1164 /* zero out the cmd, except for the embedded scsi_request */
1165 memset((char *)cmd + sizeof(cmd->req), 0,
ee524236 1166 sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
3b003157 1167
e9c787e6
CH
1168 cmd->device = dev;
1169 cmd->sense_buffer = buf;
1170 cmd->prot_sdb = prot;
64104f70 1171 cmd->flags = flags;
e9c787e6 1172 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
832889f5
BVA
1173 cmd->jiffies_at_alloc = jiffies_at_alloc;
1174 cmd->retries = retries;
64a87b24 1175
2dd6fb59 1176 scsi_add_cmd_to_list(cmd);
3b003157
CH
1177}
1178
785ba83b
CH
1179static inline blk_status_t prep_to_mq(int ret)
1180{
1181 switch (ret) {
1182 case BLKPREP_OK:
1183 return BLK_STS_OK;
1184 case BLKPREP_DEFER:
1185 return BLK_STS_RESOURCE;
1186 default:
1187 return BLK_STS_IOERR;
1188 }
1189}
1190
1191static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
1192 struct request *req)
7b16318d 1193{
bed2213d 1194 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
3b003157
CH
1195
1196 /*
aebf526b 1197 * Passthrough requests may transfer data, in which case they must
3b003157
CH
1198 * a bio attached to them. Or they might contain a SCSI command
1199 * that does not transfer data, in which case they may optionally
1200 * submit a request without an attached bio.
1201 */
1202 if (req->bio) {
3c356bde 1203 int ret = scsi_init_io(cmd);
3b003157 1204 if (unlikely(ret))
785ba83b 1205 return prep_to_mq(ret);
3b003157 1206 } else {
b0790410 1207 BUG_ON(blk_rq_bytes(req));
3b003157 1208
30b0c37b 1209 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
3b003157 1210 }
7b16318d 1211
82ed4db4
CH
1212 cmd->cmd_len = scsi_req(req)->cmd_len;
1213 cmd->cmnd = scsi_req(req)->cmd;
b0790410 1214 cmd->transfersize = blk_rq_bytes(req);
64c7f1d1 1215 cmd->allowed = scsi_req(req)->retries;
785ba83b 1216 return BLK_STS_OK;
7b16318d 1217}
7b16318d 1218
3b003157 1219/*
aebf526b 1220 * Setup a normal block command. These are simple request from filesystems
3868cf8e 1221 * that still need to be translated to SCSI CDBs from the ULD.
3b003157 1222 */
785ba83b
CH
1223static blk_status_t scsi_setup_fs_cmnd(struct scsi_device *sdev,
1224 struct request *req)
1da177e4 1225{
bed2213d 1226 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
a6a8d9f8 1227
ee14c674
CH
1228 if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
1229 int ret = sdev->handler->prep_fn(sdev, req);
a6a8d9f8 1230 if (ret != BLKPREP_OK)
785ba83b 1231 return prep_to_mq(ret);
a6a8d9f8
CS
1232 }
1233
82ed4db4 1234 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
64a87b24 1235 memset(cmd->cmnd, 0, BLK_MAX_CDB);
785ba83b 1236 return prep_to_mq(scsi_cmd_to_driver(cmd)->init_command(cmd));
3b003157
CH
1237}
1238
785ba83b
CH
1239static blk_status_t scsi_setup_cmnd(struct scsi_device *sdev,
1240 struct request *req)
6af7a4ff 1241{
bed2213d 1242 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
6af7a4ff
CH
1243
1244 if (!blk_rq_bytes(req))
1245 cmd->sc_data_direction = DMA_NONE;
1246 else if (rq_data_dir(req) == WRITE)
1247 cmd->sc_data_direction = DMA_TO_DEVICE;
1248 else
1249 cmd->sc_data_direction = DMA_FROM_DEVICE;
1250
aebf526b
CH
1251 if (blk_rq_is_scsi(req))
1252 return scsi_setup_scsi_cmnd(sdev, req);
1253 else
6af7a4ff 1254 return scsi_setup_fs_cmnd(sdev, req);
6af7a4ff
CH
1255}
1256
c092d4ec 1257static blk_status_t
a1b73fc1 1258scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
3b003157 1259{
c092d4ec
CH
1260 switch (sdev->sdev_state) {
1261 case SDEV_OFFLINE:
1262 case SDEV_TRANSPORT_OFFLINE:
1263 /*
1264 * If the device is offline we refuse to process any
1265 * commands. The device must be brought online
1266 * before trying any recovery commands.
1267 */
1268 sdev_printk(KERN_ERR, sdev,
1269 "rejecting I/O to offline device\n");
1270 return BLK_STS_IOERR;
1271 case SDEV_DEL:
1272 /*
1273 * If the device is fully deleted, we refuse to
1274 * process any commands as well.
1275 */
1276 sdev_printk(KERN_ERR, sdev,
1277 "rejecting I/O to dead device\n");
1278 return BLK_STS_IOERR;
1279 case SDEV_BLOCK:
1280 case SDEV_CREATED_BLOCK:
1281 return BLK_STS_RESOURCE;
1282 case SDEV_QUIESCE:
1283 /*
1284 * If the devices is blocked we defer normal commands.
1285 */
1286 if (req && !(req->rq_flags & RQF_PREEMPT))
1287 return BLK_STS_RESOURCE;
1288 return BLK_STS_OK;
1289 default:
1290 /*
1291 * For any other not fully online state we only allow
1292 * special commands. In particular any user initiated
1293 * command is not allowed.
1294 */
1295 if (req && !(req->rq_flags & RQF_PREEMPT))
1296 return BLK_STS_IOERR;
1297 return BLK_STS_OK;
1da177e4 1298 }
7f9a6bc4 1299}
1da177e4 1300
1da177e4
LT
1301/*
1302 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1303 * return 0.
1304 *
1305 * Called with the queue_lock held.
1306 */
1307static inline int scsi_dev_queue_ready(struct request_queue *q,
1308 struct scsi_device *sdev)
1309{
71e75c97
CH
1310 unsigned int busy;
1311
1312 busy = atomic_inc_return(&sdev->device_busy) - 1;
cd9070c9 1313 if (atomic_read(&sdev->device_blocked)) {
71e75c97
CH
1314 if (busy)
1315 goto out_dec;
1316
1da177e4
LT
1317 /*
1318 * unblock after device_blocked iterates to zero
1319 */
f664a3cc 1320 if (atomic_dec_return(&sdev->device_blocked) > 0)
71e75c97 1321 goto out_dec;
71e75c97
CH
1322 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
1323 "unblocking device at zero depth\n"));
1da177e4 1324 }
71e75c97
CH
1325
1326 if (busy >= sdev->queue_depth)
1327 goto out_dec;
1da177e4
LT
1328
1329 return 1;
71e75c97
CH
1330out_dec:
1331 atomic_dec(&sdev->device_busy);
1332 return 0;
1da177e4
LT
1333}
1334
f0c0a376
MC
1335/*
1336 * scsi_target_queue_ready: checks if there we can send commands to target
1337 * @sdev: scsi device on starget to check.
f0c0a376
MC
1338 */
1339static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1340 struct scsi_device *sdev)
1341{
1342 struct scsi_target *starget = scsi_target(sdev);
7ae65c0f 1343 unsigned int busy;
f0c0a376
MC
1344
1345 if (starget->single_lun) {
7ae65c0f 1346 spin_lock_irq(shost->host_lock);
f0c0a376 1347 if (starget->starget_sdev_user &&
7ae65c0f
CH
1348 starget->starget_sdev_user != sdev) {
1349 spin_unlock_irq(shost->host_lock);
1350 return 0;
1351 }
f0c0a376 1352 starget->starget_sdev_user = sdev;
7ae65c0f 1353 spin_unlock_irq(shost->host_lock);
f0c0a376
MC
1354 }
1355
2ccbb008
CH
1356 if (starget->can_queue <= 0)
1357 return 1;
1358
7ae65c0f 1359 busy = atomic_inc_return(&starget->target_busy) - 1;
cd9070c9 1360 if (atomic_read(&starget->target_blocked) > 0) {
7ae65c0f
CH
1361 if (busy)
1362 goto starved;
1363
f0c0a376
MC
1364 /*
1365 * unblock after target_blocked iterates to zero
1366 */
cd9070c9 1367 if (atomic_dec_return(&starget->target_blocked) > 0)
7ae65c0f 1368 goto out_dec;
cf68d334
CH
1369
1370 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1371 "unblocking target at zero depth\n"));
f0c0a376
MC
1372 }
1373
2ccbb008 1374 if (busy >= starget->can_queue)
7ae65c0f 1375 goto starved;
f0c0a376 1376
7ae65c0f
CH
1377 return 1;
1378
1379starved:
1380 spin_lock_irq(shost->host_lock);
1381 list_move_tail(&sdev->starved_entry, &shost->starved_list);
cf68d334 1382 spin_unlock_irq(shost->host_lock);
7ae65c0f 1383out_dec:
2ccbb008
CH
1384 if (starget->can_queue > 0)
1385 atomic_dec(&starget->target_busy);
7ae65c0f 1386 return 0;
f0c0a376
MC
1387}
1388
1da177e4
LT
1389/*
1390 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1391 * return 0. We must end up running the queue again whenever 0 is
1392 * returned, else IO can hang.
1da177e4
LT
1393 */
1394static inline int scsi_host_queue_ready(struct request_queue *q,
1395 struct Scsi_Host *shost,
1396 struct scsi_device *sdev)
1397{
74665016 1398 unsigned int busy;
cf68d334 1399
939647ee 1400 if (scsi_host_in_recovery(shost))
74665016
CH
1401 return 0;
1402
d772a65d 1403 busy = atomic_inc_return(&shost->host_busy) - 1;
cd9070c9 1404 if (atomic_read(&shost->host_blocked) > 0) {
d772a65d 1405 if (busy)
74665016
CH
1406 goto starved;
1407
1da177e4
LT
1408 /*
1409 * unblock after host_blocked iterates to zero
1410 */
cd9070c9 1411 if (atomic_dec_return(&shost->host_blocked) > 0)
74665016 1412 goto out_dec;
cf68d334
CH
1413
1414 SCSI_LOG_MLQUEUE(3,
1415 shost_printk(KERN_INFO, shost,
1416 "unblocking host at zero depth\n"));
1da177e4 1417 }
74665016 1418
d772a65d 1419 if (shost->can_queue > 0 && busy >= shost->can_queue)
74665016
CH
1420 goto starved;
1421 if (shost->host_self_blocked)
1422 goto starved;
1da177e4
LT
1423
1424 /* We're OK to process the command, so we can't be starved */
74665016
CH
1425 if (!list_empty(&sdev->starved_entry)) {
1426 spin_lock_irq(shost->host_lock);
1427 if (!list_empty(&sdev->starved_entry))
1428 list_del_init(&sdev->starved_entry);
1429 spin_unlock_irq(shost->host_lock);
1430 }
1da177e4 1431
74665016
CH
1432 return 1;
1433
1434starved:
1435 spin_lock_irq(shost->host_lock);
1436 if (list_empty(&sdev->starved_entry))
1437 list_add_tail(&sdev->starved_entry, &shost->starved_list);
cf68d334 1438 spin_unlock_irq(shost->host_lock);
74665016 1439out_dec:
3bd6f43f 1440 scsi_dec_host_busy(shost);
74665016 1441 return 0;
1da177e4
LT
1442}
1443
6c5121b7
KU
1444/*
1445 * Busy state exporting function for request stacking drivers.
1446 *
1447 * For efficiency, no lock is taken to check the busy state of
1448 * shost/starget/sdev, since the returned value is not guaranteed and
1449 * may be changed after request stacking drivers call the function,
1450 * regardless of taking lock or not.
1451 *
67bd9413
BVA
1452 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1453 * needs to return 'not busy'. Otherwise, request stacking drivers
1454 * may hold requests forever.
6c5121b7 1455 */
f664a3cc 1456static bool scsi_mq_lld_busy(struct request_queue *q)
6c5121b7
KU
1457{
1458 struct scsi_device *sdev = q->queuedata;
1459 struct Scsi_Host *shost;
6c5121b7 1460
3f3299d5 1461 if (blk_queue_dying(q))
f664a3cc 1462 return false;
6c5121b7
KU
1463
1464 shost = sdev->host;
6c5121b7 1465
b7e94a16
JN
1466 /*
1467 * Ignore host/starget busy state.
1468 * Since block layer does not have a concept of fairness across
1469 * multiple queues, congestion of host/starget needs to be handled
1470 * in SCSI layer.
1471 */
1472 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
f664a3cc 1473 return true;
e36e0c80 1474
f664a3cc 1475 return false;
1da177e4
LT
1476}
1477
1aea6434
JA
1478static void scsi_softirq_done(struct request *rq)
1479{
bed2213d 1480 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
242f9dcb 1481 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
1aea6434
JA
1482 int disposition;
1483
1484 INIT_LIST_HEAD(&cmd->eh_entry);
1485
242f9dcb
JA
1486 atomic_inc(&cmd->device->iodone_cnt);
1487 if (cmd->result)
1488 atomic_inc(&cmd->device->ioerr_cnt);
1489
1aea6434
JA
1490 disposition = scsi_decide_disposition(cmd);
1491 if (disposition != SUCCESS &&
1492 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1493 sdev_printk(KERN_ERR, cmd->device,
1494 "timing out command, waited %lus\n",
1495 wait_for/HZ);
1496 disposition = SUCCESS;
1497 }
91921e01 1498
1aea6434
JA
1499 scsi_log_completion(cmd, disposition);
1500
1501 switch (disposition) {
1502 case SUCCESS:
1503 scsi_finish_command(cmd);
1504 break;
1505 case NEEDS_RETRY:
596f482a 1506 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
1aea6434
JA
1507 break;
1508 case ADD_TO_MLQUEUE:
1509 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1510 break;
1511 default:
a0658632 1512 scsi_eh_scmd_add(cmd);
2171b6d0 1513 break;
1aea6434
JA
1514 }
1515}
1516
82042a2c
CH
1517/**
1518 * scsi_dispatch_command - Dispatch a command to the low-level driver.
1519 * @cmd: command block we are dispatching.
1520 *
1521 * Return: nonzero return request was rejected and device's queue needs to be
1522 * plugged.
1523 */
1524static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
1525{
1526 struct Scsi_Host *host = cmd->device->host;
1527 int rtn = 0;
1528
1529 atomic_inc(&cmd->device->iorequest_cnt);
1530
1531 /* check if the device is still usable */
1532 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
1533 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
1534 * returns an immediate error upwards, and signals
1535 * that the device is no longer present */
1536 cmd->result = DID_NO_CONNECT << 16;
1537 goto done;
1538 }
1539
1540 /* Check to see if the scsi lld made this device blocked. */
1541 if (unlikely(scsi_device_blocked(cmd->device))) {
1542 /*
1543 * in blocked state, the command is just put back on
1544 * the device queue. The suspend state has already
1545 * blocked the queue so future requests should not
1546 * occur until the device transitions out of the
1547 * suspend state.
1548 */
1549 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1550 "queuecommand : device blocked\n"));
1551 return SCSI_MLQUEUE_DEVICE_BUSY;
1552 }
1553
1554 /* Store the LUN value in cmnd, if needed. */
1555 if (cmd->device->lun_in_cdb)
1556 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
1557 (cmd->device->lun << 5 & 0xe0);
1558
1559 scsi_log_send(cmd);
1560
1561 /*
1562 * Before we queue this command, check if the command
1563 * length exceeds what the host adapter can handle.
1564 */
1565 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
1566 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1567 "queuecommand : command too long. "
1568 "cdb_size=%d host->max_cmd_len=%d\n",
1569 cmd->cmd_len, cmd->device->host->max_cmd_len));
1570 cmd->result = (DID_ABORT << 16);
1571 goto done;
1572 }
1573
1574 if (unlikely(host->shost_state == SHOST_DEL)) {
1575 cmd->result = (DID_NO_CONNECT << 16);
1576 goto done;
1577
1578 }
1579
1580 trace_scsi_dispatch_cmd_start(cmd);
1581 rtn = host->hostt->queuecommand(host, cmd);
1582 if (rtn) {
1583 trace_scsi_dispatch_cmd_error(cmd, rtn);
1584 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
1585 rtn != SCSI_MLQUEUE_TARGET_BUSY)
1586 rtn = SCSI_MLQUEUE_HOST_BUSY;
1587
1588 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
1589 "queuecommand : request rejected\n"));
1590 }
1591
1592 return rtn;
1593 done:
1594 cmd->scsi_done(cmd);
1595 return 0;
1596}
1597
be4c186c
BVA
1598/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
1599static unsigned int scsi_mq_sgl_size(struct Scsi_Host *shost)
1600{
1601 return min_t(unsigned int, shost->sg_tablesize, SG_CHUNK_SIZE) *
1602 sizeof(struct scatterlist);
1603}
1604
785ba83b 1605static blk_status_t scsi_mq_prep_fn(struct request *req)
d285203c
CH
1606{
1607 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1608 struct scsi_device *sdev = req->q->queuedata;
1609 struct Scsi_Host *shost = sdev->host;
d285203c
CH
1610 struct scatterlist *sg;
1611
08f78436 1612 scsi_init_command(sdev, cmd);
d285203c
CH
1613
1614 req->special = cmd;
1615
1616 cmd->request = req;
d285203c
CH
1617
1618 cmd->tag = req->tag;
d285203c
CH
1619 cmd->prot_op = SCSI_PROT_NORMAL;
1620
d285203c
CH
1621 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
1622 cmd->sdb.table.sgl = sg;
1623
1624 if (scsi_host_get_prot(shost)) {
d285203c
CH
1625 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));
1626
1627 cmd->prot_sdb->table.sgl =
1628 (struct scatterlist *)(cmd->prot_sdb + 1);
1629 }
1630
1631 if (blk_bidi_rq(req)) {
1632 struct request *next_rq = req->next_rq;
1633 struct scsi_data_buffer *bidi_sdb = blk_mq_rq_to_pdu(next_rq);
1634
1635 memset(bidi_sdb, 0, sizeof(struct scsi_data_buffer));
1636 bidi_sdb->table.sgl =
1637 (struct scatterlist *)(bidi_sdb + 1);
1638
1639 next_rq->special = bidi_sdb;
1640 }
1641
fe052529
CH
1642 blk_mq_start_request(req);
1643
8fe8ffb1 1644 return scsi_setup_cmnd(sdev, req);
d285203c
CH
1645}
1646
1647static void scsi_mq_done(struct scsi_cmnd *cmd)
1648{
1649 trace_scsi_dispatch_cmd_done(cmd);
08e0029a 1650 blk_mq_complete_request(cmd->request);
d285203c
CH
1651}
1652
0df21c86 1653static void scsi_mq_put_budget(struct blk_mq_hw_ctx *hctx)
d285203c 1654{
0df21c86
ML
1655 struct request_queue *q = hctx->queue;
1656 struct scsi_device *sdev = q->queuedata;
0df21c86 1657
0df21c86
ML
1658 atomic_dec(&sdev->device_busy);
1659 put_device(&sdev->sdev_gendev);
1660}
1661
88022d72 1662static bool scsi_mq_get_budget(struct blk_mq_hw_ctx *hctx)
0df21c86
ML
1663{
1664 struct request_queue *q = hctx->queue;
d285203c 1665 struct scsi_device *sdev = q->queuedata;
d285203c 1666
d285203c
CH
1667 if (!get_device(&sdev->sdev_gendev))
1668 goto out;
d285203c
CH
1669 if (!scsi_dev_queue_ready(q, sdev))
1670 goto out_put_device;
d285203c 1671
88022d72 1672 return true;
0df21c86 1673
0df21c86
ML
1674out_put_device:
1675 put_device(&sdev->sdev_gendev);
1676out:
7e70aa78
ML
1677 if (atomic_read(&sdev->device_busy) == 0 && !scsi_device_blocked(sdev))
1678 blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
88022d72 1679 return false;
0df21c86
ML
1680}
1681
fc17b653 1682static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
74c45052 1683 const struct blk_mq_queue_data *bd)
d285203c 1684{
74c45052 1685 struct request *req = bd->rq;
d285203c
CH
1686 struct request_queue *q = req->q;
1687 struct scsi_device *sdev = q->queuedata;
1688 struct Scsi_Host *shost = sdev->host;
1689 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
fc17b653 1690 blk_status_t ret;
d285203c
CH
1691 int reason;
1692
c092d4ec
CH
1693 /*
1694 * If the device is not in running state we will reject some or all
1695 * commands.
1696 */
1697 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1698 ret = scsi_prep_state_check(sdev, req);
1699 if (ret != BLK_STS_OK)
1700 goto out_put_budget;
1701 }
d285203c 1702
fc17b653 1703 ret = BLK_STS_RESOURCE;
d285203c 1704 if (!scsi_target_queue_ready(shost, sdev))
826a70a0 1705 goto out_put_budget;
d285203c
CH
1706 if (!scsi_host_queue_ready(q, shost, sdev))
1707 goto out_dec_target_busy;
1708
e8064021 1709 if (!(req->rq_flags & RQF_DONTPREP)) {
785ba83b 1710 ret = scsi_mq_prep_fn(req);
fc17b653 1711 if (ret != BLK_STS_OK)
d285203c 1712 goto out_dec_host_busy;
e8064021 1713 req->rq_flags |= RQF_DONTPREP;
fe052529
CH
1714 } else {
1715 blk_mq_start_request(req);
d285203c
CH
1716 }
1717
125c99bc
CH
1718 if (sdev->simple_tags)
1719 cmd->flags |= SCMD_TAGGED;
b1dd2aac 1720 else
125c99bc 1721 cmd->flags &= ~SCMD_TAGGED;
b1dd2aac 1722
d285203c
CH
1723 scsi_init_cmd_errh(cmd);
1724 cmd->scsi_done = scsi_mq_done;
1725
1726 reason = scsi_dispatch_cmd(cmd);
1727 if (reason) {
1728 scsi_set_blocked(cmd, reason);
fc17b653 1729 ret = BLK_STS_RESOURCE;
d285203c
CH
1730 goto out_dec_host_busy;
1731 }
1732
fc17b653 1733 return BLK_STS_OK;
d285203c
CH
1734
1735out_dec_host_busy:
3bd6f43f 1736 scsi_dec_host_busy(shost);
d285203c
CH
1737out_dec_target_busy:
1738 if (scsi_target(sdev)->can_queue > 0)
1739 atomic_dec(&scsi_target(sdev)->target_busy);
0df21c86
ML
1740out_put_budget:
1741 scsi_mq_put_budget(hctx);
d285203c 1742 switch (ret) {
fc17b653
CH
1743 case BLK_STS_OK:
1744 break;
1745 case BLK_STS_RESOURCE:
86ff7c2a
ML
1746 if (atomic_read(&sdev->device_busy) ||
1747 scsi_device_blocked(sdev))
1748 ret = BLK_STS_DEV_RESOURCE;
d285203c 1749 break;
fc17b653 1750 default:
d285203c
CH
1751 /*
1752 * Make sure to release all allocated ressources when
1753 * we hit an error, as we will never see this command
1754 * again.
1755 */
e8064021 1756 if (req->rq_flags & RQF_DONTPREP)
d285203c
CH
1757 scsi_mq_uninit_cmd(cmd);
1758 break;
d285203c
CH
1759 }
1760 return ret;
1761}
1762
0152fb6b
CH
1763static enum blk_eh_timer_return scsi_timeout(struct request *req,
1764 bool reserved)
1765{
1766 if (reserved)
1767 return BLK_EH_RESET_TIMER;
1768 return scsi_times_out(req);
1769}
1770
e7008ff5
BVA
1771static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
1772 unsigned int hctx_idx, unsigned int numa_node)
d285203c 1773{
d6296d39 1774 struct Scsi_Host *shost = set->driver_data;
8e688254 1775 const bool unchecked_isa_dma = shost->unchecked_isa_dma;
d285203c 1776 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
08f78436 1777 struct scatterlist *sg;
d285203c 1778
8e688254
BVA
1779 if (unchecked_isa_dma)
1780 cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
1781 cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
1782 GFP_KERNEL, numa_node);
d285203c
CH
1783 if (!cmd->sense_buffer)
1784 return -ENOMEM;
82ed4db4 1785 cmd->req.sense = cmd->sense_buffer;
08f78436
BVA
1786
1787 if (scsi_host_get_prot(shost)) {
1788 sg = (void *)cmd + sizeof(struct scsi_cmnd) +
1789 shost->hostt->cmd_size;
1790 cmd->prot_sdb = (void *)sg + scsi_mq_sgl_size(shost);
1791 }
1792
d285203c
CH
1793 return 0;
1794}
1795
e7008ff5
BVA
1796static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
1797 unsigned int hctx_idx)
d285203c
CH
1798{
1799 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1800
8e688254
BVA
1801 scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
1802 cmd->sense_buffer);
d285203c
CH
1803}
1804
2d9c5c20
CH
1805static int scsi_map_queues(struct blk_mq_tag_set *set)
1806{
1807 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);
1808
1809 if (shost->hostt->map_queues)
1810 return shost->hostt->map_queues(shost);
ed76e329 1811 return blk_mq_map_queues(&set->map[0]);
2d9c5c20
CH
1812}
1813
d48777a6 1814void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
1da177e4 1815{
6f381fa3 1816 struct device *dev = shost->dma_dev;
1da177e4 1817
a8474ce2
JA
1818 /*
1819 * this limit is imposed by hardware restrictions
1820 */
8a78362c 1821 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
65e8617f 1822 SG_MAX_SEGMENTS));
a8474ce2 1823
13f05c8d
MP
1824 if (scsi_host_prot_dma(shost)) {
1825 shost->sg_prot_tablesize =
1826 min_not_zero(shost->sg_prot_tablesize,
1827 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1828 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1829 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1830 }
1831
086fa5ff 1832 blk_queue_max_hw_sectors(q, shost->max_sectors);
21e07dba
CH
1833 if (shost->unchecked_isa_dma)
1834 blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
1da177e4 1835 blk_queue_segment_boundary(q, shost->dma_boundary);
99c84dbd 1836 dma_set_seg_boundary(dev, shost->dma_boundary);
1da177e4 1837
860ac568
FT
1838 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
1839
1da177e4 1840 if (!shost->use_clustering)
e692cb66 1841 q->limits.cluster = 0;
465ff318
JB
1842
1843 /*
90addc6b
HC
1844 * Set a reasonable default alignment: The larger of 32-byte (dword),
1845 * which is a common minimum for HBAs, and the minimum DMA alignment,
1846 * which is set by the platform.
1847 *
1848 * Devices that require a bigger alignment can increase it later.
465ff318 1849 */
90addc6b 1850 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
d285203c 1851}
d48777a6 1852EXPORT_SYMBOL_GPL(__scsi_init_queue);
465ff318 1853
f363b089 1854static const struct blk_mq_ops scsi_mq_ops = {
0df21c86
ML
1855 .get_budget = scsi_mq_get_budget,
1856 .put_budget = scsi_mq_put_budget,
d285203c
CH
1857 .queue_rq = scsi_queue_rq,
1858 .complete = scsi_softirq_done,
0152fb6b 1859 .timeout = scsi_timeout,
0eebd005
BVA
1860#ifdef CONFIG_BLK_DEBUG_FS
1861 .show_rq = scsi_show_rq,
1862#endif
e7008ff5
BVA
1863 .init_request = scsi_mq_init_request,
1864 .exit_request = scsi_mq_exit_request,
ca18d6f7 1865 .initialize_rq_fn = scsi_initialize_rq,
3a7ea2c4 1866 .busy = scsi_mq_lld_busy,
2d9c5c20 1867 .map_queues = scsi_map_queues,
d285203c
CH
1868};
1869
1870struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
1871{
1872 sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
1873 if (IS_ERR(sdev->request_queue))
1874 return NULL;
1875
1876 sdev->request_queue->queuedata = sdev;
1877 __scsi_init_queue(sdev->host, sdev->request_queue);
17cb960f 1878 blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
d285203c
CH
1879 return sdev->request_queue;
1880}
1881
1882int scsi_mq_setup_tags(struct Scsi_Host *shost)
1883{
be4c186c 1884 unsigned int cmd_size, sgl_size;
d285203c 1885
be4c186c 1886 sgl_size = scsi_mq_sgl_size(shost);
d285203c
CH
1887 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
1888 if (scsi_host_get_prot(shost))
1889 cmd_size += sizeof(struct scsi_data_buffer) + sgl_size;
1890
1891 memset(&shost->tag_set, 0, sizeof(shost->tag_set));
1892 shost->tag_set.ops = &scsi_mq_ops;
efec4b90 1893 shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
d285203c
CH
1894 shost->tag_set.queue_depth = shost->can_queue;
1895 shost->tag_set.cmd_size = cmd_size;
1896 shost->tag_set.numa_node = NUMA_NO_NODE;
1897 shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
24391c0d
SL
1898 shost->tag_set.flags |=
1899 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
d285203c
CH
1900 shost->tag_set.driver_data = shost;
1901
1902 return blk_mq_alloc_tag_set(&shost->tag_set);
1903}
1904
1905void scsi_mq_destroy_tags(struct Scsi_Host *shost)
1906{
1907 blk_mq_free_tag_set(&shost->tag_set);
1908}
1909
857de6e0
HR
1910/**
1911 * scsi_device_from_queue - return sdev associated with a request_queue
1912 * @q: The request queue to return the sdev from
1913 *
1914 * Return the sdev associated with a request queue or NULL if the
1915 * request_queue does not reference a SCSI device.
1916 */
1917struct scsi_device *scsi_device_from_queue(struct request_queue *q)
1918{
1919 struct scsi_device *sdev = NULL;
1920
f664a3cc 1921 if (q->mq_ops == &scsi_mq_ops)
857de6e0
HR
1922 sdev = q->queuedata;
1923 if (!sdev || !get_device(&sdev->sdev_gendev))
1924 sdev = NULL;
1925
1926 return sdev;
1927}
1928EXPORT_SYMBOL_GPL(scsi_device_from_queue);
1929
1da177e4
LT
1930/*
1931 * Function: scsi_block_requests()
1932 *
1933 * Purpose: Utility function used by low-level drivers to prevent further
1934 * commands from being queued to the device.
1935 *
1936 * Arguments: shost - Host in question
1937 *
1938 * Returns: Nothing
1939 *
1940 * Lock status: No locks are assumed held.
1941 *
1942 * Notes: There is no timer nor any other means by which the requests
1943 * get unblocked other than the low-level driver calling
1944 * scsi_unblock_requests().
1945 */
1946void scsi_block_requests(struct Scsi_Host *shost)
1947{
1948 shost->host_self_blocked = 1;
1949}
1950EXPORT_SYMBOL(scsi_block_requests);
1951
1952/*
1953 * Function: scsi_unblock_requests()
1954 *
1955 * Purpose: Utility function used by low-level drivers to allow further
1956 * commands from being queued to the device.
1957 *
1958 * Arguments: shost - Host in question
1959 *
1960 * Returns: Nothing
1961 *
1962 * Lock status: No locks are assumed held.
1963 *
1964 * Notes: There is no timer nor any other means by which the requests
1965 * get unblocked other than the low-level driver calling
1966 * scsi_unblock_requests().
1967 *
1968 * This is done as an API function so that changes to the
1969 * internals of the scsi mid-layer won't require wholesale
1970 * changes to drivers that use this feature.
1971 */
1972void scsi_unblock_requests(struct Scsi_Host *shost)
1973{
1974 shost->host_self_blocked = 0;
1975 scsi_run_host_queues(shost);
1976}
1977EXPORT_SYMBOL(scsi_unblock_requests);
1978
1979int __init scsi_init_queue(void)
1980{
6362abd3
MP
1981 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1982 sizeof(struct scsi_data_buffer),
1983 0, 0, NULL);
1984 if (!scsi_sdb_cache) {
1985 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
f078727b 1986 return -ENOMEM;
6f9a35e2
BH
1987 }
1988
1da177e4
LT
1989 return 0;
1990}
1991
1992void scsi_exit_queue(void)
1993{
0a6ac4ee
CH
1994 kmem_cache_destroy(scsi_sense_cache);
1995 kmem_cache_destroy(scsi_sense_isadma_cache);
6362abd3 1996 kmem_cache_destroy(scsi_sdb_cache);
1da177e4 1997}
5baba830
JB
1998
1999/**
2000 * scsi_mode_select - issue a mode select
2001 * @sdev: SCSI device to be queried
2002 * @pf: Page format bit (1 == standard, 0 == vendor specific)
2003 * @sp: Save page bit (0 == don't save, 1 == save)
2004 * @modepage: mode page being requested
2005 * @buffer: request buffer (may not be smaller than eight bytes)
2006 * @len: length of request buffer.
2007 * @timeout: command timeout
2008 * @retries: number of retries before failing
2009 * @data: returns a structure abstracting the mode header data
eb44820c 2010 * @sshdr: place to put sense data (or NULL if no sense to be collected).
5baba830
JB
2011 * must be SCSI_SENSE_BUFFERSIZE big.
2012 *
2013 * Returns zero if successful; negative error number or scsi
2014 * status on error
2015 *
2016 */
2017int
2018scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
2019 unsigned char *buffer, int len, int timeout, int retries,
2020 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2021{
2022 unsigned char cmd[10];
2023 unsigned char *real_buffer;
2024 int ret;
2025
2026 memset(cmd, 0, sizeof(cmd));
2027 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
2028
2029 if (sdev->use_10_for_ms) {
2030 if (len > 65535)
2031 return -EINVAL;
2032 real_buffer = kmalloc(8 + len, GFP_KERNEL);
2033 if (!real_buffer)
2034 return -ENOMEM;
2035 memcpy(real_buffer + 8, buffer, len);
2036 len += 8;
2037 real_buffer[0] = 0;
2038 real_buffer[1] = 0;
2039 real_buffer[2] = data->medium_type;
2040 real_buffer[3] = data->device_specific;
2041 real_buffer[4] = data->longlba ? 0x01 : 0;
2042 real_buffer[5] = 0;
2043 real_buffer[6] = data->block_descriptor_length >> 8;
2044 real_buffer[7] = data->block_descriptor_length;
2045
2046 cmd[0] = MODE_SELECT_10;
2047 cmd[7] = len >> 8;
2048 cmd[8] = len;
2049 } else {
2050 if (len > 255 || data->block_descriptor_length > 255 ||
2051 data->longlba)
2052 return -EINVAL;
2053
2054 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2055 if (!real_buffer)
2056 return -ENOMEM;
2057 memcpy(real_buffer + 4, buffer, len);
2058 len += 4;
2059 real_buffer[0] = 0;
2060 real_buffer[1] = data->medium_type;
2061 real_buffer[2] = data->device_specific;
2062 real_buffer[3] = data->block_descriptor_length;
2063
2064
2065 cmd[0] = MODE_SELECT;
2066 cmd[4] = len;
2067 }
2068
2069 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
f4f4e47e 2070 sshdr, timeout, retries, NULL);
5baba830
JB
2071 kfree(real_buffer);
2072 return ret;
2073}
2074EXPORT_SYMBOL_GPL(scsi_mode_select);
2075
1da177e4 2076/**
eb44820c 2077 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
1cf72699 2078 * @sdev: SCSI device to be queried
1da177e4
LT
2079 * @dbd: set if mode sense will allow block descriptors to be returned
2080 * @modepage: mode page being requested
2081 * @buffer: request buffer (may not be smaller than eight bytes)
2082 * @len: length of request buffer.
2083 * @timeout: command timeout
2084 * @retries: number of retries before failing
2085 * @data: returns a structure abstracting the mode header data
eb44820c 2086 * @sshdr: place to put sense data (or NULL if no sense to be collected).
1cf72699 2087 * must be SCSI_SENSE_BUFFERSIZE big.
1da177e4
LT
2088 *
2089 * Returns zero if unsuccessful, or the header offset (either 4
2090 * or 8 depending on whether a six or ten byte command was
2091 * issued) if successful.
eb44820c 2092 */
1da177e4 2093int
1cf72699 2094scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
1da177e4 2095 unsigned char *buffer, int len, int timeout, int retries,
5baba830
JB
2096 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2097{
1da177e4
LT
2098 unsigned char cmd[12];
2099 int use_10_for_ms;
2100 int header_length;
0ae80ba9 2101 int result, retry_count = retries;
ea73a9f2 2102 struct scsi_sense_hdr my_sshdr;
1da177e4
LT
2103
2104 memset(data, 0, sizeof(*data));
2105 memset(&cmd[0], 0, 12);
2106 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2107 cmd[2] = modepage;
2108
ea73a9f2
JB
2109 /* caller might not be interested in sense, but we need it */
2110 if (!sshdr)
2111 sshdr = &my_sshdr;
2112
1da177e4 2113 retry:
1cf72699 2114 use_10_for_ms = sdev->use_10_for_ms;
1da177e4
LT
2115
2116 if (use_10_for_ms) {
2117 if (len < 8)
2118 len = 8;
2119
2120 cmd[0] = MODE_SENSE_10;
2121 cmd[8] = len;
2122 header_length = 8;
2123 } else {
2124 if (len < 4)
2125 len = 4;
2126
2127 cmd[0] = MODE_SENSE;
2128 cmd[4] = len;
2129 header_length = 4;
2130 }
2131
1da177e4
LT
2132 memset(buffer, 0, len);
2133
1cf72699 2134 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
f4f4e47e 2135 sshdr, timeout, retries, NULL);
1da177e4
LT
2136
2137 /* This code looks awful: what it's doing is making sure an
2138 * ILLEGAL REQUEST sense return identifies the actual command
2139 * byte as the problem. MODE_SENSE commands can return
2140 * ILLEGAL REQUEST if the code page isn't supported */
2141
1cf72699 2142 if (use_10_for_ms && !scsi_status_is_good(result) &&
c65be1a6 2143 driver_byte(result) == DRIVER_SENSE) {
ea73a9f2
JB
2144 if (scsi_sense_valid(sshdr)) {
2145 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2146 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
1da177e4
LT
2147 /*
2148 * Invalid command operation code
2149 */
1cf72699 2150 sdev->use_10_for_ms = 0;
1da177e4
LT
2151 goto retry;
2152 }
2153 }
2154 }
2155
1cf72699 2156 if(scsi_status_is_good(result)) {
6d73c851
AV
2157 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2158 (modepage == 6 || modepage == 8))) {
2159 /* Initio breakage? */
2160 header_length = 0;
2161 data->length = 13;
2162 data->medium_type = 0;
2163 data->device_specific = 0;
2164 data->longlba = 0;
2165 data->block_descriptor_length = 0;
2166 } else if(use_10_for_ms) {
1da177e4
LT
2167 data->length = buffer[0]*256 + buffer[1] + 2;
2168 data->medium_type = buffer[2];
2169 data->device_specific = buffer[3];
2170 data->longlba = buffer[4] & 0x01;
2171 data->block_descriptor_length = buffer[6]*256
2172 + buffer[7];
2173 } else {
2174 data->length = buffer[0] + 1;
2175 data->medium_type = buffer[1];
2176 data->device_specific = buffer[2];
2177 data->block_descriptor_length = buffer[3];
2178 }
6d73c851 2179 data->header_length = header_length;
0ae80ba9
HR
2180 } else if ((status_byte(result) == CHECK_CONDITION) &&
2181 scsi_sense_valid(sshdr) &&
2182 sshdr->sense_key == UNIT_ATTENTION && retry_count) {
2183 retry_count--;
2184 goto retry;
1da177e4
LT
2185 }
2186
1cf72699 2187 return result;
1da177e4
LT
2188}
2189EXPORT_SYMBOL(scsi_mode_sense);
2190
001aac25
JB
2191/**
2192 * scsi_test_unit_ready - test if unit is ready
2193 * @sdev: scsi device to change the state of.
2194 * @timeout: command timeout
2195 * @retries: number of retries before failing
74a78ebd 2196 * @sshdr: outpout pointer for decoded sense information.
001aac25
JB
2197 *
2198 * Returns zero if unsuccessful or an error if TUR failed. For
9f8a2c23 2199 * removable media, UNIT_ATTENTION sets ->changed flag.
001aac25 2200 **/
1da177e4 2201int
001aac25 2202scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
74a78ebd 2203 struct scsi_sense_hdr *sshdr)
1da177e4 2204{
1da177e4
LT
2205 char cmd[] = {
2206 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2207 };
2208 int result;
001aac25 2209
001aac25
JB
2210 /* try to eat the UNIT_ATTENTION if there are enough retries */
2211 do {
2212 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
9b91fd34 2213 timeout, 1, NULL);
32c356d7
JB
2214 if (sdev->removable && scsi_sense_valid(sshdr) &&
2215 sshdr->sense_key == UNIT_ATTENTION)
2216 sdev->changed = 1;
2217 } while (scsi_sense_valid(sshdr) &&
2218 sshdr->sense_key == UNIT_ATTENTION && --retries);
001aac25 2219
1da177e4
LT
2220 return result;
2221}
2222EXPORT_SYMBOL(scsi_test_unit_ready);
2223
2224/**
eb44820c 2225 * scsi_device_set_state - Take the given device through the device state model.
1da177e4
LT
2226 * @sdev: scsi device to change the state of.
2227 * @state: state to change to.
2228 *
23cb27fd 2229 * Returns zero if successful or an error if the requested
1da177e4 2230 * transition is illegal.
eb44820c 2231 */
1da177e4
LT
2232int
2233scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2234{
2235 enum scsi_device_state oldstate = sdev->sdev_state;
2236
2237 if (state == oldstate)
2238 return 0;
2239
2240 switch (state) {
2241 case SDEV_CREATED:
6f4267e3
JB
2242 switch (oldstate) {
2243 case SDEV_CREATED_BLOCK:
2244 break;
2245 default:
2246 goto illegal;
2247 }
2248 break;
1da177e4
LT
2249
2250 case SDEV_RUNNING:
2251 switch (oldstate) {
2252 case SDEV_CREATED:
2253 case SDEV_OFFLINE:
1b8d2620 2254 case SDEV_TRANSPORT_OFFLINE:
1da177e4
LT
2255 case SDEV_QUIESCE:
2256 case SDEV_BLOCK:
2257 break;
2258 default:
2259 goto illegal;
2260 }
2261 break;
2262
2263 case SDEV_QUIESCE:
2264 switch (oldstate) {
2265 case SDEV_RUNNING:
2266 case SDEV_OFFLINE:
1b8d2620 2267 case SDEV_TRANSPORT_OFFLINE:
1da177e4
LT
2268 break;
2269 default:
2270 goto illegal;
2271 }
2272 break;
2273
2274 case SDEV_OFFLINE:
1b8d2620 2275 case SDEV_TRANSPORT_OFFLINE:
1da177e4
LT
2276 switch (oldstate) {
2277 case SDEV_CREATED:
2278 case SDEV_RUNNING:
2279 case SDEV_QUIESCE:
2280 case SDEV_BLOCK:
2281 break;
2282 default:
2283 goto illegal;
2284 }
2285 break;
2286
2287 case SDEV_BLOCK:
2288 switch (oldstate) {
1da177e4 2289 case SDEV_RUNNING:
6f4267e3 2290 case SDEV_CREATED_BLOCK:
a33e5bfb 2291 case SDEV_OFFLINE:
6f4267e3
JB
2292 break;
2293 default:
2294 goto illegal;
2295 }
2296 break;
2297
2298 case SDEV_CREATED_BLOCK:
2299 switch (oldstate) {
2300 case SDEV_CREATED:
1da177e4
LT
2301 break;
2302 default:
2303 goto illegal;
2304 }
2305 break;
2306
2307 case SDEV_CANCEL:
2308 switch (oldstate) {
2309 case SDEV_CREATED:
2310 case SDEV_RUNNING:
9ea72909 2311 case SDEV_QUIESCE:
1da177e4 2312 case SDEV_OFFLINE:
1b8d2620 2313 case SDEV_TRANSPORT_OFFLINE:
1da177e4
LT
2314 break;
2315 default:
2316 goto illegal;
2317 }
2318 break;
2319
2320 case SDEV_DEL:
2321 switch (oldstate) {
309bd271
BK
2322 case SDEV_CREATED:
2323 case SDEV_RUNNING:
2324 case SDEV_OFFLINE:
1b8d2620 2325 case SDEV_TRANSPORT_OFFLINE:
1da177e4 2326 case SDEV_CANCEL:
255ee932 2327 case SDEV_BLOCK:
0516c08d 2328 case SDEV_CREATED_BLOCK:
1da177e4
LT
2329 break;
2330 default:
2331 goto illegal;
2332 }
2333 break;
2334
2335 }
2336 sdev->sdev_state = state;
2337 return 0;
2338
2339 illegal:
91921e01 2340 SCSI_LOG_ERROR_RECOVERY(1,
9ccfc756 2341 sdev_printk(KERN_ERR, sdev,
91921e01 2342 "Illegal state transition %s->%s",
9ccfc756
JB
2343 scsi_device_state_name(oldstate),
2344 scsi_device_state_name(state))
1da177e4
LT
2345 );
2346 return -EINVAL;
2347}
2348EXPORT_SYMBOL(scsi_device_set_state);
2349
a341cd0f
JG
2350/**
2351 * sdev_evt_emit - emit a single SCSI device uevent
2352 * @sdev: associated SCSI device
2353 * @evt: event to emit
2354 *
2355 * Send a single uevent (scsi_event) to the associated scsi_device.
2356 */
2357static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2358{
2359 int idx = 0;
2360 char *envp[3];
2361
2362 switch (evt->evt_type) {
2363 case SDEV_EVT_MEDIA_CHANGE:
2364 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2365 break;
279afdfe 2366 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
d3d32891 2367 scsi_rescan_device(&sdev->sdev_gendev);
279afdfe
EM
2368 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2369 break;
2370 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2371 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2372 break;
2373 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2374 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2375 break;
2376 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2377 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2378 break;
2379 case SDEV_EVT_LUN_CHANGE_REPORTED:
2380 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2381 break;
14c3e677
HR
2382 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2383 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
2384 break;
cf3431bb
HR
2385 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2386 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
2387 break;
a341cd0f
JG
2388 default:
2389 /* do nothing */
2390 break;
2391 }
2392
2393 envp[idx++] = NULL;
2394
2395 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2396}
2397
2398/**
2399 * sdev_evt_thread - send a uevent for each scsi event
2400 * @work: work struct for scsi_device
2401 *
2402 * Dispatch queued events to their associated scsi_device kobjects
2403 * as uevents.
2404 */
2405void scsi_evt_thread(struct work_struct *work)
2406{
2407 struct scsi_device *sdev;
279afdfe 2408 enum scsi_device_event evt_type;
a341cd0f
JG
2409 LIST_HEAD(event_list);
2410
2411 sdev = container_of(work, struct scsi_device, event_work);
2412
279afdfe
EM
2413 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2414 if (test_and_clear_bit(evt_type, sdev->pending_events))
2415 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2416
a341cd0f
JG
2417 while (1) {
2418 struct scsi_event *evt;
2419 struct list_head *this, *tmp;
2420 unsigned long flags;
2421
2422 spin_lock_irqsave(&sdev->list_lock, flags);
2423 list_splice_init(&sdev->event_list, &event_list);
2424 spin_unlock_irqrestore(&sdev->list_lock, flags);
2425
2426 if (list_empty(&event_list))
2427 break;
2428
2429 list_for_each_safe(this, tmp, &event_list) {
2430 evt = list_entry(this, struct scsi_event, node);
2431 list_del(&evt->node);
2432 scsi_evt_emit(sdev, evt);
2433 kfree(evt);
2434 }
2435 }
2436}
2437
2438/**
2439 * sdev_evt_send - send asserted event to uevent thread
2440 * @sdev: scsi_device event occurred on
2441 * @evt: event to send
2442 *
2443 * Assert scsi device event asynchronously.
2444 */
2445void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2446{
2447 unsigned long flags;
2448
4d1566ed
KS
2449#if 0
2450 /* FIXME: currently this check eliminates all media change events
2451 * for polled devices. Need to update to discriminate between AN
2452 * and polled events */
a341cd0f
JG
2453 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2454 kfree(evt);
2455 return;
2456 }
4d1566ed 2457#endif
a341cd0f
JG
2458
2459 spin_lock_irqsave(&sdev->list_lock, flags);
2460 list_add_tail(&evt->node, &sdev->event_list);
2461 schedule_work(&sdev->event_work);
2462 spin_unlock_irqrestore(&sdev->list_lock, flags);
2463}
2464EXPORT_SYMBOL_GPL(sdev_evt_send);
2465
2466/**
2467 * sdev_evt_alloc - allocate a new scsi event
2468 * @evt_type: type of event to allocate
2469 * @gfpflags: GFP flags for allocation
2470 *
2471 * Allocates and returns a new scsi_event.
2472 */
2473struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2474 gfp_t gfpflags)
2475{
2476 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2477 if (!evt)
2478 return NULL;
2479
2480 evt->evt_type = evt_type;
2481 INIT_LIST_HEAD(&evt->node);
2482
2483 /* evt_type-specific initialization, if any */
2484 switch (evt_type) {
2485 case SDEV_EVT_MEDIA_CHANGE:
279afdfe
EM
2486 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2487 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2488 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2489 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2490 case SDEV_EVT_LUN_CHANGE_REPORTED:
14c3e677 2491 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
cf3431bb 2492 case SDEV_EVT_POWER_ON_RESET_OCCURRED:
a341cd0f
JG
2493 default:
2494 /* do nothing */
2495 break;
2496 }
2497
2498 return evt;
2499}
2500EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2501
2502/**
2503 * sdev_evt_send_simple - send asserted event to uevent thread
2504 * @sdev: scsi_device event occurred on
2505 * @evt_type: type of event to send
2506 * @gfpflags: GFP flags for allocation
2507 *
2508 * Assert scsi device event asynchronously, given an event type.
2509 */
2510void sdev_evt_send_simple(struct scsi_device *sdev,
2511 enum scsi_device_event evt_type, gfp_t gfpflags)
2512{
2513 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2514 if (!evt) {
2515 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2516 evt_type);
2517 return;
2518 }
2519
2520 sdev_evt_send(sdev, evt);
2521}
2522EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2523
1da177e4
LT
2524/**
2525 * scsi_device_quiesce - Block user issued commands.
2526 * @sdev: scsi device to quiesce.
2527 *
2528 * This works by trying to transition to the SDEV_QUIESCE state
2529 * (which must be a legal transition). When the device is in this
2530 * state, only special requests will be accepted, all others will
2531 * be deferred. Since special requests may also be requeued requests,
2532 * a successful return doesn't guarantee the device will be
2533 * totally quiescent.
2534 *
2535 * Must be called with user context, may sleep.
2536 *
2537 * Returns zero if unsuccessful or an error if not.
eb44820c 2538 */
1da177e4
LT
2539int
2540scsi_device_quiesce(struct scsi_device *sdev)
2541{
3a0a5299 2542 struct request_queue *q = sdev->request_queue;
0db6ca8a
BVA
2543 int err;
2544
3a0a5299
BVA
2545 /*
2546 * It is allowed to call scsi_device_quiesce() multiple times from
2547 * the same context but concurrent scsi_device_quiesce() calls are
2548 * not allowed.
2549 */
2550 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);
2551
cd84a62e
BVA
2552 if (sdev->quiesced_by == current)
2553 return 0;
2554
2555 blk_set_pm_only(q);
3a0a5299
BVA
2556
2557 blk_mq_freeze_queue(q);
2558 /*
cd84a62e 2559 * Ensure that the effect of blk_set_pm_only() will be visible
3a0a5299
BVA
2560 * for percpu_ref_tryget() callers that occur after the queue
2561 * unfreeze even if the queue was already frozen before this function
2562 * was called. See also https://lwn.net/Articles/573497/.
2563 */
2564 synchronize_rcu();
2565 blk_mq_unfreeze_queue(q);
2566
0db6ca8a
BVA
2567 mutex_lock(&sdev->state_mutex);
2568 err = scsi_device_set_state(sdev, SDEV_QUIESCE);
3a0a5299
BVA
2569 if (err == 0)
2570 sdev->quiesced_by = current;
2571 else
cd84a62e 2572 blk_clear_pm_only(q);
0db6ca8a
BVA
2573 mutex_unlock(&sdev->state_mutex);
2574
3a0a5299 2575 return err;
1da177e4
LT
2576}
2577EXPORT_SYMBOL(scsi_device_quiesce);
2578
2579/**
2580 * scsi_device_resume - Restart user issued commands to a quiesced device.
2581 * @sdev: scsi device to resume.
2582 *
2583 * Moves the device from quiesced back to running and restarts the
2584 * queues.
2585 *
2586 * Must be called with user context, may sleep.
eb44820c 2587 */
a7a20d10 2588void scsi_device_resume(struct scsi_device *sdev)
1da177e4 2589{
a7a20d10
DW
2590 /* check if the device state was mutated prior to resume, and if
2591 * so assume the state is being managed elsewhere (for example
2592 * device deleted during suspend)
2593 */
0db6ca8a 2594 mutex_lock(&sdev->state_mutex);
3a0a5299
BVA
2595 WARN_ON_ONCE(!sdev->quiesced_by);
2596 sdev->quiesced_by = NULL;
cd84a62e 2597 blk_clear_pm_only(sdev->request_queue);
3a0a5299
BVA
2598 if (sdev->sdev_state == SDEV_QUIESCE)
2599 scsi_device_set_state(sdev, SDEV_RUNNING);
0db6ca8a 2600 mutex_unlock(&sdev->state_mutex);
1da177e4
LT
2601}
2602EXPORT_SYMBOL(scsi_device_resume);
2603
2604static void
2605device_quiesce_fn(struct scsi_device *sdev, void *data)
2606{
2607 scsi_device_quiesce(sdev);
2608}
2609
2610void
2611scsi_target_quiesce(struct scsi_target *starget)
2612{
2613 starget_for_each_device(starget, NULL, device_quiesce_fn);
2614}
2615EXPORT_SYMBOL(scsi_target_quiesce);
2616
2617static void
2618device_resume_fn(struct scsi_device *sdev, void *data)
2619{
2620 scsi_device_resume(sdev);
2621}
2622
2623void
2624scsi_target_resume(struct scsi_target *starget)
2625{
2626 starget_for_each_device(starget, NULL, device_resume_fn);
2627}
2628EXPORT_SYMBOL(scsi_target_resume);
2629
2630/**
551eb598
BVA
2631 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
2632 * @sdev: device to block
1da177e4 2633 *
551eb598 2634 * Pause SCSI command processing on the specified device. Does not sleep.
1da177e4 2635 *
551eb598 2636 * Returns zero if successful or a negative error code upon failure.
669f0441 2637 *
551eb598
BVA
2638 * Notes:
2639 * This routine transitions the device to the SDEV_BLOCK state (which must be
2640 * a legal transition). When the device is in this state, command processing
2641 * is paused until the device leaves the SDEV_BLOCK state. See also
2642 * scsi_internal_device_unblock_nowait().
eb44820c 2643 */
551eb598 2644int scsi_internal_device_block_nowait(struct scsi_device *sdev)
1da177e4 2645{
165125e1 2646 struct request_queue *q = sdev->request_queue;
1da177e4
LT
2647 int err = 0;
2648
2649 err = scsi_device_set_state(sdev, SDEV_BLOCK);
6f4267e3
JB
2650 if (err) {
2651 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2652
2653 if (err)
2654 return err;
2655 }
1da177e4
LT
2656
2657 /*
2658 * The device has transitioned to SDEV_BLOCK. Stop the
2659 * block layer from calling the midlayer with this device's
2660 * request queue.
2661 */
f664a3cc 2662 blk_mq_quiesce_queue_nowait(q);
1da177e4
LT
2663 return 0;
2664}
551eb598
BVA
2665EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);
2666
1da177e4 2667/**
551eb598
BVA
2668 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
2669 * @sdev: device to block
2670 *
2671 * Pause SCSI command processing on the specified device and wait until all
2672 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
1da177e4 2673 *
551eb598 2674 * Returns zero if successful or a negative error code upon failure.
1da177e4 2675 *
551eb598
BVA
2676 * Note:
2677 * This routine transitions the device to the SDEV_BLOCK state (which must be
2678 * a legal transition). When the device is in this state, command processing
2679 * is paused until the device leaves the SDEV_BLOCK state. See also
2680 * scsi_internal_device_unblock().
1da177e4 2681 *
551eb598
BVA
2682 * To do: avoid that scsi_send_eh_cmnd() calls queuecommand() after
2683 * scsi_internal_device_block() has blocked a SCSI device and also
2684 * remove the rport mutex lock and unlock calls from srp_queuecommand().
eb44820c 2685 */
551eb598 2686static int scsi_internal_device_block(struct scsi_device *sdev)
1da177e4 2687{
551eb598
BVA
2688 struct request_queue *q = sdev->request_queue;
2689 int err;
2690
0db6ca8a 2691 mutex_lock(&sdev->state_mutex);
551eb598 2692 err = scsi_internal_device_block_nowait(sdev);
f664a3cc
JA
2693 if (err == 0)
2694 blk_mq_quiesce_queue(q);
0db6ca8a
BVA
2695 mutex_unlock(&sdev->state_mutex);
2696
551eb598
BVA
2697 return err;
2698}
1da177e4 2699
66483a4a
BVA
2700void scsi_start_queue(struct scsi_device *sdev)
2701{
2702 struct request_queue *q = sdev->request_queue;
5d9fb5cc 2703
f664a3cc 2704 blk_mq_unquiesce_queue(q);
66483a4a
BVA
2705}
2706
1da177e4 2707/**
43f7571b 2708 * scsi_internal_device_unblock_nowait - resume a device after a block request
1da177e4 2709 * @sdev: device to resume
43f7571b 2710 * @new_state: state to set the device to after unblocking
1da177e4 2711 *
43f7571b
BVA
2712 * Restart the device queue for a previously suspended SCSI device. Does not
2713 * sleep.
1da177e4 2714 *
43f7571b 2715 * Returns zero if successful or a negative error code upon failure.
1da177e4 2716 *
43f7571b
BVA
2717 * Notes:
2718 * This routine transitions the device to the SDEV_RUNNING state or to one of
2719 * the offline states (which must be a legal transition) allowing the midlayer
2720 * to goose the queue for this device.
eb44820c 2721 */
43f7571b
BVA
2722int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
2723 enum scsi_device_state new_state)
1da177e4 2724{
5d9fb5cc
MC
2725 /*
2726 * Try to transition the scsi device to SDEV_RUNNING or one of the
2727 * offlined states and goose the device queue if successful.
1da177e4 2728 */
8cd1ec78
HR
2729 switch (sdev->sdev_state) {
2730 case SDEV_BLOCK:
2731 case SDEV_TRANSPORT_OFFLINE:
5d9fb5cc 2732 sdev->sdev_state = new_state;
8cd1ec78
HR
2733 break;
2734 case SDEV_CREATED_BLOCK:
5d9fb5cc
MC
2735 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2736 new_state == SDEV_OFFLINE)
2737 sdev->sdev_state = new_state;
2738 else
2739 sdev->sdev_state = SDEV_CREATED;
8cd1ec78
HR
2740 break;
2741 case SDEV_CANCEL:
2742 case SDEV_OFFLINE:
2743 break;
2744 default:
5c10e63c 2745 return -EINVAL;
8cd1ec78 2746 }
66483a4a 2747 scsi_start_queue(sdev);
1da177e4
LT
2748
2749 return 0;
2750}
43f7571b
BVA
2751EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);
2752
2753/**
2754 * scsi_internal_device_unblock - resume a device after a block request
2755 * @sdev: device to resume
2756 * @new_state: state to set the device to after unblocking
2757 *
2758 * Restart the device queue for a previously suspended SCSI device. May sleep.
2759 *
2760 * Returns zero if successful or a negative error code upon failure.
2761 *
2762 * Notes:
2763 * This routine transitions the device to the SDEV_RUNNING state or to one of
2764 * the offline states (which must be a legal transition) allowing the midlayer
2765 * to goose the queue for this device.
2766 */
2767static int scsi_internal_device_unblock(struct scsi_device *sdev,
2768 enum scsi_device_state new_state)
2769{
0db6ca8a
BVA
2770 int ret;
2771
2772 mutex_lock(&sdev->state_mutex);
2773 ret = scsi_internal_device_unblock_nowait(sdev, new_state);
2774 mutex_unlock(&sdev->state_mutex);
2775
2776 return ret;
43f7571b 2777}
1da177e4
LT
2778
2779static void
2780device_block(struct scsi_device *sdev, void *data)
2781{
551eb598 2782 scsi_internal_device_block(sdev);
1da177e4
LT
2783}
2784
2785static int
2786target_block(struct device *dev, void *data)
2787{
2788 if (scsi_is_target_device(dev))
2789 starget_for_each_device(to_scsi_target(dev), NULL,
2790 device_block);
2791 return 0;
2792}
2793
2794void
2795scsi_target_block(struct device *dev)
2796{
2797 if (scsi_is_target_device(dev))
2798 starget_for_each_device(to_scsi_target(dev), NULL,
2799 device_block);
2800 else
2801 device_for_each_child(dev, NULL, target_block);
2802}
2803EXPORT_SYMBOL_GPL(scsi_target_block);
2804
2805static void
2806device_unblock(struct scsi_device *sdev, void *data)
2807{
5d9fb5cc 2808 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
1da177e4
LT
2809}
2810
2811static int
2812target_unblock(struct device *dev, void *data)
2813{
2814 if (scsi_is_target_device(dev))
5d9fb5cc 2815 starget_for_each_device(to_scsi_target(dev), data,
1da177e4
LT
2816 device_unblock);
2817 return 0;
2818}
2819
2820void
5d9fb5cc 2821scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
1da177e4
LT
2822{
2823 if (scsi_is_target_device(dev))
5d9fb5cc 2824 starget_for_each_device(to_scsi_target(dev), &new_state,
1da177e4
LT
2825 device_unblock);
2826 else
5d9fb5cc 2827 device_for_each_child(dev, &new_state, target_unblock);
1da177e4
LT
2828}
2829EXPORT_SYMBOL_GPL(scsi_target_unblock);
cdb8c2a6
GL
2830
2831/**
2832 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
eb44820c 2833 * @sgl: scatter-gather list
cdb8c2a6
GL
2834 * @sg_count: number of segments in sg
2835 * @offset: offset in bytes into sg, on return offset into the mapped area
2836 * @len: bytes to map, on return number of bytes mapped
2837 *
2838 * Returns virtual address of the start of the mapped page
2839 */
c6132da1 2840void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
cdb8c2a6
GL
2841 size_t *offset, size_t *len)
2842{
2843 int i;
2844 size_t sg_len = 0, len_complete = 0;
c6132da1 2845 struct scatterlist *sg;
cdb8c2a6
GL
2846 struct page *page;
2847
22cfefb5
AM
2848 WARN_ON(!irqs_disabled());
2849
c6132da1 2850 for_each_sg(sgl, sg, sg_count, i) {
cdb8c2a6 2851 len_complete = sg_len; /* Complete sg-entries */
c6132da1 2852 sg_len += sg->length;
cdb8c2a6
GL
2853 if (sg_len > *offset)
2854 break;
2855 }
2856
2857 if (unlikely(i == sg_count)) {
169e1a2a
AM
2858 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2859 "elements %d\n",
cadbd4a5 2860 __func__, sg_len, *offset, sg_count);
cdb8c2a6
GL
2861 WARN_ON(1);
2862 return NULL;
2863 }
2864
2865 /* Offset starting from the beginning of first page in this sg-entry */
c6132da1 2866 *offset = *offset - len_complete + sg->offset;
cdb8c2a6
GL
2867
2868 /* Assumption: contiguous pages can be accessed as "page + i" */
45711f1a 2869 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
cdb8c2a6
GL
2870 *offset &= ~PAGE_MASK;
2871
2872 /* Bytes in this sg-entry from *offset to the end of the page */
2873 sg_len = PAGE_SIZE - *offset;
2874 if (*len > sg_len)
2875 *len = sg_len;
2876
77dfce07 2877 return kmap_atomic(page);
cdb8c2a6
GL
2878}
2879EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2880
2881/**
eb44820c 2882 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
cdb8c2a6
GL
2883 * @virt: virtual address to be unmapped
2884 */
2885void scsi_kunmap_atomic_sg(void *virt)
2886{
77dfce07 2887 kunmap_atomic(virt);
cdb8c2a6
GL
2888}
2889EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
6f4c827e
AL
2890
2891void sdev_disable_disk_events(struct scsi_device *sdev)
2892{
2893 atomic_inc(&sdev->disk_events_disable_depth);
2894}
2895EXPORT_SYMBOL(sdev_disable_disk_events);
2896
2897void sdev_enable_disk_events(struct scsi_device *sdev)
2898{
2899 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2900 return;
2901 atomic_dec(&sdev->disk_events_disable_depth);
2902}
2903EXPORT_SYMBOL(sdev_enable_disk_events);
9983bed3
HR
2904
2905/**
2906 * scsi_vpd_lun_id - return a unique device identification
2907 * @sdev: SCSI device
2908 * @id: buffer for the identification
2909 * @id_len: length of the buffer
2910 *
2911 * Copies a unique device identification into @id based
2912 * on the information in the VPD page 0x83 of the device.
2913 * The string will be formatted as a SCSI name string.
2914 *
2915 * Returns the length of the identification or error on failure.
2916 * If the identifier is longer than the supplied buffer the actual
2917 * identifier length is returned and the buffer is not zero-padded.
2918 */
2919int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
2920{
2921 u8 cur_id_type = 0xff;
2922 u8 cur_id_size = 0;
ccf1e004
BVA
2923 const unsigned char *d, *cur_id_str;
2924 const struct scsi_vpd *vpd_pg83;
9983bed3
HR
2925 int id_size = -EINVAL;
2926
2927 rcu_read_lock();
2928 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
2929 if (!vpd_pg83) {
2930 rcu_read_unlock();
2931 return -ENXIO;
2932 }
2933
2934 /*
2935 * Look for the correct descriptor.
2936 * Order of preference for lun descriptor:
2937 * - SCSI name string
2938 * - NAA IEEE Registered Extended
2939 * - EUI-64 based 16-byte
2940 * - EUI-64 based 12-byte
2941 * - NAA IEEE Registered
2942 * - NAA IEEE Extended
d230823a 2943 * - T10 Vendor ID
9983bed3
HR
2944 * as longer descriptors reduce the likelyhood
2945 * of identification clashes.
2946 */
2947
2948 /* The id string must be at least 20 bytes + terminating NULL byte */
2949 if (id_len < 21) {
2950 rcu_read_unlock();
2951 return -EINVAL;
2952 }
2953
2954 memset(id, 0, id_len);
ccf1e004
BVA
2955 d = vpd_pg83->data + 4;
2956 while (d < vpd_pg83->data + vpd_pg83->len) {
9983bed3
HR
2957 /* Skip designators not referring to the LUN */
2958 if ((d[1] & 0x30) != 0x00)
2959 goto next_desig;
2960
2961 switch (d[1] & 0xf) {
d230823a
HR
2962 case 0x1:
2963 /* T10 Vendor ID */
2964 if (cur_id_size > d[3])
2965 break;
2966 /* Prefer anything */
2967 if (cur_id_type > 0x01 && cur_id_type != 0xff)
2968 break;
2969 cur_id_size = d[3];
2970 if (cur_id_size + 4 > id_len)
2971 cur_id_size = id_len - 4;
2972 cur_id_str = d + 4;
2973 cur_id_type = d[1] & 0xf;
2974 id_size = snprintf(id, id_len, "t10.%*pE",
2975 cur_id_size, cur_id_str);
2976 break;
9983bed3
HR
2977 case 0x2:
2978 /* EUI-64 */
2979 if (cur_id_size > d[3])
2980 break;
2981 /* Prefer NAA IEEE Registered Extended */
2982 if (cur_id_type == 0x3 &&
2983 cur_id_size == d[3])
2984 break;
2985 cur_id_size = d[3];
2986 cur_id_str = d + 4;
2987 cur_id_type = d[1] & 0xf;
2988 switch (cur_id_size) {
2989 case 8:
2990 id_size = snprintf(id, id_len,
2991 "eui.%8phN",
2992 cur_id_str);
2993 break;
2994 case 12:
2995 id_size = snprintf(id, id_len,
2996 "eui.%12phN",
2997 cur_id_str);
2998 break;
2999 case 16:
3000 id_size = snprintf(id, id_len,
3001 "eui.%16phN",
3002 cur_id_str);
3003 break;
3004 default:
3005 cur_id_size = 0;
3006 break;
3007 }
3008 break;
3009 case 0x3:
3010 /* NAA */
3011 if (cur_id_size > d[3])
3012 break;
3013 cur_id_size = d[3];
3014 cur_id_str = d + 4;
3015 cur_id_type = d[1] & 0xf;
3016 switch (cur_id_size) {
3017 case 8:
3018 id_size = snprintf(id, id_len,
3019 "naa.%8phN",
3020 cur_id_str);
3021 break;
3022 case 16:
3023 id_size = snprintf(id, id_len,
3024 "naa.%16phN",
3025 cur_id_str);
3026 break;
3027 default:
3028 cur_id_size = 0;
3029 break;
3030 }
3031 break;
3032 case 0x8:
3033 /* SCSI name string */
3034 if (cur_id_size + 4 > d[3])
3035 break;
3036 /* Prefer others for truncated descriptor */
3037 if (cur_id_size && d[3] > id_len)
3038 break;
3039 cur_id_size = id_size = d[3];
3040 cur_id_str = d + 4;
3041 cur_id_type = d[1] & 0xf;
3042 if (cur_id_size >= id_len)
3043 cur_id_size = id_len - 1;
3044 memcpy(id, cur_id_str, cur_id_size);
3045 /* Decrease priority for truncated descriptor */
3046 if (cur_id_size != id_size)
3047 cur_id_size = 6;
3048 break;
3049 default:
3050 break;
3051 }
3052next_desig:
3053 d += d[3] + 4;
3054 }
3055 rcu_read_unlock();
3056
3057 return id_size;
3058}
3059EXPORT_SYMBOL(scsi_vpd_lun_id);
a8aa3978
HR
3060
3061/*
3062 * scsi_vpd_tpg_id - return a target port group identifier
3063 * @sdev: SCSI device
3064 *
3065 * Returns the Target Port Group identifier from the information
3066 * froom VPD page 0x83 of the device.
3067 *
3068 * Returns the identifier or error on failure.
3069 */
3070int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
3071{
ccf1e004
BVA
3072 const unsigned char *d;
3073 const struct scsi_vpd *vpd_pg83;
a8aa3978
HR
3074 int group_id = -EAGAIN, rel_port = -1;
3075
3076 rcu_read_lock();
3077 vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
3078 if (!vpd_pg83) {
3079 rcu_read_unlock();
3080 return -ENXIO;
3081 }
3082
ccf1e004
BVA
3083 d = vpd_pg83->data + 4;
3084 while (d < vpd_pg83->data + vpd_pg83->len) {
a8aa3978
HR
3085 switch (d[1] & 0xf) {
3086 case 0x4:
3087 /* Relative target port */
3088 rel_port = get_unaligned_be16(&d[6]);
3089 break;
3090 case 0x5:
3091 /* Target port group */
3092 group_id = get_unaligned_be16(&d[6]);
3093 break;
3094 default:
3095 break;
3096 }
3097 d += d[3] + 4;
3098 }
3099 rcu_read_unlock();
3100
3101 if (group_id >= 0 && rel_id && rel_port != -1)
3102 *rel_id = rel_port;
3103
3104 return group_id;
3105}
3106EXPORT_SYMBOL(scsi_vpd_tpg_id);