core.c 111.4 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
2 3 4 5 6 7 8
/*
 * NVM Express device driver
 * Copyright (c) 2011-2014, Intel Corporation.
 */

#include <linux/blkdev.h>
#include <linux/blk-mq.h>
9
#include <linux/compat.h>
10
#include <linux/delay.h>
11
#include <linux/errno.h>
12
#include <linux/hdreg.h>
13
#include <linux/kernel.h>
14
#include <linux/module.h>
15
#include <linux/backing-dev.h>
16
#include <linux/list_sort.h>
17 18
#include <linux/slab.h>
#include <linux/types.h>
19 20 21 22
#include <linux/pr.h>
#include <linux/ptrace.h>
#include <linux/nvme_ioctl.h>
#include <linux/t10-pi.h>
23
#include <linux/pm_qos.h>
24
#include <asm/unaligned.h>
25 26

#include "nvme.h"
S
Sagi Grimberg 已提交
27
#include "fabrics.h"
28

H
Hannes Reinecke 已提交
29 30 31
#define CREATE_TRACE_POINTS
#include "trace.h"

32 33
#define NVME_MINORS		(1U << MINORBITS)

34 35
unsigned int admin_timeout = 60;
module_param(admin_timeout, uint, 0644);
36
MODULE_PARM_DESC(admin_timeout, "timeout in seconds for admin commands");
37
EXPORT_SYMBOL_GPL(admin_timeout);
38

39 40
unsigned int nvme_io_timeout = 30;
module_param_named(io_timeout, nvme_io_timeout, uint, 0644);
41
MODULE_PARM_DESC(io_timeout, "timeout in seconds for I/O");
42
EXPORT_SYMBOL_GPL(nvme_io_timeout);
43

44
static unsigned char shutdown_timeout = 5;
45 46 47
module_param(shutdown_timeout, byte, 0644);
MODULE_PARM_DESC(shutdown_timeout, "timeout in seconds for controller shutdown");

48 49
static u8 nvme_max_retries = 5;
module_param_named(max_retries, nvme_max_retries, byte, 0644);
K
Keith Busch 已提交
50
MODULE_PARM_DESC(max_retries, "max number of retries a command may have");
51

52
static unsigned long default_ps_max_latency_us = 100000;
53 54 55 56
module_param(default_ps_max_latency_us, ulong, 0644);
MODULE_PARM_DESC(default_ps_max_latency_us,
		 "max power saving latency for new devices; use PM QOS to change per device");

57 58 59 60
static bool force_apst;
module_param(force_apst, bool, 0644);
MODULE_PARM_DESC(force_apst, "allow APST for newly enumerated devices even if quirked off");

61 62 63 64
static bool streams;
module_param(streams, bool, 0644);
MODULE_PARM_DESC(streams, "turn on support for Streams write directives");

65 66 67 68 69
/*
 * nvme_wq - hosts nvme related works that are not reset or delete
 * nvme_reset_wq - hosts nvme reset works
 * nvme_delete_wq - hosts nvme delete works
 *
70 71
 * nvme_wq will host works such as scan, aen handling, fw activation,
 * keep-alive, periodic reconnects etc. nvme_reset_wq
72 73 74 75
 * runs reset works which also flush works hosted on nvme_wq for
 * serialization purposes. nvme_delete_wq host controller deletion
 * works which flush reset works for serialization.
 */
76 77 78
struct workqueue_struct *nvme_wq;
EXPORT_SYMBOL_GPL(nvme_wq);

79 80 81 82 83 84
struct workqueue_struct *nvme_reset_wq;
EXPORT_SYMBOL_GPL(nvme_reset_wq);

struct workqueue_struct *nvme_delete_wq;
EXPORT_SYMBOL_GPL(nvme_delete_wq);

C
Christoph Hellwig 已提交
85 86
static LIST_HEAD(nvme_subsystems);
static DEFINE_MUTEX(nvme_subsystems_lock);
87

88
static DEFINE_IDA(nvme_instance_ida);
89
static dev_t nvme_chr_devt;
90
static struct class *nvme_class;
C
Christoph Hellwig 已提交
91
static struct class *nvme_subsys_class;
92

93
static int nvme_revalidate_disk(struct gendisk *disk);
94
static void nvme_put_subsystem(struct nvme_subsystem *subsys);
95 96 97 98 99 100 101 102 103 104 105 106 107 108
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					   unsigned nsid);

static void nvme_set_queue_dying(struct nvme_ns *ns)
{
	/*
	 * Revalidating a dead namespace sets capacity to 0. This will end
	 * buffered writers dirtying pages that can't be synced.
	 */
	if (!ns->disk || test_and_set_bit(NVME_NS_DEAD, &ns->flags))
		return;
	blk_set_queue_dying(ns->queue);
	/* Forcibly unquiesce queues to avoid blocking dispatch */
	blk_mq_unquiesce_queue(ns->queue);
109 110 111 112
	/*
	 * Revalidate after unblocking dispatchers that may be holding bd_butex
	 */
	revalidate_disk(ns->disk);
113
}
114

115 116 117 118 119
static void nvme_queue_scan(struct nvme_ctrl *ctrl)
{
	/*
	 * Only new queue scan work when admin and IO queues are both alive
	 */
K
Keith Busch 已提交
120
	if (ctrl->state == NVME_CTRL_LIVE && ctrl->tagset)
121 122 123
		queue_work(nvme_wq, &ctrl->scan_work);
}

124 125 126 127 128 129
/*
 * Use this function to proceed with scheduling reset_work for a controller
 * that had previously been set to the resetting state. This is intended for
 * code paths that can't be interrupted by other reset attempts. A hot removal
 * may prevent this from succeeding.
 */
130
int nvme_try_sched_reset(struct nvme_ctrl *ctrl)
131 132 133 134 135 136 137
{
	if (ctrl->state != NVME_CTRL_RESETTING)
		return -EBUSY;
	if (!queue_work(nvme_reset_wq, &ctrl->reset_work))
		return -EBUSY;
	return 0;
}
138
EXPORT_SYMBOL_GPL(nvme_try_sched_reset);
139

140 141 142 143
int nvme_reset_ctrl(struct nvme_ctrl *ctrl)
{
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
		return -EBUSY;
144
	if (!queue_work(nvme_reset_wq, &ctrl->reset_work))
145 146 147 148 149
		return -EBUSY;
	return 0;
}
EXPORT_SYMBOL_GPL(nvme_reset_ctrl);

S
Sagi Grimberg 已提交
150
int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl)
151 152 153 154
{
	int ret;

	ret = nvme_reset_ctrl(ctrl);
155
	if (!ret) {
156
		flush_work(&ctrl->reset_work);
K
Keith Busch 已提交
157
		if (ctrl->state != NVME_CTRL_LIVE)
158 159 160
			ret = -ENETRESET;
	}

161 162
	return ret;
}
S
Sagi Grimberg 已提交
163
EXPORT_SYMBOL_GPL(nvme_reset_ctrl_sync);
164

165
static void nvme_do_delete_ctrl(struct nvme_ctrl *ctrl)
166
{
167 168 169
	dev_info(ctrl->device,
		 "Removing ctrl: NQN \"%s\"\n", ctrl->opts->subsysnqn);

170
	flush_work(&ctrl->reset_work);
171 172
	nvme_stop_ctrl(ctrl);
	nvme_remove_namespaces(ctrl);
173
	ctrl->ops->delete_ctrl(ctrl);
174
	nvme_uninit_ctrl(ctrl);
175 176
}

177 178 179 180 181 182 183 184
static void nvme_delete_ctrl_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, delete_work);

	nvme_do_delete_ctrl(ctrl);
}

185 186 187 188
int nvme_delete_ctrl(struct nvme_ctrl *ctrl)
{
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
		return -EBUSY;
189
	if (!queue_work(nvme_delete_wq, &ctrl->delete_work))
190 191 192 193 194
		return -EBUSY;
	return 0;
}
EXPORT_SYMBOL_GPL(nvme_delete_ctrl);

195
static void nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl)
196 197
{
	/*
198 199
	 * Keep a reference until nvme_do_delete_ctrl() complete,
	 * since ->delete_ctrl can free the controller.
200 201
	 */
	nvme_get_ctrl(ctrl);
202
	if (nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
203
		nvme_do_delete_ctrl(ctrl);
204 205 206
	nvme_put_ctrl(ctrl);
}

207 208 209 210 211
static inline bool nvme_ns_has_pi(struct nvme_ns *ns)
{
	return ns->pi_type && ns->ms == sizeof(struct t10_pi_tuple);
}

212
static blk_status_t nvme_error_status(u16 status)
213
{
214
	switch (status & 0x7ff) {
215
	case NVME_SC_SUCCESS:
216
		return BLK_STS_OK;
217
	case NVME_SC_CAP_EXCEEDED:
218
		return BLK_STS_NOSPC;
219
	case NVME_SC_LBA_RANGE:
220 221
	case NVME_SC_CMD_INTERRUPTED:
	case NVME_SC_NS_NOT_READY:
222 223
		return BLK_STS_TARGET;
	case NVME_SC_BAD_ATTRIBUTES:
224
	case NVME_SC_ONCS_NOT_SUPPORTED:
225 226 227
	case NVME_SC_INVALID_OPCODE:
	case NVME_SC_INVALID_FIELD:
	case NVME_SC_INVALID_NS:
228
		return BLK_STS_NOTSUPP;
229 230 231
	case NVME_SC_WRITE_FAULT:
	case NVME_SC_READ_ERROR:
	case NVME_SC_UNWRITTEN_BLOCK:
232 233
	case NVME_SC_ACCESS_DENIED:
	case NVME_SC_READ_ONLY:
234
	case NVME_SC_COMPARE_FAILED:
235
		return BLK_STS_MEDIUM;
236 237 238 239 240 241 242
	case NVME_SC_GUARD_CHECK:
	case NVME_SC_APPTAG_CHECK:
	case NVME_SC_REFTAG_CHECK:
	case NVME_SC_INVALID_PI:
		return BLK_STS_PROTECTION;
	case NVME_SC_RESERVATION_CONFLICT:
		return BLK_STS_NEXUS;
243 244
	case NVME_SC_HOST_PATH_ERROR:
		return BLK_STS_TRANSPORT;
245 246
	default:
		return BLK_STS_IOERR;
247 248 249
	}
}

250
static inline bool nvme_req_needs_retry(struct request *req)
251
{
252 253
	if (blk_noretry_request(req))
		return false;
254
	if (nvme_req(req)->status & NVME_SC_DNR)
255
		return false;
256
	if (nvme_req(req)->retries >= nvme_max_retries)
257 258
		return false;
	return true;
259 260
}

261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
static void nvme_retry_req(struct request *req)
{
	struct nvme_ns *ns = req->q->queuedata;
	unsigned long delay = 0;
	u16 crd;

	/* The mask and shift result must be <= 3 */
	crd = (nvme_req(req)->status & NVME_SC_CRD) >> 11;
	if (ns && crd)
		delay = ns->ctrl->crdt[crd - 1] * 100;

	nvme_req(req)->retries++;
	blk_mq_requeue_request(req, false);
	blk_mq_delay_kick_requeue_list(req->q, delay);
}

277 278
void nvme_complete_rq(struct request *req)
{
279
	blk_status_t status = nvme_error_status(nvme_req(req)->status);
280

281 282
	trace_nvme_complete_rq(req);

283 284
	nvme_cleanup_cmd(req);

285 286 287
	if (nvme_req(req)->ctrl->kas)
		nvme_req(req)->ctrl->comp_seen = true;

288
	if (unlikely(status != BLK_STS_OK && nvme_req_needs_retry(req))) {
289
		if ((req->cmd_flags & REQ_NVME_MPATH) && nvme_failover_req(req))
290 291 292
			return;

		if (!blk_queue_dying(req->q)) {
293
			nvme_retry_req(req);
294 295
			return;
		}
296
	}
H
Hannes Reinecke 已提交
297 298

	nvme_trace_bio_complete(req, status);
299
	blk_mq_end_request(req, status);
300 301 302
}
EXPORT_SYMBOL_GPL(nvme_complete_rq);

303
bool nvme_cancel_request(struct request *req, void *data, bool reserved)
304 305 306 307
{
	dev_dbg_ratelimited(((struct nvme_ctrl *) data)->device,
				"Cancelling I/O %d", req->tag);

308 309 310 311
	/* don't abort one completed request */
	if (blk_mq_request_completed(req))
		return true;

312
	nvme_req(req)->status = NVME_SC_HOST_ABORTED_CMD;
313
	blk_mq_complete_request(req);
314
	return true;
315 316 317
}
EXPORT_SYMBOL_GPL(nvme_cancel_request);

318 319 320
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state)
{
321
	enum nvme_ctrl_state old_state;
322
	unsigned long flags;
323 324
	bool changed = false;

325
	spin_lock_irqsave(&ctrl->lock, flags);
326 327

	old_state = ctrl->state;
328 329 330
	switch (new_state) {
	case NVME_CTRL_LIVE:
		switch (old_state) {
331
		case NVME_CTRL_NEW:
332
		case NVME_CTRL_RESETTING:
333
		case NVME_CTRL_CONNECTING:
334 335 336 337 338 339 340 341 342
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
	case NVME_CTRL_RESETTING:
		switch (old_state) {
		case NVME_CTRL_NEW:
343 344 345 346 347 348 349
		case NVME_CTRL_LIVE:
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
350
	case NVME_CTRL_CONNECTING:
351
		switch (old_state) {
352
		case NVME_CTRL_NEW:
353
		case NVME_CTRL_RESETTING:
354 355 356 357 358 359 360 361 362 363
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
	case NVME_CTRL_DELETING:
		switch (old_state) {
		case NVME_CTRL_LIVE:
		case NVME_CTRL_RESETTING:
364
		case NVME_CTRL_CONNECTING:
365 366 367 368 369 370
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
371 372 373 374 375 376 377 378 379
	case NVME_CTRL_DEAD:
		switch (old_state) {
		case NVME_CTRL_DELETING:
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
380 381 382 383
	default:
		break;
	}

384
	if (changed) {
385
		ctrl->state = new_state;
386 387
		wake_up_all(&ctrl->state_wq);
	}
388

389
	spin_unlock_irqrestore(&ctrl->lock, flags);
390 391
	if (changed && ctrl->state == NVME_CTRL_LIVE)
		nvme_kick_requeue_lists(ctrl);
392 393 394 395
	return changed;
}
EXPORT_SYMBOL_GPL(nvme_change_ctrl_state);

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
/*
 * Returns true for sink states that can't ever transition back to live.
 */
static bool nvme_state_terminal(struct nvme_ctrl *ctrl)
{
	switch (ctrl->state) {
	case NVME_CTRL_NEW:
	case NVME_CTRL_LIVE:
	case NVME_CTRL_RESETTING:
	case NVME_CTRL_CONNECTING:
		return false;
	case NVME_CTRL_DELETING:
	case NVME_CTRL_DEAD:
		return true;
	default:
		WARN_ONCE(1, "Unhandled ctrl state:%d", ctrl->state);
		return true;
	}
}

/*
 * Waits for the controller state to be resetting, or returns false if it is
 * not possible to ever transition to that state.
 */
bool nvme_wait_reset(struct nvme_ctrl *ctrl)
{
	wait_event(ctrl->state_wq,
		   nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING) ||
		   nvme_state_terminal(ctrl));
	return ctrl->state == NVME_CTRL_RESETTING;
}
EXPORT_SYMBOL_GPL(nvme_wait_reset);

C
Christoph Hellwig 已提交
429 430 431 432 433
static void nvme_free_ns_head(struct kref *ref)
{
	struct nvme_ns_head *head =
		container_of(ref, struct nvme_ns_head, ref);

434
	nvme_mpath_remove_disk(head);
C
Christoph Hellwig 已提交
435
	ida_simple_remove(&head->subsys->ns_ida, head->instance);
436
	cleanup_srcu_struct(&head->srcu);
437
	nvme_put_subsystem(head->subsys);
C
Christoph Hellwig 已提交
438 439 440 441 442 443 444 445
	kfree(head);
}

static void nvme_put_ns_head(struct nvme_ns_head *head)
{
	kref_put(&head->ref, nvme_free_ns_head);
}

446 447 448 449
static void nvme_free_ns(struct kref *kref)
{
	struct nvme_ns *ns = container_of(kref, struct nvme_ns, kref);

450 451
	if (ns->ndev)
		nvme_nvm_unregister(ns);
452 453

	put_disk(ns->disk);
C
Christoph Hellwig 已提交
454
	nvme_put_ns_head(ns->head);
455
	nvme_put_ctrl(ns->ctrl);
456 457 458
	kfree(ns);
}

459
static void nvme_put_ns(struct nvme_ns *ns)
460 461 462 463
{
	kref_put(&ns->kref, nvme_free_ns);
}

464 465 466 467 468 469 470 471 472
static inline void nvme_clear_nvme_request(struct request *req)
{
	if (!(req->rq_flags & RQF_DONTPREP)) {
		nvme_req(req)->retries = 0;
		nvme_req(req)->flags = 0;
		req->rq_flags |= RQF_DONTPREP;
	}
}

473
struct request *nvme_alloc_request(struct request_queue *q,
474
		struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid)
475
{
476
	unsigned op = nvme_is_write(cmd) ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN;
477 478
	struct request *req;

479
	if (qid == NVME_QID_ANY) {
480
		req = blk_mq_alloc_request(q, op, flags);
481
	} else {
482
		req = blk_mq_alloc_request_hctx(q, op, flags,
483 484
				qid ? qid - 1 : 0);
	}
485
	if (IS_ERR(req))
486
		return req;
487 488

	req->cmd_flags |= REQ_FAILFAST_DRIVER;
489
	nvme_clear_nvme_request(req);
490
	nvme_req(req)->cmd = cmd;
491

492 493
	return req;
}
494
EXPORT_SYMBOL_GPL(nvme_alloc_request);
495

496 497 498 499 500 501 502
static int nvme_toggle_streams(struct nvme_ctrl *ctrl, bool enable)
{
	struct nvme_command c;

	memset(&c, 0, sizeof(c));

	c.directive.opcode = nvme_admin_directive_send;
A
Arnav Dawn 已提交
503
	c.directive.nsid = cpu_to_le32(NVME_NSID_ALL);
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
	c.directive.doper = NVME_DIR_SND_ID_OP_ENABLE;
	c.directive.dtype = NVME_DIR_IDENTIFY;
	c.directive.tdtype = NVME_DIR_STREAMS;
	c.directive.endir = enable ? NVME_DIR_ENDIR : 0;

	return nvme_submit_sync_cmd(ctrl->admin_q, &c, NULL, 0);
}

static int nvme_disable_streams(struct nvme_ctrl *ctrl)
{
	return nvme_toggle_streams(ctrl, false);
}

static int nvme_enable_streams(struct nvme_ctrl *ctrl)
{
	return nvme_toggle_streams(ctrl, true);
}

static int nvme_get_stream_params(struct nvme_ctrl *ctrl,
				  struct streams_directive_params *s, u32 nsid)
{
	struct nvme_command c;

	memset(&c, 0, sizeof(c));
	memset(s, 0, sizeof(*s));

	c.directive.opcode = nvme_admin_directive_recv;
	c.directive.nsid = cpu_to_le32(nsid);
K
Keith Busch 已提交
532
	c.directive.numd = cpu_to_le32(nvme_bytes_to_numd(sizeof(*s)));
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
	c.directive.doper = NVME_DIR_RCV_ST_OP_PARAM;
	c.directive.dtype = NVME_DIR_STREAMS;

	return nvme_submit_sync_cmd(ctrl->admin_q, &c, s, sizeof(*s));
}

static int nvme_configure_directives(struct nvme_ctrl *ctrl)
{
	struct streams_directive_params s;
	int ret;

	if (!(ctrl->oacs & NVME_CTRL_OACS_DIRECTIVES))
		return 0;
	if (!streams)
		return 0;

	ret = nvme_enable_streams(ctrl);
	if (ret)
		return ret;

A
Arnav Dawn 已提交
553
	ret = nvme_get_stream_params(ctrl, &s, NVME_NSID_ALL);
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
	if (ret)
		return ret;

	ctrl->nssa = le16_to_cpu(s.nssa);
	if (ctrl->nssa < BLK_MAX_WRITE_HINTS - 1) {
		dev_info(ctrl->device, "too few streams (%u) available\n",
					ctrl->nssa);
		nvme_disable_streams(ctrl);
		return 0;
	}

	ctrl->nr_streams = min_t(unsigned, ctrl->nssa, BLK_MAX_WRITE_HINTS - 1);
	dev_info(ctrl->device, "Using %u streams\n", ctrl->nr_streams);
	return 0;
}

/*
 * Check if 'req' has a write hint associated with it. If it does, assign
 * a valid namespace stream to the write.
 */
static void nvme_assign_write_stream(struct nvme_ctrl *ctrl,
				     struct request *req, u16 *control,
				     u32 *dsmgmt)
{
	enum rw_hint streamid = req->write_hint;

	if (streamid == WRITE_LIFE_NOT_SET || streamid == WRITE_LIFE_NONE)
		streamid = 0;
	else {
		streamid--;
		if (WARN_ON_ONCE(streamid > ctrl->nr_streams))
			return;

		*control |= NVME_RW_DTYPE_STREAMS;
		*dsmgmt |= streamid << 16;
	}

	if (streamid < ARRAY_SIZE(req->q->write_hints))
		req->q->write_hints[streamid] += blk_rq_bytes(req) >> 9;
}

M
Ming Lin 已提交
595 596 597 598
static inline void nvme_setup_flush(struct nvme_ns *ns,
		struct nvme_command *cmnd)
{
	cmnd->common.opcode = nvme_cmd_flush;
C
Christoph Hellwig 已提交
599
	cmnd->common.nsid = cpu_to_le32(ns->head->ns_id);
M
Ming Lin 已提交
600 601
}

602
static blk_status_t nvme_setup_discard(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
603 604
		struct nvme_command *cmnd)
{
605
	unsigned short segments = blk_rq_nr_discard_segments(req), n = 0;
M
Ming Lin 已提交
606
	struct nvme_dsm_range *range;
607
	struct bio *bio;
M
Ming Lin 已提交
608

609 610 611 612 613 614 615 616
	/*
	 * Some devices do not consider the DSM 'Number of Ranges' field when
	 * determining how much data to DMA. Always allocate memory for maximum
	 * number of segments to prevent device reading beyond end of buffer.
	 */
	static const size_t alloc_size = sizeof(*range) * NVME_DSM_MAX_RANGES;

	range = kzalloc(alloc_size, GFP_ATOMIC | __GFP_NOWARN);
617 618 619 620 621 622 623 624 625 626 627
	if (!range) {
		/*
		 * If we fail allocation our range, fallback to the controller
		 * discard page. If that's also busy, it's safe to return
		 * busy, as we know we can make progress once that's freed.
		 */
		if (test_and_set_bit_lock(0, &ns->ctrl->discard_page_busy))
			return BLK_STS_RESOURCE;

		range = page_address(ns->ctrl->discard_page);
	}
M
Ming Lin 已提交
628

629
	__rq_for_each_bio(bio, req) {
630
		u64 slba = nvme_sect_to_lba(ns, bio->bi_iter.bi_sector);
631 632
		u32 nlb = bio->bi_iter.bi_size >> ns->lba_shift;

K
Keith Busch 已提交
633 634 635 636 637
		if (n < segments) {
			range[n].cattr = cpu_to_le32(0);
			range[n].nlb = cpu_to_le32(nlb);
			range[n].slba = cpu_to_le64(slba);
		}
638 639 640 641
		n++;
	}

	if (WARN_ON_ONCE(n != segments)) {
642 643 644 645
		if (virt_to_page(range) == ns->ctrl->discard_page)
			clear_bit_unlock(0, &ns->ctrl->discard_page_busy);
		else
			kfree(range);
646
		return BLK_STS_IOERR;
647
	}
M
Ming Lin 已提交
648 649

	cmnd->dsm.opcode = nvme_cmd_dsm;
C
Christoph Hellwig 已提交
650
	cmnd->dsm.nsid = cpu_to_le32(ns->head->ns_id);
651
	cmnd->dsm.nr = cpu_to_le32(segments - 1);
M
Ming Lin 已提交
652 653
	cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);

654 655
	req->special_vec.bv_page = virt_to_page(range);
	req->special_vec.bv_offset = offset_in_page(range);
656
	req->special_vec.bv_len = alloc_size;
657
	req->rq_flags |= RQF_SPECIAL_PAYLOAD;
M
Ming Lin 已提交
658

659
	return BLK_STS_OK;
M
Ming Lin 已提交
660 661
}

662 663 664 665 666 667 668 669 670
static inline blk_status_t nvme_setup_write_zeroes(struct nvme_ns *ns,
		struct request *req, struct nvme_command *cmnd)
{
	if (ns->ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
		return nvme_setup_discard(ns, req, cmnd);

	cmnd->write_zeroes.opcode = nvme_cmd_write_zeroes;
	cmnd->write_zeroes.nsid = cpu_to_le32(ns->head->ns_id);
	cmnd->write_zeroes.slba =
671
		cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
672 673 674 675 676 677
	cmnd->write_zeroes.length =
		cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
	cmnd->write_zeroes.control = 0;
	return BLK_STS_OK;
}

678 679
static inline blk_status_t nvme_setup_rw(struct nvme_ns *ns,
		struct request *req, struct nvme_command *cmnd)
M
Ming Lin 已提交
680
{
681
	struct nvme_ctrl *ctrl = ns->ctrl;
M
Ming Lin 已提交
682 683 684 685 686 687 688 689 690 691 692 693
	u16 control = 0;
	u32 dsmgmt = 0;

	if (req->cmd_flags & REQ_FUA)
		control |= NVME_RW_FUA;
	if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD))
		control |= NVME_RW_LR;

	if (req->cmd_flags & REQ_RAHEAD)
		dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;

	cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
C
Christoph Hellwig 已提交
694
	cmnd->rw.nsid = cpu_to_le32(ns->head->ns_id);
695
	cmnd->rw.slba = cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
M
Ming Lin 已提交
696 697
	cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);

698 699 700
	if (req_op(req) == REQ_OP_WRITE && ctrl->nr_streams)
		nvme_assign_write_stream(ctrl, req, &control, &dsmgmt);

M
Ming Lin 已提交
701
	if (ns->ms) {
702 703 704 705 706 707 708 709 710 711 712 713
		/*
		 * If formated with metadata, the block layer always provides a
		 * metadata buffer if CONFIG_BLK_DEV_INTEGRITY is enabled.  Else
		 * we enable the PRACT bit for protection information or set the
		 * namespace capacity to zero to prevent any I/O.
		 */
		if (!blk_integrity_rq(req)) {
			if (WARN_ON_ONCE(!nvme_ns_has_pi(ns)))
				return BLK_STS_NOTSUPP;
			control |= NVME_RW_PRINFO_PRACT;
		}

M
Ming Lin 已提交
714 715 716 717 718 719 720 721
		switch (ns->pi_type) {
		case NVME_NS_DPS_PI_TYPE3:
			control |= NVME_RW_PRINFO_PRCHK_GUARD;
			break;
		case NVME_NS_DPS_PI_TYPE1:
		case NVME_NS_DPS_PI_TYPE2:
			control |= NVME_RW_PRINFO_PRCHK_GUARD |
					NVME_RW_PRINFO_PRCHK_REF;
722
			cmnd->rw.reftag = cpu_to_le32(t10_pi_ref_tag(req));
M
Ming Lin 已提交
723 724 725 726 727 728
			break;
		}
	}

	cmnd->rw.control = cpu_to_le16(control);
	cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
729
	return 0;
M
Ming Lin 已提交
730 731
}

732 733 734
void nvme_cleanup_cmd(struct request *req)
{
	if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
735 736 737 738 739 740 741
		struct nvme_ns *ns = req->rq_disk->private_data;
		struct page *page = req->special_vec.bv_page;

		if (page == ns->ctrl->discard_page)
			clear_bit_unlock(0, &ns->ctrl->discard_page_busy);
		else
			kfree(page_address(page) + req->special_vec.bv_offset);
742 743 744 745
	}
}
EXPORT_SYMBOL_GPL(nvme_cleanup_cmd);

746
blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
747 748
		struct nvme_command *cmd)
{
749
	blk_status_t ret = BLK_STS_OK;
M
Ming Lin 已提交
750

751
	nvme_clear_nvme_request(req);
752

753
	memset(cmd, 0, sizeof(*cmd));
754 755 756
	switch (req_op(req)) {
	case REQ_OP_DRV_IN:
	case REQ_OP_DRV_OUT:
757
		memcpy(cmd, nvme_req(req)->cmd, sizeof(*cmd));
758 759
		break;
	case REQ_OP_FLUSH:
M
Ming Lin 已提交
760
		nvme_setup_flush(ns, cmd);
761
		break;
762
	case REQ_OP_WRITE_ZEROES:
763 764
		ret = nvme_setup_write_zeroes(ns, req, cmd);
		break;
765
	case REQ_OP_DISCARD:
M
Ming Lin 已提交
766
		ret = nvme_setup_discard(ns, req, cmd);
767 768 769
		break;
	case REQ_OP_READ:
	case REQ_OP_WRITE:
770
		ret = nvme_setup_rw(ns, req, cmd);
771 772 773
		break;
	default:
		WARN_ON_ONCE(1);
774
		return BLK_STS_IOERR;
775
	}
M
Ming Lin 已提交
776

777
	cmd->common.command_id = req->tag;
K
Keith Busch 已提交
778
	trace_nvme_setup_cmd(req, cmd);
M
Ming Lin 已提交
779 780 781 782
	return ret;
}
EXPORT_SYMBOL_GPL(nvme_setup_cmd);

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
static void nvme_end_sync_rq(struct request *rq, blk_status_t error)
{
	struct completion *waiting = rq->end_io_data;

	rq->end_io_data = NULL;
	complete(waiting);
}

static void nvme_execute_rq_polled(struct request_queue *q,
		struct gendisk *bd_disk, struct request *rq, int at_head)
{
	DECLARE_COMPLETION_ONSTACK(wait);

	WARN_ON_ONCE(!test_bit(QUEUE_FLAG_POLL, &q->queue_flags));

	rq->cmd_flags |= REQ_HIPRI;
	rq->end_io_data = &wait;
	blk_execute_rq_nowait(q, bd_disk, rq, at_head, nvme_end_sync_rq);

	while (!completion_done(&wait)) {
		blk_poll(q, request_to_qc_t(rq->mq_hctx, rq), true);
		cond_resched();
	}
}

808 809 810 811 812
/*
 * Returns 0 on success.  If the result is negative, it's a Linux error code;
 * if the result is positive, it's an NVM Express status code
 */
int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
813
		union nvme_result *result, void *buffer, unsigned bufflen,
814
		unsigned timeout, int qid, int at_head,
815
		blk_mq_req_flags_t flags, bool poll)
816 817 818 819
{
	struct request *req;
	int ret;

820
	req = nvme_alloc_request(q, cmd, flags, qid);
821 822 823 824 825
	if (IS_ERR(req))
		return PTR_ERR(req);

	req->timeout = timeout ? timeout : ADMIN_TIMEOUT;

826 827 828 829
	if (buffer && bufflen) {
		ret = blk_rq_map_kern(q, req, buffer, bufflen, GFP_KERNEL);
		if (ret)
			goto out;
830 831
	}

832 833 834 835
	if (poll)
		nvme_execute_rq_polled(req->q, NULL, req, at_head);
	else
		blk_execute_rq(req->q, NULL, req, at_head);
836 837
	if (result)
		*result = nvme_req(req)->result;
838 839 840 841
	if (nvme_req(req)->flags & NVME_REQ_CANCELLED)
		ret = -EINTR;
	else
		ret = nvme_req(req)->status;
842 843 844 845
 out:
	blk_mq_free_request(req);
	return ret;
}
846
EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd);
847 848 849 850

int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
		void *buffer, unsigned bufflen)
{
851
	return __nvme_submit_sync_cmd(q, cmd, NULL, buffer, bufflen, 0,
852
			NVME_QID_ANY, 0, 0, false);
853
}
854
EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd);
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
static void *nvme_add_user_metadata(struct bio *bio, void __user *ubuf,
		unsigned len, u32 seed, bool write)
{
	struct bio_integrity_payload *bip;
	int ret = -ENOMEM;
	void *buf;

	buf = kmalloc(len, GFP_KERNEL);
	if (!buf)
		goto out;

	ret = -EFAULT;
	if (write && copy_from_user(buf, ubuf, len))
		goto out_free_meta;

	bip = bio_integrity_alloc(bio, GFP_KERNEL, 1);
	if (IS_ERR(bip)) {
		ret = PTR_ERR(bip);
		goto out_free_meta;
	}

	bip->bip_iter.bi_size = len;
	bip->bip_iter.bi_sector = seed;
	ret = bio_integrity_add_page(bio, virt_to_page(buf), len,
			offset_in_page(buf));
	if (ret == len)
		return buf;
	ret = -ENOMEM;
out_free_meta:
	kfree(buf);
out:
	return ERR_PTR(ret);
}

890
static int nvme_submit_user_cmd(struct request_queue *q,
891 892
		struct nvme_command *cmd, void __user *ubuffer,
		unsigned bufflen, void __user *meta_buffer, unsigned meta_len,
893
		u32 meta_seed, u64 *result, unsigned timeout)
894
{
895
	bool write = nvme_is_write(cmd);
896 897
	struct nvme_ns *ns = q->queuedata;
	struct gendisk *disk = ns ? ns->disk : NULL;
898
	struct request *req;
899 900
	struct bio *bio = NULL;
	void *meta = NULL;
901 902
	int ret;

903
	req = nvme_alloc_request(q, cmd, 0, NVME_QID_ANY);
904 905 906 907
	if (IS_ERR(req))
		return PTR_ERR(req);

	req->timeout = timeout ? timeout : ADMIN_TIMEOUT;
908
	nvme_req(req)->flags |= NVME_REQ_USERCMD;
909 910

	if (ubuffer && bufflen) {
911 912 913 914 915
		ret = blk_rq_map_user(q, req, NULL, ubuffer, bufflen,
				GFP_KERNEL);
		if (ret)
			goto out;
		bio = req->bio;
916
		bio->bi_disk = disk;
917 918 919 920 921
		if (disk && meta_buffer && meta_len) {
			meta = nvme_add_user_metadata(bio, meta_buffer, meta_len,
					meta_seed, write);
			if (IS_ERR(meta)) {
				ret = PTR_ERR(meta);
922 923
				goto out_unmap;
			}
924
			req->cmd_flags |= REQ_INTEGRITY;
925 926
		}
	}
927

928
	blk_execute_rq(req->q, disk, req, 0);
929 930 931 932
	if (nvme_req(req)->flags & NVME_REQ_CANCELLED)
		ret = -EINTR;
	else
		ret = nvme_req(req)->status;
933
	if (result)
934
		*result = le64_to_cpu(nvme_req(req)->result.u64);
935 936 937 938 939 940
	if (meta && !ret && !write) {
		if (copy_to_user(meta_buffer, meta, meta_len))
			ret = -EFAULT;
	}
	kfree(meta);
 out_unmap:
941
	if (bio)
942
		blk_rq_unmap_user(bio);
943 944 945 946 947
 out:
	blk_mq_free_request(req);
	return ret;
}

948
static void nvme_keep_alive_end_io(struct request *rq, blk_status_t status)
S
Sagi Grimberg 已提交
949 950
{
	struct nvme_ctrl *ctrl = rq->end_io_data;
951 952
	unsigned long flags;
	bool startka = false;
S
Sagi Grimberg 已提交
953 954 955

	blk_mq_free_request(rq);

956
	if (status) {
S
Sagi Grimberg 已提交
957
		dev_err(ctrl->device,
958 959
			"failed nvme_keep_alive_end_io error=%d\n",
				status);
S
Sagi Grimberg 已提交
960 961 962
		return;
	}

963
	ctrl->comp_seen = false;
964 965 966 967 968 969
	spin_lock_irqsave(&ctrl->lock, flags);
	if (ctrl->state == NVME_CTRL_LIVE ||
	    ctrl->state == NVME_CTRL_CONNECTING)
		startka = true;
	spin_unlock_irqrestore(&ctrl->lock, flags);
	if (startka)
970
		queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ);
S
Sagi Grimberg 已提交
971 972 973 974 975 976
}

static int nvme_keep_alive(struct nvme_ctrl *ctrl)
{
	struct request *rq;

977
	rq = nvme_alloc_request(ctrl->admin_q, &ctrl->ka_cmd, BLK_MQ_REQ_RESERVED,
S
Sagi Grimberg 已提交
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
			NVME_QID_ANY);
	if (IS_ERR(rq))
		return PTR_ERR(rq);

	rq->timeout = ctrl->kato * HZ;
	rq->end_io_data = ctrl;

	blk_execute_rq_nowait(rq->q, NULL, rq, 0, nvme_keep_alive_end_io);

	return 0;
}

static void nvme_keep_alive_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl = container_of(to_delayed_work(work),
			struct nvme_ctrl, ka_work);
994 995 996 997 998 999
	bool comp_seen = ctrl->comp_seen;

	if ((ctrl->ctratt & NVME_CTRL_ATTR_TBKAS) && comp_seen) {
		dev_dbg(ctrl->device,
			"reschedule traffic based keep-alive timer\n");
		ctrl->comp_seen = false;
1000
		queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ);
1001 1002
		return;
	}
S
Sagi Grimberg 已提交
1003 1004 1005 1006

	if (nvme_keep_alive(ctrl)) {
		/* allocation failure, reset the controller */
		dev_err(ctrl->device, "keep-alive failed\n");
1007
		nvme_reset_ctrl(ctrl);
S
Sagi Grimberg 已提交
1008 1009 1010 1011
		return;
	}
}

1012
static void nvme_start_keep_alive(struct nvme_ctrl *ctrl)
S
Sagi Grimberg 已提交
1013 1014 1015 1016
{
	if (unlikely(ctrl->kato == 0))
		return;

1017
	queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ);
S
Sagi Grimberg 已提交
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
}

void nvme_stop_keep_alive(struct nvme_ctrl *ctrl)
{
	if (unlikely(ctrl->kato == 0))
		return;

	cancel_delayed_work_sync(&ctrl->ka_work);
}
EXPORT_SYMBOL_GPL(nvme_stop_keep_alive);

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
/*
 * In NVMe 1.0 the CNS field was just a binary controller or namespace
 * flag, thus sending any new CNS opcodes has a big chance of not working.
 * Qemu unfortunately had that bug after reporting a 1.1 version compliance
 * (but not for any later version).
 */
static bool nvme_ctrl_limited_cns(struct nvme_ctrl *ctrl)
{
	if (ctrl->quirks & NVME_QUIRK_IDENTIFY_CNS)
		return ctrl->vs < NVME_VS(1, 2, 0);
	return ctrl->vs < NVME_VS(1, 1, 0);
}

K
Keith Busch 已提交
1042
static int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id)
1043 1044 1045 1046 1047 1048
{
	struct nvme_command c = { };
	int error;

	/* gcc-4.4.4 (at least) has issues with initializers and anon unions */
	c.identify.opcode = nvme_admin_identify;
1049
	c.identify.cns = NVME_ID_CNS_CTRL;
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061

	*id = kmalloc(sizeof(struct nvme_id_ctrl), GFP_KERNEL);
	if (!*id)
		return -ENOMEM;

	error = nvme_submit_sync_cmd(dev->admin_q, &c, *id,
			sizeof(struct nvme_id_ctrl));
	if (error)
		kfree(*id);
	return error;
}

1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
static int nvme_process_ns_desc(struct nvme_ctrl *ctrl, struct nvme_ns_ids *ids,
		struct nvme_ns_id_desc *cur)
{
	const char *warn_str = "ctrl returned bogus length:";
	void *data = cur;

	switch (cur->nidt) {
	case NVME_NIDT_EUI64:
		if (cur->nidl != NVME_NIDT_EUI64_LEN) {
			dev_warn(ctrl->device, "%s %d for NVME_NIDT_EUI64\n",
				 warn_str, cur->nidl);
			return -1;
		}
		memcpy(ids->eui64, data + sizeof(*cur), NVME_NIDT_EUI64_LEN);
		return NVME_NIDT_EUI64_LEN;
	case NVME_NIDT_NGUID:
		if (cur->nidl != NVME_NIDT_NGUID_LEN) {
			dev_warn(ctrl->device, "%s %d for NVME_NIDT_NGUID\n",
				 warn_str, cur->nidl);
			return -1;
		}
		memcpy(ids->nguid, data + sizeof(*cur), NVME_NIDT_NGUID_LEN);
		return NVME_NIDT_NGUID_LEN;
	case NVME_NIDT_UUID:
		if (cur->nidl != NVME_NIDT_UUID_LEN) {
			dev_warn(ctrl->device, "%s %d for NVME_NIDT_UUID\n",
				 warn_str, cur->nidl);
			return -1;
		}
		uuid_copy(&ids->uuid, data + sizeof(*cur));
		return NVME_NIDT_UUID_LEN;
	default:
		/* Skip unknown types */
		return cur->nidl;
	}
}

1099
static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl, unsigned nsid,
1100
		struct nvme_ns_ids *ids)
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
{
	struct nvme_command c = { };
	int status;
	void *data;
	int pos;
	int len;

	c.identify.opcode = nvme_admin_identify;
	c.identify.nsid = cpu_to_le32(nsid);
	c.identify.cns = NVME_ID_CNS_NS_DESC_LIST;

	data = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
	if (!data)
		return -ENOMEM;

1116
	status = nvme_submit_sync_cmd(ctrl->admin_q, &c, data,
1117
				      NVME_IDENTIFY_DATA_SIZE);
1118 1119 1120 1121 1122 1123 1124
	if (status) {
		dev_warn(ctrl->device,
			"Identify Descriptors failed (%d)\n", status);
		 /*
		  * Don't treat an error as fatal, as we potentially already
		  * have a NGUID or EUI-64.
		  */
1125
		if (status > 0 && !(status & NVME_SC_DNR))
1126
			status = 0;
1127
		goto free_data;
1128
	}
1129 1130 1131 1132 1133 1134 1135

	for (pos = 0; pos < NVME_IDENTIFY_DATA_SIZE; pos += len) {
		struct nvme_ns_id_desc *cur = data + pos;

		if (cur->nidl == 0)
			break;

1136 1137 1138
		len = nvme_process_ns_desc(ctrl, ids, cur);
		if (len < 0)
			goto free_data;
1139 1140 1141 1142 1143 1144 1145 1146

		len += sizeof(*cur);
	}
free_data:
	kfree(data);
	return status;
}

1147 1148 1149 1150 1151
static int nvme_identify_ns_list(struct nvme_ctrl *dev, unsigned nsid, __le32 *ns_list)
{
	struct nvme_command c = { };

	c.identify.opcode = nvme_admin_identify;
1152
	c.identify.cns = NVME_ID_CNS_NS_ACTIVE_LIST;
1153
	c.identify.nsid = cpu_to_le32(nsid);
1154 1155
	return nvme_submit_sync_cmd(dev->admin_q, &c, ns_list,
				    NVME_IDENTIFY_DATA_SIZE);
1156 1157
}

1158 1159
static int nvme_identify_ns(struct nvme_ctrl *ctrl,
		unsigned nsid, struct nvme_id_ns **id)
1160 1161 1162 1163 1164
{
	struct nvme_command c = { };
	int error;

	/* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1165 1166
	c.identify.opcode = nvme_admin_identify;
	c.identify.nsid = cpu_to_le32(nsid);
1167
	c.identify.cns = NVME_ID_CNS_NS;
1168

1169 1170 1171
	*id = kmalloc(sizeof(**id), GFP_KERNEL);
	if (!*id)
		return -ENOMEM;
1172

1173
	error = nvme_submit_sync_cmd(ctrl->admin_q, &c, *id, sizeof(**id));
1174
	if (error) {
1175
		dev_warn(ctrl->device, "Identify namespace failed (%d)\n", error);
1176
		kfree(*id);
1177 1178
	}

1179
	return error;
1180 1181
}

K
Keith Busch 已提交
1182 1183
static int nvme_features(struct nvme_ctrl *dev, u8 op, unsigned int fid,
		unsigned int dword11, void *buffer, size_t buflen, u32 *result)
1184
{
1185
	union nvme_result res = { 0 };
1186
	struct nvme_command c;
1187
	int ret;
1188 1189

	memset(&c, 0, sizeof(c));
K
Keith Busch 已提交
1190
	c.features.opcode = op;
1191 1192 1193
	c.features.fid = cpu_to_le32(fid);
	c.features.dword11 = cpu_to_le32(dword11);

1194
	ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &res,
1195
			buffer, buflen, 0, NVME_QID_ANY, 0, 0, false);
1196
	if (ret >= 0 && result)
1197
		*result = le32_to_cpu(res.u32);
1198
	return ret;
1199 1200
}

K
Keith Busch 已提交
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid,
		      unsigned int dword11, void *buffer, size_t buflen,
		      u32 *result)
{
	return nvme_features(dev, nvme_admin_set_features, fid, dword11, buffer,
			     buflen, result);
}
EXPORT_SYMBOL_GPL(nvme_set_features);

int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid,
		      unsigned int dword11, void *buffer, size_t buflen,
		      u32 *result)
{
	return nvme_features(dev, nvme_admin_get_features, fid, dword11, buffer,
			     buflen, result);
}
EXPORT_SYMBOL_GPL(nvme_get_features);

C
Christoph Hellwig 已提交
1219 1220 1221 1222 1223 1224
int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count)
{
	u32 q_count = (*count - 1) | ((*count - 1) << 16);
	u32 result;
	int status, nr_io_queues;

1225
	status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, NULL, 0,
C
Christoph Hellwig 已提交
1226
			&result);
1227
	if (status < 0)
C
Christoph Hellwig 已提交
1228 1229
		return status;

1230 1231 1232 1233 1234 1235
	/*
	 * Degraded controllers might return an error when setting the queue
	 * count.  We still want to be able to bring them online and offer
	 * access to the admin queue, as that might be only way to fix them up.
	 */
	if (status > 0) {
1236
		dev_err(ctrl->device, "Could not set queue count (%d)\n", status);
1237 1238 1239 1240 1241 1242
		*count = 0;
	} else {
		nr_io_queues = min(result & 0xffff, result >> 16) + 1;
		*count = min(*count, nr_io_queues);
	}

C
Christoph Hellwig 已提交
1243 1244
	return 0;
}
1245
EXPORT_SYMBOL_GPL(nvme_set_queue_count);
C
Christoph Hellwig 已提交
1246

1247
#define NVME_AEN_SUPPORTED \
1248 1249
	(NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_FW_ACT | \
	 NVME_AEN_CFG_ANA_CHANGE | NVME_AEN_CFG_DISC_CHANGE)
1250 1251 1252

static void nvme_enable_aen(struct nvme_ctrl *ctrl)
{
1253
	u32 result, supported_aens = ctrl->oaes & NVME_AEN_SUPPORTED;
1254 1255
	int status;

1256 1257 1258 1259 1260
	if (!supported_aens)
		return;

	status = nvme_set_features(ctrl, NVME_FEAT_ASYNC_EVENT, supported_aens,
			NULL, 0, &result);
1261 1262
	if (status)
		dev_warn(ctrl->device, "Failed to configure AEN (cfg %x)\n",
1263
			 supported_aens);
1264 1265

	queue_work(nvme_wq, &ctrl->async_event_work);
1266 1267
}

1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
/*
 * Convert integer values from ioctl structures to user pointers, silently
 * ignoring the upper bits in the compat case to match behaviour of 32-bit
 * kernels.
 */
static void __user *nvme_to_user_ptr(uintptr_t ptrval)
{
	if (in_compat_syscall())
		ptrval = (compat_uptr_t)ptrval;
	return (void __user *)ptrval;
}

1280 1281 1282 1283 1284 1285 1286 1287 1288
static int nvme_submit_io(struct nvme_ns *ns, struct nvme_user_io __user *uio)
{
	struct nvme_user_io io;
	struct nvme_command c;
	unsigned length, meta_len;
	void __user *metadata;

	if (copy_from_user(&io, uio, sizeof(io)))
		return -EFAULT;
1289 1290
	if (io.flags)
		return -EINVAL;
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302

	switch (io.opcode) {
	case nvme_cmd_write:
	case nvme_cmd_read:
	case nvme_cmd_compare:
		break;
	default:
		return -EINVAL;
	}

	length = (io.nblocks + 1) << ns->lba_shift;
	meta_len = (io.nblocks + 1) * ns->ms;
1303
	metadata = nvme_to_user_ptr(io.metadata);
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315

	if (ns->ext) {
		length += meta_len;
		meta_len = 0;
	} else if (meta_len) {
		if ((io.metadata & 3) || !io.metadata)
			return -EINVAL;
	}

	memset(&c, 0, sizeof(c));
	c.rw.opcode = io.opcode;
	c.rw.flags = io.flags;
C
Christoph Hellwig 已提交
1316
	c.rw.nsid = cpu_to_le32(ns->head->ns_id);
1317 1318 1319 1320 1321 1322 1323 1324
	c.rw.slba = cpu_to_le64(io.slba);
	c.rw.length = cpu_to_le16(io.nblocks);
	c.rw.control = cpu_to_le16(io.control);
	c.rw.dsmgmt = cpu_to_le32(io.dsmgmt);
	c.rw.reftag = cpu_to_le32(io.reftag);
	c.rw.apptag = cpu_to_le16(io.apptag);
	c.rw.appmask = cpu_to_le16(io.appmask);

1325
	return nvme_submit_user_cmd(ns->queue, &c,
1326
			nvme_to_user_ptr(io.addr), length,
1327
			metadata, meta_len, lower_32_bits(io.slba), NULL, 0);
1328 1329
}

1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
static u32 nvme_known_admin_effects(u8 opcode)
{
	switch (opcode) {
	case nvme_admin_format_nvm:
		return NVME_CMD_EFFECTS_CSUPP | NVME_CMD_EFFECTS_LBCC |
					NVME_CMD_EFFECTS_CSE_MASK;
	case nvme_admin_sanitize_nvm:
		return NVME_CMD_EFFECTS_CSE_MASK;
	default:
		break;
	}
	return 0;
}

static u32 nvme_passthru_start(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
								u8 opcode)
{
	u32 effects = 0;

	if (ns) {
		if (ctrl->effects)
			effects = le32_to_cpu(ctrl->effects->iocs[opcode]);
1352
		if (effects & ~(NVME_CMD_EFFECTS_CSUPP | NVME_CMD_EFFECTS_LBCC))
1353 1354 1355 1356 1357 1358 1359
			dev_warn(ctrl->device,
				 "IO command:%02x has unhandled effects:%08x\n",
				 opcode, effects);
		return 0;
	}

	if (ctrl->effects)
1360
		effects = le32_to_cpu(ctrl->effects->acs[opcode]);
K
Keith Busch 已提交
1361
	effects |= nvme_known_admin_effects(opcode);
1362 1363 1364 1365 1366 1367

	/*
	 * For simplicity, IO to all namespaces is quiesced even if the command
	 * effects say only one namespace is affected.
	 */
	if (effects & (NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_CSE_MASK)) {
1368
		mutex_lock(&ctrl->scan_lock);
1369 1370 1371
		mutex_lock(&ctrl->subsys->lock);
		nvme_mpath_start_freeze(ctrl->subsys);
		nvme_mpath_wait_freeze(ctrl->subsys);
1372 1373 1374 1375 1376 1377 1378 1379
		nvme_start_freeze(ctrl);
		nvme_wait_freeze(ctrl);
	}
	return effects;
}

static void nvme_update_formats(struct nvme_ctrl *ctrl)
{
1380
	struct nvme_ns *ns;
1381

1382 1383 1384 1385 1386
	down_read(&ctrl->namespaces_rwsem);
	list_for_each_entry(ns, &ctrl->namespaces, list)
		if (ns->disk && nvme_revalidate_disk(ns->disk))
			nvme_set_queue_dying(ns);
	up_read(&ctrl->namespaces_rwsem);
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
}

static void nvme_passthru_end(struct nvme_ctrl *ctrl, u32 effects)
{
	/*
	 * Revalidate LBA changes prior to unfreezing. This is necessary to
	 * prevent memory corruption if a logical block size was changed by
	 * this command.
	 */
	if (effects & NVME_CMD_EFFECTS_LBCC)
		nvme_update_formats(ctrl);
1398
	if (effects & (NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_CSE_MASK)) {
1399
		nvme_unfreeze(ctrl);
1400 1401
		nvme_mpath_unfreeze(ctrl->subsys);
		mutex_unlock(&ctrl->subsys->lock);
1402
		nvme_remove_invalid_namespaces(ctrl, NVME_NSID_ALL);
1403 1404
		mutex_unlock(&ctrl->scan_lock);
	}
1405 1406 1407 1408 1409 1410
	if (effects & NVME_CMD_EFFECTS_CCC)
		nvme_init_identify(ctrl);
	if (effects & (NVME_CMD_EFFECTS_NIC | NVME_CMD_EFFECTS_NCC))
		nvme_queue_scan(ctrl);
}

1411
static int nvme_user_cmd(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
1412 1413 1414 1415 1416
			struct nvme_passthru_cmd __user *ucmd)
{
	struct nvme_passthru_cmd cmd;
	struct nvme_command c;
	unsigned timeout = 0;
1417
	u32 effects;
1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
	u64 result;
	int status;

	if (!capable(CAP_SYS_ADMIN))
		return -EACCES;
	if (copy_from_user(&cmd, ucmd, sizeof(cmd)))
		return -EFAULT;
	if (cmd.flags)
		return -EINVAL;

	memset(&c, 0, sizeof(c));
	c.common.opcode = cmd.opcode;
	c.common.flags = cmd.flags;
	c.common.nsid = cpu_to_le32(cmd.nsid);
	c.common.cdw2[0] = cpu_to_le32(cmd.cdw2);
	c.common.cdw2[1] = cpu_to_le32(cmd.cdw3);
	c.common.cdw10 = cpu_to_le32(cmd.cdw10);
	c.common.cdw11 = cpu_to_le32(cmd.cdw11);
	c.common.cdw12 = cpu_to_le32(cmd.cdw12);
	c.common.cdw13 = cpu_to_le32(cmd.cdw13);
	c.common.cdw14 = cpu_to_le32(cmd.cdw14);
	c.common.cdw15 = cpu_to_le32(cmd.cdw15);

	if (cmd.timeout_ms)
		timeout = msecs_to_jiffies(cmd.timeout_ms);

	effects = nvme_passthru_start(ctrl, ns, cmd.opcode);
	status = nvme_submit_user_cmd(ns ? ns->queue : ctrl->admin_q, &c,
1446 1447 1448
			nvme_to_user_ptr(cmd.addr), cmd.data_len,
			nvme_to_user_ptr(cmd.metadata), cmd.metadata_len,
			0, &result, timeout);
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
	nvme_passthru_end(ctrl, effects);

	if (status >= 0) {
		if (put_user(result, &ucmd->result))
			return -EFAULT;
	}

	return status;
}

static int nvme_user_cmd64(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
			struct nvme_passthru_cmd64 __user *ucmd)
{
	struct nvme_passthru_cmd64 cmd;
	struct nvme_command c;
	unsigned timeout = 0;
	u32 effects;
1466 1467 1468 1469 1470 1471
	int status;

	if (!capable(CAP_SYS_ADMIN))
		return -EACCES;
	if (copy_from_user(&cmd, ucmd, sizeof(cmd)))
		return -EFAULT;
1472 1473
	if (cmd.flags)
		return -EINVAL;
1474 1475 1476 1477 1478 1479 1480

	memset(&c, 0, sizeof(c));
	c.common.opcode = cmd.opcode;
	c.common.flags = cmd.flags;
	c.common.nsid = cpu_to_le32(cmd.nsid);
	c.common.cdw2[0] = cpu_to_le32(cmd.cdw2);
	c.common.cdw2[1] = cpu_to_le32(cmd.cdw3);
1481 1482 1483 1484 1485 1486
	c.common.cdw10 = cpu_to_le32(cmd.cdw10);
	c.common.cdw11 = cpu_to_le32(cmd.cdw11);
	c.common.cdw12 = cpu_to_le32(cmd.cdw12);
	c.common.cdw13 = cpu_to_le32(cmd.cdw13);
	c.common.cdw14 = cpu_to_le32(cmd.cdw14);
	c.common.cdw15 = cpu_to_le32(cmd.cdw15);
1487 1488 1489 1490

	if (cmd.timeout_ms)
		timeout = msecs_to_jiffies(cmd.timeout_ms);

1491
	effects = nvme_passthru_start(ctrl, ns, cmd.opcode);
1492
	status = nvme_submit_user_cmd(ns ? ns->queue : ctrl->admin_q, &c,
1493 1494
			nvme_to_user_ptr(cmd.addr), cmd.data_len,
			nvme_to_user_ptr(cmd.metadata), cmd.metadata_len,
1495
			0, &cmd.result, timeout);
1496 1497
	nvme_passthru_end(ctrl, effects);

1498 1499 1500 1501 1502 1503 1504 1505
	if (status >= 0) {
		if (put_user(cmd.result, &ucmd->result))
			return -EFAULT;
	}

	return status;
}

1506 1507 1508 1509 1510 1511
/*
 * Issue ioctl requests on the first available path.  Note that unlike normal
 * block layer requests we will not retry failed request on another controller.
 */
static struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk,
		struct nvme_ns_head **head, int *srcu_idx)
1512
{
1513 1514
#ifdef CONFIG_NVME_MULTIPATH
	if (disk->fops == &nvme_ns_head_ops) {
1515 1516
		struct nvme_ns *ns;

1517 1518
		*head = disk->private_data;
		*srcu_idx = srcu_read_lock(&(*head)->srcu);
1519 1520 1521 1522
		ns = nvme_find_path(*head);
		if (!ns)
			srcu_read_unlock(&(*head)->srcu, *srcu_idx);
		return ns;
1523 1524 1525 1526 1527 1528
	}
#endif
	*head = NULL;
	*srcu_idx = -1;
	return disk->private_data;
}
1529

1530 1531 1532 1533 1534
static void nvme_put_ns_from_disk(struct nvme_ns_head *head, int idx)
{
	if (head)
		srcu_read_unlock(&head->srcu, idx);
}
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
static bool is_ctrl_ioctl(unsigned int cmd)
{
	if (cmd == NVME_IOCTL_ADMIN_CMD || cmd == NVME_IOCTL_ADMIN64_CMD)
		return true;
	if (is_sed_ioctl(cmd))
		return true;
	return false;
}

static int nvme_handle_ctrl_ioctl(struct nvme_ns *ns, unsigned int cmd,
				  void __user *argp,
				  struct nvme_ns_head *head,
				  int srcu_idx)
{
	struct nvme_ctrl *ctrl = ns->ctrl;
	int ret;

	nvme_get_ctrl(ns->ctrl);
	nvme_put_ns_from_disk(head, srcu_idx);

	switch (cmd) {
	case NVME_IOCTL_ADMIN_CMD:
		ret = nvme_user_cmd(ctrl, NULL, argp);
		break;
	case NVME_IOCTL_ADMIN64_CMD:
		ret = nvme_user_cmd64(ctrl, NULL, argp);
		break;
	default:
		ret = sed_ioctl(ctrl->opal_dev, cmd, argp);
		break;
	}
	nvme_put_ctrl(ctrl);
	return ret;
}

1571 1572
static int nvme_ioctl(struct block_device *bdev, fmode_t mode,
		unsigned int cmd, unsigned long arg)
1573
{
1574
	struct nvme_ns_head *head = NULL;
1575
	void __user *argp = (void __user *)arg;
1576 1577 1578 1579 1580
	struct nvme_ns *ns;
	int srcu_idx, ret;

	ns = nvme_get_ns_from_disk(bdev->bd_disk, &head, &srcu_idx);
	if (unlikely(!ns))
1581 1582
		return -EWOULDBLOCK;

1583 1584 1585 1586 1587
	/*
	 * Handle ioctls that apply to the controller instead of the namespace
	 * seperately and drop the ns SRCU reference early.  This avoids a
	 * deadlock when deleting namespaces using the passthrough interface.
	 */
1588 1589
	if (is_ctrl_ioctl(cmd))
		return nvme_handle_ctrl_ioctl(ns, cmd, argp, head, srcu_idx);
1590

1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601
	switch (cmd) {
	case NVME_IOCTL_ID:
		force_successful_syscall_return();
		ret = ns->head->ns_id;
		break;
	case NVME_IOCTL_IO_CMD:
		ret = nvme_user_cmd(ns->ctrl, ns, argp);
		break;
	case NVME_IOCTL_SUBMIT_IO:
		ret = nvme_submit_io(ns, argp);
		break;
1602 1603 1604
	case NVME_IOCTL_IO64_CMD:
		ret = nvme_user_cmd64(ns->ctrl, ns, argp);
		break;
1605 1606 1607 1608 1609 1610 1611
	default:
		if (ns->ndev)
			ret = nvme_nvm_ioctl(ns, cmd, arg);
		else
			ret = -ENOTTY;
	}

1612 1613
	nvme_put_ns_from_disk(head, srcu_idx);
	return ret;
1614 1615
}

1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656
#ifdef CONFIG_COMPAT
struct nvme_user_io32 {
	__u8	opcode;
	__u8	flags;
	__u16	control;
	__u16	nblocks;
	__u16	rsvd;
	__u64	metadata;
	__u64	addr;
	__u64	slba;
	__u32	dsmgmt;
	__u32	reftag;
	__u16	apptag;
	__u16	appmask;
} __attribute__((__packed__));

#define NVME_IOCTL_SUBMIT_IO32	_IOW('N', 0x42, struct nvme_user_io32)

static int nvme_compat_ioctl(struct block_device *bdev, fmode_t mode,
		unsigned int cmd, unsigned long arg)
{
	/*
	 * Corresponds to the difference of NVME_IOCTL_SUBMIT_IO
	 * between 32 bit programs and 64 bit kernel.
	 * The cause is that the results of sizeof(struct nvme_user_io),
	 * which is used to define NVME_IOCTL_SUBMIT_IO,
	 * are not same between 32 bit compiler and 64 bit compiler.
	 * NVME_IOCTL_SUBMIT_IO32 is for 64 bit kernel handling
	 * NVME_IOCTL_SUBMIT_IO issued from 32 bit programs.
	 * Other IOCTL numbers are same between 32 bit and 64 bit.
	 * So there is nothing to do regarding to other IOCTL numbers.
	 */
	if (cmd == NVME_IOCTL_SUBMIT_IO32)
		return nvme_ioctl(bdev, mode, NVME_IOCTL_SUBMIT_IO, arg);

	return nvme_ioctl(bdev, mode, cmd, arg);
}
#else
#define nvme_compat_ioctl	NULL
#endif /* CONFIG_COMPAT */

1657 1658
static int nvme_open(struct block_device *bdev, fmode_t mode)
{
C
Christoph Hellwig 已提交
1659 1660
	struct nvme_ns *ns = bdev->bd_disk->private_data;

1661 1662 1663
#ifdef CONFIG_NVME_MULTIPATH
	/* should never be called due to GENHD_FL_HIDDEN */
	if (WARN_ON_ONCE(ns->head->disk))
1664
		goto fail;
1665
#endif
C
Christoph Hellwig 已提交
1666
	if (!kref_get_unless_zero(&ns->kref))
1667 1668 1669 1670
		goto fail;
	if (!try_module_get(ns->ctrl->ops->module))
		goto fail_put_ns;

C
Christoph Hellwig 已提交
1671
	return 0;
1672 1673 1674 1675 1676

fail_put_ns:
	nvme_put_ns(ns);
fail:
	return -ENXIO;
1677 1678 1679 1680
}

static void nvme_release(struct gendisk *disk, fmode_t mode)
{
1681 1682 1683 1684
	struct nvme_ns *ns = disk->private_data;

	module_put(ns->ctrl->ops->module);
	nvme_put_ns(ns);
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
}

static int nvme_getgeo(struct block_device *bdev, struct hd_geometry *geo)
{
	/* some standard values */
	geo->heads = 1 << 6;
	geo->sectors = 1 << 5;
	geo->cylinders = get_capacity(bdev->bd_disk) >> 11;
	return 0;
}

#ifdef CONFIG_BLK_DEV_INTEGRITY
1697
static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type)
1698 1699 1700
{
	struct blk_integrity integrity;

1701
	memset(&integrity, 0, sizeof(integrity));
1702
	switch (pi_type) {
1703 1704
	case NVME_NS_DPS_PI_TYPE3:
		integrity.profile = &t10_pi_type3_crc;
1705 1706
		integrity.tag_size = sizeof(u16) + sizeof(u32);
		integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1707 1708 1709 1710
		break;
	case NVME_NS_DPS_PI_TYPE1:
	case NVME_NS_DPS_PI_TYPE2:
		integrity.profile = &t10_pi_type1_crc;
1711 1712
		integrity.tag_size = sizeof(u16);
		integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1713 1714 1715 1716 1717
		break;
	default:
		integrity.profile = NULL;
		break;
	}
1718 1719 1720
	integrity.tuple_size = ms;
	blk_integrity_register(disk, &integrity);
	blk_queue_max_integrity_segments(disk->queue, 1);
1721 1722
}
#else
1723
static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type)
1724 1725 1726 1727
{
}
#endif /* CONFIG_BLK_DEV_INTEGRITY */

1728 1729
static void nvme_set_chunk_size(struct nvme_ns *ns)
{
1730
	u32 chunk_size = nvme_lba_to_sect(ns, ns->noiob);
1731 1732 1733
	blk_queue_chunk_sectors(ns->queue, rounddown_pow_of_two(chunk_size));
}

1734
static void nvme_config_discard(struct gendisk *disk, struct nvme_ns *ns)
1735
{
1736
	struct nvme_ctrl *ctrl = ns->ctrl;
1737
	struct request_queue *queue = disk->queue;
1738 1739
	u32 size = queue_logical_block_size(queue);

1740 1741 1742 1743 1744 1745 1746
	if (!(ctrl->oncs & NVME_CTRL_ONCS_DSM)) {
		blk_queue_flag_clear(QUEUE_FLAG_DISCARD, queue);
		return;
	}

	if (ctrl->nr_streams && ns->sws && ns->sgs)
		size *= ns->sws * ns->sgs;
1747

1748 1749 1750
	BUILD_BUG_ON(PAGE_SIZE / sizeof(struct nvme_dsm_range) <
			NVME_DSM_MAX_RANGES);

1751
	queue->limits.discard_alignment = 0;
1752
	queue->limits.discard_granularity = size;
1753

1754 1755 1756 1757
	/* If discard is already enabled, don't reset queue limits */
	if (blk_queue_flag_test_and_set(QUEUE_FLAG_DISCARD, queue))
		return;

1758 1759
	blk_queue_max_discard_sectors(queue, UINT_MAX);
	blk_queue_max_discard_segments(queue, NVME_DSM_MAX_RANGES);
1760 1761

	if (ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
1762
		blk_queue_max_write_zeroes_sectors(queue, UINT_MAX);
1763 1764
}

1765
static void nvme_config_write_zeroes(struct gendisk *disk, struct nvme_ns *ns)
1766
{
1767
	u64 max_blocks;
1768

1769 1770
	if (!(ns->ctrl->oncs & NVME_CTRL_ONCS_WRITE_ZEROES) ||
	    (ns->ctrl->quirks & NVME_QUIRK_DISABLE_WRITE_ZEROES))
1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782
		return;
	/*
	 * Even though NVMe spec explicitly states that MDTS is not
	 * applicable to the write-zeroes:- "The restriction does not apply to
	 * commands that do not transfer data between the host and the
	 * controller (e.g., Write Uncorrectable ro Write Zeroes command).".
	 * In order to be more cautious use controller's max_hw_sectors value
	 * to configure the maximum sectors for the write-zeroes which is
	 * configured based on the controller's MDTS field in the
	 * nvme_init_identify() if available.
	 */
	if (ns->ctrl->max_hw_sectors == UINT_MAX)
1783
		max_blocks = (u64)USHRT_MAX + 1;
1784
	else
1785
		max_blocks = ns->ctrl->max_hw_sectors + 1;
1786

1787 1788
	blk_queue_max_write_zeroes_sectors(disk->queue,
					   nvme_lba_to_sect(ns, max_blocks));
1789 1790
}

1791
static int nvme_report_ns_ids(struct nvme_ctrl *ctrl, unsigned int nsid,
1792
		struct nvme_id_ns *id, struct nvme_ns_ids *ids)
1793
{
1794 1795
	memset(ids, 0, sizeof(*ids));

1796
	if (ctrl->vs >= NVME_VS(1, 1, 0))
1797
		memcpy(ids->eui64, id->eui64, sizeof(id->eui64));
1798
	if (ctrl->vs >= NVME_VS(1, 2, 0))
1799
		memcpy(ids->nguid, id->nguid, sizeof(id->nguid));
1800 1801 1802
	if (ctrl->vs >= NVME_VS(1, 3, 0))
		return nvme_identify_ns_descs(ctrl, nsid, ids);
	return 0;
1803 1804
}

C
Christoph Hellwig 已提交
1805 1806 1807 1808 1809 1810 1811
static bool nvme_ns_ids_valid(struct nvme_ns_ids *ids)
{
	return !uuid_is_null(&ids->uuid) ||
		memchr_inv(ids->nguid, 0, sizeof(ids->nguid)) ||
		memchr_inv(ids->eui64, 0, sizeof(ids->eui64));
}

1812 1813 1814 1815 1816 1817 1818
static bool nvme_ns_ids_equal(struct nvme_ns_ids *a, struct nvme_ns_ids *b)
{
	return uuid_equal(&a->uuid, &b->uuid) &&
		memcmp(&a->nguid, &b->nguid, sizeof(a->nguid)) == 0 &&
		memcmp(&a->eui64, &b->eui64, sizeof(a->eui64)) == 0;
}

1819 1820 1821
static void nvme_update_disk_info(struct gendisk *disk,
		struct nvme_ns *ns, struct nvme_id_ns *id)
{
1822
	sector_t capacity = nvme_lba_to_sect(ns, le64_to_cpu(id->nsze));
1823
	unsigned short bs = 1 << ns->lba_shift;
1824
	u32 atomic_bs, phys_bs, io_opt;
1825

1826 1827 1828 1829
	if (ns->lba_shift > PAGE_SHIFT) {
		/* unsupported block size, set capacity to 0 later */
		bs = (1 << 9);
	}
1830 1831 1832
	blk_mq_freeze_queue(disk->queue);
	blk_integrity_unregister(disk);

1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
	if (id->nabo == 0) {
		/*
		 * Bit 1 indicates whether NAWUPF is defined for this namespace
		 * and whether it should be used instead of AWUPF. If NAWUPF ==
		 * 0 then AWUPF must be used instead.
		 */
		if (id->nsfeat & (1 << 1) && id->nawupf)
			atomic_bs = (1 + le16_to_cpu(id->nawupf)) * bs;
		else
			atomic_bs = (1 + ns->ctrl->subsys->awupf) * bs;
	} else {
		atomic_bs = bs;
	}
	phys_bs = bs;
	io_opt = bs;
	if (id->nsfeat & (1 << 4)) {
		/* NPWG = Namespace Preferred Write Granularity */
		phys_bs *= 1 + le16_to_cpu(id->npwg);
		/* NOWS = Namespace Optimal Write Size */
		io_opt *= 1 + le16_to_cpu(id->nows);
	}

1855
	blk_queue_logical_block_size(disk->queue, bs);
1856 1857 1858 1859 1860 1861 1862 1863
	/*
	 * Linux filesystems assume writing a single physical block is
	 * an atomic operation. Hence limit the physical block size to the
	 * value of the Atomic Write Unit Power Fail parameter.
	 */
	blk_queue_physical_block_size(disk->queue, min(phys_bs, atomic_bs));
	blk_queue_io_min(disk->queue, phys_bs);
	blk_queue_io_opt(disk->queue, io_opt);
1864

1865 1866 1867
	if (ns->ms && !ns->ext &&
	    (ns->ctrl->ops->flags & NVME_F_METADATA_SUPPORTED))
		nvme_init_integrity(disk, ns->ms, ns->pi_type);
1868 1869
	if ((ns->ms && !nvme_ns_has_pi(ns) && !blk_get_integrity(disk)) ||
	    ns->lba_shift > PAGE_SHIFT)
1870 1871
		capacity = 0;

1872
	set_capacity_revalidate_and_notify(disk, capacity, false);
1873

1874
	nvme_config_discard(disk, ns);
1875
	nvme_config_write_zeroes(disk, ns);
1876 1877 1878 1879 1880 1881

	if (id->nsattr & (1 << 0))
		set_disk_ro(disk, true);
	else
		set_disk_ro(disk, false);

1882 1883 1884
	blk_mq_unfreeze_queue(disk->queue);
}

1885 1886 1887
static void __nvme_revalidate_disk(struct gendisk *disk, struct nvme_id_ns *id)
{
	struct nvme_ns *ns = disk->private_data;
1888 1889 1890 1891 1892

	/*
	 * If identify namespace failed, use default 512 byte block size so
	 * block layer can use before failing read/write for 0 capacity.
	 */
1893
	ns->lba_shift = id->lbaf[id->flbas & NVME_NS_FLBAS_LBA_MASK].ds;
1894 1895
	if (ns->lba_shift == 0)
		ns->lba_shift = 9;
1896
	ns->noiob = le16_to_cpu(id->noiob);
1897
	ns->ms = le16_to_cpu(id->lbaf[id->flbas & NVME_NS_FLBAS_LBA_MASK].ms);
1898
	ns->ext = ns->ms && (id->flbas & NVME_NS_FLBAS_META_EXT);
1899 1900 1901 1902 1903
	/* the PI implementation requires metadata equal t10 pi tuple size */
	if (ns->ms == sizeof(struct t10_pi_tuple))
		ns->pi_type = id->dps & NVME_NS_DPS_PI_MASK;
	else
		ns->pi_type = 0;
1904

1905 1906
	if (ns->noiob)
		nvme_set_chunk_size(ns);
1907
	nvme_update_disk_info(disk, ns, id);
1908
#ifdef CONFIG_NVME_MULTIPATH
1909
	if (ns->head->disk) {
1910
		nvme_update_disk_info(ns->head->disk, ns, id);
1911
		blk_queue_stack_limits(ns->head->disk->queue, ns->queue);
1912 1913 1914 1915 1916 1917 1918
		if (bdi_cap_stable_pages_required(ns->queue->backing_dev_info)) {
			struct backing_dev_info *info =
				ns->head->disk->queue->backing_dev_info;

                        info->capabilities |= BDI_CAP_STABLE_WRITES;
		}

1919
		revalidate_disk(ns->head->disk);
1920
	}
1921
#endif
1922
}
1923

1924 1925 1926
static int nvme_revalidate_disk(struct gendisk *disk)
{
	struct nvme_ns *ns = disk->private_data;
1927 1928
	struct nvme_ctrl *ctrl = ns->ctrl;
	struct nvme_id_ns *id;
1929
	struct nvme_ns_ids ids;
1930
	int ret = 0;
1931 1932 1933 1934 1935 1936

	if (test_bit(NVME_NS_DEAD, &ns->flags)) {
		set_capacity(disk, 0);
		return -ENODEV;
	}

1937 1938 1939
	ret = nvme_identify_ns(ctrl, ns->head->ns_id, &id);
	if (ret)
		goto out;
1940

1941 1942
	if (id->ncap == 0) {
		ret = -ENODEV;
1943
		goto free_id;
1944
	}
1945

1946
	__nvme_revalidate_disk(disk, id);
1947 1948 1949 1950
	ret = nvme_report_ns_ids(ctrl, ns->head->ns_id, id, &ids);
	if (ret)
		goto free_id;

C
Christoph Hellwig 已提交
1951
	if (!nvme_ns_ids_equal(&ns->head->ids, &ids)) {
1952
		dev_err(ctrl->device,
C
Christoph Hellwig 已提交
1953
			"identifiers changed for nsid %d\n", ns->head->ns_id);
1954 1955 1956
		ret = -ENODEV;
	}

1957
free_id:
1958
	kfree(id);
1959
out:
1960 1961 1962 1963 1964 1965 1966
	/*
	 * Only fail the function if we got a fatal error back from the
	 * device, otherwise ignore the error and just move on.
	 */
	if (ret == -ENOMEM || (ret > 0 && !(ret & NVME_SC_DNR)))
		ret = 0;
	else if (ret > 0)
1967
		ret = blk_status_to_errno(nvme_error_status(ret));
1968
	return ret;
1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
}

static char nvme_pr_type(enum pr_type type)
{
	switch (type) {
	case PR_WRITE_EXCLUSIVE:
		return 1;
	case PR_EXCLUSIVE_ACCESS:
		return 2;
	case PR_WRITE_EXCLUSIVE_REG_ONLY:
		return 3;
	case PR_EXCLUSIVE_ACCESS_REG_ONLY:
		return 4;
	case PR_WRITE_EXCLUSIVE_ALL_REGS:
		return 5;
	case PR_EXCLUSIVE_ACCESS_ALL_REGS:
		return 6;
	default:
		return 0;
	}
};

static int nvme_pr_command(struct block_device *bdev, u32 cdw10,
				u64 key, u64 sa_key, u8 op)
{
1994 1995
	struct nvme_ns_head *head = NULL;
	struct nvme_ns *ns;
1996
	struct nvme_command c;
1997
	int srcu_idx, ret;
1998 1999
	u8 data[16] = { 0, };

2000 2001 2002 2003
	ns = nvme_get_ns_from_disk(bdev->bd_disk, &head, &srcu_idx);
	if (unlikely(!ns))
		return -EWOULDBLOCK;

2004 2005 2006 2007 2008
	put_unaligned_le64(key, &data[0]);
	put_unaligned_le64(sa_key, &data[8]);

	memset(&c, 0, sizeof(c));
	c.common.opcode = op;
2009
	c.common.nsid = cpu_to_le32(ns->head->ns_id);
2010
	c.common.cdw10 = cpu_to_le32(cdw10);
2011

2012
	ret = nvme_submit_sync_cmd(ns->queue, &c, data, 16);
2013 2014
	nvme_put_ns_from_disk(head, srcu_idx);
	return ret;
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
}

static int nvme_pr_register(struct block_device *bdev, u64 old,
		u64 new, unsigned flags)
{
	u32 cdw10;

	if (flags & ~PR_FL_IGNORE_KEY)
		return -EOPNOTSUPP;

	cdw10 = old ? 2 : 0;
	cdw10 |= (flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0;
	cdw10 |= (1 << 30) | (1 << 31); /* PTPL=1 */
	return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_register);
}

static int nvme_pr_reserve(struct block_device *bdev, u64 key,
		enum pr_type type, unsigned flags)
{
	u32 cdw10;

	if (flags & ~PR_FL_IGNORE_KEY)
		return -EOPNOTSUPP;

	cdw10 = nvme_pr_type(type) << 8;
	cdw10 |= ((flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0);
	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_acquire);
}

static int nvme_pr_preempt(struct block_device *bdev, u64 old, u64 new,
		enum pr_type type, bool abort)
{
2047
	u32 cdw10 = nvme_pr_type(type) << 8 | (abort ? 2 : 1);
2048 2049 2050 2051 2052
	return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire);
}

static int nvme_pr_clear(struct block_device *bdev, u64 key)
{
2053
	u32 cdw10 = 1 | (key ? 1 << 3 : 0);
2054 2055 2056 2057 2058
	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_register);
}

static int nvme_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
{
2059
	u32 cdw10 = nvme_pr_type(type) << 8 | (key ? 1 << 3 : 0);
2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070
	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release);
}

static const struct pr_ops nvme_pr_ops = {
	.pr_register	= nvme_pr_register,
	.pr_reserve	= nvme_pr_reserve,
	.pr_release	= nvme_pr_release,
	.pr_preempt	= nvme_pr_preempt,
	.pr_clear	= nvme_pr_clear,
};

2071
#ifdef CONFIG_BLK_SED_OPAL
2072 2073
int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
		bool send)
2074
{
2075
	struct nvme_ctrl *ctrl = data;
2076 2077 2078 2079 2080 2081 2082 2083
	struct nvme_command cmd;

	memset(&cmd, 0, sizeof(cmd));
	if (send)
		cmd.common.opcode = nvme_admin_security_send;
	else
		cmd.common.opcode = nvme_admin_security_recv;
	cmd.common.nsid = 0;
2084 2085
	cmd.common.cdw10 = cpu_to_le32(((u32)secp) << 24 | ((u32)spsp) << 8);
	cmd.common.cdw11 = cpu_to_le32(len);
2086 2087

	return __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, NULL, buffer, len,
2088
				      ADMIN_TIMEOUT, NVME_QID_ANY, 1, 0, false);
2089 2090 2091 2092
}
EXPORT_SYMBOL_GPL(nvme_sec_submit);
#endif /* CONFIG_BLK_SED_OPAL */

2093
static const struct block_device_operations nvme_fops = {
2094 2095
	.owner		= THIS_MODULE,
	.ioctl		= nvme_ioctl,
2096
	.compat_ioctl	= nvme_compat_ioctl,
2097 2098 2099 2100 2101 2102 2103
	.open		= nvme_open,
	.release	= nvme_release,
	.getgeo		= nvme_getgeo,
	.revalidate_disk= nvme_revalidate_disk,
	.pr_ops		= &nvme_pr_ops,
};

2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123
#ifdef CONFIG_NVME_MULTIPATH
static int nvme_ns_head_open(struct block_device *bdev, fmode_t mode)
{
	struct nvme_ns_head *head = bdev->bd_disk->private_data;

	if (!kref_get_unless_zero(&head->ref))
		return -ENXIO;
	return 0;
}

static void nvme_ns_head_release(struct gendisk *disk, fmode_t mode)
{
	nvme_put_ns_head(disk->private_data);
}

const struct block_device_operations nvme_ns_head_ops = {
	.owner		= THIS_MODULE,
	.open		= nvme_ns_head_open,
	.release	= nvme_ns_head_release,
	.ioctl		= nvme_ioctl,
2124
	.compat_ioctl	= nvme_compat_ioctl,
2125 2126 2127 2128 2129
	.getgeo		= nvme_getgeo,
	.pr_ops		= &nvme_pr_ops,
};
#endif /* CONFIG_NVME_MULTIPATH */

2130 2131 2132 2133 2134 2135 2136 2137
static int nvme_wait_ready(struct nvme_ctrl *ctrl, u64 cap, bool enabled)
{
	unsigned long timeout =
		((NVME_CAP_TIMEOUT(cap) + 1) * HZ / 2) + jiffies;
	u32 csts, bit = enabled ? NVME_CSTS_RDY : 0;
	int ret;

	while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) {
K
Keith Busch 已提交
2138 2139
		if (csts == ~0)
			return -ENODEV;
2140 2141 2142
		if ((csts & NVME_CSTS_RDY) == bit)
			break;

2143
		usleep_range(1000, 2000);
2144 2145 2146
		if (fatal_signal_pending(current))
			return -EINTR;
		if (time_after(jiffies, timeout)) {
2147
			dev_err(ctrl->device,
2148 2149
				"Device not ready; aborting %s, CSTS=0x%x\n",
				enabled ? "initialisation" : "reset", csts);
2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162
			return -ENODEV;
		}
	}

	return ret;
}

/*
 * If the device has been passed off to us in an enabled state, just clear
 * the enabled bit.  The spec says we should set the 'shutdown notification
 * bits', but doing so may cause the device to complete commands to the
 * admin queue ... and we don't know what memory that might be pointing at!
 */
2163
int nvme_disable_ctrl(struct nvme_ctrl *ctrl)
2164 2165 2166 2167 2168 2169 2170 2171 2172
{
	int ret;

	ctrl->ctrl_config &= ~NVME_CC_SHN_MASK;
	ctrl->ctrl_config &= ~NVME_CC_ENABLE;

	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
	if (ret)
		return ret;
2173

2174
	if (ctrl->quirks & NVME_QUIRK_DELAY_BEFORE_CHK_RDY)
2175 2176
		msleep(NVME_QUIRK_DELAY_AMOUNT);

2177
	return nvme_wait_ready(ctrl, ctrl->cap, false);
2178
}
2179
EXPORT_SYMBOL_GPL(nvme_disable_ctrl);
2180

2181
int nvme_enable_ctrl(struct nvme_ctrl *ctrl)
2182 2183 2184 2185 2186 2187
{
	/*
	 * Default to a 4K page size, with the intention to update this
	 * path in the future to accomodate architectures with differing
	 * kernel and IO page sizes.
	 */
2188
	unsigned dev_page_min, page_shift = 12;
2189 2190
	int ret;

2191 2192 2193 2194 2195 2196 2197
	ret = ctrl->ops->reg_read64(ctrl, NVME_REG_CAP, &ctrl->cap);
	if (ret) {
		dev_err(ctrl->device, "Reading CAP failed (%d)\n", ret);
		return ret;
	}
	dev_page_min = NVME_CAP_MPSMIN(ctrl->cap) + 12;

2198
	if (page_shift < dev_page_min) {
2199
		dev_err(ctrl->device,
2200 2201 2202 2203 2204 2205 2206 2207 2208
			"Minimum device page size %u too large for host (%u)\n",
			1 << dev_page_min, 1 << page_shift);
		return -ENODEV;
	}

	ctrl->page_size = 1 << page_shift;

	ctrl->ctrl_config = NVME_CC_CSS_NVM;
	ctrl->ctrl_config |= (page_shift - 12) << NVME_CC_MPS_SHIFT;
2209
	ctrl->ctrl_config |= NVME_CC_AMS_RR | NVME_CC_SHN_NONE;
2210 2211 2212 2213 2214 2215
	ctrl->ctrl_config |= NVME_CC_IOSQES | NVME_CC_IOCQES;
	ctrl->ctrl_config |= NVME_CC_ENABLE;

	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
	if (ret)
		return ret;
2216
	return nvme_wait_ready(ctrl, ctrl->cap, true);
2217
}
2218
EXPORT_SYMBOL_GPL(nvme_enable_ctrl);
2219 2220 2221

int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl)
{
2222
	unsigned long timeout = jiffies + (ctrl->shutdown_timeout * HZ);
2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240
	u32 csts;
	int ret;

	ctrl->ctrl_config &= ~NVME_CC_SHN_MASK;
	ctrl->ctrl_config |= NVME_CC_SHN_NORMAL;

	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
	if (ret)
		return ret;

	while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) {
		if ((csts & NVME_CSTS_SHST_MASK) == NVME_CSTS_SHST_CMPLT)
			break;

		msleep(100);
		if (fatal_signal_pending(current))
			return -EINTR;
		if (time_after(jiffies, timeout)) {
2241
			dev_err(ctrl->device,
2242 2243 2244 2245 2246 2247 2248
				"Device shutdown incomplete; abort shutdown\n");
			return -ENODEV;
		}
	}

	return ret;
}
2249
EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl);
2250

2251 2252 2253
static void nvme_set_queue_limits(struct nvme_ctrl *ctrl,
		struct request_queue *q)
{
2254 2255
	bool vwc = false;

2256
	if (ctrl->max_hw_sectors) {
2257 2258 2259
		u32 max_segments =
			(ctrl->max_hw_sectors / (ctrl->page_size >> 9)) + 1;

2260
		max_segments = min_not_zero(max_segments, ctrl->max_segments);
2261
		blk_queue_max_hw_sectors(q, ctrl->max_hw_sectors);
2262
		blk_queue_max_segments(q, min_t(u32, max_segments, USHRT_MAX));
2263
	}
2264 2265
	if ((ctrl->quirks & NVME_QUIRK_STRIPE_SIZE) &&
	    is_power_of_2(ctrl->max_hw_sectors))
K
Keith Busch 已提交
2266
		blk_queue_chunk_sectors(q, ctrl->max_hw_sectors);
2267
	blk_queue_virt_boundary(q, ctrl->page_size - 1);
2268 2269 2270
	if (ctrl->vwc & NVME_CTRL_VWC_PRESENT)
		vwc = true;
	blk_queue_write_cache(q, vwc, vwc);
2271 2272
}

2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289
static int nvme_configure_timestamp(struct nvme_ctrl *ctrl)
{
	__le64 ts;
	int ret;

	if (!(ctrl->oncs & NVME_CTRL_ONCS_TIMESTAMP))
		return 0;

	ts = cpu_to_le64(ktime_to_ms(ktime_get_real()));
	ret = nvme_set_features(ctrl, NVME_FEAT_TIMESTAMP, 0, &ts, sizeof(ts),
			NULL);
	if (ret)
		dev_warn_once(ctrl->device,
			"could not set timestamp (%d)\n", ret);
	return ret;
}

2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309
static int nvme_configure_acre(struct nvme_ctrl *ctrl)
{
	struct nvme_feat_host_behavior *host;
	int ret;

	/* Don't bother enabling the feature if retry delay is not reported */
	if (!ctrl->crdt[0])
		return 0;

	host = kzalloc(sizeof(*host), GFP_KERNEL);
	if (!host)
		return 0;

	host->acre = NVME_ENABLE_ACRE;
	ret = nvme_set_features(ctrl, NVME_FEAT_HOST_BEHAVIOR, 0,
				host, sizeof(*host), NULL);
	kfree(host);
	return ret;
}

2310
static int nvme_configure_apst(struct nvme_ctrl *ctrl)
2311 2312 2313 2314 2315 2316 2317 2318
{
	/*
	 * APST (Autonomous Power State Transition) lets us program a
	 * table of power state transitions that the controller will
	 * perform automatically.  We configure it with a simple
	 * heuristic: we are willing to spend at most 2% of the time
	 * transitioning between power states.  Therefore, when running
	 * in any given state, we will enter the next lower-power
A
Andy Lutomirski 已提交
2319
	 * non-operational state after waiting 50 * (enlat + exlat)
2320
	 * microseconds, as long as that state's exit latency is under
2321 2322 2323 2324 2325 2326 2327 2328 2329
	 * the requested maximum latency.
	 *
	 * We will not autonomously enter any non-operational state for
	 * which the total latency exceeds ps_max_latency_us.  Users
	 * can set ps_max_latency_us to zero to turn off APST.
	 */

	unsigned apste;
	struct nvme_feat_auto_pst *table;
2330 2331
	u64 max_lat_us = 0;
	int max_ps = -1;
2332 2333 2334 2335 2336 2337 2338
	int ret;

	/*
	 * If APST isn't supported or if we haven't been initialized yet,
	 * then don't do anything.
	 */
	if (!ctrl->apsta)
2339
		return 0;
2340 2341 2342

	if (ctrl->npss > 31) {
		dev_warn(ctrl->device, "NPSS is invalid; not using APST\n");
2343
		return 0;
2344 2345 2346 2347
	}

	table = kzalloc(sizeof(*table), GFP_KERNEL);
	if (!table)
2348
		return 0;
2349

2350
	if (!ctrl->apst_enabled || ctrl->ps_max_latency_us == 0) {
2351 2352
		/* Turn off APST. */
		apste = 0;
2353
		dev_dbg(ctrl->device, "APST disabled\n");
2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364
	} else {
		__le64 target = cpu_to_le64(0);
		int state;

		/*
		 * Walk through all states from lowest- to highest-power.
		 * According to the spec, lower-numbered states use more
		 * power.  NPSS, despite the name, is the index of the
		 * lowest-power state, not the number of states.
		 */
		for (state = (int)ctrl->npss; state >= 0; state--) {
2365
			u64 total_latency_us, exit_latency_us, transition_ms;
2366 2367 2368 2369

			if (target)
				table->entries[state] = target;

2370 2371 2372 2373 2374 2375 2376 2377
			/*
			 * Don't allow transitions to the deepest state
			 * if it's quirked off.
			 */
			if (state == ctrl->npss &&
			    (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS))
				continue;

2378 2379 2380 2381 2382 2383 2384 2385
			/*
			 * Is this state a useful non-operational state for
			 * higher-power states to autonomously transition to?
			 */
			if (!(ctrl->psd[state].flags &
			      NVME_PS_FLAGS_NON_OP_STATE))
				continue;

2386 2387 2388
			exit_latency_us =
				(u64)le32_to_cpu(ctrl->psd[state].exit_lat);
			if (exit_latency_us > ctrl->ps_max_latency_us)
2389 2390
				continue;

2391 2392 2393 2394
			total_latency_us =
				exit_latency_us +
				le32_to_cpu(ctrl->psd[state].entry_lat);

2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405
			/*
			 * This state is good.  Use it as the APST idle
			 * target for higher power states.
			 */
			transition_ms = total_latency_us + 19;
			do_div(transition_ms, 20);
			if (transition_ms > (1 << 24) - 1)
				transition_ms = (1 << 24) - 1;

			target = cpu_to_le64((state << 3) |
					     (transition_ms << 8));
2406 2407 2408 2409 2410 2411

			if (max_ps == -1)
				max_ps = state;

			if (total_latency_us > max_lat_us)
				max_lat_us = total_latency_us;
2412 2413 2414
		}

		apste = 1;
2415 2416 2417 2418 2419 2420 2421

		if (max_ps == -1) {
			dev_dbg(ctrl->device, "APST enabled but no non-operational states are available\n");
		} else {
			dev_dbg(ctrl->device, "APST enabled: max PS = %d, max round-trip latency = %lluus, table = %*phN\n",
				max_ps, max_lat_us, (int)sizeof(*table), table);
		}
2422 2423 2424 2425 2426 2427 2428 2429
	}

	ret = nvme_set_features(ctrl, NVME_FEAT_AUTO_PST, apste,
				table, sizeof(*table), NULL);
	if (ret)
		dev_err(ctrl->device, "failed to set APST feature (%d)\n", ret);

	kfree(table);
2430
	return ret;
2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453
}

static void nvme_set_latency_tolerance(struct device *dev, s32 val)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
	u64 latency;

	switch (val) {
	case PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT:
	case PM_QOS_LATENCY_ANY:
		latency = U64_MAX;
		break;

	default:
		latency = val;
	}

	if (ctrl->ps_max_latency_us != latency) {
		ctrl->ps_max_latency_us = latency;
		nvme_configure_apst(ctrl);
	}
}

2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466
struct nvme_core_quirk_entry {
	/*
	 * NVMe model and firmware strings are padded with spaces.  For
	 * simplicity, strings in the quirk table are padded with NULLs
	 * instead.
	 */
	u16 vid;
	const char *mn;
	const char *fr;
	unsigned long quirks;
};

static const struct nvme_core_quirk_entry core_quirks[] = {
2467
	{
2468 2469 2470 2471 2472 2473
		/*
		 * This Toshiba device seems to die using any APST states.  See:
		 * https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1678184/comments/11
		 */
		.vid = 0x1179,
		.mn = "THNSF5256GPUK TOSHIBA",
2474
		.quirks = NVME_QUIRK_NO_APST,
2475 2476 2477 2478 2479 2480 2481 2482 2483 2484
	},
	{
		/*
		 * This LiteON CL1-3D*-Q11 firmware version has a race
		 * condition associated with actions related to suspend to idle
		 * LiteON has resolved the problem in future firmware
		 */
		.vid = 0x14a4,
		.fr = "22301111",
		.quirks = NVME_QUIRK_SIMPLE_SUSPEND,
2485
	}
2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516
};

/* match is null-terminated but idstr is space-padded. */
static bool string_matches(const char *idstr, const char *match, size_t len)
{
	size_t matchlen;

	if (!match)
		return true;

	matchlen = strlen(match);
	WARN_ON_ONCE(matchlen > len);

	if (memcmp(idstr, match, matchlen))
		return false;

	for (; matchlen < len; matchlen++)
		if (idstr[matchlen] != ' ')
			return false;

	return true;
}

static bool quirk_matches(const struct nvme_id_ctrl *id,
			  const struct nvme_core_quirk_entry *q)
{
	return q->vid == le16_to_cpu(id->vid) &&
		string_matches(id->mn, q->mn, sizeof(id->mn)) &&
		string_matches(id->fr, q->fr, sizeof(id->fr));
}

C
Christoph Hellwig 已提交
2517 2518
static void nvme_init_subnqn(struct nvme_subsystem *subsys, struct nvme_ctrl *ctrl,
		struct nvme_id_ctrl *id)
2519 2520 2521 2522
{
	size_t nqnlen;
	int off;

2523 2524 2525 2526 2527 2528
	if(!(ctrl->quirks & NVME_QUIRK_IGNORE_DEV_SUBNQN)) {
		nqnlen = strnlen(id->subnqn, NVMF_NQN_SIZE);
		if (nqnlen > 0 && nqnlen < NVMF_NQN_SIZE) {
			strlcpy(subsys->subnqn, id->subnqn, NVMF_NQN_SIZE);
			return;
		}
2529

2530 2531 2532
		if (ctrl->vs >= NVME_VS(1, 2, 1))
			dev_warn(ctrl->device, "missing or invalid SUBNQN field.\n");
	}
2533 2534

	/* Generate a "fake" NQN per Figure 254 in NVMe 1.3 + ECN 001 */
C
Christoph Hellwig 已提交
2535
	off = snprintf(subsys->subnqn, NVMF_NQN_SIZE,
2536
			"nqn.2014.08.org.nvmexpress:%04x%04x",
2537
			le16_to_cpu(id->vid), le16_to_cpu(id->ssvid));
C
Christoph Hellwig 已提交
2538
	memcpy(subsys->subnqn + off, id->sn, sizeof(id->sn));
2539
	off += sizeof(id->sn);
C
Christoph Hellwig 已提交
2540
	memcpy(subsys->subnqn + off, id->mn, sizeof(id->mn));
2541
	off += sizeof(id->mn);
C
Christoph Hellwig 已提交
2542 2543 2544
	memset(subsys->subnqn + off, 0, sizeof(subsys->subnqn) - off);
}

2545
static void nvme_release_subsystem(struct device *dev)
C
Christoph Hellwig 已提交
2546
{
2547 2548 2549
	struct nvme_subsystem *subsys =
		container_of(dev, struct nvme_subsystem, dev);

2550 2551
	if (subsys->instance >= 0)
		ida_simple_remove(&nvme_instance_ida, subsys->instance);
C
Christoph Hellwig 已提交
2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563
	kfree(subsys);
}

static void nvme_destroy_subsystem(struct kref *ref)
{
	struct nvme_subsystem *subsys =
			container_of(ref, struct nvme_subsystem, ref);

	mutex_lock(&nvme_subsystems_lock);
	list_del(&subsys->entry);
	mutex_unlock(&nvme_subsystems_lock);

C
Christoph Hellwig 已提交
2564
	ida_destroy(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579
	device_del(&subsys->dev);
	put_device(&subsys->dev);
}

static void nvme_put_subsystem(struct nvme_subsystem *subsys)
{
	kref_put(&subsys->ref, nvme_destroy_subsystem);
}

static struct nvme_subsystem *__nvme_find_get_subsystem(const char *subsysnqn)
{
	struct nvme_subsystem *subsys;

	lockdep_assert_held(&nvme_subsystems_lock);

2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590
	/*
	 * Fail matches for discovery subsystems. This results
	 * in each discovery controller bound to a unique subsystem.
	 * This avoids issues with validating controller values
	 * that can only be true when there is a single unique subsystem.
	 * There may be multiple and completely independent entities
	 * that provide discovery controllers.
	 */
	if (!strcmp(subsysnqn, NVME_DISC_SUBSYS_NAME))
		return NULL;

C
Christoph Hellwig 已提交
2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601
	list_for_each_entry(subsys, &nvme_subsystems, entry) {
		if (strcmp(subsys->subnqn, subsysnqn))
			continue;
		if (!kref_get_unless_zero(&subsys->ref))
			continue;
		return subsys;
	}

	return NULL;
}

2602 2603 2604 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 2635 2636
#define SUBSYS_ATTR_RO(_name, _mode, _show)			\
	struct device_attribute subsys_attr_##_name = \
		__ATTR(_name, _mode, _show, NULL)

static ssize_t nvme_subsys_show_nqn(struct device *dev,
				    struct device_attribute *attr,
				    char *buf)
{
	struct nvme_subsystem *subsys =
		container_of(dev, struct nvme_subsystem, dev);

	return snprintf(buf, PAGE_SIZE, "%s\n", subsys->subnqn);
}
static SUBSYS_ATTR_RO(subsysnqn, S_IRUGO, nvme_subsys_show_nqn);

#define nvme_subsys_show_str_function(field)				\
static ssize_t subsys_##field##_show(struct device *dev,		\
			    struct device_attribute *attr, char *buf)	\
{									\
	struct nvme_subsystem *subsys =					\
		container_of(dev, struct nvme_subsystem, dev);		\
	return sprintf(buf, "%.*s\n",					\
		       (int)sizeof(subsys->field), subsys->field);	\
}									\
static SUBSYS_ATTR_RO(field, S_IRUGO, subsys_##field##_show);

nvme_subsys_show_str_function(model);
nvme_subsys_show_str_function(serial);
nvme_subsys_show_str_function(firmware_rev);

static struct attribute *nvme_subsys_attrs[] = {
	&subsys_attr_model.attr,
	&subsys_attr_serial.attr,
	&subsys_attr_firmware_rev.attr,
	&subsys_attr_subsysnqn.attr,
2637 2638 2639
#ifdef CONFIG_NVME_MULTIPATH
	&subsys_attr_iopolicy.attr,
#endif
2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651
	NULL,
};

static struct attribute_group nvme_subsys_attrs_group = {
	.attrs = nvme_subsys_attrs,
};

static const struct attribute_group *nvme_subsys_attrs_groups[] = {
	&nvme_subsys_attrs_group,
	NULL,
};

2652 2653
static bool nvme_validate_cntlid(struct nvme_subsystem *subsys,
		struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
2654
{
2655
	struct nvme_ctrl *tmp;
2656

2657 2658
	lockdep_assert_held(&nvme_subsystems_lock);

2659
	list_for_each_entry(tmp, &subsys->ctrls, subsys_entry) {
2660
		if (nvme_state_terminal(tmp))
2661 2662 2663 2664 2665 2666 2667 2668
			continue;

		if (tmp->cntlid == ctrl->cntlid) {
			dev_err(ctrl->device,
				"Duplicate cntlid %u with %s, rejecting\n",
				ctrl->cntlid, dev_name(tmp->device));
			return false;
		}
2669

2670 2671 2672 2673 2674 2675 2676
		if ((id->cmic & (1 << 1)) ||
		    (ctrl->opts && ctrl->opts->discovery_nqn))
			continue;

		dev_err(ctrl->device,
			"Subsystem does not support multiple controllers\n");
		return false;
2677 2678
	}

2679
	return true;
2680 2681
}

C
Christoph Hellwig 已提交
2682 2683 2684 2685 2686 2687 2688 2689
static int nvme_init_subsystem(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
{
	struct nvme_subsystem *subsys, *found;
	int ret;

	subsys = kzalloc(sizeof(*subsys), GFP_KERNEL);
	if (!subsys)
		return -ENOMEM;
2690 2691

	subsys->instance = -1;
C
Christoph Hellwig 已提交
2692 2693 2694
	mutex_init(&subsys->lock);
	kref_init(&subsys->ref);
	INIT_LIST_HEAD(&subsys->ctrls);
C
Christoph Hellwig 已提交
2695
	INIT_LIST_HEAD(&subsys->nsheads);
C
Christoph Hellwig 已提交
2696 2697 2698 2699 2700 2701
	nvme_init_subnqn(subsys, ctrl, id);
	memcpy(subsys->serial, id->sn, sizeof(subsys->serial));
	memcpy(subsys->model, id->mn, sizeof(subsys->model));
	memcpy(subsys->firmware_rev, id->fr, sizeof(subsys->firmware_rev));
	subsys->vendor_id = le16_to_cpu(id->vid);
	subsys->cmic = id->cmic;
2702
	subsys->awupf = le16_to_cpu(id->awupf);
2703 2704 2705
#ifdef CONFIG_NVME_MULTIPATH
	subsys->iopolicy = NVME_IOPOLICY_NUMA;
#endif
C
Christoph Hellwig 已提交
2706 2707 2708

	subsys->dev.class = nvme_subsys_class;
	subsys->dev.release = nvme_release_subsystem;
2709
	subsys->dev.groups = nvme_subsys_attrs_groups;
2710
	dev_set_name(&subsys->dev, "nvme-subsys%d", ctrl->instance);
C
Christoph Hellwig 已提交
2711 2712 2713 2714 2715
	device_initialize(&subsys->dev);

	mutex_lock(&nvme_subsystems_lock);
	found = __nvme_find_get_subsystem(subsys->subnqn);
	if (found) {
2716
		put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2717
		subsys = found;
2718

2719
		if (!nvme_validate_cntlid(subsys, ctrl, id)) {
C
Christoph Hellwig 已提交
2720
			ret = -EINVAL;
2721
			goto out_put_subsystem;
C
Christoph Hellwig 已提交
2722 2723 2724 2725 2726 2727
		}
	} else {
		ret = device_add(&subsys->dev);
		if (ret) {
			dev_err(ctrl->device,
				"failed to register subsystem device.\n");
2728
			put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2729 2730
			goto out_unlock;
		}
C
Christoph Hellwig 已提交
2731
		ida_init(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2732 2733 2734
		list_add_tail(&subsys->entry, &nvme_subsystems);
	}

2735 2736 2737
	ret = sysfs_create_link(&subsys->dev.kobj, &ctrl->device->kobj,
				dev_name(ctrl->device));
	if (ret) {
C
Christoph Hellwig 已提交
2738 2739
		dev_err(ctrl->device,
			"failed to create sysfs link from subsystem.\n");
2740
		goto out_put_subsystem;
C
Christoph Hellwig 已提交
2741 2742
	}

2743 2744
	if (!found)
		subsys->instance = ctrl->instance;
2745
	ctrl->subsys = subsys;
C
Christoph Hellwig 已提交
2746
	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
2747
	mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
2748 2749
	return 0;

2750 2751
out_put_subsystem:
	nvme_put_subsystem(subsys);
C
Christoph Hellwig 已提交
2752 2753 2754
out_unlock:
	mutex_unlock(&nvme_subsystems_lock);
	return ret;
2755 2756
}

2757 2758
int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp,
		void *log, size_t size, u64 offset)
K
Keith Busch 已提交
2759 2760
{
	struct nvme_command c = { };
K
Keith Busch 已提交
2761
	u32 dwlen = nvme_bytes_to_numd(size);
2762 2763

	c.get_log_page.opcode = nvme_admin_get_log_page;
2764
	c.get_log_page.nsid = cpu_to_le32(nsid);
2765
	c.get_log_page.lid = log_page;
2766
	c.get_log_page.lsp = lsp;
2767 2768
	c.get_log_page.numdl = cpu_to_le16(dwlen & ((1 << 16) - 1));
	c.get_log_page.numdu = cpu_to_le16(dwlen >> 16);
2769 2770
	c.get_log_page.lpol = cpu_to_le32(lower_32_bits(offset));
	c.get_log_page.lpou = cpu_to_le32(upper_32_bits(offset));
K
Keith Busch 已提交
2771 2772 2773 2774

	return nvme_submit_sync_cmd(ctrl->admin_q, &c, log, size);
}

2775 2776 2777 2778 2779 2780 2781 2782 2783 2784
static int nvme_get_effects_log(struct nvme_ctrl *ctrl)
{
	int ret;

	if (!ctrl->effects)
		ctrl->effects = kzalloc(sizeof(*ctrl->effects), GFP_KERNEL);

	if (!ctrl->effects)
		return 0;

2785 2786
	ret = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CMD_EFFECTS, 0,
			ctrl->effects, sizeof(*ctrl->effects), 0);
2787 2788 2789 2790 2791
	if (ret) {
		kfree(ctrl->effects);
		ctrl->effects = NULL;
	}
	return ret;
2792 2793
}

2794 2795 2796 2797 2798 2799 2800 2801 2802
/*
 * Initialize the cached copies of the Identify data and various controller
 * register in our nvme_ctrl structure.  This should be called as soon as
 * the admin queue is fully up and running.
 */
int nvme_init_identify(struct nvme_ctrl *ctrl)
{
	struct nvme_id_ctrl *id;
	int ret, page_shift;
2803
	u32 max_hw_sectors;
2804
	bool prev_apst_enabled;
2805

2806 2807
	ret = ctrl->ops->reg_read32(ctrl, NVME_REG_VS, &ctrl->vs);
	if (ret) {
2808
		dev_err(ctrl->device, "Reading VS failed (%d)\n", ret);
2809 2810
		return ret;
	}
2811
	page_shift = NVME_CAP_MPSMIN(ctrl->cap) + 12;
2812
	ctrl->sqsize = min_t(int, NVME_CAP_MQES(ctrl->cap), ctrl->sqsize);
2813

2814
	if (ctrl->vs >= NVME_VS(1, 1, 0))
2815
		ctrl->subsystem = NVME_CAP_NSSRC(ctrl->cap);
2816

2817 2818
	ret = nvme_identify_ctrl(ctrl, &id);
	if (ret) {
2819
		dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret);
2820 2821 2822
		return -EIO;
	}

2823 2824 2825
	if (id->lpa & NVME_CTRL_LPA_CMD_EFFECTS_LOG) {
		ret = nvme_get_effects_log(ctrl);
		if (ret < 0)
2826
			goto out_free;
2827
	}
2828

2829 2830 2831
	if (!(ctrl->ops->flags & NVME_F_FABRICS))
		ctrl->cntlid = le16_to_cpu(id->cntlid);

2832
	if (!ctrl->identified) {
C
Christoph Hellwig 已提交
2833 2834 2835 2836 2837 2838
		int i;

		ret = nvme_init_subsystem(ctrl, id);
		if (ret)
			goto out_free;

2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852
		/*
		 * Check for quirks.  Quirk can depend on firmware version,
		 * so, in principle, the set of quirks present can change
		 * across a reset.  As a possible future enhancement, we
		 * could re-scan for quirks every time we reinitialize
		 * the device, but we'd have to make sure that the driver
		 * behaves intelligently if the quirks change.
		 */
		for (i = 0; i < ARRAY_SIZE(core_quirks); i++) {
			if (quirk_matches(id, &core_quirks[i]))
				ctrl->quirks |= core_quirks[i].quirks;
		}
	}

2853
	if (force_apst && (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) {
2854
		dev_warn(ctrl->device, "forcibly allowing all power states due to nvme_core.force_apst -- use at your own risk\n");
2855 2856 2857
		ctrl->quirks &= ~NVME_QUIRK_NO_DEEPEST_PS;
	}

2858 2859 2860 2861
	ctrl->crdt[0] = le16_to_cpu(id->crdt1);
	ctrl->crdt[1] = le16_to_cpu(id->crdt2);
	ctrl->crdt[2] = le16_to_cpu(id->crdt3);

2862
	ctrl->oacs = le16_to_cpu(id->oacs);
2863
	ctrl->oncs = le16_to_cpu(id->oncs);
2864
	ctrl->mtfa = le16_to_cpu(id->mtfa);
2865
	ctrl->oaes = le32_to_cpu(id->oaes);
2866 2867 2868
	ctrl->wctemp = le16_to_cpu(id->wctemp);
	ctrl->cctemp = le16_to_cpu(id->cctemp);

2869
	atomic_set(&ctrl->abort_limit, id->acl + 1);
2870 2871
	ctrl->vwc = id->vwc;
	if (id->mdts)
2872
		max_hw_sectors = 1 << (id->mdts + page_shift - 9);
2873
	else
2874 2875 2876
		max_hw_sectors = UINT_MAX;
	ctrl->max_hw_sectors =
		min_not_zero(ctrl->max_hw_sectors, max_hw_sectors);
2877

2878
	nvme_set_queue_limits(ctrl, ctrl->admin_q);
2879
	ctrl->sgls = le32_to_cpu(id->sgls);
S
Sagi Grimberg 已提交
2880
	ctrl->kas = le16_to_cpu(id->kas);
C
Christoph Hellwig 已提交
2881
	ctrl->max_namespaces = le32_to_cpu(id->mnan);
S
Sagi Grimberg 已提交
2882
	ctrl->ctratt = le32_to_cpu(id->ctratt);
2883

2884 2885 2886 2887 2888 2889 2890 2891
	if (id->rtd3e) {
		/* us -> s */
		u32 transition_time = le32_to_cpu(id->rtd3e) / 1000000;

		ctrl->shutdown_timeout = clamp_t(unsigned int, transition_time,
						 shutdown_timeout, 60);

		if (ctrl->shutdown_timeout != shutdown_timeout)
2892
			dev_info(ctrl->device,
2893 2894 2895 2896 2897
				 "Shutdown timeout set to %u seconds\n",
				 ctrl->shutdown_timeout);
	} else
		ctrl->shutdown_timeout = shutdown_timeout;

2898
	ctrl->npss = id->npss;
2899 2900
	ctrl->apsta = id->apsta;
	prev_apst_enabled = ctrl->apst_enabled;
2901 2902
	if (ctrl->quirks & NVME_QUIRK_NO_APST) {
		if (force_apst && id->apsta) {
2903
			dev_warn(ctrl->device, "forcibly allowing APST due to nvme_core.force_apst -- use at your own risk\n");
2904
			ctrl->apst_enabled = true;
2905
		} else {
2906
			ctrl->apst_enabled = false;
2907 2908
		}
	} else {
2909
		ctrl->apst_enabled = id->apsta;
2910
	}
2911 2912
	memcpy(ctrl->psd, id->psd, sizeof(ctrl->psd));

2913
	if (ctrl->ops->flags & NVME_F_FABRICS) {
2914 2915 2916 2917 2918 2919 2920 2921 2922
		ctrl->icdoff = le16_to_cpu(id->icdoff);
		ctrl->ioccsz = le32_to_cpu(id->ioccsz);
		ctrl->iorcsz = le32_to_cpu(id->iorcsz);
		ctrl->maxcmd = le16_to_cpu(id->maxcmd);

		/*
		 * In fabrics we need to verify the cntlid matches the
		 * admin connect
		 */
2923
		if (ctrl->cntlid != le16_to_cpu(id->cntlid)) {
2924 2925 2926 2927
			dev_err(ctrl->device,
				"Mismatching cntlid: Connect %u vs Identify "
				"%u, rejecting\n",
				ctrl->cntlid, le16_to_cpu(id->cntlid));
2928
			ret = -EINVAL;
2929 2930
			goto out_free;
		}
S
Sagi Grimberg 已提交
2931 2932

		if (!ctrl->opts->discovery_nqn && !ctrl->kas) {
2933
			dev_err(ctrl->device,
S
Sagi Grimberg 已提交
2934 2935
				"keep-alive support is mandatory for fabrics\n");
			ret = -EINVAL;
2936
			goto out_free;
S
Sagi Grimberg 已提交
2937
		}
2938
	} else {
2939 2940
		ctrl->hmpre = le32_to_cpu(id->hmpre);
		ctrl->hmmin = le32_to_cpu(id->hmmin);
2941 2942
		ctrl->hmminds = le32_to_cpu(id->hmminds);
		ctrl->hmmaxd = le16_to_cpu(id->hmmaxd);
2943
	}
2944

C
Christoph Hellwig 已提交
2945
	ret = nvme_mpath_init(ctrl, id);
2946
	kfree(id);
2947

C
Christoph Hellwig 已提交
2948 2949 2950
	if (ret < 0)
		return ret;

2951
	if (ctrl->apst_enabled && !prev_apst_enabled)
2952
		dev_pm_qos_expose_latency_tolerance(ctrl->device);
2953
	else if (!ctrl->apst_enabled && prev_apst_enabled)
2954 2955
		dev_pm_qos_hide_latency_tolerance(ctrl->device);

2956 2957 2958
	ret = nvme_configure_apst(ctrl);
	if (ret < 0)
		return ret;
2959 2960 2961 2962
	
	ret = nvme_configure_timestamp(ctrl);
	if (ret < 0)
		return ret;
2963 2964 2965 2966

	ret = nvme_configure_directives(ctrl);
	if (ret < 0)
		return ret;
2967

2968 2969 2970 2971
	ret = nvme_configure_acre(ctrl);
	if (ret < 0)
		return ret;

2972 2973 2974
	if (!ctrl->identified)
		nvme_hwmon_init(ctrl);

2975
	ctrl->identified = true;
2976

2977 2978 2979 2980
	return 0;

out_free:
	kfree(id);
2981
	return ret;
2982
}
2983
EXPORT_SYMBOL_GPL(nvme_init_identify);
2984

2985
static int nvme_dev_open(struct inode *inode, struct file *file)
2986
{
2987 2988
	struct nvme_ctrl *ctrl =
		container_of(inode->i_cdev, struct nvme_ctrl, cdev);
2989

2990 2991 2992 2993
	switch (ctrl->state) {
	case NVME_CTRL_LIVE:
		break;
	default:
2994
		return -EWOULDBLOCK;
2995 2996
	}

2997
	file->private_data = ctrl;
2998 2999 3000
	return 0;
}

3001 3002 3003 3004 3005
static int nvme_dev_user_cmd(struct nvme_ctrl *ctrl, void __user *argp)
{
	struct nvme_ns *ns;
	int ret;

3006
	down_read(&ctrl->namespaces_rwsem);
3007 3008 3009 3010 3011 3012 3013
	if (list_empty(&ctrl->namespaces)) {
		ret = -ENOTTY;
		goto out_unlock;
	}

	ns = list_first_entry(&ctrl->namespaces, struct nvme_ns, list);
	if (ns != list_last_entry(&ctrl->namespaces, struct nvme_ns, list)) {
3014
		dev_warn(ctrl->device,
3015 3016 3017 3018 3019
			"NVME_IOCTL_IO_CMD not supported when multiple namespaces present!\n");
		ret = -EINVAL;
		goto out_unlock;
	}

3020
	dev_warn(ctrl->device,
3021 3022
		"using deprecated NVME_IOCTL_IO_CMD ioctl on the char device!\n");
	kref_get(&ns->kref);
3023
	up_read(&ctrl->namespaces_rwsem);
3024 3025 3026 3027 3028 3029

	ret = nvme_user_cmd(ctrl, ns, argp);
	nvme_put_ns(ns);
	return ret;

out_unlock:
3030
	up_read(&ctrl->namespaces_rwsem);
3031 3032 3033
	return ret;
}

3034 3035 3036 3037 3038 3039 3040 3041 3042
static long nvme_dev_ioctl(struct file *file, unsigned int cmd,
		unsigned long arg)
{
	struct nvme_ctrl *ctrl = file->private_data;
	void __user *argp = (void __user *)arg;

	switch (cmd) {
	case NVME_IOCTL_ADMIN_CMD:
		return nvme_user_cmd(ctrl, NULL, argp);
3043 3044
	case NVME_IOCTL_ADMIN64_CMD:
		return nvme_user_cmd64(ctrl, NULL, argp);
3045
	case NVME_IOCTL_IO_CMD:
3046
		return nvme_dev_user_cmd(ctrl, argp);
3047
	case NVME_IOCTL_RESET:
3048
		dev_warn(ctrl->device, "resetting controller\n");
3049
		return nvme_reset_ctrl_sync(ctrl);
3050 3051
	case NVME_IOCTL_SUBSYS_RESET:
		return nvme_reset_subsystem(ctrl);
K
Keith Busch 已提交
3052 3053 3054
	case NVME_IOCTL_RESCAN:
		nvme_queue_scan(ctrl);
		return 0;
3055 3056 3057 3058 3059 3060 3061 3062 3063
	default:
		return -ENOTTY;
	}
}

static const struct file_operations nvme_dev_fops = {
	.owner		= THIS_MODULE,
	.open		= nvme_dev_open,
	.unlocked_ioctl	= nvme_dev_ioctl,
3064
	.compat_ioctl	= compat_ptr_ioctl,
3065 3066 3067 3068 3069 3070 3071 3072 3073
};

static ssize_t nvme_sysfs_reset(struct device *dev,
				struct device_attribute *attr, const char *buf,
				size_t count)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
	int ret;

3074
	ret = nvme_reset_ctrl_sync(ctrl);
3075 3076 3077
	if (ret < 0)
		return ret;
	return count;
3078
}
3079
static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset);
3080

K
Keith Busch 已提交
3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091
static ssize_t nvme_sysfs_rescan(struct device *dev,
				struct device_attribute *attr, const char *buf,
				size_t count)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

	nvme_queue_scan(ctrl);
	return count;
}
static DEVICE_ATTR(rescan_controller, S_IWUSR, NULL, nvme_sysfs_rescan);

3092 3093 3094 3095 3096 3097 3098 3099 3100 3101
static inline struct nvme_ns_head *dev_to_ns_head(struct device *dev)
{
	struct gendisk *disk = dev_to_disk(dev);

	if (disk->fops == &nvme_fops)
		return nvme_get_ns_from_dev(dev)->head;
	else
		return disk->private_data;
}

3102
static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
3103
		char *buf)
3104
{
3105 3106 3107
	struct nvme_ns_head *head = dev_to_ns_head(dev);
	struct nvme_ns_ids *ids = &head->ids;
	struct nvme_subsystem *subsys = head->subsys;
C
Christoph Hellwig 已提交
3108 3109
	int serial_len = sizeof(subsys->serial);
	int model_len = sizeof(subsys->model);
3110

3111 3112
	if (!uuid_is_null(&ids->uuid))
		return sprintf(buf, "uuid.%pU\n", &ids->uuid);
3113

3114 3115
	if (memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
		return sprintf(buf, "eui.%16phN\n", ids->nguid);
3116

3117 3118
	if (memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
		return sprintf(buf, "eui.%8phN\n", ids->eui64);
3119

C
Christoph Hellwig 已提交
3120 3121
	while (serial_len > 0 && (subsys->serial[serial_len - 1] == ' ' ||
				  subsys->serial[serial_len - 1] == '\0'))
3122
		serial_len--;
C
Christoph Hellwig 已提交
3123 3124
	while (model_len > 0 && (subsys->model[model_len - 1] == ' ' ||
				 subsys->model[model_len - 1] == '\0'))
3125 3126
		model_len--;

C
Christoph Hellwig 已提交
3127 3128
	return sprintf(buf, "nvme.%04x-%*phN-%*phN-%08x\n", subsys->vendor_id,
		serial_len, subsys->serial, model_len, subsys->model,
3129
		head->ns_id);
3130
}
J
Joe Perches 已提交
3131
static DEVICE_ATTR_RO(wwid);
3132

3133
static ssize_t nguid_show(struct device *dev, struct device_attribute *attr,
3134
		char *buf)
3135
{
3136
	return sprintf(buf, "%pU\n", dev_to_ns_head(dev)->ids.nguid);
3137
}
J
Joe Perches 已提交
3138
static DEVICE_ATTR_RO(nguid);
3139

3140
static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
3141
		char *buf)
3142
{
3143
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3144 3145 3146 3147

	/* For backward compatibility expose the NGUID to userspace if
	 * we have no UUID set
	 */
3148
	if (uuid_is_null(&ids->uuid)) {
3149 3150
		printk_ratelimited(KERN_WARNING
				   "No UUID available providing old NGUID\n");
3151
		return sprintf(buf, "%pU\n", ids->nguid);
3152
	}
3153
	return sprintf(buf, "%pU\n", &ids->uuid);
3154
}
J
Joe Perches 已提交
3155
static DEVICE_ATTR_RO(uuid);
3156 3157

static ssize_t eui_show(struct device *dev, struct device_attribute *attr,
3158
		char *buf)
3159
{
3160
	return sprintf(buf, "%8ph\n", dev_to_ns_head(dev)->ids.eui64);
3161
}
J
Joe Perches 已提交
3162
static DEVICE_ATTR_RO(eui);
3163 3164

static ssize_t nsid_show(struct device *dev, struct device_attribute *attr,
3165
		char *buf)
3166
{
3167
	return sprintf(buf, "%d\n", dev_to_ns_head(dev)->ns_id);
3168
}
J
Joe Perches 已提交
3169
static DEVICE_ATTR_RO(nsid);
3170

3171
static struct attribute *nvme_ns_id_attrs[] = {
3172
	&dev_attr_wwid.attr,
3173
	&dev_attr_uuid.attr,
3174
	&dev_attr_nguid.attr,
3175 3176
	&dev_attr_eui.attr,
	&dev_attr_nsid.attr,
C
Christoph Hellwig 已提交
3177 3178 3179 3180
#ifdef CONFIG_NVME_MULTIPATH
	&dev_attr_ana_grpid.attr,
	&dev_attr_ana_state.attr,
#endif
3181 3182 3183
	NULL,
};

3184
static umode_t nvme_ns_id_attrs_are_visible(struct kobject *kobj,
3185 3186 3187
		struct attribute *a, int n)
{
	struct device *dev = container_of(kobj, struct device, kobj);
3188
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3189 3190

	if (a == &dev_attr_uuid.attr) {
3191
		if (uuid_is_null(&ids->uuid) &&
3192
		    !memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3193 3194 3195
			return 0;
	}
	if (a == &dev_attr_nguid.attr) {
3196
		if (!memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3197 3198 3199
			return 0;
	}
	if (a == &dev_attr_eui.attr) {
3200
		if (!memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3201 3202
			return 0;
	}
C
Christoph Hellwig 已提交
3203 3204 3205 3206 3207 3208 3209 3210
#ifdef CONFIG_NVME_MULTIPATH
	if (a == &dev_attr_ana_grpid.attr || a == &dev_attr_ana_state.attr) {
		if (dev_to_disk(dev)->fops != &nvme_fops) /* per-path attr */
			return 0;
		if (!nvme_ctrl_use_ana(nvme_get_ns_from_dev(dev)->ctrl))
			return 0;
	}
#endif
3211 3212 3213
	return a->mode;
}

3214
static const struct attribute_group nvme_ns_id_attr_group = {
3215 3216
	.attrs		= nvme_ns_id_attrs,
	.is_visible	= nvme_ns_id_attrs_are_visible,
3217 3218
};

3219 3220 3221 3222 3223 3224 3225 3226
const struct attribute_group *nvme_ns_id_attr_groups[] = {
	&nvme_ns_id_attr_group,
#ifdef CONFIG_NVM
	&nvme_nvm_attr_group,
#endif
	NULL,
};

M
Ming Lin 已提交
3227
#define nvme_show_str_function(field)						\
3228 3229 3230 3231
static ssize_t  field##_show(struct device *dev,				\
			    struct device_attribute *attr, char *buf)		\
{										\
        struct nvme_ctrl *ctrl = dev_get_drvdata(dev);				\
C
Christoph Hellwig 已提交
3232 3233
        return sprintf(buf, "%.*s\n",						\
		(int)sizeof(ctrl->subsys->field), ctrl->subsys->field);		\
3234 3235 3236
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

C
Christoph Hellwig 已提交
3237 3238 3239 3240
nvme_show_str_function(model);
nvme_show_str_function(serial);
nvme_show_str_function(firmware_rev);

M
Ming Lin 已提交
3241 3242 3243 3244 3245 3246 3247 3248 3249 3250
#define nvme_show_int_function(field)						\
static ssize_t  field##_show(struct device *dev,				\
			    struct device_attribute *attr, char *buf)		\
{										\
        struct nvme_ctrl *ctrl = dev_get_drvdata(dev);				\
        return sprintf(buf, "%d\n", ctrl->field);	\
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

nvme_show_int_function(cntlid);
3251
nvme_show_int_function(numa_node);
3252 3253
nvme_show_int_function(queue_count);
nvme_show_int_function(sqsize);
3254

M
Ming Lin 已提交
3255 3256 3257 3258 3259 3260
static ssize_t nvme_sysfs_delete(struct device *dev,
				struct device_attribute *attr, const char *buf,
				size_t count)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3261 3262 3263 3264
	/* Can't delete non-created controllers */
	if (!ctrl->created)
		return -EBUSY;

M
Ming Lin 已提交
3265
	if (device_remove_file_self(dev, attr))
3266
		nvme_delete_ctrl_sync(ctrl);
M
Ming Lin 已提交
3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280
	return count;
}
static DEVICE_ATTR(delete_controller, S_IWUSR, NULL, nvme_sysfs_delete);

static ssize_t nvme_sysfs_show_transport(struct device *dev,
					 struct device_attribute *attr,
					 char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

	return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->ops->name);
}
static DEVICE_ATTR(transport, S_IRUGO, nvme_sysfs_show_transport, NULL);

3281 3282 3283 3284 3285 3286 3287 3288 3289
static ssize_t nvme_sysfs_show_state(struct device *dev,
				     struct device_attribute *attr,
				     char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
	static const char *const state_name[] = {
		[NVME_CTRL_NEW]		= "new",
		[NVME_CTRL_LIVE]	= "live",
		[NVME_CTRL_RESETTING]	= "resetting",
3290
		[NVME_CTRL_CONNECTING]	= "connecting",
3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303
		[NVME_CTRL_DELETING]	= "deleting",
		[NVME_CTRL_DEAD]	= "dead",
	};

	if ((unsigned)ctrl->state < ARRAY_SIZE(state_name) &&
	    state_name[ctrl->state])
		return sprintf(buf, "%s\n", state_name[ctrl->state]);

	return sprintf(buf, "unknown state\n");
}

static DEVICE_ATTR(state, S_IRUGO, nvme_sysfs_show_state, NULL);

M
Ming Lin 已提交
3304 3305 3306 3307 3308 3309
static ssize_t nvme_sysfs_show_subsysnqn(struct device *dev,
					 struct device_attribute *attr,
					 char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

C
Christoph Hellwig 已提交
3310
	return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->subsys->subnqn);
M
Ming Lin 已提交
3311 3312 3313
}
static DEVICE_ATTR(subsysnqn, S_IRUGO, nvme_sysfs_show_subsysnqn, NULL);

3314 3315 3316 3317 3318 3319 3320 3321 3322 3323
static ssize_t nvme_sysfs_show_hostnqn(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

	return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->opts->host->nqn);
}
static DEVICE_ATTR(hostnqn, S_IRUGO, nvme_sysfs_show_hostnqn, NULL);

3324 3325 3326 3327 3328 3329 3330 3331 3332 3333
static ssize_t nvme_sysfs_show_hostid(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

	return snprintf(buf, PAGE_SIZE, "%pU\n", &ctrl->opts->host->id);
}
static DEVICE_ATTR(hostid, S_IRUGO, nvme_sysfs_show_hostid, NULL);

M
Ming Lin 已提交
3334 3335 3336 3337 3338 3339 3340 3341 3342 3343
static ssize_t nvme_sysfs_show_address(struct device *dev,
					 struct device_attribute *attr,
					 char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

	return ctrl->ops->get_address(ctrl, buf, PAGE_SIZE);
}
static DEVICE_ATTR(address, S_IRUGO, nvme_sysfs_show_address, NULL);

3344 3345
static struct attribute *nvme_dev_attrs[] = {
	&dev_attr_reset_controller.attr,
K
Keith Busch 已提交
3346
	&dev_attr_rescan_controller.attr,
3347 3348 3349
	&dev_attr_model.attr,
	&dev_attr_serial.attr,
	&dev_attr_firmware_rev.attr,
M
Ming Lin 已提交
3350
	&dev_attr_cntlid.attr,
M
Ming Lin 已提交
3351 3352 3353 3354
	&dev_attr_delete_controller.attr,
	&dev_attr_transport.attr,
	&dev_attr_subsysnqn.attr,
	&dev_attr_address.attr,
3355
	&dev_attr_state.attr,
3356
	&dev_attr_numa_node.attr,
3357 3358
	&dev_attr_queue_count.attr,
	&dev_attr_sqsize.attr,
3359
	&dev_attr_hostnqn.attr,
3360
	&dev_attr_hostid.attr,
3361 3362 3363
	NULL
};

M
Ming Lin 已提交
3364 3365 3366 3367 3368 3369
static umode_t nvme_dev_attrs_are_visible(struct kobject *kobj,
		struct attribute *a, int n)
{
	struct device *dev = container_of(kobj, struct device, kobj);
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3370 3371 3372 3373
	if (a == &dev_attr_delete_controller.attr && !ctrl->ops->delete_ctrl)
		return 0;
	if (a == &dev_attr_address.attr && !ctrl->ops->get_address)
		return 0;
3374 3375
	if (a == &dev_attr_hostnqn.attr && !ctrl->opts)
		return 0;
3376 3377
	if (a == &dev_attr_hostid.attr && !ctrl->opts)
		return 0;
M
Ming Lin 已提交
3378 3379 3380 3381

	return a->mode;
}

3382
static struct attribute_group nvme_dev_attrs_group = {
M
Ming Lin 已提交
3383 3384
	.attrs		= nvme_dev_attrs,
	.is_visible	= nvme_dev_attrs_are_visible,
3385 3386 3387 3388 3389 3390 3391
};

static const struct attribute_group *nvme_dev_attr_groups[] = {
	&nvme_dev_attrs_group,
	NULL,
};

3392
static struct nvme_ns_head *nvme_find_ns_head(struct nvme_subsystem *subsys,
C
Christoph Hellwig 已提交
3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423
		unsigned nsid)
{
	struct nvme_ns_head *h;

	lockdep_assert_held(&subsys->lock);

	list_for_each_entry(h, &subsys->nsheads, entry) {
		if (h->ns_id == nsid && kref_get_unless_zero(&h->ref))
			return h;
	}

	return NULL;
}

static int __nvme_check_ids(struct nvme_subsystem *subsys,
		struct nvme_ns_head *new)
{
	struct nvme_ns_head *h;

	lockdep_assert_held(&subsys->lock);

	list_for_each_entry(h, &subsys->nsheads, entry) {
		if (nvme_ns_ids_valid(&new->ids) &&
		    nvme_ns_ids_equal(&new->ids, &h->ids))
			return -EINVAL;
	}

	return 0;
}

static struct nvme_ns_head *nvme_alloc_ns_head(struct nvme_ctrl *ctrl,
K
Keith Busch 已提交
3424
		unsigned nsid, struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
3425 3426
{
	struct nvme_ns_head *head;
3427
	size_t size = sizeof(*head);
C
Christoph Hellwig 已提交
3428 3429
	int ret = -ENOMEM;

3430 3431 3432 3433 3434
#ifdef CONFIG_NVME_MULTIPATH
	size += num_possible_nodes() * sizeof(struct nvme_ns *);
#endif

	head = kzalloc(size, GFP_KERNEL);
C
Christoph Hellwig 已提交
3435 3436 3437 3438 3439 3440 3441
	if (!head)
		goto out;
	ret = ida_simple_get(&ctrl->subsys->ns_ida, 1, 0, GFP_KERNEL);
	if (ret < 0)
		goto out_free_head;
	head->instance = ret;
	INIT_LIST_HEAD(&head->list);
3442 3443 3444
	ret = init_srcu_struct(&head->srcu);
	if (ret)
		goto out_ida_remove;
C
Christoph Hellwig 已提交
3445 3446
	head->subsys = ctrl->subsys;
	head->ns_id = nsid;
3447
	head->ids = *ids;
C
Christoph Hellwig 已提交
3448 3449 3450 3451 3452 3453 3454 3455 3456
	kref_init(&head->ref);

	ret = __nvme_check_ids(ctrl->subsys, head);
	if (ret) {
		dev_err(ctrl->device,
			"duplicate IDs for nsid %d\n", nsid);
		goto out_cleanup_srcu;
	}

3457 3458 3459 3460
	ret = nvme_mpath_alloc_disk(ctrl, head);
	if (ret)
		goto out_cleanup_srcu;

C
Christoph Hellwig 已提交
3461
	list_add_tail(&head->entry, &ctrl->subsys->nsheads);
3462 3463 3464

	kref_get(&ctrl->subsys->ref);

C
Christoph Hellwig 已提交
3465 3466 3467
	return head;
out_cleanup_srcu:
	cleanup_srcu_struct(&head->srcu);
3468
out_ida_remove:
C
Christoph Hellwig 已提交
3469 3470 3471 3472
	ida_simple_remove(&ctrl->subsys->ns_ida, head->instance);
out_free_head:
	kfree(head);
out:
3473 3474
	if (ret > 0)
		ret = blk_status_to_errno(nvme_error_status(ret));
C
Christoph Hellwig 已提交
3475 3476 3477 3478
	return ERR_PTR(ret);
}

static int nvme_init_ns_head(struct nvme_ns *ns, unsigned nsid,
3479
		struct nvme_id_ns *id)
C
Christoph Hellwig 已提交
3480 3481 3482 3483
{
	struct nvme_ctrl *ctrl = ns->ctrl;
	bool is_shared = id->nmic & (1 << 0);
	struct nvme_ns_head *head = NULL;
3484
	struct nvme_ns_ids ids;
C
Christoph Hellwig 已提交
3485 3486
	int ret = 0;

3487 3488 3489 3490
	ret = nvme_report_ns_ids(ctrl, nsid, id, &ids);
	if (ret)
		goto out;

C
Christoph Hellwig 已提交
3491 3492
	mutex_lock(&ctrl->subsys->lock);
	if (is_shared)
3493
		head = nvme_find_ns_head(ctrl->subsys, nsid);
C
Christoph Hellwig 已提交
3494
	if (!head) {
K
Keith Busch 已提交
3495
		head = nvme_alloc_ns_head(ctrl, nsid, &ids);
C
Christoph Hellwig 已提交
3496 3497 3498 3499 3500 3501 3502 3503 3504 3505
		if (IS_ERR(head)) {
			ret = PTR_ERR(head);
			goto out_unlock;
		}
	} else {
		if (!nvme_ns_ids_equal(&head->ids, &ids)) {
			dev_err(ctrl->device,
				"IDs don't match for shared namespace %d\n",
					nsid);
			ret = -EINVAL;
3506
			nvme_put_ns_head(head);
C
Christoph Hellwig 已提交
3507 3508 3509 3510 3511 3512 3513 3514 3515
			goto out_unlock;
		}
	}

	list_add_tail(&ns->siblings, &head->list);
	ns->head = head;

out_unlock:
	mutex_unlock(&ctrl->subsys->lock);
3516
out:
3517 3518
	if (ret > 0)
		ret = blk_status_to_errno(nvme_error_status(ret));
C
Christoph Hellwig 已提交
3519 3520 3521
	return ret;
}

3522 3523 3524 3525 3526
static int ns_cmp(void *priv, struct list_head *a, struct list_head *b)
{
	struct nvme_ns *nsa = container_of(a, struct nvme_ns, list);
	struct nvme_ns *nsb = container_of(b, struct nvme_ns, list);

C
Christoph Hellwig 已提交
3527
	return nsa->head->ns_id - nsb->head->ns_id;
3528 3529
}

3530
static struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid)
3531
{
3532
	struct nvme_ns *ns, *ret = NULL;
3533

3534
	down_read(&ctrl->namespaces_rwsem);
3535
	list_for_each_entry(ns, &ctrl->namespaces, list) {
C
Christoph Hellwig 已提交
3536
		if (ns->head->ns_id == nsid) {
3537 3538
			if (!kref_get_unless_zero(&ns->kref))
				continue;
3539 3540 3541
			ret = ns;
			break;
		}
C
Christoph Hellwig 已提交
3542
		if (ns->head->ns_id > nsid)
3543 3544
			break;
	}
3545
	up_read(&ctrl->namespaces_rwsem);
3546
	return ret;
3547 3548
}

3549 3550 3551 3552 3553 3554 3555 3556
static int nvme_setup_streams_ns(struct nvme_ctrl *ctrl, struct nvme_ns *ns)
{
	struct streams_directive_params s;
	int ret;

	if (!ctrl->nr_streams)
		return 0;

C
Christoph Hellwig 已提交
3557
	ret = nvme_get_stream_params(ctrl, &s, ns->head->ns_id);
3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574
	if (ret)
		return ret;

	ns->sws = le32_to_cpu(s.sws);
	ns->sgs = le16_to_cpu(s.sgs);

	if (ns->sws) {
		unsigned int bs = 1 << ns->lba_shift;

		blk_queue_io_min(ns->queue, bs * ns->sws);
		if (ns->sgs)
			blk_queue_io_opt(ns->queue, bs * ns->sws * ns->sgs);
	}

	return 0;
}

3575
static void nvme_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid)
3576 3577 3578
{
	struct nvme_ns *ns;
	struct gendisk *disk;
3579 3580
	struct nvme_id_ns *id;
	char disk_name[DISK_NAME_LEN];
3581
	int node = ctrl->numa_node, flags = GENHD_FL_EXT_DEVT, ret;
3582 3583 3584

	ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
	if (!ns)
3585
		return;
3586 3587

	ns->queue = blk_mq_init_queue(ctrl->tagset);
3588
	if (IS_ERR(ns->queue))
C
Christoph Hellwig 已提交
3589
		goto out_free_ns;
3590

3591
	if (ctrl->opts && ctrl->opts->data_digest)
3592 3593 3594
		ns->queue->backing_dev_info->capabilities
			|= BDI_CAP_STABLE_WRITES;

3595
	blk_queue_flag_set(QUEUE_FLAG_NONROT, ns->queue);
3596 3597 3598
	if (ctrl->ops->flags & NVME_F_PCI_P2PDMA)
		blk_queue_flag_set(QUEUE_FLAG_PCI_P2PDMA, ns->queue);

3599 3600 3601 3602 3603 3604 3605
	ns->queue->queuedata = ns;
	ns->ctrl = ctrl;

	kref_init(&ns->kref);
	ns->lba_shift = 9; /* set to a default value for 512 until disk is validated */

	blk_queue_logical_block_size(ns->queue, 1 << ns->lba_shift);
3606
	nvme_set_queue_limits(ctrl, ns->queue);
3607

3608 3609
	ret = nvme_identify_ns(ctrl, nsid, &id);
	if (ret)
3610 3611
		goto out_free_queue;

3612
	if (id->ncap == 0)	/* no namespace (legacy quirk) */
3613 3614
		goto out_free_id;

3615 3616
	ret = nvme_init_ns_head(ns, nsid, id);
	if (ret)
C
Christoph Hellwig 已提交
3617
		goto out_free_id;
3618
	nvme_setup_streams_ns(ctrl, ns);
3619
	nvme_set_disk_name(disk_name, ns, ctrl, &flags);
3620

3621
	disk = alloc_disk_node(0, node);
3622
	if (!disk)
C
Christoph Hellwig 已提交
3623
		goto out_unlink_ns;
3624

3625 3626 3627
	disk->fops = &nvme_fops;
	disk->private_data = ns;
	disk->queue = ns->queue;
3628
	disk->flags = flags;
3629 3630 3631 3632
	memcpy(disk->disk_name, disk_name, DISK_NAME_LEN);
	ns->disk = disk;

	__nvme_revalidate_disk(disk, id);
3633

3634
	if ((ctrl->quirks & NVME_QUIRK_LIGHTNVM) && id->vs[0] == 0x1) {
3635 3636
		ret = nvme_nvm_register(ns, disk_name, node);
		if (ret) {
3637 3638 3639 3640 3641
			dev_warn(ctrl->device, "LightNVM init failure\n");
			goto out_put_disk;
		}
	}

3642
	down_write(&ctrl->namespaces_rwsem);
3643
	list_add_tail(&ns->list, &ctrl->namespaces);
3644
	up_write(&ctrl->namespaces_rwsem);
3645

3646
	nvme_get_ctrl(ctrl);
3647

3648
	device_add_disk(ctrl->device, ns->disk, nvme_ns_id_attr_groups);
3649

C
Christoph Hellwig 已提交
3650
	nvme_mpath_add_disk(ns, id);
3651
	nvme_fault_inject_init(&ns->fault_inject, ns->disk->disk_name);
C
Christoph Hellwig 已提交
3652 3653
	kfree(id);

3654
	return;
3655
 out_put_disk:
3656 3657
	/* prevent double queue cleanup */
	ns->disk->queue = NULL;
3658
	put_disk(ns->disk);
C
Christoph Hellwig 已提交
3659 3660 3661
 out_unlink_ns:
	mutex_lock(&ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
3662 3663
	if (list_empty(&ns->head->list))
		list_del_init(&ns->head->entry);
C
Christoph Hellwig 已提交
3664
	mutex_unlock(&ctrl->subsys->lock);
3665
	nvme_put_ns_head(ns->head);
3666 3667
 out_free_id:
	kfree(id);
3668 3669 3670 3671 3672 3673 3674 3675
 out_free_queue:
	blk_cleanup_queue(ns->queue);
 out_free_ns:
	kfree(ns);
}

static void nvme_ns_remove(struct nvme_ns *ns)
{
3676 3677
	if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
		return;
3678

3679
	nvme_fault_inject_fini(&ns->fault_inject);
3680 3681 3682

	mutex_lock(&ns->ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
3683 3684
	if (list_empty(&ns->head->list))
		list_del_init(&ns->head->entry);
3685
	mutex_unlock(&ns->ctrl->subsys->lock);
3686

3687 3688 3689 3690
	synchronize_rcu(); /* guarantee not available in head->list */
	nvme_mpath_clear_current_path(ns);
	synchronize_srcu(&ns->head->srcu); /* wait for concurrent submissions */

3691
	if (ns->disk && ns->disk->flags & GENHD_FL_UP) {
3692 3693
		del_gendisk(ns->disk);
		blk_cleanup_queue(ns->queue);
3694 3695
		if (blk_get_integrity(ns->disk))
			blk_integrity_unregister(ns->disk);
3696
	}
3697

3698
	down_write(&ns->ctrl->namespaces_rwsem);
3699
	list_del_init(&ns->list);
3700
	up_write(&ns->ctrl->namespaces_rwsem);
3701

3702
	nvme_mpath_check_last_path(ns);
3703 3704 3705
	nvme_put_ns(ns);
}

3706 3707 3708 3709 3710 3711 3712 3713 3714 3715
static void nvme_ns_remove_by_nsid(struct nvme_ctrl *ctrl, u32 nsid)
{
	struct nvme_ns *ns = nvme_find_get_ns(ctrl, nsid);

	if (ns) {
		nvme_ns_remove(ns);
		nvme_put_ns(ns);
	}
}

3716 3717 3718 3719
static void nvme_validate_ns(struct nvme_ctrl *ctrl, unsigned nsid)
{
	struct nvme_ns *ns;

3720
	ns = nvme_find_get_ns(ctrl, nsid);
3721
	if (ns) {
3722
		if (ns->disk && revalidate_disk(ns->disk))
3723
			nvme_ns_remove(ns);
3724
		nvme_put_ns(ns);
3725 3726 3727 3728
	} else
		nvme_alloc_ns(ctrl, nsid);
}

3729 3730 3731 3732
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					unsigned nsid)
{
	struct nvme_ns *ns, *next;
3733
	LIST_HEAD(rm_list);
3734

3735
	down_write(&ctrl->namespaces_rwsem);
3736
	list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) {
3737
		if (ns->head->ns_id > nsid || test_bit(NVME_NS_DEAD, &ns->flags))
3738
			list_move_tail(&ns->list, &rm_list);
3739
	}
3740
	up_write(&ctrl->namespaces_rwsem);
3741 3742 3743 3744

	list_for_each_entry_safe(ns, next, &rm_list, list)
		nvme_ns_remove(ns);

3745 3746
}

3747
static int nvme_scan_ns_list(struct nvme_ctrl *ctrl)
3748
{
3749
	const int nr_entries = NVME_IDENTIFY_DATA_SIZE / sizeof(__le32);
3750
	__le32 *ns_list;
3751 3752
	u32 prev = 0;
	int ret = 0, i;
3753

3754 3755 3756
	if (nvme_ctrl_limited_cns(ctrl))
		return -EOPNOTSUPP;

3757
	ns_list = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
3758 3759 3760
	if (!ns_list)
		return -ENOMEM;

3761
	for (;;) {
3762 3763
		ret = nvme_identify_ns_list(ctrl, prev, ns_list);
		if (ret)
3764
			goto free;
3765

3766
		for (i = 0; i < nr_entries; i++) {
3767
			u32 nsid = le32_to_cpu(ns_list[i]);
3768

3769 3770
			if (!nsid)	/* end of the list? */
				goto out;
3771
			nvme_validate_ns(ctrl, nsid);
3772 3773
			while (++prev < nsid)
				nvme_ns_remove_by_nsid(ctrl, prev);
3774 3775 3776
		}
	}
 out:
3777 3778
	nvme_remove_invalid_namespaces(ctrl, prev);
 free:
3779 3780 3781 3782
	kfree(ns_list);
	return ret;
}

3783
static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl)
3784
{
3785 3786 3787 3788 3789 3790 3791
	struct nvme_id_ctrl *id;
	u32 nn, i;

	if (nvme_identify_ctrl(ctrl, &id))
		return;
	nn = le32_to_cpu(id->nn);
	kfree(id);
3792

3793 3794 3795
	for (i = 1; i <= nn; i++)
		nvme_validate_ns(ctrl, i);

3796
	nvme_remove_invalid_namespaces(ctrl, nn);
3797 3798
}

3799
static void nvme_clear_changed_ns_log(struct nvme_ctrl *ctrl)
3800 3801 3802
{
	size_t log_size = NVME_MAX_CHANGED_NAMESPACES * sizeof(__le32);
	__le32 *log;
3803
	int error;
3804 3805 3806

	log = kzalloc(log_size, GFP_KERNEL);
	if (!log)
3807
		return;
3808

3809 3810 3811 3812 3813 3814
	/*
	 * We need to read the log to clear the AEN, but we don't want to rely
	 * on it for the changed namespace information as userspace could have
	 * raced with us in reading the log page, which could cause us to miss
	 * updates.
	 */
3815 3816
	error = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CHANGED_NS, 0, log,
			log_size, 0);
3817
	if (error)
3818 3819 3820 3821 3822 3823
		dev_warn(ctrl->device,
			"reading changed ns log failed: %d\n", error);

	kfree(log);
}

3824
static void nvme_scan_work(struct work_struct *work)
3825
{
3826 3827
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, scan_work);
3828

K
Keith Busch 已提交
3829 3830
	/* No tagset on a live ctrl means IO queues could not created */
	if (ctrl->state != NVME_CTRL_LIVE || !ctrl->tagset)
3831 3832
		return;

D
Dan Carpenter 已提交
3833
	if (test_and_clear_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events)) {
3834
		dev_info(ctrl->device, "rescanning namespaces.\n");
3835
		nvme_clear_changed_ns_log(ctrl);
3836 3837
	}

3838
	mutex_lock(&ctrl->scan_lock);
3839 3840
	if (nvme_scan_ns_list(ctrl) != 0)
		nvme_scan_ns_sequential(ctrl);
3841
	mutex_unlock(&ctrl->scan_lock);
3842

3843
	down_write(&ctrl->namespaces_rwsem);
3844
	list_sort(NULL, &ctrl->namespaces, ns_cmp);
3845
	up_write(&ctrl->namespaces_rwsem);
3846
}
3847

3848 3849 3850 3851 3852
/*
 * This function iterates the namespace list unlocked to allow recovery from
 * controller failure. It is up to the caller to ensure the namespace list is
 * not modified by scan work while this function is executing.
 */
3853 3854 3855
void nvme_remove_namespaces(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns, *next;
3856
	LIST_HEAD(ns_list);
3857

3858 3859 3860 3861 3862 3863 3864
	/*
	 * make sure to requeue I/O to all namespaces as these
	 * might result from the scan itself and must complete
	 * for the scan_work to make progress
	 */
	nvme_mpath_clear_ctrl_paths(ctrl);

3865 3866 3867
	/* prevent racing with ns scanning */
	flush_work(&ctrl->scan_work);

3868 3869 3870 3871 3872 3873 3874 3875 3876
	/*
	 * The dead states indicates the controller was not gracefully
	 * disconnected. In that case, we won't be able to flush any data while
	 * removing the namespaces' disks; fail all the queues now to avoid
	 * potentially having to clean up the failed sync later.
	 */
	if (ctrl->state == NVME_CTRL_DEAD)
		nvme_kill_queues(ctrl);

3877
	down_write(&ctrl->namespaces_rwsem);
3878
	list_splice_init(&ctrl->namespaces, &ns_list);
3879
	up_write(&ctrl->namespaces_rwsem);
3880 3881

	list_for_each_entry_safe(ns, next, &ns_list, list)
3882 3883
		nvme_ns_remove(ns);
}
3884
EXPORT_SYMBOL_GPL(nvme_remove_namespaces);
3885

3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912
static int nvme_class_uevent(struct device *dev, struct kobj_uevent_env *env)
{
	struct nvme_ctrl *ctrl =
		container_of(dev, struct nvme_ctrl, ctrl_device);
	struct nvmf_ctrl_options *opts = ctrl->opts;
	int ret;

	ret = add_uevent_var(env, "NVME_TRTYPE=%s", ctrl->ops->name);
	if (ret)
		return ret;

	if (opts) {
		ret = add_uevent_var(env, "NVME_TRADDR=%s", opts->traddr);
		if (ret)
			return ret;

		ret = add_uevent_var(env, "NVME_TRSVCID=%s",
				opts->trsvcid ?: "none");
		if (ret)
			return ret;

		ret = add_uevent_var(env, "NVME_HOST_TRADDR=%s",
				opts->host_traddr ?: "none");
	}
	return ret;
}

3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928
static void nvme_aen_uevent(struct nvme_ctrl *ctrl)
{
	char *envp[2] = { NULL, NULL };
	u32 aen_result = ctrl->aen_result;

	ctrl->aen_result = 0;
	if (!aen_result)
		return;

	envp[0] = kasprintf(GFP_KERNEL, "NVME_AEN=%#08x", aen_result);
	if (!envp[0])
		return;
	kobject_uevent_env(&ctrl->device->kobj, KOBJ_CHANGE, envp);
	kfree(envp[0]);
}

3929 3930 3931 3932 3933
static void nvme_async_event_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, async_event_work);

3934
	nvme_aen_uevent(ctrl);
3935
	ctrl->ops->submit_async_event(ctrl);
3936 3937
}

3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959
static bool nvme_ctrl_pp_status(struct nvme_ctrl *ctrl)
{

	u32 csts;

	if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts))
		return false;

	if (csts == ~0)
		return false;

	return ((ctrl->ctrl_config & NVME_CC_ENABLE) && (csts & NVME_CSTS_PP));
}

static void nvme_get_fw_slot_info(struct nvme_ctrl *ctrl)
{
	struct nvme_fw_slot_info_log *log;

	log = kmalloc(sizeof(*log), GFP_KERNEL);
	if (!log)
		return;

3960
	if (nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_FW_SLOT, 0, log,
3961 3962
			sizeof(*log), 0))
		dev_warn(ctrl->device, "Get FW SLOT INFO log error\n");
3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983
	kfree(log);
}

static void nvme_fw_act_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl = container_of(work,
				struct nvme_ctrl, fw_act_work);
	unsigned long fw_act_timeout;

	if (ctrl->mtfa)
		fw_act_timeout = jiffies +
				msecs_to_jiffies(ctrl->mtfa * 100);
	else
		fw_act_timeout = jiffies +
				msecs_to_jiffies(admin_timeout * 1000);

	nvme_stop_queues(ctrl);
	while (nvme_ctrl_pp_status(ctrl)) {
		if (time_after(jiffies, fw_act_timeout)) {
			dev_warn(ctrl->device,
				"Fw activation timeout, reset controller\n");
3984 3985
			nvme_try_sched_reset(ctrl);
			return;
3986 3987 3988 3989
		}
		msleep(100);
	}

3990
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE))
3991 3992 3993
		return;

	nvme_start_queues(ctrl);
3994
	/* read FW slot information to clear the AER */
3995 3996 3997
	nvme_get_fw_slot_info(ctrl);
}

3998 3999
static void nvme_handle_aen_notice(struct nvme_ctrl *ctrl, u32 result)
{
4000 4001
	u32 aer_notice_type = (result & 0xff00) >> 8;

4002 4003
	trace_nvme_async_event(ctrl, aer_notice_type);

4004
	switch (aer_notice_type) {
4005
	case NVME_AER_NOTICE_NS_CHANGED:
D
Dan Carpenter 已提交
4006
		set_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events);
4007 4008 4009
		nvme_queue_scan(ctrl);
		break;
	case NVME_AER_NOTICE_FW_ACT_STARTING:
4010 4011 4012 4013 4014 4015 4016
		/*
		 * We are (ab)using the RESETTING state to prevent subsequent
		 * recovery actions from interfering with the controller's
		 * firmware activation.
		 */
		if (nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
			queue_work(nvme_wq, &ctrl->fw_act_work);
4017
		break;
C
Christoph Hellwig 已提交
4018 4019 4020 4021 4022 4023 4024
#ifdef CONFIG_NVME_MULTIPATH
	case NVME_AER_NOTICE_ANA:
		if (!ctrl->ana_log_buf)
			break;
		queue_work(nvme_wq, &ctrl->ana_work);
		break;
#endif
4025 4026 4027
	case NVME_AER_NOTICE_DISC_CHANGED:
		ctrl->aen_result = result;
		break;
4028 4029 4030 4031 4032
	default:
		dev_warn(ctrl->device, "async event result %08x\n", result);
	}
}

4033
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
4034
		volatile union nvme_result *res)
4035
{
4036
	u32 result = le32_to_cpu(res->u32);
4037
	u32 aer_type = result & 0x07;
4038

4039
	if (le16_to_cpu(status) >> 1 != NVME_SC_SUCCESS)
4040 4041
		return;

4042
	switch (aer_type) {
4043 4044 4045
	case NVME_AER_NOTICE:
		nvme_handle_aen_notice(ctrl, result);
		break;
4046 4047 4048 4049
	case NVME_AER_ERROR:
	case NVME_AER_SMART:
	case NVME_AER_CSS:
	case NVME_AER_VS:
4050
		trace_nvme_async_event(ctrl, aer_type);
4051
		ctrl->aen_result = result;
4052 4053 4054
		break;
	default:
		break;
4055
	}
4056
	queue_work(nvme_wq, &ctrl->async_event_work);
4057 4058
}
EXPORT_SYMBOL_GPL(nvme_complete_async_event);
4059

4060
void nvme_stop_ctrl(struct nvme_ctrl *ctrl)
4061
{
C
Christoph Hellwig 已提交
4062
	nvme_mpath_stop(ctrl);
4063
	nvme_stop_keep_alive(ctrl);
4064
	flush_work(&ctrl->async_event_work);
4065
	cancel_work_sync(&ctrl->fw_act_work);
4066 4067 4068 4069 4070 4071 4072 4073
}
EXPORT_SYMBOL_GPL(nvme_stop_ctrl);

void nvme_start_ctrl(struct nvme_ctrl *ctrl)
{
	if (ctrl->kato)
		nvme_start_keep_alive(ctrl);

4074 4075
	nvme_enable_aen(ctrl);

4076 4077 4078 4079
	if (ctrl->queue_count > 1) {
		nvme_queue_scan(ctrl);
		nvme_start_queues(ctrl);
	}
4080
	ctrl->created = true;
4081 4082
}
EXPORT_SYMBOL_GPL(nvme_start_ctrl);
4083

4084 4085
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl)
{
4086
	nvme_fault_inject_fini(&ctrl->fault_inject);
4087
	dev_pm_qos_hide_latency_tolerance(ctrl->device);
4088
	cdev_device_del(&ctrl->cdev, ctrl->device);
4089
	nvme_put_ctrl(ctrl);
4090
}
4091
EXPORT_SYMBOL_GPL(nvme_uninit_ctrl);
4092

4093
static void nvme_free_ctrl(struct device *dev)
4094
{
4095 4096
	struct nvme_ctrl *ctrl =
		container_of(dev, struct nvme_ctrl, ctrl_device);
C
Christoph Hellwig 已提交
4097
	struct nvme_subsystem *subsys = ctrl->subsys;
4098

4099 4100 4101
	if (subsys && ctrl->instance != subsys->instance)
		ida_simple_remove(&nvme_instance_ida, ctrl->instance);

4102
	kfree(ctrl->effects);
C
Christoph Hellwig 已提交
4103
	nvme_mpath_uninit(ctrl);
S
Sagi Grimberg 已提交
4104
	__free_page(ctrl->discard_page);
4105

C
Christoph Hellwig 已提交
4106
	if (subsys) {
4107
		mutex_lock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4108 4109
		list_del(&ctrl->subsys_entry);
		sysfs_remove_link(&subsys->dev.kobj, dev_name(ctrl->device));
4110
		mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4111
	}
4112 4113 4114

	ctrl->ops->free_ctrl(ctrl);

C
Christoph Hellwig 已提交
4115 4116
	if (subsys)
		nvme_put_subsystem(subsys);
4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128
}

/*
 * Initialize a NVMe controller structures.  This needs to be called during
 * earliest initialization so that we have the initialized structured around
 * during probing.
 */
int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
		const struct nvme_ctrl_ops *ops, unsigned long quirks)
{
	int ret;

4129 4130
	ctrl->state = NVME_CTRL_NEW;
	spin_lock_init(&ctrl->lock);
4131
	mutex_init(&ctrl->scan_lock);
4132
	INIT_LIST_HEAD(&ctrl->namespaces);
4133
	init_rwsem(&ctrl->namespaces_rwsem);
4134 4135 4136
	ctrl->dev = dev;
	ctrl->ops = ops;
	ctrl->quirks = quirks;
4137
	INIT_WORK(&ctrl->scan_work, nvme_scan_work);
4138
	INIT_WORK(&ctrl->async_event_work, nvme_async_event_work);
4139
	INIT_WORK(&ctrl->fw_act_work, nvme_fw_act_work);
4140
	INIT_WORK(&ctrl->delete_work, nvme_delete_ctrl_work);
4141
	init_waitqueue_head(&ctrl->state_wq);
4142

4143 4144 4145 4146
	INIT_DELAYED_WORK(&ctrl->ka_work, nvme_keep_alive_work);
	memset(&ctrl->ka_cmd, 0, sizeof(ctrl->ka_cmd));
	ctrl->ka_cmd.common.opcode = nvme_admin_keep_alive;

4147 4148 4149 4150 4151 4152 4153 4154
	BUILD_BUG_ON(NVME_DSM_MAX_RANGES * sizeof(struct nvme_dsm_range) >
			PAGE_SIZE);
	ctrl->discard_page = alloc_page(GFP_KERNEL);
	if (!ctrl->discard_page) {
		ret = -ENOMEM;
		goto out;
	}

4155 4156
	ret = ida_simple_get(&nvme_instance_ida, 0, 0, GFP_KERNEL);
	if (ret < 0)
4157
		goto out;
4158
	ctrl->instance = ret;
4159

4160 4161
	device_initialize(&ctrl->ctrl_device);
	ctrl->device = &ctrl->ctrl_device;
4162
	ctrl->device->devt = MKDEV(MAJOR(nvme_chr_devt), ctrl->instance);
4163 4164 4165 4166 4167 4168 4169
	ctrl->device->class = nvme_class;
	ctrl->device->parent = ctrl->dev;
	ctrl->device->groups = nvme_dev_attr_groups;
	ctrl->device->release = nvme_free_ctrl;
	dev_set_drvdata(ctrl->device, ctrl);
	ret = dev_set_name(ctrl->device, "nvme%d", ctrl->instance);
	if (ret)
4170 4171
		goto out_release_instance;

4172
	nvme_get_ctrl(ctrl);
4173 4174 4175
	cdev_init(&ctrl->cdev, &nvme_dev_fops);
	ctrl->cdev.owner = ops->module;
	ret = cdev_device_add(&ctrl->cdev, ctrl->device);
4176 4177
	if (ret)
		goto out_free_name;
4178

4179 4180 4181 4182 4183 4184 4185 4186
	/*
	 * Initialize latency tolerance controls.  The sysfs files won't
	 * be visible to userspace unless the device actually supports APST.
	 */
	ctrl->device->power.set_latency_tolerance = nvme_set_latency_tolerance;
	dev_pm_qos_update_user_latency_tolerance(ctrl->device,
		min(default_ps_max_latency_us, (unsigned long)S32_MAX));

4187 4188
	nvme_fault_inject_init(&ctrl->fault_inject, dev_name(ctrl->device));

4189
	return 0;
4190
out_free_name:
4191
	nvme_put_ctrl(ctrl);
4192
	kfree_const(ctrl->device->kobj.name);
4193
out_release_instance:
4194
	ida_simple_remove(&nvme_instance_ida, ctrl->instance);
4195
out:
4196 4197
	if (ctrl->discard_page)
		__free_page(ctrl->discard_page);
4198 4199
	return ret;
}
4200
EXPORT_SYMBOL_GPL(nvme_init_ctrl);
4201

4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212
/**
 * nvme_kill_queues(): Ends all namespace queues
 * @ctrl: the dead controller that needs to end
 *
 * Call this function when the driver determines it is unable to get the
 * controller in a state capable of servicing IO.
 */
void nvme_kill_queues(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

4213
	down_read(&ctrl->namespaces_rwsem);
M
Ming Lei 已提交
4214

4215
	/* Forcibly unquiesce queues to avoid blocking dispatch */
I
Igor Konopko 已提交
4216
	if (ctrl->admin_q && !blk_queue_dying(ctrl->admin_q))
4217
		blk_mq_unquiesce_queue(ctrl->admin_q);
4218

4219 4220
	list_for_each_entry(ns, &ctrl->namespaces, list)
		nvme_set_queue_dying(ns);
4221

4222
	up_read(&ctrl->namespaces_rwsem);
4223
}
4224
EXPORT_SYMBOL_GPL(nvme_kill_queues);
4225

K
Keith Busch 已提交
4226 4227 4228 4229
void nvme_unfreeze(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

4230
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4231 4232
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_unfreeze_queue(ns->queue);
4233
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4234 4235 4236 4237 4238 4239 4240
}
EXPORT_SYMBOL_GPL(nvme_unfreeze);

void nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout)
{
	struct nvme_ns *ns;

4241
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4242 4243 4244 4245 4246
	list_for_each_entry(ns, &ctrl->namespaces, list) {
		timeout = blk_mq_freeze_queue_wait_timeout(ns->queue, timeout);
		if (timeout <= 0)
			break;
	}
4247
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4248 4249 4250 4251 4252 4253 4254
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze_timeout);

void nvme_wait_freeze(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

4255
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4256 4257
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_freeze_queue_wait(ns->queue);
4258
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4259 4260 4261 4262 4263 4264 4265
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze);

void nvme_start_freeze(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

4266
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4267
	list_for_each_entry(ns, &ctrl->namespaces, list)
4268
		blk_freeze_queue_start(ns->queue);
4269
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4270 4271 4272
}
EXPORT_SYMBOL_GPL(nvme_start_freeze);

4273
void nvme_stop_queues(struct nvme_ctrl *ctrl)
4274 4275 4276
{
	struct nvme_ns *ns;

4277
	down_read(&ctrl->namespaces_rwsem);
4278
	list_for_each_entry(ns, &ctrl->namespaces, list)
4279
		blk_mq_quiesce_queue(ns->queue);
4280
	up_read(&ctrl->namespaces_rwsem);
4281
}
4282
EXPORT_SYMBOL_GPL(nvme_stop_queues);
4283

4284
void nvme_start_queues(struct nvme_ctrl *ctrl)
4285 4286 4287
{
	struct nvme_ns *ns;

4288
	down_read(&ctrl->namespaces_rwsem);
4289
	list_for_each_entry(ns, &ctrl->namespaces, list)
4290
		blk_mq_unquiesce_queue(ns->queue);
4291
	up_read(&ctrl->namespaces_rwsem);
4292
}
4293
EXPORT_SYMBOL_GPL(nvme_start_queues);
4294

K
Keith Busch 已提交
4295 4296 4297 4298 4299 4300 4301 4302 4303

void nvme_sync_queues(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

	down_read(&ctrl->namespaces_rwsem);
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_sync_queue(ns->queue);
	up_read(&ctrl->namespaces_rwsem);
4304 4305 4306

	if (ctrl->admin_q)
		blk_sync_queue(ctrl->admin_q);
K
Keith Busch 已提交
4307 4308 4309
}
EXPORT_SYMBOL_GPL(nvme_sync_queues);

4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334
/*
 * Check we didn't inadvertently grow the command structure sizes:
 */
static inline void _nvme_check_size(void)
{
	BUILD_BUG_ON(sizeof(struct nvme_common_command) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_rw_command) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_identify) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_features) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_download_firmware) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_format_cmd) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_dsm_cmd) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_write_zeroes_cmd) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_abort_cmd) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_get_log_page_command) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_command) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl) != NVME_IDENTIFY_DATA_SIZE);
	BUILD_BUG_ON(sizeof(struct nvme_id_ns) != NVME_IDENTIFY_DATA_SIZE);
	BUILD_BUG_ON(sizeof(struct nvme_lba_range_type) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_smart_log) != 512);
	BUILD_BUG_ON(sizeof(struct nvme_dbbuf) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_directive_cmd) != 64);
}


4335
static int __init nvme_core_init(void)
4336
{
4337
	int result = -ENOMEM;
4338

4339 4340
	_nvme_check_size();

4341 4342 4343
	nvme_wq = alloc_workqueue("nvme-wq",
			WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0);
	if (!nvme_wq)
4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354
		goto out;

	nvme_reset_wq = alloc_workqueue("nvme-reset-wq",
			WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0);
	if (!nvme_reset_wq)
		goto destroy_wq;

	nvme_delete_wq = alloc_workqueue("nvme-delete-wq",
			WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0);
	if (!nvme_delete_wq)
		goto destroy_reset_wq;
4355

4356
	result = alloc_chrdev_region(&nvme_chr_devt, 0, NVME_MINORS, "nvme");
4357
	if (result < 0)
4358
		goto destroy_delete_wq;
4359 4360 4361 4362 4363 4364

	nvme_class = class_create(THIS_MODULE, "nvme");
	if (IS_ERR(nvme_class)) {
		result = PTR_ERR(nvme_class);
		goto unregister_chrdev;
	}
4365
	nvme_class->dev_uevent = nvme_class_uevent;
4366

C
Christoph Hellwig 已提交
4367 4368 4369 4370 4371
	nvme_subsys_class = class_create(THIS_MODULE, "nvme-subsystem");
	if (IS_ERR(nvme_subsys_class)) {
		result = PTR_ERR(nvme_subsys_class);
		goto destroy_class;
	}
4372
	return 0;
4373

C
Christoph Hellwig 已提交
4374 4375
destroy_class:
	class_destroy(nvme_class);
4376
unregister_chrdev:
4377
	unregister_chrdev_region(nvme_chr_devt, NVME_MINORS);
4378 4379 4380 4381
destroy_delete_wq:
	destroy_workqueue(nvme_delete_wq);
destroy_reset_wq:
	destroy_workqueue(nvme_reset_wq);
4382 4383
destroy_wq:
	destroy_workqueue(nvme_wq);
4384
out:
4385
	return result;
4386 4387
}

4388
static void __exit nvme_core_exit(void)
4389
{
C
Christoph Hellwig 已提交
4390
	class_destroy(nvme_subsys_class);
4391
	class_destroy(nvme_class);
4392
	unregister_chrdev_region(nvme_chr_devt, NVME_MINORS);
4393 4394
	destroy_workqueue(nvme_delete_wq);
	destroy_workqueue(nvme_reset_wq);
4395
	destroy_workqueue(nvme_wq);
M
Max Gurtovoy 已提交
4396
	ida_destroy(&nvme_instance_ida);
4397
}
4398 4399 4400 4401 4402

MODULE_LICENSE("GPL");
MODULE_VERSION("1.0");
module_init(nvme_core_init);
module_exit(nvme_core_exit);