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/sched.h>
  44 #include <linux/timer.h>
  45 #include <linux/string.h>
  46 #include <linux/slab.h>
  47 #include <linux/blkdev.h>
  48 #include <linux/delay.h>
  49 #include <linux/init.h>
  50 #include <linux/completion.h>
  51 #include <linux/unistd.h>
  52 #include <linux/spinlock.h>
  53 #include <linux/kmod.h>
  54 #include <linux/interrupt.h>
  55 #include <linux/notifier.h>
  56 #include <linux/cpu.h>
  57 #include <linux/mutex.h>
  58
  59 #include <scsi/scsi.h>
  60 #include <scsi/scsi_cmnd.h>
  61 #include <scsi/scsi_dbg.h>
  62 #include <scsi/scsi_device.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  * Macro to determine the size of SCSI command. This macro takes vendor
  83  * unique commands into account. SCSI commands in groups 6 and 7 are
  84  * vendor unique and we will depend upon the command length being
  85  * supplied correctly in cmd_len.
  86  */
  87 #define CDB_SIZE(cmd)   (((((cmd)->cmnd[0] >> 5) & 7) < 6) ? \
  88                                 COMMAND_SIZE((cmd)->cmnd[0]) : (cmd)->cmd_len)
  89
  90 /*
  91  * Note - the initial logging level can be set here to log events at boot time.
  92  * After the system is up, you may enable logging via the /proc interface.
  93  */
  94 unsigned int scsi_logging_level;
  95 #if defined(CONFIG_SCSI_LOGGING)
  96 EXPORT_SYMBOL(scsi_logging_level);
  97 #endif
  98
  99 /* NB: These are exposed through /proc/scsi/scsi and form part of the ABI.
 100  * You may not alter any existing entry (although adding new ones is
 101  * encouraged once assigned by ANSI/INCITS T10
 102  */
 103 static const char *const scsi_device_types[] = {
 104         "Direct-Access    ",
 105         "Sequential-Access",
 106         "Printer          ",
 107         "Processor        ",
 108         "WORM             ",
 109         "CD-ROM           ",
 110         "Scanner          ",
 111         "Optical Device   ",
 112         "Medium Changer   ",
 113         "Communications   ",
 114         "ASC IT8          ",
 115         "ASC IT8          ",
 116         "RAID             ",
 117         "Enclosure        ",
 118         "Direct-Access-RBC",
 119         "Optical card     ",
 120         "Bridge controller",
 121         "Object storage   ",
 122         "Automation/Drive ",
 123 };
 124
 125 const char * scsi_device_type(unsigned type)
 126 {
 127         if (type == 0x1e)
 128                 return "Well-known LUN   ";
 129         if (type == 0x1f)
 130                 return "No Device        ";
 131         if (type >= ARRAY_SIZE(scsi_device_types))
 132                 return "Unknown          ";
 133         return scsi_device_types[type];
 134 }
 135
 136 EXPORT_SYMBOL(scsi_device_type);
 137
 138 struct scsi_host_cmd_pool {
 139         struct kmem_cache       *slab;
 140         unsigned int    users;
 141         char            *name;
 142         unsigned int    slab_flags;
 143         gfp_t           gfp_mask;
 144 };
 145
 146 static struct scsi_host_cmd_pool scsi_cmd_pool = {
 147         .name           = "scsi_cmd_cache",
 148         .slab_flags     = SLAB_HWCACHE_ALIGN,
 149 };
 150
 151 static struct scsi_host_cmd_pool scsi_cmd_dma_pool = {
 152         .name           = "scsi_cmd_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 struct scsi_cmnd *__scsi_get_command(struct Scsi_Host *shost, gfp_t gfp_mask)
 160 {
 161         struct scsi_cmnd *cmd;
 162
 163         cmd = kmem_cache_alloc(shost->cmd_pool->slab,
 164                         gfp_mask | shost->cmd_pool->gfp_mask);
 165
 166         if (unlikely(!cmd)) {
 167                 unsigned long flags;
 168
 169                 spin_lock_irqsave(&shost->free_list_lock, flags);
 170                 if (likely(!list_empty(&shost->free_list))) {
 171                         cmd = list_entry(shost->free_list.next,
 172                                          struct scsi_cmnd, list);
 173                         list_del_init(&cmd->list);
 174                 }
 175                 spin_unlock_irqrestore(&shost->free_list_lock, flags);
 176         }
 177
 178         return cmd;
 179 }
 180 EXPORT_SYMBOL_GPL(__scsi_get_command);
 181
 182 /*
 183  * Function:    scsi_get_command()
 184  *
 185  * Purpose:     Allocate and setup a scsi command block
 186  *
 187  * Arguments:   dev     - parent scsi device
 188  *              gfp_mask- allocator flags
 189  *
 190  * Returns:     The allocated scsi command structure.
 191  */
 192 struct scsi_cmnd *scsi_get_command(struct scsi_device *dev, gfp_t gfp_mask)
 193 {
 194         struct scsi_cmnd *cmd;
 195
 196         /* Bail if we can't get a reference to the device */
 197         if (!get_device(&dev->sdev_gendev))
 198                 return NULL;
 199
 200         cmd = __scsi_get_command(dev->host, gfp_mask);
 201
 202         if (likely(cmd != NULL)) {
 203                 unsigned long flags;
 204
 205                 memset(cmd, 0, sizeof(*cmd));
 206                 cmd->device = dev;
 207                 init_timer(&cmd->eh_timeout);
 208                 INIT_LIST_HEAD(&cmd->list);
 209                 spin_lock_irqsave(&dev->list_lock, flags);
 210                 list_add_tail(&cmd->list, &dev->cmd_list);
 211                 spin_unlock_irqrestore(&dev->list_lock, flags);
 212                 cmd->jiffies_at_alloc = jiffies;
 213         } else
 214                 put_device(&dev->sdev_gendev);
 215
 216         return cmd;
 217 }
 218 EXPORT_SYMBOL(scsi_get_command);
 219
 220 void __scsi_put_command(struct Scsi_Host *shost, struct scsi_cmnd *cmd,
 221                         struct device *dev)
 222 {
 223         unsigned long flags;
 224
 225         /* changing locks here, don't need to restore the irq state */
 226         spin_lock_irqsave(&shost->free_list_lock, flags);
 227         if (unlikely(list_empty(&shost->free_list))) {
 228                 list_add(&cmd->list, &shost->free_list);
 229                 cmd = NULL;
 230         }
 231         spin_unlock_irqrestore(&shost->free_list_lock, flags);
 232
 233         if (likely(cmd != NULL))
 234                 kmem_cache_free(shost->cmd_pool->slab, cmd);
 235
 236         put_device(dev);
 237 }
 238 EXPORT_SYMBOL(__scsi_put_command);
 239
 240 /*
 241  * Function:    scsi_put_command()
 242  *
 243  * Purpose:     Free a scsi command block
 244  *
 245  * Arguments:   cmd     - command block to free
 246  *
 247  * Returns:     Nothing.
 248  *
 249  * Notes:       The command must not belong to any lists.
 250  */
 251 void scsi_put_command(struct scsi_cmnd *cmd)
 252 {
 253         struct scsi_device *sdev = cmd->device;
 254         unsigned long flags;
 255
 256         /* serious error if the command hasn't come from a device list */
 257         spin_lock_irqsave(&cmd->device->list_lock, flags);
 258         BUG_ON(list_empty(&cmd->list));
 259         list_del_init(&cmd->list);
 260         spin_unlock_irqrestore(&cmd->device->list_lock, flags);
 261
 262         __scsi_put_command(cmd->device->host, cmd, &sdev->sdev_gendev);
 263 }
 264 EXPORT_SYMBOL(scsi_put_command);
 265
 266 /*
 267  * Function:    scsi_setup_command_freelist()
 268  *
 269  * Purpose:     Setup the command freelist for a scsi host.
 270  *
 271  * Arguments:   shost   - host to allocate the freelist for.
 272  *
 273  * Returns:     Nothing.
 274  */
 275 int scsi_setup_command_freelist(struct Scsi_Host *shost)
 276 {
 277         struct scsi_host_cmd_pool *pool;
 278         struct scsi_cmnd *cmd;
 279
 280         spin_lock_init(&shost->free_list_lock);
 281         INIT_LIST_HEAD(&shost->free_list);
 282
 283         /*
 284          * Select a command slab for this host and create it if not
 285          * yet existant.
 286          */
 287         mutex_lock(&host_cmd_pool_mutex);
 288         pool = (shost->unchecked_isa_dma ? &scsi_cmd_dma_pool : &scsi_cmd_pool);
 289         if (!pool->users) {
 290                 pool->slab = kmem_cache_create(pool->name,
 291                                 sizeof(struct scsi_cmnd), 0,
 292                                 pool->slab_flags, NULL, NULL);
 293                 if (!pool->slab)
 294                         goto fail;
 295         }
 296
 297         pool->users++;
 298         shost->cmd_pool = pool;
 299         mutex_unlock(&host_cmd_pool_mutex);
 300
 301         /*
 302          * Get one backup command for this host.
 303          */
 304         cmd = kmem_cache_alloc(shost->cmd_pool->slab,
 305                         GFP_KERNEL | shost->cmd_pool->gfp_mask);
 306         if (!cmd)
 307                 goto fail2;
 308         list_add(&cmd->list, &shost->free_list);
 309         return 0;
 310
 311  fail2:
 312         if (!--pool->users)
 313                 kmem_cache_destroy(pool->slab);
 314         return -ENOMEM;
 315  fail:
 316         mutex_unlock(&host_cmd_pool_mutex);
 317         return -ENOMEM;
 318
 319 }
 320
 321 /*
 322  * Function:    scsi_destroy_command_freelist()
 323  *
 324  * Purpose:     Release the command freelist for a scsi host.
 325  *
 326  * Arguments:   shost   - host that's freelist is going to be destroyed
 327  */
 328 void scsi_destroy_command_freelist(struct Scsi_Host *shost)
 329 {
 330         while (!list_empty(&shost->free_list)) {
 331                 struct scsi_cmnd *cmd;
 332
 333                 cmd = list_entry(shost->free_list.next, struct scsi_cmnd, list);
 334                 list_del_init(&cmd->list);
 335                 kmem_cache_free(shost->cmd_pool->slab, cmd);
 336         }
 337
 338         mutex_lock(&host_cmd_pool_mutex);
 339         if (!--shost->cmd_pool->users)
 340                 kmem_cache_destroy(shost->cmd_pool->slab);
 341         mutex_unlock(&host_cmd_pool_mutex);
 342 }
 343
 344 #ifdef CONFIG_SCSI_LOGGING
 345 void scsi_log_send(struct scsi_cmnd *cmd)
 346 {
 347         unsigned int level;
 348         struct scsi_device *sdev;
 349
 350         /*
 351          * If ML QUEUE log level is greater than or equal to:
 352          *
 353          * 1: nothing (match completion)
 354          *
 355          * 2: log opcode + command of all commands
 356          *
 357          * 3: same as 2 plus dump cmd address
 358          *
 359          * 4: same as 3 plus dump extra junk
 360          */
 361         if (unlikely(scsi_logging_level)) {
 362                 level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
 363                                        SCSI_LOG_MLQUEUE_BITS);
 364                 if (level > 1) {
 365                         sdev = cmd->device;
 366                         sdev_printk(KERN_INFO, sdev, "send ");
 367                         if (level > 2)
 368                                 printk("0x%p ", cmd);
 369                         /*
 370                          * spaces to match disposition and cmd->result
 371                          * output in scsi_log_completion.
 372                          */
 373                         printk("                 ");
 374                         scsi_print_command(cmd);
 375                         if (level > 3) {
 376                                 printk(KERN_INFO "buffer = 0x%p, bufflen = %d,"
 377                                        " done = 0x%p, queuecommand 0x%p\n",
 378                                         cmd->request_buffer, cmd->request_bufflen,
 379                                         cmd->done,
 380                                         sdev->host->hostt->queuecommand);
 381
 382                         }
 383                 }
 384         }
 385 }
 386
 387 void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
 388 {
 389         unsigned int level;
 390         struct scsi_device *sdev;
 391
 392         /*
 393          * If ML COMPLETE log level is greater than or equal to:
 394          *
 395          * 1: log disposition, result, opcode + command, and conditionally
 396          * sense data for failures or non SUCCESS dispositions.
 397          *
 398          * 2: same as 1 but for all command completions.
 399          *
 400          * 3: same as 2 plus dump cmd address
 401          *
 402          * 4: same as 3 plus dump extra junk
 403          */
 404         if (unlikely(scsi_logging_level)) {
 405                 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
 406                                        SCSI_LOG_MLCOMPLETE_BITS);
 407                 if (((level > 0) && (cmd->result || disposition != SUCCESS)) ||
 408                     (level > 1)) {
 409                         sdev = cmd->device;
 410                         sdev_printk(KERN_INFO, sdev, "done ");
 411                         if (level > 2)
 412                                 printk("0x%p ", cmd);
 413                         /*
 414                          * Dump truncated values, so we usually fit within
 415                          * 80 chars.
 416                          */
 417                         switch (disposition) {
 418                         case SUCCESS:
 419                                 printk("SUCCESS");
 420                                 break;
 421                         case NEEDS_RETRY:
 422                                 printk("RETRY  ");
 423                                 break;
 424                         case ADD_TO_MLQUEUE:
 425                                 printk("MLQUEUE");
 426                                 break;
 427                         case FAILED:
 428                                 printk("FAILED ");
 429                                 break;
 430                         case TIMEOUT_ERROR:
 431                                 /*
 432                                  * If called via scsi_times_out.
 433                                  */
 434                                 printk("TIMEOUT");
 435                                 break;
 436                         default:
 437                                 printk("UNKNOWN");
 438                         }
 439                         printk(" %8x ", cmd->result);
 440                         scsi_print_command(cmd);
 441                         if (status_byte(cmd->result) & CHECK_CONDITION) {
 442                                 /*
 443                                  * XXX The scsi_print_sense formatting/prefix
 444                                  * doesn't match this function.
 445                                  */
 446                                 scsi_print_sense("", cmd);
 447                         }
 448                         if (level > 3) {
 449                                 printk(KERN_INFO "scsi host busy %d failed %d\n",
 450                                        sdev->host->host_busy,
 451                                        sdev->host->host_failed);
 452                         }
 453                 }
 454         }
 455 }
 456 #endif
 457
 458 /*
 459  * Assign a serial number and pid to the request for error recovery
 460  * and debugging purposes.  Protected by the Host_Lock of host.
 461  */
 462 static inline void scsi_cmd_get_serial(struct Scsi_Host *host, struct scsi_cmnd *cmd)
 463 {
 464         cmd->serial_number = host->cmd_serial_number++;
 465         if (cmd->serial_number == 0)
 466                 cmd->serial_number = host->cmd_serial_number++;
 467
 468         cmd->pid = host->cmd_pid++;
 469         if (cmd->pid == 0)
 470                 cmd->pid = host->cmd_pid++;
 471 }
 472
 473 /*
 474  * Function:    scsi_dispatch_command
 475  *
 476  * Purpose:     Dispatch a command to the low-level driver.
 477  *
 478  * Arguments:   cmd - command block we are dispatching.
 479  *
 480  * Notes:
 481  */
 482 int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
 483 {
 484         struct Scsi_Host *host = cmd->device->host;
 485         unsigned long flags = 0;
 486         unsigned long timeout;
 487         int rtn = 0;
 488
 489         /* check if the device is still usable */
 490         if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
 491                 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
 492                  * returns an immediate error upwards, and signals
 493                  * that the device is no longer present */
 494                 cmd->result = DID_NO_CONNECT << 16;
 495                 atomic_inc(&cmd->device->iorequest_cnt);
 496                 __scsi_done(cmd);
 497                 /* return 0 (because the command has been processed) */
 498                 goto out;
 499         }
 500
 501         /* Check to see if the scsi lld put this device into state SDEV_BLOCK. */
 502         if (unlikely(cmd->device->sdev_state == SDEV_BLOCK)) {
 503                 /*
 504                  * in SDEV_BLOCK, the command is just put back on the device
 505                  * queue.  The suspend state has already blocked the queue so
 506                  * future requests should not occur until the device
 507                  * transitions out of the suspend state.
 508                  */
 509                 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
 510
 511                 SCSI_LOG_MLQUEUE(3, printk("queuecommand : device blocked \n"));
 512
 513                 /*
 514                  * NOTE: rtn is still zero here because we don't need the
 515                  * queue to be plugged on return (it's already stopped)
 516                  */
 517                 goto out;
 518         }
 519
 520         /*
 521          * If SCSI-2 or lower, store the LUN value in cmnd.
 522          */
 523         if (cmd->device->scsi_level <= SCSI_2 &&
 524             cmd->device->scsi_level != SCSI_UNKNOWN) {
 525                 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
 526                                (cmd->device->lun << 5 & 0xe0);
 527         }
 528
 529         /*
 530          * We will wait MIN_RESET_DELAY clock ticks after the last reset so
 531          * we can avoid the drive not being ready.
 532          */
 533         timeout = host->last_reset + MIN_RESET_DELAY;
 534
 535         if (host->resetting && time_before(jiffies, timeout)) {
 536                 int ticks_remaining = timeout - jiffies;
 537                 /*
 538                  * NOTE: This may be executed from within an interrupt
 539                  * handler!  This is bad, but for now, it'll do.  The irq
 540                  * level of the interrupt handler has been masked out by the
 541                  * platform dependent interrupt handling code already, so the
 542                  * sti() here will not cause another call to the SCSI host's
 543                  * interrupt handler (assuming there is one irq-level per
 544                  * host).
 545                  */
 546                 while (--ticks_remaining >= 0)
 547                         mdelay(1 + 999 / HZ);
 548                 host->resetting = 0;
 549         }
 550
 551         /*
 552          * AK: unlikely race here: for some reason the timer could
 553          * expire before the serial number is set up below.
 554          */
 555         scsi_add_timer(cmd, cmd->timeout_per_command, scsi_times_out);
 556
 557         scsi_log_send(cmd);
 558
 559         /*
 560          * We will use a queued command if possible, otherwise we will
 561          * emulate the queuing and calling of completion function ourselves.
 562          */
 563         atomic_inc(&cmd->device->iorequest_cnt);
 564
 565         /*
 566          * Before we queue this command, check if the command
 567          * length exceeds what the host adapter can handle.
 568          */
 569         if (CDB_SIZE(cmd) > cmd->device->host->max_cmd_len) {
 570                 SCSI_LOG_MLQUEUE(3,
 571                                 printk("queuecommand : command too long.\n"));
 572                 cmd->result = (DID_ABORT << 16);
 573
 574                 scsi_done(cmd);
 575                 goto out;
 576         }
 577
 578         spin_lock_irqsave(host->host_lock, flags);
 579         scsi_cmd_get_serial(host, cmd);
 580
 581         if (unlikely(host->shost_state == SHOST_DEL)) {
 582                 cmd->result = (DID_NO_CONNECT << 16);
 583                 scsi_done(cmd);
 584         } else {
 585                 rtn = host->hostt->queuecommand(cmd, scsi_done);
 586         }
 587         spin_unlock_irqrestore(host->host_lock, flags);
 588         if (rtn) {
 589                 if (scsi_delete_timer(cmd)) {
 590                         atomic_inc(&cmd->device->iodone_cnt);
 591                         scsi_queue_insert(cmd,
 592                                           (rtn == SCSI_MLQUEUE_DEVICE_BUSY) ?
 593                                           rtn : SCSI_MLQUEUE_HOST_BUSY);
 594                 }
 595                 SCSI_LOG_MLQUEUE(3,
 596                     printk("queuecommand : request rejected\n"));
 597         }
 598
 599  out:
 600         SCSI_LOG_MLQUEUE(3, printk("leaving scsi_dispatch_cmnd()\n"));
 601         return rtn;
 602 }
 603
 604 /**
 605  * scsi_req_abort_cmd -- Request command recovery for the specified command
 606  * cmd: pointer to the SCSI command of interest
 607  *
 608  * This function requests that SCSI Core start recovery for the
 609  * command by deleting the timer and adding the command to the eh
 610  * queue.  It can be called by either LLDDs or SCSI Core.  LLDDs who
 611  * implement their own error recovery MAY ignore the timeout event if
 612  * they generated scsi_req_abort_cmd.
 613  */
 614 void scsi_req_abort_cmd(struct scsi_cmnd *cmd)
 615 {
 616         if (!scsi_delete_timer(cmd))
 617                 return;
 618         scsi_times_out(cmd);
 619 }
 620 EXPORT_SYMBOL(scsi_req_abort_cmd);
 621
 622 /**
 623  * scsi_done - Enqueue the finished SCSI command into the done queue.
 624  * @cmd: The SCSI Command for which a low-level device driver (LLDD) gives
 625  * ownership back to SCSI Core -- i.e. the LLDD has finished with it.
 626  *
 627  * This function is the mid-level's (SCSI Core) interrupt routine, which
 628  * regains ownership of the SCSI command (de facto) from a LLDD, and enqueues
 629  * the command to the done queue for further processing.
 630  *
 631  * This is the producer of the done queue who enqueues at the tail.
 632  *
 633  * This function is interrupt context safe.
 634  */
 635 static void scsi_done(struct scsi_cmnd *cmd)
 636 {
 637         /*
 638          * We don't have to worry about this one timing out any more.
 639          * If we are unable to remove the timer, then the command
 640          * has already timed out.  In which case, we have no choice but to
 641          * let the timeout function run, as we have no idea where in fact
 642          * that function could really be.  It might be on another processor,
 643          * etc, etc.
 644          */
 645         if (!scsi_delete_timer(cmd))
 646                 return;
 647         __scsi_done(cmd);
 648 }
 649
 650 /* Private entry to scsi_done() to complete a command when the timer
 651  * isn't running --- used by scsi_times_out */
 652 void __scsi_done(struct scsi_cmnd *cmd)
 653 {
 654         struct request *rq = cmd->request;
 655
 656         /*
 657          * Set the serial numbers back to zero
 658          */
 659         cmd->serial_number = 0;
 660
 661         atomic_inc(&cmd->device->iodone_cnt);
 662         if (cmd->result)
 663                 atomic_inc(&cmd->device->ioerr_cnt);
 664
 665         BUG_ON(!rq);
 666
 667         /*
 668          * The uptodate/nbytes values don't matter, as we allow partial
 669          * completes and thus will check this in the softirq callback
 670          */
 671         rq->completion_data = cmd;
 672         blk_complete_request(rq);
 673 }
 674
 675 /*
 676  * Function:    scsi_finish_command
 677  *
 678  * Purpose:     Pass command off to upper layer for finishing of I/O
 679  *              request, waking processes that are waiting on results,
 680  *              etc.
 681  */
 682 void scsi_finish_command(struct scsi_cmnd *cmd)
 683 {
 684         struct scsi_device *sdev = cmd->device;
 685         struct Scsi_Host *shost = sdev->host;
 686
 687         scsi_device_unbusy(sdev);
 688
 689         /*
 690          * Clear the flags which say that the device/host is no longer
 691          * capable of accepting new commands.  These are set in scsi_queue.c
 692          * for both the queue full condition on a device, and for a
 693          * host full condition on the host.
 694          *
 695          * XXX(hch): What about locking?
 696          */
 697         shost->host_blocked = 0;
 698         sdev->device_blocked = 0;
 699
 700         /*
 701          * If we have valid sense information, then some kind of recovery
 702          * must have taken place.  Make a note of this.
 703          */
 704         if (SCSI_SENSE_VALID(cmd))
 705                 cmd->result |= (DRIVER_SENSE << 24);
 706
 707         SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
 708                                 "Notifying upper driver of completion "
 709                                 "(result %x)\n", cmd->result));
 710
 711         cmd->done(cmd);
 712 }
 713 EXPORT_SYMBOL(scsi_finish_command);
 714
 715 /*
 716  * Function:    scsi_adjust_queue_depth()
 717  *
 718  * Purpose:     Allow low level drivers to tell us to change the queue depth
 719  *              on a specific SCSI device
 720  *
 721  * Arguments:   sdev    - SCSI Device in question
 722  *              tagged  - Do we use tagged queueing (non-0) or do we treat
 723  *                        this device as an untagged device (0)
 724  *              tags    - Number of tags allowed if tagged queueing enabled,
 725  *                        or number of commands the low level driver can
 726  *                        queue up in non-tagged mode (as per cmd_per_lun).
 727  *
 728  * Returns:     Nothing
 729  *
 730  * Lock Status: None held on entry
 731  *
 732  * Notes:       Low level drivers may call this at any time and we will do
 733  *              the right thing depending on whether or not the device is
 734  *              currently active and whether or not it even has the
 735  *              command blocks built yet.
 736  */
 737 void scsi_adjust_queue_depth(struct scsi_device *sdev, int tagged, int tags)
 738 {
 739         unsigned long flags;
 740
 741         /*
 742          * refuse to set tagged depth to an unworkable size
 743          */
 744         if (tags <= 0)
 745                 return;
 746
 747         spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
 748
 749         /* Check to see if the queue is managed by the block layer
 750          * if it is, and we fail to adjust the depth, exit */
 751         if (blk_queue_tagged(sdev->request_queue) &&
 752             blk_queue_resize_tags(sdev->request_queue, tags) != 0)
 753                 goto out;
 754
 755         sdev->queue_depth = tags;
 756         switch (tagged) {
 757                 case MSG_ORDERED_TAG:
 758                         sdev->ordered_tags = 1;
 759                         sdev->simple_tags = 1;
 760                         break;
 761                 case MSG_SIMPLE_TAG:
 762                         sdev->ordered_tags = 0;
 763                         sdev->simple_tags = 1;
 764                         break;
 765                 default:
 766                         sdev_printk(KERN_WARNING, sdev,
 767                                     "scsi_adjust_queue_depth, bad queue type, "
 768                                     "disabled\n");
 769                 case 0:
 770                         sdev->ordered_tags = sdev->simple_tags = 0;
 771                         sdev->queue_depth = tags;
 772                         break;
 773         }
 774  out:
 775         spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
 776 }
 777 EXPORT_SYMBOL(scsi_adjust_queue_depth);
 778
 779 /*
 780  * Function:    scsi_track_queue_full()
 781  *
 782  * Purpose:     This function will track successive QUEUE_FULL events on a
 783  *              specific SCSI device to determine if and when there is a
 784  *              need to adjust the queue depth on the device.
 785  *
 786  * Arguments:   sdev    - SCSI Device in question
 787  *              depth   - Current number of outstanding SCSI commands on
 788  *                        this device, not counting the one returned as
 789  *                        QUEUE_FULL.
 790  *
 791  * Returns:     0 - No change needed
 792  *              >0 - Adjust queue depth to this new depth
 793  *              -1 - Drop back to untagged operation using host->cmd_per_lun
 794  *                      as the untagged command depth
 795  *
 796  * Lock Status: None held on entry
 797  *
 798  * Notes:       Low level drivers may call this at any time and we will do
 799  *              "The Right Thing."  We are interrupt context safe.
 800  */
 801 int scsi_track_queue_full(struct scsi_device *sdev, int depth)
 802 {
 803         if ((jiffies >> 4) == sdev->last_queue_full_time)
 804                 return 0;
 805
 806         sdev->last_queue_full_time = (jiffies >> 4);
 807         if (sdev->last_queue_full_depth != depth) {
 808                 sdev->last_queue_full_count = 1;
 809                 sdev->last_queue_full_depth = depth;
 810         } else {
 811                 sdev->last_queue_full_count++;
 812         }
 813
 814         if (sdev->last_queue_full_count <= 10)
 815                 return 0;
 816         if (sdev->last_queue_full_depth < 8) {
 817                 /* Drop back to untagged */
 818                 scsi_adjust_queue_depth(sdev, 0, sdev->host->cmd_per_lun);
 819                 return -1;
 820         }
 821
 822         if (sdev->ordered_tags)
 823                 scsi_adjust_queue_depth(sdev, MSG_ORDERED_TAG, depth);
 824         else
 825                 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
 826         return depth;
 827 }
 828 EXPORT_SYMBOL(scsi_track_queue_full);
 829
 830 /**
 831  * scsi_device_get  -  get an addition reference to a scsi_device
 832  * @sdev:       device to get a reference to
 833  *
 834  * Gets a reference to the scsi_device and increments the use count
 835  * of the underlying LLDD module.  You must hold host_lock of the
 836  * parent Scsi_Host or already have a reference when calling this.
 837  */
 838 int scsi_device_get(struct scsi_device *sdev)
 839 {
 840         if (sdev->sdev_state == SDEV_DEL)
 841                 return -ENXIO;
 842         if (!get_device(&sdev->sdev_gendev))
 843                 return -ENXIO;
 844         /* We can fail this if we're doing SCSI operations
 845          * from module exit (like cache flush) */
 846         try_module_get(sdev->host->hostt->module);
 847
 848         return 0;
 849 }
 850 EXPORT_SYMBOL(scsi_device_get);
 851
 852 /**
 853  * scsi_device_put  -  release a reference to a scsi_device
 854  * @sdev:       device to release a reference on.
 855  *
 856  * Release a reference to the scsi_device and decrements the use count
 857  * of the underlying LLDD module.  The device is freed once the last
 858  * user vanishes.
 859  */
 860 void scsi_device_put(struct scsi_device *sdev)
 861 {
 862 #ifdef CONFIG_MODULE_UNLOAD
 863         struct module *module = sdev->host->hostt->module;
 864
 865         /* The module refcount will be zero if scsi_device_get()
 866          * was called from a module removal routine */
 867         if (module && module_refcount(module) != 0)
 868                 module_put(module);
 869 #endif
 870         put_device(&sdev->sdev_gendev);
 871 }
 872 EXPORT_SYMBOL(scsi_device_put);
 873
 874 /* helper for shost_for_each_device, thus not documented */
 875 struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
 876                                            struct scsi_device *prev)
 877 {
 878         struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
 879         struct scsi_device *next = NULL;
 880         unsigned long flags;
 881
 882         spin_lock_irqsave(shost->host_lock, flags);
 883         while (list->next != &shost->__devices) {
 884                 next = list_entry(list->next, struct scsi_device, siblings);
 885                 /* skip devices that we can't get a reference to */
 886                 if (!scsi_device_get(next))
 887                         break;
 888                 next = NULL;
 889                 list = list->next;
 890         }
 891         spin_unlock_irqrestore(shost->host_lock, flags);
 892
 893         if (prev)
 894                 scsi_device_put(prev);
 895         return next;
 896 }
 897 EXPORT_SYMBOL(__scsi_iterate_devices);
 898
 899 /**
 900  * starget_for_each_device  -  helper to walk all devices of a target
 901  * @starget:    target whose devices we want to iterate over.
 902  *
 903  * This traverses over each devices of @shost.  The devices have
 904  * a reference that must be released by scsi_host_put when breaking
 905  * out of the loop.
 906  */
 907 void starget_for_each_device(struct scsi_target *starget, void * data,
 908                      void (*fn)(struct scsi_device *, void *))
 909 {
 910         struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
 911         struct scsi_device *sdev;
 912
 913         shost_for_each_device(sdev, shost) {
 914                 if ((sdev->channel == starget->channel) &&
 915                     (sdev->id == starget->id))
 916                         fn(sdev, data);
 917         }
 918 }
 919 EXPORT_SYMBOL(starget_for_each_device);
 920
 921 /**
 922  * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
 923  * @starget:    SCSI target pointer
 924  * @lun:        SCSI Logical Unit Number
 925  *
 926  * Looks up the scsi_device with the specified @lun for a give
 927  * @starget. The returned scsi_device does not have an additional
 928  * reference.  You must hold the host's host_lock over this call and
 929  * any access to the returned scsi_device.
 930  *
 931  * Note:  The only reason why drivers would want to use this is because
 932  * they're need to access the device list in irq context.  Otherwise you
 933  * really want to use scsi_device_lookup_by_target instead.
 934  **/
 935 struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
 936                                                    uint lun)
 937 {
 938         struct scsi_device *sdev;
 939
 940         list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
 941                 if (sdev->lun ==lun)
 942                         return sdev;
 943         }
 944
 945         return NULL;
 946 }
 947 EXPORT_SYMBOL(__scsi_device_lookup_by_target);
 948
 949 /**
 950  * scsi_device_lookup_by_target - find a device given the target
 951  * @starget:    SCSI target pointer
 952  * @lun:        SCSI Logical Unit Number
 953  *
 954  * Looks up the scsi_device with the specified @channel, @id, @lun for a
 955  * give host.  The returned scsi_device has an additional reference that
 956  * needs to be release with scsi_host_put once you're done with it.
 957  **/
 958 struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
 959                                                  uint lun)
 960 {
 961         struct scsi_device *sdev;
 962         struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
 963         unsigned long flags;
 964
 965         spin_lock_irqsave(shost->host_lock, flags);
 966         sdev = __scsi_device_lookup_by_target(starget, lun);
 967         if (sdev && scsi_device_get(sdev))
 968                 sdev = NULL;
 969         spin_unlock_irqrestore(shost->host_lock, flags);
 970
 971         return sdev;
 972 }
 973 EXPORT_SYMBOL(scsi_device_lookup_by_target);
 974
 975 /**
 976  * scsi_device_lookup - find a device given the host (UNLOCKED)
 977  * @shost:      SCSI host pointer
 978  * @channel:    SCSI channel (zero if only one channel)
 979  * @pun:        SCSI target number (physical unit number)
 980  * @lun:        SCSI Logical Unit Number
 981  *
 982  * Looks up the scsi_device with the specified @channel, @id, @lun for a
 983  * give host. The returned scsi_device does not have an additional reference.
 984  * You must hold the host's host_lock over this call and any access to the
 985  * returned scsi_device.
 986  *
 987  * Note:  The only reason why drivers would want to use this is because
 988  * they're need to access the device list in irq context.  Otherwise you
 989  * really want to use scsi_device_lookup instead.
 990  **/
 991 struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
 992                 uint channel, uint id, uint lun)
 993 {
 994         struct scsi_device *sdev;
 995
 996         list_for_each_entry(sdev, &shost->__devices, siblings) {
 997                 if (sdev->channel == channel && sdev->id == id &&
 998                                 sdev->lun ==lun)
 999                         return sdev;
1000         }
1001
1002         return NULL;
1003 }
1004 EXPORT_SYMBOL(__scsi_device_lookup);
1005
1006 /**
1007  * scsi_device_lookup - find a device given the host
1008  * @shost:      SCSI host pointer
1009  * @channel:    SCSI channel (zero if only one channel)
1010  * @id:         SCSI target number (physical unit number)
1011  * @lun:        SCSI Logical Unit Number
1012  *
1013  * Looks up the scsi_device with the specified @channel, @id, @lun for a
1014  * give host.  The returned scsi_device has an additional reference that
1015  * needs to be release with scsi_host_put once you're done with it.
1016  **/
1017 struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
1018                 uint channel, uint id, uint lun)
1019 {
1020         struct scsi_device *sdev;
1021         unsigned long flags;
1022
1023         spin_lock_irqsave(shost->host_lock, flags);
1024         sdev = __scsi_device_lookup(shost, channel, id, lun);
1025         if (sdev && scsi_device_get(sdev))
1026                 sdev = NULL;
1027         spin_unlock_irqrestore(shost->host_lock, flags);
1028
1029         return sdev;
1030 }
1031 EXPORT_SYMBOL(scsi_device_lookup);
1032
1033 /**
1034  * scsi_device_cancel - cancel outstanding IO to this device
1035  * @sdev:       Pointer to struct scsi_device
1036  * @recovery:   Boolean instructing function to recover device or not.
1037  *
1038  **/
1039 int scsi_device_cancel(struct scsi_device *sdev, int recovery)
1040 {
1041         struct scsi_cmnd *scmd;
1042         LIST_HEAD(active_list);
1043         struct list_head *lh, *lh_sf;
1044         unsigned long flags;
1045
1046         scsi_device_set_state(sdev, SDEV_CANCEL);
1047
1048         spin_lock_irqsave(&sdev->list_lock, flags);
1049         list_for_each_entry(scmd, &sdev->cmd_list, list) {
1050                 if (scmd->request) {
1051                         /*
1052                          * If we are unable to remove the timer, it means
1053                          * that the command has already timed out or
1054                          * finished.
1055                          */
1056                         if (!scsi_delete_timer(scmd))
1057                                 continue;
1058                         list_add_tail(&scmd->eh_entry, &active_list);
1059                 }
1060         }
1061         spin_unlock_irqrestore(&sdev->list_lock, flags);
1062
1063         if (!list_empty(&active_list)) {
1064                 list_for_each_safe(lh, lh_sf, &active_list) {
1065                         scmd = list_entry(lh, struct scsi_cmnd, eh_entry);
1066                         list_del_init(lh);
1067                         if (recovery &&
1068                             !scsi_eh_scmd_add(scmd, SCSI_EH_CANCEL_CMD)) {
1069                                 scmd->result = (DID_ABORT << 16);
1070                                 scsi_finish_command(scmd);
1071                         }
1072                 }
1073         }
1074
1075         return 0;
1076 }
1077 EXPORT_SYMBOL(scsi_device_cancel);
1078
1079 MODULE_DESCRIPTION("SCSI core");
1080 MODULE_LICENSE("GPL");
1081
1082 module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
1083 MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");
1084
1085 static int __init init_scsi(void)
1086 {
1087         int error;
1088
1089         error = scsi_init_queue();
1090         if (error)
1091                 return error;
1092         error = scsi_init_procfs();
1093         if (error)
1094                 goto cleanup_queue;
1095         error = scsi_init_devinfo();
1096         if (error)
1097                 goto cleanup_procfs;
1098         error = scsi_init_hosts();
1099         if (error)
1100                 goto cleanup_devlist;
1101         error = scsi_init_sysctl();
1102         if (error)
1103                 goto cleanup_hosts;
1104         error = scsi_sysfs_register();
1105         if (error)
1106                 goto cleanup_sysctl;
1107
1108         scsi_netlink_init();
1109
1110         printk(KERN_NOTICE "SCSI subsystem initialized\n");
1111         return 0;
1112
1113 cleanup_sysctl:
1114         scsi_exit_sysctl();
1115 cleanup_hosts:
1116         scsi_exit_hosts();
1117 cleanup_devlist:
1118         scsi_exit_devinfo();
1119 cleanup_procfs:
1120         scsi_exit_procfs();
1121 cleanup_queue:
1122         scsi_exit_queue();
1123         printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
1124                -error);
1125         return error;
1126 }
1127
1128 static void __exit exit_scsi(void)
1129 {
1130         scsi_netlink_exit();
1131         scsi_sysfs_unregister();
1132         scsi_exit_sysctl();
1133         scsi_exit_hosts();
1134         scsi_exit_devinfo();
1135         scsi_exit_procfs();
1136         scsi_exit_queue();
1137 }
1138
1139 subsys_initcall(init_scsi);
1140 module_exit(exit_scsi);