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