blob: b58327758c58ca021a0a7860146fe431481d6893 [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>
Paul Gortmaker09703662011-05-27 09:37:25 -040015#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/mempool.h>
17#include <linux/slab.h>
18#include <linux/init.h>
19#include <linux/pci.h>
20#include <linux/delay.h>
James Bottomleyfaead262006-02-14 10:42:07 -060021#include <linux/hardirq.h>
Jens Axboec6132da2007-10-16 11:08:49 +020022#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020025#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <scsi/scsi_dbg.h>
27#include <scsi/scsi_device.h>
28#include <scsi/scsi_driver.h>
29#include <scsi/scsi_eh.h>
30#include <scsi/scsi_host.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32#include "scsi_priv.h"
33#include "scsi_logging.h"
34
35
Tobias Klauser6391a112006-06-08 22:23:48 -070036#define SG_MEMPOOL_NR ARRAY_SIZE(scsi_sg_pools)
Jens Axboe59725112007-04-02 10:06:42 +020037#define SG_MEMPOOL_SIZE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39struct scsi_host_sg_pool {
40 size_t size;
Jens Axboea8474ce2007-08-07 09:02:51 +020041 char *name;
Christoph Lametere18b8902006-12-06 20:33:20 -080042 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 mempool_t *pool;
44};
45
James Bottomleyd3f46f32008-01-15 11:11:46 -060046#define SP(x) { x, "sgpool-" __stringify(x) }
47#if (SCSI_MAX_SG_SEGMENTS < 32)
48#error SCSI_MAX_SG_SEGMENTS is too small (must be 32 or greater)
49#endif
Adrian Bunk52c1da32005-06-23 22:05:33 -070050static struct scsi_host_sg_pool scsi_sg_pools[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 SP(8),
52 SP(16),
FUJITA Tomonorifd820f42007-09-18 12:14:37 +020053#if (SCSI_MAX_SG_SEGMENTS > 32)
James Bottomleyd3f46f32008-01-15 11:11:46 -060054 SP(32),
FUJITA Tomonorifd820f42007-09-18 12:14:37 +020055#if (SCSI_MAX_SG_SEGMENTS > 64)
James Bottomleyd3f46f32008-01-15 11:11:46 -060056 SP(64),
57#if (SCSI_MAX_SG_SEGMENTS > 128)
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 SP(128),
James Bottomleyd3f46f32008-01-15 11:11:46 -060059#if (SCSI_MAX_SG_SEGMENTS > 256)
60#error SCSI_MAX_SG_SEGMENTS is too large (256 MAX)
FUJITA Tomonorifd820f42007-09-18 12:14:37 +020061#endif
62#endif
63#endif
James Bottomleyd3f46f32008-01-15 11:11:46 -060064#endif
65 SP(SCSI_MAX_SG_SEGMENTS)
Jens Axboea8474ce2007-08-07 09:02:51 +020066};
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#undef SP
68
Martin K. Petersen7027ad72008-07-17 17:08:48 -040069struct kmem_cache *scsi_sdb_cache;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +020070
Jens Axboea488e742010-04-16 21:13:15 +020071/*
72 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
73 * not change behaviour from the previous unplug mechanism, experimentation
74 * may prove this needs changing.
75 */
76#define SCSI_QUEUE_DELAY 3
77
James Bottomleye91442b2005-09-09 10:44:16 -050078/*
79 * Function: scsi_unprep_request()
80 *
81 * Purpose: Remove all preparation done for a request, including its
82 * associated scsi_cmnd, so that it can be requeued.
83 *
84 * Arguments: req - request to unprepare
85 *
86 * Lock status: Assumed that no locks are held upon entry.
87 *
88 * Returns: Nothing.
89 */
90static void scsi_unprep_request(struct request *req)
91{
92 struct scsi_cmnd *cmd = req->special;
93
James Bottomley28018c22010-07-01 19:49:17 +090094 blk_unprep_request(req);
Christoph Hellwigbeb40482006-06-10 18:01:03 +020095 req->special = NULL;
James Bottomleye91442b2005-09-09 10:44:16 -050096
James Bottomleye91442b2005-09-09 10:44:16 -050097 scsi_put_command(cmd);
98}
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -050099
James Bottomley4f5299a2009-01-02 10:42:21 -0600100/**
101 * __scsi_queue_insert - private queue insertion
102 * @cmd: The SCSI command being requeued
103 * @reason: The reason for the requeue
104 * @unbusy: Whether the queue should be unbusied
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 *
James Bottomley4f5299a2009-01-02 10:42:21 -0600106 * This is a private queue insertion. The public interface
107 * scsi_queue_insert() always assumes the queue should be unbusied
108 * because it's always called before the completion. This function is
109 * for a requeue after completion, which should only occur in this
110 * file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000112static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
114 struct Scsi_Host *host = cmd->device->host;
115 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500116 struct scsi_target *starget = scsi_target(device);
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500117 struct request_queue *q = device->request_queue;
118 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120 SCSI_LOG_MLQUEUE(1,
121 printk("Inserting command %p into mlqueue\n", cmd));
122
123 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900124 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 *
126 * If the host/device isn't busy, assume that something actually
127 * completed, and that we should be able to queue a command now.
128 *
129 * Note that the prior mid-layer assumption that any host could
130 * always queue at least one command is now broken. The mid-layer
131 * will implement a user specifiable stall (see
132 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
133 * if a command is requeued with no other commands outstanding
134 * either for the device or for the host.
135 */
Mike Christief0c0a372008-08-17 15:24:38 -0500136 switch (reason) {
137 case SCSI_MLQUEUE_HOST_BUSY:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 host->host_blocked = host->max_host_blocked;
Mike Christief0c0a372008-08-17 15:24:38 -0500139 break;
140 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400141 case SCSI_MLQUEUE_EH_RETRY:
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 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600153 if (unbusy)
154 scsi_device_unbusy(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500157 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000158 * that are already in the queue. Schedule requeue work under
159 * lock such that the kblockd_schedule_work() call happens
160 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200161 */
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500162 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley59897da2005-09-14 12:57:42 -0400163 blk_requeue_request(q, cmd->request);
Jens Axboe9937a5e2011-05-17 11:04:44 +0200164 kblockd_schedule_work(q, &device->requeue_work);
Bart Van Asscheb4854622012-06-29 15:36:07 +0000165 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166}
167
James Bottomley4f5299a2009-01-02 10:42:21 -0600168/*
169 * Function: scsi_queue_insert()
170 *
171 * Purpose: Insert a command in the midlevel queue.
172 *
173 * Arguments: cmd - command that we are adding to queue.
174 * reason - why we are inserting command to queue.
175 *
176 * Lock status: Assumed that lock is not held upon entry.
177 *
178 * Returns: Nothing.
179 *
180 * Notes: We do this for one of two cases. Either the host is busy
181 * and it cannot accept any more commands for the time being,
182 * or the device returned QUEUE_FULL and can accept no more
183 * commands.
184 * Notes: This could be called either from an interrupt context or a
185 * normal process context.
186 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000187void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600188{
Bart Van Assche84feb162012-06-29 15:35:05 +0000189 __scsi_queue_insert(cmd, reason, 1);
James Bottomley4f5299a2009-01-02 10:42:21 -0600190}
James Bottomley39216032005-06-15 18:48:29 -0500191/**
James Bottomley33aa6872005-08-28 11:31:14 -0500192 * scsi_execute - insert request and wait for the result
James Bottomley39216032005-06-15 18:48:29 -0500193 * @sdev: scsi device
194 * @cmd: scsi command
195 * @data_direction: data direction
196 * @buffer: data buffer
197 * @bufflen: len of buffer
198 * @sense: optional sense buffer
199 * @timeout: request timeout in seconds
200 * @retries: number of times to retry request
James Bottomley33aa6872005-08-28 11:31:14 -0500201 * @flags: or into request flags;
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900202 * @resid: optional residual length
James Bottomley39216032005-06-15 18:48:29 -0500203 *
Michael Opdenacker59c51592007-05-09 08:57:56 +0200204 * returns the req->errors value which is the scsi_cmnd result
James Bottomleyea73a9f2005-08-28 11:33:52 -0500205 * field.
Rob Landleyeb448202007-11-03 13:30:39 -0500206 */
James Bottomley33aa6872005-08-28 11:31:14 -0500207int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
208 int data_direction, void *buffer, unsigned bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900209 unsigned char *sense, int timeout, int retries, int flags,
210 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500211{
212 struct request *req;
213 int write = (data_direction == DMA_TO_DEVICE);
214 int ret = DRIVER_ERROR << 24;
215
216 req = blk_get_request(sdev->request_queue, write, __GFP_WAIT);
James Bottomleybfe159a2011-07-07 15:45:40 -0500217 if (!req)
218 return ret;
James Bottomley39216032005-06-15 18:48:29 -0500219
220 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
221 buffer, bufflen, __GFP_WAIT))
222 goto out;
223
224 req->cmd_len = COMMAND_SIZE(cmd[0]);
225 memcpy(req->cmd, cmd, req->cmd_len);
226 req->sense = sense;
227 req->sense_len = 0;
Mike Christie17e01f22005-11-11 05:31:37 -0600228 req->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500229 req->timeout = timeout;
Jens Axboe4aff5e22006-08-10 08:44:47 +0200230 req->cmd_type = REQ_TYPE_BLOCK_PC;
231 req->cmd_flags |= flags | REQ_QUIET | REQ_PREEMPT;
James Bottomley39216032005-06-15 18:48:29 -0500232
233 /*
234 * head injection *required* here otherwise quiesce won't work
235 */
236 blk_execute_rq(req->q, NULL, req, 1);
237
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400238 /*
239 * Some devices (USB mass-storage in particular) may transfer
240 * garbage data together with a residue indicating that the data
241 * is invalid. Prevent the garbage from being misinterpreted
242 * and prevent security leaks by zeroing out the excess data.
243 */
Tejun Heoc3a4d782009-05-07 22:24:37 +0900244 if (unlikely(req->resid_len > 0 && req->resid_len <= bufflen))
245 memset(buffer + (bufflen - req->resid_len), 0, req->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400246
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900247 if (resid)
Tejun Heoc3a4d782009-05-07 22:24:37 +0900248 *resid = req->resid_len;
James Bottomley39216032005-06-15 18:48:29 -0500249 ret = req->errors;
250 out:
251 blk_put_request(req);
252
253 return ret;
254}
James Bottomley33aa6872005-08-28 11:31:14 -0500255EXPORT_SYMBOL(scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500256
James Bottomleyea73a9f2005-08-28 11:33:52 -0500257
258int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
259 int data_direction, void *buffer, unsigned bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900260 struct scsi_sense_hdr *sshdr, int timeout, int retries,
261 int *resid)
James Bottomleyea73a9f2005-08-28 11:33:52 -0500262{
263 char *sense = NULL;
akpm@osdl.org1ccb48b2005-06-26 00:12:51 -0700264 int result;
265
James Bottomleyea73a9f2005-08-28 11:33:52 -0500266 if (sshdr) {
Jes Sorensen24669f752006-01-16 10:31:18 -0500267 sense = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500268 if (!sense)
269 return DRIVER_ERROR << 24;
James Bottomleyea73a9f2005-08-28 11:33:52 -0500270 }
akpm@osdl.org1ccb48b2005-06-26 00:12:51 -0700271 result = scsi_execute(sdev, cmd, data_direction, buffer, bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900272 sense, timeout, retries, 0, resid);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500273 if (sshdr)
James Bottomleye5143852005-08-09 11:55:36 -0500274 scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, sshdr);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500275
276 kfree(sense);
277 return result;
278}
279EXPORT_SYMBOL(scsi_execute_req);
280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281/*
282 * Function: scsi_init_cmd_errh()
283 *
284 * Purpose: Initialize cmd fields related to error handling.
285 *
286 * Arguments: cmd - command that is ready to be queued.
287 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 * Notes: This function has the job of initializing a number of
289 * fields related to error handling. Typically this will
290 * be called once for each command, as required.
291 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200292static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 cmd->serial_number = 0;
Boaz Harrosh30b0c37b2007-12-13 13:47:40 +0200295 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900296 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300298 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299}
300
301void scsi_device_unbusy(struct scsi_device *sdev)
302{
303 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500304 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 unsigned long flags;
306
307 spin_lock_irqsave(shost->host_lock, flags);
308 shost->host_busy--;
Mike Christief0c0a372008-08-17 15:24:38 -0500309 starget->target_busy--;
James Bottomley939647e2005-09-18 15:05:20 -0500310 if (unlikely(scsi_host_in_recovery(shost) &&
Tejun Heoee7863b2006-05-15 20:57:20 +0900311 (shost->host_failed || shost->host_eh_scheduled)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 scsi_eh_wakeup(shost);
313 spin_unlock(shost->host_lock);
152587d2005-04-12 16:22:06 -0500314 spin_lock(sdev->request_queue->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 sdev->device_busy--;
152587d2005-04-12 16:22:06 -0500316 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317}
318
319/*
320 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
321 * and call blk_run_queue for all the scsi_devices on the target -
322 * including current_sdev first.
323 *
324 * Called with *no* scsi locks held.
325 */
326static void scsi_single_lun_run(struct scsi_device *current_sdev)
327{
328 struct Scsi_Host *shost = current_sdev->host;
329 struct scsi_device *sdev, *tmp;
330 struct scsi_target *starget = scsi_target(current_sdev);
331 unsigned long flags;
332
333 spin_lock_irqsave(shost->host_lock, flags);
334 starget->starget_sdev_user = NULL;
335 spin_unlock_irqrestore(shost->host_lock, flags);
336
337 /*
338 * Call blk_run_queue for all LUNs on the target, starting with
339 * current_sdev. We race with others (to set starget_sdev_user),
340 * but in most cases, we will be first. Ideally, each LU on the
341 * target would get some limited time or requests on the target.
342 */
343 blk_run_queue(current_sdev->request_queue);
344
345 spin_lock_irqsave(shost->host_lock, flags);
346 if (starget->starget_sdev_user)
347 goto out;
348 list_for_each_entry_safe(sdev, tmp, &starget->devices,
349 same_target_siblings) {
350 if (sdev == current_sdev)
351 continue;
352 if (scsi_device_get(sdev))
353 continue;
354
355 spin_unlock_irqrestore(shost->host_lock, flags);
356 blk_run_queue(sdev->request_queue);
357 spin_lock_irqsave(shost->host_lock, flags);
358
359 scsi_device_put(sdev);
360 }
361 out:
362 spin_unlock_irqrestore(shost->host_lock, flags);
363}
364
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400365static inline int scsi_device_is_busy(struct scsi_device *sdev)
366{
367 if (sdev->device_busy >= sdev->queue_depth || sdev->device_blocked)
368 return 1;
369
370 return 0;
371}
372
Mike Christief0c0a372008-08-17 15:24:38 -0500373static inline int scsi_target_is_busy(struct scsi_target *starget)
374{
375 return ((starget->can_queue > 0 &&
376 starget->target_busy >= starget->can_queue) ||
377 starget->target_blocked);
378}
379
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400380static inline int scsi_host_is_busy(struct Scsi_Host *shost)
381{
382 if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
383 shost->host_blocked || shost->host_self_blocked)
384 return 1;
385
386 return 0;
387}
388
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389/*
390 * Function: scsi_run_queue()
391 *
392 * Purpose: Select a proper request queue to serve next
393 *
394 * Arguments: q - last request's queue
395 *
396 * Returns: Nothing
397 *
398 * Notes: The previous command was completely finished, start
399 * a new one if possible.
400 */
401static void scsi_run_queue(struct request_queue *q)
402{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600403 struct scsi_device *sdev = q->queuedata;
James Bottomleyc055f5b2011-05-01 09:42:07 -0500404 struct Scsi_Host *shost;
Mike Christie2a3a59e2008-11-11 13:42:35 -0600405 LIST_HEAD(starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 unsigned long flags;
407
James Bottomleyc055f5b2011-05-01 09:42:07 -0500408 shost = sdev->host;
Tony Battersby25d7c362007-11-12 10:00:44 -0500409 if (scsi_target(sdev)->single_lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 scsi_single_lun_run(sdev);
411
412 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600413 list_splice_init(&shost->starved_list, &starved_list);
414
415 while (!list_empty(&starved_list)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 /*
417 * As long as shost is accepting commands and we have
418 * starved queues, call blk_run_queue. scsi_request_fn
419 * drops the queue_lock and can add us back to the
420 * starved_list.
421 *
422 * host_lock protects the starved_list and starved_entry.
423 * scsi_request_fn must get the host_lock before checking
424 * or modifying starved_list or starved_entry.
425 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600426 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500427 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500428
Mike Christie2a3a59e2008-11-11 13:42:35 -0600429 sdev = list_entry(starved_list.next,
430 struct scsi_device, starved_entry);
431 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500432 if (scsi_target_is_busy(scsi_target(sdev))) {
433 list_move_tail(&sdev->starved_entry,
434 &shost->starved_list);
435 continue;
436 }
437
Jens Axboe9937a5e2011-05-17 11:04:44 +0200438 spin_unlock(shost->host_lock);
439 spin_lock(sdev->request_queue->queue_lock);
440 __blk_run_queue(sdev->request_queue);
441 spin_unlock(sdev->request_queue->queue_lock);
442 spin_lock(shost->host_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600444 /* put any unprocessed entries back */
445 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 spin_unlock_irqrestore(shost->host_lock, flags);
447
448 blk_run_queue(q);
449}
450
Jens Axboe9937a5e2011-05-17 11:04:44 +0200451void scsi_requeue_run_queue(struct work_struct *work)
452{
453 struct scsi_device *sdev;
454 struct request_queue *q;
455
456 sdev = container_of(work, struct scsi_device, requeue_work);
457 q = sdev->request_queue;
458 scsi_run_queue(q);
459}
460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461/*
462 * Function: scsi_requeue_command()
463 *
464 * Purpose: Handle post-processing of completed commands.
465 *
466 * Arguments: q - queue to operate on
467 * cmd - command that may need to be requeued.
468 *
469 * Returns: Nothing
470 *
471 * Notes: After command completion, there may be blocks left
472 * over which weren't finished by the previous command
473 * this can be for a number of reasons - the main one is
474 * I/O errors in the middle of the request, in which case
475 * we need to request the blocks that come after the bad
476 * sector.
James Bottomleye91442b2005-09-09 10:44:16 -0500477 * Notes: Upon return, cmd is a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 */
479static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
480{
Bart Van Assche940f5d42012-06-29 15:34:26 +0000481 struct scsi_device *sdev = cmd->device;
James Bottomleye91442b2005-09-09 10:44:16 -0500482 struct request *req = cmd->request;
Tejun Heo 283369c2005-04-24 02:06:36 -0500483 unsigned long flags;
484
Bart Van Assche940f5d42012-06-29 15:34:26 +0000485 /*
486 * We need to hold a reference on the device to avoid the queue being
487 * killed after the unlock and before scsi_run_queue is invoked which
488 * may happen because scsi_unprep_request() puts the command which
489 * releases its reference on the device.
490 */
491 get_device(&sdev->sdev_gendev);
492
Tejun Heo 283369c2005-04-24 02:06:36 -0500493 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley02bd3492008-12-12 13:28:29 -0600494 scsi_unprep_request(req);
James Bottomleye91442b2005-09-09 10:44:16 -0500495 blk_requeue_request(q, req);
Tejun Heo 283369c2005-04-24 02:06:36 -0500496 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
498 scsi_run_queue(q);
Bart Van Assche940f5d42012-06-29 15:34:26 +0000499
500 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501}
502
503void scsi_next_command(struct scsi_cmnd *cmd)
504{
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800505 struct scsi_device *sdev = cmd->device;
506 struct request_queue *q = sdev->request_queue;
507
508 /* need to hold a reference on the device before we let go of the cmd */
509 get_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
511 scsi_put_command(cmd);
512 scsi_run_queue(q);
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800513
514 /* ok to remove device now */
515 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516}
517
518void scsi_run_host_queues(struct Scsi_Host *shost)
519{
520 struct scsi_device *sdev;
521
522 shost_for_each_device(sdev, shost)
523 scsi_run_queue(sdev->request_queue);
524}
525
James Bottomley79ed2422009-01-06 13:15:20 -0600526static void __scsi_release_buffers(struct scsi_cmnd *, int);
527
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528/*
529 * Function: scsi_end_request()
530 *
531 * Purpose: Post-processing of completed commands (usually invoked at end
532 * of upper level post-processing and scsi_io_completion).
533 *
534 * Arguments: cmd - command that is complete.
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500535 * error - 0 if I/O indicates success, < 0 for I/O error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 * bytes - number of bytes of completed I/O
537 * requeue - indicates whether we should requeue leftovers.
538 *
539 * Lock status: Assumed that lock is not held upon entry.
540 *
James Bottomleye91442b2005-09-09 10:44:16 -0500541 * Returns: cmd if requeue required, NULL otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 *
543 * Notes: This is called for block device requests in order to
544 * mark some number of sectors as complete.
545 *
546 * We are guaranteeing that the request queue will be goosed
547 * at some point during this call.
James Bottomleye91442b2005-09-09 10:44:16 -0500548 * Notes: If cmd was requeued, upon return it will be a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 */
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500550static struct scsi_cmnd *scsi_end_request(struct scsi_cmnd *cmd, int error,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 int bytes, int requeue)
552{
Jens Axboe165125e2007-07-24 09:28:11 +0200553 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 struct request *req = cmd->request;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555
556 /*
557 * If there are blocks left over at the end, set up the command
558 * to queue the remainder of them.
559 */
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500560 if (blk_end_request(req, error, bytes)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 /* kill remainder if no retrys */
Mike Christie4a274462008-08-19 18:45:31 -0500562 if (error && scsi_noretry_cmd(cmd))
Tejun Heoe4588242009-05-12 08:49:32 +0200563 blk_end_request_all(req, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 else {
James Bottomleye91442b2005-09-09 10:44:16 -0500565 if (requeue) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 /*
567 * Bleah. Leftovers again. Stick the
568 * leftovers in the front of the
569 * queue, and goose the queue again.
570 */
James Bottomley79ed2422009-01-06 13:15:20 -0600571 scsi_release_buffers(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 scsi_requeue_command(q, cmd);
James Bottomleye91442b2005-09-09 10:44:16 -0500573 cmd = NULL;
574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 return cmd;
576 }
577 }
578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 /*
580 * This will goose the queue request function at the end, so we don't
581 * need to worry about launching another command.
582 */
James Bottomley79ed2422009-01-06 13:15:20 -0600583 __scsi_release_buffers(cmd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 scsi_next_command(cmd);
585 return NULL;
586}
587
Jens Axboea8474ce2007-08-07 09:02:51 +0200588static inline unsigned int scsi_sgtable_index(unsigned short nents)
589{
590 unsigned int index;
591
James Bottomleyd3f46f32008-01-15 11:11:46 -0600592 BUG_ON(nents > SCSI_MAX_SG_SEGMENTS);
593
594 if (nents <= 8)
Jens Axboea8474ce2007-08-07 09:02:51 +0200595 index = 0;
James Bottomleyd3f46f32008-01-15 11:11:46 -0600596 else
597 index = get_count_order(nents) - 3;
Jens Axboea8474ce2007-08-07 09:02:51 +0200598
599 return index;
600}
601
Jens Axboe5ed79592007-11-15 09:13:11 +0100602static void scsi_sg_free(struct scatterlist *sgl, unsigned int nents)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603{
604 struct scsi_host_sg_pool *sgp;
Jens Axboe5ed79592007-11-15 09:13:11 +0100605
606 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
607 mempool_free(sgl, sgp->pool);
608}
609
610static struct scatterlist *scsi_sg_alloc(unsigned int nents, gfp_t gfp_mask)
611{
612 struct scsi_host_sg_pool *sgp;
613
614 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
615 return mempool_alloc(sgp->pool, gfp_mask);
616}
617
Boaz Harrosh30b0c37b2007-12-13 13:47:40 +0200618static int scsi_alloc_sgtable(struct scsi_data_buffer *sdb, int nents,
619 gfp_t gfp_mask)
Jens Axboe5ed79592007-11-15 09:13:11 +0100620{
621 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Boaz Harrosh30b0c37b2007-12-13 13:47:40 +0200623 BUG_ON(!nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
Boaz Harrosh30b0c37b2007-12-13 13:47:40 +0200625 ret = __sg_alloc_table(&sdb->table, nents, SCSI_MAX_SG_SEGMENTS,
626 gfp_mask, scsi_sg_alloc);
Jens Axboe5ed79592007-11-15 09:13:11 +0100627 if (unlikely(ret))
Boaz Harrosh30b0c37b2007-12-13 13:47:40 +0200628 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS,
James Bottomley7cedb1f2008-01-13 14:15:28 -0600629 scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Jens Axboea8474ce2007-08-07 09:02:51 +0200631 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632}
633
Boaz Harrosh30b0c37b2007-12-13 13:47:40 +0200634static void scsi_free_sgtable(struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
Boaz Harrosh30b0c37b2007-12-13 13:47:40 +0200636 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS, scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637}
638
James Bottomley79ed2422009-01-06 13:15:20 -0600639static void __scsi_release_buffers(struct scsi_cmnd *cmd, int do_bidi_check)
640{
641
642 if (cmd->sdb.table.nents)
643 scsi_free_sgtable(&cmd->sdb);
644
645 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
646
647 if (do_bidi_check && scsi_bidi_cmnd(cmd)) {
648 struct scsi_data_buffer *bidi_sdb =
649 cmd->request->next_rq->special;
650 scsi_free_sgtable(bidi_sdb);
651 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
652 cmd->request->next_rq->special = NULL;
653 }
654
655 if (scsi_prot_sg_count(cmd))
656 scsi_free_sgtable(cmd->prot_sdb);
657}
658
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659/*
660 * Function: scsi_release_buffers()
661 *
662 * Purpose: Completion processing for block device I/O requests.
663 *
664 * Arguments: cmd - command that we are bailing.
665 *
666 * Lock status: Assumed that no lock is held upon entry.
667 *
668 * Returns: Nothing
669 *
670 * Notes: In the event that an upper level driver rejects a
671 * command, we must release resources allocated during
672 * the __init_io() function. Primarily this would involve
673 * the scatter-gather table, and potentially any bounce
674 * buffers.
675 */
Boaz Harroshbb52d822007-12-13 16:14:27 -0800676void scsi_release_buffers(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677{
James Bottomley79ed2422009-01-06 13:15:20 -0600678 __scsi_release_buffers(cmd, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679}
Boaz Harroshbb52d822007-12-13 16:14:27 -0800680EXPORT_SYMBOL(scsi_release_buffers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100682static int __scsi_error_from_host_byte(struct scsi_cmnd *cmd, int result)
683{
684 int error = 0;
685
686 switch(host_byte(result)) {
687 case DID_TRANSPORT_FAILFAST:
688 error = -ENOLINK;
689 break;
690 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000691 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100692 error = -EREMOTEIO;
693 break;
694 case DID_NEXUS_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000695 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100696 error = -EBADE;
697 break;
698 default:
699 error = -EIO;
700 break;
701 }
702
703 return error;
704}
705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706/*
707 * Function: scsi_io_completion()
708 *
709 * Purpose: Completion processing for block device I/O requests.
710 *
711 * Arguments: cmd - command that is finished.
712 *
713 * Lock status: Assumed that no lock is held upon entry.
714 *
715 * Returns: Nothing
716 *
717 * Notes: This function is matched in terms of capabilities to
718 * the function that created the scatter-gather list.
719 * In other words, if there are no bounce buffers
720 * (the normal case for most drivers), we don't need
721 * the logic to deal with cleaning up afterwards.
722 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500723 * We must call scsi_end_request(). This will finish off
724 * the specified number of sectors. If we are done, the
725 * command block will be released and the queue function
726 * will be goosed. If we are not done then we have to
727 * figure out what to do next:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500729 * a) We can call scsi_requeue_command(). The request
730 * will be unprepared and put back on the queue. Then
731 * a new command will be created for it. This should
732 * be used if we made forward progress, or if we want
733 * to switch from READ(10) to READ(6) for example.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500735 * b) We can call scsi_queue_insert(). The request will
736 * be put back on the queue and retried using the same
737 * command as before, possibly after a delay.
738 *
739 * c) We can call blk_end_request() with -EIO to fail
740 * the remainder of the request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 */
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700742void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743{
744 int result = cmd->result;
Jens Axboe165125e2007-07-24 09:28:11 +0200745 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 struct request *req = cmd->request;
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500747 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 struct scsi_sense_hdr sshdr;
749 int sense_valid = 0;
750 int sense_deferred = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500751 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
752 ACTION_DELAYED_RETRY} action;
753 char *description = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 if (result) {
756 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
757 if (sense_valid)
758 sense_deferred = scsi_sense_is_deferred(&sshdr);
759 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200760
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200761 if (req->cmd_type == REQ_TYPE_BLOCK_PC) { /* SG_IO ioctl from block level */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 req->errors = result;
763 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 if (sense_valid && req->sense) {
765 /*
766 * SG_IO wants current and deferred errors
767 */
768 int len = 8 + cmd->sense_buffer[7];
769
770 if (len > SCSI_SENSE_BUFFERSIZE)
771 len = SCSI_SENSE_BUFFERSIZE;
772 memcpy(req->sense, cmd->sense_buffer, len);
773 req->sense_len = len;
774 }
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500775 if (!sense_deferred)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100776 error = __scsi_error_from_host_byte(cmd, result);
Pete Wyckoffb22f6872007-03-13 16:53:28 -0400777 }
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900778
779 req->resid_len = scsi_get_resid(cmd);
780
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200781 if (scsi_bidi_cmnd(cmd)) {
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900782 /*
783 * Bidi commands Must be complete as a whole,
784 * both sides at once.
785 */
786 req->next_rq->resid_len = scsi_in(cmd)->resid;
787
Boaz Harrosh63c43b02009-12-15 17:25:43 +0200788 scsi_release_buffers(cmd);
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900789 blk_end_request_all(req, 0);
790
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900791 scsi_next_command(cmd);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200792 return;
793 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 }
795
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200796 /* no bidi support for !REQ_TYPE_BLOCK_PC yet */
797 BUG_ON(blk_bidi_rq(req));
Boaz Harrosh30b0c37b2007-12-13 13:47:40 +0200798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 * Next deal with any sectors which we were able to correctly
801 * handle.
802 */
Tejun Heo83096eb2009-05-07 22:24:39 +0900803 SCSI_LOG_HLCOMPLETE(1, printk("%u sectors total, "
James Bottomleyd6b0c532006-07-02 10:06:28 -0500804 "%d bytes done.\n",
Tejun Heo83096eb2009-05-07 22:24:39 +0900805 blk_rq_sectors(req), good_bytes));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
James Bottomleya9bddd72009-03-30 16:55:51 +0000807 /*
808 * Recovered errors need reporting, but they're always treated
809 * as success, so fiddle the result code here. For BLOCK_PC
810 * we already took a copy of the original into rq->errors which
811 * is what gets returned to the user
812 */
Douglas Gilberte7efe592010-01-03 13:51:15 -0500813 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
814 /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
815 * print since caller wants ATA registers. Only occurs on
816 * SCSI ATA PASS_THROUGH commands when CK_COND=1
817 */
818 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
819 ;
820 else if (!(req->cmd_flags & REQ_QUIET))
James Bottomleya9bddd72009-03-30 16:55:51 +0000821 scsi_print_sense("", cmd);
822 result = 0;
823 /* BLOCK_PC may have set error */
824 error = 0;
825 }
826
827 /*
828 * A number of bytes were successfully read. If there
James Bottomleyd6b0c532006-07-02 10:06:28 -0500829 * are leftovers and there is some kind of error
830 * (result != 0), retry the rest.
831 */
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500832 if (scsi_end_request(cmd, error, good_bytes, result == 0) == NULL)
James Bottomleyd6b0c532006-07-02 10:06:28 -0500833 return;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700834
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100835 error = __scsi_error_from_host_byte(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500836
Alan Sternb60af5b2008-11-03 15:56:47 -0500837 if (host_byte(result) == DID_RESET) {
838 /* Third party bus reset or reset for error recovery
839 * reasons. Just retry the command and see what
840 * happens.
841 */
842 action = ACTION_RETRY;
843 } else if (sense_valid && !sense_deferred) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 switch (sshdr.sense_key) {
845 case UNIT_ATTENTION:
846 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700847 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 * and quietly refuse further access.
849 */
850 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500851 description = "Media Changed";
852 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700854 /* Must have been a power glitch, or a
855 * bus reset. Could not have been a
856 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500857 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700858 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500859 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 }
861 break;
862 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700863 /* If we had an ILLEGAL REQUEST returned, then
864 * we may have performed an unsupported
865 * command. The only thing this should be
866 * would be a ten byte read where only a six
867 * byte read was supported. Also, on a system
868 * where READ CAPACITY failed, we may have
869 * read past the end of the disk.
870 */
Jens Axboe26a68012005-11-29 21:03:34 +0100871 if ((cmd->device->use_10_for_rw &&
872 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 (cmd->cmnd[0] == READ_10 ||
874 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500875 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500877 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500878 } else if (sshdr.asc == 0x10) /* DIX */ {
879 description = "Host Data Integrity Failure";
880 action = ACTION_FAIL;
881 error = -EILSEQ;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500882 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
883 } else if ((sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
884 (cmd->cmnd[0] == UNMAP ||
885 cmd->cmnd[0] == WRITE_SAME_16 ||
886 cmd->cmnd[0] == WRITE_SAME)) {
887 description = "Discard failure";
888 action = ACTION_FAIL;
Martin K. Petersen66a651a2012-02-13 15:38:22 -0500889 error = -EREMOTEIO;
Alan Sternb60af5b2008-11-03 15:56:47 -0500890 } else
891 action = ACTION_FAIL;
892 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400893 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000894 action = ACTION_FAIL;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400895 if (sshdr.asc == 0x10) { /* DIF */
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500896 description = "Target Data Integrity Failure";
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500897 error = -EILSEQ;
James Bottomley126c09822009-02-19 21:48:54 +0000898 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 break;
900 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700901 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500902 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500904 if (sshdr.asc == 0x04) {
905 switch (sshdr.ascq) {
906 case 0x01: /* becoming ready */
907 case 0x04: /* format in progress */
908 case 0x05: /* rebuild in progress */
909 case 0x06: /* recalculation in progress */
910 case 0x07: /* operation in progress */
911 case 0x08: /* Long write in progress */
912 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500913 case 0x14: /* space allocation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500914 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500915 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500916 default:
917 description = "Device not ready";
918 action = ACTION_FAIL;
919 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500920 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500921 } else {
922 description = "Device not ready";
923 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500925 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700927 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500928 action = ACTION_FAIL;
929 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500931 description = "Unhandled sense code";
932 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 break;
934 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500935 } else {
936 description = "Unhandled error code";
937 action = ACTION_FAIL;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700938 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500939
940 switch (action) {
941 case ACTION_FAIL:
942 /* Give up and fail the remainder of the request */
James Bottomley79ed2422009-01-06 13:15:20 -0600943 scsi_release_buffers(cmd);
Jens Axboe4aff5e22006-08-10 08:44:47 +0200944 if (!(req->cmd_flags & REQ_QUIET)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500945 if (description)
Alan Stern3dbf6a52008-12-15 10:31:28 -0500946 scmd_printk(KERN_INFO, cmd, "%s\n",
Alan Sternb60af5b2008-11-03 15:56:47 -0500947 description);
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500948 scsi_print_result(cmd);
James Bottomley3173d8c2005-09-04 11:32:05 -0500949 if (driver_byte(result) & DRIVER_SENSE)
950 scsi_print_sense("", cmd);
Martin K. Petersen002b1eb2009-05-23 11:45:07 -0400951 scsi_print_command(cmd);
James Bottomley3173d8c2005-09-04 11:32:05 -0500952 }
Mike Christiead630822009-09-28 15:50:52 -0500953 if (blk_end_request_err(req, error))
Tejun Heoda6c5c72009-09-11 14:26:40 +0200954 scsi_requeue_command(q, cmd);
955 else
956 scsi_next_command(cmd);
Alan Sternb60af5b2008-11-03 15:56:47 -0500957 break;
958 case ACTION_REPREP:
959 /* Unprep the request and put it back at the head of the queue.
960 * A new command will be prepared and issued.
961 */
James Bottomley79ed2422009-01-06 13:15:20 -0600962 scsi_release_buffers(cmd);
Alan Sternb60af5b2008-11-03 15:56:47 -0500963 scsi_requeue_command(q, cmd);
964 break;
965 case ACTION_RETRY:
966 /* Retry the same command immediately */
James Bottomley4f5299a2009-01-02 10:42:21 -0600967 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -0500968 break;
969 case ACTION_DELAYED_RETRY:
970 /* Retry the same command after a delay */
James Bottomley4f5299a2009-01-02 10:42:21 -0600971 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -0500972 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 }
974}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200976static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb,
977 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200979 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980
981 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +0100982 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 */
Boaz Harrosh30b0c37b2007-12-13 13:47:40 +0200984 if (unlikely(scsi_alloc_sgtable(sdb, req->nr_phys_segments,
985 gfp_mask))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 return BLKPREP_DEFER;
Alan Stern7c72ce82005-10-14 11:23:27 -0400987 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
Christoph Hellwig3b003152006-11-04 20:10:55 +0100989 req->buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
991 /*
992 * Next, walk the list, and fill in the addresses and sizes of
993 * each segment.
994 */
Boaz Harrosh30b0c37b2007-12-13 13:47:40 +0200995 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
996 BUG_ON(count > sdb->table.nents);
997 sdb->table.nents = count;
Tejun Heo1011c1b2009-05-07 22:24:45 +0900998 sdb->length = blk_rq_bytes(req);
Rusty Russell4a03d902007-11-19 11:28:48 +1100999 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001001
1002/*
1003 * Function: scsi_init_io()
1004 *
1005 * Purpose: SCSI I/O initialize function.
1006 *
1007 * Arguments: cmd - Command descriptor we wish to initialize
1008 *
1009 * Returns: 0 on success
1010 * BLKPREP_DEFER if the failure is retryable
1011 * BLKPREP_KILL if the failure is fatal
1012 */
1013int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask)
1014{
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001015 struct request *rq = cmd->request;
1016
1017 int error = scsi_init_sgtable(rq, &cmd->sdb, gfp_mask);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001018 if (error)
1019 goto err_exit;
1020
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001021 if (blk_bidi_rq(rq)) {
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001022 struct scsi_data_buffer *bidi_sdb = kmem_cache_zalloc(
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001023 scsi_sdb_cache, GFP_ATOMIC);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001024 if (!bidi_sdb) {
1025 error = BLKPREP_DEFER;
1026 goto err_exit;
1027 }
1028
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001029 rq->next_rq->special = bidi_sdb;
1030 error = scsi_init_sgtable(rq->next_rq, bidi_sdb, GFP_ATOMIC);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001031 if (error)
1032 goto err_exit;
1033 }
1034
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001035 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001036 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1037 int ivecs, count;
1038
1039 BUG_ON(prot_sdb == NULL);
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001040 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001041
1042 if (scsi_alloc_sgtable(prot_sdb, ivecs, gfp_mask)) {
1043 error = BLKPREP_DEFER;
1044 goto err_exit;
1045 }
1046
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001047 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001048 prot_sdb->table.sgl);
1049 BUG_ON(unlikely(count > ivecs));
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001050 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001051
1052 cmd->prot_sdb = prot_sdb;
1053 cmd->prot_sdb->table.nents = count;
1054 }
1055
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001056 return BLKPREP_OK ;
1057
1058err_exit:
1059 scsi_release_buffers(cmd);
FUJITA Tomonori610a6342010-07-08 10:16:17 +02001060 cmd->request->special = NULL;
James Bottomley3a5c19c2010-08-16 10:06:26 -05001061 scsi_put_command(cmd);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001062 return error;
1063}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001064EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065
Christoph Hellwig3b003152006-11-04 20:10:55 +01001066static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
1067 struct request *req)
1068{
1069 struct scsi_cmnd *cmd;
1070
1071 if (!req->special) {
1072 cmd = scsi_get_command(sdev, GFP_ATOMIC);
1073 if (unlikely(!cmd))
1074 return NULL;
1075 req->special = cmd;
1076 } else {
1077 cmd = req->special;
1078 }
1079
1080 /* pull a tag out of the request if we have one */
1081 cmd->tag = req->tag;
1082 cmd->request = req;
1083
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001084 cmd->cmnd = req->cmd;
Martin K. Petersen72f7d322011-03-08 02:03:59 -05001085 cmd->prot_op = SCSI_PROT_NORMAL;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001086
Christoph Hellwig3b003152006-11-04 20:10:55 +01001087 return cmd;
1088}
1089
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001090int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001091{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001092 struct scsi_cmnd *cmd;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001093 int ret = scsi_prep_state_check(sdev, req);
1094
1095 if (ret != BLKPREP_OK)
1096 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001097
1098 cmd = scsi_get_cmd_from_req(sdev, req);
1099 if (unlikely(!cmd))
1100 return BLKPREP_DEFER;
1101
1102 /*
1103 * BLOCK_PC requests may transfer data, in which case they must
1104 * a bio attached to them. Or they might contain a SCSI command
1105 * that does not transfer data, in which case they may optionally
1106 * submit a request without an attached bio.
1107 */
1108 if (req->bio) {
1109 int ret;
1110
1111 BUG_ON(!req->nr_phys_segments);
1112
Boaz Harroshbb52d822007-12-13 16:14:27 -08001113 ret = scsi_init_io(cmd, GFP_ATOMIC);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001114 if (unlikely(ret))
1115 return ret;
1116 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001117 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001118
Boaz Harrosh30b0c37b2007-12-13 13:47:40 +02001119 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001120 req->buffer = NULL;
1121 }
James Bottomley7b163182005-12-15 20:17:02 -06001122
James Bottomley7b163182005-12-15 20:17:02 -06001123 cmd->cmd_len = req->cmd_len;
Tejun Heob0790412009-05-07 22:24:42 +09001124 if (!blk_rq_bytes(req))
James Bottomley7b163182005-12-15 20:17:02 -06001125 cmd->sc_data_direction = DMA_NONE;
1126 else if (rq_data_dir(req) == WRITE)
1127 cmd->sc_data_direction = DMA_TO_DEVICE;
1128 else
1129 cmd->sc_data_direction = DMA_FROM_DEVICE;
1130
Tejun Heob0790412009-05-07 22:24:42 +09001131 cmd->transfersize = blk_rq_bytes(req);
James Bottomley7b163182005-12-15 20:17:02 -06001132 cmd->allowed = req->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001133 return BLKPREP_OK;
1134}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001135EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001136
1137/*
1138 * Setup a REQ_TYPE_FS command. These are simple read/write request
1139 * from filesystems that still need to be translated to SCSI CDBs from
1140 * the ULD.
1141 */
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001142int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001143{
1144 struct scsi_cmnd *cmd;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001145 int ret = scsi_prep_state_check(sdev, req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001146
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001147 if (ret != BLKPREP_OK)
1148 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001149
1150 if (unlikely(sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh
1151 && sdev->scsi_dh_data->scsi_dh->prep_fn)) {
1152 ret = sdev->scsi_dh_data->scsi_dh->prep_fn(sdev, req);
1153 if (ret != BLKPREP_OK)
1154 return ret;
1155 }
1156
Christoph Hellwig3b003152006-11-04 20:10:55 +01001157 /*
1158 * Filesystem requests must transfer data.
1159 */
1160 BUG_ON(!req->nr_phys_segments);
1161
1162 cmd = scsi_get_cmd_from_req(sdev, req);
1163 if (unlikely(!cmd))
1164 return BLKPREP_DEFER;
1165
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001166 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Boaz Harroshbb52d822007-12-13 16:14:27 -08001167 return scsi_init_io(cmd, GFP_ATOMIC);
James Bottomley7b163182005-12-15 20:17:02 -06001168}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001169EXPORT_SYMBOL(scsi_setup_fs_cmnd);
James Bottomley7b163182005-12-15 20:17:02 -06001170
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001171int scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001173 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174
1175 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001176 * If the device is not in running state we will reject some
1177 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001180 switch (sdev->sdev_state) {
1181 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05001182 case SDEV_TRANSPORT_OFFLINE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001183 /*
1184 * If the device is offline we refuse to process any
1185 * commands. The device must be brought online
1186 * before trying any recovery commands.
1187 */
1188 sdev_printk(KERN_ERR, sdev,
1189 "rejecting I/O to offline device\n");
1190 ret = BLKPREP_KILL;
1191 break;
1192 case SDEV_DEL:
1193 /*
1194 * If the device is fully deleted, we refuse to
1195 * process any commands as well.
1196 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001197 sdev_printk(KERN_ERR, sdev,
1198 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001199 ret = BLKPREP_KILL;
1200 break;
1201 case SDEV_QUIESCE:
1202 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001203 case SDEV_CREATED_BLOCK:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001204 /*
1205 * If the devices is blocked we defer normal commands.
1206 */
1207 if (!(req->cmd_flags & REQ_PREEMPT))
1208 ret = BLKPREP_DEFER;
1209 break;
1210 default:
1211 /*
1212 * For any other not fully online state we only allow
1213 * special commands. In particular any user initiated
1214 * command is not allowed.
1215 */
1216 if (!(req->cmd_flags & REQ_PREEMPT))
1217 ret = BLKPREP_KILL;
1218 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001221 return ret;
1222}
1223EXPORT_SYMBOL(scsi_prep_state_check);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001225int scsi_prep_return(struct request_queue *q, struct request *req, int ret)
1226{
1227 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228
Christoph Hellwig3b003152006-11-04 20:10:55 +01001229 switch (ret) {
1230 case BLKPREP_KILL:
1231 req->errors = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001232 /* release the command and kill it */
1233 if (req->special) {
1234 struct scsi_cmnd *cmd = req->special;
1235 scsi_release_buffers(cmd);
1236 scsi_put_command(cmd);
1237 req->special = NULL;
1238 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001239 break;
1240 case BLKPREP_DEFER:
1241 /*
Tejun Heo9934c8c2009-05-08 11:54:16 +09001242 * If we defer, the blk_peek_request() returns NULL, but the
Jens Axboea488e742010-04-16 21:13:15 +02001243 * queue must be restarted, so we schedule a callback to happen
1244 * shortly.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001245 */
1246 if (sdev->device_busy == 0)
Jens Axboea488e742010-04-16 21:13:15 +02001247 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001248 break;
1249 default:
1250 req->cmd_flags |= REQ_DONTPREP;
1251 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252
Christoph Hellwig3b003152006-11-04 20:10:55 +01001253 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001255EXPORT_SYMBOL(scsi_prep_return);
1256
James Bottomley751bf4d2008-01-02 11:14:30 -06001257int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001258{
1259 struct scsi_device *sdev = q->queuedata;
1260 int ret = BLKPREP_KILL;
1261
1262 if (req->cmd_type == REQ_TYPE_BLOCK_PC)
1263 ret = scsi_setup_blk_pc_cmnd(sdev, req);
1264 return scsi_prep_return(q, req, ret);
1265}
Hannes Reineckeb3912772009-06-18 09:57:18 +02001266EXPORT_SYMBOL(scsi_prep_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
1268/*
1269 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1270 * return 0.
1271 *
1272 * Called with the queue_lock held.
1273 */
1274static inline int scsi_dev_queue_ready(struct request_queue *q,
1275 struct scsi_device *sdev)
1276{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 if (sdev->device_busy == 0 && sdev->device_blocked) {
1278 /*
1279 * unblock after device_blocked iterates to zero
1280 */
1281 if (--sdev->device_blocked == 0) {
1282 SCSI_LOG_MLQUEUE(3,
James Bottomley9ccfc752005-10-02 11:45:08 -05001283 sdev_printk(KERN_INFO, sdev,
1284 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 } else {
Jens Axboea488e742010-04-16 21:13:15 +02001286 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 return 0;
1288 }
1289 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001290 if (scsi_device_is_busy(sdev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 return 0;
1292
1293 return 1;
1294}
1295
Mike Christief0c0a372008-08-17 15:24:38 -05001296
1297/*
1298 * scsi_target_queue_ready: checks if there we can send commands to target
1299 * @sdev: scsi device on starget to check.
1300 *
1301 * Called with the host lock held.
1302 */
1303static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1304 struct scsi_device *sdev)
1305{
1306 struct scsi_target *starget = scsi_target(sdev);
1307
1308 if (starget->single_lun) {
1309 if (starget->starget_sdev_user &&
1310 starget->starget_sdev_user != sdev)
1311 return 0;
1312 starget->starget_sdev_user = sdev;
1313 }
1314
1315 if (starget->target_busy == 0 && starget->target_blocked) {
1316 /*
1317 * unblock after target_blocked iterates to zero
1318 */
1319 if (--starget->target_blocked == 0) {
1320 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1321 "unblocking target at zero depth\n"));
Mike Christieb4efdd52009-04-09 15:57:10 -05001322 } else
Mike Christief0c0a372008-08-17 15:24:38 -05001323 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001324 }
1325
1326 if (scsi_target_is_busy(starget)) {
Shaohua Li466c08c2012-01-10 11:27:01 +08001327 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Hillf Dantonfd01a662010-12-16 14:26:37 -06001328 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001329 }
1330
Mike Christief0c0a372008-08-17 15:24:38 -05001331 return 1;
1332}
1333
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334/*
1335 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1336 * return 0. We must end up running the queue again whenever 0 is
1337 * returned, else IO can hang.
1338 *
1339 * Called with host_lock held.
1340 */
1341static inline int scsi_host_queue_ready(struct request_queue *q,
1342 struct Scsi_Host *shost,
1343 struct scsi_device *sdev)
1344{
James Bottomley939647e2005-09-18 15:05:20 -05001345 if (scsi_host_in_recovery(shost))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 return 0;
1347 if (shost->host_busy == 0 && shost->host_blocked) {
1348 /*
1349 * unblock after host_blocked iterates to zero
1350 */
1351 if (--shost->host_blocked == 0) {
1352 SCSI_LOG_MLQUEUE(3,
1353 printk("scsi%d unblocking host at zero depth\n",
1354 shost->host_no));
1355 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 return 0;
1357 }
1358 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001359 if (scsi_host_is_busy(shost)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 if (list_empty(&sdev->starved_entry))
1361 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1362 return 0;
1363 }
1364
1365 /* We're OK to process the command, so we can't be starved */
1366 if (!list_empty(&sdev->starved_entry))
1367 list_del_init(&sdev->starved_entry);
1368
1369 return 1;
1370}
1371
1372/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001373 * Busy state exporting function for request stacking drivers.
1374 *
1375 * For efficiency, no lock is taken to check the busy state of
1376 * shost/starget/sdev, since the returned value is not guaranteed and
1377 * may be changed after request stacking drivers call the function,
1378 * regardless of taking lock or not.
1379 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001380 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1381 * needs to return 'not busy'. Otherwise, request stacking drivers
1382 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001383 */
1384static int scsi_lld_busy(struct request_queue *q)
1385{
1386 struct scsi_device *sdev = q->queuedata;
1387 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001388
Bart Van Assche67bd9412012-06-29 15:33:22 +00001389 if (blk_queue_dead(q))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001390 return 0;
1391
1392 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001393
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001394 /*
1395 * Ignore host/starget busy state.
1396 * Since block layer does not have a concept of fairness across
1397 * multiple queues, congestion of host/starget needs to be handled
1398 * in SCSI layer.
1399 */
1400 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001401 return 1;
1402
1403 return 0;
1404}
1405
1406/*
James Bottomleye91442b2005-09-09 10:44:16 -05001407 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 */
Jens Axboe165125e2007-07-24 09:28:11 +02001409static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410{
James Bottomleye91442b2005-09-09 10:44:16 -05001411 struct scsi_cmnd *cmd = req->special;
Jiri Slaby03b14702009-09-23 16:15:35 +02001412 struct scsi_device *sdev;
1413 struct scsi_target *starget;
1414 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Tejun Heo9934c8c2009-05-08 11:54:16 +09001416 blk_start_request(req);
James Bottomley788ce432005-09-09 13:40:23 -05001417
Hannes Reinecke74571812011-11-09 08:39:24 +01001418 scmd_printk(KERN_INFO, cmd, "killing request\n");
1419
Jiri Slaby03b14702009-09-23 16:15:35 +02001420 sdev = cmd->device;
1421 starget = scsi_target(sdev);
1422 shost = sdev->host;
James Bottomleye91442b2005-09-09 10:44:16 -05001423 scsi_init_cmd_errh(cmd);
1424 cmd->result = DID_NO_CONNECT << 16;
1425 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001426
1427 /*
1428 * SCSI request completion path will do scsi_device_unbusy(),
1429 * bump busy counts. To bump the counters, we need to dance
1430 * with the locks as normal issue path does.
1431 */
1432 sdev->device_busy++;
1433 spin_unlock(sdev->request_queue->queue_lock);
1434 spin_lock(shost->host_lock);
1435 shost->host_busy++;
Mike Christief0c0a372008-08-17 15:24:38 -05001436 starget->target_busy++;
Tejun Heoe36e0c82006-04-11 17:27:53 +09001437 spin_unlock(shost->host_lock);
1438 spin_lock(sdev->request_queue->queue_lock);
1439
Jens Axboe242f9dc2008-09-14 05:55:09 -07001440 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441}
1442
Jens Axboe1aea6432006-01-09 16:03:03 +01001443static void scsi_softirq_done(struct request *rq)
1444{
Jens Axboe242f9dc2008-09-14 05:55:09 -07001445 struct scsi_cmnd *cmd = rq->special;
1446 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001447 int disposition;
1448
1449 INIT_LIST_HEAD(&cmd->eh_entry);
1450
Jens Axboe242f9dc2008-09-14 05:55:09 -07001451 atomic_inc(&cmd->device->iodone_cnt);
1452 if (cmd->result)
1453 atomic_inc(&cmd->device->ioerr_cnt);
1454
Jens Axboe1aea6432006-01-09 16:03:03 +01001455 disposition = scsi_decide_disposition(cmd);
1456 if (disposition != SUCCESS &&
1457 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1458 sdev_printk(KERN_ERR, cmd->device,
1459 "timing out command, waited %lus\n",
1460 wait_for/HZ);
1461 disposition = SUCCESS;
1462 }
1463
1464 scsi_log_completion(cmd, disposition);
1465
1466 switch (disposition) {
1467 case SUCCESS:
1468 scsi_finish_command(cmd);
1469 break;
1470 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001471 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001472 break;
1473 case ADD_TO_MLQUEUE:
1474 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1475 break;
1476 default:
1477 if (!scsi_eh_scmd_add(cmd, 0))
1478 scsi_finish_command(cmd);
1479 }
1480}
1481
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482/*
1483 * Function: scsi_request_fn()
1484 *
1485 * Purpose: Main strategy routine for SCSI.
1486 *
1487 * Arguments: q - Pointer to actual queue.
1488 *
1489 * Returns: Nothing
1490 *
1491 * Lock status: IO request lock assumed to be held when called.
1492 */
1493static void scsi_request_fn(struct request_queue *q)
1494{
1495 struct scsi_device *sdev = q->queuedata;
1496 struct Scsi_Host *shost;
1497 struct scsi_cmnd *cmd;
1498 struct request *req;
1499
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 if(!get_device(&sdev->sdev_gendev))
1501 /* We must be tearing the block queue down already */
1502 return;
1503
1504 /*
1505 * To start with, we keep looping until the queue is empty, or until
1506 * the host is no longer able to accept any more requests.
1507 */
1508 shost = sdev->host;
Jens Axboea488e742010-04-16 21:13:15 +02001509 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 int rtn;
1511 /*
1512 * get next queueable request. We do this early to make sure
1513 * that the request is fully prepared even if we cannot
1514 * accept it.
1515 */
Tejun Heo9934c8c2009-05-08 11:54:16 +09001516 req = blk_peek_request(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 if (!req || !scsi_dev_queue_ready(q, sdev))
1518 break;
1519
1520 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001521 sdev_printk(KERN_ERR, sdev,
1522 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001523 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 continue;
1525 }
1526
1527
1528 /*
1529 * Remove the request from the request list.
1530 */
1531 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
Tejun Heo9934c8c2009-05-08 11:54:16 +09001532 blk_start_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 sdev->device_busy++;
1534
1535 spin_unlock(q->queue_lock);
James Bottomleye91442b2005-09-09 10:44:16 -05001536 cmd = req->special;
1537 if (unlikely(cmd == NULL)) {
1538 printk(KERN_CRIT "impossible request in %s.\n"
1539 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001540 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001541 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001542 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001543 BUG();
1544 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 spin_lock(shost->host_lock);
1546
Mike Christieecefe8a2008-07-11 19:50:35 -05001547 /*
1548 * We hit this when the driver is using a host wide
1549 * tag map. For device level tag maps the queue_depth check
1550 * in the device ready fn would prevent us from trying
1551 * to allocate a tag. Since the map is a shared host resource
1552 * we add the dev to the starved list so it eventually gets
1553 * a run when a tag is freed.
1554 */
Mike Christie6bd522f2008-07-22 15:34:38 -05001555 if (blk_queue_tagged(q) && !blk_rq_tagged(req)) {
Mike Christieecefe8a2008-07-11 19:50:35 -05001556 if (list_empty(&sdev->starved_entry))
1557 list_add_tail(&sdev->starved_entry,
1558 &shost->starved_list);
1559 goto not_ready;
1560 }
1561
Mike Christief0c0a372008-08-17 15:24:38 -05001562 if (!scsi_target_queue_ready(shost, sdev))
1563 goto not_ready;
1564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 if (!scsi_host_queue_ready(q, shost, sdev))
1566 goto not_ready;
Mike Christief0c0a372008-08-17 15:24:38 -05001567
1568 scsi_target(sdev)->target_busy++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 shost->host_busy++;
1570
1571 /*
1572 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1573 * take the lock again.
1574 */
1575 spin_unlock_irq(shost->host_lock);
1576
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 /*
1578 * Finally, initialize any error handling parameters, and set up
1579 * the timers for timeouts.
1580 */
1581 scsi_init_cmd_errh(cmd);
1582
1583 /*
1584 * Dispatch the command to the low-level driver.
1585 */
1586 rtn = scsi_dispatch_cmd(cmd);
1587 spin_lock_irq(q->queue_lock);
Jens Axboea488e742010-04-16 21:13:15 +02001588 if (rtn)
1589 goto out_delay;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 }
1591
1592 goto out;
1593
1594 not_ready:
1595 spin_unlock_irq(shost->host_lock);
1596
1597 /*
1598 * lock q, handle tag, requeue req, and decrement device_busy. We
1599 * must return with queue_lock held.
1600 *
1601 * Decrementing device_busy without checking it is OK, as all such
1602 * cases (host limits or settings) should run the queue at some
1603 * later time.
1604 */
1605 spin_lock_irq(q->queue_lock);
1606 blk_requeue_request(q, req);
1607 sdev->device_busy--;
Jens Axboea488e742010-04-16 21:13:15 +02001608out_delay:
1609 if (sdev->device_busy == 0)
1610 blk_delay_queue(q, SCSI_QUEUE_DELAY);
1611out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 /* must be careful here...if we trigger the ->remove() function
1613 * we cannot be holding the q lock */
1614 spin_unlock_irq(q->queue_lock);
1615 put_device(&sdev->sdev_gendev);
1616 spin_lock_irq(q->queue_lock);
1617}
1618
1619u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
1620{
1621 struct device *host_dev;
1622 u64 bounce_limit = 0xffffffff;
1623
1624 if (shost->unchecked_isa_dma)
1625 return BLK_BOUNCE_ISA;
1626 /*
1627 * Platforms with virtual-DMA translation
1628 * hardware have no practical limit.
1629 */
1630 if (!PCI_DMA_BUS_IS_PHYS)
1631 return BLK_BOUNCE_ANY;
1632
1633 host_dev = scsi_get_device(shost);
1634 if (host_dev && host_dev->dma_mask)
1635 bounce_limit = *host_dev->dma_mask;
1636
1637 return bounce_limit;
1638}
1639EXPORT_SYMBOL(scsi_calculate_bounce_limit);
1640
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001641struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
1642 request_fn_proc *request_fn)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 struct request_queue *q;
Lin Ming6f381fa2012-04-12 13:50:38 +08001645 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001647 q = blk_init_queue(request_fn, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 if (!q)
1649 return NULL;
1650
Jens Axboea8474ce2007-08-07 09:02:51 +02001651 /*
1652 * this limit is imposed by hardware restrictions
1653 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001654 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
1655 SCSI_MAX_SG_CHAIN_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001656
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001657 if (scsi_host_prot_dma(shost)) {
1658 shost->sg_prot_tablesize =
1659 min_not_zero(shost->sg_prot_tablesize,
1660 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1661 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1662 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1663 }
1664
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001665 blk_queue_max_hw_sectors(q, shost->max_sectors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
1667 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001668 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669
FUJITA Tomonori860ac562008-02-04 22:28:05 -08001670 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
1671
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01001673 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06001674
1675 /*
1676 * set a reasonable default alignment on word boundaries: the
1677 * host and device may alter it using
1678 * blk_queue_update_dma_alignment() later.
1679 */
1680 blk_queue_dma_alignment(q, 0x03);
1681
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 return q;
1683}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001684EXPORT_SYMBOL(__scsi_alloc_queue);
1685
1686struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
1687{
1688 struct request_queue *q;
1689
1690 q = __scsi_alloc_queue(sdev->host, scsi_request_fn);
1691 if (!q)
1692 return NULL;
1693
1694 blk_queue_prep_rq(q, scsi_prep_fn);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001695 blk_queue_softirq_done(q, scsi_softirq_done);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001696 blk_queue_rq_timed_out(q, scsi_times_out);
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001697 blk_queue_lld_busy(q, scsi_lld_busy);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001698 return q;
1699}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701/*
1702 * Function: scsi_block_requests()
1703 *
1704 * Purpose: Utility function used by low-level drivers to prevent further
1705 * commands from being queued to the device.
1706 *
1707 * Arguments: shost - Host in question
1708 *
1709 * Returns: Nothing
1710 *
1711 * Lock status: No locks are assumed held.
1712 *
1713 * Notes: There is no timer nor any other means by which the requests
1714 * get unblocked other than the low-level driver calling
1715 * scsi_unblock_requests().
1716 */
1717void scsi_block_requests(struct Scsi_Host *shost)
1718{
1719 shost->host_self_blocked = 1;
1720}
1721EXPORT_SYMBOL(scsi_block_requests);
1722
1723/*
1724 * Function: scsi_unblock_requests()
1725 *
1726 * Purpose: Utility function used by low-level drivers to allow further
1727 * commands from being queued to the device.
1728 *
1729 * Arguments: shost - Host in question
1730 *
1731 * Returns: Nothing
1732 *
1733 * Lock status: No locks are assumed held.
1734 *
1735 * Notes: There is no timer nor any other means by which the requests
1736 * get unblocked other than the low-level driver calling
1737 * scsi_unblock_requests().
1738 *
1739 * This is done as an API function so that changes to the
1740 * internals of the scsi mid-layer won't require wholesale
1741 * changes to drivers that use this feature.
1742 */
1743void scsi_unblock_requests(struct Scsi_Host *shost)
1744{
1745 shost->host_self_blocked = 0;
1746 scsi_run_host_queues(shost);
1747}
1748EXPORT_SYMBOL(scsi_unblock_requests);
1749
1750int __init scsi_init_queue(void)
1751{
1752 int i;
1753
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001754 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1755 sizeof(struct scsi_data_buffer),
1756 0, 0, NULL);
1757 if (!scsi_sdb_cache) {
1758 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001759 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001760 }
1761
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1763 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1764 int size = sgp->size * sizeof(struct scatterlist);
1765
1766 sgp->slab = kmem_cache_create(sgp->name, size, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09001767 SLAB_HWCACHE_ALIGN, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 if (!sgp->slab) {
1769 printk(KERN_ERR "SCSI: can't init sg slab %s\n",
1770 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001771 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 }
1773
Matthew Dobson93d23412006-03-26 01:37:50 -08001774 sgp->pool = mempool_create_slab_pool(SG_MEMPOOL_SIZE,
1775 sgp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 if (!sgp->pool) {
1777 printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
1778 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001779 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 }
1781 }
1782
1783 return 0;
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001784
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001785cleanup_sdb:
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001786 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1787 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1788 if (sgp->pool)
1789 mempool_destroy(sgp->pool);
1790 if (sgp->slab)
1791 kmem_cache_destroy(sgp->slab);
1792 }
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001793 kmem_cache_destroy(scsi_sdb_cache);
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001794
1795 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796}
1797
1798void scsi_exit_queue(void)
1799{
1800 int i;
1801
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001802 kmem_cache_destroy(scsi_sdb_cache);
Mike Christieaa7b5cd2005-11-11 05:31:41 -06001803
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1805 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1806 mempool_destroy(sgp->pool);
1807 kmem_cache_destroy(sgp->slab);
1808 }
1809}
James Bottomley5baba832006-03-18 14:10:35 -06001810
1811/**
1812 * scsi_mode_select - issue a mode select
1813 * @sdev: SCSI device to be queried
1814 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1815 * @sp: Save page bit (0 == don't save, 1 == save)
1816 * @modepage: mode page being requested
1817 * @buffer: request buffer (may not be smaller than eight bytes)
1818 * @len: length of request buffer.
1819 * @timeout: command timeout
1820 * @retries: number of retries before failing
1821 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001822 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001823 * must be SCSI_SENSE_BUFFERSIZE big.
1824 *
1825 * Returns zero if successful; negative error number or scsi
1826 * status on error
1827 *
1828 */
1829int
1830scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1831 unsigned char *buffer, int len, int timeout, int retries,
1832 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1833{
1834 unsigned char cmd[10];
1835 unsigned char *real_buffer;
1836 int ret;
1837
1838 memset(cmd, 0, sizeof(cmd));
1839 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
1840
1841 if (sdev->use_10_for_ms) {
1842 if (len > 65535)
1843 return -EINVAL;
1844 real_buffer = kmalloc(8 + len, GFP_KERNEL);
1845 if (!real_buffer)
1846 return -ENOMEM;
1847 memcpy(real_buffer + 8, buffer, len);
1848 len += 8;
1849 real_buffer[0] = 0;
1850 real_buffer[1] = 0;
1851 real_buffer[2] = data->medium_type;
1852 real_buffer[3] = data->device_specific;
1853 real_buffer[4] = data->longlba ? 0x01 : 0;
1854 real_buffer[5] = 0;
1855 real_buffer[6] = data->block_descriptor_length >> 8;
1856 real_buffer[7] = data->block_descriptor_length;
1857
1858 cmd[0] = MODE_SELECT_10;
1859 cmd[7] = len >> 8;
1860 cmd[8] = len;
1861 } else {
1862 if (len > 255 || data->block_descriptor_length > 255 ||
1863 data->longlba)
1864 return -EINVAL;
1865
1866 real_buffer = kmalloc(4 + len, GFP_KERNEL);
1867 if (!real_buffer)
1868 return -ENOMEM;
1869 memcpy(real_buffer + 4, buffer, len);
1870 len += 4;
1871 real_buffer[0] = 0;
1872 real_buffer[1] = data->medium_type;
1873 real_buffer[2] = data->device_specific;
1874 real_buffer[3] = data->block_descriptor_length;
1875
1876
1877 cmd[0] = MODE_SELECT;
1878 cmd[4] = len;
1879 }
1880
1881 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09001882 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06001883 kfree(real_buffer);
1884 return ret;
1885}
1886EXPORT_SYMBOL_GPL(scsi_mode_select);
1887
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888/**
Rob Landleyeb448202007-11-03 13:30:39 -05001889 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05001890 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 * @dbd: set if mode sense will allow block descriptors to be returned
1892 * @modepage: mode page being requested
1893 * @buffer: request buffer (may not be smaller than eight bytes)
1894 * @len: length of request buffer.
1895 * @timeout: command timeout
1896 * @retries: number of retries before failing
1897 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001898 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05001899 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 *
1901 * Returns zero if unsuccessful, or the header offset (either 4
1902 * or 8 depending on whether a six or ten byte command was
1903 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05001904 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905int
James Bottomley1cf72692005-08-28 11:27:01 -05001906scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06001908 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1909{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 unsigned char cmd[12];
1911 int use_10_for_ms;
1912 int header_length;
James Bottomley1cf72692005-08-28 11:27:01 -05001913 int result;
James Bottomleyea73a9f2005-08-28 11:33:52 -05001914 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915
1916 memset(data, 0, sizeof(*data));
1917 memset(&cmd[0], 0, 12);
1918 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
1919 cmd[2] = modepage;
1920
James Bottomleyea73a9f2005-08-28 11:33:52 -05001921 /* caller might not be interested in sense, but we need it */
1922 if (!sshdr)
1923 sshdr = &my_sshdr;
1924
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05001926 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927
1928 if (use_10_for_ms) {
1929 if (len < 8)
1930 len = 8;
1931
1932 cmd[0] = MODE_SENSE_10;
1933 cmd[8] = len;
1934 header_length = 8;
1935 } else {
1936 if (len < 4)
1937 len = 4;
1938
1939 cmd[0] = MODE_SENSE;
1940 cmd[4] = len;
1941 header_length = 4;
1942 }
1943
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 memset(buffer, 0, len);
1945
James Bottomley1cf72692005-08-28 11:27:01 -05001946 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09001947 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948
1949 /* This code looks awful: what it's doing is making sure an
1950 * ILLEGAL REQUEST sense return identifies the actual command
1951 * byte as the problem. MODE_SENSE commands can return
1952 * ILLEGAL REQUEST if the code page isn't supported */
1953
James Bottomley1cf72692005-08-28 11:27:01 -05001954 if (use_10_for_ms && !scsi_status_is_good(result) &&
1955 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05001956 if (scsi_sense_valid(sshdr)) {
1957 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
1958 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 /*
1960 * Invalid command operation code
1961 */
James Bottomley1cf72692005-08-28 11:27:01 -05001962 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 goto retry;
1964 }
1965 }
1966 }
1967
James Bottomley1cf72692005-08-28 11:27:01 -05001968 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01001969 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
1970 (modepage == 6 || modepage == 8))) {
1971 /* Initio breakage? */
1972 header_length = 0;
1973 data->length = 13;
1974 data->medium_type = 0;
1975 data->device_specific = 0;
1976 data->longlba = 0;
1977 data->block_descriptor_length = 0;
1978 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 data->length = buffer[0]*256 + buffer[1] + 2;
1980 data->medium_type = buffer[2];
1981 data->device_specific = buffer[3];
1982 data->longlba = buffer[4] & 0x01;
1983 data->block_descriptor_length = buffer[6]*256
1984 + buffer[7];
1985 } else {
1986 data->length = buffer[0] + 1;
1987 data->medium_type = buffer[1];
1988 data->device_specific = buffer[2];
1989 data->block_descriptor_length = buffer[3];
1990 }
Al Viro6d73c852006-02-23 02:03:16 +01001991 data->header_length = header_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 }
1993
James Bottomley1cf72692005-08-28 11:27:01 -05001994 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995}
1996EXPORT_SYMBOL(scsi_mode_sense);
1997
James Bottomley001aac22007-12-02 19:10:40 +02001998/**
1999 * scsi_test_unit_ready - test if unit is ready
2000 * @sdev: scsi device to change the state of.
2001 * @timeout: command timeout
2002 * @retries: number of retries before failing
2003 * @sshdr_external: Optional pointer to struct scsi_sense_hdr for
2004 * returning sense. Make sure that this is cleared before passing
2005 * in.
2006 *
2007 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002008 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002009 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010int
James Bottomley001aac22007-12-02 19:10:40 +02002011scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
2012 struct scsi_sense_hdr *sshdr_external)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 char cmd[] = {
2015 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2016 };
James Bottomley001aac22007-12-02 19:10:40 +02002017 struct scsi_sense_hdr *sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002019
2020 if (!sshdr_external)
2021 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
2022 else
2023 sshdr = sshdr_external;
2024
2025 /* try to eat the UNIT_ATTENTION if there are enough retries */
2026 do {
2027 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002028 timeout, retries, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002029 if (sdev->removable && scsi_sense_valid(sshdr) &&
2030 sshdr->sense_key == UNIT_ATTENTION)
2031 sdev->changed = 1;
2032 } while (scsi_sense_valid(sshdr) &&
2033 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002034
James Bottomley001aac22007-12-02 19:10:40 +02002035 if (!sshdr_external)
2036 kfree(sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 return result;
2038}
2039EXPORT_SYMBOL(scsi_test_unit_ready);
2040
2041/**
Rob Landleyeb448202007-11-03 13:30:39 -05002042 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 * @sdev: scsi device to change the state of.
2044 * @state: state to change to.
2045 *
2046 * Returns zero if unsuccessful or an error if the requested
2047 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002048 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049int
2050scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2051{
2052 enum scsi_device_state oldstate = sdev->sdev_state;
2053
2054 if (state == oldstate)
2055 return 0;
2056
2057 switch (state) {
2058 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002059 switch (oldstate) {
2060 case SDEV_CREATED_BLOCK:
2061 break;
2062 default:
2063 goto illegal;
2064 }
2065 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066
2067 case SDEV_RUNNING:
2068 switch (oldstate) {
2069 case SDEV_CREATED:
2070 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002071 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072 case SDEV_QUIESCE:
2073 case SDEV_BLOCK:
2074 break;
2075 default:
2076 goto illegal;
2077 }
2078 break;
2079
2080 case SDEV_QUIESCE:
2081 switch (oldstate) {
2082 case SDEV_RUNNING:
2083 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002084 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 break;
2086 default:
2087 goto illegal;
2088 }
2089 break;
2090
2091 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002092 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 switch (oldstate) {
2094 case SDEV_CREATED:
2095 case SDEV_RUNNING:
2096 case SDEV_QUIESCE:
2097 case SDEV_BLOCK:
2098 break;
2099 default:
2100 goto illegal;
2101 }
2102 break;
2103
2104 case SDEV_BLOCK:
2105 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002107 case SDEV_CREATED_BLOCK:
2108 break;
2109 default:
2110 goto illegal;
2111 }
2112 break;
2113
2114 case SDEV_CREATED_BLOCK:
2115 switch (oldstate) {
2116 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 break;
2118 default:
2119 goto illegal;
2120 }
2121 break;
2122
2123 case SDEV_CANCEL:
2124 switch (oldstate) {
2125 case SDEV_CREATED:
2126 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002127 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002129 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 case SDEV_BLOCK:
2131 break;
2132 default:
2133 goto illegal;
2134 }
2135 break;
2136
2137 case SDEV_DEL:
2138 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002139 case SDEV_CREATED:
2140 case SDEV_RUNNING:
2141 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002142 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 case SDEV_CANCEL:
2144 break;
2145 default:
2146 goto illegal;
2147 }
2148 break;
2149
2150 }
2151 sdev->sdev_state = state;
2152 return 0;
2153
2154 illegal:
2155 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002156 sdev_printk(KERN_ERR, sdev,
2157 "Illegal state transition %s->%s\n",
2158 scsi_device_state_name(oldstate),
2159 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 );
2161 return -EINVAL;
2162}
2163EXPORT_SYMBOL(scsi_device_set_state);
2164
2165/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002166 * sdev_evt_emit - emit a single SCSI device uevent
2167 * @sdev: associated SCSI device
2168 * @evt: event to emit
2169 *
2170 * Send a single uevent (scsi_event) to the associated scsi_device.
2171 */
2172static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2173{
2174 int idx = 0;
2175 char *envp[3];
2176
2177 switch (evt->evt_type) {
2178 case SDEV_EVT_MEDIA_CHANGE:
2179 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2180 break;
2181
2182 default:
2183 /* do nothing */
2184 break;
2185 }
2186
2187 envp[idx++] = NULL;
2188
2189 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2190}
2191
2192/**
2193 * sdev_evt_thread - send a uevent for each scsi event
2194 * @work: work struct for scsi_device
2195 *
2196 * Dispatch queued events to their associated scsi_device kobjects
2197 * as uevents.
2198 */
2199void scsi_evt_thread(struct work_struct *work)
2200{
2201 struct scsi_device *sdev;
2202 LIST_HEAD(event_list);
2203
2204 sdev = container_of(work, struct scsi_device, event_work);
2205
2206 while (1) {
2207 struct scsi_event *evt;
2208 struct list_head *this, *tmp;
2209 unsigned long flags;
2210
2211 spin_lock_irqsave(&sdev->list_lock, flags);
2212 list_splice_init(&sdev->event_list, &event_list);
2213 spin_unlock_irqrestore(&sdev->list_lock, flags);
2214
2215 if (list_empty(&event_list))
2216 break;
2217
2218 list_for_each_safe(this, tmp, &event_list) {
2219 evt = list_entry(this, struct scsi_event, node);
2220 list_del(&evt->node);
2221 scsi_evt_emit(sdev, evt);
2222 kfree(evt);
2223 }
2224 }
2225}
2226
2227/**
2228 * sdev_evt_send - send asserted event to uevent thread
2229 * @sdev: scsi_device event occurred on
2230 * @evt: event to send
2231 *
2232 * Assert scsi device event asynchronously.
2233 */
2234void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2235{
2236 unsigned long flags;
2237
Kay Sievers4d1566e2008-03-19 13:04:47 +01002238#if 0
2239 /* FIXME: currently this check eliminates all media change events
2240 * for polled devices. Need to update to discriminate between AN
2241 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002242 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2243 kfree(evt);
2244 return;
2245 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002246#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002247
2248 spin_lock_irqsave(&sdev->list_lock, flags);
2249 list_add_tail(&evt->node, &sdev->event_list);
2250 schedule_work(&sdev->event_work);
2251 spin_unlock_irqrestore(&sdev->list_lock, flags);
2252}
2253EXPORT_SYMBOL_GPL(sdev_evt_send);
2254
2255/**
2256 * sdev_evt_alloc - allocate a new scsi event
2257 * @evt_type: type of event to allocate
2258 * @gfpflags: GFP flags for allocation
2259 *
2260 * Allocates and returns a new scsi_event.
2261 */
2262struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2263 gfp_t gfpflags)
2264{
2265 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2266 if (!evt)
2267 return NULL;
2268
2269 evt->evt_type = evt_type;
2270 INIT_LIST_HEAD(&evt->node);
2271
2272 /* evt_type-specific initialization, if any */
2273 switch (evt_type) {
2274 case SDEV_EVT_MEDIA_CHANGE:
2275 default:
2276 /* do nothing */
2277 break;
2278 }
2279
2280 return evt;
2281}
2282EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2283
2284/**
2285 * sdev_evt_send_simple - send asserted event to uevent thread
2286 * @sdev: scsi_device event occurred on
2287 * @evt_type: type of event to send
2288 * @gfpflags: GFP flags for allocation
2289 *
2290 * Assert scsi device event asynchronously, given an event type.
2291 */
2292void sdev_evt_send_simple(struct scsi_device *sdev,
2293 enum scsi_device_event evt_type, gfp_t gfpflags)
2294{
2295 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2296 if (!evt) {
2297 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2298 evt_type);
2299 return;
2300 }
2301
2302 sdev_evt_send(sdev, evt);
2303}
2304EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2305
2306/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 * scsi_device_quiesce - Block user issued commands.
2308 * @sdev: scsi device to quiesce.
2309 *
2310 * This works by trying to transition to the SDEV_QUIESCE state
2311 * (which must be a legal transition). When the device is in this
2312 * state, only special requests will be accepted, all others will
2313 * be deferred. Since special requests may also be requeued requests,
2314 * a successful return doesn't guarantee the device will be
2315 * totally quiescent.
2316 *
2317 * Must be called with user context, may sleep.
2318 *
2319 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002320 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321int
2322scsi_device_quiesce(struct scsi_device *sdev)
2323{
2324 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2325 if (err)
2326 return err;
2327
2328 scsi_run_queue(sdev->request_queue);
2329 while (sdev->device_busy) {
2330 msleep_interruptible(200);
2331 scsi_run_queue(sdev->request_queue);
2332 }
2333 return 0;
2334}
2335EXPORT_SYMBOL(scsi_device_quiesce);
2336
2337/**
2338 * scsi_device_resume - Restart user issued commands to a quiesced device.
2339 * @sdev: scsi device to resume.
2340 *
2341 * Moves the device from quiesced back to running and restarts the
2342 * queues.
2343 *
2344 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002345 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002346void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002348 /* check if the device state was mutated prior to resume, and if
2349 * so assume the state is being managed elsewhere (for example
2350 * device deleted during suspend)
2351 */
2352 if (sdev->sdev_state != SDEV_QUIESCE ||
2353 scsi_device_set_state(sdev, SDEV_RUNNING))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 return;
2355 scsi_run_queue(sdev->request_queue);
2356}
2357EXPORT_SYMBOL(scsi_device_resume);
2358
2359static void
2360device_quiesce_fn(struct scsi_device *sdev, void *data)
2361{
2362 scsi_device_quiesce(sdev);
2363}
2364
2365void
2366scsi_target_quiesce(struct scsi_target *starget)
2367{
2368 starget_for_each_device(starget, NULL, device_quiesce_fn);
2369}
2370EXPORT_SYMBOL(scsi_target_quiesce);
2371
2372static void
2373device_resume_fn(struct scsi_device *sdev, void *data)
2374{
2375 scsi_device_resume(sdev);
2376}
2377
2378void
2379scsi_target_resume(struct scsi_target *starget)
2380{
2381 starget_for_each_device(starget, NULL, device_resume_fn);
2382}
2383EXPORT_SYMBOL(scsi_target_resume);
2384
2385/**
Rob Landleyeb448202007-11-03 13:30:39 -05002386 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387 * @sdev: device to block
2388 *
2389 * Block request made by scsi lld's to temporarily stop all
2390 * scsi commands on the specified device. Called from interrupt
2391 * or normal process context.
2392 *
2393 * Returns zero if successful or error if not
2394 *
2395 * Notes:
2396 * This routine transitions the device to the SDEV_BLOCK state
2397 * (which must be a legal transition). When the device is in this
2398 * state, all commands are deferred until the scsi lld reenables
2399 * the device with scsi_device_unblock or device_block_tmo fires.
Rob Landleyeb448202007-11-03 13:30:39 -05002400 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401int
2402scsi_internal_device_block(struct scsi_device *sdev)
2403{
Jens Axboe165125e2007-07-24 09:28:11 +02002404 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405 unsigned long flags;
2406 int err = 0;
2407
2408 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002409 if (err) {
2410 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2411
2412 if (err)
2413 return err;
2414 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415
2416 /*
2417 * The device has transitioned to SDEV_BLOCK. Stop the
2418 * block layer from calling the midlayer with this device's
2419 * request queue.
2420 */
2421 spin_lock_irqsave(q->queue_lock, flags);
2422 blk_stop_queue(q);
2423 spin_unlock_irqrestore(q->queue_lock, flags);
2424
2425 return 0;
2426}
2427EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2428
2429/**
2430 * scsi_internal_device_unblock - resume a device after a block request
2431 * @sdev: device to resume
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002432 * @new_state: state to set devices to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433 *
2434 * Called by scsi lld's or the midlayer to restart the device queue
2435 * for the previously suspended scsi device. Called from interrupt or
2436 * normal process context.
2437 *
2438 * Returns zero if successful or error if not.
2439 *
2440 * Notes:
2441 * This routine transitions the device to the SDEV_RUNNING state
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002442 * or to one of the offline states (which must be a legal transition)
Mike Christied0754982012-05-17 23:56:58 -05002443 * allowing the midlayer to goose the queue for this device.
Rob Landleyeb448202007-11-03 13:30:39 -05002444 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445int
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002446scsi_internal_device_unblock(struct scsi_device *sdev,
2447 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448{
Jens Axboe165125e2007-07-24 09:28:11 +02002449 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 unsigned long flags;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002451
2452 /*
2453 * Try to transition the scsi device to SDEV_RUNNING or one of the
2454 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 */
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002456 if (sdev->sdev_state == SDEV_BLOCK)
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002457 sdev->sdev_state = new_state;
2458 else if (sdev->sdev_state == SDEV_CREATED_BLOCK) {
2459 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2460 new_state == SDEV_OFFLINE)
2461 sdev->sdev_state = new_state;
2462 else
2463 sdev->sdev_state = SDEV_CREATED;
2464 } else if (sdev->sdev_state != SDEV_CANCEL &&
Mike Christie986fe6c2010-10-06 03:10:59 -05002465 sdev->sdev_state != SDEV_OFFLINE)
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002466 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467
2468 spin_lock_irqsave(q->queue_lock, flags);
2469 blk_start_queue(q);
2470 spin_unlock_irqrestore(q->queue_lock, flags);
2471
2472 return 0;
2473}
2474EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
2475
2476static void
2477device_block(struct scsi_device *sdev, void *data)
2478{
2479 scsi_internal_device_block(sdev);
2480}
2481
2482static int
2483target_block(struct device *dev, void *data)
2484{
2485 if (scsi_is_target_device(dev))
2486 starget_for_each_device(to_scsi_target(dev), NULL,
2487 device_block);
2488 return 0;
2489}
2490
2491void
2492scsi_target_block(struct device *dev)
2493{
2494 if (scsi_is_target_device(dev))
2495 starget_for_each_device(to_scsi_target(dev), NULL,
2496 device_block);
2497 else
2498 device_for_each_child(dev, NULL, target_block);
2499}
2500EXPORT_SYMBOL_GPL(scsi_target_block);
2501
2502static void
2503device_unblock(struct scsi_device *sdev, void *data)
2504{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002505 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506}
2507
2508static int
2509target_unblock(struct device *dev, void *data)
2510{
2511 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002512 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513 device_unblock);
2514 return 0;
2515}
2516
2517void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002518scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519{
2520 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002521 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 device_unblock);
2523 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002524 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525}
2526EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002527
2528/**
2529 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002530 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002531 * @sg_count: number of segments in sg
2532 * @offset: offset in bytes into sg, on return offset into the mapped area
2533 * @len: bytes to map, on return number of bytes mapped
2534 *
2535 * Returns virtual address of the start of the mapped page
2536 */
Jens Axboec6132da2007-10-16 11:08:49 +02002537void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002538 size_t *offset, size_t *len)
2539{
2540 int i;
2541 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002542 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002543 struct page *page;
2544
Andrew Morton22cfefb2007-02-05 16:39:03 -08002545 WARN_ON(!irqs_disabled());
2546
Jens Axboec6132da2007-10-16 11:08:49 +02002547 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002548 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002549 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002550 if (sg_len > *offset)
2551 break;
2552 }
2553
2554 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002555 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2556 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002557 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002558 WARN_ON(1);
2559 return NULL;
2560 }
2561
2562 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002563 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002564
2565 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002566 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002567 *offset &= ~PAGE_MASK;
2568
2569 /* Bytes in this sg-entry from *offset to the end of the page */
2570 sg_len = PAGE_SIZE - *offset;
2571 if (*len > sg_len)
2572 *len = sg_len;
2573
Cong Wang77dfce02011-11-25 23:14:23 +08002574 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002575}
2576EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2577
2578/**
Rob Landleyeb448202007-11-03 13:30:39 -05002579 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002580 * @virt: virtual address to be unmapped
2581 */
2582void scsi_kunmap_atomic_sg(void *virt)
2583{
Cong Wang77dfce02011-11-25 23:14:23 +08002584 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002585}
2586EXPORT_SYMBOL(scsi_kunmap_atomic_sg);