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