core.c 124.7 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
#include <linux/pr.h>
#include <linux/ptrace.h>
#include <linux/nvme_ioctl.h>
22
#include <linux/pm_qos.h>
23
#include <asm/unaligned.h>
24 25

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

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

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

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

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

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

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

51
static unsigned long default_ps_max_latency_us = 100000;
52 53 54 55
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");

56 57 58 59
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");

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

64 65 66 67 68
/*
 * 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
 *
69 70
 * nvme_wq will host works such as scan, aen handling, fw activation,
 * keep-alive, periodic reconnects etc. nvme_reset_wq
71 72 73 74
 * 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.
 */
75 76 77
struct workqueue_struct *nvme_wq;
EXPORT_SYMBOL_GPL(nvme_wq);

78 79 80 81 82 83
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 已提交
84 85
static LIST_HEAD(nvme_subsystems);
static DEFINE_MUTEX(nvme_subsystems_lock);
86

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

92
static void nvme_put_subsystem(struct nvme_subsystem *subsys);
93 94 95
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					   unsigned nsid);

96 97 98 99 100 101 102 103
/*
 * Prepare a queue for teardown.
 *
 * This must forcibly unquiesce queues to avoid blocking dispatch, and only set
 * the capacity to 0 after that to avoid blocking dispatchers that may be
 * holding bd_butex.  This will end buffered writers dirtying pages that can't
 * be synced.
 */
104 105
static void nvme_set_queue_dying(struct nvme_ns *ns)
{
C
Christoph Hellwig 已提交
106
	if (test_and_set_bit(NVME_NS_DEAD, &ns->flags))
107
		return;
108

109 110
	blk_set_queue_dying(ns->queue);
	blk_mq_unquiesce_queue(ns->queue);
111

112
	set_capacity_and_notify(ns->disk, 0);
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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
static void nvme_failfast_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl = container_of(to_delayed_work(work),
			struct nvme_ctrl, failfast_work);

	if (ctrl->state != NVME_CTRL_CONNECTING)
		return;

	set_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags);
	dev_info(ctrl->device, "failfast expired\n");
	nvme_kick_requeue_lists(ctrl);
}

static inline void nvme_start_failfast_work(struct nvme_ctrl *ctrl)
{
	if (!ctrl->opts || ctrl->opts->fast_io_fail_tmo == -1)
		return;

	schedule_delayed_work(&ctrl->failfast_work,
			      ctrl->opts->fast_io_fail_tmo * HZ);
}

static inline void nvme_stop_failfast_work(struct nvme_ctrl *ctrl)
{
	if (!ctrl->opts)
		return;

	cancel_delayed_work_sync(&ctrl->failfast_work);
	clear_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags);
}


172 173 174 175
int nvme_reset_ctrl(struct nvme_ctrl *ctrl)
{
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
		return -EBUSY;
176
	if (!queue_work(nvme_reset_wq, &ctrl->reset_work))
177 178 179 180 181
		return -EBUSY;
	return 0;
}
EXPORT_SYMBOL_GPL(nvme_reset_ctrl);

182
static int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl)
183 184 185 186
{
	int ret;

	ret = nvme_reset_ctrl(ctrl);
187
	if (!ret) {
188
		flush_work(&ctrl->reset_work);
K
Keith Busch 已提交
189
		if (ctrl->state != NVME_CTRL_LIVE)
190 191 192
			ret = -ENETRESET;
	}

193 194 195
	return ret;
}

196
static void nvme_do_delete_ctrl(struct nvme_ctrl *ctrl)
197
{
198 199 200
	dev_info(ctrl->device,
		 "Removing ctrl: NQN \"%s\"\n", ctrl->opts->subsysnqn);

201
	flush_work(&ctrl->reset_work);
202 203
	nvme_stop_ctrl(ctrl);
	nvme_remove_namespaces(ctrl);
204
	ctrl->ops->delete_ctrl(ctrl);
205
	nvme_uninit_ctrl(ctrl);
206 207
}

208 209 210 211 212 213 214 215
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);
}

216 217 218 219
int nvme_delete_ctrl(struct nvme_ctrl *ctrl)
{
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
		return -EBUSY;
220
	if (!queue_work(nvme_delete_wq, &ctrl->delete_work))
221 222 223 224 225
		return -EBUSY;
	return 0;
}
EXPORT_SYMBOL_GPL(nvme_delete_ctrl);

226
static void nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl)
227 228
{
	/*
229 230
	 * Keep a reference until nvme_do_delete_ctrl() complete,
	 * since ->delete_ctrl can free the controller.
231 232
	 */
	nvme_get_ctrl(ctrl);
233
	if (nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
234
		nvme_do_delete_ctrl(ctrl);
235 236 237
	nvme_put_ctrl(ctrl);
}

238
static blk_status_t nvme_error_status(u16 status)
239
{
240
	switch (status & 0x7ff) {
241
	case NVME_SC_SUCCESS:
242
		return BLK_STS_OK;
243
	case NVME_SC_CAP_EXCEEDED:
244
		return BLK_STS_NOSPC;
245
	case NVME_SC_LBA_RANGE:
246 247
	case NVME_SC_CMD_INTERRUPTED:
	case NVME_SC_NS_NOT_READY:
248 249
		return BLK_STS_TARGET;
	case NVME_SC_BAD_ATTRIBUTES:
250
	case NVME_SC_ONCS_NOT_SUPPORTED:
251 252 253
	case NVME_SC_INVALID_OPCODE:
	case NVME_SC_INVALID_FIELD:
	case NVME_SC_INVALID_NS:
254
		return BLK_STS_NOTSUPP;
255 256 257
	case NVME_SC_WRITE_FAULT:
	case NVME_SC_READ_ERROR:
	case NVME_SC_UNWRITTEN_BLOCK:
258 259
	case NVME_SC_ACCESS_DENIED:
	case NVME_SC_READ_ONLY:
260
	case NVME_SC_COMPARE_FAILED:
261
		return BLK_STS_MEDIUM;
262 263 264 265 266 267 268
	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;
269 270
	case NVME_SC_HOST_PATH_ERROR:
		return BLK_STS_TRANSPORT;
K
Keith Busch 已提交
271 272 273 274
	case NVME_SC_ZONE_TOO_MANY_ACTIVE:
		return BLK_STS_ZONE_ACTIVE_RESOURCE;
	case NVME_SC_ZONE_TOO_MANY_OPEN:
		return BLK_STS_ZONE_OPEN_RESOURCE;
275 276
	default:
		return BLK_STS_IOERR;
277 278 279
	}
}

280 281 282 283 284 285 286
static void nvme_retry_req(struct request *req)
{
	unsigned long delay = 0;
	u16 crd;

	/* The mask and shift result must be <= 3 */
	crd = (nvme_req(req)->status & NVME_SC_CRD) >> 11;
287 288
	if (crd)
		delay = nvme_req(req)->ctrl->crdt[crd - 1] * 100;
289 290 291 292 293 294

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

295 296 297 298 299 300 301
enum nvme_disposition {
	COMPLETE,
	RETRY,
	FAILOVER,
};

static inline enum nvme_disposition nvme_decide_disposition(struct request *req)
302
{
303 304
	if (likely(nvme_req(req)->status == 0))
		return COMPLETE;
305

306 307 308 309
	if (blk_noretry_request(req) ||
	    (nvme_req(req)->status & NVME_SC_DNR) ||
	    nvme_req(req)->retries >= nvme_max_retries)
		return COMPLETE;
310

311
	if (req->cmd_flags & REQ_NVME_MPATH) {
312 313
		if (nvme_is_path_error(nvme_req(req)->status) ||
		    blk_queue_dying(req->q))
314
			return FAILOVER;
315 316 317
	} else {
		if (blk_queue_dying(req->q))
			return COMPLETE;
318
	}
319

320 321
	return RETRY;
}
322

323 324 325
static inline void nvme_end_req(struct request *req)
{
	blk_status_t status = nvme_error_status(nvme_req(req)->status);
326

327 328
	if (IS_ENABLED(CONFIG_BLK_DEV_ZONED) &&
	    req_op(req) == REQ_OP_ZONE_APPEND)
K
Keith Busch 已提交
329 330
		req->__sector = nvme_lba_to_sect(req->q->queuedata,
			le64_to_cpu(nvme_req(req)->result.u64));
H
Hannes Reinecke 已提交
331

332
	nvme_trace_bio_complete(req);
333
	blk_mq_end_request(req, status);
334
}
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355

void nvme_complete_rq(struct request *req)
{
	trace_nvme_complete_rq(req);
	nvme_cleanup_cmd(req);

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

	switch (nvme_decide_disposition(req)) {
	case COMPLETE:
		nvme_end_req(req);
		return;
	case RETRY:
		nvme_retry_req(req);
		return;
	case FAILOVER:
		nvme_failover_req(req);
		return;
	}
}
356 357
EXPORT_SYMBOL_GPL(nvme_complete_rq);

358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
/*
 * Called to unwind from ->queue_rq on a failed command submission so that the
 * multipathing code gets called to potentially failover to another path.
 * The caller needs to unwind all transport specific resource allocations and
 * must return propagate the return value.
 */
blk_status_t nvme_host_path_error(struct request *req)
{
	nvme_req(req)->status = NVME_SC_HOST_PATH_ERROR;
	blk_mq_set_request_complete(req);
	nvme_complete_rq(req);
	return BLK_STS_OK;
}
EXPORT_SYMBOL_GPL(nvme_host_path_error);

373
bool nvme_cancel_request(struct request *req, void *data, bool reserved)
374 375 376 377
{
	dev_dbg_ratelimited(((struct nvme_ctrl *) data)->device,
				"Cancelling I/O %d", req->tag);

378 379 380 381
	/* don't abort one completed request */
	if (blk_mq_request_completed(req))
		return true;

382
	nvme_req(req)->status = NVME_SC_HOST_ABORTED_CMD;
383
	nvme_req(req)->flags |= NVME_REQ_CANCELLED;
384
	blk_mq_complete_request(req);
385
	return true;
386 387 388
}
EXPORT_SYMBOL_GPL(nvme_cancel_request);

C
Chao Leng 已提交
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
void nvme_cancel_tagset(struct nvme_ctrl *ctrl)
{
	if (ctrl->tagset) {
		blk_mq_tagset_busy_iter(ctrl->tagset,
				nvme_cancel_request, ctrl);
		blk_mq_tagset_wait_completed_request(ctrl->tagset);
	}
}
EXPORT_SYMBOL_GPL(nvme_cancel_tagset);

void nvme_cancel_admin_tagset(struct nvme_ctrl *ctrl)
{
	if (ctrl->admin_tagset) {
		blk_mq_tagset_busy_iter(ctrl->admin_tagset,
				nvme_cancel_request, ctrl);
		blk_mq_tagset_wait_completed_request(ctrl->admin_tagset);
	}
}
EXPORT_SYMBOL_GPL(nvme_cancel_admin_tagset);

409 410 411
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state)
{
412
	enum nvme_ctrl_state old_state;
413
	unsigned long flags;
414 415
	bool changed = false;

416
	spin_lock_irqsave(&ctrl->lock, flags);
417 418

	old_state = ctrl->state;
419 420 421
	switch (new_state) {
	case NVME_CTRL_LIVE:
		switch (old_state) {
422
		case NVME_CTRL_NEW:
423
		case NVME_CTRL_RESETTING:
424
		case NVME_CTRL_CONNECTING:
425
			changed = true;
426
			fallthrough;
427 428 429 430 431 432 433
		default:
			break;
		}
		break;
	case NVME_CTRL_RESETTING:
		switch (old_state) {
		case NVME_CTRL_NEW:
434 435
		case NVME_CTRL_LIVE:
			changed = true;
436
			fallthrough;
437 438 439 440
		default:
			break;
		}
		break;
441
	case NVME_CTRL_CONNECTING:
442
		switch (old_state) {
443
		case NVME_CTRL_NEW:
444
		case NVME_CTRL_RESETTING:
445
			changed = true;
446
			fallthrough;
447 448 449 450 451 452 453 454
		default:
			break;
		}
		break;
	case NVME_CTRL_DELETING:
		switch (old_state) {
		case NVME_CTRL_LIVE:
		case NVME_CTRL_RESETTING:
455
		case NVME_CTRL_CONNECTING:
456
			changed = true;
457
			fallthrough;
458 459 460 461
		default:
			break;
		}
		break;
462 463 464 465 466
	case NVME_CTRL_DELETING_NOIO:
		switch (old_state) {
		case NVME_CTRL_DELETING:
		case NVME_CTRL_DEAD:
			changed = true;
467
			fallthrough;
468 469 470 471
		default:
			break;
		}
		break;
472 473 474 475
	case NVME_CTRL_DEAD:
		switch (old_state) {
		case NVME_CTRL_DELETING:
			changed = true;
476
			fallthrough;
477 478 479 480
		default:
			break;
		}
		break;
481 482 483 484
	default:
		break;
	}

485
	if (changed) {
486
		ctrl->state = new_state;
487 488
		wake_up_all(&ctrl->state_wq);
	}
489

490
	spin_unlock_irqrestore(&ctrl->lock, flags);
491 492 493 494 495 496
	if (!changed)
		return false;

	if (ctrl->state == NVME_CTRL_LIVE) {
		if (old_state == NVME_CTRL_CONNECTING)
			nvme_stop_failfast_work(ctrl);
497
		nvme_kick_requeue_lists(ctrl);
498 499 500 501
	} else if (ctrl->state == NVME_CTRL_CONNECTING &&
		old_state == NVME_CTRL_RESETTING) {
		nvme_start_failfast_work(ctrl);
	}
502 503 504 505
	return changed;
}
EXPORT_SYMBOL_GPL(nvme_change_ctrl_state);

506 507 508 509 510 511 512 513 514 515 516 517
/*
 * 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:
518
	case NVME_CTRL_DELETING_NOIO:
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
	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 已提交
540 541 542 543 544
static void nvme_free_ns_head(struct kref *ref)
{
	struct nvme_ns_head *head =
		container_of(ref, struct nvme_ns_head, ref);

545
	nvme_mpath_remove_disk(head);
C
Christoph Hellwig 已提交
546
	ida_simple_remove(&head->subsys->ns_ida, head->instance);
547
	cleanup_srcu_struct(&head->srcu);
548
	nvme_put_subsystem(head->subsys);
C
Christoph Hellwig 已提交
549 550 551 552 553 554 555 556
	kfree(head);
}

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

557 558 559 560
static void nvme_free_ns(struct kref *kref)
{
	struct nvme_ns *ns = container_of(kref, struct nvme_ns, kref);

561 562
	if (ns->ndev)
		nvme_nvm_unregister(ns);
563 564

	put_disk(ns->disk);
C
Christoph Hellwig 已提交
565
	nvme_put_ns_head(ns->head);
566
	nvme_put_ctrl(ns->ctrl);
567 568 569
	kfree(ns);
}

570
void nvme_put_ns(struct nvme_ns *ns)
571 572 573
{
	kref_put(&ns->kref, nvme_free_ns);
}
574
EXPORT_SYMBOL_NS_GPL(nvme_put_ns, NVME_TARGET_PASSTHRU);
575

576 577
static inline void nvme_clear_nvme_request(struct request *req)
{
578 579 580
	struct nvme_command *cmd = nvme_req(req)->cmd;

	memset(cmd, 0, sizeof(*cmd));
581 582 583
	nvme_req(req)->retries = 0;
	nvme_req(req)->flags = 0;
	req->rq_flags |= RQF_DONTPREP;
584 585
}

586
static inline unsigned int nvme_req_op(struct nvme_command *cmd)
587
{
588 589
	return nvme_is_write(cmd) ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN;
}
590

591 592 593
static inline void nvme_init_request(struct request *req,
		struct nvme_command *cmd)
{
594 595 596
	if (req->q->queuedata)
		req->timeout = NVME_IO_TIMEOUT;
	else /* no queuedata implies admin queue */
597
		req->timeout = NVME_ADMIN_TIMEOUT;
598

599 600 601
	/* passthru commands should let the driver set the SGL flags */
	cmd->common.flags &= ~NVME_CMD_SGL_ALL;

602
	req->cmd_flags |= REQ_FAILFAST_DRIVER;
603
	nvme_clear_nvme_request(req);
604
	memcpy(nvme_req(req)->cmd, cmd, sizeof(*cmd));
605
}
606

607 608 609 610 611 612 613 614
struct request *nvme_alloc_request(struct request_queue *q,
		struct nvme_command *cmd, blk_mq_req_flags_t flags)
{
	struct request *req;

	req = blk_mq_alloc_request(q, nvme_req_op(cmd), flags);
	if (!IS_ERR(req))
		nvme_init_request(req, cmd);
615 616
	return req;
}
617
EXPORT_SYMBOL_GPL(nvme_alloc_request);
618

619
static struct request *nvme_alloc_request_qid(struct request_queue *q,
620 621 622 623 624 625 626 627 628 629 630
		struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid)
{
	struct request *req;

	req = blk_mq_alloc_request_hctx(q, nvme_req_op(cmd), flags,
			qid ? qid - 1 : 0);
	if (!IS_ERR(req))
		nvme_init_request(req, cmd);
	return req;
}

631 632 633 634 635 636 637
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 已提交
638
	c.directive.nsid = cpu_to_le32(NVME_NSID_ALL);
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
	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 已提交
667
	c.directive.numd = cpu_to_le32(nvme_bytes_to_numd(sizeof(*s)));
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
	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 已提交
688
	ret = nvme_get_stream_params(ctrl, &s, NVME_NSID_ALL);
689
	if (ret)
690
		goto out_disable_stream;
691 692 693 694 695

	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);
696
		goto out_disable_stream;
697 698
	}

699
	ctrl->nr_streams = min_t(u16, ctrl->nssa, BLK_MAX_WRITE_HINTS - 1);
700 701
	dev_info(ctrl->device, "Using %u streams\n", ctrl->nr_streams);
	return 0;
702 703 704 705

out_disable_stream:
	nvme_disable_streams(ctrl);
	return ret;
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
}

/*
 * 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 已提交
733 734 735 736
static inline void nvme_setup_flush(struct nvme_ns *ns,
		struct nvme_command *cmnd)
{
	cmnd->common.opcode = nvme_cmd_flush;
C
Christoph Hellwig 已提交
737
	cmnd->common.nsid = cpu_to_le32(ns->head->ns_id);
M
Ming Lin 已提交
738 739
}

740
static blk_status_t nvme_setup_discard(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
741 742
		struct nvme_command *cmnd)
{
743
	unsigned short segments = blk_rq_nr_discard_segments(req), n = 0;
M
Ming Lin 已提交
744
	struct nvme_dsm_range *range;
745
	struct bio *bio;
M
Ming Lin 已提交
746

747 748 749 750 751 752 753 754
	/*
	 * 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);
755 756 757 758 759 760 761 762 763 764 765
	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 已提交
766

767
	__rq_for_each_bio(bio, req) {
768
		u64 slba = nvme_sect_to_lba(ns, bio->bi_iter.bi_sector);
769 770
		u32 nlb = bio->bi_iter.bi_size >> ns->lba_shift;

K
Keith Busch 已提交
771 772 773 774 775
		if (n < segments) {
			range[n].cattr = cpu_to_le32(0);
			range[n].nlb = cpu_to_le32(nlb);
			range[n].slba = cpu_to_le64(slba);
		}
776 777 778 779
		n++;
	}

	if (WARN_ON_ONCE(n != segments)) {
780 781 782 783
		if (virt_to_page(range) == ns->ctrl->discard_page)
			clear_bit_unlock(0, &ns->ctrl->discard_page_busy);
		else
			kfree(range);
784
		return BLK_STS_IOERR;
785
	}
M
Ming Lin 已提交
786 787

	cmnd->dsm.opcode = nvme_cmd_dsm;
C
Christoph Hellwig 已提交
788
	cmnd->dsm.nsid = cpu_to_le32(ns->head->ns_id);
789
	cmnd->dsm.nr = cpu_to_le32(segments - 1);
M
Ming Lin 已提交
790 791
	cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);

792 793
	req->special_vec.bv_page = virt_to_page(range);
	req->special_vec.bv_offset = offset_in_page(range);
794
	req->special_vec.bv_len = alloc_size;
795
	req->rq_flags |= RQF_SPECIAL_PAYLOAD;
M
Ming Lin 已提交
796

797
	return BLK_STS_OK;
M
Ming Lin 已提交
798 799
}

800 801 802 803 804 805 806 807 808
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 =
809
		cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
810 811 812 813 814 815
	cmnd->write_zeroes.length =
		cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
	cmnd->write_zeroes.control = 0;
	return BLK_STS_OK;
}

816
static inline blk_status_t nvme_setup_rw(struct nvme_ns *ns,
K
Keith Busch 已提交
817 818
		struct request *req, struct nvme_command *cmnd,
		enum nvme_opcode op)
M
Ming Lin 已提交
819
{
820
	struct nvme_ctrl *ctrl = ns->ctrl;
M
Ming Lin 已提交
821 822 823 824 825 826 827 828 829 830 831
	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;

K
Keith Busch 已提交
832
	cmnd->rw.opcode = op;
C
Christoph Hellwig 已提交
833
	cmnd->rw.nsid = cpu_to_le32(ns->head->ns_id);
834
	cmnd->rw.slba = cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
M
Ming Lin 已提交
835 836
	cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);

837 838 839
	if (req_op(req) == REQ_OP_WRITE && ctrl->nr_streams)
		nvme_assign_write_stream(ctrl, req, &control, &dsmgmt);

M
Ming Lin 已提交
840
	if (ns->ms) {
841 842 843 844 845 846 847 848 849 850 851 852
		/*
		 * 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 已提交
853 854 855 856 857 858 859 860
		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;
K
Keith Busch 已提交
861 862
			if (op == nvme_cmd_zone_append)
				control |= NVME_RW_APPEND_PIREMAP;
863
			cmnd->rw.reftag = cpu_to_le32(t10_pi_ref_tag(req));
M
Ming Lin 已提交
864 865 866 867 868 869
			break;
		}
	}

	cmnd->rw.control = cpu_to_le16(control);
	cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
870
	return 0;
M
Ming Lin 已提交
871 872
}

873 874 875
void nvme_cleanup_cmd(struct request *req)
{
	if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
M
Minwoo Im 已提交
876
		struct nvme_ctrl *ctrl = nvme_req(req)->ctrl;
877 878
		struct page *page = req->special_vec.bv_page;

M
Minwoo Im 已提交
879 880
		if (page == ctrl->discard_page)
			clear_bit_unlock(0, &ctrl->discard_page_busy);
881 882
		else
			kfree(page_address(page) + req->special_vec.bv_offset);
883 884 885 886
	}
}
EXPORT_SYMBOL_GPL(nvme_cleanup_cmd);

887
blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req)
M
Ming Lin 已提交
888
{
889
	struct nvme_command *cmd = nvme_req(req)->cmd;
890
	blk_status_t ret = BLK_STS_OK;
M
Ming Lin 已提交
891

892 893
	if (!(req->rq_flags & RQF_DONTPREP))
		nvme_clear_nvme_request(req);
894

895 896 897
	switch (req_op(req)) {
	case REQ_OP_DRV_IN:
	case REQ_OP_DRV_OUT:
898
		/* these are setup prior to execution in nvme_init_request() */
899 900
		break;
	case REQ_OP_FLUSH:
M
Ming Lin 已提交
901
		nvme_setup_flush(ns, cmd);
902
		break;
K
Keith Busch 已提交
903 904 905 906 907 908 909 910 911 912 913 914 915
	case REQ_OP_ZONE_RESET_ALL:
	case REQ_OP_ZONE_RESET:
		ret = nvme_setup_zone_mgmt_send(ns, req, cmd, NVME_ZONE_RESET);
		break;
	case REQ_OP_ZONE_OPEN:
		ret = nvme_setup_zone_mgmt_send(ns, req, cmd, NVME_ZONE_OPEN);
		break;
	case REQ_OP_ZONE_CLOSE:
		ret = nvme_setup_zone_mgmt_send(ns, req, cmd, NVME_ZONE_CLOSE);
		break;
	case REQ_OP_ZONE_FINISH:
		ret = nvme_setup_zone_mgmt_send(ns, req, cmd, NVME_ZONE_FINISH);
		break;
916
	case REQ_OP_WRITE_ZEROES:
917 918
		ret = nvme_setup_write_zeroes(ns, req, cmd);
		break;
919
	case REQ_OP_DISCARD:
M
Ming Lin 已提交
920
		ret = nvme_setup_discard(ns, req, cmd);
921 922
		break;
	case REQ_OP_READ:
K
Keith Busch 已提交
923 924
		ret = nvme_setup_rw(ns, req, cmd, nvme_cmd_read);
		break;
925
	case REQ_OP_WRITE:
K
Keith Busch 已提交
926 927 928 929
		ret = nvme_setup_rw(ns, req, cmd, nvme_cmd_write);
		break;
	case REQ_OP_ZONE_APPEND:
		ret = nvme_setup_rw(ns, req, cmd, nvme_cmd_zone_append);
930 931 932
		break;
	default:
		WARN_ON_ONCE(1);
933
		return BLK_STS_IOERR;
934
	}
M
Ming Lin 已提交
935

936
	cmd->common.command_id = req->tag;
K
Keith Busch 已提交
937
	trace_nvme_setup_cmd(req, cmd);
M
Ming Lin 已提交
938 939 940 941
	return ret;
}
EXPORT_SYMBOL_GPL(nvme_setup_cmd);

942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
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;
959
	blk_execute_rq_nowait(bd_disk, rq, at_head, nvme_end_sync_rq);
960 961 962 963 964 965 966

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

967 968 969 970 971
/*
 * 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,
972
		union nvme_result *result, void *buffer, unsigned bufflen,
973
		unsigned timeout, int qid, int at_head,
974
		blk_mq_req_flags_t flags, bool poll)
975 976 977 978
{
	struct request *req;
	int ret;

979 980 981 982
	if (qid == NVME_QID_ANY)
		req = nvme_alloc_request(q, cmd, flags);
	else
		req = nvme_alloc_request_qid(q, cmd, flags, qid);
983 984 985
	if (IS_ERR(req))
		return PTR_ERR(req);

986 987
	if (timeout)
		req->timeout = timeout;
988

989 990 991 992
	if (buffer && bufflen) {
		ret = blk_rq_map_kern(q, req, buffer, bufflen, GFP_KERNEL);
		if (ret)
			goto out;
993 994
	}

995 996 997
	if (poll)
		nvme_execute_rq_polled(req->q, NULL, req, at_head);
	else
998
		blk_execute_rq(NULL, req, at_head);
999 1000
	if (result)
		*result = nvme_req(req)->result;
1001 1002 1003 1004
	if (nvme_req(req)->flags & NVME_REQ_CANCELLED)
		ret = -EINTR;
	else
		ret = nvme_req(req)->status;
1005 1006 1007 1008
 out:
	blk_mq_free_request(req);
	return ret;
}
1009
EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd);
1010 1011 1012 1013

int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
		void *buffer, unsigned bufflen)
{
1014
	return __nvme_submit_sync_cmd(q, cmd, NULL, buffer, bufflen, 0,
1015
			NVME_QID_ANY, 0, 0, false);
1016
}
1017
EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd);
1018

1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
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);
}

1053 1054 1055 1056
static u32 nvme_known_admin_effects(u8 opcode)
{
	switch (opcode) {
	case nvme_admin_format_nvm:
1057
		return NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_NCC |
1058 1059
			NVME_CMD_EFFECTS_CSE_MASK;
	case nvme_admin_sanitize_nvm:
1060
		return NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_CSE_MASK;
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
	default:
		break;
	}
	return 0;
}

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

	if (ns) {
		if (ns->head->effects)
			effects = le32_to_cpu(ns->head->effects->iocs[opcode]);
		if (effects & ~(NVME_CMD_EFFECTS_CSUPP | NVME_CMD_EFFECTS_LBCC))
1075 1076 1077
			dev_warn_once(ctrl->device,
				"IO command:%02x has unhandled effects:%08x\n",
				opcode, effects);
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
		return 0;
	}

	if (ctrl->effects)
		effects = le32_to_cpu(ctrl->effects->acs[opcode]);
	effects |= nvme_known_admin_effects(opcode);

	return effects;
}
EXPORT_SYMBOL_NS_GPL(nvme_command_effects, NVME_TARGET_PASSTHRU);

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

	/*
	 * For simplicity, IO to all namespaces is quiesced even if the command
	 * effects say only one namespace is affected.
	 */
1098
	if (effects & NVME_CMD_EFFECTS_CSE_MASK) {
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
		mutex_lock(&ctrl->scan_lock);
		mutex_lock(&ctrl->subsys->lock);
		nvme_mpath_start_freeze(ctrl->subsys);
		nvme_mpath_wait_freeze(ctrl->subsys);
		nvme_start_freeze(ctrl);
		nvme_wait_freeze(ctrl);
	}
	return effects;
}

static void nvme_passthru_end(struct nvme_ctrl *ctrl, u32 effects)
{
1111
	if (effects & NVME_CMD_EFFECTS_CSE_MASK) {
1112 1113 1114 1115 1116 1117 1118
		nvme_unfreeze(ctrl);
		nvme_mpath_unfreeze(ctrl->subsys);
		mutex_unlock(&ctrl->subsys->lock);
		nvme_remove_invalid_namespaces(ctrl, NVME_NSID_ALL);
		mutex_unlock(&ctrl->scan_lock);
	}
	if (effects & NVME_CMD_EFFECTS_CCC)
1119
		nvme_init_ctrl_finish(ctrl);
1120 1121 1122 1123 1124 1125
	if (effects & (NVME_CMD_EFFECTS_NIC | NVME_CMD_EFFECTS_NCC)) {
		nvme_queue_scan(ctrl);
		flush_work(&ctrl->scan_work);
	}
}

1126 1127 1128 1129 1130 1131 1132 1133 1134
void nvme_execute_passthru_rq(struct request *rq)
{
	struct nvme_command *cmd = nvme_req(rq)->cmd;
	struct nvme_ctrl *ctrl = nvme_req(rq)->ctrl;
	struct nvme_ns *ns = rq->q->queuedata;
	struct gendisk *disk = ns ? ns->disk : NULL;
	u32 effects;

	effects = nvme_passthru_start(ctrl, ns, cmd->common.opcode);
1135
	blk_execute_rq(disk, rq, 0);
1136 1137
	if (effects) /* nothing to be done for zero cmd effects */
		nvme_passthru_end(ctrl, effects);
1138 1139 1140
}
EXPORT_SYMBOL_NS_GPL(nvme_execute_passthru_rq, NVME_TARGET_PASSTHRU);

1141
static int nvme_submit_user_cmd(struct request_queue *q,
1142 1143
		struct nvme_command *cmd, void __user *ubuffer,
		unsigned bufflen, void __user *meta_buffer, unsigned meta_len,
1144
		u32 meta_seed, u64 *result, unsigned timeout)
1145
{
1146
	bool write = nvme_is_write(cmd);
1147
	struct nvme_ns *ns = q->queuedata;
1148
	struct block_device *bdev = ns ? ns->disk->part0 : NULL;
1149
	struct request *req;
1150 1151
	struct bio *bio = NULL;
	void *meta = NULL;
1152 1153
	int ret;

1154
	req = nvme_alloc_request(q, cmd, 0);
1155 1156 1157
	if (IS_ERR(req))
		return PTR_ERR(req);

1158 1159
	if (timeout)
		req->timeout = timeout;
1160
	nvme_req(req)->flags |= NVME_REQ_USERCMD;
1161 1162

	if (ubuffer && bufflen) {
1163 1164 1165 1166 1167
		ret = blk_rq_map_user(q, req, NULL, ubuffer, bufflen,
				GFP_KERNEL);
		if (ret)
			goto out;
		bio = req->bio;
1168 1169
		if (bdev)
			bio_set_dev(bio, bdev);
1170
		if (bdev && meta_buffer && meta_len) {
1171 1172 1173 1174
			meta = nvme_add_user_metadata(bio, meta_buffer, meta_len,
					meta_seed, write);
			if (IS_ERR(meta)) {
				ret = PTR_ERR(meta);
1175 1176
				goto out_unmap;
			}
1177
			req->cmd_flags |= REQ_INTEGRITY;
1178 1179
		}
	}
1180

1181
	nvme_execute_passthru_rq(req);
1182 1183 1184 1185
	if (nvme_req(req)->flags & NVME_REQ_CANCELLED)
		ret = -EINTR;
	else
		ret = nvme_req(req)->status;
1186
	if (result)
1187
		*result = le64_to_cpu(nvme_req(req)->result.u64);
1188 1189 1190 1191 1192 1193
	if (meta && !ret && !write) {
		if (copy_to_user(meta_buffer, meta, meta_len))
			ret = -EFAULT;
	}
	kfree(meta);
 out_unmap:
1194
	if (bio)
1195
		blk_rq_unmap_user(bio);
1196 1197 1198 1199 1200
 out:
	blk_mq_free_request(req);
	return ret;
}

1201
static void nvme_keep_alive_end_io(struct request *rq, blk_status_t status)
S
Sagi Grimberg 已提交
1202 1203
{
	struct nvme_ctrl *ctrl = rq->end_io_data;
1204 1205
	unsigned long flags;
	bool startka = false;
S
Sagi Grimberg 已提交
1206 1207 1208

	blk_mq_free_request(rq);

1209
	if (status) {
S
Sagi Grimberg 已提交
1210
		dev_err(ctrl->device,
1211 1212
			"failed nvme_keep_alive_end_io error=%d\n",
				status);
S
Sagi Grimberg 已提交
1213 1214 1215
		return;
	}

1216
	ctrl->comp_seen = false;
1217 1218 1219 1220 1221 1222
	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)
1223
		queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ);
S
Sagi Grimberg 已提交
1224 1225 1226 1227 1228 1229
}

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

1230 1231
	rq = nvme_alloc_request(ctrl->admin_q, &ctrl->ka_cmd,
			BLK_MQ_REQ_RESERVED);
S
Sagi Grimberg 已提交
1232 1233 1234 1235 1236 1237
	if (IS_ERR(rq))
		return PTR_ERR(rq);

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

1238
	blk_execute_rq_nowait(NULL, rq, 0, nvme_keep_alive_end_io);
S
Sagi Grimberg 已提交
1239 1240 1241 1242 1243 1244 1245 1246

	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);
1247 1248 1249 1250 1251 1252
	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;
1253
		queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ);
1254 1255
		return;
	}
S
Sagi Grimberg 已提交
1256 1257 1258 1259

	if (nvme_keep_alive(ctrl)) {
		/* allocation failure, reset the controller */
		dev_err(ctrl->device, "keep-alive failed\n");
1260
		nvme_reset_ctrl(ctrl);
S
Sagi Grimberg 已提交
1261 1262 1263 1264
		return;
	}
}

1265
static void nvme_start_keep_alive(struct nvme_ctrl *ctrl)
S
Sagi Grimberg 已提交
1266 1267 1268 1269
{
	if (unlikely(ctrl->kato == 0))
		return;

1270
	queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ);
S
Sagi Grimberg 已提交
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281
}

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

1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
/*
 * 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 已提交
1295
static int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id)
1296 1297 1298 1299 1300 1301
{
	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;
1302
	c.identify.cns = NVME_ID_CNS_CTRL;
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314

	*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;
}

1315 1316 1317 1318 1319
static bool nvme_multi_css(struct nvme_ctrl *ctrl)
{
	return (ctrl->ctrl_config & NVME_CC_CSS_MASK) == NVME_CC_CSS_CSI;
}

1320
static int nvme_process_ns_desc(struct nvme_ctrl *ctrl, struct nvme_ns_ids *ids,
1321
		struct nvme_ns_id_desc *cur, bool *csi_seen)
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350
{
	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;
1351 1352 1353 1354 1355 1356 1357 1358 1359
	case NVME_NIDT_CSI:
		if (cur->nidl != NVME_NIDT_CSI_LEN) {
			dev_warn(ctrl->device, "%s %d for NVME_NIDT_CSI\n",
				 warn_str, cur->nidl);
			return -1;
		}
		memcpy(&ids->csi, data + sizeof(*cur), NVME_NIDT_CSI_LEN);
		*csi_seen = true;
		return NVME_NIDT_CSI_LEN;
1360 1361 1362 1363 1364 1365
	default:
		/* Skip unknown types */
		return cur->nidl;
	}
}

1366
static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl, unsigned nsid,
1367
		struct nvme_ns_ids *ids)
1368 1369
{
	struct nvme_command c = { };
1370 1371
	bool csi_seen = false;
	int status, pos, len;
1372 1373
	void *data;

1374 1375
	if (ctrl->vs < NVME_VS(1, 3, 0) && !nvme_multi_css(ctrl))
		return 0;
1376 1377 1378
	if (ctrl->quirks & NVME_QUIRK_NO_NS_DESC_LIST)
		return 0;

1379 1380 1381 1382 1383 1384 1385 1386
	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;

1387
	status = nvme_submit_sync_cmd(ctrl->admin_q, &c, data,
1388
				      NVME_IDENTIFY_DATA_SIZE);
1389 1390
	if (status) {
		dev_warn(ctrl->device,
1391 1392
			"Identify Descriptors failed (nsid=%u, status=0x%x)\n",
			nsid, status);
1393
		goto free_data;
1394
	}
1395 1396 1397 1398 1399 1400 1401

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

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

1402
		len = nvme_process_ns_desc(ctrl, ids, cur, &csi_seen);
1403
		if (len < 0)
1404
			break;
1405 1406 1407

		len += sizeof(*cur);
	}
1408 1409 1410 1411 1412 1413 1414

	if (nvme_multi_css(ctrl) && !csi_seen) {
		dev_warn(ctrl->device, "Command set not reported for nsid:%d\n",
			 nsid);
		status = -EINVAL;
	}

1415 1416 1417 1418 1419
free_data:
	kfree(data);
	return status;
}

1420 1421
static int nvme_identify_ns(struct nvme_ctrl *ctrl, unsigned nsid,
			struct nvme_ns_ids *ids, struct nvme_id_ns **id)
1422 1423 1424 1425 1426
{
	struct nvme_command c = { };
	int error;

	/* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1427 1428
	c.identify.opcode = nvme_admin_identify;
	c.identify.nsid = cpu_to_le32(nsid);
1429
	c.identify.cns = NVME_ID_CNS_NS;
1430

1431 1432 1433
	*id = kmalloc(sizeof(**id), GFP_KERNEL);
	if (!*id)
		return -ENOMEM;
1434

1435
	error = nvme_submit_sync_cmd(ctrl->admin_q, &c, *id, sizeof(**id));
1436
	if (error) {
1437
		dev_warn(ctrl->device, "Identify namespace failed (%d)\n", error);
1438
		goto out_free_id;
1439 1440
	}

1441
	error = NVME_SC_INVALID_NS | NVME_SC_DNR;
1442 1443
	if ((*id)->ncap == 0) /* namespace not allocated or attached */
		goto out_free_id;
1444 1445 1446 1447 1448 1449 1450 1451

	if (ctrl->vs >= NVME_VS(1, 1, 0) &&
	    !memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
		memcpy(ids->eui64, (*id)->eui64, sizeof(ids->eui64));
	if (ctrl->vs >= NVME_VS(1, 2, 0) &&
	    !memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
		memcpy(ids->nguid, (*id)->nguid, sizeof(ids->nguid));

1452 1453 1454 1455
	return 0;

out_free_id:
	kfree(*id);
1456
	return error;
1457 1458
}

K
Keith Busch 已提交
1459 1460
static int nvme_features(struct nvme_ctrl *dev, u8 op, unsigned int fid,
		unsigned int dword11, void *buffer, size_t buflen, u32 *result)
1461
{
1462
	union nvme_result res = { 0 };
1463
	struct nvme_command c;
1464
	int ret;
1465 1466

	memset(&c, 0, sizeof(c));
K
Keith Busch 已提交
1467
	c.features.opcode = op;
1468 1469 1470
	c.features.fid = cpu_to_le32(fid);
	c.features.dword11 = cpu_to_le32(dword11);

1471
	ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &res,
1472
			buffer, buflen, 0, NVME_QID_ANY, 0, 0, false);
1473
	if (ret >= 0 && result)
1474
		*result = le32_to_cpu(res.u32);
1475
	return ret;
1476 1477
}

K
Keith Busch 已提交
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495
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 已提交
1496 1497 1498 1499 1500 1501
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;

1502
	status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, NULL, 0,
C
Christoph Hellwig 已提交
1503
			&result);
1504
	if (status < 0)
C
Christoph Hellwig 已提交
1505 1506
		return status;

1507 1508 1509 1510 1511 1512
	/*
	 * 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) {
1513
		dev_err(ctrl->device, "Could not set queue count (%d)\n", status);
1514 1515 1516 1517 1518 1519
		*count = 0;
	} else {
		nr_io_queues = min(result & 0xffff, result >> 16) + 1;
		*count = min(*count, nr_io_queues);
	}

C
Christoph Hellwig 已提交
1520 1521
	return 0;
}
1522
EXPORT_SYMBOL_GPL(nvme_set_queue_count);
C
Christoph Hellwig 已提交
1523

1524
#define NVME_AEN_SUPPORTED \
1525 1526
	(NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_FW_ACT | \
	 NVME_AEN_CFG_ANA_CHANGE | NVME_AEN_CFG_DISC_CHANGE)
1527 1528 1529

static void nvme_enable_aen(struct nvme_ctrl *ctrl)
{
1530
	u32 result, supported_aens = ctrl->oaes & NVME_AEN_SUPPORTED;
1531 1532
	int status;

1533 1534 1535 1536 1537
	if (!supported_aens)
		return;

	status = nvme_set_features(ctrl, NVME_FEAT_ASYNC_EVENT, supported_aens,
			NULL, 0, &result);
1538 1539
	if (status)
		dev_warn(ctrl->device, "Failed to configure AEN (cfg %x)\n",
1540
			 supported_aens);
1541 1542

	queue_work(nvme_wq, &ctrl->async_event_work);
1543 1544
}

1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556
/*
 * 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;
}

1557 1558 1559 1560 1561 1562 1563 1564 1565
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;
1566 1567
	if (io.flags)
		return -EINVAL;
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578

	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;
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593

	if ((io.control & NVME_RW_PRINFO_PRACT) &&
	    ns->ms == sizeof(struct t10_pi_tuple)) {
		/*
		 * Protection information is stripped/inserted by the
		 * controller.
		 */
		if (nvme_to_user_ptr(io.metadata))
			return -EINVAL;
		meta_len = 0;
		metadata = NULL;
	} else {
		meta_len = (io.nblocks + 1) * ns->ms;
		metadata = nvme_to_user_ptr(io.metadata);
	}
1594

1595
	if (ns->features & NVME_NS_EXT_LBAS) {
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
		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 已提交
1606
	c.rw.nsid = cpu_to_le32(ns->head->ns_id);
1607 1608 1609 1610 1611 1612 1613 1614
	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);

1615
	return nvme_submit_user_cmd(ns->queue, &c,
1616
			nvme_to_user_ptr(io.addr), length,
1617
			metadata, meta_len, lower_32_bits(io.slba), NULL, 0);
1618 1619
}

1620
static int nvme_user_cmd(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
1621 1622 1623 1624 1625
			struct nvme_passthru_cmd __user *ucmd)
{
	struct nvme_passthru_cmd cmd;
	struct nvme_command c;
	unsigned timeout = 0;
1626 1627 1628 1629 1630 1631 1632 1633 1634
	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;
1635 1636 1637 1638 1639 1640
	if (ns && cmd.nsid != ns->head->ns_id) {
		dev_err(ctrl->device,
			"%s: nsid (%u) in cmd does not match nsid (%u) of namespace\n",
			current->comm, cmd.nsid, ns->head->ns_id);
		return -EINVAL;
	}
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658

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

	status = nvme_submit_user_cmd(ns ? ns->queue : ctrl->admin_q, &c,
1659 1660 1661
			nvme_to_user_ptr(cmd.addr), cmd.data_len,
			nvme_to_user_ptr(cmd.metadata), cmd.metadata_len,
			0, &result, timeout);
1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676

	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;
1677 1678 1679 1680 1681 1682
	int status;

	if (!capable(CAP_SYS_ADMIN))
		return -EACCES;
	if (copy_from_user(&cmd, ucmd, sizeof(cmd)))
		return -EFAULT;
1683 1684
	if (cmd.flags)
		return -EINVAL;
1685 1686 1687 1688 1689 1690
	if (ns && cmd.nsid != ns->head->ns_id) {
		dev_err(ctrl->device,
			"%s: nsid (%u) in cmd does not match nsid (%u) of namespace\n",
			current->comm, cmd.nsid, ns->head->ns_id);
		return -EINVAL;
	}
1691 1692 1693 1694 1695 1696 1697

	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);
1698 1699 1700 1701 1702 1703
	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);
1704 1705 1706 1707 1708

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

	status = nvme_submit_user_cmd(ns ? ns->queue : ctrl->admin_q, &c,
1709 1710
			nvme_to_user_ptr(cmd.addr), cmd.data_len,
			nvme_to_user_ptr(cmd.metadata), cmd.metadata_len,
1711
			0, &cmd.result, timeout);
1712

1713 1714 1715 1716 1717 1718 1719 1720
	if (status >= 0) {
		if (put_user(cmd.result, &ucmd->result))
			return -EFAULT;
	}

	return status;
}

1721 1722 1723 1724
/*
 * Issue ioctl requests on the first available path.  Note that unlike normal
 * block layer requests we will not retry failed request on another controller.
 */
K
Keith Busch 已提交
1725
struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk,
1726
		struct nvme_ns_head **head, int *srcu_idx)
1727
{
1728 1729
#ifdef CONFIG_NVME_MULTIPATH
	if (disk->fops == &nvme_ns_head_ops) {
1730 1731
		struct nvme_ns *ns;

1732 1733
		*head = disk->private_data;
		*srcu_idx = srcu_read_lock(&(*head)->srcu);
1734 1735 1736 1737
		ns = nvme_find_path(*head);
		if (!ns)
			srcu_read_unlock(&(*head)->srcu, *srcu_idx);
		return ns;
1738 1739 1740 1741 1742 1743
	}
#endif
	*head = NULL;
	*srcu_idx = -1;
	return disk->private_data;
}
1744

K
Keith Busch 已提交
1745
void nvme_put_ns_from_disk(struct nvme_ns_head *head, int idx)
1746 1747 1748 1749
{
	if (head)
		srcu_read_unlock(&head->srcu, idx);
}
1750

1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785
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;
}

1786 1787
static int nvme_ioctl(struct block_device *bdev, fmode_t mode,
		unsigned int cmd, unsigned long arg)
1788
{
1789
	struct nvme_ns_head *head = NULL;
1790
	void __user *argp = (void __user *)arg;
1791 1792 1793 1794 1795
	struct nvme_ns *ns;
	int srcu_idx, ret;

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

1798 1799 1800 1801 1802
	/*
	 * 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.
	 */
1803 1804
	if (is_ctrl_ioctl(cmd))
		return nvme_handle_ctrl_ioctl(ns, cmd, argp, head, srcu_idx);
1805

1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816
	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;
1817 1818 1819
	case NVME_IOCTL_IO64_CMD:
		ret = nvme_user_cmd64(ns->ctrl, ns, argp);
		break;
1820 1821 1822 1823 1824 1825 1826
	default:
		if (ns->ndev)
			ret = nvme_nvm_ioctl(ns, cmd, arg);
		else
			ret = -ENOTTY;
	}

1827 1828
	nvme_put_ns_from_disk(head, srcu_idx);
	return ret;
1829 1830
}

1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871
#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 */

1872 1873
static int nvme_open(struct block_device *bdev, fmode_t mode)
{
C
Christoph Hellwig 已提交
1874 1875
	struct nvme_ns *ns = bdev->bd_disk->private_data;

1876 1877 1878
#ifdef CONFIG_NVME_MULTIPATH
	/* should never be called due to GENHD_FL_HIDDEN */
	if (WARN_ON_ONCE(ns->head->disk))
1879
		goto fail;
1880
#endif
C
Christoph Hellwig 已提交
1881
	if (!kref_get_unless_zero(&ns->kref))
1882 1883 1884 1885
		goto fail;
	if (!try_module_get(ns->ctrl->ops->module))
		goto fail_put_ns;

C
Christoph Hellwig 已提交
1886
	return 0;
1887 1888 1889 1890 1891

fail_put_ns:
	nvme_put_ns(ns);
fail:
	return -ENXIO;
1892 1893 1894 1895
}

static void nvme_release(struct gendisk *disk, fmode_t mode)
{
1896 1897 1898 1899
	struct nvme_ns *ns = disk->private_data;

	module_put(ns->ctrl->ops->module);
	nvme_put_ns(ns);
1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911
}

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
1912 1913
static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type,
				u32 max_integrity_segments)
1914 1915 1916
{
	struct blk_integrity integrity;

1917
	memset(&integrity, 0, sizeof(integrity));
1918
	switch (pi_type) {
1919 1920
	case NVME_NS_DPS_PI_TYPE3:
		integrity.profile = &t10_pi_type3_crc;
1921 1922
		integrity.tag_size = sizeof(u16) + sizeof(u32);
		integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1923 1924 1925 1926
		break;
	case NVME_NS_DPS_PI_TYPE1:
	case NVME_NS_DPS_PI_TYPE2:
		integrity.profile = &t10_pi_type1_crc;
1927 1928
		integrity.tag_size = sizeof(u16);
		integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1929 1930 1931 1932 1933
		break;
	default:
		integrity.profile = NULL;
		break;
	}
1934 1935
	integrity.tuple_size = ms;
	blk_integrity_register(disk, &integrity);
1936
	blk_queue_max_integrity_segments(disk->queue, max_integrity_segments);
1937 1938
}
#else
1939 1940
static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type,
				u32 max_integrity_segments)
1941 1942 1943 1944
{
}
#endif /* CONFIG_BLK_DEV_INTEGRITY */

1945
static void nvme_config_discard(struct gendisk *disk, struct nvme_ns *ns)
1946
{
1947
	struct nvme_ctrl *ctrl = ns->ctrl;
1948
	struct request_queue *queue = disk->queue;
1949 1950
	u32 size = queue_logical_block_size(queue);

1951
	if (ctrl->max_discard_sectors == 0) {
1952 1953 1954 1955 1956 1957
		blk_queue_flag_clear(QUEUE_FLAG_DISCARD, queue);
		return;
	}

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

1959 1960 1961
	BUILD_BUG_ON(PAGE_SIZE / sizeof(struct nvme_dsm_range) <
			NVME_DSM_MAX_RANGES);

1962
	queue->limits.discard_alignment = 0;
1963
	queue->limits.discard_granularity = size;
1964

1965 1966 1967 1968
	/* If discard is already enabled, don't reset queue limits */
	if (blk_queue_flag_test_and_set(QUEUE_FLAG_DISCARD, queue))
		return;

1969 1970
	blk_queue_max_discard_sectors(queue, ctrl->max_discard_sectors);
	blk_queue_max_discard_segments(queue, ctrl->max_discard_segments);
1971 1972

	if (ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
1973
		blk_queue_max_write_zeroes_sectors(queue, UINT_MAX);
1974 1975
}

C
Christoph Hellwig 已提交
1976 1977 1978 1979 1980 1981 1982
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));
}

1983 1984 1985 1986
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 &&
1987 1988
		memcmp(&a->eui64, &b->eui64, sizeof(a->eui64)) == 0 &&
		a->csi == b->csi;
1989 1990
}

K
Keith Busch 已提交
1991 1992
static int nvme_setup_streams_ns(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
				 u32 *phys_bs, u32 *io_opt)
1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
{
	struct streams_directive_params s;
	int ret;

	if (!ctrl->nr_streams)
		return 0;

	ret = nvme_get_stream_params(ctrl, &s, ns->head->ns_id);
	if (ret)
		return ret;

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

	if (ns->sws) {
K
Keith Busch 已提交
2008
		*phys_bs = ns->sws * (1 << ns->lba_shift);
2009
		if (ns->sgs)
K
Keith Busch 已提交
2010
			*io_opt = *phys_bs * ns->sgs;
2011 2012 2013 2014 2015
	}

	return 0;
}

2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059
static int nvme_configure_metadata(struct nvme_ns *ns, struct nvme_id_ns *id)
{
	struct nvme_ctrl *ctrl = ns->ctrl;

	/*
	 * The PI implementation requires the metadata size to be equal to the
	 * t10 pi tuple size.
	 */
	ns->ms = le16_to_cpu(id->lbaf[id->flbas & NVME_NS_FLBAS_LBA_MASK].ms);
	if (ns->ms == sizeof(struct t10_pi_tuple))
		ns->pi_type = id->dps & NVME_NS_DPS_PI_MASK;
	else
		ns->pi_type = 0;

	ns->features &= ~(NVME_NS_METADATA_SUPPORTED | NVME_NS_EXT_LBAS);
	if (!ns->ms || !(ctrl->ops->flags & NVME_F_METADATA_SUPPORTED))
		return 0;
	if (ctrl->ops->flags & NVME_F_FABRICS) {
		/*
		 * The NVMe over Fabrics specification only supports metadata as
		 * part of the extended data LBA.  We rely on HCA/HBA support to
		 * remap the separate metadata buffer from the block layer.
		 */
		if (WARN_ON_ONCE(!(id->flbas & NVME_NS_FLBAS_META_EXT)))
			return -EINVAL;
		if (ctrl->max_integrity_segments)
			ns->features |=
				(NVME_NS_METADATA_SUPPORTED | NVME_NS_EXT_LBAS);
	} else {
		/*
		 * For PCIe controllers, we can't easily remap the separate
		 * metadata buffer from the block layer and thus require a
		 * separate metadata buffer for block layer metadata/PI support.
		 * We allow extended LBAs for the passthrough interface, though.
		 */
		if (id->flbas & NVME_NS_FLBAS_META_EXT)
			ns->features |= NVME_NS_EXT_LBAS;
		else
			ns->features |= NVME_NS_METADATA_SUPPORTED;
	}

	return 0;
}

2060 2061 2062
static void nvme_set_queue_limits(struct nvme_ctrl *ctrl,
		struct request_queue *q)
{
2063
	bool vwc = ctrl->vwc & NVME_CTRL_VWC_PRESENT;
2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077

	if (ctrl->max_hw_sectors) {
		u32 max_segments =
			(ctrl->max_hw_sectors / (NVME_CTRL_PAGE_SIZE >> 9)) + 1;

		max_segments = min_not_zero(max_segments, ctrl->max_segments);
		blk_queue_max_hw_sectors(q, ctrl->max_hw_sectors);
		blk_queue_max_segments(q, min_t(u32, max_segments, USHRT_MAX));
	}
	blk_queue_virt_boundary(q, NVME_CTRL_PAGE_SIZE - 1);
	blk_queue_dma_alignment(q, 7);
	blk_queue_write_cache(q, vwc, vwc);
}

2078 2079 2080
static void nvme_update_disk_info(struct gendisk *disk,
		struct nvme_ns *ns, struct nvme_id_ns *id)
{
2081
	sector_t capacity = nvme_lba_to_sect(ns, le64_to_cpu(id->nsze));
2082
	unsigned short bs = 1 << ns->lba_shift;
D
Damien Le Moal 已提交
2083
	u32 atomic_bs, phys_bs, io_opt = 0;
2084

2085 2086 2087 2088
	/*
	 * The block layer can't support LBA sizes larger than the page size
	 * yet, so catch this early and don't allow block I/O.
	 */
2089
	if (ns->lba_shift > PAGE_SHIFT) {
2090
		capacity = 0;
2091 2092
		bs = (1 << 9);
	}
2093

2094 2095
	blk_integrity_unregister(disk);

D
Damien Le Moal 已提交
2096
	atomic_bs = phys_bs = bs;
K
Keith Busch 已提交
2097
	nvme_setup_streams_ns(ns->ctrl, ns, &phys_bs, &io_opt);
2098 2099 2100 2101 2102 2103
	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.
		 */
2104
		if (id->nsfeat & NVME_NS_FEAT_ATOMICS && id->nawupf)
2105 2106 2107 2108
			atomic_bs = (1 + le16_to_cpu(id->nawupf)) * bs;
		else
			atomic_bs = (1 + ns->ctrl->subsys->awupf) * bs;
	}
K
Keith Busch 已提交
2109

2110
	if (id->nsfeat & NVME_NS_FEAT_IO_OPT) {
2111
		/* NPWG = Namespace Preferred Write Granularity */
K
Keith Busch 已提交
2112
		phys_bs = bs * (1 + le16_to_cpu(id->npwg));
2113
		/* NOWS = Namespace Optimal Write Size */
K
Keith Busch 已提交
2114
		io_opt = bs * (1 + le16_to_cpu(id->nows));
2115 2116
	}

2117
	blk_queue_logical_block_size(disk->queue, bs);
2118 2119 2120 2121 2122 2123 2124 2125
	/*
	 * 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);
2126

2127 2128 2129 2130 2131 2132 2133 2134 2135
	/*
	 * Register a metadata profile for PI, or the plain non-integrity NVMe
	 * metadata masquerading as Type 0 if supported, otherwise reject block
	 * I/O to namespaces with metadata except when the namespace supports
	 * PI, as it can strip/insert in that case.
	 */
	if (ns->ms) {
		if (IS_ENABLED(CONFIG_BLK_DEV_INTEGRITY) &&
		    (ns->features & NVME_NS_METADATA_SUPPORTED))
2136 2137
			nvme_init_integrity(disk, ns->ms, ns->pi_type,
					    ns->ctrl->max_integrity_segments);
2138 2139 2140 2141
		else if (!nvme_ns_has_pi(ns))
			capacity = 0;
	}

2142
	set_capacity_and_notify(disk, capacity);
2143

2144
	nvme_config_discard(disk, ns);
2145 2146
	blk_queue_max_write_zeroes_sectors(disk->queue,
					   ns->ctrl->max_zeroes_sectors);
2147

2148 2149
	set_disk_ro(disk, (id->nsattr & NVME_NS_ATTR_RO) ||
		test_bit(NVME_NS_FORCE_RO, &ns->flags));
2150 2151
}

2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188
static inline bool nvme_first_scan(struct gendisk *disk)
{
	/* nvme_alloc_ns() scans the disk prior to adding it */
	return !(disk->flags & GENHD_FL_UP);
}

static void nvme_set_chunk_sectors(struct nvme_ns *ns, struct nvme_id_ns *id)
{
	struct nvme_ctrl *ctrl = ns->ctrl;
	u32 iob;

	if ((ctrl->quirks & NVME_QUIRK_STRIPE_SIZE) &&
	    is_power_of_2(ctrl->max_hw_sectors))
		iob = ctrl->max_hw_sectors;
	else
		iob = nvme_lba_to_sect(ns, le16_to_cpu(id->noiob));

	if (!iob)
		return;

	if (!is_power_of_2(iob)) {
		if (nvme_first_scan(ns->disk))
			pr_warn("%s: ignoring unaligned IO boundary:%u\n",
				ns->disk->disk_name, iob);
		return;
	}

	if (blk_queue_is_zoned(ns->disk->queue)) {
		if (nvme_first_scan(ns->disk))
			pr_warn("%s: ignoring zoned namespace IO boundary\n",
				ns->disk->disk_name);
		return;
	}

	blk_queue_chunk_sectors(ns->queue, iob);
}

2189
static int nvme_update_ns_info(struct nvme_ns *ns, struct nvme_id_ns *id)
2190
{
K
Keith Busch 已提交
2191 2192
	unsigned lbaf = id->flbas & NVME_NS_FLBAS_LBA_MASK;
	int ret;
2193

2194
	blk_mq_freeze_queue(ns->disk->queue);
K
Keith Busch 已提交
2195
	ns->lba_shift = id->lbaf[lbaf].ds;
2196
	nvme_set_queue_limits(ns->ctrl, ns->queue);
2197

2198 2199 2200 2201 2202 2203
	ret = nvme_configure_metadata(ns, id);
	if (ret)
		goto out_unfreeze;
	nvme_set_chunk_sectors(ns, id);
	nvme_update_disk_info(ns->disk, ns, id);

2204
	if (ns->head->ids.csi == NVME_CSI_ZNS) {
2205
		ret = nvme_update_zone_info(ns, lbaf);
2206
		if (ret)
2207
			goto out_unfreeze;
2208 2209
	}

2210
	blk_mq_unfreeze_queue(ns->disk->queue);
2211

2212 2213
	if (blk_queue_is_zoned(ns->queue)) {
		ret = nvme_revalidate_zones(ns);
2214
		if (ret && !nvme_first_scan(ns->disk))
2215
			return ret;
2216 2217
	}

2218
#ifdef CONFIG_NVME_MULTIPATH
2219
	if (ns->head->disk) {
2220
		blk_mq_freeze_queue(ns->head->disk->queue);
2221
		nvme_update_disk_info(ns->head->disk, ns, id);
2222 2223
		blk_stack_limits(&ns->head->disk->queue->limits,
				 &ns->queue->limits, 0);
2224
		blk_queue_update_readahead(ns->head->disk->queue);
2225
		blk_mq_unfreeze_queue(ns->head->disk->queue);
2226
	}
2227
#endif
2228
	return 0;
2229

2230 2231
out_unfreeze:
	blk_mq_unfreeze_queue(ns->disk->queue);
K
Keith Busch 已提交
2232 2233 2234
	return ret;
}

2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257
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)
{
2258 2259
	struct nvme_ns_head *head = NULL;
	struct nvme_ns *ns;
2260
	struct nvme_command c;
2261
	int srcu_idx, ret;
2262 2263
	u8 data[16] = { 0, };

2264 2265 2266 2267
	ns = nvme_get_ns_from_disk(bdev->bd_disk, &head, &srcu_idx);
	if (unlikely(!ns))
		return -EWOULDBLOCK;

2268 2269 2270 2271 2272
	put_unaligned_le64(key, &data[0]);
	put_unaligned_le64(sa_key, &data[8]);

	memset(&c, 0, sizeof(c));
	c.common.opcode = op;
2273
	c.common.nsid = cpu_to_le32(ns->head->ns_id);
2274
	c.common.cdw10 = cpu_to_le32(cdw10);
2275

2276
	ret = nvme_submit_sync_cmd(ns->queue, &c, data, 16);
2277 2278
	nvme_put_ns_from_disk(head, srcu_idx);
	return ret;
2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310
}

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)
{
2311
	u32 cdw10 = nvme_pr_type(type) << 8 | (abort ? 2 : 1);
2312

2313 2314 2315 2316 2317
	return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire);
}

static int nvme_pr_clear(struct block_device *bdev, u64 key)
{
2318
	u32 cdw10 = 1 | (key ? 1 << 3 : 0);
2319

2320 2321 2322 2323 2324
	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)
{
2325
	u32 cdw10 = nvme_pr_type(type) << 8 | (key ? 1 << 3 : 0);
2326

2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337
	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,
};

2338
#ifdef CONFIG_BLK_SED_OPAL
2339 2340
int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
		bool send)
2341
{
2342
	struct nvme_ctrl *ctrl = data;
2343 2344 2345 2346 2347 2348 2349 2350
	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;
2351 2352
	cmd.common.cdw10 = cpu_to_le32(((u32)secp) << 24 | ((u32)spsp) << 8);
	cmd.common.cdw11 = cpu_to_le32(len);
2353

2354 2355
	return __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, NULL, buffer, len, 0,
			NVME_QID_ANY, 1, 0, false);
2356 2357 2358 2359
}
EXPORT_SYMBOL_GPL(nvme_sec_submit);
#endif /* CONFIG_BLK_SED_OPAL */

J
Javier González 已提交
2360
static const struct block_device_operations nvme_bdev_ops = {
2361 2362
	.owner		= THIS_MODULE,
	.ioctl		= nvme_ioctl,
2363
	.compat_ioctl	= nvme_compat_ioctl,
2364 2365 2366
	.open		= nvme_open,
	.release	= nvme_release,
	.getgeo		= nvme_getgeo,
K
Keith Busch 已提交
2367
	.report_zones	= nvme_report_zones,
2368 2369 2370
	.pr_ops		= &nvme_pr_ops,
};

2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387
#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,
2388
	.submit_bio	= nvme_ns_head_submit_bio,
2389 2390 2391
	.open		= nvme_ns_head_open,
	.release	= nvme_ns_head_release,
	.ioctl		= nvme_ioctl,
2392
	.compat_ioctl	= nvme_compat_ioctl,
2393
	.getgeo		= nvme_getgeo,
K
Keith Busch 已提交
2394
	.report_zones	= nvme_report_zones,
2395 2396 2397 2398
	.pr_ops		= &nvme_pr_ops,
};
#endif /* CONFIG_NVME_MULTIPATH */

2399 2400 2401 2402 2403 2404 2405 2406
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 已提交
2407 2408
		if (csts == ~0)
			return -ENODEV;
2409 2410 2411
		if ((csts & NVME_CSTS_RDY) == bit)
			break;

2412
		usleep_range(1000, 2000);
2413 2414 2415
		if (fatal_signal_pending(current))
			return -EINTR;
		if (time_after(jiffies, timeout)) {
2416
			dev_err(ctrl->device,
2417 2418
				"Device not ready; aborting %s, CSTS=0x%x\n",
				enabled ? "initialisation" : "reset", csts);
2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431
			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!
 */
2432
int nvme_disable_ctrl(struct nvme_ctrl *ctrl)
2433 2434 2435 2436 2437 2438 2439 2440 2441
{
	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;
2442

2443
	if (ctrl->quirks & NVME_QUIRK_DELAY_BEFORE_CHK_RDY)
2444 2445
		msleep(NVME_QUIRK_DELAY_AMOUNT);

2446
	return nvme_wait_ready(ctrl, ctrl->cap, false);
2447
}
2448
EXPORT_SYMBOL_GPL(nvme_disable_ctrl);
2449

2450
int nvme_enable_ctrl(struct nvme_ctrl *ctrl)
2451
{
2452
	unsigned dev_page_min;
2453 2454
	int ret;

2455 2456 2457 2458 2459 2460 2461
	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;

2462
	if (NVME_CTRL_PAGE_SHIFT < dev_page_min) {
2463
		dev_err(ctrl->device,
2464
			"Minimum device page size %u too large for host (%u)\n",
2465
			1 << dev_page_min, 1 << NVME_CTRL_PAGE_SHIFT);
2466 2467 2468
		return -ENODEV;
	}

2469 2470 2471 2472
	if (NVME_CAP_CSS(ctrl->cap) & NVME_CAP_CSS_CSI)
		ctrl->ctrl_config = NVME_CC_CSS_CSI;
	else
		ctrl->ctrl_config = NVME_CC_CSS_NVM;
2473
	ctrl->ctrl_config |= (NVME_CTRL_PAGE_SHIFT - 12) << NVME_CC_MPS_SHIFT;
2474
	ctrl->ctrl_config |= NVME_CC_AMS_RR | NVME_CC_SHN_NONE;
2475 2476 2477 2478 2479 2480
	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;
2481
	return nvme_wait_ready(ctrl, ctrl->cap, true);
2482
}
2483
EXPORT_SYMBOL_GPL(nvme_enable_ctrl);
2484 2485 2486

int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl)
{
2487
	unsigned long timeout = jiffies + (ctrl->shutdown_timeout * HZ);
2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505
	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)) {
2506
			dev_err(ctrl->device,
2507 2508 2509 2510 2511 2512 2513
				"Device shutdown incomplete; abort shutdown\n");
			return -ENODEV;
		}
	}

	return ret;
}
2514
EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl);
2515

2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532
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;
}

2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552
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;
}

2553
static int nvme_configure_apst(struct nvme_ctrl *ctrl)
2554 2555 2556 2557 2558 2559 2560 2561
{
	/*
	 * 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 已提交
2562
	 * non-operational state after waiting 50 * (enlat + exlat)
2563
	 * microseconds, as long as that state's exit latency is under
2564 2565 2566 2567 2568 2569 2570 2571 2572
	 * 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;
2573 2574
	u64 max_lat_us = 0;
	int max_ps = -1;
2575 2576 2577 2578 2579 2580 2581
	int ret;

	/*
	 * If APST isn't supported or if we haven't been initialized yet,
	 * then don't do anything.
	 */
	if (!ctrl->apsta)
2582
		return 0;
2583 2584 2585

	if (ctrl->npss > 31) {
		dev_warn(ctrl->device, "NPSS is invalid; not using APST\n");
2586
		return 0;
2587 2588 2589 2590
	}

	table = kzalloc(sizeof(*table), GFP_KERNEL);
	if (!table)
2591
		return 0;
2592

2593
	if (!ctrl->apst_enabled || ctrl->ps_max_latency_us == 0) {
2594 2595
		/* Turn off APST. */
		apste = 0;
2596
		dev_dbg(ctrl->device, "APST disabled\n");
2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607
	} 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--) {
2608
			u64 total_latency_us, exit_latency_us, transition_ms;
2609 2610 2611 2612

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

2613 2614 2615 2616 2617 2618 2619 2620
			/*
			 * 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;

2621 2622 2623 2624 2625 2626 2627 2628
			/*
			 * 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;

2629 2630 2631
			exit_latency_us =
				(u64)le32_to_cpu(ctrl->psd[state].exit_lat);
			if (exit_latency_us > ctrl->ps_max_latency_us)
2632 2633
				continue;

2634 2635 2636 2637
			total_latency_us =
				exit_latency_us +
				le32_to_cpu(ctrl->psd[state].entry_lat);

2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648
			/*
			 * 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));
2649 2650 2651 2652 2653 2654

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

			if (total_latency_us > max_lat_us)
				max_lat_us = total_latency_us;
2655 2656 2657
		}

		apste = 1;
2658 2659 2660 2661 2662 2663 2664

		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);
		}
2665 2666 2667 2668 2669 2670 2671 2672
	}

	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);
2673
	return ret;
2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696
}

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

2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709
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[] = {
2710
	{
2711 2712 2713 2714 2715 2716
		/*
		 * 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",
2717
		.quirks = NVME_QUIRK_NO_APST,
2718 2719 2720 2721 2722 2723 2724 2725 2726 2727
	},
	{
		/*
		 * 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,
2728
	}
2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759
};

/* 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 已提交
2760 2761
static void nvme_init_subnqn(struct nvme_subsystem *subsys, struct nvme_ctrl *ctrl,
		struct nvme_id_ctrl *id)
2762 2763 2764 2765
{
	size_t nqnlen;
	int off;

2766 2767 2768 2769 2770 2771
	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;
		}
2772

2773 2774 2775
		if (ctrl->vs >= NVME_VS(1, 2, 1))
			dev_warn(ctrl->device, "missing or invalid SUBNQN field.\n");
	}
2776 2777

	/* Generate a "fake" NQN per Figure 254 in NVMe 1.3 + ECN 001 */
C
Christoph Hellwig 已提交
2778
	off = snprintf(subsys->subnqn, NVMF_NQN_SIZE,
2779
			"nqn.2014.08.org.nvmexpress:%04x%04x",
2780
			le16_to_cpu(id->vid), le16_to_cpu(id->ssvid));
C
Christoph Hellwig 已提交
2781
	memcpy(subsys->subnqn + off, id->sn, sizeof(id->sn));
2782
	off += sizeof(id->sn);
C
Christoph Hellwig 已提交
2783
	memcpy(subsys->subnqn + off, id->mn, sizeof(id->mn));
2784
	off += sizeof(id->mn);
C
Christoph Hellwig 已提交
2785 2786 2787
	memset(subsys->subnqn + off, 0, sizeof(subsys->subnqn) - off);
}

2788
static void nvme_release_subsystem(struct device *dev)
C
Christoph Hellwig 已提交
2789
{
2790 2791 2792
	struct nvme_subsystem *subsys =
		container_of(dev, struct nvme_subsystem, dev);

2793 2794
	if (subsys->instance >= 0)
		ida_simple_remove(&nvme_instance_ida, subsys->instance);
C
Christoph Hellwig 已提交
2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806
	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 已提交
2807
	ida_destroy(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822
	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);

2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833
	/*
	 * 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 已提交
2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844
	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;
}

2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855
#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);

2856
	return sysfs_emit(buf, "%s\n", subsys->subnqn);
2857 2858 2859 2860 2861 2862 2863 2864 2865
}
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);		\
2866 2867
	return sysfs_emit(buf, "%.*s\n",				\
			   (int)sizeof(subsys->field), subsys->field);	\
2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879
}									\
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,
2880 2881 2882
#ifdef CONFIG_NVME_MULTIPATH
	&subsys_attr_iopolicy.attr,
#endif
2883 2884 2885
	NULL,
};

2886
static const struct attribute_group nvme_subsys_attrs_group = {
2887 2888 2889 2890 2891 2892 2893 2894
	.attrs = nvme_subsys_attrs,
};

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

2895 2896 2897 2898 2899
static inline bool nvme_discovery_ctrl(struct nvme_ctrl *ctrl)
{
	return ctrl->opts && ctrl->opts->discovery_nqn;
}

2900 2901
static bool nvme_validate_cntlid(struct nvme_subsystem *subsys,
		struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
2902
{
2903
	struct nvme_ctrl *tmp;
2904

2905 2906
	lockdep_assert_held(&nvme_subsystems_lock);

2907
	list_for_each_entry(tmp, &subsys->ctrls, subsys_entry) {
2908
		if (nvme_state_terminal(tmp))
2909 2910 2911 2912 2913 2914 2915 2916
			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;
		}
2917

2918
		if ((id->cmic & NVME_CTRL_CMIC_MULTI_CTRL) ||
2919
		    nvme_discovery_ctrl(ctrl))
2920 2921 2922 2923 2924
			continue;

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

2927
	return true;
2928 2929
}

C
Christoph Hellwig 已提交
2930 2931 2932 2933 2934 2935 2936 2937
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;
2938 2939

	subsys->instance = -1;
C
Christoph Hellwig 已提交
2940 2941 2942
	mutex_init(&subsys->lock);
	kref_init(&subsys->ref);
	INIT_LIST_HEAD(&subsys->ctrls);
C
Christoph Hellwig 已提交
2943
	INIT_LIST_HEAD(&subsys->nsheads);
C
Christoph Hellwig 已提交
2944 2945 2946 2947 2948 2949
	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;
2950
	subsys->awupf = le16_to_cpu(id->awupf);
2951 2952 2953
#ifdef CONFIG_NVME_MULTIPATH
	subsys->iopolicy = NVME_IOPOLICY_NUMA;
#endif
C
Christoph Hellwig 已提交
2954 2955 2956

	subsys->dev.class = nvme_subsys_class;
	subsys->dev.release = nvme_release_subsystem;
2957
	subsys->dev.groups = nvme_subsys_attrs_groups;
2958
	dev_set_name(&subsys->dev, "nvme-subsys%d", ctrl->instance);
C
Christoph Hellwig 已提交
2959 2960 2961 2962 2963
	device_initialize(&subsys->dev);

	mutex_lock(&nvme_subsystems_lock);
	found = __nvme_find_get_subsystem(subsys->subnqn);
	if (found) {
2964
		put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2965
		subsys = found;
2966

2967
		if (!nvme_validate_cntlid(subsys, ctrl, id)) {
C
Christoph Hellwig 已提交
2968
			ret = -EINVAL;
2969
			goto out_put_subsystem;
C
Christoph Hellwig 已提交
2970 2971 2972 2973 2974 2975
		}
	} else {
		ret = device_add(&subsys->dev);
		if (ret) {
			dev_err(ctrl->device,
				"failed to register subsystem device.\n");
2976
			put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2977 2978
			goto out_unlock;
		}
C
Christoph Hellwig 已提交
2979
		ida_init(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2980 2981 2982
		list_add_tail(&subsys->entry, &nvme_subsystems);
	}

2983 2984 2985
	ret = sysfs_create_link(&subsys->dev.kobj, &ctrl->device->kobj,
				dev_name(ctrl->device));
	if (ret) {
C
Christoph Hellwig 已提交
2986 2987
		dev_err(ctrl->device,
			"failed to create sysfs link from subsystem.\n");
2988
		goto out_put_subsystem;
C
Christoph Hellwig 已提交
2989 2990
	}

2991 2992
	if (!found)
		subsys->instance = ctrl->instance;
2993
	ctrl->subsys = subsys;
C
Christoph Hellwig 已提交
2994
	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
2995
	mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
2996 2997
	return 0;

2998 2999
out_put_subsystem:
	nvme_put_subsystem(subsys);
C
Christoph Hellwig 已提交
3000 3001 3002
out_unlock:
	mutex_unlock(&nvme_subsystems_lock);
	return ret;
3003 3004
}

3005
int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
3006
		void *log, size_t size, u64 offset)
K
Keith Busch 已提交
3007 3008
{
	struct nvme_command c = { };
K
Keith Busch 已提交
3009
	u32 dwlen = nvme_bytes_to_numd(size);
3010 3011

	c.get_log_page.opcode = nvme_admin_get_log_page;
3012
	c.get_log_page.nsid = cpu_to_le32(nsid);
3013
	c.get_log_page.lid = log_page;
3014
	c.get_log_page.lsp = lsp;
3015 3016
	c.get_log_page.numdl = cpu_to_le16(dwlen & ((1 << 16) - 1));
	c.get_log_page.numdu = cpu_to_le16(dwlen >> 16);
3017 3018
	c.get_log_page.lpol = cpu_to_le32(lower_32_bits(offset));
	c.get_log_page.lpou = cpu_to_le32(upper_32_bits(offset));
3019
	c.get_log_page.csi = csi;
K
Keith Busch 已提交
3020 3021 3022 3023

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

3024 3025
static int nvme_get_effects_log(struct nvme_ctrl *ctrl, u8 csi,
				struct nvme_effects_log **log)
3026
{
3027
	struct nvme_effects_log	*cel = xa_load(&ctrl->cels, csi);
3028 3029
	int ret;

3030 3031
	if (cel)
		goto out;
3032

3033 3034 3035
	cel = kzalloc(sizeof(*cel), GFP_KERNEL);
	if (!cel)
		return -ENOMEM;
3036

3037
	ret = nvme_get_log(ctrl, 0x00, NVME_LOG_CMD_EFFECTS, 0, csi,
3038
			cel, sizeof(*cel), 0);
3039
	if (ret) {
3040 3041
		kfree(cel);
		return ret;
3042
	}
3043

3044
	xa_store(&ctrl->cels, csi, cel, GFP_KERNEL);
3045
out:
3046
	*log = cel;
3047
	return 0;
3048 3049
}

3050 3051
static inline u32 nvme_mps_to_sectors(struct nvme_ctrl *ctrl, u32 units)
{
3052
	u32 page_shift = NVME_CAP_MPSMIN(ctrl->cap) + 12, val;
3053

3054 3055 3056
	if (check_shl_overflow(1U, units + page_shift - 9, &val))
		return UINT_MAX;
	return val;
3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111
}

static int nvme_init_non_mdts_limits(struct nvme_ctrl *ctrl)
{
	struct nvme_command c = { };
	struct nvme_id_ctrl_nvm *id;
	int ret;

	if (ctrl->oncs & NVME_CTRL_ONCS_DSM) {
		ctrl->max_discard_sectors = UINT_MAX;
		ctrl->max_discard_segments = NVME_DSM_MAX_RANGES;
	} else {
		ctrl->max_discard_sectors = 0;
		ctrl->max_discard_segments = 0;
	}

	/*
	 * Even though NVMe spec explicitly states that MDTS is not applicable
	 * to the write-zeroes, we are cautious and limit the size to the
	 * controllers max_hw_sectors value, which is based on the MDTS field
	 * and possibly other limiting factors.
	 */
	if ((ctrl->oncs & NVME_CTRL_ONCS_WRITE_ZEROES) &&
	    !(ctrl->quirks & NVME_QUIRK_DISABLE_WRITE_ZEROES))
		ctrl->max_zeroes_sectors = ctrl->max_hw_sectors;
	else
		ctrl->max_zeroes_sectors = 0;

	if (nvme_ctrl_limited_cns(ctrl))
		return 0;

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

	c.identify.opcode = nvme_admin_identify;
	c.identify.cns = NVME_ID_CNS_CS_CTRL;
	c.identify.csi = NVME_CSI_NVM;

	ret = nvme_submit_sync_cmd(ctrl->admin_q, &c, id, sizeof(*id));
	if (ret)
		goto free_data;

	if (id->dmrl)
		ctrl->max_discard_segments = id->dmrl;
	if (id->dmrsl)
		ctrl->max_discard_sectors = le32_to_cpu(id->dmrsl);
	if (id->wzsl)
		ctrl->max_zeroes_sectors = nvme_mps_to_sectors(ctrl, id->wzsl);

free_data:
	kfree(id);
	return ret;
}

3112
static int nvme_init_identify(struct nvme_ctrl *ctrl)
3113 3114
{
	struct nvme_id_ctrl *id;
3115
	u32 max_hw_sectors;
3116
	bool prev_apst_enabled;
3117
	int ret;
3118

3119 3120
	ret = nvme_identify_ctrl(ctrl, &id);
	if (ret) {
3121
		dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret);
3122 3123 3124
		return -EIO;
	}

3125
	if (id->lpa & NVME_CTRL_LPA_CMD_EFFECTS_LOG) {
3126
		ret = nvme_get_effects_log(ctrl, NVME_CSI_NVM, &ctrl->effects);
3127
		if (ret < 0)
3128
			goto out_free;
3129
	}
3130

3131 3132 3133
	if (!(ctrl->ops->flags & NVME_F_FABRICS))
		ctrl->cntlid = le16_to_cpu(id->cntlid);

3134
	if (!ctrl->identified) {
3135
		unsigned int i;
C
Christoph Hellwig 已提交
3136 3137 3138 3139 3140

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

3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154
		/*
		 * 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;
		}
	}

3155
	if (force_apst && (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) {
3156
		dev_warn(ctrl->device, "forcibly allowing all power states due to nvme_core.force_apst -- use at your own risk\n");
3157 3158 3159
		ctrl->quirks &= ~NVME_QUIRK_NO_DEEPEST_PS;
	}

3160 3161 3162 3163
	ctrl->crdt[0] = le16_to_cpu(id->crdt1);
	ctrl->crdt[1] = le16_to_cpu(id->crdt2);
	ctrl->crdt[2] = le16_to_cpu(id->crdt3);

3164
	ctrl->oacs = le16_to_cpu(id->oacs);
3165
	ctrl->oncs = le16_to_cpu(id->oncs);
3166
	ctrl->mtfa = le16_to_cpu(id->mtfa);
3167
	ctrl->oaes = le32_to_cpu(id->oaes);
3168 3169 3170
	ctrl->wctemp = le16_to_cpu(id->wctemp);
	ctrl->cctemp = le16_to_cpu(id->cctemp);

3171
	atomic_set(&ctrl->abort_limit, id->acl + 1);
3172 3173
	ctrl->vwc = id->vwc;
	if (id->mdts)
3174
		max_hw_sectors = nvme_mps_to_sectors(ctrl, id->mdts);
3175
	else
3176 3177 3178
		max_hw_sectors = UINT_MAX;
	ctrl->max_hw_sectors =
		min_not_zero(ctrl->max_hw_sectors, max_hw_sectors);
3179

3180
	nvme_set_queue_limits(ctrl, ctrl->admin_q);
3181
	ctrl->sgls = le32_to_cpu(id->sgls);
S
Sagi Grimberg 已提交
3182
	ctrl->kas = le16_to_cpu(id->kas);
C
Christoph Hellwig 已提交
3183
	ctrl->max_namespaces = le32_to_cpu(id->mnan);
S
Sagi Grimberg 已提交
3184
	ctrl->ctratt = le32_to_cpu(id->ctratt);
3185

3186 3187
	if (id->rtd3e) {
		/* us -> s */
3188
		u32 transition_time = le32_to_cpu(id->rtd3e) / USEC_PER_SEC;
3189 3190 3191 3192 3193

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

		if (ctrl->shutdown_timeout != shutdown_timeout)
3194
			dev_info(ctrl->device,
3195 3196 3197 3198 3199
				 "Shutdown timeout set to %u seconds\n",
				 ctrl->shutdown_timeout);
	} else
		ctrl->shutdown_timeout = shutdown_timeout;

3200
	ctrl->npss = id->npss;
3201 3202
	ctrl->apsta = id->apsta;
	prev_apst_enabled = ctrl->apst_enabled;
3203 3204
	if (ctrl->quirks & NVME_QUIRK_NO_APST) {
		if (force_apst && id->apsta) {
3205
			dev_warn(ctrl->device, "forcibly allowing APST due to nvme_core.force_apst -- use at your own risk\n");
3206
			ctrl->apst_enabled = true;
3207
		} else {
3208
			ctrl->apst_enabled = false;
3209 3210
		}
	} else {
3211
		ctrl->apst_enabled = id->apsta;
3212
	}
3213 3214
	memcpy(ctrl->psd, id->psd, sizeof(ctrl->psd));

3215
	if (ctrl->ops->flags & NVME_F_FABRICS) {
3216 3217 3218 3219 3220 3221 3222 3223 3224
		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
		 */
3225
		if (ctrl->cntlid != le16_to_cpu(id->cntlid)) {
3226 3227 3228 3229
			dev_err(ctrl->device,
				"Mismatching cntlid: Connect %u vs Identify "
				"%u, rejecting\n",
				ctrl->cntlid, le16_to_cpu(id->cntlid));
3230
			ret = -EINVAL;
3231 3232
			goto out_free;
		}
S
Sagi Grimberg 已提交
3233

3234
		if (!nvme_discovery_ctrl(ctrl) && !ctrl->kas) {
3235
			dev_err(ctrl->device,
S
Sagi Grimberg 已提交
3236 3237
				"keep-alive support is mandatory for fabrics\n");
			ret = -EINVAL;
3238
			goto out_free;
S
Sagi Grimberg 已提交
3239
		}
3240
	} else {
3241 3242
		ctrl->hmpre = le32_to_cpu(id->hmpre);
		ctrl->hmmin = le32_to_cpu(id->hmmin);
3243 3244
		ctrl->hmminds = le32_to_cpu(id->hmminds);
		ctrl->hmmaxd = le16_to_cpu(id->hmmaxd);
3245
	}
3246

C
Christoph Hellwig 已提交
3247 3248
	ret = nvme_mpath_init(ctrl, id);
	if (ret < 0)
3249
		goto out_free;
C
Christoph Hellwig 已提交
3250

3251
	if (ctrl->apst_enabled && !prev_apst_enabled)
3252
		dev_pm_qos_expose_latency_tolerance(ctrl->device);
3253
	else if (!ctrl->apst_enabled && prev_apst_enabled)
3254 3255
		dev_pm_qos_hide_latency_tolerance(ctrl->device);

3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284
out_free:
	kfree(id);
	return ret;
}

/*
 * 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_ctrl_finish(struct nvme_ctrl *ctrl)
{
	int ret;

	ret = ctrl->ops->reg_read32(ctrl, NVME_REG_VS, &ctrl->vs);
	if (ret) {
		dev_err(ctrl->device, "Reading VS failed (%d)\n", ret);
		return ret;
	}

	ctrl->sqsize = min_t(u16, NVME_CAP_MQES(ctrl->cap), ctrl->sqsize);

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

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

3285 3286 3287 3288
	ret = nvme_init_non_mdts_limits(ctrl);
	if (ret < 0)
		return ret;

3289 3290 3291
	ret = nvme_configure_apst(ctrl);
	if (ret < 0)
		return ret;
3292

3293 3294 3295
	ret = nvme_configure_timestamp(ctrl);
	if (ret < 0)
		return ret;
3296 3297 3298 3299

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

3301 3302 3303 3304
	ret = nvme_configure_acre(ctrl);
	if (ret < 0)
		return ret;

3305
	if (!ctrl->identified && !nvme_discovery_ctrl(ctrl)) {
K
Keith Busch 已提交
3306 3307 3308 3309
		ret = nvme_hwmon_init(ctrl);
		if (ret < 0)
			return ret;
	}
3310

3311
	ctrl->identified = true;
3312

3313
	return 0;
3314
}
3315
EXPORT_SYMBOL_GPL(nvme_init_ctrl_finish);
3316

3317
static int nvme_dev_open(struct inode *inode, struct file *file)
3318
{
3319 3320
	struct nvme_ctrl *ctrl =
		container_of(inode->i_cdev, struct nvme_ctrl, cdev);
3321

3322 3323 3324 3325
	switch (ctrl->state) {
	case NVME_CTRL_LIVE:
		break;
	default:
3326
		return -EWOULDBLOCK;
3327 3328
	}

3329
	nvme_get_ctrl(ctrl);
3330 3331
	if (!try_module_get(ctrl->ops->module)) {
		nvme_put_ctrl(ctrl);
3332
		return -EINVAL;
3333
	}
3334

3335
	file->private_data = ctrl;
3336 3337 3338
	return 0;
}

3339 3340 3341 3342 3343 3344 3345 3346 3347 3348
static int nvme_dev_release(struct inode *inode, struct file *file)
{
	struct nvme_ctrl *ctrl =
		container_of(inode->i_cdev, struct nvme_ctrl, cdev);

	module_put(ctrl->ops->module);
	nvme_put_ctrl(ctrl);
	return 0;
}

3349 3350 3351 3352 3353
static int nvme_dev_user_cmd(struct nvme_ctrl *ctrl, void __user *argp)
{
	struct nvme_ns *ns;
	int ret;

3354
	down_read(&ctrl->namespaces_rwsem);
3355 3356 3357 3358 3359 3360 3361
	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)) {
3362
		dev_warn(ctrl->device,
3363 3364 3365 3366 3367
			"NVME_IOCTL_IO_CMD not supported when multiple namespaces present!\n");
		ret = -EINVAL;
		goto out_unlock;
	}

3368
	dev_warn(ctrl->device,
3369 3370
		"using deprecated NVME_IOCTL_IO_CMD ioctl on the char device!\n");
	kref_get(&ns->kref);
3371
	up_read(&ctrl->namespaces_rwsem);
3372 3373 3374 3375 3376 3377

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

out_unlock:
3378
	up_read(&ctrl->namespaces_rwsem);
3379 3380 3381
	return ret;
}

3382 3383 3384 3385 3386 3387 3388 3389 3390
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);
3391 3392
	case NVME_IOCTL_ADMIN64_CMD:
		return nvme_user_cmd64(ctrl, NULL, argp);
3393
	case NVME_IOCTL_IO_CMD:
3394
		return nvme_dev_user_cmd(ctrl, argp);
3395
	case NVME_IOCTL_RESET:
3396
		dev_warn(ctrl->device, "resetting controller\n");
3397
		return nvme_reset_ctrl_sync(ctrl);
3398 3399
	case NVME_IOCTL_SUBSYS_RESET:
		return nvme_reset_subsystem(ctrl);
K
Keith Busch 已提交
3400 3401 3402
	case NVME_IOCTL_RESCAN:
		nvme_queue_scan(ctrl);
		return 0;
3403 3404 3405 3406 3407 3408 3409 3410
	default:
		return -ENOTTY;
	}
}

static const struct file_operations nvme_dev_fops = {
	.owner		= THIS_MODULE,
	.open		= nvme_dev_open,
3411
	.release	= nvme_dev_release,
3412
	.unlocked_ioctl	= nvme_dev_ioctl,
3413
	.compat_ioctl	= compat_ptr_ioctl,
3414 3415 3416 3417 3418 3419 3420 3421 3422
};

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;

3423
	ret = nvme_reset_ctrl_sync(ctrl);
3424 3425 3426
	if (ret < 0)
		return ret;
	return count;
3427
}
3428
static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset);
3429

K
Keith Busch 已提交
3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440
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);

3441 3442 3443 3444
static inline struct nvme_ns_head *dev_to_ns_head(struct device *dev)
{
	struct gendisk *disk = dev_to_disk(dev);

J
Javier González 已提交
3445
	if (disk->fops == &nvme_bdev_ops)
3446 3447 3448 3449 3450
		return nvme_get_ns_from_dev(dev)->head;
	else
		return disk->private_data;
}

3451
static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
3452
		char *buf)
3453
{
3454 3455 3456
	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 已提交
3457 3458
	int serial_len = sizeof(subsys->serial);
	int model_len = sizeof(subsys->model);
3459

3460
	if (!uuid_is_null(&ids->uuid))
3461
		return sysfs_emit(buf, "uuid.%pU\n", &ids->uuid);
3462

3463
	if (memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3464
		return sysfs_emit(buf, "eui.%16phN\n", ids->nguid);
3465

3466
	if (memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3467
		return sysfs_emit(buf, "eui.%8phN\n", ids->eui64);
3468

C
Christoph Hellwig 已提交
3469 3470
	while (serial_len > 0 && (subsys->serial[serial_len - 1] == ' ' ||
				  subsys->serial[serial_len - 1] == '\0'))
3471
		serial_len--;
C
Christoph Hellwig 已提交
3472 3473
	while (model_len > 0 && (subsys->model[model_len - 1] == ' ' ||
				 subsys->model[model_len - 1] == '\0'))
3474 3475
		model_len--;

3476
	return sysfs_emit(buf, "nvme.%04x-%*phN-%*phN-%08x\n", subsys->vendor_id,
C
Christoph Hellwig 已提交
3477
		serial_len, subsys->serial, model_len, subsys->model,
3478
		head->ns_id);
3479
}
J
Joe Perches 已提交
3480
static DEVICE_ATTR_RO(wwid);
3481

3482
static ssize_t nguid_show(struct device *dev, struct device_attribute *attr,
3483
		char *buf)
3484
{
3485
	return sysfs_emit(buf, "%pU\n", dev_to_ns_head(dev)->ids.nguid);
3486
}
J
Joe Perches 已提交
3487
static DEVICE_ATTR_RO(nguid);
3488

3489
static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
3490
		char *buf)
3491
{
3492
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3493 3494 3495 3496

	/* For backward compatibility expose the NGUID to userspace if
	 * we have no UUID set
	 */
3497
	if (uuid_is_null(&ids->uuid)) {
3498 3499
		printk_ratelimited(KERN_WARNING
				   "No UUID available providing old NGUID\n");
3500
		return sysfs_emit(buf, "%pU\n", ids->nguid);
3501
	}
3502
	return sysfs_emit(buf, "%pU\n", &ids->uuid);
3503
}
J
Joe Perches 已提交
3504
static DEVICE_ATTR_RO(uuid);
3505 3506

static ssize_t eui_show(struct device *dev, struct device_attribute *attr,
3507
		char *buf)
3508
{
3509
	return sysfs_emit(buf, "%8ph\n", dev_to_ns_head(dev)->ids.eui64);
3510
}
J
Joe Perches 已提交
3511
static DEVICE_ATTR_RO(eui);
3512 3513

static ssize_t nsid_show(struct device *dev, struct device_attribute *attr,
3514
		char *buf)
3515
{
3516
	return sysfs_emit(buf, "%d\n", dev_to_ns_head(dev)->ns_id);
3517
}
J
Joe Perches 已提交
3518
static DEVICE_ATTR_RO(nsid);
3519

3520
static struct attribute *nvme_ns_id_attrs[] = {
3521
	&dev_attr_wwid.attr,
3522
	&dev_attr_uuid.attr,
3523
	&dev_attr_nguid.attr,
3524 3525
	&dev_attr_eui.attr,
	&dev_attr_nsid.attr,
C
Christoph Hellwig 已提交
3526 3527 3528 3529
#ifdef CONFIG_NVME_MULTIPATH
	&dev_attr_ana_grpid.attr,
	&dev_attr_ana_state.attr,
#endif
3530 3531 3532
	NULL,
};

3533
static umode_t nvme_ns_id_attrs_are_visible(struct kobject *kobj,
3534 3535 3536
		struct attribute *a, int n)
{
	struct device *dev = container_of(kobj, struct device, kobj);
3537
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3538 3539

	if (a == &dev_attr_uuid.attr) {
3540
		if (uuid_is_null(&ids->uuid) &&
3541
		    !memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3542 3543 3544
			return 0;
	}
	if (a == &dev_attr_nguid.attr) {
3545
		if (!memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3546 3547 3548
			return 0;
	}
	if (a == &dev_attr_eui.attr) {
3549
		if (!memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3550 3551
			return 0;
	}
C
Christoph Hellwig 已提交
3552 3553
#ifdef CONFIG_NVME_MULTIPATH
	if (a == &dev_attr_ana_grpid.attr || a == &dev_attr_ana_state.attr) {
J
Javier González 已提交
3554
		if (dev_to_disk(dev)->fops != &nvme_bdev_ops) /* per-path attr */
C
Christoph Hellwig 已提交
3555 3556 3557 3558 3559
			return 0;
		if (!nvme_ctrl_use_ana(nvme_get_ns_from_dev(dev)->ctrl))
			return 0;
	}
#endif
3560 3561 3562
	return a->mode;
}

3563
static const struct attribute_group nvme_ns_id_attr_group = {
3564 3565
	.attrs		= nvme_ns_id_attrs,
	.is_visible	= nvme_ns_id_attrs_are_visible,
3566 3567
};

3568 3569 3570 3571 3572 3573 3574 3575
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 已提交
3576
#define nvme_show_str_function(field)						\
3577 3578 3579 3580
static ssize_t  field##_show(struct device *dev,				\
			    struct device_attribute *attr, char *buf)		\
{										\
        struct nvme_ctrl *ctrl = dev_get_drvdata(dev);				\
3581
        return sysfs_emit(buf, "%.*s\n",					\
C
Christoph Hellwig 已提交
3582
		(int)sizeof(ctrl->subsys->field), ctrl->subsys->field);		\
3583 3584 3585
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

C
Christoph Hellwig 已提交
3586 3587 3588 3589
nvme_show_str_function(model);
nvme_show_str_function(serial);
nvme_show_str_function(firmware_rev);

M
Ming Lin 已提交
3590 3591 3592 3593 3594
#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);				\
3595
        return sysfs_emit(buf, "%d\n", ctrl->field);				\
M
Ming Lin 已提交
3596 3597 3598 3599
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

nvme_show_int_function(cntlid);
3600
nvme_show_int_function(numa_node);
3601 3602
nvme_show_int_function(queue_count);
nvme_show_int_function(sqsize);
3603

M
Ming Lin 已提交
3604 3605 3606 3607 3608 3609 3610
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);

	if (device_remove_file_self(dev, attr))
3611
		nvme_delete_ctrl_sync(ctrl);
M
Ming Lin 已提交
3612 3613 3614 3615 3616 3617 3618 3619 3620 3621
	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);

3622
	return sysfs_emit(buf, "%s\n", ctrl->ops->name);
M
Ming Lin 已提交
3623 3624 3625
}
static DEVICE_ATTR(transport, S_IRUGO, nvme_sysfs_show_transport, NULL);

3626 3627 3628 3629 3630 3631 3632 3633 3634
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",
3635
		[NVME_CTRL_CONNECTING]	= "connecting",
3636
		[NVME_CTRL_DELETING]	= "deleting",
3637
		[NVME_CTRL_DELETING_NOIO]= "deleting (no IO)",
3638 3639 3640 3641 3642
		[NVME_CTRL_DEAD]	= "dead",
	};

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

3645
	return sysfs_emit(buf, "unknown state\n");
3646 3647 3648 3649
}

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

M
Ming Lin 已提交
3650 3651 3652 3653 3654 3655
static ssize_t nvme_sysfs_show_subsysnqn(struct device *dev,
					 struct device_attribute *attr,
					 char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3656
	return sysfs_emit(buf, "%s\n", ctrl->subsys->subnqn);
M
Ming Lin 已提交
3657 3658 3659
}
static DEVICE_ATTR(subsysnqn, S_IRUGO, nvme_sysfs_show_subsysnqn, NULL);

3660 3661 3662 3663 3664 3665
static ssize_t nvme_sysfs_show_hostnqn(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3666
	return sysfs_emit(buf, "%s\n", ctrl->opts->host->nqn);
3667 3668 3669
}
static DEVICE_ATTR(hostnqn, S_IRUGO, nvme_sysfs_show_hostnqn, NULL);

3670 3671 3672 3673 3674 3675
static ssize_t nvme_sysfs_show_hostid(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3676
	return sysfs_emit(buf, "%pU\n", &ctrl->opts->host->id);
3677 3678 3679
}
static DEVICE_ATTR(hostid, S_IRUGO, nvme_sysfs_show_hostid, NULL);

M
Ming Lin 已提交
3680 3681 3682 3683 3684 3685 3686 3687 3688 3689
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);

3690 3691 3692 3693 3694 3695 3696
static ssize_t nvme_ctrl_loss_tmo_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
	struct nvmf_ctrl_options *opts = ctrl->opts;

	if (ctrl->opts->max_reconnects == -1)
3697 3698 3699
		return sysfs_emit(buf, "off\n");
	return sysfs_emit(buf, "%d\n",
			  opts->max_reconnects * opts->reconnect_delay);
3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712
}

static ssize_t nvme_ctrl_loss_tmo_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t count)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
	struct nvmf_ctrl_options *opts = ctrl->opts;
	int ctrl_loss_tmo, err;

	err = kstrtoint(buf, 10, &ctrl_loss_tmo);
	if (err)
		return -EINVAL;

3713
	if (ctrl_loss_tmo < 0)
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728
		opts->max_reconnects = -1;
	else
		opts->max_reconnects = DIV_ROUND_UP(ctrl_loss_tmo,
						opts->reconnect_delay);
	return count;
}
static DEVICE_ATTR(ctrl_loss_tmo, S_IRUGO | S_IWUSR,
	nvme_ctrl_loss_tmo_show, nvme_ctrl_loss_tmo_store);

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

	if (ctrl->opts->reconnect_delay == -1)
3729 3730
		return sysfs_emit(buf, "off\n");
	return sysfs_emit(buf, "%d\n", ctrl->opts->reconnect_delay);
3731 3732 3733 3734 3735 3736 3737 3738 3739 3740
}

static ssize_t nvme_ctrl_reconnect_delay_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t count)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
	unsigned int v;
	int err;

	err = kstrtou32(buf, 10, &v);
3741 3742
	if (err)
		return err;
3743 3744 3745 3746 3747 3748 3749

	ctrl->opts->reconnect_delay = v;
	return count;
}
static DEVICE_ATTR(reconnect_delay, S_IRUGO | S_IWUSR,
	nvme_ctrl_reconnect_delay_show, nvme_ctrl_reconnect_delay_store);

3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779
static ssize_t nvme_ctrl_fast_io_fail_tmo_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

	if (ctrl->opts->fast_io_fail_tmo == -1)
		return sysfs_emit(buf, "off\n");
	return sysfs_emit(buf, "%d\n", ctrl->opts->fast_io_fail_tmo);
}

static ssize_t nvme_ctrl_fast_io_fail_tmo_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t count)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
	struct nvmf_ctrl_options *opts = ctrl->opts;
	int fast_io_fail_tmo, err;

	err = kstrtoint(buf, 10, &fast_io_fail_tmo);
	if (err)
		return -EINVAL;

	if (fast_io_fail_tmo < 0)
		opts->fast_io_fail_tmo = -1;
	else
		opts->fast_io_fail_tmo = fast_io_fail_tmo;
	return count;
}
static DEVICE_ATTR(fast_io_fail_tmo, S_IRUGO | S_IWUSR,
	nvme_ctrl_fast_io_fail_tmo_show, nvme_ctrl_fast_io_fail_tmo_store);

3780 3781
static struct attribute *nvme_dev_attrs[] = {
	&dev_attr_reset_controller.attr,
K
Keith Busch 已提交
3782
	&dev_attr_rescan_controller.attr,
3783 3784 3785
	&dev_attr_model.attr,
	&dev_attr_serial.attr,
	&dev_attr_firmware_rev.attr,
M
Ming Lin 已提交
3786
	&dev_attr_cntlid.attr,
M
Ming Lin 已提交
3787 3788 3789 3790
	&dev_attr_delete_controller.attr,
	&dev_attr_transport.attr,
	&dev_attr_subsysnqn.attr,
	&dev_attr_address.attr,
3791
	&dev_attr_state.attr,
3792
	&dev_attr_numa_node.attr,
3793 3794
	&dev_attr_queue_count.attr,
	&dev_attr_sqsize.attr,
3795
	&dev_attr_hostnqn.attr,
3796
	&dev_attr_hostid.attr,
3797 3798
	&dev_attr_ctrl_loss_tmo.attr,
	&dev_attr_reconnect_delay.attr,
3799
	&dev_attr_fast_io_fail_tmo.attr,
3800 3801 3802
	NULL
};

M
Ming Lin 已提交
3803 3804 3805 3806 3807 3808
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);

3809 3810 3811 3812
	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;
3813 3814
	if (a == &dev_attr_hostnqn.attr && !ctrl->opts)
		return 0;
3815 3816
	if (a == &dev_attr_hostid.attr && !ctrl->opts)
		return 0;
3817 3818 3819 3820
	if (a == &dev_attr_ctrl_loss_tmo.attr && !ctrl->opts)
		return 0;
	if (a == &dev_attr_reconnect_delay.attr && !ctrl->opts)
		return 0;
M
Ming Lin 已提交
3821 3822 3823 3824

	return a->mode;
}

3825
static const struct attribute_group nvme_dev_attrs_group = {
M
Ming Lin 已提交
3826 3827
	.attrs		= nvme_dev_attrs,
	.is_visible	= nvme_dev_attrs_are_visible,
3828 3829 3830 3831 3832 3833 3834
};

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

3835
static struct nvme_ns_head *nvme_find_ns_head(struct nvme_subsystem *subsys,
C
Christoph Hellwig 已提交
3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866
		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 已提交
3867
		unsigned nsid, struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
3868 3869
{
	struct nvme_ns_head *head;
3870
	size_t size = sizeof(*head);
C
Christoph Hellwig 已提交
3871 3872
	int ret = -ENOMEM;

3873 3874 3875 3876 3877
#ifdef CONFIG_NVME_MULTIPATH
	size += num_possible_nodes() * sizeof(struct nvme_ns *);
#endif

	head = kzalloc(size, GFP_KERNEL);
C
Christoph Hellwig 已提交
3878 3879 3880 3881 3882 3883 3884
	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);
3885 3886 3887
	ret = init_srcu_struct(&head->srcu);
	if (ret)
		goto out_ida_remove;
C
Christoph Hellwig 已提交
3888 3889
	head->subsys = ctrl->subsys;
	head->ns_id = nsid;
3890
	head->ids = *ids;
C
Christoph Hellwig 已提交
3891 3892 3893 3894 3895 3896 3897 3898 3899
	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;
	}

3900 3901 3902 3903 3904 3905 3906
	if (head->ids.csi) {
		ret = nvme_get_effects_log(ctrl, head->ids.csi, &head->effects);
		if (ret)
			goto out_cleanup_srcu;
	} else
		head->effects = ctrl->effects;

3907 3908 3909 3910
	ret = nvme_mpath_alloc_disk(ctrl, head);
	if (ret)
		goto out_cleanup_srcu;

C
Christoph Hellwig 已提交
3911
	list_add_tail(&head->entry, &ctrl->subsys->nsheads);
3912 3913 3914

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

C
Christoph Hellwig 已提交
3915 3916 3917
	return head;
out_cleanup_srcu:
	cleanup_srcu_struct(&head->srcu);
3918
out_ida_remove:
C
Christoph Hellwig 已提交
3919 3920 3921 3922
	ida_simple_remove(&ctrl->subsys->ns_ida, head->instance);
out_free_head:
	kfree(head);
out:
3923 3924
	if (ret > 0)
		ret = blk_status_to_errno(nvme_error_status(ret));
C
Christoph Hellwig 已提交
3925 3926 3927 3928
	return ERR_PTR(ret);
}

static int nvme_init_ns_head(struct nvme_ns *ns, unsigned nsid,
3929
		struct nvme_ns_ids *ids, bool is_shared)
C
Christoph Hellwig 已提交
3930 3931 3932 3933 3934 3935
{
	struct nvme_ctrl *ctrl = ns->ctrl;
	struct nvme_ns_head *head = NULL;
	int ret = 0;

	mutex_lock(&ctrl->subsys->lock);
3936
	head = nvme_find_ns_head(ctrl->subsys, nsid);
C
Christoph Hellwig 已提交
3937
	if (!head) {
3938
		head = nvme_alloc_ns_head(ctrl, nsid, ids);
C
Christoph Hellwig 已提交
3939 3940 3941 3942
		if (IS_ERR(head)) {
			ret = PTR_ERR(head);
			goto out_unlock;
		}
3943
		head->shared = is_shared;
C
Christoph Hellwig 已提交
3944
	} else {
3945
		ret = -EINVAL;
3946
		if (!is_shared || !head->shared) {
3947
			dev_err(ctrl->device,
3948 3949
				"Duplicate unshared namespace %d\n", nsid);
			goto out_put_ns_head;
3950
		}
3951
		if (!nvme_ns_ids_equal(&head->ids, ids)) {
C
Christoph Hellwig 已提交
3952 3953 3954
			dev_err(ctrl->device,
				"IDs don't match for shared namespace %d\n",
					nsid);
3955
			goto out_put_ns_head;
C
Christoph Hellwig 已提交
3956 3957 3958
		}
	}

3959
	list_add_tail_rcu(&ns->siblings, &head->list);
C
Christoph Hellwig 已提交
3960
	ns->head = head;
3961 3962
	mutex_unlock(&ctrl->subsys->lock);
	return 0;
C
Christoph Hellwig 已提交
3963

3964 3965
out_put_ns_head:
	nvme_put_ns_head(head);
C
Christoph Hellwig 已提交
3966 3967 3968 3969 3970
out_unlock:
	mutex_unlock(&ctrl->subsys->lock);
	return ret;
}

3971 3972 3973 3974 3975
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 已提交
3976
	return nsa->head->ns_id - nsb->head->ns_id;
3977 3978
}

3979
struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid)
3980
{
3981
	struct nvme_ns *ns, *ret = NULL;
3982

3983
	down_read(&ctrl->namespaces_rwsem);
3984
	list_for_each_entry(ns, &ctrl->namespaces, list) {
C
Christoph Hellwig 已提交
3985
		if (ns->head->ns_id == nsid) {
3986 3987
			if (!kref_get_unless_zero(&ns->kref))
				continue;
3988 3989 3990
			ret = ns;
			break;
		}
C
Christoph Hellwig 已提交
3991
		if (ns->head->ns_id > nsid)
3992 3993
			break;
	}
3994
	up_read(&ctrl->namespaces_rwsem);
3995
	return ret;
3996
}
3997
EXPORT_SYMBOL_NS_GPL(nvme_find_get_ns, NVME_TARGET_PASSTHRU);
3998

3999 4000
static void nvme_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid,
		struct nvme_ns_ids *ids)
4001 4002 4003
{
	struct nvme_ns *ns;
	struct gendisk *disk;
4004 4005
	struct nvme_id_ns *id;
	char disk_name[DISK_NAME_LEN];
4006
	int node = ctrl->numa_node, flags = GENHD_FL_EXT_DEVT;
4007

4008
	if (nvme_identify_ns(ctrl, nsid, ids, &id))
4009 4010
		return;

4011 4012
	ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
	if (!ns)
4013
		goto out_free_id;
4014 4015

	ns->queue = blk_mq_init_queue(ctrl->tagset);
4016
	if (IS_ERR(ns->queue))
C
Christoph Hellwig 已提交
4017
		goto out_free_ns;
4018

4019
	if (ctrl->opts && ctrl->opts->data_digest)
4020
		blk_queue_flag_set(QUEUE_FLAG_STABLE_WRITES, ns->queue);
4021

4022
	blk_queue_flag_set(QUEUE_FLAG_NONROT, ns->queue);
4023 4024 4025
	if (ctrl->ops->flags & NVME_F_PCI_P2PDMA)
		blk_queue_flag_set(QUEUE_FLAG_PCI_P2PDMA, ns->queue);

4026 4027 4028 4029
	ns->queue->queuedata = ns;
	ns->ctrl = ctrl;
	kref_init(&ns->kref);

4030
	if (nvme_init_ns_head(ns, nsid, ids, id->nmic & NVME_NS_NMIC_SHARED))
4031
		goto out_free_queue;
4032
	nvme_set_disk_name(disk_name, ns, ctrl, &flags);
4033

4034
	disk = alloc_disk_node(0, node);
4035
	if (!disk)
C
Christoph Hellwig 已提交
4036
		goto out_unlink_ns;
4037

J
Javier González 已提交
4038
	disk->fops = &nvme_bdev_ops;
4039 4040
	disk->private_data = ns;
	disk->queue = ns->queue;
4041
	disk->flags = flags;
4042 4043 4044
	memcpy(disk->disk_name, disk_name, DISK_NAME_LEN);
	ns->disk = disk;

4045
	if (nvme_update_ns_info(ns, id))
4046
		goto out_put_disk;
4047

4048
	if ((ctrl->quirks & NVME_QUIRK_LIGHTNVM) && id->vs[0] == 0x1) {
4049
		if (nvme_nvm_register(ns, disk_name, node)) {
4050 4051 4052 4053 4054
			dev_warn(ctrl->device, "LightNVM init failure\n");
			goto out_put_disk;
		}
	}

4055
	down_write(&ctrl->namespaces_rwsem);
4056
	list_add_tail(&ns->list, &ctrl->namespaces);
4057
	up_write(&ctrl->namespaces_rwsem);
4058

4059
	nvme_get_ctrl(ctrl);
4060

4061
	device_add_disk(ctrl->device, ns->disk, nvme_ns_id_attr_groups);
4062

C
Christoph Hellwig 已提交
4063
	nvme_mpath_add_disk(ns, id);
4064
	nvme_fault_inject_init(&ns->fault_inject, ns->disk->disk_name);
C
Christoph Hellwig 已提交
4065 4066
	kfree(id);

4067
	return;
4068
 out_put_disk:
4069 4070
	/* prevent double queue cleanup */
	ns->disk->queue = NULL;
4071
	put_disk(ns->disk);
C
Christoph Hellwig 已提交
4072 4073 4074
 out_unlink_ns:
	mutex_lock(&ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
4075 4076
	if (list_empty(&ns->head->list))
		list_del_init(&ns->head->entry);
C
Christoph Hellwig 已提交
4077
	mutex_unlock(&ctrl->subsys->lock);
4078
	nvme_put_ns_head(ns->head);
4079 4080 4081 4082
 out_free_queue:
	blk_cleanup_queue(ns->queue);
 out_free_ns:
	kfree(ns);
4083 4084
 out_free_id:
	kfree(id);
4085 4086 4087 4088
}

static void nvme_ns_remove(struct nvme_ns *ns)
{
4089 4090
	if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
		return;
4091

4092
	set_capacity(ns->disk, 0);
4093
	nvme_fault_inject_fini(&ns->fault_inject);
4094 4095 4096

	mutex_lock(&ns->ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
4097 4098
	if (list_empty(&ns->head->list))
		list_del_init(&ns->head->entry);
4099
	mutex_unlock(&ns->ctrl->subsys->lock);
4100

4101 4102 4103 4104
	synchronize_rcu(); /* guarantee not available in head->list */
	nvme_mpath_clear_current_path(ns);
	synchronize_srcu(&ns->head->srcu); /* wait for concurrent submissions */

C
Christoph Hellwig 已提交
4105
	if (ns->disk->flags & GENHD_FL_UP) {
4106 4107
		del_gendisk(ns->disk);
		blk_cleanup_queue(ns->queue);
4108 4109
		if (blk_get_integrity(ns->disk))
			blk_integrity_unregister(ns->disk);
4110
	}
4111

4112
	down_write(&ns->ctrl->namespaces_rwsem);
4113
	list_del_init(&ns->list);
4114
	up_write(&ns->ctrl->namespaces_rwsem);
4115

4116
	nvme_mpath_check_last_path(ns);
4117 4118 4119
	nvme_put_ns(ns);
}

4120 4121 4122 4123 4124 4125 4126 4127 4128 4129
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);
	}
}

4130
static void nvme_validate_ns(struct nvme_ns *ns, struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
4131 4132
{
	struct nvme_id_ns *id;
4133
	int ret = NVME_SC_INVALID_NS | NVME_SC_DNR;
C
Christoph Hellwig 已提交
4134

4135 4136
	if (test_bit(NVME_NS_DEAD, &ns->flags))
		goto out;
C
Christoph Hellwig 已提交
4137

4138
	ret = nvme_identify_ns(ns->ctrl, ns->head->ns_id, ids, &id);
C
Christoph Hellwig 已提交
4139 4140 4141
	if (ret)
		goto out;

4142
	ret = NVME_SC_INVALID_NS | NVME_SC_DNR;
C
Christoph Hellwig 已提交
4143
	if (!nvme_ns_ids_equal(&ns->head->ids, ids)) {
4144
		dev_err(ns->ctrl->device,
C
Christoph Hellwig 已提交
4145
			"identifiers changed for nsid %d\n", ns->head->ns_id);
4146
		goto out_free_id;
C
Christoph Hellwig 已提交
4147 4148 4149
	}

	ret = nvme_update_ns_info(ns, id);
4150 4151

out_free_id:
C
Christoph Hellwig 已提交
4152 4153 4154
	kfree(id);
out:
	/*
4155
	 * Only remove the namespace if we got a fatal error back from the
C
Christoph Hellwig 已提交
4156
	 * device, otherwise ignore the error and just move on.
4157 4158
	 *
	 * TODO: we should probably schedule a delayed retry here.
C
Christoph Hellwig 已提交
4159
	 */
4160
	if (ret > 0 && (ret & NVME_SC_DNR))
4161
		nvme_ns_remove(ns);
C
Christoph Hellwig 已提交
4162 4163
}

4164
static void nvme_validate_or_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid)
4165
{
4166
	struct nvme_ns_ids ids = { };
4167 4168
	struct nvme_ns *ns;

4169 4170
	if (nvme_identify_ns_descs(ctrl, nsid, &ids))
		return;
4171

4172
	ns = nvme_find_get_ns(ctrl, nsid);
4173
	if (ns) {
4174
		nvme_validate_ns(ns, &ids);
4175
		nvme_put_ns(ns);
4176 4177 4178
		return;
	}

4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189
	switch (ids.csi) {
	case NVME_CSI_NVM:
		nvme_alloc_ns(ctrl, nsid, &ids);
		break;
	case NVME_CSI_ZNS:
		if (!IS_ENABLED(CONFIG_BLK_DEV_ZONED)) {
			dev_warn(ctrl->device,
				"nsid %u not supported without CONFIG_BLK_DEV_ZONED\n",
				nsid);
			break;
		}
4190 4191 4192
		if (!nvme_multi_css(ctrl)) {
			dev_warn(ctrl->device,
				"command set not reported for nsid: %d\n",
4193
				nsid);
4194 4195
			break;
		}
4196 4197 4198 4199 4200 4201 4202
		nvme_alloc_ns(ctrl, nsid, &ids);
		break;
	default:
		dev_warn(ctrl->device, "unknown csi %u for nsid %u\n",
			ids.csi, nsid);
		break;
	}
4203 4204
}

4205 4206 4207 4208
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					unsigned nsid)
{
	struct nvme_ns *ns, *next;
4209
	LIST_HEAD(rm_list);
4210

4211
	down_write(&ctrl->namespaces_rwsem);
4212
	list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) {
4213
		if (ns->head->ns_id > nsid || test_bit(NVME_NS_DEAD, &ns->flags))
4214
			list_move_tail(&ns->list, &rm_list);
4215
	}
4216
	up_write(&ctrl->namespaces_rwsem);
4217 4218 4219 4220

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

4221 4222
}

4223
static int nvme_scan_ns_list(struct nvme_ctrl *ctrl)
4224
{
4225
	const int nr_entries = NVME_IDENTIFY_DATA_SIZE / sizeof(__le32);
4226
	__le32 *ns_list;
4227 4228
	u32 prev = 0;
	int ret = 0, i;
4229

4230 4231
	if (nvme_ctrl_limited_cns(ctrl))
		return -EOPNOTSUPP;
4232

4233
	ns_list = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
4234 4235 4236
	if (!ns_list)
		return -ENOMEM;

4237
	for (;;) {
4238 4239 4240 4241 4242 4243 4244 4245
		struct nvme_command cmd = {
			.identify.opcode	= nvme_admin_identify,
			.identify.cns		= NVME_ID_CNS_NS_ACTIVE_LIST,
			.identify.nsid		= cpu_to_le32(prev),
		};

		ret = nvme_submit_sync_cmd(ctrl->admin_q, &cmd, ns_list,
					    NVME_IDENTIFY_DATA_SIZE);
4246 4247 4248
		if (ret) {
			dev_warn(ctrl->device,
				"Identify NS List failed (status=0x%x)\n", ret);
4249
			goto free;
4250
		}
4251

4252
		for (i = 0; i < nr_entries; i++) {
4253
			u32 nsid = le32_to_cpu(ns_list[i]);
4254

4255 4256
			if (!nsid)	/* end of the list? */
				goto out;
4257
			nvme_validate_or_alloc_ns(ctrl, nsid);
4258 4259
			while (++prev < nsid)
				nvme_ns_remove_by_nsid(ctrl, prev);
4260 4261 4262
		}
	}
 out:
4263 4264
	nvme_remove_invalid_namespaces(ctrl, prev);
 free:
4265 4266 4267 4268
	kfree(ns_list);
	return ret;
}

4269
static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl)
4270
{
4271 4272 4273 4274 4275 4276 4277
	struct nvme_id_ctrl *id;
	u32 nn, i;

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

4279
	for (i = 1; i <= nn; i++)
4280
		nvme_validate_or_alloc_ns(ctrl, i);
4281

4282
	nvme_remove_invalid_namespaces(ctrl, nn);
4283 4284
}

4285
static void nvme_clear_changed_ns_log(struct nvme_ctrl *ctrl)
4286 4287 4288
{
	size_t log_size = NVME_MAX_CHANGED_NAMESPACES * sizeof(__le32);
	__le32 *log;
4289
	int error;
4290 4291 4292

	log = kzalloc(log_size, GFP_KERNEL);
	if (!log)
4293
		return;
4294

4295 4296 4297 4298 4299 4300
	/*
	 * 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.
	 */
4301 4302
	error = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CHANGED_NS, 0,
			NVME_CSI_NVM, log, log_size, 0);
4303
	if (error)
4304 4305 4306 4307 4308 4309
		dev_warn(ctrl->device,
			"reading changed ns log failed: %d\n", error);

	kfree(log);
}

4310
static void nvme_scan_work(struct work_struct *work)
4311
{
4312 4313
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, scan_work);
4314

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

D
Dan Carpenter 已提交
4319
	if (test_and_clear_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events)) {
4320
		dev_info(ctrl->device, "rescanning namespaces.\n");
4321
		nvme_clear_changed_ns_log(ctrl);
4322 4323
	}

4324
	mutex_lock(&ctrl->scan_lock);
4325 4326
	if (nvme_scan_ns_list(ctrl) != 0)
		nvme_scan_ns_sequential(ctrl);
4327
	mutex_unlock(&ctrl->scan_lock);
4328

4329
	down_write(&ctrl->namespaces_rwsem);
4330
	list_sort(NULL, &ctrl->namespaces, ns_cmp);
4331
	up_write(&ctrl->namespaces_rwsem);
4332
}
4333

4334 4335 4336 4337 4338
/*
 * 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.
 */
4339 4340 4341
void nvme_remove_namespaces(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns, *next;
4342
	LIST_HEAD(ns_list);
4343

4344 4345 4346 4347 4348 4349 4350
	/*
	 * 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);

4351 4352 4353
	/* prevent racing with ns scanning */
	flush_work(&ctrl->scan_work);

4354 4355 4356 4357 4358 4359 4360 4361 4362
	/*
	 * 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);

4363 4364 4365
	/* this is a no-op when called from the controller reset handler */
	nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING_NOIO);

4366
	down_write(&ctrl->namespaces_rwsem);
4367
	list_splice_init(&ctrl->namespaces, &ns_list);
4368
	up_write(&ctrl->namespaces_rwsem);
4369 4370

	list_for_each_entry_safe(ns, next, &ns_list, list)
4371 4372
		nvme_ns_remove(ns);
}
4373
EXPORT_SYMBOL_GPL(nvme_remove_namespaces);
4374

4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401
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;
}

4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417
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]);
}

4418 4419 4420 4421 4422
static void nvme_async_event_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, async_event_work);

4423
	nvme_aen_uevent(ctrl);
4424
	ctrl->ops->submit_async_event(ctrl);
4425 4426
}

4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448
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;

4449 4450
	if (nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_FW_SLOT, 0, NVME_CSI_NVM,
			log, sizeof(*log), 0))
4451
		dev_warn(ctrl->device, "Get FW SLOT INFO log error\n");
4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472
	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");
4473 4474
			nvme_try_sched_reset(ctrl);
			return;
4475 4476 4477 4478
		}
		msleep(100);
	}

4479
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE))
4480 4481 4482
		return;

	nvme_start_queues(ctrl);
4483
	/* read FW slot information to clear the AER */
4484 4485 4486
	nvme_get_fw_slot_info(ctrl);
}

4487 4488
static void nvme_handle_aen_notice(struct nvme_ctrl *ctrl, u32 result)
{
4489 4490
	u32 aer_notice_type = (result & 0xff00) >> 8;

4491 4492
	trace_nvme_async_event(ctrl, aer_notice_type);

4493
	switch (aer_notice_type) {
4494
	case NVME_AER_NOTICE_NS_CHANGED:
D
Dan Carpenter 已提交
4495
		set_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events);
4496 4497 4498
		nvme_queue_scan(ctrl);
		break;
	case NVME_AER_NOTICE_FW_ACT_STARTING:
4499 4500 4501 4502 4503 4504 4505
		/*
		 * 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);
4506
		break;
C
Christoph Hellwig 已提交
4507 4508 4509 4510 4511 4512 4513
#ifdef CONFIG_NVME_MULTIPATH
	case NVME_AER_NOTICE_ANA:
		if (!ctrl->ana_log_buf)
			break;
		queue_work(nvme_wq, &ctrl->ana_work);
		break;
#endif
4514 4515 4516
	case NVME_AER_NOTICE_DISC_CHANGED:
		ctrl->aen_result = result;
		break;
4517 4518 4519 4520 4521
	default:
		dev_warn(ctrl->device, "async event result %08x\n", result);
	}
}

4522
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
4523
		volatile union nvme_result *res)
4524
{
4525
	u32 result = le32_to_cpu(res->u32);
4526
	u32 aer_type = result & 0x07;
4527

4528
	if (le16_to_cpu(status) >> 1 != NVME_SC_SUCCESS)
4529 4530
		return;

4531
	switch (aer_type) {
4532 4533 4534
	case NVME_AER_NOTICE:
		nvme_handle_aen_notice(ctrl, result);
		break;
4535 4536 4537 4538
	case NVME_AER_ERROR:
	case NVME_AER_SMART:
	case NVME_AER_CSS:
	case NVME_AER_VS:
4539
		trace_nvme_async_event(ctrl, aer_type);
4540
		ctrl->aen_result = result;
4541 4542 4543
		break;
	default:
		break;
4544
	}
4545
	queue_work(nvme_wq, &ctrl->async_event_work);
4546 4547
}
EXPORT_SYMBOL_GPL(nvme_complete_async_event);
4548

4549
void nvme_stop_ctrl(struct nvme_ctrl *ctrl)
4550
{
C
Christoph Hellwig 已提交
4551
	nvme_mpath_stop(ctrl);
4552
	nvme_stop_keep_alive(ctrl);
4553
	nvme_stop_failfast_work(ctrl);
4554
	flush_work(&ctrl->async_event_work);
4555
	cancel_work_sync(&ctrl->fw_act_work);
4556 4557 4558 4559 4560
}
EXPORT_SYMBOL_GPL(nvme_stop_ctrl);

void nvme_start_ctrl(struct nvme_ctrl *ctrl)
{
4561
	nvme_start_keep_alive(ctrl);
4562

4563 4564
	nvme_enable_aen(ctrl);

4565 4566 4567 4568 4569 4570
	if (ctrl->queue_count > 1) {
		nvme_queue_scan(ctrl);
		nvme_start_queues(ctrl);
	}
}
EXPORT_SYMBOL_GPL(nvme_start_ctrl);
4571

4572 4573
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl)
{
4574
	nvme_hwmon_exit(ctrl);
4575
	nvme_fault_inject_fini(&ctrl->fault_inject);
4576
	dev_pm_qos_hide_latency_tolerance(ctrl->device);
4577
	cdev_device_del(&ctrl->cdev, ctrl->device);
4578
	nvme_put_ctrl(ctrl);
4579
}
4580
EXPORT_SYMBOL_GPL(nvme_uninit_ctrl);
4581

4582 4583 4584 4585 4586
static void nvme_free_cels(struct nvme_ctrl *ctrl)
{
	struct nvme_effects_log	*cel;
	unsigned long i;

4587
	xa_for_each(&ctrl->cels, i, cel) {
4588 4589 4590 4591 4592 4593 4594
		xa_erase(&ctrl->cels, i);
		kfree(cel);
	}

	xa_destroy(&ctrl->cels);
}

4595
static void nvme_free_ctrl(struct device *dev)
4596
{
4597 4598
	struct nvme_ctrl *ctrl =
		container_of(dev, struct nvme_ctrl, ctrl_device);
C
Christoph Hellwig 已提交
4599
	struct nvme_subsystem *subsys = ctrl->subsys;
4600

K
Keith Busch 已提交
4601
	if (!subsys || ctrl->instance != subsys->instance)
4602 4603
		ida_simple_remove(&nvme_instance_ida, ctrl->instance);

4604
	nvme_free_cels(ctrl);
C
Christoph Hellwig 已提交
4605
	nvme_mpath_uninit(ctrl);
S
Sagi Grimberg 已提交
4606
	__free_page(ctrl->discard_page);
4607

C
Christoph Hellwig 已提交
4608
	if (subsys) {
4609
		mutex_lock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4610 4611
		list_del(&ctrl->subsys_entry);
		sysfs_remove_link(&subsys->dev.kobj, dev_name(ctrl->device));
4612
		mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4613
	}
4614 4615 4616

	ctrl->ops->free_ctrl(ctrl);

C
Christoph Hellwig 已提交
4617 4618
	if (subsys)
		nvme_put_subsystem(subsys);
4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630
}

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

4631
	ctrl->state = NVME_CTRL_NEW;
4632
	clear_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags);
4633
	spin_lock_init(&ctrl->lock);
4634
	mutex_init(&ctrl->scan_lock);
4635
	INIT_LIST_HEAD(&ctrl->namespaces);
4636
	xa_init(&ctrl->cels);
4637
	init_rwsem(&ctrl->namespaces_rwsem);
4638 4639 4640
	ctrl->dev = dev;
	ctrl->ops = ops;
	ctrl->quirks = quirks;
4641
	ctrl->numa_node = NUMA_NO_NODE;
4642
	INIT_WORK(&ctrl->scan_work, nvme_scan_work);
4643
	INIT_WORK(&ctrl->async_event_work, nvme_async_event_work);
4644
	INIT_WORK(&ctrl->fw_act_work, nvme_fw_act_work);
4645
	INIT_WORK(&ctrl->delete_work, nvme_delete_ctrl_work);
4646
	init_waitqueue_head(&ctrl->state_wq);
4647

4648
	INIT_DELAYED_WORK(&ctrl->ka_work, nvme_keep_alive_work);
4649
	INIT_DELAYED_WORK(&ctrl->failfast_work, nvme_failfast_work);
4650 4651 4652
	memset(&ctrl->ka_cmd, 0, sizeof(ctrl->ka_cmd));
	ctrl->ka_cmd.common.opcode = nvme_admin_keep_alive;

4653 4654 4655 4656 4657 4658 4659 4660
	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;
	}

4661 4662
	ret = ida_simple_get(&nvme_instance_ida, 0, 0, GFP_KERNEL);
	if (ret < 0)
4663
		goto out;
4664
	ctrl->instance = ret;
4665

4666 4667
	device_initialize(&ctrl->ctrl_device);
	ctrl->device = &ctrl->ctrl_device;
4668 4669
	ctrl->device->devt = MKDEV(MAJOR(nvme_ctrl_base_chr_devt),
			ctrl->instance);
4670 4671 4672 4673 4674 4675 4676
	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)
4677 4678
		goto out_release_instance;

4679
	nvme_get_ctrl(ctrl);
4680 4681 4682
	cdev_init(&ctrl->cdev, &nvme_dev_fops);
	ctrl->cdev.owner = ops->module;
	ret = cdev_device_add(&ctrl->cdev, ctrl->device);
4683 4684
	if (ret)
		goto out_free_name;
4685

4686 4687 4688 4689 4690 4691 4692 4693
	/*
	 * 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));

4694 4695
	nvme_fault_inject_init(&ctrl->fault_inject, dev_name(ctrl->device));

4696
	return 0;
4697
out_free_name:
4698
	nvme_put_ctrl(ctrl);
4699
	kfree_const(ctrl->device->kobj.name);
4700
out_release_instance:
4701
	ida_simple_remove(&nvme_instance_ida, ctrl->instance);
4702
out:
4703 4704
	if (ctrl->discard_page)
		__free_page(ctrl->discard_page);
4705 4706
	return ret;
}
4707
EXPORT_SYMBOL_GPL(nvme_init_ctrl);
4708

4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719
/**
 * 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;

4720
	down_read(&ctrl->namespaces_rwsem);
M
Ming Lei 已提交
4721

4722
	/* Forcibly unquiesce queues to avoid blocking dispatch */
I
Igor Konopko 已提交
4723
	if (ctrl->admin_q && !blk_queue_dying(ctrl->admin_q))
4724
		blk_mq_unquiesce_queue(ctrl->admin_q);
4725

4726 4727
	list_for_each_entry(ns, &ctrl->namespaces, list)
		nvme_set_queue_dying(ns);
4728

4729
	up_read(&ctrl->namespaces_rwsem);
4730
}
4731
EXPORT_SYMBOL_GPL(nvme_kill_queues);
4732

K
Keith Busch 已提交
4733 4734 4735 4736
void nvme_unfreeze(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

4737
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4738 4739
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_unfreeze_queue(ns->queue);
4740
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4741 4742 4743
}
EXPORT_SYMBOL_GPL(nvme_unfreeze);

4744
int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout)
K
Keith Busch 已提交
4745 4746 4747
{
	struct nvme_ns *ns;

4748
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4749 4750 4751 4752 4753
	list_for_each_entry(ns, &ctrl->namespaces, list) {
		timeout = blk_mq_freeze_queue_wait_timeout(ns->queue, timeout);
		if (timeout <= 0)
			break;
	}
4754
	up_read(&ctrl->namespaces_rwsem);
4755
	return timeout;
K
Keith Busch 已提交
4756 4757 4758 4759 4760 4761 4762
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze_timeout);

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

4763
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4764 4765
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_freeze_queue_wait(ns->queue);
4766
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4767 4768 4769 4770 4771 4772 4773
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze);

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

4774
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4775
	list_for_each_entry(ns, &ctrl->namespaces, list)
4776
		blk_freeze_queue_start(ns->queue);
4777
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4778 4779 4780
}
EXPORT_SYMBOL_GPL(nvme_start_freeze);

4781
void nvme_stop_queues(struct nvme_ctrl *ctrl)
4782 4783 4784
{
	struct nvme_ns *ns;

4785
	down_read(&ctrl->namespaces_rwsem);
4786
	list_for_each_entry(ns, &ctrl->namespaces, list)
4787
		blk_mq_quiesce_queue(ns->queue);
4788
	up_read(&ctrl->namespaces_rwsem);
4789
}
4790
EXPORT_SYMBOL_GPL(nvme_stop_queues);
4791

4792
void nvme_start_queues(struct nvme_ctrl *ctrl)
4793 4794 4795
{
	struct nvme_ns *ns;

4796
	down_read(&ctrl->namespaces_rwsem);
4797
	list_for_each_entry(ns, &ctrl->namespaces, list)
4798
		blk_mq_unquiesce_queue(ns->queue);
4799
	up_read(&ctrl->namespaces_rwsem);
4800
}
4801
EXPORT_SYMBOL_GPL(nvme_start_queues);
4802

C
Chao Leng 已提交
4803
void nvme_sync_io_queues(struct nvme_ctrl *ctrl)
K
Keith Busch 已提交
4804 4805 4806 4807 4808 4809 4810
{
	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);
C
Chao Leng 已提交
4811 4812
}
EXPORT_SYMBOL_GPL(nvme_sync_io_queues);
4813

C
Chao Leng 已提交
4814 4815 4816
void nvme_sync_queues(struct nvme_ctrl *ctrl)
{
	nvme_sync_io_queues(ctrl);
4817 4818
	if (ctrl->admin_q)
		blk_sync_queue(ctrl->admin_q);
K
Keith Busch 已提交
4819 4820 4821
}
EXPORT_SYMBOL_GPL(nvme_sync_queues);

4822
struct nvme_ctrl *nvme_ctrl_from_file(struct file *file)
4823
{
4824 4825 4826
	if (file->f_op != &nvme_dev_fops)
		return NULL;
	return file->private_data;
4827
}
4828
EXPORT_SYMBOL_NS_GPL(nvme_ctrl_from_file, NVME_TARGET_PASSTHRU);
4829

4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847
/*
 * 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);
K
Keith Busch 已提交
4848 4849
	BUILD_BUG_ON(sizeof(struct nvme_id_ns_zns) != NVME_IDENTIFY_DATA_SIZE);
	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl_zns) != NVME_IDENTIFY_DATA_SIZE);
4850
	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl_nvm) != NVME_IDENTIFY_DATA_SIZE);
4851 4852 4853 4854 4855 4856 4857
	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);
}


4858
static int __init nvme_core_init(void)
4859
{
4860
	int result = -ENOMEM;
4861

4862 4863
	_nvme_check_size();

4864 4865 4866
	nvme_wq = alloc_workqueue("nvme-wq",
			WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0);
	if (!nvme_wq)
4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877
		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;
4878

4879 4880
	result = alloc_chrdev_region(&nvme_ctrl_base_chr_devt, 0,
			NVME_MINORS, "nvme");
4881
	if (result < 0)
4882
		goto destroy_delete_wq;
4883 4884 4885 4886 4887 4888

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

C
Christoph Hellwig 已提交
4891 4892 4893 4894 4895
	nvme_subsys_class = class_create(THIS_MODULE, "nvme-subsystem");
	if (IS_ERR(nvme_subsys_class)) {
		result = PTR_ERR(nvme_subsys_class);
		goto destroy_class;
	}
4896
	return 0;
4897

C
Christoph Hellwig 已提交
4898 4899
destroy_class:
	class_destroy(nvme_class);
4900
unregister_chrdev:
4901
	unregister_chrdev_region(nvme_ctrl_base_chr_devt, NVME_MINORS);
4902 4903 4904 4905
destroy_delete_wq:
	destroy_workqueue(nvme_delete_wq);
destroy_reset_wq:
	destroy_workqueue(nvme_reset_wq);
4906 4907
destroy_wq:
	destroy_workqueue(nvme_wq);
4908
out:
4909
	return result;
4910 4911
}

4912
static void __exit nvme_core_exit(void)
4913
{
C
Christoph Hellwig 已提交
4914
	class_destroy(nvme_subsys_class);
4915
	class_destroy(nvme_class);
4916
	unregister_chrdev_region(nvme_ctrl_base_chr_devt, NVME_MINORS);
4917 4918
	destroy_workqueue(nvme_delete_wq);
	destroy_workqueue(nvme_reset_wq);
4919
	destroy_workqueue(nvme_wq);
M
Max Gurtovoy 已提交
4920
	ida_destroy(&nvme_instance_ida);
4921
}
4922 4923 4924 4925 4926

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