Merge commit 'v2.6.28-rc7' into core/locking
[linux-2.6] / drivers / scsi / scsi.c
1 /*
2  *  scsi.c Copyright (C) 1992 Drew Eckhardt
3  *         Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
4  *         Copyright (C) 2002, 2003 Christoph Hellwig
5  *
6  *  generic mid-level SCSI driver
7  *      Initial versions: Drew Eckhardt
8  *      Subsequent revisions: Eric Youngdale
9  *
10  *  <drew@colorado.edu>
11  *
12  *  Bug correction thanks go to :
13  *      Rik Faith <faith@cs.unc.edu>
14  *      Tommy Thorn <tthorn>
15  *      Thomas Wuensche <tw@fgb1.fgb.mw.tu-muenchen.de>
16  *
17  *  Modified by Eric Youngdale eric@andante.org or ericy@gnu.ai.mit.edu to
18  *  add scatter-gather, multiple outstanding request, and other
19  *  enhancements.
20  *
21  *  Native multichannel, wide scsi, /proc/scsi and hot plugging
22  *  support added by Michael Neuffer <mike@i-connect.net>
23  *
24  *  Added request_module("scsi_hostadapter") for kerneld:
25  *  (Put an "alias scsi_hostadapter your_hostadapter" in /etc/modprobe.conf)
26  *  Bjorn Ekwall  <bj0rn@blox.se>
27  *  (changed to kmod)
28  *
29  *  Major improvements to the timeout, abort, and reset processing,
30  *  as well as performance modifications for large queue depths by
31  *  Leonard N. Zubkoff <lnz@dandelion.com>
32  *
33  *  Converted cli() code to spinlocks, Ingo Molnar
34  *
35  *  Jiffies wrap fixes (host->resetting), 3 Dec 1998 Andrea Arcangeli
36  *
37  *  out_of_space hacks, D. Gilbert (dpg) 990608
38  */
39
40 #include <linux/module.h>
41 #include <linux/moduleparam.h>
42 #include <linux/kernel.h>
43 #include <linux/timer.h>
44 #include <linux/string.h>
45 #include <linux/slab.h>
46 #include <linux/blkdev.h>
47 #include <linux/delay.h>
48 #include <linux/init.h>
49 #include <linux/completion.h>
50 #include <linux/unistd.h>
51 #include <linux/spinlock.h>
52 #include <linux/kmod.h>
53 #include <linux/interrupt.h>
54 #include <linux/notifier.h>
55 #include <linux/cpu.h>
56 #include <linux/mutex.h>
57
58 #include <scsi/scsi.h>
59 #include <scsi/scsi_cmnd.h>
60 #include <scsi/scsi_dbg.h>
61 #include <scsi/scsi_device.h>
62 #include <scsi/scsi_driver.h>
63 #include <scsi/scsi_eh.h>
64 #include <scsi/scsi_host.h>
65 #include <scsi/scsi_tcq.h>
66
67 #include "scsi_priv.h"
68 #include "scsi_logging.h"
69
70 static void scsi_done(struct scsi_cmnd *cmd);
71
72 /*
73  * Definitions and constants.
74  */
75
76 #define MIN_RESET_DELAY (2*HZ)
77
78 /* Do not call reset on error if we just did a reset within 15 sec. */
79 #define MIN_RESET_PERIOD (15*HZ)
80
81 /*
82  * Note - the initial logging level can be set here to log events at boot time.
83  * After the system is up, you may enable logging via the /proc interface.
84  */
85 unsigned int scsi_logging_level;
86 #if defined(CONFIG_SCSI_LOGGING)
87 EXPORT_SYMBOL(scsi_logging_level);
88 #endif
89
90 /* NB: These are exposed through /proc/scsi/scsi and form part of the ABI.
91  * You may not alter any existing entry (although adding new ones is
92  * encouraged once assigned by ANSI/INCITS T10
93  */
94 static const char *const scsi_device_types[] = {
95         "Direct-Access    ",
96         "Sequential-Access",
97         "Printer          ",
98         "Processor        ",
99         "WORM             ",
100         "CD-ROM           ",
101         "Scanner          ",
102         "Optical Device   ",
103         "Medium Changer   ",
104         "Communications   ",
105         "ASC IT8          ",
106         "ASC IT8          ",
107         "RAID             ",
108         "Enclosure        ",
109         "Direct-Access-RBC",
110         "Optical card     ",
111         "Bridge controller",
112         "Object storage   ",
113         "Automation/Drive ",
114 };
115
116 /**
117  * scsi_device_type - Return 17 char string indicating device type.
118  * @type: type number to look up
119  */
120
121 const char * scsi_device_type(unsigned type)
122 {
123         if (type == 0x1e)
124                 return "Well-known LUN   ";
125         if (type == 0x1f)
126                 return "No Device        ";
127         if (type >= ARRAY_SIZE(scsi_device_types))
128                 return "Unknown          ";
129         return scsi_device_types[type];
130 }
131
132 EXPORT_SYMBOL(scsi_device_type);
133
134 struct scsi_host_cmd_pool {
135         struct kmem_cache       *cmd_slab;
136         struct kmem_cache       *sense_slab;
137         unsigned int            users;
138         char                    *cmd_name;
139         char                    *sense_name;
140         unsigned int            slab_flags;
141         gfp_t                   gfp_mask;
142 };
143
144 static struct scsi_host_cmd_pool scsi_cmd_pool = {
145         .cmd_name       = "scsi_cmd_cache",
146         .sense_name     = "scsi_sense_cache",
147         .slab_flags     = SLAB_HWCACHE_ALIGN,
148 };
149
150 static struct scsi_host_cmd_pool scsi_cmd_dma_pool = {
151         .cmd_name       = "scsi_cmd_cache(DMA)",
152         .sense_name     = "scsi_sense_cache(DMA)",
153         .slab_flags     = SLAB_HWCACHE_ALIGN|SLAB_CACHE_DMA,
154         .gfp_mask       = __GFP_DMA,
155 };
156
157 static DEFINE_MUTEX(host_cmd_pool_mutex);
158
159 /**
160  * scsi_pool_alloc_command - internal function to get a fully allocated command
161  * @pool:       slab pool to allocate the command from
162  * @gfp_mask:   mask for the allocation
163  *
164  * Returns a fully allocated command (with the allied sense buffer) or
165  * NULL on failure
166  */
167 static struct scsi_cmnd *
168 scsi_pool_alloc_command(struct scsi_host_cmd_pool *pool, gfp_t gfp_mask)
169 {
170         struct scsi_cmnd *cmd;
171
172         cmd = kmem_cache_alloc(pool->cmd_slab, gfp_mask | pool->gfp_mask);
173         if (!cmd)
174                 return NULL;
175
176         memset(cmd, 0, sizeof(*cmd));
177
178         cmd->sense_buffer = kmem_cache_alloc(pool->sense_slab,
179                                              gfp_mask | pool->gfp_mask);
180         if (!cmd->sense_buffer) {
181                 kmem_cache_free(pool->cmd_slab, cmd);
182                 return NULL;
183         }
184
185         return cmd;
186 }
187
188 /**
189  * scsi_pool_free_command - internal function to release a command
190  * @pool:       slab pool to allocate the command from
191  * @cmd:        command to release
192  *
193  * the command must previously have been allocated by
194  * scsi_pool_alloc_command.
195  */
196 static void
197 scsi_pool_free_command(struct scsi_host_cmd_pool *pool,
198                          struct scsi_cmnd *cmd)
199 {
200         if (cmd->prot_sdb)
201                 kmem_cache_free(scsi_sdb_cache, cmd->prot_sdb);
202
203         kmem_cache_free(pool->sense_slab, cmd->sense_buffer);
204         kmem_cache_free(pool->cmd_slab, cmd);
205 }
206
207 /**
208  * scsi_host_alloc_command - internal function to allocate command
209  * @shost:      SCSI host whose pool to allocate from
210  * @gfp_mask:   mask for the allocation
211  *
212  * Returns a fully allocated command with sense buffer and protection
213  * data buffer (where applicable) or NULL on failure
214  */
215 static struct scsi_cmnd *
216 scsi_host_alloc_command(struct Scsi_Host *shost, gfp_t gfp_mask)
217 {
218         struct scsi_cmnd *cmd;
219
220         cmd = scsi_pool_alloc_command(shost->cmd_pool, gfp_mask);
221         if (!cmd)
222                 return NULL;
223
224         if (scsi_host_get_prot(shost) >= SHOST_DIX_TYPE0_PROTECTION) {
225                 cmd->prot_sdb = kmem_cache_zalloc(scsi_sdb_cache, gfp_mask);
226
227                 if (!cmd->prot_sdb) {
228                         scsi_pool_free_command(shost->cmd_pool, cmd);
229                         return NULL;
230                 }
231         }
232
233         return cmd;
234 }
235
236 /**
237  * __scsi_get_command - Allocate a struct scsi_cmnd
238  * @shost: host to transmit command
239  * @gfp_mask: allocation mask
240  *
241  * Description: allocate a struct scsi_cmd from host's slab, recycling from the
242  *              host's free_list if necessary.
243  */
244 struct scsi_cmnd *__scsi_get_command(struct Scsi_Host *shost, gfp_t gfp_mask)
245 {
246         struct scsi_cmnd *cmd;
247         unsigned char *buf;
248
249         cmd = scsi_host_alloc_command(shost, gfp_mask);
250
251         if (unlikely(!cmd)) {
252                 unsigned long flags;
253
254                 spin_lock_irqsave(&shost->free_list_lock, flags);
255                 if (likely(!list_empty(&shost->free_list))) {
256                         cmd = list_entry(shost->free_list.next,
257                                          struct scsi_cmnd, list);
258                         list_del_init(&cmd->list);
259                 }
260                 spin_unlock_irqrestore(&shost->free_list_lock, flags);
261
262                 if (cmd) {
263                         buf = cmd->sense_buffer;
264                         memset(cmd, 0, sizeof(*cmd));
265                         cmd->sense_buffer = buf;
266                 }
267         }
268
269         return cmd;
270 }
271 EXPORT_SYMBOL_GPL(__scsi_get_command);
272
273 /**
274  * scsi_get_command - Allocate and setup a scsi command block
275  * @dev: parent scsi device
276  * @gfp_mask: allocator flags
277  *
278  * Returns:     The allocated scsi command structure.
279  */
280 struct scsi_cmnd *scsi_get_command(struct scsi_device *dev, gfp_t gfp_mask)
281 {
282         struct scsi_cmnd *cmd;
283
284         /* Bail if we can't get a reference to the device */
285         if (!get_device(&dev->sdev_gendev))
286                 return NULL;
287
288         cmd = __scsi_get_command(dev->host, gfp_mask);
289
290         if (likely(cmd != NULL)) {
291                 unsigned long flags;
292
293                 cmd->device = dev;
294                 INIT_LIST_HEAD(&cmd->list);
295                 spin_lock_irqsave(&dev->list_lock, flags);
296                 list_add_tail(&cmd->list, &dev->cmd_list);
297                 spin_unlock_irqrestore(&dev->list_lock, flags);
298                 cmd->jiffies_at_alloc = jiffies;
299         } else
300                 put_device(&dev->sdev_gendev);
301
302         return cmd;
303 }
304 EXPORT_SYMBOL(scsi_get_command);
305
306 /**
307  * __scsi_put_command - Free a struct scsi_cmnd
308  * @shost: dev->host
309  * @cmd: Command to free
310  * @dev: parent scsi device
311  */
312 void __scsi_put_command(struct Scsi_Host *shost, struct scsi_cmnd *cmd,
313                         struct device *dev)
314 {
315         unsigned long flags;
316
317         /* changing locks here, don't need to restore the irq state */
318         spin_lock_irqsave(&shost->free_list_lock, flags);
319         if (unlikely(list_empty(&shost->free_list))) {
320                 list_add(&cmd->list, &shost->free_list);
321                 cmd = NULL;
322         }
323         spin_unlock_irqrestore(&shost->free_list_lock, flags);
324
325         if (likely(cmd != NULL))
326                 scsi_pool_free_command(shost->cmd_pool, cmd);
327
328         put_device(dev);
329 }
330 EXPORT_SYMBOL(__scsi_put_command);
331
332 /**
333  * scsi_put_command - Free a scsi command block
334  * @cmd: command block to free
335  *
336  * Returns:     Nothing.
337  *
338  * Notes:       The command must not belong to any lists.
339  */
340 void scsi_put_command(struct scsi_cmnd *cmd)
341 {
342         struct scsi_device *sdev = cmd->device;
343         unsigned long flags;
344
345         /* serious error if the command hasn't come from a device list */
346         spin_lock_irqsave(&cmd->device->list_lock, flags);
347         BUG_ON(list_empty(&cmd->list));
348         list_del_init(&cmd->list);
349         spin_unlock_irqrestore(&cmd->device->list_lock, flags);
350
351         __scsi_put_command(cmd->device->host, cmd, &sdev->sdev_gendev);
352 }
353 EXPORT_SYMBOL(scsi_put_command);
354
355 static struct scsi_host_cmd_pool *scsi_get_host_cmd_pool(gfp_t gfp_mask)
356 {
357         struct scsi_host_cmd_pool *retval = NULL, *pool;
358         /*
359          * Select a command slab for this host and create it if not
360          * yet existent.
361          */
362         mutex_lock(&host_cmd_pool_mutex);
363         pool = (gfp_mask & __GFP_DMA) ? &scsi_cmd_dma_pool :
364                 &scsi_cmd_pool;
365         if (!pool->users) {
366                 pool->cmd_slab = kmem_cache_create(pool->cmd_name,
367                                                    sizeof(struct scsi_cmnd), 0,
368                                                    pool->slab_flags, NULL);
369                 if (!pool->cmd_slab)
370                         goto fail;
371
372                 pool->sense_slab = kmem_cache_create(pool->sense_name,
373                                                      SCSI_SENSE_BUFFERSIZE, 0,
374                                                      pool->slab_flags, NULL);
375                 if (!pool->sense_slab) {
376                         kmem_cache_destroy(pool->cmd_slab);
377                         goto fail;
378                 }
379         }
380
381         pool->users++;
382         retval = pool;
383  fail:
384         mutex_unlock(&host_cmd_pool_mutex);
385         return retval;
386 }
387
388 static void scsi_put_host_cmd_pool(gfp_t gfp_mask)
389 {
390         struct scsi_host_cmd_pool *pool;
391
392         mutex_lock(&host_cmd_pool_mutex);
393         pool = (gfp_mask & __GFP_DMA) ? &scsi_cmd_dma_pool :
394                 &scsi_cmd_pool;
395         /*
396          * This may happen if a driver has a mismatched get and put
397          * of the command pool; the driver should be implicated in
398          * the stack trace
399          */
400         BUG_ON(pool->users == 0);
401
402         if (!--pool->users) {
403                 kmem_cache_destroy(pool->cmd_slab);
404                 kmem_cache_destroy(pool->sense_slab);
405         }
406         mutex_unlock(&host_cmd_pool_mutex);
407 }
408
409 /**
410  * scsi_allocate_command - get a fully allocated SCSI command
411  * @gfp_mask:   allocation mask
412  *
413  * This function is for use outside of the normal host based pools.
414  * It allocates the relevant command and takes an additional reference
415  * on the pool it used.  This function *must* be paired with
416  * scsi_free_command which also has the identical mask, otherwise the
417  * free pool counts will eventually go wrong and you'll trigger a bug.
418  *
419  * This function should *only* be used by drivers that need a static
420  * command allocation at start of day for internal functions.
421  */
422 struct scsi_cmnd *scsi_allocate_command(gfp_t gfp_mask)
423 {
424         struct scsi_host_cmd_pool *pool = scsi_get_host_cmd_pool(gfp_mask);
425
426         if (!pool)
427                 return NULL;
428
429         return scsi_pool_alloc_command(pool, gfp_mask);
430 }
431 EXPORT_SYMBOL(scsi_allocate_command);
432
433 /**
434  * scsi_free_command - free a command allocated by scsi_allocate_command
435  * @gfp_mask:   mask used in the original allocation
436  * @cmd:        command to free
437  *
438  * Note: using the original allocation mask is vital because that's
439  * what determines which command pool we use to free the command.  Any
440  * mismatch will cause the system to BUG eventually.
441  */
442 void scsi_free_command(gfp_t gfp_mask, struct scsi_cmnd *cmd)
443 {
444         struct scsi_host_cmd_pool *pool = scsi_get_host_cmd_pool(gfp_mask);
445
446         /*
447          * this could trigger if the mask to scsi_allocate_command
448          * doesn't match this mask.  Otherwise we're guaranteed that this
449          * succeeds because scsi_allocate_command must have taken a reference
450          * on the pool
451          */
452         BUG_ON(!pool);
453
454         scsi_pool_free_command(pool, cmd);
455         /*
456          * scsi_put_host_cmd_pool is called twice; once to release the
457          * reference we took above, and once to release the reference
458          * originally taken by scsi_allocate_command
459          */
460         scsi_put_host_cmd_pool(gfp_mask);
461         scsi_put_host_cmd_pool(gfp_mask);
462 }
463 EXPORT_SYMBOL(scsi_free_command);
464
465 /**
466  * scsi_setup_command_freelist - Setup the command freelist for a scsi host.
467  * @shost: host to allocate the freelist for.
468  *
469  * Description: The command freelist protects against system-wide out of memory
470  * deadlock by preallocating one SCSI command structure for each host, so the
471  * system can always write to a swap file on a device associated with that host.
472  *
473  * Returns:     Nothing.
474  */
475 int scsi_setup_command_freelist(struct Scsi_Host *shost)
476 {
477         struct scsi_cmnd *cmd;
478         const gfp_t gfp_mask = shost->unchecked_isa_dma ? GFP_DMA : GFP_KERNEL;
479
480         spin_lock_init(&shost->free_list_lock);
481         INIT_LIST_HEAD(&shost->free_list);
482
483         shost->cmd_pool = scsi_get_host_cmd_pool(gfp_mask);
484
485         if (!shost->cmd_pool)
486                 return -ENOMEM;
487
488         /*
489          * Get one backup command for this host.
490          */
491         cmd = scsi_host_alloc_command(shost, gfp_mask);
492         if (!cmd) {
493                 scsi_put_host_cmd_pool(gfp_mask);
494                 shost->cmd_pool = NULL;
495                 return -ENOMEM;
496         }
497         list_add(&cmd->list, &shost->free_list);
498         return 0;
499 }
500
501 /**
502  * scsi_destroy_command_freelist - Release the command freelist for a scsi host.
503  * @shost: host whose freelist is going to be destroyed
504  */
505 void scsi_destroy_command_freelist(struct Scsi_Host *shost)
506 {
507         /*
508          * If cmd_pool is NULL the free list was not initialized, so
509          * do not attempt to release resources.
510          */
511         if (!shost->cmd_pool)
512                 return;
513
514         while (!list_empty(&shost->free_list)) {
515                 struct scsi_cmnd *cmd;
516
517                 cmd = list_entry(shost->free_list.next, struct scsi_cmnd, list);
518                 list_del_init(&cmd->list);
519                 scsi_pool_free_command(shost->cmd_pool, cmd);
520         }
521         shost->cmd_pool = NULL;
522         scsi_put_host_cmd_pool(shost->unchecked_isa_dma ? GFP_DMA : GFP_KERNEL);
523 }
524
525 #ifdef CONFIG_SCSI_LOGGING
526 void scsi_log_send(struct scsi_cmnd *cmd)
527 {
528         unsigned int level;
529
530         /*
531          * If ML QUEUE log level is greater than or equal to:
532          *
533          * 1: nothing (match completion)
534          *
535          * 2: log opcode + command of all commands
536          *
537          * 3: same as 2 plus dump cmd address
538          *
539          * 4: same as 3 plus dump extra junk
540          */
541         if (unlikely(scsi_logging_level)) {
542                 level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
543                                        SCSI_LOG_MLQUEUE_BITS);
544                 if (level > 1) {
545                         scmd_printk(KERN_INFO, cmd, "Send: ");
546                         if (level > 2)
547                                 printk("0x%p ", cmd);
548                         printk("\n");
549                         scsi_print_command(cmd);
550                         if (level > 3) {
551                                 printk(KERN_INFO "buffer = 0x%p, bufflen = %d,"
552                                        " queuecommand 0x%p\n",
553                                         scsi_sglist(cmd), scsi_bufflen(cmd),
554                                         cmd->device->host->hostt->queuecommand);
555
556                         }
557                 }
558         }
559 }
560
561 void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
562 {
563         unsigned int level;
564
565         /*
566          * If ML COMPLETE log level is greater than or equal to:
567          *
568          * 1: log disposition, result, opcode + command, and conditionally
569          * sense data for failures or non SUCCESS dispositions.
570          *
571          * 2: same as 1 but for all command completions.
572          *
573          * 3: same as 2 plus dump cmd address
574          *
575          * 4: same as 3 plus dump extra junk
576          */
577         if (unlikely(scsi_logging_level)) {
578                 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
579                                        SCSI_LOG_MLCOMPLETE_BITS);
580                 if (((level > 0) && (cmd->result || disposition != SUCCESS)) ||
581                     (level > 1)) {
582                         scmd_printk(KERN_INFO, cmd, "Done: ");
583                         if (level > 2)
584                                 printk("0x%p ", cmd);
585                         /*
586                          * Dump truncated values, so we usually fit within
587                          * 80 chars.
588                          */
589                         switch (disposition) {
590                         case SUCCESS:
591                                 printk("SUCCESS\n");
592                                 break;
593                         case NEEDS_RETRY:
594                                 printk("RETRY\n");
595                                 break;
596                         case ADD_TO_MLQUEUE:
597                                 printk("MLQUEUE\n");
598                                 break;
599                         case FAILED:
600                                 printk("FAILED\n");
601                                 break;
602                         case TIMEOUT_ERROR:
603                                 /* 
604                                  * If called via scsi_times_out.
605                                  */
606                                 printk("TIMEOUT\n");
607                                 break;
608                         default:
609                                 printk("UNKNOWN\n");
610                         }
611                         scsi_print_result(cmd);
612                         scsi_print_command(cmd);
613                         if (status_byte(cmd->result) & CHECK_CONDITION)
614                                 scsi_print_sense("", cmd);
615                         if (level > 3)
616                                 scmd_printk(KERN_INFO, cmd,
617                                             "scsi host busy %d failed %d\n",
618                                             cmd->device->host->host_busy,
619                                             cmd->device->host->host_failed);
620                 }
621         }
622 }
623 #endif
624
625 /**
626  * scsi_cmd_get_serial - Assign a serial number to a command
627  * @host: the scsi host
628  * @cmd: command to assign serial number to
629  *
630  * Description: a serial number identifies a request for error recovery
631  * and debugging purposes.  Protected by the Host_Lock of host.
632  */
633 static inline void scsi_cmd_get_serial(struct Scsi_Host *host, struct scsi_cmnd *cmd)
634 {
635         cmd->serial_number = host->cmd_serial_number++;
636         if (cmd->serial_number == 0) 
637                 cmd->serial_number = host->cmd_serial_number++;
638 }
639
640 /**
641  * scsi_dispatch_command - Dispatch a command to the low-level driver.
642  * @cmd: command block we are dispatching.
643  *
644  * Return: nonzero return request was rejected and device's queue needs to be
645  * plugged.
646  */
647 int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
648 {
649         struct Scsi_Host *host = cmd->device->host;
650         unsigned long flags = 0;
651         unsigned long timeout;
652         int rtn = 0;
653
654         /*
655          * We will use a queued command if possible, otherwise we will
656          * emulate the queuing and calling of completion function ourselves.
657          */
658         atomic_inc(&cmd->device->iorequest_cnt);
659
660         /* check if the device is still usable */
661         if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
662                 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
663                  * returns an immediate error upwards, and signals
664                  * that the device is no longer present */
665                 cmd->result = DID_NO_CONNECT << 16;
666                 scsi_done(cmd);
667                 /* return 0 (because the command has been processed) */
668                 goto out;
669         }
670
671         /* Check to see if the scsi lld made this device blocked. */
672         if (unlikely(scsi_device_blocked(cmd->device))) {
673                 /* 
674                  * in blocked state, the command is just put back on
675                  * the device queue.  The suspend state has already
676                  * blocked the queue so future requests should not
677                  * occur until the device transitions out of the
678                  * suspend state.
679                  */
680
681                 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
682
683                 SCSI_LOG_MLQUEUE(3, printk("queuecommand : device blocked \n"));
684
685                 /*
686                  * NOTE: rtn is still zero here because we don't need the
687                  * queue to be plugged on return (it's already stopped)
688                  */
689                 goto out;
690         }
691
692         /* 
693          * If SCSI-2 or lower, store the LUN value in cmnd.
694          */
695         if (cmd->device->scsi_level <= SCSI_2 &&
696             cmd->device->scsi_level != SCSI_UNKNOWN) {
697                 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
698                                (cmd->device->lun << 5 & 0xe0);
699         }
700
701         /*
702          * We will wait MIN_RESET_DELAY clock ticks after the last reset so
703          * we can avoid the drive not being ready.
704          */
705         timeout = host->last_reset + MIN_RESET_DELAY;
706
707         if (host->resetting && time_before(jiffies, timeout)) {
708                 int ticks_remaining = timeout - jiffies;
709                 /*
710                  * NOTE: This may be executed from within an interrupt
711                  * handler!  This is bad, but for now, it'll do.  The irq
712                  * level of the interrupt handler has been masked out by the
713                  * platform dependent interrupt handling code already, so the
714                  * sti() here will not cause another call to the SCSI host's
715                  * interrupt handler (assuming there is one irq-level per
716                  * host).
717                  */
718                 while (--ticks_remaining >= 0)
719                         mdelay(1 + 999 / HZ);
720                 host->resetting = 0;
721         }
722
723         scsi_log_send(cmd);
724
725         /*
726          * Before we queue this command, check if the command
727          * length exceeds what the host adapter can handle.
728          */
729         if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
730                 SCSI_LOG_MLQUEUE(3,
731                         printk("queuecommand : command too long. "
732                                "cdb_size=%d host->max_cmd_len=%d\n",
733                                cmd->cmd_len, cmd->device->host->max_cmd_len));
734                 cmd->result = (DID_ABORT << 16);
735
736                 scsi_done(cmd);
737                 goto out;
738         }
739
740         spin_lock_irqsave(host->host_lock, flags);
741         /*
742          * AK: unlikely race here: for some reason the timer could
743          * expire before the serial number is set up below.
744          *
745          * TODO: kill serial or move to blk layer
746          */
747         scsi_cmd_get_serial(host, cmd); 
748
749         if (unlikely(host->shost_state == SHOST_DEL)) {
750                 cmd->result = (DID_NO_CONNECT << 16);
751                 scsi_done(cmd);
752         } else {
753                 rtn = host->hostt->queuecommand(cmd, scsi_done);
754         }
755         spin_unlock_irqrestore(host->host_lock, flags);
756         if (rtn) {
757                 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
758                     rtn != SCSI_MLQUEUE_TARGET_BUSY)
759                         rtn = SCSI_MLQUEUE_HOST_BUSY;
760
761                 scsi_queue_insert(cmd, rtn);
762
763                 SCSI_LOG_MLQUEUE(3,
764                     printk("queuecommand : request rejected\n"));
765         }
766
767  out:
768         SCSI_LOG_MLQUEUE(3, printk("leaving scsi_dispatch_cmnd()\n"));
769         return rtn;
770 }
771
772 /**
773  * scsi_done - Enqueue the finished SCSI command into the done queue.
774  * @cmd: The SCSI Command for which a low-level device driver (LLDD) gives
775  * ownership back to SCSI Core -- i.e. the LLDD has finished with it.
776  *
777  * Description: This function is the mid-level's (SCSI Core) interrupt routine,
778  * which regains ownership of the SCSI command (de facto) from a LLDD, and
779  * enqueues the command to the done queue for further processing.
780  *
781  * This is the producer of the done queue who enqueues at the tail.
782  *
783  * This function is interrupt context safe.
784  */
785 static void scsi_done(struct scsi_cmnd *cmd)
786 {
787         blk_complete_request(cmd->request);
788 }
789
790 /* Move this to a header if it becomes more generally useful */
791 static struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
792 {
793         return *(struct scsi_driver **)cmd->request->rq_disk->private_data;
794 }
795
796 /**
797  * scsi_finish_command - cleanup and pass command back to upper layer
798  * @cmd: the command
799  *
800  * Description: Pass command off to upper layer for finishing of I/O
801  *              request, waking processes that are waiting on results,
802  *              etc.
803  */
804 void scsi_finish_command(struct scsi_cmnd *cmd)
805 {
806         struct scsi_device *sdev = cmd->device;
807         struct scsi_target *starget = scsi_target(sdev);
808         struct Scsi_Host *shost = sdev->host;
809         struct scsi_driver *drv;
810         unsigned int good_bytes;
811
812         scsi_device_unbusy(sdev);
813
814         /*
815          * Clear the flags which say that the device/host is no longer
816          * capable of accepting new commands.  These are set in scsi_queue.c
817          * for both the queue full condition on a device, and for a
818          * host full condition on the host.
819          *
820          * XXX(hch): What about locking?
821          */
822         shost->host_blocked = 0;
823         starget->target_blocked = 0;
824         sdev->device_blocked = 0;
825
826         /*
827          * If we have valid sense information, then some kind of recovery
828          * must have taken place.  Make a note of this.
829          */
830         if (SCSI_SENSE_VALID(cmd))
831                 cmd->result |= (DRIVER_SENSE << 24);
832
833         SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
834                                 "Notifying upper driver of completion "
835                                 "(result %x)\n", cmd->result));
836
837         good_bytes = scsi_bufflen(cmd);
838         if (cmd->request->cmd_type != REQ_TYPE_BLOCK_PC) {
839                 int old_good_bytes = good_bytes;
840                 drv = scsi_cmd_to_driver(cmd);
841                 if (drv->done)
842                         good_bytes = drv->done(cmd);
843                 /*
844                  * USB may not give sense identifying bad sector and
845                  * simply return a residue instead, so subtract off the
846                  * residue if drv->done() error processing indicates no
847                  * change to the completion length.
848                  */
849                 if (good_bytes == old_good_bytes)
850                         good_bytes -= scsi_get_resid(cmd);
851         }
852         scsi_io_completion(cmd, good_bytes);
853 }
854 EXPORT_SYMBOL(scsi_finish_command);
855
856 /**
857  * scsi_adjust_queue_depth - Let low level drivers change a device's queue depth
858  * @sdev: SCSI Device in question
859  * @tagged: Do we use tagged queueing (non-0) or do we treat
860  *          this device as an untagged device (0)
861  * @tags: Number of tags allowed if tagged queueing enabled,
862  *        or number of commands the low level driver can
863  *        queue up in non-tagged mode (as per cmd_per_lun).
864  *
865  * Returns:     Nothing
866  *
867  * Lock Status: None held on entry
868  *
869  * Notes:       Low level drivers may call this at any time and we will do
870  *              the right thing depending on whether or not the device is
871  *              currently active and whether or not it even has the
872  *              command blocks built yet.
873  */
874 void scsi_adjust_queue_depth(struct scsi_device *sdev, int tagged, int tags)
875 {
876         unsigned long flags;
877
878         /*
879          * refuse to set tagged depth to an unworkable size
880          */
881         if (tags <= 0)
882                 return;
883
884         spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
885
886         /*
887          * Check to see if the queue is managed by the block layer.
888          * If it is, and we fail to adjust the depth, exit.
889          *
890          * Do not resize the tag map if it is a host wide share bqt,
891          * because the size should be the hosts's can_queue. If there
892          * is more IO than the LLD's can_queue (so there are not enuogh
893          * tags) request_fn's host queue ready check will handle it.
894          */
895         if (!sdev->host->bqt) {
896                 if (blk_queue_tagged(sdev->request_queue) &&
897                     blk_queue_resize_tags(sdev->request_queue, tags) != 0)
898                         goto out;
899         }
900
901         sdev->queue_depth = tags;
902         switch (tagged) {
903                 case MSG_ORDERED_TAG:
904                         sdev->ordered_tags = 1;
905                         sdev->simple_tags = 1;
906                         break;
907                 case MSG_SIMPLE_TAG:
908                         sdev->ordered_tags = 0;
909                         sdev->simple_tags = 1;
910                         break;
911                 default:
912                         sdev_printk(KERN_WARNING, sdev,
913                                     "scsi_adjust_queue_depth, bad queue type, "
914                                     "disabled\n");
915                 case 0:
916                         sdev->ordered_tags = sdev->simple_tags = 0;
917                         sdev->queue_depth = tags;
918                         break;
919         }
920  out:
921         spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
922 }
923 EXPORT_SYMBOL(scsi_adjust_queue_depth);
924
925 /**
926  * scsi_track_queue_full - track QUEUE_FULL events to adjust queue depth
927  * @sdev: SCSI Device in question
928  * @depth: Current number of outstanding SCSI commands on this device,
929  *         not counting the one returned as QUEUE_FULL.
930  *
931  * Description: This function will track successive QUEUE_FULL events on a
932  *              specific SCSI device to determine if and when there is a
933  *              need to adjust the queue depth on the device.
934  *
935  * Returns:     0 - No change needed, >0 - Adjust queue depth to this new depth,
936  *              -1 - Drop back to untagged operation using host->cmd_per_lun
937  *                      as the untagged command depth
938  *
939  * Lock Status: None held on entry
940  *
941  * Notes:       Low level drivers may call this at any time and we will do
942  *              "The Right Thing."  We are interrupt context safe.
943  */
944 int scsi_track_queue_full(struct scsi_device *sdev, int depth)
945 {
946         if ((jiffies >> 4) == sdev->last_queue_full_time)
947                 return 0;
948
949         sdev->last_queue_full_time = (jiffies >> 4);
950         if (sdev->last_queue_full_depth != depth) {
951                 sdev->last_queue_full_count = 1;
952                 sdev->last_queue_full_depth = depth;
953         } else {
954                 sdev->last_queue_full_count++;
955         }
956
957         if (sdev->last_queue_full_count <= 10)
958                 return 0;
959         if (sdev->last_queue_full_depth < 8) {
960                 /* Drop back to untagged */
961                 scsi_adjust_queue_depth(sdev, 0, sdev->host->cmd_per_lun);
962                 return -1;
963         }
964         
965         if (sdev->ordered_tags)
966                 scsi_adjust_queue_depth(sdev, MSG_ORDERED_TAG, depth);
967         else
968                 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
969         return depth;
970 }
971 EXPORT_SYMBOL(scsi_track_queue_full);
972
973 /**
974  * scsi_device_get  -  get an additional reference to a scsi_device
975  * @sdev:       device to get a reference to
976  *
977  * Description: Gets a reference to the scsi_device and increments the use count
978  * of the underlying LLDD module.  You must hold host_lock of the
979  * parent Scsi_Host or already have a reference when calling this.
980  */
981 int scsi_device_get(struct scsi_device *sdev)
982 {
983         if (sdev->sdev_state == SDEV_DEL)
984                 return -ENXIO;
985         if (!get_device(&sdev->sdev_gendev))
986                 return -ENXIO;
987         /* We can fail this if we're doing SCSI operations
988          * from module exit (like cache flush) */
989         try_module_get(sdev->host->hostt->module);
990
991         return 0;
992 }
993 EXPORT_SYMBOL(scsi_device_get);
994
995 /**
996  * scsi_device_put  -  release a reference to a scsi_device
997  * @sdev:       device to release a reference on.
998  *
999  * Description: Release a reference to the scsi_device and decrements the use
1000  * count of the underlying LLDD module.  The device is freed once the last
1001  * user vanishes.
1002  */
1003 void scsi_device_put(struct scsi_device *sdev)
1004 {
1005 #ifdef CONFIG_MODULE_UNLOAD
1006         struct module *module = sdev->host->hostt->module;
1007
1008         /* The module refcount will be zero if scsi_device_get()
1009          * was called from a module removal routine */
1010         if (module && module_refcount(module) != 0)
1011                 module_put(module);
1012 #endif
1013         put_device(&sdev->sdev_gendev);
1014 }
1015 EXPORT_SYMBOL(scsi_device_put);
1016
1017 /* helper for shost_for_each_device, see that for documentation */
1018 struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
1019                                            struct scsi_device *prev)
1020 {
1021         struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
1022         struct scsi_device *next = NULL;
1023         unsigned long flags;
1024
1025         spin_lock_irqsave(shost->host_lock, flags);
1026         while (list->next != &shost->__devices) {
1027                 next = list_entry(list->next, struct scsi_device, siblings);
1028                 /* skip devices that we can't get a reference to */
1029                 if (!scsi_device_get(next))
1030                         break;
1031                 next = NULL;
1032                 list = list->next;
1033         }
1034         spin_unlock_irqrestore(shost->host_lock, flags);
1035
1036         if (prev)
1037                 scsi_device_put(prev);
1038         return next;
1039 }
1040 EXPORT_SYMBOL(__scsi_iterate_devices);
1041
1042 /**
1043  * starget_for_each_device  -  helper to walk all devices of a target
1044  * @starget:    target whose devices we want to iterate over.
1045  * @data:       Opaque passed to each function call.
1046  * @fn:         Function to call on each device
1047  *
1048  * This traverses over each device of @starget.  The devices have
1049  * a reference that must be released by scsi_host_put when breaking
1050  * out of the loop.
1051  */
1052 void starget_for_each_device(struct scsi_target *starget, void *data,
1053                      void (*fn)(struct scsi_device *, void *))
1054 {
1055         struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1056         struct scsi_device *sdev;
1057
1058         shost_for_each_device(sdev, shost) {
1059                 if ((sdev->channel == starget->channel) &&
1060                     (sdev->id == starget->id))
1061                         fn(sdev, data);
1062         }
1063 }
1064 EXPORT_SYMBOL(starget_for_each_device);
1065
1066 /**
1067  * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
1068  * @starget:    target whose devices we want to iterate over.
1069  * @data:       parameter for callback @fn()
1070  * @fn:         callback function that is invoked for each device
1071  *
1072  * This traverses over each device of @starget.  It does _not_
1073  * take a reference on the scsi_device, so the whole loop must be
1074  * protected by shost->host_lock.
1075  *
1076  * Note:  The only reason why drivers would want to use this is because
1077  * they need to access the device list in irq context.  Otherwise you
1078  * really want to use starget_for_each_device instead.
1079  **/
1080 void __starget_for_each_device(struct scsi_target *starget, void *data,
1081                                void (*fn)(struct scsi_device *, void *))
1082 {
1083         struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1084         struct scsi_device *sdev;
1085
1086         __shost_for_each_device(sdev, shost) {
1087                 if ((sdev->channel == starget->channel) &&
1088                     (sdev->id == starget->id))
1089                         fn(sdev, data);
1090         }
1091 }
1092 EXPORT_SYMBOL(__starget_for_each_device);
1093
1094 /**
1095  * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
1096  * @starget:    SCSI target pointer
1097  * @lun:        SCSI Logical Unit Number
1098  *
1099  * Description: Looks up the scsi_device with the specified @lun for a given
1100  * @starget.  The returned scsi_device does not have an additional
1101  * reference.  You must hold the host's host_lock over this call and
1102  * any access to the returned scsi_device.
1103  *
1104  * Note:  The only reason why drivers should use this is because
1105  * they need to access the device list in irq context.  Otherwise you
1106  * really want to use scsi_device_lookup_by_target instead.
1107  **/
1108 struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
1109                                                    uint lun)
1110 {
1111         struct scsi_device *sdev;
1112
1113         list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
1114                 if (sdev->lun ==lun)
1115                         return sdev;
1116         }
1117
1118         return NULL;
1119 }
1120 EXPORT_SYMBOL(__scsi_device_lookup_by_target);
1121
1122 /**
1123  * scsi_device_lookup_by_target - find a device given the target
1124  * @starget:    SCSI target pointer
1125  * @lun:        SCSI Logical Unit Number
1126  *
1127  * Description: Looks up the scsi_device with the specified @channel, @id, @lun
1128  * for a given host.  The returned scsi_device has an additional reference that
1129  * needs to be released with scsi_device_put once you're done with it.
1130  **/
1131 struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
1132                                                  uint lun)
1133 {
1134         struct scsi_device *sdev;
1135         struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1136         unsigned long flags;
1137
1138         spin_lock_irqsave(shost->host_lock, flags);
1139         sdev = __scsi_device_lookup_by_target(starget, lun);
1140         if (sdev && scsi_device_get(sdev))
1141                 sdev = NULL;
1142         spin_unlock_irqrestore(shost->host_lock, flags);
1143
1144         return sdev;
1145 }
1146 EXPORT_SYMBOL(scsi_device_lookup_by_target);
1147
1148 /**
1149  * __scsi_device_lookup - find a device given the host (UNLOCKED)
1150  * @shost:      SCSI host pointer
1151  * @channel:    SCSI channel (zero if only one channel)
1152  * @id:         SCSI target number (physical unit number)
1153  * @lun:        SCSI Logical Unit Number
1154  *
1155  * Description: Looks up the scsi_device with the specified @channel, @id, @lun
1156  * for a given host. The returned scsi_device does not have an additional
1157  * reference.  You must hold the host's host_lock over this call and any access
1158  * to the returned scsi_device.
1159  *
1160  * Note:  The only reason why drivers would want to use this is because
1161  * they need to access the device list in irq context.  Otherwise you
1162  * really want to use scsi_device_lookup instead.
1163  **/
1164 struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
1165                 uint channel, uint id, uint lun)
1166 {
1167         struct scsi_device *sdev;
1168
1169         list_for_each_entry(sdev, &shost->__devices, siblings) {
1170                 if (sdev->channel == channel && sdev->id == id &&
1171                                 sdev->lun ==lun)
1172                         return sdev;
1173         }
1174
1175         return NULL;
1176 }
1177 EXPORT_SYMBOL(__scsi_device_lookup);
1178
1179 /**
1180  * scsi_device_lookup - find a device given the host
1181  * @shost:      SCSI host pointer
1182  * @channel:    SCSI channel (zero if only one channel)
1183  * @id:         SCSI target number (physical unit number)
1184  * @lun:        SCSI Logical Unit Number
1185  *
1186  * Description: Looks up the scsi_device with the specified @channel, @id, @lun
1187  * for a given host.  The returned scsi_device has an additional reference that
1188  * needs to be released with scsi_device_put once you're done with it.
1189  **/
1190 struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
1191                 uint channel, uint id, uint lun)
1192 {
1193         struct scsi_device *sdev;
1194         unsigned long flags;
1195
1196         spin_lock_irqsave(shost->host_lock, flags);
1197         sdev = __scsi_device_lookup(shost, channel, id, lun);
1198         if (sdev && scsi_device_get(sdev))
1199                 sdev = NULL;
1200         spin_unlock_irqrestore(shost->host_lock, flags);
1201
1202         return sdev;
1203 }
1204 EXPORT_SYMBOL(scsi_device_lookup);
1205
1206 MODULE_DESCRIPTION("SCSI core");
1207 MODULE_LICENSE("GPL");
1208
1209 module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
1210 MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");
1211
1212 static int __init init_scsi(void)
1213 {
1214         int error;
1215
1216         error = scsi_init_queue();
1217         if (error)
1218                 return error;
1219         error = scsi_init_procfs();
1220         if (error)
1221                 goto cleanup_queue;
1222         error = scsi_init_devinfo();
1223         if (error)
1224                 goto cleanup_procfs;
1225         error = scsi_init_hosts();
1226         if (error)
1227                 goto cleanup_devlist;
1228         error = scsi_init_sysctl();
1229         if (error)
1230                 goto cleanup_hosts;
1231         error = scsi_sysfs_register();
1232         if (error)
1233                 goto cleanup_sysctl;
1234
1235         scsi_netlink_init();
1236
1237         printk(KERN_NOTICE "SCSI subsystem initialized\n");
1238         return 0;
1239
1240 cleanup_sysctl:
1241         scsi_exit_sysctl();
1242 cleanup_hosts:
1243         scsi_exit_hosts();
1244 cleanup_devlist:
1245         scsi_exit_devinfo();
1246 cleanup_procfs:
1247         scsi_exit_procfs();
1248 cleanup_queue:
1249         scsi_exit_queue();
1250         printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
1251                -error);
1252         return error;
1253 }
1254
1255 static void __exit exit_scsi(void)
1256 {
1257         scsi_netlink_exit();
1258         scsi_sysfs_unregister();
1259         scsi_exit_sysctl();
1260         scsi_exit_hosts();
1261         scsi_exit_devinfo();
1262         scsi_exit_procfs();
1263         scsi_exit_queue();
1264 }
1265
1266 subsys_initcall(init_scsi);
1267 module_exit(exit_scsi);