scsi_lib.c 82.1 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds's avatar
Linus Torvalds committed
2
/*
3 4
 * Copyright (C) 1999 Eric Youngdale
 * Copyright (C) 2014 Christoph Hellwig
Linus Torvalds's avatar
Linus Torvalds committed
5 6 7 8 9 10 11 12
 *
 *  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>
13
#include <linux/bitops.h>
Linus Torvalds's avatar
Linus Torvalds committed
14 15 16
#include <linux/blkdev.h>
#include <linux/completion.h>
#include <linux/kernel.h>
17
#include <linux/export.h>
Linus Torvalds's avatar
Linus Torvalds committed
18 19 20
#include <linux/init.h>
#include <linux/pci.h>
#include <linux/delay.h>
21
#include <linux/hardirq.h>
22
#include <linux/scatterlist.h>
23
#include <linux/blk-mq.h>
24
#include <linux/ratelimit.h>
25
#include <asm/unaligned.h>
Linus Torvalds's avatar
Linus Torvalds committed
26 27

#include <scsi/scsi.h>
28
#include <scsi/scsi_cmnd.h>
Linus Torvalds's avatar
Linus Torvalds committed
29 30 31 32 33
#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>
34
#include <scsi/scsi_transport.h> /* __scsi_init_queue() */
35
#include <scsi/scsi_dh.h>
Linus Torvalds's avatar
Linus Torvalds committed
36

37 38
#include <trace/events/scsi.h>

39
#include "scsi_debugfs.h"
Linus Torvalds's avatar
Linus Torvalds committed
40 41 42
#include "scsi_priv.h"
#include "scsi_logging.h"

43 44 45 46
/*
 * Size of integrity metadata is usually small, 1 inline sg should
 * cover normal cases.
 */
47 48 49 50
#ifdef CONFIG_ARCH_NO_SG_CHAIN
#define  SCSI_INLINE_PROT_SG_CNT  0
#define  SCSI_INLINE_SG_CNT  0
#else
51
#define  SCSI_INLINE_PROT_SG_CNT  1
52
#define  SCSI_INLINE_SG_CNT  2
53
#endif
54

55
static struct kmem_cache *scsi_sdb_cache;
56 57 58
static struct kmem_cache *scsi_sense_cache;
static struct kmem_cache *scsi_sense_isadma_cache;
static DEFINE_MUTEX(scsi_sense_cache_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
59

60 61
static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd);

62
static inline struct kmem_cache *
63
scsi_select_sense_cache(bool unchecked_isa_dma)
64
{
65
	return unchecked_isa_dma ? scsi_sense_isadma_cache : scsi_sense_cache;
66 67
}

68 69
static void scsi_free_sense_buffer(bool unchecked_isa_dma,
				   unsigned char *sense_buffer)
70
{
71 72
	kmem_cache_free(scsi_select_sense_cache(unchecked_isa_dma),
			sense_buffer);
73 74
}

75
static unsigned char *scsi_alloc_sense_buffer(bool unchecked_isa_dma,
76
	gfp_t gfp_mask, int numa_node)
77
{
78 79
	return kmem_cache_alloc_node(scsi_select_sense_cache(unchecked_isa_dma),
				     gfp_mask, numa_node);
80 81 82 83 84 85 86
}

int scsi_init_sense_cache(struct Scsi_Host *shost)
{
	struct kmem_cache *cache;
	int ret = 0;

87
	mutex_lock(&scsi_sense_cache_mutex);
88
	cache = scsi_select_sense_cache(shost->unchecked_isa_dma);
89
	if (cache)
90
		goto exit;
91 92 93 94

	if (shost->unchecked_isa_dma) {
		scsi_sense_isadma_cache =
			kmem_cache_create("scsi_sense_cache(DMA)",
95 96
				SCSI_SENSE_BUFFERSIZE, 0,
				SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA, NULL);
97 98 99 100
		if (!scsi_sense_isadma_cache)
			ret = -ENOMEM;
	} else {
		scsi_sense_cache =
101 102 103
			kmem_cache_create_usercopy("scsi_sense_cache",
				SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN,
				0, SCSI_SENSE_BUFFERSIZE, NULL);
104 105 106
		if (!scsi_sense_cache)
			ret = -ENOMEM;
	}
107
 exit:
108 109 110
	mutex_unlock(&scsi_sense_cache_mutex);
	return ret;
}
111

112 113 114 115 116 117 118
/*
 * 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

119 120
static void
scsi_set_blocked(struct scsi_cmnd *cmd, int reason)
Linus Torvalds's avatar
Linus Torvalds committed
121 122 123
{
	struct Scsi_Host *host = cmd->device->host;
	struct scsi_device *device = cmd->device;
124
	struct scsi_target *starget = scsi_target(device);
Linus Torvalds's avatar
Linus Torvalds committed
125 126

	/*
127
	 * Set the appropriate busy bit for the device/host.
Linus Torvalds's avatar
Linus Torvalds committed
128 129 130 131 132 133 134 135 136 137 138
	 *
	 * 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.
	 */
139 140
	switch (reason) {
	case SCSI_MLQUEUE_HOST_BUSY:
141
		atomic_set(&host->host_blocked, host->max_host_blocked);
142 143
		break;
	case SCSI_MLQUEUE_DEVICE_BUSY:
144
	case SCSI_MLQUEUE_EH_RETRY:
145 146
		atomic_set(&device->device_blocked,
			   device->max_device_blocked);
147 148
		break;
	case SCSI_MLQUEUE_TARGET_BUSY:
149 150
		atomic_set(&starget->target_blocked,
			   starget->max_target_blocked);
151 152
		break;
	}
153 154
}

155 156
static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd)
{
157 158 159 160 161 162
	if (cmd->request->rq_flags & RQF_DONTPREP) {
		cmd->request->rq_flags &= ~RQF_DONTPREP;
		scsi_mq_uninit_cmd(cmd);
	} else {
		WARN_ON_ONCE(true);
	}
163
	blk_mq_requeue_request(cmd->request, true);
164 165
}

166 167 168 169 170 171 172 173 174 175 176 177
/**
 * __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
 *
 * 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.
 */
178
static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, bool unbusy)
179 180 181 182 183 184 185
{
	struct scsi_device *device = cmd->device;

	SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd,
		"Inserting command %p into mlqueue\n", cmd));

	scsi_set_blocked(cmd, reason);
Linus Torvalds's avatar
Linus Torvalds committed
186 187 188 189 190

	/*
	 * Decrement the counters, since these commands are no longer
	 * active on the host/device.
	 */
191 192
	if (unbusy)
		scsi_device_unbusy(device);
Linus Torvalds's avatar
Linus Torvalds committed
193 194

	/*
195
	 * Requeue this command.  It will go before all other commands
196 197 198
	 * that are already in the queue. Schedule requeue work under
	 * lock such that the kblockd_schedule_work() call happens
	 * before blk_cleanup_queue() finishes.
199
	 */
200
	cmd->result = 0;
201 202

	blk_mq_requeue_request(cmd->request, true);
Linus Torvalds's avatar
Linus Torvalds committed
203 204
}

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
/*
 * 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.
 */
224
void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
225
{
226
	__scsi_queue_insert(cmd, reason, true);
227
}
228

229 230

/**
231
 * __scsi_execute - insert request and wait for the result
232 233 234 235 236 237 238 239 240 241 242 243 244
 * @sdev:	scsi device
 * @cmd:	scsi command
 * @data_direction: data direction
 * @buffer:	data buffer
 * @bufflen:	len of buffer
 * @sense:	optional sense buffer
 * @sshdr:	optional decoded sense header
 * @timeout:	request timeout in seconds
 * @retries:	number of times to retry request
 * @flags:	flags for ->cmd_flags
 * @rq_flags:	flags for ->rq_flags
 * @resid:	optional residual length
 *
245 246
 * Returns the scsi_cmnd result field if a command was executed, or a negative
 * Linux error code if we didn't get that far.
247
 */
248
int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
249
		 int data_direction, void *buffer, unsigned bufflen,
250 251 252
		 unsigned char *sense, struct scsi_sense_hdr *sshdr,
		 int timeout, int retries, u64 flags, req_flags_t rq_flags,
		 int *resid)
253 254
{
	struct request *req;
255
	struct scsi_request *rq;
256 257
	int ret = DRIVER_ERROR << 24;

258
	req = blk_get_request(sdev->request_queue,
259
			data_direction == DMA_TO_DEVICE ?
260
			REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, BLK_MQ_REQ_PREEMPT);
261
	if (IS_ERR(req))
262
		return ret;
263
	rq = scsi_req(req);
264 265

	if (bufflen &&	blk_rq_map_kern(sdev->request_queue, req,
266
					buffer, bufflen, GFP_NOIO))
267 268
		goto out;

269 270
	rq->cmd_len = COMMAND_SIZE(cmd[0]);
	memcpy(rq->cmd, cmd, rq->cmd_len);
271
	rq->retries = retries;
272
	req->timeout = timeout;
273
	req->cmd_flags |= flags;
274
	req->rq_flags |= rq_flags | RQF_QUIET;
275 276 277 278 279 280

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

281 282 283 284 285 286
	/*
	 * 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.
	 */
287 288
	if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen))
		memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len);
289

290
	if (resid)
291 292 293
		*resid = rq->resid_len;
	if (sense && rq->sense_len)
		memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE);
294 295
	if (sshdr)
		scsi_normalize_sense(rq->sense, rq->sense_len, sshdr);
296
	ret = rq->result;
297 298 299 300 301
 out:
	blk_put_request(req);

	return ret;
}
302
EXPORT_SYMBOL(__scsi_execute);
303

Linus Torvalds's avatar
Linus Torvalds committed
304 305 306 307 308 309 310 311 312 313 314
/*
 * 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.
 */
315
static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
Linus Torvalds's avatar
Linus Torvalds committed
316
{
317
	scsi_set_resid(cmd, 0);
318
	memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Linus Torvalds's avatar
Linus Torvalds committed
319
	if (cmd->cmd_len == 0)
320
		cmd->cmd_len = scsi_command_size(cmd->cmnd);
Linus Torvalds's avatar
Linus Torvalds committed
321 322
}

323 324 325 326 327 328 329 330 331 332
/*
 * Decrement the host_busy counter and wake up the error handler if necessary.
 * Avoid as follows that the error handler is not woken up if shost->host_busy
 * == shost->host_failed: use call_rcu() in scsi_eh_scmd_add() in combination
 * with an RCU read lock in this function to ensure that this function in its
 * entirety either finishes before scsi_eh_scmd_add() increases the
 * host_failed counter or that it notices the shost state change made by
 * scsi_eh_scmd_add().
 */
static void scsi_dec_host_busy(struct Scsi_Host *shost)
Linus Torvalds's avatar
Linus Torvalds committed
333 334 335
{
	unsigned long flags;

336
	rcu_read_lock();
337
	atomic_dec(&shost->host_busy);
338
	if (unlikely(scsi_host_in_recovery(shost))) {
339
		spin_lock_irqsave(shost->host_lock, flags);
340 341
		if (shost->host_failed || shost->host_eh_scheduled)
			scsi_eh_wakeup(shost);
342 343
		spin_unlock_irqrestore(shost->host_lock, flags);
	}
344 345 346 347 348 349 350 351 352 353 354 355
	rcu_read_unlock();
}

void scsi_device_unbusy(struct scsi_device *sdev)
{
	struct Scsi_Host *shost = sdev->host;
	struct scsi_target *starget = scsi_target(sdev);

	scsi_dec_host_busy(shost);

	if (starget->can_queue > 0)
		atomic_dec(&starget->target_busy);
356

357
	atomic_dec(&sdev->device_busy);
Linus Torvalds's avatar
Linus Torvalds committed
358 359
}

360 361
static void scsi_kick_queue(struct request_queue *q)
{
362
	blk_mq_run_hw_queues(q, false);
363 364
}

Linus Torvalds's avatar
Linus Torvalds committed
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
/*
 * 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.
	 */
389
	scsi_kick_queue(current_sdev->request_queue);
Linus Torvalds's avatar
Linus Torvalds committed
390 391 392 393 394 395 396 397 398 399 400 401

	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);
402
		scsi_kick_queue(sdev->request_queue);
Linus Torvalds's avatar
Linus Torvalds committed
403 404 405 406 407 408 409 410
		spin_lock_irqsave(shost->host_lock, flags);
	
		scsi_device_put(sdev);
	}
 out:
	spin_unlock_irqrestore(shost->host_lock, flags);
}

411
static inline bool scsi_device_is_busy(struct scsi_device *sdev)
412
{
413 414 415 416 417
	if (atomic_read(&sdev->device_busy) >= sdev->queue_depth)
		return true;
	if (atomic_read(&sdev->device_blocked) > 0)
		return true;
	return false;
418 419
}

420
static inline bool scsi_target_is_busy(struct scsi_target *starget)
421
{
422 423 424 425 426 427
	if (starget->can_queue > 0) {
		if (atomic_read(&starget->target_busy) >= starget->can_queue)
			return true;
		if (atomic_read(&starget->target_blocked) > 0)
			return true;
	}
428
	return false;
429 430
}

431
static inline bool scsi_host_is_busy(struct Scsi_Host *shost)
432
{
433
	if (shost->can_queue > 0 &&
434 435 436 437 438 439 440
	    atomic_read(&shost->host_busy) >= shost->can_queue)
		return true;
	if (atomic_read(&shost->host_blocked) > 0)
		return true;
	if (shost->host_self_blocked)
		return true;
	return false;
441 442
}

443
static void scsi_starved_list_run(struct Scsi_Host *shost)
Linus Torvalds's avatar
Linus Torvalds committed
444
{
445
	LIST_HEAD(starved_list);
446
	struct scsi_device *sdev;
Linus Torvalds's avatar
Linus Torvalds committed
447 448 449
	unsigned long flags;

	spin_lock_irqsave(shost->host_lock, flags);
450 451 452
	list_splice_init(&shost->starved_list, &starved_list);

	while (!list_empty(&starved_list)) {
453 454
		struct request_queue *slq;

Linus Torvalds's avatar
Linus Torvalds committed
455 456 457 458 459 460 461 462 463 464
		/*
		 * 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.
		 */
465
		if (scsi_host_is_busy(shost))
466 467
			break;

468 469 470
		sdev = list_entry(starved_list.next,
				  struct scsi_device, starved_entry);
		list_del_init(&sdev->starved_entry);
471 472 473 474 475 476
		if (scsi_target_is_busy(scsi_target(sdev))) {
			list_move_tail(&sdev->starved_entry,
				       &shost->starved_list);
			continue;
		}

477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
		/*
		 * 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);

492
		scsi_kick_queue(slq);
493 494 495
		blk_put_queue(slq);

		spin_lock_irqsave(shost->host_lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
496
	}
497 498
	/* put any unprocessed entries back */
	list_splice(&starved_list, &shost->starved_list);
Linus Torvalds's avatar
Linus Torvalds committed
499
	spin_unlock_irqrestore(shost->host_lock, flags);
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
}

/*
 * 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);
Linus Torvalds's avatar
Linus Torvalds committed
522

523
	blk_mq_run_hw_queues(q, false);
Linus Torvalds's avatar
Linus Torvalds committed
524 525
}

526 527 528 529 530 531 532 533 534 535
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);
}

Linus Torvalds's avatar
Linus Torvalds committed
536 537 538 539 540 541 542 543
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);
}

544 545
static void scsi_uninit_cmd(struct scsi_cmnd *cmd)
{
546
	if (!blk_rq_is_passthrough(cmd->request)) {
547 548 549 550 551 552 553 554 555 556
		struct scsi_driver *drv = scsi_cmd_to_driver(cmd);

		if (drv->uninit_command)
			drv->uninit_command(cmd);
	}
}

static void scsi_mq_free_sgtables(struct scsi_cmnd *cmd)
{
	if (cmd->sdb.table.nents)
557 558
		sg_free_table_chained(&cmd->sdb.table,
				SCSI_INLINE_SG_CNT);
559
	if (scsi_prot_sg_count(cmd))
560 561
		sg_free_table_chained(&cmd->prot_sdb->table,
				SCSI_INLINE_PROT_SG_CNT);
562 563 564 565 566 567
}

static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd)
{
	scsi_mq_free_sgtables(cmd);
	scsi_uninit_cmd(cmd);
568
	scsi_del_cmd_from_list(cmd);
569 570
}

571
/* Returns false when no more bytes to process, true if there are more */
572
static bool scsi_end_request(struct request *req, blk_status_t error,
573
		unsigned int bytes)
574
{
575
	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
576 577 578 579 580 581 582 583 584
	struct scsi_device *sdev = cmd->device;
	struct request_queue *q = sdev->request_queue;

	if (blk_update_request(req, error, bytes))
		return true;

	if (blk_queue_add_random(q))
		add_disk_randomness(req->rq_disk);

585 586 587 588 589
	if (!blk_rq_is_scsi(req)) {
		WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED));
		cmd->flags &= ~SCMD_INITIALIZED;
	}

590 591 592 593 594 595 596 597
	/*
	 * Calling rcu_barrier() is not necessary here because the
	 * SCSI error handler guarantees that the function called by
	 * call_rcu() has been called before scsi_end_request() is
	 * called.
	 */
	destroy_rcu_head(&cmd->rcu);

598 599 600 601 602 603 604 605
	/*
	 * In the MQ case the command gets freed by __blk_mq_end_request,
	 * so we have to do all cleanup that depends on it earlier.
	 *
	 * We also can't kick the queues from irq context, so we
	 * will have to defer it to a workqueue.
	 */
	scsi_mq_uninit_cmd(cmd);
606

607 608 609 610 611
	/*
	 * queue is still alive, so grab the ref for preventing it
	 * from being cleaned up during running queue.
	 */
	percpu_ref_get(&q->q_usage_counter);
612

613
	__blk_mq_end_request(req, error);
614

615 616 617 618 619
	if (scsi_target(sdev)->single_lun ||
	    !list_empty(&sdev->host->starved_list))
		kblockd_schedule_work(&sdev->requeue_work);
	else
		blk_mq_run_hw_queues(q, true);
620

621
	percpu_ref_put(&q->q_usage_counter);
622 623 624
	return false;
}

625
/**
626 627
 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t
 * @cmd:	SCSI command
628 629
 * @result:	scsi error code
 *
630 631
 * Translate a SCSI result code into a blk_status_t value. May reset the host
 * byte of @cmd->result.
632
 */
633
static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result)
634
{
635
	switch (host_byte(result)) {
636 637 638 639 640 641 642 643 644
	case DID_OK:
		/*
		 * Also check the other bytes than the status byte in result
		 * to handle the case when a SCSI LLD sets result to
		 * DRIVER_SENSE << 24 without setting SAM_STAT_CHECK_CONDITION.
		 */
		if (scsi_status_is_good(result) && (result & ~0xff) == 0)
			return BLK_STS_OK;
		return BLK_STS_IOERR;
645
	case DID_TRANSPORT_FAILFAST:
646
		return BLK_STS_TRANSPORT;
647
	case DID_TARGET_FAILURE:
648
		set_host_byte(cmd, DID_OK);
649
		return BLK_STS_TARGET;
650
	case DID_NEXUS_FAILURE:
651
		set_host_byte(cmd, DID_OK);
652
		return BLK_STS_NEXUS;
653 654
	case DID_ALLOC_FAILURE:
		set_host_byte(cmd, DID_OK);
655
		return BLK_STS_NOSPC;
656 657
	case DID_MEDIUM_ERROR:
		set_host_byte(cmd, DID_OK);
658
		return BLK_STS_MEDIUM;
659
	default:
660
		return BLK_STS_IOERR;
661 662 663
	}
}

664 665 666 667 668
/* Helper for scsi_io_completion() when "reprep" action required. */
static void scsi_io_completion_reprep(struct scsi_cmnd *cmd,
				      struct request_queue *q)
{
	/* A new command will be prepared and issued. */
669
	scsi_mq_requeue_cmd(cmd);
670 671
}

672 673
/* Helper for scsi_io_completion() when special action required. */
static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result)
Linus Torvalds's avatar
Linus Torvalds committed
674
{
675
	struct request_queue *q = cmd->device->request_queue;
Linus Torvalds's avatar
Linus Torvalds committed
676
	struct request *req = cmd->request;
677
	int level = 0;
678 679
	enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
	      ACTION_DELAYED_RETRY} action;
680
	unsigned long wait_for = (cmd->allowed + 1) * req->timeout;
681 682 683 684
	struct scsi_sense_hdr sshdr;
	bool sense_valid;
	bool sense_current = true;      /* false implies "deferred sense" */
	blk_status_t blk_stat;
Linus Torvalds's avatar
Linus Torvalds committed
685

686 687 688
	sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
	if (sense_valid)
		sense_current = !scsi_sense_is_deferred(&sshdr);
689

690
	blk_stat = scsi_result_to_blk_status(cmd, result);
691

692 693 694 695 696 697
	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;
698
	} else if (sense_valid && sense_current) {
Linus Torvalds's avatar
Linus Torvalds committed
699 700 701
		switch (sshdr.sense_key) {
		case UNIT_ATTENTION:
			if (cmd->device->removable) {
702
				/* Detected disc change.  Set a bit
Linus Torvalds's avatar
Linus Torvalds committed
703 704 705
				 * and quietly refuse further access.
				 */
				cmd->device->changed = 1;
706
				action = ACTION_FAIL;
Linus Torvalds's avatar
Linus Torvalds committed
707
			} else {
708 709 710
				/* Must have been a power glitch, or a
				 * bus reset.  Could not have been a
				 * media change, so we just retry the
711
				 * command and see what happens.
712
				 */
713
				action = ACTION_RETRY;
Linus Torvalds's avatar
Linus Torvalds committed
714 715 716
			}
			break;
		case ILLEGAL_REQUEST:
717 718 719 720 721 722 723 724
			/* 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.
			 */
725 726
			if ((cmd->device->use_10_for_rw &&
			    sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
Linus Torvalds's avatar
Linus Torvalds committed
727 728
			    (cmd->cmnd[0] == READ_10 ||
			     cmd->cmnd[0] == WRITE_10)) {
729
				/* This will issue a new 6-byte command. */
Linus Torvalds's avatar
Linus Torvalds committed
730
				cmd->device->use_10_for_rw = 0;
731
				action = ACTION_REPREP;
732 733
			} else if (sshdr.asc == 0x10) /* DIX */ {
				action = ACTION_FAIL;
734
				blk_stat = BLK_STS_PROTECTION;
735
			/* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
736
			} else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
737
				action = ACTION_FAIL;
738
				blk_stat = BLK_STS_TARGET;
739 740 741
			} else
				action = ACTION_FAIL;
			break;
742
		case ABORTED_COMMAND:
743
			action = ACTION_FAIL;
744
			if (sshdr.asc == 0x10) /* DIF */
745
				blk_stat = BLK_STS_PROTECTION;
Linus Torvalds's avatar
Linus Torvalds committed
746 747
			break;
		case NOT_READY:
748
			/* If the device is in the process of becoming
749
			 * ready, or has a temporary blockage, retry.
Linus Torvalds's avatar
Linus Torvalds committed
750
			 */
751 752 753 754 755 756 757 758 759
			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 */
760
				case 0x14: /* space allocation in progress */
761 762 763 764
				case 0x1a: /* start stop unit in progress */
				case 0x1b: /* sanitize in progress */
				case 0x1d: /* configuration in progress */
				case 0x24: /* depopulation in progress */
765
					action = ACTION_DELAYED_RETRY;
766
					break;
767 768 769
				default:
					action = ACTION_FAIL;
					break;
770
				}
771
			} else
772 773
				action = ACTION_FAIL;
			break;
Linus Torvalds's avatar
Linus Torvalds committed
774
		case VOLUME_OVERFLOW:
775
			/* See SSC3rXX or current. */
776 777
			action = ACTION_FAIL;
			break;
Linus Torvalds's avatar
Linus Torvalds committed
778
		default:
779
			action = ACTION_FAIL;
Linus Torvalds's avatar
Linus Torvalds committed
780 781
			break;
		}
782
	} else
783 784
		action = ACTION_FAIL;

785
	if (action != ACTION_FAIL &&
786
	    time_before(cmd->jiffies_at_alloc + wait_for, jiffies))
787 788
		action = ACTION_FAIL;

789 790 791
	switch (action) {
	case ACTION_FAIL:
		/* Give up and fail the remainder of the request */
792
		if (!(req->rq_flags & RQF_QUIET)) {
793 794 795 796 797
			static DEFINE_RATELIMIT_STATE(_rs,
					DEFAULT_RATELIMIT_INTERVAL,
					DEFAULT_RATELIMIT_BURST);

			if (unlikely(scsi_logging_level))
798 799 800
				level =
				     SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
						    SCSI_LOG_MLCOMPLETE_BITS);
801 802 803 804 805 806 807

			/*
			 * if logging is enabled the failure will be printed
			 * in scsi_log_completion(), so avoid duplicate messages
			 */
			if (!level && __ratelimit(&_rs)) {
				scsi_print_result(cmd, NULL, FAILED);
808
				if (driver_byte(result) == DRIVER_SENSE)
809 810 811
					scsi_print_sense(cmd);
				scsi_print_command(cmd);
			}
812
		}
813
		if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req)))
814
			return;
815
		/*FALLTHRU*/
816
	case ACTION_REPREP:
817
		scsi_io_completion_reprep(cmd, q);
818 819 820
		break;
	case ACTION_RETRY:
		/* Retry the same command immediately */
821
		__scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false);
822 823 824
		break;
	case ACTION_DELAYED_RETRY:
		/* Retry the same command after a delay */
825
		__scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false);
826
		break;
Linus Torvalds's avatar
Linus Torvalds committed
827 828 829
	}
}

830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
/*
 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a
 * new result that may suppress further error checking. Also modifies
 * *blk_statp in some cases.
 */
static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result,
					blk_status_t *blk_statp)
{
	bool sense_valid;
	bool sense_current = true;	/* false implies "deferred sense" */
	struct request *req = cmd->request;
	struct scsi_sense_hdr sshdr;

	sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
	if (sense_valid)
		sense_current = !scsi_sense_is_deferred(&sshdr);

	if (blk_rq_is_passthrough(req)) {
		if (sense_valid) {
			/*
			 * SG_IO wants current and deferred errors
			 */
			scsi_req(req)->sense_len =
				min(8 + cmd->sense_buffer[7],
				    SCSI_SENSE_BUFFERSIZE);
		}
		if (sense_current)
			*blk_statp = scsi_result_to_blk_status(cmd, result);
	} else if (blk_rq_bytes(req) == 0 && sense_current) {
		/*
		 * Flush commands do not transfers any data, and thus cannot use
		 * good_bytes != blk_rq_bytes(req) as the signal for an error.
		 * This sets *blk_statp explicitly for the problem case.
		 */
		*blk_statp = scsi_result_to_blk_status(cmd, result);
	}
	/*
	 * Recovered errors need reporting, but they're always treated as
	 * success, so fiddle the result code here.  For passthrough requests
	 * we already took a copy of the original into sreq->result which
	 * is what gets returned to the user
	 */
	if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
		bool do_print = true;
		/*
		 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d]
		 * 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))
			do_print = false;
		else if (req->rq_flags & RQF_QUIET)
			do_print = false;
		if (do_print)
			scsi_print_sense(cmd);
		result = 0;
		/* for passthrough, *blk_statp may be set */
		*blk_statp = BLK_STS_OK;
	}
	/*
	 * Another corner case: the SCSI status byte is non-zero but 'good'.
	 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when
	 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD
	 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related
	 * intermediate statuses (both obsolete in SAM-4) as good.
	 */
	if (status_byte(result) && scsi_status_is_good(result)) {
		result = 0;
		*blk_statp = BLK_STS_OK;
	}
	return result;
}

Linus Torvalds's avatar
Linus Torvalds committed
903 904 905 906 907 908 909 910 911 912 913
/*
 * 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
 *
914 915 916
 * 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
917
 *		figure out what to do next:
Linus Torvalds's avatar
Linus Torvalds committed
918
 *
919 920 921 922 923
 *		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.
Linus Torvalds's avatar
Linus Torvalds committed
924
 *
925
 *		b) We can call __scsi_queue_insert().  The request will
926 927 928
 *		   be put back on the queue and retried using the same
 *		   command as before, possibly after a delay.
 *
929 930
 *		c) We can call scsi_end_request() with blk_stat other than
 *		   BLK_STS_OK, to fail the remainder of the request.
Linus Torvalds's avatar
Linus Torvalds committed
931
 */
932
void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
Linus Torvalds's avatar
Linus Torvalds committed
933 934
{
	int result = cmd->result;
935
	struct request_queue *q = cmd->device->request_queue;
Linus Torvalds's avatar
Linus Torvalds committed
936
	struct request *req = cmd->request;
937
	blk_status_t blk_stat = BLK_STS_OK;
Linus Torvalds's avatar
Linus Torvalds committed
938

939
	if (unlikely(result))	/* a nz result may or may not be an error */
940
		result = scsi_io_completion_nz_result(cmd, result, &blk_stat);
941

942
	if (unlikely(blk_rq_is_passthrough(req))) {
943
		/*
944
		 * scsi_result_to_blk_status may have reset the host_byte
945
		 */
946
		scsi_req(req)->result = cmd->result;
947
	}
948

Linus Torvalds's avatar
Linus Torvalds committed
949 950 951 952
	/*
	 * Next deal with any sectors which we were able to correctly
	 * handle.
	 */
953 954 955
	SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd,
		"%u sectors total, %d bytes done.\n",
		blk_rq_sectors(req), good_bytes));
956

957
	/*
958 959 960
	 * Next deal with any sectors which we were able to correctly
	 * handle. Failed, zero length commands always need to drop down
	 * to retry code. Fast path should return in this block.
961
	 */
962
	if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) {
963
		if (likely(!scsi_end_request(req, blk_stat, good_bytes)))
964 965
			return; /* no bytes remaining */
	}
966

967 968
	/* Kill remainder if no retries. */
	if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) {
969
		if (scsi_end_request(req, blk_stat, blk_rq_bytes(req)))
970 971
			WARN_ONCE(true,
			    "Bytes remaining after failed, no-retry command");
972
		return;
973 974 975 976 977
	}

	/*
	 * If there had been no error, but we have leftover bytes in the
	 * requeues just queue the command up again.
978
	 */
979
	if (likely(result == 0))
980 981
		scsi_io_completion_reprep(cmd, q);
	else
982
		scsi_io_completion_action(cmd, result);
Linus Torvalds's avatar
Linus Torvalds committed
983 984
}

985 986
static blk_status_t scsi_init_sgtable(struct request *req,
		struct scsi_data_buffer *sdb)
Linus Torvalds's avatar
Linus Torvalds committed
987
{
988
	int count;
Linus Torvalds's avatar
Linus Torvalds committed
989 990

	/*
991
	 * If sg table allocation fails, requeue request later.
Linus Torvalds's avatar
Linus Torvalds committed
992
	 */
993
	if (unlikely(sg_alloc_table_chained(&sdb->table,
994
			blk_rq_nr_phys_segments(req), sdb->table.sgl,
995
			SCSI_INLINE_SG_CNT)))
996
		return BLK_STS_RESOURCE;
Linus Torvalds's avatar
Linus Torvalds committed
997 998 999 1000 1001

	/* 
	 * Next, walk the list, and fill in the addresses and sizes of
	 * each segment.
	 */
1002 1003 1004
	count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
	BUG_ON(count > sdb->table.nents);
	sdb->table.nents = count;
1005
	sdb->length = blk_rq_payload_bytes(req);
1006
	return BLK_STS_OK;
Linus Torvalds's avatar
Linus Torvalds committed
1007
}
1008 1009 1010 1011 1012 1013 1014 1015

/*
 * Function:    scsi_init_io()
 *
 * Purpose:     SCSI I/O initialize function.
 *
 * Arguments:   cmd   - Command descriptor we wish to initialize
 *
1016 1017 1018
 * Returns:     BLK_STS_OK on success
 *		BLK_STS_RESOURCE if the failure is retryable
 *		BLK_STS_IOERR if the failure is fatal
1019
 */
1020
blk_status_t scsi_init_io(struct scsi_cmnd *cmd)
1021
{
1022
	struct request *rq = cmd->request;
1023
	blk_status_t ret;
1024

1025
	if (WARN_ON_ONCE(!blk_rq_nr_phys_segments(rq)))
1026
		return BLK_STS_IOERR;
1027

1028 1029 1030
	ret = scsi_init_sgtable(rq, &cmd->sdb);
	if (ret)
		return ret;
1031

1032
	if (blk_integrity_rq(rq)) {
1033 1034 1035
		struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
		int ivecs, count;

1036
		if (WARN_ON_ONCE(!prot_sdb)) {
1037 1038 1039 1040 1041
			/*
			 * This can happen if someone (e.g. multipath)
			 * queues a command to a device on an adapter
			 * that does not support DIX.
			 */
1042
			ret = BLK_STS_IOERR;
1043
			goto out_free_sgtables;
1044 1045
		}

1046
		ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio);
1047

1048
		if (sg_alloc_table_chained(&prot_sdb->table, ivecs,
1049
				prot_sdb->table.sgl,
1050
				SCSI_INLINE_PROT_SG_CNT)) {
1051
			ret = BLK_STS_RESOURCE;
1052
			goto out_free_sgtables;
1053 1054
		}

1055
		count = blk_rq_map_integrity_sg(rq->q, rq->bio,
1056
						prot_sdb->table.sgl);
1057 1058
		BUG_ON(count > ivecs);
		BUG_ON(count > queue_max_integrity_segments(rq->q));
1059 1060 1061 1062 1063

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

1064
	return BLK_STS_OK;
1065
out_free_sgtables:
1066
	scsi_mq_free_sgtables(cmd);
1067
	return ret;
1068
}
1069
EXPORT_SYMBOL(scsi_init_io);
Linus Torvalds's avatar
Linus Torvalds committed
1070

1071
/**
1072
 * scsi_initialize_rq - initialize struct scsi_cmnd partially
1073
 * @rq: Request associated with the SCSI command to be initialized.
1074
 *
1075 1076 1077 1078
 * This function initializes the members of struct scsi_cmnd that must be
 * initialized before request processing starts and that won't be
 * reinitialized if a SCSI command is requeued.
 *
1079 1080
 * Called from inside blk_get_request() for pass-through requests and from
 * inside scsi_init_command() for filesystem requests.
1081
 */
1082
static void scsi_initialize_rq(struct request *rq)
1083
{
1084 1085 1086
	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);

	scsi_req_init(&cmd->req);
1087
	init_rcu_head(&cmd->rcu);
1088 1089
	cmd->jiffies_at_alloc = jiffies;
	cmd->retries = 0;
1090 1091
}

1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
/*
 * Only called when the request isn't completed by SCSI, and not freed by
 * SCSI
 */
static void scsi_cleanup_rq(struct request *rq)
{
	if (rq->rq_flags & RQF_DONTPREP) {
		scsi_mq_uninit_cmd(blk_mq_rq_to_pdu(rq));
		rq->rq_flags &= ~RQF_DONTPREP;
	}
}

1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
/* Add a command to the list used by the aacraid and dpt_i2o drivers */
void scsi_add_cmd_to_list(struct scsi_cmnd *cmd)
{
	struct scsi_device *sdev = cmd->device;
	struct Scsi_Host *shost = sdev->host;
	unsigned long flags;

	if (shost->use_cmd_list) {
		spin_lock_irqsave(&sdev->list_lock, flags);
		list_add_tail(&cmd->list, &sdev->cmd_list);
		spin_unlock_irqrestore(&sdev->list_lock, flags);
	}
}

/* Remove a command from the list used by the aacraid and dpt_i2o drivers */
void scsi_del_cmd_from_list(struct scsi_cmnd *cmd)
{
	struct scsi_device *sdev = cmd->device;
	struct Scsi_Host *shost = sdev->host;
	unsigned long flags;

	if (shost->use_cmd_list) {
		spin_lock_irqsave(&sdev->list_lock, flags);
		BUG_ON(list_empty(&cmd->list));
		list_del_init(&cmd->list);
		spin_unlock_irqrestore(&sdev->list_lock, flags);
	}
}

1133
/* Called after a request has been started. */
1134
void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd)
1135
{
1136 1137
	void *buf = cmd->sense_buffer;
	void *prot = cmd->prot_sdb;
1138 1139
	struct request *rq = blk_mq_rq_from_pdu(cmd);
	unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS;
1140 1141
	unsigned long jiffies_at_alloc;
	int retries;
1142 1143 1144 1145 1146

	if (!blk_rq_is_scsi(rq) && !(flags & SCMD_INITIALIZED)) {
		flags |= SCMD_INITIALIZED;
		scsi_initialize_rq(rq);
	}
1147

1148 1149
	jiffies_at_alloc = cmd->jiffies_at_alloc;
	retries = cmd->retries;
1150 1151
	/* zero out the cmd, except for the embedded scsi_request */
	memset((char *)cmd + sizeof(cmd->req), 0,
1152
		sizeof(*cmd) - sizeof(cmd->req) + dev->host->hostt->cmd_size);
1153

1154 1155 1156
	cmd->device = dev;
	cmd->sense_buffer = buf;
	cmd->prot_sdb = prot;
1157
	cmd->flags = flags;
1158
	INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
1159 1160
	cmd->jiffies_at_alloc = jiffies_at_alloc;
	cmd->retries = retries;
1161

1162
	scsi_add_cmd_to_list(cmd);
1163 1164
}

1165 1166
static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev,
		struct request *req)
James Bottomley's avatar
James Bottomley committed
1167
{
1168
	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1169 1170

	/*
1171
	 * Passthrough requests may transfer data, in which case they must
1172 1173 1174 1175 1176
	 * 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) {
1177 1178 1179
		blk_status_t ret = scsi_init_io(cmd);
		if (unlikely(ret != BLK_STS_OK))
			return ret;
1180
	} else {
1181
		BUG_ON(blk_rq_bytes(req));
1182

1183
		memset(&cmd->sdb, 0, sizeof(cmd->sdb));
1184
	}
James Bottomley's avatar
James Bottomley committed
1185

1186 1187
	cmd->cmd_len = scsi_req(req)->cmd_len;
	cmd->cmnd = scsi_req(req)->cmd;
1188
	cmd->transfersize = blk_rq_bytes(req);
1189
	cmd->allowed = scsi_req(req)->retries;
1190
	return BLK_STS_OK;
James Bottomley's avatar
James Bottomley committed
1191 1192
}

1193
/*
1194
 * Setup a normal block command.  These are simple request from filesystems
1195
 * that still need to be translated to SCSI CDBs from the ULD.
1196
 */
1197 1198
static blk_status_t scsi_setup_fs_cmnd(struct scsi_device *sdev,
		struct request *req)
Linus Torvalds's avatar
Linus Torvalds committed
1199
{
1200
	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1201

1202
	if (unlikely(sdev->handler && sdev->handler->prep_fn)) {
1203 1204 1205
		blk_status_t ret = sdev->handler->prep_fn(sdev, req);
		if (ret != BLK_STS_OK)
			return ret;
1206 1207
	}

1208
	cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd;
1209
	memset(cmd->cmnd, 0, BLK_MAX_CDB);
1210
	return scsi_cmd_to_driver(cmd)->init_command(cmd);
1211 1212
}

1213 1214
static blk_status_t scsi_setup_cmnd(struct scsi_device *sdev,
		struct request *req)
1215
{
1216
	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1217 1218 1219 1220 1221 1222 1223 1224

	if (!blk_rq_bytes(req))
		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;

1225 1226 1227
	if (blk_rq_is_scsi(req))
		return scsi_setup_scsi_cmnd(sdev, req);
	else
1228 1229 1230
		return scsi_setup_fs_cmnd(sdev, req);
}

1231
static blk_status_t
1232
scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
1233
{
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
	switch (sdev->sdev_state) {
	case SDEV_OFFLINE:
	case SDEV_TRANSPORT_OFFLINE:
		/*
		 * 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");
		return BLK_STS_IOERR;
	case SDEV_DEL:
		/*
		 * If the device is fully deleted, we refuse to
		 * process any commands as well.
		 */
		sdev_printk(KERN_ERR, sdev,
			    "rejecting I/O to dead device\n");
		return BLK_STS_IOERR;
	case SDEV_BLOCK:
	case SDEV_CREATED_BLOCK:
		return BLK_STS_RESOURCE;
	case SDEV_QUIESCE:
		/*
		 * If the devices is blocked we defer normal commands.
		 */
		if (req && !(req->rq_flags & RQF_PREEMPT))
			return BLK_STS_RESOURCE;
		return BLK_STS_OK;
	default:
		/*
		 * For any other not fully online state we only allow
		 * special commands.  In particular any user initiated
		 * command is not allowed.
		 */
		if (req && !(req->rq_flags & RQF_PREEMPT))
			return BLK_STS_IOERR;
		return BLK_STS_OK;
Linus Torvalds's avatar
Linus Torvalds committed
1272
	}
1273
}
Linus Torvalds's avatar
Linus Torvalds committed
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283

/*
 * 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)
{
1284 1285 1286
	unsigned int busy;

	busy = atomic_inc_return(&sdev->device_busy) - 1;
1287
	if (atomic_read(&sdev->device_blocked)) {
1288 1289 1290
		if (busy)
			goto out_dec;

Linus Torvalds's avatar
Linus Torvalds committed
1291 1292 1293
		/*
		 * unblock after device_blocked iterates to zero
		 */
1294
		if (atomic_dec_return(&sdev->device_blocked) > 0)
1295 1296 1297
			goto out_dec;
		SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev,
				   "unblocking device at zero depth\n"));
Linus Torvalds's avatar
Linus Torvalds committed
1298
	}
1299 1300 1301

	if (busy >= sdev->queue_depth)
		goto out_dec;
Linus Torvalds's avatar
Linus Torvalds committed
1302 1303

	return 1;
1304 1305 1306
out_dec:
	atomic_dec(&sdev->device_busy);
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
1307 1308
}

1309 1310 1311 1312 1313 1314 1315 1316
/*
 * scsi_target_queue_ready: checks if there we can send commands to target
 * @sdev: scsi device on starget to check.
 */
static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
					   struct scsi_device *sdev)
{
	struct scsi_target *starget = scsi_target(sdev);
1317
	unsigned int busy;
1318 1319

	if (starget->single_lun) {
1320
		spin_lock_irq(shost->host_lock);
1321
		if (starget->starget_sdev_user &&
1322 1323 1324 1325
		    starget->starget_sdev_user != sdev) {
			spin_unlock_irq(shost->host_lock);
			return 0;
		}
1326
		starget->starget_sdev_user = sdev;
1327
		spin_unlock_irq(shost->host_lock);
1328 1329
	}

1330 1331 1332
	if (starget->can_queue <= 0)
		return 1;

1333
	busy = atomic_inc_return(&starget->target_busy) - 1;
1334
	if (atomic_read(&starget->target_blocked) > 0) {
1335 1336 1337
		if (busy)
			goto starved;

1338 1339 1340
		/*
		 * unblock after target_blocked iterates to zero
		 */
1341
		if (atomic_dec_return(&starget->target_blocked) > 0)
1342
			goto out_dec;
1343 1344 1345

		SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
				 "unblocking target at zero depth\n"));
1346 1347
	}

1348
	if (busy >= starget->can_queue)
1349
		goto starved;
1350

1351 1352 1353 1354 1355
	return 1;

starved:
	spin_lock_irq(shost->host_lock);
	list_move_tail(&sdev->starved_entry, &shost->starved_list);
1356
	spin_unlock_irq(shost->host_lock);
1357
out_dec:
1358 1359
	if (starget->can_queue > 0)
		atomic_dec(&starget->target_busy);
1360
	return 0;
1361 1362
}

Linus Torvalds's avatar
Linus Torvalds committed
1363 1364 1365 1366 1367 1368 1369 1370 1371
/*
 * 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.
 */
static inline int scsi_host_queue_ready(struct request_queue *q,
				   struct Scsi_Host *shost,
				   struct scsi_device *sdev)
{
1372
	unsigned int busy;
1373

1374
	if (scsi_host_in_recovery(shost))
1375 1376
		return 0;

1377
	busy = atomic_inc_return(&shost->host_busy) - 1;
1378
	if (atomic_read(&shost->host_blocked) > 0) {
1379
		if (busy)
1380 1381
			goto starved;

Linus Torvalds's avatar
Linus Torvalds committed
1382 1383 1384
		/*
		 * unblock after host_blocked iterates to zero
		 */
1385
		if (atomic_dec_return(&shost->host_blocked) > 0)
1386
			goto out_dec;
1387 1388 1389 1390

		SCSI_LOG_MLQUEUE(3,
			shost_printk(KERN_INFO, shost,
				     "unblocking host at zero depth\n"));
Linus Torvalds's avatar
Linus Torvalds committed
1391
	}
1392

1393
	if (shost->can_queue > 0 && busy >= shost->can_queue)
1394 1395 1396
		goto starved;
	if (shost->host_self_blocked)
		goto starved;
Linus Torvalds's avatar
Linus Torvalds committed
1397 1398

	/* We're OK to process the command, so we can't be starved */
1399 1400 1401 1402 1403 1404
	if (!list_empty(&sdev->starved_entry)) {
		spin_lock_irq(shost->host_lock);
		if (!list_empty(&sdev->starved_entry))
			list_del_init(&sdev->starved_entry);
		spin_unlock_irq(shost->host_lock);
	}
Linus Torvalds's avatar
Linus Torvalds committed
1405

1406 1407 1408 1409 1410 1411
	return 1;

starved:
	spin_lock_irq(shost->host_lock);
	if (list_empty(&sdev->starved_entry))
		list_add_tail(&sdev->starved_entry, &shost->starved_list);
1412
	spin_unlock_irq(shost->host_lock);
1413
out_dec:
1414
	scsi_dec_host_busy(shost);
1415
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
1416 1417
}

1418 1419 1420 1421 1422 1423 1424 1425
/*
 * 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.
 *
1426 1427 1428
 * 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.
1429
 */
1430
static bool scsi_mq_lld_busy(struct request_queue *q)
1431 1432 1433 1434
{
	struct scsi_device *sdev = q->queuedata;
	struct Scsi_Host *shost;

1435
	if (blk_queue_dying(q))
1436
		return false;
1437 1438 1439

	shost = sdev->host;

1440 1441 1442 1443 1444 1445 1446
	/*
	 * 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))
1447
		return true;
1448

1449
	return false;
Linus Torvalds's avatar
Linus Torvalds committed
1450 1451
}

1452 1453
static void scsi_softirq_done(struct request *rq)
{
1454
	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1455
	unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
1456 1457 1458 1459
	int disposition;

	INIT_LIST_HEAD(&cmd->eh_entry);

1460 1461 1462 1463
	atomic_inc(&cmd->device->iodone_cnt);
	if (cmd->result)
		atomic_inc(&cmd->device->ioerr_cnt);

1464 1465 1466
	disposition = scsi_decide_disposition(cmd);
	if (disposition != SUCCESS &&
	    time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
1467
		scmd_printk(KERN_ERR, cmd,
1468 1469 1470 1471
			    "timing out command, waited %lus\n",
			    wait_for/HZ);
		disposition = SUCCESS;
	}
1472

1473 1474 1475 1476 1477 1478 1479
	scsi_log_completion(cmd, disposition);

	switch (disposition) {
		case SUCCESS:
			scsi_finish_command(cmd);
			break;
		case NEEDS_RETRY:
1480
			scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
1481 1482 1483 1484 1485
			break;
		case ADD_TO_MLQUEUE:
			scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
			break;
		default:
1486
			scsi_eh_scmd_add(cmd);
1487
			break;
1488 1489 1490
	}
}

1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
/**
 * scsi_dispatch_command - Dispatch a command to the low-level driver.
 * @cmd: command block we are dispatching.
 *
 * Return: nonzero return request was rejected and device's queue needs to be
 * plugged.
 */
static int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
{
	struct Scsi_Host *host = cmd->device->host;
	int rtn = 0;

	atomic_inc(&cmd->device->iorequest_cnt);

	/* check if the device is still usable */
	if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
		/* in SDEV_DEL we error all commands. DID_NO_CONNECT
		 * returns an immediate error upwards, and signals
		 * that the device is no longer present */
		cmd->result = DID_NO_CONNECT << 16;
		goto done;
	}

	/* Check to see if the scsi lld made this device blocked. */
	if (unlikely(scsi_device_blocked(cmd->device))) {
		/*
		 * in blocked state, the command is just put back on
		 * the device queue.  The suspend state has already
		 * blocked the queue so future requests should not
		 * occur until the device transitions out of the
		 * suspend state.
		 */
		SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
			"queuecommand : device blocked\n"));
		return SCSI_MLQUEUE_DEVICE_BUSY;
	}

	/* Store the LUN value in cmnd, if needed. */
	if (cmd->device->lun_in_cdb)
		cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
			       (cmd->device->lun << 5 & 0xe0);

	scsi_log_send(cmd);

	/*
	 * Before we queue this command, check if the command
	 * length exceeds what the host adapter can handle.
	 */
	if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
		SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
			       "queuecommand : command too long. "
			       "cdb_size=%d host->max_cmd_len=%d\n",
			       cmd->cmd_len, cmd->device->host->max_cmd_len));
		cmd->result = (DID_ABORT << 16);
		goto done;
	}

	if (unlikely(host->shost_state == SHOST_DEL)) {
		cmd->result = (DID_NO_CONNECT << 16);
		goto done;

	}

	trace_scsi_dispatch_cmd_start(cmd);
	rtn = host->hostt->queuecommand(host, cmd);
	if (rtn) {
		trace_scsi_dispatch_cmd_error(cmd, rtn);
		if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
		    rtn != SCSI_MLQUEUE_TARGET_BUSY)
			rtn = SCSI_MLQUEUE_HOST_BUSY;

		SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
			"queuecommand : request rejected\n"));
	}

	return rtn;
 done:
	cmd->scsi_done(cmd);
	return 0;
}

1572
/* Size in bytes of the sg-list stored in the scsi-mq command-private data. */
1573
static unsigned int scsi_mq_inline_sgl_size(struct Scsi_Host *shost)
1574
{
1575
	return min_t(unsigned int, shost->sg_tablesize, SCSI_INLINE_SG_CNT) *
1576 1577 1578
		sizeof(struct scatterlist);
}

1579
static blk_status_t scsi_mq_prep_fn(struct request *req)
1580 1581 1582 1583 1584 1585
{
	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
	struct scsi_device *sdev = req->q->queuedata;
	struct Scsi_Host *shost = sdev->host;
	struct scatterlist *sg;

1586
	scsi_init_command(sdev, cmd);
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601

	cmd->request = req;
	cmd->tag = req->tag;
	cmd->prot_op = SCSI_PROT_NORMAL;

	sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size;
	cmd->sdb.table.sgl = sg;

	if (scsi_host_get_prot(shost)) {
		memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer));

		cmd->prot_sdb->table.sgl =
			(struct scatterlist *)(cmd->prot_sdb + 1);
	}

1602 1603
	blk_mq_start_request(req);

1604
	return scsi_setup_cmnd(sdev, req);
1605 1606 1607 1608
}

static void scsi_mq_done(struct scsi_cmnd *cmd)
{
1609 1610
	if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state)))
		return;
1611
	trace_scsi_dispatch_cmd_done(cmd);
1612 1613 1614 1615 1616 1617 1618 1619 1620

	/*
	 * If the block layer didn't complete the request due to a timeout
	 * injection, scsi must clear its internal completed state so that the
	 * timeout handler will see it needs to escalate its own error
	 * recovery.
	 */
	if (unlikely(!blk_mq_complete_request(cmd->request)))
		clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
1621 1622
}

1623
static void scsi_mq_put_budget(struct blk_mq_hw_ctx *hctx)
1624
{
1625 1626 1627 1628 1629 1630
	struct request_queue *q = hctx->queue;
	struct scsi_device *sdev = q->queuedata;

	atomic_dec(&sdev->device_busy);
}

1631
static bool scsi_mq_get_budget(struct blk_mq_hw_ctx *hctx)
1632 1633
{
	struct request_queue *q = hctx->queue;
1634 1635
	struct scsi_device *sdev = q->queuedata;

1636 1637
	if (scsi_dev_queue_ready(q, sdev))
		return true;
1638

1639 1640
	if (atomic_read(&sdev->device_busy) == 0 && !scsi_device_blocked(sdev))
		blk_mq_delay_run_hw_queue(hctx, SCSI_QUEUE_DELAY);
1641
	return false;
1642 1643
}

1644
static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx,
1645
			 const struct blk_mq_queue_data *bd)
1646
{
1647
	struct request *req = bd->rq;
1648 1649 1650 1651
	struct request_queue *q = req->q;
	struct scsi_device *sdev = q->queuedata;
	struct Scsi_Host *shost = sdev->host;
	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req);
1652
	blk_status_t ret;
1653 1654
	int reason;

1655 1656 1657 1658 1659 1660 1661 1662 1663
	/*
	 * If the device is not in running state we will reject some or all
	 * commands.
	 */
	if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
		ret = scsi_prep_state_check(sdev, req);
		if (ret != BLK_STS_OK)
			goto out_put_budget;
	}
1664

1665
	ret = BLK_STS_RESOURCE;
1666
	if (!scsi_target_queue_ready(shost, sdev))
1667
		goto out_put_budget;
1668 1669 1670
	if (!scsi_host_queue_ready(q, shost, sdev))
		goto out_dec_target_busy;

1671
	if (!(req->rq_flags & RQF_DONTPREP)) {
1672
		ret = scsi_mq_prep_fn(req);
1673
		if (ret != BLK_STS_OK)
1674
			goto out_dec_host_busy;
1675
		req->rq_flags |= RQF_DONTPREP;
1676
	} else {
1677
		clear_bit(SCMD_STATE_COMPLETE, &cmd->state);
1678
		blk_mq_start_request(req);
1679 1680
	}

1681
	cmd->flags &= SCMD_PRESERVED_FLAGS;
1682 1683
	if (sdev->simple_tags)
		cmd->flags |= SCMD_TAGGED;
1684 1685
	if (bd->last)
		cmd->flags |= SCMD_LAST;
1686

1687 1688 1689 1690 1691 1692
	scsi_init_cmd_errh(cmd);
	cmd->scsi_done = scsi_mq_done;

	reason = scsi_dispatch_cmd(cmd);
	if (reason) {
		scsi_set_blocked(cmd, reason);
1693
		ret = BLK_STS_RESOURCE;
1694 1695 1696
		goto out_dec_host_busy;
	}

1697
	return BLK_STS_OK;
1698 1699

out_dec_host_busy:
1700
	scsi_dec_host_busy(shost);
1701 1702 1703
out_dec_target_busy:
	if (scsi_target(sdev)->can_queue > 0)
		atomic_dec(&scsi_target(sdev)->target_busy);
1704 1705
out_put_budget:
	scsi_mq_put_budget(hctx);
1706
	switch (ret) {
1707 1708 1709
	case BLK_STS_OK:
		break;
	case BLK_STS_RESOURCE:
1710 1711 1712
		if (atomic_read(&sdev->device_busy) ||
		    scsi_device_blocked(sdev))
			ret = BLK_STS_DEV_RESOURCE;
1713
		break;
1714
	default:
1715 1716 1717 1718
		if (unlikely(!scsi_device_online(sdev)))
			scsi_req(req)->result = DID_NO_CONNECT << 16;
		else
			scsi_req(req)->result = DID_ERROR << 16;
1719
		/*
1720
		 * Make sure to release all allocated resources when
1721 1722 1723
		 * we hit an error, as we will never see this command
		 * again.
		 */
1724
		if (req->rq_flags & RQF_DONTPREP)
1725 1726 1727 1728 1729 1730
			scsi_mq_uninit_cmd(cmd);
		break;
	}
	return ret;
}

1731 1732 1733 1734 1735 1736 1737 1738
static enum blk_eh_timer_return scsi_timeout(struct request *req,
		bool reserved)
{
	if (reserved)
		return BLK_EH_RESET_TIMER;
	return scsi_times_out(req);
}

1739 1740
static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
				unsigned int hctx_idx, unsigned int numa_node)
1741
{
1742
	struct Scsi_Host *shost = set->driver_data;
1743
	const bool unchecked_isa_dma = shost->unchecked_isa_dma;
1744
	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
1745
	struct scatterlist *sg;
1746

1747 1748 1749 1750
	if (unchecked_isa_dma)
		cmd->flags |= SCMD_UNCHECKED_ISA_DMA;
	cmd->sense_buffer = scsi_alloc_sense_buffer(unchecked_isa_dma,
						    GFP_KERNEL, numa_node);
1751 1752
	if (!cmd->sense_buffer)
		return -ENOMEM;
1753
	cmd->req.sense = cmd->sense_buffer;
1754 1755 1756 1757

	if (scsi_host_get_prot(shost)) {
		sg = (void *)cmd + sizeof(struct scsi_cmnd) +
			shost->hostt->cmd_size;
1758
		cmd->prot_sdb = (void *)sg + scsi_mq_inline_sgl_size(shost);
1759 1760
	}

1761 1762 1763
	return 0;
}

1764 1765
static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq,
				 unsigned int hctx_idx)
1766 1767 1768
{
	struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);

1769 1770
	scsi_free_sense_buffer(cmd->flags & SCMD_UNCHECKED_ISA_DMA,
			       cmd->sense_buffer);
1771 1772
}

1773 1774 1775 1776 1777 1778
static int scsi_map_queues(struct blk_mq_tag_set *set)
{
	struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set);

	if (shost->hostt->map_queues)
		return shost->hostt->map_queues(shost);
1779
	return blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
1780 1781
}

1782
void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q)
Linus Torvalds's avatar
Linus Torvalds committed
1783
{
1784
	struct device *dev = shost->dma_dev;
Linus Torvalds's avatar
Linus Torvalds committed
1785

1786 1787 1788
	/*
	 * this limit is imposed by hardware restrictions
	 */
1789
	blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize,
1790
					SG_MAX_SEGMENTS));
1791

1792 1793 1794 1795 1796 1797 1798 1799
	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);
	}

1800 1801 1802 1803
	if (dev->dma_mask) {
		shost->max_sectors = min_t(unsigned int, shost->max_sectors,
				dma_max_mapping_size(dev) >> SECTOR_SHIFT);
	}
1804
	blk_queue_max_hw_sectors(q, shost->max_sectors);
1805 1806
	if (shost->unchecked_isa_dma)
		blk_queue_bounce_limit(q, BLK_BOUNCE_ISA);
Linus Torvalds's avatar
Linus Torvalds committed
1807
	blk_queue_segment_boundary(q, shost->dma_boundary);
1808
	dma_set_seg_boundary(dev, shost->dma_boundary);
Linus Torvalds's avatar
Linus Torvalds committed
1809

1810
	blk_queue_max_segment_size(q, shost->max_segment_size);
1811 1812
	blk_queue_virt_boundary(q, shost->virt_boundary_mask);
	dma_set_max_seg_size(dev, queue_max_segment_size(q));
1813 1814

	/*
1815 1816 1817 1818 1819
	 * Set a reasonable default alignment:  The larger of 32-byte (dword),
	 * which is a common minimum for HBAs, and the minimum DMA alignment,
	 * which is set by the platform.
	 *
	 * Devices that require a bigger alignment can increase it later.
1820
	 */
1821
	blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1);
1822
}
1823
EXPORT_SYMBOL_GPL(__scsi_init_queue);
1824

1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
static const struct blk_mq_ops scsi_mq_ops_no_commit = {
	.get_budget	= scsi_mq_get_budget,
	.put_budget	= scsi_mq_put_budget,
	.queue_rq	= scsi_queue_rq,
	.complete	= scsi_softirq_done,
	.timeout	= scsi_timeout,
#ifdef CONFIG_BLK_DEBUG_FS
	.show_rq	= scsi_show_rq,
#endif
	.init_request	= scsi_mq_init_request,
	.exit_request	= scsi_mq_exit_request,
	.initialize_rq_fn = scsi_initialize_rq,
	.busy		= scsi_mq_lld_busy,
	.map_queues	= scsi_map_queues,
};


static void scsi_commit_rqs(struct blk_mq_hw_ctx *hctx)
{
	struct request_queue *q = hctx->queue;
	struct scsi_device *sdev = q->queuedata;
	struct Scsi_Host *shost = sdev->host;

	shost->hostt->commit_rqs(shost, hctx->queue_num);
}

1851
static const struct blk_mq_ops scsi_mq_ops = {
1852 1853
	.get_budget	= scsi_mq_get_budget,
	.put_budget	= scsi_mq_put_budget,
1854
	.queue_rq	= scsi_queue_rq,
1855
	.commit_rqs	= scsi_commit_rqs,
1856
	.complete	= scsi_softirq_done,
1857
	.timeout	= scsi_timeout,
1858 1859 1860
#ifdef CONFIG_BLK_DEBUG_FS
	.show_rq	= scsi_show_rq,
#endif
1861 1862
	.init_request	= scsi_mq_init_request,
	.exit_request	= scsi_mq_exit_request,
1863
	.initialize_rq_fn = scsi_initialize_rq,
1864
	.cleanup_rq	= scsi_cleanup_rq,
1865
	.busy		= scsi_mq_lld_busy,
1866
	.map_queues	= scsi_map_queues,
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876
};

struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev)
{
	sdev->request_queue = blk_mq_init_queue(&sdev->host->tag_set);
	if (IS_ERR(sdev->request_queue))
		return NULL;

	sdev->request_queue->queuedata = sdev;
	__scsi_init_queue(sdev->host, sdev->request_queue);
1877
	blk_queue_flag_set(QUEUE_FLAG_SCSI_PASSTHROUGH, sdev->request_queue);
1878 1879 1880 1881 1882
	return sdev->request_queue;
}

int scsi_mq_setup_tags(struct Scsi_Host *shost)
{
1883
	unsigned int cmd_size, sgl_size;
1884

1885
	sgl_size = scsi_mq_inline_sgl_size(shost);
1886 1887
	cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size;
	if (scsi_host_get_prot(shost))
1888 1889
		cmd_size += sizeof(struct scsi_data_buffer) +
			sizeof(struct scatterlist) * SCSI_INLINE_PROT_SG_CNT;
1890 1891

	memset(&shost->tag_set, 0, sizeof(shost->tag_set));
1892 1893 1894 1895
	if (shost->hostt->commit_rqs)
		shost->tag_set.ops = &scsi_mq_ops;
	else
		shost->tag_set.ops = &scsi_mq_ops_no_commit;
1896
	shost->tag_set.nr_hw_queues = shost->nr_hw_queues ? : 1;
1897 1898 1899
	shost->tag_set.queue_depth = shost->can_queue;
	shost->tag_set.cmd_size = cmd_size;
	shost->tag_set.numa_node = NUMA_NO_NODE;
Ming Lei's avatar
Ming Lei committed
1900
	shost->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
1901 1902
	shost->tag_set.flags |=
		BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy);
1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
	shost->tag_set.driver_data = shost;

	return blk_mq_alloc_tag_set(&shost->tag_set);
}

void scsi_mq_destroy_tags(struct Scsi_Host *shost)
{
	blk_mq_free_tag_set(&shost->tag_set);
}

1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923
/**
 * scsi_device_from_queue - return sdev associated with a request_queue
 * @q: The request queue to return the sdev from
 *
 * Return the sdev associated with a request queue or NULL if the
 * request_queue does not reference a SCSI device.
 */
struct scsi_device *scsi_device_from_queue(struct request_queue *q)
{
	struct scsi_device *sdev = NULL;

1924
	if (q->mq_ops == &scsi_mq_ops)
1925 1926 1927 1928 1929 1930 1931 1932
		sdev = q->queuedata;
	if (!sdev || !get_device(&sdev->sdev_gendev))
		sdev = NULL;

	return sdev;
}
EXPORT_SYMBOL_GPL(scsi_device_from_queue);

Linus Torvalds's avatar
Linus Torvalds committed
1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983
/*
 * 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)
{
1984 1985 1986 1987 1988
	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");
1989
		return -ENOMEM;
1990 1991
	}

Linus Torvalds's avatar
Linus Torvalds committed
1992 1993 1994 1995 1996
	return 0;
}

void scsi_exit_queue(void)
{
1997 1998
	kmem_cache_destroy(scsi_sense_cache);
	kmem_cache_destroy(scsi_sense_isadma_cache);
1999
	kmem_cache_destroy(scsi_sdb_cache);
Linus Torvalds's avatar
Linus Torvalds committed
2000
}
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012

/**
 *	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
2013
 *	@sshdr: place to put sense data (or NULL if no sense to be collected).
2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072
 *		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,
2073
			       sshdr, timeout, retries, NULL);
2074 2075 2076 2077 2078
	kfree(real_buffer);
	return ret;
}
EXPORT_SYMBOL_GPL(scsi_mode_select);

Linus Torvalds's avatar
Linus Torvalds committed
2079
/**
2080
 *	scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
2081
 *	@sdev:	SCSI device to be queried
Linus Torvalds's avatar
Linus Torvalds committed
2082 2083 2084 2085 2086 2087 2088
 *	@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
2089
 *	@sshdr: place to put sense data (or NULL if no sense to be collected).
2090
 *		must be SCSI_SENSE_BUFFERSIZE big.
Linus Torvalds's avatar
Linus Torvalds committed
2091 2092 2093 2094
 *
 *	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.
2095
 */
Linus Torvalds's avatar
Linus Torvalds committed
2096
int
2097
scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
Linus Torvalds's avatar
Linus Torvalds committed
2098
		  unsigned char *buffer, int len, int timeout, int retries,
2099 2100
		  struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
{
Linus Torvalds's avatar
Linus Torvalds committed
2101 2102 2103
	unsigned char cmd[12];
	int use_10_for_ms;
	int header_length;
2104
	int result, retry_count = retries;
2105
	struct scsi_sense_hdr my_sshdr;
Linus Torvalds's avatar
Linus Torvalds committed
2106 2107 2108 2109 2110 2111

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

2112 2113 2114 2115
	/* caller might not be interested in sense, but we need it */
	if (!sshdr)
		sshdr = &my_sshdr;

Linus Torvalds's avatar
Linus Torvalds committed
2116
 retry:
2117
	use_10_for_ms = sdev->use_10_for_ms;
Linus Torvalds's avatar
Linus Torvalds committed
2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136

	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);

2137
	result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
2138
				  sshdr, timeout, retries, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
2139 2140 2141 2142 2143 2144

	/* 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 */

2145
	if (use_10_for_ms && !scsi_status_is_good(result) &&
2146
	    driver_byte(result) == DRIVER_SENSE) {
2147 2148 2149
		if (scsi_sense_valid(sshdr)) {
			if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
			    (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
Linus Torvalds's avatar
Linus Torvalds committed
2150 2151 2152
				/* 
				 * Invalid command operation code
				 */
2153
				sdev->use_10_for_ms = 0;
Linus Torvalds's avatar
Linus Torvalds committed
2154 2155 2156 2157 2158
				goto retry;
			}
		}
	}

2159
	if(scsi_status_is_good(result)) {
2160 2161 2162 2163 2164 2165 2166 2167 2168 2169
		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) {
Linus Torvalds's avatar
Linus Torvalds committed
2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181
			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];
		}
2182
		data->header_length = header_length;
2183 2184 2185 2186 2187
	} else if ((status_byte(result) == CHECK_CONDITION) &&
		   scsi_sense_valid(sshdr) &&
		   sshdr->sense_key == UNIT_ATTENTION && retry_count) {
		retry_count--;
		goto retry;
Linus Torvalds's avatar
Linus Torvalds committed
2188 2189
	}

2190
	return result;
Linus Torvalds's avatar
Linus Torvalds committed
2191 2192 2193
}
EXPORT_SYMBOL(scsi_mode_sense);

2194 2195 2196 2197 2198
/**
 *	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
2199
 *	@sshdr: outpout pointer for decoded sense information.
2200 2201
 *
 *	Returns zero if unsuccessful or an error if TUR failed.  For
2202
 *	removable media, UNIT_ATTENTION sets ->changed flag.
2203
 **/
Linus Torvalds's avatar
Linus Torvalds committed
2204
int
2205
scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
2206
		     struct scsi_sense_hdr *sshdr)
Linus Torvalds's avatar
Linus Torvalds committed
2207 2208 2209 2210 2211
{
	char cmd[] = {
		TEST_UNIT_READY, 0, 0, 0, 0, 0,
	};
	int result;
2212 2213 2214 2215

	/* try to eat the UNIT_ATTENTION if there are enough retries */
	do {
		result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
2216
					  timeout, 1, NULL);
2217 2218 2219 2220 2221
		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);
2222

Linus Torvalds's avatar
Linus Torvalds committed
2223 2224 2225 2226 2227
	return result;
}
EXPORT_SYMBOL(scsi_test_unit_ready);

/**
2228
 *	scsi_device_set_state - Take the given device through the device state model.
Linus Torvalds's avatar
Linus Torvalds committed
2229 2230 2231
 *	@sdev:	scsi device to change the state of.
 *	@state:	state to change to.
 *
2232
 *	Returns zero if successful or an error if the requested
Linus Torvalds's avatar
Linus Torvalds committed
2233
 *	transition is illegal.
2234
 */
Linus Torvalds's avatar
Linus Torvalds committed
2235 2236 2237 2238 2239 2240 2241 2242 2243 2244
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:
2245 2246 2247 2248 2249 2250 2251
		switch (oldstate) {
		case SDEV_CREATED_BLOCK:
			break;
		default:
			goto illegal;
		}
		break;
Linus Torvalds's avatar
Linus Torvalds committed
2252 2253 2254 2255 2256
			
	case SDEV_RUNNING:
		switch (oldstate) {
		case SDEV_CREATED:
		case SDEV_OFFLINE:
2257
		case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds's avatar
Linus Torvalds committed
2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269
		case SDEV_QUIESCE:
		case SDEV_BLOCK:
			break;
		default:
			goto illegal;
		}
		break;

	case SDEV_QUIESCE:
		switch (oldstate) {
		case SDEV_RUNNING:
		case SDEV_OFFLINE:
2270
		case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds's avatar
Linus Torvalds committed
2271 2272 2273 2274 2275 2276 2277
			break;
		default:
			goto illegal;
		}
		break;

	case SDEV_OFFLINE:
2278
	case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds's avatar
Linus Torvalds committed
2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292
		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:
2293
		case SDEV_CREATED_BLOCK:
2294
		case SDEV_OFFLINE:
2295 2296 2297 2298 2299 2300 2301 2302 2303
			break;
		default:
			goto illegal;
		}
		break;

	case SDEV_CREATED_BLOCK:
		switch (oldstate) {
		case SDEV_CREATED:
Linus Torvalds's avatar
Linus Torvalds committed
2304 2305 2306 2307 2308 2309 2310 2311 2312 2313
			break;
		default:
			goto illegal;
		}
		break;

	case SDEV_CANCEL:
		switch (oldstate) {
		case SDEV_CREATED:
		case SDEV_RUNNING:
2314
		case SDEV_QUIESCE:
Linus Torvalds's avatar
Linus Torvalds committed
2315
		case SDEV_OFFLINE:
2316
		case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds's avatar
Linus Torvalds committed
2317 2318 2319 2320 2321 2322 2323 2324
			break;
		default:
			goto illegal;
		}
		break;

	case SDEV_DEL:
		switch (oldstate) {
2325 2326 2327
		case SDEV_CREATED:
		case SDEV_RUNNING:
		case SDEV_OFFLINE:
2328
		case SDEV_TRANSPORT_OFFLINE:
Linus Torvalds's avatar
Linus Torvalds committed
2329
		case SDEV_CANCEL:
2330
		case SDEV_BLOCK:
2331
		case SDEV_CREATED_BLOCK:
Linus Torvalds's avatar
Linus Torvalds committed
2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342
			break;
		default:
			goto illegal;
		}
		break;

	}
	sdev->sdev_state = state;
	return 0;

 illegal:
2343
	SCSI_LOG_ERROR_RECOVERY(1,
2344
				sdev_printk(KERN_ERR, sdev,
2345
					    "Illegal state transition %s->%s",
2346 2347
					    scsi_device_state_name(oldstate),
					    scsi_device_state_name(state))
Linus Torvalds's avatar
Linus Torvalds committed
2348 2349 2350 2351 2352
				);
	return -EINVAL;
}
EXPORT_SYMBOL(scsi_device_set_state);

2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368
/**
 * 	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;
2369
	case SDEV_EVT_INQUIRY_CHANGE_REPORTED:
2370
		scsi_rescan_device(&sdev->sdev_gendev);
2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384
		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;
2385 2386 2387
	case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
		envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED";
		break;
2388 2389 2390
	case SDEV_EVT_POWER_ON_RESET_OCCURRED:
		envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED";
		break;
2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410
	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;
2411
	enum scsi_device_event evt_type;
2412 2413 2414 2415
	LIST_HEAD(event_list);

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

2416 2417 2418 2419
	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);

2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451
	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;

2452 2453 2454 2455
#if 0
	/* FIXME: currently this check eliminates all media change events
	 * for polled devices.  Need to update to discriminate between AN
	 * and polled events */
2456 2457 2458 2459
	if (!test_bit(evt->evt_type, sdev->supported_events)) {
		kfree(evt);
		return;
	}
2460
#endif
2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488

	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:
2489 2490 2491 2492 2493
	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:
2494
	case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED:
2495
	case SDEV_EVT_POWER_ON_RESET_OCCURRED:
2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526
	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);

Linus Torvalds's avatar
Linus Torvalds committed
2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540
/**
 *	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.
2541
 */
Linus Torvalds's avatar
Linus Torvalds committed
2542 2543 2544
int
scsi_device_quiesce(struct scsi_device *sdev)
{
2545
	struct request_queue *q = sdev->request_queue;
2546 2547
	int err;

2548 2549 2550 2551 2552 2553 2554
	/*
	 * It is allowed to call scsi_device_quiesce() multiple times from
	 * the same context but concurrent scsi_device_quiesce() calls are
	 * not allowed.
	 */
	WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current);

2555 2556 2557 2558
	if (sdev->quiesced_by == current)
		return 0;

	blk_set_pm_only(q);
2559 2560 2561

	blk_mq_freeze_queue(q);
	/*
2562
	 * Ensure that the effect of blk_set_pm_only() will be visible
2563 2564 2565 2566 2567 2568 2569
	 * for percpu_ref_tryget() callers that occur after the queue
	 * unfreeze even if the queue was already frozen before this function
	 * was called. See also https://lwn.net/Articles/573497/.
	 */
	synchronize_rcu();
	blk_mq_unfreeze_queue(q);

2570 2571
	mutex_lock(&sdev->state_mutex);
	err = scsi_device_set_state(sdev, SDEV_QUIESCE);
2572 2573 2574
	if (err == 0)
		sdev->quiesced_by = current;
	else
2575
		blk_clear_pm_only(q);
2576 2577
	mutex_unlock(&sdev->state_mutex);

2578
	return err;
Linus Torvalds's avatar
Linus Torvalds committed
2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589
}
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.
2590
 */
2591
void scsi_device_resume(struct scsi_device *sdev)
Linus Torvalds's avatar
Linus Torvalds committed
2592
{
2593 2594 2595 2596
	/* 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)
	 */
2597
	mutex_lock(&sdev->state_mutex);
2598 2599 2600 2601
	if (sdev->quiesced_by) {
		sdev->quiesced_by = NULL;
		blk_clear_pm_only(sdev->request_queue);
	}
2602 2603
	if (sdev->sdev_state == SDEV_QUIESCE)
		scsi_device_set_state(sdev, SDEV_RUNNING);
2604
	mutex_unlock(&sdev->state_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634
}
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);

/**
2635 2636
 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state
 * @sdev: device to block
Linus Torvalds's avatar
Linus Torvalds committed
2637
 *
2638
 * Pause SCSI command processing on the specified device. Does not sleep.
Linus Torvalds's avatar
Linus Torvalds committed
2639
 *
2640
 * Returns zero if successful or a negative error code upon failure.
2641
 *
2642 2643 2644 2645 2646
 * Notes:
 * This routine transitions the device to the SDEV_BLOCK state (which must be
 * a legal transition). When the device is in this state, command processing
 * is paused until the device leaves the SDEV_BLOCK state. See also
 * scsi_internal_device_unblock_nowait().
2647
 */
2648
int scsi_internal_device_block_nowait(struct scsi_device *sdev)
Linus Torvalds's avatar
Linus Torvalds committed
2649
{
2650
	struct request_queue *q = sdev->request_queue;
Linus Torvalds's avatar
Linus Torvalds committed
2651 2652 2653
	int err = 0;

	err = scsi_device_set_state(sdev, SDEV_BLOCK);
2654 2655 2656 2657 2658 2659
	if (err) {
		err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);

		if (err)
			return err;
	}
Linus Torvalds's avatar
Linus Torvalds committed
2660 2661 2662 2663 2664 2665

	/* 
	 * The device has transitioned to SDEV_BLOCK.  Stop the
	 * block layer from calling the midlayer with this device's
	 * request queue. 
	 */
2666
	blk_mq_quiesce_queue_nowait(q);
Linus Torvalds's avatar
Linus Torvalds committed
2667 2668
	return 0;
}
2669 2670
EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait);

Linus Torvalds's avatar
Linus Torvalds committed
2671
/**
2672 2673 2674 2675 2676
 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state
 * @sdev: device to block
 *
 * Pause SCSI command processing on the specified device and wait until all
 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep.
Linus Torvalds's avatar
Linus Torvalds committed
2677
 *
2678
 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds's avatar
Linus Torvalds committed
2679
 *
2680 2681 2682 2683 2684
 * Note:
 * This routine transitions the device to the SDEV_BLOCK state (which must be
 * a legal transition). When the device is in this state, command processing
 * is paused until the device leaves the SDEV_BLOCK state. See also
 * scsi_internal_device_unblock().
2685
 */
2686
static int scsi_internal_device_block(struct scsi_device *sdev)
Linus Torvalds's avatar
Linus Torvalds committed
2687
{
2688 2689 2690
	struct request_queue *q = sdev->request_queue;
	int err;

2691
	mutex_lock(&sdev->state_mutex);
2692
	err = scsi_internal_device_block_nowait(sdev);
2693 2694
	if (err == 0)
		blk_mq_quiesce_queue(q);
2695 2696
	mutex_unlock(&sdev->state_mutex);

2697 2698
	return err;
}
Linus Torvalds's avatar
Linus Torvalds committed
2699
 
2700 2701 2702
void scsi_start_queue(struct scsi_device *sdev)
{
	struct request_queue *q = sdev->request_queue;
2703

2704
	blk_mq_unquiesce_queue(q);
2705 2706
}

Linus Torvalds's avatar
Linus Torvalds committed
2707
/**
2708
 * scsi_internal_device_unblock_nowait - resume a device after a block request
Linus Torvalds's avatar
Linus Torvalds committed
2709
 * @sdev:	device to resume
2710
 * @new_state:	state to set the device to after unblocking
Linus Torvalds's avatar
Linus Torvalds committed
2711
 *
2712 2713
 * Restart the device queue for a previously suspended SCSI device. Does not
 * sleep.
Linus Torvalds's avatar
Linus Torvalds committed
2714
 *
2715
 * Returns zero if successful or a negative error code upon failure.
Linus Torvalds's avatar
Linus Torvalds committed
2716
 *
2717 2718 2719 2720
 * Notes:
 * This routine transitions the device to the SDEV_RUNNING state or to one of
 * the offline states (which must be a legal transition) allowing the midlayer
 * to goose the queue for this device.
2721
 */
2722 2723
int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
					enum scsi_device_state new_state)
Linus Torvalds's avatar
Linus Torvalds committed
2724
{
2725 2726 2727 2728 2729 2730 2731 2732
	switch (new_state) {
	case SDEV_RUNNING:
	case SDEV_TRANSPORT_OFFLINE:
		break;
	default:
		return -EINVAL;
	}

2733 2734 2735
	/*
	 * Try to transition the scsi device to SDEV_RUNNING or one of the
	 * offlined states and goose the device queue if successful.
Linus Torvalds's avatar
Linus Torvalds committed
2736
	 */
2737 2738 2739
	switch (sdev->sdev_state) {
	case SDEV_BLOCK:
	case SDEV_TRANSPORT_OFFLINE:
2740
		sdev->sdev_state = new_state;
2741 2742
		break;
	case SDEV_CREATED_BLOCK:
2743 2744 2745 2746 2747
		if (new_state == SDEV_TRANSPORT_OFFLINE ||
		    new_state == SDEV_OFFLINE)
			sdev->sdev_state = new_state;
		else
			sdev->sdev_state = SDEV_CREATED;
2748 2749 2750 2751 2752
		break;
	case SDEV_CANCEL:
	case SDEV_OFFLINE:
		break;
	default:
2753
		return -EINVAL;
2754
	}
2755
	scsi_start_queue(sdev);
Linus Torvalds's avatar
Linus Torvalds committed
2756 2757 2758

	return 0;
}
2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777
EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait);

/**
 * scsi_internal_device_unblock - resume a device after a block request
 * @sdev:	device to resume
 * @new_state:	state to set the device to after unblocking
 *
 * Restart the device queue for a previously suspended SCSI device. May sleep.
 *
 * Returns zero if successful or a negative error code upon failure.
 *
 * Notes:
 * This routine transitions the device to the SDEV_RUNNING state or to one of
 * the offline states (which must be a legal transition) allowing the midlayer
 * to goose the queue for this device.
 */
static int scsi_internal_device_unblock(struct scsi_device *sdev,
					enum scsi_device_state new_state)
{
2778 2779 2780 2781 2782 2783 2784
	int ret;

	mutex_lock(&sdev->state_mutex);
	ret = scsi_internal_device_unblock_nowait(sdev, new_state);
	mutex_unlock(&sdev->state_mutex);

	return ret;
2785
}
Linus Torvalds's avatar
Linus Torvalds committed
2786 2787 2788 2789

static void
device_block(struct scsi_device *sdev, void *data)
{
2790 2791 2792 2793 2794 2795
	int ret;

	ret = scsi_internal_device_block(sdev);

	WARN_ONCE(ret, "scsi_internal_device_block(%s) failed: ret = %d\n",
		  dev_name(&sdev->sdev_gendev), ret);
Linus Torvalds's avatar
Linus Torvalds committed
2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820
}

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)
{
2821
	scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data);
Linus Torvalds's avatar
Linus Torvalds committed
2822 2823 2824 2825 2826 2827
}

static int
target_unblock(struct device *dev, void *data)
{
	if (scsi_is_target_device(dev))
2828
		starget_for_each_device(to_scsi_target(dev), data,
Linus Torvalds's avatar
Linus Torvalds committed
2829 2830 2831 2832 2833
					device_unblock);
	return 0;
}

void
2834
scsi_target_unblock(struct device *dev, enum scsi_device_state new_state)
Linus Torvalds's avatar
Linus Torvalds committed
2835 2836
{
	if (scsi_is_target_device(dev))
2837
		starget_for_each_device(to_scsi_target(dev), &new_state,
Linus Torvalds's avatar
Linus Torvalds committed
2838 2839
					device_unblock);
	else
2840
		device_for_each_child(dev, &new_state, target_unblock);
Linus Torvalds's avatar
Linus Torvalds committed
2841 2842
}
EXPORT_SYMBOL_GPL(scsi_target_unblock);
2843 2844 2845

/**
 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
2846
 * @sgl:	scatter-gather list
2847 2848 2849 2850 2851 2852
 * @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
 */
2853
void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
2854 2855 2856 2857
			  size_t *offset, size_t *len)
{
	int i;
	size_t sg_len = 0, len_complete = 0;
2858
	struct scatterlist *sg;
2859 2860
	struct page *page;

2861 2862
	WARN_ON(!irqs_disabled());

2863
	for_each_sg(sgl, sg, sg_count, i) {
2864
		len_complete = sg_len; /* Complete sg-entries */
2865
		sg_len += sg->length;
2866 2867 2868 2869 2870
		if (sg_len > *offset)
			break;
	}

	if (unlikely(i == sg_count)) {
2871 2872
		printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
			"elements %d\n",
2873
		       __func__, sg_len, *offset, sg_count);
2874 2875 2876 2877 2878
		WARN_ON(1);
		return NULL;
	}

	/* Offset starting from the beginning of first page in this sg-entry */
2879
	*offset = *offset - len_complete + sg->offset;
2880 2881

	/* Assumption: contiguous pages can be accessed as "page + i" */
2882
	page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
2883 2884 2885 2886 2887 2888 2889
	*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;

2890
	return kmap_atomic(page);
2891 2892 2893 2894
}
EXPORT_SYMBOL(scsi_kmap_atomic_sg);

/**
2895
 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
2896 2897 2898 2899
 * @virt:	virtual address to be unmapped
 */
void scsi_kunmap_atomic_sg(void *virt)
{
2900
	kunmap_atomic(virt);
2901 2902
}
EXPORT_SYMBOL(scsi_kunmap_atomic_sg);
2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916

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);
2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935

/**
 * scsi_vpd_lun_id - return a unique device identification
 * @sdev: SCSI device
 * @id:   buffer for the identification
 * @id_len:  length of the buffer
 *
 * Copies a unique device identification into @id based
 * on the information in the VPD page 0x83 of the device.
 * The string will be formatted as a SCSI name string.
 *
 * Returns the length of the identification or error on failure.
 * If the identifier is longer than the supplied buffer the actual
 * identifier length is returned and the buffer is not zero-padded.
 */
int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
{
	u8 cur_id_type = 0xff;
	u8 cur_id_size = 0;
2936 2937
	const unsigned char *d, *cur_id_str;
	const struct scsi_vpd *vpd_pg83;
2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955
	int id_size = -EINVAL;

	rcu_read_lock();
	vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
	if (!vpd_pg83) {
		rcu_read_unlock();
		return -ENXIO;
	}

	/*
	 * Look for the correct descriptor.
	 * Order of preference for lun descriptor:
	 * - SCSI name string
	 * - NAA IEEE Registered Extended
	 * - EUI-64 based 16-byte
	 * - EUI-64 based 12-byte
	 * - NAA IEEE Registered
	 * - NAA IEEE Extended
2956
	 * - T10 Vendor ID
2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967
	 * as longer descriptors reduce the likelyhood
	 * of identification clashes.
	 */

	/* The id string must be at least 20 bytes + terminating NULL byte */
	if (id_len < 21) {
		rcu_read_unlock();
		return -EINVAL;
	}

	memset(id, 0, id_len);
2968 2969
	d = vpd_pg83->data + 4;
	while (d < vpd_pg83->data + vpd_pg83->len) {
2970 2971 2972 2973 2974
		/* Skip designators not referring to the LUN */
		if ((d[1] & 0x30) != 0x00)
			goto next_desig;

		switch (d[1] & 0xf) {
2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989
		case 0x1:
			/* T10 Vendor ID */
			if (cur_id_size > d[3])
				break;
			/* Prefer anything */
			if (cur_id_type > 0x01 && cur_id_type != 0xff)
				break;
			cur_id_size = d[3];
			if (cur_id_size + 4 > id_len)
				cur_id_size = id_len - 4;
			cur_id_str = d + 4;
			cur_id_type = d[1] & 0xf;
			id_size = snprintf(id, id_len, "t10.%*pE",
					   cur_id_size, cur_id_str);
			break;
2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072
		case 0x2:
			/* EUI-64 */
			if (cur_id_size > d[3])
				break;
			/* Prefer NAA IEEE Registered Extended */
			if (cur_id_type == 0x3 &&
			    cur_id_size == d[3])
				break;
			cur_id_size = d[3];
			cur_id_str = d + 4;
			cur_id_type = d[1] & 0xf;
			switch (cur_id_size) {
			case 8:
				id_size = snprintf(id, id_len,
						   "eui.%8phN",
						   cur_id_str);
				break;
			case 12:
				id_size = snprintf(id, id_len,
						   "eui.%12phN",
						   cur_id_str);
				break;
			case 16:
				id_size = snprintf(id, id_len,
						   "eui.%16phN",
						   cur_id_str);
				break;
			default:
				cur_id_size = 0;
				break;
			}
			break;
		case 0x3:
			/* NAA */
			if (cur_id_size > d[3])
				break;
			cur_id_size = d[3];
			cur_id_str = d + 4;
			cur_id_type = d[1] & 0xf;
			switch (cur_id_size) {
			case 8:
				id_size = snprintf(id, id_len,
						   "naa.%8phN",
						   cur_id_str);
				break;
			case 16:
				id_size = snprintf(id, id_len,
						   "naa.%16phN",
						   cur_id_str);
				break;
			default:
				cur_id_size = 0;
				break;
			}
			break;
		case 0x8:
			/* SCSI name string */
			if (cur_id_size + 4 > d[3])
				break;
			/* Prefer others for truncated descriptor */
			if (cur_id_size && d[3] > id_len)
				break;
			cur_id_size = id_size = d[3];
			cur_id_str = d + 4;
			cur_id_type = d[1] & 0xf;
			if (cur_id_size >= id_len)
				cur_id_size = id_len - 1;
			memcpy(id, cur_id_str, cur_id_size);
			/* Decrease priority for truncated descriptor */
			if (cur_id_size != id_size)
				cur_id_size = 6;
			break;
		default:
			break;
		}
next_desig:
		d += d[3] + 4;
	}
	rcu_read_unlock();

	return id_size;
}
EXPORT_SYMBOL(scsi_vpd_lun_id);
3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084

/*
 * scsi_vpd_tpg_id - return a target port group identifier
 * @sdev: SCSI device
 *
 * Returns the Target Port Group identifier from the information
 * froom VPD page 0x83 of the device.
 *
 * Returns the identifier or error on failure.
 */
int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
{
3085 3086
	const unsigned char *d;
	const struct scsi_vpd *vpd_pg83;
3087 3088 3089 3090 3091 3092 3093 3094 3095
	int group_id = -EAGAIN, rel_port = -1;

	rcu_read_lock();
	vpd_pg83 = rcu_dereference(sdev->vpd_pg83);
	if (!vpd_pg83) {
		rcu_read_unlock();
		return -ENXIO;
	}

3096 3097
	d = vpd_pg83->data + 4;
	while (d < vpd_pg83->data + vpd_pg83->len) {
3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119
		switch (d[1] & 0xf) {
		case 0x4:
			/* Relative target port */
			rel_port = get_unaligned_be16(&d[6]);
			break;
		case 0x5:
			/* Target port group */
			group_id = get_unaligned_be16(&d[6]);
			break;
		default:
			break;
		}
		d += d[3] + 4;
	}
	rcu_read_unlock();

	if (group_id >= 0 && rel_id && rel_port != -1)
		*rel_id = rel_port;

	return group_id;
}
EXPORT_SYMBOL(scsi_vpd_tpg_id);