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>
19 #include <linux/hardirq.h>
20 #include <linux/scatterlist.h>
22 #include <scsi/scsi.h>
23 #include <scsi/scsi_cmnd.h>
24 #include <scsi/scsi_dbg.h>
25 #include <scsi/scsi_device.h>
26 #include <scsi/scsi_driver.h>
27 #include <scsi/scsi_eh.h>
28 #include <scsi/scsi_host.h>
30 #include "scsi_priv.h"
31 #include "scsi_logging.h"
34 #define SG_MEMPOOL_NR ARRAY_SIZE(scsi_sg_pools)
35 #define SG_MEMPOOL_SIZE 2
38 * The maximum number of SG segments that we will put inside a scatterlist
39 * (unless chaining is used). Should ideally fit inside a single page, to
40 * avoid a higher order allocation.
42 #define SCSI_MAX_SG_SEGMENTS 128
44 struct scsi_host_sg_pool {
47 struct kmem_cache *slab;
51 #define SP(x) { x, "sgpool-" #x }
52 static struct scsi_host_sg_pool scsi_sg_pools[] = {
55 #if (SCSI_MAX_SG_SEGMENTS > 16)
57 #if (SCSI_MAX_SG_SEGMENTS > 32)
59 #if (SCSI_MAX_SG_SEGMENTS > 64)
67 static void scsi_run_queue(struct request_queue *q);
70 * Function: scsi_unprep_request()
72 * Purpose: Remove all preparation done for a request, including its
73 * associated scsi_cmnd, so that it can be requeued.
75 * Arguments: req - request to unprepare
77 * Lock status: Assumed that no locks are held upon entry.
81 static void scsi_unprep_request(struct request *req)
83 struct scsi_cmnd *cmd = req->special;
85 req->cmd_flags &= ~REQ_DONTPREP;
88 scsi_put_command(cmd);
92 * Function: scsi_queue_insert()
94 * Purpose: Insert a command in the midlevel queue.
96 * Arguments: cmd - command that we are adding to queue.
97 * reason - why we are inserting command to queue.
99 * Lock status: Assumed that lock is not held upon entry.
103 * Notes: We do this for one of two cases. Either the host is busy
104 * and it cannot accept any more commands for the time being,
105 * or the device returned QUEUE_FULL and can accept no more
107 * Notes: This could be called either from an interrupt context or a
108 * normal process context.
110 int scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
112 struct Scsi_Host *host = cmd->device->host;
113 struct scsi_device *device = cmd->device;
114 struct request_queue *q = device->request_queue;
118 printk("Inserting command %p into mlqueue\n", cmd));
121 * Set the appropriate busy bit for the device/host.
123 * If the host/device isn't busy, assume that something actually
124 * completed, and that we should be able to queue a command now.
126 * Note that the prior mid-layer assumption that any host could
127 * always queue at least one command is now broken. The mid-layer
128 * will implement a user specifiable stall (see
129 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
130 * if a command is requeued with no other commands outstanding
131 * either for the device or for the host.
133 if (reason == SCSI_MLQUEUE_HOST_BUSY)
134 host->host_blocked = host->max_host_blocked;
135 else if (reason == SCSI_MLQUEUE_DEVICE_BUSY)
136 device->device_blocked = device->max_device_blocked;
139 * Decrement the counters, since these commands are no longer
140 * active on the host/device.
142 scsi_device_unbusy(device);
145 * Requeue this command. It will go before all other commands
146 * that are already in the queue.
148 * NOTE: there is magic here about the way the queue is plugged if
149 * we have no outstanding commands.
151 * Although we *don't* plug the queue, we call the request
152 * function. The SCSI request function detects the blocked condition
153 * and plugs the queue appropriately.
155 spin_lock_irqsave(q->queue_lock, flags);
156 blk_requeue_request(q, cmd->request);
157 spin_unlock_irqrestore(q->queue_lock, flags);
165 * scsi_execute - insert request and wait for the result
168 * @data_direction: data direction
169 * @buffer: data buffer
170 * @bufflen: len of buffer
171 * @sense: optional sense buffer
172 * @timeout: request timeout in seconds
173 * @retries: number of times to retry request
174 * @flags: or into request flags;
176 * returns the req->errors value which is the scsi_cmnd result
179 int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
180 int data_direction, void *buffer, unsigned bufflen,
181 unsigned char *sense, int timeout, int retries, int flags)
184 int write = (data_direction == DMA_TO_DEVICE);
185 int ret = DRIVER_ERROR << 24;
187 req = blk_get_request(sdev->request_queue, write, __GFP_WAIT);
189 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
190 buffer, bufflen, __GFP_WAIT))
193 req->cmd_len = COMMAND_SIZE(cmd[0]);
194 memcpy(req->cmd, cmd, req->cmd_len);
197 req->retries = retries;
198 req->timeout = timeout;
199 req->cmd_type = REQ_TYPE_BLOCK_PC;
200 req->cmd_flags |= flags | REQ_QUIET | REQ_PREEMPT;
203 * head injection *required* here otherwise quiesce won't work
205 blk_execute_rq(req->q, NULL, req, 1);
209 blk_put_request(req);
213 EXPORT_SYMBOL(scsi_execute);
216 int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
217 int data_direction, void *buffer, unsigned bufflen,
218 struct scsi_sense_hdr *sshdr, int timeout, int retries)
224 sense = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
226 return DRIVER_ERROR << 24;
228 result = scsi_execute(sdev, cmd, data_direction, buffer, bufflen,
229 sense, timeout, retries, 0);
231 scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, sshdr);
236 EXPORT_SYMBOL(scsi_execute_req);
238 struct scsi_io_context {
240 void (*done)(void *data, char *sense, int result, int resid);
241 char sense[SCSI_SENSE_BUFFERSIZE];
244 static struct kmem_cache *scsi_io_context_cache;
246 static void scsi_end_async(struct request *req, int uptodate)
248 struct scsi_io_context *sioc = req->end_io_data;
251 sioc->done(sioc->data, sioc->sense, req->errors, req->data_len);
253 kmem_cache_free(scsi_io_context_cache, sioc);
254 __blk_put_request(req->q, req);
257 static int scsi_merge_bio(struct request *rq, struct bio *bio)
259 struct request_queue *q = rq->q;
261 bio->bi_flags &= ~(1 << BIO_SEG_VALID);
262 if (rq_data_dir(rq) == WRITE)
263 bio->bi_rw |= (1 << BIO_RW);
264 blk_queue_bounce(q, &bio);
266 return blk_rq_append_bio(q, rq, bio);
269 static void scsi_bi_endio(struct bio *bio, int error)
275 * scsi_req_map_sg - map a scatterlist into a request
276 * @rq: request to fill
278 * @nsegs: number of elements
279 * @bufflen: len of buffer
280 * @gfp: memory allocation flags
282 * scsi_req_map_sg maps a scatterlist into a request so that the
283 * request can be sent to the block layer. We do not trust the scatterlist
284 * sent to use, as some ULDs use that struct to only organize the pages.
286 static int scsi_req_map_sg(struct request *rq, struct scatterlist *sgl,
287 int nsegs, unsigned bufflen, gfp_t gfp)
289 struct request_queue *q = rq->q;
290 int nr_pages = (bufflen + sgl[0].offset + PAGE_SIZE - 1) >> PAGE_SHIFT;
291 unsigned int data_len = bufflen, len, bytes, off;
292 struct scatterlist *sg;
294 struct bio *bio = NULL;
295 int i, err, nr_vecs = 0;
297 for_each_sg(sgl, sg, nsegs, i) {
303 while (len > 0 && data_len > 0) {
305 * sg sends a scatterlist that is larger than
306 * the data_len it wants transferred for certain
309 bytes = min_t(unsigned int, len, PAGE_SIZE - off);
310 bytes = min(bytes, data_len);
313 nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
316 bio = bio_alloc(gfp, nr_vecs);
321 bio->bi_end_io = scsi_bi_endio;
324 if (bio_add_pc_page(q, bio, page, bytes, off) !=
331 if (bio->bi_vcnt >= nr_vecs) {
332 err = scsi_merge_bio(rq, bio);
347 rq->buffer = rq->data = NULL;
348 rq->data_len = bufflen;
352 while ((bio = rq->bio) != NULL) {
353 rq->bio = bio->bi_next;
355 * call endio instead of bio_put incase it was bounced
364 * scsi_execute_async - insert request
367 * @cmd_len: length of scsi cdb
368 * @data_direction: data direction
369 * @buffer: data buffer (this can be a kernel buffer or scatterlist)
370 * @bufflen: len of buffer
371 * @use_sg: if buffer is a scatterlist this is the number of elements
372 * @timeout: request timeout in seconds
373 * @retries: number of times to retry request
374 * @flags: or into request flags
376 int scsi_execute_async(struct scsi_device *sdev, const unsigned char *cmd,
377 int cmd_len, int data_direction, void *buffer, unsigned bufflen,
378 int use_sg, int timeout, int retries, void *privdata,
379 void (*done)(void *, char *, int, int), gfp_t gfp)
382 struct scsi_io_context *sioc;
384 int write = (data_direction == DMA_TO_DEVICE);
386 sioc = kmem_cache_zalloc(scsi_io_context_cache, gfp);
388 return DRIVER_ERROR << 24;
390 req = blk_get_request(sdev->request_queue, write, gfp);
393 req->cmd_type = REQ_TYPE_BLOCK_PC;
394 req->cmd_flags |= REQ_QUIET;
397 err = scsi_req_map_sg(req, buffer, use_sg, bufflen, gfp);
399 err = blk_rq_map_kern(req->q, req, buffer, bufflen, gfp);
404 req->cmd_len = cmd_len;
405 memset(req->cmd, 0, BLK_MAX_CDB); /* ATAPI hates garbage after CDB */
406 memcpy(req->cmd, cmd, req->cmd_len);
407 req->sense = sioc->sense;
409 req->timeout = timeout;
410 req->retries = retries;
411 req->end_io_data = sioc;
413 sioc->data = privdata;
416 blk_execute_rq_nowait(req->q, NULL, req, 1, scsi_end_async);
420 blk_put_request(req);
422 kmem_cache_free(scsi_io_context_cache, sioc);
423 return DRIVER_ERROR << 24;
425 EXPORT_SYMBOL_GPL(scsi_execute_async);
428 * Function: scsi_init_cmd_errh()
430 * Purpose: Initialize cmd fields related to error handling.
432 * Arguments: cmd - command that is ready to be queued.
434 * Notes: This function has the job of initializing a number of
435 * fields related to error handling. Typically this will
436 * be called once for each command, as required.
438 static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
440 cmd->serial_number = 0;
442 memset(cmd->sense_buffer, 0, sizeof cmd->sense_buffer);
443 if (cmd->cmd_len == 0)
444 cmd->cmd_len = COMMAND_SIZE(cmd->cmnd[0]);
447 void scsi_device_unbusy(struct scsi_device *sdev)
449 struct Scsi_Host *shost = sdev->host;
452 spin_lock_irqsave(shost->host_lock, flags);
454 if (unlikely(scsi_host_in_recovery(shost) &&
455 (shost->host_failed || shost->host_eh_scheduled)))
456 scsi_eh_wakeup(shost);
457 spin_unlock(shost->host_lock);
458 spin_lock(sdev->request_queue->queue_lock);
460 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
464 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
465 * and call blk_run_queue for all the scsi_devices on the target -
466 * including current_sdev first.
468 * Called with *no* scsi locks held.
470 static void scsi_single_lun_run(struct scsi_device *current_sdev)
472 struct Scsi_Host *shost = current_sdev->host;
473 struct scsi_device *sdev, *tmp;
474 struct scsi_target *starget = scsi_target(current_sdev);
477 spin_lock_irqsave(shost->host_lock, flags);
478 starget->starget_sdev_user = NULL;
479 spin_unlock_irqrestore(shost->host_lock, flags);
482 * Call blk_run_queue for all LUNs on the target, starting with
483 * current_sdev. We race with others (to set starget_sdev_user),
484 * but in most cases, we will be first. Ideally, each LU on the
485 * target would get some limited time or requests on the target.
487 blk_run_queue(current_sdev->request_queue);
489 spin_lock_irqsave(shost->host_lock, flags);
490 if (starget->starget_sdev_user)
492 list_for_each_entry_safe(sdev, tmp, &starget->devices,
493 same_target_siblings) {
494 if (sdev == current_sdev)
496 if (scsi_device_get(sdev))
499 spin_unlock_irqrestore(shost->host_lock, flags);
500 blk_run_queue(sdev->request_queue);
501 spin_lock_irqsave(shost->host_lock, flags);
503 scsi_device_put(sdev);
506 spin_unlock_irqrestore(shost->host_lock, flags);
510 * Function: scsi_run_queue()
512 * Purpose: Select a proper request queue to serve next
514 * Arguments: q - last request's queue
518 * Notes: The previous command was completely finished, start
519 * a new one if possible.
521 static void scsi_run_queue(struct request_queue *q)
523 struct scsi_device *sdev = q->queuedata;
524 struct Scsi_Host *shost = sdev->host;
527 if (sdev->single_lun)
528 scsi_single_lun_run(sdev);
530 spin_lock_irqsave(shost->host_lock, flags);
531 while (!list_empty(&shost->starved_list) &&
532 !shost->host_blocked && !shost->host_self_blocked &&
533 !((shost->can_queue > 0) &&
534 (shost->host_busy >= shost->can_queue))) {
536 * As long as shost is accepting commands and we have
537 * starved queues, call blk_run_queue. scsi_request_fn
538 * drops the queue_lock and can add us back to the
541 * host_lock protects the starved_list and starved_entry.
542 * scsi_request_fn must get the host_lock before checking
543 * or modifying starved_list or starved_entry.
545 sdev = list_entry(shost->starved_list.next,
546 struct scsi_device, starved_entry);
547 list_del_init(&sdev->starved_entry);
548 spin_unlock_irqrestore(shost->host_lock, flags);
551 if (test_bit(QUEUE_FLAG_REENTER, &q->queue_flags) &&
552 !test_and_set_bit(QUEUE_FLAG_REENTER,
553 &sdev->request_queue->queue_flags)) {
554 blk_run_queue(sdev->request_queue);
555 clear_bit(QUEUE_FLAG_REENTER,
556 &sdev->request_queue->queue_flags);
558 blk_run_queue(sdev->request_queue);
560 spin_lock_irqsave(shost->host_lock, flags);
561 if (unlikely(!list_empty(&sdev->starved_entry)))
563 * sdev lost a race, and was put back on the
564 * starved list. This is unlikely but without this
565 * in theory we could loop forever.
569 spin_unlock_irqrestore(shost->host_lock, flags);
575 * Function: scsi_requeue_command()
577 * Purpose: Handle post-processing of completed commands.
579 * Arguments: q - queue to operate on
580 * cmd - command that may need to be requeued.
584 * Notes: After command completion, there may be blocks left
585 * over which weren't finished by the previous command
586 * this can be for a number of reasons - the main one is
587 * I/O errors in the middle of the request, in which case
588 * we need to request the blocks that come after the bad
590 * Notes: Upon return, cmd is a stale pointer.
592 static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
594 struct request *req = cmd->request;
597 scsi_unprep_request(req);
598 spin_lock_irqsave(q->queue_lock, flags);
599 blk_requeue_request(q, req);
600 spin_unlock_irqrestore(q->queue_lock, flags);
605 void scsi_next_command(struct scsi_cmnd *cmd)
607 struct scsi_device *sdev = cmd->device;
608 struct request_queue *q = sdev->request_queue;
610 /* need to hold a reference on the device before we let go of the cmd */
611 get_device(&sdev->sdev_gendev);
613 scsi_put_command(cmd);
616 /* ok to remove device now */
617 put_device(&sdev->sdev_gendev);
620 void scsi_run_host_queues(struct Scsi_Host *shost)
622 struct scsi_device *sdev;
624 shost_for_each_device(sdev, shost)
625 scsi_run_queue(sdev->request_queue);
629 * Function: scsi_end_request()
631 * Purpose: Post-processing of completed commands (usually invoked at end
632 * of upper level post-processing and scsi_io_completion).
634 * Arguments: cmd - command that is complete.
635 * uptodate - 1 if I/O indicates success, <= 0 for I/O error.
636 * bytes - number of bytes of completed I/O
637 * requeue - indicates whether we should requeue leftovers.
639 * Lock status: Assumed that lock is not held upon entry.
641 * Returns: cmd if requeue required, NULL otherwise.
643 * Notes: This is called for block device requests in order to
644 * mark some number of sectors as complete.
646 * We are guaranteeing that the request queue will be goosed
647 * at some point during this call.
648 * Notes: If cmd was requeued, upon return it will be a stale pointer.
650 static struct scsi_cmnd *scsi_end_request(struct scsi_cmnd *cmd, int uptodate,
651 int bytes, int requeue)
653 struct request_queue *q = cmd->device->request_queue;
654 struct request *req = cmd->request;
658 * If there are blocks left over at the end, set up the command
659 * to queue the remainder of them.
661 if (end_that_request_chunk(req, uptodate, bytes)) {
662 int leftover = (req->hard_nr_sectors << 9);
664 if (blk_pc_request(req))
665 leftover = req->data_len;
667 /* kill remainder if no retrys */
668 if (!uptodate && blk_noretry_request(req))
669 end_that_request_chunk(req, 0, leftover);
673 * Bleah. Leftovers again. Stick the
674 * leftovers in the front of the
675 * queue, and goose the queue again.
677 scsi_requeue_command(q, cmd);
684 add_disk_randomness(req->rq_disk);
686 spin_lock_irqsave(q->queue_lock, flags);
687 if (blk_rq_tagged(req))
688 blk_queue_end_tag(q, req);
689 end_that_request_last(req, uptodate);
690 spin_unlock_irqrestore(q->queue_lock, flags);
693 * This will goose the queue request function at the end, so we don't
694 * need to worry about launching another command.
696 scsi_next_command(cmd);
701 * Like SCSI_MAX_SG_SEGMENTS, but for archs that have sg chaining. This limit
702 * is totally arbitrary, a setting of 2048 will get you at least 8mb ios.
704 #define SCSI_MAX_SG_CHAIN_SEGMENTS 2048
706 static inline unsigned int scsi_sgtable_index(unsigned short nents)
717 #if (SCSI_MAX_SG_SEGMENTS > 16)
721 #if (SCSI_MAX_SG_SEGMENTS > 32)
725 #if (SCSI_MAX_SG_SEGMENTS > 64)
733 printk(KERN_ERR "scsi: bad segment count=%d\n", nents);
740 struct scatterlist *scsi_alloc_sgtable(struct scsi_cmnd *cmd, gfp_t gfp_mask)
742 struct scsi_host_sg_pool *sgp;
743 struct scatterlist *sgl, *prev, *ret;
747 BUG_ON(!cmd->use_sg);
753 if (this > SCSI_MAX_SG_SEGMENTS) {
754 this = SCSI_MAX_SG_SEGMENTS - 1;
755 index = SG_MEMPOOL_NR - 1;
757 index = scsi_sgtable_index(this);
761 sgp = scsi_sg_pools + index;
763 sgl = mempool_alloc(sgp->pool, gfp_mask);
768 * first loop through, set initial index and return value
774 * chain previous sglist, if any. we know the previous
775 * sglist must be the biggest one, or we would not have
776 * ended up doing another loop.
779 sg_chain(prev, SCSI_MAX_SG_SEGMENTS, sgl);
782 * don't allow subsequent mempool allocs to sleep, it would
783 * violate the mempool principle.
785 gfp_mask &= ~__GFP_WAIT;
786 gfp_mask |= __GFP_HIGH;
791 * ->use_sg may get modified after dma mapping has potentially
792 * shrunk the number of segments, so keep a copy of it for free.
794 cmd->__use_sg = cmd->use_sg;
799 * Free entries chained off ret. Since we were trying to
800 * allocate another sglist, we know that all entries are of
803 sgp = scsi_sg_pools + SG_MEMPOOL_NR - 1;
805 ret = &ret[SCSI_MAX_SG_SEGMENTS - 1];
807 while ((sgl = sg_chain_ptr(ret)) != NULL) {
808 ret = &sgl[SCSI_MAX_SG_SEGMENTS - 1];
809 mempool_free(sgl, sgp->pool);
812 mempool_free(prev, sgp->pool);
817 EXPORT_SYMBOL(scsi_alloc_sgtable);
819 void scsi_free_sgtable(struct scsi_cmnd *cmd)
821 struct scatterlist *sgl = cmd->request_buffer;
822 struct scsi_host_sg_pool *sgp;
825 * if this is the biggest size sglist, check if we have
826 * chained parts we need to free
828 if (cmd->__use_sg > SCSI_MAX_SG_SEGMENTS) {
829 unsigned short this, left;
830 struct scatterlist *next;
833 left = cmd->__use_sg - (SCSI_MAX_SG_SEGMENTS - 1);
834 next = sg_chain_ptr(&sgl[SCSI_MAX_SG_SEGMENTS - 1]);
835 while (left && next) {
838 if (this > SCSI_MAX_SG_SEGMENTS) {
839 this = SCSI_MAX_SG_SEGMENTS - 1;
840 index = SG_MEMPOOL_NR - 1;
842 index = scsi_sgtable_index(this);
846 sgp = scsi_sg_pools + index;
849 next = sg_chain_ptr(&sgl[sgp->size - 1]);
851 mempool_free(sgl, sgp->pool);
855 * Restore original, will be freed below
857 sgl = cmd->request_buffer;
858 sgp = scsi_sg_pools + SG_MEMPOOL_NR - 1;
860 sgp = scsi_sg_pools + scsi_sgtable_index(cmd->__use_sg);
862 mempool_free(sgl, sgp->pool);
865 EXPORT_SYMBOL(scsi_free_sgtable);
868 * Function: scsi_release_buffers()
870 * Purpose: Completion processing for block device I/O requests.
872 * Arguments: cmd - command that we are bailing.
874 * Lock status: Assumed that no lock is held upon entry.
878 * Notes: In the event that an upper level driver rejects a
879 * command, we must release resources allocated during
880 * the __init_io() function. Primarily this would involve
881 * the scatter-gather table, and potentially any bounce
884 static void scsi_release_buffers(struct scsi_cmnd *cmd)
887 scsi_free_sgtable(cmd);
890 * Zero these out. They now point to freed memory, and it is
891 * dangerous to hang onto the pointers.
893 cmd->request_buffer = NULL;
894 cmd->request_bufflen = 0;
898 * Function: scsi_io_completion()
900 * Purpose: Completion processing for block device I/O requests.
902 * Arguments: cmd - command that is finished.
904 * Lock status: Assumed that no lock is held upon entry.
908 * Notes: This function is matched in terms of capabilities to
909 * the function that created the scatter-gather list.
910 * In other words, if there are no bounce buffers
911 * (the normal case for most drivers), we don't need
912 * the logic to deal with cleaning up afterwards.
914 * We must do one of several things here:
916 * a) Call scsi_end_request. This will finish off the
917 * specified number of sectors. If we are done, the
918 * command block will be released, and the queue
919 * function will be goosed. If we are not done, then
920 * scsi_end_request will directly goose the queue.
922 * b) We can just use scsi_requeue_command() here. This would
923 * be used if we just wanted to retry, for example.
925 void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
927 int result = cmd->result;
928 int this_count = cmd->request_bufflen;
929 struct request_queue *q = cmd->device->request_queue;
930 struct request *req = cmd->request;
931 int clear_errors = 1;
932 struct scsi_sense_hdr sshdr;
934 int sense_deferred = 0;
936 scsi_release_buffers(cmd);
939 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
941 sense_deferred = scsi_sense_is_deferred(&sshdr);
944 if (blk_pc_request(req)) { /* SG_IO ioctl from block level */
945 req->errors = result;
948 if (sense_valid && req->sense) {
950 * SG_IO wants current and deferred errors
952 int len = 8 + cmd->sense_buffer[7];
954 if (len > SCSI_SENSE_BUFFERSIZE)
955 len = SCSI_SENSE_BUFFERSIZE;
956 memcpy(req->sense, cmd->sense_buffer, len);
957 req->sense_len = len;
960 req->data_len = cmd->resid;
964 * Next deal with any sectors which we were able to correctly
967 SCSI_LOG_HLCOMPLETE(1, printk("%ld sectors total, "
969 req->nr_sectors, good_bytes));
970 SCSI_LOG_HLCOMPLETE(1, printk("use_sg is %d\n", cmd->use_sg));
975 /* A number of bytes were successfully read. If there
976 * are leftovers and there is some kind of error
977 * (result != 0), retry the rest.
979 if (scsi_end_request(cmd, 1, good_bytes, result == 0) == NULL)
982 /* good_bytes = 0, or (inclusive) there were leftovers and
983 * result = 0, so scsi_end_request couldn't retry.
985 if (sense_valid && !sense_deferred) {
986 switch (sshdr.sense_key) {
988 if (cmd->device->removable) {
989 /* Detected disc change. Set a bit
990 * and quietly refuse further access.
992 cmd->device->changed = 1;
993 scsi_end_request(cmd, 0, this_count, 1);
996 /* Must have been a power glitch, or a
997 * bus reset. Could not have been a
998 * media change, so we just retry the
999 * request and see what happens.
1001 scsi_requeue_command(q, cmd);
1005 case ILLEGAL_REQUEST:
1006 /* If we had an ILLEGAL REQUEST returned, then
1007 * we may have performed an unsupported
1008 * command. The only thing this should be
1009 * would be a ten byte read where only a six
1010 * byte read was supported. Also, on a system
1011 * where READ CAPACITY failed, we may have
1012 * read past the end of the disk.
1014 if ((cmd->device->use_10_for_rw &&
1015 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
1016 (cmd->cmnd[0] == READ_10 ||
1017 cmd->cmnd[0] == WRITE_10)) {
1018 cmd->device->use_10_for_rw = 0;
1019 /* This will cause a retry with a
1022 scsi_requeue_command(q, cmd);
1025 scsi_end_request(cmd, 0, this_count, 1);
1030 /* If the device is in the process of becoming
1031 * ready, or has a temporary blockage, retry.
1033 if (sshdr.asc == 0x04) {
1034 switch (sshdr.ascq) {
1035 case 0x01: /* becoming ready */
1036 case 0x04: /* format in progress */
1037 case 0x05: /* rebuild in progress */
1038 case 0x06: /* recalculation in progress */
1039 case 0x07: /* operation in progress */
1040 case 0x08: /* Long write in progress */
1041 case 0x09: /* self test in progress */
1042 scsi_requeue_command(q, cmd);
1048 if (!(req->cmd_flags & REQ_QUIET))
1049 scsi_cmd_print_sense_hdr(cmd,
1053 scsi_end_request(cmd, 0, this_count, 1);
1055 case VOLUME_OVERFLOW:
1056 if (!(req->cmd_flags & REQ_QUIET)) {
1057 scmd_printk(KERN_INFO, cmd,
1058 "Volume overflow, CDB: ");
1059 __scsi_print_command(cmd->cmnd);
1060 scsi_print_sense("", cmd);
1062 /* See SSC3rXX or current. */
1063 scsi_end_request(cmd, 0, this_count, 1);
1069 if (host_byte(result) == DID_RESET) {
1070 /* Third party bus reset or reset for error recovery
1071 * reasons. Just retry the request and see what
1074 scsi_requeue_command(q, cmd);
1078 if (!(req->cmd_flags & REQ_QUIET)) {
1079 scsi_print_result(cmd);
1080 if (driver_byte(result) & DRIVER_SENSE)
1081 scsi_print_sense("", cmd);
1084 scsi_end_request(cmd, 0, this_count, !result);
1088 * Function: scsi_init_io()
1090 * Purpose: SCSI I/O initialize function.
1092 * Arguments: cmd - Command descriptor we wish to initialize
1094 * Returns: 0 on success
1095 * BLKPREP_DEFER if the failure is retryable
1096 * BLKPREP_KILL if the failure is fatal
1098 static int scsi_init_io(struct scsi_cmnd *cmd)
1100 struct request *req = cmd->request;
1104 * We used to not use scatter-gather for single segment request,
1105 * but now we do (it makes highmem I/O easier to support without
1108 cmd->use_sg = req->nr_phys_segments;
1111 * If sg table allocation fails, requeue request later.
1113 cmd->request_buffer = scsi_alloc_sgtable(cmd, GFP_ATOMIC);
1114 if (unlikely(!cmd->request_buffer)) {
1115 scsi_unprep_request(req);
1116 return BLKPREP_DEFER;
1120 if (blk_pc_request(req))
1121 cmd->request_bufflen = req->data_len;
1123 cmd->request_bufflen = req->nr_sectors << 9;
1126 * Next, walk the list, and fill in the addresses and sizes of
1129 count = blk_rq_map_sg(req->q, req, cmd->request_buffer);
1130 if (likely(count <= cmd->use_sg)) {
1131 cmd->use_sg = count;
1135 printk(KERN_ERR "Incorrect number of segments after building list\n");
1136 printk(KERN_ERR "counted %d, received %d\n", count, cmd->use_sg);
1137 printk(KERN_ERR "req nr_sec %lu, cur_nr_sec %u\n", req->nr_sectors,
1138 req->current_nr_sectors);
1140 return BLKPREP_KILL;
1143 static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
1144 struct request *req)
1146 struct scsi_cmnd *cmd;
1148 if (!req->special) {
1149 cmd = scsi_get_command(sdev, GFP_ATOMIC);
1157 /* pull a tag out of the request if we have one */
1158 cmd->tag = req->tag;
1164 int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
1166 struct scsi_cmnd *cmd;
1167 int ret = scsi_prep_state_check(sdev, req);
1169 if (ret != BLKPREP_OK)
1172 cmd = scsi_get_cmd_from_req(sdev, req);
1174 return BLKPREP_DEFER;
1177 * BLOCK_PC requests may transfer data, in which case they must
1178 * a bio attached to them. Or they might contain a SCSI command
1179 * that does not transfer data, in which case they may optionally
1180 * submit a request without an attached bio.
1185 BUG_ON(!req->nr_phys_segments);
1187 ret = scsi_init_io(cmd);
1191 BUG_ON(req->data_len);
1194 cmd->request_bufflen = 0;
1195 cmd->request_buffer = NULL;
1200 BUILD_BUG_ON(sizeof(req->cmd) > sizeof(cmd->cmnd));
1201 memcpy(cmd->cmnd, req->cmd, sizeof(cmd->cmnd));
1202 cmd->cmd_len = req->cmd_len;
1204 cmd->sc_data_direction = DMA_NONE;
1205 else if (rq_data_dir(req) == WRITE)
1206 cmd->sc_data_direction = DMA_TO_DEVICE;
1208 cmd->sc_data_direction = DMA_FROM_DEVICE;
1210 cmd->transfersize = req->data_len;
1211 cmd->allowed = req->retries;
1212 cmd->timeout_per_command = req->timeout;
1215 EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
1218 * Setup a REQ_TYPE_FS command. These are simple read/write request
1219 * from filesystems that still need to be translated to SCSI CDBs from
1222 int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
1224 struct scsi_cmnd *cmd;
1225 int ret = scsi_prep_state_check(sdev, req);
1227 if (ret != BLKPREP_OK)
1230 * Filesystem requests must transfer data.
1232 BUG_ON(!req->nr_phys_segments);
1234 cmd = scsi_get_cmd_from_req(sdev, req);
1236 return BLKPREP_DEFER;
1238 return scsi_init_io(cmd);
1240 EXPORT_SYMBOL(scsi_setup_fs_cmnd);
1242 int scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
1244 int ret = BLKPREP_OK;
1247 * If the device is not in running state we will reject some
1250 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1251 switch (sdev->sdev_state) {
1254 * If the device is offline we refuse to process any
1255 * commands. The device must be brought online
1256 * before trying any recovery commands.
1258 sdev_printk(KERN_ERR, sdev,
1259 "rejecting I/O to offline device\n");
1264 * If the device is fully deleted, we refuse to
1265 * process any commands as well.
1267 sdev_printk(KERN_ERR, sdev,
1268 "rejecting I/O to dead device\n");
1274 * If the devices is blocked we defer normal commands.
1276 if (!(req->cmd_flags & REQ_PREEMPT))
1277 ret = BLKPREP_DEFER;
1281 * For any other not fully online state we only allow
1282 * special commands. In particular any user initiated
1283 * command is not allowed.
1285 if (!(req->cmd_flags & REQ_PREEMPT))
1292 EXPORT_SYMBOL(scsi_prep_state_check);
1294 int scsi_prep_return(struct request_queue *q, struct request *req, int ret)
1296 struct scsi_device *sdev = q->queuedata;
1300 req->errors = DID_NO_CONNECT << 16;
1301 /* release the command and kill it */
1303 struct scsi_cmnd *cmd = req->special;
1304 scsi_release_buffers(cmd);
1305 scsi_put_command(cmd);
1306 req->special = NULL;
1311 * If we defer, the elv_next_request() returns NULL, but the
1312 * queue must be restarted, so we plug here if no returning
1313 * command will automatically do that.
1315 if (sdev->device_busy == 0)
1319 req->cmd_flags |= REQ_DONTPREP;
1324 EXPORT_SYMBOL(scsi_prep_return);
1326 static int scsi_prep_fn(struct request_queue *q, struct request *req)
1328 struct scsi_device *sdev = q->queuedata;
1329 int ret = BLKPREP_KILL;
1331 if (req->cmd_type == REQ_TYPE_BLOCK_PC)
1332 ret = scsi_setup_blk_pc_cmnd(sdev, req);
1333 return scsi_prep_return(q, req, ret);
1337 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1340 * Called with the queue_lock held.
1342 static inline int scsi_dev_queue_ready(struct request_queue *q,
1343 struct scsi_device *sdev)
1345 if (sdev->device_busy >= sdev->queue_depth)
1347 if (sdev->device_busy == 0 && sdev->device_blocked) {
1349 * unblock after device_blocked iterates to zero
1351 if (--sdev->device_blocked == 0) {
1353 sdev_printk(KERN_INFO, sdev,
1354 "unblocking device at zero depth\n"));
1360 if (sdev->device_blocked)
1367 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1368 * return 0. We must end up running the queue again whenever 0 is
1369 * returned, else IO can hang.
1371 * Called with host_lock held.
1373 static inline int scsi_host_queue_ready(struct request_queue *q,
1374 struct Scsi_Host *shost,
1375 struct scsi_device *sdev)
1377 if (scsi_host_in_recovery(shost))
1379 if (shost->host_busy == 0 && shost->host_blocked) {
1381 * unblock after host_blocked iterates to zero
1383 if (--shost->host_blocked == 0) {
1385 printk("scsi%d unblocking host at zero depth\n",
1392 if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
1393 shost->host_blocked || shost->host_self_blocked) {
1394 if (list_empty(&sdev->starved_entry))
1395 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1399 /* We're OK to process the command, so we can't be starved */
1400 if (!list_empty(&sdev->starved_entry))
1401 list_del_init(&sdev->starved_entry);
1407 * Kill a request for a dead device
1409 static void scsi_kill_request(struct request *req, struct request_queue *q)
1411 struct scsi_cmnd *cmd = req->special;
1412 struct scsi_device *sdev = cmd->device;
1413 struct Scsi_Host *shost = sdev->host;
1415 blkdev_dequeue_request(req);
1417 if (unlikely(cmd == NULL)) {
1418 printk(KERN_CRIT "impossible request in %s.\n",
1423 scsi_init_cmd_errh(cmd);
1424 cmd->result = DID_NO_CONNECT << 16;
1425 atomic_inc(&cmd->device->iorequest_cnt);
1428 * SCSI request completion path will do scsi_device_unbusy(),
1429 * bump busy counts. To bump the counters, we need to dance
1430 * with the locks as normal issue path does.
1432 sdev->device_busy++;
1433 spin_unlock(sdev->request_queue->queue_lock);
1434 spin_lock(shost->host_lock);
1436 spin_unlock(shost->host_lock);
1437 spin_lock(sdev->request_queue->queue_lock);
1442 static void scsi_softirq_done(struct request *rq)
1444 struct scsi_cmnd *cmd = rq->completion_data;
1445 unsigned long wait_for = (cmd->allowed + 1) * cmd->timeout_per_command;
1448 INIT_LIST_HEAD(&cmd->eh_entry);
1450 disposition = scsi_decide_disposition(cmd);
1451 if (disposition != SUCCESS &&
1452 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1453 sdev_printk(KERN_ERR, cmd->device,
1454 "timing out command, waited %lus\n",
1456 disposition = SUCCESS;
1459 scsi_log_completion(cmd, disposition);
1461 switch (disposition) {
1463 scsi_finish_command(cmd);
1466 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
1468 case ADD_TO_MLQUEUE:
1469 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1472 if (!scsi_eh_scmd_add(cmd, 0))
1473 scsi_finish_command(cmd);
1478 * Function: scsi_request_fn()
1480 * Purpose: Main strategy routine for SCSI.
1482 * Arguments: q - Pointer to actual queue.
1486 * Lock status: IO request lock assumed to be held when called.
1488 static void scsi_request_fn(struct request_queue *q)
1490 struct scsi_device *sdev = q->queuedata;
1491 struct Scsi_Host *shost;
1492 struct scsi_cmnd *cmd;
1493 struct request *req;
1496 printk("scsi: killing requests for dead queue\n");
1497 while ((req = elv_next_request(q)) != NULL)
1498 scsi_kill_request(req, q);
1502 if(!get_device(&sdev->sdev_gendev))
1503 /* We must be tearing the block queue down already */
1507 * To start with, we keep looping until the queue is empty, or until
1508 * the host is no longer able to accept any more requests.
1511 while (!blk_queue_plugged(q)) {
1514 * get next queueable request. We do this early to make sure
1515 * that the request is fully prepared even if we cannot
1518 req = elv_next_request(q);
1519 if (!req || !scsi_dev_queue_ready(q, sdev))
1522 if (unlikely(!scsi_device_online(sdev))) {
1523 sdev_printk(KERN_ERR, sdev,
1524 "rejecting I/O to offline device\n");
1525 scsi_kill_request(req, q);
1531 * Remove the request from the request list.
1533 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
1534 blkdev_dequeue_request(req);
1535 sdev->device_busy++;
1537 spin_unlock(q->queue_lock);
1539 if (unlikely(cmd == NULL)) {
1540 printk(KERN_CRIT "impossible request in %s.\n"
1541 "please mail a stack trace to "
1542 "linux-scsi@vger.kernel.org\n",
1544 blk_dump_rq_flags(req, "foo");
1547 spin_lock(shost->host_lock);
1549 if (!scsi_host_queue_ready(q, shost, sdev))
1551 if (sdev->single_lun) {
1552 if (scsi_target(sdev)->starget_sdev_user &&
1553 scsi_target(sdev)->starget_sdev_user != sdev)
1555 scsi_target(sdev)->starget_sdev_user = sdev;
1560 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1561 * take the lock again.
1563 spin_unlock_irq(shost->host_lock);
1566 * Finally, initialize any error handling parameters, and set up
1567 * the timers for timeouts.
1569 scsi_init_cmd_errh(cmd);
1572 * Dispatch the command to the low-level driver.
1574 rtn = scsi_dispatch_cmd(cmd);
1575 spin_lock_irq(q->queue_lock);
1577 /* we're refusing the command; because of
1578 * the way locks get dropped, we need to
1579 * check here if plugging is required */
1580 if(sdev->device_busy == 0)
1590 spin_unlock_irq(shost->host_lock);
1593 * lock q, handle tag, requeue req, and decrement device_busy. We
1594 * must return with queue_lock held.
1596 * Decrementing device_busy without checking it is OK, as all such
1597 * cases (host limits or settings) should run the queue at some
1600 spin_lock_irq(q->queue_lock);
1601 blk_requeue_request(q, req);
1602 sdev->device_busy--;
1603 if(sdev->device_busy == 0)
1606 /* must be careful here...if we trigger the ->remove() function
1607 * we cannot be holding the q lock */
1608 spin_unlock_irq(q->queue_lock);
1609 put_device(&sdev->sdev_gendev);
1610 spin_lock_irq(q->queue_lock);
1613 u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
1615 struct device *host_dev;
1616 u64 bounce_limit = 0xffffffff;
1618 if (shost->unchecked_isa_dma)
1619 return BLK_BOUNCE_ISA;
1621 * Platforms with virtual-DMA translation
1622 * hardware have no practical limit.
1624 if (!PCI_DMA_BUS_IS_PHYS)
1625 return BLK_BOUNCE_ANY;
1627 host_dev = scsi_get_device(shost);
1628 if (host_dev && host_dev->dma_mask)
1629 bounce_limit = *host_dev->dma_mask;
1631 return bounce_limit;
1633 EXPORT_SYMBOL(scsi_calculate_bounce_limit);
1635 struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
1636 request_fn_proc *request_fn)
1638 struct request_queue *q;
1640 q = blk_init_queue(request_fn, NULL);
1645 * this limit is imposed by hardware restrictions
1647 blk_queue_max_hw_segments(q, shost->sg_tablesize);
1650 * In the future, sg chaining support will be mandatory and this
1651 * ifdef can then go away. Right now we don't have all archs
1652 * converted, so better keep it safe.
1654 #ifdef ARCH_HAS_SG_CHAIN
1655 if (shost->use_sg_chaining)
1656 blk_queue_max_phys_segments(q, SCSI_MAX_SG_CHAIN_SEGMENTS);
1658 blk_queue_max_phys_segments(q, SCSI_MAX_SG_SEGMENTS);
1660 blk_queue_max_phys_segments(q, SCSI_MAX_SG_SEGMENTS);
1663 blk_queue_max_sectors(q, shost->max_sectors);
1664 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
1665 blk_queue_segment_boundary(q, shost->dma_boundary);
1667 if (!shost->use_clustering)
1668 clear_bit(QUEUE_FLAG_CLUSTER, &q->queue_flags);
1671 EXPORT_SYMBOL(__scsi_alloc_queue);
1673 struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
1675 struct request_queue *q;
1677 q = __scsi_alloc_queue(sdev->host, scsi_request_fn);
1681 blk_queue_prep_rq(q, scsi_prep_fn);
1682 blk_queue_softirq_done(q, scsi_softirq_done);
1686 void scsi_free_queue(struct request_queue *q)
1688 blk_cleanup_queue(q);
1692 * Function: scsi_block_requests()
1694 * Purpose: Utility function used by low-level drivers to prevent further
1695 * commands from being queued to the device.
1697 * Arguments: shost - Host in question
1701 * Lock status: No locks are assumed held.
1703 * Notes: There is no timer nor any other means by which the requests
1704 * get unblocked other than the low-level driver calling
1705 * scsi_unblock_requests().
1707 void scsi_block_requests(struct Scsi_Host *shost)
1709 shost->host_self_blocked = 1;
1711 EXPORT_SYMBOL(scsi_block_requests);
1714 * Function: scsi_unblock_requests()
1716 * Purpose: Utility function used by low-level drivers to allow further
1717 * commands from being queued to the device.
1719 * Arguments: shost - Host in question
1723 * Lock status: No locks are assumed held.
1725 * Notes: There is no timer nor any other means by which the requests
1726 * get unblocked other than the low-level driver calling
1727 * scsi_unblock_requests().
1729 * This is done as an API function so that changes to the
1730 * internals of the scsi mid-layer won't require wholesale
1731 * changes to drivers that use this feature.
1733 void scsi_unblock_requests(struct Scsi_Host *shost)
1735 shost->host_self_blocked = 0;
1736 scsi_run_host_queues(shost);
1738 EXPORT_SYMBOL(scsi_unblock_requests);
1740 int __init scsi_init_queue(void)
1744 scsi_io_context_cache = kmem_cache_create("scsi_io_context",
1745 sizeof(struct scsi_io_context),
1747 if (!scsi_io_context_cache) {
1748 printk(KERN_ERR "SCSI: can't init scsi io context cache\n");
1752 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1753 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1754 int size = sgp->size * sizeof(struct scatterlist);
1756 sgp->slab = kmem_cache_create(sgp->name, size, 0,
1757 SLAB_HWCACHE_ALIGN, NULL);
1759 printk(KERN_ERR "SCSI: can't init sg slab %s\n",
1763 sgp->pool = mempool_create_slab_pool(SG_MEMPOOL_SIZE,
1766 printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
1774 void scsi_exit_queue(void)
1778 kmem_cache_destroy(scsi_io_context_cache);
1780 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1781 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1782 mempool_destroy(sgp->pool);
1783 kmem_cache_destroy(sgp->slab);
1788 * scsi_mode_select - issue a mode select
1789 * @sdev: SCSI device to be queried
1790 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1791 * @sp: Save page bit (0 == don't save, 1 == save)
1792 * @modepage: mode page being requested
1793 * @buffer: request buffer (may not be smaller than eight bytes)
1794 * @len: length of request buffer.
1795 * @timeout: command timeout
1796 * @retries: number of retries before failing
1797 * @data: returns a structure abstracting the mode header data
1798 * @sense: place to put sense data (or NULL if no sense to be collected).
1799 * must be SCSI_SENSE_BUFFERSIZE big.
1801 * Returns zero if successful; negative error number or scsi
1806 scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1807 unsigned char *buffer, int len, int timeout, int retries,
1808 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1810 unsigned char cmd[10];
1811 unsigned char *real_buffer;
1814 memset(cmd, 0, sizeof(cmd));
1815 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
1817 if (sdev->use_10_for_ms) {
1820 real_buffer = kmalloc(8 + len, GFP_KERNEL);
1823 memcpy(real_buffer + 8, buffer, len);
1827 real_buffer[2] = data->medium_type;
1828 real_buffer[3] = data->device_specific;
1829 real_buffer[4] = data->longlba ? 0x01 : 0;
1831 real_buffer[6] = data->block_descriptor_length >> 8;
1832 real_buffer[7] = data->block_descriptor_length;
1834 cmd[0] = MODE_SELECT_10;
1838 if (len > 255 || data->block_descriptor_length > 255 ||
1842 real_buffer = kmalloc(4 + len, GFP_KERNEL);
1845 memcpy(real_buffer + 4, buffer, len);
1848 real_buffer[1] = data->medium_type;
1849 real_buffer[2] = data->device_specific;
1850 real_buffer[3] = data->block_descriptor_length;
1853 cmd[0] = MODE_SELECT;
1857 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
1858 sshdr, timeout, retries);
1862 EXPORT_SYMBOL_GPL(scsi_mode_select);
1865 * scsi_mode_sense - issue a mode sense, falling back from 10 to
1866 * six bytes if necessary.
1867 * @sdev: SCSI device to be queried
1868 * @dbd: set if mode sense will allow block descriptors to be returned
1869 * @modepage: mode page being requested
1870 * @buffer: request buffer (may not be smaller than eight bytes)
1871 * @len: length of request buffer.
1872 * @timeout: command timeout
1873 * @retries: number of retries before failing
1874 * @data: returns a structure abstracting the mode header data
1875 * @sense: place to put sense data (or NULL if no sense to be collected).
1876 * must be SCSI_SENSE_BUFFERSIZE big.
1878 * Returns zero if unsuccessful, or the header offset (either 4
1879 * or 8 depending on whether a six or ten byte command was
1880 * issued) if successful.
1883 scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
1884 unsigned char *buffer, int len, int timeout, int retries,
1885 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1887 unsigned char cmd[12];
1891 struct scsi_sense_hdr my_sshdr;
1893 memset(data, 0, sizeof(*data));
1894 memset(&cmd[0], 0, 12);
1895 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
1898 /* caller might not be interested in sense, but we need it */
1903 use_10_for_ms = sdev->use_10_for_ms;
1905 if (use_10_for_ms) {
1909 cmd[0] = MODE_SENSE_10;
1916 cmd[0] = MODE_SENSE;
1921 memset(buffer, 0, len);
1923 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
1924 sshdr, timeout, retries);
1926 /* This code looks awful: what it's doing is making sure an
1927 * ILLEGAL REQUEST sense return identifies the actual command
1928 * byte as the problem. MODE_SENSE commands can return
1929 * ILLEGAL REQUEST if the code page isn't supported */
1931 if (use_10_for_ms && !scsi_status_is_good(result) &&
1932 (driver_byte(result) & DRIVER_SENSE)) {
1933 if (scsi_sense_valid(sshdr)) {
1934 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
1935 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
1937 * Invalid command operation code
1939 sdev->use_10_for_ms = 0;
1945 if(scsi_status_is_good(result)) {
1946 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
1947 (modepage == 6 || modepage == 8))) {
1948 /* Initio breakage? */
1951 data->medium_type = 0;
1952 data->device_specific = 0;
1954 data->block_descriptor_length = 0;
1955 } else if(use_10_for_ms) {
1956 data->length = buffer[0]*256 + buffer[1] + 2;
1957 data->medium_type = buffer[2];
1958 data->device_specific = buffer[3];
1959 data->longlba = buffer[4] & 0x01;
1960 data->block_descriptor_length = buffer[6]*256
1963 data->length = buffer[0] + 1;
1964 data->medium_type = buffer[1];
1965 data->device_specific = buffer[2];
1966 data->block_descriptor_length = buffer[3];
1968 data->header_length = header_length;
1973 EXPORT_SYMBOL(scsi_mode_sense);
1976 scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries)
1979 TEST_UNIT_READY, 0, 0, 0, 0, 0,
1981 struct scsi_sense_hdr sshdr;
1984 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, &sshdr,
1987 if ((driver_byte(result) & DRIVER_SENSE) && sdev->removable) {
1989 if ((scsi_sense_valid(&sshdr)) &&
1990 ((sshdr.sense_key == UNIT_ATTENTION) ||
1991 (sshdr.sense_key == NOT_READY))) {
1998 EXPORT_SYMBOL(scsi_test_unit_ready);
2001 * scsi_device_set_state - Take the given device through the device
2003 * @sdev: scsi device to change the state of.
2004 * @state: state to change to.
2006 * Returns zero if unsuccessful or an error if the requested
2007 * transition is illegal.
2010 scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2012 enum scsi_device_state oldstate = sdev->sdev_state;
2014 if (state == oldstate)
2019 /* There are no legal states that come back to
2020 * created. This is the manually initialised start
2094 sdev->sdev_state = state;
2098 SCSI_LOG_ERROR_RECOVERY(1,
2099 sdev_printk(KERN_ERR, sdev,
2100 "Illegal state transition %s->%s\n",
2101 scsi_device_state_name(oldstate),
2102 scsi_device_state_name(state))
2106 EXPORT_SYMBOL(scsi_device_set_state);
2109 * scsi_device_quiesce - Block user issued commands.
2110 * @sdev: scsi device to quiesce.
2112 * This works by trying to transition to the SDEV_QUIESCE state
2113 * (which must be a legal transition). When the device is in this
2114 * state, only special requests will be accepted, all others will
2115 * be deferred. Since special requests may also be requeued requests,
2116 * a successful return doesn't guarantee the device will be
2117 * totally quiescent.
2119 * Must be called with user context, may sleep.
2121 * Returns zero if unsuccessful or an error if not.
2124 scsi_device_quiesce(struct scsi_device *sdev)
2126 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2130 scsi_run_queue(sdev->request_queue);
2131 while (sdev->device_busy) {
2132 msleep_interruptible(200);
2133 scsi_run_queue(sdev->request_queue);
2137 EXPORT_SYMBOL(scsi_device_quiesce);
2140 * scsi_device_resume - Restart user issued commands to a quiesced device.
2141 * @sdev: scsi device to resume.
2143 * Moves the device from quiesced back to running and restarts the
2146 * Must be called with user context, may sleep.
2149 scsi_device_resume(struct scsi_device *sdev)
2151 if(scsi_device_set_state(sdev, SDEV_RUNNING))
2153 scsi_run_queue(sdev->request_queue);
2155 EXPORT_SYMBOL(scsi_device_resume);
2158 device_quiesce_fn(struct scsi_device *sdev, void *data)
2160 scsi_device_quiesce(sdev);
2164 scsi_target_quiesce(struct scsi_target *starget)
2166 starget_for_each_device(starget, NULL, device_quiesce_fn);
2168 EXPORT_SYMBOL(scsi_target_quiesce);
2171 device_resume_fn(struct scsi_device *sdev, void *data)
2173 scsi_device_resume(sdev);
2177 scsi_target_resume(struct scsi_target *starget)
2179 starget_for_each_device(starget, NULL, device_resume_fn);
2181 EXPORT_SYMBOL(scsi_target_resume);
2184 * scsi_internal_device_block - internal function to put a device
2185 * temporarily into the SDEV_BLOCK state
2186 * @sdev: device to block
2188 * Block request made by scsi lld's to temporarily stop all
2189 * scsi commands on the specified device. Called from interrupt
2190 * or normal process context.
2192 * Returns zero if successful or error if not
2195 * This routine transitions the device to the SDEV_BLOCK state
2196 * (which must be a legal transition). When the device is in this
2197 * state, all commands are deferred until the scsi lld reenables
2198 * the device with scsi_device_unblock or device_block_tmo fires.
2199 * This routine assumes the host_lock is held on entry.
2202 scsi_internal_device_block(struct scsi_device *sdev)
2204 struct request_queue *q = sdev->request_queue;
2205 unsigned long flags;
2208 err = scsi_device_set_state(sdev, SDEV_BLOCK);
2213 * The device has transitioned to SDEV_BLOCK. Stop the
2214 * block layer from calling the midlayer with this device's
2217 spin_lock_irqsave(q->queue_lock, flags);
2219 spin_unlock_irqrestore(q->queue_lock, flags);
2223 EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2226 * scsi_internal_device_unblock - resume a device after a block request
2227 * @sdev: device to resume
2229 * Called by scsi lld's or the midlayer to restart the device queue
2230 * for the previously suspended scsi device. Called from interrupt or
2231 * normal process context.
2233 * Returns zero if successful or error if not.
2236 * This routine transitions the device to the SDEV_RUNNING state
2237 * (which must be a legal transition) allowing the midlayer to
2238 * goose the queue for this device. This routine assumes the
2239 * host_lock is held upon entry.
2242 scsi_internal_device_unblock(struct scsi_device *sdev)
2244 struct request_queue *q = sdev->request_queue;
2246 unsigned long flags;
2249 * Try to transition the scsi device to SDEV_RUNNING
2250 * and goose the device queue if successful.
2252 err = scsi_device_set_state(sdev, SDEV_RUNNING);
2256 spin_lock_irqsave(q->queue_lock, flags);
2258 spin_unlock_irqrestore(q->queue_lock, flags);
2262 EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
2265 device_block(struct scsi_device *sdev, void *data)
2267 scsi_internal_device_block(sdev);
2271 target_block(struct device *dev, void *data)
2273 if (scsi_is_target_device(dev))
2274 starget_for_each_device(to_scsi_target(dev), NULL,
2280 scsi_target_block(struct device *dev)
2282 if (scsi_is_target_device(dev))
2283 starget_for_each_device(to_scsi_target(dev), NULL,
2286 device_for_each_child(dev, NULL, target_block);
2288 EXPORT_SYMBOL_GPL(scsi_target_block);
2291 device_unblock(struct scsi_device *sdev, void *data)
2293 scsi_internal_device_unblock(sdev);
2297 target_unblock(struct device *dev, void *data)
2299 if (scsi_is_target_device(dev))
2300 starget_for_each_device(to_scsi_target(dev), NULL,
2306 scsi_target_unblock(struct device *dev)
2308 if (scsi_is_target_device(dev))
2309 starget_for_each_device(to_scsi_target(dev), NULL,
2312 device_for_each_child(dev, NULL, target_unblock);
2314 EXPORT_SYMBOL_GPL(scsi_target_unblock);
2317 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
2318 * @sg: scatter-gather list
2319 * @sg_count: number of segments in sg
2320 * @offset: offset in bytes into sg, on return offset into the mapped area
2321 * @len: bytes to map, on return number of bytes mapped
2323 * Returns virtual address of the start of the mapped page
2325 void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
2326 size_t *offset, size_t *len)
2329 size_t sg_len = 0, len_complete = 0;
2330 struct scatterlist *sg;
2333 WARN_ON(!irqs_disabled());
2335 for_each_sg(sgl, sg, sg_count, i) {
2336 len_complete = sg_len; /* Complete sg-entries */
2337 sg_len += sg->length;
2338 if (sg_len > *offset)
2342 if (unlikely(i == sg_count)) {
2343 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2345 __FUNCTION__, sg_len, *offset, sg_count);
2350 /* Offset starting from the beginning of first page in this sg-entry */
2351 *offset = *offset - len_complete + sg->offset;
2353 /* Assumption: contiguous pages can be accessed as "page + i" */
2354 page = nth_page(sg->page, (*offset >> PAGE_SHIFT));
2355 *offset &= ~PAGE_MASK;
2357 /* Bytes in this sg-entry from *offset to the end of the page */
2358 sg_len = PAGE_SIZE - *offset;
2362 return kmap_atomic(page, KM_BIO_SRC_IRQ);
2364 EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2367 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously
2368 * mapped with scsi_kmap_atomic_sg
2369 * @virt: virtual address to be unmapped
2371 void scsi_kunmap_atomic_sg(void *virt)
2373 kunmap_atomic(virt, KM_BIO_SRC_IRQ);
2375 EXPORT_SYMBOL(scsi_kunmap_atomic_sg);