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