scsi_lib.c 65.4 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10
/*
 *  scsi_lib.c Copyright (C) 1999 Eric Youngdale
 *
 *  SCSI queueing library.
 *      Initial versions: Eric Youngdale (eric@andante.org).
 *                        Based upon conversations with large numbers
 *                        of people at Linux Expo.
 */

#include <linux/bio.h>
J
James Bottomley 已提交
11
#include <linux/bitops.h>
L
Linus Torvalds 已提交
12 13 14
#include <linux/blkdev.h>
#include <linux/completion.h>
#include <linux/kernel.h>
15
#include <linux/export.h>
L
Linus Torvalds 已提交
16 17 18 19 20
#include <linux/mempool.h>
#include <linux/slab.h>
#include <linux/init.h>
#include <linux/pci.h>
#include <linux/delay.h>
21
#include <linux/hardirq.h>
J
Jens Axboe 已提交
22
#include <linux/scatterlist.h>
L
Linus Torvalds 已提交
23 24

#include <scsi/scsi.h>
25
#include <scsi/scsi_cmnd.h>
L
Linus Torvalds 已提交
26 27 28 29 30 31 32 33 34 35
#include <scsi/scsi_dbg.h>
#include <scsi/scsi_device.h>
#include <scsi/scsi_driver.h>
#include <scsi/scsi_eh.h>
#include <scsi/scsi_host.h>

#include "scsi_priv.h"
#include "scsi_logging.h"


36
#define SG_MEMPOOL_NR		ARRAY_SIZE(scsi_sg_pools)
37
#define SG_MEMPOOL_SIZE		2
L
Linus Torvalds 已提交
38 39 40

struct scsi_host_sg_pool {
	size_t		size;
41
	char		*name;
42
	struct kmem_cache	*slab;
L
Linus Torvalds 已提交
43 44 45
	mempool_t	*pool;
};

J
James Bottomley 已提交
46 47 48 49
#define SP(x) { x, "sgpool-" __stringify(x) }
#if (SCSI_MAX_SG_SEGMENTS < 32)
#error SCSI_MAX_SG_SEGMENTS is too small (must be 32 or greater)
#endif
A
Adrian Bunk 已提交
50
static struct scsi_host_sg_pool scsi_sg_pools[] = {
L
Linus Torvalds 已提交
51 52
	SP(8),
	SP(16),
F
FUJITA Tomonori 已提交
53
#if (SCSI_MAX_SG_SEGMENTS > 32)
J
James Bottomley 已提交
54
	SP(32),
F
FUJITA Tomonori 已提交
55
#if (SCSI_MAX_SG_SEGMENTS > 64)
J
James Bottomley 已提交
56 57
	SP(64),
#if (SCSI_MAX_SG_SEGMENTS > 128)
L
Linus Torvalds 已提交
58
	SP(128),
J
James Bottomley 已提交
59 60
#if (SCSI_MAX_SG_SEGMENTS > 256)
#error SCSI_MAX_SG_SEGMENTS is too large (256 MAX)
F
FUJITA Tomonori 已提交
61 62 63
#endif
#endif
#endif
J
James Bottomley 已提交
64 65
#endif
	SP(SCSI_MAX_SG_SEGMENTS)
66
};
L
Linus Torvalds 已提交
67 68
#undef SP

69
struct kmem_cache *scsi_sdb_cache;
70

J
Jens Axboe 已提交
71 72 73 74 75 76 77
/*
 * When to reinvoke queueing after a resource shortage. It's 3 msecs to
 * not change behaviour from the previous unplug mechanism, experimentation
 * may prove this needs changing.
 */
#define SCSI_QUEUE_DELAY	3

78 79 80 81 82
/**
 * __scsi_queue_insert - private queue insertion
 * @cmd: The SCSI command being requeued
 * @reason:  The reason for the requeue
 * @unbusy: Whether the queue should be unbusied
L
Linus Torvalds 已提交
83
 *
84 85 86 87 88
 * This is a private queue insertion.  The public interface
 * scsi_queue_insert() always assumes the queue should be unbusied
 * because it's always called before the completion.  This function is
 * for a requeue after completion, which should only occur in this
 * file.
L
Linus Torvalds 已提交
89
 */
90
static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
L
Linus Torvalds 已提交
91 92 93
{
	struct Scsi_Host *host = cmd->device->host;
	struct scsi_device *device = cmd->device;
94
	struct scsi_target *starget = scsi_target(device);
95 96
	struct request_queue *q = device->request_queue;
	unsigned long flags;
L
Linus Torvalds 已提交
97

98 99
	SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
		"Inserting command %p into mlqueue\n", cmd));
L
Linus Torvalds 已提交
100 101

	/*
102
	 * Set the appropriate busy bit for the device/host.
L
Linus Torvalds 已提交
103 104 105 106 107 108 109 110 111 112 113
	 *
	 * If the host/device isn't busy, assume that something actually
	 * completed, and that we should be able to queue a command now.
	 *
	 * Note that the prior mid-layer assumption that any host could
	 * always queue at least one command is now broken.  The mid-layer
	 * will implement a user specifiable stall (see
	 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
	 * if a command is requeued with no other commands outstanding
	 * either for the device or for the host.
	 */
114 115
	switch (reason) {
	case SCSI_MLQUEUE_HOST_BUSY:
L
Linus Torvalds 已提交
116
		host->host_blocked = host->max_host_blocked;
117 118
		break;
	case SCSI_MLQUEUE_DEVICE_BUSY:
119
	case SCSI_MLQUEUE_EH_RETRY:
L
Linus Torvalds 已提交
120
		device->device_blocked = device->max_device_blocked;
121 122 123 124 125
		break;
	case SCSI_MLQUEUE_TARGET_BUSY:
		starget->target_blocked = starget->max_target_blocked;
		break;
	}
L
Linus Torvalds 已提交
126 127 128 129 130

	/*
	 * Decrement the counters, since these commands are no longer
	 * active on the host/device.
	 */
131 132
	if (unbusy)
		scsi_device_unbusy(device);
L
Linus Torvalds 已提交
133 134

	/*
135
	 * Requeue this command.  It will go before all other commands
136 137 138
	 * that are already in the queue. Schedule requeue work under
	 * lock such that the kblockd_schedule_work() call happens
	 * before blk_cleanup_queue() finishes.
J
Jens Axboe 已提交
139
	 */
140
	cmd->result = 0;
141
	spin_lock_irqsave(q->queue_lock, flags);
J
James Bottomley 已提交
142
	blk_requeue_request(q, cmd->request);
143
	kblockd_schedule_work(&device->requeue_work);
144
	spin_unlock_irqrestore(q->queue_lock, flags);
L
Linus Torvalds 已提交
145 146
}

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
/*
 * Function:    scsi_queue_insert()
 *
 * Purpose:     Insert a command in the midlevel queue.
 *
 * Arguments:   cmd    - command that we are adding to queue.
 *              reason - why we are inserting command to queue.
 *
 * Lock status: Assumed that lock is not held upon entry.
 *
 * Returns:     Nothing.
 *
 * Notes:       We do this for one of two cases.  Either the host is busy
 *              and it cannot accept any more commands for the time being,
 *              or the device returned QUEUE_FULL and can accept no more
 *              commands.
 * Notes:       This could be called either from an interrupt context or a
 *              normal process context.
 */
166
void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
167
{
168
	__scsi_queue_insert(cmd, reason, 1);
169
}
170
/**
171
 * scsi_execute - insert request and wait for the result
172 173 174 175 176 177 178 179
 * @sdev:	scsi device
 * @cmd:	scsi command
 * @data_direction: data direction
 * @buffer:	data buffer
 * @bufflen:	len of buffer
 * @sense:	optional sense buffer
 * @timeout:	request timeout in seconds
 * @retries:	number of times to retry request
180
 * @flags:	or into request flags;
181
 * @resid:	optional residual length
182
 *
183
 * returns the req->errors value which is the scsi_cmnd result
184
 * field.
185
 */
186 187
int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
		 int data_direction, void *buffer, unsigned bufflen,
188
		 unsigned char *sense, int timeout, int retries, u64 flags,
189
		 int *resid)
190 191 192 193 194 195
{
	struct request *req;
	int write = (data_direction == DMA_TO_DEVICE);
	int ret = DRIVER_ERROR << 24;

	req = blk_get_request(sdev->request_queue, write, __GFP_WAIT);
196 197
	if (!req)
		return ret;
J
Jens Axboe 已提交
198
	blk_rq_set_block_pc(req);
199 200 201 202 203 204 205 206 207

	if (bufflen &&	blk_rq_map_kern(sdev->request_queue, req,
					buffer, bufflen, __GFP_WAIT))
		goto out;

	req->cmd_len = COMMAND_SIZE(cmd[0]);
	memcpy(req->cmd, cmd, req->cmd_len);
	req->sense = sense;
	req->sense_len = 0;
208
	req->retries = retries;
209
	req->timeout = timeout;
210
	req->cmd_flags |= flags | REQ_QUIET | REQ_PREEMPT;
211 212 213 214 215 216

	/*
	 * head injection *required* here otherwise quiesce won't work
	 */
	blk_execute_rq(req->q, NULL, req, 1);

217 218 219 220 221 222
	/*
	 * Some devices (USB mass-storage in particular) may transfer
	 * garbage data together with a residue indicating that the data
	 * is invalid.  Prevent the garbage from being misinterpreted
	 * and prevent security leaks by zeroing out the excess data.
	 */
T
Tejun Heo 已提交
223 224
	if (unlikely(req->resid_len > 0 && req->resid_len <= bufflen))
		memset(buffer + (bufflen - req->resid_len), 0, req->resid_len);
225

226
	if (resid)
T
Tejun Heo 已提交
227
		*resid = req->resid_len;
228 229 230 231 232 233
	ret = req->errors;
 out:
	blk_put_request(req);

	return ret;
}
234
EXPORT_SYMBOL(scsi_execute);
235

236
int scsi_execute_req_flags(struct scsi_device *sdev, const unsigned char *cmd,
237
		     int data_direction, void *buffer, unsigned bufflen,
238
		     struct scsi_sense_hdr *sshdr, int timeout, int retries,
239
		     int *resid, u64 flags)
240 241
{
	char *sense = NULL;
242 243
	int result;
	
244
	if (sshdr) {
J
Jes Sorensen 已提交
245
		sense = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
246 247 248
		if (!sense)
			return DRIVER_ERROR << 24;
	}
249
	result = scsi_execute(sdev, cmd, data_direction, buffer, bufflen,
250
			      sense, timeout, retries, flags, resid);
251
	if (sshdr)
252
		scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, sshdr);
253 254 255 256

	kfree(sense);
	return result;
}
257
EXPORT_SYMBOL(scsi_execute_req_flags);
258

L
Linus Torvalds 已提交
259 260 261 262 263 264 265 266 267 268 269
/*
 * Function:    scsi_init_cmd_errh()
 *
 * Purpose:     Initialize cmd fields related to error handling.
 *
 * Arguments:   cmd	- command that is ready to be queued.
 *
 * Notes:       This function has the job of initializing a number of
 *              fields related to error handling.   Typically this will
 *              be called once for each command, as required.
 */
270
static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
L
Linus Torvalds 已提交
271 272
{
	cmd->serial_number = 0;
B
Boaz Harrosh 已提交
273
	scsi_set_resid(cmd, 0);
274
	memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
L
Linus Torvalds 已提交
275
	if (cmd->cmd_len == 0)
276
		cmd->cmd_len = scsi_command_size(cmd->cmnd);
L
Linus Torvalds 已提交
277 278 279 280 281
}

void scsi_device_unbusy(struct scsi_device *sdev)
{
	struct Scsi_Host *shost = sdev->host;
282
	struct scsi_target *starget = scsi_target(sdev);
L
Linus Torvalds 已提交
283 284 285 286
	unsigned long flags;

	spin_lock_irqsave(shost->host_lock, flags);
	shost->host_busy--;
287
	starget->target_busy--;
288
	if (unlikely(scsi_host_in_recovery(shost) &&
289
		     (shost->host_failed || shost->host_eh_scheduled)))
L
Linus Torvalds 已提交
290 291
		scsi_eh_wakeup(shost);
	spin_unlock(shost->host_lock);
已提交
292
	spin_lock(sdev->request_queue->queue_lock);
L
Linus Torvalds 已提交
293
	sdev->device_busy--;
已提交
294
	spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
L
Linus Torvalds 已提交
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
}

/*
 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
 * and call blk_run_queue for all the scsi_devices on the target -
 * including current_sdev first.
 *
 * Called with *no* scsi locks held.
 */
static void scsi_single_lun_run(struct scsi_device *current_sdev)
{
	struct Scsi_Host *shost = current_sdev->host;
	struct scsi_device *sdev, *tmp;
	struct scsi_target *starget = scsi_target(current_sdev);
	unsigned long flags;

	spin_lock_irqsave(shost->host_lock, flags);
	starget->starget_sdev_user = NULL;
	spin_unlock_irqrestore(shost->host_lock, flags);

	/*
	 * Call blk_run_queue for all LUNs on the target, starting with
	 * current_sdev. We race with others (to set starget_sdev_user),
	 * but in most cases, we will be first. Ideally, each LU on the
	 * target would get some limited time or requests on the target.
	 */
	blk_run_queue(current_sdev->request_queue);

	spin_lock_irqsave(shost->host_lock, flags);
	if (starget->starget_sdev_user)
		goto out;
	list_for_each_entry_safe(sdev, tmp, &starget->devices,
			same_target_siblings) {
		if (sdev == current_sdev)
			continue;
		if (scsi_device_get(sdev))
			continue;

		spin_unlock_irqrestore(shost->host_lock, flags);
		blk_run_queue(sdev->request_queue);
		spin_lock_irqsave(shost->host_lock, flags);
	
		scsi_device_put(sdev);
	}
 out:
	spin_unlock_irqrestore(shost->host_lock, flags);
}

343 344 345 346 347 348 349 350
static inline int scsi_device_is_busy(struct scsi_device *sdev)
{
	if (sdev->device_busy >= sdev->queue_depth || sdev->device_blocked)
		return 1;

	return 0;
}

351 352 353 354 355 356 357
static inline int scsi_target_is_busy(struct scsi_target *starget)
{
	return ((starget->can_queue > 0 &&
		 starget->target_busy >= starget->can_queue) ||
		 starget->target_blocked);
}

358 359 360 361 362 363 364 365 366
static inline int scsi_host_is_busy(struct Scsi_Host *shost)
{
	if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
	    shost->host_blocked || shost->host_self_blocked)
		return 1;

	return 0;
}

367
static void scsi_starved_list_run(struct Scsi_Host *shost)
L
Linus Torvalds 已提交
368
{
369
	LIST_HEAD(starved_list);
370
	struct scsi_device *sdev;
L
Linus Torvalds 已提交
371 372 373
	unsigned long flags;

	spin_lock_irqsave(shost->host_lock, flags);
374 375 376
	list_splice_init(&shost->starved_list, &starved_list);

	while (!list_empty(&starved_list)) {
377 378
		struct request_queue *slq;

L
Linus Torvalds 已提交
379 380 381 382 383 384 385 386 387 388
		/*
		 * As long as shost is accepting commands and we have
		 * starved queues, call blk_run_queue. scsi_request_fn
		 * drops the queue_lock and can add us back to the
		 * starved_list.
		 *
		 * host_lock protects the starved_list and starved_entry.
		 * scsi_request_fn must get the host_lock before checking
		 * or modifying starved_list or starved_entry.
		 */
389
		if (scsi_host_is_busy(shost))
390 391
			break;

392 393 394
		sdev = list_entry(starved_list.next,
				  struct scsi_device, starved_entry);
		list_del_init(&sdev->starved_entry);
395 396 397 398 399 400
		if (scsi_target_is_busy(scsi_target(sdev))) {
			list_move_tail(&sdev->starved_entry,
				       &shost->starved_list);
			continue;
		}

401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
		/*
		 * Once we drop the host lock, a racing scsi_remove_device()
		 * call may remove the sdev from the starved list and destroy
		 * it and the queue.  Mitigate by taking a reference to the
		 * queue and never touching the sdev again after we drop the
		 * host lock.  Note: if __scsi_remove_device() invokes
		 * blk_cleanup_queue() before the queue is run from this
		 * function then blk_run_queue() will return immediately since
		 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING.
		 */
		slq = sdev->request_queue;
		if (!blk_get_queue(slq))
			continue;
		spin_unlock_irqrestore(shost->host_lock, flags);

		blk_run_queue(slq);
		blk_put_queue(slq);

		spin_lock_irqsave(shost->host_lock, flags);
L
Linus Torvalds 已提交
420
	}
421 422
	/* put any unprocessed entries back */
	list_splice(&starved_list, &shost->starved_list);
L
Linus Torvalds 已提交
423
	spin_unlock_irqrestore(shost->host_lock, flags);
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
}

/*
 * Function:   scsi_run_queue()
 *
 * Purpose:    Select a proper request queue to serve next
 *
 * Arguments:  q       - last request's queue
 *
 * Returns:     Nothing
 *
 * Notes:      The previous command was completely finished, start
 *             a new one if possible.
 */
static void scsi_run_queue(struct request_queue *q)
{
	struct scsi_device *sdev = q->queuedata;

	if (scsi_target(sdev)->single_lun)
		scsi_single_lun_run(sdev);
	if (!list_empty(&sdev->host->starved_list))
		scsi_starved_list_run(sdev->host);
L
Linus Torvalds 已提交
446 447 448 449

	blk_run_queue(q);
}

450 451 452 453 454 455 456 457 458 459
void scsi_requeue_run_queue(struct work_struct *work)
{
	struct scsi_device *sdev;
	struct request_queue *q;

	sdev = container_of(work, struct scsi_device, requeue_work);
	q = sdev->request_queue;
	scsi_run_queue(q);
}

L
Linus Torvalds 已提交
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
/*
 * Function:	scsi_requeue_command()
 *
 * Purpose:	Handle post-processing of completed commands.
 *
 * Arguments:	q	- queue to operate on
 *		cmd	- command that may need to be requeued.
 *
 * Returns:	Nothing
 *
 * Notes:	After command completion, there may be blocks left
 *		over which weren't finished by the previous command
 *		this can be for a number of reasons - the main one is
 *		I/O errors in the middle of the request, in which case
 *		we need to request the blocks that come after the bad
 *		sector.
476
 * Notes:	Upon return, cmd is a stale pointer.
L
Linus Torvalds 已提交
477 478 479
 */
static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
{
480
	struct scsi_device *sdev = cmd->device;
481
	struct request *req = cmd->request;
482 483 484
	unsigned long flags;

	spin_lock_irqsave(q->queue_lock, flags);
485 486 487
	blk_unprep_request(req);
	req->special = NULL;
	scsi_put_command(cmd);
488
	blk_requeue_request(q, req);
489
	spin_unlock_irqrestore(q->queue_lock, flags);
L
Linus Torvalds 已提交
490 491

	scsi_run_queue(q);
492 493

	put_device(&sdev->sdev_gendev);
L
Linus Torvalds 已提交
494 495 496 497
}

void scsi_next_command(struct scsi_cmnd *cmd)
{
498 499 500
	struct scsi_device *sdev = cmd->device;
	struct request_queue *q = sdev->request_queue;

L
Linus Torvalds 已提交
501 502
	scsi_put_command(cmd);
	scsi_run_queue(q);
503 504

	put_device(&sdev->sdev_gendev);
L
Linus Torvalds 已提交
505 506 507 508 509 510 511 512 513 514
}

void scsi_run_host_queues(struct Scsi_Host *shost)
{
	struct scsi_device *sdev;

	shost_for_each_device(sdev, shost)
		scsi_run_queue(sdev->request_queue);
}

515 516 517 518
static inline unsigned int scsi_sgtable_index(unsigned short nents)
{
	unsigned int index;

J
James Bottomley 已提交
519 520 521
	BUG_ON(nents > SCSI_MAX_SG_SEGMENTS);

	if (nents <= 8)
522
		index = 0;
J
James Bottomley 已提交
523 524
	else
		index = get_count_order(nents) - 3;
L
Linus Torvalds 已提交
525

526 527 528
	return index;
}

529
static void scsi_sg_free(struct scatterlist *sgl, unsigned int nents)
530 531 532
{
	struct scsi_host_sg_pool *sgp;

533 534 535
	sgp = scsi_sg_pools + scsi_sgtable_index(nents);
	mempool_free(sgl, sgp->pool);
}
536

537 538 539
static struct scatterlist *scsi_sg_alloc(unsigned int nents, gfp_t gfp_mask)
{
	struct scsi_host_sg_pool *sgp;
540

541 542 543
	sgp = scsi_sg_pools + scsi_sgtable_index(nents);
	return mempool_alloc(sgp->pool, gfp_mask);
}
544

B
Boaz Harrosh 已提交
545 546
static int scsi_alloc_sgtable(struct scsi_data_buffer *sdb, int nents,
			      gfp_t gfp_mask)
547 548
{
	int ret;
549

B
Boaz Harrosh 已提交
550
	BUG_ON(!nents);
551

B
Boaz Harrosh 已提交
552 553
	ret = __sg_alloc_table(&sdb->table, nents, SCSI_MAX_SG_SEGMENTS,
			       gfp_mask, scsi_sg_alloc);
554
	if (unlikely(ret))
B
Boaz Harrosh 已提交
555
		__sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS,
556
				scsi_sg_free);
J
Jens Axboe 已提交
557

558
	return ret;
L
Linus Torvalds 已提交
559 560
}

B
Boaz Harrosh 已提交
561
static void scsi_free_sgtable(struct scsi_data_buffer *sdb)
L
Linus Torvalds 已提交
562
{
B
Boaz Harrosh 已提交
563
	__sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS, scsi_sg_free);
L
Linus Torvalds 已提交
564 565 566 567 568
}

/*
 * Function:    scsi_release_buffers()
 *
569
 * Purpose:     Free resources allocate for a scsi_command.
L
Linus Torvalds 已提交
570 571 572 573 574 575 576 577 578 579
 *
 * Arguments:   cmd	- command that we are bailing.
 *
 * Lock status: Assumed that no lock is held upon entry.
 *
 * Returns:     Nothing
 *
 * Notes:       In the event that an upper level driver rejects a
 *		command, we must release resources allocated during
 *		the __init_io() function.  Primarily this would involve
580
 *		the scatter-gather table.
L
Linus Torvalds 已提交
581
 */
582
static void scsi_release_buffers(struct scsi_cmnd *cmd)
L
Linus Torvalds 已提交
583
{
584 585 586 587 588 589 590
	if (cmd->sdb.table.nents)
		scsi_free_sgtable(&cmd->sdb);

	memset(&cmd->sdb, 0, sizeof(cmd->sdb));

	if (scsi_prot_sg_count(cmd))
		scsi_free_sgtable(cmd->prot_sdb);
L
Linus Torvalds 已提交
591 592
}

593 594 595 596 597 598 599 600 601
static void scsi_release_bidi_buffers(struct scsi_cmnd *cmd)
{
	struct scsi_data_buffer *bidi_sdb = cmd->request->next_rq->special;

	scsi_free_sgtable(bidi_sdb);
	kmem_cache_free(scsi_sdb_cache, bidi_sdb);
	cmd->request->next_rq->special = NULL;
}

602 603 604 605 606 607 608 609 610 611
/**
 * __scsi_error_from_host_byte - translate SCSI error code into errno
 * @cmd:	SCSI command (unused)
 * @result:	scsi error code
 *
 * Translate SCSI error code into standard UNIX errno.
 * Return values:
 * -ENOLINK	temporary transport failure
 * -EREMOTEIO	permanent target failure, do not retry
 * -EBADE	permanent nexus failure, retry on other path
612
 * -ENOSPC	No write space available
613
 * -ENODATA	Medium error
614 615
 * -EIO		unspecified I/O error
 */
616 617 618 619 620 621 622 623 624
static int __scsi_error_from_host_byte(struct scsi_cmnd *cmd, int result)
{
	int error = 0;

	switch(host_byte(result)) {
	case DID_TRANSPORT_FAILFAST:
		error = -ENOLINK;
		break;
	case DID_TARGET_FAILURE:
625
		set_host_byte(cmd, DID_OK);
626 627 628
		error = -EREMOTEIO;
		break;
	case DID_NEXUS_FAILURE:
629
		set_host_byte(cmd, DID_OK);
630 631
		error = -EBADE;
		break;
632 633 634 635
	case DID_ALLOC_FAILURE:
		set_host_byte(cmd, DID_OK);
		error = -ENOSPC;
		break;
636 637 638 639
	case DID_MEDIUM_ERROR:
		set_host_byte(cmd, DID_OK);
		error = -ENODATA;
		break;
640 641 642 643 644 645 646 647
	default:
		error = -EIO;
		break;
	}

	return error;
}

L
Linus Torvalds 已提交
648 649 650 651 652 653 654 655 656 657 658
/*
 * Function:    scsi_io_completion()
 *
 * Purpose:     Completion processing for block device I/O requests.
 *
 * Arguments:   cmd   - command that is finished.
 *
 * Lock status: Assumed that no lock is held upon entry.
 *
 * Returns:     Nothing
 *
659 660 661
 * Notes:       We will finish off the specified number of sectors.  If we
 *		are done, the command block will be released and the queue
 *		function will be goosed.  If we are not done then we have to
A
Alan Stern 已提交
662
 *		figure out what to do next:
L
Linus Torvalds 已提交
663
 *
A
Alan Stern 已提交
664 665 666 667 668
 *		a) We can call scsi_requeue_command().  The request
 *		   will be unprepared and put back on the queue.  Then
 *		   a new command will be created for it.  This should
 *		   be used if we made forward progress, or if we want
 *		   to switch from READ(10) to READ(6) for example.
L
Linus Torvalds 已提交
669
 *
670
 *		b) We can call __scsi_queue_insert().  The request will
A
Alan Stern 已提交
671 672 673 674 675
 *		   be put back on the queue and retried using the same
 *		   command as before, possibly after a delay.
 *
 *		c) We can call blk_end_request() with -EIO to fail
 *		   the remainder of the request.
L
Linus Torvalds 已提交
676
 */
677
void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
L
Linus Torvalds 已提交
678 679
{
	int result = cmd->result;
680
	struct request_queue *q = cmd->device->request_queue;
L
Linus Torvalds 已提交
681
	struct request *req = cmd->request;
682
	int error = 0;
L
Linus Torvalds 已提交
683 684 685
	struct scsi_sense_hdr sshdr;
	int sense_valid = 0;
	int sense_deferred = 0;
A
Alan Stern 已提交
686 687
	enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
	      ACTION_DELAYED_RETRY} action;
688
	unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
L
Linus Torvalds 已提交
689 690 691 692 693 694

	if (result) {
		sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
		if (sense_valid)
			sense_deferred = scsi_sense_is_deferred(&sshdr);
	}
695

696
	if (req->cmd_type == REQ_TYPE_BLOCK_PC) { /* SG_IO ioctl from block level */
L
Linus Torvalds 已提交
697 698 699 700 701 702 703 704 705 706 707 708
		if (result) {
			if (sense_valid && req->sense) {
				/*
				 * SG_IO wants current and deferred errors
				 */
				int len = 8 + cmd->sense_buffer[7];

				if (len > SCSI_SENSE_BUFFERSIZE)
					len = SCSI_SENSE_BUFFERSIZE;
				memcpy(req->sense, cmd->sense_buffer,  len);
				req->sense_len = len;
			}
709
			if (!sense_deferred)
710
				error = __scsi_error_from_host_byte(cmd, result);
711
		}
712 713 714 715
		/*
		 * __scsi_error_from_host_byte may have reset the host_byte
		 */
		req->errors = cmd->result;
716 717 718

		req->resid_len = scsi_get_resid(cmd);

719
		if (scsi_bidi_cmnd(cmd)) {
720 721 722 723 724 725
			/*
			 * Bidi commands Must be complete as a whole,
			 * both sides at once.
			 */
			req->next_rq->resid_len = scsi_in(cmd)->resid;

726
			scsi_release_buffers(cmd);
727
			scsi_release_bidi_buffers(cmd);
728

729 730 731
			blk_end_request_all(req, 0);

			scsi_next_command(cmd);
732 733
			return;
		}
734 735 736 737 738 739 740 741
	} else if (blk_rq_bytes(req) == 0 && result && !sense_deferred) {
		/*
		 * Certain non BLOCK_PC requests are commands that don't
		 * actually transfer anything (FLUSH), so cannot use
		 * good_bytes != blk_rq_bytes(req) as the signal for an error.
		 * This sets the error explicitly for the problem case.
		 */
		error = __scsi_error_from_host_byte(cmd, result);
L
Linus Torvalds 已提交
742 743
	}

744 745
	/* no bidi support for !REQ_TYPE_BLOCK_PC yet */
	BUG_ON(blk_bidi_rq(req));
B
Boaz Harrosh 已提交
746

L
Linus Torvalds 已提交
747 748 749 750
	/*
	 * Next deal with any sectors which we were able to correctly
	 * handle.
	 */
751 752 753
	SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
		"%u sectors total, %d bytes done.\n",
		blk_rq_sectors(req), good_bytes));
754

755 756 757 758 759 760
	/*
	 * Recovered errors need reporting, but they're always treated
	 * as success, so fiddle the result code here.  For BLOCK_PC
	 * we already took a copy of the original into rq->errors which
	 * is what gets returned to the user
	 */
761 762 763 764 765 766 767 768
	if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
		/* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
		 * print since caller wants ATA registers. Only occurs on
		 * SCSI ATA PASS_THROUGH commands when CK_COND=1
		 */
		if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
			;
		else if (!(req->cmd_flags & REQ_QUIET))
769 770 771 772 773 774 775
			scsi_print_sense("", cmd);
		result = 0;
		/* BLOCK_PC may have set error */
		error = 0;
	}

	/*
776
	 * If we finished all bytes in the request we are done now.
777
	 */
778 779 780 781 782 783 784 785 786 787 788 789 790 791
	if (!blk_end_request(req, error, good_bytes))
		goto next_command;

	/*
	 * Kill remainder if no retrys.
	 */
	if (error && scsi_noretry_cmd(cmd)) {
		blk_end_request_all(req, error);
		goto next_command;
	}

	/*
	 * If there had been no error, but we have leftover bytes in the
	 * requeues just queue the command up again.
792
	 */
793 794
	if (result == 0)
		goto requeue;
795

796
	error = __scsi_error_from_host_byte(cmd, result);
797

A
Alan Stern 已提交
798 799 800 801 802 803 804
	if (host_byte(result) == DID_RESET) {
		/* Third party bus reset or reset for error recovery
		 * reasons.  Just retry the command and see what
		 * happens.
		 */
		action = ACTION_RETRY;
	} else if (sense_valid && !sense_deferred) {
L
Linus Torvalds 已提交
805 806 807
		switch (sshdr.sense_key) {
		case UNIT_ATTENTION:
			if (cmd->device->removable) {
808
				/* Detected disc change.  Set a bit
L
Linus Torvalds 已提交
809 810 811
				 * and quietly refuse further access.
				 */
				cmd->device->changed = 1;
A
Alan Stern 已提交
812
				action = ACTION_FAIL;
L
Linus Torvalds 已提交
813
			} else {
814 815 816
				/* Must have been a power glitch, or a
				 * bus reset.  Could not have been a
				 * media change, so we just retry the
A
Alan Stern 已提交
817
				 * command and see what happens.
818
				 */
A
Alan Stern 已提交
819
				action = ACTION_RETRY;
L
Linus Torvalds 已提交
820 821 822
			}
			break;
		case ILLEGAL_REQUEST:
823 824 825 826 827 828 829 830
			/* If we had an ILLEGAL REQUEST returned, then
			 * we may have performed an unsupported
			 * command.  The only thing this should be
			 * would be a ten byte read where only a six
			 * byte read was supported.  Also, on a system
			 * where READ CAPACITY failed, we may have
			 * read past the end of the disk.
			 */
831 832
			if ((cmd->device->use_10_for_rw &&
			    sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
L
Linus Torvalds 已提交
833 834
			    (cmd->cmnd[0] == READ_10 ||
			     cmd->cmnd[0] == WRITE_10)) {
A
Alan Stern 已提交
835
				/* This will issue a new 6-byte command. */
L
Linus Torvalds 已提交
836
				cmd->device->use_10_for_rw = 0;
A
Alan Stern 已提交
837
				action = ACTION_REPREP;
838 839 840
			} else if (sshdr.asc == 0x10) /* DIX */ {
				action = ACTION_FAIL;
				error = -EILSEQ;
841
			/* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
842
			} else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
843
				action = ACTION_FAIL;
844
				error = -EREMOTEIO;
A
Alan Stern 已提交
845 846 847
			} else
				action = ACTION_FAIL;
			break;
848
		case ABORTED_COMMAND:
849
			action = ACTION_FAIL;
850
			if (sshdr.asc == 0x10) /* DIF */
851
				error = -EILSEQ;
L
Linus Torvalds 已提交
852 853
			break;
		case NOT_READY:
854
			/* If the device is in the process of becoming
J
James Bottomley 已提交
855
			 * ready, or has a temporary blockage, retry.
L
Linus Torvalds 已提交
856
			 */
J
James Bottomley 已提交
857 858 859 860 861 862 863 864 865
			if (sshdr.asc == 0x04) {
				switch (sshdr.ascq) {
				case 0x01: /* becoming ready */
				case 0x04: /* format in progress */
				case 0x05: /* rebuild in progress */
				case 0x06: /* recalculation in progress */
				case 0x07: /* operation in progress */
				case 0x08: /* Long write in progress */
				case 0x09: /* self test in progress */
866
				case 0x14: /* space allocation in progress */
A
Alan Stern 已提交
867
					action = ACTION_DELAYED_RETRY;
J
James Bottomley 已提交
868
					break;
869 870 871
				default:
					action = ACTION_FAIL;
					break;
J
James Bottomley 已提交
872
				}
873
			} else
A
Alan Stern 已提交
874 875
				action = ACTION_FAIL;
			break;
L
Linus Torvalds 已提交
876
		case VOLUME_OVERFLOW:
877
			/* See SSC3rXX or current. */
A
Alan Stern 已提交
878 879
			action = ACTION_FAIL;
			break;
L
Linus Torvalds 已提交
880
		default:
A
Alan Stern 已提交
881
			action = ACTION_FAIL;
L
Linus Torvalds 已提交
882 883
			break;
		}
884
	} else
A
Alan Stern 已提交
885 886
		action = ACTION_FAIL;

887
	if (action != ACTION_FAIL &&
888
	    time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
889 890
		action = ACTION_FAIL;

A
Alan Stern 已提交
891 892 893
	switch (action) {
	case ACTION_FAIL:
		/* Give up and fail the remainder of the request */
894
		if (!(req->cmd_flags & REQ_QUIET)) {
895
			scsi_print_result(cmd);
896 897
			if (driver_byte(result) & DRIVER_SENSE)
				scsi_print_sense("", cmd);
898
			scsi_print_command(cmd);
899
		}
900 901 902
		if (!blk_end_request_err(req, error))
			goto next_command;
		/*FALLTHRU*/
A
Alan Stern 已提交
903
	case ACTION_REPREP:
904
	requeue:
A
Alan Stern 已提交
905 906 907
		/* Unprep the request and put it back at the head of the queue.
		 * A new command will be prepared and issued.
		 */
908
		scsi_release_buffers(cmd);
A
Alan Stern 已提交
909 910 911 912
		scsi_requeue_command(q, cmd);
		break;
	case ACTION_RETRY:
		/* Retry the same command immediately */
913
		__scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
A
Alan Stern 已提交
914 915 916
		break;
	case ACTION_DELAYED_RETRY:
		/* Retry the same command after a delay */
917
		__scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
A
Alan Stern 已提交
918
		break;
L
Linus Torvalds 已提交
919
	}
920 921 922 923 924
	return;

next_command:
	scsi_release_buffers(cmd);
	scsi_next_command(cmd);
L
Linus Torvalds 已提交
925 926
}

927 928
static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb,
			     gfp_t gfp_mask)
L
Linus Torvalds 已提交
929
{
930
	int count;
L
Linus Torvalds 已提交
931 932

	/*
C
Christoph Hellwig 已提交
933
	 * If sg table allocation fails, requeue request later.
L
Linus Torvalds 已提交
934
	 */
B
Boaz Harrosh 已提交
935 936
	if (unlikely(scsi_alloc_sgtable(sdb, req->nr_phys_segments,
					gfp_mask))) {
L
Linus Torvalds 已提交
937
		return BLKPREP_DEFER;
A
Alan Stern 已提交
938
	}
L
Linus Torvalds 已提交
939 940 941 942 943

	/* 
	 * Next, walk the list, and fill in the addresses and sizes of
	 * each segment.
	 */
B
Boaz Harrosh 已提交
944 945 946
	count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
	BUG_ON(count > sdb->table.nents);
	sdb->table.nents = count;
947
	sdb->length = blk_rq_bytes(req);
948
	return BLKPREP_OK;
L
Linus Torvalds 已提交
949
}
950 951 952 953 954 955 956 957 958 959 960 961 962 963

/*
 * Function:    scsi_init_io()
 *
 * Purpose:     SCSI I/O initialize function.
 *
 * Arguments:   cmd   - Command descriptor we wish to initialize
 *
 * Returns:     0 on success
 *		BLKPREP_DEFER if the failure is retryable
 *		BLKPREP_KILL if the failure is fatal
 */
int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask)
{
964
	struct scsi_device *sdev = cmd->device;
965
	struct request *rq = cmd->request;
966
	int error;
967

968 969 970
	BUG_ON(!rq->nr_phys_segments);

	error = scsi_init_sgtable(rq, &cmd->sdb, gfp_mask);
971 972 973
	if (error)
		goto err_exit;

974
	if (blk_bidi_rq(rq)) {
975
		struct scsi_data_buffer *bidi_sdb = kmem_cache_zalloc(
976
			scsi_sdb_cache, GFP_ATOMIC);
977 978 979 980 981
		if (!bidi_sdb) {
			error = BLKPREP_DEFER;
			goto err_exit;
		}

982 983
		rq->next_rq->special = bidi_sdb;
		error = scsi_init_sgtable(rq->next_rq, bidi_sdb, GFP_ATOMIC);
984 985 986 987
		if (error)
			goto err_exit;
	}

988
	if (blk_integrity_rq(rq)) {
989 990 991 992
		struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
		int ivecs, count;

		BUG_ON(prot_sdb == NULL);
993
		ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
994 995 996 997 998 999

		if (scsi_alloc_sgtable(prot_sdb, ivecs, gfp_mask)) {
			error = BLKPREP_DEFER;
			goto err_exit;
		}

1000
		count = blk_rq_map_integrity_sg(rq->q, rq->bio,
1001 1002
						prot_sdb->table.sgl);
		BUG_ON(unlikely(count > ivecs));
1003
		BUG_ON(unlikely(count > queue_max_integrity_segments(rq->q)));
1004 1005 1006 1007 1008

		cmd->prot_sdb = prot_sdb;
		cmd->prot_sdb->table.nents = count;
	}

1009 1010 1011 1012
	return BLKPREP_OK ;

err_exit:
	scsi_release_buffers(cmd);
F
FUJITA Tomonori 已提交
1013
	cmd->request->special = NULL;
1014
	scsi_put_command(cmd);
1015
	put_device(&sdev->sdev_gendev);
1016 1017
	return error;
}
1018
EXPORT_SYMBOL(scsi_init_io);
L
Linus Torvalds 已提交
1019

C
Christoph Hellwig 已提交
1020 1021 1022 1023 1024 1025
static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
		struct request *req)
{
	struct scsi_cmnd *cmd;

	if (!req->special) {
1026 1027 1028 1029
		/* Bail if we can't get a reference to the device */
		if (!get_device(&sdev->sdev_gendev))
			return NULL;

C
Christoph Hellwig 已提交
1030
		cmd = scsi_get_command(sdev, GFP_ATOMIC);
1031 1032
		if (unlikely(!cmd)) {
			put_device(&sdev->sdev_gendev);
C
Christoph Hellwig 已提交
1033
			return NULL;
1034
		}
C
Christoph Hellwig 已提交
1035 1036 1037 1038 1039 1040 1041 1042 1043
		req->special = cmd;
	} else {
		cmd = req->special;
	}

	/* pull a tag out of the request if we have one */
	cmd->tag = req->tag;
	cmd->request = req;

1044
	cmd->cmnd = req->cmd;
1045
	cmd->prot_op = SCSI_PROT_NORMAL;
1046

C
Christoph Hellwig 已提交
1047 1048 1049
	return cmd;
}

1050
int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
J
James Bottomley 已提交
1051
{
1052
	struct scsi_cmnd *cmd = req->special;
C
Christoph Hellwig 已提交
1053 1054 1055 1056 1057 1058 1059 1060

	/*
	 * BLOCK_PC requests may transfer data, in which case they must
	 * a bio attached to them.  Or they might contain a SCSI command
	 * that does not transfer data, in which case they may optionally
	 * submit a request without an attached bio.
	 */
	if (req->bio) {
1061
		int ret = scsi_init_io(cmd, GFP_ATOMIC);
C
Christoph Hellwig 已提交
1062 1063 1064
		if (unlikely(ret))
			return ret;
	} else {
T
Tejun Heo 已提交
1065
		BUG_ON(blk_rq_bytes(req));
C
Christoph Hellwig 已提交
1066

B
Boaz Harrosh 已提交
1067
		memset(&cmd->sdb, 0, sizeof(cmd->sdb));
C
Christoph Hellwig 已提交
1068
	}
J
James Bottomley 已提交
1069 1070

	cmd->cmd_len = req->cmd_len;
T
Tejun Heo 已提交
1071
	if (!blk_rq_bytes(req))
J
James Bottomley 已提交
1072 1073 1074 1075 1076 1077
		cmd->sc_data_direction = DMA_NONE;
	else if (rq_data_dir(req) == WRITE)
		cmd->sc_data_direction = DMA_TO_DEVICE;
	else
		cmd->sc_data_direction = DMA_FROM_DEVICE;
	
T
Tejun Heo 已提交
1078
	cmd->transfersize = blk_rq_bytes(req);
J
James Bottomley 已提交
1079
	cmd->allowed = req->retries;
C
Christoph Hellwig 已提交
1080
	return BLKPREP_OK;
J
James Bottomley 已提交
1081
}
1082
EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
J
James Bottomley 已提交
1083

C
Christoph Hellwig 已提交
1084 1085 1086 1087 1088
/*
 * Setup a REQ_TYPE_FS command.  These are simple read/write request
 * from filesystems that still need to be translated to SCSI CDBs from
 * the ULD.
 */
1089
int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
L
Linus Torvalds 已提交
1090
{
1091
	struct scsi_cmnd *cmd = req->special;
1092 1093 1094

	if (unlikely(sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh
			 && sdev->scsi_dh_data->scsi_dh->prep_fn)) {
1095
		int ret = sdev->scsi_dh_data->scsi_dh->prep_fn(sdev, req);
1096 1097 1098 1099
		if (ret != BLKPREP_OK)
			return ret;
	}

1100
	memset(cmd->cmnd, 0, BLK_MAX_CDB);
1101
	return scsi_init_io(cmd, GFP_ATOMIC);
C
Christoph Hellwig 已提交
1102
}
1103
EXPORT_SYMBOL(scsi_setup_fs_cmnd);
C
Christoph Hellwig 已提交
1104

1105 1106
static int
scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
C
Christoph Hellwig 已提交
1107 1108 1109
{
	int ret = BLKPREP_OK;

L
Linus Torvalds 已提交
1110
	/*
C
Christoph Hellwig 已提交
1111 1112
	 * If the device is not in running state we will reject some
	 * or all commands.
L
Linus Torvalds 已提交
1113
	 */
C
Christoph Hellwig 已提交
1114 1115 1116
	if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
		switch (sdev->sdev_state) {
		case SDEV_OFFLINE:
1117
		case SDEV_TRANSPORT_OFFLINE:
C
Christoph Hellwig 已提交
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
			/*
			 * If the device is offline we refuse to process any
			 * commands.  The device must be brought online
			 * before trying any recovery commands.
			 */
			sdev_printk(KERN_ERR, sdev,
				    "rejecting I/O to offline device\n");
			ret = BLKPREP_KILL;
			break;
		case SDEV_DEL:
			/*
			 * If the device is fully deleted, we refuse to
			 * process any commands as well.
			 */
1132
			sdev_printk(KERN_ERR, sdev,
C
Christoph Hellwig 已提交
1133 1134 1135 1136 1137
				    "rejecting I/O to dead device\n");
			ret = BLKPREP_KILL;
			break;
		case SDEV_QUIESCE:
		case SDEV_BLOCK:
1138
		case SDEV_CREATED_BLOCK:
C
Christoph Hellwig 已提交
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
			/*
			 * If the devices is blocked we defer normal commands.
			 */
			if (!(req->cmd_flags & REQ_PREEMPT))
				ret = BLKPREP_DEFER;
			break;
		default:
			/*
			 * For any other not fully online state we only allow
			 * special commands.  In particular any user initiated
			 * command is not allowed.
			 */
			if (!(req->cmd_flags & REQ_PREEMPT))
				ret = BLKPREP_KILL;
			break;
L
Linus Torvalds 已提交
1154 1155
		}
	}
1156 1157
	return ret;
}
L
Linus Torvalds 已提交
1158

1159 1160
static int
scsi_prep_return(struct request_queue *q, struct request *req, int ret)
1161 1162
{
	struct scsi_device *sdev = q->queuedata;
L
Linus Torvalds 已提交
1163

C
Christoph Hellwig 已提交
1164 1165 1166
	switch (ret) {
	case BLKPREP_KILL:
		req->errors = DID_NO_CONNECT << 16;
1167 1168 1169 1170 1171
		/* release the command and kill it */
		if (req->special) {
			struct scsi_cmnd *cmd = req->special;
			scsi_release_buffers(cmd);
			scsi_put_command(cmd);
1172
			put_device(&sdev->sdev_gendev);
1173 1174
			req->special = NULL;
		}
C
Christoph Hellwig 已提交
1175 1176
		break;
	case BLKPREP_DEFER:
L
Linus Torvalds 已提交
1177
		/*
1178
		 * If we defer, the blk_peek_request() returns NULL, but the
J
Jens Axboe 已提交
1179 1180
		 * queue must be restarted, so we schedule a callback to happen
		 * shortly.
L
Linus Torvalds 已提交
1181
		 */
C
Christoph Hellwig 已提交
1182
		if (sdev->device_busy == 0)
J
Jens Axboe 已提交
1183
			blk_delay_queue(q, SCSI_QUEUE_DELAY);
C
Christoph Hellwig 已提交
1184 1185 1186
		break;
	default:
		req->cmd_flags |= REQ_DONTPREP;
L
Linus Torvalds 已提交
1187 1188
	}

C
Christoph Hellwig 已提交
1189
	return ret;
L
Linus Torvalds 已提交
1190
}
1191

1192
static int scsi_prep_fn(struct request_queue *q, struct request *req)
1193 1194
{
	struct scsi_device *sdev = q->queuedata;
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
	struct scsi_cmnd *cmd;
	int ret;

	ret = scsi_prep_state_check(sdev, req);
	if (ret != BLKPREP_OK)
		goto out;

	cmd = scsi_get_cmd_from_req(sdev, req);
	if (unlikely(!cmd)) {
		ret = BLKPREP_DEFER;
		goto out;
	}
1207

1208 1209 1210
	if (req->cmd_type == REQ_TYPE_FS)
		ret = scsi_cmd_to_driver(cmd)->init_command(cmd);
	else if (req->cmd_type == REQ_TYPE_BLOCK_PC)
1211
		ret = scsi_setup_blk_pc_cmnd(sdev, req);
1212 1213 1214 1215
	else
		ret = BLKPREP_KILL;

out:
1216 1217
	return scsi_prep_return(q, req, ret);
}
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228

static void scsi_unprep_fn(struct request_queue *q, struct request *req)
{
	if (req->cmd_type == REQ_TYPE_FS) {
		struct scsi_cmnd *cmd = req->special;
		struct scsi_driver *drv = scsi_cmd_to_driver(cmd);

		if (drv->uninit_command)
			drv->uninit_command(cmd);
	}
}
L
Linus Torvalds 已提交
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244

/*
 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
 * return 0.
 *
 * Called with the queue_lock held.
 */
static inline int scsi_dev_queue_ready(struct request_queue *q,
				  struct scsi_device *sdev)
{
	if (sdev->device_busy == 0 && sdev->device_blocked) {
		/*
		 * unblock after device_blocked iterates to zero
		 */
		if (--sdev->device_blocked == 0) {
			SCSI_LOG_MLQUEUE(3,
1245 1246
				   sdev_printk(KERN_INFO, sdev,
				   "unblocking device at zero depth\n"));
L
Linus Torvalds 已提交
1247
		} else {
J
Jens Axboe 已提交
1248
			blk_delay_queue(q, SCSI_QUEUE_DELAY);
L
Linus Torvalds 已提交
1249 1250 1251
			return 0;
		}
	}
1252
	if (scsi_device_is_busy(sdev))
L
Linus Torvalds 已提交
1253 1254 1255 1256 1257
		return 0;

	return 1;
}

1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283

/*
 * scsi_target_queue_ready: checks if there we can send commands to target
 * @sdev: scsi device on starget to check.
 *
 * Called with the host lock held.
 */
static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
					   struct scsi_device *sdev)
{
	struct scsi_target *starget = scsi_target(sdev);

	if (starget->single_lun) {
		if (starget->starget_sdev_user &&
		    starget->starget_sdev_user != sdev)
			return 0;
		starget->starget_sdev_user = sdev;
	}

	if (starget->target_busy == 0 && starget->target_blocked) {
		/*
		 * unblock after target_blocked iterates to zero
		 */
		if (--starget->target_blocked == 0) {
			SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
					 "unblocking target at zero depth\n"));
1284
		} else
1285 1286 1287 1288
			return 0;
	}

	if (scsi_target_is_busy(starget)) {
1289
		list_move_tail(&sdev->starved_entry, &shost->starved_list);
1290
		return 0;
1291 1292 1293 1294 1295
	}

	return 1;
}

L
Linus Torvalds 已提交
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
/*
 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
 * return 0. We must end up running the queue again whenever 0 is
 * returned, else IO can hang.
 *
 * Called with host_lock held.
 */
static inline int scsi_host_queue_ready(struct request_queue *q,
				   struct Scsi_Host *shost,
				   struct scsi_device *sdev)
{
1307
	if (scsi_host_in_recovery(shost))
L
Linus Torvalds 已提交
1308 1309 1310 1311 1312 1313 1314
		return 0;
	if (shost->host_busy == 0 && shost->host_blocked) {
		/*
		 * unblock after host_blocked iterates to zero
		 */
		if (--shost->host_blocked == 0) {
			SCSI_LOG_MLQUEUE(3,
1315 1316
				shost_printk(KERN_INFO, shost,
					     "unblocking host at zero depth\n"));
L
Linus Torvalds 已提交
1317 1318 1319 1320
		} else {
			return 0;
		}
	}
1321
	if (scsi_host_is_busy(shost)) {
L
Linus Torvalds 已提交
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
		if (list_empty(&sdev->starved_entry))
			list_add_tail(&sdev->starved_entry, &shost->starved_list);
		return 0;
	}

	/* We're OK to process the command, so we can't be starved */
	if (!list_empty(&sdev->starved_entry))
		list_del_init(&sdev->starved_entry);

	return 1;
}

1334 1335 1336 1337 1338 1339 1340 1341
/*
 * Busy state exporting function for request stacking drivers.
 *
 * For efficiency, no lock is taken to check the busy state of
 * shost/starget/sdev, since the returned value is not guaranteed and
 * may be changed after request stacking drivers call the function,
 * regardless of taking lock or not.
 *
1342 1343 1344
 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi
 * needs to return 'not busy'. Otherwise, request stacking drivers
 * may hold requests forever.
1345 1346 1347 1348 1349 1350
 */
static int scsi_lld_busy(struct request_queue *q)
{
	struct scsi_device *sdev = q->queuedata;
	struct Scsi_Host *shost;

B
Bart Van Assche 已提交
1351
	if (blk_queue_dying(q))
1352 1353 1354 1355
		return 0;

	shost = sdev->host;

1356 1357 1358 1359 1360 1361 1362
	/*
	 * Ignore host/starget busy state.
	 * Since block layer does not have a concept of fairness across
	 * multiple queues, congestion of host/starget needs to be handled
	 * in SCSI layer.
	 */
	if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev))
1363 1364 1365 1366 1367
		return 1;

	return 0;
}

L
Linus Torvalds 已提交
1368
/*
1369
 * Kill a request for a dead device
L
Linus Torvalds 已提交
1370
 */
1371
static void scsi_kill_request(struct request *req, struct request_queue *q)
L
Linus Torvalds 已提交
1372
{
1373
	struct scsi_cmnd *cmd = req->special;
1374 1375 1376
	struct scsi_device *sdev;
	struct scsi_target *starget;
	struct Scsi_Host *shost;
L
Linus Torvalds 已提交
1377

1378
	blk_start_request(req);
1379

1380 1381
	scmd_printk(KERN_INFO, cmd, "killing request\n");

1382 1383 1384
	sdev = cmd->device;
	starget = scsi_target(sdev);
	shost = sdev->host;
1385 1386 1387
	scsi_init_cmd_errh(cmd);
	cmd->result = DID_NO_CONNECT << 16;
	atomic_inc(&cmd->device->iorequest_cnt);
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397

	/*
	 * SCSI request completion path will do scsi_device_unbusy(),
	 * bump busy counts.  To bump the counters, we need to dance
	 * with the locks as normal issue path does.
	 */
	sdev->device_busy++;
	spin_unlock(sdev->request_queue->queue_lock);
	spin_lock(shost->host_lock);
	shost->host_busy++;
1398
	starget->target_busy++;
1399 1400 1401
	spin_unlock(shost->host_lock);
	spin_lock(sdev->request_queue->queue_lock);

J
Jens Axboe 已提交
1402
	blk_complete_request(req);
L
Linus Torvalds 已提交
1403 1404
}

1405 1406
static void scsi_softirq_done(struct request *rq)
{
J
Jens Axboe 已提交
1407 1408
	struct scsi_cmnd *cmd = rq->special;
	unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
1409 1410 1411 1412
	int disposition;

	INIT_LIST_HEAD(&cmd->eh_entry);

J
Jens Axboe 已提交
1413 1414 1415 1416
	atomic_inc(&cmd->device->iodone_cnt);
	if (cmd->result)
		atomic_inc(&cmd->device->ioerr_cnt);

1417 1418 1419 1420 1421 1422 1423 1424
	disposition = scsi_decide_disposition(cmd);
	if (disposition != SUCCESS &&
	    time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
		sdev_printk(KERN_ERR, cmd->device,
			    "timing out command, waited %lus\n",
			    wait_for/HZ);
		disposition = SUCCESS;
	}
1425

1426 1427 1428 1429 1430 1431 1432
	scsi_log_completion(cmd, disposition);

	switch (disposition) {
		case SUCCESS:
			scsi_finish_command(cmd);
			break;
		case NEEDS_RETRY:
1433
			scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
			break;
		case ADD_TO_MLQUEUE:
			scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
			break;
		default:
			if (!scsi_eh_scmd_add(cmd, 0))
				scsi_finish_command(cmd);
	}
}

L
Linus Torvalds 已提交
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
/*
 * Function:    scsi_request_fn()
 *
 * Purpose:     Main strategy routine for SCSI.
 *
 * Arguments:   q       - Pointer to actual queue.
 *
 * Returns:     Nothing
 *
 * Lock status: IO request lock assumed to be held when called.
 */
static void scsi_request_fn(struct request_queue *q)
1456 1457
	__releases(q->queue_lock)
	__acquires(q->queue_lock)
L
Linus Torvalds 已提交
1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
{
	struct scsi_device *sdev = q->queuedata;
	struct Scsi_Host *shost;
	struct scsi_cmnd *cmd;
	struct request *req;

	/*
	 * To start with, we keep looping until the queue is empty, or until
	 * the host is no longer able to accept any more requests.
	 */
	shost = sdev->host;
J
Jens Axboe 已提交
1469
	for (;;) {
L
Linus Torvalds 已提交
1470 1471 1472
		int rtn;
		/*
		 * get next queueable request.  We do this early to make sure
1473
		 * that the request is fully prepared even if we cannot
L
Linus Torvalds 已提交
1474 1475
		 * accept it.
		 */
1476
		req = blk_peek_request(q);
L
Linus Torvalds 已提交
1477 1478 1479 1480
		if (!req || !scsi_dev_queue_ready(q, sdev))
			break;

		if (unlikely(!scsi_device_online(sdev))) {
1481 1482
			sdev_printk(KERN_ERR, sdev,
				    "rejecting I/O to offline device\n");
1483
			scsi_kill_request(req, q);
L
Linus Torvalds 已提交
1484 1485 1486 1487 1488 1489 1490 1491
			continue;
		}


		/*
		 * Remove the request from the request list.
		 */
		if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
1492
			blk_start_request(req);
L
Linus Torvalds 已提交
1493 1494 1495
		sdev->device_busy++;

		spin_unlock(q->queue_lock);
1496 1497 1498 1499
		cmd = req->special;
		if (unlikely(cmd == NULL)) {
			printk(KERN_CRIT "impossible request in %s.\n"
					 "please mail a stack trace to "
1500
					 "linux-scsi@vger.kernel.org\n",
1501
					 __func__);
1502
			blk_dump_rq_flags(req, "foo");
1503 1504
			BUG();
		}
L
Linus Torvalds 已提交
1505 1506
		spin_lock(shost->host_lock);

1507 1508 1509 1510 1511 1512 1513 1514
		/*
		 * We hit this when the driver is using a host wide
		 * tag map. For device level tag maps the queue_depth check
		 * in the device ready fn would prevent us from trying
		 * to allocate a tag. Since the map is a shared host resource
		 * we add the dev to the starved list so it eventually gets
		 * a run when a tag is freed.
		 */
1515
		if (blk_queue_tagged(q) && !blk_rq_tagged(req)) {
1516 1517 1518 1519 1520 1521
			if (list_empty(&sdev->starved_entry))
				list_add_tail(&sdev->starved_entry,
					      &shost->starved_list);
			goto not_ready;
		}

1522 1523 1524
		if (!scsi_target_queue_ready(shost, sdev))
			goto not_ready;

L
Linus Torvalds 已提交
1525 1526
		if (!scsi_host_queue_ready(q, shost, sdev))
			goto not_ready;
1527 1528

		scsi_target(sdev)->target_busy++;
L
Linus Torvalds 已提交
1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
		shost->host_busy++;

		/*
		 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
		 *		take the lock again.
		 */
		spin_unlock_irq(shost->host_lock);

		/*
		 * Finally, initialize any error handling parameters, and set up
		 * the timers for timeouts.
		 */
		scsi_init_cmd_errh(cmd);

		/*
		 * Dispatch the command to the low-level driver.
		 */
		rtn = scsi_dispatch_cmd(cmd);
		spin_lock_irq(q->queue_lock);
J
Jens Axboe 已提交
1548 1549
		if (rtn)
			goto out_delay;
L
Linus Torvalds 已提交
1550 1551
	}

1552
	return;
L
Linus Torvalds 已提交
1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567

 not_ready:
	spin_unlock_irq(shost->host_lock);

	/*
	 * lock q, handle tag, requeue req, and decrement device_busy. We
	 * must return with queue_lock held.
	 *
	 * Decrementing device_busy without checking it is OK, as all such
	 * cases (host limits or settings) should run the queue at some
	 * later time.
	 */
	spin_lock_irq(q->queue_lock);
	blk_requeue_request(q, req);
	sdev->device_busy--;
J
Jens Axboe 已提交
1568 1569 1570
out_delay:
	if (sdev->device_busy == 0)
		blk_delay_queue(q, SCSI_QUEUE_DELAY);
L
Linus Torvalds 已提交
1571 1572
}

1573
static u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
L
Linus Torvalds 已提交
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
{
	struct device *host_dev;
	u64 bounce_limit = 0xffffffff;

	if (shost->unchecked_isa_dma)
		return BLK_BOUNCE_ISA;
	/*
	 * Platforms with virtual-DMA translation
	 * hardware have no practical limit.
	 */
	if (!PCI_DMA_BUS_IS_PHYS)
		return BLK_BOUNCE_ANY;

	host_dev = scsi_get_device(shost);
	if (host_dev && host_dev->dma_mask)
1589
		bounce_limit = (u64)dma_max_pfn(host_dev) << PAGE_SHIFT;
L
Linus Torvalds 已提交
1590 1591 1592 1593

	return bounce_limit;
}

1594 1595
struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
					 request_fn_proc *request_fn)
L
Linus Torvalds 已提交
1596 1597
{
	struct request_queue *q;
1598
	struct device *dev = shost->dma_dev;
L
Linus Torvalds 已提交
1599

1600
	q = blk_init_queue(request_fn, NULL);
L
Linus Torvalds 已提交
1601 1602 1603
	if (!q)
		return NULL;

1604 1605 1606
	/*
	 * this limit is imposed by hardware restrictions
	 */
1607 1608
	blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
					SCSI_MAX_SG_CHAIN_SEGMENTS));
1609

1610 1611 1612 1613 1614 1615 1616 1617
	if (scsi_host_prot_dma(shost)) {
		shost->sg_prot_tablesize =
			min_not_zero(shost->sg_prot_tablesize,
				     (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS);
		BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize);
		blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize);
	}

1618
	blk_queue_max_hw_sectors(q, shost->max_sectors);
L
Linus Torvalds 已提交
1619 1620
	blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
	blk_queue_segment_boundary(q, shost->dma_boundary);
1621
	dma_set_seg_boundary(dev, shost->dma_boundary);
L
Linus Torvalds 已提交
1622

1623 1624
	blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));

L
Linus Torvalds 已提交
1625
	if (!shost->use_clustering)
1626
		q->limits.cluster = 0;
1627 1628 1629 1630 1631 1632 1633 1634

	/*
	 * set a reasonable default alignment on word boundaries: the
	 * host and device may alter it using
	 * blk_queue_update_dma_alignment() later.
	 */
	blk_queue_dma_alignment(q, 0x03);

L
Linus Torvalds 已提交
1635 1636
	return q;
}
1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
EXPORT_SYMBOL(__scsi_alloc_queue);

struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
{
	struct request_queue *q;

	q = __scsi_alloc_queue(sdev->host, scsi_request_fn);
	if (!q)
		return NULL;

	blk_queue_prep_rq(q, scsi_prep_fn);
1648
	blk_queue_unprep_rq(q, scsi_unprep_fn);
1649
	blk_queue_softirq_done(q, scsi_softirq_done);
J
Jens Axboe 已提交
1650
	blk_queue_rq_timed_out(q, scsi_times_out);
1651
	blk_queue_lld_busy(q, scsi_lld_busy);
1652 1653
	return q;
}
L
Linus Torvalds 已提交
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707

/*
 * Function:    scsi_block_requests()
 *
 * Purpose:     Utility function used by low-level drivers to prevent further
 *		commands from being queued to the device.
 *
 * Arguments:   shost       - Host in question
 *
 * Returns:     Nothing
 *
 * Lock status: No locks are assumed held.
 *
 * Notes:       There is no timer nor any other means by which the requests
 *		get unblocked other than the low-level driver calling
 *		scsi_unblock_requests().
 */
void scsi_block_requests(struct Scsi_Host *shost)
{
	shost->host_self_blocked = 1;
}
EXPORT_SYMBOL(scsi_block_requests);

/*
 * Function:    scsi_unblock_requests()
 *
 * Purpose:     Utility function used by low-level drivers to allow further
 *		commands from being queued to the device.
 *
 * Arguments:   shost       - Host in question
 *
 * Returns:     Nothing
 *
 * Lock status: No locks are assumed held.
 *
 * Notes:       There is no timer nor any other means by which the requests
 *		get unblocked other than the low-level driver calling
 *		scsi_unblock_requests().
 *
 *		This is done as an API function so that changes to the
 *		internals of the scsi mid-layer won't require wholesale
 *		changes to drivers that use this feature.
 */
void scsi_unblock_requests(struct Scsi_Host *shost)
{
	shost->host_self_blocked = 0;
	scsi_run_host_queues(shost);
}
EXPORT_SYMBOL(scsi_unblock_requests);

int __init scsi_init_queue(void)
{
	int i;

1708 1709 1710 1711 1712
	scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
					   sizeof(struct scsi_data_buffer),
					   0, 0, NULL);
	if (!scsi_sdb_cache) {
		printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
F
FUJITA Tomonori 已提交
1713
		return -ENOMEM;
1714 1715
	}

L
Linus Torvalds 已提交
1716 1717 1718 1719 1720
	for (i = 0; i < SG_MEMPOOL_NR; i++) {
		struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
		int size = sgp->size * sizeof(struct scatterlist);

		sgp->slab = kmem_cache_create(sgp->name, size, 0,
1721
				SLAB_HWCACHE_ALIGN, NULL);
L
Linus Torvalds 已提交
1722 1723 1724
		if (!sgp->slab) {
			printk(KERN_ERR "SCSI: can't init sg slab %s\n",
					sgp->name);
1725
			goto cleanup_sdb;
L
Linus Torvalds 已提交
1726 1727
		}

1728 1729
		sgp->pool = mempool_create_slab_pool(SG_MEMPOOL_SIZE,
						     sgp->slab);
L
Linus Torvalds 已提交
1730 1731 1732
		if (!sgp->pool) {
			printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
					sgp->name);
1733
			goto cleanup_sdb;
L
Linus Torvalds 已提交
1734 1735 1736 1737
		}
	}

	return 0;
1738

1739
cleanup_sdb:
1740 1741 1742 1743 1744 1745 1746
	for (i = 0; i < SG_MEMPOOL_NR; i++) {
		struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
		if (sgp->pool)
			mempool_destroy(sgp->pool);
		if (sgp->slab)
			kmem_cache_destroy(sgp->slab);
	}
1747
	kmem_cache_destroy(scsi_sdb_cache);
1748 1749

	return -ENOMEM;
L
Linus Torvalds 已提交
1750 1751 1752 1753 1754 1755
}

void scsi_exit_queue(void)
{
	int i;

1756
	kmem_cache_destroy(scsi_sdb_cache);
1757

L
Linus Torvalds 已提交
1758 1759 1760 1761 1762 1763
	for (i = 0; i < SG_MEMPOOL_NR; i++) {
		struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
		mempool_destroy(sgp->pool);
		kmem_cache_destroy(sgp->slab);
	}
}
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775

/**
 *	scsi_mode_select - issue a mode select
 *	@sdev:	SCSI device to be queried
 *	@pf:	Page format bit (1 == standard, 0 == vendor specific)
 *	@sp:	Save page bit (0 == don't save, 1 == save)
 *	@modepage: mode page being requested
 *	@buffer: request buffer (may not be smaller than eight bytes)
 *	@len:	length of request buffer.
 *	@timeout: command timeout
 *	@retries: number of retries before failing
 *	@data: returns a structure abstracting the mode header data
1776
 *	@sshdr: place to put sense data (or NULL if no sense to be collected).
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835
 *		must be SCSI_SENSE_BUFFERSIZE big.
 *
 *	Returns zero if successful; negative error number or scsi
 *	status on error
 *
 */
int
scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
		 unsigned char *buffer, int len, int timeout, int retries,
		 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
{
	unsigned char cmd[10];
	unsigned char *real_buffer;
	int ret;

	memset(cmd, 0, sizeof(cmd));
	cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);

	if (sdev->use_10_for_ms) {
		if (len > 65535)
			return -EINVAL;
		real_buffer = kmalloc(8 + len, GFP_KERNEL);
		if (!real_buffer)
			return -ENOMEM;
		memcpy(real_buffer + 8, buffer, len);
		len += 8;
		real_buffer[0] = 0;
		real_buffer[1] = 0;
		real_buffer[2] = data->medium_type;
		real_buffer[3] = data->device_specific;
		real_buffer[4] = data->longlba ? 0x01 : 0;
		real_buffer[5] = 0;
		real_buffer[6] = data->block_descriptor_length >> 8;
		real_buffer[7] = data->block_descriptor_length;

		cmd[0] = MODE_SELECT_10;
		cmd[7] = len >> 8;
		cmd[8] = len;
	} else {
		if (len > 255 || data->block_descriptor_length > 255 ||
		    data->longlba)
			return -EINVAL;

		real_buffer = kmalloc(4 + len, GFP_KERNEL);
		if (!real_buffer)
			return -ENOMEM;
		memcpy(real_buffer + 4, buffer, len);
		len += 4;
		real_buffer[0] = 0;
		real_buffer[1] = data->medium_type;
		real_buffer[2] = data->device_specific;
		real_buffer[3] = data->block_descriptor_length;
		

		cmd[0] = MODE_SELECT;
		cmd[4] = len;
	}

	ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
1836
			       sshdr, timeout, retries, NULL);
1837 1838 1839 1840 1841
	kfree(real_buffer);
	return ret;
}
EXPORT_SYMBOL_GPL(scsi_mode_select);

L
Linus Torvalds 已提交
1842
/**
1843
 *	scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
1844
 *	@sdev:	SCSI device to be queried
L
Linus Torvalds 已提交
1845 1846 1847 1848 1849 1850 1851
 *	@dbd:	set if mode sense will allow block descriptors to be returned
 *	@modepage: mode page being requested
 *	@buffer: request buffer (may not be smaller than eight bytes)
 *	@len:	length of request buffer.
 *	@timeout: command timeout
 *	@retries: number of retries before failing
 *	@data: returns a structure abstracting the mode header data
1852
 *	@sshdr: place to put sense data (or NULL if no sense to be collected).
1853
 *		must be SCSI_SENSE_BUFFERSIZE big.
L
Linus Torvalds 已提交
1854 1855 1856 1857
 *
 *	Returns zero if unsuccessful, or the header offset (either 4
 *	or 8 depending on whether a six or ten byte command was
 *	issued) if successful.
1858
 */
L
Linus Torvalds 已提交
1859
int
1860
scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
L
Linus Torvalds 已提交
1861
		  unsigned char *buffer, int len, int timeout, int retries,
1862 1863
		  struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
{
L
Linus Torvalds 已提交
1864 1865 1866
	unsigned char cmd[12];
	int use_10_for_ms;
	int header_length;
1867
	int result;
1868
	struct scsi_sense_hdr my_sshdr;
L
Linus Torvalds 已提交
1869 1870 1871 1872 1873 1874

	memset(data, 0, sizeof(*data));
	memset(&cmd[0], 0, 12);
	cmd[1] = dbd & 0x18;	/* allows DBD and LLBA bits */
	cmd[2] = modepage;

1875 1876 1877 1878
	/* caller might not be interested in sense, but we need it */
	if (!sshdr)
		sshdr = &my_sshdr;

L
Linus Torvalds 已提交
1879
 retry:
1880
	use_10_for_ms = sdev->use_10_for_ms;
L
Linus Torvalds 已提交
1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899

	if (use_10_for_ms) {
		if (len < 8)
			len = 8;

		cmd[0] = MODE_SENSE_10;
		cmd[8] = len;
		header_length = 8;
	} else {
		if (len < 4)
			len = 4;

		cmd[0] = MODE_SENSE;
		cmd[4] = len;
		header_length = 4;
	}

	memset(buffer, 0, len);

1900
	result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
1901
				  sshdr, timeout, retries, NULL);
L
Linus Torvalds 已提交
1902 1903 1904 1905 1906 1907

	/* This code looks awful: what it's doing is making sure an
	 * ILLEGAL REQUEST sense return identifies the actual command
	 * byte as the problem.  MODE_SENSE commands can return
	 * ILLEGAL REQUEST if the code page isn't supported */

1908 1909
	if (use_10_for_ms && !scsi_status_is_good(result) &&
	    (driver_byte(result) & DRIVER_SENSE)) {
1910 1911 1912
		if (scsi_sense_valid(sshdr)) {
			if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
			    (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
L
Linus Torvalds 已提交
1913 1914 1915
				/* 
				 * Invalid command operation code
				 */
1916
				sdev->use_10_for_ms = 0;
L
Linus Torvalds 已提交
1917 1918 1919 1920 1921
				goto retry;
			}
		}
	}

1922
	if(scsi_status_is_good(result)) {
1923 1924 1925 1926 1927 1928 1929 1930 1931 1932
		if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
			     (modepage == 6 || modepage == 8))) {
			/* Initio breakage? */
			header_length = 0;
			data->length = 13;
			data->medium_type = 0;
			data->device_specific = 0;
			data->longlba = 0;
			data->block_descriptor_length = 0;
		} else if(use_10_for_ms) {
L
Linus Torvalds 已提交
1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944
			data->length = buffer[0]*256 + buffer[1] + 2;
			data->medium_type = buffer[2];
			data->device_specific = buffer[3];
			data->longlba = buffer[4] & 0x01;
			data->block_descriptor_length = buffer[6]*256
				+ buffer[7];
		} else {
			data->length = buffer[0] + 1;
			data->medium_type = buffer[1];
			data->device_specific = buffer[2];
			data->block_descriptor_length = buffer[3];
		}
1945
		data->header_length = header_length;
L
Linus Torvalds 已提交
1946 1947
	}

1948
	return result;
L
Linus Torvalds 已提交
1949 1950 1951
}
EXPORT_SYMBOL(scsi_mode_sense);

1952 1953 1954 1955 1956 1957 1958 1959 1960 1961
/**
 *	scsi_test_unit_ready - test if unit is ready
 *	@sdev:	scsi device to change the state of.
 *	@timeout: command timeout
 *	@retries: number of retries before failing
 *	@sshdr_external: Optional pointer to struct scsi_sense_hdr for
 *		returning sense. Make sure that this is cleared before passing
 *		in.
 *
 *	Returns zero if unsuccessful or an error if TUR failed.  For
1962
 *	removable media, UNIT_ATTENTION sets ->changed flag.
1963
 **/
L
Linus Torvalds 已提交
1964
int
1965 1966
scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
		     struct scsi_sense_hdr *sshdr_external)
L
Linus Torvalds 已提交
1967 1968 1969 1970
{
	char cmd[] = {
		TEST_UNIT_READY, 0, 0, 0, 0, 0,
	};
1971
	struct scsi_sense_hdr *sshdr;
L
Linus Torvalds 已提交
1972
	int result;
1973 1974 1975 1976 1977 1978 1979 1980 1981

	if (!sshdr_external)
		sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
	else
		sshdr = sshdr_external;

	/* try to eat the UNIT_ATTENTION if there are enough retries */
	do {
		result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
1982
					  timeout, retries, NULL);
1983 1984 1985 1986 1987
		if (sdev->removable && scsi_sense_valid(sshdr) &&
		    sshdr->sense_key == UNIT_ATTENTION)
			sdev->changed = 1;
	} while (scsi_sense_valid(sshdr) &&
		 sshdr->sense_key == UNIT_ATTENTION && --retries);
1988 1989 1990

	if (!sshdr_external)
		kfree(sshdr);
L
Linus Torvalds 已提交
1991 1992 1993 1994 1995
	return result;
}
EXPORT_SYMBOL(scsi_test_unit_ready);

/**
1996
 *	scsi_device_set_state - Take the given device through the device state model.
L
Linus Torvalds 已提交
1997 1998 1999 2000 2001
 *	@sdev:	scsi device to change the state of.
 *	@state:	state to change to.
 *
 *	Returns zero if unsuccessful or an error if the requested 
 *	transition is illegal.
2002
 */
L
Linus Torvalds 已提交
2003 2004 2005 2006 2007 2008 2009 2010 2011 2012
int
scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
{
	enum scsi_device_state oldstate = sdev->sdev_state;

	if (state == oldstate)
		return 0;

	switch (state) {
	case SDEV_CREATED:
2013 2014 2015 2016 2017 2018 2019
		switch (oldstate) {
		case SDEV_CREATED_BLOCK:
			break;
		default:
			goto illegal;
		}
		break;
L
Linus Torvalds 已提交
2020 2021 2022 2023 2024
			
	case SDEV_RUNNING:
		switch (oldstate) {
		case SDEV_CREATED:
		case SDEV_OFFLINE:
2025
		case SDEV_TRANSPORT_OFFLINE:
L
Linus Torvalds 已提交
2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037
		case SDEV_QUIESCE:
		case SDEV_BLOCK:
			break;
		default:
			goto illegal;
		}
		break;

	case SDEV_QUIESCE:
		switch (oldstate) {
		case SDEV_RUNNING:
		case SDEV_OFFLINE:
2038
		case SDEV_TRANSPORT_OFFLINE:
L
Linus Torvalds 已提交
2039 2040 2041 2042 2043 2044 2045
			break;
		default:
			goto illegal;
		}
		break;

	case SDEV_OFFLINE:
2046
	case SDEV_TRANSPORT_OFFLINE:
L
Linus Torvalds 已提交
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060
		switch (oldstate) {
		case SDEV_CREATED:
		case SDEV_RUNNING:
		case SDEV_QUIESCE:
		case SDEV_BLOCK:
			break;
		default:
			goto illegal;
		}
		break;

	case SDEV_BLOCK:
		switch (oldstate) {
		case SDEV_RUNNING:
2061 2062 2063 2064 2065 2066 2067 2068 2069 2070
		case SDEV_CREATED_BLOCK:
			break;
		default:
			goto illegal;
		}
		break;

	case SDEV_CREATED_BLOCK:
		switch (oldstate) {
		case SDEV_CREATED:
L
Linus Torvalds 已提交
2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
			break;
		default:
			goto illegal;
		}
		break;

	case SDEV_CANCEL:
		switch (oldstate) {
		case SDEV_CREATED:
		case SDEV_RUNNING:
2081
		case SDEV_QUIESCE:
L
Linus Torvalds 已提交
2082
		case SDEV_OFFLINE:
2083
		case SDEV_TRANSPORT_OFFLINE:
L
Linus Torvalds 已提交
2084 2085 2086 2087 2088 2089 2090 2091 2092
		case SDEV_BLOCK:
			break;
		default:
			goto illegal;
		}
		break;

	case SDEV_DEL:
		switch (oldstate) {
2093 2094 2095
		case SDEV_CREATED:
		case SDEV_RUNNING:
		case SDEV_OFFLINE:
2096
		case SDEV_TRANSPORT_OFFLINE:
L
Linus Torvalds 已提交
2097
		case SDEV_CANCEL:
2098
		case SDEV_CREATED_BLOCK:
L
Linus Torvalds 已提交
2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109
			break;
		default:
			goto illegal;
		}
		break;

	}
	sdev->sdev_state = state;
	return 0;

 illegal:
2110
	SCSI_LOG_ERROR_RECOVERY(1,
2111
				sdev_printk(KERN_ERR, sdev,
2112
					    "Illegal state transition %s->%s",
2113 2114
					    scsi_device_state_name(oldstate),
					    scsi_device_state_name(state))
L
Linus Torvalds 已提交
2115 2116 2117 2118 2119
				);
	return -EINVAL;
}
EXPORT_SYMBOL(scsi_device_set_state);

2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135
/**
 * 	sdev_evt_emit - emit a single SCSI device uevent
 *	@sdev: associated SCSI device
 *	@evt: event to emit
 *
 *	Send a single uevent (scsi_event) to the associated scsi_device.
 */
static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
{
	int idx = 0;
	char *envp[3];

	switch (evt->evt_type) {
	case SDEV_EVT_MEDIA_CHANGE:
		envp[idx++] = "SDEV_MEDIA_CHANGE=1";
		break;
2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150
	case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
		envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED";
		break;
	case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
		envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED";
		break;
	case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
	       envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED";
		break;
	case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
		envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED";
		break;
	case SDEV_EVT_LUN_CHANGE_REPORTED:
		envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED";
		break;
2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170
	default:
		/* do nothing */
		break;
	}

	envp[idx++] = NULL;

	kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
}

/**
 * 	sdev_evt_thread - send a uevent for each scsi event
 *	@work: work struct for scsi_device
 *
 *	Dispatch queued events to their associated scsi_device kobjects
 *	as uevents.
 */
void scsi_evt_thread(struct work_struct *work)
{
	struct scsi_device *sdev;
2171
	enum scsi_device_event evt_type;
2172 2173 2174 2175
	LIST_HEAD(event_list);

	sdev = container_of(work, struct scsi_device, event_work);

2176 2177 2178 2179
	for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++)
		if (test_and_clear_bit(evt_type, sdev->pending_events))
			sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL);

2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211
	while (1) {
		struct scsi_event *evt;
		struct list_head *this, *tmp;
		unsigned long flags;

		spin_lock_irqsave(&sdev->list_lock, flags);
		list_splice_init(&sdev->event_list, &event_list);
		spin_unlock_irqrestore(&sdev->list_lock, flags);

		if (list_empty(&event_list))
			break;

		list_for_each_safe(this, tmp, &event_list) {
			evt = list_entry(this, struct scsi_event, node);
			list_del(&evt->node);
			scsi_evt_emit(sdev, evt);
			kfree(evt);
		}
	}
}

/**
 * 	sdev_evt_send - send asserted event to uevent thread
 *	@sdev: scsi_device event occurred on
 *	@evt: event to send
 *
 *	Assert scsi device event asynchronously.
 */
void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
{
	unsigned long flags;

2212 2213 2214 2215
#if 0
	/* FIXME: currently this check eliminates all media change events
	 * for polled devices.  Need to update to discriminate between AN
	 * and polled events */
2216 2217 2218 2219
	if (!test_bit(evt->evt_type, sdev->supported_events)) {
		kfree(evt);
		return;
	}
2220
#endif
2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248

	spin_lock_irqsave(&sdev->list_lock, flags);
	list_add_tail(&evt->node, &sdev->event_list);
	schedule_work(&sdev->event_work);
	spin_unlock_irqrestore(&sdev->list_lock, flags);
}
EXPORT_SYMBOL_GPL(sdev_evt_send);

/**
 * 	sdev_evt_alloc - allocate a new scsi event
 *	@evt_type: type of event to allocate
 *	@gfpflags: GFP flags for allocation
 *
 *	Allocates and returns a new scsi_event.
 */
struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
				  gfp_t gfpflags)
{
	struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
	if (!evt)
		return NULL;

	evt->evt_type = evt_type;
	INIT_LIST_HEAD(&evt->node);

	/* evt_type-specific initialization, if any */
	switch (evt_type) {
	case SDEV_EVT_MEDIA_CHANGE:
2249 2250 2251 2252 2253
	case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
	case SDEV_EVT_CAPACITY_CHANGE_REPORTED:
	case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED:
	case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED:
	case SDEV_EVT_LUN_CHANGE_REPORTED:
2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284
	default:
		/* do nothing */
		break;
	}

	return evt;
}
EXPORT_SYMBOL_GPL(sdev_evt_alloc);

/**
 * 	sdev_evt_send_simple - send asserted event to uevent thread
 *	@sdev: scsi_device event occurred on
 *	@evt_type: type of event to send
 *	@gfpflags: GFP flags for allocation
 *
 *	Assert scsi device event asynchronously, given an event type.
 */
void sdev_evt_send_simple(struct scsi_device *sdev,
			  enum scsi_device_event evt_type, gfp_t gfpflags)
{
	struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
	if (!evt) {
		sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
			    evt_type);
		return;
	}

	sdev_evt_send(sdev, evt);
}
EXPORT_SYMBOL_GPL(sdev_evt_send_simple);

L
Linus Torvalds 已提交
2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298
/**
 *	scsi_device_quiesce - Block user issued commands.
 *	@sdev:	scsi device to quiesce.
 *
 *	This works by trying to transition to the SDEV_QUIESCE state
 *	(which must be a legal transition).  When the device is in this
 *	state, only special requests will be accepted, all others will
 *	be deferred.  Since special requests may also be requeued requests,
 *	a successful return doesn't guarantee the device will be 
 *	totally quiescent.
 *
 *	Must be called with user context, may sleep.
 *
 *	Returns zero if unsuccessful or an error if not.
2299
 */
L
Linus Torvalds 已提交
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323
int
scsi_device_quiesce(struct scsi_device *sdev)
{
	int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
	if (err)
		return err;

	scsi_run_queue(sdev->request_queue);
	while (sdev->device_busy) {
		msleep_interruptible(200);
		scsi_run_queue(sdev->request_queue);
	}
	return 0;
}
EXPORT_SYMBOL(scsi_device_quiesce);

/**
 *	scsi_device_resume - Restart user issued commands to a quiesced device.
 *	@sdev:	scsi device to resume.
 *
 *	Moves the device from quiesced back to running and restarts the
 *	queues.
 *
 *	Must be called with user context, may sleep.
2324
 */
2325
void scsi_device_resume(struct scsi_device *sdev)
L
Linus Torvalds 已提交
2326
{
2327 2328 2329 2330 2331 2332
	/* check if the device state was mutated prior to resume, and if
	 * so assume the state is being managed elsewhere (for example
	 * device deleted during suspend)
	 */
	if (sdev->sdev_state != SDEV_QUIESCE ||
	    scsi_device_set_state(sdev, SDEV_RUNNING))
L
Linus Torvalds 已提交
2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364
		return;
	scsi_run_queue(sdev->request_queue);
}
EXPORT_SYMBOL(scsi_device_resume);

static void
device_quiesce_fn(struct scsi_device *sdev, void *data)
{
	scsi_device_quiesce(sdev);
}

void
scsi_target_quiesce(struct scsi_target *starget)
{
	starget_for_each_device(starget, NULL, device_quiesce_fn);
}
EXPORT_SYMBOL(scsi_target_quiesce);

static void
device_resume_fn(struct scsi_device *sdev, void *data)
{
	scsi_device_resume(sdev);
}

void
scsi_target_resume(struct scsi_target *starget)
{
	starget_for_each_device(starget, NULL, device_resume_fn);
}
EXPORT_SYMBOL(scsi_target_resume);

/**
2365
 * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
L
Linus Torvalds 已提交
2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378
 * @sdev:	device to block
 *
 * Block request made by scsi lld's to temporarily stop all
 * scsi commands on the specified device.  Called from interrupt
 * or normal process context.
 *
 * Returns zero if successful or error if not
 *
 * Notes:       
 *	This routine transitions the device to the SDEV_BLOCK state
 *	(which must be a legal transition).  When the device is in this
 *	state, all commands are deferred until the scsi lld reenables
 *	the device with scsi_device_unblock or device_block_tmo fires.
2379
 */
L
Linus Torvalds 已提交
2380 2381 2382
int
scsi_internal_device_block(struct scsi_device *sdev)
{
2383
	struct request_queue *q = sdev->request_queue;
L
Linus Torvalds 已提交
2384 2385 2386 2387
	unsigned long flags;
	int err = 0;

	err = scsi_device_set_state(sdev, SDEV_BLOCK);
2388 2389 2390 2391 2392 2393
	if (err) {
		err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);

		if (err)
			return err;
	}
L
Linus Torvalds 已提交
2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410

	/* 
	 * The device has transitioned to SDEV_BLOCK.  Stop the
	 * block layer from calling the midlayer with this device's
	 * request queue. 
	 */
	spin_lock_irqsave(q->queue_lock, flags);
	blk_stop_queue(q);
	spin_unlock_irqrestore(q->queue_lock, flags);

	return 0;
}
EXPORT_SYMBOL_GPL(scsi_internal_device_block);
 
/**
 * scsi_internal_device_unblock - resume a device after a block request
 * @sdev:	device to resume
2411
 * @new_state:	state to set devices to after unblocking
L
Linus Torvalds 已提交
2412 2413 2414 2415 2416 2417 2418 2419 2420
 *
 * Called by scsi lld's or the midlayer to restart the device queue
 * for the previously suspended scsi device.  Called from interrupt or
 * normal process context.
 *
 * Returns zero if successful or error if not.
 *
 * Notes:       
 *	This routine transitions the device to the SDEV_RUNNING state
2421
 *	or to one of the offline states (which must be a legal transition)
2422
 *	allowing the midlayer to goose the queue for this device.
2423
 */
L
Linus Torvalds 已提交
2424
int
2425 2426
scsi_internal_device_unblock(struct scsi_device *sdev,
			     enum scsi_device_state new_state)
L
Linus Torvalds 已提交
2427
{
2428
	struct request_queue *q = sdev->request_queue; 
L
Linus Torvalds 已提交
2429
	unsigned long flags;
2430 2431 2432 2433

	/*
	 * Try to transition the scsi device to SDEV_RUNNING or one of the
	 * offlined states and goose the device queue if successful.
L
Linus Torvalds 已提交
2434
	 */
2435 2436
	if ((sdev->sdev_state == SDEV_BLOCK) ||
	    (sdev->sdev_state == SDEV_TRANSPORT_OFFLINE))
2437 2438 2439 2440 2441 2442 2443 2444
		sdev->sdev_state = new_state;
	else if (sdev->sdev_state == SDEV_CREATED_BLOCK) {
		if (new_state == SDEV_TRANSPORT_OFFLINE ||
		    new_state == SDEV_OFFLINE)
			sdev->sdev_state = new_state;
		else
			sdev->sdev_state = SDEV_CREATED;
	} else if (sdev->sdev_state != SDEV_CANCEL &&
2445
		 sdev->sdev_state != SDEV_OFFLINE)
2446
		return -EINVAL;
L
Linus Torvalds 已提交
2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484

	spin_lock_irqsave(q->queue_lock, flags);
	blk_start_queue(q);
	spin_unlock_irqrestore(q->queue_lock, flags);

	return 0;
}
EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);

static void
device_block(struct scsi_device *sdev, void *data)
{
	scsi_internal_device_block(sdev);
}

static int
target_block(struct device *dev, void *data)
{
	if (scsi_is_target_device(dev))
		starget_for_each_device(to_scsi_target(dev), NULL,
					device_block);
	return 0;
}

void
scsi_target_block(struct device *dev)
{
	if (scsi_is_target_device(dev))
		starget_for_each_device(to_scsi_target(dev), NULL,
					device_block);
	else
		device_for_each_child(dev, NULL, target_block);
}
EXPORT_SYMBOL_GPL(scsi_target_block);

static void
device_unblock(struct scsi_device *sdev, void *data)
{
2485
	scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
L
Linus Torvalds 已提交
2486 2487 2488 2489 2490 2491
}

static int
target_unblock(struct device *dev, void *data)
{
	if (scsi_is_target_device(dev))
2492
		starget_for_each_device(to_scsi_target(dev), data,
L
Linus Torvalds 已提交
2493 2494 2495 2496 2497
					device_unblock);
	return 0;
}

void
2498
scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
L
Linus Torvalds 已提交
2499 2500
{
	if (scsi_is_target_device(dev))
2501
		starget_for_each_device(to_scsi_target(dev), &new_state,
L
Linus Torvalds 已提交
2502 2503
					device_unblock);
	else
2504
		device_for_each_child(dev, &new_state, target_unblock);
L
Linus Torvalds 已提交
2505 2506
}
EXPORT_SYMBOL_GPL(scsi_target_unblock);
2507 2508 2509

/**
 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
2510
 * @sgl:	scatter-gather list
2511 2512 2513 2514 2515 2516
 * @sg_count:	number of segments in sg
 * @offset:	offset in bytes into sg, on return offset into the mapped area
 * @len:	bytes to map, on return number of bytes mapped
 *
 * Returns virtual address of the start of the mapped page
 */
J
Jens Axboe 已提交
2517
void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
2518 2519 2520 2521
			  size_t *offset, size_t *len)
{
	int i;
	size_t sg_len = 0, len_complete = 0;
J
Jens Axboe 已提交
2522
	struct scatterlist *sg;
2523 2524
	struct page *page;

2525 2526
	WARN_ON(!irqs_disabled());

J
Jens Axboe 已提交
2527
	for_each_sg(sgl, sg, sg_count, i) {
2528
		len_complete = sg_len; /* Complete sg-entries */
J
Jens Axboe 已提交
2529
		sg_len += sg->length;
2530 2531 2532 2533 2534
		if (sg_len > *offset)
			break;
	}

	if (unlikely(i == sg_count)) {
2535 2536
		printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
			"elements %d\n",
2537
		       __func__, sg_len, *offset, sg_count);
2538 2539 2540 2541 2542
		WARN_ON(1);
		return NULL;
	}

	/* Offset starting from the beginning of first page in this sg-entry */
J
Jens Axboe 已提交
2543
	*offset = *offset - len_complete + sg->offset;
2544 2545

	/* Assumption: contiguous pages can be accessed as "page + i" */
J
Jens Axboe 已提交
2546
	page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
2547 2548 2549 2550 2551 2552 2553
	*offset &= ~PAGE_MASK;

	/* Bytes in this sg-entry from *offset to the end of the page */
	sg_len = PAGE_SIZE - *offset;
	if (*len > sg_len)
		*len = sg_len;

2554
	return kmap_atomic(page);
2555 2556 2557 2558
}
EXPORT_SYMBOL(scsi_kmap_atomic_sg);

/**
2559
 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
2560 2561 2562 2563
 * @virt:	virtual address to be unmapped
 */
void scsi_kunmap_atomic_sg(void *virt)
{
2564
	kunmap_atomic(virt);
2565 2566
}
EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580

void sdev_disable_disk_events(struct scsi_device *sdev)
{
	atomic_inc(&sdev->disk_events_disable_depth);
}
EXPORT_SYMBOL(sdev_disable_disk_events);

void sdev_enable_disk_events(struct scsi_device *sdev)
{
	if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0))
		return;
	atomic_dec(&sdev->disk_events_disable_depth);
}
EXPORT_SYMBOL(sdev_enable_disk_events);