]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/scsi/scsi_lib.c
[SCSI] Let scsi_cmnd->cmnd use request->cmd buffer
[mirror_ubuntu-artful-kernel.git] / drivers / scsi / scsi_lib.c
CommitLineData
1da177e4
LT
1/*
2 * scsi_lib.c Copyright (C) 1999 Eric Youngdale
3 *
4 * SCSI queueing library.
5 * Initial versions: Eric Youngdale (eric@andante.org).
6 * Based upon conversations with large numbers
7 * of people at Linux Expo.
8 */
9
10#include <linux/bio.h>
d3f46f39 11#include <linux/bitops.h>
1da177e4
LT
12#include <linux/blkdev.h>
13#include <linux/completion.h>
14#include <linux/kernel.h>
15#include <linux/mempool.h>
16#include <linux/slab.h>
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>
1da177e4
LT
22
23#include <scsi/scsi.h>
beb40487 24#include <scsi/scsi_cmnd.h>
1da177e4
LT
25#include <scsi/scsi_dbg.h>
26#include <scsi/scsi_device.h>
27#include <scsi/scsi_driver.h>
28#include <scsi/scsi_eh.h>
29#include <scsi/scsi_host.h>
1da177e4
LT
30
31#include "scsi_priv.h"
32#include "scsi_logging.h"
33
34
6391a113 35#define SG_MEMPOOL_NR ARRAY_SIZE(scsi_sg_pools)
5972511b 36#define SG_MEMPOOL_SIZE 2
1da177e4
LT
37
38struct scsi_host_sg_pool {
39 size_t size;
a8474ce2 40 char *name;
e18b890b 41 struct kmem_cache *slab;
1da177e4
LT
42 mempool_t *pool;
43};
44
d3f46f39
JB
45#define SP(x) { x, "sgpool-" __stringify(x) }
46#if (SCSI_MAX_SG_SEGMENTS < 32)
47#error SCSI_MAX_SG_SEGMENTS is too small (must be 32 or greater)
48#endif
52c1da39 49static struct scsi_host_sg_pool scsi_sg_pools[] = {
1da177e4
LT
50 SP(8),
51 SP(16),
fd820f40 52#if (SCSI_MAX_SG_SEGMENTS > 32)
d3f46f39 53 SP(32),
fd820f40 54#if (SCSI_MAX_SG_SEGMENTS > 64)
d3f46f39
JB
55 SP(64),
56#if (SCSI_MAX_SG_SEGMENTS > 128)
1da177e4 57 SP(128),
d3f46f39
JB
58#if (SCSI_MAX_SG_SEGMENTS > 256)
59#error SCSI_MAX_SG_SEGMENTS is too large (256 MAX)
fd820f40
FT
60#endif
61#endif
62#endif
d3f46f39
JB
63#endif
64 SP(SCSI_MAX_SG_SEGMENTS)
a8474ce2 65};
1da177e4
LT
66#undef SP
67
6f9a35e2
BH
68static struct kmem_cache *scsi_bidi_sdb_cache;
69
a1bf9d1d 70static void scsi_run_queue(struct request_queue *q);
e91442b6
JB
71
72/*
73 * Function: scsi_unprep_request()
74 *
75 * Purpose: Remove all preparation done for a request, including its
76 * associated scsi_cmnd, so that it can be requeued.
77 *
78 * Arguments: req - request to unprepare
79 *
80 * Lock status: Assumed that no locks are held upon entry.
81 *
82 * Returns: Nothing.
83 */
84static void scsi_unprep_request(struct request *req)
85{
86 struct scsi_cmnd *cmd = req->special;
87
4aff5e23 88 req->cmd_flags &= ~REQ_DONTPREP;
beb40487 89 req->special = NULL;
e91442b6 90
e91442b6
JB
91 scsi_put_command(cmd);
92}
a1bf9d1d 93
1da177e4
LT
94/*
95 * Function: scsi_queue_insert()
96 *
97 * Purpose: Insert a command in the midlevel queue.
98 *
99 * Arguments: cmd - command that we are adding to queue.
100 * reason - why we are inserting command to queue.
101 *
102 * Lock status: Assumed that lock is not held upon entry.
103 *
104 * Returns: Nothing.
105 *
106 * Notes: We do this for one of two cases. Either the host is busy
107 * and it cannot accept any more commands for the time being,
108 * or the device returned QUEUE_FULL and can accept no more
109 * commands.
110 * Notes: This could be called either from an interrupt context or a
111 * normal process context.
112 */
113int scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
114{
115 struct Scsi_Host *host = cmd->device->host;
116 struct scsi_device *device = cmd->device;
a1bf9d1d
TH
117 struct request_queue *q = device->request_queue;
118 unsigned long flags;
1da177e4
LT
119
120 SCSI_LOG_MLQUEUE(1,
121 printk("Inserting command %p into mlqueue\n", cmd));
122
123 /*
d8c37e7b 124 * Set the appropriate busy bit for the device/host.
1da177e4
LT
125 *
126 * If the host/device isn't busy, assume that something actually
127 * completed, and that we should be able to queue a command now.
128 *
129 * Note that the prior mid-layer assumption that any host could
130 * always queue at least one command is now broken. The mid-layer
131 * will implement a user specifiable stall (see
132 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
133 * if a command is requeued with no other commands outstanding
134 * either for the device or for the host.
135 */
136 if (reason == SCSI_MLQUEUE_HOST_BUSY)
137 host->host_blocked = host->max_host_blocked;
138 else if (reason == SCSI_MLQUEUE_DEVICE_BUSY)
139 device->device_blocked = device->max_device_blocked;
140
1da177e4
LT
141 /*
142 * Decrement the counters, since these commands are no longer
143 * active on the host/device.
144 */
145 scsi_device_unbusy(device);
146
147 /*
a1bf9d1d
TH
148 * Requeue this command. It will go before all other commands
149 * that are already in the queue.
1da177e4
LT
150 *
151 * NOTE: there is magic here about the way the queue is plugged if
152 * we have no outstanding commands.
153 *
a1bf9d1d 154 * Although we *don't* plug the queue, we call the request
1da177e4
LT
155 * function. The SCSI request function detects the blocked condition
156 * and plugs the queue appropriately.
a1bf9d1d
TH
157 */
158 spin_lock_irqsave(q->queue_lock, flags);
59897dad 159 blk_requeue_request(q, cmd->request);
a1bf9d1d
TH
160 spin_unlock_irqrestore(q->queue_lock, flags);
161
162 scsi_run_queue(q);
163
1da177e4
LT
164 return 0;
165}
166
39216033 167/**
33aa687d 168 * scsi_execute - insert request and wait for the result
39216033
JB
169 * @sdev: scsi device
170 * @cmd: scsi command
171 * @data_direction: data direction
172 * @buffer: data buffer
173 * @bufflen: len of buffer
174 * @sense: optional sense buffer
175 * @timeout: request timeout in seconds
176 * @retries: number of times to retry request
33aa687d 177 * @flags: or into request flags;
39216033 178 *
59c51591 179 * returns the req->errors value which is the scsi_cmnd result
ea73a9f2 180 * field.
eb44820c 181 */
33aa687d
JB
182int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
183 int data_direction, void *buffer, unsigned bufflen,
184 unsigned char *sense, int timeout, int retries, int flags)
39216033
JB
185{
186 struct request *req;
187 int write = (data_direction == DMA_TO_DEVICE);
188 int ret = DRIVER_ERROR << 24;
189
190 req = blk_get_request(sdev->request_queue, write, __GFP_WAIT);
191
192 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
193 buffer, bufflen, __GFP_WAIT))
194 goto out;
195
196 req->cmd_len = COMMAND_SIZE(cmd[0]);
197 memcpy(req->cmd, cmd, req->cmd_len);
198 req->sense = sense;
199 req->sense_len = 0;
17e01f21 200 req->retries = retries;
39216033 201 req->timeout = timeout;
4aff5e23
JA
202 req->cmd_type = REQ_TYPE_BLOCK_PC;
203 req->cmd_flags |= flags | REQ_QUIET | REQ_PREEMPT;
39216033
JB
204
205 /*
206 * head injection *required* here otherwise quiesce won't work
207 */
208 blk_execute_rq(req->q, NULL, req, 1);
209
210 ret = req->errors;
211 out:
212 blk_put_request(req);
213
214 return ret;
215}
33aa687d 216EXPORT_SYMBOL(scsi_execute);
39216033 217
ea73a9f2
JB
218
219int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
220 int data_direction, void *buffer, unsigned bufflen,
221 struct scsi_sense_hdr *sshdr, int timeout, int retries)
222{
223 char *sense = NULL;
1ccb48bb 224 int result;
225
ea73a9f2 226 if (sshdr) {
24669f75 227 sense = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
ea73a9f2
JB
228 if (!sense)
229 return DRIVER_ERROR << 24;
ea73a9f2 230 }
1ccb48bb 231 result = scsi_execute(sdev, cmd, data_direction, buffer, bufflen,
24669f75 232 sense, timeout, retries, 0);
ea73a9f2 233 if (sshdr)
e514385b 234 scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, sshdr);
ea73a9f2
JB
235
236 kfree(sense);
237 return result;
238}
239EXPORT_SYMBOL(scsi_execute_req);
240
6e68af66
MC
241struct scsi_io_context {
242 void *data;
243 void (*done)(void *data, char *sense, int result, int resid);
244 char sense[SCSI_SENSE_BUFFERSIZE];
245};
246
e18b890b 247static struct kmem_cache *scsi_io_context_cache;
aa7b5cd7 248
e650c305 249static void scsi_end_async(struct request *req, int uptodate)
6e68af66
MC
250{
251 struct scsi_io_context *sioc = req->end_io_data;
252
253 if (sioc->done)
254 sioc->done(sioc->data, sioc->sense, req->errors, req->data_len);
255
aa7b5cd7 256 kmem_cache_free(scsi_io_context_cache, sioc);
6e68af66
MC
257 __blk_put_request(req->q, req);
258}
259
260static int scsi_merge_bio(struct request *rq, struct bio *bio)
261{
262 struct request_queue *q = rq->q;
263
264 bio->bi_flags &= ~(1 << BIO_SEG_VALID);
265 if (rq_data_dir(rq) == WRITE)
266 bio->bi_rw |= (1 << BIO_RW);
267 blk_queue_bounce(q, &bio);
268
3001ca77 269 return blk_rq_append_bio(q, rq, bio);
6e68af66
MC
270}
271
6712ecf8 272static void scsi_bi_endio(struct bio *bio, int error)
6e68af66 273{
6e68af66 274 bio_put(bio);
6e68af66
MC
275}
276
277/**
278 * scsi_req_map_sg - map a scatterlist into a request
279 * @rq: request to fill
eb44820c 280 * @sgl: scatterlist
6e68af66
MC
281 * @nsegs: number of elements
282 * @bufflen: len of buffer
283 * @gfp: memory allocation flags
284 *
285 * scsi_req_map_sg maps a scatterlist into a request so that the
286 * request can be sent to the block layer. We do not trust the scatterlist
287 * sent to use, as some ULDs use that struct to only organize the pages.
288 */
289static int scsi_req_map_sg(struct request *rq, struct scatterlist *sgl,
290 int nsegs, unsigned bufflen, gfp_t gfp)
291{
292 struct request_queue *q = rq->q;
f5235962 293 int nr_pages = (bufflen + sgl[0].offset + PAGE_SIZE - 1) >> PAGE_SHIFT;
bd441dea 294 unsigned int data_len = bufflen, len, bytes, off;
c6132da1 295 struct scatterlist *sg;
6e68af66
MC
296 struct page *page;
297 struct bio *bio = NULL;
298 int i, err, nr_vecs = 0;
299
c6132da1 300 for_each_sg(sgl, sg, nsegs, i) {
45711f1a 301 page = sg_page(sg);
c6132da1
JA
302 off = sg->offset;
303 len = sg->length;
6e68af66 304
bd441dea
MC
305 while (len > 0 && data_len > 0) {
306 /*
307 * sg sends a scatterlist that is larger than
308 * the data_len it wants transferred for certain
309 * IO sizes
310 */
6e68af66 311 bytes = min_t(unsigned int, len, PAGE_SIZE - off);
bd441dea 312 bytes = min(bytes, data_len);
6e68af66
MC
313
314 if (!bio) {
315 nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
316 nr_pages -= nr_vecs;
317
318 bio = bio_alloc(gfp, nr_vecs);
319 if (!bio) {
320 err = -ENOMEM;
321 goto free_bios;
322 }
323 bio->bi_end_io = scsi_bi_endio;
324 }
325
326 if (bio_add_pc_page(q, bio, page, bytes, off) !=
327 bytes) {
328 bio_put(bio);
329 err = -EINVAL;
330 goto free_bios;
331 }
332
333 if (bio->bi_vcnt >= nr_vecs) {
334 err = scsi_merge_bio(rq, bio);
335 if (err) {
6712ecf8 336 bio_endio(bio, 0);
6e68af66
MC
337 goto free_bios;
338 }
339 bio = NULL;
340 }
341
342 page++;
343 len -= bytes;
bd441dea 344 data_len -=bytes;
6e68af66
MC
345 off = 0;
346 }
347 }
348
349 rq->buffer = rq->data = NULL;
bd441dea 350 rq->data_len = bufflen;
6e68af66
MC
351 return 0;
352
353free_bios:
354 while ((bio = rq->bio) != NULL) {
355 rq->bio = bio->bi_next;
356 /*
357 * call endio instead of bio_put incase it was bounced
358 */
6712ecf8 359 bio_endio(bio, 0);
6e68af66
MC
360 }
361
362 return err;
363}
364
365/**
366 * scsi_execute_async - insert request
367 * @sdev: scsi device
368 * @cmd: scsi command
bb1d1073 369 * @cmd_len: length of scsi cdb
eb44820c 370 * @data_direction: DMA_TO_DEVICE, DMA_FROM_DEVICE, or DMA_NONE
6e68af66
MC
371 * @buffer: data buffer (this can be a kernel buffer or scatterlist)
372 * @bufflen: len of buffer
373 * @use_sg: if buffer is a scatterlist this is the number of elements
374 * @timeout: request timeout in seconds
375 * @retries: number of times to retry request
eb44820c
RL
376 * @privdata: data passed to done()
377 * @done: callback function when done
378 * @gfp: memory allocation flags
379 */
6e68af66 380int scsi_execute_async(struct scsi_device *sdev, const unsigned char *cmd,
bb1d1073 381 int cmd_len, int data_direction, void *buffer, unsigned bufflen,
6e68af66
MC
382 int use_sg, int timeout, int retries, void *privdata,
383 void (*done)(void *, char *, int, int), gfp_t gfp)
384{
385 struct request *req;
386 struct scsi_io_context *sioc;
387 int err = 0;
388 int write = (data_direction == DMA_TO_DEVICE);
389
c3762229 390 sioc = kmem_cache_zalloc(scsi_io_context_cache, gfp);
6e68af66
MC
391 if (!sioc)
392 return DRIVER_ERROR << 24;
393
394 req = blk_get_request(sdev->request_queue, write, gfp);
395 if (!req)
396 goto free_sense;
4aff5e23
JA
397 req->cmd_type = REQ_TYPE_BLOCK_PC;
398 req->cmd_flags |= REQ_QUIET;
6e68af66
MC
399
400 if (use_sg)
401 err = scsi_req_map_sg(req, buffer, use_sg, bufflen, gfp);
402 else if (bufflen)
403 err = blk_rq_map_kern(req->q, req, buffer, bufflen, gfp);
404
405 if (err)
406 goto free_req;
407
bb1d1073 408 req->cmd_len = cmd_len;
097b8457 409 memset(req->cmd, 0, BLK_MAX_CDB); /* ATAPI hates garbage after CDB */
6e68af66
MC
410 memcpy(req->cmd, cmd, req->cmd_len);
411 req->sense = sioc->sense;
412 req->sense_len = 0;
413 req->timeout = timeout;
17e01f21 414 req->retries = retries;
6e68af66
MC
415 req->end_io_data = sioc;
416
417 sioc->data = privdata;
418 sioc->done = done;
419
420 blk_execute_rq_nowait(req->q, NULL, req, 1, scsi_end_async);
421 return 0;
422
423free_req:
424 blk_put_request(req);
425free_sense:
6470f2ba 426 kmem_cache_free(scsi_io_context_cache, sioc);
6e68af66
MC
427 return DRIVER_ERROR << 24;
428}
429EXPORT_SYMBOL_GPL(scsi_execute_async);
430
1da177e4
LT
431/*
432 * Function: scsi_init_cmd_errh()
433 *
434 * Purpose: Initialize cmd fields related to error handling.
435 *
436 * Arguments: cmd - command that is ready to be queued.
437 *
1da177e4
LT
438 * Notes: This function has the job of initializing a number of
439 * fields related to error handling. Typically this will
440 * be called once for each command, as required.
441 */
631c228c 442static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
1da177e4 443{
1da177e4 444 cmd->serial_number = 0;
30b0c37b 445 scsi_set_resid(cmd, 0);
b80ca4f7 446 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1da177e4
LT
447 if (cmd->cmd_len == 0)
448 cmd->cmd_len = COMMAND_SIZE(cmd->cmnd[0]);
1da177e4
LT
449}
450
451void scsi_device_unbusy(struct scsi_device *sdev)
452{
453 struct Scsi_Host *shost = sdev->host;
454 unsigned long flags;
455
456 spin_lock_irqsave(shost->host_lock, flags);
457 shost->host_busy--;
939647ee 458 if (unlikely(scsi_host_in_recovery(shost) &&
ee7863bc 459 (shost->host_failed || shost->host_eh_scheduled)))
1da177e4
LT
460 scsi_eh_wakeup(shost);
461 spin_unlock(shost->host_lock);
152587de 462 spin_lock(sdev->request_queue->queue_lock);
1da177e4 463 sdev->device_busy--;
152587de 464 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
1da177e4
LT
465}
466
467/*
468 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
469 * and call blk_run_queue for all the scsi_devices on the target -
470 * including current_sdev first.
471 *
472 * Called with *no* scsi locks held.
473 */
474static void scsi_single_lun_run(struct scsi_device *current_sdev)
475{
476 struct Scsi_Host *shost = current_sdev->host;
477 struct scsi_device *sdev, *tmp;
478 struct scsi_target *starget = scsi_target(current_sdev);
479 unsigned long flags;
480
481 spin_lock_irqsave(shost->host_lock, flags);
482 starget->starget_sdev_user = NULL;
483 spin_unlock_irqrestore(shost->host_lock, flags);
484
485 /*
486 * Call blk_run_queue for all LUNs on the target, starting with
487 * current_sdev. We race with others (to set starget_sdev_user),
488 * but in most cases, we will be first. Ideally, each LU on the
489 * target would get some limited time or requests on the target.
490 */
491 blk_run_queue(current_sdev->request_queue);
492
493 spin_lock_irqsave(shost->host_lock, flags);
494 if (starget->starget_sdev_user)
495 goto out;
496 list_for_each_entry_safe(sdev, tmp, &starget->devices,
497 same_target_siblings) {
498 if (sdev == current_sdev)
499 continue;
500 if (scsi_device_get(sdev))
501 continue;
502
503 spin_unlock_irqrestore(shost->host_lock, flags);
504 blk_run_queue(sdev->request_queue);
505 spin_lock_irqsave(shost->host_lock, flags);
506
507 scsi_device_put(sdev);
508 }
509 out:
510 spin_unlock_irqrestore(shost->host_lock, flags);
511}
512
513/*
514 * Function: scsi_run_queue()
515 *
516 * Purpose: Select a proper request queue to serve next
517 *
518 * Arguments: q - last request's queue
519 *
520 * Returns: Nothing
521 *
522 * Notes: The previous command was completely finished, start
523 * a new one if possible.
524 */
525static void scsi_run_queue(struct request_queue *q)
526{
527 struct scsi_device *sdev = q->queuedata;
528 struct Scsi_Host *shost = sdev->host;
529 unsigned long flags;
530
25d7c363 531 if (scsi_target(sdev)->single_lun)
1da177e4
LT
532 scsi_single_lun_run(sdev);
533
534 spin_lock_irqsave(shost->host_lock, flags);
535 while (!list_empty(&shost->starved_list) &&
536 !shost->host_blocked && !shost->host_self_blocked &&
537 !((shost->can_queue > 0) &&
538 (shost->host_busy >= shost->can_queue))) {
539 /*
540 * As long as shost is accepting commands and we have
541 * starved queues, call blk_run_queue. scsi_request_fn
542 * drops the queue_lock and can add us back to the
543 * starved_list.
544 *
545 * host_lock protects the starved_list and starved_entry.
546 * scsi_request_fn must get the host_lock before checking
547 * or modifying starved_list or starved_entry.
548 */
549 sdev = list_entry(shost->starved_list.next,
550 struct scsi_device, starved_entry);
551 list_del_init(&sdev->starved_entry);
552 spin_unlock_irqrestore(shost->host_lock, flags);
553
04846f25
AH
554
555 if (test_bit(QUEUE_FLAG_REENTER, &q->queue_flags) &&
556 !test_and_set_bit(QUEUE_FLAG_REENTER,
557 &sdev->request_queue->queue_flags)) {
558 blk_run_queue(sdev->request_queue);
559 clear_bit(QUEUE_FLAG_REENTER,
560 &sdev->request_queue->queue_flags);
561 } else
562 blk_run_queue(sdev->request_queue);
1da177e4
LT
563
564 spin_lock_irqsave(shost->host_lock, flags);
565 if (unlikely(!list_empty(&sdev->starved_entry)))
566 /*
567 * sdev lost a race, and was put back on the
568 * starved list. This is unlikely but without this
569 * in theory we could loop forever.
570 */
571 break;
572 }
573 spin_unlock_irqrestore(shost->host_lock, flags);
574
575 blk_run_queue(q);
576}
577
578/*
579 * Function: scsi_requeue_command()
580 *
581 * Purpose: Handle post-processing of completed commands.
582 *
583 * Arguments: q - queue to operate on
584 * cmd - command that may need to be requeued.
585 *
586 * Returns: Nothing
587 *
588 * Notes: After command completion, there may be blocks left
589 * over which weren't finished by the previous command
590 * this can be for a number of reasons - the main one is
591 * I/O errors in the middle of the request, in which case
592 * we need to request the blocks that come after the bad
593 * sector.
e91442b6 594 * Notes: Upon return, cmd is a stale pointer.
1da177e4
LT
595 */
596static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
597{
e91442b6 598 struct request *req = cmd->request;
283369cc
TH
599 unsigned long flags;
600
e91442b6 601 scsi_unprep_request(req);
283369cc 602 spin_lock_irqsave(q->queue_lock, flags);
e91442b6 603 blk_requeue_request(q, req);
283369cc 604 spin_unlock_irqrestore(q->queue_lock, flags);
1da177e4
LT
605
606 scsi_run_queue(q);
607}
608
609void scsi_next_command(struct scsi_cmnd *cmd)
610{
49d7bc64
LT
611 struct scsi_device *sdev = cmd->device;
612 struct request_queue *q = sdev->request_queue;
613
614 /* need to hold a reference on the device before we let go of the cmd */
615 get_device(&sdev->sdev_gendev);
1da177e4
LT
616
617 scsi_put_command(cmd);
618 scsi_run_queue(q);
49d7bc64
LT
619
620 /* ok to remove device now */
621 put_device(&sdev->sdev_gendev);
1da177e4
LT
622}
623
624void scsi_run_host_queues(struct Scsi_Host *shost)
625{
626 struct scsi_device *sdev;
627
628 shost_for_each_device(sdev, shost)
629 scsi_run_queue(sdev->request_queue);
630}
631
632/*
633 * Function: scsi_end_request()
634 *
635 * Purpose: Post-processing of completed commands (usually invoked at end
636 * of upper level post-processing and scsi_io_completion).
637 *
638 * Arguments: cmd - command that is complete.
610d8b0c 639 * error - 0 if I/O indicates success, < 0 for I/O error.
1da177e4
LT
640 * bytes - number of bytes of completed I/O
641 * requeue - indicates whether we should requeue leftovers.
642 *
643 * Lock status: Assumed that lock is not held upon entry.
644 *
e91442b6 645 * Returns: cmd if requeue required, NULL otherwise.
1da177e4
LT
646 *
647 * Notes: This is called for block device requests in order to
648 * mark some number of sectors as complete.
649 *
650 * We are guaranteeing that the request queue will be goosed
651 * at some point during this call.
e91442b6 652 * Notes: If cmd was requeued, upon return it will be a stale pointer.
1da177e4 653 */
610d8b0c 654static struct scsi_cmnd *scsi_end_request(struct scsi_cmnd *cmd, int error,
1da177e4
LT
655 int bytes, int requeue)
656{
165125e1 657 struct request_queue *q = cmd->device->request_queue;
1da177e4 658 struct request *req = cmd->request;
1da177e4
LT
659
660 /*
661 * If there are blocks left over at the end, set up the command
662 * to queue the remainder of them.
663 */
610d8b0c 664 if (blk_end_request(req, error, bytes)) {
1da177e4
LT
665 int leftover = (req->hard_nr_sectors << 9);
666
667 if (blk_pc_request(req))
668 leftover = req->data_len;
669
670 /* kill remainder if no retrys */
610d8b0c
KU
671 if (error && blk_noretry_request(req))
672 blk_end_request(req, error, leftover);
1da177e4 673 else {
e91442b6 674 if (requeue) {
1da177e4
LT
675 /*
676 * Bleah. Leftovers again. Stick the
677 * leftovers in the front of the
678 * queue, and goose the queue again.
679 */
680 scsi_requeue_command(q, cmd);
e91442b6
JB
681 cmd = NULL;
682 }
1da177e4
LT
683 return cmd;
684 }
685 }
686
1da177e4
LT
687 /*
688 * This will goose the queue request function at the end, so we don't
689 * need to worry about launching another command.
690 */
691 scsi_next_command(cmd);
692 return NULL;
693}
694
a8474ce2
JA
695static inline unsigned int scsi_sgtable_index(unsigned short nents)
696{
697 unsigned int index;
698
d3f46f39
JB
699 BUG_ON(nents > SCSI_MAX_SG_SEGMENTS);
700
701 if (nents <= 8)
a8474ce2 702 index = 0;
d3f46f39
JB
703 else
704 index = get_count_order(nents) - 3;
1da177e4 705
a8474ce2
JA
706 return index;
707}
708
5ed7959e 709static void scsi_sg_free(struct scatterlist *sgl, unsigned int nents)
a8474ce2
JA
710{
711 struct scsi_host_sg_pool *sgp;
a8474ce2 712
5ed7959e
JA
713 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
714 mempool_free(sgl, sgp->pool);
715}
a8474ce2 716
5ed7959e
JA
717static struct scatterlist *scsi_sg_alloc(unsigned int nents, gfp_t gfp_mask)
718{
719 struct scsi_host_sg_pool *sgp;
a8474ce2 720
5ed7959e
JA
721 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
722 return mempool_alloc(sgp->pool, gfp_mask);
723}
a3bec5c5 724
30b0c37b
BH
725static int scsi_alloc_sgtable(struct scsi_data_buffer *sdb, int nents,
726 gfp_t gfp_mask)
5ed7959e
JA
727{
728 int ret;
a8474ce2 729
30b0c37b 730 BUG_ON(!nents);
a8474ce2 731
30b0c37b
BH
732 ret = __sg_alloc_table(&sdb->table, nents, SCSI_MAX_SG_SEGMENTS,
733 gfp_mask, scsi_sg_alloc);
5ed7959e 734 if (unlikely(ret))
30b0c37b 735 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS,
7cedb1f1 736 scsi_sg_free);
45711f1a 737
a8474ce2 738 return ret;
1da177e4
LT
739}
740
30b0c37b 741static void scsi_free_sgtable(struct scsi_data_buffer *sdb)
1da177e4 742{
30b0c37b 743 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS, scsi_sg_free);
1da177e4
LT
744}
745
746/*
747 * Function: scsi_release_buffers()
748 *
749 * Purpose: Completion processing for block device I/O requests.
750 *
751 * Arguments: cmd - command that we are bailing.
752 *
753 * Lock status: Assumed that no lock is held upon entry.
754 *
755 * Returns: Nothing
756 *
757 * Notes: In the event that an upper level driver rejects a
758 * command, we must release resources allocated during
759 * the __init_io() function. Primarily this would involve
760 * the scatter-gather table, and potentially any bounce
761 * buffers.
762 */
bb52d82f 763void scsi_release_buffers(struct scsi_cmnd *cmd)
1da177e4 764{
30b0c37b
BH
765 if (cmd->sdb.table.nents)
766 scsi_free_sgtable(&cmd->sdb);
1da177e4 767
30b0c37b 768 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
6f9a35e2
BH
769
770 if (scsi_bidi_cmnd(cmd)) {
771 struct scsi_data_buffer *bidi_sdb =
772 cmd->request->next_rq->special;
773 scsi_free_sgtable(bidi_sdb);
774 kmem_cache_free(scsi_bidi_sdb_cache, bidi_sdb);
775 cmd->request->next_rq->special = NULL;
776 }
1da177e4 777}
bb52d82f 778EXPORT_SYMBOL(scsi_release_buffers);
1da177e4 779
6f9a35e2
BH
780/*
781 * Bidi commands Must be complete as a whole, both sides at once.
782 * If part of the bytes were written and lld returned
783 * scsi_in()->resid and/or scsi_out()->resid this information will be left
784 * in req->data_len and req->next_rq->data_len. The upper-layer driver can
785 * decide what to do with this information.
786 */
8c5e03d3 787static void scsi_end_bidi_request(struct scsi_cmnd *cmd)
6f9a35e2 788{
b8de1631
KU
789 struct request *req = cmd->request;
790 unsigned int dlen = req->data_len;
791 unsigned int next_dlen = req->next_rq->data_len;
792
793 req->data_len = scsi_out(cmd)->resid;
794 req->next_rq->data_len = scsi_in(cmd)->resid;
795
796 /* The req and req->next_rq have not been completed */
797 BUG_ON(blk_end_bidi_request(req, 0, dlen, next_dlen));
798
6f9a35e2
BH
799 scsi_release_buffers(cmd);
800
801 /*
802 * This will goose the queue request function at the end, so we don't
803 * need to worry about launching another command.
804 */
805 scsi_next_command(cmd);
806}
807
1da177e4
LT
808/*
809 * Function: scsi_io_completion()
810 *
811 * Purpose: Completion processing for block device I/O requests.
812 *
813 * Arguments: cmd - command that is finished.
814 *
815 * Lock status: Assumed that no lock is held upon entry.
816 *
817 * Returns: Nothing
818 *
819 * Notes: This function is matched in terms of capabilities to
820 * the function that created the scatter-gather list.
821 * In other words, if there are no bounce buffers
822 * (the normal case for most drivers), we don't need
823 * the logic to deal with cleaning up afterwards.
824 *
825 * We must do one of several things here:
826 *
827 * a) Call scsi_end_request. This will finish off the
828 * specified number of sectors. If we are done, the
829 * command block will be released, and the queue
830 * function will be goosed. If we are not done, then
831 * scsi_end_request will directly goose the queue.
832 *
833 * b) We can just use scsi_requeue_command() here. This would
834 * be used if we just wanted to retry, for example.
835 */
03aba2f7 836void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
1da177e4
LT
837{
838 int result = cmd->result;
30b0c37b 839 int this_count = scsi_bufflen(cmd);
165125e1 840 struct request_queue *q = cmd->device->request_queue;
1da177e4 841 struct request *req = cmd->request;
fa8e36c3 842 int error = 0;
1da177e4
LT
843 struct scsi_sense_hdr sshdr;
844 int sense_valid = 0;
845 int sense_deferred = 0;
846
1da177e4
LT
847 if (result) {
848 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
849 if (sense_valid)
850 sense_deferred = scsi_sense_is_deferred(&sshdr);
851 }
631c228c 852
1da177e4
LT
853 if (blk_pc_request(req)) { /* SG_IO ioctl from block level */
854 req->errors = result;
855 if (result) {
1da177e4
LT
856 if (sense_valid && req->sense) {
857 /*
858 * SG_IO wants current and deferred errors
859 */
860 int len = 8 + cmd->sense_buffer[7];
861
862 if (len > SCSI_SENSE_BUFFERSIZE)
863 len = SCSI_SENSE_BUFFERSIZE;
864 memcpy(req->sense, cmd->sense_buffer, len);
865 req->sense_len = len;
866 }
fa8e36c3
JB
867 if (!sense_deferred)
868 error = -EIO;
b22f687d 869 }
6f9a35e2
BH
870 if (scsi_bidi_cmnd(cmd)) {
871 /* will also release_buffers */
872 scsi_end_bidi_request(cmd);
873 return;
874 }
30b0c37b 875 req->data_len = scsi_get_resid(cmd);
1da177e4
LT
876 }
877
6f9a35e2 878 BUG_ON(blk_bidi_rq(req)); /* bidi not support for !blk_pc_request yet */
30b0c37b
BH
879 scsi_release_buffers(cmd);
880
1da177e4
LT
881 /*
882 * Next deal with any sectors which we were able to correctly
883 * handle.
884 */
d6b0c537
JB
885 SCSI_LOG_HLCOMPLETE(1, printk("%ld sectors total, "
886 "%d bytes done.\n",
887 req->nr_sectors, good_bytes));
d6b0c537 888
d6b0c537
JB
889 /* A number of bytes were successfully read. If there
890 * are leftovers and there is some kind of error
891 * (result != 0), retry the rest.
892 */
fa8e36c3 893 if (scsi_end_request(cmd, error, good_bytes, result == 0) == NULL)
d6b0c537 894 return;
03aba2f7
LT
895
896 /* good_bytes = 0, or (inclusive) there were leftovers and
897 * result = 0, so scsi_end_request couldn't retry.
1da177e4
LT
898 */
899 if (sense_valid && !sense_deferred) {
900 switch (sshdr.sense_key) {
901 case UNIT_ATTENTION:
902 if (cmd->device->removable) {
03aba2f7 903 /* Detected disc change. Set a bit
1da177e4
LT
904 * and quietly refuse further access.
905 */
906 cmd->device->changed = 1;
610d8b0c 907 scsi_end_request(cmd, -EIO, this_count, 1);
1da177e4
LT
908 return;
909 } else {
03aba2f7
LT
910 /* Must have been a power glitch, or a
911 * bus reset. Could not have been a
912 * media change, so we just retry the
913 * request and see what happens.
914 */
1da177e4
LT
915 scsi_requeue_command(q, cmd);
916 return;
917 }
918 break;
919 case ILLEGAL_REQUEST:
03aba2f7
LT
920 /* If we had an ILLEGAL REQUEST returned, then
921 * we may have performed an unsupported
922 * command. The only thing this should be
923 * would be a ten byte read where only a six
924 * byte read was supported. Also, on a system
925 * where READ CAPACITY failed, we may have
926 * read past the end of the disk.
927 */
26a68019
JA
928 if ((cmd->device->use_10_for_rw &&
929 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
1da177e4
LT
930 (cmd->cmnd[0] == READ_10 ||
931 cmd->cmnd[0] == WRITE_10)) {
932 cmd->device->use_10_for_rw = 0;
03aba2f7
LT
933 /* This will cause a retry with a
934 * 6-byte command.
1da177e4
LT
935 */
936 scsi_requeue_command(q, cmd);
03aba2f7 937 return;
1da177e4 938 } else {
610d8b0c 939 scsi_end_request(cmd, -EIO, this_count, 1);
1da177e4
LT
940 return;
941 }
942 break;
943 case NOT_READY:
03aba2f7 944 /* If the device is in the process of becoming
f3e93f73 945 * ready, or has a temporary blockage, retry.
1da177e4 946 */
f3e93f73
JB
947 if (sshdr.asc == 0x04) {
948 switch (sshdr.ascq) {
949 case 0x01: /* becoming ready */
950 case 0x04: /* format in progress */
951 case 0x05: /* rebuild in progress */
952 case 0x06: /* recalculation in progress */
953 case 0x07: /* operation in progress */
954 case 0x08: /* Long write in progress */
955 case 0x09: /* self test in progress */
956 scsi_requeue_command(q, cmd);
957 return;
958 default:
959 break;
960 }
1da177e4 961 }
311b581e
JB
962 if (!(req->cmd_flags & REQ_QUIET))
963 scsi_cmd_print_sense_hdr(cmd,
964 "Device not ready",
965 &sshdr);
966
610d8b0c 967 scsi_end_request(cmd, -EIO, this_count, 1);
1da177e4
LT
968 return;
969 case VOLUME_OVERFLOW:
4aff5e23 970 if (!(req->cmd_flags & REQ_QUIET)) {
3bf743e7 971 scmd_printk(KERN_INFO, cmd,
03aba2f7 972 "Volume overflow, CDB: ");
631c228c 973 __scsi_print_command(cmd->cmnd);
3173d8c3
JB
974 scsi_print_sense("", cmd);
975 }
03aba2f7 976 /* See SSC3rXX or current. */
610d8b0c 977 scsi_end_request(cmd, -EIO, this_count, 1);
1da177e4
LT
978 return;
979 default:
980 break;
981 }
03aba2f7 982 }
1da177e4 983 if (host_byte(result) == DID_RESET) {
03aba2f7
LT
984 /* Third party bus reset or reset for error recovery
985 * reasons. Just retry the request and see what
986 * happens.
1da177e4
LT
987 */
988 scsi_requeue_command(q, cmd);
989 return;
990 }
991 if (result) {
4aff5e23 992 if (!(req->cmd_flags & REQ_QUIET)) {
a4d04a4c 993 scsi_print_result(cmd);
3173d8c3
JB
994 if (driver_byte(result) & DRIVER_SENSE)
995 scsi_print_sense("", cmd);
996 }
1da177e4 997 }
610d8b0c 998 scsi_end_request(cmd, -EIO, this_count, !result);
1da177e4 999}
1da177e4 1000
6f9a35e2
BH
1001static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb,
1002 gfp_t gfp_mask)
1da177e4 1003{
6f9a35e2 1004 int count;
1da177e4
LT
1005
1006 /*
3b003157 1007 * If sg table allocation fails, requeue request later.
1da177e4 1008 */
30b0c37b
BH
1009 if (unlikely(scsi_alloc_sgtable(sdb, req->nr_phys_segments,
1010 gfp_mask))) {
1da177e4 1011 return BLKPREP_DEFER;
7c72ce81 1012 }
1da177e4 1013
3b003157 1014 req->buffer = NULL;
1da177e4
LT
1015
1016 /*
1017 * Next, walk the list, and fill in the addresses and sizes of
1018 * each segment.
1019 */
30b0c37b
BH
1020 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1021 BUG_ON(count > sdb->table.nents);
1022 sdb->table.nents = count;
6b00769f
TH
1023 if (blk_pc_request(req))
1024 sdb->length = req->data_len;
1025 else
1026 sdb->length = req->nr_sectors << 9;
4a03d90e 1027 return BLKPREP_OK;
1da177e4 1028}
6f9a35e2
BH
1029
1030/*
1031 * Function: scsi_init_io()
1032 *
1033 * Purpose: SCSI I/O initialize function.
1034 *
1035 * Arguments: cmd - Command descriptor we wish to initialize
1036 *
1037 * Returns: 0 on success
1038 * BLKPREP_DEFER if the failure is retryable
1039 * BLKPREP_KILL if the failure is fatal
1040 */
1041int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask)
1042{
1043 int error = scsi_init_sgtable(cmd->request, &cmd->sdb, gfp_mask);
1044 if (error)
1045 goto err_exit;
1046
1047 if (blk_bidi_rq(cmd->request)) {
1048 struct scsi_data_buffer *bidi_sdb = kmem_cache_zalloc(
1049 scsi_bidi_sdb_cache, GFP_ATOMIC);
1050 if (!bidi_sdb) {
1051 error = BLKPREP_DEFER;
1052 goto err_exit;
1053 }
1054
1055 cmd->request->next_rq->special = bidi_sdb;
1056 error = scsi_init_sgtable(cmd->request->next_rq, bidi_sdb,
1057 GFP_ATOMIC);
1058 if (error)
1059 goto err_exit;
1060 }
1061
1062 return BLKPREP_OK ;
1063
1064err_exit:
1065 scsi_release_buffers(cmd);
1066 if (error == BLKPREP_KILL)
1067 scsi_put_command(cmd);
1068 else /* BLKPREP_DEFER */
1069 scsi_unprep_request(cmd->request);
1070
1071 return error;
1072}
bb52d82f 1073EXPORT_SYMBOL(scsi_init_io);
1da177e4 1074
3b003157
CH
1075static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
1076 struct request *req)
1077{
1078 struct scsi_cmnd *cmd;
1079
1080 if (!req->special) {
1081 cmd = scsi_get_command(sdev, GFP_ATOMIC);
1082 if (unlikely(!cmd))
1083 return NULL;
1084 req->special = cmd;
1085 } else {
1086 cmd = req->special;
1087 }
1088
1089 /* pull a tag out of the request if we have one */
1090 cmd->tag = req->tag;
1091 cmd->request = req;
1092
64a87b24
BH
1093 cmd->cmnd = req->cmd;
1094
3b003157
CH
1095 return cmd;
1096}
1097
7f9a6bc4 1098int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
7b16318d 1099{
3b003157 1100 struct scsi_cmnd *cmd;
7f9a6bc4
JB
1101 int ret = scsi_prep_state_check(sdev, req);
1102
1103 if (ret != BLKPREP_OK)
1104 return ret;
3b003157
CH
1105
1106 cmd = scsi_get_cmd_from_req(sdev, req);
1107 if (unlikely(!cmd))
1108 return BLKPREP_DEFER;
1109
1110 /*
1111 * BLOCK_PC requests may transfer data, in which case they must
1112 * a bio attached to them. Or they might contain a SCSI command
1113 * that does not transfer data, in which case they may optionally
1114 * submit a request without an attached bio.
1115 */
1116 if (req->bio) {
1117 int ret;
1118
1119 BUG_ON(!req->nr_phys_segments);
1120
bb52d82f 1121 ret = scsi_init_io(cmd, GFP_ATOMIC);
3b003157
CH
1122 if (unlikely(ret))
1123 return ret;
1124 } else {
1125 BUG_ON(req->data_len);
1126 BUG_ON(req->data);
1127
30b0c37b 1128 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
3b003157
CH
1129 req->buffer = NULL;
1130 }
7b16318d 1131
7b16318d
JB
1132 cmd->cmd_len = req->cmd_len;
1133 if (!req->data_len)
1134 cmd->sc_data_direction = DMA_NONE;
1135 else if (rq_data_dir(req) == WRITE)
1136 cmd->sc_data_direction = DMA_TO_DEVICE;
1137 else
1138 cmd->sc_data_direction = DMA_FROM_DEVICE;
1139
1140 cmd->transfersize = req->data_len;
1141 cmd->allowed = req->retries;
1142 cmd->timeout_per_command = req->timeout;
3b003157 1143 return BLKPREP_OK;
7b16318d 1144}
7f9a6bc4 1145EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
7b16318d 1146
3b003157
CH
1147/*
1148 * Setup a REQ_TYPE_FS command. These are simple read/write request
1149 * from filesystems that still need to be translated to SCSI CDBs from
1150 * the ULD.
1151 */
7f9a6bc4 1152int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
1da177e4 1153{
1da177e4 1154 struct scsi_cmnd *cmd;
7f9a6bc4 1155 int ret = scsi_prep_state_check(sdev, req);
1da177e4 1156
7f9a6bc4
JB
1157 if (ret != BLKPREP_OK)
1158 return ret;
1da177e4 1159 /*
3b003157 1160 * Filesystem requests must transfer data.
1da177e4 1161 */
3b003157
CH
1162 BUG_ON(!req->nr_phys_segments);
1163
1164 cmd = scsi_get_cmd_from_req(sdev, req);
1165 if (unlikely(!cmd))
1166 return BLKPREP_DEFER;
1167
64a87b24 1168 memset(cmd->cmnd, 0, BLK_MAX_CDB);
bb52d82f 1169 return scsi_init_io(cmd, GFP_ATOMIC);
3b003157 1170}
7f9a6bc4 1171EXPORT_SYMBOL(scsi_setup_fs_cmnd);
3b003157 1172
7f9a6bc4 1173int scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
3b003157 1174{
3b003157
CH
1175 int ret = BLKPREP_OK;
1176
1da177e4 1177 /*
3b003157
CH
1178 * If the device is not in running state we will reject some
1179 * or all commands.
1da177e4 1180 */
3b003157
CH
1181 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1182 switch (sdev->sdev_state) {
1183 case SDEV_OFFLINE:
1184 /*
1185 * If the device is offline we refuse to process any
1186 * commands. The device must be brought online
1187 * before trying any recovery commands.
1188 */
1189 sdev_printk(KERN_ERR, sdev,
1190 "rejecting I/O to offline device\n");
1191 ret = BLKPREP_KILL;
1192 break;
1193 case SDEV_DEL:
1194 /*
1195 * If the device is fully deleted, we refuse to
1196 * process any commands as well.
1197 */
9ccfc756 1198 sdev_printk(KERN_ERR, sdev,
3b003157
CH
1199 "rejecting I/O to dead device\n");
1200 ret = BLKPREP_KILL;
1201 break;
1202 case SDEV_QUIESCE:
1203 case SDEV_BLOCK:
1204 /*
1205 * If the devices is blocked we defer normal commands.
1206 */
1207 if (!(req->cmd_flags & REQ_PREEMPT))
1208 ret = BLKPREP_DEFER;
1209 break;
1210 default:
1211 /*
1212 * For any other not fully online state we only allow
1213 * special commands. In particular any user initiated
1214 * command is not allowed.
1215 */
1216 if (!(req->cmd_flags & REQ_PREEMPT))
1217 ret = BLKPREP_KILL;
1218 break;
1da177e4 1219 }
1da177e4 1220 }
7f9a6bc4
JB
1221 return ret;
1222}
1223EXPORT_SYMBOL(scsi_prep_state_check);
1da177e4 1224
7f9a6bc4
JB
1225int scsi_prep_return(struct request_queue *q, struct request *req, int ret)
1226{
1227 struct scsi_device *sdev = q->queuedata;
1da177e4 1228
3b003157
CH
1229 switch (ret) {
1230 case BLKPREP_KILL:
1231 req->errors = DID_NO_CONNECT << 16;
7f9a6bc4
JB
1232 /* release the command and kill it */
1233 if (req->special) {
1234 struct scsi_cmnd *cmd = req->special;
1235 scsi_release_buffers(cmd);
1236 scsi_put_command(cmd);
1237 req->special = NULL;
1238 }
3b003157
CH
1239 break;
1240 case BLKPREP_DEFER:
1da177e4 1241 /*
3b003157
CH
1242 * If we defer, the elv_next_request() returns NULL, but the
1243 * queue must be restarted, so we plug here if no returning
1244 * command will automatically do that.
1da177e4 1245 */
3b003157
CH
1246 if (sdev->device_busy == 0)
1247 blk_plug_device(q);
1248 break;
1249 default:
1250 req->cmd_flags |= REQ_DONTPREP;
1da177e4
LT
1251 }
1252
3b003157 1253 return ret;
1da177e4 1254}
7f9a6bc4
JB
1255EXPORT_SYMBOL(scsi_prep_return);
1256
751bf4d7 1257int scsi_prep_fn(struct request_queue *q, struct request *req)
7f9a6bc4
JB
1258{
1259 struct scsi_device *sdev = q->queuedata;
1260 int ret = BLKPREP_KILL;
1261
1262 if (req->cmd_type == REQ_TYPE_BLOCK_PC)
1263 ret = scsi_setup_blk_pc_cmnd(sdev, req);
1264 return scsi_prep_return(q, req, ret);
1265}
1da177e4
LT
1266
1267/*
1268 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1269 * return 0.
1270 *
1271 * Called with the queue_lock held.
1272 */
1273static inline int scsi_dev_queue_ready(struct request_queue *q,
1274 struct scsi_device *sdev)
1275{
1276 if (sdev->device_busy >= sdev->queue_depth)
1277 return 0;
1278 if (sdev->device_busy == 0 && sdev->device_blocked) {
1279 /*
1280 * unblock after device_blocked iterates to zero
1281 */
1282 if (--sdev->device_blocked == 0) {
1283 SCSI_LOG_MLQUEUE(3,
9ccfc756
JB
1284 sdev_printk(KERN_INFO, sdev,
1285 "unblocking device at zero depth\n"));
1da177e4
LT
1286 } else {
1287 blk_plug_device(q);
1288 return 0;
1289 }
1290 }
1291 if (sdev->device_blocked)
1292 return 0;
1293
1294 return 1;
1295}
1296
1297/*
1298 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1299 * return 0. We must end up running the queue again whenever 0 is
1300 * returned, else IO can hang.
1301 *
1302 * Called with host_lock held.
1303 */
1304static inline int scsi_host_queue_ready(struct request_queue *q,
1305 struct Scsi_Host *shost,
1306 struct scsi_device *sdev)
1307{
939647ee 1308 if (scsi_host_in_recovery(shost))
1da177e4
LT
1309 return 0;
1310 if (shost->host_busy == 0 && shost->host_blocked) {
1311 /*
1312 * unblock after host_blocked iterates to zero
1313 */
1314 if (--shost->host_blocked == 0) {
1315 SCSI_LOG_MLQUEUE(3,
1316 printk("scsi%d unblocking host at zero depth\n",
1317 shost->host_no));
1318 } else {
1319 blk_plug_device(q);
1320 return 0;
1321 }
1322 }
1323 if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
1324 shost->host_blocked || shost->host_self_blocked) {
1325 if (list_empty(&sdev->starved_entry))
1326 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1327 return 0;
1328 }
1329
1330 /* We're OK to process the command, so we can't be starved */
1331 if (!list_empty(&sdev->starved_entry))
1332 list_del_init(&sdev->starved_entry);
1333
1334 return 1;
1335}
1336
1337/*
e91442b6 1338 * Kill a request for a dead device
1da177e4 1339 */
165125e1 1340static void scsi_kill_request(struct request *req, struct request_queue *q)
1da177e4 1341{
e91442b6 1342 struct scsi_cmnd *cmd = req->special;
e36e0c80
TH
1343 struct scsi_device *sdev = cmd->device;
1344 struct Scsi_Host *shost = sdev->host;
1da177e4 1345
788ce43a
JB
1346 blkdev_dequeue_request(req);
1347
e91442b6
JB
1348 if (unlikely(cmd == NULL)) {
1349 printk(KERN_CRIT "impossible request in %s.\n",
1350 __FUNCTION__);
1351 BUG();
1da177e4 1352 }
e91442b6
JB
1353
1354 scsi_init_cmd_errh(cmd);
1355 cmd->result = DID_NO_CONNECT << 16;
1356 atomic_inc(&cmd->device->iorequest_cnt);
e36e0c80
TH
1357
1358 /*
1359 * SCSI request completion path will do scsi_device_unbusy(),
1360 * bump busy counts. To bump the counters, we need to dance
1361 * with the locks as normal issue path does.
1362 */
1363 sdev->device_busy++;
1364 spin_unlock(sdev->request_queue->queue_lock);
1365 spin_lock(shost->host_lock);
1366 shost->host_busy++;
1367 spin_unlock(shost->host_lock);
1368 spin_lock(sdev->request_queue->queue_lock);
1369
e91442b6 1370 __scsi_done(cmd);
1da177e4
LT
1371}
1372
1aea6434
JA
1373static void scsi_softirq_done(struct request *rq)
1374{
1375 struct scsi_cmnd *cmd = rq->completion_data;
8884efab 1376 unsigned long wait_for = (cmd->allowed + 1) * cmd->timeout_per_command;
1aea6434
JA
1377 int disposition;
1378
1379 INIT_LIST_HEAD(&cmd->eh_entry);
1380
1381 disposition = scsi_decide_disposition(cmd);
1382 if (disposition != SUCCESS &&
1383 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1384 sdev_printk(KERN_ERR, cmd->device,
1385 "timing out command, waited %lus\n",
1386 wait_for/HZ);
1387 disposition = SUCCESS;
1388 }
1389
1390 scsi_log_completion(cmd, disposition);
1391
1392 switch (disposition) {
1393 case SUCCESS:
1394 scsi_finish_command(cmd);
1395 break;
1396 case NEEDS_RETRY:
596f482a 1397 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
1aea6434
JA
1398 break;
1399 case ADD_TO_MLQUEUE:
1400 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1401 break;
1402 default:
1403 if (!scsi_eh_scmd_add(cmd, 0))
1404 scsi_finish_command(cmd);
1405 }
1406}
1407
1da177e4
LT
1408/*
1409 * Function: scsi_request_fn()
1410 *
1411 * Purpose: Main strategy routine for SCSI.
1412 *
1413 * Arguments: q - Pointer to actual queue.
1414 *
1415 * Returns: Nothing
1416 *
1417 * Lock status: IO request lock assumed to be held when called.
1418 */
1419static void scsi_request_fn(struct request_queue *q)
1420{
1421 struct scsi_device *sdev = q->queuedata;
1422 struct Scsi_Host *shost;
1423 struct scsi_cmnd *cmd;
1424 struct request *req;
1425
1426 if (!sdev) {
1427 printk("scsi: killing requests for dead queue\n");
e91442b6
JB
1428 while ((req = elv_next_request(q)) != NULL)
1429 scsi_kill_request(req, q);
1da177e4
LT
1430 return;
1431 }
1432
1433 if(!get_device(&sdev->sdev_gendev))
1434 /* We must be tearing the block queue down already */
1435 return;
1436
1437 /*
1438 * To start with, we keep looping until the queue is empty, or until
1439 * the host is no longer able to accept any more requests.
1440 */
1441 shost = sdev->host;
1442 while (!blk_queue_plugged(q)) {
1443 int rtn;
1444 /*
1445 * get next queueable request. We do this early to make sure
1446 * that the request is fully prepared even if we cannot
1447 * accept it.
1448 */
1449 req = elv_next_request(q);
1450 if (!req || !scsi_dev_queue_ready(q, sdev))
1451 break;
1452
1453 if (unlikely(!scsi_device_online(sdev))) {
9ccfc756
JB
1454 sdev_printk(KERN_ERR, sdev,
1455 "rejecting I/O to offline device\n");
e91442b6 1456 scsi_kill_request(req, q);
1da177e4
LT
1457 continue;
1458 }
1459
1460
1461 /*
1462 * Remove the request from the request list.
1463 */
1464 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
1465 blkdev_dequeue_request(req);
1466 sdev->device_busy++;
1467
1468 spin_unlock(q->queue_lock);
e91442b6
JB
1469 cmd = req->special;
1470 if (unlikely(cmd == NULL)) {
1471 printk(KERN_CRIT "impossible request in %s.\n"
1472 "please mail a stack trace to "
4aff5e23 1473 "linux-scsi@vger.kernel.org\n",
e91442b6 1474 __FUNCTION__);
4aff5e23 1475 blk_dump_rq_flags(req, "foo");
e91442b6
JB
1476 BUG();
1477 }
1da177e4
LT
1478 spin_lock(shost->host_lock);
1479
1480 if (!scsi_host_queue_ready(q, shost, sdev))
1481 goto not_ready;
25d7c363 1482 if (scsi_target(sdev)->single_lun) {
1da177e4
LT
1483 if (scsi_target(sdev)->starget_sdev_user &&
1484 scsi_target(sdev)->starget_sdev_user != sdev)
1485 goto not_ready;
1486 scsi_target(sdev)->starget_sdev_user = sdev;
1487 }
1488 shost->host_busy++;
1489
1490 /*
1491 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1492 * take the lock again.
1493 */
1494 spin_unlock_irq(shost->host_lock);
1495
1da177e4
LT
1496 /*
1497 * Finally, initialize any error handling parameters, and set up
1498 * the timers for timeouts.
1499 */
1500 scsi_init_cmd_errh(cmd);
1501
1502 /*
1503 * Dispatch the command to the low-level driver.
1504 */
1505 rtn = scsi_dispatch_cmd(cmd);
1506 spin_lock_irq(q->queue_lock);
1507 if(rtn) {
1508 /* we're refusing the command; because of
1509 * the way locks get dropped, we need to
1510 * check here if plugging is required */
1511 if(sdev->device_busy == 0)
1512 blk_plug_device(q);
1513
1514 break;
1515 }
1516 }
1517
1518 goto out;
1519
1520 not_ready:
1521 spin_unlock_irq(shost->host_lock);
1522
1523 /*
1524 * lock q, handle tag, requeue req, and decrement device_busy. We
1525 * must return with queue_lock held.
1526 *
1527 * Decrementing device_busy without checking it is OK, as all such
1528 * cases (host limits or settings) should run the queue at some
1529 * later time.
1530 */
1531 spin_lock_irq(q->queue_lock);
1532 blk_requeue_request(q, req);
1533 sdev->device_busy--;
1534 if(sdev->device_busy == 0)
1535 blk_plug_device(q);
1536 out:
1537 /* must be careful here...if we trigger the ->remove() function
1538 * we cannot be holding the q lock */
1539 spin_unlock_irq(q->queue_lock);
1540 put_device(&sdev->sdev_gendev);
1541 spin_lock_irq(q->queue_lock);
1542}
1543
1544u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
1545{
1546 struct device *host_dev;
1547 u64 bounce_limit = 0xffffffff;
1548
1549 if (shost->unchecked_isa_dma)
1550 return BLK_BOUNCE_ISA;
1551 /*
1552 * Platforms with virtual-DMA translation
1553 * hardware have no practical limit.
1554 */
1555 if (!PCI_DMA_BUS_IS_PHYS)
1556 return BLK_BOUNCE_ANY;
1557
1558 host_dev = scsi_get_device(shost);
1559 if (host_dev && host_dev->dma_mask)
1560 bounce_limit = *host_dev->dma_mask;
1561
1562 return bounce_limit;
1563}
1564EXPORT_SYMBOL(scsi_calculate_bounce_limit);
1565
b58d9154
FT
1566struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
1567 request_fn_proc *request_fn)
1da177e4 1568{
1da177e4 1569 struct request_queue *q;
860ac568 1570 struct device *dev = shost->shost_gendev.parent;
1da177e4 1571
b58d9154 1572 q = blk_init_queue(request_fn, NULL);
1da177e4
LT
1573 if (!q)
1574 return NULL;
1575
a8474ce2
JA
1576 /*
1577 * this limit is imposed by hardware restrictions
1578 */
1da177e4 1579 blk_queue_max_hw_segments(q, shost->sg_tablesize);
d3f46f39 1580 blk_queue_max_phys_segments(q, SCSI_MAX_SG_CHAIN_SEGMENTS);
a8474ce2 1581
1da177e4
LT
1582 blk_queue_max_sectors(q, shost->max_sectors);
1583 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
1584 blk_queue_segment_boundary(q, shost->dma_boundary);
99c84dbd 1585 dma_set_seg_boundary(dev, shost->dma_boundary);
1da177e4 1586
860ac568
FT
1587 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
1588
1da177e4
LT
1589 if (!shost->use_clustering)
1590 clear_bit(QUEUE_FLAG_CLUSTER, &q->queue_flags);
465ff318
JB
1591
1592 /*
1593 * set a reasonable default alignment on word boundaries: the
1594 * host and device may alter it using
1595 * blk_queue_update_dma_alignment() later.
1596 */
1597 blk_queue_dma_alignment(q, 0x03);
1598
1da177e4
LT
1599 return q;
1600}
b58d9154
FT
1601EXPORT_SYMBOL(__scsi_alloc_queue);
1602
1603struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
1604{
1605 struct request_queue *q;
1606
1607 q = __scsi_alloc_queue(sdev->host, scsi_request_fn);
1608 if (!q)
1609 return NULL;
1610
1611 blk_queue_prep_rq(q, scsi_prep_fn);
b58d9154
FT
1612 blk_queue_softirq_done(q, scsi_softirq_done);
1613 return q;
1614}
1da177e4
LT
1615
1616void scsi_free_queue(struct request_queue *q)
1617{
1618 blk_cleanup_queue(q);
1619}
1620
1621/*
1622 * Function: scsi_block_requests()
1623 *
1624 * Purpose: Utility function used by low-level drivers to prevent further
1625 * commands from being queued to the device.
1626 *
1627 * Arguments: shost - Host in question
1628 *
1629 * Returns: Nothing
1630 *
1631 * Lock status: No locks are assumed held.
1632 *
1633 * Notes: There is no timer nor any other means by which the requests
1634 * get unblocked other than the low-level driver calling
1635 * scsi_unblock_requests().
1636 */
1637void scsi_block_requests(struct Scsi_Host *shost)
1638{
1639 shost->host_self_blocked = 1;
1640}
1641EXPORT_SYMBOL(scsi_block_requests);
1642
1643/*
1644 * Function: scsi_unblock_requests()
1645 *
1646 * Purpose: Utility function used by low-level drivers to allow further
1647 * commands from being queued to the device.
1648 *
1649 * Arguments: shost - Host in question
1650 *
1651 * Returns: Nothing
1652 *
1653 * Lock status: No locks are assumed held.
1654 *
1655 * Notes: There is no timer nor any other means by which the requests
1656 * get unblocked other than the low-level driver calling
1657 * scsi_unblock_requests().
1658 *
1659 * This is done as an API function so that changes to the
1660 * internals of the scsi mid-layer won't require wholesale
1661 * changes to drivers that use this feature.
1662 */
1663void scsi_unblock_requests(struct Scsi_Host *shost)
1664{
1665 shost->host_self_blocked = 0;
1666 scsi_run_host_queues(shost);
1667}
1668EXPORT_SYMBOL(scsi_unblock_requests);
1669
1670int __init scsi_init_queue(void)
1671{
1672 int i;
1673
aa7b5cd7
MC
1674 scsi_io_context_cache = kmem_cache_create("scsi_io_context",
1675 sizeof(struct scsi_io_context),
20c2df83 1676 0, 0, NULL);
aa7b5cd7
MC
1677 if (!scsi_io_context_cache) {
1678 printk(KERN_ERR "SCSI: can't init scsi io context cache\n");
1679 return -ENOMEM;
1680 }
1681
6f9a35e2
BH
1682 scsi_bidi_sdb_cache = kmem_cache_create("scsi_bidi_sdb",
1683 sizeof(struct scsi_data_buffer),
1684 0, 0, NULL);
1685 if (!scsi_bidi_sdb_cache) {
1686 printk(KERN_ERR "SCSI: can't init scsi bidi sdb cache\n");
3d9dd6ee 1687 goto cleanup_io_context;
6f9a35e2
BH
1688 }
1689
1da177e4
LT
1690 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1691 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1692 int size = sgp->size * sizeof(struct scatterlist);
1693
1694 sgp->slab = kmem_cache_create(sgp->name, size, 0,
20c2df83 1695 SLAB_HWCACHE_ALIGN, NULL);
1da177e4
LT
1696 if (!sgp->slab) {
1697 printk(KERN_ERR "SCSI: can't init sg slab %s\n",
1698 sgp->name);
3d9dd6ee 1699 goto cleanup_bidi_sdb;
1da177e4
LT
1700 }
1701
93d2341c
MD
1702 sgp->pool = mempool_create_slab_pool(SG_MEMPOOL_SIZE,
1703 sgp->slab);
1da177e4
LT
1704 if (!sgp->pool) {
1705 printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
1706 sgp->name);
3d9dd6ee 1707 goto cleanup_bidi_sdb;
1da177e4
LT
1708 }
1709 }
1710
1711 return 0;
3d9dd6ee
FT
1712
1713cleanup_bidi_sdb:
1714 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1715 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1716 if (sgp->pool)
1717 mempool_destroy(sgp->pool);
1718 if (sgp->slab)
1719 kmem_cache_destroy(sgp->slab);
1720 }
1721 kmem_cache_destroy(scsi_bidi_sdb_cache);
1722cleanup_io_context:
1723 kmem_cache_destroy(scsi_io_context_cache);
1724
1725 return -ENOMEM;
1da177e4
LT
1726}
1727
1728void scsi_exit_queue(void)
1729{
1730 int i;
1731
aa7b5cd7 1732 kmem_cache_destroy(scsi_io_context_cache);
b172b6e9 1733 kmem_cache_destroy(scsi_bidi_sdb_cache);
aa7b5cd7 1734
1da177e4
LT
1735 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1736 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1737 mempool_destroy(sgp->pool);
1738 kmem_cache_destroy(sgp->slab);
1739 }
1740}
5baba830
JB
1741
1742/**
1743 * scsi_mode_select - issue a mode select
1744 * @sdev: SCSI device to be queried
1745 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1746 * @sp: Save page bit (0 == don't save, 1 == save)
1747 * @modepage: mode page being requested
1748 * @buffer: request buffer (may not be smaller than eight bytes)
1749 * @len: length of request buffer.
1750 * @timeout: command timeout
1751 * @retries: number of retries before failing
1752 * @data: returns a structure abstracting the mode header data
eb44820c 1753 * @sshdr: place to put sense data (or NULL if no sense to be collected).
5baba830
JB
1754 * must be SCSI_SENSE_BUFFERSIZE big.
1755 *
1756 * Returns zero if successful; negative error number or scsi
1757 * status on error
1758 *
1759 */
1760int
1761scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1762 unsigned char *buffer, int len, int timeout, int retries,
1763 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1764{
1765 unsigned char cmd[10];
1766 unsigned char *real_buffer;
1767 int ret;
1768
1769 memset(cmd, 0, sizeof(cmd));
1770 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
1771
1772 if (sdev->use_10_for_ms) {
1773 if (len > 65535)
1774 return -EINVAL;
1775 real_buffer = kmalloc(8 + len, GFP_KERNEL);
1776 if (!real_buffer)
1777 return -ENOMEM;
1778 memcpy(real_buffer + 8, buffer, len);
1779 len += 8;
1780 real_buffer[0] = 0;
1781 real_buffer[1] = 0;
1782 real_buffer[2] = data->medium_type;
1783 real_buffer[3] = data->device_specific;
1784 real_buffer[4] = data->longlba ? 0x01 : 0;
1785 real_buffer[5] = 0;
1786 real_buffer[6] = data->block_descriptor_length >> 8;
1787 real_buffer[7] = data->block_descriptor_length;
1788
1789 cmd[0] = MODE_SELECT_10;
1790 cmd[7] = len >> 8;
1791 cmd[8] = len;
1792 } else {
1793 if (len > 255 || data->block_descriptor_length > 255 ||
1794 data->longlba)
1795 return -EINVAL;
1796
1797 real_buffer = kmalloc(4 + len, GFP_KERNEL);
1798 if (!real_buffer)
1799 return -ENOMEM;
1800 memcpy(real_buffer + 4, buffer, len);
1801 len += 4;
1802 real_buffer[0] = 0;
1803 real_buffer[1] = data->medium_type;
1804 real_buffer[2] = data->device_specific;
1805 real_buffer[3] = data->block_descriptor_length;
1806
1807
1808 cmd[0] = MODE_SELECT;
1809 cmd[4] = len;
1810 }
1811
1812 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
1813 sshdr, timeout, retries);
1814 kfree(real_buffer);
1815 return ret;
1816}
1817EXPORT_SYMBOL_GPL(scsi_mode_select);
1818
1da177e4 1819/**
eb44820c 1820 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
1cf72699 1821 * @sdev: SCSI device to be queried
1da177e4
LT
1822 * @dbd: set if mode sense will allow block descriptors to be returned
1823 * @modepage: mode page being requested
1824 * @buffer: request buffer (may not be smaller than eight bytes)
1825 * @len: length of request buffer.
1826 * @timeout: command timeout
1827 * @retries: number of retries before failing
1828 * @data: returns a structure abstracting the mode header data
eb44820c 1829 * @sshdr: place to put sense data (or NULL if no sense to be collected).
1cf72699 1830 * must be SCSI_SENSE_BUFFERSIZE big.
1da177e4
LT
1831 *
1832 * Returns zero if unsuccessful, or the header offset (either 4
1833 * or 8 depending on whether a six or ten byte command was
1834 * issued) if successful.
eb44820c 1835 */
1da177e4 1836int
1cf72699 1837scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
1da177e4 1838 unsigned char *buffer, int len, int timeout, int retries,
5baba830
JB
1839 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1840{
1da177e4
LT
1841 unsigned char cmd[12];
1842 int use_10_for_ms;
1843 int header_length;
1cf72699 1844 int result;
ea73a9f2 1845 struct scsi_sense_hdr my_sshdr;
1da177e4
LT
1846
1847 memset(data, 0, sizeof(*data));
1848 memset(&cmd[0], 0, 12);
1849 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
1850 cmd[2] = modepage;
1851
ea73a9f2
JB
1852 /* caller might not be interested in sense, but we need it */
1853 if (!sshdr)
1854 sshdr = &my_sshdr;
1855
1da177e4 1856 retry:
1cf72699 1857 use_10_for_ms = sdev->use_10_for_ms;
1da177e4
LT
1858
1859 if (use_10_for_ms) {
1860 if (len < 8)
1861 len = 8;
1862
1863 cmd[0] = MODE_SENSE_10;
1864 cmd[8] = len;
1865 header_length = 8;
1866 } else {
1867 if (len < 4)
1868 len = 4;
1869
1870 cmd[0] = MODE_SENSE;
1871 cmd[4] = len;
1872 header_length = 4;
1873 }
1874
1da177e4
LT
1875 memset(buffer, 0, len);
1876
1cf72699 1877 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
ea73a9f2 1878 sshdr, timeout, retries);
1da177e4
LT
1879
1880 /* This code looks awful: what it's doing is making sure an
1881 * ILLEGAL REQUEST sense return identifies the actual command
1882 * byte as the problem. MODE_SENSE commands can return
1883 * ILLEGAL REQUEST if the code page isn't supported */
1884
1cf72699
JB
1885 if (use_10_for_ms && !scsi_status_is_good(result) &&
1886 (driver_byte(result) & DRIVER_SENSE)) {
ea73a9f2
JB
1887 if (scsi_sense_valid(sshdr)) {
1888 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
1889 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
1da177e4
LT
1890 /*
1891 * Invalid command operation code
1892 */
1cf72699 1893 sdev->use_10_for_ms = 0;
1da177e4
LT
1894 goto retry;
1895 }
1896 }
1897 }
1898
1cf72699 1899 if(scsi_status_is_good(result)) {
6d73c851
AV
1900 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
1901 (modepage == 6 || modepage == 8))) {
1902 /* Initio breakage? */
1903 header_length = 0;
1904 data->length = 13;
1905 data->medium_type = 0;
1906 data->device_specific = 0;
1907 data->longlba = 0;
1908 data->block_descriptor_length = 0;
1909 } else if(use_10_for_ms) {
1da177e4
LT
1910 data->length = buffer[0]*256 + buffer[1] + 2;
1911 data->medium_type = buffer[2];
1912 data->device_specific = buffer[3];
1913 data->longlba = buffer[4] & 0x01;
1914 data->block_descriptor_length = buffer[6]*256
1915 + buffer[7];
1916 } else {
1917 data->length = buffer[0] + 1;
1918 data->medium_type = buffer[1];
1919 data->device_specific = buffer[2];
1920 data->block_descriptor_length = buffer[3];
1921 }
6d73c851 1922 data->header_length = header_length;
1da177e4
LT
1923 }
1924
1cf72699 1925 return result;
1da177e4
LT
1926}
1927EXPORT_SYMBOL(scsi_mode_sense);
1928
001aac25
JB
1929/**
1930 * scsi_test_unit_ready - test if unit is ready
1931 * @sdev: scsi device to change the state of.
1932 * @timeout: command timeout
1933 * @retries: number of retries before failing
1934 * @sshdr_external: Optional pointer to struct scsi_sense_hdr for
1935 * returning sense. Make sure that this is cleared before passing
1936 * in.
1937 *
1938 * Returns zero if unsuccessful or an error if TUR failed. For
1939 * removable media, a return of NOT_READY or UNIT_ATTENTION is
1940 * translated to success, with the ->changed flag updated.
1941 **/
1da177e4 1942int
001aac25
JB
1943scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
1944 struct scsi_sense_hdr *sshdr_external)
1da177e4 1945{
1da177e4
LT
1946 char cmd[] = {
1947 TEST_UNIT_READY, 0, 0, 0, 0, 0,
1948 };
001aac25 1949 struct scsi_sense_hdr *sshdr;
1da177e4 1950 int result;
001aac25
JB
1951
1952 if (!sshdr_external)
1953 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
1954 else
1955 sshdr = sshdr_external;
1956
1957 /* try to eat the UNIT_ATTENTION if there are enough retries */
1958 do {
1959 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
1960 timeout, retries);
1961 } while ((driver_byte(result) & DRIVER_SENSE) &&
1962 sshdr && sshdr->sense_key == UNIT_ATTENTION &&
1963 --retries);
1964
1965 if (!sshdr)
1966 /* could not allocate sense buffer, so can't process it */
1967 return result;
1da177e4 1968
1cf72699 1969 if ((driver_byte(result) & DRIVER_SENSE) && sdev->removable) {
1da177e4 1970
001aac25
JB
1971 if ((scsi_sense_valid(sshdr)) &&
1972 ((sshdr->sense_key == UNIT_ATTENTION) ||
1973 (sshdr->sense_key == NOT_READY))) {
1da177e4 1974 sdev->changed = 1;
1cf72699 1975 result = 0;
1da177e4
LT
1976 }
1977 }
001aac25
JB
1978 if (!sshdr_external)
1979 kfree(sshdr);
1da177e4
LT
1980 return result;
1981}
1982EXPORT_SYMBOL(scsi_test_unit_ready);
1983
1984/**
eb44820c 1985 * scsi_device_set_state - Take the given device through the device state model.
1da177e4
LT
1986 * @sdev: scsi device to change the state of.
1987 * @state: state to change to.
1988 *
1989 * Returns zero if unsuccessful or an error if the requested
1990 * transition is illegal.
eb44820c 1991 */
1da177e4
LT
1992int
1993scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
1994{
1995 enum scsi_device_state oldstate = sdev->sdev_state;
1996
1997 if (state == oldstate)
1998 return 0;
1999
2000 switch (state) {
2001 case SDEV_CREATED:
2002 /* There are no legal states that come back to
2003 * created. This is the manually initialised start
2004 * state */
2005 goto illegal;
2006
2007 case SDEV_RUNNING:
2008 switch (oldstate) {
2009 case SDEV_CREATED:
2010 case SDEV_OFFLINE:
2011 case SDEV_QUIESCE:
2012 case SDEV_BLOCK:
2013 break;
2014 default:
2015 goto illegal;
2016 }
2017 break;
2018
2019 case SDEV_QUIESCE:
2020 switch (oldstate) {
2021 case SDEV_RUNNING:
2022 case SDEV_OFFLINE:
2023 break;
2024 default:
2025 goto illegal;
2026 }
2027 break;
2028
2029 case SDEV_OFFLINE:
2030 switch (oldstate) {
2031 case SDEV_CREATED:
2032 case SDEV_RUNNING:
2033 case SDEV_QUIESCE:
2034 case SDEV_BLOCK:
2035 break;
2036 default:
2037 goto illegal;
2038 }
2039 break;
2040
2041 case SDEV_BLOCK:
2042 switch (oldstate) {
2043 case SDEV_CREATED:
2044 case SDEV_RUNNING:
2045 break;
2046 default:
2047 goto illegal;
2048 }
2049 break;
2050
2051 case SDEV_CANCEL:
2052 switch (oldstate) {
2053 case SDEV_CREATED:
2054 case SDEV_RUNNING:
9ea72909 2055 case SDEV_QUIESCE:
1da177e4
LT
2056 case SDEV_OFFLINE:
2057 case SDEV_BLOCK:
2058 break;
2059 default:
2060 goto illegal;
2061 }
2062 break;
2063
2064 case SDEV_DEL:
2065 switch (oldstate) {
309bd271
BK
2066 case SDEV_CREATED:
2067 case SDEV_RUNNING:
2068 case SDEV_OFFLINE:
1da177e4
LT
2069 case SDEV_CANCEL:
2070 break;
2071 default:
2072 goto illegal;
2073 }
2074 break;
2075
2076 }
2077 sdev->sdev_state = state;
2078 return 0;
2079
2080 illegal:
2081 SCSI_LOG_ERROR_RECOVERY(1,
9ccfc756
JB
2082 sdev_printk(KERN_ERR, sdev,
2083 "Illegal state transition %s->%s\n",
2084 scsi_device_state_name(oldstate),
2085 scsi_device_state_name(state))
1da177e4
LT
2086 );
2087 return -EINVAL;
2088}
2089EXPORT_SYMBOL(scsi_device_set_state);
2090
a341cd0f
JG
2091/**
2092 * sdev_evt_emit - emit a single SCSI device uevent
2093 * @sdev: associated SCSI device
2094 * @evt: event to emit
2095 *
2096 * Send a single uevent (scsi_event) to the associated scsi_device.
2097 */
2098static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2099{
2100 int idx = 0;
2101 char *envp[3];
2102
2103 switch (evt->evt_type) {
2104 case SDEV_EVT_MEDIA_CHANGE:
2105 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2106 break;
2107
2108 default:
2109 /* do nothing */
2110 break;
2111 }
2112
2113 envp[idx++] = NULL;
2114
2115 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2116}
2117
2118/**
2119 * sdev_evt_thread - send a uevent for each scsi event
2120 * @work: work struct for scsi_device
2121 *
2122 * Dispatch queued events to their associated scsi_device kobjects
2123 * as uevents.
2124 */
2125void scsi_evt_thread(struct work_struct *work)
2126{
2127 struct scsi_device *sdev;
2128 LIST_HEAD(event_list);
2129
2130 sdev = container_of(work, struct scsi_device, event_work);
2131
2132 while (1) {
2133 struct scsi_event *evt;
2134 struct list_head *this, *tmp;
2135 unsigned long flags;
2136
2137 spin_lock_irqsave(&sdev->list_lock, flags);
2138 list_splice_init(&sdev->event_list, &event_list);
2139 spin_unlock_irqrestore(&sdev->list_lock, flags);
2140
2141 if (list_empty(&event_list))
2142 break;
2143
2144 list_for_each_safe(this, tmp, &event_list) {
2145 evt = list_entry(this, struct scsi_event, node);
2146 list_del(&evt->node);
2147 scsi_evt_emit(sdev, evt);
2148 kfree(evt);
2149 }
2150 }
2151}
2152
2153/**
2154 * sdev_evt_send - send asserted event to uevent thread
2155 * @sdev: scsi_device event occurred on
2156 * @evt: event to send
2157 *
2158 * Assert scsi device event asynchronously.
2159 */
2160void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2161{
2162 unsigned long flags;
2163
4d1566ed
KS
2164#if 0
2165 /* FIXME: currently this check eliminates all media change events
2166 * for polled devices. Need to update to discriminate between AN
2167 * and polled events */
a341cd0f
JG
2168 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2169 kfree(evt);
2170 return;
2171 }
4d1566ed 2172#endif
a341cd0f
JG
2173
2174 spin_lock_irqsave(&sdev->list_lock, flags);
2175 list_add_tail(&evt->node, &sdev->event_list);
2176 schedule_work(&sdev->event_work);
2177 spin_unlock_irqrestore(&sdev->list_lock, flags);
2178}
2179EXPORT_SYMBOL_GPL(sdev_evt_send);
2180
2181/**
2182 * sdev_evt_alloc - allocate a new scsi event
2183 * @evt_type: type of event to allocate
2184 * @gfpflags: GFP flags for allocation
2185 *
2186 * Allocates and returns a new scsi_event.
2187 */
2188struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2189 gfp_t gfpflags)
2190{
2191 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2192 if (!evt)
2193 return NULL;
2194
2195 evt->evt_type = evt_type;
2196 INIT_LIST_HEAD(&evt->node);
2197
2198 /* evt_type-specific initialization, if any */
2199 switch (evt_type) {
2200 case SDEV_EVT_MEDIA_CHANGE:
2201 default:
2202 /* do nothing */
2203 break;
2204 }
2205
2206 return evt;
2207}
2208EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2209
2210/**
2211 * sdev_evt_send_simple - send asserted event to uevent thread
2212 * @sdev: scsi_device event occurred on
2213 * @evt_type: type of event to send
2214 * @gfpflags: GFP flags for allocation
2215 *
2216 * Assert scsi device event asynchronously, given an event type.
2217 */
2218void sdev_evt_send_simple(struct scsi_device *sdev,
2219 enum scsi_device_event evt_type, gfp_t gfpflags)
2220{
2221 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2222 if (!evt) {
2223 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2224 evt_type);
2225 return;
2226 }
2227
2228 sdev_evt_send(sdev, evt);
2229}
2230EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2231
1da177e4
LT
2232/**
2233 * scsi_device_quiesce - Block user issued commands.
2234 * @sdev: scsi device to quiesce.
2235 *
2236 * This works by trying to transition to the SDEV_QUIESCE state
2237 * (which must be a legal transition). When the device is in this
2238 * state, only special requests will be accepted, all others will
2239 * be deferred. Since special requests may also be requeued requests,
2240 * a successful return doesn't guarantee the device will be
2241 * totally quiescent.
2242 *
2243 * Must be called with user context, may sleep.
2244 *
2245 * Returns zero if unsuccessful or an error if not.
eb44820c 2246 */
1da177e4
LT
2247int
2248scsi_device_quiesce(struct scsi_device *sdev)
2249{
2250 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2251 if (err)
2252 return err;
2253
2254 scsi_run_queue(sdev->request_queue);
2255 while (sdev->device_busy) {
2256 msleep_interruptible(200);
2257 scsi_run_queue(sdev->request_queue);
2258 }
2259 return 0;
2260}
2261EXPORT_SYMBOL(scsi_device_quiesce);
2262
2263/**
2264 * scsi_device_resume - Restart user issued commands to a quiesced device.
2265 * @sdev: scsi device to resume.
2266 *
2267 * Moves the device from quiesced back to running and restarts the
2268 * queues.
2269 *
2270 * Must be called with user context, may sleep.
eb44820c 2271 */
1da177e4
LT
2272void
2273scsi_device_resume(struct scsi_device *sdev)
2274{
2275 if(scsi_device_set_state(sdev, SDEV_RUNNING))
2276 return;
2277 scsi_run_queue(sdev->request_queue);
2278}
2279EXPORT_SYMBOL(scsi_device_resume);
2280
2281static void
2282device_quiesce_fn(struct scsi_device *sdev, void *data)
2283{
2284 scsi_device_quiesce(sdev);
2285}
2286
2287void
2288scsi_target_quiesce(struct scsi_target *starget)
2289{
2290 starget_for_each_device(starget, NULL, device_quiesce_fn);
2291}
2292EXPORT_SYMBOL(scsi_target_quiesce);
2293
2294static void
2295device_resume_fn(struct scsi_device *sdev, void *data)
2296{
2297 scsi_device_resume(sdev);
2298}
2299
2300void
2301scsi_target_resume(struct scsi_target *starget)
2302{
2303 starget_for_each_device(starget, NULL, device_resume_fn);
2304}
2305EXPORT_SYMBOL(scsi_target_resume);
2306
2307/**
eb44820c 2308 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
1da177e4
LT
2309 * @sdev: device to block
2310 *
2311 * Block request made by scsi lld's to temporarily stop all
2312 * scsi commands on the specified device. Called from interrupt
2313 * or normal process context.
2314 *
2315 * Returns zero if successful or error if not
2316 *
2317 * Notes:
2318 * This routine transitions the device to the SDEV_BLOCK state
2319 * (which must be a legal transition). When the device is in this
2320 * state, all commands are deferred until the scsi lld reenables
2321 * the device with scsi_device_unblock or device_block_tmo fires.
2322 * This routine assumes the host_lock is held on entry.
eb44820c 2323 */
1da177e4
LT
2324int
2325scsi_internal_device_block(struct scsi_device *sdev)
2326{
165125e1 2327 struct request_queue *q = sdev->request_queue;
1da177e4
LT
2328 unsigned long flags;
2329 int err = 0;
2330
2331 err = scsi_device_set_state(sdev, SDEV_BLOCK);
2332 if (err)
2333 return err;
2334
2335 /*
2336 * The device has transitioned to SDEV_BLOCK. Stop the
2337 * block layer from calling the midlayer with this device's
2338 * request queue.
2339 */
2340 spin_lock_irqsave(q->queue_lock, flags);
2341 blk_stop_queue(q);
2342 spin_unlock_irqrestore(q->queue_lock, flags);
2343
2344 return 0;
2345}
2346EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2347
2348/**
2349 * scsi_internal_device_unblock - resume a device after a block request
2350 * @sdev: device to resume
2351 *
2352 * Called by scsi lld's or the midlayer to restart the device queue
2353 * for the previously suspended scsi device. Called from interrupt or
2354 * normal process context.
2355 *
2356 * Returns zero if successful or error if not.
2357 *
2358 * Notes:
2359 * This routine transitions the device to the SDEV_RUNNING state
2360 * (which must be a legal transition) allowing the midlayer to
2361 * goose the queue for this device. This routine assumes the
2362 * host_lock is held upon entry.
eb44820c 2363 */
1da177e4
LT
2364int
2365scsi_internal_device_unblock(struct scsi_device *sdev)
2366{
165125e1 2367 struct request_queue *q = sdev->request_queue;
1da177e4
LT
2368 int err;
2369 unsigned long flags;
2370
2371 /*
2372 * Try to transition the scsi device to SDEV_RUNNING
2373 * and goose the device queue if successful.
2374 */
2375 err = scsi_device_set_state(sdev, SDEV_RUNNING);
2376 if (err)
2377 return err;
2378
2379 spin_lock_irqsave(q->queue_lock, flags);
2380 blk_start_queue(q);
2381 spin_unlock_irqrestore(q->queue_lock, flags);
2382
2383 return 0;
2384}
2385EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
2386
2387static void
2388device_block(struct scsi_device *sdev, void *data)
2389{
2390 scsi_internal_device_block(sdev);
2391}
2392
2393static int
2394target_block(struct device *dev, void *data)
2395{
2396 if (scsi_is_target_device(dev))
2397 starget_for_each_device(to_scsi_target(dev), NULL,
2398 device_block);
2399 return 0;
2400}
2401
2402void
2403scsi_target_block(struct device *dev)
2404{
2405 if (scsi_is_target_device(dev))
2406 starget_for_each_device(to_scsi_target(dev), NULL,
2407 device_block);
2408 else
2409 device_for_each_child(dev, NULL, target_block);
2410}
2411EXPORT_SYMBOL_GPL(scsi_target_block);
2412
2413static void
2414device_unblock(struct scsi_device *sdev, void *data)
2415{
2416 scsi_internal_device_unblock(sdev);
2417}
2418
2419static int
2420target_unblock(struct device *dev, void *data)
2421{
2422 if (scsi_is_target_device(dev))
2423 starget_for_each_device(to_scsi_target(dev), NULL,
2424 device_unblock);
2425 return 0;
2426}
2427
2428void
2429scsi_target_unblock(struct device *dev)
2430{
2431 if (scsi_is_target_device(dev))
2432 starget_for_each_device(to_scsi_target(dev), NULL,
2433 device_unblock);
2434 else
2435 device_for_each_child(dev, NULL, target_unblock);
2436}
2437EXPORT_SYMBOL_GPL(scsi_target_unblock);
cdb8c2a6
GL
2438
2439/**
2440 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
eb44820c 2441 * @sgl: scatter-gather list
cdb8c2a6
GL
2442 * @sg_count: number of segments in sg
2443 * @offset: offset in bytes into sg, on return offset into the mapped area
2444 * @len: bytes to map, on return number of bytes mapped
2445 *
2446 * Returns virtual address of the start of the mapped page
2447 */
c6132da1 2448void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
cdb8c2a6
GL
2449 size_t *offset, size_t *len)
2450{
2451 int i;
2452 size_t sg_len = 0, len_complete = 0;
c6132da1 2453 struct scatterlist *sg;
cdb8c2a6
GL
2454 struct page *page;
2455
22cfefb5
AM
2456 WARN_ON(!irqs_disabled());
2457
c6132da1 2458 for_each_sg(sgl, sg, sg_count, i) {
cdb8c2a6 2459 len_complete = sg_len; /* Complete sg-entries */
c6132da1 2460 sg_len += sg->length;
cdb8c2a6
GL
2461 if (sg_len > *offset)
2462 break;
2463 }
2464
2465 if (unlikely(i == sg_count)) {
169e1a2a
AM
2466 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2467 "elements %d\n",
cdb8c2a6
GL
2468 __FUNCTION__, sg_len, *offset, sg_count);
2469 WARN_ON(1);
2470 return NULL;
2471 }
2472
2473 /* Offset starting from the beginning of first page in this sg-entry */
c6132da1 2474 *offset = *offset - len_complete + sg->offset;
cdb8c2a6
GL
2475
2476 /* Assumption: contiguous pages can be accessed as "page + i" */
45711f1a 2477 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
cdb8c2a6
GL
2478 *offset &= ~PAGE_MASK;
2479
2480 /* Bytes in this sg-entry from *offset to the end of the page */
2481 sg_len = PAGE_SIZE - *offset;
2482 if (*len > sg_len)
2483 *len = sg_len;
2484
2485 return kmap_atomic(page, KM_BIO_SRC_IRQ);
2486}
2487EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2488
2489/**
eb44820c 2490 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
cdb8c2a6
GL
2491 * @virt: virtual address to be unmapped
2492 */
2493void scsi_kunmap_atomic_sg(void *virt)
2494{
2495 kunmap_atomic(virt, KM_BIO_SRC_IRQ);
2496}
2497EXPORT_SYMBOL(scsi_kunmap_atomic_sg);