2 * scsi_lib.c Copyright (C) 1999 Eric Youngdale
4 * SCSI queueing library.
5 * Initial versions: Eric Youngdale (eric@andante.org).
6 * Based upon conversations with large numbers
7 * of people at Linux Expo.
10 #include <linux/bio.h>
11 #include <linux/bitops.h>
12 #include <linux/blkdev.h>
13 #include <linux/completion.h>
14 #include <linux/kernel.h>
15 #include <linux/mempool.h>
16 #include <linux/slab.h>
17 #include <linux/init.h>
18 #include <linux/pci.h>
19 #include <linux/delay.h>
20 #include <linux/hardirq.h>
21 #include <linux/scatterlist.h>
23 #include <scsi/scsi.h>
24 #include <scsi/scsi_cmnd.h>
25 #include <scsi/scsi_dbg.h>
26 #include <scsi/scsi_device.h>
27 #include <scsi/scsi_driver.h>
28 #include <scsi/scsi_eh.h>
29 #include <scsi/scsi_host.h>
31 #include "scsi_priv.h"
32 #include "scsi_logging.h"
35 #define SG_MEMPOOL_NR ARRAY_SIZE(scsi_sg_pools)
36 #define SG_MEMPOOL_SIZE 2
38 struct scsi_host_sg_pool {
41 struct kmem_cache *slab;
45 #define SP(x) { x, "sgpool-" __stringify(x) }
46 #if (SCSI_MAX_SG_SEGMENTS < 32)
47 #error SCSI_MAX_SG_SEGMENTS is too small (must be 32 or greater)
49 static struct scsi_host_sg_pool scsi_sg_pools[] = {
52 #if (SCSI_MAX_SG_SEGMENTS > 32)
54 #if (SCSI_MAX_SG_SEGMENTS > 64)
56 #if (SCSI_MAX_SG_SEGMENTS > 128)
58 #if (SCSI_MAX_SG_SEGMENTS > 256)
59 #error SCSI_MAX_SG_SEGMENTS is too large (256 MAX)
64 SP(SCSI_MAX_SG_SEGMENTS)
68 struct kmem_cache *scsi_sdb_cache;
70 static void scsi_run_queue(struct request_queue *q);
73 * Function: scsi_unprep_request()
75 * Purpose: Remove all preparation done for a request, including its
76 * associated scsi_cmnd, so that it can be requeued.
78 * Arguments: req - request to unprepare
80 * Lock status: Assumed that no locks are held upon entry.
84 static void scsi_unprep_request(struct request *req)
86 struct scsi_cmnd *cmd = req->special;
88 req->cmd_flags &= ~REQ_DONTPREP;
91 scsi_put_command(cmd);
95 * __scsi_queue_insert - private queue insertion
96 * @cmd: The SCSI command being requeued
97 * @reason: The reason for the requeue
98 * @unbusy: Whether the queue should be unbusied
100 * This is a private queue insertion. The public interface
101 * scsi_queue_insert() always assumes the queue should be unbusied
102 * because it's always called before the completion. This function is
103 * for a requeue after completion, which should only occur in this
106 static int __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
108 struct Scsi_Host *host = cmd->device->host;
109 struct scsi_device *device = cmd->device;
110 struct scsi_target *starget = scsi_target(device);
111 struct request_queue *q = device->request_queue;
115 printk("Inserting command %p into mlqueue\n", cmd));
118 * Set the appropriate busy bit for the device/host.
120 * If the host/device isn't busy, assume that something actually
121 * completed, and that we should be able to queue a command now.
123 * Note that the prior mid-layer assumption that any host could
124 * always queue at least one command is now broken. The mid-layer
125 * will implement a user specifiable stall (see
126 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
127 * if a command is requeued with no other commands outstanding
128 * either for the device or for the host.
131 case SCSI_MLQUEUE_HOST_BUSY:
132 host->host_blocked = host->max_host_blocked;
134 case SCSI_MLQUEUE_DEVICE_BUSY:
135 device->device_blocked = device->max_device_blocked;
137 case SCSI_MLQUEUE_TARGET_BUSY:
138 starget->target_blocked = starget->max_target_blocked;
143 * Decrement the counters, since these commands are no longer
144 * active on the host/device.
147 scsi_device_unbusy(device);
150 * Requeue this command. It will go before all other commands
151 * that are already in the queue.
153 * NOTE: there is magic here about the way the queue is plugged if
154 * we have no outstanding commands.
156 * Although we *don't* plug the queue, we call the request
157 * function. The SCSI request function detects the blocked condition
158 * and plugs the queue appropriately.
160 spin_lock_irqsave(q->queue_lock, flags);
161 blk_requeue_request(q, cmd->request);
162 spin_unlock_irqrestore(q->queue_lock, flags);
170 * Function: scsi_queue_insert()
172 * Purpose: Insert a command in the midlevel queue.
174 * Arguments: cmd - command that we are adding to queue.
175 * reason - why we are inserting command to queue.
177 * Lock status: Assumed that lock is not held upon entry.
181 * Notes: We do this for one of two cases. Either the host is busy
182 * and it cannot accept any more commands for the time being,
183 * or the device returned QUEUE_FULL and can accept no more
185 * Notes: This could be called either from an interrupt context or a
186 * normal process context.
188 int scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
190 return __scsi_queue_insert(cmd, reason, 1);
193 * scsi_execute - insert request and wait for the result
196 * @data_direction: data direction
197 * @buffer: data buffer
198 * @bufflen: len of buffer
199 * @sense: optional sense buffer
200 * @timeout: request timeout in seconds
201 * @retries: number of times to retry request
202 * @flags: or into request flags;
203 * @resid: optional residual length
205 * returns the req->errors value which is the scsi_cmnd result
208 int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
209 int data_direction, void *buffer, unsigned bufflen,
210 unsigned char *sense, int timeout, int retries, int flags,
214 int write = (data_direction == DMA_TO_DEVICE);
215 int ret = DRIVER_ERROR << 24;
217 req = blk_get_request(sdev->request_queue, write, __GFP_WAIT);
219 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
220 buffer, bufflen, __GFP_WAIT))
223 req->cmd_len = COMMAND_SIZE(cmd[0]);
224 memcpy(req->cmd, cmd, req->cmd_len);
227 req->retries = retries;
228 req->timeout = timeout;
229 req->cmd_type = REQ_TYPE_BLOCK_PC;
230 req->cmd_flags |= flags | REQ_QUIET | REQ_PREEMPT;
233 * head injection *required* here otherwise quiesce won't work
235 blk_execute_rq(req->q, NULL, req, 1);
238 * Some devices (USB mass-storage in particular) may transfer
239 * garbage data together with a residue indicating that the data
240 * is invalid. Prevent the garbage from being misinterpreted
241 * and prevent security leaks by zeroing out the excess data.
243 if (unlikely(req->resid_len > 0 && req->resid_len <= bufflen))
244 memset(buffer + (bufflen - req->resid_len), 0, req->resid_len);
247 *resid = req->resid_len;
250 blk_put_request(req);
254 EXPORT_SYMBOL(scsi_execute);
257 int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
258 int data_direction, void *buffer, unsigned bufflen,
259 struct scsi_sense_hdr *sshdr, int timeout, int retries,
266 sense = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
268 return DRIVER_ERROR << 24;
270 result = scsi_execute(sdev, cmd, data_direction, buffer, bufflen,
271 sense, timeout, retries, 0, resid);
273 scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, sshdr);
278 EXPORT_SYMBOL(scsi_execute_req);
281 * Function: scsi_init_cmd_errh()
283 * Purpose: Initialize cmd fields related to error handling.
285 * Arguments: cmd - command that is ready to be queued.
287 * Notes: This function has the job of initializing a number of
288 * fields related to error handling. Typically this will
289 * be called once for each command, as required.
291 static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
293 cmd->serial_number = 0;
294 scsi_set_resid(cmd, 0);
295 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
296 if (cmd->cmd_len == 0)
297 cmd->cmd_len = scsi_command_size(cmd->cmnd);
300 void scsi_device_unbusy(struct scsi_device *sdev)
302 struct Scsi_Host *shost = sdev->host;
303 struct scsi_target *starget = scsi_target(sdev);
306 spin_lock_irqsave(shost->host_lock, flags);
308 starget->target_busy--;
309 if (unlikely(scsi_host_in_recovery(shost) &&
310 (shost->host_failed || shost->host_eh_scheduled)))
311 scsi_eh_wakeup(shost);
312 spin_unlock(shost->host_lock);
313 spin_lock(sdev->request_queue->queue_lock);
315 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
319 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
320 * and call blk_run_queue for all the scsi_devices on the target -
321 * including current_sdev first.
323 * Called with *no* scsi locks held.
325 static void scsi_single_lun_run(struct scsi_device *current_sdev)
327 struct Scsi_Host *shost = current_sdev->host;
328 struct scsi_device *sdev, *tmp;
329 struct scsi_target *starget = scsi_target(current_sdev);
332 spin_lock_irqsave(shost->host_lock, flags);
333 starget->starget_sdev_user = NULL;
334 spin_unlock_irqrestore(shost->host_lock, flags);
337 * Call blk_run_queue for all LUNs on the target, starting with
338 * current_sdev. We race with others (to set starget_sdev_user),
339 * but in most cases, we will be first. Ideally, each LU on the
340 * target would get some limited time or requests on the target.
342 blk_run_queue(current_sdev->request_queue);
344 spin_lock_irqsave(shost->host_lock, flags);
345 if (starget->starget_sdev_user)
347 list_for_each_entry_safe(sdev, tmp, &starget->devices,
348 same_target_siblings) {
349 if (sdev == current_sdev)
351 if (scsi_device_get(sdev))
354 spin_unlock_irqrestore(shost->host_lock, flags);
355 blk_run_queue(sdev->request_queue);
356 spin_lock_irqsave(shost->host_lock, flags);
358 scsi_device_put(sdev);
361 spin_unlock_irqrestore(shost->host_lock, flags);
364 static inline int scsi_device_is_busy(struct scsi_device *sdev)
366 if (sdev->device_busy >= sdev->queue_depth || sdev->device_blocked)
372 static inline int scsi_target_is_busy(struct scsi_target *starget)
374 return ((starget->can_queue > 0 &&
375 starget->target_busy >= starget->can_queue) ||
376 starget->target_blocked);
379 static inline int scsi_host_is_busy(struct Scsi_Host *shost)
381 if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
382 shost->host_blocked || shost->host_self_blocked)
389 * Function: scsi_run_queue()
391 * Purpose: Select a proper request queue to serve next
393 * Arguments: q - last request's queue
397 * Notes: The previous command was completely finished, start
398 * a new one if possible.
400 static void scsi_run_queue(struct request_queue *q)
402 struct scsi_device *sdev = q->queuedata;
403 struct Scsi_Host *shost = sdev->host;
404 LIST_HEAD(starved_list);
407 if (scsi_target(sdev)->single_lun)
408 scsi_single_lun_run(sdev);
410 spin_lock_irqsave(shost->host_lock, flags);
411 list_splice_init(&shost->starved_list, &starved_list);
413 while (!list_empty(&starved_list)) {
417 * As long as shost is accepting commands and we have
418 * starved queues, call blk_run_queue. scsi_request_fn
419 * drops the queue_lock and can add us back to the
422 * host_lock protects the starved_list and starved_entry.
423 * scsi_request_fn must get the host_lock before checking
424 * or modifying starved_list or starved_entry.
426 if (scsi_host_is_busy(shost))
429 sdev = list_entry(starved_list.next,
430 struct scsi_device, starved_entry);
431 list_del_init(&sdev->starved_entry);
432 if (scsi_target_is_busy(scsi_target(sdev))) {
433 list_move_tail(&sdev->starved_entry,
434 &shost->starved_list);
438 spin_unlock(shost->host_lock);
440 spin_lock(sdev->request_queue->queue_lock);
441 flagset = test_bit(QUEUE_FLAG_REENTER, &q->queue_flags) &&
442 !test_bit(QUEUE_FLAG_REENTER,
443 &sdev->request_queue->queue_flags);
445 queue_flag_set(QUEUE_FLAG_REENTER, sdev->request_queue);
446 __blk_run_queue(sdev->request_queue);
448 queue_flag_clear(QUEUE_FLAG_REENTER, sdev->request_queue);
449 spin_unlock(sdev->request_queue->queue_lock);
451 spin_lock(shost->host_lock);
453 /* put any unprocessed entries back */
454 list_splice(&starved_list, &shost->starved_list);
455 spin_unlock_irqrestore(shost->host_lock, flags);
461 * Function: scsi_requeue_command()
463 * Purpose: Handle post-processing of completed commands.
465 * Arguments: q - queue to operate on
466 * cmd - command that may need to be requeued.
470 * Notes: After command completion, there may be blocks left
471 * over which weren't finished by the previous command
472 * this can be for a number of reasons - the main one is
473 * I/O errors in the middle of the request, in which case
474 * we need to request the blocks that come after the bad
476 * Notes: Upon return, cmd is a stale pointer.
478 static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
480 struct request *req = cmd->request;
483 spin_lock_irqsave(q->queue_lock, flags);
484 scsi_unprep_request(req);
485 blk_requeue_request(q, req);
486 spin_unlock_irqrestore(q->queue_lock, flags);
491 void scsi_next_command(struct scsi_cmnd *cmd)
493 struct scsi_device *sdev = cmd->device;
494 struct request_queue *q = sdev->request_queue;
496 /* need to hold a reference on the device before we let go of the cmd */
497 get_device(&sdev->sdev_gendev);
499 scsi_put_command(cmd);
502 /* ok to remove device now */
503 put_device(&sdev->sdev_gendev);
506 void scsi_run_host_queues(struct Scsi_Host *shost)
508 struct scsi_device *sdev;
510 shost_for_each_device(sdev, shost)
511 scsi_run_queue(sdev->request_queue);
514 static void __scsi_release_buffers(struct scsi_cmnd *, int);
517 * Function: scsi_end_request()
519 * Purpose: Post-processing of completed commands (usually invoked at end
520 * of upper level post-processing and scsi_io_completion).
522 * Arguments: cmd - command that is complete.
523 * error - 0 if I/O indicates success, < 0 for I/O error.
524 * bytes - number of bytes of completed I/O
525 * requeue - indicates whether we should requeue leftovers.
527 * Lock status: Assumed that lock is not held upon entry.
529 * Returns: cmd if requeue required, NULL otherwise.
531 * Notes: This is called for block device requests in order to
532 * mark some number of sectors as complete.
534 * We are guaranteeing that the request queue will be goosed
535 * at some point during this call.
536 * Notes: If cmd was requeued, upon return it will be a stale pointer.
538 static struct scsi_cmnd *scsi_end_request(struct scsi_cmnd *cmd, int error,
539 int bytes, int requeue)
541 struct request_queue *q = cmd->device->request_queue;
542 struct request *req = cmd->request;
545 * If there are blocks left over at the end, set up the command
546 * to queue the remainder of them.
548 if (blk_end_request(req, error, bytes)) {
549 /* kill remainder if no retrys */
550 if (error && scsi_noretry_cmd(cmd))
551 blk_end_request_all(req, error);
555 * Bleah. Leftovers again. Stick the
556 * leftovers in the front of the
557 * queue, and goose the queue again.
559 scsi_release_buffers(cmd);
560 scsi_requeue_command(q, cmd);
568 * This will goose the queue request function at the end, so we don't
569 * need to worry about launching another command.
571 __scsi_release_buffers(cmd, 0);
572 scsi_next_command(cmd);
576 static inline unsigned int scsi_sgtable_index(unsigned short nents)
580 BUG_ON(nents > SCSI_MAX_SG_SEGMENTS);
585 index = get_count_order(nents) - 3;
590 static void scsi_sg_free(struct scatterlist *sgl, unsigned int nents)
592 struct scsi_host_sg_pool *sgp;
594 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
595 mempool_free(sgl, sgp->pool);
598 static struct scatterlist *scsi_sg_alloc(unsigned int nents, gfp_t gfp_mask)
600 struct scsi_host_sg_pool *sgp;
602 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
603 return mempool_alloc(sgp->pool, gfp_mask);
606 static int scsi_alloc_sgtable(struct scsi_data_buffer *sdb, int nents,
613 ret = __sg_alloc_table(&sdb->table, nents, SCSI_MAX_SG_SEGMENTS,
614 gfp_mask, scsi_sg_alloc);
616 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS,
622 static void scsi_free_sgtable(struct scsi_data_buffer *sdb)
624 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS, scsi_sg_free);
627 static void __scsi_release_buffers(struct scsi_cmnd *cmd, int do_bidi_check)
630 if (cmd->sdb.table.nents)
631 scsi_free_sgtable(&cmd->sdb);
633 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
635 if (do_bidi_check && scsi_bidi_cmnd(cmd)) {
636 struct scsi_data_buffer *bidi_sdb =
637 cmd->request->next_rq->special;
638 scsi_free_sgtable(bidi_sdb);
639 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
640 cmd->request->next_rq->special = NULL;
643 if (scsi_prot_sg_count(cmd))
644 scsi_free_sgtable(cmd->prot_sdb);
648 * Function: scsi_release_buffers()
650 * Purpose: Completion processing for block device I/O requests.
652 * Arguments: cmd - command that we are bailing.
654 * Lock status: Assumed that no lock is held upon entry.
658 * Notes: In the event that an upper level driver rejects a
659 * command, we must release resources allocated during
660 * the __init_io() function. Primarily this would involve
661 * the scatter-gather table, and potentially any bounce
664 void scsi_release_buffers(struct scsi_cmnd *cmd)
666 __scsi_release_buffers(cmd, 1);
668 EXPORT_SYMBOL(scsi_release_buffers);
671 * Function: scsi_io_completion()
673 * Purpose: Completion processing for block device I/O requests.
675 * Arguments: cmd - command that is finished.
677 * Lock status: Assumed that no lock is held upon entry.
681 * Notes: This function is matched in terms of capabilities to
682 * the function that created the scatter-gather list.
683 * In other words, if there are no bounce buffers
684 * (the normal case for most drivers), we don't need
685 * the logic to deal with cleaning up afterwards.
687 * We must call scsi_end_request(). This will finish off
688 * the specified number of sectors. If we are done, the
689 * command block will be released and the queue function
690 * will be goosed. If we are not done then we have to
691 * figure out what to do next:
693 * a) We can call scsi_requeue_command(). The request
694 * will be unprepared and put back on the queue. Then
695 * a new command will be created for it. This should
696 * be used if we made forward progress, or if we want
697 * to switch from READ(10) to READ(6) for example.
699 * b) We can call scsi_queue_insert(). The request will
700 * be put back on the queue and retried using the same
701 * command as before, possibly after a delay.
703 * c) We can call blk_end_request() with -EIO to fail
704 * the remainder of the request.
706 void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
708 int result = cmd->result;
710 struct request_queue *q = cmd->device->request_queue;
711 struct request *req = cmd->request;
713 struct scsi_sense_hdr sshdr;
715 int sense_deferred = 0;
716 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
717 ACTION_DELAYED_RETRY} action;
718 char *description = NULL;
721 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
723 sense_deferred = scsi_sense_is_deferred(&sshdr);
726 if (blk_pc_request(req)) { /* SG_IO ioctl from block level */
727 req->errors = result;
729 if (sense_valid && req->sense) {
731 * SG_IO wants current and deferred errors
733 int len = 8 + cmd->sense_buffer[7];
735 if (len > SCSI_SENSE_BUFFERSIZE)
736 len = SCSI_SENSE_BUFFERSIZE;
737 memcpy(req->sense, cmd->sense_buffer, len);
738 req->sense_len = len;
744 req->resid_len = scsi_get_resid(cmd);
746 if (scsi_bidi_cmnd(cmd)) {
748 * Bidi commands Must be complete as a whole,
749 * both sides at once.
751 req->next_rq->resid_len = scsi_in(cmd)->resid;
753 blk_end_request_all(req, 0);
755 scsi_release_buffers(cmd);
756 scsi_next_command(cmd);
761 BUG_ON(blk_bidi_rq(req)); /* bidi not support for !blk_pc_request yet */
764 * Next deal with any sectors which we were able to correctly
767 SCSI_LOG_HLCOMPLETE(1, printk("%u sectors total, "
769 blk_rq_sectors(req), good_bytes));
772 * Recovered errors need reporting, but they're always treated
773 * as success, so fiddle the result code here. For BLOCK_PC
774 * we already took a copy of the original into rq->errors which
775 * is what gets returned to the user
777 if (sense_valid && sshdr.sense_key == RECOVERED_ERROR) {
778 if (!(req->cmd_flags & REQ_QUIET))
779 scsi_print_sense("", cmd);
781 /* BLOCK_PC may have set error */
786 * A number of bytes were successfully read. If there
787 * are leftovers and there is some kind of error
788 * (result != 0), retry the rest.
790 if (scsi_end_request(cmd, error, good_bytes, result == 0) == NULL)
792 this_count = blk_rq_bytes(req);
796 if (host_byte(result) == DID_RESET) {
797 /* Third party bus reset or reset for error recovery
798 * reasons. Just retry the command and see what
801 action = ACTION_RETRY;
802 } else if (sense_valid && !sense_deferred) {
803 switch (sshdr.sense_key) {
805 if (cmd->device->removable) {
806 /* Detected disc change. Set a bit
807 * and quietly refuse further access.
809 cmd->device->changed = 1;
810 description = "Media Changed";
811 action = ACTION_FAIL;
813 /* Must have been a power glitch, or a
814 * bus reset. Could not have been a
815 * media change, so we just retry the
816 * command and see what happens.
818 action = ACTION_RETRY;
821 case ILLEGAL_REQUEST:
822 /* If we had an ILLEGAL REQUEST returned, then
823 * we may have performed an unsupported
824 * command. The only thing this should be
825 * would be a ten byte read where only a six
826 * byte read was supported. Also, on a system
827 * where READ CAPACITY failed, we may have
828 * read past the end of the disk.
830 if ((cmd->device->use_10_for_rw &&
831 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
832 (cmd->cmnd[0] == READ_10 ||
833 cmd->cmnd[0] == WRITE_10)) {
834 /* This will issue a new 6-byte command. */
835 cmd->device->use_10_for_rw = 0;
836 action = ACTION_REPREP;
837 } else if (sshdr.asc == 0x10) /* DIX */ {
838 description = "Host Data Integrity Failure";
839 action = ACTION_FAIL;
842 action = ACTION_FAIL;
844 case ABORTED_COMMAND:
845 action = ACTION_FAIL;
846 if (sshdr.asc == 0x10) { /* DIF */
847 description = "Target Data Integrity Failure";
852 /* If the device is in the process of becoming
853 * ready, or has a temporary blockage, retry.
855 if (sshdr.asc == 0x04) {
856 switch (sshdr.ascq) {
857 case 0x01: /* becoming ready */
858 case 0x04: /* format in progress */
859 case 0x05: /* rebuild in progress */
860 case 0x06: /* recalculation in progress */
861 case 0x07: /* operation in progress */
862 case 0x08: /* Long write in progress */
863 case 0x09: /* self test in progress */
864 action = ACTION_DELAYED_RETRY;
867 description = "Device not ready";
868 action = ACTION_FAIL;
872 description = "Device not ready";
873 action = ACTION_FAIL;
876 case VOLUME_OVERFLOW:
877 /* See SSC3rXX or current. */
878 action = ACTION_FAIL;
881 description = "Unhandled sense code";
882 action = ACTION_FAIL;
886 description = "Unhandled error code";
887 action = ACTION_FAIL;
892 /* Give up and fail the remainder of the request */
893 scsi_release_buffers(cmd);
894 if (!(req->cmd_flags & REQ_QUIET)) {
896 scmd_printk(KERN_INFO, cmd, "%s\n",
898 scsi_print_result(cmd);
899 if (driver_byte(result) & DRIVER_SENSE)
900 scsi_print_sense("", cmd);
902 blk_end_request_all(req, -EIO);
903 scsi_next_command(cmd);
906 /* Unprep the request and put it back at the head of the queue.
907 * A new command will be prepared and issued.
909 scsi_release_buffers(cmd);
910 scsi_requeue_command(q, cmd);
913 /* Retry the same command immediately */
914 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
916 case ACTION_DELAYED_RETRY:
917 /* Retry the same command after a delay */
918 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
923 static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb,
929 * If sg table allocation fails, requeue request later.
931 if (unlikely(scsi_alloc_sgtable(sdb, req->nr_phys_segments,
933 return BLKPREP_DEFER;
939 * Next, walk the list, and fill in the addresses and sizes of
942 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
943 BUG_ON(count > sdb->table.nents);
944 sdb->table.nents = count;
945 sdb->length = blk_rq_bytes(req);
950 * Function: scsi_init_io()
952 * Purpose: SCSI I/O initialize function.
954 * Arguments: cmd - Command descriptor we wish to initialize
956 * Returns: 0 on success
957 * BLKPREP_DEFER if the failure is retryable
958 * BLKPREP_KILL if the failure is fatal
960 int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask)
962 int error = scsi_init_sgtable(cmd->request, &cmd->sdb, gfp_mask);
966 if (blk_bidi_rq(cmd->request)) {
967 struct scsi_data_buffer *bidi_sdb = kmem_cache_zalloc(
968 scsi_sdb_cache, GFP_ATOMIC);
970 error = BLKPREP_DEFER;
974 cmd->request->next_rq->special = bidi_sdb;
975 error = scsi_init_sgtable(cmd->request->next_rq, bidi_sdb,
981 if (blk_integrity_rq(cmd->request)) {
982 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
985 BUG_ON(prot_sdb == NULL);
986 ivecs = blk_rq_count_integrity_sg(cmd->request);
988 if (scsi_alloc_sgtable(prot_sdb, ivecs, gfp_mask)) {
989 error = BLKPREP_DEFER;
993 count = blk_rq_map_integrity_sg(cmd->request,
994 prot_sdb->table.sgl);
995 BUG_ON(unlikely(count > ivecs));
997 cmd->prot_sdb = prot_sdb;
998 cmd->prot_sdb->table.nents = count;
1004 scsi_release_buffers(cmd);
1005 if (error == BLKPREP_KILL)
1006 scsi_put_command(cmd);
1007 else /* BLKPREP_DEFER */
1008 scsi_unprep_request(cmd->request);
1012 EXPORT_SYMBOL(scsi_init_io);
1014 static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
1015 struct request *req)
1017 struct scsi_cmnd *cmd;
1019 if (!req->special) {
1020 cmd = scsi_get_command(sdev, GFP_ATOMIC);
1028 /* pull a tag out of the request if we have one */
1029 cmd->tag = req->tag;
1032 cmd->cmnd = req->cmd;
1037 int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
1039 struct scsi_cmnd *cmd;
1040 int ret = scsi_prep_state_check(sdev, req);
1042 if (ret != BLKPREP_OK)
1045 cmd = scsi_get_cmd_from_req(sdev, req);
1047 return BLKPREP_DEFER;
1050 * BLOCK_PC requests may transfer data, in which case they must
1051 * a bio attached to them. Or they might contain a SCSI command
1052 * that does not transfer data, in which case they may optionally
1053 * submit a request without an attached bio.
1058 BUG_ON(!req->nr_phys_segments);
1060 ret = scsi_init_io(cmd, GFP_ATOMIC);
1064 BUG_ON(blk_rq_bytes(req));
1066 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
1070 cmd->cmd_len = req->cmd_len;
1071 if (!blk_rq_bytes(req))
1072 cmd->sc_data_direction = DMA_NONE;
1073 else if (rq_data_dir(req) == WRITE)
1074 cmd->sc_data_direction = DMA_TO_DEVICE;
1076 cmd->sc_data_direction = DMA_FROM_DEVICE;
1078 cmd->transfersize = blk_rq_bytes(req);
1079 cmd->allowed = req->retries;
1082 EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
1085 * Setup a REQ_TYPE_FS command. These are simple read/write request
1086 * from filesystems that still need to be translated to SCSI CDBs from
1089 int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
1091 struct scsi_cmnd *cmd;
1092 int ret = scsi_prep_state_check(sdev, req);
1094 if (ret != BLKPREP_OK)
1097 if (unlikely(sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh
1098 && sdev->scsi_dh_data->scsi_dh->prep_fn)) {
1099 ret = sdev->scsi_dh_data->scsi_dh->prep_fn(sdev, req);
1100 if (ret != BLKPREP_OK)
1105 * Filesystem requests must transfer data.
1107 BUG_ON(!req->nr_phys_segments);
1109 cmd = scsi_get_cmd_from_req(sdev, req);
1111 return BLKPREP_DEFER;
1113 memset(cmd->cmnd, 0, BLK_MAX_CDB);
1114 return scsi_init_io(cmd, GFP_ATOMIC);
1116 EXPORT_SYMBOL(scsi_setup_fs_cmnd);
1118 int scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
1120 int ret = BLKPREP_OK;
1123 * If the device is not in running state we will reject some
1126 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1127 switch (sdev->sdev_state) {
1130 * If the device is offline we refuse to process any
1131 * commands. The device must be brought online
1132 * before trying any recovery commands.
1134 sdev_printk(KERN_ERR, sdev,
1135 "rejecting I/O to offline device\n");
1140 * If the device is fully deleted, we refuse to
1141 * process any commands as well.
1143 sdev_printk(KERN_ERR, sdev,
1144 "rejecting I/O to dead device\n");
1149 case SDEV_CREATED_BLOCK:
1151 * If the devices is blocked we defer normal commands.
1153 if (!(req->cmd_flags & REQ_PREEMPT))
1154 ret = BLKPREP_DEFER;
1158 * For any other not fully online state we only allow
1159 * special commands. In particular any user initiated
1160 * command is not allowed.
1162 if (!(req->cmd_flags & REQ_PREEMPT))
1169 EXPORT_SYMBOL(scsi_prep_state_check);
1171 int scsi_prep_return(struct request_queue *q, struct request *req, int ret)
1173 struct scsi_device *sdev = q->queuedata;
1177 req->errors = DID_NO_CONNECT << 16;
1178 /* release the command and kill it */
1180 struct scsi_cmnd *cmd = req->special;
1181 scsi_release_buffers(cmd);
1182 scsi_put_command(cmd);
1183 req->special = NULL;
1188 * If we defer, the blk_peek_request() returns NULL, but the
1189 * queue must be restarted, so we plug here if no returning
1190 * command will automatically do that.
1192 if (sdev->device_busy == 0)
1196 req->cmd_flags |= REQ_DONTPREP;
1201 EXPORT_SYMBOL(scsi_prep_return);
1203 int scsi_prep_fn(struct request_queue *q, struct request *req)
1205 struct scsi_device *sdev = q->queuedata;
1206 int ret = BLKPREP_KILL;
1208 if (req->cmd_type == REQ_TYPE_BLOCK_PC)
1209 ret = scsi_setup_blk_pc_cmnd(sdev, req);
1210 return scsi_prep_return(q, req, ret);
1214 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1217 * Called with the queue_lock held.
1219 static inline int scsi_dev_queue_ready(struct request_queue *q,
1220 struct scsi_device *sdev)
1222 if (sdev->device_busy == 0 && sdev->device_blocked) {
1224 * unblock after device_blocked iterates to zero
1226 if (--sdev->device_blocked == 0) {
1228 sdev_printk(KERN_INFO, sdev,
1229 "unblocking device at zero depth\n"));
1235 if (scsi_device_is_busy(sdev))
1243 * scsi_target_queue_ready: checks if there we can send commands to target
1244 * @sdev: scsi device on starget to check.
1246 * Called with the host lock held.
1248 static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1249 struct scsi_device *sdev)
1251 struct scsi_target *starget = scsi_target(sdev);
1253 if (starget->single_lun) {
1254 if (starget->starget_sdev_user &&
1255 starget->starget_sdev_user != sdev)
1257 starget->starget_sdev_user = sdev;
1260 if (starget->target_busy == 0 && starget->target_blocked) {
1262 * unblock after target_blocked iterates to zero
1264 if (--starget->target_blocked == 0) {
1265 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1266 "unblocking target at zero depth\n"));
1268 blk_plug_device(sdev->request_queue);
1273 if (scsi_target_is_busy(starget)) {
1274 if (list_empty(&sdev->starved_entry)) {
1275 list_add_tail(&sdev->starved_entry,
1276 &shost->starved_list);
1281 /* We're OK to process the command, so we can't be starved */
1282 if (!list_empty(&sdev->starved_entry))
1283 list_del_init(&sdev->starved_entry);
1288 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1289 * return 0. We must end up running the queue again whenever 0 is
1290 * returned, else IO can hang.
1292 * Called with host_lock held.
1294 static inline int scsi_host_queue_ready(struct request_queue *q,
1295 struct Scsi_Host *shost,
1296 struct scsi_device *sdev)
1298 if (scsi_host_in_recovery(shost))
1300 if (shost->host_busy == 0 && shost->host_blocked) {
1302 * unblock after host_blocked iterates to zero
1304 if (--shost->host_blocked == 0) {
1306 printk("scsi%d unblocking host at zero depth\n",
1312 if (scsi_host_is_busy(shost)) {
1313 if (list_empty(&sdev->starved_entry))
1314 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1318 /* We're OK to process the command, so we can't be starved */
1319 if (!list_empty(&sdev->starved_entry))
1320 list_del_init(&sdev->starved_entry);
1326 * Busy state exporting function for request stacking drivers.
1328 * For efficiency, no lock is taken to check the busy state of
1329 * shost/starget/sdev, since the returned value is not guaranteed and
1330 * may be changed after request stacking drivers call the function,
1331 * regardless of taking lock or not.
1333 * When scsi can't dispatch I/Os anymore and needs to kill I/Os
1334 * (e.g. !sdev), scsi needs to return 'not busy'.
1335 * Otherwise, request stacking drivers may hold requests forever.
1337 static int scsi_lld_busy(struct request_queue *q)
1339 struct scsi_device *sdev = q->queuedata;
1340 struct Scsi_Host *shost;
1341 struct scsi_target *starget;
1347 starget = scsi_target(sdev);
1349 if (scsi_host_in_recovery(shost) || scsi_host_is_busy(shost) ||
1350 scsi_target_is_busy(starget) || scsi_device_is_busy(sdev))
1357 * Kill a request for a dead device
1359 static void scsi_kill_request(struct request *req, struct request_queue *q)
1361 struct scsi_cmnd *cmd = req->special;
1362 struct scsi_device *sdev = cmd->device;
1363 struct scsi_target *starget = scsi_target(sdev);
1364 struct Scsi_Host *shost = sdev->host;
1366 blk_start_request(req);
1368 if (unlikely(cmd == NULL)) {
1369 printk(KERN_CRIT "impossible request in %s.\n",
1374 scsi_init_cmd_errh(cmd);
1375 cmd->result = DID_NO_CONNECT << 16;
1376 atomic_inc(&cmd->device->iorequest_cnt);
1379 * SCSI request completion path will do scsi_device_unbusy(),
1380 * bump busy counts. To bump the counters, we need to dance
1381 * with the locks as normal issue path does.
1383 sdev->device_busy++;
1384 spin_unlock(sdev->request_queue->queue_lock);
1385 spin_lock(shost->host_lock);
1387 starget->target_busy++;
1388 spin_unlock(shost->host_lock);
1389 spin_lock(sdev->request_queue->queue_lock);
1391 blk_complete_request(req);
1394 static void scsi_softirq_done(struct request *rq)
1396 struct scsi_cmnd *cmd = rq->special;
1397 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
1400 INIT_LIST_HEAD(&cmd->eh_entry);
1403 * Set the serial numbers back to zero
1405 cmd->serial_number = 0;
1407 atomic_inc(&cmd->device->iodone_cnt);
1409 atomic_inc(&cmd->device->ioerr_cnt);
1411 disposition = scsi_decide_disposition(cmd);
1412 if (disposition != SUCCESS &&
1413 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1414 sdev_printk(KERN_ERR, cmd->device,
1415 "timing out command, waited %lus\n",
1417 disposition = SUCCESS;
1420 scsi_log_completion(cmd, disposition);
1422 switch (disposition) {
1424 scsi_finish_command(cmd);
1427 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
1429 case ADD_TO_MLQUEUE:
1430 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1433 if (!scsi_eh_scmd_add(cmd, 0))
1434 scsi_finish_command(cmd);
1439 * Function: scsi_request_fn()
1441 * Purpose: Main strategy routine for SCSI.
1443 * Arguments: q - Pointer to actual queue.
1447 * Lock status: IO request lock assumed to be held when called.
1449 static void scsi_request_fn(struct request_queue *q)
1451 struct scsi_device *sdev = q->queuedata;
1452 struct Scsi_Host *shost;
1453 struct scsi_cmnd *cmd;
1454 struct request *req;
1457 printk("scsi: killing requests for dead queue\n");
1458 while ((req = blk_peek_request(q)) != NULL)
1459 scsi_kill_request(req, q);
1463 if(!get_device(&sdev->sdev_gendev))
1464 /* We must be tearing the block queue down already */
1468 * To start with, we keep looping until the queue is empty, or until
1469 * the host is no longer able to accept any more requests.
1472 while (!blk_queue_plugged(q)) {
1475 * get next queueable request. We do this early to make sure
1476 * that the request is fully prepared even if we cannot
1479 req = blk_peek_request(q);
1480 if (!req || !scsi_dev_queue_ready(q, sdev))
1483 if (unlikely(!scsi_device_online(sdev))) {
1484 sdev_printk(KERN_ERR, sdev,
1485 "rejecting I/O to offline device\n");
1486 scsi_kill_request(req, q);
1492 * Remove the request from the request list.
1494 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
1495 blk_start_request(req);
1496 sdev->device_busy++;
1498 spin_unlock(q->queue_lock);
1500 if (unlikely(cmd == NULL)) {
1501 printk(KERN_CRIT "impossible request in %s.\n"
1502 "please mail a stack trace to "
1503 "linux-scsi@vger.kernel.org\n",
1505 blk_dump_rq_flags(req, "foo");
1508 spin_lock(shost->host_lock);
1511 * We hit this when the driver is using a host wide
1512 * tag map. For device level tag maps the queue_depth check
1513 * in the device ready fn would prevent us from trying
1514 * to allocate a tag. Since the map is a shared host resource
1515 * we add the dev to the starved list so it eventually gets
1516 * a run when a tag is freed.
1518 if (blk_queue_tagged(q) && !blk_rq_tagged(req)) {
1519 if (list_empty(&sdev->starved_entry))
1520 list_add_tail(&sdev->starved_entry,
1521 &shost->starved_list);
1525 if (!scsi_target_queue_ready(shost, sdev))
1528 if (!scsi_host_queue_ready(q, shost, sdev))
1531 scsi_target(sdev)->target_busy++;
1535 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1536 * take the lock again.
1538 spin_unlock_irq(shost->host_lock);
1541 * Finally, initialize any error handling parameters, and set up
1542 * the timers for timeouts.
1544 scsi_init_cmd_errh(cmd);
1547 * Dispatch the command to the low-level driver.
1549 rtn = scsi_dispatch_cmd(cmd);
1550 spin_lock_irq(q->queue_lock);
1552 /* we're refusing the command; because of
1553 * the way locks get dropped, we need to
1554 * check here if plugging is required */
1555 if(sdev->device_busy == 0)
1565 spin_unlock_irq(shost->host_lock);
1568 * lock q, handle tag, requeue req, and decrement device_busy. We
1569 * must return with queue_lock held.
1571 * Decrementing device_busy without checking it is OK, as all such
1572 * cases (host limits or settings) should run the queue at some
1575 spin_lock_irq(q->queue_lock);
1576 blk_requeue_request(q, req);
1577 sdev->device_busy--;
1578 if(sdev->device_busy == 0)
1581 /* must be careful here...if we trigger the ->remove() function
1582 * we cannot be holding the q lock */
1583 spin_unlock_irq(q->queue_lock);
1584 put_device(&sdev->sdev_gendev);
1585 spin_lock_irq(q->queue_lock);
1588 u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
1590 struct device *host_dev;
1591 u64 bounce_limit = 0xffffffff;
1593 if (shost->unchecked_isa_dma)
1594 return BLK_BOUNCE_ISA;
1596 * Platforms with virtual-DMA translation
1597 * hardware have no practical limit.
1599 if (!PCI_DMA_BUS_IS_PHYS)
1600 return BLK_BOUNCE_ANY;
1602 host_dev = scsi_get_device(shost);
1603 if (host_dev && host_dev->dma_mask)
1604 bounce_limit = *host_dev->dma_mask;
1606 return bounce_limit;
1608 EXPORT_SYMBOL(scsi_calculate_bounce_limit);
1610 struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
1611 request_fn_proc *request_fn)
1613 struct request_queue *q;
1614 struct device *dev = shost->shost_gendev.parent;
1616 q = blk_init_queue(request_fn, NULL);
1621 * this limit is imposed by hardware restrictions
1623 blk_queue_max_hw_segments(q, shost->sg_tablesize);
1624 blk_queue_max_phys_segments(q, SCSI_MAX_SG_CHAIN_SEGMENTS);
1626 blk_queue_max_sectors(q, shost->max_sectors);
1627 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
1628 blk_queue_segment_boundary(q, shost->dma_boundary);
1629 dma_set_seg_boundary(dev, shost->dma_boundary);
1631 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
1633 /* New queue, no concurrency on queue_flags */
1634 if (!shost->use_clustering)
1635 queue_flag_clear_unlocked(QUEUE_FLAG_CLUSTER, q);
1638 * set a reasonable default alignment on word boundaries: the
1639 * host and device may alter it using
1640 * blk_queue_update_dma_alignment() later.
1642 blk_queue_dma_alignment(q, 0x03);
1646 EXPORT_SYMBOL(__scsi_alloc_queue);
1648 struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
1650 struct request_queue *q;
1652 q = __scsi_alloc_queue(sdev->host, scsi_request_fn);
1656 blk_queue_prep_rq(q, scsi_prep_fn);
1657 blk_queue_softirq_done(q, scsi_softirq_done);
1658 blk_queue_rq_timed_out(q, scsi_times_out);
1659 blk_queue_lld_busy(q, scsi_lld_busy);
1663 void scsi_free_queue(struct request_queue *q)
1665 blk_cleanup_queue(q);
1669 * Function: scsi_block_requests()
1671 * Purpose: Utility function used by low-level drivers to prevent further
1672 * commands from being queued to the device.
1674 * Arguments: shost - Host in question
1678 * Lock status: No locks are assumed held.
1680 * Notes: There is no timer nor any other means by which the requests
1681 * get unblocked other than the low-level driver calling
1682 * scsi_unblock_requests().
1684 void scsi_block_requests(struct Scsi_Host *shost)
1686 shost->host_self_blocked = 1;
1688 EXPORT_SYMBOL(scsi_block_requests);
1691 * Function: scsi_unblock_requests()
1693 * Purpose: Utility function used by low-level drivers to allow further
1694 * commands from being queued to the device.
1696 * Arguments: shost - Host in question
1700 * Lock status: No locks are assumed held.
1702 * Notes: There is no timer nor any other means by which the requests
1703 * get unblocked other than the low-level driver calling
1704 * scsi_unblock_requests().
1706 * This is done as an API function so that changes to the
1707 * internals of the scsi mid-layer won't require wholesale
1708 * changes to drivers that use this feature.
1710 void scsi_unblock_requests(struct Scsi_Host *shost)
1712 shost->host_self_blocked = 0;
1713 scsi_run_host_queues(shost);
1715 EXPORT_SYMBOL(scsi_unblock_requests);
1717 int __init scsi_init_queue(void)
1721 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1722 sizeof(struct scsi_data_buffer),
1724 if (!scsi_sdb_cache) {
1725 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
1729 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1730 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1731 int size = sgp->size * sizeof(struct scatterlist);
1733 sgp->slab = kmem_cache_create(sgp->name, size, 0,
1734 SLAB_HWCACHE_ALIGN, NULL);
1736 printk(KERN_ERR "SCSI: can't init sg slab %s\n",
1741 sgp->pool = mempool_create_slab_pool(SG_MEMPOOL_SIZE,
1744 printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
1753 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1754 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1756 mempool_destroy(sgp->pool);
1758 kmem_cache_destroy(sgp->slab);
1760 kmem_cache_destroy(scsi_sdb_cache);
1765 void scsi_exit_queue(void)
1769 kmem_cache_destroy(scsi_sdb_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);
1779 * scsi_mode_select - issue a mode select
1780 * @sdev: SCSI device to be queried
1781 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1782 * @sp: Save page bit (0 == don't save, 1 == save)
1783 * @modepage: mode page being requested
1784 * @buffer: request buffer (may not be smaller than eight bytes)
1785 * @len: length of request buffer.
1786 * @timeout: command timeout
1787 * @retries: number of retries before failing
1788 * @data: returns a structure abstracting the mode header data
1789 * @sshdr: place to put sense data (or NULL if no sense to be collected).
1790 * must be SCSI_SENSE_BUFFERSIZE big.
1792 * Returns zero if successful; negative error number or scsi
1797 scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1798 unsigned char *buffer, int len, int timeout, int retries,
1799 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1801 unsigned char cmd[10];
1802 unsigned char *real_buffer;
1805 memset(cmd, 0, sizeof(cmd));
1806 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
1808 if (sdev->use_10_for_ms) {
1811 real_buffer = kmalloc(8 + len, GFP_KERNEL);
1814 memcpy(real_buffer + 8, buffer, len);
1818 real_buffer[2] = data->medium_type;
1819 real_buffer[3] = data->device_specific;
1820 real_buffer[4] = data->longlba ? 0x01 : 0;
1822 real_buffer[6] = data->block_descriptor_length >> 8;
1823 real_buffer[7] = data->block_descriptor_length;
1825 cmd[0] = MODE_SELECT_10;
1829 if (len > 255 || data->block_descriptor_length > 255 ||
1833 real_buffer = kmalloc(4 + len, GFP_KERNEL);
1836 memcpy(real_buffer + 4, buffer, len);
1839 real_buffer[1] = data->medium_type;
1840 real_buffer[2] = data->device_specific;
1841 real_buffer[3] = data->block_descriptor_length;
1844 cmd[0] = MODE_SELECT;
1848 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
1849 sshdr, timeout, retries, NULL);
1853 EXPORT_SYMBOL_GPL(scsi_mode_select);
1856 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
1857 * @sdev: SCSI device to be queried
1858 * @dbd: set if mode sense will allow block descriptors to be returned
1859 * @modepage: mode page being requested
1860 * @buffer: request buffer (may not be smaller than eight bytes)
1861 * @len: length of request buffer.
1862 * @timeout: command timeout
1863 * @retries: number of retries before failing
1864 * @data: returns a structure abstracting the mode header data
1865 * @sshdr: place to put sense data (or NULL if no sense to be collected).
1866 * must be SCSI_SENSE_BUFFERSIZE big.
1868 * Returns zero if unsuccessful, or the header offset (either 4
1869 * or 8 depending on whether a six or ten byte command was
1870 * issued) if successful.
1873 scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
1874 unsigned char *buffer, int len, int timeout, int retries,
1875 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1877 unsigned char cmd[12];
1881 struct scsi_sense_hdr my_sshdr;
1883 memset(data, 0, sizeof(*data));
1884 memset(&cmd[0], 0, 12);
1885 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
1888 /* caller might not be interested in sense, but we need it */
1893 use_10_for_ms = sdev->use_10_for_ms;
1895 if (use_10_for_ms) {
1899 cmd[0] = MODE_SENSE_10;
1906 cmd[0] = MODE_SENSE;
1911 memset(buffer, 0, len);
1913 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
1914 sshdr, timeout, retries, NULL);
1916 /* This code looks awful: what it's doing is making sure an
1917 * ILLEGAL REQUEST sense return identifies the actual command
1918 * byte as the problem. MODE_SENSE commands can return
1919 * ILLEGAL REQUEST if the code page isn't supported */
1921 if (use_10_for_ms && !scsi_status_is_good(result) &&
1922 (driver_byte(result) & DRIVER_SENSE)) {
1923 if (scsi_sense_valid(sshdr)) {
1924 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
1925 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
1927 * Invalid command operation code
1929 sdev->use_10_for_ms = 0;
1935 if(scsi_status_is_good(result)) {
1936 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
1937 (modepage == 6 || modepage == 8))) {
1938 /* Initio breakage? */
1941 data->medium_type = 0;
1942 data->device_specific = 0;
1944 data->block_descriptor_length = 0;
1945 } else if(use_10_for_ms) {
1946 data->length = buffer[0]*256 + buffer[1] + 2;
1947 data->medium_type = buffer[2];
1948 data->device_specific = buffer[3];
1949 data->longlba = buffer[4] & 0x01;
1950 data->block_descriptor_length = buffer[6]*256
1953 data->length = buffer[0] + 1;
1954 data->medium_type = buffer[1];
1955 data->device_specific = buffer[2];
1956 data->block_descriptor_length = buffer[3];
1958 data->header_length = header_length;
1963 EXPORT_SYMBOL(scsi_mode_sense);
1966 * scsi_test_unit_ready - test if unit is ready
1967 * @sdev: scsi device to change the state of.
1968 * @timeout: command timeout
1969 * @retries: number of retries before failing
1970 * @sshdr_external: Optional pointer to struct scsi_sense_hdr for
1971 * returning sense. Make sure that this is cleared before passing
1974 * Returns zero if unsuccessful or an error if TUR failed. For
1975 * removable media, a return of NOT_READY or UNIT_ATTENTION is
1976 * translated to success, with the ->changed flag updated.
1979 scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
1980 struct scsi_sense_hdr *sshdr_external)
1983 TEST_UNIT_READY, 0, 0, 0, 0, 0,
1985 struct scsi_sense_hdr *sshdr;
1988 if (!sshdr_external)
1989 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
1991 sshdr = sshdr_external;
1993 /* try to eat the UNIT_ATTENTION if there are enough retries */
1995 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
1996 timeout, retries, NULL);
1997 if (sdev->removable && scsi_sense_valid(sshdr) &&
1998 sshdr->sense_key == UNIT_ATTENTION)
2000 } while (scsi_sense_valid(sshdr) &&
2001 sshdr->sense_key == UNIT_ATTENTION && --retries);
2004 /* could not allocate sense buffer, so can't process it */
2007 if (sdev->removable && scsi_sense_valid(sshdr) &&
2008 (sshdr->sense_key == UNIT_ATTENTION ||
2009 sshdr->sense_key == NOT_READY)) {
2013 if (!sshdr_external)
2017 EXPORT_SYMBOL(scsi_test_unit_ready);
2020 * scsi_device_set_state - Take the given device through the device state model.
2021 * @sdev: scsi device to change the state of.
2022 * @state: state to change to.
2024 * Returns zero if unsuccessful or an error if the requested
2025 * transition is illegal.
2028 scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2030 enum scsi_device_state oldstate = sdev->sdev_state;
2032 if (state == oldstate)
2038 case SDEV_CREATED_BLOCK:
2082 case SDEV_CREATED_BLOCK:
2089 case SDEV_CREATED_BLOCK:
2124 sdev->sdev_state = state;
2128 SCSI_LOG_ERROR_RECOVERY(1,
2129 sdev_printk(KERN_ERR, sdev,
2130 "Illegal state transition %s->%s\n",
2131 scsi_device_state_name(oldstate),
2132 scsi_device_state_name(state))
2136 EXPORT_SYMBOL(scsi_device_set_state);
2139 * sdev_evt_emit - emit a single SCSI device uevent
2140 * @sdev: associated SCSI device
2141 * @evt: event to emit
2143 * Send a single uevent (scsi_event) to the associated scsi_device.
2145 static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2150 switch (evt->evt_type) {
2151 case SDEV_EVT_MEDIA_CHANGE:
2152 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2162 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2166 * sdev_evt_thread - send a uevent for each scsi event
2167 * @work: work struct for scsi_device
2169 * Dispatch queued events to their associated scsi_device kobjects
2172 void scsi_evt_thread(struct work_struct *work)
2174 struct scsi_device *sdev;
2175 LIST_HEAD(event_list);
2177 sdev = container_of(work, struct scsi_device, event_work);
2180 struct scsi_event *evt;
2181 struct list_head *this, *tmp;
2182 unsigned long flags;
2184 spin_lock_irqsave(&sdev->list_lock, flags);
2185 list_splice_init(&sdev->event_list, &event_list);
2186 spin_unlock_irqrestore(&sdev->list_lock, flags);
2188 if (list_empty(&event_list))
2191 list_for_each_safe(this, tmp, &event_list) {
2192 evt = list_entry(this, struct scsi_event, node);
2193 list_del(&evt->node);
2194 scsi_evt_emit(sdev, evt);
2201 * sdev_evt_send - send asserted event to uevent thread
2202 * @sdev: scsi_device event occurred on
2203 * @evt: event to send
2205 * Assert scsi device event asynchronously.
2207 void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2209 unsigned long flags;
2212 /* FIXME: currently this check eliminates all media change events
2213 * for polled devices. Need to update to discriminate between AN
2214 * and polled events */
2215 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2221 spin_lock_irqsave(&sdev->list_lock, flags);
2222 list_add_tail(&evt->node, &sdev->event_list);
2223 schedule_work(&sdev->event_work);
2224 spin_unlock_irqrestore(&sdev->list_lock, flags);
2226 EXPORT_SYMBOL_GPL(sdev_evt_send);
2229 * sdev_evt_alloc - allocate a new scsi event
2230 * @evt_type: type of event to allocate
2231 * @gfpflags: GFP flags for allocation
2233 * Allocates and returns a new scsi_event.
2235 struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2238 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2242 evt->evt_type = evt_type;
2243 INIT_LIST_HEAD(&evt->node);
2245 /* evt_type-specific initialization, if any */
2247 case SDEV_EVT_MEDIA_CHANGE:
2255 EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2258 * sdev_evt_send_simple - send asserted event to uevent thread
2259 * @sdev: scsi_device event occurred on
2260 * @evt_type: type of event to send
2261 * @gfpflags: GFP flags for allocation
2263 * Assert scsi device event asynchronously, given an event type.
2265 void sdev_evt_send_simple(struct scsi_device *sdev,
2266 enum scsi_device_event evt_type, gfp_t gfpflags)
2268 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2270 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2275 sdev_evt_send(sdev, evt);
2277 EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2280 * scsi_device_quiesce - Block user issued commands.
2281 * @sdev: scsi device to quiesce.
2283 * This works by trying to transition to the SDEV_QUIESCE state
2284 * (which must be a legal transition). When the device is in this
2285 * state, only special requests will be accepted, all others will
2286 * be deferred. Since special requests may also be requeued requests,
2287 * a successful return doesn't guarantee the device will be
2288 * totally quiescent.
2290 * Must be called with user context, may sleep.
2292 * Returns zero if unsuccessful or an error if not.
2295 scsi_device_quiesce(struct scsi_device *sdev)
2297 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2301 scsi_run_queue(sdev->request_queue);
2302 while (sdev->device_busy) {
2303 msleep_interruptible(200);
2304 scsi_run_queue(sdev->request_queue);
2308 EXPORT_SYMBOL(scsi_device_quiesce);
2311 * scsi_device_resume - Restart user issued commands to a quiesced device.
2312 * @sdev: scsi device to resume.
2314 * Moves the device from quiesced back to running and restarts the
2317 * Must be called with user context, may sleep.
2320 scsi_device_resume(struct scsi_device *sdev)
2322 if(scsi_device_set_state(sdev, SDEV_RUNNING))
2324 scsi_run_queue(sdev->request_queue);
2326 EXPORT_SYMBOL(scsi_device_resume);
2329 device_quiesce_fn(struct scsi_device *sdev, void *data)
2331 scsi_device_quiesce(sdev);
2335 scsi_target_quiesce(struct scsi_target *starget)
2337 starget_for_each_device(starget, NULL, device_quiesce_fn);
2339 EXPORT_SYMBOL(scsi_target_quiesce);
2342 device_resume_fn(struct scsi_device *sdev, void *data)
2344 scsi_device_resume(sdev);
2348 scsi_target_resume(struct scsi_target *starget)
2350 starget_for_each_device(starget, NULL, device_resume_fn);
2352 EXPORT_SYMBOL(scsi_target_resume);
2355 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
2356 * @sdev: device to block
2358 * Block request made by scsi lld's to temporarily stop all
2359 * scsi commands on the specified device. Called from interrupt
2360 * or normal process context.
2362 * Returns zero if successful or error if not
2365 * This routine transitions the device to the SDEV_BLOCK state
2366 * (which must be a legal transition). When the device is in this
2367 * state, all commands are deferred until the scsi lld reenables
2368 * the device with scsi_device_unblock or device_block_tmo fires.
2369 * This routine assumes the host_lock is held on entry.
2372 scsi_internal_device_block(struct scsi_device *sdev)
2374 struct request_queue *q = sdev->request_queue;
2375 unsigned long flags;
2378 err = scsi_device_set_state(sdev, SDEV_BLOCK);
2380 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2387 * The device has transitioned to SDEV_BLOCK. Stop the
2388 * block layer from calling the midlayer with this device's
2391 spin_lock_irqsave(q->queue_lock, flags);
2393 spin_unlock_irqrestore(q->queue_lock, flags);
2397 EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2400 * scsi_internal_device_unblock - resume a device after a block request
2401 * @sdev: device to resume
2403 * Called by scsi lld's or the midlayer to restart the device queue
2404 * for the previously suspended scsi device. Called from interrupt or
2405 * normal process context.
2407 * Returns zero if successful or error if not.
2410 * This routine transitions the device to the SDEV_RUNNING state
2411 * (which must be a legal transition) allowing the midlayer to
2412 * goose the queue for this device. This routine assumes the
2413 * host_lock is held upon entry.
2416 scsi_internal_device_unblock(struct scsi_device *sdev)
2418 struct request_queue *q = sdev->request_queue;
2420 unsigned long flags;
2423 * Try to transition the scsi device to SDEV_RUNNING
2424 * and goose the device queue if successful.
2426 err = scsi_device_set_state(sdev, SDEV_RUNNING);
2428 err = scsi_device_set_state(sdev, SDEV_CREATED);
2434 spin_lock_irqsave(q->queue_lock, flags);
2436 spin_unlock_irqrestore(q->queue_lock, flags);
2440 EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
2443 device_block(struct scsi_device *sdev, void *data)
2445 scsi_internal_device_block(sdev);
2449 target_block(struct device *dev, void *data)
2451 if (scsi_is_target_device(dev))
2452 starget_for_each_device(to_scsi_target(dev), NULL,
2458 scsi_target_block(struct device *dev)
2460 if (scsi_is_target_device(dev))
2461 starget_for_each_device(to_scsi_target(dev), NULL,
2464 device_for_each_child(dev, NULL, target_block);
2466 EXPORT_SYMBOL_GPL(scsi_target_block);
2469 device_unblock(struct scsi_device *sdev, void *data)
2471 scsi_internal_device_unblock(sdev);
2475 target_unblock(struct device *dev, void *data)
2477 if (scsi_is_target_device(dev))
2478 starget_for_each_device(to_scsi_target(dev), NULL,
2484 scsi_target_unblock(struct device *dev)
2486 if (scsi_is_target_device(dev))
2487 starget_for_each_device(to_scsi_target(dev), NULL,
2490 device_for_each_child(dev, NULL, target_unblock);
2492 EXPORT_SYMBOL_GPL(scsi_target_unblock);
2495 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
2496 * @sgl: scatter-gather list
2497 * @sg_count: number of segments in sg
2498 * @offset: offset in bytes into sg, on return offset into the mapped area
2499 * @len: bytes to map, on return number of bytes mapped
2501 * Returns virtual address of the start of the mapped page
2503 void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
2504 size_t *offset, size_t *len)
2507 size_t sg_len = 0, len_complete = 0;
2508 struct scatterlist *sg;
2511 WARN_ON(!irqs_disabled());
2513 for_each_sg(sgl, sg, sg_count, i) {
2514 len_complete = sg_len; /* Complete sg-entries */
2515 sg_len += sg->length;
2516 if (sg_len > *offset)
2520 if (unlikely(i == sg_count)) {
2521 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2523 __func__, sg_len, *offset, sg_count);
2528 /* Offset starting from the beginning of first page in this sg-entry */
2529 *offset = *offset - len_complete + sg->offset;
2531 /* Assumption: contiguous pages can be accessed as "page + i" */
2532 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
2533 *offset &= ~PAGE_MASK;
2535 /* Bytes in this sg-entry from *offset to the end of the page */
2536 sg_len = PAGE_SIZE - *offset;
2540 return kmap_atomic(page, KM_BIO_SRC_IRQ);
2542 EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2545 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
2546 * @virt: virtual address to be unmapped
2548 void scsi_kunmap_atomic_sg(void *virt)
2550 kunmap_atomic(virt, KM_BIO_SRC_IRQ);
2552 EXPORT_SYMBOL(scsi_kunmap_atomic_sg);