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