[SCSI] Delete trailing full stop
[linux-2.6-block.git] / drivers / scsi / scsi_lib.c
CommitLineData
1da177e4
LT
1/*
2 * scsi_lib.c Copyright (C) 1999 Eric Youngdale
3 *
4 * SCSI queueing library.
5 * Initial versions: Eric Youngdale (eric@andante.org).
6 * Based upon conversations with large numbers
7 * of people at Linux Expo.
8 */
9
10#include <linux/bio.h>
11#include <linux/blkdev.h>
12#include <linux/completion.h>
13#include <linux/kernel.h>
14#include <linux/mempool.h>
15#include <linux/slab.h>
16#include <linux/init.h>
17#include <linux/pci.h>
18#include <linux/delay.h>
19
20#include <scsi/scsi.h>
21#include <scsi/scsi_dbg.h>
22#include <scsi/scsi_device.h>
23#include <scsi/scsi_driver.h>
24#include <scsi/scsi_eh.h>
25#include <scsi/scsi_host.h>
26#include <scsi/scsi_request.h>
27
28#include "scsi_priv.h"
29#include "scsi_logging.h"
30
31
32#define SG_MEMPOOL_NR (sizeof(scsi_sg_pools)/sizeof(struct scsi_host_sg_pool))
33#define SG_MEMPOOL_SIZE 32
34
35struct scsi_host_sg_pool {
36 size_t size;
37 char *name;
38 kmem_cache_t *slab;
39 mempool_t *pool;
40};
41
42#if (SCSI_MAX_PHYS_SEGMENTS < 32)
43#error SCSI_MAX_PHYS_SEGMENTS is too small
44#endif
45
46#define SP(x) { x, "sgpool-" #x }
52c1da39 47static struct scsi_host_sg_pool scsi_sg_pools[] = {
1da177e4
LT
48 SP(8),
49 SP(16),
50 SP(32),
51#if (SCSI_MAX_PHYS_SEGMENTS > 32)
52 SP(64),
53#if (SCSI_MAX_PHYS_SEGMENTS > 64)
54 SP(128),
55#if (SCSI_MAX_PHYS_SEGMENTS > 128)
56 SP(256),
57#if (SCSI_MAX_PHYS_SEGMENTS > 256)
58#error SCSI_MAX_PHYS_SEGMENTS is too large
59#endif
60#endif
61#endif
62#endif
63};
64#undef SP
65
66
67/*
68 * Function: scsi_insert_special_req()
69 *
70 * Purpose: Insert pre-formed request into request queue.
71 *
72 * Arguments: sreq - request that is ready to be queued.
73 * at_head - boolean. True if we should insert at head
74 * of queue, false if we should insert at tail.
75 *
76 * Lock status: Assumed that lock is not held upon entry.
77 *
78 * Returns: Nothing
79 *
80 * Notes: This function is called from character device and from
81 * ioctl types of functions where the caller knows exactly
82 * what SCSI command needs to be issued. The idea is that
83 * we merely inject the command into the queue (at the head
84 * for now), and then call the queue request function to actually
85 * process it.
86 */
87int scsi_insert_special_req(struct scsi_request *sreq, int at_head)
88{
89 /*
90 * Because users of this function are apt to reuse requests with no
91 * modification, we have to sanitise the request flags here
92 */
93 sreq->sr_request->flags &= ~REQ_DONTPREP;
94 blk_insert_request(sreq->sr_device->request_queue, sreq->sr_request,
867d1191 95 at_head, sreq);
1da177e4
LT
96 return 0;
97}
98
a1bf9d1d 99static void scsi_run_queue(struct request_queue *q);
e91442b6
JB
100
101/*
102 * Function: scsi_unprep_request()
103 *
104 * Purpose: Remove all preparation done for a request, including its
105 * associated scsi_cmnd, so that it can be requeued.
106 *
107 * Arguments: req - request to unprepare
108 *
109 * Lock status: Assumed that no locks are held upon entry.
110 *
111 * Returns: Nothing.
112 */
113static void scsi_unprep_request(struct request *req)
114{
115 struct scsi_cmnd *cmd = req->special;
116
117 req->flags &= ~REQ_DONTPREP;
118 req->special = (req->flags & REQ_SPECIAL) ? cmd->sc_request : NULL;
119
e91442b6
JB
120 scsi_put_command(cmd);
121}
a1bf9d1d 122
1da177e4
LT
123/*
124 * Function: scsi_queue_insert()
125 *
126 * Purpose: Insert a command in the midlevel queue.
127 *
128 * Arguments: cmd - command that we are adding to queue.
129 * reason - why we are inserting command to queue.
130 *
131 * Lock status: Assumed that lock is not held upon entry.
132 *
133 * Returns: Nothing.
134 *
135 * Notes: We do this for one of two cases. Either the host is busy
136 * and it cannot accept any more commands for the time being,
137 * or the device returned QUEUE_FULL and can accept no more
138 * commands.
139 * Notes: This could be called either from an interrupt context or a
140 * normal process context.
141 */
142int scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
143{
144 struct Scsi_Host *host = cmd->device->host;
145 struct scsi_device *device = cmd->device;
a1bf9d1d
TH
146 struct request_queue *q = device->request_queue;
147 unsigned long flags;
1da177e4
LT
148
149 SCSI_LOG_MLQUEUE(1,
150 printk("Inserting command %p into mlqueue\n", cmd));
151
152 /*
d8c37e7b 153 * Set the appropriate busy bit for the device/host.
1da177e4
LT
154 *
155 * If the host/device isn't busy, assume that something actually
156 * completed, and that we should be able to queue a command now.
157 *
158 * Note that the prior mid-layer assumption that any host could
159 * always queue at least one command is now broken. The mid-layer
160 * will implement a user specifiable stall (see
161 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
162 * if a command is requeued with no other commands outstanding
163 * either for the device or for the host.
164 */
165 if (reason == SCSI_MLQUEUE_HOST_BUSY)
166 host->host_blocked = host->max_host_blocked;
167 else if (reason == SCSI_MLQUEUE_DEVICE_BUSY)
168 device->device_blocked = device->max_device_blocked;
169
1da177e4
LT
170 /*
171 * Decrement the counters, since these commands are no longer
172 * active on the host/device.
173 */
174 scsi_device_unbusy(device);
175
176 /*
a1bf9d1d
TH
177 * Requeue this command. It will go before all other commands
178 * that are already in the queue.
1da177e4
LT
179 *
180 * NOTE: there is magic here about the way the queue is plugged if
181 * we have no outstanding commands.
182 *
a1bf9d1d 183 * Although we *don't* plug the queue, we call the request
1da177e4
LT
184 * function. The SCSI request function detects the blocked condition
185 * and plugs the queue appropriately.
a1bf9d1d
TH
186 */
187 spin_lock_irqsave(q->queue_lock, flags);
59897dad 188 blk_requeue_request(q, cmd->request);
a1bf9d1d
TH
189 spin_unlock_irqrestore(q->queue_lock, flags);
190
191 scsi_run_queue(q);
192
1da177e4
LT
193 return 0;
194}
195
196/*
197 * Function: scsi_do_req
198 *
199 * Purpose: Queue a SCSI request
200 *
201 * Arguments: sreq - command descriptor.
202 * cmnd - actual SCSI command to be performed.
203 * buffer - data buffer.
204 * bufflen - size of data buffer.
205 * done - completion function to be run.
206 * timeout - how long to let it run before timeout.
207 * retries - number of retries we allow.
208 *
209 * Lock status: No locks held upon entry.
210 *
211 * Returns: Nothing.
212 *
213 * Notes: This function is only used for queueing requests for things
214 * like ioctls and character device requests - this is because
215 * we essentially just inject a request into the queue for the
216 * device.
217 *
218 * In order to support the scsi_device_quiesce function, we
219 * now inject requests on the *head* of the device queue
220 * rather than the tail.
221 */
222void scsi_do_req(struct scsi_request *sreq, const void *cmnd,
223 void *buffer, unsigned bufflen,
224 void (*done)(struct scsi_cmnd *),
225 int timeout, int retries)
226{
227 /*
228 * If the upper level driver is reusing these things, then
229 * we should release the low-level block now. Another one will
230 * be allocated later when this request is getting queued.
231 */
232 __scsi_release_request(sreq);
233
234 /*
235 * Our own function scsi_done (which marks the host as not busy,
236 * disables the timeout counter, etc) will be called by us or by the
237 * scsi_hosts[host].queuecommand() function needs to also call
238 * the completion function for the high level driver.
239 */
240 memcpy(sreq->sr_cmnd, cmnd, sizeof(sreq->sr_cmnd));
241 sreq->sr_bufflen = bufflen;
242 sreq->sr_buffer = buffer;
243 sreq->sr_allowed = retries;
244 sreq->sr_done = done;
245 sreq->sr_timeout_per_command = timeout;
246
247 if (sreq->sr_cmd_len == 0)
248 sreq->sr_cmd_len = COMMAND_SIZE(sreq->sr_cmnd[0]);
249
250 /*
251 * head injection *required* here otherwise quiesce won't work
252 */
253 scsi_insert_special_req(sreq, 1);
254}
255EXPORT_SYMBOL(scsi_do_req);
256
39216033 257/**
33aa687d 258 * scsi_execute - insert request and wait for the result
39216033
JB
259 * @sdev: scsi device
260 * @cmd: scsi command
261 * @data_direction: data direction
262 * @buffer: data buffer
263 * @bufflen: len of buffer
264 * @sense: optional sense buffer
265 * @timeout: request timeout in seconds
266 * @retries: number of times to retry request
33aa687d 267 * @flags: or into request flags;
39216033 268 *
ea73a9f2
JB
269 * returns the req->errors value which is the the scsi_cmnd result
270 * field.
39216033 271 **/
33aa687d
JB
272int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
273 int data_direction, void *buffer, unsigned bufflen,
274 unsigned char *sense, int timeout, int retries, int flags)
39216033
JB
275{
276 struct request *req;
277 int write = (data_direction == DMA_TO_DEVICE);
278 int ret = DRIVER_ERROR << 24;
279
280 req = blk_get_request(sdev->request_queue, write, __GFP_WAIT);
281
282 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
283 buffer, bufflen, __GFP_WAIT))
284 goto out;
285
286 req->cmd_len = COMMAND_SIZE(cmd[0]);
287 memcpy(req->cmd, cmd, req->cmd_len);
288 req->sense = sense;
289 req->sense_len = 0;
290 req->timeout = timeout;
3173d8c3 291 req->flags |= flags | REQ_BLOCK_PC | REQ_SPECIAL | REQ_QUIET;
39216033
JB
292
293 /*
294 * head injection *required* here otherwise quiesce won't work
295 */
296 blk_execute_rq(req->q, NULL, req, 1);
297
298 ret = req->errors;
299 out:
300 blk_put_request(req);
301
302 return ret;
303}
33aa687d 304EXPORT_SYMBOL(scsi_execute);
39216033 305
ea73a9f2
JB
306
307int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
308 int data_direction, void *buffer, unsigned bufflen,
309 struct scsi_sense_hdr *sshdr, int timeout, int retries)
310{
311 char *sense = NULL;
1ccb48bb 312 int result;
313
ea73a9f2 314 if (sshdr) {
286f3e13 315 sense = kmalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
ea73a9f2
JB
316 if (!sense)
317 return DRIVER_ERROR << 24;
e514385b 318 memset(sense, 0, SCSI_SENSE_BUFFERSIZE);
ea73a9f2 319 }
1ccb48bb 320 result = scsi_execute(sdev, cmd, data_direction, buffer, bufflen,
ea73a9f2
JB
321 sense, timeout, retries, 0);
322 if (sshdr)
e514385b 323 scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, sshdr);
ea73a9f2
JB
324
325 kfree(sense);
326 return result;
327}
328EXPORT_SYMBOL(scsi_execute_req);
329
1da177e4
LT
330/*
331 * Function: scsi_init_cmd_errh()
332 *
333 * Purpose: Initialize cmd fields related to error handling.
334 *
335 * Arguments: cmd - command that is ready to be queued.
336 *
337 * Returns: Nothing
338 *
339 * Notes: This function has the job of initializing a number of
340 * fields related to error handling. Typically this will
341 * be called once for each command, as required.
342 */
343static int scsi_init_cmd_errh(struct scsi_cmnd *cmd)
344{
1da177e4 345 cmd->serial_number = 0;
1da177e4
LT
346
347 memset(cmd->sense_buffer, 0, sizeof cmd->sense_buffer);
348
349 if (cmd->cmd_len == 0)
350 cmd->cmd_len = COMMAND_SIZE(cmd->cmnd[0]);
351
352 /*
353 * We need saved copies of a number of fields - this is because
354 * error handling may need to overwrite these with different values
355 * to run different commands, and once error handling is complete,
356 * we will need to restore these values prior to running the actual
357 * command.
358 */
359 cmd->old_use_sg = cmd->use_sg;
360 cmd->old_cmd_len = cmd->cmd_len;
361 cmd->sc_old_data_direction = cmd->sc_data_direction;
362 cmd->old_underflow = cmd->underflow;
363 memcpy(cmd->data_cmnd, cmd->cmnd, sizeof(cmd->cmnd));
364 cmd->buffer = cmd->request_buffer;
365 cmd->bufflen = cmd->request_bufflen;
1da177e4
LT
366
367 return 1;
368}
369
370/*
371 * Function: scsi_setup_cmd_retry()
372 *
373 * Purpose: Restore the command state for a retry
374 *
375 * Arguments: cmd - command to be restored
376 *
377 * Returns: Nothing
378 *
379 * Notes: Immediately prior to retrying a command, we need
380 * to restore certain fields that we saved above.
381 */
382void scsi_setup_cmd_retry(struct scsi_cmnd *cmd)
383{
384 memcpy(cmd->cmnd, cmd->data_cmnd, sizeof(cmd->data_cmnd));
385 cmd->request_buffer = cmd->buffer;
386 cmd->request_bufflen = cmd->bufflen;
387 cmd->use_sg = cmd->old_use_sg;
388 cmd->cmd_len = cmd->old_cmd_len;
389 cmd->sc_data_direction = cmd->sc_old_data_direction;
390 cmd->underflow = cmd->old_underflow;
391}
392
393void scsi_device_unbusy(struct scsi_device *sdev)
394{
395 struct Scsi_Host *shost = sdev->host;
396 unsigned long flags;
397
398 spin_lock_irqsave(shost->host_lock, flags);
399 shost->host_busy--;
939647ee 400 if (unlikely(scsi_host_in_recovery(shost) &&
1da177e4
LT
401 shost->host_failed))
402 scsi_eh_wakeup(shost);
403 spin_unlock(shost->host_lock);
152587de 404 spin_lock(sdev->request_queue->queue_lock);
1da177e4 405 sdev->device_busy--;
152587de 406 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
1da177e4
LT
407}
408
409/*
410 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
411 * and call blk_run_queue for all the scsi_devices on the target -
412 * including current_sdev first.
413 *
414 * Called with *no* scsi locks held.
415 */
416static void scsi_single_lun_run(struct scsi_device *current_sdev)
417{
418 struct Scsi_Host *shost = current_sdev->host;
419 struct scsi_device *sdev, *tmp;
420 struct scsi_target *starget = scsi_target(current_sdev);
421 unsigned long flags;
422
423 spin_lock_irqsave(shost->host_lock, flags);
424 starget->starget_sdev_user = NULL;
425 spin_unlock_irqrestore(shost->host_lock, flags);
426
427 /*
428 * Call blk_run_queue for all LUNs on the target, starting with
429 * current_sdev. We race with others (to set starget_sdev_user),
430 * but in most cases, we will be first. Ideally, each LU on the
431 * target would get some limited time or requests on the target.
432 */
433 blk_run_queue(current_sdev->request_queue);
434
435 spin_lock_irqsave(shost->host_lock, flags);
436 if (starget->starget_sdev_user)
437 goto out;
438 list_for_each_entry_safe(sdev, tmp, &starget->devices,
439 same_target_siblings) {
440 if (sdev == current_sdev)
441 continue;
442 if (scsi_device_get(sdev))
443 continue;
444
445 spin_unlock_irqrestore(shost->host_lock, flags);
446 blk_run_queue(sdev->request_queue);
447 spin_lock_irqsave(shost->host_lock, flags);
448
449 scsi_device_put(sdev);
450 }
451 out:
452 spin_unlock_irqrestore(shost->host_lock, flags);
453}
454
455/*
456 * Function: scsi_run_queue()
457 *
458 * Purpose: Select a proper request queue to serve next
459 *
460 * Arguments: q - last request's queue
461 *
462 * Returns: Nothing
463 *
464 * Notes: The previous command was completely finished, start
465 * a new one if possible.
466 */
467static void scsi_run_queue(struct request_queue *q)
468{
469 struct scsi_device *sdev = q->queuedata;
470 struct Scsi_Host *shost = sdev->host;
471 unsigned long flags;
472
473 if (sdev->single_lun)
474 scsi_single_lun_run(sdev);
475
476 spin_lock_irqsave(shost->host_lock, flags);
477 while (!list_empty(&shost->starved_list) &&
478 !shost->host_blocked && !shost->host_self_blocked &&
479 !((shost->can_queue > 0) &&
480 (shost->host_busy >= shost->can_queue))) {
481 /*
482 * As long as shost is accepting commands and we have
483 * starved queues, call blk_run_queue. scsi_request_fn
484 * drops the queue_lock and can add us back to the
485 * starved_list.
486 *
487 * host_lock protects the starved_list and starved_entry.
488 * scsi_request_fn must get the host_lock before checking
489 * or modifying starved_list or starved_entry.
490 */
491 sdev = list_entry(shost->starved_list.next,
492 struct scsi_device, starved_entry);
493 list_del_init(&sdev->starved_entry);
494 spin_unlock_irqrestore(shost->host_lock, flags);
495
496 blk_run_queue(sdev->request_queue);
497
498 spin_lock_irqsave(shost->host_lock, flags);
499 if (unlikely(!list_empty(&sdev->starved_entry)))
500 /*
501 * sdev lost a race, and was put back on the
502 * starved list. This is unlikely but without this
503 * in theory we could loop forever.
504 */
505 break;
506 }
507 spin_unlock_irqrestore(shost->host_lock, flags);
508
509 blk_run_queue(q);
510}
511
512/*
513 * Function: scsi_requeue_command()
514 *
515 * Purpose: Handle post-processing of completed commands.
516 *
517 * Arguments: q - queue to operate on
518 * cmd - command that may need to be requeued.
519 *
520 * Returns: Nothing
521 *
522 * Notes: After command completion, there may be blocks left
523 * over which weren't finished by the previous command
524 * this can be for a number of reasons - the main one is
525 * I/O errors in the middle of the request, in which case
526 * we need to request the blocks that come after the bad
527 * sector.
e91442b6 528 * Notes: Upon return, cmd is a stale pointer.
1da177e4
LT
529 */
530static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
531{
e91442b6 532 struct request *req = cmd->request;
283369cc
TH
533 unsigned long flags;
534
e91442b6 535 scsi_unprep_request(req);
283369cc 536 spin_lock_irqsave(q->queue_lock, flags);
e91442b6 537 blk_requeue_request(q, req);
283369cc 538 spin_unlock_irqrestore(q->queue_lock, flags);
1da177e4
LT
539
540 scsi_run_queue(q);
541}
542
543void scsi_next_command(struct scsi_cmnd *cmd)
544{
49d7bc64
LT
545 struct scsi_device *sdev = cmd->device;
546 struct request_queue *q = sdev->request_queue;
547
548 /* need to hold a reference on the device before we let go of the cmd */
549 get_device(&sdev->sdev_gendev);
1da177e4
LT
550
551 scsi_put_command(cmd);
552 scsi_run_queue(q);
49d7bc64
LT
553
554 /* ok to remove device now */
555 put_device(&sdev->sdev_gendev);
1da177e4
LT
556}
557
558void scsi_run_host_queues(struct Scsi_Host *shost)
559{
560 struct scsi_device *sdev;
561
562 shost_for_each_device(sdev, shost)
563 scsi_run_queue(sdev->request_queue);
564}
565
566/*
567 * Function: scsi_end_request()
568 *
569 * Purpose: Post-processing of completed commands (usually invoked at end
570 * of upper level post-processing and scsi_io_completion).
571 *
572 * Arguments: cmd - command that is complete.
573 * uptodate - 1 if I/O indicates success, <= 0 for I/O error.
574 * bytes - number of bytes of completed I/O
575 * requeue - indicates whether we should requeue leftovers.
576 *
577 * Lock status: Assumed that lock is not held upon entry.
578 *
e91442b6 579 * Returns: cmd if requeue required, NULL otherwise.
1da177e4
LT
580 *
581 * Notes: This is called for block device requests in order to
582 * mark some number of sectors as complete.
583 *
584 * We are guaranteeing that the request queue will be goosed
585 * at some point during this call.
e91442b6 586 * Notes: If cmd was requeued, upon return it will be a stale pointer.
1da177e4
LT
587 */
588static struct scsi_cmnd *scsi_end_request(struct scsi_cmnd *cmd, int uptodate,
589 int bytes, int requeue)
590{
591 request_queue_t *q = cmd->device->request_queue;
592 struct request *req = cmd->request;
593 unsigned long flags;
594
595 /*
596 * If there are blocks left over at the end, set up the command
597 * to queue the remainder of them.
598 */
599 if (end_that_request_chunk(req, uptodate, bytes)) {
600 int leftover = (req->hard_nr_sectors << 9);
601
602 if (blk_pc_request(req))
603 leftover = req->data_len;
604
605 /* kill remainder if no retrys */
606 if (!uptodate && blk_noretry_request(req))
607 end_that_request_chunk(req, 0, leftover);
608 else {
e91442b6 609 if (requeue) {
1da177e4
LT
610 /*
611 * Bleah. Leftovers again. Stick the
612 * leftovers in the front of the
613 * queue, and goose the queue again.
614 */
615 scsi_requeue_command(q, cmd);
e91442b6
JB
616 cmd = NULL;
617 }
1da177e4
LT
618 return cmd;
619 }
620 }
621
622 add_disk_randomness(req->rq_disk);
623
624 spin_lock_irqsave(q->queue_lock, flags);
625 if (blk_rq_tagged(req))
626 blk_queue_end_tag(q, req);
627 end_that_request_last(req);
628 spin_unlock_irqrestore(q->queue_lock, flags);
629
630 /*
631 * This will goose the queue request function at the end, so we don't
632 * need to worry about launching another command.
633 */
634 scsi_next_command(cmd);
635 return NULL;
636}
637
c53033f6 638static struct scatterlist *scsi_alloc_sgtable(struct scsi_cmnd *cmd, gfp_t gfp_mask)
1da177e4
LT
639{
640 struct scsi_host_sg_pool *sgp;
641 struct scatterlist *sgl;
642
643 BUG_ON(!cmd->use_sg);
644
645 switch (cmd->use_sg) {
646 case 1 ... 8:
647 cmd->sglist_len = 0;
648 break;
649 case 9 ... 16:
650 cmd->sglist_len = 1;
651 break;
652 case 17 ... 32:
653 cmd->sglist_len = 2;
654 break;
655#if (SCSI_MAX_PHYS_SEGMENTS > 32)
656 case 33 ... 64:
657 cmd->sglist_len = 3;
658 break;
659#if (SCSI_MAX_PHYS_SEGMENTS > 64)
660 case 65 ... 128:
661 cmd->sglist_len = 4;
662 break;
663#if (SCSI_MAX_PHYS_SEGMENTS > 128)
664 case 129 ... 256:
665 cmd->sglist_len = 5;
666 break;
667#endif
668#endif
669#endif
670 default:
671 return NULL;
672 }
673
674 sgp = scsi_sg_pools + cmd->sglist_len;
675 sgl = mempool_alloc(sgp->pool, gfp_mask);
1da177e4
LT
676 return sgl;
677}
678
679static void scsi_free_sgtable(struct scatterlist *sgl, int index)
680{
681 struct scsi_host_sg_pool *sgp;
682
a77e3362 683 BUG_ON(index >= SG_MEMPOOL_NR);
1da177e4
LT
684
685 sgp = scsi_sg_pools + index;
686 mempool_free(sgl, sgp->pool);
687}
688
689/*
690 * Function: scsi_release_buffers()
691 *
692 * Purpose: Completion processing for block device I/O requests.
693 *
694 * Arguments: cmd - command that we are bailing.
695 *
696 * Lock status: Assumed that no lock is held upon entry.
697 *
698 * Returns: Nothing
699 *
700 * Notes: In the event that an upper level driver rejects a
701 * command, we must release resources allocated during
702 * the __init_io() function. Primarily this would involve
703 * the scatter-gather table, and potentially any bounce
704 * buffers.
705 */
706static void scsi_release_buffers(struct scsi_cmnd *cmd)
707{
708 struct request *req = cmd->request;
709
710 /*
711 * Free up any indirection buffers we allocated for DMA purposes.
712 */
713 if (cmd->use_sg)
714 scsi_free_sgtable(cmd->request_buffer, cmd->sglist_len);
715 else if (cmd->request_buffer != req->buffer)
716 kfree(cmd->request_buffer);
717
718 /*
719 * Zero these out. They now point to freed memory, and it is
720 * dangerous to hang onto the pointers.
721 */
722 cmd->buffer = NULL;
723 cmd->bufflen = 0;
724 cmd->request_buffer = NULL;
725 cmd->request_bufflen = 0;
726}
727
728/*
729 * Function: scsi_io_completion()
730 *
731 * Purpose: Completion processing for block device I/O requests.
732 *
733 * Arguments: cmd - command that is finished.
734 *
735 * Lock status: Assumed that no lock is held upon entry.
736 *
737 * Returns: Nothing
738 *
739 * Notes: This function is matched in terms of capabilities to
740 * the function that created the scatter-gather list.
741 * In other words, if there are no bounce buffers
742 * (the normal case for most drivers), we don't need
743 * the logic to deal with cleaning up afterwards.
744 *
745 * We must do one of several things here:
746 *
747 * a) Call scsi_end_request. This will finish off the
748 * specified number of sectors. If we are done, the
749 * command block will be released, and the queue
750 * function will be goosed. If we are not done, then
751 * scsi_end_request will directly goose the queue.
752 *
753 * b) We can just use scsi_requeue_command() here. This would
754 * be used if we just wanted to retry, for example.
755 */
756void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes,
757 unsigned int block_bytes)
758{
759 int result = cmd->result;
760 int this_count = cmd->bufflen;
761 request_queue_t *q = cmd->device->request_queue;
762 struct request *req = cmd->request;
763 int clear_errors = 1;
764 struct scsi_sense_hdr sshdr;
765 int sense_valid = 0;
766 int sense_deferred = 0;
767
768 if (blk_complete_barrier_rq(q, req, good_bytes >> 9))
769 return;
770
771 /*
772 * Free up any indirection buffers we allocated for DMA purposes.
773 * For the case of a READ, we need to copy the data out of the
774 * bounce buffer and into the real buffer.
775 */
776 if (cmd->use_sg)
777 scsi_free_sgtable(cmd->buffer, cmd->sglist_len);
778 else if (cmd->buffer != req->buffer) {
779 if (rq_data_dir(req) == READ) {
780 unsigned long flags;
781 char *to = bio_kmap_irq(req->bio, &flags);
782 memcpy(to, cmd->buffer, cmd->bufflen);
783 bio_kunmap_irq(to, &flags);
784 }
785 kfree(cmd->buffer);
786 }
787
788 if (result) {
789 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
790 if (sense_valid)
791 sense_deferred = scsi_sense_is_deferred(&sshdr);
792 }
793 if (blk_pc_request(req)) { /* SG_IO ioctl from block level */
794 req->errors = result;
795 if (result) {
796 clear_errors = 0;
797 if (sense_valid && req->sense) {
798 /*
799 * SG_IO wants current and deferred errors
800 */
801 int len = 8 + cmd->sense_buffer[7];
802
803 if (len > SCSI_SENSE_BUFFERSIZE)
804 len = SCSI_SENSE_BUFFERSIZE;
805 memcpy(req->sense, cmd->sense_buffer, len);
806 req->sense_len = len;
807 }
808 } else
809 req->data_len = cmd->resid;
810 }
811
812 /*
813 * Zero these out. They now point to freed memory, and it is
814 * dangerous to hang onto the pointers.
815 */
816 cmd->buffer = NULL;
817 cmd->bufflen = 0;
818 cmd->request_buffer = NULL;
819 cmd->request_bufflen = 0;
820
821 /*
822 * Next deal with any sectors which we were able to correctly
823 * handle.
824 */
825 if (good_bytes >= 0) {
826 SCSI_LOG_HLCOMPLETE(1, printk("%ld sectors total, %d bytes done.\n",
827 req->nr_sectors, good_bytes));
828 SCSI_LOG_HLCOMPLETE(1, printk("use_sg is %d\n", cmd->use_sg));
829
830 if (clear_errors)
831 req->errors = 0;
832 /*
833 * If multiple sectors are requested in one buffer, then
834 * they will have been finished off by the first command.
835 * If not, then we have a multi-buffer command.
836 *
837 * If block_bytes != 0, it means we had a medium error
838 * of some sort, and that we want to mark some number of
839 * sectors as not uptodate. Thus we want to inhibit
840 * requeueing right here - we will requeue down below
841 * when we handle the bad sectors.
842 */
1da177e4
LT
843
844 /*
e91442b6
JB
845 * If the command completed without error, then either
846 * finish off the rest of the command, or start a new one.
1da177e4 847 */
e91442b6 848 if (scsi_end_request(cmd, 1, good_bytes, result == 0) == NULL)
1da177e4 849 return;
1da177e4
LT
850 }
851 /*
852 * Now, if we were good little boys and girls, Santa left us a request
853 * sense buffer. We can extract information from this, so we
854 * can choose a block to remap, etc.
855 */
856 if (sense_valid && !sense_deferred) {
857 switch (sshdr.sense_key) {
858 case UNIT_ATTENTION:
859 if (cmd->device->removable) {
860 /* detected disc change. set a bit
861 * and quietly refuse further access.
862 */
863 cmd->device->changed = 1;
e91442b6 864 scsi_end_request(cmd, 0,
1da177e4
LT
865 this_count, 1);
866 return;
867 } else {
868 /*
869 * Must have been a power glitch, or a
870 * bus reset. Could not have been a
871 * media change, so we just retry the
872 * request and see what happens.
873 */
874 scsi_requeue_command(q, cmd);
875 return;
876 }
877 break;
878 case ILLEGAL_REQUEST:
879 /*
880 * If we had an ILLEGAL REQUEST returned, then we may
881 * have performed an unsupported command. The only
882 * thing this should be would be a ten byte read where
883 * only a six byte read was supported. Also, on a
884 * system where READ CAPACITY failed, we may have read
885 * past the end of the disk.
886 */
887 if (cmd->device->use_10_for_rw &&
888 (cmd->cmnd[0] == READ_10 ||
889 cmd->cmnd[0] == WRITE_10)) {
890 cmd->device->use_10_for_rw = 0;
891 /*
892 * This will cause a retry with a 6-byte
893 * command.
894 */
895 scsi_requeue_command(q, cmd);
896 result = 0;
897 } else {
e91442b6 898 scsi_end_request(cmd, 0, this_count, 1);
1da177e4
LT
899 return;
900 }
901 break;
902 case NOT_READY:
903 /*
904 * If the device is in the process of becoming ready,
905 * retry.
906 */
907 if (sshdr.asc == 0x04 && sshdr.ascq == 0x01) {
908 scsi_requeue_command(q, cmd);
909 return;
910 }
3173d8c3 911 if (!(req->flags & REQ_QUIET))
3bf743e7
JG
912 scmd_printk(KERN_INFO, cmd,
913 "Device not ready.\n");
e91442b6 914 scsi_end_request(cmd, 0, this_count, 1);
1da177e4
LT
915 return;
916 case VOLUME_OVERFLOW:
3173d8c3 917 if (!(req->flags & REQ_QUIET)) {
3bf743e7
JG
918 scmd_printk(KERN_INFO, cmd,
919 "Volume overflow, CDB: ");
3173d8c3
JB
920 __scsi_print_command(cmd->data_cmnd);
921 scsi_print_sense("", cmd);
922 }
e91442b6 923 scsi_end_request(cmd, 0, block_bytes, 1);
1da177e4
LT
924 return;
925 default:
926 break;
927 }
928 } /* driver byte != 0 */
929 if (host_byte(result) == DID_RESET) {
930 /*
931 * Third party bus reset or reset for error
932 * recovery reasons. Just retry the request
933 * and see what happens.
934 */
935 scsi_requeue_command(q, cmd);
936 return;
937 }
938 if (result) {
3173d8c3 939 if (!(req->flags & REQ_QUIET)) {
3bf743e7
JG
940 scmd_printk(KERN_INFO, cmd,
941 "SCSI error: return code = 0x%x\n", result);
3173d8c3
JB
942
943 if (driver_byte(result) & DRIVER_SENSE)
944 scsi_print_sense("", cmd);
945 }
1da177e4
LT
946 /*
947 * Mark a single buffer as not uptodate. Queue the remainder.
948 * We sometimes get this cruft in the event that a medium error
949 * isn't properly reported.
950 */
951 block_bytes = req->hard_cur_sectors << 9;
952 if (!block_bytes)
953 block_bytes = req->data_len;
e91442b6 954 scsi_end_request(cmd, 0, block_bytes, 1);
1da177e4
LT
955 }
956}
957EXPORT_SYMBOL(scsi_io_completion);
958
959/*
960 * Function: scsi_init_io()
961 *
962 * Purpose: SCSI I/O initialize function.
963 *
964 * Arguments: cmd - Command descriptor we wish to initialize
965 *
966 * Returns: 0 on success
967 * BLKPREP_DEFER if the failure is retryable
968 * BLKPREP_KILL if the failure is fatal
969 */
970static int scsi_init_io(struct scsi_cmnd *cmd)
971{
972 struct request *req = cmd->request;
973 struct scatterlist *sgpnt;
974 int count;
975
976 /*
977 * if this is a rq->data based REQ_BLOCK_PC, setup for a non-sg xfer
978 */
979 if ((req->flags & REQ_BLOCK_PC) && !req->bio) {
980 cmd->request_bufflen = req->data_len;
981 cmd->request_buffer = req->data;
982 req->buffer = req->data;
983 cmd->use_sg = 0;
984 return 0;
985 }
986
987 /*
988 * we used to not use scatter-gather for single segment request,
989 * but now we do (it makes highmem I/O easier to support without
990 * kmapping pages)
991 */
992 cmd->use_sg = req->nr_phys_segments;
993
994 /*
995 * if sg table allocation fails, requeue request later.
996 */
997 sgpnt = scsi_alloc_sgtable(cmd, GFP_ATOMIC);
7c72ce81
AS
998 if (unlikely(!sgpnt)) {
999 scsi_unprep_request(req);
1da177e4 1000 return BLKPREP_DEFER;
7c72ce81 1001 }
1da177e4
LT
1002
1003 cmd->request_buffer = (char *) sgpnt;
1004 cmd->request_bufflen = req->nr_sectors << 9;
1005 if (blk_pc_request(req))
1006 cmd->request_bufflen = req->data_len;
1007 req->buffer = NULL;
1008
1009 /*
1010 * Next, walk the list, and fill in the addresses and sizes of
1011 * each segment.
1012 */
1013 count = blk_rq_map_sg(req->q, req, cmd->request_buffer);
1014
1015 /*
1016 * mapped well, send it off
1017 */
1018 if (likely(count <= cmd->use_sg)) {
1019 cmd->use_sg = count;
1020 return 0;
1021 }
1022
1023 printk(KERN_ERR "Incorrect number of segments after building list\n");
1024 printk(KERN_ERR "counted %d, received %d\n", count, cmd->use_sg);
1025 printk(KERN_ERR "req nr_sec %lu, cur_nr_sec %u\n", req->nr_sectors,
1026 req->current_nr_sectors);
1027
1028 /* release the command and kill it */
1029 scsi_release_buffers(cmd);
1030 scsi_put_command(cmd);
1031 return BLKPREP_KILL;
1032}
1033
1034static int scsi_prepare_flush_fn(request_queue_t *q, struct request *rq)
1035{
1036 struct scsi_device *sdev = q->queuedata;
1037 struct scsi_driver *drv;
1038
1039 if (sdev->sdev_state == SDEV_RUNNING) {
1040 drv = *(struct scsi_driver **) rq->rq_disk->private_data;
1041
1042 if (drv->prepare_flush)
1043 return drv->prepare_flush(q, rq);
1044 }
1045
1046 return 0;
1047}
1048
1049static void scsi_end_flush_fn(request_queue_t *q, struct request *rq)
1050{
1051 struct scsi_device *sdev = q->queuedata;
1052 struct request *flush_rq = rq->end_io_data;
1053 struct scsi_driver *drv;
1054
1055 if (flush_rq->errors) {
1056 printk("scsi: barrier error, disabling flush support\n");
1057 blk_queue_ordered(q, QUEUE_ORDERED_NONE);
1058 }
1059
1060 if (sdev->sdev_state == SDEV_RUNNING) {
1061 drv = *(struct scsi_driver **) rq->rq_disk->private_data;
1062 drv->end_flush(q, rq);
1063 }
1064}
1065
1066static int scsi_issue_flush_fn(request_queue_t *q, struct gendisk *disk,
1067 sector_t *error_sector)
1068{
1069 struct scsi_device *sdev = q->queuedata;
1070 struct scsi_driver *drv;
1071
1072 if (sdev->sdev_state != SDEV_RUNNING)
1073 return -ENXIO;
1074
1075 drv = *(struct scsi_driver **) disk->private_data;
1076 if (drv->issue_flush)
1077 return drv->issue_flush(&sdev->sdev_gendev, error_sector);
1078
1079 return -EOPNOTSUPP;
1080}
1081
e537a36d
JB
1082static void scsi_generic_done(struct scsi_cmnd *cmd)
1083{
1084 BUG_ON(!blk_pc_request(cmd->request));
1085 scsi_io_completion(cmd, cmd->result == 0 ? cmd->bufflen : 0, 0);
1086}
1087
1da177e4
LT
1088static int scsi_prep_fn(struct request_queue *q, struct request *req)
1089{
1090 struct scsi_device *sdev = q->queuedata;
1091 struct scsi_cmnd *cmd;
1092 int specials_only = 0;
1093
1094 /*
1095 * Just check to see if the device is online. If it isn't, we
1096 * refuse to process any commands. The device must be brought
1097 * online before trying any recovery commands
1098 */
1099 if (unlikely(!scsi_device_online(sdev))) {
9ccfc756
JB
1100 sdev_printk(KERN_ERR, sdev,
1101 "rejecting I/O to offline device\n");
6f16b535 1102 goto kill;
1da177e4
LT
1103 }
1104 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
1105 /* OK, we're not in a running state don't prep
1106 * user commands */
1107 if (sdev->sdev_state == SDEV_DEL) {
1108 /* Device is fully deleted, no commands
1109 * at all allowed down */
9ccfc756
JB
1110 sdev_printk(KERN_ERR, sdev,
1111 "rejecting I/O to dead device\n");
6f16b535 1112 goto kill;
1da177e4
LT
1113 }
1114 /* OK, we only allow special commands (i.e. not
1115 * user initiated ones */
1116 specials_only = sdev->sdev_state;
1117 }
1118
1119 /*
1120 * Find the actual device driver associated with this command.
1121 * The SPECIAL requests are things like character device or
1122 * ioctls, which did not originate from ll_rw_blk. Note that
1123 * the special field is also used to indicate the cmd for
1124 * the remainder of a partially fulfilled request that can
1125 * come up when there is a medium error. We have to treat
1126 * these two cases differently. We differentiate by looking
1127 * at request->cmd, as this tells us the real story.
1128 */
e537a36d 1129 if (req->flags & REQ_SPECIAL && req->special) {
1da177e4
LT
1130 struct scsi_request *sreq = req->special;
1131
1132 if (sreq->sr_magic == SCSI_REQ_MAGIC) {
1133 cmd = scsi_get_command(sreq->sr_device, GFP_ATOMIC);
1134 if (unlikely(!cmd))
1135 goto defer;
1136 scsi_init_cmd_from_req(cmd, sreq);
1137 } else
1138 cmd = req->special;
1139 } else if (req->flags & (REQ_CMD | REQ_BLOCK_PC)) {
1140
e537a36d 1141 if(unlikely(specials_only) && !(req->flags & REQ_SPECIAL)) {
1da177e4
LT
1142 if(specials_only == SDEV_QUIESCE ||
1143 specials_only == SDEV_BLOCK)
6f16b535 1144 goto defer;
1da177e4 1145
9ccfc756
JB
1146 sdev_printk(KERN_ERR, sdev,
1147 "rejecting I/O to device being removed\n");
6f16b535 1148 goto kill;
1da177e4
LT
1149 }
1150
1151
1152 /*
1153 * Now try and find a command block that we can use.
1154 */
1155 if (!req->special) {
1156 cmd = scsi_get_command(sdev, GFP_ATOMIC);
1157 if (unlikely(!cmd))
1158 goto defer;
1159 } else
1160 cmd = req->special;
1161
1162 /* pull a tag out of the request if we have one */
1163 cmd->tag = req->tag;
1164 } else {
1165 blk_dump_rq_flags(req, "SCSI bad req");
6f16b535 1166 goto kill;
1da177e4
LT
1167 }
1168
1169 /* note the overloading of req->special. When the tag
1170 * is active it always means cmd. If the tag goes
1171 * back for re-queueing, it may be reset */
1172 req->special = cmd;
1173 cmd->request = req;
1174
1175 /*
1176 * FIXME: drop the lock here because the functions below
1177 * expect to be called without the queue lock held. Also,
1178 * previously, we dequeued the request before dropping the
1179 * lock. We hope REQ_STARTED prevents anything untoward from
1180 * happening now.
1181 */
1182 if (req->flags & (REQ_CMD | REQ_BLOCK_PC)) {
1183 struct scsi_driver *drv;
1184 int ret;
1185
1186 /*
1187 * This will do a couple of things:
1188 * 1) Fill in the actual SCSI command.
1189 * 2) Fill in any other upper-level specific fields
1190 * (timeout).
1191 *
1192 * If this returns 0, it means that the request failed
1193 * (reading past end of disk, reading offline device,
1194 * etc). This won't actually talk to the device, but
1195 * some kinds of consistency checking may cause the
1196 * request to be rejected immediately.
1197 */
1198
1199 /*
1200 * This sets up the scatter-gather table (allocating if
1201 * required).
1202 */
1203 ret = scsi_init_io(cmd);
6f16b535 1204 switch(ret) {
7c72ce81 1205 /* For BLKPREP_KILL/DEFER the cmd was released */
6f16b535 1206 case BLKPREP_KILL:
6f16b535
MC
1207 goto kill;
1208 case BLKPREP_DEFER:
1209 goto defer;
1210 }
1da177e4
LT
1211
1212 /*
1213 * Initialize the actual SCSI command for this request.
1214 */
e537a36d
JB
1215 if (req->rq_disk) {
1216 drv = *(struct scsi_driver **)req->rq_disk->private_data;
1217 if (unlikely(!drv->init_command(cmd))) {
1218 scsi_release_buffers(cmd);
1219 scsi_put_command(cmd);
6f16b535 1220 goto kill;
e537a36d
JB
1221 }
1222 } else {
1223 memcpy(cmd->cmnd, req->cmd, sizeof(cmd->cmnd));
186d330e 1224 cmd->cmd_len = req->cmd_len;
e537a36d
JB
1225 if (rq_data_dir(req) == WRITE)
1226 cmd->sc_data_direction = DMA_TO_DEVICE;
1227 else if (req->data_len)
1228 cmd->sc_data_direction = DMA_FROM_DEVICE;
1229 else
1230 cmd->sc_data_direction = DMA_NONE;
1231
1232 cmd->transfersize = req->data_len;
1233 cmd->allowed = 3;
1234 cmd->timeout_per_command = req->timeout;
1235 cmd->done = scsi_generic_done;
1da177e4
LT
1236 }
1237 }
1238
1239 /*
1240 * The request is now prepped, no need to come back here
1241 */
1242 req->flags |= REQ_DONTPREP;
1243 return BLKPREP_OK;
1244
1245 defer:
1246 /* If we defer, the elv_next_request() returns NULL, but the
1247 * queue must be restarted, so we plug here if no returning
1248 * command will automatically do that. */
1249 if (sdev->device_busy == 0)
1250 blk_plug_device(q);
1251 return BLKPREP_DEFER;
6f16b535
MC
1252 kill:
1253 req->errors = DID_NO_CONNECT << 16;
1254 return BLKPREP_KILL;
1da177e4
LT
1255}
1256
1257/*
1258 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1259 * return 0.
1260 *
1261 * Called with the queue_lock held.
1262 */
1263static inline int scsi_dev_queue_ready(struct request_queue *q,
1264 struct scsi_device *sdev)
1265{
1266 if (sdev->device_busy >= sdev->queue_depth)
1267 return 0;
1268 if (sdev->device_busy == 0 && sdev->device_blocked) {
1269 /*
1270 * unblock after device_blocked iterates to zero
1271 */
1272 if (--sdev->device_blocked == 0) {
1273 SCSI_LOG_MLQUEUE(3,
9ccfc756
JB
1274 sdev_printk(KERN_INFO, sdev,
1275 "unblocking device at zero depth\n"));
1da177e4
LT
1276 } else {
1277 blk_plug_device(q);
1278 return 0;
1279 }
1280 }
1281 if (sdev->device_blocked)
1282 return 0;
1283
1284 return 1;
1285}
1286
1287/*
1288 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1289 * return 0. We must end up running the queue again whenever 0 is
1290 * returned, else IO can hang.
1291 *
1292 * Called with host_lock held.
1293 */
1294static inline int scsi_host_queue_ready(struct request_queue *q,
1295 struct Scsi_Host *shost,
1296 struct scsi_device *sdev)
1297{
939647ee 1298 if (scsi_host_in_recovery(shost))
1da177e4
LT
1299 return 0;
1300 if (shost->host_busy == 0 && shost->host_blocked) {
1301 /*
1302 * unblock after host_blocked iterates to zero
1303 */
1304 if (--shost->host_blocked == 0) {
1305 SCSI_LOG_MLQUEUE(3,
1306 printk("scsi%d unblocking host at zero depth\n",
1307 shost->host_no));
1308 } else {
1309 blk_plug_device(q);
1310 return 0;
1311 }
1312 }
1313 if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
1314 shost->host_blocked || shost->host_self_blocked) {
1315 if (list_empty(&sdev->starved_entry))
1316 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1317 return 0;
1318 }
1319
1320 /* We're OK to process the command, so we can't be starved */
1321 if (!list_empty(&sdev->starved_entry))
1322 list_del_init(&sdev->starved_entry);
1323
1324 return 1;
1325}
1326
1327/*
e91442b6 1328 * Kill a request for a dead device
1da177e4 1329 */
e91442b6 1330static void scsi_kill_request(struct request *req, request_queue_t *q)
1da177e4 1331{
e91442b6 1332 struct scsi_cmnd *cmd = req->special;
1da177e4 1333
788ce43a
JB
1334 blkdev_dequeue_request(req);
1335
e91442b6
JB
1336 if (unlikely(cmd == NULL)) {
1337 printk(KERN_CRIT "impossible request in %s.\n",
1338 __FUNCTION__);
1339 BUG();
1da177e4 1340 }
e91442b6
JB
1341
1342 scsi_init_cmd_errh(cmd);
1343 cmd->result = DID_NO_CONNECT << 16;
1344 atomic_inc(&cmd->device->iorequest_cnt);
1345 __scsi_done(cmd);
1da177e4
LT
1346}
1347
1348/*
1349 * Function: scsi_request_fn()
1350 *
1351 * Purpose: Main strategy routine for SCSI.
1352 *
1353 * Arguments: q - Pointer to actual queue.
1354 *
1355 * Returns: Nothing
1356 *
1357 * Lock status: IO request lock assumed to be held when called.
1358 */
1359static void scsi_request_fn(struct request_queue *q)
1360{
1361 struct scsi_device *sdev = q->queuedata;
1362 struct Scsi_Host *shost;
1363 struct scsi_cmnd *cmd;
1364 struct request *req;
1365
1366 if (!sdev) {
1367 printk("scsi: killing requests for dead queue\n");
e91442b6
JB
1368 while ((req = elv_next_request(q)) != NULL)
1369 scsi_kill_request(req, q);
1da177e4
LT
1370 return;
1371 }
1372
1373 if(!get_device(&sdev->sdev_gendev))
1374 /* We must be tearing the block queue down already */
1375 return;
1376
1377 /*
1378 * To start with, we keep looping until the queue is empty, or until
1379 * the host is no longer able to accept any more requests.
1380 */
1381 shost = sdev->host;
1382 while (!blk_queue_plugged(q)) {
1383 int rtn;
1384 /*
1385 * get next queueable request. We do this early to make sure
1386 * that the request is fully prepared even if we cannot
1387 * accept it.
1388 */
1389 req = elv_next_request(q);
1390 if (!req || !scsi_dev_queue_ready(q, sdev))
1391 break;
1392
1393 if (unlikely(!scsi_device_online(sdev))) {
9ccfc756
JB
1394 sdev_printk(KERN_ERR, sdev,
1395 "rejecting I/O to offline device\n");
e91442b6 1396 scsi_kill_request(req, q);
1da177e4
LT
1397 continue;
1398 }
1399
1400
1401 /*
1402 * Remove the request from the request list.
1403 */
1404 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
1405 blkdev_dequeue_request(req);
1406 sdev->device_busy++;
1407
1408 spin_unlock(q->queue_lock);
e91442b6
JB
1409 cmd = req->special;
1410 if (unlikely(cmd == NULL)) {
1411 printk(KERN_CRIT "impossible request in %s.\n"
1412 "please mail a stack trace to "
1413 "linux-scsi@vger.kernel.org",
1414 __FUNCTION__);
1415 BUG();
1416 }
1da177e4
LT
1417 spin_lock(shost->host_lock);
1418
1419 if (!scsi_host_queue_ready(q, shost, sdev))
1420 goto not_ready;
1421 if (sdev->single_lun) {
1422 if (scsi_target(sdev)->starget_sdev_user &&
1423 scsi_target(sdev)->starget_sdev_user != sdev)
1424 goto not_ready;
1425 scsi_target(sdev)->starget_sdev_user = sdev;
1426 }
1427 shost->host_busy++;
1428
1429 /*
1430 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1431 * take the lock again.
1432 */
1433 spin_unlock_irq(shost->host_lock);
1434
1da177e4
LT
1435 /*
1436 * Finally, initialize any error handling parameters, and set up
1437 * the timers for timeouts.
1438 */
1439 scsi_init_cmd_errh(cmd);
1440
1441 /*
1442 * Dispatch the command to the low-level driver.
1443 */
1444 rtn = scsi_dispatch_cmd(cmd);
1445 spin_lock_irq(q->queue_lock);
1446 if(rtn) {
1447 /* we're refusing the command; because of
1448 * the way locks get dropped, we need to
1449 * check here if plugging is required */
1450 if(sdev->device_busy == 0)
1451 blk_plug_device(q);
1452
1453 break;
1454 }
1455 }
1456
1457 goto out;
1458
1459 not_ready:
1460 spin_unlock_irq(shost->host_lock);
1461
1462 /*
1463 * lock q, handle tag, requeue req, and decrement device_busy. We
1464 * must return with queue_lock held.
1465 *
1466 * Decrementing device_busy without checking it is OK, as all such
1467 * cases (host limits or settings) should run the queue at some
1468 * later time.
1469 */
1470 spin_lock_irq(q->queue_lock);
1471 blk_requeue_request(q, req);
1472 sdev->device_busy--;
1473 if(sdev->device_busy == 0)
1474 blk_plug_device(q);
1475 out:
1476 /* must be careful here...if we trigger the ->remove() function
1477 * we cannot be holding the q lock */
1478 spin_unlock_irq(q->queue_lock);
1479 put_device(&sdev->sdev_gendev);
1480 spin_lock_irq(q->queue_lock);
1481}
1482
1483u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
1484{
1485 struct device *host_dev;
1486 u64 bounce_limit = 0xffffffff;
1487
1488 if (shost->unchecked_isa_dma)
1489 return BLK_BOUNCE_ISA;
1490 /*
1491 * Platforms with virtual-DMA translation
1492 * hardware have no practical limit.
1493 */
1494 if (!PCI_DMA_BUS_IS_PHYS)
1495 return BLK_BOUNCE_ANY;
1496
1497 host_dev = scsi_get_device(shost);
1498 if (host_dev && host_dev->dma_mask)
1499 bounce_limit = *host_dev->dma_mask;
1500
1501 return bounce_limit;
1502}
1503EXPORT_SYMBOL(scsi_calculate_bounce_limit);
1504
1505struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
1506{
1507 struct Scsi_Host *shost = sdev->host;
1508 struct request_queue *q;
1509
152587de 1510 q = blk_init_queue(scsi_request_fn, NULL);
1da177e4
LT
1511 if (!q)
1512 return NULL;
1513
1514 blk_queue_prep_rq(q, scsi_prep_fn);
1515
1516 blk_queue_max_hw_segments(q, shost->sg_tablesize);
1517 blk_queue_max_phys_segments(q, SCSI_MAX_PHYS_SEGMENTS);
1518 blk_queue_max_sectors(q, shost->max_sectors);
1519 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
1520 blk_queue_segment_boundary(q, shost->dma_boundary);
1521 blk_queue_issue_flush_fn(q, scsi_issue_flush_fn);
1522
1523 /*
1524 * ordered tags are superior to flush ordering
1525 */
1526 if (shost->ordered_tag)
1527 blk_queue_ordered(q, QUEUE_ORDERED_TAG);
1528 else if (shost->ordered_flush) {
1529 blk_queue_ordered(q, QUEUE_ORDERED_FLUSH);
1530 q->prepare_flush_fn = scsi_prepare_flush_fn;
1531 q->end_flush_fn = scsi_end_flush_fn;
1532 }
1533
1534 if (!shost->use_clustering)
1535 clear_bit(QUEUE_FLAG_CLUSTER, &q->queue_flags);
1536 return q;
1537}
1538
1539void scsi_free_queue(struct request_queue *q)
1540{
1541 blk_cleanup_queue(q);
1542}
1543
1544/*
1545 * Function: scsi_block_requests()
1546 *
1547 * Purpose: Utility function used by low-level drivers to prevent further
1548 * commands from being queued to the device.
1549 *
1550 * Arguments: shost - Host in question
1551 *
1552 * Returns: Nothing
1553 *
1554 * Lock status: No locks are assumed held.
1555 *
1556 * Notes: There is no timer nor any other means by which the requests
1557 * get unblocked other than the low-level driver calling
1558 * scsi_unblock_requests().
1559 */
1560void scsi_block_requests(struct Scsi_Host *shost)
1561{
1562 shost->host_self_blocked = 1;
1563}
1564EXPORT_SYMBOL(scsi_block_requests);
1565
1566/*
1567 * Function: scsi_unblock_requests()
1568 *
1569 * Purpose: Utility function used by low-level drivers to allow further
1570 * commands from being queued to the device.
1571 *
1572 * Arguments: shost - Host in question
1573 *
1574 * Returns: Nothing
1575 *
1576 * Lock status: No locks are assumed held.
1577 *
1578 * Notes: There is no timer nor any other means by which the requests
1579 * get unblocked other than the low-level driver calling
1580 * scsi_unblock_requests().
1581 *
1582 * This is done as an API function so that changes to the
1583 * internals of the scsi mid-layer won't require wholesale
1584 * changes to drivers that use this feature.
1585 */
1586void scsi_unblock_requests(struct Scsi_Host *shost)
1587{
1588 shost->host_self_blocked = 0;
1589 scsi_run_host_queues(shost);
1590}
1591EXPORT_SYMBOL(scsi_unblock_requests);
1592
1593int __init scsi_init_queue(void)
1594{
1595 int i;
1596
1597 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1598 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1599 int size = sgp->size * sizeof(struct scatterlist);
1600
1601 sgp->slab = kmem_cache_create(sgp->name, size, 0,
1602 SLAB_HWCACHE_ALIGN, NULL, NULL);
1603 if (!sgp->slab) {
1604 printk(KERN_ERR "SCSI: can't init sg slab %s\n",
1605 sgp->name);
1606 }
1607
1608 sgp->pool = mempool_create(SG_MEMPOOL_SIZE,
1609 mempool_alloc_slab, mempool_free_slab,
1610 sgp->slab);
1611 if (!sgp->pool) {
1612 printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
1613 sgp->name);
1614 }
1615 }
1616
1617 return 0;
1618}
1619
1620void scsi_exit_queue(void)
1621{
1622 int i;
1623
1624 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1625 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1626 mempool_destroy(sgp->pool);
1627 kmem_cache_destroy(sgp->slab);
1628 }
1629}
1630/**
ea73a9f2 1631 * scsi_mode_sense - issue a mode sense, falling back from 10 to
1da177e4 1632 * six bytes if necessary.
1cf72699 1633 * @sdev: SCSI device to be queried
1da177e4
LT
1634 * @dbd: set if mode sense will allow block descriptors to be returned
1635 * @modepage: mode page being requested
1636 * @buffer: request buffer (may not be smaller than eight bytes)
1637 * @len: length of request buffer.
1638 * @timeout: command timeout
1639 * @retries: number of retries before failing
1640 * @data: returns a structure abstracting the mode header data
1cf72699
JB
1641 * @sense: place to put sense data (or NULL if no sense to be collected).
1642 * must be SCSI_SENSE_BUFFERSIZE big.
1da177e4
LT
1643 *
1644 * Returns zero if unsuccessful, or the header offset (either 4
1645 * or 8 depending on whether a six or ten byte command was
1646 * issued) if successful.
1647 **/
1648int
1cf72699 1649scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
1da177e4 1650 unsigned char *buffer, int len, int timeout, int retries,
ea73a9f2 1651 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr) {
1da177e4
LT
1652 unsigned char cmd[12];
1653 int use_10_for_ms;
1654 int header_length;
1cf72699 1655 int result;
ea73a9f2 1656 struct scsi_sense_hdr my_sshdr;
1da177e4
LT
1657
1658 memset(data, 0, sizeof(*data));
1659 memset(&cmd[0], 0, 12);
1660 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
1661 cmd[2] = modepage;
1662
ea73a9f2
JB
1663 /* caller might not be interested in sense, but we need it */
1664 if (!sshdr)
1665 sshdr = &my_sshdr;
1666
1da177e4 1667 retry:
1cf72699 1668 use_10_for_ms = sdev->use_10_for_ms;
1da177e4
LT
1669
1670 if (use_10_for_ms) {
1671 if (len < 8)
1672 len = 8;
1673
1674 cmd[0] = MODE_SENSE_10;
1675 cmd[8] = len;
1676 header_length = 8;
1677 } else {
1678 if (len < 4)
1679 len = 4;
1680
1681 cmd[0] = MODE_SENSE;
1682 cmd[4] = len;
1683 header_length = 4;
1684 }
1685
1da177e4
LT
1686 memset(buffer, 0, len);
1687
1cf72699 1688 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
ea73a9f2 1689 sshdr, timeout, retries);
1da177e4
LT
1690
1691 /* This code looks awful: what it's doing is making sure an
1692 * ILLEGAL REQUEST sense return identifies the actual command
1693 * byte as the problem. MODE_SENSE commands can return
1694 * ILLEGAL REQUEST if the code page isn't supported */
1695
1cf72699
JB
1696 if (use_10_for_ms && !scsi_status_is_good(result) &&
1697 (driver_byte(result) & DRIVER_SENSE)) {
ea73a9f2
JB
1698 if (scsi_sense_valid(sshdr)) {
1699 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
1700 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
1da177e4
LT
1701 /*
1702 * Invalid command operation code
1703 */
1cf72699 1704 sdev->use_10_for_ms = 0;
1da177e4
LT
1705 goto retry;
1706 }
1707 }
1708 }
1709
1cf72699 1710 if(scsi_status_is_good(result)) {
1da177e4
LT
1711 data->header_length = header_length;
1712 if(use_10_for_ms) {
1713 data->length = buffer[0]*256 + buffer[1] + 2;
1714 data->medium_type = buffer[2];
1715 data->device_specific = buffer[3];
1716 data->longlba = buffer[4] & 0x01;
1717 data->block_descriptor_length = buffer[6]*256
1718 + buffer[7];
1719 } else {
1720 data->length = buffer[0] + 1;
1721 data->medium_type = buffer[1];
1722 data->device_specific = buffer[2];
1723 data->block_descriptor_length = buffer[3];
1724 }
1725 }
1726
1cf72699 1727 return result;
1da177e4
LT
1728}
1729EXPORT_SYMBOL(scsi_mode_sense);
1730
1731int
1732scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries)
1733{
1da177e4
LT
1734 char cmd[] = {
1735 TEST_UNIT_READY, 0, 0, 0, 0, 0,
1736 };
ea73a9f2 1737 struct scsi_sense_hdr sshdr;
1da177e4
LT
1738 int result;
1739
ea73a9f2 1740 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, &sshdr,
1cf72699 1741 timeout, retries);
1da177e4 1742
1cf72699 1743 if ((driver_byte(result) & DRIVER_SENSE) && sdev->removable) {
1da177e4 1744
ea73a9f2 1745 if ((scsi_sense_valid(&sshdr)) &&
1da177e4
LT
1746 ((sshdr.sense_key == UNIT_ATTENTION) ||
1747 (sshdr.sense_key == NOT_READY))) {
1748 sdev->changed = 1;
1cf72699 1749 result = 0;
1da177e4
LT
1750 }
1751 }
1da177e4
LT
1752 return result;
1753}
1754EXPORT_SYMBOL(scsi_test_unit_ready);
1755
1756/**
1757 * scsi_device_set_state - Take the given device through the device
1758 * state model.
1759 * @sdev: scsi device to change the state of.
1760 * @state: state to change to.
1761 *
1762 * Returns zero if unsuccessful or an error if the requested
1763 * transition is illegal.
1764 **/
1765int
1766scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
1767{
1768 enum scsi_device_state oldstate = sdev->sdev_state;
1769
1770 if (state == oldstate)
1771 return 0;
1772
1773 switch (state) {
1774 case SDEV_CREATED:
1775 /* There are no legal states that come back to
1776 * created. This is the manually initialised start
1777 * state */
1778 goto illegal;
1779
1780 case SDEV_RUNNING:
1781 switch (oldstate) {
1782 case SDEV_CREATED:
1783 case SDEV_OFFLINE:
1784 case SDEV_QUIESCE:
1785 case SDEV_BLOCK:
1786 break;
1787 default:
1788 goto illegal;
1789 }
1790 break;
1791
1792 case SDEV_QUIESCE:
1793 switch (oldstate) {
1794 case SDEV_RUNNING:
1795 case SDEV_OFFLINE:
1796 break;
1797 default:
1798 goto illegal;
1799 }
1800 break;
1801
1802 case SDEV_OFFLINE:
1803 switch (oldstate) {
1804 case SDEV_CREATED:
1805 case SDEV_RUNNING:
1806 case SDEV_QUIESCE:
1807 case SDEV_BLOCK:
1808 break;
1809 default:
1810 goto illegal;
1811 }
1812 break;
1813
1814 case SDEV_BLOCK:
1815 switch (oldstate) {
1816 case SDEV_CREATED:
1817 case SDEV_RUNNING:
1818 break;
1819 default:
1820 goto illegal;
1821 }
1822 break;
1823
1824 case SDEV_CANCEL:
1825 switch (oldstate) {
1826 case SDEV_CREATED:
1827 case SDEV_RUNNING:
1828 case SDEV_OFFLINE:
1829 case SDEV_BLOCK:
1830 break;
1831 default:
1832 goto illegal;
1833 }
1834 break;
1835
1836 case SDEV_DEL:
1837 switch (oldstate) {
1838 case SDEV_CANCEL:
1839 break;
1840 default:
1841 goto illegal;
1842 }
1843 break;
1844
1845 }
1846 sdev->sdev_state = state;
1847 return 0;
1848
1849 illegal:
1850 SCSI_LOG_ERROR_RECOVERY(1,
9ccfc756
JB
1851 sdev_printk(KERN_ERR, sdev,
1852 "Illegal state transition %s->%s\n",
1853 scsi_device_state_name(oldstate),
1854 scsi_device_state_name(state))
1da177e4
LT
1855 );
1856 return -EINVAL;
1857}
1858EXPORT_SYMBOL(scsi_device_set_state);
1859
1860/**
1861 * scsi_device_quiesce - Block user issued commands.
1862 * @sdev: scsi device to quiesce.
1863 *
1864 * This works by trying to transition to the SDEV_QUIESCE state
1865 * (which must be a legal transition). When the device is in this
1866 * state, only special requests will be accepted, all others will
1867 * be deferred. Since special requests may also be requeued requests,
1868 * a successful return doesn't guarantee the device will be
1869 * totally quiescent.
1870 *
1871 * Must be called with user context, may sleep.
1872 *
1873 * Returns zero if unsuccessful or an error if not.
1874 **/
1875int
1876scsi_device_quiesce(struct scsi_device *sdev)
1877{
1878 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
1879 if (err)
1880 return err;
1881
1882 scsi_run_queue(sdev->request_queue);
1883 while (sdev->device_busy) {
1884 msleep_interruptible(200);
1885 scsi_run_queue(sdev->request_queue);
1886 }
1887 return 0;
1888}
1889EXPORT_SYMBOL(scsi_device_quiesce);
1890
1891/**
1892 * scsi_device_resume - Restart user issued commands to a quiesced device.
1893 * @sdev: scsi device to resume.
1894 *
1895 * Moves the device from quiesced back to running and restarts the
1896 * queues.
1897 *
1898 * Must be called with user context, may sleep.
1899 **/
1900void
1901scsi_device_resume(struct scsi_device *sdev)
1902{
1903 if(scsi_device_set_state(sdev, SDEV_RUNNING))
1904 return;
1905 scsi_run_queue(sdev->request_queue);
1906}
1907EXPORT_SYMBOL(scsi_device_resume);
1908
1909static void
1910device_quiesce_fn(struct scsi_device *sdev, void *data)
1911{
1912 scsi_device_quiesce(sdev);
1913}
1914
1915void
1916scsi_target_quiesce(struct scsi_target *starget)
1917{
1918 starget_for_each_device(starget, NULL, device_quiesce_fn);
1919}
1920EXPORT_SYMBOL(scsi_target_quiesce);
1921
1922static void
1923device_resume_fn(struct scsi_device *sdev, void *data)
1924{
1925 scsi_device_resume(sdev);
1926}
1927
1928void
1929scsi_target_resume(struct scsi_target *starget)
1930{
1931 starget_for_each_device(starget, NULL, device_resume_fn);
1932}
1933EXPORT_SYMBOL(scsi_target_resume);
1934
1935/**
1936 * scsi_internal_device_block - internal function to put a device
1937 * temporarily into the SDEV_BLOCK state
1938 * @sdev: device to block
1939 *
1940 * Block request made by scsi lld's to temporarily stop all
1941 * scsi commands on the specified device. Called from interrupt
1942 * or normal process context.
1943 *
1944 * Returns zero if successful or error if not
1945 *
1946 * Notes:
1947 * This routine transitions the device to the SDEV_BLOCK state
1948 * (which must be a legal transition). When the device is in this
1949 * state, all commands are deferred until the scsi lld reenables
1950 * the device with scsi_device_unblock or device_block_tmo fires.
1951 * This routine assumes the host_lock is held on entry.
1952 **/
1953int
1954scsi_internal_device_block(struct scsi_device *sdev)
1955{
1956 request_queue_t *q = sdev->request_queue;
1957 unsigned long flags;
1958 int err = 0;
1959
1960 err = scsi_device_set_state(sdev, SDEV_BLOCK);
1961 if (err)
1962 return err;
1963
1964 /*
1965 * The device has transitioned to SDEV_BLOCK. Stop the
1966 * block layer from calling the midlayer with this device's
1967 * request queue.
1968 */
1969 spin_lock_irqsave(q->queue_lock, flags);
1970 blk_stop_queue(q);
1971 spin_unlock_irqrestore(q->queue_lock, flags);
1972
1973 return 0;
1974}
1975EXPORT_SYMBOL_GPL(scsi_internal_device_block);
1976
1977/**
1978 * scsi_internal_device_unblock - resume a device after a block request
1979 * @sdev: device to resume
1980 *
1981 * Called by scsi lld's or the midlayer to restart the device queue
1982 * for the previously suspended scsi device. Called from interrupt or
1983 * normal process context.
1984 *
1985 * Returns zero if successful or error if not.
1986 *
1987 * Notes:
1988 * This routine transitions the device to the SDEV_RUNNING state
1989 * (which must be a legal transition) allowing the midlayer to
1990 * goose the queue for this device. This routine assumes the
1991 * host_lock is held upon entry.
1992 **/
1993int
1994scsi_internal_device_unblock(struct scsi_device *sdev)
1995{
1996 request_queue_t *q = sdev->request_queue;
1997 int err;
1998 unsigned long flags;
1999
2000 /*
2001 * Try to transition the scsi device to SDEV_RUNNING
2002 * and goose the device queue if successful.
2003 */
2004 err = scsi_device_set_state(sdev, SDEV_RUNNING);
2005 if (err)
2006 return err;
2007
2008 spin_lock_irqsave(q->queue_lock, flags);
2009 blk_start_queue(q);
2010 spin_unlock_irqrestore(q->queue_lock, flags);
2011
2012 return 0;
2013}
2014EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
2015
2016static void
2017device_block(struct scsi_device *sdev, void *data)
2018{
2019 scsi_internal_device_block(sdev);
2020}
2021
2022static int
2023target_block(struct device *dev, void *data)
2024{
2025 if (scsi_is_target_device(dev))
2026 starget_for_each_device(to_scsi_target(dev), NULL,
2027 device_block);
2028 return 0;
2029}
2030
2031void
2032scsi_target_block(struct device *dev)
2033{
2034 if (scsi_is_target_device(dev))
2035 starget_for_each_device(to_scsi_target(dev), NULL,
2036 device_block);
2037 else
2038 device_for_each_child(dev, NULL, target_block);
2039}
2040EXPORT_SYMBOL_GPL(scsi_target_block);
2041
2042static void
2043device_unblock(struct scsi_device *sdev, void *data)
2044{
2045 scsi_internal_device_unblock(sdev);
2046}
2047
2048static int
2049target_unblock(struct device *dev, void *data)
2050{
2051 if (scsi_is_target_device(dev))
2052 starget_for_each_device(to_scsi_target(dev), NULL,
2053 device_unblock);
2054 return 0;
2055}
2056
2057void
2058scsi_target_unblock(struct device *dev)
2059{
2060 if (scsi_is_target_device(dev))
2061 starget_for_each_device(to_scsi_target(dev), NULL,
2062 device_unblock);
2063 else
2064 device_for_each_child(dev, NULL, target_unblock);
2065}
2066EXPORT_SYMBOL_GPL(scsi_target_unblock);