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

#include <linux/blkdev.h>
#include <linux/blk-mq.h>
9
#include <linux/blk-integrity.h>
10
#include <linux/compat.h>
11
#include <linux/delay.h>
12
#include <linux/errno.h>
13
#include <linux/hdreg.h>
14
#include <linux/kernel.h>
15
#include <linux/module.h>
16
#include <linux/backing-dev.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
#include <linux/nvme-auth.h>
28

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

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

34 35 36 37 38
struct nvme_ns_info {
	struct nvme_ns_ids ids;
	u32 nsid;
	__le32 anagrpid;
	bool is_shared;
39
	bool is_readonly;
40 41 42
	bool is_ready;
};

43 44
unsigned int admin_timeout = 60;
module_param(admin_timeout, uint, 0644);
45
MODULE_PARM_DESC(admin_timeout, "timeout in seconds for admin commands");
46
EXPORT_SYMBOL_GPL(admin_timeout);
47

48 49
unsigned int nvme_io_timeout = 30;
module_param_named(io_timeout, nvme_io_timeout, uint, 0644);
50
MODULE_PARM_DESC(io_timeout, "timeout in seconds for I/O");
51
EXPORT_SYMBOL_GPL(nvme_io_timeout);
52

53
static unsigned char shutdown_timeout = 5;
54 55 56
module_param(shutdown_timeout, byte, 0644);
MODULE_PARM_DESC(shutdown_timeout, "timeout in seconds for controller shutdown");

57 58
static u8 nvme_max_retries = 5;
module_param_named(max_retries, nvme_max_retries, byte, 0644);
K
Keith Busch 已提交
59
MODULE_PARM_DESC(max_retries, "max number of retries a command may have");
60

61
static unsigned long default_ps_max_latency_us = 100000;
62 63 64 65
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");

66 67 68 69
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");

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
static unsigned long apst_primary_timeout_ms = 100;
module_param(apst_primary_timeout_ms, ulong, 0644);
MODULE_PARM_DESC(apst_primary_timeout_ms,
	"primary APST timeout in ms");

static unsigned long apst_secondary_timeout_ms = 2000;
module_param(apst_secondary_timeout_ms, ulong, 0644);
MODULE_PARM_DESC(apst_secondary_timeout_ms,
	"secondary APST timeout in ms");

static unsigned long apst_primary_latency_tol_us = 15000;
module_param(apst_primary_latency_tol_us, ulong, 0644);
MODULE_PARM_DESC(apst_primary_latency_tol_us,
	"primary APST latency tolerance in us");

static unsigned long apst_secondary_latency_tol_us = 100000;
module_param(apst_secondary_latency_tol_us, ulong, 0644);
MODULE_PARM_DESC(apst_secondary_latency_tol_us,
	"secondary APST latency tolerance in us");

90 91 92 93 94
/*
 * 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
 *
95 96
 * nvme_wq will host works such as scan, aen handling, fw activation,
 * keep-alive, periodic reconnects etc. nvme_reset_wq
97 98 99 100
 * 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.
 */
101 102 103
struct workqueue_struct *nvme_wq;
EXPORT_SYMBOL_GPL(nvme_wq);

104 105 106 107 108 109
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 已提交
110 111
static LIST_HEAD(nvme_subsystems);
static DEFINE_MUTEX(nvme_subsystems_lock);
112

113
static DEFINE_IDA(nvme_instance_ida);
114
static dev_t nvme_ctrl_base_chr_devt;
115
static struct class *nvme_class;
C
Christoph Hellwig 已提交
116
static struct class *nvme_subsys_class;
117

118 119 120 121
static DEFINE_IDA(nvme_ns_chr_minor_ida);
static dev_t nvme_ns_chr_devt;
static struct class *nvme_ns_chr_class;

122
static void nvme_put_subsystem(struct nvme_subsystem *subsys);
123 124
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					   unsigned nsid);
125 126
static void nvme_update_keep_alive(struct nvme_ctrl *ctrl,
				   struct nvme_command *cmd);
127

128
void nvme_queue_scan(struct nvme_ctrl *ctrl)
129 130 131 132
{
	/*
	 * Only new queue scan work when admin and IO queues are both alive
	 */
K
Keith Busch 已提交
133
	if (ctrl->state == NVME_CTRL_LIVE && ctrl->tagset)
134 135 136
		queue_work(nvme_wq, &ctrl->scan_work);
}

137 138 139 140 141 142
/*
 * 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.
 */
143
int nvme_try_sched_reset(struct nvme_ctrl *ctrl)
144 145 146 147 148 149 150
{
	if (ctrl->state != NVME_CTRL_RESETTING)
		return -EBUSY;
	if (!queue_work(nvme_reset_wq, &ctrl->reset_work))
		return -EBUSY;
	return 0;
}
151
EXPORT_SYMBOL_GPL(nvme_try_sched_reset);
152

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
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);
}


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

195
int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl)
196 197 198 199
{
	int ret;

	ret = nvme_reset_ctrl(ctrl);
200
	if (!ret) {
201
		flush_work(&ctrl->reset_work);
K
Keith Busch 已提交
202
		if (ctrl->state != NVME_CTRL_LIVE)
203 204 205
			ret = -ENETRESET;
	}

206 207 208
	return ret;
}

209
static void nvme_do_delete_ctrl(struct nvme_ctrl *ctrl)
210
{
211
	dev_info(ctrl->device,
212
		 "Removing ctrl: NQN \"%s\"\n", nvmf_ctrl_subsysnqn(ctrl));
213

214
	flush_work(&ctrl->reset_work);
215 216
	nvme_stop_ctrl(ctrl);
	nvme_remove_namespaces(ctrl);
217
	ctrl->ops->delete_ctrl(ctrl);
218
	nvme_uninit_ctrl(ctrl);
219 220
}

221 222 223 224 225 226 227 228
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);
}

229 230 231 232
int nvme_delete_ctrl(struct nvme_ctrl *ctrl)
{
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
		return -EBUSY;
233
	if (!queue_work(nvme_delete_wq, &ctrl->delete_work))
234 235 236 237 238
		return -EBUSY;
	return 0;
}
EXPORT_SYMBOL_GPL(nvme_delete_ctrl);

239
static void nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl)
240 241
{
	/*
242 243
	 * Keep a reference until nvme_do_delete_ctrl() complete,
	 * since ->delete_ctrl can free the controller.
244 245
	 */
	nvme_get_ctrl(ctrl);
246
	if (nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
247
		nvme_do_delete_ctrl(ctrl);
248 249 250
	nvme_put_ctrl(ctrl);
}

251
static blk_status_t nvme_error_status(u16 status)
252
{
253
	switch (status & 0x7ff) {
254
	case NVME_SC_SUCCESS:
255
		return BLK_STS_OK;
256
	case NVME_SC_CAP_EXCEEDED:
257
		return BLK_STS_NOSPC;
258
	case NVME_SC_LBA_RANGE:
259 260
	case NVME_SC_CMD_INTERRUPTED:
	case NVME_SC_NS_NOT_READY:
261 262
		return BLK_STS_TARGET;
	case NVME_SC_BAD_ATTRIBUTES:
263
	case NVME_SC_ONCS_NOT_SUPPORTED:
264 265 266
	case NVME_SC_INVALID_OPCODE:
	case NVME_SC_INVALID_FIELD:
	case NVME_SC_INVALID_NS:
267
		return BLK_STS_NOTSUPP;
268 269 270
	case NVME_SC_WRITE_FAULT:
	case NVME_SC_READ_ERROR:
	case NVME_SC_UNWRITTEN_BLOCK:
271 272
	case NVME_SC_ACCESS_DENIED:
	case NVME_SC_READ_ONLY:
273
	case NVME_SC_COMPARE_FAILED:
274
		return BLK_STS_MEDIUM;
275 276 277 278 279 280 281
	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;
282 283
	case NVME_SC_HOST_PATH_ERROR:
		return BLK_STS_TRANSPORT;
K
Keith Busch 已提交
284 285 286 287
	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;
288 289
	default:
		return BLK_STS_IOERR;
290 291 292
	}
}

293 294 295 296 297 298 299
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;
300 301
	if (crd)
		delay = nvme_req(req)->ctrl->crdt[crd - 1] * 100;
302 303 304 305 306 307

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

A
Alan Adamson 已提交
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
static void nvme_log_error(struct request *req)
{
	struct nvme_ns *ns = req->q->queuedata;
	struct nvme_request *nr = nvme_req(req);

	if (ns) {
		pr_err_ratelimited("%s: %s(0x%x) @ LBA %llu, %llu blocks, %s (sct 0x%x / sc 0x%x) %s%s\n",
		       ns->disk ? ns->disk->disk_name : "?",
		       nvme_get_opcode_str(nr->cmd->common.opcode),
		       nr->cmd->common.opcode,
		       (unsigned long long)nvme_sect_to_lba(ns, blk_rq_pos(req)),
		       (unsigned long long)blk_rq_bytes(req) >> ns->lba_shift,
		       nvme_get_error_status_str(nr->status),
		       nr->status >> 8 & 7,	/* Status Code Type */
		       nr->status & 0xff,	/* Status Code */
		       nr->status & NVME_SC_MORE ? "MORE " : "",
		       nr->status & NVME_SC_DNR  ? "DNR "  : "");
		return;
	}

	pr_err_ratelimited("%s: %s(0x%x), %s (sct 0x%x / sc 0x%x) %s%s\n",
			   dev_name(nr->ctrl->device),
			   nvme_get_admin_opcode_str(nr->cmd->common.opcode),
			   nr->cmd->common.opcode,
			   nvme_get_error_status_str(nr->status),
			   nr->status >> 8 & 7,	/* Status Code Type */
			   nr->status & 0xff,	/* Status Code */
			   nr->status & NVME_SC_MORE ? "MORE " : "",
			   nr->status & NVME_SC_DNR  ? "DNR "  : "");
}

339 340 341 342
enum nvme_disposition {
	COMPLETE,
	RETRY,
	FAILOVER,
343
	AUTHENTICATE,
344 345 346
};

static inline enum nvme_disposition nvme_decide_disposition(struct request *req)
347
{
348 349
	if (likely(nvme_req(req)->status == 0))
		return COMPLETE;
350

351 352 353
	if ((nvme_req(req)->status & 0x7ff) == NVME_SC_AUTH_REQUIRED)
		return AUTHENTICATE;

354 355 356 357
	if (blk_noretry_request(req) ||
	    (nvme_req(req)->status & NVME_SC_DNR) ||
	    nvme_req(req)->retries >= nvme_max_retries)
		return COMPLETE;
358

359
	if (req->cmd_flags & REQ_NVME_MPATH) {
360 361
		if (nvme_is_path_error(nvme_req(req)->status) ||
		    blk_queue_dying(req->q))
362
			return FAILOVER;
363 364 365
	} else {
		if (blk_queue_dying(req->q))
			return COMPLETE;
366
	}
367

368 369
	return RETRY;
}
370

371
static inline void nvme_end_req_zoned(struct request *req)
372 373 374
{
	if (IS_ENABLED(CONFIG_BLK_DEV_ZONED) &&
	    req_op(req) == REQ_OP_ZONE_APPEND)
K
Keith Busch 已提交
375 376
		req->__sector = nvme_lba_to_sect(req->q->queuedata,
			le64_to_cpu(nvme_req(req)->result.u64));
377 378 379 380 381
}

static inline void nvme_end_req(struct request *req)
{
	blk_status_t status = nvme_error_status(nvme_req(req)->status);
H
Hannes Reinecke 已提交
382

383
	if (unlikely(nvme_req(req)->status && !(req->rq_flags & RQF_QUIET)))
A
Alan Adamson 已提交
384
		nvme_log_error(req);
385
	nvme_end_req_zoned(req);
386
	nvme_trace_bio_complete(req);
387
	blk_mq_end_request(req, status);
388
}
389 390 391

void nvme_complete_rq(struct request *req)
{
392 393
	struct nvme_ctrl *ctrl = nvme_req(req)->ctrl;

394 395 396
	trace_nvme_complete_rq(req);
	nvme_cleanup_cmd(req);

397 398
	if (ctrl->kas)
		ctrl->comp_seen = true;
399 400 401 402 403 404 405 406 407 408 409

	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;
410 411 412 413 414 415 416 417
	case AUTHENTICATE:
#ifdef CONFIG_NVME_AUTH
		queue_work(nvme_wq, &ctrl->dhchap_auth_work);
		nvme_retry_req(req);
#else
		nvme_end_req(req);
#endif
		return;
418 419
	}
}
420 421
EXPORT_SYMBOL_GPL(nvme_complete_rq);

422 423
void nvme_complete_batch_req(struct request *req)
{
424
	trace_nvme_complete_rq(req);
425 426 427 428 429
	nvme_cleanup_cmd(req);
	nvme_end_req_zoned(req);
}
EXPORT_SYMBOL_GPL(nvme_complete_batch_req);

430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
/*
 * 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);

445
bool nvme_cancel_request(struct request *req, void *data)
446 447 448 449
{
	dev_dbg_ratelimited(((struct nvme_ctrl *) data)->device,
				"Cancelling I/O %d", req->tag);

450 451 452 453
	/* don't abort one completed request */
	if (blk_mq_request_completed(req))
		return true;

454
	nvme_req(req)->status = NVME_SC_HOST_ABORTED_CMD;
455
	nvme_req(req)->flags |= NVME_REQ_CANCELLED;
456
	blk_mq_complete_request(req);
457
	return true;
458 459 460
}
EXPORT_SYMBOL_GPL(nvme_cancel_request);

C
Chao Leng 已提交
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
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);

481 482 483
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state)
{
484
	enum nvme_ctrl_state old_state;
485
	unsigned long flags;
486 487
	bool changed = false;

488
	spin_lock_irqsave(&ctrl->lock, flags);
489 490

	old_state = ctrl->state;
491 492 493
	switch (new_state) {
	case NVME_CTRL_LIVE:
		switch (old_state) {
494
		case NVME_CTRL_NEW:
495
		case NVME_CTRL_RESETTING:
496
		case NVME_CTRL_CONNECTING:
497
			changed = true;
498
			fallthrough;
499 500 501 502 503 504 505
		default:
			break;
		}
		break;
	case NVME_CTRL_RESETTING:
		switch (old_state) {
		case NVME_CTRL_NEW:
506 507
		case NVME_CTRL_LIVE:
			changed = true;
508
			fallthrough;
509 510 511 512
		default:
			break;
		}
		break;
513
	case NVME_CTRL_CONNECTING:
514
		switch (old_state) {
515
		case NVME_CTRL_NEW:
516
		case NVME_CTRL_RESETTING:
517
			changed = true;
518
			fallthrough;
519 520 521 522 523 524 525 526
		default:
			break;
		}
		break;
	case NVME_CTRL_DELETING:
		switch (old_state) {
		case NVME_CTRL_LIVE:
		case NVME_CTRL_RESETTING:
527
		case NVME_CTRL_CONNECTING:
528
			changed = true;
529
			fallthrough;
530 531 532 533
		default:
			break;
		}
		break;
534 535 536 537 538
	case NVME_CTRL_DELETING_NOIO:
		switch (old_state) {
		case NVME_CTRL_DELETING:
		case NVME_CTRL_DEAD:
			changed = true;
539
			fallthrough;
540 541 542 543
		default:
			break;
		}
		break;
544 545 546 547
	case NVME_CTRL_DEAD:
		switch (old_state) {
		case NVME_CTRL_DELETING:
			changed = true;
548
			fallthrough;
549 550 551 552
		default:
			break;
		}
		break;
553 554 555 556
	default:
		break;
	}

557
	if (changed) {
558
		ctrl->state = new_state;
559 560
		wake_up_all(&ctrl->state_wq);
	}
561

562
	spin_unlock_irqrestore(&ctrl->lock, flags);
563 564 565 566 567 568
	if (!changed)
		return false;

	if (ctrl->state == NVME_CTRL_LIVE) {
		if (old_state == NVME_CTRL_CONNECTING)
			nvme_stop_failfast_work(ctrl);
569
		nvme_kick_requeue_lists(ctrl);
570 571 572 573
	} else if (ctrl->state == NVME_CTRL_CONNECTING &&
		old_state == NVME_CTRL_RESETTING) {
		nvme_start_failfast_work(ctrl);
	}
574 575 576 577
	return changed;
}
EXPORT_SYMBOL_GPL(nvme_change_ctrl_state);

578 579 580 581 582 583 584 585 586 587 588 589
/*
 * 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:
590
	case NVME_CTRL_DELETING_NOIO:
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
	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 已提交
612 613 614 615 616
static void nvme_free_ns_head(struct kref *ref)
{
	struct nvme_ns_head *head =
		container_of(ref, struct nvme_ns_head, ref);

617
	nvme_mpath_remove_disk(head);
618
	ida_free(&head->subsys->ns_ida, head->instance);
619
	cleanup_srcu_struct(&head->srcu);
620
	nvme_put_subsystem(head->subsys);
C
Christoph Hellwig 已提交
621 622 623
	kfree(head);
}

624
bool nvme_tryget_ns_head(struct nvme_ns_head *head)
625 626 627 628
{
	return kref_get_unless_zero(&head->ref);
}

629
void nvme_put_ns_head(struct nvme_ns_head *head)
C
Christoph Hellwig 已提交
630 631 632 633
{
	kref_put(&head->ref, nvme_free_ns_head);
}

634 635 636 637 638
static void nvme_free_ns(struct kref *kref)
{
	struct nvme_ns *ns = container_of(kref, struct nvme_ns, kref);

	put_disk(ns->disk);
C
Christoph Hellwig 已提交
639
	nvme_put_ns_head(ns->head);
640
	nvme_put_ctrl(ns->ctrl);
641 642 643
	kfree(ns);
}

K
Kanchan Joshi 已提交
644 645 646 647 648
static inline bool nvme_get_ns(struct nvme_ns *ns)
{
	return kref_get_unless_zero(&ns->kref);
}

649
void nvme_put_ns(struct nvme_ns *ns)
650 651 652
{
	kref_put(&ns->kref, nvme_free_ns);
}
653
EXPORT_SYMBOL_NS_GPL(nvme_put_ns, NVME_TARGET_PASSTHRU);
654

655 656
static inline void nvme_clear_nvme_request(struct request *req)
{
657
	nvme_req(req)->status = 0;
658 659 660
	nvme_req(req)->retries = 0;
	nvme_req(req)->flags = 0;
	req->rq_flags |= RQF_DONTPREP;
661 662
}

663 664
/* initialize a passthrough request */
void nvme_init_request(struct request *req, struct nvme_command *cmd)
665
{
666 667 668
	if (req->q->queuedata)
		req->timeout = NVME_IO_TIMEOUT;
	else /* no queuedata implies admin queue */
669
		req->timeout = NVME_ADMIN_TIMEOUT;
670

671 672 673
	/* passthru commands should let the driver set the SGL flags */
	cmd->common.flags &= ~NVME_CMD_SGL_ALL;

674
	req->cmd_flags |= REQ_FAILFAST_DRIVER;
675
	if (req->mq_hctx->type == HCTX_TYPE_POLL)
676
		req->cmd_flags |= REQ_POLLED;
677
	nvme_clear_nvme_request(req);
678
	memcpy(nvme_req(req)->cmd, cmd, sizeof(*cmd));
679
}
680
EXPORT_SYMBOL_GPL(nvme_init_request);
681

682 683 684 685 686 687 688 689 690 691 692 693 694
/*
 * For something we're not in a state to send to the device the default action
 * is to busy it and retry it after the controller state is recovered.  However,
 * if the controller is deleting or if anything is marked for failfast or
 * nvme multipath it is immediately failed.
 *
 * Note: commands used to initialize the controller will be marked for failfast.
 * Note: nvme cli/ioctl commands are marked for failfast.
 */
blk_status_t nvme_fail_nonready_command(struct nvme_ctrl *ctrl,
		struct request *rq)
{
	if (ctrl->state != NVME_CTRL_DELETING_NOIO &&
695
	    ctrl->state != NVME_CTRL_DELETING &&
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
	    ctrl->state != NVME_CTRL_DEAD &&
	    !test_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags) &&
	    !blk_noretry_request(rq) && !(rq->cmd_flags & REQ_NVME_MPATH))
		return BLK_STS_RESOURCE;
	return nvme_host_path_error(rq);
}
EXPORT_SYMBOL_GPL(nvme_fail_nonready_command);

bool __nvme_check_ready(struct nvme_ctrl *ctrl, struct request *rq,
		bool queue_live)
{
	struct nvme_request *req = nvme_req(rq);

	/*
	 * currently we have a problem sending passthru commands
	 * on the admin_q if the controller is not LIVE because we can't
	 * make sure that they are going out after the admin connect,
	 * controller enable and/or other commands in the initialization
	 * sequence. until the controller will be LIVE, fail with
	 * BLK_STS_RESOURCE so that they will be rescheduled.
	 */
	if (rq->q == ctrl->admin_q && (req->flags & NVME_REQ_USERCMD))
		return false;

	if (ctrl->ops->flags & NVME_F_FABRICS) {
		/*
		 * Only allow commands on a live queue, except for the connect
		 * command, which is require to set the queue live in the
		 * appropinquate states.
		 */
		switch (ctrl->state) {
		case NVME_CTRL_CONNECTING:
			if (blk_rq_is_passthrough(rq) && nvme_is_fabrics(req->cmd) &&
729 730 731
			    (req->cmd->fabrics.fctype == nvme_fabrics_type_connect ||
			     req->cmd->fabrics.fctype == nvme_fabrics_type_auth_send ||
			     req->cmd->fabrics.fctype == nvme_fabrics_type_auth_receive))
732 733 734 735 736 737 738 739 740 741 742 743 744
				return true;
			break;
		default:
			break;
		case NVME_CTRL_DEAD:
			return false;
		}
	}

	return queue_live;
}
EXPORT_SYMBOL_GPL(__nvme_check_ready);

M
Ming Lin 已提交
745 746 747
static inline void nvme_setup_flush(struct nvme_ns *ns,
		struct nvme_command *cmnd)
{
748
	memset(cmnd, 0, sizeof(*cmnd));
M
Ming Lin 已提交
749
	cmnd->common.opcode = nvme_cmd_flush;
C
Christoph Hellwig 已提交
750
	cmnd->common.nsid = cpu_to_le32(ns->head->ns_id);
M
Ming Lin 已提交
751 752
}

753
static blk_status_t nvme_setup_discard(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
754 755
		struct nvme_command *cmnd)
{
756
	unsigned short segments = blk_rq_nr_discard_segments(req), n = 0;
M
Ming Lin 已提交
757
	struct nvme_dsm_range *range;
758
	struct bio *bio;
M
Ming Lin 已提交
759

760 761 762 763 764 765 766 767
	/*
	 * 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);
768 769 770 771 772 773 774 775 776 777 778
	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 已提交
779

780
	__rq_for_each_bio(bio, req) {
781
		u64 slba = nvme_sect_to_lba(ns, bio->bi_iter.bi_sector);
782 783
		u32 nlb = bio->bi_iter.bi_size >> ns->lba_shift;

K
Keith Busch 已提交
784 785 786 787 788
		if (n < segments) {
			range[n].cattr = cpu_to_le32(0);
			range[n].nlb = cpu_to_le32(nlb);
			range[n].slba = cpu_to_le64(slba);
		}
789 790 791 792
		n++;
	}

	if (WARN_ON_ONCE(n != segments)) {
793 794 795 796
		if (virt_to_page(range) == ns->ctrl->discard_page)
			clear_bit_unlock(0, &ns->ctrl->discard_page_busy);
		else
			kfree(range);
797
		return BLK_STS_IOERR;
798
	}
M
Ming Lin 已提交
799

800
	memset(cmnd, 0, sizeof(*cmnd));
M
Ming Lin 已提交
801
	cmnd->dsm.opcode = nvme_cmd_dsm;
C
Christoph Hellwig 已提交
802
	cmnd->dsm.nsid = cpu_to_le32(ns->head->ns_id);
803
	cmnd->dsm.nr = cpu_to_le32(segments - 1);
M
Ming Lin 已提交
804 805
	cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);

806 807
	req->special_vec.bv_page = virt_to_page(range);
	req->special_vec.bv_offset = offset_in_page(range);
808
	req->special_vec.bv_len = alloc_size;
809
	req->rq_flags |= RQF_SPECIAL_PAYLOAD;
M
Ming Lin 已提交
810

811
	return BLK_STS_OK;
M
Ming Lin 已提交
812 813
}

814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
static void nvme_set_ref_tag(struct nvme_ns *ns, struct nvme_command *cmnd,
			      struct request *req)
{
	u32 upper, lower;
	u64 ref48;

	/* both rw and write zeroes share the same reftag format */
	switch (ns->guard_type) {
	case NVME_NVM_NS_16B_GUARD:
		cmnd->rw.reftag = cpu_to_le32(t10_pi_ref_tag(req));
		break;
	case NVME_NVM_NS_64B_GUARD:
		ref48 = ext_pi_ref_tag(req);
		lower = lower_32_bits(ref48);
		upper = upper_32_bits(ref48);

		cmnd->rw.reftag = cpu_to_le32(lower);
		cmnd->rw.cdw3 = cpu_to_le32(upper);
		break;
	default:
		break;
	}
}

838 839 840
static inline blk_status_t nvme_setup_write_zeroes(struct nvme_ns *ns,
		struct request *req, struct nvme_command *cmnd)
{
841 842
	memset(cmnd, 0, sizeof(*cmnd));

843 844 845 846 847 848
	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 =
849
		cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
850 851
	cmnd->write_zeroes.length =
		cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
K
Klaus Jensen 已提交
852 853

	if (nvme_ns_has_pi(ns)) {
854
		cmnd->write_zeroes.control = cpu_to_le16(NVME_RW_PRINFO_PRACT);
K
Klaus Jensen 已提交
855 856 857 858

		switch (ns->pi_type) {
		case NVME_NS_DPS_PI_TYPE1:
		case NVME_NS_DPS_PI_TYPE2:
859
			nvme_set_ref_tag(ns, cmnd, req);
K
Klaus Jensen 已提交
860 861 862 863
			break;
		}
	}

864 865 866
	return BLK_STS_OK;
}

867
static inline blk_status_t nvme_setup_rw(struct nvme_ns *ns,
K
Keith Busch 已提交
868 869
		struct request *req, struct nvme_command *cmnd,
		enum nvme_opcode op)
M
Ming Lin 已提交
870 871 872 873 874 875 876 877 878 879 880 881
{
	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 已提交
882
	cmnd->rw.opcode = op;
883
	cmnd->rw.flags = 0;
C
Christoph Hellwig 已提交
884
	cmnd->rw.nsid = cpu_to_le32(ns->head->ns_id);
885 886
	cmnd->rw.cdw2 = 0;
	cmnd->rw.cdw3 = 0;
887
	cmnd->rw.metadata = 0;
888
	cmnd->rw.slba = cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
M
Ming Lin 已提交
889
	cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
890 891 892
	cmnd->rw.reftag = 0;
	cmnd->rw.apptag = 0;
	cmnd->rw.appmask = 0;
M
Ming Lin 已提交
893 894

	if (ns->ms) {
895 896 897 898 899 900 901 902 903 904 905 906
		/*
		 * 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 已提交
907 908 909 910 911 912 913 914
		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 已提交
915 916
			if (op == nvme_cmd_zone_append)
				control |= NVME_RW_APPEND_PIREMAP;
917
			nvme_set_ref_tag(ns, cmnd, req);
M
Ming Lin 已提交
918 919 920 921 922 923
			break;
		}
	}

	cmnd->rw.control = cpu_to_le16(control);
	cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
924
	return 0;
M
Ming Lin 已提交
925 926
}

927 928 929
void nvme_cleanup_cmd(struct request *req)
{
	if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
M
Minwoo Im 已提交
930
		struct nvme_ctrl *ctrl = nvme_req(req)->ctrl;
931

C
Christoph Hellwig 已提交
932
		if (req->special_vec.bv_page == ctrl->discard_page)
M
Minwoo Im 已提交
933
			clear_bit_unlock(0, &ctrl->discard_page_busy);
934
		else
C
Christoph Hellwig 已提交
935
			kfree(bvec_virt(&req->special_vec));
936 937 938 939
	}
}
EXPORT_SYMBOL_GPL(nvme_cleanup_cmd);

940
blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req)
M
Ming Lin 已提交
941
{
942
	struct nvme_command *cmd = nvme_req(req)->cmd;
943
	blk_status_t ret = BLK_STS_OK;
M
Ming Lin 已提交
944

945
	if (!(req->rq_flags & RQF_DONTPREP))
946
		nvme_clear_nvme_request(req);
947

948 949 950
	switch (req_op(req)) {
	case REQ_OP_DRV_IN:
	case REQ_OP_DRV_OUT:
951
		/* these are setup prior to execution in nvme_init_request() */
952 953
		break;
	case REQ_OP_FLUSH:
M
Ming Lin 已提交
954
		nvme_setup_flush(ns, cmd);
955
		break;
K
Keith Busch 已提交
956 957 958 959 960 961 962 963 964 965 966 967 968
	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;
969
	case REQ_OP_WRITE_ZEROES:
970 971
		ret = nvme_setup_write_zeroes(ns, req, cmd);
		break;
972
	case REQ_OP_DISCARD:
M
Ming Lin 已提交
973
		ret = nvme_setup_discard(ns, req, cmd);
974 975
		break;
	case REQ_OP_READ:
K
Keith Busch 已提交
976 977
		ret = nvme_setup_rw(ns, req, cmd, nvme_cmd_read);
		break;
978
	case REQ_OP_WRITE:
K
Keith Busch 已提交
979 980 981 982
		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);
983 984 985
		break;
	default:
		WARN_ON_ONCE(1);
986
		return BLK_STS_IOERR;
987
	}
M
Ming Lin 已提交
988

989
	cmd->common.command_id = nvme_cid(req);
K
Keith Busch 已提交
990
	trace_nvme_setup_cmd(req, cmd);
M
Ming Lin 已提交
991 992 993 994
	return ret;
}
EXPORT_SYMBOL_GPL(nvme_setup_cmd);

995 996 997 998 999 1000
/*
 * Return values:
 * 0:  success
 * >0: nvme controller's cqe status response
 * <0: kernel error in lieu of controller response
 */
1001
static int nvme_execute_rq(struct request *rq, bool at_head)
1002 1003 1004
{
	blk_status_t status;

1005
	status = blk_execute_rq(rq, at_head);
1006 1007 1008 1009 1010 1011 1012
	if (nvme_req(rq)->flags & NVME_REQ_CANCELLED)
		return -EINTR;
	if (nvme_req(rq)->status)
		return nvme_req(rq)->status;
	return blk_status_to_errno(status);
}

1013 1014 1015 1016 1017
/*
 * 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,
1018
		union nvme_result *result, void *buffer, unsigned bufflen,
1019
		int qid, int at_head, blk_mq_req_flags_t flags)
1020 1021 1022 1023
{
	struct request *req;
	int ret;

1024
	if (qid == NVME_QID_ANY)
1025
		req = blk_mq_alloc_request(q, nvme_req_op(cmd), flags);
1026
	else
1027
		req = blk_mq_alloc_request_hctx(q, nvme_req_op(cmd), flags,
1028
						qid - 1);
1029

1030 1031
	if (IS_ERR(req))
		return PTR_ERR(req);
1032
	nvme_init_request(req, cmd);
1033

1034 1035 1036 1037
	if (buffer && bufflen) {
		ret = blk_rq_map_kern(q, req, buffer, bufflen, GFP_KERNEL);
		if (ret)
			goto out;
1038 1039
	}

1040
	req->rq_flags |= RQF_QUIET;
1041
	ret = nvme_execute_rq(req, at_head);
1042
	if (result && ret >= 0)
1043
		*result = nvme_req(req)->result;
1044 1045 1046 1047
 out:
	blk_mq_free_request(req);
	return ret;
}
1048
EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd);
1049 1050 1051 1052

int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
		void *buffer, unsigned bufflen)
{
1053
	return __nvme_submit_sync_cmd(q, cmd, NULL, buffer, bufflen,
1054
			NVME_QID_ANY, 0, 0);
1055
}
1056
EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd);
1057

1058 1059 1060 1061
static u32 nvme_known_admin_effects(u8 opcode)
{
	switch (opcode) {
	case nvme_admin_format_nvm:
1062
		return NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_NCC |
1063 1064
			NVME_CMD_EFFECTS_CSE_MASK;
	case nvme_admin_sanitize_nvm:
1065
		return NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_CSE_MASK;
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
	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))
1080 1081 1082
			dev_warn_once(ctrl->device,
				"IO command:%02x has unhandled effects:%08x\n",
				opcode, effects);
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
		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.
	 */
1103
	if (effects & NVME_CMD_EFFECTS_CSE_MASK) {
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
		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;
}

1114 1115
void nvme_passthru_end(struct nvme_ctrl *ctrl, u32 effects,
		       struct nvme_command *cmd, int status)
1116
{
1117
	if (effects & NVME_CMD_EFFECTS_CSE_MASK) {
1118 1119 1120 1121 1122 1123 1124
		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)
1125
		nvme_init_ctrl_finish(ctrl);
1126 1127 1128 1129
	if (effects & (NVME_CMD_EFFECTS_NIC | NVME_CMD_EFFECTS_NCC)) {
		nvme_queue_scan(ctrl);
		flush_work(&ctrl->scan_work);
	}
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149

	switch (cmd->common.opcode) {
	case nvme_admin_set_features:
		switch (le32_to_cpu(cmd->common.cdw10) & 0xFF) {
		case NVME_FEAT_KATO:
			/*
			 * Keep alive commands interval on the host should be
			 * updated when KATO is modified by Set Features
			 * commands.
			 */
			if (!status)
				nvme_update_keep_alive(ctrl, cmd);
			break;
		default:
			break;
		}
		break;
	default:
		break;
	}
1150
}
1151
EXPORT_SYMBOL_NS_GPL(nvme_passthru_end, NVME_TARGET_PASSTHRU);
1152

1153
int nvme_execute_passthru_rq(struct request *rq, u32 *effects)
1154 1155 1156 1157 1158
{
	struct nvme_command *cmd = nvme_req(rq)->cmd;
	struct nvme_ctrl *ctrl = nvme_req(rq)->ctrl;
	struct nvme_ns *ns = rq->q->queuedata;

1159 1160
	*effects = nvme_passthru_start(ctrl, ns, cmd->common.opcode);
	return nvme_execute_rq(rq, false);
1161 1162 1163
}
EXPORT_SYMBOL_NS_GPL(nvme_execute_passthru_rq, NVME_TARGET_PASSTHRU);

H
Hannes Reinecke 已提交
1164 1165 1166 1167 1168 1169 1170
/*
 * Recommended frequency for KATO commands per NVMe 1.4 section 7.12.1:
 * 
 *   The host should send Keep Alive commands at half of the Keep Alive Timeout
 *   accounting for transport roundtrip times [..].
 */
static void nvme_queue_keep_alive_work(struct nvme_ctrl *ctrl)
1171
{
H
Hannes Reinecke 已提交
1172
	queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ / 2);
1173 1174
}

1175 1176
static enum rq_end_io_ret nvme_keep_alive_end_io(struct request *rq,
						 blk_status_t status)
S
Sagi Grimberg 已提交
1177 1178
{
	struct nvme_ctrl *ctrl = rq->end_io_data;
1179 1180
	unsigned long flags;
	bool startka = false;
S
Sagi Grimberg 已提交
1181 1182 1183

	blk_mq_free_request(rq);

1184
	if (status) {
S
Sagi Grimberg 已提交
1185
		dev_err(ctrl->device,
1186 1187
			"failed nvme_keep_alive_end_io error=%d\n",
				status);
1188
		return RQ_END_IO_NONE;
S
Sagi Grimberg 已提交
1189 1190
	}

1191
	ctrl->comp_seen = false;
1192 1193 1194 1195 1196 1197
	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)
H
Hannes Reinecke 已提交
1198
		nvme_queue_keep_alive_work(ctrl);
1199
	return RQ_END_IO_NONE;
S
Sagi Grimberg 已提交
1200 1201 1202 1203 1204 1205
}

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);
1206
	bool comp_seen = ctrl->comp_seen;
1207
	struct request *rq;
1208 1209 1210 1211 1212

	if ((ctrl->ctratt & NVME_CTRL_ATTR_TBKAS) && comp_seen) {
		dev_dbg(ctrl->device,
			"reschedule traffic based keep-alive timer\n");
		ctrl->comp_seen = false;
H
Hannes Reinecke 已提交
1213
		nvme_queue_keep_alive_work(ctrl);
1214 1215
		return;
	}
S
Sagi Grimberg 已提交
1216

1217 1218
	rq = blk_mq_alloc_request(ctrl->admin_q, nvme_req_op(&ctrl->ka_cmd),
				  BLK_MQ_REQ_RESERVED | BLK_MQ_REQ_NOWAIT);
1219
	if (IS_ERR(rq)) {
S
Sagi Grimberg 已提交
1220
		/* allocation failure, reset the controller */
1221
		dev_err(ctrl->device, "keep-alive failed: %ld\n", PTR_ERR(rq));
1222
		nvme_reset_ctrl(ctrl);
S
Sagi Grimberg 已提交
1223 1224
		return;
	}
1225
	nvme_init_request(rq, &ctrl->ka_cmd);
1226 1227

	rq->timeout = ctrl->kato * HZ;
1228
	rq->end_io = nvme_keep_alive_end_io;
1229
	rq->end_io_data = ctrl;
1230
	rq->rq_flags |= RQF_QUIET;
1231
	blk_execute_rq_nowait(rq, false);
S
Sagi Grimberg 已提交
1232 1233
}

1234
static void nvme_start_keep_alive(struct nvme_ctrl *ctrl)
S
Sagi Grimberg 已提交
1235 1236 1237 1238
{
	if (unlikely(ctrl->kato == 0))
		return;

H
Hannes Reinecke 已提交
1239
	nvme_queue_keep_alive_work(ctrl);
S
Sagi Grimberg 已提交
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
}

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

1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
static void nvme_update_keep_alive(struct nvme_ctrl *ctrl,
				   struct nvme_command *cmd)
{
	unsigned int new_kato =
		DIV_ROUND_UP(le32_to_cpu(cmd->common.cdw11), 1000);

	dev_info(ctrl->device,
		 "keep alive interval updated from %u ms to %u ms\n",
		 ctrl->kato * 1000 / 2, new_kato * 1000 / 2);

	nvme_stop_keep_alive(ctrl);
	ctrl->kato = new_kato;
	nvme_start_keep_alive(ctrl);
}

1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
/*
 * 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 已提交
1279
static int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id)
1280 1281 1282 1283 1284 1285
{
	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;
1286
	c.identify.cns = NVME_ID_CNS_CTRL;
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298

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

1299
static int nvme_process_ns_desc(struct nvme_ctrl *ctrl, struct nvme_ns_ids *ids,
1300
		struct nvme_ns_id_desc *cur, bool *csi_seen)
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
{
	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;
		}
1312 1313
		if (ctrl->quirks & NVME_QUIRK_BOGUS_NID)
			return NVME_NIDT_EUI64_LEN;
1314 1315 1316 1317 1318 1319 1320 1321
		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;
		}
1322 1323
		if (ctrl->quirks & NVME_QUIRK_BOGUS_NID)
			return NVME_NIDT_NGUID_LEN;
1324 1325 1326 1327 1328 1329 1330 1331
		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;
		}
1332 1333
		if (ctrl->quirks & NVME_QUIRK_BOGUS_NID)
			return NVME_NIDT_UUID_LEN;
1334 1335
		uuid_copy(&ids->uuid, data + sizeof(*cur));
		return NVME_NIDT_UUID_LEN;
1336 1337 1338 1339 1340 1341 1342 1343 1344
	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;
1345 1346 1347 1348 1349 1350
	default:
		/* Skip unknown types */
		return cur->nidl;
	}
}

1351 1352
static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl,
		struct nvme_ns_info *info)
1353 1354
{
	struct nvme_command c = { };
1355 1356
	bool csi_seen = false;
	int status, pos, len;
1357 1358
	void *data;

1359 1360
	if (ctrl->vs < NVME_VS(1, 3, 0) && !nvme_multi_css(ctrl))
		return 0;
1361 1362 1363
	if (ctrl->quirks & NVME_QUIRK_NO_NS_DESC_LIST)
		return 0;

1364
	c.identify.opcode = nvme_admin_identify;
1365
	c.identify.nsid = cpu_to_le32(info->nsid);
1366 1367 1368 1369 1370 1371
	c.identify.cns = NVME_ID_CNS_NS_DESC_LIST;

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

1372
	status = nvme_submit_sync_cmd(ctrl->admin_q, &c, data,
1373
				      NVME_IDENTIFY_DATA_SIZE);
1374 1375
	if (status) {
		dev_warn(ctrl->device,
1376
			"Identify Descriptors failed (nsid=%u, status=0x%x)\n",
1377
			info->nsid, status);
1378
		goto free_data;
1379
	}
1380 1381 1382 1383 1384 1385 1386

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

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

1387
		len = nvme_process_ns_desc(ctrl, &info->ids, cur, &csi_seen);
1388
		if (len < 0)
1389
			break;
1390 1391 1392

		len += sizeof(*cur);
	}
1393 1394 1395

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

1400 1401 1402 1403 1404
free_data:
	kfree(data);
	return status;
}

1405
static int nvme_identify_ns(struct nvme_ctrl *ctrl, unsigned nsid,
1406
			struct nvme_id_ns **id)
1407 1408 1409 1410 1411
{
	struct nvme_command c = { };
	int error;

	/* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1412 1413
	c.identify.opcode = nvme_admin_identify;
	c.identify.nsid = cpu_to_le32(nsid);
1414
	c.identify.cns = NVME_ID_CNS_NS;
1415

1416 1417 1418
	*id = kmalloc(sizeof(**id), GFP_KERNEL);
	if (!*id)
		return -ENOMEM;
1419

1420
	error = nvme_submit_sync_cmd(ctrl->admin_q, &c, *id, sizeof(**id));
1421
	if (error) {
1422
		dev_warn(ctrl->device, "Identify namespace failed (%d)\n", error);
1423
		goto out_free_id;
1424 1425
	}

1426
	error = NVME_SC_INVALID_NS | NVME_SC_DNR;
1427 1428
	if ((*id)->ncap == 0) /* namespace not allocated or attached */
		goto out_free_id;
1429
	return 0;
1430

1431 1432 1433 1434
out_free_id:
	kfree(*id);
	return error;
}
1435

1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
static int nvme_ns_info_from_identify(struct nvme_ctrl *ctrl,
		struct nvme_ns_info *info)
{
	struct nvme_ns_ids *ids = &info->ids;
	struct nvme_id_ns *id;
	int ret;

	ret = nvme_identify_ns(ctrl, info->nsid, &id);
	if (ret)
		return ret;
	info->anagrpid = id->anagrpid;
	info->is_shared = id->nmic & NVME_NS_NMIC_SHARED;
1448
	info->is_readonly = id->nsattr & NVME_NS_ATTR_RO;
1449
	info->is_ready = true;
1450 1451 1452 1453 1454 1455
	if (ctrl->quirks & NVME_QUIRK_BOGUS_NID) {
		dev_info(ctrl->device,
			 "Ignoring bogus Namespace Identifiers\n");
	} else {
		if (ctrl->vs >= NVME_VS(1, 1, 0) &&
		    !memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
1456
			memcpy(ids->eui64, id->eui64, sizeof(ids->eui64));
1457 1458
		if (ctrl->vs >= NVME_VS(1, 2, 0) &&
		    !memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
1459
			memcpy(ids->nguid, id->nguid, sizeof(ids->nguid));
1460
	}
1461
	kfree(id);
1462
	return 0;
1463 1464
}

1465 1466
static int nvme_ns_info_from_id_cs_indep(struct nvme_ctrl *ctrl,
		struct nvme_ns_info *info)
1467
{
1468
	struct nvme_id_ns_cs_indep *id;
1469 1470
	struct nvme_command c = {
		.identify.opcode	= nvme_admin_identify,
1471
		.identify.nsid		= cpu_to_le32(info->nsid),
1472 1473 1474 1475
		.identify.cns		= NVME_ID_CNS_NS_CS_INDEP,
	};
	int ret;

1476 1477
	id = kmalloc(sizeof(*id), GFP_KERNEL);
	if (!id)
1478 1479
		return -ENOMEM;

1480 1481 1482 1483
	ret = nvme_submit_sync_cmd(ctrl->admin_q, &c, id, sizeof(*id));
	if (!ret) {
		info->anagrpid = id->anagrpid;
		info->is_shared = id->nmic & NVME_NS_NMIC_SHARED;
1484
		info->is_readonly = id->nsattr & NVME_NS_ATTR_RO;
1485
		info->is_ready = id->nstat & NVME_NSTAT_NRDY;
1486
	}
1487 1488
	kfree(id);
	return ret;
1489 1490
}

K
Keith Busch 已提交
1491 1492
static int nvme_features(struct nvme_ctrl *dev, u8 op, unsigned int fid,
		unsigned int dword11, void *buffer, size_t buflen, u32 *result)
1493
{
1494
	union nvme_result res = { 0 };
1495
	struct nvme_command c = { };
1496
	int ret;
1497

K
Keith Busch 已提交
1498
	c.features.opcode = op;
1499 1500 1501
	c.features.fid = cpu_to_le32(fid);
	c.features.dword11 = cpu_to_le32(dword11);

1502
	ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &res,
1503
			buffer, buflen, NVME_QID_ANY, 0, 0);
1504
	if (ret >= 0 && result)
1505
		*result = le32_to_cpu(res.u32);
1506
	return ret;
1507 1508
}

K
Keith Busch 已提交
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526
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 已提交
1527 1528 1529 1530 1531 1532
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;

1533
	status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, NULL, 0,
C
Christoph Hellwig 已提交
1534
			&result);
1535
	if (status < 0)
C
Christoph Hellwig 已提交
1536 1537
		return status;

1538 1539 1540 1541 1542 1543
	/*
	 * 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) {
1544
		dev_err(ctrl->device, "Could not set queue count (%d)\n", status);
1545 1546 1547 1548 1549 1550
		*count = 0;
	} else {
		nr_io_queues = min(result & 0xffff, result >> 16) + 1;
		*count = min(*count, nr_io_queues);
	}

C
Christoph Hellwig 已提交
1551 1552
	return 0;
}
1553
EXPORT_SYMBOL_GPL(nvme_set_queue_count);
C
Christoph Hellwig 已提交
1554

1555
#define NVME_AEN_SUPPORTED \
1556 1557
	(NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_FW_ACT | \
	 NVME_AEN_CFG_ANA_CHANGE | NVME_AEN_CFG_DISC_CHANGE)
1558 1559 1560

static void nvme_enable_aen(struct nvme_ctrl *ctrl)
{
1561
	u32 result, supported_aens = ctrl->oaes & NVME_AEN_SUPPORTED;
1562 1563
	int status;

1564 1565 1566 1567 1568
	if (!supported_aens)
		return;

	status = nvme_set_features(ctrl, NVME_FEAT_ASYNC_EVENT, supported_aens,
			NULL, 0, &result);
1569 1570
	if (status)
		dev_warn(ctrl->device, "Failed to configure AEN (cfg %x)\n",
1571
			 supported_aens);
1572 1573

	queue_work(nvme_wq, &ctrl->async_event_work);
1574 1575
}

1576
static int nvme_ns_open(struct nvme_ns *ns)
1577 1578
{

1579
	/* should never be called due to GENHD_FL_HIDDEN */
1580
	if (WARN_ON_ONCE(nvme_ns_head_multipath(ns->head)))
1581
		goto fail;
K
Kanchan Joshi 已提交
1582
	if (!nvme_get_ns(ns))
1583 1584 1585 1586
		goto fail;
	if (!try_module_get(ns->ctrl->ops->module))
		goto fail_put_ns;

C
Christoph Hellwig 已提交
1587
	return 0;
1588 1589 1590 1591 1592

fail_put_ns:
	nvme_put_ns(ns);
fail:
	return -ENXIO;
1593 1594
}

1595
static void nvme_ns_release(struct nvme_ns *ns)
1596
{
1597 1598 1599

	module_put(ns->ctrl->ops->module);
	nvme_put_ns(ns);
1600 1601
}

1602 1603 1604 1605 1606 1607 1608 1609 1610 1611
static int nvme_open(struct block_device *bdev, fmode_t mode)
{
	return nvme_ns_open(bdev->bd_disk->private_data);
}

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

1612
int nvme_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1613 1614 1615 1616 1617 1618 1619 1620 1621
{
	/* 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
1622
static void nvme_init_integrity(struct gendisk *disk, struct nvme_ns *ns,
1623
				u32 max_integrity_segments)
1624
{
1625
	struct blk_integrity integrity = { };
1626

1627
	switch (ns->pi_type) {
1628
	case NVME_NS_DPS_PI_TYPE3:
1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
		switch (ns->guard_type) {
		case NVME_NVM_NS_16B_GUARD:
			integrity.profile = &t10_pi_type3_crc;
			integrity.tag_size = sizeof(u16) + sizeof(u32);
			integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
			break;
		case NVME_NVM_NS_64B_GUARD:
			integrity.profile = &ext_pi_type3_crc64;
			integrity.tag_size = sizeof(u16) + 6;
			integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
			break;
		default:
			integrity.profile = NULL;
			break;
		}
1644 1645 1646
		break;
	case NVME_NS_DPS_PI_TYPE1:
	case NVME_NS_DPS_PI_TYPE2:
1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661
		switch (ns->guard_type) {
		case NVME_NVM_NS_16B_GUARD:
			integrity.profile = &t10_pi_type1_crc;
			integrity.tag_size = sizeof(u16);
			integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
			break;
		case NVME_NVM_NS_64B_GUARD:
			integrity.profile = &ext_pi_type1_crc64;
			integrity.tag_size = sizeof(u16);
			integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
			break;
		default:
			integrity.profile = NULL;
			break;
		}
1662 1663 1664 1665 1666
		break;
	default:
		integrity.profile = NULL;
		break;
	}
1667 1668

	integrity.tuple_size = ns->ms;
1669
	blk_integrity_register(disk, &integrity);
1670
	blk_queue_max_integrity_segments(disk->queue, max_integrity_segments);
1671 1672
}
#else
1673
static void nvme_init_integrity(struct gendisk *disk, struct nvme_ns *ns,
1674
				u32 max_integrity_segments)
1675 1676 1677 1678
{
}
#endif /* CONFIG_BLK_DEV_INTEGRITY */

1679
static void nvme_config_discard(struct gendisk *disk, struct nvme_ns *ns)
1680
{
1681
	struct nvme_ctrl *ctrl = ns->ctrl;
1682
	struct request_queue *queue = disk->queue;
1683 1684
	u32 size = queue_logical_block_size(queue);

1685
	if (ctrl->max_discard_sectors == 0) {
1686
		blk_queue_max_discard_sectors(queue, 0);
1687 1688 1689
		return;
	}

1690 1691 1692
	BUILD_BUG_ON(PAGE_SIZE / sizeof(struct nvme_dsm_range) <
			NVME_DSM_MAX_RANGES);

1693
	queue->limits.discard_granularity = size;
1694

1695
	/* If discard is already enabled, don't reset queue limits */
1696
	if (queue->limits.max_discard_sectors)
1697 1698
		return;

T
Tom Yan 已提交
1699 1700 1701
	if (ctrl->dmrsl && ctrl->dmrsl <= nvme_sect_to_lba(ns, UINT_MAX))
		ctrl->max_discard_sectors = nvme_lba_to_sect(ns, ctrl->dmrsl);

1702 1703
	blk_queue_max_discard_sectors(queue, ctrl->max_discard_sectors);
	blk_queue_max_discard_segments(queue, ctrl->max_discard_segments);
1704 1705

	if (ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
1706
		blk_queue_max_write_zeroes_sectors(queue, UINT_MAX);
1707 1708
}

1709 1710 1711 1712
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 &&
1713 1714
		memcmp(&a->eui64, &b->eui64, sizeof(a->eui64)) == 0 &&
		a->csi == b->csi;
1715 1716
}

1717
static int nvme_init_ms(struct nvme_ns *ns, struct nvme_id_ns *id)
1718
{
1719 1720
	bool first = id->dps & NVME_NS_DPS_PI_FIRST;
	unsigned lbaf = nvme_lbaf_index(id->flbas);
1721
	struct nvme_ctrl *ctrl = ns->ctrl;
1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
	struct nvme_command c = { };
	struct nvme_id_ns_nvm *nvm;
	int ret = 0;
	u32 elbaf;

	ns->pi_size = 0;
	ns->ms = le16_to_cpu(id->lbaf[lbaf].ms);
	if (!(ctrl->ctratt & NVME_CTRL_ATTR_ELBAS)) {
		ns->pi_size = sizeof(struct t10_pi_tuple);
		ns->guard_type = NVME_NVM_NS_16B_GUARD;
		goto set_pi;
	}
1734

1735 1736 1737
	nvm = kzalloc(sizeof(*nvm), GFP_KERNEL);
	if (!nvm)
		return -ENOMEM;
1738

1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769
	c.identify.opcode = nvme_admin_identify;
	c.identify.nsid = cpu_to_le32(ns->head->ns_id);
	c.identify.cns = NVME_ID_CNS_CS_NS;
	c.identify.csi = NVME_CSI_NVM;

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

	elbaf = le32_to_cpu(nvm->elbaf[lbaf]);

	/* no support for storage tag formats right now */
	if (nvme_elbaf_sts(elbaf))
		goto free_data;

	ns->guard_type = nvme_elbaf_guard_type(elbaf);
	switch (ns->guard_type) {
	case NVME_NVM_NS_64B_GUARD:
		ns->pi_size = sizeof(struct crc64_pi_tuple);
		break;
	case NVME_NVM_NS_16B_GUARD:
		ns->pi_size = sizeof(struct t10_pi_tuple);
		break;
	default:
		break;
	}

free_data:
	kfree(nvm);
set_pi:
	if (ns->pi_size && (first || ns->ms == ns->pi_size))
1770 1771 1772 1773
		ns->pi_type = id->dps & NVME_NS_DPS_PI_MASK;
	else
		ns->pi_type = 0;

1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
	return ret;
}

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

	if (nvme_init_ms(ns, id))
		return;

1784 1785
	ns->features &= ~(NVME_NS_METADATA_SUPPORTED | NVME_NS_EXT_LBAS);
	if (!ns->ms || !(ctrl->ops->flags & NVME_F_METADATA_SUPPORTED))
1786 1787
		return;

1788 1789 1790 1791 1792 1793 1794
	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)))
1795
			return;
1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809

		ns->features |= NVME_NS_EXT_LBAS;

		/*
		 * The current fabrics transport drivers support namespace
		 * metadata formats only if nvme_ns_has_pi() returns true.
		 * Suppress support for all other formats so the namespace will
		 * have a 0 capacity and not be usable through the block stack.
		 *
		 * Note, this check will need to be modified if any drivers
		 * gain the ability to use other metadata formats.
		 */
		if (ctrl->max_integrity_segments && nvme_ns_has_pi(ns))
			ns->features |= NVME_NS_METADATA_SUPPORTED;
1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823
	} 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;
	}
}

1824 1825 1826
static void nvme_set_queue_limits(struct nvme_ctrl *ctrl,
		struct request_queue *q)
{
1827
	bool vwc = ctrl->vwc & NVME_CTRL_VWC_PRESENT;
1828 1829 1830 1831 1832 1833 1834 1835 1836 1837

	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);
K
Keith Busch 已提交
1838
	blk_queue_dma_alignment(q, 3);
1839 1840 1841
	blk_queue_write_cache(q, vwc, vwc);
}

1842 1843 1844
static void nvme_update_disk_info(struct gendisk *disk,
		struct nvme_ns *ns, struct nvme_id_ns *id)
{
1845
	sector_t capacity = nvme_lba_to_sect(ns, le64_to_cpu(id->nsze));
1846
	unsigned short bs = 1 << ns->lba_shift;
D
Damien Le Moal 已提交
1847
	u32 atomic_bs, phys_bs, io_opt = 0;
1848

1849 1850 1851 1852
	/*
	 * 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.
	 */
1853
	if (ns->lba_shift > PAGE_SHIFT) {
1854
		capacity = 0;
1855 1856
		bs = (1 << 9);
	}
1857

1858 1859
	blk_integrity_unregister(disk);

D
Damien Le Moal 已提交
1860
	atomic_bs = phys_bs = bs;
1861 1862 1863 1864 1865 1866
	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.
		 */
1867
		if (id->nsfeat & NVME_NS_FEAT_ATOMICS && id->nawupf)
1868 1869 1870 1871
			atomic_bs = (1 + le16_to_cpu(id->nawupf)) * bs;
		else
			atomic_bs = (1 + ns->ctrl->subsys->awupf) * bs;
	}
K
Keith Busch 已提交
1872

1873
	if (id->nsfeat & NVME_NS_FEAT_IO_OPT) {
1874
		/* NPWG = Namespace Preferred Write Granularity */
K
Keith Busch 已提交
1875
		phys_bs = bs * (1 + le16_to_cpu(id->npwg));
1876
		/* NOWS = Namespace Optimal Write Size */
K
Keith Busch 已提交
1877
		io_opt = bs * (1 + le16_to_cpu(id->nows));
1878 1879
	}

1880
	blk_queue_logical_block_size(disk->queue, bs);
1881 1882 1883 1884 1885 1886 1887 1888
	/*
	 * 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);
1889

1890 1891 1892 1893 1894 1895 1896 1897 1898
	/*
	 * 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))
1899
			nvme_init_integrity(disk, ns,
1900
					    ns->ctrl->max_integrity_segments);
1901 1902 1903 1904
		else if (!nvme_ns_has_pi(ns))
			capacity = 0;
	}

1905
	set_capacity_and_notify(disk, capacity);
1906

1907
	nvme_config_discard(disk, ns);
1908 1909
	blk_queue_max_write_zeroes_sectors(disk->queue,
					   ns->ctrl->max_zeroes_sectors);
1910 1911
}

1912 1913 1914 1915 1916
static bool nvme_ns_is_readonly(struct nvme_ns *ns, struct nvme_ns_info *info)
{
	return info->is_readonly || test_bit(NVME_NS_FORCE_RO, &ns->flags);
}

1917 1918 1919
static inline bool nvme_first_scan(struct gendisk *disk)
{
	/* nvme_alloc_ns() scans the disk prior to adding it */
C
Christoph Hellwig 已提交
1920
	return !disk_live(disk);
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953
}

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

1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978
static int nvme_update_ns_info_generic(struct nvme_ns *ns,
		struct nvme_ns_info *info)
{
	blk_mq_freeze_queue(ns->disk->queue);
	nvme_set_queue_limits(ns->ctrl, ns->queue);
	set_disk_ro(ns->disk, nvme_ns_is_readonly(ns, info));
	blk_mq_unfreeze_queue(ns->disk->queue);

	if (nvme_ns_head_multipath(ns->head)) {
		blk_mq_freeze_queue(ns->head->disk->queue);
		set_disk_ro(ns->head->disk, nvme_ns_is_readonly(ns, info));
		nvme_mpath_revalidate_paths(ns);
		blk_stack_limits(&ns->head->disk->queue->limits,
				 &ns->queue->limits, 0);
		ns->head->disk->flags |= GENHD_FL_HIDDEN;
		blk_mq_unfreeze_queue(ns->head->disk->queue);
	}

	/* Hide the block-interface for these devices */
	ns->disk->flags |= GENHD_FL_HIDDEN;
	set_bit(NVME_NS_READY, &ns->flags);

	return 0;
}

1979 1980
static int nvme_update_ns_info_block(struct nvme_ns *ns,
		struct nvme_ns_info *info)
1981
{
1982 1983
	struct nvme_id_ns *id;
	unsigned lbaf;
K
Keith Busch 已提交
1984
	int ret;
1985

1986 1987 1988 1989
	ret = nvme_identify_ns(ns->ctrl, info->nsid, &id);
	if (ret)
		return ret;

1990
	blk_mq_freeze_queue(ns->disk->queue);
1991
	lbaf = nvme_lbaf_index(id->flbas);
K
Keith Busch 已提交
1992
	ns->lba_shift = id->lbaf[lbaf].ds;
1993
	nvme_set_queue_limits(ns->ctrl, ns->queue);
1994

1995
	nvme_configure_metadata(ns, id);
1996 1997 1998
	nvme_set_chunk_sectors(ns, id);
	nvme_update_disk_info(ns->disk, ns, id);

1999
	if (ns->head->ids.csi == NVME_CSI_ZNS) {
2000
		ret = nvme_update_zone_info(ns, lbaf);
2001 2002 2003 2004
		if (ret) {
			blk_mq_unfreeze_queue(ns->disk->queue);
			goto out;
		}
2005 2006
	}

2007
	set_disk_ro(ns->disk, nvme_ns_is_readonly(ns, info));
2008
	set_bit(NVME_NS_READY, &ns->flags);
2009
	blk_mq_unfreeze_queue(ns->disk->queue);
2010

2011 2012
	if (blk_queue_is_zoned(ns->queue)) {
		ret = nvme_revalidate_zones(ns);
2013
		if (ret && !nvme_first_scan(ns->disk))
2014
			goto out;
2015 2016
	}

2017
	if (nvme_ns_head_multipath(ns->head)) {
2018
		blk_mq_freeze_queue(ns->head->disk->queue);
2019
		nvme_update_disk_info(ns->head->disk, ns, id);
2020
		set_disk_ro(ns->head->disk, nvme_ns_is_readonly(ns, info));
2021
		nvme_mpath_revalidate_paths(ns);
2022 2023
		blk_stack_limits(&ns->head->disk->queue->limits,
				 &ns->queue->limits, 0);
2024
		disk_update_readahead(ns->head->disk);
2025
		blk_mq_unfreeze_queue(ns->head->disk->queue);
2026
	}
2027

2028 2029
	ret = 0;
out:
2030 2031 2032 2033 2034 2035
	/*
	 * If probing fails due an unsupported feature, hide the block device,
	 * but still allow other access.
	 */
	if (ret == -ENODEV) {
		ns->disk->flags |= GENHD_FL_HIDDEN;
2036
		set_bit(NVME_NS_READY, &ns->flags);
2037 2038
		ret = 0;
	}
2039
	kfree(id);
K
Keith Busch 已提交
2040 2041 2042
	return ret;
}

2043 2044 2045 2046 2047
static int nvme_update_ns_info(struct nvme_ns *ns, struct nvme_ns_info *info)
{
	switch (info->ids.csi) {
	case NVME_CSI_ZNS:
		if (!IS_ENABLED(CONFIG_BLK_DEV_ZONED)) {
2048 2049
			dev_info(ns->ctrl->device,
	"block device for nsid %u not supported without CONFIG_BLK_DEV_ZONED\n",
2050
				info->nsid);
2051
			return nvme_update_ns_info_generic(ns, info);
2052 2053 2054 2055 2056
		}
		return nvme_update_ns_info_block(ns, info);
	case NVME_CSI_NVM:
		return nvme_update_ns_info_block(ns, info);
	default:
2057 2058 2059 2060
		dev_info(ns->ctrl->device,
			"block device for nsid %u not supported (csi %u)\n",
			info->nsid, info->ids.csi);
		return nvme_update_ns_info_generic(ns, info);
2061 2062 2063
	}
}

2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081
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;
	}
2082
}
2083

2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106
static int nvme_send_ns_head_pr_command(struct block_device *bdev,
		struct nvme_command *c, u8 data[16])
{
	struct nvme_ns_head *head = bdev->bd_disk->private_data;
	int srcu_idx = srcu_read_lock(&head->srcu);
	struct nvme_ns *ns = nvme_find_path(head);
	int ret = -EWOULDBLOCK;

	if (ns) {
		c->common.nsid = cpu_to_le32(ns->head->ns_id);
		ret = nvme_submit_sync_cmd(ns->queue, c, data, 16);
	}
	srcu_read_unlock(&head->srcu, srcu_idx);
	return ret;
}
	
static int nvme_send_ns_pr_command(struct nvme_ns *ns, struct nvme_command *c,
		u8 data[16])
{
	c->common.nsid = cpu_to_le32(ns->head->ns_id);
	return nvme_submit_sync_cmd(ns->queue, c, data, 16);
}

2107 2108 2109
static int nvme_pr_command(struct block_device *bdev, u32 cdw10,
				u64 key, u64 sa_key, u8 op)
{
2110
	struct nvme_command c = { };
2111 2112 2113 2114 2115 2116
	u8 data[16] = { 0, };

	put_unaligned_le64(key, &data[0]);
	put_unaligned_le64(sa_key, &data[8]);

	c.common.opcode = op;
2117
	c.common.cdw10 = cpu_to_le32(cdw10);
2118

2119 2120 2121 2122
	if (IS_ENABLED(CONFIG_NVME_MULTIPATH) &&
	    bdev->bd_disk->fops == &nvme_ns_head_ops)
		return nvme_send_ns_head_pr_command(bdev, &c, data);
	return nvme_send_ns_pr_command(bdev->bd_disk->private_data, &c, data);
2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154
}

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

2157 2158 2159 2160 2161
	return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire);
}

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

2164
	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release);
2165 2166 2167 2168
}

static int nvme_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
{
2169
	u32 cdw10 = nvme_pr_type(type) << 8 | (key ? 0 : 1 << 3);
2170

2171 2172 2173
	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release);
}

2174
const struct pr_ops nvme_pr_ops = {
2175 2176 2177 2178 2179 2180 2181
	.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,
};

2182
#ifdef CONFIG_BLK_SED_OPAL
2183 2184
int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
		bool send)
2185
{
2186
	struct nvme_ctrl *ctrl = data;
2187
	struct nvme_command cmd = { };
2188 2189 2190 2191 2192 2193

	if (send)
		cmd.common.opcode = nvme_admin_security_send;
	else
		cmd.common.opcode = nvme_admin_security_recv;
	cmd.common.nsid = 0;
2194 2195
	cmd.common.cdw10 = cpu_to_le32(((u32)secp) << 24 | ((u32)spsp) << 8);
	cmd.common.cdw11 = cpu_to_le32(len);
2196

2197
	return __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, NULL, buffer, len,
2198
			NVME_QID_ANY, 1, 0);
2199 2200 2201 2202
}
EXPORT_SYMBOL_GPL(nvme_sec_submit);
#endif /* CONFIG_BLK_SED_OPAL */

2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213
#ifdef CONFIG_BLK_DEV_ZONED
static int nvme_report_zones(struct gendisk *disk, sector_t sector,
		unsigned int nr_zones, report_zones_cb cb, void *data)
{
	return nvme_ns_report_zones(disk->private_data, sector, nr_zones, cb,
			data);
}
#else
#define nvme_report_zones	NULL
#endif /* CONFIG_BLK_DEV_ZONED */

J
Javier González 已提交
2214
static const struct block_device_operations nvme_bdev_ops = {
2215 2216
	.owner		= THIS_MODULE,
	.ioctl		= nvme_ioctl,
2217
	.compat_ioctl	= blkdev_compat_ptr_ioctl,
2218 2219 2220
	.open		= nvme_open,
	.release	= nvme_release,
	.getgeo		= nvme_getgeo,
K
Keith Busch 已提交
2221
	.report_zones	= nvme_report_zones,
2222 2223 2224
	.pr_ops		= &nvme_pr_ops,
};

2225
static int nvme_wait_ready(struct nvme_ctrl *ctrl, u32 timeout, bool enabled)
2226
{
2227
	unsigned long timeout_jiffies = ((timeout + 1) * HZ / 2) + jiffies;
2228 2229 2230 2231
	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 已提交
2232 2233
		if (csts == ~0)
			return -ENODEV;
2234 2235 2236
		if ((csts & NVME_CSTS_RDY) == bit)
			break;

2237
		usleep_range(1000, 2000);
2238 2239
		if (fatal_signal_pending(current))
			return -EINTR;
2240
		if (time_after(jiffies, timeout_jiffies)) {
2241
			dev_err(ctrl->device,
2242 2243
				"Device not ready; aborting %s, CSTS=0x%x\n",
				enabled ? "initialisation" : "reset", csts);
2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256
			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!
 */
2257
int nvme_disable_ctrl(struct nvme_ctrl *ctrl)
2258 2259 2260 2261 2262 2263 2264 2265 2266
{
	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;
2267

2268
	if (ctrl->quirks & NVME_QUIRK_DELAY_BEFORE_CHK_RDY)
2269 2270
		msleep(NVME_QUIRK_DELAY_AMOUNT);

2271
	return nvme_wait_ready(ctrl, NVME_CAP_TIMEOUT(ctrl->cap), false);
2272
}
2273
EXPORT_SYMBOL_GPL(nvme_disable_ctrl);
2274

2275
int nvme_enable_ctrl(struct nvme_ctrl *ctrl)
2276
{
2277
	unsigned dev_page_min;
2278
	u32 timeout;
2279 2280
	int ret;

2281 2282 2283 2284 2285 2286 2287
	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;

2288
	if (NVME_CTRL_PAGE_SHIFT < dev_page_min) {
2289
		dev_err(ctrl->device,
2290
			"Minimum device page size %u too large for host (%u)\n",
2291
			1 << dev_page_min, 1 << NVME_CTRL_PAGE_SHIFT);
2292 2293 2294
		return -ENODEV;
	}

2295 2296 2297 2298
	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;
2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319

	if (ctrl->cap & NVME_CAP_CRMS_CRWMS) {
		u32 crto;

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

		if (ctrl->cap & NVME_CAP_CRMS_CRIMS) {
			ctrl->ctrl_config |= NVME_CC_CRIME;
			timeout = NVME_CRTO_CRIMT(crto);
		} else {
			timeout = NVME_CRTO_CRWMT(crto);
		}
	} else {
		timeout = NVME_CAP_TIMEOUT(ctrl->cap);
	}

2320
	ctrl->ctrl_config |= (NVME_CTRL_PAGE_SHIFT - 12) << NVME_CC_MPS_SHIFT;
2321
	ctrl->ctrl_config |= NVME_CC_AMS_RR | NVME_CC_SHN_NONE;
2322
	ctrl->ctrl_config |= NVME_CC_IOSQES | NVME_CC_IOCQES;
2323 2324 2325
	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
	if (ret)
		return ret;
2326

2327 2328 2329 2330 2331 2332
	/* Flush write to device (required if transport is PCI) */
	ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CC, &ctrl->ctrl_config);
	if (ret)
		return ret;

	ctrl->ctrl_config |= NVME_CC_ENABLE;
2333 2334 2335
	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
	if (ret)
		return ret;
2336
	return nvme_wait_ready(ctrl, timeout, true);
2337
}
2338
EXPORT_SYMBOL_GPL(nvme_enable_ctrl);
2339 2340 2341

int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl)
{
2342
	unsigned long timeout = jiffies + (ctrl->shutdown_timeout * HZ);
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360
	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)) {
2361
			dev_err(ctrl->device,
2362 2363 2364 2365 2366 2367 2368
				"Device shutdown incomplete; abort shutdown\n");
			return -ENODEV;
		}
	}

	return ret;
}
2369
EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl);
2370

2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387
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;
}

2388
static int nvme_configure_host_options(struct nvme_ctrl *ctrl)
2389 2390
{
	struct nvme_feat_host_behavior *host;
2391
	u8 acre = 0, lbafee = 0;
2392 2393 2394
	int ret;

	/* Don't bother enabling the feature if retry delay is not reported */
2395 2396 2397 2398 2399 2400
	if (ctrl->crdt[0])
		acre = NVME_ENABLE_ACRE;
	if (ctrl->ctratt & NVME_CTRL_ATTR_ELBAS)
		lbafee = NVME_ENABLE_LBAFEE;

	if (!acre && !lbafee)
2401 2402 2403 2404 2405 2406
		return 0;

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

2407 2408
	host->acre = acre;
	host->lbafee = lbafee;
2409 2410 2411 2412 2413 2414
	ret = nvme_set_features(ctrl, NVME_FEAT_HOST_BEHAVIOR, 0,
				host, sizeof(*host), NULL);
	kfree(host);
	return ret;
}

2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443
/*
 * The function checks whether the given total (exlat + enlat) latency of
 * a power state allows the latter to be used as an APST transition target.
 * It does so by comparing the latency to the primary and secondary latency
 * tolerances defined by module params. If there's a match, the corresponding
 * timeout value is returned and the matching tolerance index (1 or 2) is
 * reported.
 */
static bool nvme_apst_get_transition_time(u64 total_latency,
		u64 *transition_time, unsigned *last_index)
{
	if (total_latency <= apst_primary_latency_tol_us) {
		if (*last_index == 1)
			return false;
		*last_index = 1;
		*transition_time = apst_primary_timeout_ms;
		return true;
	}
	if (apst_secondary_timeout_ms &&
		total_latency <= apst_secondary_latency_tol_us) {
		if (*last_index <= 2)
			return false;
		*last_index = 2;
		*transition_time = apst_secondary_timeout_ms;
		return true;
	}
	return false;
}

2444 2445 2446
/*
 * APST (Autonomous Power State Transition) lets us program a table of power
 * state transitions that the controller will perform automatically.
2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462
 *
 * Depending on module params, one of the two supported techniques will be used:
 *
 * - If the parameters provide explicit timeouts and tolerances, they will be
 *   used to build a table with up to 2 non-operational states to transition to.
 *   The default parameter values were selected based on the values used by
 *   Microsoft's and Intel's NVMe drivers. Yet, since we don't implement dynamic
 *   regeneration of the APST table in the event of switching between external
 *   and battery power, the timeouts and tolerances reflect a compromise
 *   between values used by Microsoft for AC and battery scenarios.
 * - If not, we'll configure the table 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 non-operational state after waiting 50 * (enlat + exlat)
 *   microseconds, as long as that state's exit latency is under the requested
 *   maximum latency.
2463 2464 2465 2466 2467 2468
 *
 * 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.
 */
2469
static int nvme_configure_apst(struct nvme_ctrl *ctrl)
2470 2471
{
	struct nvme_feat_auto_pst *table;
2472
	unsigned apste = 0;
2473
	u64 max_lat_us = 0;
2474
	__le64 target = 0;
2475
	int max_ps = -1;
2476
	int state;
2477
	int ret;
2478
	unsigned last_lt_index = UINT_MAX;
2479 2480 2481 2482 2483 2484

	/*
	 * If APST isn't supported or if we haven't been initialized yet,
	 * then don't do anything.
	 */
	if (!ctrl->apsta)
2485
		return 0;
2486 2487 2488

	if (ctrl->npss > 31) {
		dev_warn(ctrl->device, "NPSS is invalid; not using APST\n");
2489
		return 0;
2490 2491 2492 2493
	}

	table = kzalloc(sizeof(*table), GFP_KERNEL);
	if (!table)
2494
		return 0;
2495

2496
	if (!ctrl->apst_enabled || ctrl->ps_max_latency_us == 0) {
2497
		/* Turn off APST. */
2498
		dev_dbg(ctrl->device, "APST disabled\n");
2499 2500
		goto done;
	}
2501

2502 2503 2504 2505 2506 2507 2508 2509
	/*
	 * 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--) {
		u64 total_latency_us, exit_latency_us, transition_ms;
2510

2511 2512
		if (target)
			table->entries[state] = target;
2513 2514

		/*
2515 2516
		 * Don't allow transitions to the deepest state if it's quirked
		 * off.
2517
		 */
2518 2519 2520
		if (state == ctrl->npss &&
		    (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS))
			continue;
2521

2522 2523 2524 2525 2526 2527
		/*
		 * 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;
2528

2529 2530 2531
		exit_latency_us = (u64)le32_to_cpu(ctrl->psd[state].exit_lat);
		if (exit_latency_us > ctrl->ps_max_latency_us)
			continue;
2532

2533 2534
		total_latency_us = exit_latency_us +
			le32_to_cpu(ctrl->psd[state].entry_lat);
2535

2536
		/*
2537 2538
		 * This state is good. It can be used as the APST idle target
		 * for higher power states.
2539
		 */
2540 2541 2542 2543 2544 2545 2546 2547 2548 2549
		if (apst_primary_timeout_ms && apst_primary_latency_tol_us) {
			if (!nvme_apst_get_transition_time(total_latency_us,
					&transition_ms, &last_lt_index))
				continue;
		} else {
			transition_ms = total_latency_us + 19;
			do_div(transition_ms, 20);
			if (transition_ms > (1 << 24) - 1)
				transition_ms = (1 << 24) - 1;
		}
2550 2551 2552 2553 2554 2555

		target = cpu_to_le64((state << 3) | (transition_ms << 8));
		if (max_ps == -1)
			max_ps = state;
		if (total_latency_us > max_lat_us)
			max_lat_us = total_latency_us;
2556 2557
	}

2558 2559 2560 2561 2562 2563 2564 2565
	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);
	apste = 1;

done:
2566 2567 2568 2569 2570
	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);
2571
	return ret;
2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590
}

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;
2591 2592
		if (ctrl->state == NVME_CTRL_LIVE)
			nvme_configure_apst(ctrl);
2593 2594 2595
	}
}

2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608
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[] = {
2609
	{
2610 2611 2612 2613 2614 2615
		/*
		 * 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",
2616
		.quirks = NVME_QUIRK_NO_APST,
2617 2618 2619 2620 2621 2622 2623 2624 2625 2626
	},
	{
		/*
		 * 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,
2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640
	},
	{
		/*
		 * This Kioxia CD6-V Series / HPE PE8030 device times out and
		 * aborts I/O during any load, but more easily reproducible
		 * with discards (fstrim).
		 *
		 * The device is left in a state where it is also not possible
		 * to use "nvme set-feature" to disable APST, but booting with
		 * nvme_core.default_ps_max_latency=0 works.
		 */
		.vid = 0x1e0f,
		.mn = "KCD6XVUL6T40",
		.quirks = NVME_QUIRK_NO_APST,
2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654
	},
	{
		/*
		 * The external Samsung X5 SSD fails initialization without a
		 * delay before checking if it is ready and has a whole set of
		 * other problems.  To make this even more interesting, it
		 * shares the PCI ID with internal Samsung 970 Evo Plus that
		 * does not need or want these quirks.
		 */
		.vid = 0x144d,
		.mn = "Samsung Portable SSD X5",
		.quirks = NVME_QUIRK_DELAY_BEFORE_CHK_RDY |
			  NVME_QUIRK_NO_DEEPEST_PS |
			  NVME_QUIRK_IGNORE_DEV_SUBNQN,
2655
	}
2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686
};

/* 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 已提交
2687 2688
static void nvme_init_subnqn(struct nvme_subsystem *subsys, struct nvme_ctrl *ctrl,
		struct nvme_id_ctrl *id)
2689 2690 2691 2692
{
	size_t nqnlen;
	int off;

2693 2694 2695
	if(!(ctrl->quirks & NVME_QUIRK_IGNORE_DEV_SUBNQN)) {
		nqnlen = strnlen(id->subnqn, NVMF_NQN_SIZE);
		if (nqnlen > 0 && nqnlen < NVMF_NQN_SIZE) {
2696
			strscpy(subsys->subnqn, id->subnqn, NVMF_NQN_SIZE);
2697 2698
			return;
		}
2699

2700 2701 2702
		if (ctrl->vs >= NVME_VS(1, 2, 1))
			dev_warn(ctrl->device, "missing or invalid SUBNQN field.\n");
	}
2703

2704 2705 2706 2707 2708
	/*
	 * Generate a "fake" NQN similar to the one in Section 4.5 of the NVMe
	 * Base Specification 2.0.  It is slightly different from the format
	 * specified there due to historic reasons, and we can't change it now.
	 */
C
Christoph Hellwig 已提交
2709
	off = snprintf(subsys->subnqn, NVMF_NQN_SIZE,
2710
			"nqn.2014.08.org.nvmexpress:%04x%04x",
2711
			le16_to_cpu(id->vid), le16_to_cpu(id->ssvid));
C
Christoph Hellwig 已提交
2712
	memcpy(subsys->subnqn + off, id->sn, sizeof(id->sn));
2713
	off += sizeof(id->sn);
C
Christoph Hellwig 已提交
2714
	memcpy(subsys->subnqn + off, id->mn, sizeof(id->mn));
2715
	off += sizeof(id->mn);
C
Christoph Hellwig 已提交
2716 2717 2718
	memset(subsys->subnqn + off, 0, sizeof(subsys->subnqn) - off);
}

2719
static void nvme_release_subsystem(struct device *dev)
C
Christoph Hellwig 已提交
2720
{
2721 2722 2723
	struct nvme_subsystem *subsys =
		container_of(dev, struct nvme_subsystem, dev);

2724
	if (subsys->instance >= 0)
2725
		ida_free(&nvme_instance_ida, subsys->instance);
C
Christoph Hellwig 已提交
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737
	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 已提交
2738
	ida_destroy(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753
	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);

2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764
	/*
	 * 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 已提交
2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775
	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;
}

2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786
#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);

2787
	return sysfs_emit(buf, "%s\n", subsys->subnqn);
2788 2789 2790
}
static SUBSYS_ATTR_RO(subsysnqn, S_IRUGO, nvme_subsys_show_nqn);

2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808
static ssize_t nvme_subsys_show_type(struct device *dev,
				    struct device_attribute *attr,
				    char *buf)
{
	struct nvme_subsystem *subsys =
		container_of(dev, struct nvme_subsystem, dev);

	switch (subsys->subtype) {
	case NVME_NQN_DISC:
		return sysfs_emit(buf, "discovery\n");
	case NVME_NQN_NVME:
		return sysfs_emit(buf, "nvm\n");
	default:
		return sysfs_emit(buf, "reserved\n");
	}
}
static SUBSYS_ATTR_RO(subsystype, S_IRUGO, nvme_subsys_show_type);

2809 2810 2811 2812 2813 2814
#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);		\
2815 2816
	return sysfs_emit(buf, "%.*s\n",				\
			   (int)sizeof(subsys->field), subsys->field);	\
2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828
}									\
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,
2829
	&subsys_attr_subsystype.attr,
2830 2831 2832
#ifdef CONFIG_NVME_MULTIPATH
	&subsys_attr_iopolicy.attr,
#endif
2833 2834 2835
	NULL,
};

2836
static const struct attribute_group nvme_subsys_attrs_group = {
2837 2838 2839 2840 2841 2842 2843 2844
	.attrs = nvme_subsys_attrs,
};

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

2845 2846 2847 2848 2849
static inline bool nvme_discovery_ctrl(struct nvme_ctrl *ctrl)
{
	return ctrl->opts && ctrl->opts->discovery_nqn;
}

2850 2851
static bool nvme_validate_cntlid(struct nvme_subsystem *subsys,
		struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
2852
{
2853
	struct nvme_ctrl *tmp;
2854

2855 2856
	lockdep_assert_held(&nvme_subsystems_lock);

2857
	list_for_each_entry(tmp, &subsys->ctrls, subsys_entry) {
2858
		if (nvme_state_terminal(tmp))
2859 2860 2861 2862
			continue;

		if (tmp->cntlid == ctrl->cntlid) {
			dev_err(ctrl->device,
2863 2864 2865
				"Duplicate cntlid %u with %s, subsys %s, rejecting\n",
				ctrl->cntlid, dev_name(tmp->device),
				subsys->subnqn);
2866 2867
			return false;
		}
2868

2869
		if ((id->cmic & NVME_CTRL_CMIC_MULTI_CTRL) ||
2870
		    nvme_discovery_ctrl(ctrl))
2871 2872 2873 2874 2875
			continue;

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

2878
	return true;
2879 2880
}

C
Christoph Hellwig 已提交
2881 2882 2883 2884 2885 2886 2887 2888
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;
2889 2890

	subsys->instance = -1;
C
Christoph Hellwig 已提交
2891 2892 2893
	mutex_init(&subsys->lock);
	kref_init(&subsys->ref);
	INIT_LIST_HEAD(&subsys->ctrls);
C
Christoph Hellwig 已提交
2894
	INIT_LIST_HEAD(&subsys->nsheads);
C
Christoph Hellwig 已提交
2895 2896 2897 2898 2899
	nvme_init_subnqn(subsys, ctrl, id);
	memcpy(subsys->serial, id->sn, sizeof(subsys->serial));
	memcpy(subsys->model, id->mn, sizeof(subsys->model));
	subsys->vendor_id = le16_to_cpu(id->vid);
	subsys->cmic = id->cmic;
2900 2901 2902 2903 2904 2905 2906 2907

	/* Versions prior to 1.4 don't necessarily report a valid type */
	if (id->cntrltype == NVME_CTRL_DISC ||
	    !strcmp(subsys->subnqn, NVME_DISC_SUBSYS_NAME))
		subsys->subtype = NVME_NQN_DISC;
	else
		subsys->subtype = NVME_NQN_NVME;

2908 2909 2910 2911 2912 2913 2914
	if (nvme_discovery_ctrl(ctrl) && subsys->subtype != NVME_NQN_DISC) {
		dev_err(ctrl->device,
			"Subsystem %s is not a discovery controller",
			subsys->subnqn);
		kfree(subsys);
		return -EINVAL;
	}
2915
	subsys->awupf = le16_to_cpu(id->awupf);
2916
	nvme_mpath_default_iopolicy(subsys);
C
Christoph Hellwig 已提交
2917 2918 2919

	subsys->dev.class = nvme_subsys_class;
	subsys->dev.release = nvme_release_subsystem;
2920
	subsys->dev.groups = nvme_subsys_attrs_groups;
2921
	dev_set_name(&subsys->dev, "nvme-subsys%d", ctrl->instance);
C
Christoph Hellwig 已提交
2922 2923 2924 2925 2926
	device_initialize(&subsys->dev);

	mutex_lock(&nvme_subsystems_lock);
	found = __nvme_find_get_subsystem(subsys->subnqn);
	if (found) {
2927
		put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2928
		subsys = found;
2929

2930
		if (!nvme_validate_cntlid(subsys, ctrl, id)) {
C
Christoph Hellwig 已提交
2931
			ret = -EINVAL;
2932
			goto out_put_subsystem;
C
Christoph Hellwig 已提交
2933 2934 2935 2936 2937 2938
		}
	} else {
		ret = device_add(&subsys->dev);
		if (ret) {
			dev_err(ctrl->device,
				"failed to register subsystem device.\n");
2939
			put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2940 2941
			goto out_unlock;
		}
C
Christoph Hellwig 已提交
2942
		ida_init(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2943 2944 2945
		list_add_tail(&subsys->entry, &nvme_subsystems);
	}

2946 2947 2948
	ret = sysfs_create_link(&subsys->dev.kobj, &ctrl->device->kobj,
				dev_name(ctrl->device));
	if (ret) {
C
Christoph Hellwig 已提交
2949 2950
		dev_err(ctrl->device,
			"failed to create sysfs link from subsystem.\n");
2951
		goto out_put_subsystem;
C
Christoph Hellwig 已提交
2952 2953
	}

2954 2955
	if (!found)
		subsys->instance = ctrl->instance;
2956
	ctrl->subsys = subsys;
C
Christoph Hellwig 已提交
2957
	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
2958
	mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
2959 2960
	return 0;

2961 2962
out_put_subsystem:
	nvme_put_subsystem(subsys);
C
Christoph Hellwig 已提交
2963 2964 2965
out_unlock:
	mutex_unlock(&nvme_subsystems_lock);
	return ret;
2966 2967
}

2968
int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
2969
		void *log, size_t size, u64 offset)
K
Keith Busch 已提交
2970 2971
{
	struct nvme_command c = { };
K
Keith Busch 已提交
2972
	u32 dwlen = nvme_bytes_to_numd(size);
2973 2974

	c.get_log_page.opcode = nvme_admin_get_log_page;
2975
	c.get_log_page.nsid = cpu_to_le32(nsid);
2976
	c.get_log_page.lid = log_page;
2977
	c.get_log_page.lsp = lsp;
2978 2979
	c.get_log_page.numdl = cpu_to_le16(dwlen & ((1 << 16) - 1));
	c.get_log_page.numdu = cpu_to_le16(dwlen >> 16);
2980 2981
	c.get_log_page.lpol = cpu_to_le32(lower_32_bits(offset));
	c.get_log_page.lpou = cpu_to_le32(upper_32_bits(offset));
2982
	c.get_log_page.csi = csi;
K
Keith Busch 已提交
2983 2984 2985 2986

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

2987 2988
static int nvme_get_effects_log(struct nvme_ctrl *ctrl, u8 csi,
				struct nvme_effects_log **log)
2989
{
2990
	struct nvme_effects_log	*cel = xa_load(&ctrl->cels, csi);
2991 2992
	int ret;

2993 2994
	if (cel)
		goto out;
2995

2996 2997 2998
	cel = kzalloc(sizeof(*cel), GFP_KERNEL);
	if (!cel)
		return -ENOMEM;
2999

3000
	ret = nvme_get_log(ctrl, 0x00, NVME_LOG_CMD_EFFECTS, 0, csi,
3001
			cel, sizeof(*cel), 0);
3002
	if (ret) {
3003 3004
		kfree(cel);
		return ret;
3005
	}
3006

3007
	xa_store(&ctrl->cels, csi, cel, GFP_KERNEL);
3008
out:
3009
	*log = cel;
3010
	return 0;
3011 3012
}

3013
static inline u32 nvme_mps_to_sectors(struct nvme_ctrl *ctrl, u32 units)
3014
{
3015
	u32 page_shift = NVME_CAP_MPSMIN(ctrl->cap) + 12, val;
3016

3017 3018 3019
	if (check_shl_overflow(1U, units + page_shift - 9, &val))
		return UINT_MAX;
	return val;
3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033
}

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;
3034
	}
3035

3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064
	/*
	 * 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;
T
Tom Yan 已提交
3065
	ctrl->dmrsl = le32_to_cpu(id->dmrsl);
3066 3067 3068 3069 3070 3071 3072 3073
	if (id->wzsl)
		ctrl->max_zeroes_sectors = nvme_mps_to_sectors(ctrl, id->wzsl);

free_data:
	kfree(id);
	return ret;
}

3074
static int nvme_init_identify(struct nvme_ctrl *ctrl)
3075 3076
{
	struct nvme_id_ctrl *id;
3077
	u32 max_hw_sectors;
3078
	bool prev_apst_enabled;
3079
	int ret;
3080

3081 3082
	ret = nvme_identify_ctrl(ctrl, &id);
	if (ret) {
3083
		dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret);
3084 3085 3086
		return -EIO;
	}

3087
	if (id->lpa & NVME_CTRL_LPA_CMD_EFFECTS_LOG) {
3088
		ret = nvme_get_effects_log(ctrl, NVME_CSI_NVM, &ctrl->effects);
3089
		if (ret < 0)
3090
			goto out_free;
3091
	}
3092

3093 3094 3095
	if (!(ctrl->ops->flags & NVME_F_FABRICS))
		ctrl->cntlid = le16_to_cpu(id->cntlid);

3096
	if (!ctrl->identified) {
3097
		unsigned int i;
C
Christoph Hellwig 已提交
3098 3099 3100 3101 3102

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

3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115
		/*
		 * 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;
		}
	}
3116 3117
	memcpy(ctrl->subsys->firmware_rev, id->fr,
	       sizeof(ctrl->subsys->firmware_rev));
3118

3119
	if (force_apst && (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) {
3120
		dev_warn(ctrl->device, "forcibly allowing all power states due to nvme_core.force_apst -- use at your own risk\n");
3121 3122 3123
		ctrl->quirks &= ~NVME_QUIRK_NO_DEEPEST_PS;
	}

3124 3125 3126 3127
	ctrl->crdt[0] = le16_to_cpu(id->crdt1);
	ctrl->crdt[1] = le16_to_cpu(id->crdt2);
	ctrl->crdt[2] = le16_to_cpu(id->crdt3);

3128
	ctrl->oacs = le16_to_cpu(id->oacs);
3129
	ctrl->oncs = le16_to_cpu(id->oncs);
3130
	ctrl->mtfa = le16_to_cpu(id->mtfa);
3131
	ctrl->oaes = le32_to_cpu(id->oaes);
3132 3133 3134
	ctrl->wctemp = le16_to_cpu(id->wctemp);
	ctrl->cctemp = le16_to_cpu(id->cctemp);

3135
	atomic_set(&ctrl->abort_limit, id->acl + 1);
3136 3137
	ctrl->vwc = id->vwc;
	if (id->mdts)
3138
		max_hw_sectors = nvme_mps_to_sectors(ctrl, id->mdts);
3139
	else
3140 3141 3142
		max_hw_sectors = UINT_MAX;
	ctrl->max_hw_sectors =
		min_not_zero(ctrl->max_hw_sectors, max_hw_sectors);
3143

3144
	nvme_set_queue_limits(ctrl, ctrl->admin_q);
3145
	ctrl->sgls = le32_to_cpu(id->sgls);
S
Sagi Grimberg 已提交
3146
	ctrl->kas = le16_to_cpu(id->kas);
C
Christoph Hellwig 已提交
3147
	ctrl->max_namespaces = le32_to_cpu(id->mnan);
S
Sagi Grimberg 已提交
3148
	ctrl->ctratt = le32_to_cpu(id->ctratt);
3149

3150 3151 3152
	ctrl->cntrltype = id->cntrltype;
	ctrl->dctype = id->dctype;

3153 3154
	if (id->rtd3e) {
		/* us -> s */
3155
		u32 transition_time = le32_to_cpu(id->rtd3e) / USEC_PER_SEC;
3156 3157 3158 3159 3160

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

		if (ctrl->shutdown_timeout != shutdown_timeout)
3161
			dev_info(ctrl->device,
3162 3163 3164 3165 3166
				 "Shutdown timeout set to %u seconds\n",
				 ctrl->shutdown_timeout);
	} else
		ctrl->shutdown_timeout = shutdown_timeout;

3167
	ctrl->npss = id->npss;
3168 3169
	ctrl->apsta = id->apsta;
	prev_apst_enabled = ctrl->apst_enabled;
3170 3171
	if (ctrl->quirks & NVME_QUIRK_NO_APST) {
		if (force_apst && id->apsta) {
3172
			dev_warn(ctrl->device, "forcibly allowing APST due to nvme_core.force_apst -- use at your own risk\n");
3173
			ctrl->apst_enabled = true;
3174
		} else {
3175
			ctrl->apst_enabled = false;
3176 3177
		}
	} else {
3178
		ctrl->apst_enabled = id->apsta;
3179
	}
3180 3181
	memcpy(ctrl->psd, id->psd, sizeof(ctrl->psd));

3182
	if (ctrl->ops->flags & NVME_F_FABRICS) {
3183 3184 3185 3186 3187 3188 3189 3190 3191
		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
		 */
3192
		if (ctrl->cntlid != le16_to_cpu(id->cntlid)) {
3193 3194 3195 3196
			dev_err(ctrl->device,
				"Mismatching cntlid: Connect %u vs Identify "
				"%u, rejecting\n",
				ctrl->cntlid, le16_to_cpu(id->cntlid));
3197
			ret = -EINVAL;
3198 3199
			goto out_free;
		}
S
Sagi Grimberg 已提交
3200

3201
		if (!nvme_discovery_ctrl(ctrl) && !ctrl->kas) {
3202
			dev_err(ctrl->device,
S
Sagi Grimberg 已提交
3203 3204
				"keep-alive support is mandatory for fabrics\n");
			ret = -EINVAL;
3205
			goto out_free;
S
Sagi Grimberg 已提交
3206
		}
3207
	} else {
3208 3209
		ctrl->hmpre = le32_to_cpu(id->hmpre);
		ctrl->hmmin = le32_to_cpu(id->hmmin);
3210 3211
		ctrl->hmminds = le32_to_cpu(id->hmminds);
		ctrl->hmmaxd = le16_to_cpu(id->hmmaxd);
3212
	}
3213

3214
	ret = nvme_mpath_init_identify(ctrl, id);
C
Christoph Hellwig 已提交
3215
	if (ret < 0)
3216
		goto out_free;
C
Christoph Hellwig 已提交
3217

3218
	if (ctrl->apst_enabled && !prev_apst_enabled)
3219
		dev_pm_qos_expose_latency_tolerance(ctrl->device);
3220
	else if (!ctrl->apst_enabled && prev_apst_enabled)
3221 3222
		dev_pm_qos_hide_latency_tolerance(ctrl->device);

3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251
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;

3252 3253 3254
	ret = nvme_configure_apst(ctrl);
	if (ret < 0)
		return ret;
3255

3256 3257 3258
	ret = nvme_configure_timestamp(ctrl);
	if (ret < 0)
		return ret;
3259

3260
	ret = nvme_configure_host_options(ctrl);
3261 3262 3263
	if (ret < 0)
		return ret;

3264
	if (!ctrl->identified && !nvme_discovery_ctrl(ctrl)) {
3265 3266 3267 3268
		/*
		 * Do not return errors unless we are in a controller reset,
		 * the controller works perfectly fine without hwmon.
		 */
K
Keith Busch 已提交
3269
		ret = nvme_hwmon_init(ctrl);
3270
		if (ret == -EINTR)
K
Keith Busch 已提交
3271 3272
			return ret;
	}
3273

3274
	ctrl->identified = true;
3275

3276
	return 0;
3277
}
3278
EXPORT_SYMBOL_GPL(nvme_init_ctrl_finish);
3279

3280
static int nvme_dev_open(struct inode *inode, struct file *file)
3281
{
3282 3283
	struct nvme_ctrl *ctrl =
		container_of(inode->i_cdev, struct nvme_ctrl, cdev);
3284

3285 3286 3287 3288
	switch (ctrl->state) {
	case NVME_CTRL_LIVE:
		break;
	default:
3289
		return -EWOULDBLOCK;
3290 3291
	}

3292
	nvme_get_ctrl(ctrl);
3293 3294
	if (!try_module_get(ctrl->ops->module)) {
		nvme_put_ctrl(ctrl);
3295
		return -EINVAL;
3296
	}
3297

3298
	file->private_data = ctrl;
3299 3300 3301
	return 0;
}

3302 3303 3304 3305 3306 3307 3308 3309 3310 3311
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;
}

3312 3313 3314
static const struct file_operations nvme_dev_fops = {
	.owner		= THIS_MODULE,
	.open		= nvme_dev_open,
3315
	.release	= nvme_dev_release,
3316
	.unlocked_ioctl	= nvme_dev_ioctl,
3317
	.compat_ioctl	= compat_ptr_ioctl,
3318
	.uring_cmd	= nvme_dev_uring_cmd,
3319 3320 3321 3322 3323 3324 3325 3326 3327
};

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;

3328
	ret = nvme_reset_ctrl_sync(ctrl);
3329 3330 3331
	if (ret < 0)
		return ret;
	return count;
3332
}
3333
static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset);
3334

K
Keith Busch 已提交
3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345
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);

3346 3347 3348 3349
static inline struct nvme_ns_head *dev_to_ns_head(struct device *dev)
{
	struct gendisk *disk = dev_to_disk(dev);

J
Javier González 已提交
3350
	if (disk->fops == &nvme_bdev_ops)
3351 3352 3353 3354 3355
		return nvme_get_ns_from_dev(dev)->head;
	else
		return disk->private_data;
}

3356
static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
3357
		char *buf)
3358
{
3359 3360 3361
	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 已提交
3362 3363
	int serial_len = sizeof(subsys->serial);
	int model_len = sizeof(subsys->model);
3364

3365
	if (!uuid_is_null(&ids->uuid))
3366
		return sysfs_emit(buf, "uuid.%pU\n", &ids->uuid);
3367

3368
	if (memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3369
		return sysfs_emit(buf, "eui.%16phN\n", ids->nguid);
3370

3371
	if (memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3372
		return sysfs_emit(buf, "eui.%8phN\n", ids->eui64);
3373

C
Christoph Hellwig 已提交
3374 3375
	while (serial_len > 0 && (subsys->serial[serial_len - 1] == ' ' ||
				  subsys->serial[serial_len - 1] == '\0'))
3376
		serial_len--;
C
Christoph Hellwig 已提交
3377 3378
	while (model_len > 0 && (subsys->model[model_len - 1] == ' ' ||
				 subsys->model[model_len - 1] == '\0'))
3379 3380
		model_len--;

3381
	return sysfs_emit(buf, "nvme.%04x-%*phN-%*phN-%08x\n", subsys->vendor_id,
C
Christoph Hellwig 已提交
3382
		serial_len, subsys->serial, model_len, subsys->model,
3383
		head->ns_id);
3384
}
J
Joe Perches 已提交
3385
static DEVICE_ATTR_RO(wwid);
3386

3387
static ssize_t nguid_show(struct device *dev, struct device_attribute *attr,
3388
		char *buf)
3389
{
3390
	return sysfs_emit(buf, "%pU\n", dev_to_ns_head(dev)->ids.nguid);
3391
}
J
Joe Perches 已提交
3392
static DEVICE_ATTR_RO(nguid);
3393

3394
static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
3395
		char *buf)
3396
{
3397
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3398 3399 3400 3401

	/* For backward compatibility expose the NGUID to userspace if
	 * we have no UUID set
	 */
3402
	if (uuid_is_null(&ids->uuid)) {
3403 3404
		dev_warn_ratelimited(dev,
			"No UUID available providing old NGUID\n");
3405
		return sysfs_emit(buf, "%pU\n", ids->nguid);
3406
	}
3407
	return sysfs_emit(buf, "%pU\n", &ids->uuid);
3408
}
J
Joe Perches 已提交
3409
static DEVICE_ATTR_RO(uuid);
3410 3411

static ssize_t eui_show(struct device *dev, struct device_attribute *attr,
3412
		char *buf)
3413
{
3414
	return sysfs_emit(buf, "%8ph\n", dev_to_ns_head(dev)->ids.eui64);
3415
}
J
Joe Perches 已提交
3416
static DEVICE_ATTR_RO(eui);
3417 3418

static ssize_t nsid_show(struct device *dev, struct device_attribute *attr,
3419
		char *buf)
3420
{
3421
	return sysfs_emit(buf, "%d\n", dev_to_ns_head(dev)->ns_id);
3422
}
J
Joe Perches 已提交
3423
static DEVICE_ATTR_RO(nsid);
3424

3425
static struct attribute *nvme_ns_id_attrs[] = {
3426
	&dev_attr_wwid.attr,
3427
	&dev_attr_uuid.attr,
3428
	&dev_attr_nguid.attr,
3429 3430
	&dev_attr_eui.attr,
	&dev_attr_nsid.attr,
C
Christoph Hellwig 已提交
3431 3432 3433 3434
#ifdef CONFIG_NVME_MULTIPATH
	&dev_attr_ana_grpid.attr,
	&dev_attr_ana_state.attr,
#endif
3435 3436 3437
	NULL,
};

3438
static umode_t nvme_ns_id_attrs_are_visible(struct kobject *kobj,
3439 3440 3441
		struct attribute *a, int n)
{
	struct device *dev = container_of(kobj, struct device, kobj);
3442
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3443 3444

	if (a == &dev_attr_uuid.attr) {
3445
		if (uuid_is_null(&ids->uuid) &&
3446
		    !memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3447 3448 3449
			return 0;
	}
	if (a == &dev_attr_nguid.attr) {
3450
		if (!memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3451 3452 3453
			return 0;
	}
	if (a == &dev_attr_eui.attr) {
3454
		if (!memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3455 3456
			return 0;
	}
C
Christoph Hellwig 已提交
3457 3458
#ifdef CONFIG_NVME_MULTIPATH
	if (a == &dev_attr_ana_grpid.attr || a == &dev_attr_ana_state.attr) {
J
Javier González 已提交
3459
		if (dev_to_disk(dev)->fops != &nvme_bdev_ops) /* per-path attr */
C
Christoph Hellwig 已提交
3460 3461 3462 3463 3464
			return 0;
		if (!nvme_ctrl_use_ana(nvme_get_ns_from_dev(dev)->ctrl))
			return 0;
	}
#endif
3465 3466 3467
	return a->mode;
}

3468
static const struct attribute_group nvme_ns_id_attr_group = {
3469 3470
	.attrs		= nvme_ns_id_attrs,
	.is_visible	= nvme_ns_id_attrs_are_visible,
3471 3472
};

3473 3474 3475 3476 3477
const struct attribute_group *nvme_ns_id_attr_groups[] = {
	&nvme_ns_id_attr_group,
	NULL,
};

M
Ming Lin 已提交
3478
#define nvme_show_str_function(field)						\
3479 3480 3481 3482
static ssize_t  field##_show(struct device *dev,				\
			    struct device_attribute *attr, char *buf)		\
{										\
        struct nvme_ctrl *ctrl = dev_get_drvdata(dev);				\
3483
        return sysfs_emit(buf, "%.*s\n",					\
C
Christoph Hellwig 已提交
3484
		(int)sizeof(ctrl->subsys->field), ctrl->subsys->field);		\
3485 3486 3487
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

C
Christoph Hellwig 已提交
3488 3489 3490 3491
nvme_show_str_function(model);
nvme_show_str_function(serial);
nvme_show_str_function(firmware_rev);

M
Ming Lin 已提交
3492 3493 3494 3495 3496
#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);				\
3497
        return sysfs_emit(buf, "%d\n", ctrl->field);				\
M
Ming Lin 已提交
3498 3499 3500 3501
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

nvme_show_int_function(cntlid);
3502
nvme_show_int_function(numa_node);
3503 3504
nvme_show_int_function(queue_count);
nvme_show_int_function(sqsize);
3505
nvme_show_int_function(kato);
3506

M
Ming Lin 已提交
3507 3508 3509 3510 3511 3512 3513
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))
3514
		nvme_delete_ctrl_sync(ctrl);
M
Ming Lin 已提交
3515 3516 3517 3518 3519 3520 3521 3522 3523 3524
	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);

3525
	return sysfs_emit(buf, "%s\n", ctrl->ops->name);
M
Ming Lin 已提交
3526 3527 3528
}
static DEVICE_ATTR(transport, S_IRUGO, nvme_sysfs_show_transport, NULL);

3529 3530 3531 3532 3533 3534 3535 3536 3537
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",
3538
		[NVME_CTRL_CONNECTING]	= "connecting",
3539
		[NVME_CTRL_DELETING]	= "deleting",
3540
		[NVME_CTRL_DELETING_NOIO]= "deleting (no IO)",
3541 3542 3543 3544 3545
		[NVME_CTRL_DEAD]	= "dead",
	};

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

3548
	return sysfs_emit(buf, "unknown state\n");
3549 3550 3551 3552
}

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

M
Ming Lin 已提交
3553 3554 3555 3556 3557 3558
static ssize_t nvme_sysfs_show_subsysnqn(struct device *dev,
					 struct device_attribute *attr,
					 char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3559
	return sysfs_emit(buf, "%s\n", ctrl->subsys->subnqn);
M
Ming Lin 已提交
3560 3561 3562
}
static DEVICE_ATTR(subsysnqn, S_IRUGO, nvme_sysfs_show_subsysnqn, NULL);

3563 3564 3565 3566 3567 3568
static ssize_t nvme_sysfs_show_hostnqn(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3569
	return sysfs_emit(buf, "%s\n", ctrl->opts->host->nqn);
3570 3571 3572
}
static DEVICE_ATTR(hostnqn, S_IRUGO, nvme_sysfs_show_hostnqn, NULL);

3573 3574 3575 3576 3577 3578
static ssize_t nvme_sysfs_show_hostid(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3579
	return sysfs_emit(buf, "%pU\n", &ctrl->opts->host->id);
3580 3581 3582
}
static DEVICE_ATTR(hostid, S_IRUGO, nvme_sysfs_show_hostid, NULL);

M
Ming Lin 已提交
3583 3584 3585 3586 3587 3588 3589 3590 3591 3592
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);

3593 3594 3595 3596 3597 3598 3599
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)
3600 3601 3602
		return sysfs_emit(buf, "off\n");
	return sysfs_emit(buf, "%d\n",
			  opts->max_reconnects * opts->reconnect_delay);
3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615
}

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;

3616
	if (ctrl_loss_tmo < 0)
3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631
		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)
3632 3633
		return sysfs_emit(buf, "off\n");
	return sysfs_emit(buf, "%d\n", ctrl->opts->reconnect_delay);
3634 3635 3636 3637 3638 3639 3640 3641 3642 3643
}

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);
3644 3645
	if (err)
		return err;
3646 3647 3648 3649 3650 3651 3652

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

3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682
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);

3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716
static ssize_t cntrltype_show(struct device *dev,
			      struct device_attribute *attr, char *buf)
{
	static const char * const type[] = {
		[NVME_CTRL_IO] = "io\n",
		[NVME_CTRL_DISC] = "discovery\n",
		[NVME_CTRL_ADMIN] = "admin\n",
	};
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

	if (ctrl->cntrltype > NVME_CTRL_ADMIN || !type[ctrl->cntrltype])
		return sysfs_emit(buf, "reserved\n");

	return sysfs_emit(buf, type[ctrl->cntrltype]);
}
static DEVICE_ATTR_RO(cntrltype);

static ssize_t dctype_show(struct device *dev,
			   struct device_attribute *attr, char *buf)
{
	static const char * const type[] = {
		[NVME_DCTYPE_NOT_REPORTED] = "none\n",
		[NVME_DCTYPE_DDC] = "ddc\n",
		[NVME_DCTYPE_CDC] = "cdc\n",
	};
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

	if (ctrl->dctype > NVME_DCTYPE_CDC || !type[ctrl->dctype])
		return sysfs_emit(buf, "reserved\n");

	return sysfs_emit(buf, type[ctrl->dctype]);
}
static DEVICE_ATTR_RO(dctype);

3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 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 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818
#ifdef CONFIG_NVME_AUTH
static ssize_t nvme_ctrl_dhchap_secret_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 (!opts->dhchap_secret)
		return sysfs_emit(buf, "none\n");
	return sysfs_emit(buf, "%s\n", opts->dhchap_secret);
}

static ssize_t nvme_ctrl_dhchap_secret_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;
	char *dhchap_secret;

	if (!ctrl->opts->dhchap_secret)
		return -EINVAL;
	if (count < 7)
		return -EINVAL;
	if (memcmp(buf, "DHHC-1:", 7))
		return -EINVAL;

	dhchap_secret = kzalloc(count + 1, GFP_KERNEL);
	if (!dhchap_secret)
		return -ENOMEM;
	memcpy(dhchap_secret, buf, count);
	nvme_auth_stop(ctrl);
	if (strcmp(dhchap_secret, opts->dhchap_secret)) {
		int ret;

		ret = nvme_auth_generate_key(dhchap_secret, &ctrl->host_key);
		if (ret)
			return ret;
		kfree(opts->dhchap_secret);
		opts->dhchap_secret = dhchap_secret;
		/* Key has changed; re-authentication with new key */
		nvme_auth_reset(ctrl);
	}
	/* Start re-authentication */
	dev_info(ctrl->device, "re-authenticating controller\n");
	queue_work(nvme_wq, &ctrl->dhchap_auth_work);

	return count;
}
static DEVICE_ATTR(dhchap_secret, S_IRUGO | S_IWUSR,
	nvme_ctrl_dhchap_secret_show, nvme_ctrl_dhchap_secret_store);

static ssize_t nvme_ctrl_dhchap_ctrl_secret_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 (!opts->dhchap_ctrl_secret)
		return sysfs_emit(buf, "none\n");
	return sysfs_emit(buf, "%s\n", opts->dhchap_ctrl_secret);
}

static ssize_t nvme_ctrl_dhchap_ctrl_secret_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;
	char *dhchap_secret;

	if (!ctrl->opts->dhchap_ctrl_secret)
		return -EINVAL;
	if (count < 7)
		return -EINVAL;
	if (memcmp(buf, "DHHC-1:", 7))
		return -EINVAL;

	dhchap_secret = kzalloc(count + 1, GFP_KERNEL);
	if (!dhchap_secret)
		return -ENOMEM;
	memcpy(dhchap_secret, buf, count);
	nvme_auth_stop(ctrl);
	if (strcmp(dhchap_secret, opts->dhchap_ctrl_secret)) {
		int ret;

		ret = nvme_auth_generate_key(dhchap_secret, &ctrl->ctrl_key);
		if (ret)
			return ret;
		kfree(opts->dhchap_ctrl_secret);
		opts->dhchap_ctrl_secret = dhchap_secret;
		/* Key has changed; re-authentication with new key */
		nvme_auth_reset(ctrl);
	}
	/* Start re-authentication */
	dev_info(ctrl->device, "re-authenticating controller\n");
	queue_work(nvme_wq, &ctrl->dhchap_auth_work);

	return count;
}
static DEVICE_ATTR(dhchap_ctrl_secret, S_IRUGO | S_IWUSR,
	nvme_ctrl_dhchap_ctrl_secret_show, nvme_ctrl_dhchap_ctrl_secret_store);
#endif

3819 3820
static struct attribute *nvme_dev_attrs[] = {
	&dev_attr_reset_controller.attr,
K
Keith Busch 已提交
3821
	&dev_attr_rescan_controller.attr,
3822 3823 3824
	&dev_attr_model.attr,
	&dev_attr_serial.attr,
	&dev_attr_firmware_rev.attr,
M
Ming Lin 已提交
3825
	&dev_attr_cntlid.attr,
M
Ming Lin 已提交
3826 3827 3828 3829
	&dev_attr_delete_controller.attr,
	&dev_attr_transport.attr,
	&dev_attr_subsysnqn.attr,
	&dev_attr_address.attr,
3830
	&dev_attr_state.attr,
3831
	&dev_attr_numa_node.attr,
3832 3833
	&dev_attr_queue_count.attr,
	&dev_attr_sqsize.attr,
3834
	&dev_attr_hostnqn.attr,
3835
	&dev_attr_hostid.attr,
3836 3837
	&dev_attr_ctrl_loss_tmo.attr,
	&dev_attr_reconnect_delay.attr,
3838
	&dev_attr_fast_io_fail_tmo.attr,
3839
	&dev_attr_kato.attr,
3840 3841
	&dev_attr_cntrltype.attr,
	&dev_attr_dctype.attr,
3842 3843 3844 3845
#ifdef CONFIG_NVME_AUTH
	&dev_attr_dhchap_secret.attr,
	&dev_attr_dhchap_ctrl_secret.attr,
#endif
3846 3847 3848
	NULL
};

M
Ming Lin 已提交
3849 3850 3851 3852 3853 3854
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);

3855 3856 3857 3858
	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;
3859 3860
	if (a == &dev_attr_hostnqn.attr && !ctrl->opts)
		return 0;
3861 3862
	if (a == &dev_attr_hostid.attr && !ctrl->opts)
		return 0;
3863 3864 3865 3866
	if (a == &dev_attr_ctrl_loss_tmo.attr && !ctrl->opts)
		return 0;
	if (a == &dev_attr_reconnect_delay.attr && !ctrl->opts)
		return 0;
3867 3868
	if (a == &dev_attr_fast_io_fail_tmo.attr && !ctrl->opts)
		return 0;
3869 3870 3871 3872 3873 3874
#ifdef CONFIG_NVME_AUTH
	if (a == &dev_attr_dhchap_secret.attr && !ctrl->opts)
		return 0;
	if (a == &dev_attr_dhchap_ctrl_secret.attr && !ctrl->opts)
		return 0;
#endif
M
Ming Lin 已提交
3875 3876 3877 3878

	return a->mode;
}

3879
static const struct attribute_group nvme_dev_attrs_group = {
M
Ming Lin 已提交
3880 3881
	.attrs		= nvme_dev_attrs,
	.is_visible	= nvme_dev_attrs_are_visible,
3882 3883 3884 3885 3886 3887 3888
};

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

3889
static struct nvme_ns_head *nvme_find_ns_head(struct nvme_ctrl *ctrl,
C
Christoph Hellwig 已提交
3890 3891 3892 3893
		unsigned nsid)
{
	struct nvme_ns_head *h;

3894
	lockdep_assert_held(&ctrl->subsys->lock);
C
Christoph Hellwig 已提交
3895

3896 3897 3898 3899 3900 3901 3902
	list_for_each_entry(h, &ctrl->subsys->nsheads, entry) {
		/*
		 * Private namespaces can share NSIDs under some conditions.
		 * In that case we can't use the same ns_head for namespaces
		 * with the same NSID.
		 */
		if (h->ns_id != nsid || !nvme_is_unique_nsid(ctrl, h))
3903 3904
			continue;
		if (!list_empty(&h->list) && nvme_tryget_ns_head(h))
C
Christoph Hellwig 已提交
3905 3906 3907 3908 3909 3910
			return h;
	}

	return NULL;
}

3911 3912
static int nvme_subsys_check_duplicate_ids(struct nvme_subsystem *subsys,
		struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
3913
{
3914 3915 3916
	bool has_uuid = !uuid_is_null(&ids->uuid);
	bool has_nguid = memchr_inv(ids->nguid, 0, sizeof(ids->nguid));
	bool has_eui64 = memchr_inv(ids->eui64, 0, sizeof(ids->eui64));
C
Christoph Hellwig 已提交
3917 3918 3919 3920 3921
	struct nvme_ns_head *h;

	lockdep_assert_held(&subsys->lock);

	list_for_each_entry(h, &subsys->nsheads, entry) {
3922 3923 3924 3925 3926 3927 3928
		if (has_uuid && uuid_equal(&ids->uuid, &h->ids.uuid))
			return -EINVAL;
		if (has_nguid &&
		    memcmp(&ids->nguid, &h->ids.nguid, sizeof(ids->nguid)) == 0)
			return -EINVAL;
		if (has_eui64 &&
		    memcmp(&ids->eui64, &h->ids.eui64, sizeof(ids->eui64)) == 0)
C
Christoph Hellwig 已提交
3929 3930 3931 3932 3933 3934
			return -EINVAL;
	}

	return 0;
}

3935 3936
static void nvme_cdev_rel(struct device *dev)
{
3937
	ida_free(&nvme_ns_chr_minor_ida, MINOR(dev->devt));
3938 3939
}

3940 3941 3942
void nvme_cdev_del(struct cdev *cdev, struct device *cdev_device)
{
	cdev_device_del(cdev, cdev_device);
3943
	put_device(cdev_device);
3944 3945 3946 3947 3948 3949 3950
}

int nvme_cdev_add(struct cdev *cdev, struct device *cdev_device,
		const struct file_operations *fops, struct module *owner)
{
	int minor, ret;

3951
	minor = ida_alloc(&nvme_ns_chr_minor_ida, GFP_KERNEL);
3952 3953 3954 3955
	if (minor < 0)
		return minor;
	cdev_device->devt = MKDEV(MAJOR(nvme_ns_chr_devt), minor);
	cdev_device->class = nvme_ns_chr_class;
3956
	cdev_device->release = nvme_cdev_rel;
3957 3958 3959 3960
	device_initialize(cdev_device);
	cdev_init(cdev, fops);
	cdev->owner = owner;
	ret = cdev_device_add(cdev, cdev_device);
3961
	if (ret)
3962
		put_device(cdev_device);
3963

3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983
	return ret;
}

static int nvme_ns_chr_open(struct inode *inode, struct file *file)
{
	return nvme_ns_open(container_of(inode->i_cdev, struct nvme_ns, cdev));
}

static int nvme_ns_chr_release(struct inode *inode, struct file *file)
{
	nvme_ns_release(container_of(inode->i_cdev, struct nvme_ns, cdev));
	return 0;
}

static const struct file_operations nvme_ns_chr_fops = {
	.owner		= THIS_MODULE,
	.open		= nvme_ns_chr_open,
	.release	= nvme_ns_chr_release,
	.unlocked_ioctl	= nvme_ns_chr_ioctl,
	.compat_ioctl	= compat_ptr_ioctl,
3984
	.uring_cmd	= nvme_ns_chr_uring_cmd,
3985
	.uring_cmd_iopoll = nvme_ns_chr_uring_cmd_iopoll,
3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996
};

static int nvme_add_ns_cdev(struct nvme_ns *ns)
{
	int ret;

	ns->cdev_device.parent = ns->ctrl->device;
	ret = dev_set_name(&ns->cdev_device, "ng%dn%d",
			   ns->ctrl->instance, ns->head->instance);
	if (ret)
		return ret;
3997 3998 3999

	return nvme_cdev_add(&ns->cdev, &ns->cdev_device, &nvme_ns_chr_fops,
			     ns->ctrl->ops->module);
4000 4001
}

C
Christoph Hellwig 已提交
4002
static struct nvme_ns_head *nvme_alloc_ns_head(struct nvme_ctrl *ctrl,
4003
		struct nvme_ns_info *info)
C
Christoph Hellwig 已提交
4004 4005
{
	struct nvme_ns_head *head;
4006
	size_t size = sizeof(*head);
C
Christoph Hellwig 已提交
4007 4008
	int ret = -ENOMEM;

4009 4010 4011 4012 4013
#ifdef CONFIG_NVME_MULTIPATH
	size += num_possible_nodes() * sizeof(struct nvme_ns *);
#endif

	head = kzalloc(size, GFP_KERNEL);
C
Christoph Hellwig 已提交
4014 4015
	if (!head)
		goto out;
4016
	ret = ida_alloc_min(&ctrl->subsys->ns_ida, 1, GFP_KERNEL);
C
Christoph Hellwig 已提交
4017 4018 4019 4020
	if (ret < 0)
		goto out_free_head;
	head->instance = ret;
	INIT_LIST_HEAD(&head->list);
4021 4022 4023
	ret = init_srcu_struct(&head->srcu);
	if (ret)
		goto out_ida_remove;
C
Christoph Hellwig 已提交
4024
	head->subsys = ctrl->subsys;
4025 4026 4027
	head->ns_id = info->nsid;
	head->ids = info->ids;
	head->shared = info->is_shared;
C
Christoph Hellwig 已提交
4028 4029
	kref_init(&head->ref);

4030 4031 4032 4033 4034 4035 4036
	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;

4037 4038 4039 4040
	ret = nvme_mpath_alloc_disk(ctrl, head);
	if (ret)
		goto out_cleanup_srcu;

C
Christoph Hellwig 已提交
4041
	list_add_tail(&head->entry, &ctrl->subsys->nsheads);
4042 4043 4044

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

C
Christoph Hellwig 已提交
4045 4046 4047
	return head;
out_cleanup_srcu:
	cleanup_srcu_struct(&head->srcu);
4048
out_ida_remove:
4049
	ida_free(&ctrl->subsys->ns_ida, head->instance);
C
Christoph Hellwig 已提交
4050 4051 4052
out_free_head:
	kfree(head);
out:
4053 4054
	if (ret > 0)
		ret = blk_status_to_errno(nvme_error_status(ret));
C
Christoph Hellwig 已提交
4055 4056 4057
	return ERR_PTR(ret);
}

4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083
static int nvme_global_check_duplicate_ids(struct nvme_subsystem *this,
		struct nvme_ns_ids *ids)
{
	struct nvme_subsystem *s;
	int ret = 0;

	/*
	 * Note that this check is racy as we try to avoid holding the global
	 * lock over the whole ns_head creation.  But it is only intended as
	 * a sanity check anyway.
	 */
	mutex_lock(&nvme_subsystems_lock);
	list_for_each_entry(s, &nvme_subsystems, entry) {
		if (s == this)
			continue;
		mutex_lock(&s->lock);
		ret = nvme_subsys_check_duplicate_ids(s, ids);
		mutex_unlock(&s->lock);
		if (ret)
			break;
	}
	mutex_unlock(&nvme_subsystems_lock);

	return ret;
}

4084
static int nvme_init_ns_head(struct nvme_ns *ns, struct nvme_ns_info *info)
C
Christoph Hellwig 已提交
4085 4086 4087
{
	struct nvme_ctrl *ctrl = ns->ctrl;
	struct nvme_ns_head *head = NULL;
4088 4089
	int ret;

4090
	ret = nvme_global_check_duplicate_ids(ctrl->subsys, &info->ids);
4091 4092
	if (ret) {
		dev_err(ctrl->device,
4093
			"globally duplicate IDs for nsid %d\n", info->nsid);
4094
		nvme_print_device_info(ctrl);
4095 4096
		return ret;
	}
C
Christoph Hellwig 已提交
4097 4098

	mutex_lock(&ctrl->subsys->lock);
4099
	head = nvme_find_ns_head(ctrl, info->nsid);
C
Christoph Hellwig 已提交
4100
	if (!head) {
4101
		ret = nvme_subsys_check_duplicate_ids(ctrl->subsys, &info->ids);
4102 4103
		if (ret) {
			dev_err(ctrl->device,
4104
				"duplicate IDs in subsystem for nsid %d\n",
4105
				info->nsid);
4106 4107
			goto out_unlock;
		}
4108
		head = nvme_alloc_ns_head(ctrl, info);
C
Christoph Hellwig 已提交
4109 4110 4111 4112 4113
		if (IS_ERR(head)) {
			ret = PTR_ERR(head);
			goto out_unlock;
		}
	} else {
4114
		ret = -EINVAL;
4115
		if (!info->is_shared || !head->shared) {
4116
			dev_err(ctrl->device,
4117 4118
				"Duplicate unshared namespace %d\n",
				info->nsid);
4119
			goto out_put_ns_head;
4120
		}
4121
		if (!nvme_ns_ids_equal(&head->ids, &info->ids)) {
C
Christoph Hellwig 已提交
4122 4123
			dev_err(ctrl->device,
				"IDs don't match for shared namespace %d\n",
4124
					info->nsid);
4125
			goto out_put_ns_head;
C
Christoph Hellwig 已提交
4126
		}
4127 4128 4129 4130

		if (!multipath && !list_empty(&head->list)) {
			dev_warn(ctrl->device,
				"Found shared namespace %d, but multipathing not supported.\n",
4131
				info->nsid);
4132 4133 4134
			dev_warn_once(ctrl->device,
				"Support for shared namespaces without CONFIG_NVME_MULTIPATH is deprecated and will be removed in Linux 6.0\n.");
		}
C
Christoph Hellwig 已提交
4135 4136
	}

4137
	list_add_tail_rcu(&ns->siblings, &head->list);
C
Christoph Hellwig 已提交
4138
	ns->head = head;
4139 4140
	mutex_unlock(&ctrl->subsys->lock);
	return 0;
C
Christoph Hellwig 已提交
4141

4142 4143
out_put_ns_head:
	nvme_put_ns_head(head);
C
Christoph Hellwig 已提交
4144 4145 4146 4147 4148
out_unlock:
	mutex_unlock(&ctrl->subsys->lock);
	return ret;
}

4149
struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid)
4150
{
4151
	struct nvme_ns *ns, *ret = NULL;
4152

4153
	down_read(&ctrl->namespaces_rwsem);
4154
	list_for_each_entry(ns, &ctrl->namespaces, list) {
C
Christoph Hellwig 已提交
4155
		if (ns->head->ns_id == nsid) {
K
Kanchan Joshi 已提交
4156
			if (!nvme_get_ns(ns))
4157
				continue;
4158 4159 4160
			ret = ns;
			break;
		}
C
Christoph Hellwig 已提交
4161
		if (ns->head->ns_id > nsid)
4162 4163
			break;
	}
4164
	up_read(&ctrl->namespaces_rwsem);
4165
	return ret;
4166
}
4167
EXPORT_SYMBOL_NS_GPL(nvme_find_get_ns, NVME_TARGET_PASSTHRU);
4168

4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184
/*
 * Add the namespace to the controller list while keeping the list ordered.
 */
static void nvme_ns_add_to_ctrl_list(struct nvme_ns *ns)
{
	struct nvme_ns *tmp;

	list_for_each_entry_reverse(tmp, &ns->ctrl->namespaces, list) {
		if (tmp->head->ns_id < ns->head->ns_id) {
			list_add(&ns->list, &tmp->list);
			return;
		}
	}
	list_add(&ns->list, &ns->ctrl->namespaces);
}

4185
static void nvme_alloc_ns(struct nvme_ctrl *ctrl, struct nvme_ns_info *info)
4186 4187 4188
{
	struct nvme_ns *ns;
	struct gendisk *disk;
4189
	int node = ctrl->numa_node;
4190 4191 4192

	ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
	if (!ns)
4193
		return;
4194

C
Christoph Hellwig 已提交
4195 4196
	disk = blk_mq_alloc_disk(ctrl->tagset, ns);
	if (IS_ERR(disk))
C
Christoph Hellwig 已提交
4197
		goto out_free_ns;
C
Christoph Hellwig 已提交
4198 4199 4200 4201 4202
	disk->fops = &nvme_bdev_ops;
	disk->private_data = ns;

	ns->disk = disk;
	ns->queue = disk->queue;
4203

4204
	if (ctrl->opts && ctrl->opts->data_digest)
4205
		blk_queue_flag_set(QUEUE_FLAG_STABLE_WRITES, ns->queue);
4206

4207
	blk_queue_flag_set(QUEUE_FLAG_NONROT, ns->queue);
4208 4209
	if (ctrl->ops->supports_pci_p2pdma &&
	    ctrl->ops->supports_pci_p2pdma(ctrl))
4210 4211
		blk_queue_flag_set(QUEUE_FLAG_PCI_P2PDMA, ns->queue);

4212 4213 4214
	ns->ctrl = ctrl;
	kref_init(&ns->kref);

4215
	if (nvme_init_ns_head(ns, info))
C
Christoph Hellwig 已提交
4216
		goto out_cleanup_disk;
4217

4218
	/*
4219 4220 4221 4222 4223 4224 4225 4226 4227
	 * If multipathing is enabled, the device name for all disks and not
	 * just those that represent shared namespaces needs to be based on the
	 * subsystem instance.  Using the controller instance for private
	 * namespaces could lead to naming collisions between shared and private
	 * namespaces if they don't use a common numbering scheme.
	 *
	 * If multipathing is not enabled, disk names must use the controller
	 * instance as shared namespaces will show up as multiple block
	 * devices.
4228
	 */
4229 4230 4231 4232 4233 4234 4235 4236
	if (ns->head->disk) {
		sprintf(disk->disk_name, "nvme%dc%dn%d", ctrl->subsys->instance,
			ctrl->instance, ns->head->instance);
		disk->flags |= GENHD_FL_HIDDEN;
	} else if (multipath) {
		sprintf(disk->disk_name, "nvme%dn%d", ctrl->subsys->instance,
			ns->head->instance);
	} else {
4237 4238
		sprintf(disk->disk_name, "nvme%dn%d", ctrl->instance,
			ns->head->instance);
4239
	}
4240

4241
	if (nvme_update_ns_info(ns, info))
C
Christoph Hellwig 已提交
4242
		goto out_unlink_ns;
4243

4244
	down_write(&ctrl->namespaces_rwsem);
4245
	nvme_ns_add_to_ctrl_list(ns);
4246
	up_write(&ctrl->namespaces_rwsem);
4247
	nvme_get_ctrl(ctrl);
4248

4249 4250 4251
	if (device_add_disk(ctrl->device, ns->disk, nvme_ns_id_attr_groups))
		goto out_cleanup_ns_from_list;

4252 4253
	if (!nvme_ns_head_multipath(ns->head))
		nvme_add_ns_cdev(ns);
4254

4255
	nvme_mpath_add_disk(ns, info->anagrpid);
4256
	nvme_fault_inject_init(&ns->fault_inject, ns->disk->disk_name);
C
Christoph Hellwig 已提交
4257

4258
	return;
C
Christoph Hellwig 已提交
4259

4260 4261 4262 4263 4264
 out_cleanup_ns_from_list:
	nvme_put_ctrl(ctrl);
	down_write(&ctrl->namespaces_rwsem);
	list_del_init(&ns->list);
	up_write(&ctrl->namespaces_rwsem);
C
Christoph Hellwig 已提交
4265 4266 4267
 out_unlink_ns:
	mutex_lock(&ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
4268 4269
	if (list_empty(&ns->head->list))
		list_del_init(&ns->head->entry);
C
Christoph Hellwig 已提交
4270
	mutex_unlock(&ctrl->subsys->lock);
4271
	nvme_put_ns_head(ns->head);
C
Christoph Hellwig 已提交
4272
 out_cleanup_disk:
4273
	put_disk(disk);
4274 4275 4276 4277 4278 4279
 out_free_ns:
	kfree(ns);
}

static void nvme_ns_remove(struct nvme_ns *ns)
{
4280 4281
	bool last_path = false;

4282 4283
	if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
		return;
4284

4285
	clear_bit(NVME_NS_READY, &ns->flags);
4286
	set_capacity(ns->disk, 0);
4287
	nvme_fault_inject_fini(&ns->fault_inject);
4288

4289 4290 4291 4292 4293 4294 4295 4296 4297 4298
	/*
	 * Ensure that !NVME_NS_READY is seen by other threads to prevent
	 * this ns going back into current_path.
	 */
	synchronize_srcu(&ns->head->srcu);

	/* wait for concurrent submissions */
	if (nvme_mpath_clear_current_path(ns))
		synchronize_srcu(&ns->head->srcu);

4299 4300
	mutex_lock(&ns->ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
4301 4302 4303 4304
	if (list_empty(&ns->head->list)) {
		list_del_init(&ns->head->entry);
		last_path = true;
	}
4305
	mutex_unlock(&ns->ctrl->subsys->lock);
4306

4307 4308 4309
	/* guarantee not available in head->list */
	synchronize_rcu();

4310 4311 4312
	if (!nvme_ns_head_multipath(ns->head))
		nvme_cdev_del(&ns->cdev, &ns->cdev_device);
	del_gendisk(ns->disk);
4313

4314
	down_write(&ns->ctrl->namespaces_rwsem);
4315
	list_del_init(&ns->list);
4316
	up_write(&ns->ctrl->namespaces_rwsem);
4317

4318 4319
	if (last_path)
		nvme_mpath_shutdown_disk(ns->head);
4320 4321 4322
	nvme_put_ns(ns);
}

4323 4324 4325 4326 4327 4328 4329 4330 4331 4332
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);
	}
}

4333
static void nvme_validate_ns(struct nvme_ns *ns, struct nvme_ns_info *info)
C
Christoph Hellwig 已提交
4334
{
4335
	int ret = NVME_SC_INVALID_NS | NVME_SC_DNR;
C
Christoph Hellwig 已提交
4336

4337 4338
	if (test_bit(NVME_NS_DEAD, &ns->flags))
		goto out;
C
Christoph Hellwig 已提交
4339

4340
	ret = NVME_SC_INVALID_NS | NVME_SC_DNR;
4341
	if (!nvme_ns_ids_equal(&ns->head->ids, &info->ids)) {
4342
		dev_err(ns->ctrl->device,
C
Christoph Hellwig 已提交
4343
			"identifiers changed for nsid %d\n", ns->head->ns_id);
4344
		goto out;
C
Christoph Hellwig 已提交
4345 4346
	}

4347
	ret = nvme_update_ns_info(ns, info);
C
Christoph Hellwig 已提交
4348 4349
out:
	/*
4350
	 * Only remove the namespace if we got a fatal error back from the
C
Christoph Hellwig 已提交
4351
	 * device, otherwise ignore the error and just move on.
4352 4353
	 *
	 * TODO: we should probably schedule a delayed retry here.
C
Christoph Hellwig 已提交
4354
	 */
4355
	if (ret > 0 && (ret & NVME_SC_DNR))
4356
		nvme_ns_remove(ns);
C
Christoph Hellwig 已提交
4357 4358
}

4359
static void nvme_scan_ns(struct nvme_ctrl *ctrl, unsigned nsid)
4360
{
4361
	struct nvme_ns_info info = { .nsid = nsid };
4362 4363
	struct nvme_ns *ns;

4364
	if (nvme_identify_ns_descs(ctrl, &info))
4365
		return;
4366

4367
	if (info.ids.csi != NVME_CSI_NVM && !nvme_multi_css(ctrl)) {
4368 4369 4370 4371 4372
		dev_warn(ctrl->device,
			"command set not reported for nsid: %d\n", nsid);
		return;
	}

4373
	/*
4374 4375 4376
	 * If available try to use the Command Set Idependent Identify Namespace
	 * data structure to find all the generic information that is needed to
	 * set up a namespace.  If not fall back to the legacy version.
4377
	 */
4378 4379
	if ((ctrl->cap & NVME_CAP_CRMS_CRIMS) ||
	    (info.ids.csi != NVME_CSI_NVM && info.ids.csi != NVME_CSI_ZNS)) {
4380 4381 4382 4383 4384
		if (nvme_ns_info_from_id_cs_indep(ctrl, &info))
			return;
	} else {
		if (nvme_ns_info_from_identify(ctrl, &info))
			return;
4385 4386
	}

4387 4388 4389 4390 4391
	/*
	 * Ignore the namespace if it is not ready. We will get an AEN once it
	 * becomes ready and restart the scan.
	 */
	if (!info.is_ready)
4392 4393
		return;

4394
	ns = nvme_find_get_ns(ctrl, nsid);
4395
	if (ns) {
4396
		nvme_validate_ns(ns, &info);
4397
		nvme_put_ns(ns);
4398 4399
	} else {
		nvme_alloc_ns(ctrl, &info);
4400
	}
4401 4402
}

4403 4404 4405 4406
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					unsigned nsid)
{
	struct nvme_ns *ns, *next;
4407
	LIST_HEAD(rm_list);
4408

4409
	down_write(&ctrl->namespaces_rwsem);
4410
	list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) {
4411
		if (ns->head->ns_id > nsid || test_bit(NVME_NS_DEAD, &ns->flags))
4412
			list_move_tail(&ns->list, &rm_list);
4413
	}
4414
	up_write(&ctrl->namespaces_rwsem);
4415 4416 4417 4418

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

4419 4420
}

4421
static int nvme_scan_ns_list(struct nvme_ctrl *ctrl)
4422
{
4423
	const int nr_entries = NVME_IDENTIFY_DATA_SIZE / sizeof(__le32);
4424
	__le32 *ns_list;
4425 4426
	u32 prev = 0;
	int ret = 0, i;
4427

4428 4429
	if (nvme_ctrl_limited_cns(ctrl))
		return -EOPNOTSUPP;
4430

4431
	ns_list = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
4432 4433 4434
	if (!ns_list)
		return -ENOMEM;

4435
	for (;;) {
4436 4437 4438 4439 4440 4441 4442 4443
		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);
4444 4445 4446
		if (ret) {
			dev_warn(ctrl->device,
				"Identify NS List failed (status=0x%x)\n", ret);
4447
			goto free;
4448
		}
4449

4450
		for (i = 0; i < nr_entries; i++) {
4451
			u32 nsid = le32_to_cpu(ns_list[i]);
4452

4453 4454
			if (!nsid)	/* end of the list? */
				goto out;
4455
			nvme_scan_ns(ctrl, nsid);
4456 4457
			while (++prev < nsid)
				nvme_ns_remove_by_nsid(ctrl, prev);
4458 4459 4460
		}
	}
 out:
4461 4462
	nvme_remove_invalid_namespaces(ctrl, prev);
 free:
4463 4464 4465 4466
	kfree(ns_list);
	return ret;
}

4467
static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl)
4468
{
4469 4470 4471 4472 4473 4474 4475
	struct nvme_id_ctrl *id;
	u32 nn, i;

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

4477
	for (i = 1; i <= nn; i++)
4478
		nvme_scan_ns(ctrl, i);
4479

4480
	nvme_remove_invalid_namespaces(ctrl, nn);
4481 4482
}

4483
static void nvme_clear_changed_ns_log(struct nvme_ctrl *ctrl)
4484 4485 4486
{
	size_t log_size = NVME_MAX_CHANGED_NAMESPACES * sizeof(__le32);
	__le32 *log;
4487
	int error;
4488 4489 4490

	log = kzalloc(log_size, GFP_KERNEL);
	if (!log)
4491
		return;
4492

4493 4494 4495 4496 4497 4498
	/*
	 * 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.
	 */
4499 4500
	error = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CHANGED_NS, 0,
			NVME_CSI_NVM, log, log_size, 0);
4501
	if (error)
4502 4503 4504 4505 4506 4507
		dev_warn(ctrl->device,
			"reading changed ns log failed: %d\n", error);

	kfree(log);
}

4508
static void nvme_scan_work(struct work_struct *work)
4509
{
4510 4511
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, scan_work);
4512
	int ret;
4513

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

4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531
	/*
	 * Identify controller limits can change at controller reset due to
	 * new firmware download, even though it is not common we cannot ignore
	 * such scenario. Controller's non-mdts limits are reported in the unit
	 * of logical blocks that is dependent on the format of attached
	 * namespace. Hence re-read the limits at the time of ns allocation.
	 */
	ret = nvme_init_non_mdts_limits(ctrl);
	if (ret < 0) {
		dev_warn(ctrl->device,
			"reading non-mdts-limits failed: %d\n", ret);
		return;
	}

D
Dan Carpenter 已提交
4532
	if (test_and_clear_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events)) {
4533
		dev_info(ctrl->device, "rescanning namespaces.\n");
4534
		nvme_clear_changed_ns_log(ctrl);
4535 4536
	}

4537
	mutex_lock(&ctrl->scan_lock);
4538 4539
	if (nvme_scan_ns_list(ctrl) != 0)
		nvme_scan_ns_sequential(ctrl);
4540
	mutex_unlock(&ctrl->scan_lock);
4541
}
4542

4543 4544 4545 4546 4547
/*
 * 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.
 */
4548 4549 4550
void nvme_remove_namespaces(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns, *next;
4551
	LIST_HEAD(ns_list);
4552

4553 4554 4555 4556 4557 4558 4559
	/*
	 * 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);

4560 4561 4562
	/* prevent racing with ns scanning */
	flush_work(&ctrl->scan_work);

4563 4564 4565 4566 4567 4568 4569 4570 4571
	/*
	 * 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);

4572 4573 4574
	/* this is a no-op when called from the controller reset handler */
	nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING_NOIO);

4575
	down_write(&ctrl->namespaces_rwsem);
4576
	list_splice_init(&ctrl->namespaces, &ns_list);
4577
	up_write(&ctrl->namespaces_rwsem);
4578 4579

	list_for_each_entry_safe(ns, next, &ns_list, list)
4580 4581
		nvme_ns_remove(ns);
}
4582
EXPORT_SYMBOL_GPL(nvme_remove_namespaces);
4583

4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606
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");
4607 4608 4609 4610 4611
		if (ret)
			return ret;

		ret = add_uevent_var(env, "NVME_HOST_IFACE=%s",
				opts->host_iface ?: "none");
4612 4613 4614 4615
	}
	return ret;
}

4616 4617 4618 4619 4620 4621 4622
static void nvme_change_uevent(struct nvme_ctrl *ctrl, char *envdata)
{
	char *envp[2] = { envdata, NULL };

	kobject_uevent_env(&ctrl->device->kobj, KOBJ_CHANGE, envp);
}

4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638
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]);
}

4639 4640 4641 4642 4643
static void nvme_async_event_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, async_event_work);

4644
	nvme_aen_uevent(ctrl);
4645 4646 4647 4648 4649 4650 4651 4652

	/*
	 * The transport drivers must guarantee AER submission here is safe by
	 * flushing ctrl async_event_work after changing the controller state
	 * from LIVE and before freeing the admin queue.
	*/
	if (ctrl->state == NVME_CTRL_LIVE)
		ctrl->ops->submit_async_event(ctrl);
4653 4654
}

4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676
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;

4677 4678
	if (nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_FW_SLOT, 0, NVME_CSI_NVM,
			log, sizeof(*log), 0))
4679
		dev_warn(ctrl->device, "Get FW SLOT INFO log error\n");
4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700
	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");
4701 4702
			nvme_try_sched_reset(ctrl);
			return;
4703 4704 4705 4706
		}
		msleep(100);
	}

4707
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE))
4708 4709 4710
		return;

	nvme_start_queues(ctrl);
4711
	/* read FW slot information to clear the AER */
4712
	nvme_get_fw_slot_info(ctrl);
4713 4714

	queue_work(nvme_wq, &ctrl->async_event_work);
4715 4716
}

4717 4718 4719 4720 4721 4722 4723 4724 4725 4726
static u32 nvme_aer_type(u32 result)
{
	return result & 0x7;
}

static u32 nvme_aer_subtype(u32 result)
{
	return (result & 0xff00) >> 8;
}

4727
static bool nvme_handle_aen_notice(struct nvme_ctrl *ctrl, u32 result)
4728
{
4729
	u32 aer_notice_type = nvme_aer_subtype(result);
4730
	bool requeue = true;
4731

4732 4733
	trace_nvme_async_event(ctrl, aer_notice_type);

4734
	switch (aer_notice_type) {
4735
	case NVME_AER_NOTICE_NS_CHANGED:
D
Dan Carpenter 已提交
4736
		set_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events);
4737 4738 4739
		nvme_queue_scan(ctrl);
		break;
	case NVME_AER_NOTICE_FW_ACT_STARTING:
4740 4741 4742 4743 4744
		/*
		 * We are (ab)using the RESETTING state to prevent subsequent
		 * recovery actions from interfering with the controller's
		 * firmware activation.
		 */
4745 4746
		if (nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING)) {
			nvme_auth_stop(ctrl);
4747
			requeue = false;
4748
			queue_work(nvme_wq, &ctrl->fw_act_work);
4749
		}
4750
		break;
C
Christoph Hellwig 已提交
4751 4752 4753 4754 4755 4756 4757
#ifdef CONFIG_NVME_MULTIPATH
	case NVME_AER_NOTICE_ANA:
		if (!ctrl->ana_log_buf)
			break;
		queue_work(nvme_wq, &ctrl->ana_work);
		break;
#endif
4758 4759 4760
	case NVME_AER_NOTICE_DISC_CHANGED:
		ctrl->aen_result = result;
		break;
4761 4762 4763
	default:
		dev_warn(ctrl->device, "async event result %08x\n", result);
	}
4764
	return requeue;
4765 4766
}

4767 4768 4769 4770 4771 4772 4773
static void nvme_handle_aer_persistent_error(struct nvme_ctrl *ctrl)
{
	trace_nvme_async_event(ctrl, NVME_AER_ERROR);
	dev_warn(ctrl->device, "resetting controller due to AER\n");
	nvme_reset_ctrl(ctrl);
}

4774
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
4775
		volatile union nvme_result *res)
4776
{
4777
	u32 result = le32_to_cpu(res->u32);
4778 4779
	u32 aer_type = nvme_aer_type(result);
	u32 aer_subtype = nvme_aer_subtype(result);
4780
	bool requeue = true;
4781

4782
	if (le16_to_cpu(status) >> 1 != NVME_SC_SUCCESS)
4783 4784
		return;

4785
	switch (aer_type) {
4786
	case NVME_AER_NOTICE:
4787
		requeue = nvme_handle_aen_notice(ctrl, result);
4788
		break;
4789
	case NVME_AER_ERROR:
4790 4791 4792 4793 4794 4795 4796 4797 4798
		/*
		 * For a persistent internal error, don't run async_event_work
		 * to submit a new AER. The controller reset will do it.
		 */
		if (aer_subtype == NVME_AER_ERROR_PERSIST_INT_ERR) {
			nvme_handle_aer_persistent_error(ctrl);
			return;
		}
		fallthrough;
4799 4800 4801
	case NVME_AER_SMART:
	case NVME_AER_CSS:
	case NVME_AER_VS:
4802
		trace_nvme_async_event(ctrl, aer_type);
4803
		ctrl->aen_result = result;
4804 4805 4806
		break;
	default:
		break;
4807
	}
4808 4809 4810

	if (requeue)
		queue_work(nvme_wq, &ctrl->async_event_work);
4811 4812
}
EXPORT_SYMBOL_GPL(nvme_complete_async_event);
4813

4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852
int nvme_alloc_admin_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set,
		const struct blk_mq_ops *ops, unsigned int flags,
		unsigned int cmd_size)
{
	int ret;

	memset(set, 0, sizeof(*set));
	set->ops = ops;
	set->queue_depth = NVME_AQ_MQ_TAG_DEPTH;
	if (ctrl->ops->flags & NVME_F_FABRICS)
		set->reserved_tags = NVMF_RESERVED_TAGS;
	set->numa_node = ctrl->numa_node;
	set->flags = flags;
	set->cmd_size = cmd_size;
	set->driver_data = ctrl;
	set->nr_hw_queues = 1;
	set->timeout = NVME_ADMIN_TIMEOUT;
	ret = blk_mq_alloc_tag_set(set);
	if (ret)
		return ret;

	ctrl->admin_q = blk_mq_init_queue(set);
	if (IS_ERR(ctrl->admin_q)) {
		ret = PTR_ERR(ctrl->admin_q);
		goto out_free_tagset;
	}

	if (ctrl->ops->flags & NVME_F_FABRICS) {
		ctrl->fabrics_q = blk_mq_init_queue(set);
		if (IS_ERR(ctrl->fabrics_q)) {
			ret = PTR_ERR(ctrl->fabrics_q);
			goto out_cleanup_admin_q;
		}
	}

	ctrl->admin_tagset = set;
	return 0;

out_cleanup_admin_q:
4853
	blk_mq_destroy_queue(ctrl->admin_q);
4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915
out_free_tagset:
	blk_mq_free_tag_set(ctrl->admin_tagset);
	return ret;
}
EXPORT_SYMBOL_GPL(nvme_alloc_admin_tag_set);

void nvme_remove_admin_tag_set(struct nvme_ctrl *ctrl)
{
	blk_mq_destroy_queue(ctrl->admin_q);
	if (ctrl->ops->flags & NVME_F_FABRICS)
		blk_mq_destroy_queue(ctrl->fabrics_q);
	blk_mq_free_tag_set(ctrl->admin_tagset);
}
EXPORT_SYMBOL_GPL(nvme_remove_admin_tag_set);

int nvme_alloc_io_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set,
		const struct blk_mq_ops *ops, unsigned int flags,
		unsigned int cmd_size)
{
	int ret;

	memset(set, 0, sizeof(*set));
	set->ops = ops;
	set->queue_depth = ctrl->sqsize + 1;
	set->reserved_tags = NVMF_RESERVED_TAGS;
	set->numa_node = ctrl->numa_node;
	set->flags = flags;
	set->cmd_size = cmd_size,
	set->driver_data = ctrl;
	set->nr_hw_queues = ctrl->queue_count - 1;
	set->timeout = NVME_IO_TIMEOUT;
	if (ops->map_queues)
		set->nr_maps = ctrl->opts->nr_poll_queues ? HCTX_MAX_TYPES : 2;
	ret = blk_mq_alloc_tag_set(set);
	if (ret)
		return ret;

	if (ctrl->ops->flags & NVME_F_FABRICS) {
		ctrl->connect_q = blk_mq_init_queue(set);
        	if (IS_ERR(ctrl->connect_q)) {
			ret = PTR_ERR(ctrl->connect_q);
			goto out_free_tag_set;
		}
	}

	ctrl->tagset = set;
	return 0;

out_free_tag_set:
	blk_mq_free_tag_set(set);
	return ret;
}
EXPORT_SYMBOL_GPL(nvme_alloc_io_tag_set);

void nvme_remove_io_tag_set(struct nvme_ctrl *ctrl)
{
	if (ctrl->ops->flags & NVME_F_FABRICS)
		blk_mq_destroy_queue(ctrl->connect_q);
	blk_mq_free_tag_set(ctrl->tagset);
}
EXPORT_SYMBOL_GPL(nvme_remove_io_tag_set);

4916
void nvme_stop_ctrl(struct nvme_ctrl *ctrl)
4917
{
C
Christoph Hellwig 已提交
4918
	nvme_mpath_stop(ctrl);
4919
	nvme_auth_stop(ctrl);
4920
	nvme_stop_keep_alive(ctrl);
4921
	nvme_stop_failfast_work(ctrl);
4922
	flush_work(&ctrl->async_event_work);
4923
	cancel_work_sync(&ctrl->fw_act_work);
4924 4925
	if (ctrl->ops->stop_ctrl)
		ctrl->ops->stop_ctrl(ctrl);
4926 4927 4928 4929 4930
}
EXPORT_SYMBOL_GPL(nvme_stop_ctrl);

void nvme_start_ctrl(struct nvme_ctrl *ctrl)
{
4931
	nvme_start_keep_alive(ctrl);
4932

4933 4934
	nvme_enable_aen(ctrl);

4935 4936 4937 4938 4939 4940 4941 4942 4943 4944
	/*
	 * persistent discovery controllers need to send indication to userspace
	 * to re-read the discovery log page to learn about possible changes
	 * that were missed. We identify persistent discovery controllers by
	 * checking that they started once before, hence are reconnecting back.
	 */
	if (test_and_set_bit(NVME_CTRL_STARTED_ONCE, &ctrl->flags) &&
	    nvme_discovery_ctrl(ctrl))
		nvme_change_uevent(ctrl, "NVME_EVENT=rediscover");

4945 4946 4947
	if (ctrl->queue_count > 1) {
		nvme_queue_scan(ctrl);
		nvme_start_queues(ctrl);
4948
		nvme_mpath_update(ctrl);
4949
	}
4950 4951

	nvme_change_uevent(ctrl, "NVME_EVENT=connected");
4952 4953
}
EXPORT_SYMBOL_GPL(nvme_start_ctrl);
4954

4955 4956
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl)
{
4957
	nvme_hwmon_exit(ctrl);
4958
	nvme_fault_inject_fini(&ctrl->fault_inject);
4959
	dev_pm_qos_hide_latency_tolerance(ctrl->device);
4960
	cdev_device_del(&ctrl->cdev, ctrl->device);
4961
	nvme_put_ctrl(ctrl);
4962
}
4963
EXPORT_SYMBOL_GPL(nvme_uninit_ctrl);
4964

4965 4966 4967 4968 4969
static void nvme_free_cels(struct nvme_ctrl *ctrl)
{
	struct nvme_effects_log	*cel;
	unsigned long i;

4970
	xa_for_each(&ctrl->cels, i, cel) {
4971 4972 4973 4974 4975 4976 4977
		xa_erase(&ctrl->cels, i);
		kfree(cel);
	}

	xa_destroy(&ctrl->cels);
}

4978
static void nvme_free_ctrl(struct device *dev)
4979
{
4980 4981
	struct nvme_ctrl *ctrl =
		container_of(dev, struct nvme_ctrl, ctrl_device);
C
Christoph Hellwig 已提交
4982
	struct nvme_subsystem *subsys = ctrl->subsys;
4983

K
Keith Busch 已提交
4984
	if (!subsys || ctrl->instance != subsys->instance)
4985
		ida_free(&nvme_instance_ida, ctrl->instance);
4986

4987
	nvme_free_cels(ctrl);
C
Christoph Hellwig 已提交
4988
	nvme_mpath_uninit(ctrl);
4989 4990
	nvme_auth_stop(ctrl);
	nvme_auth_free(ctrl);
S
Sagi Grimberg 已提交
4991
	__free_page(ctrl->discard_page);
4992

C
Christoph Hellwig 已提交
4993
	if (subsys) {
4994
		mutex_lock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4995 4996
		list_del(&ctrl->subsys_entry);
		sysfs_remove_link(&subsys->dev.kobj, dev_name(ctrl->device));
4997
		mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4998
	}
4999 5000 5001

	ctrl->ops->free_ctrl(ctrl);

C
Christoph Hellwig 已提交
5002 5003
	if (subsys)
		nvme_put_subsystem(subsys);
5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015
}

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

5016
	ctrl->state = NVME_CTRL_NEW;
5017
	clear_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags);
5018
	spin_lock_init(&ctrl->lock);
5019
	mutex_init(&ctrl->scan_lock);
5020
	INIT_LIST_HEAD(&ctrl->namespaces);
5021
	xa_init(&ctrl->cels);
5022
	init_rwsem(&ctrl->namespaces_rwsem);
5023 5024 5025
	ctrl->dev = dev;
	ctrl->ops = ops;
	ctrl->quirks = quirks;
5026
	ctrl->numa_node = NUMA_NO_NODE;
5027
	INIT_WORK(&ctrl->scan_work, nvme_scan_work);
5028
	INIT_WORK(&ctrl->async_event_work, nvme_async_event_work);
5029
	INIT_WORK(&ctrl->fw_act_work, nvme_fw_act_work);
5030
	INIT_WORK(&ctrl->delete_work, nvme_delete_ctrl_work);
5031
	init_waitqueue_head(&ctrl->state_wq);
5032

5033
	INIT_DELAYED_WORK(&ctrl->ka_work, nvme_keep_alive_work);
5034
	INIT_DELAYED_WORK(&ctrl->failfast_work, nvme_failfast_work);
5035 5036 5037
	memset(&ctrl->ka_cmd, 0, sizeof(ctrl->ka_cmd));
	ctrl->ka_cmd.common.opcode = nvme_admin_keep_alive;

5038 5039 5040 5041 5042 5043 5044 5045
	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;
	}

5046
	ret = ida_alloc(&nvme_instance_ida, GFP_KERNEL);
5047
	if (ret < 0)
5048
		goto out;
5049
	ctrl->instance = ret;
5050

5051 5052
	device_initialize(&ctrl->ctrl_device);
	ctrl->device = &ctrl->ctrl_device;
5053 5054
	ctrl->device->devt = MKDEV(MAJOR(nvme_ctrl_base_chr_devt),
			ctrl->instance);
5055 5056 5057 5058 5059 5060 5061
	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)
5062 5063
		goto out_release_instance;

5064
	nvme_get_ctrl(ctrl);
5065 5066 5067
	cdev_init(&ctrl->cdev, &nvme_dev_fops);
	ctrl->cdev.owner = ops->module;
	ret = cdev_device_add(&ctrl->cdev, ctrl->device);
5068 5069
	if (ret)
		goto out_free_name;
5070

5071 5072 5073 5074 5075 5076 5077 5078
	/*
	 * 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));

5079
	nvme_fault_inject_init(&ctrl->fault_inject, dev_name(ctrl->device));
5080
	nvme_mpath_init_ctrl(ctrl);
5081
	nvme_auth_init_ctrl(ctrl);
5082

5083
	return 0;
5084
out_free_name:
5085
	nvme_put_ctrl(ctrl);
5086
	kfree_const(ctrl->device->kobj.name);
5087
out_release_instance:
5088
	ida_free(&nvme_instance_ida, ctrl->instance);
5089
out:
5090 5091
	if (ctrl->discard_page)
		__free_page(ctrl->discard_page);
5092 5093
	return ret;
}
5094
EXPORT_SYMBOL_GPL(nvme_init_ctrl);
5095

5096 5097
static void nvme_start_ns_queue(struct nvme_ns *ns)
{
M
Ming Lei 已提交
5098 5099
	if (test_and_clear_bit(NVME_NS_STOPPED, &ns->flags))
		blk_mq_unquiesce_queue(ns->queue);
5100 5101 5102 5103
}

static void nvme_stop_ns_queue(struct nvme_ns *ns)
{
M
Ming Lei 已提交
5104 5105
	if (!test_and_set_bit(NVME_NS_STOPPED, &ns->flags))
		blk_mq_quiesce_queue(ns->queue);
M
Ming Lei 已提交
5106 5107
	else
		blk_mq_wait_quiesce_done(ns->queue);
5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122
}

/*
 * 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.
 */
static void nvme_set_queue_dying(struct nvme_ns *ns)
{
	if (test_and_set_bit(NVME_NS_DEAD, &ns->flags))
		return;

5123
	blk_mark_disk_dead(ns->disk);
5124 5125 5126 5127 5128
	nvme_start_ns_queue(ns);

	set_capacity_and_notify(ns->disk, 0);
}

5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139
/**
 * 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;

5140
	down_read(&ctrl->namespaces_rwsem);
M
Ming Lei 已提交
5141

5142
	/* Forcibly unquiesce queues to avoid blocking dispatch */
I
Igor Konopko 已提交
5143
	if (ctrl->admin_q && !blk_queue_dying(ctrl->admin_q))
5144
		nvme_start_admin_queue(ctrl);
5145

5146 5147
	list_for_each_entry(ns, &ctrl->namespaces, list)
		nvme_set_queue_dying(ns);
5148

5149
	up_read(&ctrl->namespaces_rwsem);
5150
}
5151
EXPORT_SYMBOL_GPL(nvme_kill_queues);
5152

K
Keith Busch 已提交
5153 5154 5155 5156
void nvme_unfreeze(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

5157
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
5158 5159
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_unfreeze_queue(ns->queue);
5160
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
5161 5162 5163
}
EXPORT_SYMBOL_GPL(nvme_unfreeze);

5164
int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout)
K
Keith Busch 已提交
5165 5166 5167
{
	struct nvme_ns *ns;

5168
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
5169 5170 5171 5172 5173
	list_for_each_entry(ns, &ctrl->namespaces, list) {
		timeout = blk_mq_freeze_queue_wait_timeout(ns->queue, timeout);
		if (timeout <= 0)
			break;
	}
5174
	up_read(&ctrl->namespaces_rwsem);
5175
	return timeout;
K
Keith Busch 已提交
5176 5177 5178 5179 5180 5181 5182
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze_timeout);

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

5183
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
5184 5185
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_freeze_queue_wait(ns->queue);
5186
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
5187 5188 5189 5190 5191 5192 5193
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze);

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

5194
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
5195
	list_for_each_entry(ns, &ctrl->namespaces, list)
5196
		blk_freeze_queue_start(ns->queue);
5197
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
5198 5199 5200
}
EXPORT_SYMBOL_GPL(nvme_start_freeze);

5201
void nvme_stop_queues(struct nvme_ctrl *ctrl)
5202 5203 5204
{
	struct nvme_ns *ns;

5205
	down_read(&ctrl->namespaces_rwsem);
5206
	list_for_each_entry(ns, &ctrl->namespaces, list)
5207
		nvme_stop_ns_queue(ns);
5208
	up_read(&ctrl->namespaces_rwsem);
5209
}
5210
EXPORT_SYMBOL_GPL(nvme_stop_queues);
5211

5212
void nvme_start_queues(struct nvme_ctrl *ctrl)
5213 5214 5215
{
	struct nvme_ns *ns;

5216
	down_read(&ctrl->namespaces_rwsem);
5217
	list_for_each_entry(ns, &ctrl->namespaces, list)
5218
		nvme_start_ns_queue(ns);
5219
	up_read(&ctrl->namespaces_rwsem);
5220
}
5221
EXPORT_SYMBOL_GPL(nvme_start_queues);
5222

5223 5224
void nvme_stop_admin_queue(struct nvme_ctrl *ctrl)
{
M
Ming Lei 已提交
5225 5226
	if (!test_and_set_bit(NVME_CTRL_ADMIN_Q_STOPPED, &ctrl->flags))
		blk_mq_quiesce_queue(ctrl->admin_q);
M
Ming Lei 已提交
5227 5228
	else
		blk_mq_wait_quiesce_done(ctrl->admin_q);
5229 5230 5231 5232 5233
}
EXPORT_SYMBOL_GPL(nvme_stop_admin_queue);

void nvme_start_admin_queue(struct nvme_ctrl *ctrl)
{
M
Ming Lei 已提交
5234 5235
	if (test_and_clear_bit(NVME_CTRL_ADMIN_Q_STOPPED, &ctrl->flags))
		blk_mq_unquiesce_queue(ctrl->admin_q);
5236 5237 5238
}
EXPORT_SYMBOL_GPL(nvme_start_admin_queue);

C
Chao Leng 已提交
5239
void nvme_sync_io_queues(struct nvme_ctrl *ctrl)
K
Keith Busch 已提交
5240 5241 5242 5243 5244 5245 5246
{
	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 已提交
5247 5248
}
EXPORT_SYMBOL_GPL(nvme_sync_io_queues);
5249

C
Chao Leng 已提交
5250 5251 5252
void nvme_sync_queues(struct nvme_ctrl *ctrl)
{
	nvme_sync_io_queues(ctrl);
5253 5254
	if (ctrl->admin_q)
		blk_sync_queue(ctrl->admin_q);
K
Keith Busch 已提交
5255 5256 5257
}
EXPORT_SYMBOL_GPL(nvme_sync_queues);

5258
struct nvme_ctrl *nvme_ctrl_from_file(struct file *file)
5259
{
5260 5261 5262
	if (file->f_op != &nvme_dev_fops)
		return NULL;
	return file->private_data;
5263
}
5264
EXPORT_SYMBOL_NS_GPL(nvme_ctrl_from_file, NVME_TARGET_PASSTHRU);
5265

5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283
/*
 * 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);
5284 5285
	BUILD_BUG_ON(sizeof(struct nvme_id_ns_cs_indep) !=
			NVME_IDENTIFY_DATA_SIZE);
K
Keith Busch 已提交
5286
	BUILD_BUG_ON(sizeof(struct nvme_id_ns_zns) != NVME_IDENTIFY_DATA_SIZE);
5287
	BUILD_BUG_ON(sizeof(struct nvme_id_ns_nvm) != NVME_IDENTIFY_DATA_SIZE);
K
Keith Busch 已提交
5288
	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl_zns) != NVME_IDENTIFY_DATA_SIZE);
5289
	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl_nvm) != NVME_IDENTIFY_DATA_SIZE);
5290 5291 5292 5293
	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);
5294
	BUILD_BUG_ON(sizeof(struct nvme_feat_host_behavior) != 512);
5295 5296 5297
}


5298
static int __init nvme_core_init(void)
5299
{
5300
	int result = -ENOMEM;
5301

5302 5303
	_nvme_check_size();

5304 5305 5306
	nvme_wq = alloc_workqueue("nvme-wq",
			WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0);
	if (!nvme_wq)
5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317
		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;
5318

5319 5320
	result = alloc_chrdev_region(&nvme_ctrl_base_chr_devt, 0,
			NVME_MINORS, "nvme");
5321
	if (result < 0)
5322
		goto destroy_delete_wq;
5323 5324 5325 5326 5327 5328

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

C
Christoph Hellwig 已提交
5331 5332 5333 5334 5335
	nvme_subsys_class = class_create(THIS_MODULE, "nvme-subsystem");
	if (IS_ERR(nvme_subsys_class)) {
		result = PTR_ERR(nvme_subsys_class);
		goto destroy_class;
	}
5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347

	result = alloc_chrdev_region(&nvme_ns_chr_devt, 0, NVME_MINORS,
				     "nvme-generic");
	if (result < 0)
		goto destroy_subsys_class;

	nvme_ns_chr_class = class_create(THIS_MODULE, "nvme-generic");
	if (IS_ERR(nvme_ns_chr_class)) {
		result = PTR_ERR(nvme_ns_chr_class);
		goto unregister_generic_ns;
	}

5348
	return 0;
5349

5350 5351 5352 5353
unregister_generic_ns:
	unregister_chrdev_region(nvme_ns_chr_devt, NVME_MINORS);
destroy_subsys_class:
	class_destroy(nvme_subsys_class);
C
Christoph Hellwig 已提交
5354 5355
destroy_class:
	class_destroy(nvme_class);
5356
unregister_chrdev:
5357
	unregister_chrdev_region(nvme_ctrl_base_chr_devt, NVME_MINORS);
5358 5359 5360 5361
destroy_delete_wq:
	destroy_workqueue(nvme_delete_wq);
destroy_reset_wq:
	destroy_workqueue(nvme_reset_wq);
5362 5363
destroy_wq:
	destroy_workqueue(nvme_wq);
5364
out:
5365
	return result;
5366 5367
}

5368
static void __exit nvme_core_exit(void)
5369
{
5370
	class_destroy(nvme_ns_chr_class);
C
Christoph Hellwig 已提交
5371
	class_destroy(nvme_subsys_class);
5372
	class_destroy(nvme_class);
5373
	unregister_chrdev_region(nvme_ns_chr_devt, NVME_MINORS);
5374
	unregister_chrdev_region(nvme_ctrl_base_chr_devt, NVME_MINORS);
5375 5376
	destroy_workqueue(nvme_delete_wq);
	destroy_workqueue(nvme_reset_wq);
5377
	destroy_workqueue(nvme_wq);
5378
	ida_destroy(&nvme_ns_chr_minor_ida);
M
Max Gurtovoy 已提交
5379
	ida_destroy(&nvme_instance_ida);
5380
}
5381 5382 5383 5384 5385

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