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/blkdev.h>
12 #include <linux/completion.h>
13 #include <linux/kernel.h>
14 #include <linux/mempool.h>
15 #include <linux/slab.h>
16 #include <linux/init.h>
17 #include <linux/pci.h>
18 #include <linux/delay.h>
20 #include <scsi/scsi.h>
21 #include <scsi/scsi_dbg.h>
22 #include <scsi/scsi_device.h>
23 #include <scsi/scsi_driver.h>
24 #include <scsi/scsi_eh.h>
25 #include <scsi/scsi_host.h>
26 #include <scsi/scsi_request.h>
28 #include "scsi_priv.h"
29 #include "scsi_logging.h"
32 #define SG_MEMPOOL_NR (sizeof(scsi_sg_pools)/sizeof(struct scsi_host_sg_pool))
33 #define SG_MEMPOOL_SIZE 32
35 struct scsi_host_sg_pool
{
42 #if (SCSI_MAX_PHYS_SEGMENTS < 32)
43 #error SCSI_MAX_PHYS_SEGMENTS is too small
46 #define SP(x) { x, "sgpool-" #x }
47 static struct scsi_host_sg_pool scsi_sg_pools
[] = {
51 #if (SCSI_MAX_PHYS_SEGMENTS > 32)
53 #if (SCSI_MAX_PHYS_SEGMENTS > 64)
55 #if (SCSI_MAX_PHYS_SEGMENTS > 128)
57 #if (SCSI_MAX_PHYS_SEGMENTS > 256)
58 #error SCSI_MAX_PHYS_SEGMENTS is too large
66 static void scsi_run_queue(struct request_queue
*q
);
69 * Function: scsi_unprep_request()
71 * Purpose: Remove all preparation done for a request, including its
72 * associated scsi_cmnd, so that it can be requeued.
74 * Arguments: req - request to unprepare
76 * Lock status: Assumed that no locks are held upon entry.
80 static void scsi_unprep_request(struct request
*req
)
82 struct scsi_cmnd
*cmd
= req
->special
;
84 req
->flags
&= ~REQ_DONTPREP
;
85 req
->special
= (req
->flags
& REQ_SPECIAL
) ? cmd
->sc_request
: NULL
;
87 scsi_put_command(cmd
);
91 * Function: scsi_queue_insert()
93 * Purpose: Insert a command in the midlevel queue.
95 * Arguments: cmd - command that we are adding to queue.
96 * reason - why we are inserting command to queue.
98 * Lock status: Assumed that lock is not held upon entry.
102 * Notes: We do this for one of two cases. Either the host is busy
103 * and it cannot accept any more commands for the time being,
104 * or the device returned QUEUE_FULL and can accept no more
106 * Notes: This could be called either from an interrupt context or a
107 * normal process context.
109 int scsi_queue_insert(struct scsi_cmnd
*cmd
, int reason
)
111 struct Scsi_Host
*host
= cmd
->device
->host
;
112 struct scsi_device
*device
= cmd
->device
;
113 struct request_queue
*q
= device
->request_queue
;
117 printk("Inserting command %p into mlqueue\n", cmd
));
120 * Set the appropriate busy bit for the device/host.
122 * If the host/device isn't busy, assume that something actually
123 * completed, and that we should be able to queue a command now.
125 * Note that the prior mid-layer assumption that any host could
126 * always queue at least one command is now broken. The mid-layer
127 * will implement a user specifiable stall (see
128 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
129 * if a command is requeued with no other commands outstanding
130 * either for the device or for the host.
132 if (reason
== SCSI_MLQUEUE_HOST_BUSY
)
133 host
->host_blocked
= host
->max_host_blocked
;
134 else if (reason
== SCSI_MLQUEUE_DEVICE_BUSY
)
135 device
->device_blocked
= device
->max_device_blocked
;
138 * Decrement the counters, since these commands are no longer
139 * active on the host/device.
141 scsi_device_unbusy(device
);
144 * Requeue this command. It will go before all other commands
145 * that are already in the queue.
147 * NOTE: there is magic here about the way the queue is plugged if
148 * we have no outstanding commands.
150 * Although we *don't* plug the queue, we call the request
151 * function. The SCSI request function detects the blocked condition
152 * and plugs the queue appropriately.
154 spin_lock_irqsave(q
->queue_lock
, flags
);
155 blk_requeue_request(q
, cmd
->request
);
156 spin_unlock_irqrestore(q
->queue_lock
, flags
);
164 * Function: scsi_do_req
166 * Purpose: Queue a SCSI request
168 * Arguments: sreq - command descriptor.
169 * cmnd - actual SCSI command to be performed.
170 * buffer - data buffer.
171 * bufflen - size of data buffer.
172 * done - completion function to be run.
173 * timeout - how long to let it run before timeout.
174 * retries - number of retries we allow.
176 * Lock status: No locks held upon entry.
180 * Notes: This function is only used for queueing requests for things
181 * like ioctls and character device requests - this is because
182 * we essentially just inject a request into the queue for the
185 * In order to support the scsi_device_quiesce function, we
186 * now inject requests on the *head* of the device queue
187 * rather than the tail.
189 void scsi_do_req(struct scsi_request
*sreq
, const void *cmnd
,
190 void *buffer
, unsigned bufflen
,
191 void (*done
)(struct scsi_cmnd
*),
192 int timeout
, int retries
)
195 * If the upper level driver is reusing these things, then
196 * we should release the low-level block now. Another one will
197 * be allocated later when this request is getting queued.
199 __scsi_release_request(sreq
);
202 * Our own function scsi_done (which marks the host as not busy,
203 * disables the timeout counter, etc) will be called by us or by the
204 * scsi_hosts[host].queuecommand() function needs to also call
205 * the completion function for the high level driver.
207 memcpy(sreq
->sr_cmnd
, cmnd
, sizeof(sreq
->sr_cmnd
));
208 sreq
->sr_bufflen
= bufflen
;
209 sreq
->sr_buffer
= buffer
;
210 sreq
->sr_allowed
= retries
;
211 sreq
->sr_done
= done
;
212 sreq
->sr_timeout_per_command
= timeout
;
214 if (sreq
->sr_cmd_len
== 0)
215 sreq
->sr_cmd_len
= COMMAND_SIZE(sreq
->sr_cmnd
[0]);
218 * head injection *required* here otherwise quiesce won't work
220 * Because users of this function are apt to reuse requests with no
221 * modification, we have to sanitise the request flags here
223 sreq
->sr_request
->flags
&= ~REQ_DONTPREP
;
224 blk_insert_request(sreq
->sr_device
->request_queue
, sreq
->sr_request
,
227 EXPORT_SYMBOL(scsi_do_req
);
230 * scsi_execute - insert request and wait for the result
233 * @data_direction: data direction
234 * @buffer: data buffer
235 * @bufflen: len of buffer
236 * @sense: optional sense buffer
237 * @timeout: request timeout in seconds
238 * @retries: number of times to retry request
239 * @flags: or into request flags;
241 * returns the req->errors value which is the the scsi_cmnd result
244 int scsi_execute(struct scsi_device
*sdev
, const unsigned char *cmd
,
245 int data_direction
, void *buffer
, unsigned bufflen
,
246 unsigned char *sense
, int timeout
, int retries
, int flags
)
249 int write
= (data_direction
== DMA_TO_DEVICE
);
250 int ret
= DRIVER_ERROR
<< 24;
252 req
= blk_get_request(sdev
->request_queue
, write
, __GFP_WAIT
);
254 if (bufflen
&& blk_rq_map_kern(sdev
->request_queue
, req
,
255 buffer
, bufflen
, __GFP_WAIT
))
258 req
->cmd_len
= COMMAND_SIZE(cmd
[0]);
259 memcpy(req
->cmd
, cmd
, req
->cmd_len
);
262 req
->retries
= retries
;
263 req
->timeout
= timeout
;
264 req
->flags
|= flags
| REQ_BLOCK_PC
| REQ_SPECIAL
| REQ_QUIET
;
267 * head injection *required* here otherwise quiesce won't work
269 blk_execute_rq(req
->q
, NULL
, req
, 1);
273 blk_put_request(req
);
277 EXPORT_SYMBOL(scsi_execute
);
280 int scsi_execute_req(struct scsi_device
*sdev
, const unsigned char *cmd
,
281 int data_direction
, void *buffer
, unsigned bufflen
,
282 struct scsi_sense_hdr
*sshdr
, int timeout
, int retries
)
288 sense
= kmalloc(SCSI_SENSE_BUFFERSIZE
, GFP_NOIO
);
290 return DRIVER_ERROR
<< 24;
291 memset(sense
, 0, SCSI_SENSE_BUFFERSIZE
);
293 result
= scsi_execute(sdev
, cmd
, data_direction
, buffer
, bufflen
,
294 sense
, timeout
, retries
, 0);
296 scsi_normalize_sense(sense
, SCSI_SENSE_BUFFERSIZE
, sshdr
);
301 EXPORT_SYMBOL(scsi_execute_req
);
303 struct scsi_io_context
{
305 void (*done
)(void *data
, char *sense
, int result
, int resid
);
306 char sense
[SCSI_SENSE_BUFFERSIZE
];
309 static kmem_cache_t
*scsi_io_context_cache
;
311 static void scsi_end_async(struct request
*req
, int uptodate
)
313 struct scsi_io_context
*sioc
= req
->end_io_data
;
316 sioc
->done(sioc
->data
, sioc
->sense
, req
->errors
, req
->data_len
);
318 kmem_cache_free(scsi_io_context_cache
, sioc
);
319 __blk_put_request(req
->q
, req
);
322 static int scsi_merge_bio(struct request
*rq
, struct bio
*bio
)
324 struct request_queue
*q
= rq
->q
;
326 bio
->bi_flags
&= ~(1 << BIO_SEG_VALID
);
327 if (rq_data_dir(rq
) == WRITE
)
328 bio
->bi_rw
|= (1 << BIO_RW
);
329 blk_queue_bounce(q
, &bio
);
332 blk_rq_bio_prep(q
, rq
, bio
);
333 else if (!q
->back_merge_fn(q
, rq
, bio
))
336 rq
->biotail
->bi_next
= bio
;
338 rq
->hard_nr_sectors
+= bio_sectors(bio
);
339 rq
->nr_sectors
= rq
->hard_nr_sectors
;
345 static int scsi_bi_endio(struct bio
*bio
, unsigned int bytes_done
, int error
)
355 * scsi_req_map_sg - map a scatterlist into a request
356 * @rq: request to fill
358 * @nsegs: number of elements
359 * @bufflen: len of buffer
360 * @gfp: memory allocation flags
362 * scsi_req_map_sg maps a scatterlist into a request so that the
363 * request can be sent to the block layer. We do not trust the scatterlist
364 * sent to use, as some ULDs use that struct to only organize the pages.
366 static int scsi_req_map_sg(struct request
*rq
, struct scatterlist
*sgl
,
367 int nsegs
, unsigned bufflen
, gfp_t gfp
)
369 struct request_queue
*q
= rq
->q
;
370 int nr_pages
= (bufflen
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
371 unsigned int data_len
= 0, len
, bytes
, off
;
373 struct bio
*bio
= NULL
;
374 int i
, err
, nr_vecs
= 0;
376 for (i
= 0; i
< nsegs
; i
++) {
383 bytes
= min_t(unsigned int, len
, PAGE_SIZE
- off
);
386 nr_vecs
= min_t(int, BIO_MAX_PAGES
, nr_pages
);
389 bio
= bio_alloc(gfp
, nr_vecs
);
394 bio
->bi_end_io
= scsi_bi_endio
;
397 if (bio_add_pc_page(q
, bio
, page
, bytes
, off
) !=
404 if (bio
->bi_vcnt
>= nr_vecs
) {
405 err
= scsi_merge_bio(rq
, bio
);
407 bio_endio(bio
, bio
->bi_size
, 0);
419 rq
->buffer
= rq
->data
= NULL
;
420 rq
->data_len
= data_len
;
424 while ((bio
= rq
->bio
) != NULL
) {
425 rq
->bio
= bio
->bi_next
;
427 * call endio instead of bio_put incase it was bounced
429 bio_endio(bio
, bio
->bi_size
, 0);
436 * scsi_execute_async - insert request
439 * @data_direction: data direction
440 * @buffer: data buffer (this can be a kernel buffer or scatterlist)
441 * @bufflen: len of buffer
442 * @use_sg: if buffer is a scatterlist this is the number of elements
443 * @timeout: request timeout in seconds
444 * @retries: number of times to retry request
445 * @flags: or into request flags
447 int scsi_execute_async(struct scsi_device
*sdev
, const unsigned char *cmd
,
448 int data_direction
, void *buffer
, unsigned bufflen
,
449 int use_sg
, int timeout
, int retries
, void *privdata
,
450 void (*done
)(void *, char *, int, int), gfp_t gfp
)
453 struct scsi_io_context
*sioc
;
455 int write
= (data_direction
== DMA_TO_DEVICE
);
457 sioc
= kmem_cache_alloc(scsi_io_context_cache
, gfp
);
459 return DRIVER_ERROR
<< 24;
460 memset(sioc
, 0, sizeof(*sioc
));
462 req
= blk_get_request(sdev
->request_queue
, write
, gfp
);
465 req
->flags
|= REQ_BLOCK_PC
| REQ_QUIET
;
468 err
= scsi_req_map_sg(req
, buffer
, use_sg
, bufflen
, gfp
);
470 err
= blk_rq_map_kern(req
->q
, req
, buffer
, bufflen
, gfp
);
475 req
->cmd_len
= COMMAND_SIZE(cmd
[0]);
476 memcpy(req
->cmd
, cmd
, req
->cmd_len
);
477 req
->sense
= sioc
->sense
;
479 req
->timeout
= timeout
;
480 req
->retries
= retries
;
481 req
->end_io_data
= sioc
;
483 sioc
->data
= privdata
;
486 blk_execute_rq_nowait(req
->q
, NULL
, req
, 1, scsi_end_async
);
490 blk_put_request(req
);
493 return DRIVER_ERROR
<< 24;
495 EXPORT_SYMBOL_GPL(scsi_execute_async
);
498 * Function: scsi_init_cmd_errh()
500 * Purpose: Initialize cmd fields related to error handling.
502 * Arguments: cmd - command that is ready to be queued.
506 * Notes: This function has the job of initializing a number of
507 * fields related to error handling. Typically this will
508 * be called once for each command, as required.
510 static int scsi_init_cmd_errh(struct scsi_cmnd
*cmd
)
512 cmd
->serial_number
= 0;
514 memset(cmd
->sense_buffer
, 0, sizeof cmd
->sense_buffer
);
516 if (cmd
->cmd_len
== 0)
517 cmd
->cmd_len
= COMMAND_SIZE(cmd
->cmnd
[0]);
520 * We need saved copies of a number of fields - this is because
521 * error handling may need to overwrite these with different values
522 * to run different commands, and once error handling is complete,
523 * we will need to restore these values prior to running the actual
526 cmd
->old_use_sg
= cmd
->use_sg
;
527 cmd
->old_cmd_len
= cmd
->cmd_len
;
528 cmd
->sc_old_data_direction
= cmd
->sc_data_direction
;
529 cmd
->old_underflow
= cmd
->underflow
;
530 memcpy(cmd
->data_cmnd
, cmd
->cmnd
, sizeof(cmd
->cmnd
));
531 cmd
->buffer
= cmd
->request_buffer
;
532 cmd
->bufflen
= cmd
->request_bufflen
;
538 * Function: scsi_setup_cmd_retry()
540 * Purpose: Restore the command state for a retry
542 * Arguments: cmd - command to be restored
546 * Notes: Immediately prior to retrying a command, we need
547 * to restore certain fields that we saved above.
549 void scsi_setup_cmd_retry(struct scsi_cmnd
*cmd
)
551 memcpy(cmd
->cmnd
, cmd
->data_cmnd
, sizeof(cmd
->data_cmnd
));
552 cmd
->request_buffer
= cmd
->buffer
;
553 cmd
->request_bufflen
= cmd
->bufflen
;
554 cmd
->use_sg
= cmd
->old_use_sg
;
555 cmd
->cmd_len
= cmd
->old_cmd_len
;
556 cmd
->sc_data_direction
= cmd
->sc_old_data_direction
;
557 cmd
->underflow
= cmd
->old_underflow
;
560 void scsi_device_unbusy(struct scsi_device
*sdev
)
562 struct Scsi_Host
*shost
= sdev
->host
;
565 spin_lock_irqsave(shost
->host_lock
, flags
);
567 if (unlikely(scsi_host_in_recovery(shost
) &&
569 scsi_eh_wakeup(shost
);
570 spin_unlock(shost
->host_lock
);
571 spin_lock(sdev
->request_queue
->queue_lock
);
573 spin_unlock_irqrestore(sdev
->request_queue
->queue_lock
, flags
);
577 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
578 * and call blk_run_queue for all the scsi_devices on the target -
579 * including current_sdev first.
581 * Called with *no* scsi locks held.
583 static void scsi_single_lun_run(struct scsi_device
*current_sdev
)
585 struct Scsi_Host
*shost
= current_sdev
->host
;
586 struct scsi_device
*sdev
, *tmp
;
587 struct scsi_target
*starget
= scsi_target(current_sdev
);
590 spin_lock_irqsave(shost
->host_lock
, flags
);
591 starget
->starget_sdev_user
= NULL
;
592 spin_unlock_irqrestore(shost
->host_lock
, flags
);
595 * Call blk_run_queue for all LUNs on the target, starting with
596 * current_sdev. We race with others (to set starget_sdev_user),
597 * but in most cases, we will be first. Ideally, each LU on the
598 * target would get some limited time or requests on the target.
600 blk_run_queue(current_sdev
->request_queue
);
602 spin_lock_irqsave(shost
->host_lock
, flags
);
603 if (starget
->starget_sdev_user
)
605 list_for_each_entry_safe(sdev
, tmp
, &starget
->devices
,
606 same_target_siblings
) {
607 if (sdev
== current_sdev
)
609 if (scsi_device_get(sdev
))
612 spin_unlock_irqrestore(shost
->host_lock
, flags
);
613 blk_run_queue(sdev
->request_queue
);
614 spin_lock_irqsave(shost
->host_lock
, flags
);
616 scsi_device_put(sdev
);
619 spin_unlock_irqrestore(shost
->host_lock
, flags
);
623 * Function: scsi_run_queue()
625 * Purpose: Select a proper request queue to serve next
627 * Arguments: q - last request's queue
631 * Notes: The previous command was completely finished, start
632 * a new one if possible.
634 static void scsi_run_queue(struct request_queue
*q
)
636 struct scsi_device
*sdev
= q
->queuedata
;
637 struct Scsi_Host
*shost
= sdev
->host
;
640 if (sdev
->single_lun
)
641 scsi_single_lun_run(sdev
);
643 spin_lock_irqsave(shost
->host_lock
, flags
);
644 while (!list_empty(&shost
->starved_list
) &&
645 !shost
->host_blocked
&& !shost
->host_self_blocked
&&
646 !((shost
->can_queue
> 0) &&
647 (shost
->host_busy
>= shost
->can_queue
))) {
649 * As long as shost is accepting commands and we have
650 * starved queues, call blk_run_queue. scsi_request_fn
651 * drops the queue_lock and can add us back to the
654 * host_lock protects the starved_list and starved_entry.
655 * scsi_request_fn must get the host_lock before checking
656 * or modifying starved_list or starved_entry.
658 sdev
= list_entry(shost
->starved_list
.next
,
659 struct scsi_device
, starved_entry
);
660 list_del_init(&sdev
->starved_entry
);
661 spin_unlock_irqrestore(shost
->host_lock
, flags
);
663 blk_run_queue(sdev
->request_queue
);
665 spin_lock_irqsave(shost
->host_lock
, flags
);
666 if (unlikely(!list_empty(&sdev
->starved_entry
)))
668 * sdev lost a race, and was put back on the
669 * starved list. This is unlikely but without this
670 * in theory we could loop forever.
674 spin_unlock_irqrestore(shost
->host_lock
, flags
);
680 * Function: scsi_requeue_command()
682 * Purpose: Handle post-processing of completed commands.
684 * Arguments: q - queue to operate on
685 * cmd - command that may need to be requeued.
689 * Notes: After command completion, there may be blocks left
690 * over which weren't finished by the previous command
691 * this can be for a number of reasons - the main one is
692 * I/O errors in the middle of the request, in which case
693 * we need to request the blocks that come after the bad
695 * Notes: Upon return, cmd is a stale pointer.
697 static void scsi_requeue_command(struct request_queue
*q
, struct scsi_cmnd
*cmd
)
699 struct request
*req
= cmd
->request
;
702 scsi_unprep_request(req
);
703 spin_lock_irqsave(q
->queue_lock
, flags
);
704 blk_requeue_request(q
, req
);
705 spin_unlock_irqrestore(q
->queue_lock
, flags
);
710 void scsi_next_command(struct scsi_cmnd
*cmd
)
712 struct scsi_device
*sdev
= cmd
->device
;
713 struct request_queue
*q
= sdev
->request_queue
;
715 /* need to hold a reference on the device before we let go of the cmd */
716 get_device(&sdev
->sdev_gendev
);
718 scsi_put_command(cmd
);
721 /* ok to remove device now */
722 put_device(&sdev
->sdev_gendev
);
725 void scsi_run_host_queues(struct Scsi_Host
*shost
)
727 struct scsi_device
*sdev
;
729 shost_for_each_device(sdev
, shost
)
730 scsi_run_queue(sdev
->request_queue
);
734 * Function: scsi_end_request()
736 * Purpose: Post-processing of completed commands (usually invoked at end
737 * of upper level post-processing and scsi_io_completion).
739 * Arguments: cmd - command that is complete.
740 * uptodate - 1 if I/O indicates success, <= 0 for I/O error.
741 * bytes - number of bytes of completed I/O
742 * requeue - indicates whether we should requeue leftovers.
744 * Lock status: Assumed that lock is not held upon entry.
746 * Returns: cmd if requeue required, NULL otherwise.
748 * Notes: This is called for block device requests in order to
749 * mark some number of sectors as complete.
751 * We are guaranteeing that the request queue will be goosed
752 * at some point during this call.
753 * Notes: If cmd was requeued, upon return it will be a stale pointer.
755 static struct scsi_cmnd
*scsi_end_request(struct scsi_cmnd
*cmd
, int uptodate
,
756 int bytes
, int requeue
)
758 request_queue_t
*q
= cmd
->device
->request_queue
;
759 struct request
*req
= cmd
->request
;
763 * If there are blocks left over at the end, set up the command
764 * to queue the remainder of them.
766 if (end_that_request_chunk(req
, uptodate
, bytes
)) {
767 int leftover
= (req
->hard_nr_sectors
<< 9);
769 if (blk_pc_request(req
))
770 leftover
= req
->data_len
;
772 /* kill remainder if no retrys */
773 if (!uptodate
&& blk_noretry_request(req
))
774 end_that_request_chunk(req
, 0, leftover
);
778 * Bleah. Leftovers again. Stick the
779 * leftovers in the front of the
780 * queue, and goose the queue again.
782 scsi_requeue_command(q
, cmd
);
789 add_disk_randomness(req
->rq_disk
);
791 spin_lock_irqsave(q
->queue_lock
, flags
);
792 if (blk_rq_tagged(req
))
793 blk_queue_end_tag(q
, req
);
794 end_that_request_last(req
, uptodate
);
795 spin_unlock_irqrestore(q
->queue_lock
, flags
);
798 * This will goose the queue request function at the end, so we don't
799 * need to worry about launching another command.
801 scsi_next_command(cmd
);
805 static struct scatterlist
*scsi_alloc_sgtable(struct scsi_cmnd
*cmd
, gfp_t gfp_mask
)
807 struct scsi_host_sg_pool
*sgp
;
808 struct scatterlist
*sgl
;
810 BUG_ON(!cmd
->use_sg
);
812 switch (cmd
->use_sg
) {
822 #if (SCSI_MAX_PHYS_SEGMENTS > 32)
826 #if (SCSI_MAX_PHYS_SEGMENTS > 64)
830 #if (SCSI_MAX_PHYS_SEGMENTS > 128)
841 sgp
= scsi_sg_pools
+ cmd
->sglist_len
;
842 sgl
= mempool_alloc(sgp
->pool
, gfp_mask
);
846 static void scsi_free_sgtable(struct scatterlist
*sgl
, int index
)
848 struct scsi_host_sg_pool
*sgp
;
850 BUG_ON(index
>= SG_MEMPOOL_NR
);
852 sgp
= scsi_sg_pools
+ index
;
853 mempool_free(sgl
, sgp
->pool
);
857 * Function: scsi_release_buffers()
859 * Purpose: Completion processing for block device I/O requests.
861 * Arguments: cmd - command that we are bailing.
863 * Lock status: Assumed that no lock is held upon entry.
867 * Notes: In the event that an upper level driver rejects a
868 * command, we must release resources allocated during
869 * the __init_io() function. Primarily this would involve
870 * the scatter-gather table, and potentially any bounce
873 static void scsi_release_buffers(struct scsi_cmnd
*cmd
)
875 struct request
*req
= cmd
->request
;
878 * Free up any indirection buffers we allocated for DMA purposes.
881 scsi_free_sgtable(cmd
->request_buffer
, cmd
->sglist_len
);
882 else if (cmd
->request_buffer
!= req
->buffer
)
883 kfree(cmd
->request_buffer
);
886 * Zero these out. They now point to freed memory, and it is
887 * dangerous to hang onto the pointers.
891 cmd
->request_buffer
= NULL
;
892 cmd
->request_bufflen
= 0;
896 * Function: scsi_io_completion()
898 * Purpose: Completion processing for block device I/O requests.
900 * Arguments: cmd - command that is finished.
902 * Lock status: Assumed that no lock is held upon entry.
906 * Notes: This function is matched in terms of capabilities to
907 * the function that created the scatter-gather list.
908 * In other words, if there are no bounce buffers
909 * (the normal case for most drivers), we don't need
910 * the logic to deal with cleaning up afterwards.
912 * We must do one of several things here:
914 * a) Call scsi_end_request. This will finish off the
915 * specified number of sectors. If we are done, the
916 * command block will be released, and the queue
917 * function will be goosed. If we are not done, then
918 * scsi_end_request will directly goose the queue.
920 * b) We can just use scsi_requeue_command() here. This would
921 * be used if we just wanted to retry, for example.
923 void scsi_io_completion(struct scsi_cmnd
*cmd
, unsigned int good_bytes
,
924 unsigned int block_bytes
)
926 int result
= cmd
->result
;
927 int this_count
= cmd
->bufflen
;
928 request_queue_t
*q
= cmd
->device
->request_queue
;
929 struct request
*req
= cmd
->request
;
930 int clear_errors
= 1;
931 struct scsi_sense_hdr sshdr
;
933 int sense_deferred
= 0;
936 * Free up any indirection buffers we allocated for DMA purposes.
937 * For the case of a READ, we need to copy the data out of the
938 * bounce buffer and into the real buffer.
941 scsi_free_sgtable(cmd
->buffer
, cmd
->sglist_len
);
942 else if (cmd
->buffer
!= req
->buffer
) {
943 if (rq_data_dir(req
) == READ
) {
945 char *to
= bio_kmap_irq(req
->bio
, &flags
);
946 memcpy(to
, cmd
->buffer
, cmd
->bufflen
);
947 bio_kunmap_irq(to
, &flags
);
953 sense_valid
= scsi_command_normalize_sense(cmd
, &sshdr
);
955 sense_deferred
= scsi_sense_is_deferred(&sshdr
);
957 if (blk_pc_request(req
)) { /* SG_IO ioctl from block level */
958 req
->errors
= result
;
961 if (sense_valid
&& req
->sense
) {
963 * SG_IO wants current and deferred errors
965 int len
= 8 + cmd
->sense_buffer
[7];
967 if (len
> SCSI_SENSE_BUFFERSIZE
)
968 len
= SCSI_SENSE_BUFFERSIZE
;
969 memcpy(req
->sense
, cmd
->sense_buffer
, len
);
970 req
->sense_len
= len
;
973 req
->data_len
= cmd
->resid
;
977 * Zero these out. They now point to freed memory, and it is
978 * dangerous to hang onto the pointers.
982 cmd
->request_buffer
= NULL
;
983 cmd
->request_bufflen
= 0;
986 * Next deal with any sectors which we were able to correctly
989 if (good_bytes
>= 0) {
990 SCSI_LOG_HLCOMPLETE(1, printk("%ld sectors total, %d bytes done.\n",
991 req
->nr_sectors
, good_bytes
));
992 SCSI_LOG_HLCOMPLETE(1, printk("use_sg is %d\n", cmd
->use_sg
));
997 * If multiple sectors are requested in one buffer, then
998 * they will have been finished off by the first command.
999 * If not, then we have a multi-buffer command.
1001 * If block_bytes != 0, it means we had a medium error
1002 * of some sort, and that we want to mark some number of
1003 * sectors as not uptodate. Thus we want to inhibit
1004 * requeueing right here - we will requeue down below
1005 * when we handle the bad sectors.
1009 * If the command completed without error, then either
1010 * finish off the rest of the command, or start a new one.
1012 if (scsi_end_request(cmd
, 1, good_bytes
, result
== 0) == NULL
)
1016 * Now, if we were good little boys and girls, Santa left us a request
1017 * sense buffer. We can extract information from this, so we
1018 * can choose a block to remap, etc.
1020 if (sense_valid
&& !sense_deferred
) {
1021 switch (sshdr
.sense_key
) {
1022 case UNIT_ATTENTION
:
1023 if (cmd
->device
->removable
) {
1024 /* detected disc change. set a bit
1025 * and quietly refuse further access.
1027 cmd
->device
->changed
= 1;
1028 scsi_end_request(cmd
, 0,
1033 * Must have been a power glitch, or a
1034 * bus reset. Could not have been a
1035 * media change, so we just retry the
1036 * request and see what happens.
1038 scsi_requeue_command(q
, cmd
);
1042 case ILLEGAL_REQUEST
:
1044 * If we had an ILLEGAL REQUEST returned, then we may
1045 * have performed an unsupported command. The only
1046 * thing this should be would be a ten byte read where
1047 * only a six byte read was supported. Also, on a
1048 * system where READ CAPACITY failed, we may have read
1049 * past the end of the disk.
1051 if ((cmd
->device
->use_10_for_rw
&&
1052 sshdr
.asc
== 0x20 && sshdr
.ascq
== 0x00) &&
1053 (cmd
->cmnd
[0] == READ_10
||
1054 cmd
->cmnd
[0] == WRITE_10
)) {
1055 cmd
->device
->use_10_for_rw
= 0;
1057 * This will cause a retry with a 6-byte
1060 scsi_requeue_command(q
, cmd
);
1063 scsi_end_request(cmd
, 0, this_count
, 1);
1069 * If the device is in the process of becoming ready,
1072 if (sshdr
.asc
== 0x04 && sshdr
.ascq
== 0x01) {
1073 scsi_requeue_command(q
, cmd
);
1076 if (!(req
->flags
& REQ_QUIET
))
1077 scmd_printk(KERN_INFO
, cmd
,
1078 "Device not ready.\n");
1079 scsi_end_request(cmd
, 0, this_count
, 1);
1081 case VOLUME_OVERFLOW
:
1082 if (!(req
->flags
& REQ_QUIET
)) {
1083 scmd_printk(KERN_INFO
, cmd
,
1084 "Volume overflow, CDB: ");
1085 __scsi_print_command(cmd
->data_cmnd
);
1086 scsi_print_sense("", cmd
);
1088 scsi_end_request(cmd
, 0, block_bytes
, 1);
1093 } /* driver byte != 0 */
1094 if (host_byte(result
) == DID_RESET
) {
1096 * Third party bus reset or reset for error
1097 * recovery reasons. Just retry the request
1098 * and see what happens.
1100 scsi_requeue_command(q
, cmd
);
1104 if (!(req
->flags
& REQ_QUIET
)) {
1105 scmd_printk(KERN_INFO
, cmd
,
1106 "SCSI error: return code = 0x%x\n", result
);
1108 if (driver_byte(result
) & DRIVER_SENSE
)
1109 scsi_print_sense("", cmd
);
1112 * Mark a single buffer as not uptodate. Queue the remainder.
1113 * We sometimes get this cruft in the event that a medium error
1114 * isn't properly reported.
1116 block_bytes
= req
->hard_cur_sectors
<< 9;
1118 block_bytes
= req
->data_len
;
1119 scsi_end_request(cmd
, 0, block_bytes
, 1);
1122 EXPORT_SYMBOL(scsi_io_completion
);
1125 * Function: scsi_init_io()
1127 * Purpose: SCSI I/O initialize function.
1129 * Arguments: cmd - Command descriptor we wish to initialize
1131 * Returns: 0 on success
1132 * BLKPREP_DEFER if the failure is retryable
1133 * BLKPREP_KILL if the failure is fatal
1135 static int scsi_init_io(struct scsi_cmnd
*cmd
)
1137 struct request
*req
= cmd
->request
;
1138 struct scatterlist
*sgpnt
;
1142 * if this is a rq->data based REQ_BLOCK_PC, setup for a non-sg xfer
1144 if ((req
->flags
& REQ_BLOCK_PC
) && !req
->bio
) {
1145 cmd
->request_bufflen
= req
->data_len
;
1146 cmd
->request_buffer
= req
->data
;
1147 req
->buffer
= req
->data
;
1153 * we used to not use scatter-gather for single segment request,
1154 * but now we do (it makes highmem I/O easier to support without
1157 cmd
->use_sg
= req
->nr_phys_segments
;
1160 * if sg table allocation fails, requeue request later.
1162 sgpnt
= scsi_alloc_sgtable(cmd
, GFP_ATOMIC
);
1163 if (unlikely(!sgpnt
)) {
1164 scsi_unprep_request(req
);
1165 return BLKPREP_DEFER
;
1168 cmd
->request_buffer
= (char *) sgpnt
;
1169 cmd
->request_bufflen
= req
->nr_sectors
<< 9;
1170 if (blk_pc_request(req
))
1171 cmd
->request_bufflen
= req
->data_len
;
1175 * Next, walk the list, and fill in the addresses and sizes of
1178 count
= blk_rq_map_sg(req
->q
, req
, cmd
->request_buffer
);
1181 * mapped well, send it off
1183 if (likely(count
<= cmd
->use_sg
)) {
1184 cmd
->use_sg
= count
;
1188 printk(KERN_ERR
"Incorrect number of segments after building list\n");
1189 printk(KERN_ERR
"counted %d, received %d\n", count
, cmd
->use_sg
);
1190 printk(KERN_ERR
"req nr_sec %lu, cur_nr_sec %u\n", req
->nr_sectors
,
1191 req
->current_nr_sectors
);
1193 /* release the command and kill it */
1194 scsi_release_buffers(cmd
);
1195 scsi_put_command(cmd
);
1196 return BLKPREP_KILL
;
1199 static int scsi_issue_flush_fn(request_queue_t
*q
, struct gendisk
*disk
,
1200 sector_t
*error_sector
)
1202 struct scsi_device
*sdev
= q
->queuedata
;
1203 struct scsi_driver
*drv
;
1205 if (sdev
->sdev_state
!= SDEV_RUNNING
)
1208 drv
= *(struct scsi_driver
**) disk
->private_data
;
1209 if (drv
->issue_flush
)
1210 return drv
->issue_flush(&sdev
->sdev_gendev
, error_sector
);
1215 static void scsi_generic_done(struct scsi_cmnd
*cmd
)
1217 BUG_ON(!blk_pc_request(cmd
->request
));
1219 * This will complete the whole command with uptodate=1 so
1220 * as far as the block layer is concerned the command completed
1221 * successfully. Since this is a REQ_BLOCK_PC command the
1222 * caller should check the request's errors value
1224 scsi_io_completion(cmd
, cmd
->bufflen
, 0);
1227 void scsi_setup_blk_pc_cmnd(struct scsi_cmnd
*cmd
)
1229 struct request
*req
= cmd
->request
;
1231 BUG_ON(sizeof(req
->cmd
) > sizeof(cmd
->cmnd
));
1232 memcpy(cmd
->cmnd
, req
->cmd
, sizeof(cmd
->cmnd
));
1233 cmd
->cmd_len
= req
->cmd_len
;
1235 cmd
->sc_data_direction
= DMA_NONE
;
1236 else if (rq_data_dir(req
) == WRITE
)
1237 cmd
->sc_data_direction
= DMA_TO_DEVICE
;
1239 cmd
->sc_data_direction
= DMA_FROM_DEVICE
;
1241 cmd
->transfersize
= req
->data_len
;
1242 cmd
->allowed
= req
->retries
;
1243 cmd
->timeout_per_command
= req
->timeout
;
1245 EXPORT_SYMBOL_GPL(scsi_setup_blk_pc_cmnd
);
1247 static int scsi_prep_fn(struct request_queue
*q
, struct request
*req
)
1249 struct scsi_device
*sdev
= q
->queuedata
;
1250 struct scsi_cmnd
*cmd
;
1251 int specials_only
= 0;
1254 * Just check to see if the device is online. If it isn't, we
1255 * refuse to process any commands. The device must be brought
1256 * online before trying any recovery commands
1258 if (unlikely(!scsi_device_online(sdev
))) {
1259 sdev_printk(KERN_ERR
, sdev
,
1260 "rejecting I/O to offline device\n");
1263 if (unlikely(sdev
->sdev_state
!= SDEV_RUNNING
)) {
1264 /* OK, we're not in a running state don't prep
1266 if (sdev
->sdev_state
== SDEV_DEL
) {
1267 /* Device is fully deleted, no commands
1268 * at all allowed down */
1269 sdev_printk(KERN_ERR
, sdev
,
1270 "rejecting I/O to dead device\n");
1273 /* OK, we only allow special commands (i.e. not
1274 * user initiated ones */
1275 specials_only
= sdev
->sdev_state
;
1279 * Find the actual device driver associated with this command.
1280 * The SPECIAL requests are things like character device or
1281 * ioctls, which did not originate from ll_rw_blk. Note that
1282 * the special field is also used to indicate the cmd for
1283 * the remainder of a partially fulfilled request that can
1284 * come up when there is a medium error. We have to treat
1285 * these two cases differently. We differentiate by looking
1286 * at request->cmd, as this tells us the real story.
1288 if (req
->flags
& REQ_SPECIAL
&& req
->special
) {
1289 struct scsi_request
*sreq
= req
->special
;
1291 if (sreq
->sr_magic
== SCSI_REQ_MAGIC
) {
1292 cmd
= scsi_get_command(sreq
->sr_device
, GFP_ATOMIC
);
1295 scsi_init_cmd_from_req(cmd
, sreq
);
1298 } else if (req
->flags
& (REQ_CMD
| REQ_BLOCK_PC
)) {
1300 if(unlikely(specials_only
) && !(req
->flags
& REQ_SPECIAL
)) {
1301 if(specials_only
== SDEV_QUIESCE
||
1302 specials_only
== SDEV_BLOCK
)
1305 sdev_printk(KERN_ERR
, sdev
,
1306 "rejecting I/O to device being removed\n");
1312 * Now try and find a command block that we can use.
1314 if (!req
->special
) {
1315 cmd
= scsi_get_command(sdev
, GFP_ATOMIC
);
1321 /* pull a tag out of the request if we have one */
1322 cmd
->tag
= req
->tag
;
1324 blk_dump_rq_flags(req
, "SCSI bad req");
1328 /* note the overloading of req->special. When the tag
1329 * is active it always means cmd. If the tag goes
1330 * back for re-queueing, it may be reset */
1335 * FIXME: drop the lock here because the functions below
1336 * expect to be called without the queue lock held. Also,
1337 * previously, we dequeued the request before dropping the
1338 * lock. We hope REQ_STARTED prevents anything untoward from
1341 if (req
->flags
& (REQ_CMD
| REQ_BLOCK_PC
)) {
1342 struct scsi_driver
*drv
;
1346 * This will do a couple of things:
1347 * 1) Fill in the actual SCSI command.
1348 * 2) Fill in any other upper-level specific fields
1351 * If this returns 0, it means that the request failed
1352 * (reading past end of disk, reading offline device,
1353 * etc). This won't actually talk to the device, but
1354 * some kinds of consistency checking may cause the
1355 * request to be rejected immediately.
1359 * This sets up the scatter-gather table (allocating if
1362 ret
= scsi_init_io(cmd
);
1364 /* For BLKPREP_KILL/DEFER the cmd was released */
1372 * Initialize the actual SCSI command for this request.
1375 drv
= *(struct scsi_driver
**)req
->rq_disk
->private_data
;
1376 if (unlikely(!drv
->init_command(cmd
))) {
1377 scsi_release_buffers(cmd
);
1378 scsi_put_command(cmd
);
1382 scsi_setup_blk_pc_cmnd(cmd
);
1383 cmd
->done
= scsi_generic_done
;
1388 * The request is now prepped, no need to come back here
1390 req
->flags
|= REQ_DONTPREP
;
1394 /* If we defer, the elv_next_request() returns NULL, but the
1395 * queue must be restarted, so we plug here if no returning
1396 * command will automatically do that. */
1397 if (sdev
->device_busy
== 0)
1399 return BLKPREP_DEFER
;
1401 req
->errors
= DID_NO_CONNECT
<< 16;
1402 return BLKPREP_KILL
;
1406 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1409 * Called with the queue_lock held.
1411 static inline int scsi_dev_queue_ready(struct request_queue
*q
,
1412 struct scsi_device
*sdev
)
1414 if (sdev
->device_busy
>= sdev
->queue_depth
)
1416 if (sdev
->device_busy
== 0 && sdev
->device_blocked
) {
1418 * unblock after device_blocked iterates to zero
1420 if (--sdev
->device_blocked
== 0) {
1422 sdev_printk(KERN_INFO
, sdev
,
1423 "unblocking device at zero depth\n"));
1429 if (sdev
->device_blocked
)
1436 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1437 * return 0. We must end up running the queue again whenever 0 is
1438 * returned, else IO can hang.
1440 * Called with host_lock held.
1442 static inline int scsi_host_queue_ready(struct request_queue
*q
,
1443 struct Scsi_Host
*shost
,
1444 struct scsi_device
*sdev
)
1446 if (scsi_host_in_recovery(shost
))
1448 if (shost
->host_busy
== 0 && shost
->host_blocked
) {
1450 * unblock after host_blocked iterates to zero
1452 if (--shost
->host_blocked
== 0) {
1454 printk("scsi%d unblocking host at zero depth\n",
1461 if ((shost
->can_queue
> 0 && shost
->host_busy
>= shost
->can_queue
) ||
1462 shost
->host_blocked
|| shost
->host_self_blocked
) {
1463 if (list_empty(&sdev
->starved_entry
))
1464 list_add_tail(&sdev
->starved_entry
, &shost
->starved_list
);
1468 /* We're OK to process the command, so we can't be starved */
1469 if (!list_empty(&sdev
->starved_entry
))
1470 list_del_init(&sdev
->starved_entry
);
1476 * Kill a request for a dead device
1478 static void scsi_kill_request(struct request
*req
, request_queue_t
*q
)
1480 struct scsi_cmnd
*cmd
= req
->special
;
1482 blkdev_dequeue_request(req
);
1484 if (unlikely(cmd
== NULL
)) {
1485 printk(KERN_CRIT
"impossible request in %s.\n",
1490 scsi_init_cmd_errh(cmd
);
1491 cmd
->result
= DID_NO_CONNECT
<< 16;
1492 atomic_inc(&cmd
->device
->iorequest_cnt
);
1497 * Function: scsi_request_fn()
1499 * Purpose: Main strategy routine for SCSI.
1501 * Arguments: q - Pointer to actual queue.
1505 * Lock status: IO request lock assumed to be held when called.
1507 static void scsi_request_fn(struct request_queue
*q
)
1509 struct scsi_device
*sdev
= q
->queuedata
;
1510 struct Scsi_Host
*shost
;
1511 struct scsi_cmnd
*cmd
;
1512 struct request
*req
;
1515 printk("scsi: killing requests for dead queue\n");
1516 while ((req
= elv_next_request(q
)) != NULL
)
1517 scsi_kill_request(req
, q
);
1521 if(!get_device(&sdev
->sdev_gendev
))
1522 /* We must be tearing the block queue down already */
1526 * To start with, we keep looping until the queue is empty, or until
1527 * the host is no longer able to accept any more requests.
1530 while (!blk_queue_plugged(q
)) {
1533 * get next queueable request. We do this early to make sure
1534 * that the request is fully prepared even if we cannot
1537 req
= elv_next_request(q
);
1538 if (!req
|| !scsi_dev_queue_ready(q
, sdev
))
1541 if (unlikely(!scsi_device_online(sdev
))) {
1542 sdev_printk(KERN_ERR
, sdev
,
1543 "rejecting I/O to offline device\n");
1544 scsi_kill_request(req
, q
);
1550 * Remove the request from the request list.
1552 if (!(blk_queue_tagged(q
) && !blk_queue_start_tag(q
, req
)))
1553 blkdev_dequeue_request(req
);
1554 sdev
->device_busy
++;
1556 spin_unlock(q
->queue_lock
);
1558 if (unlikely(cmd
== NULL
)) {
1559 printk(KERN_CRIT
"impossible request in %s.\n"
1560 "please mail a stack trace to "
1561 "linux-scsi@vger.kernel.org",
1565 spin_lock(shost
->host_lock
);
1567 if (!scsi_host_queue_ready(q
, shost
, sdev
))
1569 if (sdev
->single_lun
) {
1570 if (scsi_target(sdev
)->starget_sdev_user
&&
1571 scsi_target(sdev
)->starget_sdev_user
!= sdev
)
1573 scsi_target(sdev
)->starget_sdev_user
= sdev
;
1578 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1579 * take the lock again.
1581 spin_unlock_irq(shost
->host_lock
);
1584 * Finally, initialize any error handling parameters, and set up
1585 * the timers for timeouts.
1587 scsi_init_cmd_errh(cmd
);
1590 * Dispatch the command to the low-level driver.
1592 rtn
= scsi_dispatch_cmd(cmd
);
1593 spin_lock_irq(q
->queue_lock
);
1595 /* we're refusing the command; because of
1596 * the way locks get dropped, we need to
1597 * check here if plugging is required */
1598 if(sdev
->device_busy
== 0)
1608 spin_unlock_irq(shost
->host_lock
);
1611 * lock q, handle tag, requeue req, and decrement device_busy. We
1612 * must return with queue_lock held.
1614 * Decrementing device_busy without checking it is OK, as all such
1615 * cases (host limits or settings) should run the queue at some
1618 spin_lock_irq(q
->queue_lock
);
1619 blk_requeue_request(q
, req
);
1620 sdev
->device_busy
--;
1621 if(sdev
->device_busy
== 0)
1624 /* must be careful here...if we trigger the ->remove() function
1625 * we cannot be holding the q lock */
1626 spin_unlock_irq(q
->queue_lock
);
1627 put_device(&sdev
->sdev_gendev
);
1628 spin_lock_irq(q
->queue_lock
);
1631 u64
scsi_calculate_bounce_limit(struct Scsi_Host
*shost
)
1633 struct device
*host_dev
;
1634 u64 bounce_limit
= 0xffffffff;
1636 if (shost
->unchecked_isa_dma
)
1637 return BLK_BOUNCE_ISA
;
1639 * Platforms with virtual-DMA translation
1640 * hardware have no practical limit.
1642 if (!PCI_DMA_BUS_IS_PHYS
)
1643 return BLK_BOUNCE_ANY
;
1645 host_dev
= scsi_get_device(shost
);
1646 if (host_dev
&& host_dev
->dma_mask
)
1647 bounce_limit
= *host_dev
->dma_mask
;
1649 return bounce_limit
;
1651 EXPORT_SYMBOL(scsi_calculate_bounce_limit
);
1653 struct request_queue
*scsi_alloc_queue(struct scsi_device
*sdev
)
1655 struct Scsi_Host
*shost
= sdev
->host
;
1656 struct request_queue
*q
;
1658 q
= blk_init_queue(scsi_request_fn
, NULL
);
1662 blk_queue_prep_rq(q
, scsi_prep_fn
);
1664 blk_queue_max_hw_segments(q
, shost
->sg_tablesize
);
1665 blk_queue_max_phys_segments(q
, SCSI_MAX_PHYS_SEGMENTS
);
1666 blk_queue_max_sectors(q
, shost
->max_sectors
);
1667 blk_queue_bounce_limit(q
, scsi_calculate_bounce_limit(shost
));
1668 blk_queue_segment_boundary(q
, shost
->dma_boundary
);
1669 blk_queue_issue_flush_fn(q
, scsi_issue_flush_fn
);
1671 if (!shost
->use_clustering
)
1672 clear_bit(QUEUE_FLAG_CLUSTER
, &q
->queue_flags
);
1676 void scsi_free_queue(struct request_queue
*q
)
1678 blk_cleanup_queue(q
);
1682 * Function: scsi_block_requests()
1684 * Purpose: Utility function used by low-level drivers to prevent further
1685 * commands from being queued to the device.
1687 * Arguments: shost - Host in question
1691 * Lock status: No locks are assumed held.
1693 * Notes: There is no timer nor any other means by which the requests
1694 * get unblocked other than the low-level driver calling
1695 * scsi_unblock_requests().
1697 void scsi_block_requests(struct Scsi_Host
*shost
)
1699 shost
->host_self_blocked
= 1;
1701 EXPORT_SYMBOL(scsi_block_requests
);
1704 * Function: scsi_unblock_requests()
1706 * Purpose: Utility function used by low-level drivers to allow further
1707 * commands from being queued to the device.
1709 * Arguments: shost - Host in question
1713 * Lock status: No locks are assumed held.
1715 * Notes: There is no timer nor any other means by which the requests
1716 * get unblocked other than the low-level driver calling
1717 * scsi_unblock_requests().
1719 * This is done as an API function so that changes to the
1720 * internals of the scsi mid-layer won't require wholesale
1721 * changes to drivers that use this feature.
1723 void scsi_unblock_requests(struct Scsi_Host
*shost
)
1725 shost
->host_self_blocked
= 0;
1726 scsi_run_host_queues(shost
);
1728 EXPORT_SYMBOL(scsi_unblock_requests
);
1730 int __init
scsi_init_queue(void)
1734 scsi_io_context_cache
= kmem_cache_create("scsi_io_context",
1735 sizeof(struct scsi_io_context
),
1737 if (!scsi_io_context_cache
) {
1738 printk(KERN_ERR
"SCSI: can't init scsi io context cache\n");
1742 for (i
= 0; i
< SG_MEMPOOL_NR
; i
++) {
1743 struct scsi_host_sg_pool
*sgp
= scsi_sg_pools
+ i
;
1744 int size
= sgp
->size
* sizeof(struct scatterlist
);
1746 sgp
->slab
= kmem_cache_create(sgp
->name
, size
, 0,
1747 SLAB_HWCACHE_ALIGN
, NULL
, NULL
);
1749 printk(KERN_ERR
"SCSI: can't init sg slab %s\n",
1753 sgp
->pool
= mempool_create(SG_MEMPOOL_SIZE
,
1754 mempool_alloc_slab
, mempool_free_slab
,
1757 printk(KERN_ERR
"SCSI: can't init sg mempool %s\n",
1765 void scsi_exit_queue(void)
1769 kmem_cache_destroy(scsi_io_context_cache
);
1771 for (i
= 0; i
< SG_MEMPOOL_NR
; i
++) {
1772 struct scsi_host_sg_pool
*sgp
= scsi_sg_pools
+ i
;
1773 mempool_destroy(sgp
->pool
);
1774 kmem_cache_destroy(sgp
->slab
);
1778 * scsi_mode_sense - issue a mode sense, falling back from 10 to
1779 * six bytes if necessary.
1780 * @sdev: SCSI device to be queried
1781 * @dbd: set if mode sense will allow block descriptors to be returned
1782 * @modepage: mode page being requested
1783 * @buffer: request buffer (may not be smaller than eight bytes)
1784 * @len: length of request buffer.
1785 * @timeout: command timeout
1786 * @retries: number of retries before failing
1787 * @data: returns a structure abstracting the mode header data
1788 * @sense: place to put sense data (or NULL if no sense to be collected).
1789 * must be SCSI_SENSE_BUFFERSIZE big.
1791 * Returns zero if unsuccessful, or the header offset (either 4
1792 * or 8 depending on whether a six or ten byte command was
1793 * issued) if successful.
1796 scsi_mode_sense(struct scsi_device
*sdev
, int dbd
, int modepage
,
1797 unsigned char *buffer
, int len
, int timeout
, int retries
,
1798 struct scsi_mode_data
*data
, struct scsi_sense_hdr
*sshdr
) {
1799 unsigned char cmd
[12];
1803 struct scsi_sense_hdr my_sshdr
;
1805 memset(data
, 0, sizeof(*data
));
1806 memset(&cmd
[0], 0, 12);
1807 cmd
[1] = dbd
& 0x18; /* allows DBD and LLBA bits */
1810 /* caller might not be interested in sense, but we need it */
1815 use_10_for_ms
= sdev
->use_10_for_ms
;
1817 if (use_10_for_ms
) {
1821 cmd
[0] = MODE_SENSE_10
;
1828 cmd
[0] = MODE_SENSE
;
1833 memset(buffer
, 0, len
);
1835 result
= scsi_execute_req(sdev
, cmd
, DMA_FROM_DEVICE
, buffer
, len
,
1836 sshdr
, timeout
, retries
);
1838 /* This code looks awful: what it's doing is making sure an
1839 * ILLEGAL REQUEST sense return identifies the actual command
1840 * byte as the problem. MODE_SENSE commands can return
1841 * ILLEGAL REQUEST if the code page isn't supported */
1843 if (use_10_for_ms
&& !scsi_status_is_good(result
) &&
1844 (driver_byte(result
) & DRIVER_SENSE
)) {
1845 if (scsi_sense_valid(sshdr
)) {
1846 if ((sshdr
->sense_key
== ILLEGAL_REQUEST
) &&
1847 (sshdr
->asc
== 0x20) && (sshdr
->ascq
== 0)) {
1849 * Invalid command operation code
1851 sdev
->use_10_for_ms
= 0;
1857 if(scsi_status_is_good(result
)) {
1858 data
->header_length
= header_length
;
1860 data
->length
= buffer
[0]*256 + buffer
[1] + 2;
1861 data
->medium_type
= buffer
[2];
1862 data
->device_specific
= buffer
[3];
1863 data
->longlba
= buffer
[4] & 0x01;
1864 data
->block_descriptor_length
= buffer
[6]*256
1867 data
->length
= buffer
[0] + 1;
1868 data
->medium_type
= buffer
[1];
1869 data
->device_specific
= buffer
[2];
1870 data
->block_descriptor_length
= buffer
[3];
1876 EXPORT_SYMBOL(scsi_mode_sense
);
1879 scsi_test_unit_ready(struct scsi_device
*sdev
, int timeout
, int retries
)
1882 TEST_UNIT_READY
, 0, 0, 0, 0, 0,
1884 struct scsi_sense_hdr sshdr
;
1887 result
= scsi_execute_req(sdev
, cmd
, DMA_NONE
, NULL
, 0, &sshdr
,
1890 if ((driver_byte(result
) & DRIVER_SENSE
) && sdev
->removable
) {
1892 if ((scsi_sense_valid(&sshdr
)) &&
1893 ((sshdr
.sense_key
== UNIT_ATTENTION
) ||
1894 (sshdr
.sense_key
== NOT_READY
))) {
1901 EXPORT_SYMBOL(scsi_test_unit_ready
);
1904 * scsi_device_set_state - Take the given device through the device
1906 * @sdev: scsi device to change the state of.
1907 * @state: state to change to.
1909 * Returns zero if unsuccessful or an error if the requested
1910 * transition is illegal.
1913 scsi_device_set_state(struct scsi_device
*sdev
, enum scsi_device_state state
)
1915 enum scsi_device_state oldstate
= sdev
->sdev_state
;
1917 if (state
== oldstate
)
1922 /* There are no legal states that come back to
1923 * created. This is the manually initialised start
1993 sdev
->sdev_state
= state
;
1997 SCSI_LOG_ERROR_RECOVERY(1,
1998 sdev_printk(KERN_ERR
, sdev
,
1999 "Illegal state transition %s->%s\n",
2000 scsi_device_state_name(oldstate
),
2001 scsi_device_state_name(state
))
2005 EXPORT_SYMBOL(scsi_device_set_state
);
2008 * scsi_device_quiesce - Block user issued commands.
2009 * @sdev: scsi device to quiesce.
2011 * This works by trying to transition to the SDEV_QUIESCE state
2012 * (which must be a legal transition). When the device is in this
2013 * state, only special requests will be accepted, all others will
2014 * be deferred. Since special requests may also be requeued requests,
2015 * a successful return doesn't guarantee the device will be
2016 * totally quiescent.
2018 * Must be called with user context, may sleep.
2020 * Returns zero if unsuccessful or an error if not.
2023 scsi_device_quiesce(struct scsi_device
*sdev
)
2025 int err
= scsi_device_set_state(sdev
, SDEV_QUIESCE
);
2029 scsi_run_queue(sdev
->request_queue
);
2030 while (sdev
->device_busy
) {
2031 msleep_interruptible(200);
2032 scsi_run_queue(sdev
->request_queue
);
2036 EXPORT_SYMBOL(scsi_device_quiesce
);
2039 * scsi_device_resume - Restart user issued commands to a quiesced device.
2040 * @sdev: scsi device to resume.
2042 * Moves the device from quiesced back to running and restarts the
2045 * Must be called with user context, may sleep.
2048 scsi_device_resume(struct scsi_device
*sdev
)
2050 if(scsi_device_set_state(sdev
, SDEV_RUNNING
))
2052 scsi_run_queue(sdev
->request_queue
);
2054 EXPORT_SYMBOL(scsi_device_resume
);
2057 device_quiesce_fn(struct scsi_device
*sdev
, void *data
)
2059 scsi_device_quiesce(sdev
);
2063 scsi_target_quiesce(struct scsi_target
*starget
)
2065 starget_for_each_device(starget
, NULL
, device_quiesce_fn
);
2067 EXPORT_SYMBOL(scsi_target_quiesce
);
2070 device_resume_fn(struct scsi_device
*sdev
, void *data
)
2072 scsi_device_resume(sdev
);
2076 scsi_target_resume(struct scsi_target
*starget
)
2078 starget_for_each_device(starget
, NULL
, device_resume_fn
);
2080 EXPORT_SYMBOL(scsi_target_resume
);
2083 * scsi_internal_device_block - internal function to put a device
2084 * temporarily into the SDEV_BLOCK state
2085 * @sdev: device to block
2087 * Block request made by scsi lld's to temporarily stop all
2088 * scsi commands on the specified device. Called from interrupt
2089 * or normal process context.
2091 * Returns zero if successful or error if not
2094 * This routine transitions the device to the SDEV_BLOCK state
2095 * (which must be a legal transition). When the device is in this
2096 * state, all commands are deferred until the scsi lld reenables
2097 * the device with scsi_device_unblock or device_block_tmo fires.
2098 * This routine assumes the host_lock is held on entry.
2101 scsi_internal_device_block(struct scsi_device
*sdev
)
2103 request_queue_t
*q
= sdev
->request_queue
;
2104 unsigned long flags
;
2107 err
= scsi_device_set_state(sdev
, SDEV_BLOCK
);
2112 * The device has transitioned to SDEV_BLOCK. Stop the
2113 * block layer from calling the midlayer with this device's
2116 spin_lock_irqsave(q
->queue_lock
, flags
);
2118 spin_unlock_irqrestore(q
->queue_lock
, flags
);
2122 EXPORT_SYMBOL_GPL(scsi_internal_device_block
);
2125 * scsi_internal_device_unblock - resume a device after a block request
2126 * @sdev: device to resume
2128 * Called by scsi lld's or the midlayer to restart the device queue
2129 * for the previously suspended scsi device. Called from interrupt or
2130 * normal process context.
2132 * Returns zero if successful or error if not.
2135 * This routine transitions the device to the SDEV_RUNNING state
2136 * (which must be a legal transition) allowing the midlayer to
2137 * goose the queue for this device. This routine assumes the
2138 * host_lock is held upon entry.
2141 scsi_internal_device_unblock(struct scsi_device
*sdev
)
2143 request_queue_t
*q
= sdev
->request_queue
;
2145 unsigned long flags
;
2148 * Try to transition the scsi device to SDEV_RUNNING
2149 * and goose the device queue if successful.
2151 err
= scsi_device_set_state(sdev
, SDEV_RUNNING
);
2155 spin_lock_irqsave(q
->queue_lock
, flags
);
2157 spin_unlock_irqrestore(q
->queue_lock
, flags
);
2161 EXPORT_SYMBOL_GPL(scsi_internal_device_unblock
);
2164 device_block(struct scsi_device
*sdev
, void *data
)
2166 scsi_internal_device_block(sdev
);
2170 target_block(struct device
*dev
, void *data
)
2172 if (scsi_is_target_device(dev
))
2173 starget_for_each_device(to_scsi_target(dev
), NULL
,
2179 scsi_target_block(struct device
*dev
)
2181 if (scsi_is_target_device(dev
))
2182 starget_for_each_device(to_scsi_target(dev
), NULL
,
2185 device_for_each_child(dev
, NULL
, target_block
);
2187 EXPORT_SYMBOL_GPL(scsi_target_block
);
2190 device_unblock(struct scsi_device
*sdev
, void *data
)
2192 scsi_internal_device_unblock(sdev
);
2196 target_unblock(struct device
*dev
, void *data
)
2198 if (scsi_is_target_device(dev
))
2199 starget_for_each_device(to_scsi_target(dev
), NULL
,
2205 scsi_target_unblock(struct device
*dev
)
2207 if (scsi_is_target_device(dev
))
2208 starget_for_each_device(to_scsi_target(dev
), NULL
,
2211 device_for_each_child(dev
, NULL
, target_unblock
);
2213 EXPORT_SYMBOL_GPL(scsi_target_unblock
);