blob: 8c73bb4e0a2f910f4d1f2cec0b6c5de80cdd956f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
James Bottomleyd3f46f32008-01-15 11:11:46 -060011#include <linux/bitops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/blkdev.h>
13#include <linux/completion.h>
14#include <linux/kernel.h>
15#include <linux/mempool.h>
16#include <linux/slab.h>
17#include <linux/init.h>
18#include <linux/pci.h>
19#include <linux/delay.h>
James Bottomleyfaead262006-02-14 10:42:07 -060020#include <linux/hardirq.h>
Jens Axboec6132da2007-10-16 11:08:49 +020021#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
23#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020024#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <scsi/scsi_dbg.h>
26#include <scsi/scsi_device.h>
27#include <scsi/scsi_driver.h>
28#include <scsi/scsi_eh.h>
29#include <scsi/scsi_host.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31#include "scsi_priv.h"
32#include "scsi_logging.h"
33
34
Tobias Klauser6391a112006-06-08 22:23:48 -070035#define SG_MEMPOOL_NR ARRAY_SIZE(scsi_sg_pools)
Jens Axboe59725112007-04-02 10:06:42 +020036#define SG_MEMPOOL_SIZE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38struct scsi_host_sg_pool {
39 size_t size;
Jens Axboea8474ce2007-08-07 09:02:51 +020040 char *name;
Christoph Lametere18b8902006-12-06 20:33:20 -080041 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 mempool_t *pool;
43};
44
James Bottomleyd3f46f32008-01-15 11:11:46 -060045#define SP(x) { x, "sgpool-" __stringify(x) }
46#if (SCSI_MAX_SG_SEGMENTS < 32)
47#error SCSI_MAX_SG_SEGMENTS is too small (must be 32 or greater)
48#endif
Adrian Bunk52c1da32005-06-23 22:05:33 -070049static struct scsi_host_sg_pool scsi_sg_pools[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 SP(8),
51 SP(16),
FUJITA Tomonorifd820f42007-09-18 12:14:37 +020052#if (SCSI_MAX_SG_SEGMENTS > 32)
James Bottomleyd3f46f32008-01-15 11:11:46 -060053 SP(32),
FUJITA Tomonorifd820f42007-09-18 12:14:37 +020054#if (SCSI_MAX_SG_SEGMENTS > 64)
James Bottomleyd3f46f32008-01-15 11:11:46 -060055 SP(64),
56#if (SCSI_MAX_SG_SEGMENTS > 128)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 SP(128),
James Bottomleyd3f46f32008-01-15 11:11:46 -060058#if (SCSI_MAX_SG_SEGMENTS > 256)
59#error SCSI_MAX_SG_SEGMENTS is too large (256 MAX)
FUJITA Tomonorifd820f42007-09-18 12:14:37 +020060#endif
61#endif
62#endif
James Bottomleyd3f46f32008-01-15 11:11:46 -060063#endif
64 SP(SCSI_MAX_SG_SEGMENTS)
Jens Axboea8474ce2007-08-07 09:02:51 +020065};
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#undef SP
67
Martin K. Petersen7027ad72008-07-17 17:08:48 -040068struct kmem_cache *scsi_sdb_cache;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +020069
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -050070static void scsi_run_queue(struct request_queue *q);
James Bottomleye91442b2005-09-09 10:44:16 -050071
72/*
73 * Function: scsi_unprep_request()
74 *
75 * Purpose: Remove all preparation done for a request, including its
76 * associated scsi_cmnd, so that it can be requeued.
77 *
78 * Arguments: req - request to unprepare
79 *
80 * Lock status: Assumed that no locks are held upon entry.
81 *
82 * Returns: Nothing.
83 */
84static void scsi_unprep_request(struct request *req)
85{
86 struct scsi_cmnd *cmd = req->special;
87
Jens Axboe4aff5e22006-08-10 08:44:47 +020088 req->cmd_flags &= ~REQ_DONTPREP;
Christoph Hellwigbeb40482006-06-10 18:01:03 +020089 req->special = NULL;
James Bottomleye91442b2005-09-09 10:44:16 -050090
James Bottomleye91442b2005-09-09 10:44:16 -050091 scsi_put_command(cmd);
92}
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -050093
Linus Torvalds1da177e2005-04-16 15:20:36 -070094/*
95 * Function: scsi_queue_insert()
96 *
97 * Purpose: Insert a command in the midlevel queue.
98 *
99 * Arguments: cmd - command that we are adding to queue.
100 * reason - why we are inserting command to queue.
101 *
102 * Lock status: Assumed that lock is not held upon entry.
103 *
104 * Returns: Nothing.
105 *
106 * Notes: We do this for one of two cases. Either the host is busy
107 * and it cannot accept any more commands for the time being,
108 * or the device returned QUEUE_FULL and can accept no more
109 * commands.
110 * Notes: This could be called either from an interrupt context or a
111 * normal process context.
112 */
113int scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
114{
115 struct Scsi_Host *host = cmd->device->host;
116 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500117 struct scsi_target *starget = scsi_target(device);
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500118 struct request_queue *q = device->request_queue;
119 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121 SCSI_LOG_MLQUEUE(1,
122 printk("Inserting command %p into mlqueue\n", cmd));
123
124 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900125 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 *
127 * If the host/device isn't busy, assume that something actually
128 * completed, and that we should be able to queue a command now.
129 *
130 * Note that the prior mid-layer assumption that any host could
131 * always queue at least one command is now broken. The mid-layer
132 * will implement a user specifiable stall (see
133 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
134 * if a command is requeued with no other commands outstanding
135 * either for the device or for the host.
136 */
Mike Christief0c0a372008-08-17 15:24:38 -0500137 switch (reason) {
138 case SCSI_MLQUEUE_HOST_BUSY:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 host->host_blocked = host->max_host_blocked;
Mike Christief0c0a372008-08-17 15:24:38 -0500140 break;
141 case SCSI_MLQUEUE_DEVICE_BUSY:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 device->device_blocked = device->max_device_blocked;
Mike Christief0c0a372008-08-17 15:24:38 -0500143 break;
144 case SCSI_MLQUEUE_TARGET_BUSY:
145 starget->target_blocked = starget->max_target_blocked;
146 break;
147 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 * Decrement the counters, since these commands are no longer
151 * active on the host/device.
152 */
153 scsi_device_unbusy(device);
154
155 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500156 * Requeue this command. It will go before all other commands
157 * that are already in the queue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 *
159 * NOTE: there is magic here about the way the queue is plugged if
160 * we have no outstanding commands.
161 *
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500162 * Although we *don't* plug the queue, we call the request
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 * function. The SCSI request function detects the blocked condition
164 * and plugs the queue appropriately.
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500165 */
166 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley59897da2005-09-14 12:57:42 -0400167 blk_requeue_request(q, cmd->request);
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500168 spin_unlock_irqrestore(q->queue_lock, flags);
169
170 scsi_run_queue(q);
171
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 return 0;
173}
174
James Bottomley39216032005-06-15 18:48:29 -0500175/**
James Bottomley33aa6872005-08-28 11:31:14 -0500176 * scsi_execute - insert request and wait for the result
James Bottomley39216032005-06-15 18:48:29 -0500177 * @sdev: scsi device
178 * @cmd: scsi command
179 * @data_direction: data direction
180 * @buffer: data buffer
181 * @bufflen: len of buffer
182 * @sense: optional sense buffer
183 * @timeout: request timeout in seconds
184 * @retries: number of times to retry request
James Bottomley33aa6872005-08-28 11:31:14 -0500185 * @flags: or into request flags;
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900186 * @resid: optional residual length
James Bottomley39216032005-06-15 18:48:29 -0500187 *
Michael Opdenacker59c51592007-05-09 08:57:56 +0200188 * returns the req->errors value which is the scsi_cmnd result
James Bottomleyea73a9f2005-08-28 11:33:52 -0500189 * field.
Rob Landleyeb448202007-11-03 13:30:39 -0500190 */
James Bottomley33aa6872005-08-28 11:31:14 -0500191int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
192 int data_direction, void *buffer, unsigned bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900193 unsigned char *sense, int timeout, int retries, int flags,
194 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500195{
196 struct request *req;
197 int write = (data_direction == DMA_TO_DEVICE);
198 int ret = DRIVER_ERROR << 24;
199
200 req = blk_get_request(sdev->request_queue, write, __GFP_WAIT);
201
202 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
203 buffer, bufflen, __GFP_WAIT))
204 goto out;
205
206 req->cmd_len = COMMAND_SIZE(cmd[0]);
207 memcpy(req->cmd, cmd, req->cmd_len);
208 req->sense = sense;
209 req->sense_len = 0;
Mike Christie17e01f22005-11-11 05:31:37 -0600210 req->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500211 req->timeout = timeout;
Jens Axboe4aff5e22006-08-10 08:44:47 +0200212 req->cmd_type = REQ_TYPE_BLOCK_PC;
213 req->cmd_flags |= flags | REQ_QUIET | REQ_PREEMPT;
James Bottomley39216032005-06-15 18:48:29 -0500214
215 /*
216 * head injection *required* here otherwise quiesce won't work
217 */
218 blk_execute_rq(req->q, NULL, req, 1);
219
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400220 /*
221 * Some devices (USB mass-storage in particular) may transfer
222 * garbage data together with a residue indicating that the data
223 * is invalid. Prevent the garbage from being misinterpreted
224 * and prevent security leaks by zeroing out the excess data.
225 */
226 if (unlikely(req->data_len > 0 && req->data_len <= bufflen))
227 memset(buffer + (bufflen - req->data_len), 0, req->data_len);
228
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900229 if (resid)
230 *resid = req->data_len;
James Bottomley39216032005-06-15 18:48:29 -0500231 ret = req->errors;
232 out:
233 blk_put_request(req);
234
235 return ret;
236}
James Bottomley33aa6872005-08-28 11:31:14 -0500237EXPORT_SYMBOL(scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500238
James Bottomleyea73a9f2005-08-28 11:33:52 -0500239
240int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
241 int data_direction, void *buffer, unsigned bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900242 struct scsi_sense_hdr *sshdr, int timeout, int retries,
243 int *resid)
James Bottomleyea73a9f2005-08-28 11:33:52 -0500244{
245 char *sense = NULL;
akpm@osdl.org1ccb48b2005-06-26 00:12:51 -0700246 int result;
247
James Bottomleyea73a9f2005-08-28 11:33:52 -0500248 if (sshdr) {
Jes Sorensen24669f752006-01-16 10:31:18 -0500249 sense = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500250 if (!sense)
251 return DRIVER_ERROR << 24;
James Bottomleyea73a9f2005-08-28 11:33:52 -0500252 }
akpm@osdl.org1ccb48b2005-06-26 00:12:51 -0700253 result = scsi_execute(sdev, cmd, data_direction, buffer, bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900254 sense, timeout, retries, 0, resid);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500255 if (sshdr)
James Bottomleye5143852005-08-09 11:55:36 -0500256 scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, sshdr);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500257
258 kfree(sense);
259 return result;
260}
261EXPORT_SYMBOL(scsi_execute_req);
262
Mike Christie6e68af62005-11-11 05:30:27 -0600263struct scsi_io_context {
264 void *data;
265 void (*done)(void *data, char *sense, int result, int resid);
266 char sense[SCSI_SENSE_BUFFERSIZE];
267};
268
Christoph Lametere18b8902006-12-06 20:33:20 -0800269static struct kmem_cache *scsi_io_context_cache;
Mike Christieaa7b5cd2005-11-11 05:31:41 -0600270
Jens Axboee650c302006-01-06 12:38:30 +0100271static void scsi_end_async(struct request *req, int uptodate)
Mike Christie6e68af62005-11-11 05:30:27 -0600272{
273 struct scsi_io_context *sioc = req->end_io_data;
274
275 if (sioc->done)
276 sioc->done(sioc->data, sioc->sense, req->errors, req->data_len);
277
Mike Christieaa7b5cd2005-11-11 05:31:41 -0600278 kmem_cache_free(scsi_io_context_cache, sioc);
Mike Christie6e68af62005-11-11 05:30:27 -0600279 __blk_put_request(req->q, req);
280}
281
282static int scsi_merge_bio(struct request *rq, struct bio *bio)
283{
284 struct request_queue *q = rq->q;
285
286 bio->bi_flags &= ~(1 << BIO_SEG_VALID);
287 if (rq_data_dir(rq) == WRITE)
288 bio->bi_rw |= (1 << BIO_RW);
289 blk_queue_bounce(q, &bio);
290
NeilBrown3001ca72007-08-16 13:31:27 +0200291 return blk_rq_append_bio(q, rq, bio);
Mike Christie6e68af62005-11-11 05:30:27 -0600292}
293
NeilBrown6712ecf2007-09-27 12:47:43 +0200294static void scsi_bi_endio(struct bio *bio, int error)
Mike Christie6e68af62005-11-11 05:30:27 -0600295{
Mike Christie6e68af62005-11-11 05:30:27 -0600296 bio_put(bio);
Mike Christie6e68af62005-11-11 05:30:27 -0600297}
298
299/**
300 * scsi_req_map_sg - map a scatterlist into a request
301 * @rq: request to fill
Rob Landleyeb448202007-11-03 13:30:39 -0500302 * @sgl: scatterlist
Mike Christie6e68af62005-11-11 05:30:27 -0600303 * @nsegs: number of elements
304 * @bufflen: len of buffer
305 * @gfp: memory allocation flags
306 *
307 * scsi_req_map_sg maps a scatterlist into a request so that the
308 * request can be sent to the block layer. We do not trust the scatterlist
309 * sent to use, as some ULDs use that struct to only organize the pages.
310 */
311static int scsi_req_map_sg(struct request *rq, struct scatterlist *sgl,
312 int nsegs, unsigned bufflen, gfp_t gfp)
313{
314 struct request_queue *q = rq->q;
Bryan Holtyf5235962006-03-22 06:35:39 -0600315 int nr_pages = (bufflen + sgl[0].offset + PAGE_SIZE - 1) >> PAGE_SHIFT;
Mike Christiebd441de2007-03-13 12:52:29 -0500316 unsigned int data_len = bufflen, len, bytes, off;
Jens Axboec6132da2007-10-16 11:08:49 +0200317 struct scatterlist *sg;
Mike Christie6e68af62005-11-11 05:30:27 -0600318 struct page *page;
319 struct bio *bio = NULL;
320 int i, err, nr_vecs = 0;
321
Jens Axboec6132da2007-10-16 11:08:49 +0200322 for_each_sg(sgl, sg, nsegs, i) {
Jens Axboe45711f12007-10-22 21:19:53 +0200323 page = sg_page(sg);
Jens Axboec6132da2007-10-16 11:08:49 +0200324 off = sg->offset;
325 len = sg->length;
Mike Christie6e68af62005-11-11 05:30:27 -0600326
Mike Christiebd441de2007-03-13 12:52:29 -0500327 while (len > 0 && data_len > 0) {
328 /*
329 * sg sends a scatterlist that is larger than
330 * the data_len it wants transferred for certain
331 * IO sizes
332 */
Mike Christie6e68af62005-11-11 05:30:27 -0600333 bytes = min_t(unsigned int, len, PAGE_SIZE - off);
Mike Christiebd441de2007-03-13 12:52:29 -0500334 bytes = min(bytes, data_len);
Mike Christie6e68af62005-11-11 05:30:27 -0600335
336 if (!bio) {
337 nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
338 nr_pages -= nr_vecs;
339
340 bio = bio_alloc(gfp, nr_vecs);
341 if (!bio) {
342 err = -ENOMEM;
343 goto free_bios;
344 }
345 bio->bi_end_io = scsi_bi_endio;
346 }
347
348 if (bio_add_pc_page(q, bio, page, bytes, off) !=
349 bytes) {
350 bio_put(bio);
351 err = -EINVAL;
352 goto free_bios;
353 }
354
355 if (bio->bi_vcnt >= nr_vecs) {
356 err = scsi_merge_bio(rq, bio);
357 if (err) {
NeilBrown6712ecf2007-09-27 12:47:43 +0200358 bio_endio(bio, 0);
Mike Christie6e68af62005-11-11 05:30:27 -0600359 goto free_bios;
360 }
361 bio = NULL;
362 }
363
364 page++;
365 len -= bytes;
Mike Christiebd441de2007-03-13 12:52:29 -0500366 data_len -=bytes;
Mike Christie6e68af62005-11-11 05:30:27 -0600367 off = 0;
368 }
369 }
370
371 rq->buffer = rq->data = NULL;
Mike Christiebd441de2007-03-13 12:52:29 -0500372 rq->data_len = bufflen;
Mike Christie6e68af62005-11-11 05:30:27 -0600373 return 0;
374
375free_bios:
376 while ((bio = rq->bio) != NULL) {
377 rq->bio = bio->bi_next;
378 /*
379 * call endio instead of bio_put incase it was bounced
380 */
NeilBrown6712ecf2007-09-27 12:47:43 +0200381 bio_endio(bio, 0);
Mike Christie6e68af62005-11-11 05:30:27 -0600382 }
383
384 return err;
385}
386
387/**
388 * scsi_execute_async - insert request
389 * @sdev: scsi device
390 * @cmd: scsi command
brking@us.ibm.combb1d1072006-01-23 15:03:22 -0600391 * @cmd_len: length of scsi cdb
Rob Landleyeb448202007-11-03 13:30:39 -0500392 * @data_direction: DMA_TO_DEVICE, DMA_FROM_DEVICE, or DMA_NONE
Mike Christie6e68af62005-11-11 05:30:27 -0600393 * @buffer: data buffer (this can be a kernel buffer or scatterlist)
394 * @bufflen: len of buffer
395 * @use_sg: if buffer is a scatterlist this is the number of elements
396 * @timeout: request timeout in seconds
397 * @retries: number of times to retry request
Rob Landleyeb448202007-11-03 13:30:39 -0500398 * @privdata: data passed to done()
399 * @done: callback function when done
400 * @gfp: memory allocation flags
401 */
Mike Christie6e68af62005-11-11 05:30:27 -0600402int scsi_execute_async(struct scsi_device *sdev, const unsigned char *cmd,
brking@us.ibm.combb1d1072006-01-23 15:03:22 -0600403 int cmd_len, int data_direction, void *buffer, unsigned bufflen,
Mike Christie6e68af62005-11-11 05:30:27 -0600404 int use_sg, int timeout, int retries, void *privdata,
405 void (*done)(void *, char *, int, int), gfp_t gfp)
406{
407 struct request *req;
408 struct scsi_io_context *sioc;
409 int err = 0;
410 int write = (data_direction == DMA_TO_DEVICE);
411
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800412 sioc = kmem_cache_zalloc(scsi_io_context_cache, gfp);
Mike Christie6e68af62005-11-11 05:30:27 -0600413 if (!sioc)
414 return DRIVER_ERROR << 24;
415
416 req = blk_get_request(sdev->request_queue, write, gfp);
417 if (!req)
418 goto free_sense;
Jens Axboe4aff5e22006-08-10 08:44:47 +0200419 req->cmd_type = REQ_TYPE_BLOCK_PC;
420 req->cmd_flags |= REQ_QUIET;
Mike Christie6e68af62005-11-11 05:30:27 -0600421
422 if (use_sg)
423 err = scsi_req_map_sg(req, buffer, use_sg, bufflen, gfp);
424 else if (bufflen)
425 err = blk_rq_map_kern(req->q, req, buffer, bufflen, gfp);
426
427 if (err)
428 goto free_req;
429
brking@us.ibm.combb1d1072006-01-23 15:03:22 -0600430 req->cmd_len = cmd_len;
Tejun Heo097b8452006-11-16 01:19:31 -0800431 memset(req->cmd, 0, BLK_MAX_CDB); /* ATAPI hates garbage after CDB */
Mike Christie6e68af62005-11-11 05:30:27 -0600432 memcpy(req->cmd, cmd, req->cmd_len);
433 req->sense = sioc->sense;
434 req->sense_len = 0;
435 req->timeout = timeout;
Mike Christie17e01f22005-11-11 05:31:37 -0600436 req->retries = retries;
Mike Christie6e68af62005-11-11 05:30:27 -0600437 req->end_io_data = sioc;
438
439 sioc->data = privdata;
440 sioc->done = done;
441
442 blk_execute_rq_nowait(req->q, NULL, req, 1, scsi_end_async);
443 return 0;
444
445free_req:
446 blk_put_request(req);
447free_sense:
Arne Redlich6470f2b2006-09-30 15:49:40 +0200448 kmem_cache_free(scsi_io_context_cache, sioc);
Mike Christie6e68af62005-11-11 05:30:27 -0600449 return DRIVER_ERROR << 24;
450}
451EXPORT_SYMBOL_GPL(scsi_execute_async);
452
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453/*
454 * Function: scsi_init_cmd_errh()
455 *
456 * Purpose: Initialize cmd fields related to error handling.
457 *
458 * Arguments: cmd - command that is ready to be queued.
459 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 * Notes: This function has the job of initializing a number of
461 * fields related to error handling. Typically this will
462 * be called once for each command, as required.
463 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200464static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 cmd->serial_number = 0;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200467 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900468 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300470 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471}
472
473void scsi_device_unbusy(struct scsi_device *sdev)
474{
475 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500476 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 unsigned long flags;
478
479 spin_lock_irqsave(shost->host_lock, flags);
480 shost->host_busy--;
Mike Christief0c0a372008-08-17 15:24:38 -0500481 starget->target_busy--;
James Bottomley939647e2005-09-18 15:05:20 -0500482 if (unlikely(scsi_host_in_recovery(shost) &&
Tejun Heoee7863b2006-05-15 20:57:20 +0900483 (shost->host_failed || shost->host_eh_scheduled)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 scsi_eh_wakeup(shost);
485 spin_unlock(shost->host_lock);
152587d2005-04-12 16:22:06 -0500486 spin_lock(sdev->request_queue->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 sdev->device_busy--;
152587d2005-04-12 16:22:06 -0500488 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489}
490
491/*
492 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
493 * and call blk_run_queue for all the scsi_devices on the target -
494 * including current_sdev first.
495 *
496 * Called with *no* scsi locks held.
497 */
498static void scsi_single_lun_run(struct scsi_device *current_sdev)
499{
500 struct Scsi_Host *shost = current_sdev->host;
501 struct scsi_device *sdev, *tmp;
502 struct scsi_target *starget = scsi_target(current_sdev);
503 unsigned long flags;
504
505 spin_lock_irqsave(shost->host_lock, flags);
506 starget->starget_sdev_user = NULL;
507 spin_unlock_irqrestore(shost->host_lock, flags);
508
509 /*
510 * Call blk_run_queue for all LUNs on the target, starting with
511 * current_sdev. We race with others (to set starget_sdev_user),
512 * but in most cases, we will be first. Ideally, each LU on the
513 * target would get some limited time or requests on the target.
514 */
515 blk_run_queue(current_sdev->request_queue);
516
517 spin_lock_irqsave(shost->host_lock, flags);
518 if (starget->starget_sdev_user)
519 goto out;
520 list_for_each_entry_safe(sdev, tmp, &starget->devices,
521 same_target_siblings) {
522 if (sdev == current_sdev)
523 continue;
524 if (scsi_device_get(sdev))
525 continue;
526
527 spin_unlock_irqrestore(shost->host_lock, flags);
528 blk_run_queue(sdev->request_queue);
529 spin_lock_irqsave(shost->host_lock, flags);
530
531 scsi_device_put(sdev);
532 }
533 out:
534 spin_unlock_irqrestore(shost->host_lock, flags);
535}
536
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400537static inline int scsi_device_is_busy(struct scsi_device *sdev)
538{
539 if (sdev->device_busy >= sdev->queue_depth || sdev->device_blocked)
540 return 1;
541
542 return 0;
543}
544
Mike Christief0c0a372008-08-17 15:24:38 -0500545static inline int scsi_target_is_busy(struct scsi_target *starget)
546{
547 return ((starget->can_queue > 0 &&
548 starget->target_busy >= starget->can_queue) ||
549 starget->target_blocked);
550}
551
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400552static inline int scsi_host_is_busy(struct Scsi_Host *shost)
553{
554 if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
555 shost->host_blocked || shost->host_self_blocked)
556 return 1;
557
558 return 0;
559}
560
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561/*
562 * Function: scsi_run_queue()
563 *
564 * Purpose: Select a proper request queue to serve next
565 *
566 * Arguments: q - last request's queue
567 *
568 * Returns: Nothing
569 *
570 * Notes: The previous command was completely finished, start
571 * a new one if possible.
572 */
573static void scsi_run_queue(struct request_queue *q)
574{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600575 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 struct Scsi_Host *shost = sdev->host;
Mike Christie2a3a59e2008-11-11 13:42:35 -0600577 LIST_HEAD(starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 unsigned long flags;
579
Tony Battersby25d7c362007-11-12 10:00:44 -0500580 if (scsi_target(sdev)->single_lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 scsi_single_lun_run(sdev);
582
583 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600584 list_splice_init(&shost->starved_list, &starved_list);
585
586 while (!list_empty(&starved_list)) {
Nick Piggin75ad23b2008-04-29 14:48:33 +0200587 int flagset;
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 /*
590 * As long as shost is accepting commands and we have
591 * starved queues, call blk_run_queue. scsi_request_fn
592 * drops the queue_lock and can add us back to the
593 * starved_list.
594 *
595 * host_lock protects the starved_list and starved_entry.
596 * scsi_request_fn must get the host_lock before checking
597 * or modifying starved_list or starved_entry.
598 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600599 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500600 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500601
Mike Christie2a3a59e2008-11-11 13:42:35 -0600602 sdev = list_entry(starved_list.next,
603 struct scsi_device, starved_entry);
604 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500605 if (scsi_target_is_busy(scsi_target(sdev))) {
606 list_move_tail(&sdev->starved_entry,
607 &shost->starved_list);
608 continue;
609 }
610
Nick Piggin75ad23b2008-04-29 14:48:33 +0200611 spin_unlock(shost->host_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
Nick Piggin75ad23b2008-04-29 14:48:33 +0200613 spin_lock(sdev->request_queue->queue_lock);
614 flagset = test_bit(QUEUE_FLAG_REENTER, &q->queue_flags) &&
615 !test_bit(QUEUE_FLAG_REENTER,
616 &sdev->request_queue->queue_flags);
617 if (flagset)
618 queue_flag_set(QUEUE_FLAG_REENTER, sdev->request_queue);
619 __blk_run_queue(sdev->request_queue);
620 if (flagset)
621 queue_flag_clear(QUEUE_FLAG_REENTER, sdev->request_queue);
622 spin_unlock(sdev->request_queue->queue_lock);
Andreas Herrmann04846f22006-08-09 17:31:16 +0200623
Nick Piggin75ad23b2008-04-29 14:48:33 +0200624 spin_lock(shost->host_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600626 /* put any unprocessed entries back */
627 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 spin_unlock_irqrestore(shost->host_lock, flags);
629
630 blk_run_queue(q);
631}
632
633/*
634 * Function: scsi_requeue_command()
635 *
636 * Purpose: Handle post-processing of completed commands.
637 *
638 * Arguments: q - queue to operate on
639 * cmd - command that may need to be requeued.
640 *
641 * Returns: Nothing
642 *
643 * Notes: After command completion, there may be blocks left
644 * over which weren't finished by the previous command
645 * this can be for a number of reasons - the main one is
646 * I/O errors in the middle of the request, in which case
647 * we need to request the blocks that come after the bad
648 * sector.
James Bottomleye91442b2005-09-09 10:44:16 -0500649 * Notes: Upon return, cmd is a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 */
651static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
652{
James Bottomleye91442b2005-09-09 10:44:16 -0500653 struct request *req = cmd->request;
Tejun Heo 283369c2005-04-24 02:06:36 -0500654 unsigned long flags;
655
Tejun Heo 283369c2005-04-24 02:06:36 -0500656 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley02bd3492008-12-12 13:28:29 -0600657 scsi_unprep_request(req);
James Bottomleye91442b2005-09-09 10:44:16 -0500658 blk_requeue_request(q, req);
Tejun Heo 283369c2005-04-24 02:06:36 -0500659 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
661 scsi_run_queue(q);
662}
663
664void scsi_next_command(struct scsi_cmnd *cmd)
665{
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800666 struct scsi_device *sdev = cmd->device;
667 struct request_queue *q = sdev->request_queue;
668
669 /* need to hold a reference on the device before we let go of the cmd */
670 get_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
672 scsi_put_command(cmd);
673 scsi_run_queue(q);
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800674
675 /* ok to remove device now */
676 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677}
678
679void scsi_run_host_queues(struct Scsi_Host *shost)
680{
681 struct scsi_device *sdev;
682
683 shost_for_each_device(sdev, shost)
684 scsi_run_queue(sdev->request_queue);
685}
686
687/*
688 * Function: scsi_end_request()
689 *
690 * Purpose: Post-processing of completed commands (usually invoked at end
691 * of upper level post-processing and scsi_io_completion).
692 *
693 * Arguments: cmd - command that is complete.
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500694 * error - 0 if I/O indicates success, < 0 for I/O error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 * bytes - number of bytes of completed I/O
696 * requeue - indicates whether we should requeue leftovers.
697 *
698 * Lock status: Assumed that lock is not held upon entry.
699 *
James Bottomleye91442b2005-09-09 10:44:16 -0500700 * Returns: cmd if requeue required, NULL otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 *
702 * Notes: This is called for block device requests in order to
703 * mark some number of sectors as complete.
704 *
705 * We are guaranteeing that the request queue will be goosed
706 * at some point during this call.
James Bottomleye91442b2005-09-09 10:44:16 -0500707 * Notes: If cmd was requeued, upon return it will be a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 */
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500709static struct scsi_cmnd *scsi_end_request(struct scsi_cmnd *cmd, int error,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 int bytes, int requeue)
711{
Jens Axboe165125e2007-07-24 09:28:11 +0200712 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 struct request *req = cmd->request;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 /*
716 * If there are blocks left over at the end, set up the command
717 * to queue the remainder of them.
718 */
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500719 if (blk_end_request(req, error, bytes)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 int leftover = (req->hard_nr_sectors << 9);
721
722 if (blk_pc_request(req))
723 leftover = req->data_len;
724
725 /* kill remainder if no retrys */
Mike Christie4a274462008-08-19 18:45:31 -0500726 if (error && scsi_noretry_cmd(cmd))
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500727 blk_end_request(req, error, leftover);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 else {
James Bottomleye91442b2005-09-09 10:44:16 -0500729 if (requeue) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 /*
731 * Bleah. Leftovers again. Stick the
732 * leftovers in the front of the
733 * queue, and goose the queue again.
734 */
735 scsi_requeue_command(q, cmd);
James Bottomleye91442b2005-09-09 10:44:16 -0500736 cmd = NULL;
737 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 return cmd;
739 }
740 }
741
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 /*
743 * This will goose the queue request function at the end, so we don't
744 * need to worry about launching another command.
745 */
746 scsi_next_command(cmd);
747 return NULL;
748}
749
Jens Axboea8474ce2007-08-07 09:02:51 +0200750static inline unsigned int scsi_sgtable_index(unsigned short nents)
751{
752 unsigned int index;
753
James Bottomleyd3f46f32008-01-15 11:11:46 -0600754 BUG_ON(nents > SCSI_MAX_SG_SEGMENTS);
755
756 if (nents <= 8)
Jens Axboea8474ce2007-08-07 09:02:51 +0200757 index = 0;
James Bottomleyd3f46f32008-01-15 11:11:46 -0600758 else
759 index = get_count_order(nents) - 3;
Jens Axboea8474ce2007-08-07 09:02:51 +0200760
761 return index;
762}
763
Jens Axboe5ed79592007-11-15 09:13:11 +0100764static void scsi_sg_free(struct scatterlist *sgl, unsigned int nents)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765{
766 struct scsi_host_sg_pool *sgp;
Jens Axboe5ed79592007-11-15 09:13:11 +0100767
768 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
769 mempool_free(sgl, sgp->pool);
770}
771
772static struct scatterlist *scsi_sg_alloc(unsigned int nents, gfp_t gfp_mask)
773{
774 struct scsi_host_sg_pool *sgp;
775
776 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
777 return mempool_alloc(sgp->pool, gfp_mask);
778}
779
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200780static int scsi_alloc_sgtable(struct scsi_data_buffer *sdb, int nents,
781 gfp_t gfp_mask)
Jens Axboe5ed79592007-11-15 09:13:11 +0100782{
783 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200785 BUG_ON(!nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200787 ret = __sg_alloc_table(&sdb->table, nents, SCSI_MAX_SG_SEGMENTS,
788 gfp_mask, scsi_sg_alloc);
Jens Axboe5ed79592007-11-15 09:13:11 +0100789 if (unlikely(ret))
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200790 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS,
James Bottomley7cedb1f2008-01-13 14:15:28 -0600791 scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
Jens Axboea8474ce2007-08-07 09:02:51 +0200793 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794}
795
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200796static void scsi_free_sgtable(struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200798 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS, scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799}
800
801/*
802 * Function: scsi_release_buffers()
803 *
804 * Purpose: Completion processing for block device I/O requests.
805 *
806 * Arguments: cmd - command that we are bailing.
807 *
808 * Lock status: Assumed that no lock is held upon entry.
809 *
810 * Returns: Nothing
811 *
812 * Notes: In the event that an upper level driver rejects a
813 * command, we must release resources allocated during
814 * the __init_io() function. Primarily this would involve
815 * the scatter-gather table, and potentially any bounce
816 * buffers.
817 */
Boaz Harroshbb52d822007-12-13 16:14:27 -0800818void scsi_release_buffers(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200820 if (cmd->sdb.table.nents)
821 scsi_free_sgtable(&cmd->sdb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200823 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200824
825 if (scsi_bidi_cmnd(cmd)) {
826 struct scsi_data_buffer *bidi_sdb =
827 cmd->request->next_rq->special;
828 scsi_free_sgtable(bidi_sdb);
Martin K. Petersen6362abd2008-06-05 23:30:03 -0400829 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200830 cmd->request->next_rq->special = NULL;
831 }
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400832
833 if (scsi_prot_sg_count(cmd))
834 scsi_free_sgtable(cmd->prot_sdb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835}
Boaz Harroshbb52d822007-12-13 16:14:27 -0800836EXPORT_SYMBOL(scsi_release_buffers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
838/*
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200839 * Bidi commands Must be complete as a whole, both sides at once.
840 * If part of the bytes were written and lld returned
841 * scsi_in()->resid and/or scsi_out()->resid this information will be left
842 * in req->data_len and req->next_rq->data_len. The upper-layer driver can
843 * decide what to do with this information.
844 */
Adrian Bunk8c5e03d2008-03-31 01:53:55 +0300845static void scsi_end_bidi_request(struct scsi_cmnd *cmd)
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200846{
Kiyoshi Uedab8de1632008-01-18 12:02:15 -0500847 struct request *req = cmd->request;
848 unsigned int dlen = req->data_len;
849 unsigned int next_dlen = req->next_rq->data_len;
850
851 req->data_len = scsi_out(cmd)->resid;
852 req->next_rq->data_len = scsi_in(cmd)->resid;
853
854 /* The req and req->next_rq have not been completed */
855 BUG_ON(blk_end_bidi_request(req, 0, dlen, next_dlen));
856
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200857 scsi_release_buffers(cmd);
858
859 /*
860 * This will goose the queue request function at the end, so we don't
861 * need to worry about launching another command.
862 */
863 scsi_next_command(cmd);
864}
865
866/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 * Function: scsi_io_completion()
868 *
869 * Purpose: Completion processing for block device I/O requests.
870 *
871 * Arguments: cmd - command that is finished.
872 *
873 * Lock status: Assumed that no lock is held upon entry.
874 *
875 * Returns: Nothing
876 *
877 * Notes: This function is matched in terms of capabilities to
878 * the function that created the scatter-gather list.
879 * In other words, if there are no bounce buffers
880 * (the normal case for most drivers), we don't need
881 * the logic to deal with cleaning up afterwards.
882 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500883 * We must call scsi_end_request(). This will finish off
884 * the specified number of sectors. If we are done, the
885 * command block will be released and the queue function
886 * will be goosed. If we are not done then we have to
887 * figure out what to do next:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500889 * a) We can call scsi_requeue_command(). The request
890 * will be unprepared and put back on the queue. Then
891 * a new command will be created for it. This should
892 * be used if we made forward progress, or if we want
893 * to switch from READ(10) to READ(6) for example.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500895 * b) We can call scsi_queue_insert(). The request will
896 * be put back on the queue and retried using the same
897 * command as before, possibly after a delay.
898 *
899 * c) We can call blk_end_request() with -EIO to fail
900 * the remainder of the request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 */
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700902void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903{
904 int result = cmd->result;
James Bottomley44ea91c2008-09-20 00:31:50 +0000905 int this_count;
Jens Axboe165125e2007-07-24 09:28:11 +0200906 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 struct request *req = cmd->request;
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500908 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 struct scsi_sense_hdr sshdr;
910 int sense_valid = 0;
911 int sense_deferred = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500912 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
913 ACTION_DELAYED_RETRY} action;
914 char *description = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 if (result) {
917 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
918 if (sense_valid)
919 sense_deferred = scsi_sense_is_deferred(&sshdr);
920 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200921
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 if (blk_pc_request(req)) { /* SG_IO ioctl from block level */
923 req->errors = result;
924 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 if (sense_valid && req->sense) {
926 /*
927 * SG_IO wants current and deferred errors
928 */
929 int len = 8 + cmd->sense_buffer[7];
930
931 if (len > SCSI_SENSE_BUFFERSIZE)
932 len = SCSI_SENSE_BUFFERSIZE;
933 memcpy(req->sense, cmd->sense_buffer, len);
934 req->sense_len = len;
935 }
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500936 if (!sense_deferred)
937 error = -EIO;
Pete Wyckoffb22f6872007-03-13 16:53:28 -0400938 }
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200939 if (scsi_bidi_cmnd(cmd)) {
940 /* will also release_buffers */
941 scsi_end_bidi_request(cmd);
942 return;
943 }
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200944 req->data_len = scsi_get_resid(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 }
946
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200947 BUG_ON(blk_bidi_rq(req)); /* bidi not support for !blk_pc_request yet */
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200948 scsi_release_buffers(cmd);
949
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 * Next deal with any sectors which we were able to correctly
952 * handle.
953 */
James Bottomleyd6b0c532006-07-02 10:06:28 -0500954 SCSI_LOG_HLCOMPLETE(1, printk("%ld sectors total, "
955 "%d bytes done.\n",
956 req->nr_sectors, good_bytes));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
James Bottomleyd6b0c532006-07-02 10:06:28 -0500958 /* A number of bytes were successfully read. If there
959 * are leftovers and there is some kind of error
960 * (result != 0), retry the rest.
961 */
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500962 if (scsi_end_request(cmd, error, good_bytes, result == 0) == NULL)
James Bottomleyd6b0c532006-07-02 10:06:28 -0500963 return;
James Bottomley44ea91c2008-09-20 00:31:50 +0000964 this_count = blk_rq_bytes(req);
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700965
Alan Sternb60af5b2008-11-03 15:56:47 -0500966 if (host_byte(result) == DID_RESET) {
967 /* Third party bus reset or reset for error recovery
968 * reasons. Just retry the command and see what
969 * happens.
970 */
971 action = ACTION_RETRY;
972 } else if (sense_valid && !sense_deferred) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 switch (sshdr.sense_key) {
974 case UNIT_ATTENTION:
975 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700976 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 * and quietly refuse further access.
978 */
979 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500980 description = "Media Changed";
981 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700983 /* Must have been a power glitch, or a
984 * bus reset. Could not have been a
985 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500986 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700987 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500988 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 }
990 break;
991 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700992 /* If we had an ILLEGAL REQUEST returned, then
993 * we may have performed an unsupported
994 * command. The only thing this should be
995 * would be a ten byte read where only a six
996 * byte read was supported. Also, on a system
997 * where READ CAPACITY failed, we may have
998 * read past the end of the disk.
999 */
Jens Axboe26a68012005-11-29 21:03:34 +01001000 if ((cmd->device->use_10_for_rw &&
1001 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 (cmd->cmnd[0] == READ_10 ||
1003 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -05001004 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -05001006 action = ACTION_REPREP;
1007 } else
1008 action = ACTION_FAIL;
1009 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -04001010 case ABORTED_COMMAND:
1011 if (sshdr.asc == 0x10) { /* DIF */
Alan Sternb60af5b2008-11-03 15:56:47 -05001012 action = ACTION_FAIL;
1013 description = "Data Integrity Failure";
1014 } else
1015 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 break;
1017 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -07001018 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -05001019 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 */
James Bottomleyf3e93f72006-04-25 16:48:30 -05001021 if (sshdr.asc == 0x04) {
1022 switch (sshdr.ascq) {
1023 case 0x01: /* becoming ready */
1024 case 0x04: /* format in progress */
1025 case 0x05: /* rebuild in progress */
1026 case 0x06: /* recalculation in progress */
1027 case 0x07: /* operation in progress */
1028 case 0x08: /* Long write in progress */
1029 case 0x09: /* self test in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -05001030 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -05001031 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -05001032 default:
1033 description = "Device not ready";
1034 action = ACTION_FAIL;
1035 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -05001036 }
Alan Sternb60af5b2008-11-03 15:56:47 -05001037 } else {
1038 description = "Device not ready";
1039 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 }
Alan Sternb60af5b2008-11-03 15:56:47 -05001041 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -07001043 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -05001044 action = ACTION_FAIL;
1045 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 default:
Alan Sternb60af5b2008-11-03 15:56:47 -05001047 description = "Unhandled sense code";
1048 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 break;
1050 }
Alan Sternb60af5b2008-11-03 15:56:47 -05001051 } else {
1052 description = "Unhandled error code";
1053 action = ACTION_FAIL;
Luben Tuikov03aba2f2006-06-23 09:39:09 -07001054 }
Alan Sternb60af5b2008-11-03 15:56:47 -05001055
1056 switch (action) {
1057 case ACTION_FAIL:
1058 /* Give up and fail the remainder of the request */
Jens Axboe4aff5e22006-08-10 08:44:47 +02001059 if (!(req->cmd_flags & REQ_QUIET)) {
Alan Sternb60af5b2008-11-03 15:56:47 -05001060 if (description)
Alan Stern3dbf6a52008-12-15 10:31:28 -05001061 scmd_printk(KERN_INFO, cmd, "%s\n",
Alan Sternb60af5b2008-11-03 15:56:47 -05001062 description);
Martin K. Petersena4d04a42007-02-27 22:40:27 -05001063 scsi_print_result(cmd);
James Bottomley3173d8c2005-09-04 11:32:05 -05001064 if (driver_byte(result) & DRIVER_SENSE)
1065 scsi_print_sense("", cmd);
1066 }
Alan Sternb60af5b2008-11-03 15:56:47 -05001067 blk_end_request(req, -EIO, blk_rq_bytes(req));
1068 scsi_next_command(cmd);
1069 break;
1070 case ACTION_REPREP:
1071 /* Unprep the request and put it back at the head of the queue.
1072 * A new command will be prepared and issued.
1073 */
1074 scsi_requeue_command(q, cmd);
1075 break;
1076 case ACTION_RETRY:
1077 /* Retry the same command immediately */
1078 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
1079 break;
1080 case ACTION_DELAYED_RETRY:
1081 /* Retry the same command after a delay */
1082 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1083 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 }
1085}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001087static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb,
1088 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001090 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
1092 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001093 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001095 if (unlikely(scsi_alloc_sgtable(sdb, req->nr_phys_segments,
1096 gfp_mask))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 return BLKPREP_DEFER;
Alan Stern7c72ce82005-10-14 11:23:27 -04001098 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
Christoph Hellwig3b003152006-11-04 20:10:55 +01001100 req->buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
1102 /*
1103 * Next, walk the list, and fill in the addresses and sizes of
1104 * each segment.
1105 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001106 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1107 BUG_ON(count > sdb->table.nents);
1108 sdb->table.nents = count;
Tejun Heo6b007692008-02-19 11:36:35 +01001109 if (blk_pc_request(req))
1110 sdb->length = req->data_len;
1111 else
1112 sdb->length = req->nr_sectors << 9;
Rusty Russell4a03d902007-11-19 11:28:48 +11001113 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001115
1116/*
1117 * Function: scsi_init_io()
1118 *
1119 * Purpose: SCSI I/O initialize function.
1120 *
1121 * Arguments: cmd - Command descriptor we wish to initialize
1122 *
1123 * Returns: 0 on success
1124 * BLKPREP_DEFER if the failure is retryable
1125 * BLKPREP_KILL if the failure is fatal
1126 */
1127int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask)
1128{
1129 int error = scsi_init_sgtable(cmd->request, &cmd->sdb, gfp_mask);
1130 if (error)
1131 goto err_exit;
1132
1133 if (blk_bidi_rq(cmd->request)) {
1134 struct scsi_data_buffer *bidi_sdb = kmem_cache_zalloc(
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001135 scsi_sdb_cache, GFP_ATOMIC);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001136 if (!bidi_sdb) {
1137 error = BLKPREP_DEFER;
1138 goto err_exit;
1139 }
1140
1141 cmd->request->next_rq->special = bidi_sdb;
1142 error = scsi_init_sgtable(cmd->request->next_rq, bidi_sdb,
1143 GFP_ATOMIC);
1144 if (error)
1145 goto err_exit;
1146 }
1147
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001148 if (blk_integrity_rq(cmd->request)) {
1149 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1150 int ivecs, count;
1151
1152 BUG_ON(prot_sdb == NULL);
1153 ivecs = blk_rq_count_integrity_sg(cmd->request);
1154
1155 if (scsi_alloc_sgtable(prot_sdb, ivecs, gfp_mask)) {
1156 error = BLKPREP_DEFER;
1157 goto err_exit;
1158 }
1159
1160 count = blk_rq_map_integrity_sg(cmd->request,
1161 prot_sdb->table.sgl);
1162 BUG_ON(unlikely(count > ivecs));
1163
1164 cmd->prot_sdb = prot_sdb;
1165 cmd->prot_sdb->table.nents = count;
1166 }
1167
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001168 return BLKPREP_OK ;
1169
1170err_exit:
1171 scsi_release_buffers(cmd);
1172 if (error == BLKPREP_KILL)
1173 scsi_put_command(cmd);
1174 else /* BLKPREP_DEFER */
1175 scsi_unprep_request(cmd->request);
1176
1177 return error;
1178}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001179EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180
Christoph Hellwig3b003152006-11-04 20:10:55 +01001181static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
1182 struct request *req)
1183{
1184 struct scsi_cmnd *cmd;
1185
1186 if (!req->special) {
1187 cmd = scsi_get_command(sdev, GFP_ATOMIC);
1188 if (unlikely(!cmd))
1189 return NULL;
1190 req->special = cmd;
1191 } else {
1192 cmd = req->special;
1193 }
1194
1195 /* pull a tag out of the request if we have one */
1196 cmd->tag = req->tag;
1197 cmd->request = req;
1198
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001199 cmd->cmnd = req->cmd;
1200
Christoph Hellwig3b003152006-11-04 20:10:55 +01001201 return cmd;
1202}
1203
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001204int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001205{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001206 struct scsi_cmnd *cmd;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001207 int ret = scsi_prep_state_check(sdev, req);
1208
1209 if (ret != BLKPREP_OK)
1210 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001211
1212 cmd = scsi_get_cmd_from_req(sdev, req);
1213 if (unlikely(!cmd))
1214 return BLKPREP_DEFER;
1215
1216 /*
1217 * BLOCK_PC requests may transfer data, in which case they must
1218 * a bio attached to them. Or they might contain a SCSI command
1219 * that does not transfer data, in which case they may optionally
1220 * submit a request without an attached bio.
1221 */
1222 if (req->bio) {
1223 int ret;
1224
1225 BUG_ON(!req->nr_phys_segments);
1226
Boaz Harroshbb52d822007-12-13 16:14:27 -08001227 ret = scsi_init_io(cmd, GFP_ATOMIC);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001228 if (unlikely(ret))
1229 return ret;
1230 } else {
1231 BUG_ON(req->data_len);
1232 BUG_ON(req->data);
1233
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001234 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001235 req->buffer = NULL;
1236 }
James Bottomley7b163182005-12-15 20:17:02 -06001237
James Bottomley7b163182005-12-15 20:17:02 -06001238 cmd->cmd_len = req->cmd_len;
1239 if (!req->data_len)
1240 cmd->sc_data_direction = DMA_NONE;
1241 else if (rq_data_dir(req) == WRITE)
1242 cmd->sc_data_direction = DMA_TO_DEVICE;
1243 else
1244 cmd->sc_data_direction = DMA_FROM_DEVICE;
1245
1246 cmd->transfersize = req->data_len;
1247 cmd->allowed = req->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001248 return BLKPREP_OK;
1249}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001250EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001251
1252/*
1253 * Setup a REQ_TYPE_FS command. These are simple read/write request
1254 * from filesystems that still need to be translated to SCSI CDBs from
1255 * the ULD.
1256 */
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001257int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001258{
1259 struct scsi_cmnd *cmd;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001260 int ret = scsi_prep_state_check(sdev, req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001261
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001262 if (ret != BLKPREP_OK)
1263 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001264
1265 if (unlikely(sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh
1266 && sdev->scsi_dh_data->scsi_dh->prep_fn)) {
1267 ret = sdev->scsi_dh_data->scsi_dh->prep_fn(sdev, req);
1268 if (ret != BLKPREP_OK)
1269 return ret;
1270 }
1271
Christoph Hellwig3b003152006-11-04 20:10:55 +01001272 /*
1273 * Filesystem requests must transfer data.
1274 */
1275 BUG_ON(!req->nr_phys_segments);
1276
1277 cmd = scsi_get_cmd_from_req(sdev, req);
1278 if (unlikely(!cmd))
1279 return BLKPREP_DEFER;
1280
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001281 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Boaz Harroshbb52d822007-12-13 16:14:27 -08001282 return scsi_init_io(cmd, GFP_ATOMIC);
James Bottomley7b163182005-12-15 20:17:02 -06001283}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001284EXPORT_SYMBOL(scsi_setup_fs_cmnd);
James Bottomley7b163182005-12-15 20:17:02 -06001285
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001286int scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001288 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289
1290 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001291 * If the device is not in running state we will reject some
1292 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001295 switch (sdev->sdev_state) {
1296 case SDEV_OFFLINE:
1297 /*
1298 * If the device is offline we refuse to process any
1299 * commands. The device must be brought online
1300 * before trying any recovery commands.
1301 */
1302 sdev_printk(KERN_ERR, sdev,
1303 "rejecting I/O to offline device\n");
1304 ret = BLKPREP_KILL;
1305 break;
1306 case SDEV_DEL:
1307 /*
1308 * If the device is fully deleted, we refuse to
1309 * process any commands as well.
1310 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001311 sdev_printk(KERN_ERR, sdev,
1312 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001313 ret = BLKPREP_KILL;
1314 break;
1315 case SDEV_QUIESCE:
1316 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001317 case SDEV_CREATED_BLOCK:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001318 /*
1319 * If the devices is blocked we defer normal commands.
1320 */
1321 if (!(req->cmd_flags & REQ_PREEMPT))
1322 ret = BLKPREP_DEFER;
1323 break;
1324 default:
1325 /*
1326 * For any other not fully online state we only allow
1327 * special commands. In particular any user initiated
1328 * command is not allowed.
1329 */
1330 if (!(req->cmd_flags & REQ_PREEMPT))
1331 ret = BLKPREP_KILL;
1332 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001335 return ret;
1336}
1337EXPORT_SYMBOL(scsi_prep_state_check);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001339int scsi_prep_return(struct request_queue *q, struct request *req, int ret)
1340{
1341 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
Christoph Hellwig3b003152006-11-04 20:10:55 +01001343 switch (ret) {
1344 case BLKPREP_KILL:
1345 req->errors = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001346 /* release the command and kill it */
1347 if (req->special) {
1348 struct scsi_cmnd *cmd = req->special;
1349 scsi_release_buffers(cmd);
1350 scsi_put_command(cmd);
1351 req->special = NULL;
1352 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001353 break;
1354 case BLKPREP_DEFER:
1355 /*
1356 * If we defer, the elv_next_request() returns NULL, but the
1357 * queue must be restarted, so we plug here if no returning
1358 * command will automatically do that.
1359 */
1360 if (sdev->device_busy == 0)
1361 blk_plug_device(q);
1362 break;
1363 default:
1364 req->cmd_flags |= REQ_DONTPREP;
1365 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366
Christoph Hellwig3b003152006-11-04 20:10:55 +01001367 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001369EXPORT_SYMBOL(scsi_prep_return);
1370
James Bottomley751bf4d2008-01-02 11:14:30 -06001371int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001372{
1373 struct scsi_device *sdev = q->queuedata;
1374 int ret = BLKPREP_KILL;
1375
1376 if (req->cmd_type == REQ_TYPE_BLOCK_PC)
1377 ret = scsi_setup_blk_pc_cmnd(sdev, req);
1378 return scsi_prep_return(q, req, ret);
1379}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
1381/*
1382 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1383 * return 0.
1384 *
1385 * Called with the queue_lock held.
1386 */
1387static inline int scsi_dev_queue_ready(struct request_queue *q,
1388 struct scsi_device *sdev)
1389{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 if (sdev->device_busy == 0 && sdev->device_blocked) {
1391 /*
1392 * unblock after device_blocked iterates to zero
1393 */
1394 if (--sdev->device_blocked == 0) {
1395 SCSI_LOG_MLQUEUE(3,
James Bottomley9ccfc752005-10-02 11:45:08 -05001396 sdev_printk(KERN_INFO, sdev,
1397 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 } else {
1399 blk_plug_device(q);
1400 return 0;
1401 }
1402 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001403 if (scsi_device_is_busy(sdev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 return 0;
1405
1406 return 1;
1407}
1408
Mike Christief0c0a372008-08-17 15:24:38 -05001409
1410/*
1411 * scsi_target_queue_ready: checks if there we can send commands to target
1412 * @sdev: scsi device on starget to check.
1413 *
1414 * Called with the host lock held.
1415 */
1416static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1417 struct scsi_device *sdev)
1418{
1419 struct scsi_target *starget = scsi_target(sdev);
1420
1421 if (starget->single_lun) {
1422 if (starget->starget_sdev_user &&
1423 starget->starget_sdev_user != sdev)
1424 return 0;
1425 starget->starget_sdev_user = sdev;
1426 }
1427
1428 if (starget->target_busy == 0 && starget->target_blocked) {
1429 /*
1430 * unblock after target_blocked iterates to zero
1431 */
1432 if (--starget->target_blocked == 0) {
1433 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1434 "unblocking target at zero depth\n"));
1435 } else {
1436 blk_plug_device(sdev->request_queue);
1437 return 0;
1438 }
1439 }
1440
1441 if (scsi_target_is_busy(starget)) {
1442 if (list_empty(&sdev->starved_entry)) {
1443 list_add_tail(&sdev->starved_entry,
1444 &shost->starved_list);
1445 return 0;
1446 }
1447 }
1448
1449 /* We're OK to process the command, so we can't be starved */
1450 if (!list_empty(&sdev->starved_entry))
1451 list_del_init(&sdev->starved_entry);
1452 return 1;
1453}
1454
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455/*
1456 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1457 * return 0. We must end up running the queue again whenever 0 is
1458 * returned, else IO can hang.
1459 *
1460 * Called with host_lock held.
1461 */
1462static inline int scsi_host_queue_ready(struct request_queue *q,
1463 struct Scsi_Host *shost,
1464 struct scsi_device *sdev)
1465{
James Bottomley939647e2005-09-18 15:05:20 -05001466 if (scsi_host_in_recovery(shost))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 return 0;
1468 if (shost->host_busy == 0 && shost->host_blocked) {
1469 /*
1470 * unblock after host_blocked iterates to zero
1471 */
1472 if (--shost->host_blocked == 0) {
1473 SCSI_LOG_MLQUEUE(3,
1474 printk("scsi%d unblocking host at zero depth\n",
1475 shost->host_no));
1476 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 return 0;
1478 }
1479 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001480 if (scsi_host_is_busy(shost)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 if (list_empty(&sdev->starved_entry))
1482 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1483 return 0;
1484 }
1485
1486 /* We're OK to process the command, so we can't be starved */
1487 if (!list_empty(&sdev->starved_entry))
1488 list_del_init(&sdev->starved_entry);
1489
1490 return 1;
1491}
1492
1493/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001494 * Busy state exporting function for request stacking drivers.
1495 *
1496 * For efficiency, no lock is taken to check the busy state of
1497 * shost/starget/sdev, since the returned value is not guaranteed and
1498 * may be changed after request stacking drivers call the function,
1499 * regardless of taking lock or not.
1500 *
1501 * When scsi can't dispatch I/Os anymore and needs to kill I/Os
1502 * (e.g. !sdev), scsi needs to return 'not busy'.
1503 * Otherwise, request stacking drivers may hold requests forever.
1504 */
1505static int scsi_lld_busy(struct request_queue *q)
1506{
1507 struct scsi_device *sdev = q->queuedata;
1508 struct Scsi_Host *shost;
1509 struct scsi_target *starget;
1510
1511 if (!sdev)
1512 return 0;
1513
1514 shost = sdev->host;
1515 starget = scsi_target(sdev);
1516
1517 if (scsi_host_in_recovery(shost) || scsi_host_is_busy(shost) ||
1518 scsi_target_is_busy(starget) || scsi_device_is_busy(sdev))
1519 return 1;
1520
1521 return 0;
1522}
1523
1524/*
James Bottomleye91442b2005-09-09 10:44:16 -05001525 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 */
Jens Axboe165125e2007-07-24 09:28:11 +02001527static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528{
James Bottomleye91442b2005-09-09 10:44:16 -05001529 struct scsi_cmnd *cmd = req->special;
Tejun Heoe36e0c82006-04-11 17:27:53 +09001530 struct scsi_device *sdev = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -05001531 struct scsi_target *starget = scsi_target(sdev);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001532 struct Scsi_Host *shost = sdev->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
James Bottomley788ce432005-09-09 13:40:23 -05001534 blkdev_dequeue_request(req);
1535
James Bottomleye91442b2005-09-09 10:44:16 -05001536 if (unlikely(cmd == NULL)) {
1537 printk(KERN_CRIT "impossible request in %s.\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001538 __func__);
James Bottomleye91442b2005-09-09 10:44:16 -05001539 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 }
James Bottomleye91442b2005-09-09 10:44:16 -05001541
1542 scsi_init_cmd_errh(cmd);
1543 cmd->result = DID_NO_CONNECT << 16;
1544 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001545
1546 /*
1547 * SCSI request completion path will do scsi_device_unbusy(),
1548 * bump busy counts. To bump the counters, we need to dance
1549 * with the locks as normal issue path does.
1550 */
1551 sdev->device_busy++;
1552 spin_unlock(sdev->request_queue->queue_lock);
1553 spin_lock(shost->host_lock);
1554 shost->host_busy++;
Mike Christief0c0a372008-08-17 15:24:38 -05001555 starget->target_busy++;
Tejun Heoe36e0c82006-04-11 17:27:53 +09001556 spin_unlock(shost->host_lock);
1557 spin_lock(sdev->request_queue->queue_lock);
1558
Jens Axboe242f9dc2008-09-14 05:55:09 -07001559 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560}
1561
Jens Axboe1aea6432006-01-09 16:03:03 +01001562static void scsi_softirq_done(struct request *rq)
1563{
Jens Axboe242f9dc2008-09-14 05:55:09 -07001564 struct scsi_cmnd *cmd = rq->special;
1565 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001566 int disposition;
1567
1568 INIT_LIST_HEAD(&cmd->eh_entry);
1569
Jens Axboe242f9dc2008-09-14 05:55:09 -07001570 /*
1571 * Set the serial numbers back to zero
1572 */
1573 cmd->serial_number = 0;
1574
1575 atomic_inc(&cmd->device->iodone_cnt);
1576 if (cmd->result)
1577 atomic_inc(&cmd->device->ioerr_cnt);
1578
Jens Axboe1aea6432006-01-09 16:03:03 +01001579 disposition = scsi_decide_disposition(cmd);
1580 if (disposition != SUCCESS &&
1581 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1582 sdev_printk(KERN_ERR, cmd->device,
1583 "timing out command, waited %lus\n",
1584 wait_for/HZ);
1585 disposition = SUCCESS;
1586 }
1587
1588 scsi_log_completion(cmd, disposition);
1589
1590 switch (disposition) {
1591 case SUCCESS:
1592 scsi_finish_command(cmd);
1593 break;
1594 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001595 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001596 break;
1597 case ADD_TO_MLQUEUE:
1598 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1599 break;
1600 default:
1601 if (!scsi_eh_scmd_add(cmd, 0))
1602 scsi_finish_command(cmd);
1603 }
1604}
1605
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606/*
1607 * Function: scsi_request_fn()
1608 *
1609 * Purpose: Main strategy routine for SCSI.
1610 *
1611 * Arguments: q - Pointer to actual queue.
1612 *
1613 * Returns: Nothing
1614 *
1615 * Lock status: IO request lock assumed to be held when called.
1616 */
1617static void scsi_request_fn(struct request_queue *q)
1618{
1619 struct scsi_device *sdev = q->queuedata;
1620 struct Scsi_Host *shost;
1621 struct scsi_cmnd *cmd;
1622 struct request *req;
1623
1624 if (!sdev) {
1625 printk("scsi: killing requests for dead queue\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001626 while ((req = elv_next_request(q)) != NULL)
1627 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 return;
1629 }
1630
1631 if(!get_device(&sdev->sdev_gendev))
1632 /* We must be tearing the block queue down already */
1633 return;
1634
1635 /*
1636 * To start with, we keep looping until the queue is empty, or until
1637 * the host is no longer able to accept any more requests.
1638 */
1639 shost = sdev->host;
1640 while (!blk_queue_plugged(q)) {
1641 int rtn;
1642 /*
1643 * get next queueable request. We do this early to make sure
1644 * that the request is fully prepared even if we cannot
1645 * accept it.
1646 */
1647 req = elv_next_request(q);
1648 if (!req || !scsi_dev_queue_ready(q, sdev))
1649 break;
1650
1651 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001652 sdev_printk(KERN_ERR, sdev,
1653 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001654 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 continue;
1656 }
1657
1658
1659 /*
1660 * Remove the request from the request list.
1661 */
1662 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
1663 blkdev_dequeue_request(req);
1664 sdev->device_busy++;
1665
1666 spin_unlock(q->queue_lock);
James Bottomleye91442b2005-09-09 10:44:16 -05001667 cmd = req->special;
1668 if (unlikely(cmd == NULL)) {
1669 printk(KERN_CRIT "impossible request in %s.\n"
1670 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001671 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001672 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001673 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001674 BUG();
1675 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 spin_lock(shost->host_lock);
1677
Mike Christieecefe8a2008-07-11 19:50:35 -05001678 /*
1679 * We hit this when the driver is using a host wide
1680 * tag map. For device level tag maps the queue_depth check
1681 * in the device ready fn would prevent us from trying
1682 * to allocate a tag. Since the map is a shared host resource
1683 * we add the dev to the starved list so it eventually gets
1684 * a run when a tag is freed.
1685 */
Mike Christie6bd522f2008-07-22 15:34:38 -05001686 if (blk_queue_tagged(q) && !blk_rq_tagged(req)) {
Mike Christieecefe8a2008-07-11 19:50:35 -05001687 if (list_empty(&sdev->starved_entry))
1688 list_add_tail(&sdev->starved_entry,
1689 &shost->starved_list);
1690 goto not_ready;
1691 }
1692
Mike Christief0c0a372008-08-17 15:24:38 -05001693 if (!scsi_target_queue_ready(shost, sdev))
1694 goto not_ready;
1695
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 if (!scsi_host_queue_ready(q, shost, sdev))
1697 goto not_ready;
Mike Christief0c0a372008-08-17 15:24:38 -05001698
1699 scsi_target(sdev)->target_busy++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 shost->host_busy++;
1701
1702 /*
1703 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1704 * take the lock again.
1705 */
1706 spin_unlock_irq(shost->host_lock);
1707
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 /*
1709 * Finally, initialize any error handling parameters, and set up
1710 * the timers for timeouts.
1711 */
1712 scsi_init_cmd_errh(cmd);
1713
1714 /*
1715 * Dispatch the command to the low-level driver.
1716 */
1717 rtn = scsi_dispatch_cmd(cmd);
1718 spin_lock_irq(q->queue_lock);
1719 if(rtn) {
1720 /* we're refusing the command; because of
1721 * the way locks get dropped, we need to
1722 * check here if plugging is required */
1723 if(sdev->device_busy == 0)
1724 blk_plug_device(q);
1725
1726 break;
1727 }
1728 }
1729
1730 goto out;
1731
1732 not_ready:
1733 spin_unlock_irq(shost->host_lock);
1734
1735 /*
1736 * lock q, handle tag, requeue req, and decrement device_busy. We
1737 * must return with queue_lock held.
1738 *
1739 * Decrementing device_busy without checking it is OK, as all such
1740 * cases (host limits or settings) should run the queue at some
1741 * later time.
1742 */
1743 spin_lock_irq(q->queue_lock);
1744 blk_requeue_request(q, req);
1745 sdev->device_busy--;
1746 if(sdev->device_busy == 0)
1747 blk_plug_device(q);
1748 out:
1749 /* must be careful here...if we trigger the ->remove() function
1750 * we cannot be holding the q lock */
1751 spin_unlock_irq(q->queue_lock);
1752 put_device(&sdev->sdev_gendev);
1753 spin_lock_irq(q->queue_lock);
1754}
1755
1756u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
1757{
1758 struct device *host_dev;
1759 u64 bounce_limit = 0xffffffff;
1760
1761 if (shost->unchecked_isa_dma)
1762 return BLK_BOUNCE_ISA;
1763 /*
1764 * Platforms with virtual-DMA translation
1765 * hardware have no practical limit.
1766 */
1767 if (!PCI_DMA_BUS_IS_PHYS)
1768 return BLK_BOUNCE_ANY;
1769
1770 host_dev = scsi_get_device(shost);
1771 if (host_dev && host_dev->dma_mask)
1772 bounce_limit = *host_dev->dma_mask;
1773
1774 return bounce_limit;
1775}
1776EXPORT_SYMBOL(scsi_calculate_bounce_limit);
1777
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001778struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
1779 request_fn_proc *request_fn)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 struct request_queue *q;
FUJITA Tomonori860ac562008-02-04 22:28:05 -08001782 struct device *dev = shost->shost_gendev.parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001784 q = blk_init_queue(request_fn, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 if (!q)
1786 return NULL;
1787
Jens Axboea8474ce2007-08-07 09:02:51 +02001788 /*
1789 * this limit is imposed by hardware restrictions
1790 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 blk_queue_max_hw_segments(q, shost->sg_tablesize);
James Bottomleyd3f46f32008-01-15 11:11:46 -06001792 blk_queue_max_phys_segments(q, SCSI_MAX_SG_CHAIN_SEGMENTS);
Jens Axboea8474ce2007-08-07 09:02:51 +02001793
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 blk_queue_max_sectors(q, shost->max_sectors);
1795 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
1796 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001797 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798
FUJITA Tomonori860ac562008-02-04 22:28:05 -08001799 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
1800
Nick Piggin75ad23b2008-04-29 14:48:33 +02001801 /* New queue, no concurrency on queue_flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 if (!shost->use_clustering)
Nick Piggin75ad23b2008-04-29 14:48:33 +02001803 queue_flag_clear_unlocked(QUEUE_FLAG_CLUSTER, q);
James Bottomley465ff312008-01-01 10:00:10 -06001804
1805 /*
1806 * set a reasonable default alignment on word boundaries: the
1807 * host and device may alter it using
1808 * blk_queue_update_dma_alignment() later.
1809 */
1810 blk_queue_dma_alignment(q, 0x03);
1811
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 return q;
1813}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001814EXPORT_SYMBOL(__scsi_alloc_queue);
1815
1816struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
1817{
1818 struct request_queue *q;
1819
1820 q = __scsi_alloc_queue(sdev->host, scsi_request_fn);
1821 if (!q)
1822 return NULL;
1823
1824 blk_queue_prep_rq(q, scsi_prep_fn);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001825 blk_queue_softirq_done(q, scsi_softirq_done);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001826 blk_queue_rq_timed_out(q, scsi_times_out);
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001827 blk_queue_lld_busy(q, scsi_lld_busy);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001828 return q;
1829}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830
1831void scsi_free_queue(struct request_queue *q)
1832{
1833 blk_cleanup_queue(q);
1834}
1835
1836/*
1837 * Function: scsi_block_requests()
1838 *
1839 * Purpose: Utility function used by low-level drivers to prevent further
1840 * commands from being queued to the device.
1841 *
1842 * Arguments: shost - Host in question
1843 *
1844 * Returns: Nothing
1845 *
1846 * Lock status: No locks are assumed held.
1847 *
1848 * Notes: There is no timer nor any other means by which the requests
1849 * get unblocked other than the low-level driver calling
1850 * scsi_unblock_requests().
1851 */
1852void scsi_block_requests(struct Scsi_Host *shost)
1853{
1854 shost->host_self_blocked = 1;
1855}
1856EXPORT_SYMBOL(scsi_block_requests);
1857
1858/*
1859 * Function: scsi_unblock_requests()
1860 *
1861 * Purpose: Utility function used by low-level drivers to allow further
1862 * commands from being queued to the device.
1863 *
1864 * Arguments: shost - Host in question
1865 *
1866 * Returns: Nothing
1867 *
1868 * Lock status: No locks are assumed held.
1869 *
1870 * Notes: There is no timer nor any other means by which the requests
1871 * get unblocked other than the low-level driver calling
1872 * scsi_unblock_requests().
1873 *
1874 * This is done as an API function so that changes to the
1875 * internals of the scsi mid-layer won't require wholesale
1876 * changes to drivers that use this feature.
1877 */
1878void scsi_unblock_requests(struct Scsi_Host *shost)
1879{
1880 shost->host_self_blocked = 0;
1881 scsi_run_host_queues(shost);
1882}
1883EXPORT_SYMBOL(scsi_unblock_requests);
1884
1885int __init scsi_init_queue(void)
1886{
1887 int i;
1888
Mike Christieaa7b5cd2005-11-11 05:31:41 -06001889 scsi_io_context_cache = kmem_cache_create("scsi_io_context",
1890 sizeof(struct scsi_io_context),
Paul Mundt20c2df82007-07-20 10:11:58 +09001891 0, 0, NULL);
Mike Christieaa7b5cd2005-11-11 05:31:41 -06001892 if (!scsi_io_context_cache) {
1893 printk(KERN_ERR "SCSI: can't init scsi io context cache\n");
1894 return -ENOMEM;
1895 }
1896
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001897 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1898 sizeof(struct scsi_data_buffer),
1899 0, 0, NULL);
1900 if (!scsi_sdb_cache) {
1901 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001902 goto cleanup_io_context;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001903 }
1904
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1906 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1907 int size = sgp->size * sizeof(struct scatterlist);
1908
1909 sgp->slab = kmem_cache_create(sgp->name, size, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09001910 SLAB_HWCACHE_ALIGN, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 if (!sgp->slab) {
1912 printk(KERN_ERR "SCSI: can't init sg slab %s\n",
1913 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001914 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 }
1916
Matthew Dobson93d23412006-03-26 01:37:50 -08001917 sgp->pool = mempool_create_slab_pool(SG_MEMPOOL_SIZE,
1918 sgp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 if (!sgp->pool) {
1920 printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
1921 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001922 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 }
1924 }
1925
1926 return 0;
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001927
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001928cleanup_sdb:
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001929 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1930 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1931 if (sgp->pool)
1932 mempool_destroy(sgp->pool);
1933 if (sgp->slab)
1934 kmem_cache_destroy(sgp->slab);
1935 }
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001936 kmem_cache_destroy(scsi_sdb_cache);
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001937cleanup_io_context:
1938 kmem_cache_destroy(scsi_io_context_cache);
1939
1940 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941}
1942
1943void scsi_exit_queue(void)
1944{
1945 int i;
1946
Mike Christieaa7b5cd2005-11-11 05:31:41 -06001947 kmem_cache_destroy(scsi_io_context_cache);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001948 kmem_cache_destroy(scsi_sdb_cache);
Mike Christieaa7b5cd2005-11-11 05:31:41 -06001949
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1951 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1952 mempool_destroy(sgp->pool);
1953 kmem_cache_destroy(sgp->slab);
1954 }
1955}
James Bottomley5baba832006-03-18 14:10:35 -06001956
1957/**
1958 * scsi_mode_select - issue a mode select
1959 * @sdev: SCSI device to be queried
1960 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1961 * @sp: Save page bit (0 == don't save, 1 == save)
1962 * @modepage: mode page being requested
1963 * @buffer: request buffer (may not be smaller than eight bytes)
1964 * @len: length of request buffer.
1965 * @timeout: command timeout
1966 * @retries: number of retries before failing
1967 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001968 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001969 * must be SCSI_SENSE_BUFFERSIZE big.
1970 *
1971 * Returns zero if successful; negative error number or scsi
1972 * status on error
1973 *
1974 */
1975int
1976scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1977 unsigned char *buffer, int len, int timeout, int retries,
1978 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1979{
1980 unsigned char cmd[10];
1981 unsigned char *real_buffer;
1982 int ret;
1983
1984 memset(cmd, 0, sizeof(cmd));
1985 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
1986
1987 if (sdev->use_10_for_ms) {
1988 if (len > 65535)
1989 return -EINVAL;
1990 real_buffer = kmalloc(8 + len, GFP_KERNEL);
1991 if (!real_buffer)
1992 return -ENOMEM;
1993 memcpy(real_buffer + 8, buffer, len);
1994 len += 8;
1995 real_buffer[0] = 0;
1996 real_buffer[1] = 0;
1997 real_buffer[2] = data->medium_type;
1998 real_buffer[3] = data->device_specific;
1999 real_buffer[4] = data->longlba ? 0x01 : 0;
2000 real_buffer[5] = 0;
2001 real_buffer[6] = data->block_descriptor_length >> 8;
2002 real_buffer[7] = data->block_descriptor_length;
2003
2004 cmd[0] = MODE_SELECT_10;
2005 cmd[7] = len >> 8;
2006 cmd[8] = len;
2007 } else {
2008 if (len > 255 || data->block_descriptor_length > 255 ||
2009 data->longlba)
2010 return -EINVAL;
2011
2012 real_buffer = kmalloc(4 + len, GFP_KERNEL);
2013 if (!real_buffer)
2014 return -ENOMEM;
2015 memcpy(real_buffer + 4, buffer, len);
2016 len += 4;
2017 real_buffer[0] = 0;
2018 real_buffer[1] = data->medium_type;
2019 real_buffer[2] = data->device_specific;
2020 real_buffer[3] = data->block_descriptor_length;
2021
2022
2023 cmd[0] = MODE_SELECT;
2024 cmd[4] = len;
2025 }
2026
2027 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002028 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06002029 kfree(real_buffer);
2030 return ret;
2031}
2032EXPORT_SYMBOL_GPL(scsi_mode_select);
2033
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034/**
Rob Landleyeb448202007-11-03 13:30:39 -05002035 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05002036 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 * @dbd: set if mode sense will allow block descriptors to be returned
2038 * @modepage: mode page being requested
2039 * @buffer: request buffer (may not be smaller than eight bytes)
2040 * @len: length of request buffer.
2041 * @timeout: command timeout
2042 * @retries: number of retries before failing
2043 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05002044 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05002045 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 *
2047 * Returns zero if unsuccessful, or the header offset (either 4
2048 * or 8 depending on whether a six or ten byte command was
2049 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05002050 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051int
James Bottomley1cf72692005-08-28 11:27:01 -05002052scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06002054 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
2055{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 unsigned char cmd[12];
2057 int use_10_for_ms;
2058 int header_length;
James Bottomley1cf72692005-08-28 11:27:01 -05002059 int result;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002060 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061
2062 memset(data, 0, sizeof(*data));
2063 memset(&cmd[0], 0, 12);
2064 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
2065 cmd[2] = modepage;
2066
James Bottomleyea73a9f2005-08-28 11:33:52 -05002067 /* caller might not be interested in sense, but we need it */
2068 if (!sshdr)
2069 sshdr = &my_sshdr;
2070
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05002072 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073
2074 if (use_10_for_ms) {
2075 if (len < 8)
2076 len = 8;
2077
2078 cmd[0] = MODE_SENSE_10;
2079 cmd[8] = len;
2080 header_length = 8;
2081 } else {
2082 if (len < 4)
2083 len = 4;
2084
2085 cmd[0] = MODE_SENSE;
2086 cmd[4] = len;
2087 header_length = 4;
2088 }
2089
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 memset(buffer, 0, len);
2091
James Bottomley1cf72692005-08-28 11:27:01 -05002092 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002093 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094
2095 /* This code looks awful: what it's doing is making sure an
2096 * ILLEGAL REQUEST sense return identifies the actual command
2097 * byte as the problem. MODE_SENSE commands can return
2098 * ILLEGAL REQUEST if the code page isn't supported */
2099
James Bottomley1cf72692005-08-28 11:27:01 -05002100 if (use_10_for_ms && !scsi_status_is_good(result) &&
2101 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002102 if (scsi_sense_valid(sshdr)) {
2103 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2104 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 /*
2106 * Invalid command operation code
2107 */
James Bottomley1cf72692005-08-28 11:27:01 -05002108 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 goto retry;
2110 }
2111 }
2112 }
2113
James Bottomley1cf72692005-08-28 11:27:01 -05002114 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002115 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2116 (modepage == 6 || modepage == 8))) {
2117 /* Initio breakage? */
2118 header_length = 0;
2119 data->length = 13;
2120 data->medium_type = 0;
2121 data->device_specific = 0;
2122 data->longlba = 0;
2123 data->block_descriptor_length = 0;
2124 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 data->length = buffer[0]*256 + buffer[1] + 2;
2126 data->medium_type = buffer[2];
2127 data->device_specific = buffer[3];
2128 data->longlba = buffer[4] & 0x01;
2129 data->block_descriptor_length = buffer[6]*256
2130 + buffer[7];
2131 } else {
2132 data->length = buffer[0] + 1;
2133 data->medium_type = buffer[1];
2134 data->device_specific = buffer[2];
2135 data->block_descriptor_length = buffer[3];
2136 }
Al Viro6d73c852006-02-23 02:03:16 +01002137 data->header_length = header_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 }
2139
James Bottomley1cf72692005-08-28 11:27:01 -05002140 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141}
2142EXPORT_SYMBOL(scsi_mode_sense);
2143
James Bottomley001aac22007-12-02 19:10:40 +02002144/**
2145 * scsi_test_unit_ready - test if unit is ready
2146 * @sdev: scsi device to change the state of.
2147 * @timeout: command timeout
2148 * @retries: number of retries before failing
2149 * @sshdr_external: Optional pointer to struct scsi_sense_hdr for
2150 * returning sense. Make sure that this is cleared before passing
2151 * in.
2152 *
2153 * Returns zero if unsuccessful or an error if TUR failed. For
2154 * removable media, a return of NOT_READY or UNIT_ATTENTION is
2155 * translated to success, with the ->changed flag updated.
2156 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157int
James Bottomley001aac22007-12-02 19:10:40 +02002158scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
2159 struct scsi_sense_hdr *sshdr_external)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 char cmd[] = {
2162 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2163 };
James Bottomley001aac22007-12-02 19:10:40 +02002164 struct scsi_sense_hdr *sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002166
2167 if (!sshdr_external)
2168 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
2169 else
2170 sshdr = sshdr_external;
2171
2172 /* try to eat the UNIT_ATTENTION if there are enough retries */
2173 do {
2174 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002175 timeout, retries, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002176 if (sdev->removable && scsi_sense_valid(sshdr) &&
2177 sshdr->sense_key == UNIT_ATTENTION)
2178 sdev->changed = 1;
2179 } while (scsi_sense_valid(sshdr) &&
2180 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002181
2182 if (!sshdr)
2183 /* could not allocate sense buffer, so can't process it */
2184 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185
James Bottomley32c356d2008-08-20 00:58:13 +02002186 if (sdev->removable && scsi_sense_valid(sshdr) &&
2187 (sshdr->sense_key == UNIT_ATTENTION ||
2188 sshdr->sense_key == NOT_READY)) {
2189 sdev->changed = 1;
2190 result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 }
James Bottomley001aac22007-12-02 19:10:40 +02002192 if (!sshdr_external)
2193 kfree(sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 return result;
2195}
2196EXPORT_SYMBOL(scsi_test_unit_ready);
2197
2198/**
Rob Landleyeb448202007-11-03 13:30:39 -05002199 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 * @sdev: scsi device to change the state of.
2201 * @state: state to change to.
2202 *
2203 * Returns zero if unsuccessful or an error if the requested
2204 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002205 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206int
2207scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2208{
2209 enum scsi_device_state oldstate = sdev->sdev_state;
2210
2211 if (state == oldstate)
2212 return 0;
2213
2214 switch (state) {
2215 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002216 switch (oldstate) {
2217 case SDEV_CREATED_BLOCK:
2218 break;
2219 default:
2220 goto illegal;
2221 }
2222 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223
2224 case SDEV_RUNNING:
2225 switch (oldstate) {
2226 case SDEV_CREATED:
2227 case SDEV_OFFLINE:
2228 case SDEV_QUIESCE:
2229 case SDEV_BLOCK:
2230 break;
2231 default:
2232 goto illegal;
2233 }
2234 break;
2235
2236 case SDEV_QUIESCE:
2237 switch (oldstate) {
2238 case SDEV_RUNNING:
2239 case SDEV_OFFLINE:
2240 break;
2241 default:
2242 goto illegal;
2243 }
2244 break;
2245
2246 case SDEV_OFFLINE:
2247 switch (oldstate) {
2248 case SDEV_CREATED:
2249 case SDEV_RUNNING:
2250 case SDEV_QUIESCE:
2251 case SDEV_BLOCK:
2252 break;
2253 default:
2254 goto illegal;
2255 }
2256 break;
2257
2258 case SDEV_BLOCK:
2259 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002261 case SDEV_CREATED_BLOCK:
2262 break;
2263 default:
2264 goto illegal;
2265 }
2266 break;
2267
2268 case SDEV_CREATED_BLOCK:
2269 switch (oldstate) {
2270 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 break;
2272 default:
2273 goto illegal;
2274 }
2275 break;
2276
2277 case SDEV_CANCEL:
2278 switch (oldstate) {
2279 case SDEV_CREATED:
2280 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002281 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282 case SDEV_OFFLINE:
2283 case SDEV_BLOCK:
2284 break;
2285 default:
2286 goto illegal;
2287 }
2288 break;
2289
2290 case SDEV_DEL:
2291 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002292 case SDEV_CREATED:
2293 case SDEV_RUNNING:
2294 case SDEV_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 case SDEV_CANCEL:
2296 break;
2297 default:
2298 goto illegal;
2299 }
2300 break;
2301
2302 }
2303 sdev->sdev_state = state;
2304 return 0;
2305
2306 illegal:
2307 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002308 sdev_printk(KERN_ERR, sdev,
2309 "Illegal state transition %s->%s\n",
2310 scsi_device_state_name(oldstate),
2311 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 );
2313 return -EINVAL;
2314}
2315EXPORT_SYMBOL(scsi_device_set_state);
2316
2317/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002318 * sdev_evt_emit - emit a single SCSI device uevent
2319 * @sdev: associated SCSI device
2320 * @evt: event to emit
2321 *
2322 * Send a single uevent (scsi_event) to the associated scsi_device.
2323 */
2324static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2325{
2326 int idx = 0;
2327 char *envp[3];
2328
2329 switch (evt->evt_type) {
2330 case SDEV_EVT_MEDIA_CHANGE:
2331 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2332 break;
2333
2334 default:
2335 /* do nothing */
2336 break;
2337 }
2338
2339 envp[idx++] = NULL;
2340
2341 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2342}
2343
2344/**
2345 * sdev_evt_thread - send a uevent for each scsi event
2346 * @work: work struct for scsi_device
2347 *
2348 * Dispatch queued events to their associated scsi_device kobjects
2349 * as uevents.
2350 */
2351void scsi_evt_thread(struct work_struct *work)
2352{
2353 struct scsi_device *sdev;
2354 LIST_HEAD(event_list);
2355
2356 sdev = container_of(work, struct scsi_device, event_work);
2357
2358 while (1) {
2359 struct scsi_event *evt;
2360 struct list_head *this, *tmp;
2361 unsigned long flags;
2362
2363 spin_lock_irqsave(&sdev->list_lock, flags);
2364 list_splice_init(&sdev->event_list, &event_list);
2365 spin_unlock_irqrestore(&sdev->list_lock, flags);
2366
2367 if (list_empty(&event_list))
2368 break;
2369
2370 list_for_each_safe(this, tmp, &event_list) {
2371 evt = list_entry(this, struct scsi_event, node);
2372 list_del(&evt->node);
2373 scsi_evt_emit(sdev, evt);
2374 kfree(evt);
2375 }
2376 }
2377}
2378
2379/**
2380 * sdev_evt_send - send asserted event to uevent thread
2381 * @sdev: scsi_device event occurred on
2382 * @evt: event to send
2383 *
2384 * Assert scsi device event asynchronously.
2385 */
2386void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2387{
2388 unsigned long flags;
2389
Kay Sievers4d1566e2008-03-19 13:04:47 +01002390#if 0
2391 /* FIXME: currently this check eliminates all media change events
2392 * for polled devices. Need to update to discriminate between AN
2393 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002394 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2395 kfree(evt);
2396 return;
2397 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002398#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002399
2400 spin_lock_irqsave(&sdev->list_lock, flags);
2401 list_add_tail(&evt->node, &sdev->event_list);
2402 schedule_work(&sdev->event_work);
2403 spin_unlock_irqrestore(&sdev->list_lock, flags);
2404}
2405EXPORT_SYMBOL_GPL(sdev_evt_send);
2406
2407/**
2408 * sdev_evt_alloc - allocate a new scsi event
2409 * @evt_type: type of event to allocate
2410 * @gfpflags: GFP flags for allocation
2411 *
2412 * Allocates and returns a new scsi_event.
2413 */
2414struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2415 gfp_t gfpflags)
2416{
2417 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2418 if (!evt)
2419 return NULL;
2420
2421 evt->evt_type = evt_type;
2422 INIT_LIST_HEAD(&evt->node);
2423
2424 /* evt_type-specific initialization, if any */
2425 switch (evt_type) {
2426 case SDEV_EVT_MEDIA_CHANGE:
2427 default:
2428 /* do nothing */
2429 break;
2430 }
2431
2432 return evt;
2433}
2434EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2435
2436/**
2437 * sdev_evt_send_simple - send asserted event to uevent thread
2438 * @sdev: scsi_device event occurred on
2439 * @evt_type: type of event to send
2440 * @gfpflags: GFP flags for allocation
2441 *
2442 * Assert scsi device event asynchronously, given an event type.
2443 */
2444void sdev_evt_send_simple(struct scsi_device *sdev,
2445 enum scsi_device_event evt_type, gfp_t gfpflags)
2446{
2447 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2448 if (!evt) {
2449 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2450 evt_type);
2451 return;
2452 }
2453
2454 sdev_evt_send(sdev, evt);
2455}
2456EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2457
2458/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 * scsi_device_quiesce - Block user issued commands.
2460 * @sdev: scsi device to quiesce.
2461 *
2462 * This works by trying to transition to the SDEV_QUIESCE state
2463 * (which must be a legal transition). When the device is in this
2464 * state, only special requests will be accepted, all others will
2465 * be deferred. Since special requests may also be requeued requests,
2466 * a successful return doesn't guarantee the device will be
2467 * totally quiescent.
2468 *
2469 * Must be called with user context, may sleep.
2470 *
2471 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002472 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473int
2474scsi_device_quiesce(struct scsi_device *sdev)
2475{
2476 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2477 if (err)
2478 return err;
2479
2480 scsi_run_queue(sdev->request_queue);
2481 while (sdev->device_busy) {
2482 msleep_interruptible(200);
2483 scsi_run_queue(sdev->request_queue);
2484 }
2485 return 0;
2486}
2487EXPORT_SYMBOL(scsi_device_quiesce);
2488
2489/**
2490 * scsi_device_resume - Restart user issued commands to a quiesced device.
2491 * @sdev: scsi device to resume.
2492 *
2493 * Moves the device from quiesced back to running and restarts the
2494 * queues.
2495 *
2496 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002497 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498void
2499scsi_device_resume(struct scsi_device *sdev)
2500{
2501 if(scsi_device_set_state(sdev, SDEV_RUNNING))
2502 return;
2503 scsi_run_queue(sdev->request_queue);
2504}
2505EXPORT_SYMBOL(scsi_device_resume);
2506
2507static void
2508device_quiesce_fn(struct scsi_device *sdev, void *data)
2509{
2510 scsi_device_quiesce(sdev);
2511}
2512
2513void
2514scsi_target_quiesce(struct scsi_target *starget)
2515{
2516 starget_for_each_device(starget, NULL, device_quiesce_fn);
2517}
2518EXPORT_SYMBOL(scsi_target_quiesce);
2519
2520static void
2521device_resume_fn(struct scsi_device *sdev, void *data)
2522{
2523 scsi_device_resume(sdev);
2524}
2525
2526void
2527scsi_target_resume(struct scsi_target *starget)
2528{
2529 starget_for_each_device(starget, NULL, device_resume_fn);
2530}
2531EXPORT_SYMBOL(scsi_target_resume);
2532
2533/**
Rob Landleyeb448202007-11-03 13:30:39 -05002534 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535 * @sdev: device to block
2536 *
2537 * Block request made by scsi lld's to temporarily stop all
2538 * scsi commands on the specified device. Called from interrupt
2539 * or normal process context.
2540 *
2541 * Returns zero if successful or error if not
2542 *
2543 * Notes:
2544 * This routine transitions the device to the SDEV_BLOCK state
2545 * (which must be a legal transition). When the device is in this
2546 * state, all commands are deferred until the scsi lld reenables
2547 * the device with scsi_device_unblock or device_block_tmo fires.
2548 * This routine assumes the host_lock is held on entry.
Rob Landleyeb448202007-11-03 13:30:39 -05002549 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550int
2551scsi_internal_device_block(struct scsi_device *sdev)
2552{
Jens Axboe165125e2007-07-24 09:28:11 +02002553 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002554 unsigned long flags;
2555 int err = 0;
2556
2557 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002558 if (err) {
2559 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2560
2561 if (err)
2562 return err;
2563 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564
2565 /*
2566 * The device has transitioned to SDEV_BLOCK. Stop the
2567 * block layer from calling the midlayer with this device's
2568 * request queue.
2569 */
2570 spin_lock_irqsave(q->queue_lock, flags);
2571 blk_stop_queue(q);
2572 spin_unlock_irqrestore(q->queue_lock, flags);
2573
2574 return 0;
2575}
2576EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2577
2578/**
2579 * scsi_internal_device_unblock - resume a device after a block request
2580 * @sdev: device to resume
2581 *
2582 * Called by scsi lld's or the midlayer to restart the device queue
2583 * for the previously suspended scsi device. Called from interrupt or
2584 * normal process context.
2585 *
2586 * Returns zero if successful or error if not.
2587 *
2588 * Notes:
2589 * This routine transitions the device to the SDEV_RUNNING state
2590 * (which must be a legal transition) allowing the midlayer to
2591 * goose the queue for this device. This routine assumes the
2592 * host_lock is held upon entry.
Rob Landleyeb448202007-11-03 13:30:39 -05002593 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594int
2595scsi_internal_device_unblock(struct scsi_device *sdev)
2596{
Jens Axboe165125e2007-07-24 09:28:11 +02002597 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 int err;
2599 unsigned long flags;
2600
2601 /*
2602 * Try to transition the scsi device to SDEV_RUNNING
2603 * and goose the device queue if successful.
2604 */
2605 err = scsi_device_set_state(sdev, SDEV_RUNNING);
James Bottomley6f4267e2008-08-22 16:53:31 -05002606 if (err) {
2607 err = scsi_device_set_state(sdev, SDEV_CREATED);
2608
2609 if (err)
2610 return err;
2611 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612
2613 spin_lock_irqsave(q->queue_lock, flags);
2614 blk_start_queue(q);
2615 spin_unlock_irqrestore(q->queue_lock, flags);
2616
2617 return 0;
2618}
2619EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
2620
2621static void
2622device_block(struct scsi_device *sdev, void *data)
2623{
2624 scsi_internal_device_block(sdev);
2625}
2626
2627static int
2628target_block(struct device *dev, void *data)
2629{
2630 if (scsi_is_target_device(dev))
2631 starget_for_each_device(to_scsi_target(dev), NULL,
2632 device_block);
2633 return 0;
2634}
2635
2636void
2637scsi_target_block(struct device *dev)
2638{
2639 if (scsi_is_target_device(dev))
2640 starget_for_each_device(to_scsi_target(dev), NULL,
2641 device_block);
2642 else
2643 device_for_each_child(dev, NULL, target_block);
2644}
2645EXPORT_SYMBOL_GPL(scsi_target_block);
2646
2647static void
2648device_unblock(struct scsi_device *sdev, void *data)
2649{
2650 scsi_internal_device_unblock(sdev);
2651}
2652
2653static int
2654target_unblock(struct device *dev, void *data)
2655{
2656 if (scsi_is_target_device(dev))
2657 starget_for_each_device(to_scsi_target(dev), NULL,
2658 device_unblock);
2659 return 0;
2660}
2661
2662void
2663scsi_target_unblock(struct device *dev)
2664{
2665 if (scsi_is_target_device(dev))
2666 starget_for_each_device(to_scsi_target(dev), NULL,
2667 device_unblock);
2668 else
2669 device_for_each_child(dev, NULL, target_unblock);
2670}
2671EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002672
2673/**
2674 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002675 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002676 * @sg_count: number of segments in sg
2677 * @offset: offset in bytes into sg, on return offset into the mapped area
2678 * @len: bytes to map, on return number of bytes mapped
2679 *
2680 * Returns virtual address of the start of the mapped page
2681 */
Jens Axboec6132da2007-10-16 11:08:49 +02002682void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002683 size_t *offset, size_t *len)
2684{
2685 int i;
2686 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002687 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002688 struct page *page;
2689
Andrew Morton22cfefb2007-02-05 16:39:03 -08002690 WARN_ON(!irqs_disabled());
2691
Jens Axboec6132da2007-10-16 11:08:49 +02002692 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002693 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002694 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002695 if (sg_len > *offset)
2696 break;
2697 }
2698
2699 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002700 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2701 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002702 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002703 WARN_ON(1);
2704 return NULL;
2705 }
2706
2707 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002708 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002709
2710 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002711 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002712 *offset &= ~PAGE_MASK;
2713
2714 /* Bytes in this sg-entry from *offset to the end of the page */
2715 sg_len = PAGE_SIZE - *offset;
2716 if (*len > sg_len)
2717 *len = sg_len;
2718
2719 return kmap_atomic(page, KM_BIO_SRC_IRQ);
2720}
2721EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2722
2723/**
Rob Landleyeb448202007-11-03 13:30:39 -05002724 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002725 * @virt: virtual address to be unmapped
2726 */
2727void scsi_kunmap_atomic_sg(void *virt)
2728{
2729 kunmap_atomic(virt, KM_BIO_SRC_IRQ);
2730}
2731EXPORT_SYMBOL(scsi_kunmap_atomic_sg);