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