blob: 492071ca45d1c5b12381c7d3c852a1e5838eaacd [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
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800388static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600390 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800391 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 unsigned long flags;
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600395 list_splice_init(&shost->starved_list, &starved_list);
396
397 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200398 struct request_queue *slq;
399
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 /*
401 * As long as shost is accepting commands and we have
402 * starved queues, call blk_run_queue. scsi_request_fn
403 * drops the queue_lock and can add us back to the
404 * starved_list.
405 *
406 * host_lock protects the starved_list and starved_entry.
407 * scsi_request_fn must get the host_lock before checking
408 * or modifying starved_list or starved_entry.
409 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600410 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500411 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500412
Mike Christie2a3a59e2008-11-11 13:42:35 -0600413 sdev = list_entry(starved_list.next,
414 struct scsi_device, starved_entry);
415 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500416 if (scsi_target_is_busy(scsi_target(sdev))) {
417 list_move_tail(&sdev->starved_entry,
418 &shost->starved_list);
419 continue;
420 }
421
James Bottomleye2eb7242013-07-02 15:05:26 +0200422 /*
423 * Once we drop the host lock, a racing scsi_remove_device()
424 * call may remove the sdev from the starved list and destroy
425 * it and the queue. Mitigate by taking a reference to the
426 * queue and never touching the sdev again after we drop the
427 * host lock. Note: if __scsi_remove_device() invokes
428 * blk_cleanup_queue() before the queue is run from this
429 * function then blk_run_queue() will return immediately since
430 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
431 */
432 slq = sdev->request_queue;
433 if (!blk_get_queue(slq))
434 continue;
435 spin_unlock_irqrestore(shost->host_lock, flags);
436
437 blk_run_queue(slq);
438 blk_put_queue(slq);
439
440 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600442 /* put any unprocessed entries back */
443 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800445}
446
447/*
448 * Function: scsi_run_queue()
449 *
450 * Purpose: Select a proper request queue to serve next
451 *
452 * Arguments: q - last request's queue
453 *
454 * Returns: Nothing
455 *
456 * Notes: The previous command was completely finished, start
457 * a new one if possible.
458 */
459static void scsi_run_queue(struct request_queue *q)
460{
461 struct scsi_device *sdev = q->queuedata;
462
463 if (scsi_target(sdev)->single_lun)
464 scsi_single_lun_run(sdev);
465 if (!list_empty(&sdev->host->starved_list))
466 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
468 blk_run_queue(q);
469}
470
Jens Axboe9937a5e2011-05-17 11:04:44 +0200471void scsi_requeue_run_queue(struct work_struct *work)
472{
473 struct scsi_device *sdev;
474 struct request_queue *q;
475
476 sdev = container_of(work, struct scsi_device, requeue_work);
477 q = sdev->request_queue;
478 scsi_run_queue(q);
479}
480
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481/*
482 * Function: scsi_requeue_command()
483 *
484 * Purpose: Handle post-processing of completed commands.
485 *
486 * Arguments: q - queue to operate on
487 * cmd - command that may need to be requeued.
488 *
489 * Returns: Nothing
490 *
491 * Notes: After command completion, there may be blocks left
492 * over which weren't finished by the previous command
493 * this can be for a number of reasons - the main one is
494 * I/O errors in the middle of the request, in which case
495 * we need to request the blocks that come after the bad
496 * sector.
James Bottomleye91442b2005-09-09 10:44:16 -0500497 * Notes: Upon return, cmd is a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 */
499static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
500{
Bart Van Assche940f5d42012-06-29 15:34:26 +0000501 struct scsi_device *sdev = cmd->device;
James Bottomleye91442b2005-09-09 10:44:16 -0500502 struct request *req = cmd->request;
Tejun Heo 283369c2005-04-24 02:06:36 -0500503 unsigned long flags;
504
Bart Van Assche940f5d42012-06-29 15:34:26 +0000505 /*
506 * We need to hold a reference on the device to avoid the queue being
507 * killed after the unlock and before scsi_run_queue is invoked which
508 * may happen because scsi_unprep_request() puts the command which
509 * releases its reference on the device.
510 */
511 get_device(&sdev->sdev_gendev);
512
Tejun Heo 283369c2005-04-24 02:06:36 -0500513 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley02bd3492008-12-12 13:28:29 -0600514 scsi_unprep_request(req);
James Bottomleye91442b2005-09-09 10:44:16 -0500515 blk_requeue_request(q, req);
Tejun Heo 283369c2005-04-24 02:06:36 -0500516 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518 scsi_run_queue(q);
Bart Van Assche940f5d42012-06-29 15:34:26 +0000519
520 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521}
522
523void scsi_next_command(struct scsi_cmnd *cmd)
524{
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800525 struct scsi_device *sdev = cmd->device;
526 struct request_queue *q = sdev->request_queue;
527
528 /* need to hold a reference on the device before we let go of the cmd */
529 get_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
531 scsi_put_command(cmd);
532 scsi_run_queue(q);
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800533
534 /* ok to remove device now */
535 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536}
537
538void scsi_run_host_queues(struct Scsi_Host *shost)
539{
540 struct scsi_device *sdev;
541
542 shost_for_each_device(sdev, shost)
543 scsi_run_queue(sdev->request_queue);
544}
545
James Bottomley79ed2422009-01-06 13:15:20 -0600546static void __scsi_release_buffers(struct scsi_cmnd *, int);
547
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548/*
549 * Function: scsi_end_request()
550 *
551 * Purpose: Post-processing of completed commands (usually invoked at end
552 * of upper level post-processing and scsi_io_completion).
553 *
554 * Arguments: cmd - command that is complete.
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500555 * error - 0 if I/O indicates success, < 0 for I/O error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 * bytes - number of bytes of completed I/O
557 * requeue - indicates whether we should requeue leftovers.
558 *
559 * Lock status: Assumed that lock is not held upon entry.
560 *
James Bottomleye91442b2005-09-09 10:44:16 -0500561 * Returns: cmd if requeue required, NULL otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 *
563 * Notes: This is called for block device requests in order to
564 * mark some number of sectors as complete.
565 *
566 * We are guaranteeing that the request queue will be goosed
567 * at some point during this call.
James Bottomleye91442b2005-09-09 10:44:16 -0500568 * Notes: If cmd was requeued, upon return it will be a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 */
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500570static struct scsi_cmnd *scsi_end_request(struct scsi_cmnd *cmd, int error,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 int bytes, int requeue)
572{
Jens Axboe165125e2007-07-24 09:28:11 +0200573 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 struct request *req = cmd->request;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
576 /*
577 * If there are blocks left over at the end, set up the command
578 * to queue the remainder of them.
579 */
Kiyoshi Ueda610d8b02007-12-11 17:52:09 -0500580 if (blk_end_request(req, error, bytes)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 /* kill remainder if no retrys */
Mike Christie4a274462008-08-19 18:45:31 -0500582 if (error && scsi_noretry_cmd(cmd))
Tejun Heoe4588242009-05-12 08:49:32 +0200583 blk_end_request_all(req, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 else {
James Bottomleye91442b2005-09-09 10:44:16 -0500585 if (requeue) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 /*
587 * Bleah. Leftovers again. Stick the
588 * leftovers in the front of the
589 * queue, and goose the queue again.
590 */
James Bottomley79ed2422009-01-06 13:15:20 -0600591 scsi_release_buffers(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 scsi_requeue_command(q, cmd);
James Bottomleye91442b2005-09-09 10:44:16 -0500593 cmd = NULL;
594 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 return cmd;
596 }
597 }
598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 /*
600 * This will goose the queue request function at the end, so we don't
601 * need to worry about launching another command.
602 */
James Bottomley79ed2422009-01-06 13:15:20 -0600603 __scsi_release_buffers(cmd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 scsi_next_command(cmd);
605 return NULL;
606}
607
Jens Axboea8474ce2007-08-07 09:02:51 +0200608static inline unsigned int scsi_sgtable_index(unsigned short nents)
609{
610 unsigned int index;
611
James Bottomleyd3f46f32008-01-15 11:11:46 -0600612 BUG_ON(nents > SCSI_MAX_SG_SEGMENTS);
613
614 if (nents <= 8)
Jens Axboea8474ce2007-08-07 09:02:51 +0200615 index = 0;
James Bottomleyd3f46f32008-01-15 11:11:46 -0600616 else
617 index = get_count_order(nents) - 3;
Jens Axboea8474ce2007-08-07 09:02:51 +0200618
619 return index;
620}
621
Jens Axboe5ed79592007-11-15 09:13:11 +0100622static void scsi_sg_free(struct scatterlist *sgl, unsigned int nents)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623{
624 struct scsi_host_sg_pool *sgp;
Jens Axboe5ed79592007-11-15 09:13:11 +0100625
626 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
627 mempool_free(sgl, sgp->pool);
628}
629
630static struct scatterlist *scsi_sg_alloc(unsigned int nents, gfp_t gfp_mask)
631{
632 struct scsi_host_sg_pool *sgp;
633
634 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
635 return mempool_alloc(sgp->pool, gfp_mask);
636}
637
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200638static int scsi_alloc_sgtable(struct scsi_data_buffer *sdb, int nents,
639 gfp_t gfp_mask)
Jens Axboe5ed79592007-11-15 09:13:11 +0100640{
641 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200643 BUG_ON(!nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200645 ret = __sg_alloc_table(&sdb->table, nents, SCSI_MAX_SG_SEGMENTS,
646 gfp_mask, scsi_sg_alloc);
Jens Axboe5ed79592007-11-15 09:13:11 +0100647 if (unlikely(ret))
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200648 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS,
James Bottomley7cedb1f2008-01-13 14:15:28 -0600649 scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Jens Axboea8474ce2007-08-07 09:02:51 +0200651 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652}
653
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200654static void scsi_free_sgtable(struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200656 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS, scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657}
658
James Bottomley79ed2422009-01-06 13:15:20 -0600659static void __scsi_release_buffers(struct scsi_cmnd *cmd, int do_bidi_check)
660{
661
662 if (cmd->sdb.table.nents)
663 scsi_free_sgtable(&cmd->sdb);
664
665 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
666
667 if (do_bidi_check && scsi_bidi_cmnd(cmd)) {
668 struct scsi_data_buffer *bidi_sdb =
669 cmd->request->next_rq->special;
670 scsi_free_sgtable(bidi_sdb);
671 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
672 cmd->request->next_rq->special = NULL;
673 }
674
675 if (scsi_prot_sg_count(cmd))
676 scsi_free_sgtable(cmd->prot_sdb);
677}
678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679/*
680 * Function: scsi_release_buffers()
681 *
682 * Purpose: Completion processing for block device I/O requests.
683 *
684 * Arguments: cmd - command that we are bailing.
685 *
686 * Lock status: Assumed that no lock is held upon entry.
687 *
688 * Returns: Nothing
689 *
690 * Notes: In the event that an upper level driver rejects a
691 * command, we must release resources allocated during
692 * the __init_io() function. Primarily this would involve
693 * the scatter-gather table, and potentially any bounce
694 * buffers.
695 */
Boaz Harroshbb52d822007-12-13 16:14:27 -0800696void scsi_release_buffers(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697{
James Bottomley79ed2422009-01-06 13:15:20 -0600698 __scsi_release_buffers(cmd, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699}
Boaz Harroshbb52d822007-12-13 16:14:27 -0800700EXPORT_SYMBOL(scsi_release_buffers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200702/**
703 * __scsi_error_from_host_byte - translate SCSI error code into errno
704 * @cmd: SCSI command (unused)
705 * @result: scsi error code
706 *
707 * Translate SCSI error code into standard UNIX errno.
708 * Return values:
709 * -ENOLINK temporary transport failure
710 * -EREMOTEIO permanent target failure, do not retry
711 * -EBADE permanent nexus failure, retry on other path
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200712 * -ENOSPC No write space available
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200713 * -ENODATA Medium error
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200714 * -EIO unspecified I/O error
715 */
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100716static int __scsi_error_from_host_byte(struct scsi_cmnd *cmd, int result)
717{
718 int error = 0;
719
720 switch(host_byte(result)) {
721 case DID_TRANSPORT_FAILFAST:
722 error = -ENOLINK;
723 break;
724 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000725 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100726 error = -EREMOTEIO;
727 break;
728 case DID_NEXUS_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000729 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100730 error = -EBADE;
731 break;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200732 case DID_ALLOC_FAILURE:
733 set_host_byte(cmd, DID_OK);
734 error = -ENOSPC;
735 break;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200736 case DID_MEDIUM_ERROR:
737 set_host_byte(cmd, DID_OK);
738 error = -ENODATA;
739 break;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100740 default:
741 error = -EIO;
742 break;
743 }
744
745 return error;
746}
747
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748/*
749 * Function: scsi_io_completion()
750 *
751 * Purpose: Completion processing for block device I/O requests.
752 *
753 * Arguments: cmd - command that is finished.
754 *
755 * Lock status: Assumed that no lock is held upon entry.
756 *
757 * Returns: Nothing
758 *
759 * Notes: This function is matched in terms of capabilities to
760 * the function that created the scatter-gather list.
761 * In other words, if there are no bounce buffers
762 * (the normal case for most drivers), we don't need
763 * the logic to deal with cleaning up afterwards.
764 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500765 * We must call scsi_end_request(). This will finish off
766 * the specified number of sectors. If we are done, the
767 * command block will be released and the queue function
768 * will be goosed. If we are not done then we have to
769 * figure out what to do next:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500771 * a) We can call scsi_requeue_command(). The request
772 * will be unprepared and put back on the queue. Then
773 * a new command will be created for it. This should
774 * be used if we made forward progress, or if we want
775 * to switch from READ(10) to READ(6) for example.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500777 * b) We can call scsi_queue_insert(). The request will
778 * be put back on the queue and retried using the same
779 * command as before, possibly after a delay.
780 *
781 * c) We can call blk_end_request() with -EIO to fail
782 * the remainder of the request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 */
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700784void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785{
786 int result = cmd->result;
Jens Axboe165125e2007-07-24 09:28:11 +0200787 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 struct request *req = cmd->request;
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500789 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 struct scsi_sense_hdr sshdr;
791 int sense_valid = 0;
792 int sense_deferred = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500793 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
794 ACTION_DELAYED_RETRY} action;
795 char *description = NULL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900796 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 if (result) {
799 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
800 if (sense_valid)
801 sense_deferred = scsi_sense_is_deferred(&sshdr);
802 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200803
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200804 if (req->cmd_type == REQ_TYPE_BLOCK_PC) { /* SG_IO ioctl from block level */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 if (sense_valid && req->sense) {
807 /*
808 * SG_IO wants current and deferred errors
809 */
810 int len = 8 + cmd->sense_buffer[7];
811
812 if (len > SCSI_SENSE_BUFFERSIZE)
813 len = SCSI_SENSE_BUFFERSIZE;
814 memcpy(req->sense, cmd->sense_buffer, len);
815 req->sense_len = len;
816 }
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500817 if (!sense_deferred)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100818 error = __scsi_error_from_host_byte(cmd, result);
Pete Wyckoffb22f6872007-03-13 16:53:28 -0400819 }
Mike Snitzer27c41972012-05-31 15:05:33 -0400820 /*
821 * __scsi_error_from_host_byte may have reset the host_byte
822 */
823 req->errors = cmd->result;
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900824
825 req->resid_len = scsi_get_resid(cmd);
826
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200827 if (scsi_bidi_cmnd(cmd)) {
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900828 /*
829 * Bidi commands Must be complete as a whole,
830 * both sides at once.
831 */
832 req->next_rq->resid_len = scsi_in(cmd)->resid;
833
Boaz Harrosh63c43b02009-12-15 17:25:43 +0200834 scsi_release_buffers(cmd);
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900835 blk_end_request_all(req, 0);
836
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900837 scsi_next_command(cmd);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200838 return;
839 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 }
841
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200842 /* no bidi support for !REQ_TYPE_BLOCK_PC yet */
843 BUG_ON(blk_bidi_rq(req));
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200844
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 * Next deal with any sectors which we were able to correctly
847 * handle.
848 */
Tejun Heo83096eb2009-05-07 22:24:39 +0900849 SCSI_LOG_HLCOMPLETE(1, printk("%u sectors total, "
James Bottomleyd6b0c532006-07-02 10:06:28 -0500850 "%d bytes done.\n",
Tejun Heo83096eb2009-05-07 22:24:39 +0900851 blk_rq_sectors(req), good_bytes));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852
James Bottomleya9bddd72009-03-30 16:55:51 +0000853 /*
854 * Recovered errors need reporting, but they're always treated
855 * as success, so fiddle the result code here. For BLOCK_PC
856 * we already took a copy of the original into rq->errors which
857 * is what gets returned to the user
858 */
Douglas Gilberte7efe592010-01-03 13:51:15 -0500859 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
860 /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
861 * print since caller wants ATA registers. Only occurs on
862 * SCSI ATA PASS_THROUGH commands when CK_COND=1
863 */
864 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
865 ;
866 else if (!(req->cmd_flags & REQ_QUIET))
James Bottomleya9bddd72009-03-30 16:55:51 +0000867 scsi_print_sense("", cmd);
868 result = 0;
869 /* BLOCK_PC may have set error */
870 error = 0;
871 }
872
873 /*
874 * A number of bytes were successfully read. If there
James Bottomleyd6b0c532006-07-02 10:06:28 -0500875 * are leftovers and there is some kind of error
876 * (result != 0), retry the rest.
877 */
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500878 if (scsi_end_request(cmd, error, good_bytes, result == 0) == NULL)
James Bottomleyd6b0c532006-07-02 10:06:28 -0500879 return;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700880
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100881 error = __scsi_error_from_host_byte(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500882
Alan Sternb60af5b2008-11-03 15:56:47 -0500883 if (host_byte(result) == DID_RESET) {
884 /* Third party bus reset or reset for error recovery
885 * reasons. Just retry the command and see what
886 * happens.
887 */
888 action = ACTION_RETRY;
889 } else if (sense_valid && !sense_deferred) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 switch (sshdr.sense_key) {
891 case UNIT_ATTENTION:
892 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700893 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 * and quietly refuse further access.
895 */
896 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500897 description = "Media Changed";
898 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700900 /* Must have been a power glitch, or a
901 * bus reset. Could not have been a
902 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500903 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700904 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500905 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 }
907 break;
908 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700909 /* If we had an ILLEGAL REQUEST returned, then
910 * we may have performed an unsupported
911 * command. The only thing this should be
912 * would be a ten byte read where only a six
913 * byte read was supported. Also, on a system
914 * where READ CAPACITY failed, we may have
915 * read past the end of the disk.
916 */
Jens Axboe26a68012005-11-29 21:03:34 +0100917 if ((cmd->device->use_10_for_rw &&
918 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 (cmd->cmnd[0] == READ_10 ||
920 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500921 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500923 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500924 } else if (sshdr.asc == 0x10) /* DIX */ {
925 description = "Host Data Integrity Failure";
926 action = ACTION_FAIL;
927 error = -EILSEQ;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500928 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400929 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
930 switch (cmd->cmnd[0]) {
931 case UNMAP:
932 description = "Discard failure";
933 break;
934 case WRITE_SAME:
935 case WRITE_SAME_16:
936 if (cmd->cmnd[1] & 0x8)
937 description = "Discard failure";
938 else
939 description =
940 "Write same failure";
941 break;
942 default:
943 description = "Invalid command failure";
944 break;
945 }
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500946 action = ACTION_FAIL;
Martin K. Petersen66a651a2012-02-13 15:38:22 -0500947 error = -EREMOTEIO;
Alan Sternb60af5b2008-11-03 15:56:47 -0500948 } else
949 action = ACTION_FAIL;
950 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400951 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000952 action = ACTION_FAIL;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400953 if (sshdr.asc == 0x10) { /* DIF */
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500954 description = "Target Data Integrity Failure";
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500955 error = -EILSEQ;
James Bottomley126c09822009-02-19 21:48:54 +0000956 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 break;
958 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700959 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500960 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500962 if (sshdr.asc == 0x04) {
963 switch (sshdr.ascq) {
964 case 0x01: /* becoming ready */
965 case 0x04: /* format in progress */
966 case 0x05: /* rebuild in progress */
967 case 0x06: /* recalculation in progress */
968 case 0x07: /* operation in progress */
969 case 0x08: /* Long write in progress */
970 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500971 case 0x14: /* space allocation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500972 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500973 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500974 default:
975 description = "Device not ready";
976 action = ACTION_FAIL;
977 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500978 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500979 } else {
980 description = "Device not ready";
981 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500983 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700985 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500986 action = ACTION_FAIL;
987 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500989 description = "Unhandled sense code";
990 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 break;
992 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500993 } else {
994 description = "Unhandled error code";
995 action = ACTION_FAIL;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700996 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500997
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900998 if (action != ACTION_FAIL &&
999 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1000 action = ACTION_FAIL;
1001 description = "Command timed out";
1002 }
1003
Alan Sternb60af5b2008-11-03 15:56:47 -05001004 switch (action) {
1005 case ACTION_FAIL:
1006 /* Give up and fail the remainder of the request */
James Bottomley79ed2422009-01-06 13:15:20 -06001007 scsi_release_buffers(cmd);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001008 if (!(req->cmd_flags & REQ_QUIET)) {
Alan Sternb60af5b2008-11-03 15:56:47 -05001009 if (description)
Alan Stern3dbf6a52008-12-15 10:31:28 -05001010 scmd_printk(KERN_INFO, cmd, "%s\n",
Alan Sternb60af5b2008-11-03 15:56:47 -05001011 description);
Martin K. Petersena4d04a42007-02-27 22:40:27 -05001012 scsi_print_result(cmd);
James Bottomley3173d8c2005-09-04 11:32:05 -05001013 if (driver_byte(result) & DRIVER_SENSE)
1014 scsi_print_sense("", cmd);
Martin K. Petersen002b1eb2009-05-23 11:45:07 -04001015 scsi_print_command(cmd);
James Bottomley3173d8c2005-09-04 11:32:05 -05001016 }
Mike Christiead630822009-09-28 15:50:52 -05001017 if (blk_end_request_err(req, error))
Tejun Heoda6c5c72009-09-11 14:26:40 +02001018 scsi_requeue_command(q, cmd);
1019 else
1020 scsi_next_command(cmd);
Alan Sternb60af5b2008-11-03 15:56:47 -05001021 break;
1022 case ACTION_REPREP:
1023 /* Unprep the request and put it back at the head of the queue.
1024 * A new command will be prepared and issued.
1025 */
James Bottomley79ed2422009-01-06 13:15:20 -06001026 scsi_release_buffers(cmd);
Alan Sternb60af5b2008-11-03 15:56:47 -05001027 scsi_requeue_command(q, cmd);
1028 break;
1029 case ACTION_RETRY:
1030 /* Retry the same command immediately */
James Bottomley4f5299a2009-01-02 10:42:21 -06001031 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001032 break;
1033 case ACTION_DELAYED_RETRY:
1034 /* Retry the same command after a delay */
James Bottomley4f5299a2009-01-02 10:42:21 -06001035 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -05001036 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 }
1038}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001040static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb,
1041 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001043 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044
1045 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001046 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001048 if (unlikely(scsi_alloc_sgtable(sdb, req->nr_phys_segments,
1049 gfp_mask))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 return BLKPREP_DEFER;
Alan Stern7c72ce82005-10-14 11:23:27 -04001051 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052
Christoph Hellwig3b003152006-11-04 20:10:55 +01001053 req->buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054
1055 /*
1056 * Next, walk the list, and fill in the addresses and sizes of
1057 * each segment.
1058 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001059 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
1060 BUG_ON(count > sdb->table.nents);
1061 sdb->table.nents = count;
Tejun Heo1011c1b2009-05-07 22:24:45 +09001062 sdb->length = blk_rq_bytes(req);
Rusty Russell4a03d902007-11-19 11:28:48 +11001063 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001065
1066/*
1067 * Function: scsi_init_io()
1068 *
1069 * Purpose: SCSI I/O initialize function.
1070 *
1071 * Arguments: cmd - Command descriptor we wish to initialize
1072 *
1073 * Returns: 0 on success
1074 * BLKPREP_DEFER if the failure is retryable
1075 * BLKPREP_KILL if the failure is fatal
1076 */
1077int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask)
1078{
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001079 struct request *rq = cmd->request;
1080
1081 int error = scsi_init_sgtable(rq, &cmd->sdb, gfp_mask);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001082 if (error)
1083 goto err_exit;
1084
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001085 if (blk_bidi_rq(rq)) {
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001086 struct scsi_data_buffer *bidi_sdb = kmem_cache_zalloc(
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001087 scsi_sdb_cache, GFP_ATOMIC);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001088 if (!bidi_sdb) {
1089 error = BLKPREP_DEFER;
1090 goto err_exit;
1091 }
1092
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001093 rq->next_rq->special = bidi_sdb;
1094 error = scsi_init_sgtable(rq->next_rq, bidi_sdb, GFP_ATOMIC);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001095 if (error)
1096 goto err_exit;
1097 }
1098
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001099 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001100 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1101 int ivecs, count;
1102
1103 BUG_ON(prot_sdb == NULL);
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001104 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001105
1106 if (scsi_alloc_sgtable(prot_sdb, ivecs, gfp_mask)) {
1107 error = BLKPREP_DEFER;
1108 goto err_exit;
1109 }
1110
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001111 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001112 prot_sdb->table.sgl);
1113 BUG_ON(unlikely(count > ivecs));
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001114 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001115
1116 cmd->prot_sdb = prot_sdb;
1117 cmd->prot_sdb->table.nents = count;
1118 }
1119
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001120 return BLKPREP_OK ;
1121
1122err_exit:
1123 scsi_release_buffers(cmd);
FUJITA Tomonori610a6342010-07-08 10:16:17 +02001124 cmd->request->special = NULL;
James Bottomley3a5c19c2010-08-16 10:06:26 -05001125 scsi_put_command(cmd);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001126 return error;
1127}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001128EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129
Christoph Hellwig3b003152006-11-04 20:10:55 +01001130static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
1131 struct request *req)
1132{
1133 struct scsi_cmnd *cmd;
1134
1135 if (!req->special) {
1136 cmd = scsi_get_command(sdev, GFP_ATOMIC);
1137 if (unlikely(!cmd))
1138 return NULL;
1139 req->special = cmd;
1140 } else {
1141 cmd = req->special;
1142 }
1143
1144 /* pull a tag out of the request if we have one */
1145 cmd->tag = req->tag;
1146 cmd->request = req;
1147
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001148 cmd->cmnd = req->cmd;
Martin K. Petersen72f7d322011-03-08 02:03:59 -05001149 cmd->prot_op = SCSI_PROT_NORMAL;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001150
Christoph Hellwig3b003152006-11-04 20:10:55 +01001151 return cmd;
1152}
1153
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001154int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001155{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001156 struct scsi_cmnd *cmd;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001157 int ret = scsi_prep_state_check(sdev, req);
1158
1159 if (ret != BLKPREP_OK)
1160 return ret;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001161
1162 cmd = scsi_get_cmd_from_req(sdev, req);
1163 if (unlikely(!cmd))
1164 return BLKPREP_DEFER;
1165
1166 /*
1167 * BLOCK_PC requests may transfer data, in which case they must
1168 * a bio attached to them. Or they might contain a SCSI command
1169 * that does not transfer data, in which case they may optionally
1170 * submit a request without an attached bio.
1171 */
1172 if (req->bio) {
1173 int ret;
1174
1175 BUG_ON(!req->nr_phys_segments);
1176
Boaz Harroshbb52d822007-12-13 16:14:27 -08001177 ret = scsi_init_io(cmd, GFP_ATOMIC);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001178 if (unlikely(ret))
1179 return ret;
1180 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001181 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001182
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001183 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001184 req->buffer = NULL;
1185 }
James Bottomley7b163182005-12-15 20:17:02 -06001186
James Bottomley7b163182005-12-15 20:17:02 -06001187 cmd->cmd_len = req->cmd_len;
Tejun Heob0790412009-05-07 22:24:42 +09001188 if (!blk_rq_bytes(req))
James Bottomley7b163182005-12-15 20:17:02 -06001189 cmd->sc_data_direction = DMA_NONE;
1190 else if (rq_data_dir(req) == WRITE)
1191 cmd->sc_data_direction = DMA_TO_DEVICE;
1192 else
1193 cmd->sc_data_direction = DMA_FROM_DEVICE;
1194
Tejun Heob0790412009-05-07 22:24:42 +09001195 cmd->transfersize = blk_rq_bytes(req);
James Bottomley7b163182005-12-15 20:17:02 -06001196 cmd->allowed = req->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001197 return BLKPREP_OK;
1198}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001199EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001200
1201/*
1202 * Setup a REQ_TYPE_FS command. These are simple read/write request
1203 * from filesystems that still need to be translated to SCSI CDBs from
1204 * the ULD.
1205 */
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001206int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001207{
1208 struct scsi_cmnd *cmd;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001209 int ret = scsi_prep_state_check(sdev, req);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001210
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001211 if (ret != BLKPREP_OK)
1212 return ret;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001213
1214 if (unlikely(sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh
1215 && sdev->scsi_dh_data->scsi_dh->prep_fn)) {
1216 ret = sdev->scsi_dh_data->scsi_dh->prep_fn(sdev, req);
1217 if (ret != BLKPREP_OK)
1218 return ret;
1219 }
1220
Christoph Hellwig3b003152006-11-04 20:10:55 +01001221 /*
1222 * Filesystem requests must transfer data.
1223 */
1224 BUG_ON(!req->nr_phys_segments);
1225
1226 cmd = scsi_get_cmd_from_req(sdev, req);
1227 if (unlikely(!cmd))
1228 return BLKPREP_DEFER;
1229
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001230 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Boaz Harroshbb52d822007-12-13 16:14:27 -08001231 return scsi_init_io(cmd, GFP_ATOMIC);
James Bottomley7b163182005-12-15 20:17:02 -06001232}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001233EXPORT_SYMBOL(scsi_setup_fs_cmnd);
James Bottomley7b163182005-12-15 20:17:02 -06001234
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001235int scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001237 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
1239 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001240 * If the device is not in running state we will reject some
1241 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001244 switch (sdev->sdev_state) {
1245 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05001246 case SDEV_TRANSPORT_OFFLINE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001247 /*
1248 * If the device is offline we refuse to process any
1249 * commands. The device must be brought online
1250 * before trying any recovery commands.
1251 */
1252 sdev_printk(KERN_ERR, sdev,
1253 "rejecting I/O to offline device\n");
1254 ret = BLKPREP_KILL;
1255 break;
1256 case SDEV_DEL:
1257 /*
1258 * If the device is fully deleted, we refuse to
1259 * process any commands as well.
1260 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001261 sdev_printk(KERN_ERR, sdev,
1262 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001263 ret = BLKPREP_KILL;
1264 break;
1265 case SDEV_QUIESCE:
1266 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001267 case SDEV_CREATED_BLOCK:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001268 /*
1269 * If the devices is blocked we defer normal commands.
1270 */
1271 if (!(req->cmd_flags & REQ_PREEMPT))
1272 ret = BLKPREP_DEFER;
1273 break;
1274 default:
1275 /*
1276 * For any other not fully online state we only allow
1277 * special commands. In particular any user initiated
1278 * command is not allowed.
1279 */
1280 if (!(req->cmd_flags & REQ_PREEMPT))
1281 ret = BLKPREP_KILL;
1282 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001285 return ret;
1286}
1287EXPORT_SYMBOL(scsi_prep_state_check);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001289int scsi_prep_return(struct request_queue *q, struct request *req, int ret)
1290{
1291 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
Christoph Hellwig3b003152006-11-04 20:10:55 +01001293 switch (ret) {
1294 case BLKPREP_KILL:
1295 req->errors = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001296 /* release the command and kill it */
1297 if (req->special) {
1298 struct scsi_cmnd *cmd = req->special;
1299 scsi_release_buffers(cmd);
1300 scsi_put_command(cmd);
1301 req->special = NULL;
1302 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001303 break;
1304 case BLKPREP_DEFER:
1305 /*
Tejun Heo9934c8c2009-05-08 11:54:16 +09001306 * If we defer, the blk_peek_request() returns NULL, but the
Jens Axboea488e742010-04-16 21:13:15 +02001307 * queue must be restarted, so we schedule a callback to happen
1308 * shortly.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001309 */
1310 if (sdev->device_busy == 0)
Jens Axboea488e742010-04-16 21:13:15 +02001311 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001312 break;
1313 default:
1314 req->cmd_flags |= REQ_DONTPREP;
1315 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
Christoph Hellwig3b003152006-11-04 20:10:55 +01001317 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001319EXPORT_SYMBOL(scsi_prep_return);
1320
James Bottomley751bf4d2008-01-02 11:14:30 -06001321int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001322{
1323 struct scsi_device *sdev = q->queuedata;
1324 int ret = BLKPREP_KILL;
1325
1326 if (req->cmd_type == REQ_TYPE_BLOCK_PC)
1327 ret = scsi_setup_blk_pc_cmnd(sdev, req);
1328 return scsi_prep_return(q, req, ret);
1329}
Hannes Reineckeb3912772009-06-18 09:57:18 +02001330EXPORT_SYMBOL(scsi_prep_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331
1332/*
1333 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1334 * return 0.
1335 *
1336 * Called with the queue_lock held.
1337 */
1338static inline int scsi_dev_queue_ready(struct request_queue *q,
1339 struct scsi_device *sdev)
1340{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 if (sdev->device_busy == 0 && sdev->device_blocked) {
1342 /*
1343 * unblock after device_blocked iterates to zero
1344 */
1345 if (--sdev->device_blocked == 0) {
1346 SCSI_LOG_MLQUEUE(3,
James Bottomley9ccfc752005-10-02 11:45:08 -05001347 sdev_printk(KERN_INFO, sdev,
1348 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 } else {
Jens Axboea488e742010-04-16 21:13:15 +02001350 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 return 0;
1352 }
1353 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001354 if (scsi_device_is_busy(sdev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 return 0;
1356
1357 return 1;
1358}
1359
Mike Christief0c0a372008-08-17 15:24:38 -05001360
1361/*
1362 * scsi_target_queue_ready: checks if there we can send commands to target
1363 * @sdev: scsi device on starget to check.
1364 *
1365 * Called with the host lock held.
1366 */
1367static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1368 struct scsi_device *sdev)
1369{
1370 struct scsi_target *starget = scsi_target(sdev);
1371
1372 if (starget->single_lun) {
1373 if (starget->starget_sdev_user &&
1374 starget->starget_sdev_user != sdev)
1375 return 0;
1376 starget->starget_sdev_user = sdev;
1377 }
1378
1379 if (starget->target_busy == 0 && starget->target_blocked) {
1380 /*
1381 * unblock after target_blocked iterates to zero
1382 */
1383 if (--starget->target_blocked == 0) {
1384 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1385 "unblocking target at zero depth\n"));
Mike Christieb4efdd52009-04-09 15:57:10 -05001386 } else
Mike Christief0c0a372008-08-17 15:24:38 -05001387 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001388 }
1389
1390 if (scsi_target_is_busy(starget)) {
Shaohua Li466c08c2012-01-10 11:27:01 +08001391 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Hillf Dantonfd01a662010-12-16 14:26:37 -06001392 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001393 }
1394
Mike Christief0c0a372008-08-17 15:24:38 -05001395 return 1;
1396}
1397
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398/*
1399 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1400 * return 0. We must end up running the queue again whenever 0 is
1401 * returned, else IO can hang.
1402 *
1403 * Called with host_lock held.
1404 */
1405static inline int scsi_host_queue_ready(struct request_queue *q,
1406 struct Scsi_Host *shost,
1407 struct scsi_device *sdev)
1408{
James Bottomley939647e2005-09-18 15:05:20 -05001409 if (scsi_host_in_recovery(shost))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 return 0;
1411 if (shost->host_busy == 0 && shost->host_blocked) {
1412 /*
1413 * unblock after host_blocked iterates to zero
1414 */
1415 if (--shost->host_blocked == 0) {
1416 SCSI_LOG_MLQUEUE(3,
1417 printk("scsi%d unblocking host at zero depth\n",
1418 shost->host_no));
1419 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 return 0;
1421 }
1422 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001423 if (scsi_host_is_busy(shost)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 if (list_empty(&sdev->starved_entry))
1425 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1426 return 0;
1427 }
1428
1429 /* We're OK to process the command, so we can't be starved */
1430 if (!list_empty(&sdev->starved_entry))
1431 list_del_init(&sdev->starved_entry);
1432
1433 return 1;
1434}
1435
1436/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001437 * Busy state exporting function for request stacking drivers.
1438 *
1439 * For efficiency, no lock is taken to check the busy state of
1440 * shost/starget/sdev, since the returned value is not guaranteed and
1441 * may be changed after request stacking drivers call the function,
1442 * regardless of taking lock or not.
1443 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001444 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1445 * needs to return 'not busy'. Otherwise, request stacking drivers
1446 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001447 */
1448static int scsi_lld_busy(struct request_queue *q)
1449{
1450 struct scsi_device *sdev = q->queuedata;
1451 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001452
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001453 if (blk_queue_dying(q))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001454 return 0;
1455
1456 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001457
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001458 /*
1459 * Ignore host/starget busy state.
1460 * Since block layer does not have a concept of fairness across
1461 * multiple queues, congestion of host/starget needs to be handled
1462 * in SCSI layer.
1463 */
1464 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001465 return 1;
1466
1467 return 0;
1468}
1469
1470/*
James Bottomleye91442b2005-09-09 10:44:16 -05001471 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 */
Jens Axboe165125e2007-07-24 09:28:11 +02001473static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474{
James Bottomleye91442b2005-09-09 10:44:16 -05001475 struct scsi_cmnd *cmd = req->special;
Jiri Slaby03b14702009-09-23 16:15:35 +02001476 struct scsi_device *sdev;
1477 struct scsi_target *starget;
1478 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
Tejun Heo9934c8c2009-05-08 11:54:16 +09001480 blk_start_request(req);
James Bottomley788ce432005-09-09 13:40:23 -05001481
Hannes Reinecke74571812011-11-09 08:39:24 +01001482 scmd_printk(KERN_INFO, cmd, "killing request\n");
1483
Jiri Slaby03b14702009-09-23 16:15:35 +02001484 sdev = cmd->device;
1485 starget = scsi_target(sdev);
1486 shost = sdev->host;
James Bottomleye91442b2005-09-09 10:44:16 -05001487 scsi_init_cmd_errh(cmd);
1488 cmd->result = DID_NO_CONNECT << 16;
1489 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001490
1491 /*
1492 * SCSI request completion path will do scsi_device_unbusy(),
1493 * bump busy counts. To bump the counters, we need to dance
1494 * with the locks as normal issue path does.
1495 */
1496 sdev->device_busy++;
1497 spin_unlock(sdev->request_queue->queue_lock);
1498 spin_lock(shost->host_lock);
1499 shost->host_busy++;
Mike Christief0c0a372008-08-17 15:24:38 -05001500 starget->target_busy++;
Tejun Heoe36e0c82006-04-11 17:27:53 +09001501 spin_unlock(shost->host_lock);
1502 spin_lock(sdev->request_queue->queue_lock);
1503
Jens Axboe242f9dc2008-09-14 05:55:09 -07001504 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505}
1506
Jens Axboe1aea6432006-01-09 16:03:03 +01001507static void scsi_softirq_done(struct request *rq)
1508{
Jens Axboe242f9dc2008-09-14 05:55:09 -07001509 struct scsi_cmnd *cmd = rq->special;
1510 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001511 int disposition;
1512
1513 INIT_LIST_HEAD(&cmd->eh_entry);
1514
Jens Axboe242f9dc2008-09-14 05:55:09 -07001515 atomic_inc(&cmd->device->iodone_cnt);
1516 if (cmd->result)
1517 atomic_inc(&cmd->device->ioerr_cnt);
1518
Jens Axboe1aea6432006-01-09 16:03:03 +01001519 disposition = scsi_decide_disposition(cmd);
1520 if (disposition != SUCCESS &&
1521 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1522 sdev_printk(KERN_ERR, cmd->device,
1523 "timing out command, waited %lus\n",
1524 wait_for/HZ);
1525 disposition = SUCCESS;
1526 }
1527
1528 scsi_log_completion(cmd, disposition);
1529
1530 switch (disposition) {
1531 case SUCCESS:
1532 scsi_finish_command(cmd);
1533 break;
1534 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001535 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001536 break;
1537 case ADD_TO_MLQUEUE:
1538 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1539 break;
1540 default:
1541 if (!scsi_eh_scmd_add(cmd, 0))
1542 scsi_finish_command(cmd);
1543 }
1544}
1545
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546/*
1547 * Function: scsi_request_fn()
1548 *
1549 * Purpose: Main strategy routine for SCSI.
1550 *
1551 * Arguments: q - Pointer to actual queue.
1552 *
1553 * Returns: Nothing
1554 *
1555 * Lock status: IO request lock assumed to be held when called.
1556 */
1557static void scsi_request_fn(struct request_queue *q)
1558{
1559 struct scsi_device *sdev = q->queuedata;
1560 struct Scsi_Host *shost;
1561 struct scsi_cmnd *cmd;
1562 struct request *req;
1563
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 if(!get_device(&sdev->sdev_gendev))
1565 /* We must be tearing the block queue down already */
1566 return;
1567
1568 /*
1569 * To start with, we keep looping until the queue is empty, or until
1570 * the host is no longer able to accept any more requests.
1571 */
1572 shost = sdev->host;
Jens Axboea488e742010-04-16 21:13:15 +02001573 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 int rtn;
1575 /*
1576 * get next queueable request. We do this early to make sure
1577 * that the request is fully prepared even if we cannot
1578 * accept it.
1579 */
Tejun Heo9934c8c2009-05-08 11:54:16 +09001580 req = blk_peek_request(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 if (!req || !scsi_dev_queue_ready(q, sdev))
1582 break;
1583
1584 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001585 sdev_printk(KERN_ERR, sdev,
1586 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001587 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 continue;
1589 }
1590
1591
1592 /*
1593 * Remove the request from the request list.
1594 */
1595 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
Tejun Heo9934c8c2009-05-08 11:54:16 +09001596 blk_start_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 sdev->device_busy++;
1598
1599 spin_unlock(q->queue_lock);
James Bottomleye91442b2005-09-09 10:44:16 -05001600 cmd = req->special;
1601 if (unlikely(cmd == NULL)) {
1602 printk(KERN_CRIT "impossible request in %s.\n"
1603 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001604 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001605 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001606 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001607 BUG();
1608 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 spin_lock(shost->host_lock);
1610
Mike Christieecefe8a2008-07-11 19:50:35 -05001611 /*
1612 * We hit this when the driver is using a host wide
1613 * tag map. For device level tag maps the queue_depth check
1614 * in the device ready fn would prevent us from trying
1615 * to allocate a tag. Since the map is a shared host resource
1616 * we add the dev to the starved list so it eventually gets
1617 * a run when a tag is freed.
1618 */
Mike Christie6bd522f2008-07-22 15:34:38 -05001619 if (blk_queue_tagged(q) && !blk_rq_tagged(req)) {
Mike Christieecefe8a2008-07-11 19:50:35 -05001620 if (list_empty(&sdev->starved_entry))
1621 list_add_tail(&sdev->starved_entry,
1622 &shost->starved_list);
1623 goto not_ready;
1624 }
1625
Mike Christief0c0a372008-08-17 15:24:38 -05001626 if (!scsi_target_queue_ready(shost, sdev))
1627 goto not_ready;
1628
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 if (!scsi_host_queue_ready(q, shost, sdev))
1630 goto not_ready;
Mike Christief0c0a372008-08-17 15:24:38 -05001631
1632 scsi_target(sdev)->target_busy++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 shost->host_busy++;
1634
1635 /*
1636 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1637 * take the lock again.
1638 */
1639 spin_unlock_irq(shost->host_lock);
1640
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 /*
1642 * Finally, initialize any error handling parameters, and set up
1643 * the timers for timeouts.
1644 */
1645 scsi_init_cmd_errh(cmd);
1646
1647 /*
1648 * Dispatch the command to the low-level driver.
1649 */
1650 rtn = scsi_dispatch_cmd(cmd);
1651 spin_lock_irq(q->queue_lock);
Jens Axboea488e742010-04-16 21:13:15 +02001652 if (rtn)
1653 goto out_delay;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 }
1655
1656 goto out;
1657
1658 not_ready:
1659 spin_unlock_irq(shost->host_lock);
1660
1661 /*
1662 * lock q, handle tag, requeue req, and decrement device_busy. We
1663 * must return with queue_lock held.
1664 *
1665 * Decrementing device_busy without checking it is OK, as all such
1666 * cases (host limits or settings) should run the queue at some
1667 * later time.
1668 */
1669 spin_lock_irq(q->queue_lock);
1670 blk_requeue_request(q, req);
1671 sdev->device_busy--;
Jens Axboea488e742010-04-16 21:13:15 +02001672out_delay:
1673 if (sdev->device_busy == 0)
1674 blk_delay_queue(q, SCSI_QUEUE_DELAY);
1675out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 /* must be careful here...if we trigger the ->remove() function
1677 * we cannot be holding the q lock */
1678 spin_unlock_irq(q->queue_lock);
1679 put_device(&sdev->sdev_gendev);
1680 spin_lock_irq(q->queue_lock);
1681}
1682
1683u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
1684{
1685 struct device *host_dev;
1686 u64 bounce_limit = 0xffffffff;
1687
1688 if (shost->unchecked_isa_dma)
1689 return BLK_BOUNCE_ISA;
1690 /*
1691 * Platforms with virtual-DMA translation
1692 * hardware have no practical limit.
1693 */
1694 if (!PCI_DMA_BUS_IS_PHYS)
1695 return BLK_BOUNCE_ANY;
1696
1697 host_dev = scsi_get_device(shost);
1698 if (host_dev && host_dev->dma_mask)
Russell Kinge83b3662014-02-11 17:11:04 +00001699 bounce_limit = (u64)dma_max_pfn(host_dev) << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
1701 return bounce_limit;
1702}
1703EXPORT_SYMBOL(scsi_calculate_bounce_limit);
1704
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001705struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
1706 request_fn_proc *request_fn)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 struct request_queue *q;
Lin Ming6f381fa2012-04-12 13:50:38 +08001709 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001711 q = blk_init_queue(request_fn, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 if (!q)
1713 return NULL;
1714
Jens Axboea8474ce2007-08-07 09:02:51 +02001715 /*
1716 * this limit is imposed by hardware restrictions
1717 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001718 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
1719 SCSI_MAX_SG_CHAIN_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001720
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001721 if (scsi_host_prot_dma(shost)) {
1722 shost->sg_prot_tablesize =
1723 min_not_zero(shost->sg_prot_tablesize,
1724 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1725 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1726 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1727 }
1728
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001729 blk_queue_max_hw_sectors(q, shost->max_sectors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
1731 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001732 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733
FUJITA Tomonori860ac562008-02-04 22:28:05 -08001734 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
1735
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01001737 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06001738
1739 /*
1740 * set a reasonable default alignment on word boundaries: the
1741 * host and device may alter it using
1742 * blk_queue_update_dma_alignment() later.
1743 */
1744 blk_queue_dma_alignment(q, 0x03);
1745
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 return q;
1747}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001748EXPORT_SYMBOL(__scsi_alloc_queue);
1749
1750struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
1751{
1752 struct request_queue *q;
1753
1754 q = __scsi_alloc_queue(sdev->host, scsi_request_fn);
1755 if (!q)
1756 return NULL;
1757
1758 blk_queue_prep_rq(q, scsi_prep_fn);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001759 blk_queue_softirq_done(q, scsi_softirq_done);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001760 blk_queue_rq_timed_out(q, scsi_times_out);
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001761 blk_queue_lld_busy(q, scsi_lld_busy);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001762 return q;
1763}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765/*
1766 * Function: scsi_block_requests()
1767 *
1768 * Purpose: Utility function used by low-level drivers to prevent further
1769 * commands from being queued to the device.
1770 *
1771 * Arguments: shost - Host in question
1772 *
1773 * Returns: Nothing
1774 *
1775 * Lock status: No locks are assumed held.
1776 *
1777 * Notes: There is no timer nor any other means by which the requests
1778 * get unblocked other than the low-level driver calling
1779 * scsi_unblock_requests().
1780 */
1781void scsi_block_requests(struct Scsi_Host *shost)
1782{
1783 shost->host_self_blocked = 1;
1784}
1785EXPORT_SYMBOL(scsi_block_requests);
1786
1787/*
1788 * Function: scsi_unblock_requests()
1789 *
1790 * Purpose: Utility function used by low-level drivers to allow further
1791 * commands from being queued to the device.
1792 *
1793 * Arguments: shost - Host in question
1794 *
1795 * Returns: Nothing
1796 *
1797 * Lock status: No locks are assumed held.
1798 *
1799 * Notes: There is no timer nor any other means by which the requests
1800 * get unblocked other than the low-level driver calling
1801 * scsi_unblock_requests().
1802 *
1803 * This is done as an API function so that changes to the
1804 * internals of the scsi mid-layer won't require wholesale
1805 * changes to drivers that use this feature.
1806 */
1807void scsi_unblock_requests(struct Scsi_Host *shost)
1808{
1809 shost->host_self_blocked = 0;
1810 scsi_run_host_queues(shost);
1811}
1812EXPORT_SYMBOL(scsi_unblock_requests);
1813
1814int __init scsi_init_queue(void)
1815{
1816 int i;
1817
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001818 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1819 sizeof(struct scsi_data_buffer),
1820 0, 0, NULL);
1821 if (!scsi_sdb_cache) {
1822 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001823 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001824 }
1825
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1827 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1828 int size = sgp->size * sizeof(struct scatterlist);
1829
1830 sgp->slab = kmem_cache_create(sgp->name, size, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09001831 SLAB_HWCACHE_ALIGN, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 if (!sgp->slab) {
1833 printk(KERN_ERR "SCSI: can't init sg slab %s\n",
1834 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001835 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 }
1837
Matthew Dobson93d23412006-03-26 01:37:50 -08001838 sgp->pool = mempool_create_slab_pool(SG_MEMPOOL_SIZE,
1839 sgp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 if (!sgp->pool) {
1841 printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
1842 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001843 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 }
1845 }
1846
1847 return 0;
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001848
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001849cleanup_sdb:
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001850 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1851 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1852 if (sgp->pool)
1853 mempool_destroy(sgp->pool);
1854 if (sgp->slab)
1855 kmem_cache_destroy(sgp->slab);
1856 }
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001857 kmem_cache_destroy(scsi_sdb_cache);
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001858
1859 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860}
1861
1862void scsi_exit_queue(void)
1863{
1864 int i;
1865
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001866 kmem_cache_destroy(scsi_sdb_cache);
Mike Christieaa7b5cd2005-11-11 05:31:41 -06001867
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1869 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1870 mempool_destroy(sgp->pool);
1871 kmem_cache_destroy(sgp->slab);
1872 }
1873}
James Bottomley5baba832006-03-18 14:10:35 -06001874
1875/**
1876 * scsi_mode_select - issue a mode select
1877 * @sdev: SCSI device to be queried
1878 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1879 * @sp: Save page bit (0 == don't save, 1 == save)
1880 * @modepage: mode page being requested
1881 * @buffer: request buffer (may not be smaller than eight bytes)
1882 * @len: length of request buffer.
1883 * @timeout: command timeout
1884 * @retries: number of retries before failing
1885 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001886 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001887 * must be SCSI_SENSE_BUFFERSIZE big.
1888 *
1889 * Returns zero if successful; negative error number or scsi
1890 * status on error
1891 *
1892 */
1893int
1894scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1895 unsigned char *buffer, int len, int timeout, int retries,
1896 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1897{
1898 unsigned char cmd[10];
1899 unsigned char *real_buffer;
1900 int ret;
1901
1902 memset(cmd, 0, sizeof(cmd));
1903 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
1904
1905 if (sdev->use_10_for_ms) {
1906 if (len > 65535)
1907 return -EINVAL;
1908 real_buffer = kmalloc(8 + len, GFP_KERNEL);
1909 if (!real_buffer)
1910 return -ENOMEM;
1911 memcpy(real_buffer + 8, buffer, len);
1912 len += 8;
1913 real_buffer[0] = 0;
1914 real_buffer[1] = 0;
1915 real_buffer[2] = data->medium_type;
1916 real_buffer[3] = data->device_specific;
1917 real_buffer[4] = data->longlba ? 0x01 : 0;
1918 real_buffer[5] = 0;
1919 real_buffer[6] = data->block_descriptor_length >> 8;
1920 real_buffer[7] = data->block_descriptor_length;
1921
1922 cmd[0] = MODE_SELECT_10;
1923 cmd[7] = len >> 8;
1924 cmd[8] = len;
1925 } else {
1926 if (len > 255 || data->block_descriptor_length > 255 ||
1927 data->longlba)
1928 return -EINVAL;
1929
1930 real_buffer = kmalloc(4 + len, GFP_KERNEL);
1931 if (!real_buffer)
1932 return -ENOMEM;
1933 memcpy(real_buffer + 4, buffer, len);
1934 len += 4;
1935 real_buffer[0] = 0;
1936 real_buffer[1] = data->medium_type;
1937 real_buffer[2] = data->device_specific;
1938 real_buffer[3] = data->block_descriptor_length;
1939
1940
1941 cmd[0] = MODE_SELECT;
1942 cmd[4] = len;
1943 }
1944
1945 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09001946 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06001947 kfree(real_buffer);
1948 return ret;
1949}
1950EXPORT_SYMBOL_GPL(scsi_mode_select);
1951
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952/**
Rob Landleyeb448202007-11-03 13:30:39 -05001953 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05001954 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 * @dbd: set if mode sense will allow block descriptors to be returned
1956 * @modepage: mode page being requested
1957 * @buffer: request buffer (may not be smaller than eight bytes)
1958 * @len: length of request buffer.
1959 * @timeout: command timeout
1960 * @retries: number of retries before failing
1961 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001962 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05001963 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 *
1965 * Returns zero if unsuccessful, or the header offset (either 4
1966 * or 8 depending on whether a six or ten byte command was
1967 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05001968 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969int
James Bottomley1cf72692005-08-28 11:27:01 -05001970scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06001972 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1973{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 unsigned char cmd[12];
1975 int use_10_for_ms;
1976 int header_length;
James Bottomley1cf72692005-08-28 11:27:01 -05001977 int result;
James Bottomleyea73a9f2005-08-28 11:33:52 -05001978 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979
1980 memset(data, 0, sizeof(*data));
1981 memset(&cmd[0], 0, 12);
1982 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
1983 cmd[2] = modepage;
1984
James Bottomleyea73a9f2005-08-28 11:33:52 -05001985 /* caller might not be interested in sense, but we need it */
1986 if (!sshdr)
1987 sshdr = &my_sshdr;
1988
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05001990 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991
1992 if (use_10_for_ms) {
1993 if (len < 8)
1994 len = 8;
1995
1996 cmd[0] = MODE_SENSE_10;
1997 cmd[8] = len;
1998 header_length = 8;
1999 } else {
2000 if (len < 4)
2001 len = 4;
2002
2003 cmd[0] = MODE_SENSE;
2004 cmd[4] = len;
2005 header_length = 4;
2006 }
2007
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 memset(buffer, 0, len);
2009
James Bottomley1cf72692005-08-28 11:27:01 -05002010 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002011 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012
2013 /* This code looks awful: what it's doing is making sure an
2014 * ILLEGAL REQUEST sense return identifies the actual command
2015 * byte as the problem. MODE_SENSE commands can return
2016 * ILLEGAL REQUEST if the code page isn't supported */
2017
James Bottomley1cf72692005-08-28 11:27:01 -05002018 if (use_10_for_ms && !scsi_status_is_good(result) &&
2019 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002020 if (scsi_sense_valid(sshdr)) {
2021 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
2022 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 /*
2024 * Invalid command operation code
2025 */
James Bottomley1cf72692005-08-28 11:27:01 -05002026 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027 goto retry;
2028 }
2029 }
2030 }
2031
James Bottomley1cf72692005-08-28 11:27:01 -05002032 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01002033 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
2034 (modepage == 6 || modepage == 8))) {
2035 /* Initio breakage? */
2036 header_length = 0;
2037 data->length = 13;
2038 data->medium_type = 0;
2039 data->device_specific = 0;
2040 data->longlba = 0;
2041 data->block_descriptor_length = 0;
2042 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 data->length = buffer[0]*256 + buffer[1] + 2;
2044 data->medium_type = buffer[2];
2045 data->device_specific = buffer[3];
2046 data->longlba = buffer[4] & 0x01;
2047 data->block_descriptor_length = buffer[6]*256
2048 + buffer[7];
2049 } else {
2050 data->length = buffer[0] + 1;
2051 data->medium_type = buffer[1];
2052 data->device_specific = buffer[2];
2053 data->block_descriptor_length = buffer[3];
2054 }
Al Viro6d73c852006-02-23 02:03:16 +01002055 data->header_length = header_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 }
2057
James Bottomley1cf72692005-08-28 11:27:01 -05002058 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059}
2060EXPORT_SYMBOL(scsi_mode_sense);
2061
James Bottomley001aac22007-12-02 19:10:40 +02002062/**
2063 * scsi_test_unit_ready - test if unit is ready
2064 * @sdev: scsi device to change the state of.
2065 * @timeout: command timeout
2066 * @retries: number of retries before failing
2067 * @sshdr_external: Optional pointer to struct scsi_sense_hdr for
2068 * returning sense. Make sure that this is cleared before passing
2069 * in.
2070 *
2071 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01002072 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02002073 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074int
James Bottomley001aac22007-12-02 19:10:40 +02002075scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
2076 struct scsi_sense_hdr *sshdr_external)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 char cmd[] = {
2079 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2080 };
James Bottomley001aac22007-12-02 19:10:40 +02002081 struct scsi_sense_hdr *sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002083
2084 if (!sshdr_external)
2085 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
2086 else
2087 sshdr = sshdr_external;
2088
2089 /* try to eat the UNIT_ATTENTION if there are enough retries */
2090 do {
2091 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002092 timeout, retries, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002093 if (sdev->removable && scsi_sense_valid(sshdr) &&
2094 sshdr->sense_key == UNIT_ATTENTION)
2095 sdev->changed = 1;
2096 } while (scsi_sense_valid(sshdr) &&
2097 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002098
James Bottomley001aac22007-12-02 19:10:40 +02002099 if (!sshdr_external)
2100 kfree(sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 return result;
2102}
2103EXPORT_SYMBOL(scsi_test_unit_ready);
2104
2105/**
Rob Landleyeb448202007-11-03 13:30:39 -05002106 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 * @sdev: scsi device to change the state of.
2108 * @state: state to change to.
2109 *
2110 * Returns zero if unsuccessful or an error if the requested
2111 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002112 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113int
2114scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2115{
2116 enum scsi_device_state oldstate = sdev->sdev_state;
2117
2118 if (state == oldstate)
2119 return 0;
2120
2121 switch (state) {
2122 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002123 switch (oldstate) {
2124 case SDEV_CREATED_BLOCK:
2125 break;
2126 default:
2127 goto illegal;
2128 }
2129 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
2131 case SDEV_RUNNING:
2132 switch (oldstate) {
2133 case SDEV_CREATED:
2134 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002135 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 case SDEV_QUIESCE:
2137 case SDEV_BLOCK:
2138 break;
2139 default:
2140 goto illegal;
2141 }
2142 break;
2143
2144 case SDEV_QUIESCE:
2145 switch (oldstate) {
2146 case SDEV_RUNNING:
2147 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002148 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 break;
2150 default:
2151 goto illegal;
2152 }
2153 break;
2154
2155 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002156 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 switch (oldstate) {
2158 case SDEV_CREATED:
2159 case SDEV_RUNNING:
2160 case SDEV_QUIESCE:
2161 case SDEV_BLOCK:
2162 break;
2163 default:
2164 goto illegal;
2165 }
2166 break;
2167
2168 case SDEV_BLOCK:
2169 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002171 case SDEV_CREATED_BLOCK:
2172 break;
2173 default:
2174 goto illegal;
2175 }
2176 break;
2177
2178 case SDEV_CREATED_BLOCK:
2179 switch (oldstate) {
2180 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 break;
2182 default:
2183 goto illegal;
2184 }
2185 break;
2186
2187 case SDEV_CANCEL:
2188 switch (oldstate) {
2189 case SDEV_CREATED:
2190 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002191 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002193 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 case SDEV_BLOCK:
2195 break;
2196 default:
2197 goto illegal;
2198 }
2199 break;
2200
2201 case SDEV_DEL:
2202 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002203 case SDEV_CREATED:
2204 case SDEV_RUNNING:
2205 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002206 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 case SDEV_CANCEL:
Bart Van Assche0516c082013-07-02 15:06:33 +02002208 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 break;
2210 default:
2211 goto illegal;
2212 }
2213 break;
2214
2215 }
2216 sdev->sdev_state = state;
2217 return 0;
2218
2219 illegal:
2220 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002221 sdev_printk(KERN_ERR, sdev,
2222 "Illegal state transition %s->%s\n",
2223 scsi_device_state_name(oldstate),
2224 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 );
2226 return -EINVAL;
2227}
2228EXPORT_SYMBOL(scsi_device_set_state);
2229
2230/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002231 * sdev_evt_emit - emit a single SCSI device uevent
2232 * @sdev: associated SCSI device
2233 * @evt: event to emit
2234 *
2235 * Send a single uevent (scsi_event) to the associated scsi_device.
2236 */
2237static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2238{
2239 int idx = 0;
2240 char *envp[3];
2241
2242 switch (evt->evt_type) {
2243 case SDEV_EVT_MEDIA_CHANGE:
2244 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2245 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002246 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2247 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2248 break;
2249 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2250 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2251 break;
2252 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2253 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2254 break;
2255 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2256 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2257 break;
2258 case SDEV_EVT_LUN_CHANGE_REPORTED:
2259 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2260 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002261 default:
2262 /* do nothing */
2263 break;
2264 }
2265
2266 envp[idx++] = NULL;
2267
2268 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2269}
2270
2271/**
2272 * sdev_evt_thread - send a uevent for each scsi event
2273 * @work: work struct for scsi_device
2274 *
2275 * Dispatch queued events to their associated scsi_device kobjects
2276 * as uevents.
2277 */
2278void scsi_evt_thread(struct work_struct *work)
2279{
2280 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002281 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002282 LIST_HEAD(event_list);
2283
2284 sdev = container_of(work, struct scsi_device, event_work);
2285
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002286 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2287 if (test_and_clear_bit(evt_type, sdev->pending_events))
2288 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2289
Jeff Garzika341cd02007-10-29 17:15:22 -04002290 while (1) {
2291 struct scsi_event *evt;
2292 struct list_head *this, *tmp;
2293 unsigned long flags;
2294
2295 spin_lock_irqsave(&sdev->list_lock, flags);
2296 list_splice_init(&sdev->event_list, &event_list);
2297 spin_unlock_irqrestore(&sdev->list_lock, flags);
2298
2299 if (list_empty(&event_list))
2300 break;
2301
2302 list_for_each_safe(this, tmp, &event_list) {
2303 evt = list_entry(this, struct scsi_event, node);
2304 list_del(&evt->node);
2305 scsi_evt_emit(sdev, evt);
2306 kfree(evt);
2307 }
2308 }
2309}
2310
2311/**
2312 * sdev_evt_send - send asserted event to uevent thread
2313 * @sdev: scsi_device event occurred on
2314 * @evt: event to send
2315 *
2316 * Assert scsi device event asynchronously.
2317 */
2318void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2319{
2320 unsigned long flags;
2321
Kay Sievers4d1566e2008-03-19 13:04:47 +01002322#if 0
2323 /* FIXME: currently this check eliminates all media change events
2324 * for polled devices. Need to update to discriminate between AN
2325 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002326 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2327 kfree(evt);
2328 return;
2329 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002330#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002331
2332 spin_lock_irqsave(&sdev->list_lock, flags);
2333 list_add_tail(&evt->node, &sdev->event_list);
2334 schedule_work(&sdev->event_work);
2335 spin_unlock_irqrestore(&sdev->list_lock, flags);
2336}
2337EXPORT_SYMBOL_GPL(sdev_evt_send);
2338
2339/**
2340 * sdev_evt_alloc - allocate a new scsi event
2341 * @evt_type: type of event to allocate
2342 * @gfpflags: GFP flags for allocation
2343 *
2344 * Allocates and returns a new scsi_event.
2345 */
2346struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2347 gfp_t gfpflags)
2348{
2349 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2350 if (!evt)
2351 return NULL;
2352
2353 evt->evt_type = evt_type;
2354 INIT_LIST_HEAD(&evt->node);
2355
2356 /* evt_type-specific initialization, if any */
2357 switch (evt_type) {
2358 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002359 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2360 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2361 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2362 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2363 case SDEV_EVT_LUN_CHANGE_REPORTED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002364 default:
2365 /* do nothing */
2366 break;
2367 }
2368
2369 return evt;
2370}
2371EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2372
2373/**
2374 * sdev_evt_send_simple - send asserted event to uevent thread
2375 * @sdev: scsi_device event occurred on
2376 * @evt_type: type of event to send
2377 * @gfpflags: GFP flags for allocation
2378 *
2379 * Assert scsi device event asynchronously, given an event type.
2380 */
2381void sdev_evt_send_simple(struct scsi_device *sdev,
2382 enum scsi_device_event evt_type, gfp_t gfpflags)
2383{
2384 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2385 if (!evt) {
2386 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2387 evt_type);
2388 return;
2389 }
2390
2391 sdev_evt_send(sdev, evt);
2392}
2393EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2394
2395/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396 * scsi_device_quiesce - Block user issued commands.
2397 * @sdev: scsi device to quiesce.
2398 *
2399 * This works by trying to transition to the SDEV_QUIESCE state
2400 * (which must be a legal transition). When the device is in this
2401 * state, only special requests will be accepted, all others will
2402 * be deferred. Since special requests may also be requeued requests,
2403 * a successful return doesn't guarantee the device will be
2404 * totally quiescent.
2405 *
2406 * Must be called with user context, may sleep.
2407 *
2408 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002409 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410int
2411scsi_device_quiesce(struct scsi_device *sdev)
2412{
2413 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2414 if (err)
2415 return err;
2416
2417 scsi_run_queue(sdev->request_queue);
2418 while (sdev->device_busy) {
2419 msleep_interruptible(200);
2420 scsi_run_queue(sdev->request_queue);
2421 }
2422 return 0;
2423}
2424EXPORT_SYMBOL(scsi_device_quiesce);
2425
2426/**
2427 * scsi_device_resume - Restart user issued commands to a quiesced device.
2428 * @sdev: scsi device to resume.
2429 *
2430 * Moves the device from quiesced back to running and restarts the
2431 * queues.
2432 *
2433 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002434 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002435void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002437 /* check if the device state was mutated prior to resume, and if
2438 * so assume the state is being managed elsewhere (for example
2439 * device deleted during suspend)
2440 */
2441 if (sdev->sdev_state != SDEV_QUIESCE ||
2442 scsi_device_set_state(sdev, SDEV_RUNNING))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 return;
2444 scsi_run_queue(sdev->request_queue);
2445}
2446EXPORT_SYMBOL(scsi_device_resume);
2447
2448static void
2449device_quiesce_fn(struct scsi_device *sdev, void *data)
2450{
2451 scsi_device_quiesce(sdev);
2452}
2453
2454void
2455scsi_target_quiesce(struct scsi_target *starget)
2456{
2457 starget_for_each_device(starget, NULL, device_quiesce_fn);
2458}
2459EXPORT_SYMBOL(scsi_target_quiesce);
2460
2461static void
2462device_resume_fn(struct scsi_device *sdev, void *data)
2463{
2464 scsi_device_resume(sdev);
2465}
2466
2467void
2468scsi_target_resume(struct scsi_target *starget)
2469{
2470 starget_for_each_device(starget, NULL, device_resume_fn);
2471}
2472EXPORT_SYMBOL(scsi_target_resume);
2473
2474/**
Rob Landleyeb448202007-11-03 13:30:39 -05002475 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 * @sdev: device to block
2477 *
2478 * Block request made by scsi lld's to temporarily stop all
2479 * scsi commands on the specified device. Called from interrupt
2480 * or normal process context.
2481 *
2482 * Returns zero if successful or error if not
2483 *
2484 * Notes:
2485 * This routine transitions the device to the SDEV_BLOCK state
2486 * (which must be a legal transition). When the device is in this
2487 * state, all commands are deferred until the scsi lld reenables
2488 * the device with scsi_device_unblock or device_block_tmo fires.
Rob Landleyeb448202007-11-03 13:30:39 -05002489 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490int
2491scsi_internal_device_block(struct scsi_device *sdev)
2492{
Jens Axboe165125e2007-07-24 09:28:11 +02002493 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494 unsigned long flags;
2495 int err = 0;
2496
2497 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002498 if (err) {
2499 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2500
2501 if (err)
2502 return err;
2503 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504
2505 /*
2506 * The device has transitioned to SDEV_BLOCK. Stop the
2507 * block layer from calling the midlayer with this device's
2508 * request queue.
2509 */
2510 spin_lock_irqsave(q->queue_lock, flags);
2511 blk_stop_queue(q);
2512 spin_unlock_irqrestore(q->queue_lock, flags);
2513
2514 return 0;
2515}
2516EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2517
2518/**
2519 * scsi_internal_device_unblock - resume a device after a block request
2520 * @sdev: device to resume
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002521 * @new_state: state to set devices to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 *
2523 * Called by scsi lld's or the midlayer to restart the device queue
2524 * for the previously suspended scsi device. Called from interrupt or
2525 * normal process context.
2526 *
2527 * Returns zero if successful or error if not.
2528 *
2529 * Notes:
2530 * This routine transitions the device to the SDEV_RUNNING state
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002531 * or to one of the offline states (which must be a legal transition)
Mike Christied0754982012-05-17 23:56:58 -05002532 * allowing the midlayer to goose the queue for this device.
Rob Landleyeb448202007-11-03 13:30:39 -05002533 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534int
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002535scsi_internal_device_unblock(struct scsi_device *sdev,
2536 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537{
Jens Axboe165125e2007-07-24 09:28:11 +02002538 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539 unsigned long flags;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002540
2541 /*
2542 * Try to transition the scsi device to SDEV_RUNNING or one of the
2543 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544 */
Vikas Chaudhary0e580762012-08-09 04:51:30 -04002545 if ((sdev->sdev_state == SDEV_BLOCK) ||
2546 (sdev->sdev_state == SDEV_TRANSPORT_OFFLINE))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002547 sdev->sdev_state = new_state;
2548 else if (sdev->sdev_state == SDEV_CREATED_BLOCK) {
2549 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2550 new_state == SDEV_OFFLINE)
2551 sdev->sdev_state = new_state;
2552 else
2553 sdev->sdev_state = SDEV_CREATED;
2554 } else if (sdev->sdev_state != SDEV_CANCEL &&
Mike Christie986fe6c2010-10-06 03:10:59 -05002555 sdev->sdev_state != SDEV_OFFLINE)
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002556 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557
2558 spin_lock_irqsave(q->queue_lock, flags);
2559 blk_start_queue(q);
2560 spin_unlock_irqrestore(q->queue_lock, flags);
2561
2562 return 0;
2563}
2564EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
2565
2566static void
2567device_block(struct scsi_device *sdev, void *data)
2568{
2569 scsi_internal_device_block(sdev);
2570}
2571
2572static int
2573target_block(struct device *dev, void *data)
2574{
2575 if (scsi_is_target_device(dev))
2576 starget_for_each_device(to_scsi_target(dev), NULL,
2577 device_block);
2578 return 0;
2579}
2580
2581void
2582scsi_target_block(struct device *dev)
2583{
2584 if (scsi_is_target_device(dev))
2585 starget_for_each_device(to_scsi_target(dev), NULL,
2586 device_block);
2587 else
2588 device_for_each_child(dev, NULL, target_block);
2589}
2590EXPORT_SYMBOL_GPL(scsi_target_block);
2591
2592static void
2593device_unblock(struct scsi_device *sdev, void *data)
2594{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002595 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002596}
2597
2598static int
2599target_unblock(struct device *dev, void *data)
2600{
2601 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002602 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 device_unblock);
2604 return 0;
2605}
2606
2607void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002608scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609{
2610 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002611 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612 device_unblock);
2613 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002614 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002615}
2616EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002617
2618/**
2619 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002620 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002621 * @sg_count: number of segments in sg
2622 * @offset: offset in bytes into sg, on return offset into the mapped area
2623 * @len: bytes to map, on return number of bytes mapped
2624 *
2625 * Returns virtual address of the start of the mapped page
2626 */
Jens Axboec6132da2007-10-16 11:08:49 +02002627void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002628 size_t *offset, size_t *len)
2629{
2630 int i;
2631 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002632 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002633 struct page *page;
2634
Andrew Morton22cfefb2007-02-05 16:39:03 -08002635 WARN_ON(!irqs_disabled());
2636
Jens Axboec6132da2007-10-16 11:08:49 +02002637 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002638 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002639 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002640 if (sg_len > *offset)
2641 break;
2642 }
2643
2644 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002645 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2646 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002647 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002648 WARN_ON(1);
2649 return NULL;
2650 }
2651
2652 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002653 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002654
2655 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002656 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002657 *offset &= ~PAGE_MASK;
2658
2659 /* Bytes in this sg-entry from *offset to the end of the page */
2660 sg_len = PAGE_SIZE - *offset;
2661 if (*len > sg_len)
2662 *len = sg_len;
2663
Cong Wang77dfce02011-11-25 23:14:23 +08002664 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002665}
2666EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2667
2668/**
Rob Landleyeb448202007-11-03 13:30:39 -05002669 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002670 * @virt: virtual address to be unmapped
2671 */
2672void scsi_kunmap_atomic_sg(void *virt)
2673{
Cong Wang77dfce02011-11-25 23:14:23 +08002674 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002675}
2676EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002677
2678void sdev_disable_disk_events(struct scsi_device *sdev)
2679{
2680 atomic_inc(&sdev->disk_events_disable_depth);
2681}
2682EXPORT_SYMBOL(sdev_disable_disk_events);
2683
2684void sdev_enable_disk_events(struct scsi_device *sdev)
2685{
2686 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2687 return;
2688 atomic_dec(&sdev->disk_events_disable_depth);
2689}
2690EXPORT_SYMBOL(sdev_enable_disk_events);