blob: f7e316368c99ea289deb85a66541a88f06577737 [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 Bottomley4f5299a2009-01-02 10:42:21 -060078/**
79 * __scsi_queue_insert - private queue insertion
80 * @cmd: The SCSI command being requeued
81 * @reason: The reason for the requeue
82 * @unbusy: Whether the queue should be unbusied
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 *
James Bottomley4f5299a2009-01-02 10:42:21 -060084 * This is a private queue insertion. The public interface
85 * scsi_queue_insert() always assumes the queue should be unbusied
86 * because it's always called before the completion. This function is
87 * for a requeue after completion, which should only occur in this
88 * file.
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 */
Bart Van Assche84feb162012-06-29 15:35:05 +000090static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091{
92 struct Scsi_Host *host = cmd->device->host;
93 struct scsi_device *device = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -050094 struct scsi_target *starget = scsi_target(device);
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -050095 struct request_queue *q = device->request_queue;
96 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98 SCSI_LOG_MLQUEUE(1,
99 printk("Inserting command %p into mlqueue\n", cmd));
100
101 /*
Tejun Heo d8c37e72005-05-14 00:46:08 +0900102 * Set the appropriate busy bit for the device/host.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 *
104 * If the host/device isn't busy, assume that something actually
105 * completed, and that we should be able to queue a command now.
106 *
107 * Note that the prior mid-layer assumption that any host could
108 * always queue at least one command is now broken. The mid-layer
109 * will implement a user specifiable stall (see
110 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
111 * if a command is requeued with no other commands outstanding
112 * either for the device or for the host.
113 */
Mike Christief0c0a372008-08-17 15:24:38 -0500114 switch (reason) {
115 case SCSI_MLQUEUE_HOST_BUSY:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 host->host_blocked = host->max_host_blocked;
Mike Christief0c0a372008-08-17 15:24:38 -0500117 break;
118 case SCSI_MLQUEUE_DEVICE_BUSY:
James Smart573e5912011-07-06 12:45:17 -0400119 case SCSI_MLQUEUE_EH_RETRY:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 device->device_blocked = device->max_device_blocked;
Mike Christief0c0a372008-08-17 15:24:38 -0500121 break;
122 case SCSI_MLQUEUE_TARGET_BUSY:
123 starget->target_blocked = starget->max_target_blocked;
124 break;
125 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
127 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 * Decrement the counters, since these commands are no longer
129 * active on the host/device.
130 */
James Bottomley4f5299a2009-01-02 10:42:21 -0600131 if (unbusy)
132 scsi_device_unbusy(device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134 /*
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500135 * Requeue this command. It will go before all other commands
Bart Van Asscheb4854622012-06-29 15:36:07 +0000136 * that are already in the queue. Schedule requeue work under
137 * lock such that the kblockd_schedule_work() call happens
138 * before blk_cleanup_queue() finishes.
Jens Axboea488e742010-04-16 21:13:15 +0200139 */
Alan Stern644373a2014-03-28 10:51:15 -0700140 cmd->result = 0;
Tejun Heo a1bf9d1d2005-04-24 02:08:52 -0500141 spin_lock_irqsave(q->queue_lock, flags);
James Bottomley59897da2005-09-14 12:57:42 -0400142 blk_requeue_request(q, cmd->request);
Jens Axboe59c3d452014-04-08 09:15:35 -0600143 kblockd_schedule_work(&device->requeue_work);
Bart Van Asscheb4854622012-06-29 15:36:07 +0000144 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145}
146
James Bottomley4f5299a2009-01-02 10:42:21 -0600147/*
148 * Function: scsi_queue_insert()
149 *
150 * Purpose: Insert a command in the midlevel queue.
151 *
152 * Arguments: cmd - command that we are adding to queue.
153 * reason - why we are inserting command to queue.
154 *
155 * Lock status: Assumed that lock is not held upon entry.
156 *
157 * Returns: Nothing.
158 *
159 * Notes: We do this for one of two cases. Either the host is busy
160 * and it cannot accept any more commands for the time being,
161 * or the device returned QUEUE_FULL and can accept no more
162 * commands.
163 * Notes: This could be called either from an interrupt context or a
164 * normal process context.
165 */
Bart Van Assche84feb162012-06-29 15:35:05 +0000166void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
James Bottomley4f5299a2009-01-02 10:42:21 -0600167{
Bart Van Assche84feb162012-06-29 15:35:05 +0000168 __scsi_queue_insert(cmd, reason, 1);
James Bottomley4f5299a2009-01-02 10:42:21 -0600169}
James Bottomley39216032005-06-15 18:48:29 -0500170/**
James Bottomley33aa6872005-08-28 11:31:14 -0500171 * scsi_execute - insert request and wait for the result
James Bottomley39216032005-06-15 18:48:29 -0500172 * @sdev: scsi device
173 * @cmd: scsi command
174 * @data_direction: data direction
175 * @buffer: data buffer
176 * @bufflen: len of buffer
177 * @sense: optional sense buffer
178 * @timeout: request timeout in seconds
179 * @retries: number of times to retry request
James Bottomley33aa6872005-08-28 11:31:14 -0500180 * @flags: or into request flags;
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900181 * @resid: optional residual length
James Bottomley39216032005-06-15 18:48:29 -0500182 *
Michael Opdenacker59c51592007-05-09 08:57:56 +0200183 * returns the req->errors value which is the scsi_cmnd result
James Bottomleyea73a9f2005-08-28 11:33:52 -0500184 * field.
Rob Landleyeb448202007-11-03 13:30:39 -0500185 */
James Bottomley33aa6872005-08-28 11:31:14 -0500186int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
187 int data_direction, void *buffer, unsigned bufflen,
Martin K. Petersen2bfad212014-04-09 22:20:48 -0400188 unsigned char *sense, int timeout, int retries, u64 flags,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900189 int *resid)
James Bottomley39216032005-06-15 18:48:29 -0500190{
191 struct request *req;
192 int write = (data_direction == DMA_TO_DEVICE);
193 int ret = DRIVER_ERROR << 24;
194
195 req = blk_get_request(sdev->request_queue, write, __GFP_WAIT);
James Bottomleybfe159a2011-07-07 15:45:40 -0500196 if (!req)
197 return ret;
Jens Axboef27b0872014-06-06 07:57:37 -0600198 blk_rq_set_block_pc(req);
James Bottomley39216032005-06-15 18:48:29 -0500199
200 if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
201 buffer, bufflen, __GFP_WAIT))
202 goto out;
203
204 req->cmd_len = COMMAND_SIZE(cmd[0]);
205 memcpy(req->cmd, cmd, req->cmd_len);
206 req->sense = sense;
207 req->sense_len = 0;
Mike Christie17e01f22005-11-11 05:31:37 -0600208 req->retries = retries;
James Bottomley39216032005-06-15 18:48:29 -0500209 req->timeout = timeout;
Jens Axboe4aff5e22006-08-10 08:44:47 +0200210 req->cmd_flags |= flags | REQ_QUIET | REQ_PREEMPT;
James Bottomley39216032005-06-15 18:48:29 -0500211
212 /*
213 * head injection *required* here otherwise quiesce won't work
214 */
215 blk_execute_rq(req->q, NULL, req, 1);
216
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400217 /*
218 * Some devices (USB mass-storage in particular) may transfer
219 * garbage data together with a residue indicating that the data
220 * is invalid. Prevent the garbage from being misinterpreted
221 * and prevent security leaks by zeroing out the excess data.
222 */
Tejun Heoc3a4d782009-05-07 22:24:37 +0900223 if (unlikely(req->resid_len > 0 && req->resid_len <= bufflen))
224 memset(buffer + (bufflen - req->resid_len), 0, req->resid_len);
Alan Sternbdb2b8c2008-06-24 14:03:14 -0400225
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900226 if (resid)
Tejun Heoc3a4d782009-05-07 22:24:37 +0900227 *resid = req->resid_len;
James Bottomley39216032005-06-15 18:48:29 -0500228 ret = req->errors;
229 out:
230 blk_put_request(req);
231
232 return ret;
233}
James Bottomley33aa6872005-08-28 11:31:14 -0500234EXPORT_SYMBOL(scsi_execute);
James Bottomley39216032005-06-15 18:48:29 -0500235
Lin Ming9b214932013-03-23 11:42:25 +0800236int scsi_execute_req_flags(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomleyea73a9f2005-08-28 11:33:52 -0500237 int data_direction, void *buffer, unsigned bufflen,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +0900238 struct scsi_sense_hdr *sshdr, int timeout, int retries,
Martin K. Petersen2bfad212014-04-09 22:20:48 -0400239 int *resid, u64 flags)
James Bottomleyea73a9f2005-08-28 11:33:52 -0500240{
241 char *sense = NULL;
akpm@osdl.org1ccb48b2005-06-26 00:12:51 -0700242 int result;
243
James Bottomleyea73a9f2005-08-28 11:33:52 -0500244 if (sshdr) {
Jes Sorensen24669f752006-01-16 10:31:18 -0500245 sense = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500246 if (!sense)
247 return DRIVER_ERROR << 24;
James Bottomleyea73a9f2005-08-28 11:33:52 -0500248 }
akpm@osdl.org1ccb48b2005-06-26 00:12:51 -0700249 result = scsi_execute(sdev, cmd, data_direction, buffer, bufflen,
Lin Ming9b214932013-03-23 11:42:25 +0800250 sense, timeout, retries, flags, resid);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500251 if (sshdr)
James Bottomleye5143852005-08-09 11:55:36 -0500252 scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, sshdr);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500253
254 kfree(sense);
255 return result;
256}
Lin Ming9b214932013-03-23 11:42:25 +0800257EXPORT_SYMBOL(scsi_execute_req_flags);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500258
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259/*
260 * Function: scsi_init_cmd_errh()
261 *
262 * Purpose: Initialize cmd fields related to error handling.
263 *
264 * Arguments: cmd - command that is ready to be queued.
265 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 * Notes: This function has the job of initializing a number of
267 * fields related to error handling. Typically this will
268 * be called once for each command, as required.
269 */
Christoph Hellwig631c2282006-07-08 20:42:15 +0200270static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 cmd->serial_number = 0;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200273 scsi_set_resid(cmd, 0);
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900274 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 if (cmd->cmd_len == 0)
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300276 cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277}
278
279void scsi_device_unbusy(struct scsi_device *sdev)
280{
281 struct Scsi_Host *shost = sdev->host;
Mike Christief0c0a372008-08-17 15:24:38 -0500282 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 unsigned long flags;
284
285 spin_lock_irqsave(shost->host_lock, flags);
286 shost->host_busy--;
Mike Christief0c0a372008-08-17 15:24:38 -0500287 starget->target_busy--;
James Bottomley939647e2005-09-18 15:05:20 -0500288 if (unlikely(scsi_host_in_recovery(shost) &&
Tejun Heoee7863b2006-05-15 20:57:20 +0900289 (shost->host_failed || shost->host_eh_scheduled)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 scsi_eh_wakeup(shost);
291 spin_unlock(shost->host_lock);
152587d2005-04-12 16:22:06 -0500292 spin_lock(sdev->request_queue->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 sdev->device_busy--;
152587d2005-04-12 16:22:06 -0500294 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295}
296
297/*
298 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
299 * and call blk_run_queue for all the scsi_devices on the target -
300 * including current_sdev first.
301 *
302 * Called with *no* scsi locks held.
303 */
304static void scsi_single_lun_run(struct scsi_device *current_sdev)
305{
306 struct Scsi_Host *shost = current_sdev->host;
307 struct scsi_device *sdev, *tmp;
308 struct scsi_target *starget = scsi_target(current_sdev);
309 unsigned long flags;
310
311 spin_lock_irqsave(shost->host_lock, flags);
312 starget->starget_sdev_user = NULL;
313 spin_unlock_irqrestore(shost->host_lock, flags);
314
315 /*
316 * Call blk_run_queue for all LUNs on the target, starting with
317 * current_sdev. We race with others (to set starget_sdev_user),
318 * but in most cases, we will be first. Ideally, each LU on the
319 * target would get some limited time or requests on the target.
320 */
321 blk_run_queue(current_sdev->request_queue);
322
323 spin_lock_irqsave(shost->host_lock, flags);
324 if (starget->starget_sdev_user)
325 goto out;
326 list_for_each_entry_safe(sdev, tmp, &starget->devices,
327 same_target_siblings) {
328 if (sdev == current_sdev)
329 continue;
330 if (scsi_device_get(sdev))
331 continue;
332
333 spin_unlock_irqrestore(shost->host_lock, flags);
334 blk_run_queue(sdev->request_queue);
335 spin_lock_irqsave(shost->host_lock, flags);
336
337 scsi_device_put(sdev);
338 }
339 out:
340 spin_unlock_irqrestore(shost->host_lock, flags);
341}
342
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400343static inline int scsi_device_is_busy(struct scsi_device *sdev)
344{
345 if (sdev->device_busy >= sdev->queue_depth || sdev->device_blocked)
346 return 1;
347
348 return 0;
349}
350
Mike Christief0c0a372008-08-17 15:24:38 -0500351static inline int scsi_target_is_busy(struct scsi_target *starget)
352{
353 return ((starget->can_queue > 0 &&
354 starget->target_busy >= starget->can_queue) ||
355 starget->target_blocked);
356}
357
Kiyoshi Ueda9d112512008-10-04 14:11:06 -0400358static inline int scsi_host_is_busy(struct Scsi_Host *shost)
359{
360 if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
361 shost->host_blocked || shost->host_self_blocked)
362 return 1;
363
364 return 0;
365}
366
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800367static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368{
Mike Christie2a3a59e2008-11-11 13:42:35 -0600369 LIST_HEAD(starved_list);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800370 struct scsi_device *sdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 unsigned long flags;
372
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 spin_lock_irqsave(shost->host_lock, flags);
Mike Christie2a3a59e2008-11-11 13:42:35 -0600374 list_splice_init(&shost->starved_list, &starved_list);
375
376 while (!list_empty(&starved_list)) {
James Bottomleye2eb7242013-07-02 15:05:26 +0200377 struct request_queue *slq;
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 /*
380 * As long as shost is accepting commands and we have
381 * starved queues, call blk_run_queue. scsi_request_fn
382 * drops the queue_lock and can add us back to the
383 * starved_list.
384 *
385 * host_lock protects the starved_list and starved_entry.
386 * scsi_request_fn must get the host_lock before checking
387 * or modifying starved_list or starved_entry.
388 */
Mike Christie2a3a59e2008-11-11 13:42:35 -0600389 if (scsi_host_is_busy(shost))
Mike Christief0c0a372008-08-17 15:24:38 -0500390 break;
Mike Christief0c0a372008-08-17 15:24:38 -0500391
Mike Christie2a3a59e2008-11-11 13:42:35 -0600392 sdev = list_entry(starved_list.next,
393 struct scsi_device, starved_entry);
394 list_del_init(&sdev->starved_entry);
Mike Christief0c0a372008-08-17 15:24:38 -0500395 if (scsi_target_is_busy(scsi_target(sdev))) {
396 list_move_tail(&sdev->starved_entry,
397 &shost->starved_list);
398 continue;
399 }
400
James Bottomleye2eb7242013-07-02 15:05:26 +0200401 /*
402 * Once we drop the host lock, a racing scsi_remove_device()
403 * call may remove the sdev from the starved list and destroy
404 * it and the queue. Mitigate by taking a reference to the
405 * queue and never touching the sdev again after we drop the
406 * host lock. Note: if __scsi_remove_device() invokes
407 * blk_cleanup_queue() before the queue is run from this
408 * function then blk_run_queue() will return immediately since
409 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
410 */
411 slq = sdev->request_queue;
412 if (!blk_get_queue(slq))
413 continue;
414 spin_unlock_irqrestore(shost->host_lock, flags);
415
416 blk_run_queue(slq);
417 blk_put_queue(slq);
418
419 spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 }
Mike Christie2a3a59e2008-11-11 13:42:35 -0600421 /* put any unprocessed entries back */
422 list_splice(&starved_list, &shost->starved_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 spin_unlock_irqrestore(shost->host_lock, flags);
Christoph Hellwig21a05df2014-02-20 14:20:54 -0800424}
425
426/*
427 * Function: scsi_run_queue()
428 *
429 * Purpose: Select a proper request queue to serve next
430 *
431 * Arguments: q - last request's queue
432 *
433 * Returns: Nothing
434 *
435 * Notes: The previous command was completely finished, start
436 * a new one if possible.
437 */
438static void scsi_run_queue(struct request_queue *q)
439{
440 struct scsi_device *sdev = q->queuedata;
441
442 if (scsi_target(sdev)->single_lun)
443 scsi_single_lun_run(sdev);
444 if (!list_empty(&sdev->host->starved_list))
445 scsi_starved_list_run(sdev->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
447 blk_run_queue(q);
448}
449
Jens Axboe9937a5e2011-05-17 11:04:44 +0200450void scsi_requeue_run_queue(struct work_struct *work)
451{
452 struct scsi_device *sdev;
453 struct request_queue *q;
454
455 sdev = container_of(work, struct scsi_device, requeue_work);
456 q = sdev->request_queue;
457 scsi_run_queue(q);
458}
459
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460/*
461 * Function: scsi_requeue_command()
462 *
463 * Purpose: Handle post-processing of completed commands.
464 *
465 * Arguments: q - queue to operate on
466 * cmd - command that may need to be requeued.
467 *
468 * Returns: Nothing
469 *
470 * Notes: After command completion, there may be blocks left
471 * over which weren't finished by the previous command
472 * this can be for a number of reasons - the main one is
473 * I/O errors in the middle of the request, in which case
474 * we need to request the blocks that come after the bad
475 * sector.
James Bottomleye91442b2005-09-09 10:44:16 -0500476 * Notes: Upon return, cmd is a stale pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 */
478static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
479{
Bart Van Assche940f5d42012-06-29 15:34:26 +0000480 struct scsi_device *sdev = cmd->device;
James Bottomleye91442b2005-09-09 10:44:16 -0500481 struct request *req = cmd->request;
Tejun Heo 283369c2005-04-24 02:06:36 -0500482 unsigned long flags;
483
Tejun Heo 283369c2005-04-24 02:06:36 -0500484 spin_lock_irqsave(q->queue_lock, flags);
Christoph Hellwig134997a2014-02-20 14:20:58 -0800485 blk_unprep_request(req);
486 req->special = NULL;
487 scsi_put_command(cmd);
James Bottomleye91442b2005-09-09 10:44:16 -0500488 blk_requeue_request(q, req);
Tejun Heo 283369c2005-04-24 02:06:36 -0500489 spin_unlock_irqrestore(q->queue_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490
491 scsi_run_queue(q);
Bart Van Assche940f5d42012-06-29 15:34:26 +0000492
493 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494}
495
496void scsi_next_command(struct scsi_cmnd *cmd)
497{
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800498 struct scsi_device *sdev = cmd->device;
499 struct request_queue *q = sdev->request_queue;
500
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 scsi_put_command(cmd);
502 scsi_run_queue(q);
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800503
Linus Torvalds49d7bc62005-12-12 11:25:04 -0800504 put_device(&sdev->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505}
506
507void scsi_run_host_queues(struct Scsi_Host *shost)
508{
509 struct scsi_device *sdev;
510
511 shost_for_each_device(sdev, shost)
512 scsi_run_queue(sdev->request_queue);
513}
514
Jens Axboea8474ce2007-08-07 09:02:51 +0200515static inline unsigned int scsi_sgtable_index(unsigned short nents)
516{
517 unsigned int index;
518
James Bottomleyd3f46f32008-01-15 11:11:46 -0600519 BUG_ON(nents > SCSI_MAX_SG_SEGMENTS);
520
521 if (nents <= 8)
Jens Axboea8474ce2007-08-07 09:02:51 +0200522 index = 0;
James Bottomleyd3f46f32008-01-15 11:11:46 -0600523 else
524 index = get_count_order(nents) - 3;
Jens Axboea8474ce2007-08-07 09:02:51 +0200525
526 return index;
527}
528
Jens Axboe5ed79592007-11-15 09:13:11 +0100529static void scsi_sg_free(struct scatterlist *sgl, unsigned int nents)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530{
531 struct scsi_host_sg_pool *sgp;
Jens Axboe5ed79592007-11-15 09:13:11 +0100532
533 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
534 mempool_free(sgl, sgp->pool);
535}
536
537static struct scatterlist *scsi_sg_alloc(unsigned int nents, gfp_t gfp_mask)
538{
539 struct scsi_host_sg_pool *sgp;
540
541 sgp = scsi_sg_pools + scsi_sgtable_index(nents);
542 return mempool_alloc(sgp->pool, gfp_mask);
543}
544
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200545static int scsi_alloc_sgtable(struct scsi_data_buffer *sdb, int nents,
546 gfp_t gfp_mask)
Jens Axboe5ed79592007-11-15 09:13:11 +0100547{
548 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200550 BUG_ON(!nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200552 ret = __sg_alloc_table(&sdb->table, nents, SCSI_MAX_SG_SEGMENTS,
553 gfp_mask, scsi_sg_alloc);
Jens Axboe5ed79592007-11-15 09:13:11 +0100554 if (unlikely(ret))
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200555 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS,
James Bottomley7cedb1f2008-01-13 14:15:28 -0600556 scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Jens Axboea8474ce2007-08-07 09:02:51 +0200558 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559}
560
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200561static void scsi_free_sgtable(struct scsi_data_buffer *sdb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200563 __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS, scsi_sg_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564}
565
566/*
567 * Function: scsi_release_buffers()
568 *
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200569 * Purpose: Free resources allocate for a scsi_command.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 *
571 * Arguments: cmd - command that we are bailing.
572 *
573 * Lock status: Assumed that no lock is held upon entry.
574 *
575 * Returns: Nothing
576 *
577 * Notes: In the event that an upper level driver rejects a
578 * command, we must release resources allocated during
579 * the __init_io() function. Primarily this would involve
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200580 * the scatter-gather table.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 */
Boaz Harroshbb52d822007-12-13 16:14:27 -0800582void scsi_release_buffers(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583{
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200584 if (cmd->sdb.table.nents)
585 scsi_free_sgtable(&cmd->sdb);
586
587 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
588
589 if (scsi_prot_sg_count(cmd))
590 scsi_free_sgtable(cmd->prot_sdb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591}
Boaz Harroshbb52d822007-12-13 16:14:27 -0800592EXPORT_SYMBOL(scsi_release_buffers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200594static void scsi_release_bidi_buffers(struct scsi_cmnd *cmd)
595{
596 struct scsi_data_buffer *bidi_sdb = cmd->request->next_rq->special;
597
598 scsi_free_sgtable(bidi_sdb);
599 kmem_cache_free(scsi_sdb_cache, bidi_sdb);
600 cmd->request->next_rq->special = NULL;
601}
602
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200603/**
604 * __scsi_error_from_host_byte - translate SCSI error code into errno
605 * @cmd: SCSI command (unused)
606 * @result: scsi error code
607 *
608 * Translate SCSI error code into standard UNIX errno.
609 * Return values:
610 * -ENOLINK temporary transport failure
611 * -EREMOTEIO permanent target failure, do not retry
612 * -EBADE permanent nexus failure, retry on other path
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200613 * -ENOSPC No write space available
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200614 * -ENODATA Medium error
Hannes Reinecke0f7f6232013-07-01 15:16:23 +0200615 * -EIO unspecified I/O error
616 */
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100617static int __scsi_error_from_host_byte(struct scsi_cmnd *cmd, int result)
618{
619 int error = 0;
620
621 switch(host_byte(result)) {
622 case DID_TRANSPORT_FAILFAST:
623 error = -ENOLINK;
624 break;
625 case DID_TARGET_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000626 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100627 error = -EREMOTEIO;
628 break;
629 case DID_NEXUS_FAILURE:
Moger, Babu2082ebc2012-01-24 20:38:46 +0000630 set_host_byte(cmd, DID_OK);
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100631 error = -EBADE;
632 break;
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200633 case DID_ALLOC_FAILURE:
634 set_host_byte(cmd, DID_OK);
635 error = -ENOSPC;
636 break;
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200637 case DID_MEDIUM_ERROR:
638 set_host_byte(cmd, DID_OK);
639 error = -ENODATA;
640 break;
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100641 default:
642 error = -EIO;
643 break;
644 }
645
646 return error;
647}
648
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649/*
650 * Function: scsi_io_completion()
651 *
652 * Purpose: Completion processing for block device I/O requests.
653 *
654 * Arguments: cmd - command that is finished.
655 *
656 * Lock status: Assumed that no lock is held upon entry.
657 *
658 * Returns: Nothing
659 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200660 * Notes: We will finish off the specified number of sectors. If we
661 * are done, the command block will be released and the queue
662 * function will be goosed. If we are not done then we have to
Alan Sternb60af5b2008-11-03 15:56:47 -0500663 * figure out what to do next:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 *
Alan Sternb60af5b2008-11-03 15:56:47 -0500665 * a) We can call scsi_requeue_command(). The request
666 * will be unprepared and put back on the queue. Then
667 * a new command will be created for it. This should
668 * be used if we made forward progress, or if we want
669 * to switch from READ(10) to READ(6) for example.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 *
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200671 * b) We can call __scsi_queue_insert(). The request will
Alan Sternb60af5b2008-11-03 15:56:47 -0500672 * be put back on the queue and retried using the same
673 * command as before, possibly after a delay.
674 *
675 * c) We can call blk_end_request() with -EIO to fail
676 * the remainder of the request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 */
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700678void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679{
680 int result = cmd->result;
Jens Axboe165125e2007-07-24 09:28:11 +0200681 struct request_queue *q = cmd->device->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 struct request *req = cmd->request;
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500683 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 struct scsi_sense_hdr sshdr;
685 int sense_valid = 0;
686 int sense_deferred = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500687 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
688 ACTION_DELAYED_RETRY} action;
689 char *description = NULL;
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900690 unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 if (result) {
693 sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
694 if (sense_valid)
695 sense_deferred = scsi_sense_is_deferred(&sshdr);
696 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200697
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200698 if (req->cmd_type == REQ_TYPE_BLOCK_PC) { /* SG_IO ioctl from block level */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 if (sense_valid && req->sense) {
701 /*
702 * SG_IO wants current and deferred errors
703 */
704 int len = 8 + cmd->sense_buffer[7];
705
706 if (len > SCSI_SENSE_BUFFERSIZE)
707 len = SCSI_SENSE_BUFFERSIZE;
708 memcpy(req->sense, cmd->sense_buffer, len);
709 req->sense_len = len;
710 }
James Bottomleyfa8e36c2008-04-02 18:11:52 -0500711 if (!sense_deferred)
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100712 error = __scsi_error_from_host_byte(cmd, result);
Pete Wyckoffb22f6872007-03-13 16:53:28 -0400713 }
Mike Snitzer27c41972012-05-31 15:05:33 -0400714 /*
715 * __scsi_error_from_host_byte may have reset the host_byte
716 */
717 req->errors = cmd->result;
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900718
719 req->resid_len = scsi_get_resid(cmd);
720
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200721 if (scsi_bidi_cmnd(cmd)) {
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900722 /*
723 * Bidi commands Must be complete as a whole,
724 * both sides at once.
725 */
726 req->next_rq->resid_len = scsi_in(cmd)->resid;
727
Boaz Harrosh63c43b02009-12-15 17:25:43 +0200728 scsi_release_buffers(cmd);
Christoph Hellwigc682adf2014-05-01 16:51:02 +0200729 scsi_release_bidi_buffers(cmd);
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200730
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900731 blk_end_request_all(req, 0);
732
FUJITA Tomonorie6bb7a962009-05-11 17:56:08 +0900733 scsi_next_command(cmd);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200734 return;
735 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 }
737
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200738 /* no bidi support for !REQ_TYPE_BLOCK_PC yet */
739 BUG_ON(blk_bidi_rq(req));
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200740
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 * Next deal with any sectors which we were able to correctly
743 * handle.
744 */
Tejun Heo83096eb2009-05-07 22:24:39 +0900745 SCSI_LOG_HLCOMPLETE(1, printk("%u sectors total, "
James Bottomleyd6b0c532006-07-02 10:06:28 -0500746 "%d bytes done.\n",
Tejun Heo83096eb2009-05-07 22:24:39 +0900747 blk_rq_sectors(req), good_bytes));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
James Bottomleya9bddd72009-03-30 16:55:51 +0000749 /*
750 * Recovered errors need reporting, but they're always treated
751 * as success, so fiddle the result code here. For BLOCK_PC
752 * we already took a copy of the original into rq->errors which
753 * is what gets returned to the user
754 */
Douglas Gilberte7efe592010-01-03 13:51:15 -0500755 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
756 /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
757 * print since caller wants ATA registers. Only occurs on
758 * SCSI ATA PASS_THROUGH commands when CK_COND=1
759 */
760 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
761 ;
762 else if (!(req->cmd_flags & REQ_QUIET))
James Bottomleya9bddd72009-03-30 16:55:51 +0000763 scsi_print_sense("", cmd);
764 result = 0;
765 /* BLOCK_PC may have set error */
766 error = 0;
767 }
768
769 /*
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200770 * If we finished all bytes in the request we are done now.
James Bottomleyd6b0c532006-07-02 10:06:28 -0500771 */
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200772 if (!blk_end_request(req, error, good_bytes))
773 goto next_command;
774
775 /*
776 * Kill remainder if no retrys.
777 */
778 if (error && scsi_noretry_cmd(cmd)) {
779 blk_end_request_all(req, error);
780 goto next_command;
781 }
782
783 /*
784 * If there had been no error, but we have leftover bytes in the
785 * requeues just queue the command up again.
786 */
787 if (result == 0)
788 goto requeue;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700789
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100790 error = __scsi_error_from_host_byte(cmd, result);
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500791
Alan Sternb60af5b2008-11-03 15:56:47 -0500792 if (host_byte(result) == DID_RESET) {
793 /* Third party bus reset or reset for error recovery
794 * reasons. Just retry the command and see what
795 * happens.
796 */
797 action = ACTION_RETRY;
798 } else if (sense_valid && !sense_deferred) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 switch (sshdr.sense_key) {
800 case UNIT_ATTENTION:
801 if (cmd->device->removable) {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700802 /* Detected disc change. Set a bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 * and quietly refuse further access.
804 */
805 cmd->device->changed = 1;
Alan Sternb60af5b2008-11-03 15:56:47 -0500806 description = "Media Changed";
807 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 } else {
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700809 /* Must have been a power glitch, or a
810 * bus reset. Could not have been a
811 * media change, so we just retry the
Alan Sternb60af5b2008-11-03 15:56:47 -0500812 * command and see what happens.
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700813 */
Alan Sternb60af5b2008-11-03 15:56:47 -0500814 action = ACTION_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 }
816 break;
817 case ILLEGAL_REQUEST:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700818 /* If we had an ILLEGAL REQUEST returned, then
819 * we may have performed an unsupported
820 * command. The only thing this should be
821 * would be a ten byte read where only a six
822 * byte read was supported. Also, on a system
823 * where READ CAPACITY failed, we may have
824 * read past the end of the disk.
825 */
Jens Axboe26a68012005-11-29 21:03:34 +0100826 if ((cmd->device->use_10_for_rw &&
827 sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 (cmd->cmnd[0] == READ_10 ||
829 cmd->cmnd[0] == WRITE_10)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500830 /* This will issue a new 6-byte command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 cmd->device->use_10_for_rw = 0;
Alan Sternb60af5b2008-11-03 15:56:47 -0500832 action = ACTION_REPREP;
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500833 } else if (sshdr.asc == 0x10) /* DIX */ {
834 description = "Host Data Integrity Failure";
835 action = ACTION_FAIL;
836 error = -EILSEQ;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500837 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400838 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
839 switch (cmd->cmnd[0]) {
840 case UNMAP:
841 description = "Discard failure";
842 break;
843 case WRITE_SAME:
844 case WRITE_SAME_16:
845 if (cmd->cmnd[1] & 0x8)
846 description = "Discard failure";
847 else
848 description =
849 "Write same failure";
850 break;
851 default:
852 description = "Invalid command failure";
853 break;
854 }
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500855 action = ACTION_FAIL;
Martin K. Petersen66a651a2012-02-13 15:38:22 -0500856 error = -EREMOTEIO;
Alan Sternb60af5b2008-11-03 15:56:47 -0500857 } else
858 action = ACTION_FAIL;
859 break;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400860 case ABORTED_COMMAND:
James Bottomley126c09822009-02-19 21:48:54 +0000861 action = ACTION_FAIL;
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400862 if (sshdr.asc == 0x10) { /* DIF */
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500863 description = "Target Data Integrity Failure";
Martin K. Petersen3e695f82009-01-04 03:04:31 -0500864 error = -EILSEQ;
James Bottomley126c09822009-02-19 21:48:54 +0000865 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 break;
867 case NOT_READY:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700868 /* If the device is in the process of becoming
James Bottomleyf3e93f72006-04-25 16:48:30 -0500869 * ready, or has a temporary blockage, retry.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 */
James Bottomleyf3e93f72006-04-25 16:48:30 -0500871 if (sshdr.asc == 0x04) {
872 switch (sshdr.ascq) {
873 case 0x01: /* becoming ready */
874 case 0x04: /* format in progress */
875 case 0x05: /* rebuild in progress */
876 case 0x06: /* recalculation in progress */
877 case 0x07: /* operation in progress */
878 case 0x08: /* Long write in progress */
879 case 0x09: /* self test in progress */
Martin K. Petersend8705f12009-11-26 12:00:41 -0500880 case 0x14: /* space allocation in progress */
Alan Sternb60af5b2008-11-03 15:56:47 -0500881 action = ACTION_DELAYED_RETRY;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500882 break;
Alan Stern3dbf6a52008-12-15 10:31:28 -0500883 default:
884 description = "Device not ready";
885 action = ACTION_FAIL;
886 break;
James Bottomleyf3e93f72006-04-25 16:48:30 -0500887 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500888 } else {
889 description = "Device not ready";
890 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500892 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 case VOLUME_OVERFLOW:
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700894 /* See SSC3rXX or current. */
Alan Sternb60af5b2008-11-03 15:56:47 -0500895 action = ACTION_FAIL;
896 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 default:
Alan Sternb60af5b2008-11-03 15:56:47 -0500898 description = "Unhandled sense code";
899 action = ACTION_FAIL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 break;
901 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500902 } else {
903 description = "Unhandled error code";
904 action = ACTION_FAIL;
Luben Tuikov03aba2f2006-06-23 09:39:09 -0700905 }
Alan Sternb60af5b2008-11-03 15:56:47 -0500906
Eiichi Tsukataee60b2c2014-02-11 14:29:52 +0900907 if (action != ACTION_FAIL &&
908 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
909 action = ACTION_FAIL;
910 description = "Command timed out";
911 }
912
Alan Sternb60af5b2008-11-03 15:56:47 -0500913 switch (action) {
914 case ACTION_FAIL:
915 /* Give up and fail the remainder of the request */
Jens Axboe4aff5e22006-08-10 08:44:47 +0200916 if (!(req->cmd_flags & REQ_QUIET)) {
Alan Sternb60af5b2008-11-03 15:56:47 -0500917 if (description)
Alan Stern3dbf6a52008-12-15 10:31:28 -0500918 scmd_printk(KERN_INFO, cmd, "%s\n",
Alan Sternb60af5b2008-11-03 15:56:47 -0500919 description);
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500920 scsi_print_result(cmd);
James Bottomley3173d8c2005-09-04 11:32:05 -0500921 if (driver_byte(result) & DRIVER_SENSE)
922 scsi_print_sense("", cmd);
Martin K. Petersen002b1eb2009-05-23 11:45:07 -0400923 scsi_print_command(cmd);
James Bottomley3173d8c2005-09-04 11:32:05 -0500924 }
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200925 if (!blk_end_request_err(req, error))
926 goto next_command;
927 /*FALLTHRU*/
Alan Sternb60af5b2008-11-03 15:56:47 -0500928 case ACTION_REPREP:
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200929 requeue:
Alan Sternb60af5b2008-11-03 15:56:47 -0500930 /* Unprep the request and put it back at the head of the queue.
931 * A new command will be prepared and issued.
932 */
James Bottomley79ed2422009-01-06 13:15:20 -0600933 scsi_release_buffers(cmd);
Alan Sternb60af5b2008-11-03 15:56:47 -0500934 scsi_requeue_command(q, cmd);
935 break;
936 case ACTION_RETRY:
937 /* Retry the same command immediately */
James Bottomley4f5299a2009-01-02 10:42:21 -0600938 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -0500939 break;
940 case ACTION_DELAYED_RETRY:
941 /* Retry the same command after a delay */
James Bottomley4f5299a2009-01-02 10:42:21 -0600942 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
Alan Sternb60af5b2008-11-03 15:56:47 -0500943 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 }
Christoph Hellwigbc85dc52014-05-01 16:51:03 +0200945 return;
946
947next_command:
948 scsi_release_buffers(cmd);
949 scsi_next_command(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200952static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb,
953 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954{
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200955 int count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956
957 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +0100958 * If sg table allocation fails, requeue request later.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200960 if (unlikely(scsi_alloc_sgtable(sdb, req->nr_phys_segments,
961 gfp_mask))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 return BLKPREP_DEFER;
Alan Stern7c72ce82005-10-14 11:23:27 -0400963 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 /*
966 * Next, walk the list, and fill in the addresses and sizes of
967 * each segment.
968 */
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200969 count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
970 BUG_ON(count > sdb->table.nents);
971 sdb->table.nents = count;
Tejun Heo1011c1b2009-05-07 22:24:45 +0900972 sdb->length = blk_rq_bytes(req);
Rusty Russell4a03d902007-11-19 11:28:48 +1100973 return BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974}
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200975
976/*
977 * Function: scsi_init_io()
978 *
979 * Purpose: SCSI I/O initialize function.
980 *
981 * Arguments: cmd - Command descriptor we wish to initialize
982 *
983 * Returns: 0 on success
984 * BLKPREP_DEFER if the failure is retryable
985 * BLKPREP_KILL if the failure is fatal
986 */
987int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask)
988{
Christoph Hellwig5e012aa2014-04-15 12:24:55 +0200989 struct scsi_device *sdev = cmd->device;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200990 struct request *rq = cmd->request;
991
992 int error = scsi_init_sgtable(rq, &cmd->sdb, gfp_mask);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200993 if (error)
994 goto err_exit;
995
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200996 if (blk_bidi_rq(rq)) {
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200997 struct scsi_data_buffer *bidi_sdb = kmem_cache_zalloc(
Martin K. Petersen6362abd2008-06-05 23:30:03 -0400998 scsi_sdb_cache, GFP_ATOMIC);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200999 if (!bidi_sdb) {
1000 error = BLKPREP_DEFER;
1001 goto err_exit;
1002 }
1003
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001004 rq->next_rq->special = bidi_sdb;
1005 error = scsi_init_sgtable(rq->next_rq, bidi_sdb, GFP_ATOMIC);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001006 if (error)
1007 goto err_exit;
1008 }
1009
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001010 if (blk_integrity_rq(rq)) {
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001011 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
1012 int ivecs, count;
1013
1014 BUG_ON(prot_sdb == NULL);
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001015 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001016
1017 if (scsi_alloc_sgtable(prot_sdb, ivecs, gfp_mask)) {
1018 error = BLKPREP_DEFER;
1019 goto err_exit;
1020 }
1021
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001022 count = blk_rq_map_integrity_sg(rq->q, rq->bio,
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001023 prot_sdb->table.sgl);
1024 BUG_ON(unlikely(count > ivecs));
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001025 BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
Martin K. Petersen7027ad72008-07-17 17:08:48 -04001026
1027 cmd->prot_sdb = prot_sdb;
1028 cmd->prot_sdb->table.nents = count;
1029 }
1030
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001031 return BLKPREP_OK ;
1032
1033err_exit:
1034 scsi_release_buffers(cmd);
FUJITA Tomonori610a6342010-07-08 10:16:17 +02001035 cmd->request->special = NULL;
James Bottomley3a5c19c2010-08-16 10:06:26 -05001036 scsi_put_command(cmd);
Christoph Hellwig5e012aa2014-04-15 12:24:55 +02001037 put_device(&sdev->sdev_gendev);
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001038 return error;
1039}
Boaz Harroshbb52d822007-12-13 16:14:27 -08001040EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041
Christoph Hellwig3b003152006-11-04 20:10:55 +01001042static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
1043 struct request *req)
1044{
1045 struct scsi_cmnd *cmd;
1046
1047 if (!req->special) {
Christoph Hellwig04796332014-02-20 14:20:55 -08001048 /* Bail if we can't get a reference to the device */
1049 if (!get_device(&sdev->sdev_gendev))
Christoph Hellwig3b003152006-11-04 20:10:55 +01001050 return NULL;
Christoph Hellwig04796332014-02-20 14:20:55 -08001051
1052 cmd = scsi_get_command(sdev, GFP_ATOMIC);
1053 if (unlikely(!cmd)) {
1054 put_device(&sdev->sdev_gendev);
1055 return NULL;
1056 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001057 req->special = cmd;
1058 } else {
1059 cmd = req->special;
1060 }
1061
1062 /* pull a tag out of the request if we have one */
1063 cmd->tag = req->tag;
1064 cmd->request = req;
1065
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001066 cmd->cmnd = req->cmd;
Martin K. Petersen72f7d322011-03-08 02:03:59 -05001067 cmd->prot_op = SCSI_PROT_NORMAL;
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001068
Christoph Hellwig3b003152006-11-04 20:10:55 +01001069 return cmd;
1070}
1071
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001072int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
James Bottomley7b163182005-12-15 20:17:02 -06001073{
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001074 struct scsi_cmnd *cmd = req->special;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001075
1076 /*
1077 * BLOCK_PC requests may transfer data, in which case they must
1078 * a bio attached to them. Or they might contain a SCSI command
1079 * that does not transfer data, in which case they may optionally
1080 * submit a request without an attached bio.
1081 */
1082 if (req->bio) {
1083 int ret;
1084
1085 BUG_ON(!req->nr_phys_segments);
1086
Boaz Harroshbb52d822007-12-13 16:14:27 -08001087 ret = scsi_init_io(cmd, GFP_ATOMIC);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001088 if (unlikely(ret))
1089 return ret;
1090 } else {
Tejun Heob0790412009-05-07 22:24:42 +09001091 BUG_ON(blk_rq_bytes(req));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001092
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001093 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
Christoph Hellwig3b003152006-11-04 20:10:55 +01001094 }
James Bottomley7b163182005-12-15 20:17:02 -06001095
James Bottomley7b163182005-12-15 20:17:02 -06001096 cmd->cmd_len = req->cmd_len;
Tejun Heob0790412009-05-07 22:24:42 +09001097 if (!blk_rq_bytes(req))
James Bottomley7b163182005-12-15 20:17:02 -06001098 cmd->sc_data_direction = DMA_NONE;
1099 else if (rq_data_dir(req) == WRITE)
1100 cmd->sc_data_direction = DMA_TO_DEVICE;
1101 else
1102 cmd->sc_data_direction = DMA_FROM_DEVICE;
1103
Tejun Heob0790412009-05-07 22:24:42 +09001104 cmd->transfersize = blk_rq_bytes(req);
James Bottomley7b163182005-12-15 20:17:02 -06001105 cmd->allowed = req->retries;
Christoph Hellwig3b003152006-11-04 20:10:55 +01001106 return BLKPREP_OK;
1107}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001108EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001109
1110/*
1111 * Setup a REQ_TYPE_FS command. These are simple read/write request
1112 * from filesystems that still need to be translated to SCSI CDBs from
1113 * the ULD.
1114 */
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001115int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
Christoph Hellwig3b003152006-11-04 20:10:55 +01001116{
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001117 struct scsi_cmnd *cmd = req->special;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001118
1119 if (unlikely(sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh
1120 && sdev->scsi_dh_data->scsi_dh->prep_fn)) {
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001121 int ret = sdev->scsi_dh_data->scsi_dh->prep_fn(sdev, req);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -07001122 if (ret != BLKPREP_OK)
1123 return ret;
1124 }
1125
Christoph Hellwig3b003152006-11-04 20:10:55 +01001126 /*
1127 * Filesystem requests must transfer data.
1128 */
1129 BUG_ON(!req->nr_phys_segments);
1130
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001131 memset(cmd->cmnd, 0, BLK_MAX_CDB);
Boaz Harroshbb52d822007-12-13 16:14:27 -08001132 return scsi_init_io(cmd, GFP_ATOMIC);
James Bottomley7b163182005-12-15 20:17:02 -06001133}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001134EXPORT_SYMBOL(scsi_setup_fs_cmnd);
James Bottomley7b163182005-12-15 20:17:02 -06001135
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001136static int
1137scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138{
Christoph Hellwig3b003152006-11-04 20:10:55 +01001139 int ret = BLKPREP_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140
1141 /*
Christoph Hellwig3b003152006-11-04 20:10:55 +01001142 * If the device is not in running state we will reject some
1143 * or all commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
Christoph Hellwig3b003152006-11-04 20:10:55 +01001146 switch (sdev->sdev_state) {
1147 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05001148 case SDEV_TRANSPORT_OFFLINE:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001149 /*
1150 * If the device is offline we refuse to process any
1151 * commands. The device must be brought online
1152 * before trying any recovery commands.
1153 */
1154 sdev_printk(KERN_ERR, sdev,
1155 "rejecting I/O to offline device\n");
1156 ret = BLKPREP_KILL;
1157 break;
1158 case SDEV_DEL:
1159 /*
1160 * If the device is fully deleted, we refuse to
1161 * process any commands as well.
1162 */
James Bottomley9ccfc752005-10-02 11:45:08 -05001163 sdev_printk(KERN_ERR, sdev,
1164 "rejecting I/O to dead device\n");
Christoph Hellwig3b003152006-11-04 20:10:55 +01001165 ret = BLKPREP_KILL;
1166 break;
1167 case SDEV_QUIESCE:
1168 case SDEV_BLOCK:
James Bottomley6f4267e2008-08-22 16:53:31 -05001169 case SDEV_CREATED_BLOCK:
Christoph Hellwig3b003152006-11-04 20:10:55 +01001170 /*
1171 * If the devices is blocked we defer normal commands.
1172 */
1173 if (!(req->cmd_flags & REQ_PREEMPT))
1174 ret = BLKPREP_DEFER;
1175 break;
1176 default:
1177 /*
1178 * For any other not fully online state we only allow
1179 * special commands. In particular any user initiated
1180 * command is not allowed.
1181 */
1182 if (!(req->cmd_flags & REQ_PREEMPT))
1183 ret = BLKPREP_KILL;
1184 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001187 return ret;
1188}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001190static int
1191scsi_prep_return(struct request_queue *q, struct request *req, int ret)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001192{
1193 struct scsi_device *sdev = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194
Christoph Hellwig3b003152006-11-04 20:10:55 +01001195 switch (ret) {
1196 case BLKPREP_KILL:
1197 req->errors = DID_NO_CONNECT << 16;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001198 /* release the command and kill it */
1199 if (req->special) {
1200 struct scsi_cmnd *cmd = req->special;
1201 scsi_release_buffers(cmd);
1202 scsi_put_command(cmd);
Christoph Hellwig68c03d92014-04-15 12:24:56 +02001203 put_device(&sdev->sdev_gendev);
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001204 req->special = NULL;
1205 }
Christoph Hellwig3b003152006-11-04 20:10:55 +01001206 break;
1207 case BLKPREP_DEFER:
1208 /*
Tejun Heo9934c8c2009-05-08 11:54:16 +09001209 * If we defer, the blk_peek_request() returns NULL, but the
Jens Axboea488e742010-04-16 21:13:15 +02001210 * queue must be restarted, so we schedule a callback to happen
1211 * shortly.
Christoph Hellwig3b003152006-11-04 20:10:55 +01001212 */
1213 if (sdev->device_busy == 0)
Jens Axboea488e742010-04-16 21:13:15 +02001214 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Christoph Hellwig3b003152006-11-04 20:10:55 +01001215 break;
1216 default:
1217 req->cmd_flags |= REQ_DONTPREP;
1218 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219
Christoph Hellwig3b003152006-11-04 20:10:55 +01001220 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221}
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001222
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001223static int scsi_prep_fn(struct request_queue *q, struct request *req)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001224{
1225 struct scsi_device *sdev = q->queuedata;
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001226 struct scsi_cmnd *cmd;
1227 int ret;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001228
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001229 ret = scsi_prep_state_check(sdev, req);
1230 if (ret != BLKPREP_OK)
1231 goto out;
1232
1233 cmd = scsi_get_cmd_from_req(sdev, req);
1234 if (unlikely(!cmd)) {
1235 ret = BLKPREP_DEFER;
1236 goto out;
1237 }
1238
1239 if (req->cmd_type == REQ_TYPE_FS)
1240 ret = scsi_cmd_to_driver(cmd)->init_command(cmd);
1241 else if (req->cmd_type == REQ_TYPE_BLOCK_PC)
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001242 ret = scsi_setup_blk_pc_cmnd(sdev, req);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001243 else
1244 ret = BLKPREP_KILL;
1245
1246out:
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001247 return scsi_prep_return(q, req, ret);
1248}
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001249
1250static void scsi_unprep_fn(struct request_queue *q, struct request *req)
1251{
1252 if (req->cmd_type == REQ_TYPE_FS) {
1253 struct scsi_cmnd *cmd = req->special;
1254 struct scsi_driver *drv = scsi_cmd_to_driver(cmd);
1255
1256 if (drv->uninit_command)
1257 drv->uninit_command(cmd);
1258 }
1259}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260
1261/*
1262 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1263 * return 0.
1264 *
1265 * Called with the queue_lock held.
1266 */
1267static inline int scsi_dev_queue_ready(struct request_queue *q,
1268 struct scsi_device *sdev)
1269{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 if (sdev->device_busy == 0 && sdev->device_blocked) {
1271 /*
1272 * unblock after device_blocked iterates to zero
1273 */
1274 if (--sdev->device_blocked == 0) {
1275 SCSI_LOG_MLQUEUE(3,
James Bottomley9ccfc752005-10-02 11:45:08 -05001276 sdev_printk(KERN_INFO, sdev,
1277 "unblocking device at zero depth\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 } else {
Jens Axboea488e742010-04-16 21:13:15 +02001279 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 return 0;
1281 }
1282 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001283 if (scsi_device_is_busy(sdev))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 return 0;
1285
1286 return 1;
1287}
1288
Mike Christief0c0a372008-08-17 15:24:38 -05001289
1290/*
1291 * scsi_target_queue_ready: checks if there we can send commands to target
1292 * @sdev: scsi device on starget to check.
1293 *
1294 * Called with the host lock held.
1295 */
1296static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
1297 struct scsi_device *sdev)
1298{
1299 struct scsi_target *starget = scsi_target(sdev);
1300
1301 if (starget->single_lun) {
1302 if (starget->starget_sdev_user &&
1303 starget->starget_sdev_user != sdev)
1304 return 0;
1305 starget->starget_sdev_user = sdev;
1306 }
1307
1308 if (starget->target_busy == 0 && starget->target_blocked) {
1309 /*
1310 * unblock after target_blocked iterates to zero
1311 */
1312 if (--starget->target_blocked == 0) {
1313 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
1314 "unblocking target at zero depth\n"));
Mike Christieb4efdd52009-04-09 15:57:10 -05001315 } else
Mike Christief0c0a372008-08-17 15:24:38 -05001316 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001317 }
1318
1319 if (scsi_target_is_busy(starget)) {
Shaohua Li466c08c2012-01-10 11:27:01 +08001320 list_move_tail(&sdev->starved_entry, &shost->starved_list);
Hillf Dantonfd01a662010-12-16 14:26:37 -06001321 return 0;
Mike Christief0c0a372008-08-17 15:24:38 -05001322 }
1323
Mike Christief0c0a372008-08-17 15:24:38 -05001324 return 1;
1325}
1326
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327/*
1328 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1329 * return 0. We must end up running the queue again whenever 0 is
1330 * returned, else IO can hang.
1331 *
1332 * Called with host_lock held.
1333 */
1334static inline int scsi_host_queue_ready(struct request_queue *q,
1335 struct Scsi_Host *shost,
1336 struct scsi_device *sdev)
1337{
James Bottomley939647e2005-09-18 15:05:20 -05001338 if (scsi_host_in_recovery(shost))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 return 0;
1340 if (shost->host_busy == 0 && shost->host_blocked) {
1341 /*
1342 * unblock after host_blocked iterates to zero
1343 */
1344 if (--shost->host_blocked == 0) {
1345 SCSI_LOG_MLQUEUE(3,
1346 printk("scsi%d unblocking host at zero depth\n",
1347 shost->host_no));
1348 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 return 0;
1350 }
1351 }
Kiyoshi Ueda9d112512008-10-04 14:11:06 -04001352 if (scsi_host_is_busy(shost)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 if (list_empty(&sdev->starved_entry))
1354 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1355 return 0;
1356 }
1357
1358 /* We're OK to process the command, so we can't be starved */
1359 if (!list_empty(&sdev->starved_entry))
1360 list_del_init(&sdev->starved_entry);
1361
1362 return 1;
1363}
1364
1365/*
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001366 * Busy state exporting function for request stacking drivers.
1367 *
1368 * For efficiency, no lock is taken to check the busy state of
1369 * shost/starget/sdev, since the returned value is not guaranteed and
1370 * may be changed after request stacking drivers call the function,
1371 * regardless of taking lock or not.
1372 *
Bart Van Assche67bd9412012-06-29 15:33:22 +00001373 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
1374 * needs to return 'not busy'. Otherwise, request stacking drivers
1375 * may hold requests forever.
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001376 */
1377static int scsi_lld_busy(struct request_queue *q)
1378{
1379 struct scsi_device *sdev = q->queuedata;
1380 struct Scsi_Host *shost;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001381
Bart Van Assche3f3299d2012-11-28 13:42:38 +01001382 if (blk_queue_dying(q))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001383 return 0;
1384
1385 shost = sdev->host;
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001386
Jun'ichi Nomurab7e94a12012-05-22 18:57:17 +09001387 /*
1388 * Ignore host/starget busy state.
1389 * Since block layer does not have a concept of fairness across
1390 * multiple queues, congestion of host/starget needs to be handled
1391 * in SCSI layer.
1392 */
1393 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001394 return 1;
1395
1396 return 0;
1397}
1398
1399/*
James Bottomleye91442b2005-09-09 10:44:16 -05001400 * Kill a request for a dead device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 */
Jens Axboe165125e2007-07-24 09:28:11 +02001402static void scsi_kill_request(struct request *req, struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403{
James Bottomleye91442b2005-09-09 10:44:16 -05001404 struct scsi_cmnd *cmd = req->special;
Jiri Slaby03b14702009-09-23 16:15:35 +02001405 struct scsi_device *sdev;
1406 struct scsi_target *starget;
1407 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
Tejun Heo9934c8c2009-05-08 11:54:16 +09001409 blk_start_request(req);
James Bottomley788ce432005-09-09 13:40:23 -05001410
Hannes Reinecke74571812011-11-09 08:39:24 +01001411 scmd_printk(KERN_INFO, cmd, "killing request\n");
1412
Jiri Slaby03b14702009-09-23 16:15:35 +02001413 sdev = cmd->device;
1414 starget = scsi_target(sdev);
1415 shost = sdev->host;
James Bottomleye91442b2005-09-09 10:44:16 -05001416 scsi_init_cmd_errh(cmd);
1417 cmd->result = DID_NO_CONNECT << 16;
1418 atomic_inc(&cmd->device->iorequest_cnt);
Tejun Heoe36e0c82006-04-11 17:27:53 +09001419
1420 /*
1421 * SCSI request completion path will do scsi_device_unbusy(),
1422 * bump busy counts. To bump the counters, we need to dance
1423 * with the locks as normal issue path does.
1424 */
1425 sdev->device_busy++;
1426 spin_unlock(sdev->request_queue->queue_lock);
1427 spin_lock(shost->host_lock);
1428 shost->host_busy++;
Mike Christief0c0a372008-08-17 15:24:38 -05001429 starget->target_busy++;
Tejun Heoe36e0c82006-04-11 17:27:53 +09001430 spin_unlock(shost->host_lock);
1431 spin_lock(sdev->request_queue->queue_lock);
1432
Jens Axboe242f9dc2008-09-14 05:55:09 -07001433 blk_complete_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434}
1435
Jens Axboe1aea6432006-01-09 16:03:03 +01001436static void scsi_softirq_done(struct request *rq)
1437{
Jens Axboe242f9dc2008-09-14 05:55:09 -07001438 struct scsi_cmnd *cmd = rq->special;
1439 unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
Jens Axboe1aea6432006-01-09 16:03:03 +01001440 int disposition;
1441
1442 INIT_LIST_HEAD(&cmd->eh_entry);
1443
Jens Axboe242f9dc2008-09-14 05:55:09 -07001444 atomic_inc(&cmd->device->iodone_cnt);
1445 if (cmd->result)
1446 atomic_inc(&cmd->device->ioerr_cnt);
1447
Jens Axboe1aea6432006-01-09 16:03:03 +01001448 disposition = scsi_decide_disposition(cmd);
1449 if (disposition != SUCCESS &&
1450 time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1451 sdev_printk(KERN_ERR, cmd->device,
1452 "timing out command, waited %lus\n",
1453 wait_for/HZ);
1454 disposition = SUCCESS;
1455 }
1456
1457 scsi_log_completion(cmd, disposition);
1458
1459 switch (disposition) {
1460 case SUCCESS:
1461 scsi_finish_command(cmd);
1462 break;
1463 case NEEDS_RETRY:
Christoph Hellwig596f4822007-01-02 12:56:00 +01001464 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
Jens Axboe1aea6432006-01-09 16:03:03 +01001465 break;
1466 case ADD_TO_MLQUEUE:
1467 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
1468 break;
1469 default:
1470 if (!scsi_eh_scmd_add(cmd, 0))
1471 scsi_finish_command(cmd);
1472 }
1473}
1474
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475/*
1476 * Function: scsi_request_fn()
1477 *
1478 * Purpose: Main strategy routine for SCSI.
1479 *
1480 * Arguments: q - Pointer to actual queue.
1481 *
1482 * Returns: Nothing
1483 *
1484 * Lock status: IO request lock assumed to be held when called.
1485 */
1486static void scsi_request_fn(struct request_queue *q)
Bart Van Assche613be1f2014-02-20 14:20:56 -08001487 __releases(q->queue_lock)
1488 __acquires(q->queue_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489{
1490 struct scsi_device *sdev = q->queuedata;
1491 struct Scsi_Host *shost;
1492 struct scsi_cmnd *cmd;
1493 struct request *req;
1494
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 /*
1496 * To start with, we keep looping until the queue is empty, or until
1497 * the host is no longer able to accept any more requests.
1498 */
1499 shost = sdev->host;
Jens Axboea488e742010-04-16 21:13:15 +02001500 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 int rtn;
1502 /*
1503 * get next queueable request. We do this early to make sure
1504 * that the request is fully prepared even if we cannot
1505 * accept it.
1506 */
Tejun Heo9934c8c2009-05-08 11:54:16 +09001507 req = blk_peek_request(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 if (!req || !scsi_dev_queue_ready(q, sdev))
1509 break;
1510
1511 if (unlikely(!scsi_device_online(sdev))) {
James Bottomley9ccfc752005-10-02 11:45:08 -05001512 sdev_printk(KERN_ERR, sdev,
1513 "rejecting I/O to offline device\n");
James Bottomleye91442b2005-09-09 10:44:16 -05001514 scsi_kill_request(req, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 continue;
1516 }
1517
1518
1519 /*
1520 * Remove the request from the request list.
1521 */
1522 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
Tejun Heo9934c8c2009-05-08 11:54:16 +09001523 blk_start_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 sdev->device_busy++;
1525
1526 spin_unlock(q->queue_lock);
James Bottomleye91442b2005-09-09 10:44:16 -05001527 cmd = req->special;
1528 if (unlikely(cmd == NULL)) {
1529 printk(KERN_CRIT "impossible request in %s.\n"
1530 "please mail a stack trace to "
Jens Axboe4aff5e22006-08-10 08:44:47 +02001531 "linux-scsi@vger.kernel.org\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001532 __func__);
Jens Axboe4aff5e22006-08-10 08:44:47 +02001533 blk_dump_rq_flags(req, "foo");
James Bottomleye91442b2005-09-09 10:44:16 -05001534 BUG();
1535 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 spin_lock(shost->host_lock);
1537
Mike Christieecefe8a2008-07-11 19:50:35 -05001538 /*
1539 * We hit this when the driver is using a host wide
1540 * tag map. For device level tag maps the queue_depth check
1541 * in the device ready fn would prevent us from trying
1542 * to allocate a tag. Since the map is a shared host resource
1543 * we add the dev to the starved list so it eventually gets
1544 * a run when a tag is freed.
1545 */
Mike Christie6bd522f2008-07-22 15:34:38 -05001546 if (blk_queue_tagged(q) && !blk_rq_tagged(req)) {
Mike Christieecefe8a2008-07-11 19:50:35 -05001547 if (list_empty(&sdev->starved_entry))
1548 list_add_tail(&sdev->starved_entry,
1549 &shost->starved_list);
1550 goto not_ready;
1551 }
1552
Mike Christief0c0a372008-08-17 15:24:38 -05001553 if (!scsi_target_queue_ready(shost, sdev))
1554 goto not_ready;
1555
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 if (!scsi_host_queue_ready(q, shost, sdev))
1557 goto not_ready;
Mike Christief0c0a372008-08-17 15:24:38 -05001558
1559 scsi_target(sdev)->target_busy++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 shost->host_busy++;
1561
1562 /*
1563 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1564 * take the lock again.
1565 */
1566 spin_unlock_irq(shost->host_lock);
1567
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 /*
1569 * Finally, initialize any error handling parameters, and set up
1570 * the timers for timeouts.
1571 */
1572 scsi_init_cmd_errh(cmd);
1573
1574 /*
1575 * Dispatch the command to the low-level driver.
1576 */
1577 rtn = scsi_dispatch_cmd(cmd);
1578 spin_lock_irq(q->queue_lock);
Jens Axboea488e742010-04-16 21:13:15 +02001579 if (rtn)
1580 goto out_delay;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 }
1582
Bart Van Assche613be1f2014-02-20 14:20:56 -08001583 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584
1585 not_ready:
1586 spin_unlock_irq(shost->host_lock);
1587
1588 /*
1589 * lock q, handle tag, requeue req, and decrement device_busy. We
1590 * must return with queue_lock held.
1591 *
1592 * Decrementing device_busy without checking it is OK, as all such
1593 * cases (host limits or settings) should run the queue at some
1594 * later time.
1595 */
1596 spin_lock_irq(q->queue_lock);
1597 blk_requeue_request(q, req);
1598 sdev->device_busy--;
Jens Axboea488e742010-04-16 21:13:15 +02001599out_delay:
1600 if (sdev->device_busy == 0)
1601 blk_delay_queue(q, SCSI_QUEUE_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602}
1603
1604u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
1605{
1606 struct device *host_dev;
1607 u64 bounce_limit = 0xffffffff;
1608
1609 if (shost->unchecked_isa_dma)
1610 return BLK_BOUNCE_ISA;
1611 /*
1612 * Platforms with virtual-DMA translation
1613 * hardware have no practical limit.
1614 */
1615 if (!PCI_DMA_BUS_IS_PHYS)
1616 return BLK_BOUNCE_ANY;
1617
1618 host_dev = scsi_get_device(shost);
1619 if (host_dev && host_dev->dma_mask)
Russell Kinge83b3662014-02-11 17:11:04 +00001620 bounce_limit = (u64)dma_max_pfn(host_dev) << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621
1622 return bounce_limit;
1623}
1624EXPORT_SYMBOL(scsi_calculate_bounce_limit);
1625
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001626struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
1627 request_fn_proc *request_fn)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 struct request_queue *q;
Lin Ming6f381fa2012-04-12 13:50:38 +08001630 struct device *dev = shost->dma_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001632 q = blk_init_queue(request_fn, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 if (!q)
1634 return NULL;
1635
Jens Axboea8474ce2007-08-07 09:02:51 +02001636 /*
1637 * this limit is imposed by hardware restrictions
1638 */
Martin K. Petersen8a783622010-02-26 00:20:39 -05001639 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
1640 SCSI_MAX_SG_CHAIN_SEGMENTS));
Jens Axboea8474ce2007-08-07 09:02:51 +02001641
Martin K. Petersen13f05c82010-09-10 20:50:10 +02001642 if (scsi_host_prot_dma(shost)) {
1643 shost->sg_prot_tablesize =
1644 min_not_zero(shost->sg_prot_tablesize,
1645 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
1646 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
1647 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
1648 }
1649
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001650 blk_queue_max_hw_sectors(q, shost->max_sectors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
1652 blk_queue_segment_boundary(q, shost->dma_boundary);
FUJITA Tomonori99c84db2008-02-04 22:28:17 -08001653 dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
FUJITA Tomonori860ac562008-02-04 22:28:05 -08001655 blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
1656
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 if (!shost->use_clustering)
Martin K. Petersene692cb62010-12-01 19:41:49 +01001658 q->limits.cluster = 0;
James Bottomley465ff312008-01-01 10:00:10 -06001659
1660 /*
1661 * set a reasonable default alignment on word boundaries: the
1662 * host and device may alter it using
1663 * blk_queue_update_dma_alignment() later.
1664 */
1665 blk_queue_dma_alignment(q, 0x03);
1666
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 return q;
1668}
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001669EXPORT_SYMBOL(__scsi_alloc_queue);
1670
1671struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
1672{
1673 struct request_queue *q;
1674
1675 q = __scsi_alloc_queue(sdev->host, scsi_request_fn);
1676 if (!q)
1677 return NULL;
1678
1679 blk_queue_prep_rq(q, scsi_prep_fn);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001680 blk_queue_unprep_rq(q, scsi_unprep_fn);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001681 blk_queue_softirq_done(q, scsi_softirq_done);
Jens Axboe242f9dc2008-09-14 05:55:09 -07001682 blk_queue_rq_timed_out(q, scsi_times_out);
Kiyoshi Ueda6c5121b2008-10-04 14:11:35 -04001683 blk_queue_lld_busy(q, scsi_lld_busy);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +09001684 return q;
1685}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687/*
1688 * Function: scsi_block_requests()
1689 *
1690 * Purpose: Utility function used by low-level drivers to prevent further
1691 * commands from being queued to the device.
1692 *
1693 * Arguments: shost - Host in question
1694 *
1695 * Returns: Nothing
1696 *
1697 * Lock status: No locks are assumed held.
1698 *
1699 * Notes: There is no timer nor any other means by which the requests
1700 * get unblocked other than the low-level driver calling
1701 * scsi_unblock_requests().
1702 */
1703void scsi_block_requests(struct Scsi_Host *shost)
1704{
1705 shost->host_self_blocked = 1;
1706}
1707EXPORT_SYMBOL(scsi_block_requests);
1708
1709/*
1710 * Function: scsi_unblock_requests()
1711 *
1712 * Purpose: Utility function used by low-level drivers to allow further
1713 * commands from being queued to the device.
1714 *
1715 * Arguments: shost - Host in question
1716 *
1717 * Returns: Nothing
1718 *
1719 * Lock status: No locks are assumed held.
1720 *
1721 * Notes: There is no timer nor any other means by which the requests
1722 * get unblocked other than the low-level driver calling
1723 * scsi_unblock_requests().
1724 *
1725 * This is done as an API function so that changes to the
1726 * internals of the scsi mid-layer won't require wholesale
1727 * changes to drivers that use this feature.
1728 */
1729void scsi_unblock_requests(struct Scsi_Host *shost)
1730{
1731 shost->host_self_blocked = 0;
1732 scsi_run_host_queues(shost);
1733}
1734EXPORT_SYMBOL(scsi_unblock_requests);
1735
1736int __init scsi_init_queue(void)
1737{
1738 int i;
1739
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001740 scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
1741 sizeof(struct scsi_data_buffer),
1742 0, 0, NULL);
1743 if (!scsi_sdb_cache) {
1744 printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001745 return -ENOMEM;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02001746 }
1747
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1749 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1750 int size = sgp->size * sizeof(struct scatterlist);
1751
1752 sgp->slab = kmem_cache_create(sgp->name, size, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09001753 SLAB_HWCACHE_ALIGN, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 if (!sgp->slab) {
1755 printk(KERN_ERR "SCSI: can't init sg slab %s\n",
1756 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001757 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 }
1759
Matthew Dobson93d23412006-03-26 01:37:50 -08001760 sgp->pool = mempool_create_slab_pool(SG_MEMPOOL_SIZE,
1761 sgp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 if (!sgp->pool) {
1763 printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
1764 sgp->name);
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001765 goto cleanup_sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 }
1767 }
1768
1769 return 0;
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001770
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001771cleanup_sdb:
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001772 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1773 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1774 if (sgp->pool)
1775 mempool_destroy(sgp->pool);
1776 if (sgp->slab)
1777 kmem_cache_destroy(sgp->slab);
1778 }
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001779 kmem_cache_destroy(scsi_sdb_cache);
FUJITA Tomonori3d9dd6e2008-01-25 23:25:14 +09001780
1781 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782}
1783
1784void scsi_exit_queue(void)
1785{
1786 int i;
1787
Martin K. Petersen6362abd2008-06-05 23:30:03 -04001788 kmem_cache_destroy(scsi_sdb_cache);
Mike Christieaa7b5cd2005-11-11 05:31:41 -06001789
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1791 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1792 mempool_destroy(sgp->pool);
1793 kmem_cache_destroy(sgp->slab);
1794 }
1795}
James Bottomley5baba832006-03-18 14:10:35 -06001796
1797/**
1798 * scsi_mode_select - issue a mode select
1799 * @sdev: SCSI device to be queried
1800 * @pf: Page format bit (1 == standard, 0 == vendor specific)
1801 * @sp: Save page bit (0 == don't save, 1 == save)
1802 * @modepage: mode page being requested
1803 * @buffer: request buffer (may not be smaller than eight bytes)
1804 * @len: length of request buffer.
1805 * @timeout: command timeout
1806 * @retries: number of retries before failing
1807 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001808 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley5baba832006-03-18 14:10:35 -06001809 * must be SCSI_SENSE_BUFFERSIZE big.
1810 *
1811 * Returns zero if successful; negative error number or scsi
1812 * status on error
1813 *
1814 */
1815int
1816scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
1817 unsigned char *buffer, int len, int timeout, int retries,
1818 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1819{
1820 unsigned char cmd[10];
1821 unsigned char *real_buffer;
1822 int ret;
1823
1824 memset(cmd, 0, sizeof(cmd));
1825 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
1826
1827 if (sdev->use_10_for_ms) {
1828 if (len > 65535)
1829 return -EINVAL;
1830 real_buffer = kmalloc(8 + len, GFP_KERNEL);
1831 if (!real_buffer)
1832 return -ENOMEM;
1833 memcpy(real_buffer + 8, buffer, len);
1834 len += 8;
1835 real_buffer[0] = 0;
1836 real_buffer[1] = 0;
1837 real_buffer[2] = data->medium_type;
1838 real_buffer[3] = data->device_specific;
1839 real_buffer[4] = data->longlba ? 0x01 : 0;
1840 real_buffer[5] = 0;
1841 real_buffer[6] = data->block_descriptor_length >> 8;
1842 real_buffer[7] = data->block_descriptor_length;
1843
1844 cmd[0] = MODE_SELECT_10;
1845 cmd[7] = len >> 8;
1846 cmd[8] = len;
1847 } else {
1848 if (len > 255 || data->block_descriptor_length > 255 ||
1849 data->longlba)
1850 return -EINVAL;
1851
1852 real_buffer = kmalloc(4 + len, GFP_KERNEL);
1853 if (!real_buffer)
1854 return -ENOMEM;
1855 memcpy(real_buffer + 4, buffer, len);
1856 len += 4;
1857 real_buffer[0] = 0;
1858 real_buffer[1] = data->medium_type;
1859 real_buffer[2] = data->device_specific;
1860 real_buffer[3] = data->block_descriptor_length;
1861
1862
1863 cmd[0] = MODE_SELECT;
1864 cmd[4] = len;
1865 }
1866
1867 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09001868 sshdr, timeout, retries, NULL);
James Bottomley5baba832006-03-18 14:10:35 -06001869 kfree(real_buffer);
1870 return ret;
1871}
1872EXPORT_SYMBOL_GPL(scsi_mode_select);
1873
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874/**
Rob Landleyeb448202007-11-03 13:30:39 -05001875 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
James Bottomley1cf72692005-08-28 11:27:01 -05001876 * @sdev: SCSI device to be queried
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 * @dbd: set if mode sense will allow block descriptors to be returned
1878 * @modepage: mode page being requested
1879 * @buffer: request buffer (may not be smaller than eight bytes)
1880 * @len: length of request buffer.
1881 * @timeout: command timeout
1882 * @retries: number of retries before failing
1883 * @data: returns a structure abstracting the mode header data
Rob Landleyeb448202007-11-03 13:30:39 -05001884 * @sshdr: place to put sense data (or NULL if no sense to be collected).
James Bottomley1cf72692005-08-28 11:27:01 -05001885 * must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 *
1887 * Returns zero if unsuccessful, or the header offset (either 4
1888 * or 8 depending on whether a six or ten byte command was
1889 * issued) if successful.
Rob Landleyeb448202007-11-03 13:30:39 -05001890 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891int
James Bottomley1cf72692005-08-28 11:27:01 -05001892scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 unsigned char *buffer, int len, int timeout, int retries,
James Bottomley5baba832006-03-18 14:10:35 -06001894 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
1895{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 unsigned char cmd[12];
1897 int use_10_for_ms;
1898 int header_length;
James Bottomley1cf72692005-08-28 11:27:01 -05001899 int result;
James Bottomleyea73a9f2005-08-28 11:33:52 -05001900 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901
1902 memset(data, 0, sizeof(*data));
1903 memset(&cmd[0], 0, 12);
1904 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
1905 cmd[2] = modepage;
1906
James Bottomleyea73a9f2005-08-28 11:33:52 -05001907 /* caller might not be interested in sense, but we need it */
1908 if (!sshdr)
1909 sshdr = &my_sshdr;
1910
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 retry:
James Bottomley1cf72692005-08-28 11:27:01 -05001912 use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913
1914 if (use_10_for_ms) {
1915 if (len < 8)
1916 len = 8;
1917
1918 cmd[0] = MODE_SENSE_10;
1919 cmd[8] = len;
1920 header_length = 8;
1921 } else {
1922 if (len < 4)
1923 len = 4;
1924
1925 cmd[0] = MODE_SENSE;
1926 cmd[4] = len;
1927 header_length = 4;
1928 }
1929
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 memset(buffer, 0, len);
1931
James Bottomley1cf72692005-08-28 11:27:01 -05001932 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09001933 sshdr, timeout, retries, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934
1935 /* This code looks awful: what it's doing is making sure an
1936 * ILLEGAL REQUEST sense return identifies the actual command
1937 * byte as the problem. MODE_SENSE commands can return
1938 * ILLEGAL REQUEST if the code page isn't supported */
1939
James Bottomley1cf72692005-08-28 11:27:01 -05001940 if (use_10_for_ms && !scsi_status_is_good(result) &&
1941 (driver_byte(result) & DRIVER_SENSE)) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05001942 if (scsi_sense_valid(sshdr)) {
1943 if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
1944 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 /*
1946 * Invalid command operation code
1947 */
James Bottomley1cf72692005-08-28 11:27:01 -05001948 sdev->use_10_for_ms = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 goto retry;
1950 }
1951 }
1952 }
1953
James Bottomley1cf72692005-08-28 11:27:01 -05001954 if(scsi_status_is_good(result)) {
Al Viro6d73c852006-02-23 02:03:16 +01001955 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
1956 (modepage == 6 || modepage == 8))) {
1957 /* Initio breakage? */
1958 header_length = 0;
1959 data->length = 13;
1960 data->medium_type = 0;
1961 data->device_specific = 0;
1962 data->longlba = 0;
1963 data->block_descriptor_length = 0;
1964 } else if(use_10_for_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 data->length = buffer[0]*256 + buffer[1] + 2;
1966 data->medium_type = buffer[2];
1967 data->device_specific = buffer[3];
1968 data->longlba = buffer[4] & 0x01;
1969 data->block_descriptor_length = buffer[6]*256
1970 + buffer[7];
1971 } else {
1972 data->length = buffer[0] + 1;
1973 data->medium_type = buffer[1];
1974 data->device_specific = buffer[2];
1975 data->block_descriptor_length = buffer[3];
1976 }
Al Viro6d73c852006-02-23 02:03:16 +01001977 data->header_length = header_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978 }
1979
James Bottomley1cf72692005-08-28 11:27:01 -05001980 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981}
1982EXPORT_SYMBOL(scsi_mode_sense);
1983
James Bottomley001aac22007-12-02 19:10:40 +02001984/**
1985 * scsi_test_unit_ready - test if unit is ready
1986 * @sdev: scsi device to change the state of.
1987 * @timeout: command timeout
1988 * @retries: number of retries before failing
1989 * @sshdr_external: Optional pointer to struct scsi_sense_hdr for
1990 * returning sense. Make sure that this is cleared before passing
1991 * in.
1992 *
1993 * Returns zero if unsuccessful or an error if TUR failed. For
Tejun Heo9f8a2c22010-12-08 20:57:40 +01001994 * removable media, UNIT_ATTENTION sets ->changed flag.
James Bottomley001aac22007-12-02 19:10:40 +02001995 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996int
James Bottomley001aac22007-12-02 19:10:40 +02001997scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
1998 struct scsi_sense_hdr *sshdr_external)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 char cmd[] = {
2001 TEST_UNIT_READY, 0, 0, 0, 0, 0,
2002 };
James Bottomley001aac22007-12-02 19:10:40 +02002003 struct scsi_sense_hdr *sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 int result;
James Bottomley001aac22007-12-02 19:10:40 +02002005
2006 if (!sshdr_external)
2007 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
2008 else
2009 sshdr = sshdr_external;
2010
2011 /* try to eat the UNIT_ATTENTION if there are enough retries */
2012 do {
2013 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002014 timeout, retries, NULL);
James Bottomley32c356d2008-08-20 00:58:13 +02002015 if (sdev->removable && scsi_sense_valid(sshdr) &&
2016 sshdr->sense_key == UNIT_ATTENTION)
2017 sdev->changed = 1;
2018 } while (scsi_sense_valid(sshdr) &&
2019 sshdr->sense_key == UNIT_ATTENTION && --retries);
James Bottomley001aac22007-12-02 19:10:40 +02002020
James Bottomley001aac22007-12-02 19:10:40 +02002021 if (!sshdr_external)
2022 kfree(sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 return result;
2024}
2025EXPORT_SYMBOL(scsi_test_unit_ready);
2026
2027/**
Rob Landleyeb448202007-11-03 13:30:39 -05002028 * scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 * @sdev: scsi device to change the state of.
2030 * @state: state to change to.
2031 *
2032 * Returns zero if unsuccessful or an error if the requested
2033 * transition is illegal.
Rob Landleyeb448202007-11-03 13:30:39 -05002034 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035int
2036scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
2037{
2038 enum scsi_device_state oldstate = sdev->sdev_state;
2039
2040 if (state == oldstate)
2041 return 0;
2042
2043 switch (state) {
2044 case SDEV_CREATED:
James Bottomley6f4267e2008-08-22 16:53:31 -05002045 switch (oldstate) {
2046 case SDEV_CREATED_BLOCK:
2047 break;
2048 default:
2049 goto illegal;
2050 }
2051 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052
2053 case SDEV_RUNNING:
2054 switch (oldstate) {
2055 case SDEV_CREATED:
2056 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002057 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 case SDEV_QUIESCE:
2059 case SDEV_BLOCK:
2060 break;
2061 default:
2062 goto illegal;
2063 }
2064 break;
2065
2066 case SDEV_QUIESCE:
2067 switch (oldstate) {
2068 case SDEV_RUNNING:
2069 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002070 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 break;
2072 default:
2073 goto illegal;
2074 }
2075 break;
2076
2077 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002078 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 switch (oldstate) {
2080 case SDEV_CREATED:
2081 case SDEV_RUNNING:
2082 case SDEV_QUIESCE:
2083 case SDEV_BLOCK:
2084 break;
2085 default:
2086 goto illegal;
2087 }
2088 break;
2089
2090 case SDEV_BLOCK:
2091 switch (oldstate) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 case SDEV_RUNNING:
James Bottomley6f4267e2008-08-22 16:53:31 -05002093 case SDEV_CREATED_BLOCK:
2094 break;
2095 default:
2096 goto illegal;
2097 }
2098 break;
2099
2100 case SDEV_CREATED_BLOCK:
2101 switch (oldstate) {
2102 case SDEV_CREATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 break;
2104 default:
2105 goto illegal;
2106 }
2107 break;
2108
2109 case SDEV_CANCEL:
2110 switch (oldstate) {
2111 case SDEV_CREATED:
2112 case SDEV_RUNNING:
Alan Stern9ea72902006-06-23 14:25:34 -04002113 case SDEV_QUIESCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002115 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 case SDEV_BLOCK:
2117 break;
2118 default:
2119 goto illegal;
2120 }
2121 break;
2122
2123 case SDEV_DEL:
2124 switch (oldstate) {
Brian King309bd272006-06-27 11:10:43 -05002125 case SDEV_CREATED:
2126 case SDEV_RUNNING:
2127 case SDEV_OFFLINE:
Mike Christie1b8d2622012-05-17 23:56:56 -05002128 case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 case SDEV_CANCEL:
Bart Van Assche0516c082013-07-02 15:06:33 +02002130 case SDEV_CREATED_BLOCK:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 break;
2132 default:
2133 goto illegal;
2134 }
2135 break;
2136
2137 }
2138 sdev->sdev_state = state;
2139 return 0;
2140
2141 illegal:
2142 SCSI_LOG_ERROR_RECOVERY(1,
James Bottomley9ccfc752005-10-02 11:45:08 -05002143 sdev_printk(KERN_ERR, sdev,
2144 "Illegal state transition %s->%s\n",
2145 scsi_device_state_name(oldstate),
2146 scsi_device_state_name(state))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 );
2148 return -EINVAL;
2149}
2150EXPORT_SYMBOL(scsi_device_set_state);
2151
2152/**
Jeff Garzika341cd02007-10-29 17:15:22 -04002153 * sdev_evt_emit - emit a single SCSI device uevent
2154 * @sdev: associated SCSI device
2155 * @evt: event to emit
2156 *
2157 * Send a single uevent (scsi_event) to the associated scsi_device.
2158 */
2159static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
2160{
2161 int idx = 0;
2162 char *envp[3];
2163
2164 switch (evt->evt_type) {
2165 case SDEV_EVT_MEDIA_CHANGE:
2166 envp[idx++] = "SDEV_MEDIA_CHANGE=1";
2167 break;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002168 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2169 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
2170 break;
2171 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2172 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
2173 break;
2174 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2175 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
2176 break;
2177 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2178 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
2179 break;
2180 case SDEV_EVT_LUN_CHANGE_REPORTED:
2181 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
2182 break;
Jeff Garzika341cd02007-10-29 17:15:22 -04002183 default:
2184 /* do nothing */
2185 break;
2186 }
2187
2188 envp[idx++] = NULL;
2189
2190 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
2191}
2192
2193/**
2194 * sdev_evt_thread - send a uevent for each scsi event
2195 * @work: work struct for scsi_device
2196 *
2197 * Dispatch queued events to their associated scsi_device kobjects
2198 * as uevents.
2199 */
2200void scsi_evt_thread(struct work_struct *work)
2201{
2202 struct scsi_device *sdev;
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002203 enum scsi_device_event evt_type;
Jeff Garzika341cd02007-10-29 17:15:22 -04002204 LIST_HEAD(event_list);
2205
2206 sdev = container_of(work, struct scsi_device, event_work);
2207
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002208 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
2209 if (test_and_clear_bit(evt_type, sdev->pending_events))
2210 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);
2211
Jeff Garzika341cd02007-10-29 17:15:22 -04002212 while (1) {
2213 struct scsi_event *evt;
2214 struct list_head *this, *tmp;
2215 unsigned long flags;
2216
2217 spin_lock_irqsave(&sdev->list_lock, flags);
2218 list_splice_init(&sdev->event_list, &event_list);
2219 spin_unlock_irqrestore(&sdev->list_lock, flags);
2220
2221 if (list_empty(&event_list))
2222 break;
2223
2224 list_for_each_safe(this, tmp, &event_list) {
2225 evt = list_entry(this, struct scsi_event, node);
2226 list_del(&evt->node);
2227 scsi_evt_emit(sdev, evt);
2228 kfree(evt);
2229 }
2230 }
2231}
2232
2233/**
2234 * sdev_evt_send - send asserted event to uevent thread
2235 * @sdev: scsi_device event occurred on
2236 * @evt: event to send
2237 *
2238 * Assert scsi device event asynchronously.
2239 */
2240void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
2241{
2242 unsigned long flags;
2243
Kay Sievers4d1566e2008-03-19 13:04:47 +01002244#if 0
2245 /* FIXME: currently this check eliminates all media change events
2246 * for polled devices. Need to update to discriminate between AN
2247 * and polled events */
Jeff Garzika341cd02007-10-29 17:15:22 -04002248 if (!test_bit(evt->evt_type, sdev->supported_events)) {
2249 kfree(evt);
2250 return;
2251 }
Kay Sievers4d1566e2008-03-19 13:04:47 +01002252#endif
Jeff Garzika341cd02007-10-29 17:15:22 -04002253
2254 spin_lock_irqsave(&sdev->list_lock, flags);
2255 list_add_tail(&evt->node, &sdev->event_list);
2256 schedule_work(&sdev->event_work);
2257 spin_unlock_irqrestore(&sdev->list_lock, flags);
2258}
2259EXPORT_SYMBOL_GPL(sdev_evt_send);
2260
2261/**
2262 * sdev_evt_alloc - allocate a new scsi event
2263 * @evt_type: type of event to allocate
2264 * @gfpflags: GFP flags for allocation
2265 *
2266 * Allocates and returns a new scsi_event.
2267 */
2268struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
2269 gfp_t gfpflags)
2270{
2271 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
2272 if (!evt)
2273 return NULL;
2274
2275 evt->evt_type = evt_type;
2276 INIT_LIST_HEAD(&evt->node);
2277
2278 /* evt_type-specific initialization, if any */
2279 switch (evt_type) {
2280 case SDEV_EVT_MEDIA_CHANGE:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04002281 case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2282 case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
2283 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
2284 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
2285 case SDEV_EVT_LUN_CHANGE_REPORTED:
Jeff Garzika341cd02007-10-29 17:15:22 -04002286 default:
2287 /* do nothing */
2288 break;
2289 }
2290
2291 return evt;
2292}
2293EXPORT_SYMBOL_GPL(sdev_evt_alloc);
2294
2295/**
2296 * sdev_evt_send_simple - send asserted event to uevent thread
2297 * @sdev: scsi_device event occurred on
2298 * @evt_type: type of event to send
2299 * @gfpflags: GFP flags for allocation
2300 *
2301 * Assert scsi device event asynchronously, given an event type.
2302 */
2303void sdev_evt_send_simple(struct scsi_device *sdev,
2304 enum scsi_device_event evt_type, gfp_t gfpflags)
2305{
2306 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
2307 if (!evt) {
2308 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
2309 evt_type);
2310 return;
2311 }
2312
2313 sdev_evt_send(sdev, evt);
2314}
2315EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
2316
2317/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 * scsi_device_quiesce - Block user issued commands.
2319 * @sdev: scsi device to quiesce.
2320 *
2321 * This works by trying to transition to the SDEV_QUIESCE state
2322 * (which must be a legal transition). When the device is in this
2323 * state, only special requests will be accepted, all others will
2324 * be deferred. Since special requests may also be requeued requests,
2325 * a successful return doesn't guarantee the device will be
2326 * totally quiescent.
2327 *
2328 * Must be called with user context, may sleep.
2329 *
2330 * Returns zero if unsuccessful or an error if not.
Rob Landleyeb448202007-11-03 13:30:39 -05002331 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332int
2333scsi_device_quiesce(struct scsi_device *sdev)
2334{
2335 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2336 if (err)
2337 return err;
2338
2339 scsi_run_queue(sdev->request_queue);
2340 while (sdev->device_busy) {
2341 msleep_interruptible(200);
2342 scsi_run_queue(sdev->request_queue);
2343 }
2344 return 0;
2345}
2346EXPORT_SYMBOL(scsi_device_quiesce);
2347
2348/**
2349 * scsi_device_resume - Restart user issued commands to a quiesced device.
2350 * @sdev: scsi device to resume.
2351 *
2352 * Moves the device from quiesced back to running and restarts the
2353 * queues.
2354 *
2355 * Must be called with user context, may sleep.
Rob Landleyeb448202007-11-03 13:30:39 -05002356 */
Dan Williamsa7a20d12012-03-22 17:05:11 -07002357void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358{
Dan Williamsa7a20d12012-03-22 17:05:11 -07002359 /* check if the device state was mutated prior to resume, and if
2360 * so assume the state is being managed elsewhere (for example
2361 * device deleted during suspend)
2362 */
2363 if (sdev->sdev_state != SDEV_QUIESCE ||
2364 scsi_device_set_state(sdev, SDEV_RUNNING))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 return;
2366 scsi_run_queue(sdev->request_queue);
2367}
2368EXPORT_SYMBOL(scsi_device_resume);
2369
2370static void
2371device_quiesce_fn(struct scsi_device *sdev, void *data)
2372{
2373 scsi_device_quiesce(sdev);
2374}
2375
2376void
2377scsi_target_quiesce(struct scsi_target *starget)
2378{
2379 starget_for_each_device(starget, NULL, device_quiesce_fn);
2380}
2381EXPORT_SYMBOL(scsi_target_quiesce);
2382
2383static void
2384device_resume_fn(struct scsi_device *sdev, void *data)
2385{
2386 scsi_device_resume(sdev);
2387}
2388
2389void
2390scsi_target_resume(struct scsi_target *starget)
2391{
2392 starget_for_each_device(starget, NULL, device_resume_fn);
2393}
2394EXPORT_SYMBOL(scsi_target_resume);
2395
2396/**
Rob Landleyeb448202007-11-03 13:30:39 -05002397 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 * @sdev: device to block
2399 *
2400 * Block request made by scsi lld's to temporarily stop all
2401 * scsi commands on the specified device. Called from interrupt
2402 * or normal process context.
2403 *
2404 * Returns zero if successful or error if not
2405 *
2406 * Notes:
2407 * This routine transitions the device to the SDEV_BLOCK state
2408 * (which must be a legal transition). When the device is in this
2409 * state, all commands are deferred until the scsi lld reenables
2410 * the device with scsi_device_unblock or device_block_tmo fires.
Rob Landleyeb448202007-11-03 13:30:39 -05002411 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412int
2413scsi_internal_device_block(struct scsi_device *sdev)
2414{
Jens Axboe165125e2007-07-24 09:28:11 +02002415 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416 unsigned long flags;
2417 int err = 0;
2418
2419 err = scsi_device_set_state(sdev, SDEV_BLOCK);
James Bottomley6f4267e2008-08-22 16:53:31 -05002420 if (err) {
2421 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
2422
2423 if (err)
2424 return err;
2425 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426
2427 /*
2428 * The device has transitioned to SDEV_BLOCK. Stop the
2429 * block layer from calling the midlayer with this device's
2430 * request queue.
2431 */
2432 spin_lock_irqsave(q->queue_lock, flags);
2433 blk_stop_queue(q);
2434 spin_unlock_irqrestore(q->queue_lock, flags);
2435
2436 return 0;
2437}
2438EXPORT_SYMBOL_GPL(scsi_internal_device_block);
2439
2440/**
2441 * scsi_internal_device_unblock - resume a device after a block request
2442 * @sdev: device to resume
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002443 * @new_state: state to set devices to after unblocking
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 *
2445 * Called by scsi lld's or the midlayer to restart the device queue
2446 * for the previously suspended scsi device. Called from interrupt or
2447 * normal process context.
2448 *
2449 * Returns zero if successful or error if not.
2450 *
2451 * Notes:
2452 * This routine transitions the device to the SDEV_RUNNING state
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002453 * or to one of the offline states (which must be a legal transition)
Mike Christied0754982012-05-17 23:56:58 -05002454 * allowing the midlayer to goose the queue for this device.
Rob Landleyeb448202007-11-03 13:30:39 -05002455 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456int
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002457scsi_internal_device_unblock(struct scsi_device *sdev,
2458 enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459{
Jens Axboe165125e2007-07-24 09:28:11 +02002460 struct request_queue *q = sdev->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 unsigned long flags;
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002462
2463 /*
2464 * Try to transition the scsi device to SDEV_RUNNING or one of the
2465 * offlined states and goose the device queue if successful.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466 */
Vikas Chaudhary0e580762012-08-09 04:51:30 -04002467 if ((sdev->sdev_state == SDEV_BLOCK) ||
2468 (sdev->sdev_state == SDEV_TRANSPORT_OFFLINE))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002469 sdev->sdev_state = new_state;
2470 else if (sdev->sdev_state == SDEV_CREATED_BLOCK) {
2471 if (new_state == SDEV_TRANSPORT_OFFLINE ||
2472 new_state == SDEV_OFFLINE)
2473 sdev->sdev_state = new_state;
2474 else
2475 sdev->sdev_state = SDEV_CREATED;
2476 } else if (sdev->sdev_state != SDEV_CANCEL &&
Mike Christie986fe6c2010-10-06 03:10:59 -05002477 sdev->sdev_state != SDEV_OFFLINE)
Takahiro Yasui5c10e632009-04-29 12:13:02 -04002478 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479
2480 spin_lock_irqsave(q->queue_lock, flags);
2481 blk_start_queue(q);
2482 spin_unlock_irqrestore(q->queue_lock, flags);
2483
2484 return 0;
2485}
2486EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
2487
2488static void
2489device_block(struct scsi_device *sdev, void *data)
2490{
2491 scsi_internal_device_block(sdev);
2492}
2493
2494static int
2495target_block(struct device *dev, void *data)
2496{
2497 if (scsi_is_target_device(dev))
2498 starget_for_each_device(to_scsi_target(dev), NULL,
2499 device_block);
2500 return 0;
2501}
2502
2503void
2504scsi_target_block(struct device *dev)
2505{
2506 if (scsi_is_target_device(dev))
2507 starget_for_each_device(to_scsi_target(dev), NULL,
2508 device_block);
2509 else
2510 device_for_each_child(dev, NULL, target_block);
2511}
2512EXPORT_SYMBOL_GPL(scsi_target_block);
2513
2514static void
2515device_unblock(struct scsi_device *sdev, void *data)
2516{
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002517 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518}
2519
2520static int
2521target_unblock(struct device *dev, void *data)
2522{
2523 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002524 starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525 device_unblock);
2526 return 0;
2527}
2528
2529void
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002530scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531{
2532 if (scsi_is_target_device(dev))
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002533 starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 device_unblock);
2535 else
Mike Christie5d9fb5c2012-05-17 23:56:57 -05002536 device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537}
2538EXPORT_SYMBOL_GPL(scsi_target_unblock);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002539
2540/**
2541 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
Rob Landleyeb448202007-11-03 13:30:39 -05002542 * @sgl: scatter-gather list
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002543 * @sg_count: number of segments in sg
2544 * @offset: offset in bytes into sg, on return offset into the mapped area
2545 * @len: bytes to map, on return number of bytes mapped
2546 *
2547 * Returns virtual address of the start of the mapped page
2548 */
Jens Axboec6132da2007-10-16 11:08:49 +02002549void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002550 size_t *offset, size_t *len)
2551{
2552 int i;
2553 size_t sg_len = 0, len_complete = 0;
Jens Axboec6132da2007-10-16 11:08:49 +02002554 struct scatterlist *sg;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002555 struct page *page;
2556
Andrew Morton22cfefb2007-02-05 16:39:03 -08002557 WARN_ON(!irqs_disabled());
2558
Jens Axboec6132da2007-10-16 11:08:49 +02002559 for_each_sg(sgl, sg, sg_count, i) {
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002560 len_complete = sg_len; /* Complete sg-entries */
Jens Axboec6132da2007-10-16 11:08:49 +02002561 sg_len += sg->length;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002562 if (sg_len > *offset)
2563 break;
2564 }
2565
2566 if (unlikely(i == sg_count)) {
Andrew Morton169e1a22006-04-18 21:09:08 -07002567 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
2568 "elements %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07002569 __func__, sg_len, *offset, sg_count);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002570 WARN_ON(1);
2571 return NULL;
2572 }
2573
2574 /* Offset starting from the beginning of first page in this sg-entry */
Jens Axboec6132da2007-10-16 11:08:49 +02002575 *offset = *offset - len_complete + sg->offset;
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002576
2577 /* Assumption: contiguous pages can be accessed as "page + i" */
Jens Axboe45711f12007-10-22 21:19:53 +02002578 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002579 *offset &= ~PAGE_MASK;
2580
2581 /* Bytes in this sg-entry from *offset to the end of the page */
2582 sg_len = PAGE_SIZE - *offset;
2583 if (*len > sg_len)
2584 *len = sg_len;
2585
Cong Wang77dfce02011-11-25 23:14:23 +08002586 return kmap_atomic(page);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002587}
2588EXPORT_SYMBOL(scsi_kmap_atomic_sg);
2589
2590/**
Rob Landleyeb448202007-11-03 13:30:39 -05002591 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002592 * @virt: virtual address to be unmapped
2593 */
2594void scsi_kunmap_atomic_sg(void *virt)
2595{
Cong Wang77dfce02011-11-25 23:14:23 +08002596 kunmap_atomic(virt);
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +02002597}
2598EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
Aaron Lu6f4c8272013-01-23 15:09:32 +08002599
2600void sdev_disable_disk_events(struct scsi_device *sdev)
2601{
2602 atomic_inc(&sdev->disk_events_disable_depth);
2603}
2604EXPORT_SYMBOL(sdev_disable_disk_events);
2605
2606void sdev_enable_disk_events(struct scsi_device *sdev)
2607{
2608 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
2609 return;
2610 atomic_dec(&sdev->disk_events_disable_depth);
2611}
2612EXPORT_SYMBOL(sdev_enable_disk_events);