blob: c31187d79343a17af26404a2d6c547dc392ae151 [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
Holger Machtde50ada2012-06-25 16:13:02 +080071#ifdef CONFIG_ACPI
72#include <acpi/acpi_bus.h>
73
Rafael J. Wysocki53540092013-03-03 22:35:20 +010074static bool acpi_scsi_bus_match(struct device *dev)
75{
76 return dev->bus == &scsi_bus_type;
77}
78
Holger Machtde50ada2012-06-25 16:13:02 +080079int scsi_register_acpi_bus_type(struct acpi_bus_type *bus)
80{
Rafael J. Wysocki53540092013-03-03 22:35:20 +010081 bus->match = acpi_scsi_bus_match;
Holger Machtde50ada2012-06-25 16:13:02 +080082 return register_acpi_bus_type(bus);
83}
84EXPORT_SYMBOL_GPL(scsi_register_acpi_bus_type);
85
86void scsi_unregister_acpi_bus_type(struct acpi_bus_type *bus)
87{
88 unregister_acpi_bus_type(bus);
89}
90EXPORT_SYMBOL_GPL(scsi_unregister_acpi_bus_type);
91#endif
92
Jens Axboea488e742010-04-16 21:13:15 +020093/*
94 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
95 * not change behaviour from the previous unplug mechanism, experimentation
96 * may prove this needs changing.
97 */
98#define SCSI_QUEUE_DELAY 3
99
James Bottomleye91442b2005-09-09 10:44:16 -0500100/*
101 * Function: scsi_unprep_request()
102 *
103 * Purpose: Remove all preparation done for a request, including its
104 * associated scsi_cmnd, so that it can be requeued.
105 *
106 * Arguments: req - request to unprepare
107 *
108 * Lock status: Assumed that no locks are held upon entry.
109 *
110 * Returns: Nothing.
111 */
112static void scsi_unprep_request(struct request *req)
113{
114 struct scsi_cmnd *cmd = req->special;
115
James Bottomley28018c22010-07-01 19:49:17 +0900116 blk_unprep_request(req);
Christoph Hellwigbeb40482006-06-10 18:01:03 +0200117 req->special = NULL;
James Bottomleye91442b2005-09-09 10:44:16 -0500118
James Bottomleye91442b2005-09-09 10:44:16 -0500119 scsi_put_command(cmd);
120}
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500121
James Bottomley4f5299a2009-01-02 10:42:21 -0600122/**
123 * __scsi_queue_insert - private queue insertion
124 * @cmd: The SCSI command being requeued
125 * @reason: The reason for the requeue
126 * @unbusy: Whether the queue should be unbusied
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 *
James Bottomley4f5299a2009-01-02 10:42:21 -0600128 * This is a private queue insertion. The public interface
129 * scsi_queue_insert() always assumes the queue should be unbusied
130 * because it's always called before the completion. This function is
131 * for a requeue after completion, which should only occur in this
132 * file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000134static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135{
136 struct Scsi_Host *host = cmd->device->host;
137 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500138 struct scsi_target *starget = scsi_target(device);
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500139 struct request_queue *q = device->request_queue;
140 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142 SCSI_LOG_MLQUEUE(1,
143 printk("Inserting command %p into mlqueue\n", cmd));
144
145 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900146 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 *
148 * If the host/device isn't busy, assume that something actually
149 * completed, and that we should be able to queue a command now.
150 *
151 * Note that the prior mid-layer assumption that any host could
152 * always queue at least one command is now broken. The mid-layer
153 * will implement a user specifiable stall (see
154 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
155 * if a command is requeued with no other commands outstanding
156 * either for the device or for the host.
157 */
Mike Christief0c0a372008-08-17 15:24:38 -0500158 switch (reason) {
159 case SCSI_MLQUEUE_HOST_BUSY:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 host->host_blocked = host->max_host_blocked;
Mike Christief0c0a372008-08-17 15:24:38 -0500161 break;
162 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400163 case SCSI_MLQUEUE_EH_RETRY:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 device->device_blocked = device->max_device_blocked;
Mike Christief0c0a372008-08-17 15:24:38 -0500165 break;
166 case SCSI_MLQUEUE_TARGET_BUSY:
167 starget->target_blocked = starget->max_target_blocked;
168 break;
169 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 * Decrement the counters, since these commands are no longer
173 * active on the host/device.
174 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600175 if (unbusy)
176 scsi_device_unbusy(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
178 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500179 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000180 * that are already in the queue. Schedule requeue work under
181 * lock such that the kblockd_schedule_work() call happens
182 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200183 */
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500184 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley59897da2005-09-14 12:57:42 -0400185 blk_requeue_request(q, cmd->request);
Jens Axboe9937a5e2011-05-17 11:04:44 +0200186 kblockd_schedule_work(q, &device->requeue_work);
Bart Van Asscheb4854622012-06-29 15:36:07 +0000187 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188}
189
James Bottomley4f5299a2009-01-02 10:42:21 -0600190/*
191 * Function: scsi_queue_insert()
192 *
193 * Purpose: Insert a command in the midlevel queue.
194 *
195 * Arguments: cmd - command that we are adding to queue.
196 * reason - why we are inserting command to queue.
197 *
198 * Lock status: Assumed that lock is not held upon entry.
199 *
200 * Returns: Nothing.
201 *
202 * Notes: We do this for one of two cases. Either the host is busy
203 * and it cannot accept any more commands for the time being,
204 * or the device returned QUEUE_FULL and can accept no more
205 * commands.
206 * Notes: This could be called either from an interrupt context or a
207 * normal process context.
208 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000209void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600210{
Bart Van Assche84feb162012-06-29 15:35:05 +0000211 __scsi_queue_insert(cmd, reason, 1);
James Bottomley4f5299a2009-01-02 10:42:21 -0600212}
James Bottomley39216032005-06-15 18:48:29 -0500213/**
James Bottomley33aa6872005-08-28 11:31:14 -0500214 * scsi_execute - insert request and wait for the result
James Bottomley39216032005-06-15 18:48:29 -0500215 * @sdev: scsi device
216 * @cmd: scsi command
217 * @data_direction: data direction
218 * @buffer: data buffer
219 * @bufflen: len of buffer
220 * @sense: optional sense buffer
221 * @timeout: request timeout in seconds
222 * @retries: number of times to retry request
James Bottomley33aa6872005-08-28 11:31:14 -0500223 * @flags: or into request flags;
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900224 * @resid: optional residual length
James Bottomley39216032005-06-15 18:48:29 -0500225 *
Michael Opdenacker59c51592007-05-09 08:57:56 +0200226 * returns the req->errors value which is the scsi_cmnd result
James Bottomleyea73a9f2005-08-28 11:33:52 -0500227 * field.
Rob Landleyeb448202007-11-03 13:30:39 -0500228 */
James Bottomley33aa6872005-08-28 11:31:14 -0500229int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
230 int data_direction, void *buffer, unsigned bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900231 unsigned char *sense, int timeout, int retries, int flags,
232 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500233{
234 struct request *req;
235 int write = (data_direction == DMA_TO_DEVICE);
236 int ret = DRIVER_ERROR << 24;
237
238 req = blk_get_request(sdev->request_queue, write, __GFP_WAIT);
James Bottomleybfe159a2011-07-07 15:45:40 -0500239 if (!req)
240 return ret;
James Bottomley39216032005-06-15 18:48:29 -0500241
242 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
243 buffer, bufflen, __GFP_WAIT))
244 goto out;
245
246 req->cmd_len = COMMAND_SIZE(cmd[0]);
247 memcpy(req->cmd, cmd, req->cmd_len);
248 req->sense = sense;
249 req->sense_len = 0;
Mike Christie17e01f22005-11-11 05:31:37 -0600250 req->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500251 req->timeout = timeout;
Jens Axboe4aff5e22006-08-10 08:44:47 +0200252 req->cmd_type = REQ_TYPE_BLOCK_PC;
253 req->cmd_flags |= flags | REQ_QUIET | REQ_PREEMPT;
James Bottomley39216032005-06-15 18:48:29 -0500254
255 /*
256 * head injection *required* here otherwise quiesce won't work
257 */
258 blk_execute_rq(req->q, NULL, req, 1);
259
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400260 /*
261 * Some devices (USB mass-storage in particular) may transfer
262 * garbage data together with a residue indicating that the data
263 * is invalid. Prevent the garbage from being misinterpreted
264 * and prevent security leaks by zeroing out the excess data.
265 */
Tejun Heoc3a4d782009-05-07 22:24:37 +0900266 if (unlikely(req->resid_len > 0 && req->resid_len <= bufflen))
267 memset(buffer + (bufflen - req->resid_len), 0, req->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400268
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900269 if (resid)
Tejun Heoc3a4d782009-05-07 22:24:37 +0900270 *resid = req->resid_len;
James Bottomley39216032005-06-15 18:48:29 -0500271 ret = req->errors;
272 out:
273 blk_put_request(req);
274
275 return ret;
276}
James Bottomley33aa6872005-08-28 11:31:14 -0500277EXPORT_SYMBOL(scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500278
James Bottomleyea73a9f2005-08-28 11:33:52 -0500279
280int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
281 int data_direction, void *buffer, unsigned bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900282 struct scsi_sense_hdr *sshdr, int timeout, int retries,
283 int *resid)
James Bottomleyea73a9f2005-08-28 11:33:52 -0500284{
285 char *sense = NULL;
akpm@osdl.org1ccb48b2005-06-26 00:12:51 -0700286 int result;
287
James Bottomleyea73a9f2005-08-28 11:33:52 -0500288 if (sshdr) {
Jes Sorensen24669f752006-01-16 10:31:18 -0500289 sense = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500290 if (!sense)
291 return DRIVER_ERROR << 24;
James Bottomleyea73a9f2005-08-28 11:33:52 -0500292 }
akpm@osdl.org1ccb48b2005-06-26 00:12:51 -0700293 result = scsi_execute(sdev, cmd, data_direction, buffer, bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900294 sense, timeout, retries, 0, resid);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500295 if (sshdr)
James Bottomleye5143852005-08-09 11:55:36 -0500296 scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, sshdr);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500297
298 kfree(sense);
299 return result;
300}
301EXPORT_SYMBOL(scsi_execute_req);
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303/*
304 * Function: scsi_init_cmd_errh()
305 *
306 * Purpose: Initialize cmd fields related to error handling.
307 *
308 * Arguments: cmd - command that is ready to be queued.
309 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 * Notes: This function has the job of initializing a number of
311 * fields related to error handling. Typically this will
312 * be called once for each command, as required.
313 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200314static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 cmd->serial_number = 0;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200317 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900318 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300320 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321}
322
323void scsi_device_unbusy(struct scsi_device *sdev)
324{
325 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500326 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 unsigned long flags;
328
329 spin_lock_irqsave(shost->host_lock, flags);
330 shost->host_busy--;
Mike Christief0c0a372008-08-17 15:24:38 -0500331 starget->target_busy--;
James Bottomley939647e2005-09-18 15:05:20 -0500332 if (unlikely(scsi_host_in_recovery(shost) &&
Tejun Heoee7863b2006-05-15 20:57:20 +0900333 (shost->host_failed || shost->host_eh_scheduled)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 scsi_eh_wakeup(shost);
335 spin_unlock(shost->host_lock);
152587d2005-04-12 16:22:06 -0500336 spin_lock(sdev->request_queue->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 sdev->device_busy--;
152587d2005-04-12 16:22:06 -0500338 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339}
340
341/*
342 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
343 * and call blk_run_queue for all the scsi_devices on the target -
344 * including current_sdev first.
345 *
346 * Called with *no* scsi locks held.
347 */
348static void scsi_single_lun_run(struct scsi_device *current_sdev)
349{
350 struct Scsi_Host *shost = current_sdev->host;
351 struct scsi_device *sdev, *tmp;
352 struct scsi_target *starget = scsi_target(current_sdev);
353 unsigned long flags;
354
355 spin_lock_irqsave(shost->host_lock, flags);
356 starget->starget_sdev_user = NULL;
357 spin_unlock_irqrestore(shost->host_lock, flags);
358
359 /*
360 * Call blk_run_queue for all LUNs on the target, starting with
361 * current_sdev. We race with others (to set starget_sdev_user),
362 * but in most cases, we will be first. Ideally, each LU on the
363 * target would get some limited time or requests on the target.
364 */
365 blk_run_queue(current_sdev->request_queue);
366
367 spin_lock_irqsave(shost->host_lock, flags);
368 if (starget->starget_sdev_user)
369 goto out;
370 list_for_each_entry_safe(sdev, tmp, &starget->devices,
371 same_target_siblings) {
372 if (sdev == current_sdev)
373 continue;
374 if (scsi_device_get(sdev))
375 continue;
376
377 spin_unlock_irqrestore(shost->host_lock, flags);
378 blk_run_queue(sdev->request_queue);
379 spin_lock_irqsave(shost->host_lock, flags);
380
381 scsi_device_put(sdev);
382 }
383 out:
384 spin_unlock_irqrestore(shost->host_lock, flags);
385}
386
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400387static inline int scsi_device_is_busy(struct scsi_device *sdev)
388{
389 if (sdev->device_busy >= sdev->queue_depth || sdev->device_blocked)
390 return 1;
391
392 return 0;
393}
394
Mike Christief0c0a372008-08-17 15:24:38 -0500395static inline int scsi_target_is_busy(struct scsi_target *starget)
396{
397 return ((starget->can_queue > 0 &&
398 starget->target_busy >= starget->can_queue) ||
399 starget->target_blocked);
400}
401
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400402static inline int scsi_host_is_busy(struct Scsi_Host *shost)
403{
404 if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
405 shost->host_blocked || shost->host_self_blocked)
406 return 1;
407
408 return 0;
409}
410
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411/*
412 * Function: scsi_run_queue()
413 *
414 * Purpose: Select a proper request queue to serve next
415 *
416 * Arguments: q - last request's queue
417 *
418 * Returns: Nothing
419 *
420 * Notes: The previous command was completely finished, start
421 * a new one if possible.
422 */
423static void scsi_run_queue(struct request_queue *q)
424{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600425 struct scsi_device *sdev = q->queuedata;
James Bottomleyc055f5b2011-05-01 09:42:07 -0500426 struct Scsi_Host *shost;
Mike Christie2a3a59e2008-11-11 13:42:35 -0600427 LIST_HEAD(starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 unsigned long flags;
429
James Bottomleyc055f5b2011-05-01 09:42:07 -0500430 shost = sdev->host;
Tony Battersby25d7c362007-11-12 10:00:44 -0500431 if (scsi_target(sdev)->single_lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 scsi_single_lun_run(sdev);
433
434 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600435 list_splice_init(&shost->starved_list, &starved_list);
436
437 while (!list_empty(&starved_list)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 /*
439 * As long as shost is accepting commands and we have
440 * starved queues, call blk_run_queue. scsi_request_fn
441 * drops the queue_lock and can add us back to the
442 * starved_list.
443 *
444 * host_lock protects the starved_list and starved_entry.
445 * scsi_request_fn must get the host_lock before checking
446 * or modifying starved_list or starved_entry.
447 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600448 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500449 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500450
Mike Christie2a3a59e2008-11-11 13:42:35 -0600451 sdev = list_entry(starved_list.next,
452 struct scsi_device, starved_entry);
453 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500454 if (scsi_target_is_busy(scsi_target(sdev))) {
455 list_move_tail(&sdev->starved_entry,
456 &shost->starved_list);
457 continue;
458 }
459
Jens Axboe9937a5e2011-05-17 11:04:44 +0200460 spin_unlock(shost->host_lock);
461 spin_lock(sdev->request_queue->queue_lock);
462 __blk_run_queue(sdev->request_queue);
463 spin_unlock(sdev->request_queue->queue_lock);
464 spin_lock(shost->host_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600466 /* put any unprocessed entries back */
467 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 spin_unlock_irqrestore(shost->host_lock, flags);
469
470 blk_run_queue(q);
471}
472
Jens Axboe9937a5e2011-05-17 11:04:44 +0200473void scsi_requeue_run_queue(struct work_struct *work)
474{
475 struct scsi_device *sdev;
476 struct request_queue *q;
477
478 sdev = container_of(work, struct scsi_device, requeue_work);
479 q = sdev->request_queue;
480 scsi_run_queue(q);
481}
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483/*
484 * Function: scsi_requeue_command()
485 *
486 * Purpose: Handle post-processing of completed commands.
487 *
488 * Arguments: q - queue to operate on
489 * cmd - command that may need to be requeued.
490 *
491 * Returns: Nothing
492 *
493 * Notes: After command completion, there may be blocks left
494 * over which weren't finished by the previous command
495 * this can be for a number of reasons - the main one is
496 * I/O errors in the middle of the request, in which case
497 * we need to request the blocks that come after the bad
498 * sector.
James Bottomleye91442b2005-09-09 10:44:16 -0500499 * Notes: Upon return, cmd is a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 */
501static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
502{
Bart Van Assche940f5d42012-06-29 15:34:26 +0000503 struct scsi_device *sdev = cmd->device;
James Bottomleye91442b2005-09-09 10:44:16 -0500504 struct request *req = cmd->request;
Tejun Heo 283369c2005-04-24 02:06:36 -0500505 unsigned long flags;
506
Bart Van Assche940f5d42012-06-29 15:34:26 +0000507 /*
508 * We need to hold a reference on the device to avoid the queue being
509 * killed after the unlock and before scsi_run_queue is invoked which
510 * may happen because scsi_unprep_request() puts the command which
511 * releases its reference on the device.
512 */
513 get_device(&sdev->sdev_gendev);
514
Tejun Heo 283369c2005-04-24 02:06:36 -0500515 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley02bd3492008-12-12 13:28:29 -0600516 scsi_unprep_request(req);
James Bottomleye91442b2005-09-09 10:44:16 -0500517 blk_requeue_request(q, req);
Tejun Heo 283369c2005-04-24 02:06:36 -0500518 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
520 scsi_run_queue(q);
Bart Van Assche940f5d42012-06-29 15:34:26 +0000521
522 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523}
524
525void scsi_next_command(struct scsi_cmnd *cmd)
526{
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800527 struct scsi_device *sdev = cmd->device;
528 struct request_queue *q = sdev->request_queue;
529
530 /* need to hold a reference on the device before we let go of the cmd */
531 get_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
533 scsi_put_command(cmd);
534 scsi_run_queue(q);
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800535
536 /* ok to remove device now */
537 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538}
539
540void scsi_run_host_queues(struct Scsi_Host *shost)
541{
542 struct scsi_device *sdev;
543
544 shost_for_each_device(sdev, shost)
545 scsi_run_queue(sdev->request_queue);
546}
547
James Bottomley79ed2422009-01-06 13:15:20 -0600548static void __scsi_release_buffers(struct scsi_cmnd *, int);
549
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550/*
551 * Function: scsi_end_request()
552 *
553 * Purpose: Post-processing of completed commands (usually invoked at end
554 * of upper level post-processing and scsi_io_completion).
555 *
556 * Arguments: cmd - command that is complete.
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500557 * error - 0 if I/O indicates success, < 0 for I/O error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 * bytes - number of bytes of completed I/O
559 * requeue - indicates whether we should requeue leftovers.
560 *
561 * Lock status: Assumed that lock is not held upon entry.
562 *
James Bottomleye91442b2005-09-09 10:44:16 -0500563 * Returns: cmd if requeue required, NULL otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 *
565 * Notes: This is called for block device requests in order to
566 * mark some number of sectors as complete.
567 *
568 * We are guaranteeing that the request queue will be goosed
569 * at some point during this call.
James Bottomleye91442b2005-09-09 10:44:16 -0500570 * Notes: If cmd was requeued, upon return it will be a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 */
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500572static struct scsi_cmnd *scsi_end_request(struct scsi_cmnd *cmd, int error,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 int bytes, int requeue)
574{
Jens Axboe165125e2007-07-24 09:28:11 +0200575 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 struct request *req = cmd->request;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
578 /*
579 * If there are blocks left over at the end, set up the command
580 * to queue the remainder of them.
581 */
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500582 if (blk_end_request(req, error, bytes)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 /* kill remainder if no retrys */
Mike Christie4a274462008-08-19 18:45:31 -0500584 if (error && scsi_noretry_cmd(cmd))
Tejun Heoe4588242009-05-12 08:49:32 +0200585 blk_end_request_all(req, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 else {
James Bottomleye91442b2005-09-09 10:44:16 -0500587 if (requeue) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 /*
589 * Bleah. Leftovers again. Stick the
590 * leftovers in the front of the
591 * queue, and goose the queue again.
592 */
James Bottomley79ed2422009-01-06 13:15:20 -0600593 scsi_release_buffers(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 scsi_requeue_command(q, cmd);
James Bottomleye91442b2005-09-09 10:44:16 -0500595 cmd = NULL;
596 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 return cmd;
598 }
599 }
600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 /*
602 * This will goose the queue request function at the end, so we don't
603 * need to worry about launching another command.
604 */
James Bottomley79ed2422009-01-06 13:15:20 -0600605 __scsi_release_buffers(cmd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 scsi_next_command(cmd);
607 return NULL;
608}
609
Jens Axboea8474ce2007-08-07 09:02:51 +0200610static inline unsigned int scsi_sgtable_index(unsigned short nents)
611{
612 unsigned int index;
613
James Bottomleyd3f46f32008-01-15 11:11:46 -0600614 BUG_ON(nents > SCSI_MAX_SG_SEGMENTS);
615
616 if (nents <= 8)
Jens Axboea8474ce2007-08-07 09:02:51 +0200617 index = 0;
James Bottomleyd3f46f32008-01-15 11:11:46 -0600618 else
619 index = get_count_order(nents) - 3;
Jens Axboea8474ce2007-08-07 09:02:51 +0200620
621 return index;
622}
623
Jens Axboe5ed79592007-11-15 09:13:11 +0100624static void scsi_sg_free(struct scatterlist *sgl, unsigned int nents)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625{
626 struct scsi_host_sg_pool *sgp;
Jens Axboe5ed79592007-11-15 09:13:11 +0100627
628 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
629 mempool_free(sgl, sgp->pool);
630}
631
632static struct scatterlist *scsi_sg_alloc(unsigned int nents, gfp_t gfp_mask)
633{
634 struct scsi_host_sg_pool *sgp;
635
636 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
637 return mempool_alloc(sgp->pool, gfp_mask);
638}
639
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200640static int scsi_alloc_sgtable(struct scsi_data_buffer *sdb, int nents,
641 gfp_t gfp_mask)
Jens Axboe5ed79592007-11-15 09:13:11 +0100642{
643 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200645 BUG_ON(!nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200647 ret = __sg_alloc_table(&sdb->table, nents, SCSI_MAX_SG_SEGMENTS,
648 gfp_mask, scsi_sg_alloc);
Jens Axboe5ed79592007-11-15 09:13:11 +0100649 if (unlikely(ret))
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200650 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS,
James Bottomley7cedb1f2008-01-13 14:15:28 -0600651 scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Jens Axboea8474ce2007-08-07 09:02:51 +0200653 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654}
655
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200656static void scsi_free_sgtable(struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200658 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS, scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659}
660
James Bottomley79ed2422009-01-06 13:15:20 -0600661static void __scsi_release_buffers(struct scsi_cmnd *cmd, int do_bidi_check)
662{
663
664 if (cmd->sdb.table.nents)
665 scsi_free_sgtable(&cmd->sdb);
666
667 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
668
669 if (do_bidi_check && scsi_bidi_cmnd(cmd)) {
670 struct scsi_data_buffer *bidi_sdb =
671 cmd->request->next_rq->special;
672 scsi_free_sgtable(bidi_sdb);
673 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
674 cmd->request->next_rq->special = NULL;
675 }
676
677 if (scsi_prot_sg_count(cmd))
678 scsi_free_sgtable(cmd->prot_sdb);
679}
680
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681/*
682 * Function: scsi_release_buffers()
683 *
684 * Purpose: Completion processing for block device I/O requests.
685 *
686 * Arguments: cmd - command that we are bailing.
687 *
688 * Lock status: Assumed that no lock is held upon entry.
689 *
690 * Returns: Nothing
691 *
692 * Notes: In the event that an upper level driver rejects a
693 * command, we must release resources allocated during
694 * the __init_io() function. Primarily this would involve
695 * the scatter-gather table, and potentially any bounce
696 * buffers.
697 */
Boaz Harroshbb52d822007-12-13 16:14:27 -0800698void scsi_release_buffers(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699{
James Bottomley79ed2422009-01-06 13:15:20 -0600700 __scsi_release_buffers(cmd, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701}
Boaz Harroshbb52d822007-12-13 16:14:27 -0800702EXPORT_SYMBOL(scsi_release_buffers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100704static int __scsi_error_from_host_byte(struct scsi_cmnd *cmd, int result)
705{
706 int error = 0;
707
708 switch(host_byte(result)) {
709 case DID_TRANSPORT_FAILFAST:
710 error = -ENOLINK;
711 break;
712 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000713 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100714 error = -EREMOTEIO;
715 break;
716 case DID_NEXUS_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000717 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100718 error = -EBADE;
719 break;
720 default:
721 error = -EIO;
722 break;
723 }
724
725 return error;
726}
727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728/*
729 * Function: scsi_io_completion()
730 *
731 * Purpose: Completion processing for block device I/O requests.
732 *
733 * Arguments: cmd - command that is finished.
734 *
735 * Lock status: Assumed that no lock is held upon entry.
736 *
737 * Returns: Nothing
738 *
739 * Notes: This function is matched in terms of capabilities to
740 * the function that created the scatter-gather list.
741 * In other words, if there are no bounce buffers
742 * (the normal case for most drivers), we don't need
743 * the logic to deal with cleaning up afterwards.
744 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500745 * We must call scsi_end_request(). This will finish off
746 * the specified number of sectors. If we are done, the
747 * command block will be released and the queue function
748 * will be goosed. If we are not done then we have to
749 * figure out what to do next:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500751 * a) We can call scsi_requeue_command(). The request
752 * will be unprepared and put back on the queue. Then
753 * a new command will be created for it. This should
754 * be used if we made forward progress, or if we want
755 * to switch from READ(10) to READ(6) for example.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500757 * b) We can call scsi_queue_insert(). The request will
758 * be put back on the queue and retried using the same
759 * command as before, possibly after a delay.
760 *
761 * c) We can call blk_end_request() with -EIO to fail
762 * the remainder of the request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 */
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700764void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765{
766 int result = cmd->result;
Jens Axboe165125e2007-07-24 09:28:11 +0200767 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 struct request *req = cmd->request;
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500769 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 struct scsi_sense_hdr sshdr;
771 int sense_valid = 0;
772 int sense_deferred = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500773 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
774 ACTION_DELAYED_RETRY} action;
775 char *description = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 if (result) {
778 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
779 if (sense_valid)
780 sense_deferred = scsi_sense_is_deferred(&sshdr);
781 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200782
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200783 if (req->cmd_type == REQ_TYPE_BLOCK_PC) { /* SG_IO ioctl from block level */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 if (sense_valid && req->sense) {
786 /*
787 * SG_IO wants current and deferred errors
788 */
789 int len = 8 + cmd->sense_buffer[7];
790
791 if (len > SCSI_SENSE_BUFFERSIZE)
792 len = SCSI_SENSE_BUFFERSIZE;
793 memcpy(req->sense, cmd->sense_buffer, len);
794 req->sense_len = len;
795 }
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500796 if (!sense_deferred)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100797 error = __scsi_error_from_host_byte(cmd, result);
Pete Wyckoffb22f6872007-03-13 16:53:28 -0400798 }
Mike Snitzer27c41972012-05-31 15:05:33 -0400799 /*
800 * __scsi_error_from_host_byte may have reset the host_byte
801 */
802 req->errors = cmd->result;
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900803
804 req->resid_len = scsi_get_resid(cmd);
805
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200806 if (scsi_bidi_cmnd(cmd)) {
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900807 /*
808 * Bidi commands Must be complete as a whole,
809 * both sides at once.
810 */
811 req->next_rq->resid_len = scsi_in(cmd)->resid;
812
Boaz Harrosh63c43b02009-12-15 17:25:43 +0200813 scsi_release_buffers(cmd);
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900814 blk_end_request_all(req, 0);
815
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900816 scsi_next_command(cmd);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200817 return;
818 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 }
820
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200821 /* no bidi support for !REQ_TYPE_BLOCK_PC yet */
822 BUG_ON(blk_bidi_rq(req));
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200823
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 * Next deal with any sectors which we were able to correctly
826 * handle.
827 */
Tejun Heo83096eb2009-05-07 22:24:39 +0900828 SCSI_LOG_HLCOMPLETE(1, printk("%u sectors total, "
James Bottomleyd6b0c532006-07-02 10:06:28 -0500829 "%d bytes done.\n",
Tejun Heo83096eb2009-05-07 22:24:39 +0900830 blk_rq_sectors(req), good_bytes));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
James Bottomleya9bddd72009-03-30 16:55:51 +0000832 /*
833 * Recovered errors need reporting, but they're always treated
834 * as success, so fiddle the result code here. For BLOCK_PC
835 * we already took a copy of the original into rq->errors which
836 * is what gets returned to the user
837 */
Douglas Gilberte7efe592010-01-03 13:51:15 -0500838 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
839 /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
840 * print since caller wants ATA registers. Only occurs on
841 * SCSI ATA PASS_THROUGH commands when CK_COND=1
842 */
843 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
844 ;
845 else if (!(req->cmd_flags & REQ_QUIET))
James Bottomleya9bddd72009-03-30 16:55:51 +0000846 scsi_print_sense("", cmd);
847 result = 0;
848 /* BLOCK_PC may have set error */
849 error = 0;
850 }
851
852 /*
853 * A number of bytes were successfully read. If there
James Bottomleyd6b0c532006-07-02 10:06:28 -0500854 * are leftovers and there is some kind of error
855 * (result != 0), retry the rest.
856 */
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500857 if (scsi_end_request(cmd, error, good_bytes, result == 0) == NULL)
James Bottomleyd6b0c532006-07-02 10:06:28 -0500858 return;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700859
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100860 error = __scsi_error_from_host_byte(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500861
Alan Sternb60af5b2008-11-03 15:56:47 -0500862 if (host_byte(result) == DID_RESET) {
863 /* Third party bus reset or reset for error recovery
864 * reasons. Just retry the command and see what
865 * happens.
866 */
867 action = ACTION_RETRY;
868 } else if (sense_valid && !sense_deferred) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 switch (sshdr.sense_key) {
870 case UNIT_ATTENTION:
871 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700872 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 * and quietly refuse further access.
874 */
875 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500876 description = "Media Changed";
877 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700879 /* Must have been a power glitch, or a
880 * bus reset. Could not have been a
881 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500882 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700883 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500884 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 }
886 break;
887 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700888 /* If we had an ILLEGAL REQUEST returned, then
889 * we may have performed an unsupported
890 * command. The only thing this should be
891 * would be a ten byte read where only a six
892 * byte read was supported. Also, on a system
893 * where READ CAPACITY failed, we may have
894 * read past the end of the disk.
895 */
Jens Axboe26a68012005-11-29 21:03:34 +0100896 if ((cmd->device->use_10_for_rw &&
897 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 (cmd->cmnd[0] == READ_10 ||
899 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500900 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500902 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500903 } else if (sshdr.asc == 0x10) /* DIX */ {
904 description = "Host Data Integrity Failure";
905 action = ACTION_FAIL;
906 error = -EILSEQ;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500907 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400908 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
909 switch (cmd->cmnd[0]) {
910 case UNMAP:
911 description = "Discard failure";
912 break;
913 case WRITE_SAME:
914 case WRITE_SAME_16:
915 if (cmd->cmnd[1] & 0x8)
916 description = "Discard failure";
917 else
918 description =
919 "Write same failure";
920 break;
921 default:
922 description = "Invalid command failure";
923 break;
924 }
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500925 action = ACTION_FAIL;
Martin K. Petersen66a651a2012-02-13 15:38:22 -0500926 error = -EREMOTEIO;
Alan Sternb60af5b2008-11-03 15:56:47 -0500927 } else
928 action = ACTION_FAIL;
929 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400930 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000931 action = ACTION_FAIL;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400932 if (sshdr.asc == 0x10) { /* DIF */
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500933 description = "Target Data Integrity Failure";
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500934 error = -EILSEQ;
James Bottomley126c09822009-02-19 21:48:54 +0000935 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 break;
937 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700938 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500939 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500941 if (sshdr.asc == 0x04) {
942 switch (sshdr.ascq) {
943 case 0x01: /* becoming ready */
944 case 0x04: /* format in progress */
945 case 0x05: /* rebuild in progress */
946 case 0x06: /* recalculation in progress */
947 case 0x07: /* operation in progress */
948 case 0x08: /* Long write in progress */
949 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500950 case 0x14: /* space allocation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500951 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500952 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500953 default:
954 description = "Device not ready";
955 action = ACTION_FAIL;
956 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500957 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500958 } else {
959 description = "Device not ready";
960 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500962 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700964 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500965 action = ACTION_FAIL;
966 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500968 description = "Unhandled sense code";
969 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 break;
971 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500972 } else {
973 description = "Unhandled error code";
974 action = ACTION_FAIL;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700975 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500976
977 switch (action) {
978 case ACTION_FAIL:
979 /* Give up and fail the remainder of the request */
James Bottomley79ed2422009-01-06 13:15:20 -0600980 scsi_release_buffers(cmd);
Jens Axboe4aff5e22006-08-10 08:44:47 +0200981 if (!(req->cmd_flags & REQ_QUIET)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500982 if (description)
Alan Stern3dbf6a52008-12-15 10:31:28 -0500983 scmd_printk(KERN_INFO, cmd, "%s\n",
Alan Sternb60af5b2008-11-03 15:56:47 -0500984 description);
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500985 scsi_print_result(cmd);
James Bottomley3173d8c2005-09-04 11:32:05 -0500986 if (driver_byte(result) & DRIVER_SENSE)
987 scsi_print_sense("", cmd);
Martin K. Petersen002b1eb2009-05-23 11:45:07 -0400988 scsi_print_command(cmd);
James Bottomley3173d8c2005-09-04 11:32:05 -0500989 }
Mike Christiead630822009-09-28 15:50:52 -0500990 if (blk_end_request_err(req, error))
Tejun Heoda6c5c72009-09-11 14:26:40 +0200991 scsi_requeue_command(q, cmd);
992 else
993 scsi_next_command(cmd);
Alan Sternb60af5b2008-11-03 15:56:47 -0500994 break;
995 case ACTION_REPREP:
996 /* Unprep the request and put it back at the head of the queue.
997 * A new command will be prepared and issued.
998 */
James Bottomley79ed2422009-01-06 13:15:20 -0600999 scsi_release_buffers(cmd);
Alan Sternb60af5b2008-11-03 15:56:47 -05001000 scsi_requeue_command(q, cmd);
1001 break;
1002 case ACTION_RETRY:
1003 /* Retry the same command immediately */
James Bottomley4f5299a2009-01-02 10:42:21 -06001004 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001005 break;
1006 case ACTION_DELAYED_RETRY:
1007 /* Retry the same command after a delay */
James Bottomley4f5299a2009-01-02 10:42:21 -06001008 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001009 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 }
1011}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001013static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb,
1014 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001016 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
1018 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001019 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001021 if (unlikely(scsi_alloc_sgtable(sdb, req->nr_phys_segments,
1022 gfp_mask))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 return BLKPREP_DEFER;
Alan Stern7c72ce82005-10-14 11:23:27 -04001024 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025
Christoph Hellwig3b003152006-11-04 20:10:55 +01001026 req->buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
1028 /*
1029 * Next, walk the list, and fill in the addresses and sizes of
1030 * each segment.
1031 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001032 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1033 BUG_ON(count > sdb->table.nents);
1034 sdb->table.nents = count;
Tejun Heo1011c1b2009-05-07 22:24:45 +09001035 sdb->length = blk_rq_bytes(req);
Rusty Russell4a03d902007-11-19 11:28:48 +11001036 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001038
1039/*
1040 * Function: scsi_init_io()
1041 *
1042 * Purpose: SCSI I/O initialize function.
1043 *
1044 * Arguments: cmd - Command descriptor we wish to initialize
1045 *
1046 * Returns: 0 on success
1047 * BLKPREP_DEFER if the failure is retryable
1048 * BLKPREP_KILL if the failure is fatal
1049 */
1050int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask)
1051{
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001052 struct request *rq = cmd->request;
1053
1054 int error = scsi_init_sgtable(rq, &cmd->sdb, gfp_mask);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001055 if (error)
1056 goto err_exit;
1057
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001058 if (blk_bidi_rq(rq)) {
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001059 struct scsi_data_buffer *bidi_sdb = kmem_cache_zalloc(
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001060 scsi_sdb_cache, GFP_ATOMIC);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001061 if (!bidi_sdb) {
1062 error = BLKPREP_DEFER;
1063 goto err_exit;
1064 }
1065
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001066 rq->next_rq->special = bidi_sdb;
1067 error = scsi_init_sgtable(rq->next_rq, bidi_sdb, GFP_ATOMIC);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001068 if (error)
1069 goto err_exit;
1070 }
1071
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001072 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001073 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1074 int ivecs, count;
1075
1076 BUG_ON(prot_sdb == NULL);
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001077 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001078
1079 if (scsi_alloc_sgtable(prot_sdb, ivecs, gfp_mask)) {
1080 error = BLKPREP_DEFER;
1081 goto err_exit;
1082 }
1083
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001084 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001085 prot_sdb->table.sgl);
1086 BUG_ON(unlikely(count > ivecs));
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001087 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001088
1089 cmd->prot_sdb = prot_sdb;
1090 cmd->prot_sdb->table.nents = count;
1091 }
1092
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001093 return BLKPREP_OK ;
1094
1095err_exit:
1096 scsi_release_buffers(cmd);
FUJITA Tomonori610a6342010-07-08 10:16:17 +02001097 cmd->request->special = NULL;
James Bottomley3a5c19c2010-08-16 10:06:26 -05001098 scsi_put_command(cmd);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001099 return error;
1100}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001101EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102
Christoph Hellwig3b003152006-11-04 20:10:55 +01001103static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
1104 struct request *req)
1105{
1106 struct scsi_cmnd *cmd;
1107
1108 if (!req->special) {
1109 cmd = scsi_get_command(sdev, GFP_ATOMIC);
1110 if (unlikely(!cmd))
1111 return NULL;
1112 req->special = cmd;
1113 } else {
1114 cmd = req->special;
1115 }
1116
1117 /* pull a tag out of the request if we have one */
1118 cmd->tag = req->tag;
1119 cmd->request = req;
1120
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001121 cmd->cmnd = req->cmd;
Martin K. Petersen72f7d322011-03-08 02:03:59 -05001122 cmd->prot_op = SCSI_PROT_NORMAL;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001123
Christoph Hellwig3b003152006-11-04 20:10:55 +01001124 return cmd;
1125}
1126
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001127int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001128{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001129 struct scsi_cmnd *cmd;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001130 int ret = scsi_prep_state_check(sdev, req);
1131
1132 if (ret != BLKPREP_OK)
1133 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001134
1135 cmd = scsi_get_cmd_from_req(sdev, req);
1136 if (unlikely(!cmd))
1137 return BLKPREP_DEFER;
1138
1139 /*
1140 * BLOCK_PC requests may transfer data, in which case they must
1141 * a bio attached to them. Or they might contain a SCSI command
1142 * that does not transfer data, in which case they may optionally
1143 * submit a request without an attached bio.
1144 */
1145 if (req->bio) {
1146 int ret;
1147
1148 BUG_ON(!req->nr_phys_segments);
1149
Boaz Harroshbb52d822007-12-13 16:14:27 -08001150 ret = scsi_init_io(cmd, GFP_ATOMIC);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001151 if (unlikely(ret))
1152 return ret;
1153 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001154 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001155
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001156 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001157 req->buffer = NULL;
1158 }
James Bottomley7b163182005-12-15 20:17:02 -06001159
James Bottomley7b163182005-12-15 20:17:02 -06001160 cmd->cmd_len = req->cmd_len;
Tejun Heob0790412009-05-07 22:24:42 +09001161 if (!blk_rq_bytes(req))
James Bottomley7b163182005-12-15 20:17:02 -06001162 cmd->sc_data_direction = DMA_NONE;
1163 else if (rq_data_dir(req) == WRITE)
1164 cmd->sc_data_direction = DMA_TO_DEVICE;
1165 else
1166 cmd->sc_data_direction = DMA_FROM_DEVICE;
1167
Tejun Heob0790412009-05-07 22:24:42 +09001168 cmd->transfersize = blk_rq_bytes(req);
James Bottomley7b163182005-12-15 20:17:02 -06001169 cmd->allowed = req->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001170 return BLKPREP_OK;
1171}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001172EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001173
1174/*
1175 * Setup a REQ_TYPE_FS command. These are simple read/write request
1176 * from filesystems that still need to be translated to SCSI CDBs from
1177 * the ULD.
1178 */
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001179int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001180{
1181 struct scsi_cmnd *cmd;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001182 int ret = scsi_prep_state_check(sdev, req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001183
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001184 if (ret != BLKPREP_OK)
1185 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001186
1187 if (unlikely(sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh
1188 && sdev->scsi_dh_data->scsi_dh->prep_fn)) {
1189 ret = sdev->scsi_dh_data->scsi_dh->prep_fn(sdev, req);
1190 if (ret != BLKPREP_OK)
1191 return ret;
1192 }
1193
Christoph Hellwig3b003152006-11-04 20:10:55 +01001194 /*
1195 * Filesystem requests must transfer data.
1196 */
1197 BUG_ON(!req->nr_phys_segments);
1198
1199 cmd = scsi_get_cmd_from_req(sdev, req);
1200 if (unlikely(!cmd))
1201 return BLKPREP_DEFER;
1202
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001203 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Boaz Harroshbb52d822007-12-13 16:14:27 -08001204 return scsi_init_io(cmd, GFP_ATOMIC);
James Bottomley7b163182005-12-15 20:17:02 -06001205}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001206EXPORT_SYMBOL(scsi_setup_fs_cmnd);
James Bottomley7b163182005-12-15 20:17:02 -06001207
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001208int scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001210 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
1212 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001213 * If the device is not in running state we will reject some
1214 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001217 switch (sdev->sdev_state) {
1218 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05001219 case SDEV_TRANSPORT_OFFLINE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001220 /*
1221 * If the device is offline we refuse to process any
1222 * commands. The device must be brought online
1223 * before trying any recovery commands.
1224 */
1225 sdev_printk(KERN_ERR, sdev,
1226 "rejecting I/O to offline device\n");
1227 ret = BLKPREP_KILL;
1228 break;
1229 case SDEV_DEL:
1230 /*
1231 * If the device is fully deleted, we refuse to
1232 * process any commands as well.
1233 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001234 sdev_printk(KERN_ERR, sdev,
1235 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001236 ret = BLKPREP_KILL;
1237 break;
1238 case SDEV_QUIESCE:
1239 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001240 case SDEV_CREATED_BLOCK:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001241 /*
1242 * If the devices is blocked we defer normal commands.
1243 */
1244 if (!(req->cmd_flags & REQ_PREEMPT))
1245 ret = BLKPREP_DEFER;
1246 break;
1247 default:
1248 /*
1249 * For any other not fully online state we only allow
1250 * special commands. In particular any user initiated
1251 * command is not allowed.
1252 */
1253 if (!(req->cmd_flags & REQ_PREEMPT))
1254 ret = BLKPREP_KILL;
1255 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001258 return ret;
1259}
1260EXPORT_SYMBOL(scsi_prep_state_check);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001262int scsi_prep_return(struct request_queue *q, struct request *req, int ret)
1263{
1264 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
Christoph Hellwig3b003152006-11-04 20:10:55 +01001266 switch (ret) {
1267 case BLKPREP_KILL:
1268 req->errors = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001269 /* release the command and kill it */
1270 if (req->special) {
1271 struct scsi_cmnd *cmd = req->special;
1272 scsi_release_buffers(cmd);
1273 scsi_put_command(cmd);
1274 req->special = NULL;
1275 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001276 break;
1277 case BLKPREP_DEFER:
1278 /*
Tejun Heo9934c8c2009-05-08 11:54:16 +09001279 * If we defer, the blk_peek_request() returns NULL, but the
Jens Axboea488e742010-04-16 21:13:15 +02001280 * queue must be restarted, so we schedule a callback to happen
1281 * shortly.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001282 */
1283 if (sdev->device_busy == 0)
Jens Axboea488e742010-04-16 21:13:15 +02001284 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001285 break;
1286 default:
1287 req->cmd_flags |= REQ_DONTPREP;
1288 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289
Christoph Hellwig3b003152006-11-04 20:10:55 +01001290 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001292EXPORT_SYMBOL(scsi_prep_return);
1293
James Bottomley751bf4d2008-01-02 11:14:30 -06001294int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001295{
1296 struct scsi_device *sdev = q->queuedata;
1297 int ret = BLKPREP_KILL;
1298
1299 if (req->cmd_type == REQ_TYPE_BLOCK_PC)
1300 ret = scsi_setup_blk_pc_cmnd(sdev, req);
1301 return scsi_prep_return(q, req, ret);
1302}
Hannes Reineckeb3912772009-06-18 09:57:18 +02001303EXPORT_SYMBOL(scsi_prep_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304
1305/*
1306 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1307 * return 0.
1308 *
1309 * Called with the queue_lock held.
1310 */
1311static inline int scsi_dev_queue_ready(struct request_queue *q,
1312 struct scsi_device *sdev)
1313{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 if (sdev->device_busy == 0 && sdev->device_blocked) {
1315 /*
1316 * unblock after device_blocked iterates to zero
1317 */
1318 if (--sdev->device_blocked == 0) {
1319 SCSI_LOG_MLQUEUE(3,
James Bottomley9ccfc752005-10-02 11:45:08 -05001320 sdev_printk(KERN_INFO, sdev,
1321 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 } else {
Jens Axboea488e742010-04-16 21:13:15 +02001323 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 return 0;
1325 }
1326 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001327 if (scsi_device_is_busy(sdev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 return 0;
1329
1330 return 1;
1331}
1332
Mike Christief0c0a372008-08-17 15:24:38 -05001333
1334/*
1335 * scsi_target_queue_ready: checks if there we can send commands to target
1336 * @sdev: scsi device on starget to check.
1337 *
1338 * Called with the host lock held.
1339 */
1340static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1341 struct scsi_device *sdev)
1342{
1343 struct scsi_target *starget = scsi_target(sdev);
1344
1345 if (starget->single_lun) {
1346 if (starget->starget_sdev_user &&
1347 starget->starget_sdev_user != sdev)
1348 return 0;
1349 starget->starget_sdev_user = sdev;
1350 }
1351
1352 if (starget->target_busy == 0 && starget->target_blocked) {
1353 /*
1354 * unblock after target_blocked iterates to zero
1355 */
1356 if (--starget->target_blocked == 0) {
1357 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1358 "unblocking target at zero depth\n"));
Mike Christieb4efdd52009-04-09 15:57:10 -05001359 } else
Mike Christief0c0a372008-08-17 15:24:38 -05001360 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001361 }
1362
1363 if (scsi_target_is_busy(starget)) {
Shaohua Li466c08c2012-01-10 11:27:01 +08001364 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Hillf Dantonfd01a662010-12-16 14:26:37 -06001365 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001366 }
1367
Mike Christief0c0a372008-08-17 15:24:38 -05001368 return 1;
1369}
1370
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371/*
1372 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1373 * return 0. We must end up running the queue again whenever 0 is
1374 * returned, else IO can hang.
1375 *
1376 * Called with host_lock held.
1377 */
1378static inline int scsi_host_queue_ready(struct request_queue *q,
1379 struct Scsi_Host *shost,
1380 struct scsi_device *sdev)
1381{
James Bottomley939647e2005-09-18 15:05:20 -05001382 if (scsi_host_in_recovery(shost))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 return 0;
1384 if (shost->host_busy == 0 && shost->host_blocked) {
1385 /*
1386 * unblock after host_blocked iterates to zero
1387 */
1388 if (--shost->host_blocked == 0) {
1389 SCSI_LOG_MLQUEUE(3,
1390 printk("scsi%d unblocking host at zero depth\n",
1391 shost->host_no));
1392 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 return 0;
1394 }
1395 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001396 if (scsi_host_is_busy(shost)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 if (list_empty(&sdev->starved_entry))
1398 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1399 return 0;
1400 }
1401
1402 /* We're OK to process the command, so we can't be starved */
1403 if (!list_empty(&sdev->starved_entry))
1404 list_del_init(&sdev->starved_entry);
1405
1406 return 1;
1407}
1408
1409/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001410 * Busy state exporting function for request stacking drivers.
1411 *
1412 * For efficiency, no lock is taken to check the busy state of
1413 * shost/starget/sdev, since the returned value is not guaranteed and
1414 * may be changed after request stacking drivers call the function,
1415 * regardless of taking lock or not.
1416 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001417 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1418 * needs to return 'not busy'. Otherwise, request stacking drivers
1419 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001420 */
1421static int scsi_lld_busy(struct request_queue *q)
1422{
1423 struct scsi_device *sdev = q->queuedata;
1424 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001425
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001426 if (blk_queue_dying(q))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001427 return 0;
1428
1429 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001430
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001431 /*
1432 * Ignore host/starget busy state.
1433 * Since block layer does not have a concept of fairness across
1434 * multiple queues, congestion of host/starget needs to be handled
1435 * in SCSI layer.
1436 */
1437 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001438 return 1;
1439
1440 return 0;
1441}
1442
1443/*
James Bottomleye91442b2005-09-09 10:44:16 -05001444 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 */
Jens Axboe165125e2007-07-24 09:28:11 +02001446static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447{
James Bottomleye91442b2005-09-09 10:44:16 -05001448 struct scsi_cmnd *cmd = req->special;
Jiri Slaby03b14702009-09-23 16:15:35 +02001449 struct scsi_device *sdev;
1450 struct scsi_target *starget;
1451 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452
Tejun Heo9934c8c2009-05-08 11:54:16 +09001453 blk_start_request(req);
James Bottomley788ce432005-09-09 13:40:23 -05001454
Hannes Reinecke74571812011-11-09 08:39:24 +01001455 scmd_printk(KERN_INFO, cmd, "killing request\n");
1456
Jiri Slaby03b14702009-09-23 16:15:35 +02001457 sdev = cmd->device;
1458 starget = scsi_target(sdev);
1459 shost = sdev->host;
James Bottomleye91442b2005-09-09 10:44:16 -05001460 scsi_init_cmd_errh(cmd);
1461 cmd->result = DID_NO_CONNECT << 16;
1462 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001463
1464 /*
1465 * SCSI request completion path will do scsi_device_unbusy(),
1466 * bump busy counts. To bump the counters, we need to dance
1467 * with the locks as normal issue path does.
1468 */
1469 sdev->device_busy++;
1470 spin_unlock(sdev->request_queue->queue_lock);
1471 spin_lock(shost->host_lock);
1472 shost->host_busy++;
Mike Christief0c0a372008-08-17 15:24:38 -05001473 starget->target_busy++;
Tejun Heoe36e0c82006-04-11 17:27:53 +09001474 spin_unlock(shost->host_lock);
1475 spin_lock(sdev->request_queue->queue_lock);
1476
Jens Axboe242f9dc2008-09-14 05:55:09 -07001477 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478}
1479
Jens Axboe1aea6432006-01-09 16:03:03 +01001480static void scsi_softirq_done(struct request *rq)
1481{
Jens Axboe242f9dc2008-09-14 05:55:09 -07001482 struct scsi_cmnd *cmd = rq->special;
1483 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001484 int disposition;
1485
1486 INIT_LIST_HEAD(&cmd->eh_entry);
1487
Jens Axboe242f9dc2008-09-14 05:55:09 -07001488 atomic_inc(&cmd->device->iodone_cnt);
1489 if (cmd->result)
1490 atomic_inc(&cmd->device->ioerr_cnt);
1491
Jens Axboe1aea6432006-01-09 16:03:03 +01001492 disposition = scsi_decide_disposition(cmd);
1493 if (disposition != SUCCESS &&
1494 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1495 sdev_printk(KERN_ERR, cmd->device,
1496 "timing out command, waited %lus\n",
1497 wait_for/HZ);
1498 disposition = SUCCESS;
1499 }
1500
1501 scsi_log_completion(cmd, disposition);
1502
1503 switch (disposition) {
1504 case SUCCESS:
1505 scsi_finish_command(cmd);
1506 break;
1507 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001508 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001509 break;
1510 case ADD_TO_MLQUEUE:
1511 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1512 break;
1513 default:
1514 if (!scsi_eh_scmd_add(cmd, 0))
1515 scsi_finish_command(cmd);
1516 }
1517}
1518
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519/*
1520 * Function: scsi_request_fn()
1521 *
1522 * Purpose: Main strategy routine for SCSI.
1523 *
1524 * Arguments: q - Pointer to actual queue.
1525 *
1526 * Returns: Nothing
1527 *
1528 * Lock status: IO request lock assumed to be held when called.
1529 */
1530static void scsi_request_fn(struct request_queue *q)
1531{
1532 struct scsi_device *sdev = q->queuedata;
1533 struct Scsi_Host *shost;
1534 struct scsi_cmnd *cmd;
1535 struct request *req;
1536
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 if(!get_device(&sdev->sdev_gendev))
1538 /* We must be tearing the block queue down already */
1539 return;
1540
1541 /*
1542 * To start with, we keep looping until the queue is empty, or until
1543 * the host is no longer able to accept any more requests.
1544 */
1545 shost = sdev->host;
Jens Axboea488e742010-04-16 21:13:15 +02001546 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 int rtn;
1548 /*
1549 * get next queueable request. We do this early to make sure
1550 * that the request is fully prepared even if we cannot
1551 * accept it.
1552 */
Tejun Heo9934c8c2009-05-08 11:54:16 +09001553 req = blk_peek_request(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 if (!req || !scsi_dev_queue_ready(q, sdev))
1555 break;
1556
1557 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001558 sdev_printk(KERN_ERR, sdev,
1559 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001560 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 continue;
1562 }
1563
1564
1565 /*
1566 * Remove the request from the request list.
1567 */
1568 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
Tejun Heo9934c8c2009-05-08 11:54:16 +09001569 blk_start_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 sdev->device_busy++;
1571
1572 spin_unlock(q->queue_lock);
James Bottomleye91442b2005-09-09 10:44:16 -05001573 cmd = req->special;
1574 if (unlikely(cmd == NULL)) {
1575 printk(KERN_CRIT "impossible request in %s.\n"
1576 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001577 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001578 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001579 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001580 BUG();
1581 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 spin_lock(shost->host_lock);
1583
Mike Christieecefe8a2008-07-11 19:50:35 -05001584 /*
1585 * We hit this when the driver is using a host wide
1586 * tag map. For device level tag maps the queue_depth check
1587 * in the device ready fn would prevent us from trying
1588 * to allocate a tag. Since the map is a shared host resource
1589 * we add the dev to the starved list so it eventually gets
1590 * a run when a tag is freed.
1591 */
Mike Christie6bd522f2008-07-22 15:34:38 -05001592 if (blk_queue_tagged(q) && !blk_rq_tagged(req)) {
Mike Christieecefe8a2008-07-11 19:50:35 -05001593 if (list_empty(&sdev->starved_entry))
1594 list_add_tail(&sdev->starved_entry,
1595 &shost->starved_list);
1596 goto not_ready;
1597 }
1598
Mike Christief0c0a372008-08-17 15:24:38 -05001599 if (!scsi_target_queue_ready(shost, sdev))
1600 goto not_ready;
1601
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 if (!scsi_host_queue_ready(q, shost, sdev))
1603 goto not_ready;
Mike Christief0c0a372008-08-17 15:24:38 -05001604
1605 scsi_target(sdev)->target_busy++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 shost->host_busy++;
1607
1608 /*
1609 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1610 * take the lock again.
1611 */
1612 spin_unlock_irq(shost->host_lock);
1613
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 /*
1615 * Finally, initialize any error handling parameters, and set up
1616 * the timers for timeouts.
1617 */
1618 scsi_init_cmd_errh(cmd);
1619
1620 /*
1621 * Dispatch the command to the low-level driver.
1622 */
1623 rtn = scsi_dispatch_cmd(cmd);
1624 spin_lock_irq(q->queue_lock);
Jens Axboea488e742010-04-16 21:13:15 +02001625 if (rtn)
1626 goto out_delay;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 }
1628
1629 goto out;
1630
1631 not_ready:
1632 spin_unlock_irq(shost->host_lock);
1633
1634 /*
1635 * lock q, handle tag, requeue req, and decrement device_busy. We
1636 * must return with queue_lock held.
1637 *
1638 * Decrementing device_busy without checking it is OK, as all such
1639 * cases (host limits or settings) should run the queue at some
1640 * later time.
1641 */
1642 spin_lock_irq(q->queue_lock);
1643 blk_requeue_request(q, req);
1644 sdev->device_busy--;
Jens Axboea488e742010-04-16 21:13:15 +02001645out_delay:
1646 if (sdev->device_busy == 0)
1647 blk_delay_queue(q, SCSI_QUEUE_DELAY);
1648out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 /* must be careful here...if we trigger the ->remove() function
1650 * we cannot be holding the q lock */
1651 spin_unlock_irq(q->queue_lock);
1652 put_device(&sdev->sdev_gendev);
1653 spin_lock_irq(q->queue_lock);
1654}
1655
1656u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
1657{
1658 struct device *host_dev;
1659 u64 bounce_limit = 0xffffffff;
1660
1661 if (shost->unchecked_isa_dma)
1662 return BLK_BOUNCE_ISA;
1663 /*
1664 * Platforms with virtual-DMA translation
1665 * hardware have no practical limit.
1666 */
1667 if (!PCI_DMA_BUS_IS_PHYS)
1668 return BLK_BOUNCE_ANY;
1669
1670 host_dev = scsi_get_device(shost);
1671 if (host_dev && host_dev->dma_mask)
1672 bounce_limit = *host_dev->dma_mask;
1673
1674 return bounce_limit;
1675}
1676EXPORT_SYMBOL(scsi_calculate_bounce_limit);
1677
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001678struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
1679 request_fn_proc *request_fn)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 struct request_queue *q;
Lin Ming6f381fa2012-04-12 13:50:38 +08001682 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001684 q = blk_init_queue(request_fn, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 if (!q)
1686 return NULL;
1687
Jens Axboea8474ce2007-08-07 09:02:51 +02001688 /*
1689 * this limit is imposed by hardware restrictions
1690 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001691 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
1692 SCSI_MAX_SG_CHAIN_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001693
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001694 if (scsi_host_prot_dma(shost)) {
1695 shost->sg_prot_tablesize =
1696 min_not_zero(shost->sg_prot_tablesize,
1697 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1698 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1699 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1700 }
1701
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001702 blk_queue_max_hw_sectors(q, shost->max_sectors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
1704 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001705 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706
FUJITA Tomonori860ac562008-02-04 22:28:05 -08001707 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
1708
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01001710 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06001711
1712 /*
1713 * set a reasonable default alignment on word boundaries: the
1714 * host and device may alter it using
1715 * blk_queue_update_dma_alignment() later.
1716 */
1717 blk_queue_dma_alignment(q, 0x03);
1718
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 return q;
1720}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001721EXPORT_SYMBOL(__scsi_alloc_queue);
1722
1723struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
1724{
1725 struct request_queue *q;
1726
1727 q = __scsi_alloc_queue(sdev->host, scsi_request_fn);
1728 if (!q)
1729 return NULL;
1730
1731 blk_queue_prep_rq(q, scsi_prep_fn);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001732 blk_queue_softirq_done(q, scsi_softirq_done);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001733 blk_queue_rq_timed_out(q, scsi_times_out);
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001734 blk_queue_lld_busy(q, scsi_lld_busy);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001735 return q;
1736}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738/*
1739 * Function: scsi_block_requests()
1740 *
1741 * Purpose: Utility function used by low-level drivers to prevent further
1742 * commands from being queued to the device.
1743 *
1744 * Arguments: shost - Host in question
1745 *
1746 * Returns: Nothing
1747 *
1748 * Lock status: No locks are assumed held.
1749 *
1750 * Notes: There is no timer nor any other means by which the requests
1751 * get unblocked other than the low-level driver calling
1752 * scsi_unblock_requests().
1753 */
1754void scsi_block_requests(struct Scsi_Host *shost)
1755{
1756 shost->host_self_blocked = 1;
1757}
1758EXPORT_SYMBOL(scsi_block_requests);
1759
1760/*
1761 * Function: scsi_unblock_requests()
1762 *
1763 * Purpose: Utility function used by low-level drivers to allow further
1764 * commands from being queued to the device.
1765 *
1766 * Arguments: shost - Host in question
1767 *
1768 * Returns: Nothing
1769 *
1770 * Lock status: No locks are assumed held.
1771 *
1772 * Notes: There is no timer nor any other means by which the requests
1773 * get unblocked other than the low-level driver calling
1774 * scsi_unblock_requests().
1775 *
1776 * This is done as an API function so that changes to the
1777 * internals of the scsi mid-layer won't require wholesale
1778 * changes to drivers that use this feature.
1779 */
1780void scsi_unblock_requests(struct Scsi_Host *shost)
1781{
1782 shost->host_self_blocked = 0;
1783 scsi_run_host_queues(shost);
1784}
1785EXPORT_SYMBOL(scsi_unblock_requests);
1786
1787int __init scsi_init_queue(void)
1788{
1789 int i;
1790
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001791 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1792 sizeof(struct scsi_data_buffer),
1793 0, 0, NULL);
1794 if (!scsi_sdb_cache) {
1795 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001796 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001797 }
1798
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1800 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1801 int size = sgp->size * sizeof(struct scatterlist);
1802
1803 sgp->slab = kmem_cache_create(sgp->name, size, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09001804 SLAB_HWCACHE_ALIGN, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 if (!sgp->slab) {
1806 printk(KERN_ERR "SCSI: can't init sg slab %s\n",
1807 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001808 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 }
1810
Matthew Dobson93d23412006-03-26 01:37:50 -08001811 sgp->pool = mempool_create_slab_pool(SG_MEMPOOL_SIZE,
1812 sgp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 if (!sgp->pool) {
1814 printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
1815 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001816 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 }
1818 }
1819
1820 return 0;
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001821
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001822cleanup_sdb:
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001823 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1824 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1825 if (sgp->pool)
1826 mempool_destroy(sgp->pool);
1827 if (sgp->slab)
1828 kmem_cache_destroy(sgp->slab);
1829 }
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001830 kmem_cache_destroy(scsi_sdb_cache);
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001831
1832 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833}
1834
1835void scsi_exit_queue(void)
1836{
1837 int i;
1838
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001839 kmem_cache_destroy(scsi_sdb_cache);
Mike Christieaa7b5cd2005-11-11 05:31:41 -06001840
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1842 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1843 mempool_destroy(sgp->pool);
1844 kmem_cache_destroy(sgp->slab);
1845 }
1846}
James Bottomley5baba832006-03-18 14:10:35 -06001847
1848/**
1849 * scsi_mode_select - issue a mode select
1850 * @sdev: SCSI device to be queried
1851 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1852 * @sp: Save page bit (0 == don't save, 1 == save)
1853 * @modepage: mode page being requested
1854 * @buffer: request buffer (may not be smaller than eight bytes)
1855 * @len: length of request buffer.
1856 * @timeout: command timeout
1857 * @retries: number of retries before failing
1858 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001859 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001860 * must be SCSI_SENSE_BUFFERSIZE big.
1861 *
1862 * Returns zero if successful; negative error number or scsi
1863 * status on error
1864 *
1865 */
1866int
1867scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1868 unsigned char *buffer, int len, int timeout, int retries,
1869 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1870{
1871 unsigned char cmd[10];
1872 unsigned char *real_buffer;
1873 int ret;
1874
1875 memset(cmd, 0, sizeof(cmd));
1876 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
1877
1878 if (sdev->use_10_for_ms) {
1879 if (len > 65535)
1880 return -EINVAL;
1881 real_buffer = kmalloc(8 + len, GFP_KERNEL);
1882 if (!real_buffer)
1883 return -ENOMEM;
1884 memcpy(real_buffer + 8, buffer, len);
1885 len += 8;
1886 real_buffer[0] = 0;
1887 real_buffer[1] = 0;
1888 real_buffer[2] = data->medium_type;
1889 real_buffer[3] = data->device_specific;
1890 real_buffer[4] = data->longlba ? 0x01 : 0;
1891 real_buffer[5] = 0;
1892 real_buffer[6] = data->block_descriptor_length >> 8;
1893 real_buffer[7] = data->block_descriptor_length;
1894
1895 cmd[0] = MODE_SELECT_10;
1896 cmd[7] = len >> 8;
1897 cmd[8] = len;
1898 } else {
1899 if (len > 255 || data->block_descriptor_length > 255 ||
1900 data->longlba)
1901 return -EINVAL;
1902
1903 real_buffer = kmalloc(4 + len, GFP_KERNEL);
1904 if (!real_buffer)
1905 return -ENOMEM;
1906 memcpy(real_buffer + 4, buffer, len);
1907 len += 4;
1908 real_buffer[0] = 0;
1909 real_buffer[1] = data->medium_type;
1910 real_buffer[2] = data->device_specific;
1911 real_buffer[3] = data->block_descriptor_length;
1912
1913
1914 cmd[0] = MODE_SELECT;
1915 cmd[4] = len;
1916 }
1917
1918 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09001919 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06001920 kfree(real_buffer);
1921 return ret;
1922}
1923EXPORT_SYMBOL_GPL(scsi_mode_select);
1924
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925/**
Rob Landleyeb448202007-11-03 13:30:39 -05001926 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05001927 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 * @dbd: set if mode sense will allow block descriptors to be returned
1929 * @modepage: mode page being requested
1930 * @buffer: request buffer (may not be smaller than eight bytes)
1931 * @len: length of request buffer.
1932 * @timeout: command timeout
1933 * @retries: number of retries before failing
1934 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001935 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05001936 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 *
1938 * Returns zero if unsuccessful, or the header offset (either 4
1939 * or 8 depending on whether a six or ten byte command was
1940 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05001941 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942int
James Bottomley1cf72692005-08-28 11:27:01 -05001943scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06001945 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1946{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 unsigned char cmd[12];
1948 int use_10_for_ms;
1949 int header_length;
James Bottomley1cf72692005-08-28 11:27:01 -05001950 int result;
James Bottomleyea73a9f2005-08-28 11:33:52 -05001951 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952
1953 memset(data, 0, sizeof(*data));
1954 memset(&cmd[0], 0, 12);
1955 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
1956 cmd[2] = modepage;
1957
James Bottomleyea73a9f2005-08-28 11:33:52 -05001958 /* caller might not be interested in sense, but we need it */
1959 if (!sshdr)
1960 sshdr = &my_sshdr;
1961
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05001963 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964
1965 if (use_10_for_ms) {
1966 if (len < 8)
1967 len = 8;
1968
1969 cmd[0] = MODE_SENSE_10;
1970 cmd[8] = len;
1971 header_length = 8;
1972 } else {
1973 if (len < 4)
1974 len = 4;
1975
1976 cmd[0] = MODE_SENSE;
1977 cmd[4] = len;
1978 header_length = 4;
1979 }
1980
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 memset(buffer, 0, len);
1982
James Bottomley1cf72692005-08-28 11:27:01 -05001983 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09001984 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985
1986 /* This code looks awful: what it's doing is making sure an
1987 * ILLEGAL REQUEST sense return identifies the actual command
1988 * byte as the problem. MODE_SENSE commands can return
1989 * ILLEGAL REQUEST if the code page isn't supported */
1990
James Bottomley1cf72692005-08-28 11:27:01 -05001991 if (use_10_for_ms && !scsi_status_is_good(result) &&
1992 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05001993 if (scsi_sense_valid(sshdr)) {
1994 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
1995 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 /*
1997 * Invalid command operation code
1998 */
James Bottomley1cf72692005-08-28 11:27:01 -05001999 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 goto retry;
2001 }
2002 }
2003 }
2004
James Bottomley1cf72692005-08-28 11:27:01 -05002005 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002006 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2007 (modepage == 6 || modepage == 8))) {
2008 /* Initio breakage? */
2009 header_length = 0;
2010 data->length = 13;
2011 data->medium_type = 0;
2012 data->device_specific = 0;
2013 data->longlba = 0;
2014 data->block_descriptor_length = 0;
2015 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 data->length = buffer[0]*256 + buffer[1] + 2;
2017 data->medium_type = buffer[2];
2018 data->device_specific = buffer[3];
2019 data->longlba = buffer[4] & 0x01;
2020 data->block_descriptor_length = buffer[6]*256
2021 + buffer[7];
2022 } else {
2023 data->length = buffer[0] + 1;
2024 data->medium_type = buffer[1];
2025 data->device_specific = buffer[2];
2026 data->block_descriptor_length = buffer[3];
2027 }
Al Viro6d73c852006-02-23 02:03:16 +01002028 data->header_length = header_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 }
2030
James Bottomley1cf72692005-08-28 11:27:01 -05002031 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032}
2033EXPORT_SYMBOL(scsi_mode_sense);
2034
James Bottomley001aac22007-12-02 19:10:40 +02002035/**
2036 * scsi_test_unit_ready - test if unit is ready
2037 * @sdev: scsi device to change the state of.
2038 * @timeout: command timeout
2039 * @retries: number of retries before failing
2040 * @sshdr_external: Optional pointer to struct scsi_sense_hdr for
2041 * returning sense. Make sure that this is cleared before passing
2042 * in.
2043 *
2044 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002045 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002046 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047int
James Bottomley001aac22007-12-02 19:10:40 +02002048scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
2049 struct scsi_sense_hdr *sshdr_external)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 char cmd[] = {
2052 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2053 };
James Bottomley001aac22007-12-02 19:10:40 +02002054 struct scsi_sense_hdr *sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002056
2057 if (!sshdr_external)
2058 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
2059 else
2060 sshdr = sshdr_external;
2061
2062 /* try to eat the UNIT_ATTENTION if there are enough retries */
2063 do {
2064 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002065 timeout, retries, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002066 if (sdev->removable && scsi_sense_valid(sshdr) &&
2067 sshdr->sense_key == UNIT_ATTENTION)
2068 sdev->changed = 1;
2069 } while (scsi_sense_valid(sshdr) &&
2070 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002071
James Bottomley001aac22007-12-02 19:10:40 +02002072 if (!sshdr_external)
2073 kfree(sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 return result;
2075}
2076EXPORT_SYMBOL(scsi_test_unit_ready);
2077
2078/**
Rob Landleyeb448202007-11-03 13:30:39 -05002079 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 * @sdev: scsi device to change the state of.
2081 * @state: state to change to.
2082 *
2083 * Returns zero if unsuccessful or an error if the requested
2084 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002085 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086int
2087scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2088{
2089 enum scsi_device_state oldstate = sdev->sdev_state;
2090
2091 if (state == oldstate)
2092 return 0;
2093
2094 switch (state) {
2095 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002096 switch (oldstate) {
2097 case SDEV_CREATED_BLOCK:
2098 break;
2099 default:
2100 goto illegal;
2101 }
2102 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103
2104 case SDEV_RUNNING:
2105 switch (oldstate) {
2106 case SDEV_CREATED:
2107 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002108 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 case SDEV_QUIESCE:
2110 case SDEV_BLOCK:
2111 break;
2112 default:
2113 goto illegal;
2114 }
2115 break;
2116
2117 case SDEV_QUIESCE:
2118 switch (oldstate) {
2119 case SDEV_RUNNING:
2120 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002121 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 break;
2123 default:
2124 goto illegal;
2125 }
2126 break;
2127
2128 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002129 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 switch (oldstate) {
2131 case SDEV_CREATED:
2132 case SDEV_RUNNING:
2133 case SDEV_QUIESCE:
2134 case SDEV_BLOCK:
2135 break;
2136 default:
2137 goto illegal;
2138 }
2139 break;
2140
2141 case SDEV_BLOCK:
2142 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002144 case SDEV_CREATED_BLOCK:
2145 break;
2146 default:
2147 goto illegal;
2148 }
2149 break;
2150
2151 case SDEV_CREATED_BLOCK:
2152 switch (oldstate) {
2153 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 break;
2155 default:
2156 goto illegal;
2157 }
2158 break;
2159
2160 case SDEV_CANCEL:
2161 switch (oldstate) {
2162 case SDEV_CREATED:
2163 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002164 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002166 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 case SDEV_BLOCK:
2168 break;
2169 default:
2170 goto illegal;
2171 }
2172 break;
2173
2174 case SDEV_DEL:
2175 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002176 case SDEV_CREATED:
2177 case SDEV_RUNNING:
2178 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002179 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 case SDEV_CANCEL:
2181 break;
2182 default:
2183 goto illegal;
2184 }
2185 break;
2186
2187 }
2188 sdev->sdev_state = state;
2189 return 0;
2190
2191 illegal:
2192 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002193 sdev_printk(KERN_ERR, sdev,
2194 "Illegal state transition %s->%s\n",
2195 scsi_device_state_name(oldstate),
2196 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 );
2198 return -EINVAL;
2199}
2200EXPORT_SYMBOL(scsi_device_set_state);
2201
2202/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002203 * sdev_evt_emit - emit a single SCSI device uevent
2204 * @sdev: associated SCSI device
2205 * @evt: event to emit
2206 *
2207 * Send a single uevent (scsi_event) to the associated scsi_device.
2208 */
2209static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2210{
2211 int idx = 0;
2212 char *envp[3];
2213
2214 switch (evt->evt_type) {
2215 case SDEV_EVT_MEDIA_CHANGE:
2216 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2217 break;
2218
2219 default:
2220 /* do nothing */
2221 break;
2222 }
2223
2224 envp[idx++] = NULL;
2225
2226 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2227}
2228
2229/**
2230 * sdev_evt_thread - send a uevent for each scsi event
2231 * @work: work struct for scsi_device
2232 *
2233 * Dispatch queued events to their associated scsi_device kobjects
2234 * as uevents.
2235 */
2236void scsi_evt_thread(struct work_struct *work)
2237{
2238 struct scsi_device *sdev;
2239 LIST_HEAD(event_list);
2240
2241 sdev = container_of(work, struct scsi_device, event_work);
2242
2243 while (1) {
2244 struct scsi_event *evt;
2245 struct list_head *this, *tmp;
2246 unsigned long flags;
2247
2248 spin_lock_irqsave(&sdev->list_lock, flags);
2249 list_splice_init(&sdev->event_list, &event_list);
2250 spin_unlock_irqrestore(&sdev->list_lock, flags);
2251
2252 if (list_empty(&event_list))
2253 break;
2254
2255 list_for_each_safe(this, tmp, &event_list) {
2256 evt = list_entry(this, struct scsi_event, node);
2257 list_del(&evt->node);
2258 scsi_evt_emit(sdev, evt);
2259 kfree(evt);
2260 }
2261 }
2262}
2263
2264/**
2265 * sdev_evt_send - send asserted event to uevent thread
2266 * @sdev: scsi_device event occurred on
2267 * @evt: event to send
2268 *
2269 * Assert scsi device event asynchronously.
2270 */
2271void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2272{
2273 unsigned long flags;
2274
Kay Sievers4d1566e2008-03-19 13:04:47 +01002275#if 0
2276 /* FIXME: currently this check eliminates all media change events
2277 * for polled devices. Need to update to discriminate between AN
2278 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002279 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2280 kfree(evt);
2281 return;
2282 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002283#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002284
2285 spin_lock_irqsave(&sdev->list_lock, flags);
2286 list_add_tail(&evt->node, &sdev->event_list);
2287 schedule_work(&sdev->event_work);
2288 spin_unlock_irqrestore(&sdev->list_lock, flags);
2289}
2290EXPORT_SYMBOL_GPL(sdev_evt_send);
2291
2292/**
2293 * sdev_evt_alloc - allocate a new scsi event
2294 * @evt_type: type of event to allocate
2295 * @gfpflags: GFP flags for allocation
2296 *
2297 * Allocates and returns a new scsi_event.
2298 */
2299struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2300 gfp_t gfpflags)
2301{
2302 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2303 if (!evt)
2304 return NULL;
2305
2306 evt->evt_type = evt_type;
2307 INIT_LIST_HEAD(&evt->node);
2308
2309 /* evt_type-specific initialization, if any */
2310 switch (evt_type) {
2311 case SDEV_EVT_MEDIA_CHANGE:
2312 default:
2313 /* do nothing */
2314 break;
2315 }
2316
2317 return evt;
2318}
2319EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2320
2321/**
2322 * sdev_evt_send_simple - send asserted event to uevent thread
2323 * @sdev: scsi_device event occurred on
2324 * @evt_type: type of event to send
2325 * @gfpflags: GFP flags for allocation
2326 *
2327 * Assert scsi device event asynchronously, given an event type.
2328 */
2329void sdev_evt_send_simple(struct scsi_device *sdev,
2330 enum scsi_device_event evt_type, gfp_t gfpflags)
2331{
2332 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2333 if (!evt) {
2334 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2335 evt_type);
2336 return;
2337 }
2338
2339 sdev_evt_send(sdev, evt);
2340}
2341EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2342
2343/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 * scsi_device_quiesce - Block user issued commands.
2345 * @sdev: scsi device to quiesce.
2346 *
2347 * This works by trying to transition to the SDEV_QUIESCE state
2348 * (which must be a legal transition). When the device is in this
2349 * state, only special requests will be accepted, all others will
2350 * be deferred. Since special requests may also be requeued requests,
2351 * a successful return doesn't guarantee the device will be
2352 * totally quiescent.
2353 *
2354 * Must be called with user context, may sleep.
2355 *
2356 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002357 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358int
2359scsi_device_quiesce(struct scsi_device *sdev)
2360{
2361 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2362 if (err)
2363 return err;
2364
2365 scsi_run_queue(sdev->request_queue);
2366 while (sdev->device_busy) {
2367 msleep_interruptible(200);
2368 scsi_run_queue(sdev->request_queue);
2369 }
2370 return 0;
2371}
2372EXPORT_SYMBOL(scsi_device_quiesce);
2373
2374/**
2375 * scsi_device_resume - Restart user issued commands to a quiesced device.
2376 * @sdev: scsi device to resume.
2377 *
2378 * Moves the device from quiesced back to running and restarts the
2379 * queues.
2380 *
2381 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002382 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002383void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002385 /* check if the device state was mutated prior to resume, and if
2386 * so assume the state is being managed elsewhere (for example
2387 * device deleted during suspend)
2388 */
2389 if (sdev->sdev_state != SDEV_QUIESCE ||
2390 scsi_device_set_state(sdev, SDEV_RUNNING))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391 return;
2392 scsi_run_queue(sdev->request_queue);
2393}
2394EXPORT_SYMBOL(scsi_device_resume);
2395
2396static void
2397device_quiesce_fn(struct scsi_device *sdev, void *data)
2398{
2399 scsi_device_quiesce(sdev);
2400}
2401
2402void
2403scsi_target_quiesce(struct scsi_target *starget)
2404{
2405 starget_for_each_device(starget, NULL, device_quiesce_fn);
2406}
2407EXPORT_SYMBOL(scsi_target_quiesce);
2408
2409static void
2410device_resume_fn(struct scsi_device *sdev, void *data)
2411{
2412 scsi_device_resume(sdev);
2413}
2414
2415void
2416scsi_target_resume(struct scsi_target *starget)
2417{
2418 starget_for_each_device(starget, NULL, device_resume_fn);
2419}
2420EXPORT_SYMBOL(scsi_target_resume);
2421
2422/**
Rob Landleyeb448202007-11-03 13:30:39 -05002423 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424 * @sdev: device to block
2425 *
2426 * Block request made by scsi lld's to temporarily stop all
2427 * scsi commands on the specified device. Called from interrupt
2428 * or normal process context.
2429 *
2430 * Returns zero if successful or error if not
2431 *
2432 * Notes:
2433 * This routine transitions the device to the SDEV_BLOCK state
2434 * (which must be a legal transition). When the device is in this
2435 * state, all commands are deferred until the scsi lld reenables
2436 * the device with scsi_device_unblock or device_block_tmo fires.
Rob Landleyeb448202007-11-03 13:30:39 -05002437 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438int
2439scsi_internal_device_block(struct scsi_device *sdev)
2440{
Jens Axboe165125e2007-07-24 09:28:11 +02002441 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442 unsigned long flags;
2443 int err = 0;
2444
2445 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002446 if (err) {
2447 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2448
2449 if (err)
2450 return err;
2451 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452
2453 /*
2454 * The device has transitioned to SDEV_BLOCK. Stop the
2455 * block layer from calling the midlayer with this device's
2456 * request queue.
2457 */
2458 spin_lock_irqsave(q->queue_lock, flags);
2459 blk_stop_queue(q);
2460 spin_unlock_irqrestore(q->queue_lock, flags);
2461
2462 return 0;
2463}
2464EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2465
2466/**
2467 * scsi_internal_device_unblock - resume a device after a block request
2468 * @sdev: device to resume
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002469 * @new_state: state to set devices to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470 *
2471 * Called by scsi lld's or the midlayer to restart the device queue
2472 * for the previously suspended scsi device. Called from interrupt or
2473 * normal process context.
2474 *
2475 * Returns zero if successful or error if not.
2476 *
2477 * Notes:
2478 * This routine transitions the device to the SDEV_RUNNING state
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002479 * or to one of the offline states (which must be a legal transition)
Mike Christied0754982012-05-17 23:56:58 -05002480 * allowing the midlayer to goose the queue for this device.
Rob Landleyeb448202007-11-03 13:30:39 -05002481 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482int
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002483scsi_internal_device_unblock(struct scsi_device *sdev,
2484 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485{
Jens Axboe165125e2007-07-24 09:28:11 +02002486 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487 unsigned long flags;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002488
2489 /*
2490 * Try to transition the scsi device to SDEV_RUNNING or one of the
2491 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 */
Vikas Chaudhary0e580762012-08-09 04:51:30 -04002493 if ((sdev->sdev_state == SDEV_BLOCK) ||
2494 (sdev->sdev_state == SDEV_TRANSPORT_OFFLINE))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002495 sdev->sdev_state = new_state;
2496 else if (sdev->sdev_state == SDEV_CREATED_BLOCK) {
2497 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2498 new_state == SDEV_OFFLINE)
2499 sdev->sdev_state = new_state;
2500 else
2501 sdev->sdev_state = SDEV_CREATED;
2502 } else if (sdev->sdev_state != SDEV_CANCEL &&
Mike Christie986fe6c2010-10-06 03:10:59 -05002503 sdev->sdev_state != SDEV_OFFLINE)
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002504 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505
2506 spin_lock_irqsave(q->queue_lock, flags);
2507 blk_start_queue(q);
2508 spin_unlock_irqrestore(q->queue_lock, flags);
2509
2510 return 0;
2511}
2512EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
2513
2514static void
2515device_block(struct scsi_device *sdev, void *data)
2516{
2517 scsi_internal_device_block(sdev);
2518}
2519
2520static int
2521target_block(struct device *dev, void *data)
2522{
2523 if (scsi_is_target_device(dev))
2524 starget_for_each_device(to_scsi_target(dev), NULL,
2525 device_block);
2526 return 0;
2527}
2528
2529void
2530scsi_target_block(struct device *dev)
2531{
2532 if (scsi_is_target_device(dev))
2533 starget_for_each_device(to_scsi_target(dev), NULL,
2534 device_block);
2535 else
2536 device_for_each_child(dev, NULL, target_block);
2537}
2538EXPORT_SYMBOL_GPL(scsi_target_block);
2539
2540static void
2541device_unblock(struct scsi_device *sdev, void *data)
2542{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002543 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544}
2545
2546static int
2547target_unblock(struct device *dev, void *data)
2548{
2549 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002550 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551 device_unblock);
2552 return 0;
2553}
2554
2555void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002556scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557{
2558 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002559 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 device_unblock);
2561 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002562 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563}
2564EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002565
2566/**
2567 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002568 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002569 * @sg_count: number of segments in sg
2570 * @offset: offset in bytes into sg, on return offset into the mapped area
2571 * @len: bytes to map, on return number of bytes mapped
2572 *
2573 * Returns virtual address of the start of the mapped page
2574 */
Jens Axboec6132da2007-10-16 11:08:49 +02002575void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002576 size_t *offset, size_t *len)
2577{
2578 int i;
2579 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002580 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002581 struct page *page;
2582
Andrew Morton22cfefb2007-02-05 16:39:03 -08002583 WARN_ON(!irqs_disabled());
2584
Jens Axboec6132da2007-10-16 11:08:49 +02002585 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002586 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002587 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002588 if (sg_len > *offset)
2589 break;
2590 }
2591
2592 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002593 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2594 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002595 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002596 WARN_ON(1);
2597 return NULL;
2598 }
2599
2600 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002601 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002602
2603 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002604 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002605 *offset &= ~PAGE_MASK;
2606
2607 /* Bytes in this sg-entry from *offset to the end of the page */
2608 sg_len = PAGE_SIZE - *offset;
2609 if (*len > sg_len)
2610 *len = sg_len;
2611
Cong Wang77dfce02011-11-25 23:14:23 +08002612 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002613}
2614EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2615
2616/**
Rob Landleyeb448202007-11-03 13:30:39 -05002617 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002618 * @virt: virtual address to be unmapped
2619 */
2620void scsi_kunmap_atomic_sg(void *virt)
2621{
Cong Wang77dfce02011-11-25 23:14:23 +08002622 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002623}
2624EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002625
2626void sdev_disable_disk_events(struct scsi_device *sdev)
2627{
2628 atomic_inc(&sdev->disk_events_disable_depth);
2629}
2630EXPORT_SYMBOL(sdev_disable_disk_events);
2631
2632void sdev_enable_disk_events(struct scsi_device *sdev)
2633{
2634 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2635 return;
2636 atomic_dec(&sdev->disk_events_disable_depth);
2637}
2638EXPORT_SYMBOL(sdev_enable_disk_events);