2 * scsi_lib.c Copyright (C) 1999 Eric Youngdale
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.
10 #include <linux/bio.h>
11 #include <linux/bitops.h>
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>
20 #include <linux/hardirq.h>
21 #include <linux/scatterlist.h>
23 #include <scsi/scsi.h>
24 #include <scsi/scsi_cmnd.h>
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>
31 #include "scsi_priv.h"
32 #include "scsi_logging.h"
35 #define SG_MEMPOOL_NR ARRAY_SIZE(scsi_sg_pools)
36 #define SG_MEMPOOL_SIZE 2
38 struct scsi_host_sg_pool
{
41 struct kmem_cache
*slab
;
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)
49 static struct scsi_host_sg_pool scsi_sg_pools
[] = {
52 #if (SCSI_MAX_SG_SEGMENTS > 32)
54 #if (SCSI_MAX_SG_SEGMENTS > 64)
56 #if (SCSI_MAX_SG_SEGMENTS > 128)
58 #if (SCSI_MAX_SG_SEGMENTS > 256)
59 #error SCSI_MAX_SG_SEGMENTS is too large (256 MAX)
64 SP(SCSI_MAX_SG_SEGMENTS
)
68 static struct kmem_cache
*scsi_bidi_sdb_cache
;
70 static void scsi_run_queue(struct request_queue
*q
);
73 * Function: scsi_unprep_request()
75 * Purpose: Remove all preparation done for a request, including its
76 * associated scsi_cmnd, so that it can be requeued.
78 * Arguments: req - request to unprepare
80 * Lock status: Assumed that no locks are held upon entry.
84 static void scsi_unprep_request(struct request
*req
)
86 struct scsi_cmnd
*cmd
= req
->special
;
88 req
->cmd_flags
&= ~REQ_DONTPREP
;
91 scsi_put_command(cmd
);
95 * Function: scsi_queue_insert()
97 * Purpose: Insert a command in the midlevel queue.
99 * Arguments: cmd - command that we are adding to queue.
100 * reason - why we are inserting command to queue.
102 * Lock status: Assumed that lock is not held upon entry.
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
110 * Notes: This could be called either from an interrupt context or a
111 * normal process context.
113 int scsi_queue_insert(struct scsi_cmnd
*cmd
, int reason
)
115 struct Scsi_Host
*host
= cmd
->device
->host
;
116 struct scsi_device
*device
= cmd
->device
;
117 struct request_queue
*q
= device
->request_queue
;
121 printk("Inserting command %p into mlqueue\n", cmd
));
124 * Set the appropriate busy bit for the device/host.
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.
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.
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
;
142 * Decrement the counters, since these commands are no longer
143 * active on the host/device.
145 scsi_device_unbusy(device
);
148 * Requeue this command. It will go before all other commands
149 * that are already in the queue.
151 * NOTE: there is magic here about the way the queue is plugged if
152 * we have no outstanding commands.
154 * Although we *don't* plug the queue, we call the request
155 * function. The SCSI request function detects the blocked condition
156 * and plugs the queue appropriately.
158 spin_lock_irqsave(q
->queue_lock
, flags
);
159 blk_requeue_request(q
, cmd
->request
);
160 spin_unlock_irqrestore(q
->queue_lock
, flags
);
168 * scsi_execute - insert request and wait for the result
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
177 * @flags: or into request flags;
179 * returns the req->errors value which is the scsi_cmnd result
182 int 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
)
187 int write
= (data_direction
== DMA_TO_DEVICE
);
188 int ret
= DRIVER_ERROR
<< 24;
190 req
= blk_get_request(sdev
->request_queue
, write
, __GFP_WAIT
);
192 if (bufflen
&& blk_rq_map_kern(sdev
->request_queue
, req
,
193 buffer
, bufflen
, __GFP_WAIT
))
196 req
->cmd_len
= COMMAND_SIZE(cmd
[0]);
197 memcpy(req
->cmd
, cmd
, req
->cmd_len
);
200 req
->retries
= retries
;
201 req
->timeout
= timeout
;
202 req
->cmd_type
= REQ_TYPE_BLOCK_PC
;
203 req
->cmd_flags
|= flags
| REQ_QUIET
| REQ_PREEMPT
;
206 * head injection *required* here otherwise quiesce won't work
208 blk_execute_rq(req
->q
, NULL
, req
, 1);
212 blk_put_request(req
);
216 EXPORT_SYMBOL(scsi_execute
);
219 int 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
)
227 sense
= kzalloc(SCSI_SENSE_BUFFERSIZE
, GFP_NOIO
);
229 return DRIVER_ERROR
<< 24;
231 result
= scsi_execute(sdev
, cmd
, data_direction
, buffer
, bufflen
,
232 sense
, timeout
, retries
, 0);
234 scsi_normalize_sense(sense
, SCSI_SENSE_BUFFERSIZE
, sshdr
);
239 EXPORT_SYMBOL(scsi_execute_req
);
241 struct scsi_io_context
{
243 void (*done
)(void *data
, char *sense
, int result
, int resid
);
244 char sense
[SCSI_SENSE_BUFFERSIZE
];
247 static struct kmem_cache
*scsi_io_context_cache
;
249 static void scsi_end_async(struct request
*req
, int uptodate
)
251 struct scsi_io_context
*sioc
= req
->end_io_data
;
254 sioc
->done(sioc
->data
, sioc
->sense
, req
->errors
, req
->data_len
);
256 kmem_cache_free(scsi_io_context_cache
, sioc
);
257 __blk_put_request(req
->q
, req
);
260 static int scsi_merge_bio(struct request
*rq
, struct bio
*bio
)
262 struct request_queue
*q
= rq
->q
;
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
);
269 return blk_rq_append_bio(q
, rq
, bio
);
272 static void scsi_bi_endio(struct bio
*bio
, int error
)
278 * scsi_req_map_sg - map a scatterlist into a request
279 * @rq: request to fill
281 * @nsegs: number of elements
282 * @bufflen: len of buffer
283 * @gfp: memory allocation flags
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.
289 static int scsi_req_map_sg(struct request
*rq
, struct scatterlist
*sgl
,
290 int nsegs
, unsigned bufflen
, gfp_t gfp
)
292 struct request_queue
*q
= rq
->q
;
293 int nr_pages
= (bufflen
+ sgl
[0].offset
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
294 unsigned int data_len
= bufflen
, len
, bytes
, off
;
295 struct scatterlist
*sg
;
297 struct bio
*bio
= NULL
;
298 int i
, err
, nr_vecs
= 0;
300 for_each_sg(sgl
, sg
, nsegs
, i
) {
305 while (len
> 0 && data_len
> 0) {
307 * sg sends a scatterlist that is larger than
308 * the data_len it wants transferred for certain
311 bytes
= min_t(unsigned int, len
, PAGE_SIZE
- off
);
312 bytes
= min(bytes
, data_len
);
315 nr_vecs
= min_t(int, BIO_MAX_PAGES
, nr_pages
);
318 bio
= bio_alloc(gfp
, nr_vecs
);
323 bio
->bi_end_io
= scsi_bi_endio
;
326 if (bio_add_pc_page(q
, bio
, page
, bytes
, off
) !=
333 if (bio
->bi_vcnt
>= nr_vecs
) {
334 err
= scsi_merge_bio(rq
, bio
);
349 rq
->buffer
= rq
->data
= NULL
;
350 rq
->data_len
= bufflen
;
354 while ((bio
= rq
->bio
) != NULL
) {
355 rq
->bio
= bio
->bi_next
;
357 * call endio instead of bio_put incase it was bounced
366 * scsi_execute_async - insert request
369 * @cmd_len: length of scsi cdb
370 * @data_direction: DMA_TO_DEVICE, DMA_FROM_DEVICE, or DMA_NONE
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
376 * @privdata: data passed to done()
377 * @done: callback function when done
378 * @gfp: memory allocation flags
380 int scsi_execute_async(struct scsi_device
*sdev
, const unsigned char *cmd
,
381 int cmd_len
, int data_direction
, void *buffer
, unsigned bufflen
,
382 int use_sg
, int timeout
, int retries
, void *privdata
,
383 void (*done
)(void *, char *, int, int), gfp_t gfp
)
386 struct scsi_io_context
*sioc
;
388 int write
= (data_direction
== DMA_TO_DEVICE
);
390 sioc
= kmem_cache_zalloc(scsi_io_context_cache
, gfp
);
392 return DRIVER_ERROR
<< 24;
394 req
= blk_get_request(sdev
->request_queue
, write
, gfp
);
397 req
->cmd_type
= REQ_TYPE_BLOCK_PC
;
398 req
->cmd_flags
|= REQ_QUIET
;
401 err
= scsi_req_map_sg(req
, buffer
, use_sg
, bufflen
, gfp
);
403 err
= blk_rq_map_kern(req
->q
, req
, buffer
, bufflen
, gfp
);
408 req
->cmd_len
= cmd_len
;
409 memset(req
->cmd
, 0, BLK_MAX_CDB
); /* ATAPI hates garbage after CDB */
410 memcpy(req
->cmd
, cmd
, req
->cmd_len
);
411 req
->sense
= sioc
->sense
;
413 req
->timeout
= timeout
;
414 req
->retries
= retries
;
415 req
->end_io_data
= sioc
;
417 sioc
->data
= privdata
;
420 blk_execute_rq_nowait(req
->q
, NULL
, req
, 1, scsi_end_async
);
424 blk_put_request(req
);
426 kmem_cache_free(scsi_io_context_cache
, sioc
);
427 return DRIVER_ERROR
<< 24;
429 EXPORT_SYMBOL_GPL(scsi_execute_async
);
432 * Function: scsi_init_cmd_errh()
434 * Purpose: Initialize cmd fields related to error handling.
436 * Arguments: cmd - command that is ready to be queued.
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.
442 static void scsi_init_cmd_errh(struct scsi_cmnd
*cmd
)
444 cmd
->serial_number
= 0;
445 scsi_set_resid(cmd
, 0);
446 memset(cmd
->sense_buffer
, 0, SCSI_SENSE_BUFFERSIZE
);
447 if (cmd
->cmd_len
== 0)
448 cmd
->cmd_len
= COMMAND_SIZE(cmd
->cmnd
[0]);
451 void scsi_device_unbusy(struct scsi_device
*sdev
)
453 struct Scsi_Host
*shost
= sdev
->host
;
456 spin_lock_irqsave(shost
->host_lock
, flags
);
458 if (unlikely(scsi_host_in_recovery(shost
) &&
459 (shost
->host_failed
|| shost
->host_eh_scheduled
)))
460 scsi_eh_wakeup(shost
);
461 spin_unlock(shost
->host_lock
);
462 spin_lock(sdev
->request_queue
->queue_lock
);
464 spin_unlock_irqrestore(sdev
->request_queue
->queue_lock
, flags
);
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.
472 * Called with *no* scsi locks held.
474 static void scsi_single_lun_run(struct scsi_device
*current_sdev
)
476 struct Scsi_Host
*shost
= current_sdev
->host
;
477 struct scsi_device
*sdev
, *tmp
;
478 struct scsi_target
*starget
= scsi_target(current_sdev
);
481 spin_lock_irqsave(shost
->host_lock
, flags
);
482 starget
->starget_sdev_user
= NULL
;
483 spin_unlock_irqrestore(shost
->host_lock
, flags
);
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.
491 blk_run_queue(current_sdev
->request_queue
);
493 spin_lock_irqsave(shost
->host_lock
, flags
);
494 if (starget
->starget_sdev_user
)
496 list_for_each_entry_safe(sdev
, tmp
, &starget
->devices
,
497 same_target_siblings
) {
498 if (sdev
== current_sdev
)
500 if (scsi_device_get(sdev
))
503 spin_unlock_irqrestore(shost
->host_lock
, flags
);
504 blk_run_queue(sdev
->request_queue
);
505 spin_lock_irqsave(shost
->host_lock
, flags
);
507 scsi_device_put(sdev
);
510 spin_unlock_irqrestore(shost
->host_lock
, flags
);
514 * Function: scsi_run_queue()
516 * Purpose: Select a proper request queue to serve next
518 * Arguments: q - last request's queue
522 * Notes: The previous command was completely finished, start
523 * a new one if possible.
525 static void scsi_run_queue(struct request_queue
*q
)
527 struct scsi_device
*sdev
= q
->queuedata
;
528 struct Scsi_Host
*shost
= sdev
->host
;
531 if (scsi_target(sdev
)->single_lun
)
532 scsi_single_lun_run(sdev
);
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
))) {
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
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.
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
);
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
);
562 blk_run_queue(sdev
->request_queue
);
564 spin_lock_irqsave(shost
->host_lock
, flags
);
565 if (unlikely(!list_empty(&sdev
->starved_entry
)))
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.
573 spin_unlock_irqrestore(shost
->host_lock
, flags
);
579 * Function: scsi_requeue_command()
581 * Purpose: Handle post-processing of completed commands.
583 * Arguments: q - queue to operate on
584 * cmd - command that may need to be requeued.
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
594 * Notes: Upon return, cmd is a stale pointer.
596 static void scsi_requeue_command(struct request_queue
*q
, struct scsi_cmnd
*cmd
)
598 struct request
*req
= cmd
->request
;
601 scsi_unprep_request(req
);
602 spin_lock_irqsave(q
->queue_lock
, flags
);
603 blk_requeue_request(q
, req
);
604 spin_unlock_irqrestore(q
->queue_lock
, flags
);
609 void scsi_next_command(struct scsi_cmnd
*cmd
)
611 struct scsi_device
*sdev
= cmd
->device
;
612 struct request_queue
*q
= sdev
->request_queue
;
614 /* need to hold a reference on the device before we let go of the cmd */
615 get_device(&sdev
->sdev_gendev
);
617 scsi_put_command(cmd
);
620 /* ok to remove device now */
621 put_device(&sdev
->sdev_gendev
);
624 void scsi_run_host_queues(struct Scsi_Host
*shost
)
626 struct scsi_device
*sdev
;
628 shost_for_each_device(sdev
, shost
)
629 scsi_run_queue(sdev
->request_queue
);
633 * Function: scsi_end_request()
635 * Purpose: Post-processing of completed commands (usually invoked at end
636 * of upper level post-processing and scsi_io_completion).
638 * Arguments: cmd - command that is complete.
639 * error - 0 if I/O indicates success, < 0 for I/O error.
640 * bytes - number of bytes of completed I/O
641 * requeue - indicates whether we should requeue leftovers.
643 * Lock status: Assumed that lock is not held upon entry.
645 * Returns: cmd if requeue required, NULL otherwise.
647 * Notes: This is called for block device requests in order to
648 * mark some number of sectors as complete.
650 * We are guaranteeing that the request queue will be goosed
651 * at some point during this call.
652 * Notes: If cmd was requeued, upon return it will be a stale pointer.
654 static struct scsi_cmnd
*scsi_end_request(struct scsi_cmnd
*cmd
, int error
,
655 int bytes
, int requeue
)
657 struct request_queue
*q
= cmd
->device
->request_queue
;
658 struct request
*req
= cmd
->request
;
661 * If there are blocks left over at the end, set up the command
662 * to queue the remainder of them.
664 if (blk_end_request(req
, error
, bytes
)) {
665 int leftover
= (req
->hard_nr_sectors
<< 9);
667 if (blk_pc_request(req
))
668 leftover
= req
->data_len
;
670 /* kill remainder if no retrys */
671 if (error
&& blk_noretry_request(req
))
672 blk_end_request(req
, error
, leftover
);
676 * Bleah. Leftovers again. Stick the
677 * leftovers in the front of the
678 * queue, and goose the queue again.
680 scsi_requeue_command(q
, cmd
);
688 * This will goose the queue request function at the end, so we don't
689 * need to worry about launching another command.
691 scsi_next_command(cmd
);
695 static inline unsigned int scsi_sgtable_index(unsigned short nents
)
699 BUG_ON(nents
> SCSI_MAX_SG_SEGMENTS
);
704 index
= get_count_order(nents
) - 3;
709 static void scsi_sg_free(struct scatterlist
*sgl
, unsigned int nents
)
711 struct scsi_host_sg_pool
*sgp
;
713 sgp
= scsi_sg_pools
+ scsi_sgtable_index(nents
);
714 mempool_free(sgl
, sgp
->pool
);
717 static struct scatterlist
*scsi_sg_alloc(unsigned int nents
, gfp_t gfp_mask
)
719 struct scsi_host_sg_pool
*sgp
;
721 sgp
= scsi_sg_pools
+ scsi_sgtable_index(nents
);
722 return mempool_alloc(sgp
->pool
, gfp_mask
);
725 static int scsi_alloc_sgtable(struct scsi_data_buffer
*sdb
, int nents
,
732 ret
= __sg_alloc_table(&sdb
->table
, nents
, SCSI_MAX_SG_SEGMENTS
,
733 gfp_mask
, scsi_sg_alloc
);
735 __sg_free_table(&sdb
->table
, SCSI_MAX_SG_SEGMENTS
,
741 static void scsi_free_sgtable(struct scsi_data_buffer
*sdb
)
743 __sg_free_table(&sdb
->table
, SCSI_MAX_SG_SEGMENTS
, scsi_sg_free
);
747 * Function: scsi_release_buffers()
749 * Purpose: Completion processing for block device I/O requests.
751 * Arguments: cmd - command that we are bailing.
753 * Lock status: Assumed that no lock is held upon entry.
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
763 void scsi_release_buffers(struct scsi_cmnd
*cmd
)
765 if (cmd
->sdb
.table
.nents
)
766 scsi_free_sgtable(&cmd
->sdb
);
768 memset(&cmd
->sdb
, 0, sizeof(cmd
->sdb
));
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
;
778 EXPORT_SYMBOL(scsi_release_buffers
);
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.
787 void scsi_end_bidi_request(struct scsi_cmnd
*cmd
)
789 struct request
*req
= cmd
->request
;
790 unsigned int dlen
= req
->data_len
;
791 unsigned int next_dlen
= req
->next_rq
->data_len
;
793 req
->data_len
= scsi_out(cmd
)->resid
;
794 req
->next_rq
->data_len
= scsi_in(cmd
)->resid
;
796 /* The req and req->next_rq have not been completed */
797 BUG_ON(blk_end_bidi_request(req
, 0, dlen
, next_dlen
));
799 scsi_release_buffers(cmd
);
802 * This will goose the queue request function at the end, so we don't
803 * need to worry about launching another command.
805 scsi_next_command(cmd
);
809 * Function: scsi_io_completion()
811 * Purpose: Completion processing for block device I/O requests.
813 * Arguments: cmd - command that is finished.
815 * Lock status: Assumed that no lock is held upon entry.
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.
825 * We must do one of several things here:
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.
833 * b) We can just use scsi_requeue_command() here. This would
834 * be used if we just wanted to retry, for example.
836 void scsi_io_completion(struct scsi_cmnd
*cmd
, unsigned int good_bytes
)
838 int result
= cmd
->result
;
839 int this_count
= scsi_bufflen(cmd
);
840 struct request_queue
*q
= cmd
->device
->request_queue
;
841 struct request
*req
= cmd
->request
;
842 int clear_errors
= 1;
843 struct scsi_sense_hdr sshdr
;
845 int sense_deferred
= 0;
848 sense_valid
= scsi_command_normalize_sense(cmd
, &sshdr
);
850 sense_deferred
= scsi_sense_is_deferred(&sshdr
);
853 if (blk_pc_request(req
)) { /* SG_IO ioctl from block level */
854 req
->errors
= result
;
857 if (sense_valid
&& req
->sense
) {
859 * SG_IO wants current and deferred errors
861 int len
= 8 + cmd
->sense_buffer
[7];
863 if (len
> SCSI_SENSE_BUFFERSIZE
)
864 len
= SCSI_SENSE_BUFFERSIZE
;
865 memcpy(req
->sense
, cmd
->sense_buffer
, len
);
866 req
->sense_len
= len
;
869 if (scsi_bidi_cmnd(cmd
)) {
870 /* will also release_buffers */
871 scsi_end_bidi_request(cmd
);
874 req
->data_len
= scsi_get_resid(cmd
);
877 BUG_ON(blk_bidi_rq(req
)); /* bidi not support for !blk_pc_request yet */
878 scsi_release_buffers(cmd
);
881 * Next deal with any sectors which we were able to correctly
884 SCSI_LOG_HLCOMPLETE(1, printk("%ld sectors total, "
886 req
->nr_sectors
, good_bytes
));
891 /* A number of bytes were successfully read. If there
892 * are leftovers and there is some kind of error
893 * (result != 0), retry the rest.
895 if (scsi_end_request(cmd
, 0, good_bytes
, result
== 0) == NULL
)
898 /* good_bytes = 0, or (inclusive) there were leftovers and
899 * result = 0, so scsi_end_request couldn't retry.
901 if (sense_valid
&& !sense_deferred
) {
902 switch (sshdr
.sense_key
) {
904 if (cmd
->device
->removable
) {
905 /* Detected disc change. Set a bit
906 * and quietly refuse further access.
908 cmd
->device
->changed
= 1;
909 scsi_end_request(cmd
, -EIO
, this_count
, 1);
912 /* Must have been a power glitch, or a
913 * bus reset. Could not have been a
914 * media change, so we just retry the
915 * request and see what happens.
917 scsi_requeue_command(q
, cmd
);
921 case ILLEGAL_REQUEST
:
922 /* If we had an ILLEGAL REQUEST returned, then
923 * we may have performed an unsupported
924 * command. The only thing this should be
925 * would be a ten byte read where only a six
926 * byte read was supported. Also, on a system
927 * where READ CAPACITY failed, we may have
928 * read past the end of the disk.
930 if ((cmd
->device
->use_10_for_rw
&&
931 sshdr
.asc
== 0x20 && sshdr
.ascq
== 0x00) &&
932 (cmd
->cmnd
[0] == READ_10
||
933 cmd
->cmnd
[0] == WRITE_10
)) {
934 cmd
->device
->use_10_for_rw
= 0;
935 /* This will cause a retry with a
938 scsi_requeue_command(q
, cmd
);
941 scsi_end_request(cmd
, -EIO
, this_count
, 1);
946 /* If the device is in the process of becoming
947 * ready, or has a temporary blockage, retry.
949 if (sshdr
.asc
== 0x04) {
950 switch (sshdr
.ascq
) {
951 case 0x01: /* becoming ready */
952 case 0x04: /* format in progress */
953 case 0x05: /* rebuild in progress */
954 case 0x06: /* recalculation in progress */
955 case 0x07: /* operation in progress */
956 case 0x08: /* Long write in progress */
957 case 0x09: /* self test in progress */
958 scsi_requeue_command(q
, cmd
);
964 if (!(req
->cmd_flags
& REQ_QUIET
))
965 scsi_cmd_print_sense_hdr(cmd
,
969 scsi_end_request(cmd
, -EIO
, this_count
, 1);
971 case VOLUME_OVERFLOW
:
972 if (!(req
->cmd_flags
& REQ_QUIET
)) {
973 scmd_printk(KERN_INFO
, cmd
,
974 "Volume overflow, CDB: ");
975 __scsi_print_command(cmd
->cmnd
);
976 scsi_print_sense("", cmd
);
978 /* See SSC3rXX or current. */
979 scsi_end_request(cmd
, -EIO
, this_count
, 1);
985 if (host_byte(result
) == DID_RESET
) {
986 /* Third party bus reset or reset for error recovery
987 * reasons. Just retry the request and see what
990 scsi_requeue_command(q
, cmd
);
994 if (!(req
->cmd_flags
& REQ_QUIET
)) {
995 scsi_print_result(cmd
);
996 if (driver_byte(result
) & DRIVER_SENSE
)
997 scsi_print_sense("", cmd
);
1000 scsi_end_request(cmd
, -EIO
, this_count
, !result
);
1003 static int scsi_init_sgtable(struct request
*req
, struct scsi_data_buffer
*sdb
,
1009 * If sg table allocation fails, requeue request later.
1011 if (unlikely(scsi_alloc_sgtable(sdb
, req
->nr_phys_segments
,
1013 return BLKPREP_DEFER
;
1017 if (blk_pc_request(req
))
1018 sdb
->length
= req
->data_len
;
1020 sdb
->length
= req
->nr_sectors
<< 9;
1023 * Next, walk the list, and fill in the addresses and sizes of
1026 count
= blk_rq_map_sg(req
->q
, req
, sdb
->table
.sgl
);
1027 BUG_ON(count
> sdb
->table
.nents
);
1028 sdb
->table
.nents
= count
;
1033 * Function: scsi_init_io()
1035 * Purpose: SCSI I/O initialize function.
1037 * Arguments: cmd - Command descriptor we wish to initialize
1039 * Returns: 0 on success
1040 * BLKPREP_DEFER if the failure is retryable
1041 * BLKPREP_KILL if the failure is fatal
1043 int scsi_init_io(struct scsi_cmnd
*cmd
, gfp_t gfp_mask
)
1045 int error
= scsi_init_sgtable(cmd
->request
, &cmd
->sdb
, gfp_mask
);
1049 if (blk_bidi_rq(cmd
->request
)) {
1050 struct scsi_data_buffer
*bidi_sdb
= kmem_cache_zalloc(
1051 scsi_bidi_sdb_cache
, GFP_ATOMIC
);
1053 error
= BLKPREP_DEFER
;
1057 cmd
->request
->next_rq
->special
= bidi_sdb
;
1058 error
= scsi_init_sgtable(cmd
->request
->next_rq
, bidi_sdb
,
1067 scsi_release_buffers(cmd
);
1068 if (error
== BLKPREP_KILL
)
1069 scsi_put_command(cmd
);
1070 else /* BLKPREP_DEFER */
1071 scsi_unprep_request(cmd
->request
);
1075 EXPORT_SYMBOL(scsi_init_io
);
1077 static struct scsi_cmnd
*scsi_get_cmd_from_req(struct scsi_device
*sdev
,
1078 struct request
*req
)
1080 struct scsi_cmnd
*cmd
;
1082 if (!req
->special
) {
1083 cmd
= scsi_get_command(sdev
, GFP_ATOMIC
);
1091 /* pull a tag out of the request if we have one */
1092 cmd
->tag
= req
->tag
;
1098 int scsi_setup_blk_pc_cmnd(struct scsi_device
*sdev
, struct request
*req
)
1100 struct scsi_cmnd
*cmd
;
1101 int ret
= scsi_prep_state_check(sdev
, req
);
1103 if (ret
!= BLKPREP_OK
)
1106 cmd
= scsi_get_cmd_from_req(sdev
, req
);
1108 return BLKPREP_DEFER
;
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.
1119 BUG_ON(!req
->nr_phys_segments
);
1121 ret
= scsi_init_io(cmd
, GFP_ATOMIC
);
1125 BUG_ON(req
->data_len
);
1128 memset(&cmd
->sdb
, 0, sizeof(cmd
->sdb
));
1132 BUILD_BUG_ON(sizeof(req
->cmd
) > sizeof(cmd
->cmnd
));
1133 memcpy(cmd
->cmnd
, req
->cmd
, sizeof(cmd
->cmnd
));
1134 cmd
->cmd_len
= req
->cmd_len
;
1136 cmd
->sc_data_direction
= DMA_NONE
;
1137 else if (rq_data_dir(req
) == WRITE
)
1138 cmd
->sc_data_direction
= DMA_TO_DEVICE
;
1140 cmd
->sc_data_direction
= DMA_FROM_DEVICE
;
1142 cmd
->transfersize
= req
->data_len
;
1143 cmd
->allowed
= req
->retries
;
1144 cmd
->timeout_per_command
= req
->timeout
;
1147 EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd
);
1150 * Setup a REQ_TYPE_FS command. These are simple read/write request
1151 * from filesystems that still need to be translated to SCSI CDBs from
1154 int scsi_setup_fs_cmnd(struct scsi_device
*sdev
, struct request
*req
)
1156 struct scsi_cmnd
*cmd
;
1157 int ret
= scsi_prep_state_check(sdev
, req
);
1159 if (ret
!= BLKPREP_OK
)
1162 * Filesystem requests must transfer data.
1164 BUG_ON(!req
->nr_phys_segments
);
1166 cmd
= scsi_get_cmd_from_req(sdev
, req
);
1168 return BLKPREP_DEFER
;
1170 return scsi_init_io(cmd
, GFP_ATOMIC
);
1172 EXPORT_SYMBOL(scsi_setup_fs_cmnd
);
1174 int scsi_prep_state_check(struct scsi_device
*sdev
, struct request
*req
)
1176 int ret
= BLKPREP_OK
;
1179 * If the device is not in running state we will reject some
1182 if (unlikely(sdev
->sdev_state
!= SDEV_RUNNING
)) {
1183 switch (sdev
->sdev_state
) {
1186 * If the device is offline we refuse to process any
1187 * commands. The device must be brought online
1188 * before trying any recovery commands.
1190 sdev_printk(KERN_ERR
, sdev
,
1191 "rejecting I/O to offline device\n");
1196 * If the device is fully deleted, we refuse to
1197 * process any commands as well.
1199 sdev_printk(KERN_ERR
, sdev
,
1200 "rejecting I/O to dead device\n");
1206 * If the devices is blocked we defer normal commands.
1208 if (!(req
->cmd_flags
& REQ_PREEMPT
))
1209 ret
= BLKPREP_DEFER
;
1213 * For any other not fully online state we only allow
1214 * special commands. In particular any user initiated
1215 * command is not allowed.
1217 if (!(req
->cmd_flags
& REQ_PREEMPT
))
1224 EXPORT_SYMBOL(scsi_prep_state_check
);
1226 int scsi_prep_return(struct request_queue
*q
, struct request
*req
, int ret
)
1228 struct scsi_device
*sdev
= q
->queuedata
;
1232 req
->errors
= DID_NO_CONNECT
<< 16;
1233 /* release the command and kill it */
1235 struct scsi_cmnd
*cmd
= req
->special
;
1236 scsi_release_buffers(cmd
);
1237 scsi_put_command(cmd
);
1238 req
->special
= NULL
;
1243 * If we defer, the elv_next_request() returns NULL, but the
1244 * queue must be restarted, so we plug here if no returning
1245 * command will automatically do that.
1247 if (sdev
->device_busy
== 0)
1251 req
->cmd_flags
|= REQ_DONTPREP
;
1256 EXPORT_SYMBOL(scsi_prep_return
);
1258 int scsi_prep_fn(struct request_queue
*q
, struct request
*req
)
1260 struct scsi_device
*sdev
= q
->queuedata
;
1261 int ret
= BLKPREP_KILL
;
1263 if (req
->cmd_type
== REQ_TYPE_BLOCK_PC
)
1264 ret
= scsi_setup_blk_pc_cmnd(sdev
, req
);
1265 return scsi_prep_return(q
, req
, ret
);
1269 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1272 * Called with the queue_lock held.
1274 static inline int scsi_dev_queue_ready(struct request_queue
*q
,
1275 struct scsi_device
*sdev
)
1277 if (sdev
->device_busy
>= sdev
->queue_depth
)
1279 if (sdev
->device_busy
== 0 && sdev
->device_blocked
) {
1281 * unblock after device_blocked iterates to zero
1283 if (--sdev
->device_blocked
== 0) {
1285 sdev_printk(KERN_INFO
, sdev
,
1286 "unblocking device at zero depth\n"));
1292 if (sdev
->device_blocked
)
1299 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1300 * return 0. We must end up running the queue again whenever 0 is
1301 * returned, else IO can hang.
1303 * Called with host_lock held.
1305 static inline int scsi_host_queue_ready(struct request_queue
*q
,
1306 struct Scsi_Host
*shost
,
1307 struct scsi_device
*sdev
)
1309 if (scsi_host_in_recovery(shost
))
1311 if (shost
->host_busy
== 0 && shost
->host_blocked
) {
1313 * unblock after host_blocked iterates to zero
1315 if (--shost
->host_blocked
== 0) {
1317 printk("scsi%d unblocking host at zero depth\n",
1324 if ((shost
->can_queue
> 0 && shost
->host_busy
>= shost
->can_queue
) ||
1325 shost
->host_blocked
|| shost
->host_self_blocked
) {
1326 if (list_empty(&sdev
->starved_entry
))
1327 list_add_tail(&sdev
->starved_entry
, &shost
->starved_list
);
1331 /* We're OK to process the command, so we can't be starved */
1332 if (!list_empty(&sdev
->starved_entry
))
1333 list_del_init(&sdev
->starved_entry
);
1339 * Kill a request for a dead device
1341 static void scsi_kill_request(struct request
*req
, struct request_queue
*q
)
1343 struct scsi_cmnd
*cmd
= req
->special
;
1344 struct scsi_device
*sdev
= cmd
->device
;
1345 struct Scsi_Host
*shost
= sdev
->host
;
1347 blkdev_dequeue_request(req
);
1349 if (unlikely(cmd
== NULL
)) {
1350 printk(KERN_CRIT
"impossible request in %s.\n",
1355 scsi_init_cmd_errh(cmd
);
1356 cmd
->result
= DID_NO_CONNECT
<< 16;
1357 atomic_inc(&cmd
->device
->iorequest_cnt
);
1360 * SCSI request completion path will do scsi_device_unbusy(),
1361 * bump busy counts. To bump the counters, we need to dance
1362 * with the locks as normal issue path does.
1364 sdev
->device_busy
++;
1365 spin_unlock(sdev
->request_queue
->queue_lock
);
1366 spin_lock(shost
->host_lock
);
1368 spin_unlock(shost
->host_lock
);
1369 spin_lock(sdev
->request_queue
->queue_lock
);
1374 static void scsi_softirq_done(struct request
*rq
)
1376 struct scsi_cmnd
*cmd
= rq
->completion_data
;
1377 unsigned long wait_for
= (cmd
->allowed
+ 1) * cmd
->timeout_per_command
;
1380 INIT_LIST_HEAD(&cmd
->eh_entry
);
1382 disposition
= scsi_decide_disposition(cmd
);
1383 if (disposition
!= SUCCESS
&&
1384 time_before(cmd
->jiffies_at_alloc
+ wait_for
, jiffies
)) {
1385 sdev_printk(KERN_ERR
, cmd
->device
,
1386 "timing out command, waited %lus\n",
1388 disposition
= SUCCESS
;
1391 scsi_log_completion(cmd
, disposition
);
1393 switch (disposition
) {
1395 scsi_finish_command(cmd
);
1398 scsi_queue_insert(cmd
, SCSI_MLQUEUE_EH_RETRY
);
1400 case ADD_TO_MLQUEUE
:
1401 scsi_queue_insert(cmd
, SCSI_MLQUEUE_DEVICE_BUSY
);
1404 if (!scsi_eh_scmd_add(cmd
, 0))
1405 scsi_finish_command(cmd
);
1410 * Function: scsi_request_fn()
1412 * Purpose: Main strategy routine for SCSI.
1414 * Arguments: q - Pointer to actual queue.
1418 * Lock status: IO request lock assumed to be held when called.
1420 static void scsi_request_fn(struct request_queue
*q
)
1422 struct scsi_device
*sdev
= q
->queuedata
;
1423 struct Scsi_Host
*shost
;
1424 struct scsi_cmnd
*cmd
;
1425 struct request
*req
;
1428 printk("scsi: killing requests for dead queue\n");
1429 while ((req
= elv_next_request(q
)) != NULL
)
1430 scsi_kill_request(req
, q
);
1434 if(!get_device(&sdev
->sdev_gendev
))
1435 /* We must be tearing the block queue down already */
1439 * To start with, we keep looping until the queue is empty, or until
1440 * the host is no longer able to accept any more requests.
1443 while (!blk_queue_plugged(q
)) {
1446 * get next queueable request. We do this early to make sure
1447 * that the request is fully prepared even if we cannot
1450 req
= elv_next_request(q
);
1451 if (!req
|| !scsi_dev_queue_ready(q
, sdev
))
1454 if (unlikely(!scsi_device_online(sdev
))) {
1455 sdev_printk(KERN_ERR
, sdev
,
1456 "rejecting I/O to offline device\n");
1457 scsi_kill_request(req
, q
);
1463 * Remove the request from the request list.
1465 if (!(blk_queue_tagged(q
) && !blk_queue_start_tag(q
, req
)))
1466 blkdev_dequeue_request(req
);
1467 sdev
->device_busy
++;
1469 spin_unlock(q
->queue_lock
);
1471 if (unlikely(cmd
== NULL
)) {
1472 printk(KERN_CRIT
"impossible request in %s.\n"
1473 "please mail a stack trace to "
1474 "linux-scsi@vger.kernel.org\n",
1476 blk_dump_rq_flags(req
, "foo");
1479 spin_lock(shost
->host_lock
);
1481 if (!scsi_host_queue_ready(q
, shost
, sdev
))
1483 if (scsi_target(sdev
)->single_lun
) {
1484 if (scsi_target(sdev
)->starget_sdev_user
&&
1485 scsi_target(sdev
)->starget_sdev_user
!= sdev
)
1487 scsi_target(sdev
)->starget_sdev_user
= sdev
;
1492 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1493 * take the lock again.
1495 spin_unlock_irq(shost
->host_lock
);
1498 * Finally, initialize any error handling parameters, and set up
1499 * the timers for timeouts.
1501 scsi_init_cmd_errh(cmd
);
1504 * Dispatch the command to the low-level driver.
1506 rtn
= scsi_dispatch_cmd(cmd
);
1507 spin_lock_irq(q
->queue_lock
);
1509 /* we're refusing the command; because of
1510 * the way locks get dropped, we need to
1511 * check here if plugging is required */
1512 if(sdev
->device_busy
== 0)
1522 spin_unlock_irq(shost
->host_lock
);
1525 * lock q, handle tag, requeue req, and decrement device_busy. We
1526 * must return with queue_lock held.
1528 * Decrementing device_busy without checking it is OK, as all such
1529 * cases (host limits or settings) should run the queue at some
1532 spin_lock_irq(q
->queue_lock
);
1533 blk_requeue_request(q
, req
);
1534 sdev
->device_busy
--;
1535 if(sdev
->device_busy
== 0)
1538 /* must be careful here...if we trigger the ->remove() function
1539 * we cannot be holding the q lock */
1540 spin_unlock_irq(q
->queue_lock
);
1541 put_device(&sdev
->sdev_gendev
);
1542 spin_lock_irq(q
->queue_lock
);
1545 u64
scsi_calculate_bounce_limit(struct Scsi_Host
*shost
)
1547 struct device
*host_dev
;
1548 u64 bounce_limit
= 0xffffffff;
1550 if (shost
->unchecked_isa_dma
)
1551 return BLK_BOUNCE_ISA
;
1553 * Platforms with virtual-DMA translation
1554 * hardware have no practical limit.
1556 if (!PCI_DMA_BUS_IS_PHYS
)
1557 return BLK_BOUNCE_ANY
;
1559 host_dev
= scsi_get_device(shost
);
1560 if (host_dev
&& host_dev
->dma_mask
)
1561 bounce_limit
= *host_dev
->dma_mask
;
1563 return bounce_limit
;
1565 EXPORT_SYMBOL(scsi_calculate_bounce_limit
);
1567 struct request_queue
*__scsi_alloc_queue(struct Scsi_Host
*shost
,
1568 request_fn_proc
*request_fn
)
1570 struct request_queue
*q
;
1571 struct device
*dev
= shost
->shost_gendev
.parent
;
1573 q
= blk_init_queue(request_fn
, NULL
);
1578 * this limit is imposed by hardware restrictions
1580 blk_queue_max_hw_segments(q
, shost
->sg_tablesize
);
1581 blk_queue_max_phys_segments(q
, SCSI_MAX_SG_CHAIN_SEGMENTS
);
1583 blk_queue_max_sectors(q
, shost
->max_sectors
);
1584 blk_queue_bounce_limit(q
, scsi_calculate_bounce_limit(shost
));
1585 blk_queue_segment_boundary(q
, shost
->dma_boundary
);
1586 dma_set_seg_boundary(dev
, shost
->dma_boundary
);
1588 blk_queue_max_segment_size(q
, dma_get_max_seg_size(dev
));
1590 if (!shost
->use_clustering
)
1591 clear_bit(QUEUE_FLAG_CLUSTER
, &q
->queue_flags
);
1594 * set a reasonable default alignment on word boundaries: the
1595 * host and device may alter it using
1596 * blk_queue_update_dma_alignment() later.
1598 blk_queue_dma_alignment(q
, 0x03);
1602 EXPORT_SYMBOL(__scsi_alloc_queue
);
1604 struct request_queue
*scsi_alloc_queue(struct scsi_device
*sdev
)
1606 struct request_queue
*q
;
1608 q
= __scsi_alloc_queue(sdev
->host
, scsi_request_fn
);
1612 blk_queue_prep_rq(q
, scsi_prep_fn
);
1613 blk_queue_softirq_done(q
, scsi_softirq_done
);
1617 void scsi_free_queue(struct request_queue
*q
)
1619 blk_cleanup_queue(q
);
1623 * Function: scsi_block_requests()
1625 * Purpose: Utility function used by low-level drivers to prevent further
1626 * commands from being queued to the device.
1628 * Arguments: shost - Host in question
1632 * Lock status: No locks are assumed held.
1634 * Notes: There is no timer nor any other means by which the requests
1635 * get unblocked other than the low-level driver calling
1636 * scsi_unblock_requests().
1638 void scsi_block_requests(struct Scsi_Host
*shost
)
1640 shost
->host_self_blocked
= 1;
1642 EXPORT_SYMBOL(scsi_block_requests
);
1645 * Function: scsi_unblock_requests()
1647 * Purpose: Utility function used by low-level drivers to allow further
1648 * commands from being queued to the device.
1650 * Arguments: shost - Host in question
1654 * Lock status: No locks are assumed held.
1656 * Notes: There is no timer nor any other means by which the requests
1657 * get unblocked other than the low-level driver calling
1658 * scsi_unblock_requests().
1660 * This is done as an API function so that changes to the
1661 * internals of the scsi mid-layer won't require wholesale
1662 * changes to drivers that use this feature.
1664 void scsi_unblock_requests(struct Scsi_Host
*shost
)
1666 shost
->host_self_blocked
= 0;
1667 scsi_run_host_queues(shost
);
1669 EXPORT_SYMBOL(scsi_unblock_requests
);
1671 int __init
scsi_init_queue(void)
1675 scsi_io_context_cache
= kmem_cache_create("scsi_io_context",
1676 sizeof(struct scsi_io_context
),
1678 if (!scsi_io_context_cache
) {
1679 printk(KERN_ERR
"SCSI: can't init scsi io context cache\n");
1683 scsi_bidi_sdb_cache
= kmem_cache_create("scsi_bidi_sdb",
1684 sizeof(struct scsi_data_buffer
),
1686 if (!scsi_bidi_sdb_cache
) {
1687 printk(KERN_ERR
"SCSI: can't init scsi bidi sdb cache\n");
1688 goto cleanup_io_context
;
1691 for (i
= 0; i
< SG_MEMPOOL_NR
; i
++) {
1692 struct scsi_host_sg_pool
*sgp
= scsi_sg_pools
+ i
;
1693 int size
= sgp
->size
* sizeof(struct scatterlist
);
1695 sgp
->slab
= kmem_cache_create(sgp
->name
, size
, 0,
1696 SLAB_HWCACHE_ALIGN
, NULL
);
1698 printk(KERN_ERR
"SCSI: can't init sg slab %s\n",
1700 goto cleanup_bidi_sdb
;
1703 sgp
->pool
= mempool_create_slab_pool(SG_MEMPOOL_SIZE
,
1706 printk(KERN_ERR
"SCSI: can't init sg mempool %s\n",
1708 goto cleanup_bidi_sdb
;
1715 for (i
= 0; i
< SG_MEMPOOL_NR
; i
++) {
1716 struct scsi_host_sg_pool
*sgp
= scsi_sg_pools
+ i
;
1718 mempool_destroy(sgp
->pool
);
1720 kmem_cache_destroy(sgp
->slab
);
1722 kmem_cache_destroy(scsi_bidi_sdb_cache
);
1724 kmem_cache_destroy(scsi_io_context_cache
);
1729 void scsi_exit_queue(void)
1733 kmem_cache_destroy(scsi_io_context_cache
);
1734 kmem_cache_destroy(scsi_bidi_sdb_cache
);
1736 for (i
= 0; i
< SG_MEMPOOL_NR
; i
++) {
1737 struct scsi_host_sg_pool
*sgp
= scsi_sg_pools
+ i
;
1738 mempool_destroy(sgp
->pool
);
1739 kmem_cache_destroy(sgp
->slab
);
1744 * scsi_mode_select - issue a mode select
1745 * @sdev: SCSI device to be queried
1746 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1747 * @sp: Save page bit (0 == don't save, 1 == save)
1748 * @modepage: mode page being requested
1749 * @buffer: request buffer (may not be smaller than eight bytes)
1750 * @len: length of request buffer.
1751 * @timeout: command timeout
1752 * @retries: number of retries before failing
1753 * @data: returns a structure abstracting the mode header data
1754 * @sshdr: place to put sense data (or NULL if no sense to be collected).
1755 * must be SCSI_SENSE_BUFFERSIZE big.
1757 * Returns zero if successful; negative error number or scsi
1762 scsi_mode_select(struct scsi_device
*sdev
, int pf
, int sp
, int modepage
,
1763 unsigned char *buffer
, int len
, int timeout
, int retries
,
1764 struct scsi_mode_data
*data
, struct scsi_sense_hdr
*sshdr
)
1766 unsigned char cmd
[10];
1767 unsigned char *real_buffer
;
1770 memset(cmd
, 0, sizeof(cmd
));
1771 cmd
[1] = (pf
? 0x10 : 0) | (sp
? 0x01 : 0);
1773 if (sdev
->use_10_for_ms
) {
1776 real_buffer
= kmalloc(8 + len
, GFP_KERNEL
);
1779 memcpy(real_buffer
+ 8, buffer
, len
);
1783 real_buffer
[2] = data
->medium_type
;
1784 real_buffer
[3] = data
->device_specific
;
1785 real_buffer
[4] = data
->longlba
? 0x01 : 0;
1787 real_buffer
[6] = data
->block_descriptor_length
>> 8;
1788 real_buffer
[7] = data
->block_descriptor_length
;
1790 cmd
[0] = MODE_SELECT_10
;
1794 if (len
> 255 || data
->block_descriptor_length
> 255 ||
1798 real_buffer
= kmalloc(4 + len
, GFP_KERNEL
);
1801 memcpy(real_buffer
+ 4, buffer
, len
);
1804 real_buffer
[1] = data
->medium_type
;
1805 real_buffer
[2] = data
->device_specific
;
1806 real_buffer
[3] = data
->block_descriptor_length
;
1809 cmd
[0] = MODE_SELECT
;
1813 ret
= scsi_execute_req(sdev
, cmd
, DMA_TO_DEVICE
, real_buffer
, len
,
1814 sshdr
, timeout
, retries
);
1818 EXPORT_SYMBOL_GPL(scsi_mode_select
);
1821 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
1822 * @sdev: SCSI device to be queried
1823 * @dbd: set if mode sense will allow block descriptors to be returned
1824 * @modepage: mode page being requested
1825 * @buffer: request buffer (may not be smaller than eight bytes)
1826 * @len: length of request buffer.
1827 * @timeout: command timeout
1828 * @retries: number of retries before failing
1829 * @data: returns a structure abstracting the mode header data
1830 * @sshdr: place to put sense data (or NULL if no sense to be collected).
1831 * must be SCSI_SENSE_BUFFERSIZE big.
1833 * Returns zero if unsuccessful, or the header offset (either 4
1834 * or 8 depending on whether a six or ten byte command was
1835 * issued) if successful.
1838 scsi_mode_sense(struct scsi_device
*sdev
, int dbd
, int modepage
,
1839 unsigned char *buffer
, int len
, int timeout
, int retries
,
1840 struct scsi_mode_data
*data
, struct scsi_sense_hdr
*sshdr
)
1842 unsigned char cmd
[12];
1846 struct scsi_sense_hdr my_sshdr
;
1848 memset(data
, 0, sizeof(*data
));
1849 memset(&cmd
[0], 0, 12);
1850 cmd
[1] = dbd
& 0x18; /* allows DBD and LLBA bits */
1853 /* caller might not be interested in sense, but we need it */
1858 use_10_for_ms
= sdev
->use_10_for_ms
;
1860 if (use_10_for_ms
) {
1864 cmd
[0] = MODE_SENSE_10
;
1871 cmd
[0] = MODE_SENSE
;
1876 memset(buffer
, 0, len
);
1878 result
= scsi_execute_req(sdev
, cmd
, DMA_FROM_DEVICE
, buffer
, len
,
1879 sshdr
, timeout
, retries
);
1881 /* This code looks awful: what it's doing is making sure an
1882 * ILLEGAL REQUEST sense return identifies the actual command
1883 * byte as the problem. MODE_SENSE commands can return
1884 * ILLEGAL REQUEST if the code page isn't supported */
1886 if (use_10_for_ms
&& !scsi_status_is_good(result
) &&
1887 (driver_byte(result
) & DRIVER_SENSE
)) {
1888 if (scsi_sense_valid(sshdr
)) {
1889 if ((sshdr
->sense_key
== ILLEGAL_REQUEST
) &&
1890 (sshdr
->asc
== 0x20) && (sshdr
->ascq
== 0)) {
1892 * Invalid command operation code
1894 sdev
->use_10_for_ms
= 0;
1900 if(scsi_status_is_good(result
)) {
1901 if (unlikely(buffer
[0] == 0x86 && buffer
[1] == 0x0b &&
1902 (modepage
== 6 || modepage
== 8))) {
1903 /* Initio breakage? */
1906 data
->medium_type
= 0;
1907 data
->device_specific
= 0;
1909 data
->block_descriptor_length
= 0;
1910 } else if(use_10_for_ms
) {
1911 data
->length
= buffer
[0]*256 + buffer
[1] + 2;
1912 data
->medium_type
= buffer
[2];
1913 data
->device_specific
= buffer
[3];
1914 data
->longlba
= buffer
[4] & 0x01;
1915 data
->block_descriptor_length
= buffer
[6]*256
1918 data
->length
= buffer
[0] + 1;
1919 data
->medium_type
= buffer
[1];
1920 data
->device_specific
= buffer
[2];
1921 data
->block_descriptor_length
= buffer
[3];
1923 data
->header_length
= header_length
;
1928 EXPORT_SYMBOL(scsi_mode_sense
);
1931 * scsi_test_unit_ready - test if unit is ready
1932 * @sdev: scsi device to change the state of.
1933 * @timeout: command timeout
1934 * @retries: number of retries before failing
1935 * @sshdr_external: Optional pointer to struct scsi_sense_hdr for
1936 * returning sense. Make sure that this is cleared before passing
1939 * Returns zero if unsuccessful or an error if TUR failed. For
1940 * removable media, a return of NOT_READY or UNIT_ATTENTION is
1941 * translated to success, with the ->changed flag updated.
1944 scsi_test_unit_ready(struct scsi_device
*sdev
, int timeout
, int retries
,
1945 struct scsi_sense_hdr
*sshdr_external
)
1948 TEST_UNIT_READY
, 0, 0, 0, 0, 0,
1950 struct scsi_sense_hdr
*sshdr
;
1953 if (!sshdr_external
)
1954 sshdr
= kzalloc(sizeof(*sshdr
), GFP_KERNEL
);
1956 sshdr
= sshdr_external
;
1958 /* try to eat the UNIT_ATTENTION if there are enough retries */
1960 result
= scsi_execute_req(sdev
, cmd
, DMA_NONE
, NULL
, 0, sshdr
,
1962 } while ((driver_byte(result
) & DRIVER_SENSE
) &&
1963 sshdr
&& sshdr
->sense_key
== UNIT_ATTENTION
&&
1967 /* could not allocate sense buffer, so can't process it */
1970 if ((driver_byte(result
) & DRIVER_SENSE
) && sdev
->removable
) {
1972 if ((scsi_sense_valid(sshdr
)) &&
1973 ((sshdr
->sense_key
== UNIT_ATTENTION
) ||
1974 (sshdr
->sense_key
== NOT_READY
))) {
1979 if (!sshdr_external
)
1983 EXPORT_SYMBOL(scsi_test_unit_ready
);
1986 * scsi_device_set_state - Take the given device through the device state model.
1987 * @sdev: scsi device to change the state of.
1988 * @state: state to change to.
1990 * Returns zero if unsuccessful or an error if the requested
1991 * transition is illegal.
1994 scsi_device_set_state(struct scsi_device
*sdev
, enum scsi_device_state state
)
1996 enum scsi_device_state oldstate
= sdev
->sdev_state
;
1998 if (state
== oldstate
)
2003 /* There are no legal states that come back to
2004 * created. This is the manually initialised start
2078 sdev
->sdev_state
= state
;
2082 SCSI_LOG_ERROR_RECOVERY(1,
2083 sdev_printk(KERN_ERR
, sdev
,
2084 "Illegal state transition %s->%s\n",
2085 scsi_device_state_name(oldstate
),
2086 scsi_device_state_name(state
))
2090 EXPORT_SYMBOL(scsi_device_set_state
);
2093 * sdev_evt_emit - emit a single SCSI device uevent
2094 * @sdev: associated SCSI device
2095 * @evt: event to emit
2097 * Send a single uevent (scsi_event) to the associated scsi_device.
2099 static void scsi_evt_emit(struct scsi_device
*sdev
, struct scsi_event
*evt
)
2104 switch (evt
->evt_type
) {
2105 case SDEV_EVT_MEDIA_CHANGE
:
2106 envp
[idx
++] = "SDEV_MEDIA_CHANGE=1";
2116 kobject_uevent_env(&sdev
->sdev_gendev
.kobj
, KOBJ_CHANGE
, envp
);
2120 * sdev_evt_thread - send a uevent for each scsi event
2121 * @work: work struct for scsi_device
2123 * Dispatch queued events to their associated scsi_device kobjects
2126 void scsi_evt_thread(struct work_struct
*work
)
2128 struct scsi_device
*sdev
;
2129 LIST_HEAD(event_list
);
2131 sdev
= container_of(work
, struct scsi_device
, event_work
);
2134 struct scsi_event
*evt
;
2135 struct list_head
*this, *tmp
;
2136 unsigned long flags
;
2138 spin_lock_irqsave(&sdev
->list_lock
, flags
);
2139 list_splice_init(&sdev
->event_list
, &event_list
);
2140 spin_unlock_irqrestore(&sdev
->list_lock
, flags
);
2142 if (list_empty(&event_list
))
2145 list_for_each_safe(this, tmp
, &event_list
) {
2146 evt
= list_entry(this, struct scsi_event
, node
);
2147 list_del(&evt
->node
);
2148 scsi_evt_emit(sdev
, evt
);
2155 * sdev_evt_send - send asserted event to uevent thread
2156 * @sdev: scsi_device event occurred on
2157 * @evt: event to send
2159 * Assert scsi device event asynchronously.
2161 void sdev_evt_send(struct scsi_device
*sdev
, struct scsi_event
*evt
)
2163 unsigned long flags
;
2165 if (!test_bit(evt
->evt_type
, sdev
->supported_events
)) {
2170 spin_lock_irqsave(&sdev
->list_lock
, flags
);
2171 list_add_tail(&evt
->node
, &sdev
->event_list
);
2172 schedule_work(&sdev
->event_work
);
2173 spin_unlock_irqrestore(&sdev
->list_lock
, flags
);
2175 EXPORT_SYMBOL_GPL(sdev_evt_send
);
2178 * sdev_evt_alloc - allocate a new scsi event
2179 * @evt_type: type of event to allocate
2180 * @gfpflags: GFP flags for allocation
2182 * Allocates and returns a new scsi_event.
2184 struct scsi_event
*sdev_evt_alloc(enum scsi_device_event evt_type
,
2187 struct scsi_event
*evt
= kzalloc(sizeof(struct scsi_event
), gfpflags
);
2191 evt
->evt_type
= evt_type
;
2192 INIT_LIST_HEAD(&evt
->node
);
2194 /* evt_type-specific initialization, if any */
2196 case SDEV_EVT_MEDIA_CHANGE
:
2204 EXPORT_SYMBOL_GPL(sdev_evt_alloc
);
2207 * sdev_evt_send_simple - send asserted event to uevent thread
2208 * @sdev: scsi_device event occurred on
2209 * @evt_type: type of event to send
2210 * @gfpflags: GFP flags for allocation
2212 * Assert scsi device event asynchronously, given an event type.
2214 void sdev_evt_send_simple(struct scsi_device
*sdev
,
2215 enum scsi_device_event evt_type
, gfp_t gfpflags
)
2217 struct scsi_event
*evt
= sdev_evt_alloc(evt_type
, gfpflags
);
2219 sdev_printk(KERN_ERR
, sdev
, "event %d eaten due to OOM\n",
2224 sdev_evt_send(sdev
, evt
);
2226 EXPORT_SYMBOL_GPL(sdev_evt_send_simple
);
2229 * scsi_device_quiesce - Block user issued commands.
2230 * @sdev: scsi device to quiesce.
2232 * This works by trying to transition to the SDEV_QUIESCE state
2233 * (which must be a legal transition). When the device is in this
2234 * state, only special requests will be accepted, all others will
2235 * be deferred. Since special requests may also be requeued requests,
2236 * a successful return doesn't guarantee the device will be
2237 * totally quiescent.
2239 * Must be called with user context, may sleep.
2241 * Returns zero if unsuccessful or an error if not.
2244 scsi_device_quiesce(struct scsi_device
*sdev
)
2246 int err
= scsi_device_set_state(sdev
, SDEV_QUIESCE
);
2250 scsi_run_queue(sdev
->request_queue
);
2251 while (sdev
->device_busy
) {
2252 msleep_interruptible(200);
2253 scsi_run_queue(sdev
->request_queue
);
2257 EXPORT_SYMBOL(scsi_device_quiesce
);
2260 * scsi_device_resume - Restart user issued commands to a quiesced device.
2261 * @sdev: scsi device to resume.
2263 * Moves the device from quiesced back to running and restarts the
2266 * Must be called with user context, may sleep.
2269 scsi_device_resume(struct scsi_device
*sdev
)
2271 if(scsi_device_set_state(sdev
, SDEV_RUNNING
))
2273 scsi_run_queue(sdev
->request_queue
);
2275 EXPORT_SYMBOL(scsi_device_resume
);
2278 device_quiesce_fn(struct scsi_device
*sdev
, void *data
)
2280 scsi_device_quiesce(sdev
);
2284 scsi_target_quiesce(struct scsi_target
*starget
)
2286 starget_for_each_device(starget
, NULL
, device_quiesce_fn
);
2288 EXPORT_SYMBOL(scsi_target_quiesce
);
2291 device_resume_fn(struct scsi_device
*sdev
, void *data
)
2293 scsi_device_resume(sdev
);
2297 scsi_target_resume(struct scsi_target
*starget
)
2299 starget_for_each_device(starget
, NULL
, device_resume_fn
);
2301 EXPORT_SYMBOL(scsi_target_resume
);
2304 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
2305 * @sdev: device to block
2307 * Block request made by scsi lld's to temporarily stop all
2308 * scsi commands on the specified device. Called from interrupt
2309 * or normal process context.
2311 * Returns zero if successful or error if not
2314 * This routine transitions the device to the SDEV_BLOCK state
2315 * (which must be a legal transition). When the device is in this
2316 * state, all commands are deferred until the scsi lld reenables
2317 * the device with scsi_device_unblock or device_block_tmo fires.
2318 * This routine assumes the host_lock is held on entry.
2321 scsi_internal_device_block(struct scsi_device
*sdev
)
2323 struct request_queue
*q
= sdev
->request_queue
;
2324 unsigned long flags
;
2327 err
= scsi_device_set_state(sdev
, SDEV_BLOCK
);
2332 * The device has transitioned to SDEV_BLOCK. Stop the
2333 * block layer from calling the midlayer with this device's
2336 spin_lock_irqsave(q
->queue_lock
, flags
);
2338 spin_unlock_irqrestore(q
->queue_lock
, flags
);
2342 EXPORT_SYMBOL_GPL(scsi_internal_device_block
);
2345 * scsi_internal_device_unblock - resume a device after a block request
2346 * @sdev: device to resume
2348 * Called by scsi lld's or the midlayer to restart the device queue
2349 * for the previously suspended scsi device. Called from interrupt or
2350 * normal process context.
2352 * Returns zero if successful or error if not.
2355 * This routine transitions the device to the SDEV_RUNNING state
2356 * (which must be a legal transition) allowing the midlayer to
2357 * goose the queue for this device. This routine assumes the
2358 * host_lock is held upon entry.
2361 scsi_internal_device_unblock(struct scsi_device
*sdev
)
2363 struct request_queue
*q
= sdev
->request_queue
;
2365 unsigned long flags
;
2368 * Try to transition the scsi device to SDEV_RUNNING
2369 * and goose the device queue if successful.
2371 err
= scsi_device_set_state(sdev
, SDEV_RUNNING
);
2375 spin_lock_irqsave(q
->queue_lock
, flags
);
2377 spin_unlock_irqrestore(q
->queue_lock
, flags
);
2381 EXPORT_SYMBOL_GPL(scsi_internal_device_unblock
);
2384 device_block(struct scsi_device
*sdev
, void *data
)
2386 scsi_internal_device_block(sdev
);
2390 target_block(struct device
*dev
, void *data
)
2392 if (scsi_is_target_device(dev
))
2393 starget_for_each_device(to_scsi_target(dev
), NULL
,
2399 scsi_target_block(struct device
*dev
)
2401 if (scsi_is_target_device(dev
))
2402 starget_for_each_device(to_scsi_target(dev
), NULL
,
2405 device_for_each_child(dev
, NULL
, target_block
);
2407 EXPORT_SYMBOL_GPL(scsi_target_block
);
2410 device_unblock(struct scsi_device
*sdev
, void *data
)
2412 scsi_internal_device_unblock(sdev
);
2416 target_unblock(struct device
*dev
, void *data
)
2418 if (scsi_is_target_device(dev
))
2419 starget_for_each_device(to_scsi_target(dev
), NULL
,
2425 scsi_target_unblock(struct device
*dev
)
2427 if (scsi_is_target_device(dev
))
2428 starget_for_each_device(to_scsi_target(dev
), NULL
,
2431 device_for_each_child(dev
, NULL
, target_unblock
);
2433 EXPORT_SYMBOL_GPL(scsi_target_unblock
);
2436 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
2437 * @sgl: scatter-gather list
2438 * @sg_count: number of segments in sg
2439 * @offset: offset in bytes into sg, on return offset into the mapped area
2440 * @len: bytes to map, on return number of bytes mapped
2442 * Returns virtual address of the start of the mapped page
2444 void *scsi_kmap_atomic_sg(struct scatterlist
*sgl
, int sg_count
,
2445 size_t *offset
, size_t *len
)
2448 size_t sg_len
= 0, len_complete
= 0;
2449 struct scatterlist
*sg
;
2452 WARN_ON(!irqs_disabled());
2454 for_each_sg(sgl
, sg
, sg_count
, i
) {
2455 len_complete
= sg_len
; /* Complete sg-entries */
2456 sg_len
+= sg
->length
;
2457 if (sg_len
> *offset
)
2461 if (unlikely(i
== sg_count
)) {
2462 printk(KERN_ERR
"%s: Bytes in sg: %zu, requested offset %zu, "
2464 __FUNCTION__
, sg_len
, *offset
, sg_count
);
2469 /* Offset starting from the beginning of first page in this sg-entry */
2470 *offset
= *offset
- len_complete
+ sg
->offset
;
2472 /* Assumption: contiguous pages can be accessed as "page + i" */
2473 page
= nth_page(sg_page(sg
), (*offset
>> PAGE_SHIFT
));
2474 *offset
&= ~PAGE_MASK
;
2476 /* Bytes in this sg-entry from *offset to the end of the page */
2477 sg_len
= PAGE_SIZE
- *offset
;
2481 return kmap_atomic(page
, KM_BIO_SRC_IRQ
);
2483 EXPORT_SYMBOL(scsi_kmap_atomic_sg
);
2486 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
2487 * @virt: virtual address to be unmapped
2489 void scsi_kunmap_atomic_sg(void *virt
)
2491 kunmap_atomic(virt
, KM_BIO_SRC_IRQ
);
2493 EXPORT_SYMBOL(scsi_kunmap_atomic_sg
);