blob: f0ddc7dd06d3dfa9862448878994713cbbcbd01c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * scsi_lib.c Copyright (C) 1999 Eric Youngdale
3 *
4 * SCSI queueing library.
5 * Initial versions: Eric Youngdale (eric@andante.org).
6 * Based upon conversations with large numbers
7 * of people at Linux Expo.
8 */
9
10#include <linux/bio.h>
James Bottomleyd3f46f32008-01-15 11:11:46 -060011#include <linux/bitops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/blkdev.h>
13#include <linux/completion.h>
14#include <linux/kernel.h>
Paul Gortmaker09703662011-05-27 09:37:25 -040015#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/mempool.h>
17#include <linux/slab.h>
18#include <linux/init.h>
19#include <linux/pci.h>
20#include <linux/delay.h>
James Bottomleyfaead262006-02-14 10:42:07 -060021#include <linux/hardirq.h>
Jens Axboec6132da2007-10-16 11:08:49 +020022#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020025#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <scsi/scsi_dbg.h>
27#include <scsi/scsi_device.h>
28#include <scsi/scsi_driver.h>
29#include <scsi/scsi_eh.h>
30#include <scsi/scsi_host.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32#include "scsi_priv.h"
33#include "scsi_logging.h"
34
35
Tobias Klauser6391a112006-06-08 22:23:48 -070036#define SG_MEMPOOL_NR ARRAY_SIZE(scsi_sg_pools)
Jens Axboe59725112007-04-02 10:06:42 +020037#define SG_MEMPOOL_SIZE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39struct scsi_host_sg_pool {
40 size_t size;
Jens Axboea8474ce2007-08-07 09:02:51 +020041 char *name;
Christoph Lametere18b8902006-12-06 20:33:20 -080042 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 mempool_t *pool;
44};
45
James Bottomleyd3f46f32008-01-15 11:11:46 -060046#define SP(x) { x, "sgpool-" __stringify(x) }
47#if (SCSI_MAX_SG_SEGMENTS < 32)
48#error SCSI_MAX_SG_SEGMENTS is too small (must be 32 or greater)
49#endif
Adrian Bunk52c1da32005-06-23 22:05:33 -070050static struct scsi_host_sg_pool scsi_sg_pools[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 SP(8),
52 SP(16),
FUJITA Tomonorifd820f42007-09-18 12:14:37 +020053#if (SCSI_MAX_SG_SEGMENTS > 32)
James Bottomleyd3f46f32008-01-15 11:11:46 -060054 SP(32),
FUJITA Tomonorifd820f42007-09-18 12:14:37 +020055#if (SCSI_MAX_SG_SEGMENTS > 64)
James Bottomleyd3f46f32008-01-15 11:11:46 -060056 SP(64),
57#if (SCSI_MAX_SG_SEGMENTS > 128)
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 SP(128),
James Bottomleyd3f46f32008-01-15 11:11:46 -060059#if (SCSI_MAX_SG_SEGMENTS > 256)
60#error SCSI_MAX_SG_SEGMENTS is too large (256 MAX)
FUJITA Tomonorifd820f42007-09-18 12:14:37 +020061#endif
62#endif
63#endif
James Bottomleyd3f46f32008-01-15 11:11:46 -060064#endif
65 SP(SCSI_MAX_SG_SEGMENTS)
Jens Axboea8474ce2007-08-07 09:02:51 +020066};
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#undef SP
68
Martin K. Petersen7027ad72008-07-17 17:08:48 -040069struct kmem_cache *scsi_sdb_cache;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +020070
Jens Axboea488e742010-04-16 21:13:15 +020071/*
72 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
73 * not change behaviour from the previous unplug mechanism, experimentation
74 * may prove this needs changing.
75 */
76#define SCSI_QUEUE_DELAY 3
77
James Bottomleye91442b2005-09-09 10:44:16 -050078/*
79 * Function: scsi_unprep_request()
80 *
81 * Purpose: Remove all preparation done for a request, including its
82 * associated scsi_cmnd, so that it can be requeued.
83 *
84 * Arguments: req - request to unprepare
85 *
86 * Lock status: Assumed that no locks are held upon entry.
87 *
88 * Returns: Nothing.
89 */
90static void scsi_unprep_request(struct request *req)
91{
92 struct scsi_cmnd *cmd = req->special;
93
James Bottomley28018c22010-07-01 19:49:17 +090094 blk_unprep_request(req);
Christoph Hellwigbeb40482006-06-10 18:01:03 +020095 req->special = NULL;
James Bottomleye91442b2005-09-09 10:44:16 -050096
James Bottomleye91442b2005-09-09 10:44:16 -050097 scsi_put_command(cmd);
98}
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -050099
James Bottomley4f5299a2009-01-02 10:42:21 -0600100/**
101 * __scsi_queue_insert - private queue insertion
102 * @cmd: The SCSI command being requeued
103 * @reason: The reason for the requeue
104 * @unbusy: Whether the queue should be unbusied
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 *
James Bottomley4f5299a2009-01-02 10:42:21 -0600106 * This is a private queue insertion. The public interface
107 * scsi_queue_insert() always assumes the queue should be unbusied
108 * because it's always called before the completion. This function is
109 * for a requeue after completion, which should only occur in this
110 * file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000112static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
114 struct Scsi_Host *host = cmd->device->host;
115 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500116 struct scsi_target *starget = scsi_target(device);
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500117 struct request_queue *q = device->request_queue;
118 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120 SCSI_LOG_MLQUEUE(1,
121 printk("Inserting command %p into mlqueue\n", cmd));
122
123 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900124 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 *
126 * If the host/device isn't busy, assume that something actually
127 * completed, and that we should be able to queue a command now.
128 *
129 * Note that the prior mid-layer assumption that any host could
130 * always queue at least one command is now broken. The mid-layer
131 * will implement a user specifiable stall (see
132 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
133 * if a command is requeued with no other commands outstanding
134 * either for the device or for the host.
135 */
Mike Christief0c0a372008-08-17 15:24:38 -0500136 switch (reason) {
137 case SCSI_MLQUEUE_HOST_BUSY:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 host->host_blocked = host->max_host_blocked;
Mike Christief0c0a372008-08-17 15:24:38 -0500139 break;
140 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400141 case SCSI_MLQUEUE_EH_RETRY:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 device->device_blocked = device->max_device_blocked;
Mike Christief0c0a372008-08-17 15:24:38 -0500143 break;
144 case SCSI_MLQUEUE_TARGET_BUSY:
145 starget->target_blocked = starget->max_target_blocked;
146 break;
147 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 * Decrement the counters, since these commands are no longer
151 * active on the host/device.
152 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600153 if (unbusy)
154 scsi_device_unbusy(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500157 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000158 * that are already in the queue. Schedule requeue work under
159 * lock such that the kblockd_schedule_work() call happens
160 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200161 */
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500162 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley59897da2005-09-14 12:57:42 -0400163 blk_requeue_request(q, cmd->request);
Jens Axboe9937a5e2011-05-17 11:04:44 +0200164 kblockd_schedule_work(q, &device->requeue_work);
Bart Van Asscheb4854622012-06-29 15:36:07 +0000165 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166}
167
James Bottomley4f5299a2009-01-02 10:42:21 -0600168/*
169 * Function: scsi_queue_insert()
170 *
171 * Purpose: Insert a command in the midlevel queue.
172 *
173 * Arguments: cmd - command that we are adding to queue.
174 * reason - why we are inserting command to queue.
175 *
176 * Lock status: Assumed that lock is not held upon entry.
177 *
178 * Returns: Nothing.
179 *
180 * Notes: We do this for one of two cases. Either the host is busy
181 * and it cannot accept any more commands for the time being,
182 * or the device returned QUEUE_FULL and can accept no more
183 * commands.
184 * Notes: This could be called either from an interrupt context or a
185 * normal process context.
186 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000187void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600188{
Bart Van Assche84feb162012-06-29 15:35:05 +0000189 __scsi_queue_insert(cmd, reason, 1);
James Bottomley4f5299a2009-01-02 10:42:21 -0600190}
James Bottomley39216032005-06-15 18:48:29 -0500191/**
James Bottomley33aa6872005-08-28 11:31:14 -0500192 * scsi_execute - insert request and wait for the result
James Bottomley39216032005-06-15 18:48:29 -0500193 * @sdev: scsi device
194 * @cmd: scsi command
195 * @data_direction: data direction
196 * @buffer: data buffer
197 * @bufflen: len of buffer
198 * @sense: optional sense buffer
199 * @timeout: request timeout in seconds
200 * @retries: number of times to retry request
James Bottomley33aa6872005-08-28 11:31:14 -0500201 * @flags: or into request flags;
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900202 * @resid: optional residual length
James Bottomley39216032005-06-15 18:48:29 -0500203 *
Michael Opdenacker59c51592007-05-09 08:57:56 +0200204 * returns the req->errors value which is the scsi_cmnd result
James Bottomleyea73a9f2005-08-28 11:33:52 -0500205 * field.
Rob Landleyeb448202007-11-03 13:30:39 -0500206 */
James Bottomley33aa6872005-08-28 11:31:14 -0500207int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
208 int data_direction, void *buffer, unsigned bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900209 unsigned char *sense, int timeout, int retries, int flags,
210 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500211{
212 struct request *req;
213 int write = (data_direction == DMA_TO_DEVICE);
214 int ret = DRIVER_ERROR << 24;
215
216 req = blk_get_request(sdev->request_queue, write, __GFP_WAIT);
James Bottomleybfe159a2011-07-07 15:45:40 -0500217 if (!req)
218 return ret;
James Bottomley39216032005-06-15 18:48:29 -0500219
220 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
221 buffer, bufflen, __GFP_WAIT))
222 goto out;
223
224 req->cmd_len = COMMAND_SIZE(cmd[0]);
225 memcpy(req->cmd, cmd, req->cmd_len);
226 req->sense = sense;
227 req->sense_len = 0;
Mike Christie17e01f22005-11-11 05:31:37 -0600228 req->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500229 req->timeout = timeout;
Jens Axboe4aff5e22006-08-10 08:44:47 +0200230 req->cmd_type = REQ_TYPE_BLOCK_PC;
231 req->cmd_flags |= flags | REQ_QUIET | REQ_PREEMPT;
James Bottomley39216032005-06-15 18:48:29 -0500232
233 /*
234 * head injection *required* here otherwise quiesce won't work
235 */
236 blk_execute_rq(req->q, NULL, req, 1);
237
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400238 /*
239 * Some devices (USB mass-storage in particular) may transfer
240 * garbage data together with a residue indicating that the data
241 * is invalid. Prevent the garbage from being misinterpreted
242 * and prevent security leaks by zeroing out the excess data.
243 */
Tejun Heoc3a4d782009-05-07 22:24:37 +0900244 if (unlikely(req->resid_len > 0 && req->resid_len <= bufflen))
245 memset(buffer + (bufflen - req->resid_len), 0, req->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400246
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900247 if (resid)
Tejun Heoc3a4d782009-05-07 22:24:37 +0900248 *resid = req->resid_len;
James Bottomley39216032005-06-15 18:48:29 -0500249 ret = req->errors;
250 out:
251 blk_put_request(req);
252
253 return ret;
254}
James Bottomley33aa6872005-08-28 11:31:14 -0500255EXPORT_SYMBOL(scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500256
Lin Ming9b214932013-03-23 11:42:25 +0800257int scsi_execute_req_flags(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomleyea73a9f2005-08-28 11:33:52 -0500258 int data_direction, void *buffer, unsigned bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900259 struct scsi_sense_hdr *sshdr, int timeout, int retries,
Lin Ming9b214932013-03-23 11:42:25 +0800260 int *resid, int flags)
James Bottomleyea73a9f2005-08-28 11:33:52 -0500261{
262 char *sense = NULL;
akpm@osdl.org1ccb48b2005-06-26 00:12:51 -0700263 int result;
264
James Bottomleyea73a9f2005-08-28 11:33:52 -0500265 if (sshdr) {
Jes Sorensen24669f752006-01-16 10:31:18 -0500266 sense = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500267 if (!sense)
268 return DRIVER_ERROR << 24;
James Bottomleyea73a9f2005-08-28 11:33:52 -0500269 }
akpm@osdl.org1ccb48b2005-06-26 00:12:51 -0700270 result = scsi_execute(sdev, cmd, data_direction, buffer, bufflen,
Lin Ming9b214932013-03-23 11:42:25 +0800271 sense, timeout, retries, flags, resid);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500272 if (sshdr)
James Bottomleye5143852005-08-09 11:55:36 -0500273 scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, sshdr);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500274
275 kfree(sense);
276 return result;
277}
Lin Ming9b214932013-03-23 11:42:25 +0800278EXPORT_SYMBOL(scsi_execute_req_flags);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280/*
281 * Function: scsi_init_cmd_errh()
282 *
283 * Purpose: Initialize cmd fields related to error handling.
284 *
285 * Arguments: cmd - command that is ready to be queued.
286 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 * Notes: This function has the job of initializing a number of
288 * fields related to error handling. Typically this will
289 * be called once for each command, as required.
290 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200291static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 cmd->serial_number = 0;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200294 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900295 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300297 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298}
299
300void scsi_device_unbusy(struct scsi_device *sdev)
301{
302 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500303 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 unsigned long flags;
305
306 spin_lock_irqsave(shost->host_lock, flags);
307 shost->host_busy--;
Mike Christief0c0a372008-08-17 15:24:38 -0500308 starget->target_busy--;
James Bottomley939647e2005-09-18 15:05:20 -0500309 if (unlikely(scsi_host_in_recovery(shost) &&
Tejun Heoee7863b2006-05-15 20:57:20 +0900310 (shost->host_failed || shost->host_eh_scheduled)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 scsi_eh_wakeup(shost);
312 spin_unlock(shost->host_lock);
152587d2005-04-12 16:22:06 -0500313 spin_lock(sdev->request_queue->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 sdev->device_busy--;
152587d2005-04-12 16:22:06 -0500315 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316}
317
318/*
319 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
320 * and call blk_run_queue for all the scsi_devices on the target -
321 * including current_sdev first.
322 *
323 * Called with *no* scsi locks held.
324 */
325static void scsi_single_lun_run(struct scsi_device *current_sdev)
326{
327 struct Scsi_Host *shost = current_sdev->host;
328 struct scsi_device *sdev, *tmp;
329 struct scsi_target *starget = scsi_target(current_sdev);
330 unsigned long flags;
331
332 spin_lock_irqsave(shost->host_lock, flags);
333 starget->starget_sdev_user = NULL;
334 spin_unlock_irqrestore(shost->host_lock, flags);
335
336 /*
337 * Call blk_run_queue for all LUNs on the target, starting with
338 * current_sdev. We race with others (to set starget_sdev_user),
339 * but in most cases, we will be first. Ideally, each LU on the
340 * target would get some limited time or requests on the target.
341 */
342 blk_run_queue(current_sdev->request_queue);
343
344 spin_lock_irqsave(shost->host_lock, flags);
345 if (starget->starget_sdev_user)
346 goto out;
347 list_for_each_entry_safe(sdev, tmp, &starget->devices,
348 same_target_siblings) {
349 if (sdev == current_sdev)
350 continue;
351 if (scsi_device_get(sdev))
352 continue;
353
354 spin_unlock_irqrestore(shost->host_lock, flags);
355 blk_run_queue(sdev->request_queue);
356 spin_lock_irqsave(shost->host_lock, flags);
357
358 scsi_device_put(sdev);
359 }
360 out:
361 spin_unlock_irqrestore(shost->host_lock, flags);
362}
363
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400364static inline int scsi_device_is_busy(struct scsi_device *sdev)
365{
366 if (sdev->device_busy >= sdev->queue_depth || sdev->device_blocked)
367 return 1;
368
369 return 0;
370}
371
Mike Christief0c0a372008-08-17 15:24:38 -0500372static inline int scsi_target_is_busy(struct scsi_target *starget)
373{
374 return ((starget->can_queue > 0 &&
375 starget->target_busy >= starget->can_queue) ||
376 starget->target_blocked);
377}
378
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400379static inline int scsi_host_is_busy(struct Scsi_Host *shost)
380{
381 if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
382 shost->host_blocked || shost->host_self_blocked)
383 return 1;
384
385 return 0;
386}
387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388/*
389 * Function: scsi_run_queue()
390 *
391 * Purpose: Select a proper request queue to serve next
392 *
393 * Arguments: q - last request's queue
394 *
395 * Returns: Nothing
396 *
397 * Notes: The previous command was completely finished, start
398 * a new one if possible.
399 */
400static void scsi_run_queue(struct request_queue *q)
401{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600402 struct scsi_device *sdev = q->queuedata;
James Bottomleyc055f5b2011-05-01 09:42:07 -0500403 struct Scsi_Host *shost;
Mike Christie2a3a59e2008-11-11 13:42:35 -0600404 LIST_HEAD(starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 unsigned long flags;
406
James Bottomleyc055f5b2011-05-01 09:42:07 -0500407 shost = sdev->host;
Tony Battersby25d7c362007-11-12 10:00:44 -0500408 if (scsi_target(sdev)->single_lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 scsi_single_lun_run(sdev);
410
411 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600412 list_splice_init(&shost->starved_list, &starved_list);
413
414 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200415 struct request_queue *slq;
416
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 /*
418 * As long as shost is accepting commands and we have
419 * starved queues, call blk_run_queue. scsi_request_fn
420 * drops the queue_lock and can add us back to the
421 * starved_list.
422 *
423 * host_lock protects the starved_list and starved_entry.
424 * scsi_request_fn must get the host_lock before checking
425 * or modifying starved_list or starved_entry.
426 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600427 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500428 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500429
Mike Christie2a3a59e2008-11-11 13:42:35 -0600430 sdev = list_entry(starved_list.next,
431 struct scsi_device, starved_entry);
432 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500433 if (scsi_target_is_busy(scsi_target(sdev))) {
434 list_move_tail(&sdev->starved_entry,
435 &shost->starved_list);
436 continue;
437 }
438
James Bottomleye2eb7242013-07-02 15:05:26 +0200439 /*
440 * Once we drop the host lock, a racing scsi_remove_device()
441 * call may remove the sdev from the starved list and destroy
442 * it and the queue. Mitigate by taking a reference to the
443 * queue and never touching the sdev again after we drop the
444 * host lock. Note: if __scsi_remove_device() invokes
445 * blk_cleanup_queue() before the queue is run from this
446 * function then blk_run_queue() will return immediately since
447 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
448 */
449 slq = sdev->request_queue;
450 if (!blk_get_queue(slq))
451 continue;
452 spin_unlock_irqrestore(shost->host_lock, flags);
453
454 blk_run_queue(slq);
455 blk_put_queue(slq);
456
457 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600459 /* put any unprocessed entries back */
460 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 spin_unlock_irqrestore(shost->host_lock, flags);
462
463 blk_run_queue(q);
464}
465
Jens Axboe9937a5e2011-05-17 11:04:44 +0200466void scsi_requeue_run_queue(struct work_struct *work)
467{
468 struct scsi_device *sdev;
469 struct request_queue *q;
470
471 sdev = container_of(work, struct scsi_device, requeue_work);
472 q = sdev->request_queue;
473 scsi_run_queue(q);
474}
475
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476/*
477 * Function: scsi_requeue_command()
478 *
479 * Purpose: Handle post-processing of completed commands.
480 *
481 * Arguments: q - queue to operate on
482 * cmd - command that may need to be requeued.
483 *
484 * Returns: Nothing
485 *
486 * Notes: After command completion, there may be blocks left
487 * over which weren't finished by the previous command
488 * this can be for a number of reasons - the main one is
489 * I/O errors in the middle of the request, in which case
490 * we need to request the blocks that come after the bad
491 * sector.
James Bottomleye91442b2005-09-09 10:44:16 -0500492 * Notes: Upon return, cmd is a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 */
494static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
495{
Bart Van Assche940f5d42012-06-29 15:34:26 +0000496 struct scsi_device *sdev = cmd->device;
James Bottomleye91442b2005-09-09 10:44:16 -0500497 struct request *req = cmd->request;
Tejun Heo 283369c2005-04-24 02:06:36 -0500498 unsigned long flags;
499
Bart Van Assche940f5d42012-06-29 15:34:26 +0000500 /*
501 * We need to hold a reference on the device to avoid the queue being
502 * killed after the unlock and before scsi_run_queue is invoked which
503 * may happen because scsi_unprep_request() puts the command which
504 * releases its reference on the device.
505 */
506 get_device(&sdev->sdev_gendev);
507
Tejun Heo 283369c2005-04-24 02:06:36 -0500508 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley02bd3492008-12-12 13:28:29 -0600509 scsi_unprep_request(req);
James Bottomleye91442b2005-09-09 10:44:16 -0500510 blk_requeue_request(q, req);
Tejun Heo 283369c2005-04-24 02:06:36 -0500511 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
513 scsi_run_queue(q);
Bart Van Assche940f5d42012-06-29 15:34:26 +0000514
515 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516}
517
518void scsi_next_command(struct scsi_cmnd *cmd)
519{
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800520 struct scsi_device *sdev = cmd->device;
521 struct request_queue *q = sdev->request_queue;
522
523 /* need to hold a reference on the device before we let go of the cmd */
524 get_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
526 scsi_put_command(cmd);
527 scsi_run_queue(q);
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800528
529 /* ok to remove device now */
530 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531}
532
533void scsi_run_host_queues(struct Scsi_Host *shost)
534{
535 struct scsi_device *sdev;
536
537 shost_for_each_device(sdev, shost)
538 scsi_run_queue(sdev->request_queue);
539}
540
James Bottomley79ed2422009-01-06 13:15:20 -0600541static void __scsi_release_buffers(struct scsi_cmnd *, int);
542
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543/*
544 * Function: scsi_end_request()
545 *
546 * Purpose: Post-processing of completed commands (usually invoked at end
547 * of upper level post-processing and scsi_io_completion).
548 *
549 * Arguments: cmd - command that is complete.
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500550 * error - 0 if I/O indicates success, < 0 for I/O error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 * bytes - number of bytes of completed I/O
552 * requeue - indicates whether we should requeue leftovers.
553 *
554 * Lock status: Assumed that lock is not held upon entry.
555 *
James Bottomleye91442b2005-09-09 10:44:16 -0500556 * Returns: cmd if requeue required, NULL otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 *
558 * Notes: This is called for block device requests in order to
559 * mark some number of sectors as complete.
560 *
561 * We are guaranteeing that the request queue will be goosed
562 * at some point during this call.
James Bottomleye91442b2005-09-09 10:44:16 -0500563 * Notes: If cmd was requeued, upon return it will be a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 */
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500565static struct scsi_cmnd *scsi_end_request(struct scsi_cmnd *cmd, int error,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 int bytes, int requeue)
567{
Jens Axboe165125e2007-07-24 09:28:11 +0200568 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 struct request *req = cmd->request;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
571 /*
572 * If there are blocks left over at the end, set up the command
573 * to queue the remainder of them.
574 */
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500575 if (blk_end_request(req, error, bytes)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 /* kill remainder if no retrys */
Mike Christie4a274462008-08-19 18:45:31 -0500577 if (error && scsi_noretry_cmd(cmd))
Tejun Heoe4588242009-05-12 08:49:32 +0200578 blk_end_request_all(req, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 else {
James Bottomleye91442b2005-09-09 10:44:16 -0500580 if (requeue) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 /*
582 * Bleah. Leftovers again. Stick the
583 * leftovers in the front of the
584 * queue, and goose the queue again.
585 */
James Bottomley79ed2422009-01-06 13:15:20 -0600586 scsi_release_buffers(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 scsi_requeue_command(q, cmd);
James Bottomleye91442b2005-09-09 10:44:16 -0500588 cmd = NULL;
589 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 return cmd;
591 }
592 }
593
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 /*
595 * This will goose the queue request function at the end, so we don't
596 * need to worry about launching another command.
597 */
James Bottomley79ed2422009-01-06 13:15:20 -0600598 __scsi_release_buffers(cmd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 scsi_next_command(cmd);
600 return NULL;
601}
602
Jens Axboea8474ce2007-08-07 09:02:51 +0200603static inline unsigned int scsi_sgtable_index(unsigned short nents)
604{
605 unsigned int index;
606
James Bottomleyd3f46f32008-01-15 11:11:46 -0600607 BUG_ON(nents > SCSI_MAX_SG_SEGMENTS);
608
609 if (nents <= 8)
Jens Axboea8474ce2007-08-07 09:02:51 +0200610 index = 0;
James Bottomleyd3f46f32008-01-15 11:11:46 -0600611 else
612 index = get_count_order(nents) - 3;
Jens Axboea8474ce2007-08-07 09:02:51 +0200613
614 return index;
615}
616
Jens Axboe5ed79592007-11-15 09:13:11 +0100617static void scsi_sg_free(struct scatterlist *sgl, unsigned int nents)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{
619 struct scsi_host_sg_pool *sgp;
Jens Axboe5ed79592007-11-15 09:13:11 +0100620
621 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
622 mempool_free(sgl, sgp->pool);
623}
624
625static struct scatterlist *scsi_sg_alloc(unsigned int nents, gfp_t gfp_mask)
626{
627 struct scsi_host_sg_pool *sgp;
628
629 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
630 return mempool_alloc(sgp->pool, gfp_mask);
631}
632
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200633static int scsi_alloc_sgtable(struct scsi_data_buffer *sdb, int nents,
634 gfp_t gfp_mask)
Jens Axboe5ed79592007-11-15 09:13:11 +0100635{
636 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200638 BUG_ON(!nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200640 ret = __sg_alloc_table(&sdb->table, nents, SCSI_MAX_SG_SEGMENTS,
641 gfp_mask, scsi_sg_alloc);
Jens Axboe5ed79592007-11-15 09:13:11 +0100642 if (unlikely(ret))
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200643 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS,
James Bottomley7cedb1f2008-01-13 14:15:28 -0600644 scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
Jens Axboea8474ce2007-08-07 09:02:51 +0200646 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647}
648
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200649static void scsi_free_sgtable(struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200651 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS, scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652}
653
James Bottomley79ed2422009-01-06 13:15:20 -0600654static void __scsi_release_buffers(struct scsi_cmnd *cmd, int do_bidi_check)
655{
656
657 if (cmd->sdb.table.nents)
658 scsi_free_sgtable(&cmd->sdb);
659
660 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
661
662 if (do_bidi_check && scsi_bidi_cmnd(cmd)) {
663 struct scsi_data_buffer *bidi_sdb =
664 cmd->request->next_rq->special;
665 scsi_free_sgtable(bidi_sdb);
666 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
667 cmd->request->next_rq->special = NULL;
668 }
669
670 if (scsi_prot_sg_count(cmd))
671 scsi_free_sgtable(cmd->prot_sdb);
672}
673
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674/*
675 * Function: scsi_release_buffers()
676 *
677 * Purpose: Completion processing for block device I/O requests.
678 *
679 * Arguments: cmd - command that we are bailing.
680 *
681 * Lock status: Assumed that no lock is held upon entry.
682 *
683 * Returns: Nothing
684 *
685 * Notes: In the event that an upper level driver rejects a
686 * command, we must release resources allocated during
687 * the __init_io() function. Primarily this would involve
688 * the scatter-gather table, and potentially any bounce
689 * buffers.
690 */
Boaz Harroshbb52d822007-12-13 16:14:27 -0800691void scsi_release_buffers(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692{
James Bottomley79ed2422009-01-06 13:15:20 -0600693 __scsi_release_buffers(cmd, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694}
Boaz Harroshbb52d822007-12-13 16:14:27 -0800695EXPORT_SYMBOL(scsi_release_buffers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100697static int __scsi_error_from_host_byte(struct scsi_cmnd *cmd, int result)
698{
699 int error = 0;
700
701 switch(host_byte(result)) {
702 case DID_TRANSPORT_FAILFAST:
703 error = -ENOLINK;
704 break;
705 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000706 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100707 error = -EREMOTEIO;
708 break;
709 case DID_NEXUS_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000710 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100711 error = -EBADE;
712 break;
713 default:
714 error = -EIO;
715 break;
716 }
717
718 return error;
719}
720
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721/*
722 * Function: scsi_io_completion()
723 *
724 * Purpose: Completion processing for block device I/O requests.
725 *
726 * Arguments: cmd - command that is finished.
727 *
728 * Lock status: Assumed that no lock is held upon entry.
729 *
730 * Returns: Nothing
731 *
732 * Notes: This function is matched in terms of capabilities to
733 * the function that created the scatter-gather list.
734 * In other words, if there are no bounce buffers
735 * (the normal case for most drivers), we don't need
736 * the logic to deal with cleaning up afterwards.
737 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500738 * We must call scsi_end_request(). This will finish off
739 * the specified number of sectors. If we are done, the
740 * command block will be released and the queue function
741 * will be goosed. If we are not done then we have to
742 * figure out what to do next:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500744 * a) We can call scsi_requeue_command(). The request
745 * will be unprepared and put back on the queue. Then
746 * a new command will be created for it. This should
747 * be used if we made forward progress, or if we want
748 * to switch from READ(10) to READ(6) for example.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500750 * b) We can call scsi_queue_insert(). The request will
751 * be put back on the queue and retried using the same
752 * command as before, possibly after a delay.
753 *
754 * c) We can call blk_end_request() with -EIO to fail
755 * the remainder of the request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 */
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700757void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758{
759 int result = cmd->result;
Jens Axboe165125e2007-07-24 09:28:11 +0200760 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 struct request *req = cmd->request;
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500762 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 struct scsi_sense_hdr sshdr;
764 int sense_valid = 0;
765 int sense_deferred = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500766 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
767 ACTION_DELAYED_RETRY} action;
768 char *description = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 if (result) {
771 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
772 if (sense_valid)
773 sense_deferred = scsi_sense_is_deferred(&sshdr);
774 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200775
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200776 if (req->cmd_type == REQ_TYPE_BLOCK_PC) { /* SG_IO ioctl from block level */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 if (sense_valid && req->sense) {
779 /*
780 * SG_IO wants current and deferred errors
781 */
782 int len = 8 + cmd->sense_buffer[7];
783
784 if (len > SCSI_SENSE_BUFFERSIZE)
785 len = SCSI_SENSE_BUFFERSIZE;
786 memcpy(req->sense, cmd->sense_buffer, len);
787 req->sense_len = len;
788 }
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500789 if (!sense_deferred)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100790 error = __scsi_error_from_host_byte(cmd, result);
Pete Wyckoffb22f6872007-03-13 16:53:28 -0400791 }
Mike Snitzer27c41972012-05-31 15:05:33 -0400792 /*
793 * __scsi_error_from_host_byte may have reset the host_byte
794 */
795 req->errors = cmd->result;
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900796
797 req->resid_len = scsi_get_resid(cmd);
798
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200799 if (scsi_bidi_cmnd(cmd)) {
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900800 /*
801 * Bidi commands Must be complete as a whole,
802 * both sides at once.
803 */
804 req->next_rq->resid_len = scsi_in(cmd)->resid;
805
Boaz Harrosh63c43b02009-12-15 17:25:43 +0200806 scsi_release_buffers(cmd);
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900807 blk_end_request_all(req, 0);
808
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900809 scsi_next_command(cmd);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200810 return;
811 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 }
813
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200814 /* no bidi support for !REQ_TYPE_BLOCK_PC yet */
815 BUG_ON(blk_bidi_rq(req));
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200816
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 * Next deal with any sectors which we were able to correctly
819 * handle.
820 */
Tejun Heo83096eb2009-05-07 22:24:39 +0900821 SCSI_LOG_HLCOMPLETE(1, printk("%u sectors total, "
James Bottomleyd6b0c532006-07-02 10:06:28 -0500822 "%d bytes done.\n",
Tejun Heo83096eb2009-05-07 22:24:39 +0900823 blk_rq_sectors(req), good_bytes));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
James Bottomleya9bddd72009-03-30 16:55:51 +0000825 /*
826 * Recovered errors need reporting, but they're always treated
827 * as success, so fiddle the result code here. For BLOCK_PC
828 * we already took a copy of the original into rq->errors which
829 * is what gets returned to the user
830 */
Douglas Gilberte7efe592010-01-03 13:51:15 -0500831 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
832 /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
833 * print since caller wants ATA registers. Only occurs on
834 * SCSI ATA PASS_THROUGH commands when CK_COND=1
835 */
836 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
837 ;
838 else if (!(req->cmd_flags & REQ_QUIET))
James Bottomleya9bddd72009-03-30 16:55:51 +0000839 scsi_print_sense("", cmd);
840 result = 0;
841 /* BLOCK_PC may have set error */
842 error = 0;
843 }
844
845 /*
846 * A number of bytes were successfully read. If there
James Bottomleyd6b0c532006-07-02 10:06:28 -0500847 * are leftovers and there is some kind of error
848 * (result != 0), retry the rest.
849 */
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500850 if (scsi_end_request(cmd, error, good_bytes, result == 0) == NULL)
James Bottomleyd6b0c532006-07-02 10:06:28 -0500851 return;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700852
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100853 error = __scsi_error_from_host_byte(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500854
Alan Sternb60af5b2008-11-03 15:56:47 -0500855 if (host_byte(result) == DID_RESET) {
856 /* Third party bus reset or reset for error recovery
857 * reasons. Just retry the command and see what
858 * happens.
859 */
860 action = ACTION_RETRY;
861 } else if (sense_valid && !sense_deferred) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 switch (sshdr.sense_key) {
863 case UNIT_ATTENTION:
864 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700865 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 * and quietly refuse further access.
867 */
868 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500869 description = "Media Changed";
870 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700872 /* Must have been a power glitch, or a
873 * bus reset. Could not have been a
874 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500875 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700876 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500877 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 }
879 break;
880 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700881 /* If we had an ILLEGAL REQUEST returned, then
882 * we may have performed an unsupported
883 * command. The only thing this should be
884 * would be a ten byte read where only a six
885 * byte read was supported. Also, on a system
886 * where READ CAPACITY failed, we may have
887 * read past the end of the disk.
888 */
Jens Axboe26a68012005-11-29 21:03:34 +0100889 if ((cmd->device->use_10_for_rw &&
890 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 (cmd->cmnd[0] == READ_10 ||
892 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500893 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500895 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500896 } else if (sshdr.asc == 0x10) /* DIX */ {
897 description = "Host Data Integrity Failure";
898 action = ACTION_FAIL;
899 error = -EILSEQ;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500900 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400901 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
902 switch (cmd->cmnd[0]) {
903 case UNMAP:
904 description = "Discard failure";
905 break;
906 case WRITE_SAME:
907 case WRITE_SAME_16:
908 if (cmd->cmnd[1] & 0x8)
909 description = "Discard failure";
910 else
911 description =
912 "Write same failure";
913 break;
914 default:
915 description = "Invalid command failure";
916 break;
917 }
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500918 action = ACTION_FAIL;
Martin K. Petersen66a651a2012-02-13 15:38:22 -0500919 error = -EREMOTEIO;
Alan Sternb60af5b2008-11-03 15:56:47 -0500920 } else
921 action = ACTION_FAIL;
922 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400923 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000924 action = ACTION_FAIL;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400925 if (sshdr.asc == 0x10) { /* DIF */
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500926 description = "Target Data Integrity Failure";
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500927 error = -EILSEQ;
James Bottomley126c09822009-02-19 21:48:54 +0000928 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 break;
930 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700931 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500932 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500934 if (sshdr.asc == 0x04) {
935 switch (sshdr.ascq) {
936 case 0x01: /* becoming ready */
937 case 0x04: /* format in progress */
938 case 0x05: /* rebuild in progress */
939 case 0x06: /* recalculation in progress */
940 case 0x07: /* operation in progress */
941 case 0x08: /* Long write in progress */
942 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500943 case 0x14: /* space allocation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500944 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500945 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500946 default:
947 description = "Device not ready";
948 action = ACTION_FAIL;
949 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500950 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500951 } else {
952 description = "Device not ready";
953 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500955 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700957 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500958 action = ACTION_FAIL;
959 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500961 description = "Unhandled sense code";
962 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 break;
964 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500965 } else {
966 description = "Unhandled error code";
967 action = ACTION_FAIL;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700968 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500969
970 switch (action) {
971 case ACTION_FAIL:
972 /* Give up and fail the remainder of the request */
James Bottomley79ed2422009-01-06 13:15:20 -0600973 scsi_release_buffers(cmd);
Jens Axboe4aff5e22006-08-10 08:44:47 +0200974 if (!(req->cmd_flags & REQ_QUIET)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500975 if (description)
Alan Stern3dbf6a52008-12-15 10:31:28 -0500976 scmd_printk(KERN_INFO, cmd, "%s\n",
Alan Sternb60af5b2008-11-03 15:56:47 -0500977 description);
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500978 scsi_print_result(cmd);
James Bottomley3173d8c2005-09-04 11:32:05 -0500979 if (driver_byte(result) & DRIVER_SENSE)
980 scsi_print_sense("", cmd);
Martin K. Petersen002b1eb2009-05-23 11:45:07 -0400981 scsi_print_command(cmd);
James Bottomley3173d8c2005-09-04 11:32:05 -0500982 }
Mike Christiead630822009-09-28 15:50:52 -0500983 if (blk_end_request_err(req, error))
Tejun Heoda6c5c72009-09-11 14:26:40 +0200984 scsi_requeue_command(q, cmd);
985 else
986 scsi_next_command(cmd);
Alan Sternb60af5b2008-11-03 15:56:47 -0500987 break;
988 case ACTION_REPREP:
989 /* Unprep the request and put it back at the head of the queue.
990 * A new command will be prepared and issued.
991 */
James Bottomley79ed2422009-01-06 13:15:20 -0600992 scsi_release_buffers(cmd);
Alan Sternb60af5b2008-11-03 15:56:47 -0500993 scsi_requeue_command(q, cmd);
994 break;
995 case ACTION_RETRY:
996 /* Retry the same command immediately */
James Bottomley4f5299a2009-01-02 10:42:21 -0600997 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -0500998 break;
999 case ACTION_DELAYED_RETRY:
1000 /* Retry the same command after a delay */
James Bottomley4f5299a2009-01-02 10:42:21 -06001001 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001002 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 }
1004}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001006static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb,
1007 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001009 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
1011 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001012 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001014 if (unlikely(scsi_alloc_sgtable(sdb, req->nr_phys_segments,
1015 gfp_mask))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 return BLKPREP_DEFER;
Alan Stern7c72ce82005-10-14 11:23:27 -04001017 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
Christoph Hellwig3b003152006-11-04 20:10:55 +01001019 req->buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
1021 /*
1022 * Next, walk the list, and fill in the addresses and sizes of
1023 * each segment.
1024 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001025 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1026 BUG_ON(count > sdb->table.nents);
1027 sdb->table.nents = count;
Tejun Heo1011c1b2009-05-07 22:24:45 +09001028 sdb->length = blk_rq_bytes(req);
Rusty Russell4a03d902007-11-19 11:28:48 +11001029 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001031
1032/*
1033 * Function: scsi_init_io()
1034 *
1035 * Purpose: SCSI I/O initialize function.
1036 *
1037 * Arguments: cmd - Command descriptor we wish to initialize
1038 *
1039 * Returns: 0 on success
1040 * BLKPREP_DEFER if the failure is retryable
1041 * BLKPREP_KILL if the failure is fatal
1042 */
1043int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask)
1044{
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001045 struct request *rq = cmd->request;
1046
1047 int error = scsi_init_sgtable(rq, &cmd->sdb, gfp_mask);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001048 if (error)
1049 goto err_exit;
1050
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001051 if (blk_bidi_rq(rq)) {
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001052 struct scsi_data_buffer *bidi_sdb = kmem_cache_zalloc(
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001053 scsi_sdb_cache, GFP_ATOMIC);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001054 if (!bidi_sdb) {
1055 error = BLKPREP_DEFER;
1056 goto err_exit;
1057 }
1058
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001059 rq->next_rq->special = bidi_sdb;
1060 error = scsi_init_sgtable(rq->next_rq, bidi_sdb, GFP_ATOMIC);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001061 if (error)
1062 goto err_exit;
1063 }
1064
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001065 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001066 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1067 int ivecs, count;
1068
1069 BUG_ON(prot_sdb == NULL);
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001070 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001071
1072 if (scsi_alloc_sgtable(prot_sdb, ivecs, gfp_mask)) {
1073 error = BLKPREP_DEFER;
1074 goto err_exit;
1075 }
1076
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001077 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001078 prot_sdb->table.sgl);
1079 BUG_ON(unlikely(count > ivecs));
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001080 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001081
1082 cmd->prot_sdb = prot_sdb;
1083 cmd->prot_sdb->table.nents = count;
1084 }
1085
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001086 return BLKPREP_OK ;
1087
1088err_exit:
1089 scsi_release_buffers(cmd);
FUJITA Tomonori610a6342010-07-08 10:16:17 +02001090 cmd->request->special = NULL;
James Bottomley3a5c19c2010-08-16 10:06:26 -05001091 scsi_put_command(cmd);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001092 return error;
1093}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001094EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
Christoph Hellwig3b003152006-11-04 20:10:55 +01001096static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
1097 struct request *req)
1098{
1099 struct scsi_cmnd *cmd;
1100
1101 if (!req->special) {
1102 cmd = scsi_get_command(sdev, GFP_ATOMIC);
1103 if (unlikely(!cmd))
1104 return NULL;
1105 req->special = cmd;
1106 } else {
1107 cmd = req->special;
1108 }
1109
1110 /* pull a tag out of the request if we have one */
1111 cmd->tag = req->tag;
1112 cmd->request = req;
1113
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001114 cmd->cmnd = req->cmd;
Martin K. Petersen72f7d322011-03-08 02:03:59 -05001115 cmd->prot_op = SCSI_PROT_NORMAL;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001116
Christoph Hellwig3b003152006-11-04 20:10:55 +01001117 return cmd;
1118}
1119
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001120int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001121{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001122 struct scsi_cmnd *cmd;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001123 int ret = scsi_prep_state_check(sdev, req);
1124
1125 if (ret != BLKPREP_OK)
1126 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001127
1128 cmd = scsi_get_cmd_from_req(sdev, req);
1129 if (unlikely(!cmd))
1130 return BLKPREP_DEFER;
1131
1132 /*
1133 * BLOCK_PC requests may transfer data, in which case they must
1134 * a bio attached to them. Or they might contain a SCSI command
1135 * that does not transfer data, in which case they may optionally
1136 * submit a request without an attached bio.
1137 */
1138 if (req->bio) {
1139 int ret;
1140
1141 BUG_ON(!req->nr_phys_segments);
1142
Boaz Harroshbb52d822007-12-13 16:14:27 -08001143 ret = scsi_init_io(cmd, GFP_ATOMIC);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001144 if (unlikely(ret))
1145 return ret;
1146 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001147 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001148
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001149 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001150 req->buffer = NULL;
1151 }
James Bottomley7b163182005-12-15 20:17:02 -06001152
James Bottomley7b163182005-12-15 20:17:02 -06001153 cmd->cmd_len = req->cmd_len;
Tejun Heob0790412009-05-07 22:24:42 +09001154 if (!blk_rq_bytes(req))
James Bottomley7b163182005-12-15 20:17:02 -06001155 cmd->sc_data_direction = DMA_NONE;
1156 else if (rq_data_dir(req) == WRITE)
1157 cmd->sc_data_direction = DMA_TO_DEVICE;
1158 else
1159 cmd->sc_data_direction = DMA_FROM_DEVICE;
1160
Tejun Heob0790412009-05-07 22:24:42 +09001161 cmd->transfersize = blk_rq_bytes(req);
James Bottomley7b163182005-12-15 20:17:02 -06001162 cmd->allowed = req->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001163 return BLKPREP_OK;
1164}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001165EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001166
1167/*
1168 * Setup a REQ_TYPE_FS command. These are simple read/write request
1169 * from filesystems that still need to be translated to SCSI CDBs from
1170 * the ULD.
1171 */
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001172int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001173{
1174 struct scsi_cmnd *cmd;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001175 int ret = scsi_prep_state_check(sdev, req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001176
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001177 if (ret != BLKPREP_OK)
1178 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001179
1180 if (unlikely(sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh
1181 && sdev->scsi_dh_data->scsi_dh->prep_fn)) {
1182 ret = sdev->scsi_dh_data->scsi_dh->prep_fn(sdev, req);
1183 if (ret != BLKPREP_OK)
1184 return ret;
1185 }
1186
Christoph Hellwig3b003152006-11-04 20:10:55 +01001187 /*
1188 * Filesystem requests must transfer data.
1189 */
1190 BUG_ON(!req->nr_phys_segments);
1191
1192 cmd = scsi_get_cmd_from_req(sdev, req);
1193 if (unlikely(!cmd))
1194 return BLKPREP_DEFER;
1195
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001196 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Boaz Harroshbb52d822007-12-13 16:14:27 -08001197 return scsi_init_io(cmd, GFP_ATOMIC);
James Bottomley7b163182005-12-15 20:17:02 -06001198}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001199EXPORT_SYMBOL(scsi_setup_fs_cmnd);
James Bottomley7b163182005-12-15 20:17:02 -06001200
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001201int scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001203 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204
1205 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001206 * If the device is not in running state we will reject some
1207 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001210 switch (sdev->sdev_state) {
1211 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05001212 case SDEV_TRANSPORT_OFFLINE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001213 /*
1214 * If the device is offline we refuse to process any
1215 * commands. The device must be brought online
1216 * before trying any recovery commands.
1217 */
1218 sdev_printk(KERN_ERR, sdev,
1219 "rejecting I/O to offline device\n");
1220 ret = BLKPREP_KILL;
1221 break;
1222 case SDEV_DEL:
1223 /*
1224 * If the device is fully deleted, we refuse to
1225 * process any commands as well.
1226 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001227 sdev_printk(KERN_ERR, sdev,
1228 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001229 ret = BLKPREP_KILL;
1230 break;
1231 case SDEV_QUIESCE:
1232 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001233 case SDEV_CREATED_BLOCK:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001234 /*
1235 * If the devices is blocked we defer normal commands.
1236 */
1237 if (!(req->cmd_flags & REQ_PREEMPT))
1238 ret = BLKPREP_DEFER;
1239 break;
1240 default:
1241 /*
1242 * For any other not fully online state we only allow
1243 * special commands. In particular any user initiated
1244 * command is not allowed.
1245 */
1246 if (!(req->cmd_flags & REQ_PREEMPT))
1247 ret = BLKPREP_KILL;
1248 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001251 return ret;
1252}
1253EXPORT_SYMBOL(scsi_prep_state_check);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001255int scsi_prep_return(struct request_queue *q, struct request *req, int ret)
1256{
1257 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258
Christoph Hellwig3b003152006-11-04 20:10:55 +01001259 switch (ret) {
1260 case BLKPREP_KILL:
1261 req->errors = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001262 /* release the command and kill it */
1263 if (req->special) {
1264 struct scsi_cmnd *cmd = req->special;
1265 scsi_release_buffers(cmd);
1266 scsi_put_command(cmd);
1267 req->special = NULL;
1268 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001269 break;
1270 case BLKPREP_DEFER:
1271 /*
Tejun Heo9934c8c2009-05-08 11:54:16 +09001272 * If we defer, the blk_peek_request() returns NULL, but the
Jens Axboea488e742010-04-16 21:13:15 +02001273 * queue must be restarted, so we schedule a callback to happen
1274 * shortly.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001275 */
1276 if (sdev->device_busy == 0)
Jens Axboea488e742010-04-16 21:13:15 +02001277 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001278 break;
1279 default:
1280 req->cmd_flags |= REQ_DONTPREP;
1281 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
Christoph Hellwig3b003152006-11-04 20:10:55 +01001283 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001285EXPORT_SYMBOL(scsi_prep_return);
1286
James Bottomley751bf4d2008-01-02 11:14:30 -06001287int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001288{
1289 struct scsi_device *sdev = q->queuedata;
1290 int ret = BLKPREP_KILL;
1291
1292 if (req->cmd_type == REQ_TYPE_BLOCK_PC)
1293 ret = scsi_setup_blk_pc_cmnd(sdev, req);
1294 return scsi_prep_return(q, req, ret);
1295}
Hannes Reineckeb3912772009-06-18 09:57:18 +02001296EXPORT_SYMBOL(scsi_prep_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297
1298/*
1299 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1300 * return 0.
1301 *
1302 * Called with the queue_lock held.
1303 */
1304static inline int scsi_dev_queue_ready(struct request_queue *q,
1305 struct scsi_device *sdev)
1306{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 if (sdev->device_busy == 0 && sdev->device_blocked) {
1308 /*
1309 * unblock after device_blocked iterates to zero
1310 */
1311 if (--sdev->device_blocked == 0) {
1312 SCSI_LOG_MLQUEUE(3,
James Bottomley9ccfc752005-10-02 11:45:08 -05001313 sdev_printk(KERN_INFO, sdev,
1314 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 } else {
Jens Axboea488e742010-04-16 21:13:15 +02001316 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 return 0;
1318 }
1319 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001320 if (scsi_device_is_busy(sdev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 return 0;
1322
1323 return 1;
1324}
1325
Mike Christief0c0a372008-08-17 15:24:38 -05001326
1327/*
1328 * scsi_target_queue_ready: checks if there we can send commands to target
1329 * @sdev: scsi device on starget to check.
1330 *
1331 * Called with the host lock held.
1332 */
1333static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1334 struct scsi_device *sdev)
1335{
1336 struct scsi_target *starget = scsi_target(sdev);
1337
1338 if (starget->single_lun) {
1339 if (starget->starget_sdev_user &&
1340 starget->starget_sdev_user != sdev)
1341 return 0;
1342 starget->starget_sdev_user = sdev;
1343 }
1344
1345 if (starget->target_busy == 0 && starget->target_blocked) {
1346 /*
1347 * unblock after target_blocked iterates to zero
1348 */
1349 if (--starget->target_blocked == 0) {
1350 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1351 "unblocking target at zero depth\n"));
Mike Christieb4efdd52009-04-09 15:57:10 -05001352 } else
Mike Christief0c0a372008-08-17 15:24:38 -05001353 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001354 }
1355
1356 if (scsi_target_is_busy(starget)) {
Shaohua Li466c08c2012-01-10 11:27:01 +08001357 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Hillf Dantonfd01a662010-12-16 14:26:37 -06001358 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001359 }
1360
Mike Christief0c0a372008-08-17 15:24:38 -05001361 return 1;
1362}
1363
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364/*
1365 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1366 * return 0. We must end up running the queue again whenever 0 is
1367 * returned, else IO can hang.
1368 *
1369 * Called with host_lock held.
1370 */
1371static inline int scsi_host_queue_ready(struct request_queue *q,
1372 struct Scsi_Host *shost,
1373 struct scsi_device *sdev)
1374{
James Bottomley939647e2005-09-18 15:05:20 -05001375 if (scsi_host_in_recovery(shost))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 return 0;
1377 if (shost->host_busy == 0 && shost->host_blocked) {
1378 /*
1379 * unblock after host_blocked iterates to zero
1380 */
1381 if (--shost->host_blocked == 0) {
1382 SCSI_LOG_MLQUEUE(3,
1383 printk("scsi%d unblocking host at zero depth\n",
1384 shost->host_no));
1385 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 return 0;
1387 }
1388 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001389 if (scsi_host_is_busy(shost)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 if (list_empty(&sdev->starved_entry))
1391 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1392 return 0;
1393 }
1394
1395 /* We're OK to process the command, so we can't be starved */
1396 if (!list_empty(&sdev->starved_entry))
1397 list_del_init(&sdev->starved_entry);
1398
1399 return 1;
1400}
1401
1402/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001403 * Busy state exporting function for request stacking drivers.
1404 *
1405 * For efficiency, no lock is taken to check the busy state of
1406 * shost/starget/sdev, since the returned value is not guaranteed and
1407 * may be changed after request stacking drivers call the function,
1408 * regardless of taking lock or not.
1409 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001410 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1411 * needs to return 'not busy'. Otherwise, request stacking drivers
1412 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001413 */
1414static int scsi_lld_busy(struct request_queue *q)
1415{
1416 struct scsi_device *sdev = q->queuedata;
1417 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001418
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001419 if (blk_queue_dying(q))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001420 return 0;
1421
1422 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001423
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001424 /*
1425 * Ignore host/starget busy state.
1426 * Since block layer does not have a concept of fairness across
1427 * multiple queues, congestion of host/starget needs to be handled
1428 * in SCSI layer.
1429 */
1430 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001431 return 1;
1432
1433 return 0;
1434}
1435
1436/*
James Bottomleye91442b2005-09-09 10:44:16 -05001437 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 */
Jens Axboe165125e2007-07-24 09:28:11 +02001439static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440{
James Bottomleye91442b2005-09-09 10:44:16 -05001441 struct scsi_cmnd *cmd = req->special;
Jiri Slaby03b14702009-09-23 16:15:35 +02001442 struct scsi_device *sdev;
1443 struct scsi_target *starget;
1444 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445
Tejun Heo9934c8c2009-05-08 11:54:16 +09001446 blk_start_request(req);
James Bottomley788ce432005-09-09 13:40:23 -05001447
Hannes Reinecke74571812011-11-09 08:39:24 +01001448 scmd_printk(KERN_INFO, cmd, "killing request\n");
1449
Jiri Slaby03b14702009-09-23 16:15:35 +02001450 sdev = cmd->device;
1451 starget = scsi_target(sdev);
1452 shost = sdev->host;
James Bottomleye91442b2005-09-09 10:44:16 -05001453 scsi_init_cmd_errh(cmd);
1454 cmd->result = DID_NO_CONNECT << 16;
1455 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001456
1457 /*
1458 * SCSI request completion path will do scsi_device_unbusy(),
1459 * bump busy counts. To bump the counters, we need to dance
1460 * with the locks as normal issue path does.
1461 */
1462 sdev->device_busy++;
1463 spin_unlock(sdev->request_queue->queue_lock);
1464 spin_lock(shost->host_lock);
1465 shost->host_busy++;
Mike Christief0c0a372008-08-17 15:24:38 -05001466 starget->target_busy++;
Tejun Heoe36e0c82006-04-11 17:27:53 +09001467 spin_unlock(shost->host_lock);
1468 spin_lock(sdev->request_queue->queue_lock);
1469
Jens Axboe242f9dc2008-09-14 05:55:09 -07001470 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471}
1472
Jens Axboe1aea6432006-01-09 16:03:03 +01001473static void scsi_softirq_done(struct request *rq)
1474{
Jens Axboe242f9dc2008-09-14 05:55:09 -07001475 struct scsi_cmnd *cmd = rq->special;
1476 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001477 int disposition;
1478
1479 INIT_LIST_HEAD(&cmd->eh_entry);
1480
Jens Axboe242f9dc2008-09-14 05:55:09 -07001481 atomic_inc(&cmd->device->iodone_cnt);
1482 if (cmd->result)
1483 atomic_inc(&cmd->device->ioerr_cnt);
1484
Jens Axboe1aea6432006-01-09 16:03:03 +01001485 disposition = scsi_decide_disposition(cmd);
1486 if (disposition != SUCCESS &&
1487 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1488 sdev_printk(KERN_ERR, cmd->device,
1489 "timing out command, waited %lus\n",
1490 wait_for/HZ);
1491 disposition = SUCCESS;
1492 }
1493
1494 scsi_log_completion(cmd, disposition);
1495
1496 switch (disposition) {
1497 case SUCCESS:
1498 scsi_finish_command(cmd);
1499 break;
1500 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001501 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001502 break;
1503 case ADD_TO_MLQUEUE:
1504 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1505 break;
1506 default:
1507 if (!scsi_eh_scmd_add(cmd, 0))
1508 scsi_finish_command(cmd);
1509 }
1510}
1511
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512/*
1513 * Function: scsi_request_fn()
1514 *
1515 * Purpose: Main strategy routine for SCSI.
1516 *
1517 * Arguments: q - Pointer to actual queue.
1518 *
1519 * Returns: Nothing
1520 *
1521 * Lock status: IO request lock assumed to be held when called.
1522 */
1523static void scsi_request_fn(struct request_queue *q)
1524{
1525 struct scsi_device *sdev = q->queuedata;
1526 struct Scsi_Host *shost;
1527 struct scsi_cmnd *cmd;
1528 struct request *req;
1529
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 if(!get_device(&sdev->sdev_gendev))
1531 /* We must be tearing the block queue down already */
1532 return;
1533
1534 /*
1535 * To start with, we keep looping until the queue is empty, or until
1536 * the host is no longer able to accept any more requests.
1537 */
1538 shost = sdev->host;
Jens Axboea488e742010-04-16 21:13:15 +02001539 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 int rtn;
1541 /*
1542 * get next queueable request. We do this early to make sure
1543 * that the request is fully prepared even if we cannot
1544 * accept it.
1545 */
Tejun Heo9934c8c2009-05-08 11:54:16 +09001546 req = blk_peek_request(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 if (!req || !scsi_dev_queue_ready(q, sdev))
1548 break;
1549
1550 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001551 sdev_printk(KERN_ERR, sdev,
1552 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001553 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 continue;
1555 }
1556
1557
1558 /*
1559 * Remove the request from the request list.
1560 */
1561 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
Tejun Heo9934c8c2009-05-08 11:54:16 +09001562 blk_start_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 sdev->device_busy++;
1564
1565 spin_unlock(q->queue_lock);
James Bottomleye91442b2005-09-09 10:44:16 -05001566 cmd = req->special;
1567 if (unlikely(cmd == NULL)) {
1568 printk(KERN_CRIT "impossible request in %s.\n"
1569 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001570 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001571 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001572 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001573 BUG();
1574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 spin_lock(shost->host_lock);
1576
Mike Christieecefe8a2008-07-11 19:50:35 -05001577 /*
1578 * We hit this when the driver is using a host wide
1579 * tag map. For device level tag maps the queue_depth check
1580 * in the device ready fn would prevent us from trying
1581 * to allocate a tag. Since the map is a shared host resource
1582 * we add the dev to the starved list so it eventually gets
1583 * a run when a tag is freed.
1584 */
Mike Christie6bd522f2008-07-22 15:34:38 -05001585 if (blk_queue_tagged(q) && !blk_rq_tagged(req)) {
Mike Christieecefe8a2008-07-11 19:50:35 -05001586 if (list_empty(&sdev->starved_entry))
1587 list_add_tail(&sdev->starved_entry,
1588 &shost->starved_list);
1589 goto not_ready;
1590 }
1591
Mike Christief0c0a372008-08-17 15:24:38 -05001592 if (!scsi_target_queue_ready(shost, sdev))
1593 goto not_ready;
1594
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 if (!scsi_host_queue_ready(q, shost, sdev))
1596 goto not_ready;
Mike Christief0c0a372008-08-17 15:24:38 -05001597
1598 scsi_target(sdev)->target_busy++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 shost->host_busy++;
1600
1601 /*
1602 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1603 * take the lock again.
1604 */
1605 spin_unlock_irq(shost->host_lock);
1606
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 /*
1608 * Finally, initialize any error handling parameters, and set up
1609 * the timers for timeouts.
1610 */
1611 scsi_init_cmd_errh(cmd);
1612
1613 /*
1614 * Dispatch the command to the low-level driver.
1615 */
1616 rtn = scsi_dispatch_cmd(cmd);
1617 spin_lock_irq(q->queue_lock);
Jens Axboea488e742010-04-16 21:13:15 +02001618 if (rtn)
1619 goto out_delay;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 }
1621
1622 goto out;
1623
1624 not_ready:
1625 spin_unlock_irq(shost->host_lock);
1626
1627 /*
1628 * lock q, handle tag, requeue req, and decrement device_busy. We
1629 * must return with queue_lock held.
1630 *
1631 * Decrementing device_busy without checking it is OK, as all such
1632 * cases (host limits or settings) should run the queue at some
1633 * later time.
1634 */
1635 spin_lock_irq(q->queue_lock);
1636 blk_requeue_request(q, req);
1637 sdev->device_busy--;
Jens Axboea488e742010-04-16 21:13:15 +02001638out_delay:
1639 if (sdev->device_busy == 0)
1640 blk_delay_queue(q, SCSI_QUEUE_DELAY);
1641out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 /* must be careful here...if we trigger the ->remove() function
1643 * we cannot be holding the q lock */
1644 spin_unlock_irq(q->queue_lock);
1645 put_device(&sdev->sdev_gendev);
1646 spin_lock_irq(q->queue_lock);
1647}
1648
1649u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
1650{
1651 struct device *host_dev;
1652 u64 bounce_limit = 0xffffffff;
1653
1654 if (shost->unchecked_isa_dma)
1655 return BLK_BOUNCE_ISA;
1656 /*
1657 * Platforms with virtual-DMA translation
1658 * hardware have no practical limit.
1659 */
1660 if (!PCI_DMA_BUS_IS_PHYS)
1661 return BLK_BOUNCE_ANY;
1662
1663 host_dev = scsi_get_device(shost);
1664 if (host_dev && host_dev->dma_mask)
1665 bounce_limit = *host_dev->dma_mask;
1666
1667 return bounce_limit;
1668}
1669EXPORT_SYMBOL(scsi_calculate_bounce_limit);
1670
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001671struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
1672 request_fn_proc *request_fn)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 struct request_queue *q;
Lin Ming6f381fa2012-04-12 13:50:38 +08001675 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001677 q = blk_init_queue(request_fn, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 if (!q)
1679 return NULL;
1680
Jens Axboea8474ce2007-08-07 09:02:51 +02001681 /*
1682 * this limit is imposed by hardware restrictions
1683 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001684 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
1685 SCSI_MAX_SG_CHAIN_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001686
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001687 if (scsi_host_prot_dma(shost)) {
1688 shost->sg_prot_tablesize =
1689 min_not_zero(shost->sg_prot_tablesize,
1690 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1691 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1692 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1693 }
1694
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001695 blk_queue_max_hw_sectors(q, shost->max_sectors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
1697 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001698 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
FUJITA Tomonori860ac562008-02-04 22:28:05 -08001700 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
1701
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01001703 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06001704
1705 /*
1706 * set a reasonable default alignment on word boundaries: the
1707 * host and device may alter it using
1708 * blk_queue_update_dma_alignment() later.
1709 */
1710 blk_queue_dma_alignment(q, 0x03);
1711
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 return q;
1713}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001714EXPORT_SYMBOL(__scsi_alloc_queue);
1715
1716struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
1717{
1718 struct request_queue *q;
1719
1720 q = __scsi_alloc_queue(sdev->host, scsi_request_fn);
1721 if (!q)
1722 return NULL;
1723
1724 blk_queue_prep_rq(q, scsi_prep_fn);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001725 blk_queue_softirq_done(q, scsi_softirq_done);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001726 blk_queue_rq_timed_out(q, scsi_times_out);
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001727 blk_queue_lld_busy(q, scsi_lld_busy);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001728 return q;
1729}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731/*
1732 * Function: scsi_block_requests()
1733 *
1734 * Purpose: Utility function used by low-level drivers to prevent further
1735 * commands from being queued to the device.
1736 *
1737 * Arguments: shost - Host in question
1738 *
1739 * Returns: Nothing
1740 *
1741 * Lock status: No locks are assumed held.
1742 *
1743 * Notes: There is no timer nor any other means by which the requests
1744 * get unblocked other than the low-level driver calling
1745 * scsi_unblock_requests().
1746 */
1747void scsi_block_requests(struct Scsi_Host *shost)
1748{
1749 shost->host_self_blocked = 1;
1750}
1751EXPORT_SYMBOL(scsi_block_requests);
1752
1753/*
1754 * Function: scsi_unblock_requests()
1755 *
1756 * Purpose: Utility function used by low-level drivers to allow further
1757 * commands from being queued to the device.
1758 *
1759 * Arguments: shost - Host in question
1760 *
1761 * Returns: Nothing
1762 *
1763 * Lock status: No locks are assumed held.
1764 *
1765 * Notes: There is no timer nor any other means by which the requests
1766 * get unblocked other than the low-level driver calling
1767 * scsi_unblock_requests().
1768 *
1769 * This is done as an API function so that changes to the
1770 * internals of the scsi mid-layer won't require wholesale
1771 * changes to drivers that use this feature.
1772 */
1773void scsi_unblock_requests(struct Scsi_Host *shost)
1774{
1775 shost->host_self_blocked = 0;
1776 scsi_run_host_queues(shost);
1777}
1778EXPORT_SYMBOL(scsi_unblock_requests);
1779
1780int __init scsi_init_queue(void)
1781{
1782 int i;
1783
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001784 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1785 sizeof(struct scsi_data_buffer),
1786 0, 0, NULL);
1787 if (!scsi_sdb_cache) {
1788 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001789 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001790 }
1791
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1793 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1794 int size = sgp->size * sizeof(struct scatterlist);
1795
1796 sgp->slab = kmem_cache_create(sgp->name, size, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09001797 SLAB_HWCACHE_ALIGN, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 if (!sgp->slab) {
1799 printk(KERN_ERR "SCSI: can't init sg slab %s\n",
1800 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001801 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 }
1803
Matthew Dobson93d23412006-03-26 01:37:50 -08001804 sgp->pool = mempool_create_slab_pool(SG_MEMPOOL_SIZE,
1805 sgp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 if (!sgp->pool) {
1807 printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
1808 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001809 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 }
1811 }
1812
1813 return 0;
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001814
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001815cleanup_sdb:
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001816 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1817 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1818 if (sgp->pool)
1819 mempool_destroy(sgp->pool);
1820 if (sgp->slab)
1821 kmem_cache_destroy(sgp->slab);
1822 }
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001823 kmem_cache_destroy(scsi_sdb_cache);
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001824
1825 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826}
1827
1828void scsi_exit_queue(void)
1829{
1830 int i;
1831
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001832 kmem_cache_destroy(scsi_sdb_cache);
Mike Christieaa7b5cd2005-11-11 05:31:41 -06001833
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1835 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1836 mempool_destroy(sgp->pool);
1837 kmem_cache_destroy(sgp->slab);
1838 }
1839}
James Bottomley5baba832006-03-18 14:10:35 -06001840
1841/**
1842 * scsi_mode_select - issue a mode select
1843 * @sdev: SCSI device to be queried
1844 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1845 * @sp: Save page bit (0 == don't save, 1 == save)
1846 * @modepage: mode page being requested
1847 * @buffer: request buffer (may not be smaller than eight bytes)
1848 * @len: length of request buffer.
1849 * @timeout: command timeout
1850 * @retries: number of retries before failing
1851 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001852 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001853 * must be SCSI_SENSE_BUFFERSIZE big.
1854 *
1855 * Returns zero if successful; negative error number or scsi
1856 * status on error
1857 *
1858 */
1859int
1860scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1861 unsigned char *buffer, int len, int timeout, int retries,
1862 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1863{
1864 unsigned char cmd[10];
1865 unsigned char *real_buffer;
1866 int ret;
1867
1868 memset(cmd, 0, sizeof(cmd));
1869 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
1870
1871 if (sdev->use_10_for_ms) {
1872 if (len > 65535)
1873 return -EINVAL;
1874 real_buffer = kmalloc(8 + len, GFP_KERNEL);
1875 if (!real_buffer)
1876 return -ENOMEM;
1877 memcpy(real_buffer + 8, buffer, len);
1878 len += 8;
1879 real_buffer[0] = 0;
1880 real_buffer[1] = 0;
1881 real_buffer[2] = data->medium_type;
1882 real_buffer[3] = data->device_specific;
1883 real_buffer[4] = data->longlba ? 0x01 : 0;
1884 real_buffer[5] = 0;
1885 real_buffer[6] = data->block_descriptor_length >> 8;
1886 real_buffer[7] = data->block_descriptor_length;
1887
1888 cmd[0] = MODE_SELECT_10;
1889 cmd[7] = len >> 8;
1890 cmd[8] = len;
1891 } else {
1892 if (len > 255 || data->block_descriptor_length > 255 ||
1893 data->longlba)
1894 return -EINVAL;
1895
1896 real_buffer = kmalloc(4 + len, GFP_KERNEL);
1897 if (!real_buffer)
1898 return -ENOMEM;
1899 memcpy(real_buffer + 4, buffer, len);
1900 len += 4;
1901 real_buffer[0] = 0;
1902 real_buffer[1] = data->medium_type;
1903 real_buffer[2] = data->device_specific;
1904 real_buffer[3] = data->block_descriptor_length;
1905
1906
1907 cmd[0] = MODE_SELECT;
1908 cmd[4] = len;
1909 }
1910
1911 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09001912 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06001913 kfree(real_buffer);
1914 return ret;
1915}
1916EXPORT_SYMBOL_GPL(scsi_mode_select);
1917
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918/**
Rob Landleyeb448202007-11-03 13:30:39 -05001919 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05001920 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 * @dbd: set if mode sense will allow block descriptors to be returned
1922 * @modepage: mode page being requested
1923 * @buffer: request buffer (may not be smaller than eight bytes)
1924 * @len: length of request buffer.
1925 * @timeout: command timeout
1926 * @retries: number of retries before failing
1927 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001928 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05001929 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 *
1931 * Returns zero if unsuccessful, or the header offset (either 4
1932 * or 8 depending on whether a six or ten byte command was
1933 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05001934 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935int
James Bottomley1cf72692005-08-28 11:27:01 -05001936scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06001938 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1939{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 unsigned char cmd[12];
1941 int use_10_for_ms;
1942 int header_length;
James Bottomley1cf72692005-08-28 11:27:01 -05001943 int result;
James Bottomleyea73a9f2005-08-28 11:33:52 -05001944 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945
1946 memset(data, 0, sizeof(*data));
1947 memset(&cmd[0], 0, 12);
1948 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
1949 cmd[2] = modepage;
1950
James Bottomleyea73a9f2005-08-28 11:33:52 -05001951 /* caller might not be interested in sense, but we need it */
1952 if (!sshdr)
1953 sshdr = &my_sshdr;
1954
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05001956 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957
1958 if (use_10_for_ms) {
1959 if (len < 8)
1960 len = 8;
1961
1962 cmd[0] = MODE_SENSE_10;
1963 cmd[8] = len;
1964 header_length = 8;
1965 } else {
1966 if (len < 4)
1967 len = 4;
1968
1969 cmd[0] = MODE_SENSE;
1970 cmd[4] = len;
1971 header_length = 4;
1972 }
1973
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 memset(buffer, 0, len);
1975
James Bottomley1cf72692005-08-28 11:27:01 -05001976 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09001977 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978
1979 /* This code looks awful: what it's doing is making sure an
1980 * ILLEGAL REQUEST sense return identifies the actual command
1981 * byte as the problem. MODE_SENSE commands can return
1982 * ILLEGAL REQUEST if the code page isn't supported */
1983
James Bottomley1cf72692005-08-28 11:27:01 -05001984 if (use_10_for_ms && !scsi_status_is_good(result) &&
1985 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05001986 if (scsi_sense_valid(sshdr)) {
1987 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
1988 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 /*
1990 * Invalid command operation code
1991 */
James Bottomley1cf72692005-08-28 11:27:01 -05001992 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 goto retry;
1994 }
1995 }
1996 }
1997
James Bottomley1cf72692005-08-28 11:27:01 -05001998 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01001999 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2000 (modepage == 6 || modepage == 8))) {
2001 /* Initio breakage? */
2002 header_length = 0;
2003 data->length = 13;
2004 data->medium_type = 0;
2005 data->device_specific = 0;
2006 data->longlba = 0;
2007 data->block_descriptor_length = 0;
2008 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 data->length = buffer[0]*256 + buffer[1] + 2;
2010 data->medium_type = buffer[2];
2011 data->device_specific = buffer[3];
2012 data->longlba = buffer[4] & 0x01;
2013 data->block_descriptor_length = buffer[6]*256
2014 + buffer[7];
2015 } else {
2016 data->length = buffer[0] + 1;
2017 data->medium_type = buffer[1];
2018 data->device_specific = buffer[2];
2019 data->block_descriptor_length = buffer[3];
2020 }
Al Viro6d73c852006-02-23 02:03:16 +01002021 data->header_length = header_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022 }
2023
James Bottomley1cf72692005-08-28 11:27:01 -05002024 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025}
2026EXPORT_SYMBOL(scsi_mode_sense);
2027
James Bottomley001aac22007-12-02 19:10:40 +02002028/**
2029 * scsi_test_unit_ready - test if unit is ready
2030 * @sdev: scsi device to change the state of.
2031 * @timeout: command timeout
2032 * @retries: number of retries before failing
2033 * @sshdr_external: Optional pointer to struct scsi_sense_hdr for
2034 * returning sense. Make sure that this is cleared before passing
2035 * in.
2036 *
2037 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002038 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002039 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040int
James Bottomley001aac22007-12-02 19:10:40 +02002041scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
2042 struct scsi_sense_hdr *sshdr_external)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 char cmd[] = {
2045 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2046 };
James Bottomley001aac22007-12-02 19:10:40 +02002047 struct scsi_sense_hdr *sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002049
2050 if (!sshdr_external)
2051 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
2052 else
2053 sshdr = sshdr_external;
2054
2055 /* try to eat the UNIT_ATTENTION if there are enough retries */
2056 do {
2057 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002058 timeout, retries, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002059 if (sdev->removable && scsi_sense_valid(sshdr) &&
2060 sshdr->sense_key == UNIT_ATTENTION)
2061 sdev->changed = 1;
2062 } while (scsi_sense_valid(sshdr) &&
2063 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002064
James Bottomley001aac22007-12-02 19:10:40 +02002065 if (!sshdr_external)
2066 kfree(sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 return result;
2068}
2069EXPORT_SYMBOL(scsi_test_unit_ready);
2070
2071/**
Rob Landleyeb448202007-11-03 13:30:39 -05002072 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 * @sdev: scsi device to change the state of.
2074 * @state: state to change to.
2075 *
2076 * Returns zero if unsuccessful or an error if the requested
2077 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002078 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079int
2080scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2081{
2082 enum scsi_device_state oldstate = sdev->sdev_state;
2083
2084 if (state == oldstate)
2085 return 0;
2086
2087 switch (state) {
2088 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002089 switch (oldstate) {
2090 case SDEV_CREATED_BLOCK:
2091 break;
2092 default:
2093 goto illegal;
2094 }
2095 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096
2097 case SDEV_RUNNING:
2098 switch (oldstate) {
2099 case SDEV_CREATED:
2100 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002101 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 case SDEV_QUIESCE:
2103 case SDEV_BLOCK:
2104 break;
2105 default:
2106 goto illegal;
2107 }
2108 break;
2109
2110 case SDEV_QUIESCE:
2111 switch (oldstate) {
2112 case SDEV_RUNNING:
2113 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002114 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 break;
2116 default:
2117 goto illegal;
2118 }
2119 break;
2120
2121 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002122 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 switch (oldstate) {
2124 case SDEV_CREATED:
2125 case SDEV_RUNNING:
2126 case SDEV_QUIESCE:
2127 case SDEV_BLOCK:
2128 break;
2129 default:
2130 goto illegal;
2131 }
2132 break;
2133
2134 case SDEV_BLOCK:
2135 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002137 case SDEV_CREATED_BLOCK:
2138 break;
2139 default:
2140 goto illegal;
2141 }
2142 break;
2143
2144 case SDEV_CREATED_BLOCK:
2145 switch (oldstate) {
2146 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 break;
2148 default:
2149 goto illegal;
2150 }
2151 break;
2152
2153 case SDEV_CANCEL:
2154 switch (oldstate) {
2155 case SDEV_CREATED:
2156 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002157 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002159 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 case SDEV_BLOCK:
2161 break;
2162 default:
2163 goto illegal;
2164 }
2165 break;
2166
2167 case SDEV_DEL:
2168 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002169 case SDEV_CREATED:
2170 case SDEV_RUNNING:
2171 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002172 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 case SDEV_CANCEL:
Bart Van Assche0516c082013-07-02 15:06:33 +02002174 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 break;
2176 default:
2177 goto illegal;
2178 }
2179 break;
2180
2181 }
2182 sdev->sdev_state = state;
2183 return 0;
2184
2185 illegal:
2186 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002187 sdev_printk(KERN_ERR, sdev,
2188 "Illegal state transition %s->%s\n",
2189 scsi_device_state_name(oldstate),
2190 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 );
2192 return -EINVAL;
2193}
2194EXPORT_SYMBOL(scsi_device_set_state);
2195
2196/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002197 * sdev_evt_emit - emit a single SCSI device uevent
2198 * @sdev: associated SCSI device
2199 * @evt: event to emit
2200 *
2201 * Send a single uevent (scsi_event) to the associated scsi_device.
2202 */
2203static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2204{
2205 int idx = 0;
2206 char *envp[3];
2207
2208 switch (evt->evt_type) {
2209 case SDEV_EVT_MEDIA_CHANGE:
2210 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2211 break;
2212
2213 default:
2214 /* do nothing */
2215 break;
2216 }
2217
2218 envp[idx++] = NULL;
2219
2220 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2221}
2222
2223/**
2224 * sdev_evt_thread - send a uevent for each scsi event
2225 * @work: work struct for scsi_device
2226 *
2227 * Dispatch queued events to their associated scsi_device kobjects
2228 * as uevents.
2229 */
2230void scsi_evt_thread(struct work_struct *work)
2231{
2232 struct scsi_device *sdev;
2233 LIST_HEAD(event_list);
2234
2235 sdev = container_of(work, struct scsi_device, event_work);
2236
2237 while (1) {
2238 struct scsi_event *evt;
2239 struct list_head *this, *tmp;
2240 unsigned long flags;
2241
2242 spin_lock_irqsave(&sdev->list_lock, flags);
2243 list_splice_init(&sdev->event_list, &event_list);
2244 spin_unlock_irqrestore(&sdev->list_lock, flags);
2245
2246 if (list_empty(&event_list))
2247 break;
2248
2249 list_for_each_safe(this, tmp, &event_list) {
2250 evt = list_entry(this, struct scsi_event, node);
2251 list_del(&evt->node);
2252 scsi_evt_emit(sdev, evt);
2253 kfree(evt);
2254 }
2255 }
2256}
2257
2258/**
2259 * sdev_evt_send - send asserted event to uevent thread
2260 * @sdev: scsi_device event occurred on
2261 * @evt: event to send
2262 *
2263 * Assert scsi device event asynchronously.
2264 */
2265void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2266{
2267 unsigned long flags;
2268
Kay Sievers4d1566e2008-03-19 13:04:47 +01002269#if 0
2270 /* FIXME: currently this check eliminates all media change events
2271 * for polled devices. Need to update to discriminate between AN
2272 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002273 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2274 kfree(evt);
2275 return;
2276 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002277#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002278
2279 spin_lock_irqsave(&sdev->list_lock, flags);
2280 list_add_tail(&evt->node, &sdev->event_list);
2281 schedule_work(&sdev->event_work);
2282 spin_unlock_irqrestore(&sdev->list_lock, flags);
2283}
2284EXPORT_SYMBOL_GPL(sdev_evt_send);
2285
2286/**
2287 * sdev_evt_alloc - allocate a new scsi event
2288 * @evt_type: type of event to allocate
2289 * @gfpflags: GFP flags for allocation
2290 *
2291 * Allocates and returns a new scsi_event.
2292 */
2293struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2294 gfp_t gfpflags)
2295{
2296 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2297 if (!evt)
2298 return NULL;
2299
2300 evt->evt_type = evt_type;
2301 INIT_LIST_HEAD(&evt->node);
2302
2303 /* evt_type-specific initialization, if any */
2304 switch (evt_type) {
2305 case SDEV_EVT_MEDIA_CHANGE:
2306 default:
2307 /* do nothing */
2308 break;
2309 }
2310
2311 return evt;
2312}
2313EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2314
2315/**
2316 * sdev_evt_send_simple - send asserted event to uevent thread
2317 * @sdev: scsi_device event occurred on
2318 * @evt_type: type of event to send
2319 * @gfpflags: GFP flags for allocation
2320 *
2321 * Assert scsi device event asynchronously, given an event type.
2322 */
2323void sdev_evt_send_simple(struct scsi_device *sdev,
2324 enum scsi_device_event evt_type, gfp_t gfpflags)
2325{
2326 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2327 if (!evt) {
2328 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2329 evt_type);
2330 return;
2331 }
2332
2333 sdev_evt_send(sdev, evt);
2334}
2335EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2336
2337/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 * scsi_device_quiesce - Block user issued commands.
2339 * @sdev: scsi device to quiesce.
2340 *
2341 * This works by trying to transition to the SDEV_QUIESCE state
2342 * (which must be a legal transition). When the device is in this
2343 * state, only special requests will be accepted, all others will
2344 * be deferred. Since special requests may also be requeued requests,
2345 * a successful return doesn't guarantee the device will be
2346 * totally quiescent.
2347 *
2348 * Must be called with user context, may sleep.
2349 *
2350 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002351 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352int
2353scsi_device_quiesce(struct scsi_device *sdev)
2354{
2355 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2356 if (err)
2357 return err;
2358
2359 scsi_run_queue(sdev->request_queue);
2360 while (sdev->device_busy) {
2361 msleep_interruptible(200);
2362 scsi_run_queue(sdev->request_queue);
2363 }
2364 return 0;
2365}
2366EXPORT_SYMBOL(scsi_device_quiesce);
2367
2368/**
2369 * scsi_device_resume - Restart user issued commands to a quiesced device.
2370 * @sdev: scsi device to resume.
2371 *
2372 * Moves the device from quiesced back to running and restarts the
2373 * queues.
2374 *
2375 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002376 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002377void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002379 /* check if the device state was mutated prior to resume, and if
2380 * so assume the state is being managed elsewhere (for example
2381 * device deleted during suspend)
2382 */
2383 if (sdev->sdev_state != SDEV_QUIESCE ||
2384 scsi_device_set_state(sdev, SDEV_RUNNING))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385 return;
2386 scsi_run_queue(sdev->request_queue);
2387}
2388EXPORT_SYMBOL(scsi_device_resume);
2389
2390static void
2391device_quiesce_fn(struct scsi_device *sdev, void *data)
2392{
2393 scsi_device_quiesce(sdev);
2394}
2395
2396void
2397scsi_target_quiesce(struct scsi_target *starget)
2398{
2399 starget_for_each_device(starget, NULL, device_quiesce_fn);
2400}
2401EXPORT_SYMBOL(scsi_target_quiesce);
2402
2403static void
2404device_resume_fn(struct scsi_device *sdev, void *data)
2405{
2406 scsi_device_resume(sdev);
2407}
2408
2409void
2410scsi_target_resume(struct scsi_target *starget)
2411{
2412 starget_for_each_device(starget, NULL, device_resume_fn);
2413}
2414EXPORT_SYMBOL(scsi_target_resume);
2415
2416/**
Rob Landleyeb448202007-11-03 13:30:39 -05002417 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418 * @sdev: device to block
2419 *
2420 * Block request made by scsi lld's to temporarily stop all
2421 * scsi commands on the specified device. Called from interrupt
2422 * or normal process context.
2423 *
2424 * Returns zero if successful or error if not
2425 *
2426 * Notes:
2427 * This routine transitions the device to the SDEV_BLOCK state
2428 * (which must be a legal transition). When the device is in this
2429 * state, all commands are deferred until the scsi lld reenables
2430 * the device with scsi_device_unblock or device_block_tmo fires.
Rob Landleyeb448202007-11-03 13:30:39 -05002431 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002432int
2433scsi_internal_device_block(struct scsi_device *sdev)
2434{
Jens Axboe165125e2007-07-24 09:28:11 +02002435 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436 unsigned long flags;
2437 int err = 0;
2438
2439 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002440 if (err) {
2441 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2442
2443 if (err)
2444 return err;
2445 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446
2447 /*
2448 * The device has transitioned to SDEV_BLOCK. Stop the
2449 * block layer from calling the midlayer with this device's
2450 * request queue.
2451 */
2452 spin_lock_irqsave(q->queue_lock, flags);
2453 blk_stop_queue(q);
2454 spin_unlock_irqrestore(q->queue_lock, flags);
2455
2456 return 0;
2457}
2458EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2459
2460/**
2461 * scsi_internal_device_unblock - resume a device after a block request
2462 * @sdev: device to resume
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002463 * @new_state: state to set devices to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 *
2465 * Called by scsi lld's or the midlayer to restart the device queue
2466 * for the previously suspended scsi device. Called from interrupt or
2467 * normal process context.
2468 *
2469 * Returns zero if successful or error if not.
2470 *
2471 * Notes:
2472 * This routine transitions the device to the SDEV_RUNNING state
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002473 * or to one of the offline states (which must be a legal transition)
Mike Christied0754982012-05-17 23:56:58 -05002474 * allowing the midlayer to goose the queue for this device.
Rob Landleyeb448202007-11-03 13:30:39 -05002475 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476int
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002477scsi_internal_device_unblock(struct scsi_device *sdev,
2478 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479{
Jens Axboe165125e2007-07-24 09:28:11 +02002480 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481 unsigned long flags;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002482
2483 /*
2484 * Try to transition the scsi device to SDEV_RUNNING or one of the
2485 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486 */
Vikas Chaudhary0e580762012-08-09 04:51:30 -04002487 if ((sdev->sdev_state == SDEV_BLOCK) ||
2488 (sdev->sdev_state == SDEV_TRANSPORT_OFFLINE))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002489 sdev->sdev_state = new_state;
2490 else if (sdev->sdev_state == SDEV_CREATED_BLOCK) {
2491 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2492 new_state == SDEV_OFFLINE)
2493 sdev->sdev_state = new_state;
2494 else
2495 sdev->sdev_state = SDEV_CREATED;
2496 } else if (sdev->sdev_state != SDEV_CANCEL &&
Mike Christie986fe6c2010-10-06 03:10:59 -05002497 sdev->sdev_state != SDEV_OFFLINE)
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002498 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499
2500 spin_lock_irqsave(q->queue_lock, flags);
2501 blk_start_queue(q);
2502 spin_unlock_irqrestore(q->queue_lock, flags);
2503
2504 return 0;
2505}
2506EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
2507
2508static void
2509device_block(struct scsi_device *sdev, void *data)
2510{
2511 scsi_internal_device_block(sdev);
2512}
2513
2514static int
2515target_block(struct device *dev, void *data)
2516{
2517 if (scsi_is_target_device(dev))
2518 starget_for_each_device(to_scsi_target(dev), NULL,
2519 device_block);
2520 return 0;
2521}
2522
2523void
2524scsi_target_block(struct device *dev)
2525{
2526 if (scsi_is_target_device(dev))
2527 starget_for_each_device(to_scsi_target(dev), NULL,
2528 device_block);
2529 else
2530 device_for_each_child(dev, NULL, target_block);
2531}
2532EXPORT_SYMBOL_GPL(scsi_target_block);
2533
2534static void
2535device_unblock(struct scsi_device *sdev, void *data)
2536{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002537 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538}
2539
2540static int
2541target_unblock(struct device *dev, void *data)
2542{
2543 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002544 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545 device_unblock);
2546 return 0;
2547}
2548
2549void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002550scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551{
2552 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002553 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002554 device_unblock);
2555 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002556 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557}
2558EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002559
2560/**
2561 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002562 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002563 * @sg_count: number of segments in sg
2564 * @offset: offset in bytes into sg, on return offset into the mapped area
2565 * @len: bytes to map, on return number of bytes mapped
2566 *
2567 * Returns virtual address of the start of the mapped page
2568 */
Jens Axboec6132da2007-10-16 11:08:49 +02002569void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002570 size_t *offset, size_t *len)
2571{
2572 int i;
2573 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002574 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002575 struct page *page;
2576
Andrew Morton22cfefb2007-02-05 16:39:03 -08002577 WARN_ON(!irqs_disabled());
2578
Jens Axboec6132da2007-10-16 11:08:49 +02002579 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002580 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002581 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002582 if (sg_len > *offset)
2583 break;
2584 }
2585
2586 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002587 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2588 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002589 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002590 WARN_ON(1);
2591 return NULL;
2592 }
2593
2594 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002595 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002596
2597 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002598 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002599 *offset &= ~PAGE_MASK;
2600
2601 /* Bytes in this sg-entry from *offset to the end of the page */
2602 sg_len = PAGE_SIZE - *offset;
2603 if (*len > sg_len)
2604 *len = sg_len;
2605
Cong Wang77dfce02011-11-25 23:14:23 +08002606 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002607}
2608EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2609
2610/**
Rob Landleyeb448202007-11-03 13:30:39 -05002611 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002612 * @virt: virtual address to be unmapped
2613 */
2614void scsi_kunmap_atomic_sg(void *virt)
2615{
Cong Wang77dfce02011-11-25 23:14:23 +08002616 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002617}
2618EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002619
2620void sdev_disable_disk_events(struct scsi_device *sdev)
2621{
2622 atomic_inc(&sdev->disk_events_disable_depth);
2623}
2624EXPORT_SYMBOL(sdev_disable_disk_events);
2625
2626void sdev_enable_disk_events(struct scsi_device *sdev)
2627{
2628 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2629 return;
2630 atomic_dec(&sdev->disk_events_disable_depth);
2631}
2632EXPORT_SYMBOL(sdev_enable_disk_events);