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

#include <linux/blkdev.h>
#include <linux/blk-mq.h>
9
#include <linux/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

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

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

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

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

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

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

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

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

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
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");

80 81 82 83 84
/*
 * 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
 *
85 86
 * nvme_wq will host works such as scan, aen handling, fw activation,
 * keep-alive, periodic reconnects etc. nvme_reset_wq
87 88 89 90
 * 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.
 */
91 92 93
struct workqueue_struct *nvme_wq;
EXPORT_SYMBOL_GPL(nvme_wq);

94 95 96 97 98 99
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 已提交
100 101
static LIST_HEAD(nvme_subsystems);
static DEFINE_MUTEX(nvme_subsystems_lock);
102

103
static DEFINE_IDA(nvme_instance_ida);
104
static dev_t nvme_ctrl_base_chr_devt;
105
static struct class *nvme_class;
C
Christoph Hellwig 已提交
106
static struct class *nvme_subsys_class;
107

108 109 110 111
static DEFINE_IDA(nvme_ns_chr_minor_ida);
static dev_t nvme_ns_chr_devt;
static struct class *nvme_ns_chr_class;

112
static void nvme_put_subsystem(struct nvme_subsystem *subsys);
113 114
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					   unsigned nsid);
115 116
static void nvme_update_keep_alive(struct nvme_ctrl *ctrl,
				   struct nvme_command *cmd);
117

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

127 128 129 130 131 132
/*
 * 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.
 */
133
int nvme_try_sched_reset(struct nvme_ctrl *ctrl)
134 135 136 137 138 139 140
{
	if (ctrl->state != NVME_CTRL_RESETTING)
		return -EBUSY;
	if (!queue_work(nvme_reset_wq, &ctrl->reset_work))
		return -EBUSY;
	return 0;
}
141
EXPORT_SYMBOL_GPL(nvme_try_sched_reset);
142

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
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);
}


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

185
int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl)
186 187 188 189
{
	int ret;

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

196 197 198
	return ret;
}

199
static void nvme_do_delete_ctrl(struct nvme_ctrl *ctrl)
200
{
201
	dev_info(ctrl->device,
202
		 "Removing ctrl: NQN \"%s\"\n", nvmf_ctrl_subsysnqn(ctrl));
203

204
	flush_work(&ctrl->reset_work);
205 206
	nvme_stop_ctrl(ctrl);
	nvme_remove_namespaces(ctrl);
207
	ctrl->ops->delete_ctrl(ctrl);
208
	nvme_uninit_ctrl(ctrl);
209 210
}

211 212 213 214 215 216 217 218
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);
}

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

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

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

283 284 285 286 287 288 289
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;
290 291
	if (crd)
		delay = nvme_req(req)->ctrl->crdt[crd - 1] * 100;
292 293 294 295 296 297

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

A
Alan Adamson 已提交
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
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 "  : "");
}

329 330 331 332 333 334 335
enum nvme_disposition {
	COMPLETE,
	RETRY,
	FAILOVER,
};

static inline enum nvme_disposition nvme_decide_disposition(struct request *req)
336
{
337 338
	if (likely(nvme_req(req)->status == 0))
		return COMPLETE;
339

340 341 342 343
	if (blk_noretry_request(req) ||
	    (nvme_req(req)->status & NVME_SC_DNR) ||
	    nvme_req(req)->retries >= nvme_max_retries)
		return COMPLETE;
344

345
	if (req->cmd_flags & REQ_NVME_MPATH) {
346 347
		if (nvme_is_path_error(nvme_req(req)->status) ||
		    blk_queue_dying(req->q))
348
			return FAILOVER;
349 350 351
	} else {
		if (blk_queue_dying(req->q))
			return COMPLETE;
352
	}
353

354 355
	return RETRY;
}
356

357
static inline void nvme_end_req_zoned(struct request *req)
358 359 360
{
	if (IS_ENABLED(CONFIG_BLK_DEV_ZONED) &&
	    req_op(req) == REQ_OP_ZONE_APPEND)
K
Keith Busch 已提交
361 362
		req->__sector = nvme_lba_to_sect(req->q->queuedata,
			le64_to_cpu(nvme_req(req)->result.u64));
363 364 365 366 367
}

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

369
	if (unlikely(nvme_req(req)->status && !(req->rq_flags & RQF_QUIET)))
A
Alan Adamson 已提交
370
		nvme_log_error(req);
371
	nvme_end_req_zoned(req);
372
	nvme_trace_bio_complete(req);
373
	blk_mq_end_request(req, status);
374
}
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395

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

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

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

398 399
void nvme_complete_batch_req(struct request *req)
{
400
	trace_nvme_complete_rq(req);
401 402 403 404 405
	nvme_cleanup_cmd(req);
	nvme_end_req_zoned(req);
}
EXPORT_SYMBOL_GPL(nvme_complete_batch_req);

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
/*
 * 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);

421
bool nvme_cancel_request(struct request *req, void *data, bool reserved)
422 423 424 425
{
	dev_dbg_ratelimited(((struct nvme_ctrl *) data)->device,
				"Cancelling I/O %d", req->tag);

426 427 428 429
	/* don't abort one completed request */
	if (blk_mq_request_completed(req))
		return true;

430
	nvme_req(req)->status = NVME_SC_HOST_ABORTED_CMD;
431
	nvme_req(req)->flags |= NVME_REQ_CANCELLED;
432
	blk_mq_complete_request(req);
433
	return true;
434 435 436
}
EXPORT_SYMBOL_GPL(nvme_cancel_request);

C
Chao Leng 已提交
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
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);

457 458 459
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state)
{
460
	enum nvme_ctrl_state old_state;
461
	unsigned long flags;
462 463
	bool changed = false;

464
	spin_lock_irqsave(&ctrl->lock, flags);
465 466

	old_state = ctrl->state;
467 468 469
	switch (new_state) {
	case NVME_CTRL_LIVE:
		switch (old_state) {
470
		case NVME_CTRL_NEW:
471
		case NVME_CTRL_RESETTING:
472
		case NVME_CTRL_CONNECTING:
473
			changed = true;
474
			fallthrough;
475 476 477 478 479 480 481
		default:
			break;
		}
		break;
	case NVME_CTRL_RESETTING:
		switch (old_state) {
		case NVME_CTRL_NEW:
482 483
		case NVME_CTRL_LIVE:
			changed = true;
484
			fallthrough;
485 486 487 488
		default:
			break;
		}
		break;
489
	case NVME_CTRL_CONNECTING:
490
		switch (old_state) {
491
		case NVME_CTRL_NEW:
492
		case NVME_CTRL_RESETTING:
493
			changed = true;
494
			fallthrough;
495 496 497 498 499 500 501 502
		default:
			break;
		}
		break;
	case NVME_CTRL_DELETING:
		switch (old_state) {
		case NVME_CTRL_LIVE:
		case NVME_CTRL_RESETTING:
503
		case NVME_CTRL_CONNECTING:
504
			changed = true;
505
			fallthrough;
506 507 508 509
		default:
			break;
		}
		break;
510 511 512 513 514
	case NVME_CTRL_DELETING_NOIO:
		switch (old_state) {
		case NVME_CTRL_DELETING:
		case NVME_CTRL_DEAD:
			changed = true;
515
			fallthrough;
516 517 518 519
		default:
			break;
		}
		break;
520 521 522 523
	case NVME_CTRL_DEAD:
		switch (old_state) {
		case NVME_CTRL_DELETING:
			changed = true;
524
			fallthrough;
525 526 527 528
		default:
			break;
		}
		break;
529 530 531 532
	default:
		break;
	}

533
	if (changed) {
534
		ctrl->state = new_state;
535 536
		wake_up_all(&ctrl->state_wq);
	}
537

538
	spin_unlock_irqrestore(&ctrl->lock, flags);
539 540 541 542 543 544
	if (!changed)
		return false;

	if (ctrl->state == NVME_CTRL_LIVE) {
		if (old_state == NVME_CTRL_CONNECTING)
			nvme_stop_failfast_work(ctrl);
545
		nvme_kick_requeue_lists(ctrl);
546 547 548 549
	} else if (ctrl->state == NVME_CTRL_CONNECTING &&
		old_state == NVME_CTRL_RESETTING) {
		nvme_start_failfast_work(ctrl);
	}
550 551 552 553
	return changed;
}
EXPORT_SYMBOL_GPL(nvme_change_ctrl_state);

554 555 556 557 558 559 560 561 562 563 564 565
/*
 * 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:
566
	case NVME_CTRL_DELETING_NOIO:
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
	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 已提交
588 589 590 591 592
static void nvme_free_ns_head(struct kref *ref)
{
	struct nvme_ns_head *head =
		container_of(ref, struct nvme_ns_head, ref);

593
	nvme_mpath_remove_disk(head);
594
	ida_free(&head->subsys->ns_ida, head->instance);
595
	cleanup_srcu_struct(&head->srcu);
596
	nvme_put_subsystem(head->subsys);
C
Christoph Hellwig 已提交
597 598 599
	kfree(head);
}

600
bool nvme_tryget_ns_head(struct nvme_ns_head *head)
601 602 603 604
{
	return kref_get_unless_zero(&head->ref);
}

605
void nvme_put_ns_head(struct nvme_ns_head *head)
C
Christoph Hellwig 已提交
606 607 608 609
{
	kref_put(&head->ref, nvme_free_ns_head);
}

610 611 612 613 614
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 已提交
615
	nvme_put_ns_head(ns->head);
616
	nvme_put_ctrl(ns->ctrl);
617 618 619
	kfree(ns);
}

K
Kanchan Joshi 已提交
620 621 622 623 624
static inline bool nvme_get_ns(struct nvme_ns *ns)
{
	return kref_get_unless_zero(&ns->kref);
}

625
void nvme_put_ns(struct nvme_ns *ns)
626 627 628
{
	kref_put(&ns->kref, nvme_free_ns);
}
629
EXPORT_SYMBOL_NS_GPL(nvme_put_ns, NVME_TARGET_PASSTHRU);
630

631 632
static inline void nvme_clear_nvme_request(struct request *req)
{
633
	nvme_req(req)->status = 0;
634 635 636
	nvme_req(req)->retries = 0;
	nvme_req(req)->flags = 0;
	req->rq_flags |= RQF_DONTPREP;
637 638
}

639 640
/* initialize a passthrough request */
void nvme_init_request(struct request *req, struct nvme_command *cmd)
641
{
642 643 644
	if (req->q->queuedata)
		req->timeout = NVME_IO_TIMEOUT;
	else /* no queuedata implies admin queue */
645
		req->timeout = NVME_ADMIN_TIMEOUT;
646

647 648 649
	/* passthru commands should let the driver set the SGL flags */
	cmd->common.flags &= ~NVME_CMD_SGL_ALL;

650
	req->cmd_flags |= REQ_FAILFAST_DRIVER;
651
	if (req->mq_hctx->type == HCTX_TYPE_POLL)
652
		req->cmd_flags |= REQ_POLLED;
653
	nvme_clear_nvme_request(req);
654
	memcpy(nvme_req(req)->cmd, cmd, sizeof(*cmd));
655
}
656
EXPORT_SYMBOL_GPL(nvme_init_request);
657

658 659 660 661 662 663 664 665 666 667 668 669 670
/*
 * 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 &&
671
	    ctrl->state != NVME_CTRL_DELETING &&
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
	    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) &&
			    req->cmd->fabrics.fctype == nvme_fabrics_type_connect)
				return true;
			break;
		default:
			break;
		case NVME_CTRL_DEAD:
			return false;
		}
	}

	return queue_live;
}
EXPORT_SYMBOL_GPL(__nvme_check_ready);

M
Ming Lin 已提交
719 720 721
static inline void nvme_setup_flush(struct nvme_ns *ns,
		struct nvme_command *cmnd)
{
722
	memset(cmnd, 0, sizeof(*cmnd));
M
Ming Lin 已提交
723
	cmnd->common.opcode = nvme_cmd_flush;
C
Christoph Hellwig 已提交
724
	cmnd->common.nsid = cpu_to_le32(ns->head->ns_id);
M
Ming Lin 已提交
725 726
}

727
static blk_status_t nvme_setup_discard(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
728 729
		struct nvme_command *cmnd)
{
730
	unsigned short segments = blk_rq_nr_discard_segments(req), n = 0;
M
Ming Lin 已提交
731
	struct nvme_dsm_range *range;
732
	struct bio *bio;
M
Ming Lin 已提交
733

734 735 736 737 738 739 740 741
	/*
	 * 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);
742 743 744 745 746 747 748 749 750 751 752
	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 已提交
753

754
	__rq_for_each_bio(bio, req) {
755
		u64 slba = nvme_sect_to_lba(ns, bio->bi_iter.bi_sector);
756 757
		u32 nlb = bio->bi_iter.bi_size >> ns->lba_shift;

K
Keith Busch 已提交
758 759 760 761 762
		if (n < segments) {
			range[n].cattr = cpu_to_le32(0);
			range[n].nlb = cpu_to_le32(nlb);
			range[n].slba = cpu_to_le64(slba);
		}
763 764 765 766
		n++;
	}

	if (WARN_ON_ONCE(n != segments)) {
767 768 769 770
		if (virt_to_page(range) == ns->ctrl->discard_page)
			clear_bit_unlock(0, &ns->ctrl->discard_page_busy);
		else
			kfree(range);
771
		return BLK_STS_IOERR;
772
	}
M
Ming Lin 已提交
773

774
	memset(cmnd, 0, sizeof(*cmnd));
M
Ming Lin 已提交
775
	cmnd->dsm.opcode = nvme_cmd_dsm;
C
Christoph Hellwig 已提交
776
	cmnd->dsm.nsid = cpu_to_le32(ns->head->ns_id);
777
	cmnd->dsm.nr = cpu_to_le32(segments - 1);
M
Ming Lin 已提交
778 779
	cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);

780 781
	req->special_vec.bv_page = virt_to_page(range);
	req->special_vec.bv_offset = offset_in_page(range);
782
	req->special_vec.bv_len = alloc_size;
783
	req->rq_flags |= RQF_SPECIAL_PAYLOAD;
M
Ming Lin 已提交
784

785
	return BLK_STS_OK;
M
Ming Lin 已提交
786 787
}

788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
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;
	}
}

812 813 814
static inline blk_status_t nvme_setup_write_zeroes(struct nvme_ns *ns,
		struct request *req, struct nvme_command *cmnd)
{
815 816
	memset(cmnd, 0, sizeof(*cmnd));

817 818 819 820 821 822
	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 =
823
		cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
824 825
	cmnd->write_zeroes.length =
		cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
K
Klaus Jensen 已提交
826 827

	if (nvme_ns_has_pi(ns)) {
828
		cmnd->write_zeroes.control = cpu_to_le16(NVME_RW_PRINFO_PRACT);
K
Klaus Jensen 已提交
829 830 831 832

		switch (ns->pi_type) {
		case NVME_NS_DPS_PI_TYPE1:
		case NVME_NS_DPS_PI_TYPE2:
833
			nvme_set_ref_tag(ns, cmnd, req);
K
Klaus Jensen 已提交
834 835 836 837
			break;
		}
	}

838 839 840
	return BLK_STS_OK;
}

841
static inline blk_status_t nvme_setup_rw(struct nvme_ns *ns,
K
Keith Busch 已提交
842 843
		struct request *req, struct nvme_command *cmnd,
		enum nvme_opcode op)
M
Ming Lin 已提交
844 845 846 847 848 849 850 851 852 853 854 855
{
	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 已提交
856
	cmnd->rw.opcode = op;
857
	cmnd->rw.flags = 0;
C
Christoph Hellwig 已提交
858
	cmnd->rw.nsid = cpu_to_le32(ns->head->ns_id);
859 860
	cmnd->rw.cdw2 = 0;
	cmnd->rw.cdw3 = 0;
861
	cmnd->rw.metadata = 0;
862
	cmnd->rw.slba = cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
M
Ming Lin 已提交
863
	cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
864 865 866
	cmnd->rw.reftag = 0;
	cmnd->rw.apptag = 0;
	cmnd->rw.appmask = 0;
M
Ming Lin 已提交
867 868

	if (ns->ms) {
869 870 871 872 873 874 875 876 877 878 879 880
		/*
		 * 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 已提交
881 882 883 884 885 886 887 888
		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 已提交
889 890
			if (op == nvme_cmd_zone_append)
				control |= NVME_RW_APPEND_PIREMAP;
891
			nvme_set_ref_tag(ns, cmnd, req);
M
Ming Lin 已提交
892 893 894 895 896 897
			break;
		}
	}

	cmnd->rw.control = cpu_to_le16(control);
	cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
898
	return 0;
M
Ming Lin 已提交
899 900
}

901 902 903
void nvme_cleanup_cmd(struct request *req)
{
	if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
M
Minwoo Im 已提交
904
		struct nvme_ctrl *ctrl = nvme_req(req)->ctrl;
905

C
Christoph Hellwig 已提交
906
		if (req->special_vec.bv_page == ctrl->discard_page)
M
Minwoo Im 已提交
907
			clear_bit_unlock(0, &ctrl->discard_page_busy);
908
		else
C
Christoph Hellwig 已提交
909
			kfree(bvec_virt(&req->special_vec));
910 911 912 913
	}
}
EXPORT_SYMBOL_GPL(nvme_cleanup_cmd);

914
blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req)
M
Ming Lin 已提交
915
{
916
	struct nvme_command *cmd = nvme_req(req)->cmd;
917
	blk_status_t ret = BLK_STS_OK;
M
Ming Lin 已提交
918

919
	if (!(req->rq_flags & RQF_DONTPREP))
920
		nvme_clear_nvme_request(req);
921

922 923 924
	switch (req_op(req)) {
	case REQ_OP_DRV_IN:
	case REQ_OP_DRV_OUT:
925
		/* these are setup prior to execution in nvme_init_request() */
926 927
		break;
	case REQ_OP_FLUSH:
M
Ming Lin 已提交
928
		nvme_setup_flush(ns, cmd);
929
		break;
K
Keith Busch 已提交
930 931 932 933 934 935 936 937 938 939 940 941 942
	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;
943
	case REQ_OP_WRITE_ZEROES:
944 945
		ret = nvme_setup_write_zeroes(ns, req, cmd);
		break;
946
	case REQ_OP_DISCARD:
M
Ming Lin 已提交
947
		ret = nvme_setup_discard(ns, req, cmd);
948 949
		break;
	case REQ_OP_READ:
K
Keith Busch 已提交
950 951
		ret = nvme_setup_rw(ns, req, cmd, nvme_cmd_read);
		break;
952
	case REQ_OP_WRITE:
K
Keith Busch 已提交
953 954 955 956
		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);
957 958 959
		break;
	default:
		WARN_ON_ONCE(1);
960
		return BLK_STS_IOERR;
961
	}
M
Ming Lin 已提交
962

963
	cmd->common.command_id = nvme_cid(req);
K
Keith Busch 已提交
964
	trace_nvme_setup_cmd(req, cmd);
M
Ming Lin 已提交
965 966 967 968
	return ret;
}
EXPORT_SYMBOL_GPL(nvme_setup_cmd);

969 970 971 972 973 974
/*
 * Return values:
 * 0:  success
 * >0: nvme controller's cqe status response
 * <0: kernel error in lieu of controller response
 */
975
static int nvme_execute_rq(struct request *rq, bool at_head)
976 977 978
{
	blk_status_t status;

979
	status = blk_execute_rq(rq, at_head);
980 981 982 983 984 985 986
	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);
}

987 988 989 990 991
/*
 * 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,
992
		union nvme_result *result, void *buffer, unsigned bufflen,
993
		unsigned timeout, int qid, int at_head,
994
		blk_mq_req_flags_t flags)
995 996 997 998
{
	struct request *req;
	int ret;

999
	if (qid == NVME_QID_ANY)
1000
		req = blk_mq_alloc_request(q, nvme_req_op(cmd), flags);
1001
	else
1002 1003 1004
		req = blk_mq_alloc_request_hctx(q, nvme_req_op(cmd), flags,
						qid ? qid - 1 : 0);

1005 1006
	if (IS_ERR(req))
		return PTR_ERR(req);
1007
	nvme_init_request(req, cmd);
1008

1009 1010
	if (timeout)
		req->timeout = timeout;
1011

1012 1013 1014 1015
	if (buffer && bufflen) {
		ret = blk_rq_map_kern(q, req, buffer, bufflen, GFP_KERNEL);
		if (ret)
			goto out;
1016 1017
	}

1018
	req->rq_flags |= RQF_QUIET;
1019
	ret = nvme_execute_rq(req, at_head);
1020
	if (result && ret >= 0)
1021
		*result = nvme_req(req)->result;
1022 1023 1024 1025
 out:
	blk_mq_free_request(req);
	return ret;
}
1026
EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd);
1027 1028 1029 1030

int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
		void *buffer, unsigned bufflen)
{
1031
	return __nvme_submit_sync_cmd(q, cmd, NULL, buffer, bufflen, 0,
1032
			NVME_QID_ANY, 0, 0);
1033
}
1034
EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd);
1035

1036 1037 1038 1039
static u32 nvme_known_admin_effects(u8 opcode)
{
	switch (opcode) {
	case nvme_admin_format_nvm:
1040
		return NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_NCC |
1041 1042
			NVME_CMD_EFFECTS_CSE_MASK;
	case nvme_admin_sanitize_nvm:
1043
		return NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_CSE_MASK;
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
	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))
1058 1059 1060
			dev_warn_once(ctrl->device,
				"IO command:%02x has unhandled effects:%08x\n",
				opcode, effects);
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
		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.
	 */
1081
	if (effects & NVME_CMD_EFFECTS_CSE_MASK) {
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
		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;
}

1092 1093
static void nvme_passthru_end(struct nvme_ctrl *ctrl, u32 effects,
			      struct nvme_command *cmd, int status)
1094
{
1095
	if (effects & NVME_CMD_EFFECTS_CSE_MASK) {
1096 1097 1098 1099 1100 1101 1102
		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)
1103
		nvme_init_ctrl_finish(ctrl);
1104 1105 1106 1107
	if (effects & (NVME_CMD_EFFECTS_NIC | NVME_CMD_EFFECTS_NCC)) {
		nvme_queue_scan(ctrl);
		flush_work(&ctrl->scan_work);
	}
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127

	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;
	}
1128 1129
}

1130
int nvme_execute_passthru_rq(struct request *rq)
1131 1132 1133 1134 1135
{
	struct nvme_command *cmd = nvme_req(rq)->cmd;
	struct nvme_ctrl *ctrl = nvme_req(rq)->ctrl;
	struct nvme_ns *ns = rq->q->queuedata;
	u32 effects;
1136
	int  ret;
1137 1138

	effects = nvme_passthru_start(ctrl, ns, cmd->common.opcode);
1139
	ret = nvme_execute_rq(rq, false);
1140
	if (effects) /* nothing to be done for zero cmd effects */
1141
		nvme_passthru_end(ctrl, effects, cmd, ret);
1142 1143

	return ret;
1144 1145 1146
}
EXPORT_SYMBOL_NS_GPL(nvme_execute_passthru_rq, NVME_TARGET_PASSTHRU);

H
Hannes Reinecke 已提交
1147 1148 1149 1150 1151 1152 1153
/*
 * 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)
1154
{
H
Hannes Reinecke 已提交
1155
	queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ / 2);
1156 1157
}

1158
static void nvme_keep_alive_end_io(struct request *rq, blk_status_t status)
S
Sagi Grimberg 已提交
1159 1160
{
	struct nvme_ctrl *ctrl = rq->end_io_data;
1161 1162
	unsigned long flags;
	bool startka = false;
S
Sagi Grimberg 已提交
1163 1164 1165

	blk_mq_free_request(rq);

1166
	if (status) {
S
Sagi Grimberg 已提交
1167
		dev_err(ctrl->device,
1168 1169
			"failed nvme_keep_alive_end_io error=%d\n",
				status);
S
Sagi Grimberg 已提交
1170 1171 1172
		return;
	}

1173
	ctrl->comp_seen = false;
1174 1175 1176 1177 1178 1179
	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 已提交
1180
		nvme_queue_keep_alive_work(ctrl);
S
Sagi Grimberg 已提交
1181 1182 1183 1184 1185 1186
}

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);
1187
	bool comp_seen = ctrl->comp_seen;
1188
	struct request *rq;
1189 1190 1191 1192 1193

	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 已提交
1194
		nvme_queue_keep_alive_work(ctrl);
1195 1196
		return;
	}
S
Sagi Grimberg 已提交
1197

1198 1199
	rq = blk_mq_alloc_request(ctrl->admin_q, nvme_req_op(&ctrl->ka_cmd),
				  BLK_MQ_REQ_RESERVED | BLK_MQ_REQ_NOWAIT);
1200
	if (IS_ERR(rq)) {
S
Sagi Grimberg 已提交
1201
		/* allocation failure, reset the controller */
1202
		dev_err(ctrl->device, "keep-alive failed: %ld\n", PTR_ERR(rq));
1203
		nvme_reset_ctrl(ctrl);
S
Sagi Grimberg 已提交
1204 1205
		return;
	}
1206
	nvme_init_request(rq, &ctrl->ka_cmd);
1207 1208 1209

	rq->timeout = ctrl->kato * HZ;
	rq->end_io_data = ctrl;
1210
	blk_execute_rq_nowait(rq, false, nvme_keep_alive_end_io);
S
Sagi Grimberg 已提交
1211 1212
}

1213
static void nvme_start_keep_alive(struct nvme_ctrl *ctrl)
S
Sagi Grimberg 已提交
1214 1215 1216 1217
{
	if (unlikely(ctrl->kato == 0))
		return;

H
Hannes Reinecke 已提交
1218
	nvme_queue_keep_alive_work(ctrl);
S
Sagi Grimberg 已提交
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
}

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

1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
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);
}

1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
/*
 * 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 已提交
1258
static int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id)
1259 1260 1261 1262 1263 1264
{
	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;
1265
	c.identify.cns = NVME_ID_CNS_CTRL;
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277

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

1278
static int nvme_process_ns_desc(struct nvme_ctrl *ctrl, struct nvme_ns_ids *ids,
1279
		struct nvme_ns_id_desc *cur, bool *csi_seen)
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308
{
	const char *warn_str = "ctrl returned bogus length:";
	void *data = cur;

	switch (cur->nidt) {
	case NVME_NIDT_EUI64:
		if (cur->nidl != NVME_NIDT_EUI64_LEN) {
			dev_warn(ctrl->device, "%s %d for NVME_NIDT_EUI64\n",
				 warn_str, cur->nidl);
			return -1;
		}
		memcpy(ids->eui64, data + sizeof(*cur), NVME_NIDT_EUI64_LEN);
		return NVME_NIDT_EUI64_LEN;
	case NVME_NIDT_NGUID:
		if (cur->nidl != NVME_NIDT_NGUID_LEN) {
			dev_warn(ctrl->device, "%s %d for NVME_NIDT_NGUID\n",
				 warn_str, cur->nidl);
			return -1;
		}
		memcpy(ids->nguid, data + sizeof(*cur), NVME_NIDT_NGUID_LEN);
		return NVME_NIDT_NGUID_LEN;
	case NVME_NIDT_UUID:
		if (cur->nidl != NVME_NIDT_UUID_LEN) {
			dev_warn(ctrl->device, "%s %d for NVME_NIDT_UUID\n",
				 warn_str, cur->nidl);
			return -1;
		}
		uuid_copy(&ids->uuid, data + sizeof(*cur));
		return NVME_NIDT_UUID_LEN;
1309 1310 1311 1312 1313 1314 1315 1316 1317
	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;
1318 1319 1320 1321 1322 1323
	default:
		/* Skip unknown types */
		return cur->nidl;
	}
}

1324
static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl, unsigned nsid,
1325
		struct nvme_ns_ids *ids)
1326 1327
{
	struct nvme_command c = { };
1328 1329
	bool csi_seen = false;
	int status, pos, len;
1330 1331
	void *data;

1332 1333
	if (ctrl->vs < NVME_VS(1, 3, 0) && !nvme_multi_css(ctrl))
		return 0;
1334 1335 1336
	if (ctrl->quirks & NVME_QUIRK_NO_NS_DESC_LIST)
		return 0;

1337 1338 1339 1340 1341 1342 1343 1344
	c.identify.opcode = nvme_admin_identify;
	c.identify.nsid = cpu_to_le32(nsid);
	c.identify.cns = NVME_ID_CNS_NS_DESC_LIST;

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

1345
	status = nvme_submit_sync_cmd(ctrl->admin_q, &c, data,
1346
				      NVME_IDENTIFY_DATA_SIZE);
1347 1348
	if (status) {
		dev_warn(ctrl->device,
1349 1350
			"Identify Descriptors failed (nsid=%u, status=0x%x)\n",
			nsid, status);
1351
		goto free_data;
1352
	}
1353 1354 1355 1356 1357 1358 1359

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

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

1360
		len = nvme_process_ns_desc(ctrl, ids, cur, &csi_seen);
1361
		if (len < 0)
1362
			break;
1363 1364 1365

		len += sizeof(*cur);
	}
1366 1367 1368 1369 1370 1371 1372

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

1373 1374 1375 1376 1377
free_data:
	kfree(data);
	return status;
}

1378 1379
static int nvme_identify_ns(struct nvme_ctrl *ctrl, unsigned nsid,
			struct nvme_ns_ids *ids, struct nvme_id_ns **id)
1380 1381 1382 1383 1384
{
	struct nvme_command c = { };
	int error;

	/* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1385 1386
	c.identify.opcode = nvme_admin_identify;
	c.identify.nsid = cpu_to_le32(nsid);
1387
	c.identify.cns = NVME_ID_CNS_NS;
1388

1389 1390 1391
	*id = kmalloc(sizeof(**id), GFP_KERNEL);
	if (!*id)
		return -ENOMEM;
1392

1393
	error = nvme_submit_sync_cmd(ctrl->admin_q, &c, *id, sizeof(**id));
1394
	if (error) {
1395
		dev_warn(ctrl->device, "Identify namespace failed (%d)\n", error);
1396
		goto out_free_id;
1397 1398
	}

1399
	error = NVME_SC_INVALID_NS | NVME_SC_DNR;
1400 1401
	if ((*id)->ncap == 0) /* namespace not allocated or attached */
		goto out_free_id;
1402 1403 1404 1405 1406 1407 1408 1409

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

1410 1411 1412 1413
	return 0;

out_free_id:
	kfree(*id);
1414
	return error;
1415 1416
}

K
Keith Busch 已提交
1417 1418
static int nvme_features(struct nvme_ctrl *dev, u8 op, unsigned int fid,
		unsigned int dword11, void *buffer, size_t buflen, u32 *result)
1419
{
1420
	union nvme_result res = { 0 };
1421
	struct nvme_command c = { };
1422
	int ret;
1423

K
Keith Busch 已提交
1424
	c.features.opcode = op;
1425 1426 1427
	c.features.fid = cpu_to_le32(fid);
	c.features.dword11 = cpu_to_le32(dword11);

1428
	ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &res,
1429
			buffer, buflen, 0, NVME_QID_ANY, 0, 0);
1430
	if (ret >= 0 && result)
1431
		*result = le32_to_cpu(res.u32);
1432
	return ret;
1433 1434
}

K
Keith Busch 已提交
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
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 已提交
1453 1454 1455 1456 1457 1458
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;

1459
	status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, NULL, 0,
C
Christoph Hellwig 已提交
1460
			&result);
1461
	if (status < 0)
C
Christoph Hellwig 已提交
1462 1463
		return status;

1464 1465 1466 1467 1468 1469
	/*
	 * 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) {
1470
		dev_err(ctrl->device, "Could not set queue count (%d)\n", status);
1471 1472 1473 1474 1475 1476
		*count = 0;
	} else {
		nr_io_queues = min(result & 0xffff, result >> 16) + 1;
		*count = min(*count, nr_io_queues);
	}

C
Christoph Hellwig 已提交
1477 1478
	return 0;
}
1479
EXPORT_SYMBOL_GPL(nvme_set_queue_count);
C
Christoph Hellwig 已提交
1480

1481
#define NVME_AEN_SUPPORTED \
1482 1483
	(NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_FW_ACT | \
	 NVME_AEN_CFG_ANA_CHANGE | NVME_AEN_CFG_DISC_CHANGE)
1484 1485 1486

static void nvme_enable_aen(struct nvme_ctrl *ctrl)
{
1487
	u32 result, supported_aens = ctrl->oaes & NVME_AEN_SUPPORTED;
1488 1489
	int status;

1490 1491 1492 1493 1494
	if (!supported_aens)
		return;

	status = nvme_set_features(ctrl, NVME_FEAT_ASYNC_EVENT, supported_aens,
			NULL, 0, &result);
1495 1496
	if (status)
		dev_warn(ctrl->device, "Failed to configure AEN (cfg %x)\n",
1497
			 supported_aens);
1498 1499

	queue_work(nvme_wq, &ctrl->async_event_work);
1500 1501
}

1502
static int nvme_ns_open(struct nvme_ns *ns)
1503 1504
{

1505
	/* should never be called due to GENHD_FL_HIDDEN */
1506
	if (WARN_ON_ONCE(nvme_ns_head_multipath(ns->head)))
1507
		goto fail;
K
Kanchan Joshi 已提交
1508
	if (!nvme_get_ns(ns))
1509 1510 1511 1512
		goto fail;
	if (!try_module_get(ns->ctrl->ops->module))
		goto fail_put_ns;

C
Christoph Hellwig 已提交
1513
	return 0;
1514 1515 1516 1517 1518

fail_put_ns:
	nvme_put_ns(ns);
fail:
	return -ENXIO;
1519 1520
}

1521
static void nvme_ns_release(struct nvme_ns *ns)
1522
{
1523 1524 1525

	module_put(ns->ctrl->ops->module);
	nvme_put_ns(ns);
1526 1527
}

1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
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);
}

1538
int nvme_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1539 1540 1541 1542 1543 1544 1545 1546 1547
{
	/* 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
1548
static void nvme_init_integrity(struct gendisk *disk, struct nvme_ns *ns,
1549
				u32 max_integrity_segments)
1550
{
1551
	struct blk_integrity integrity = { };
1552

1553
	switch (ns->pi_type) {
1554
	case NVME_NS_DPS_PI_TYPE3:
1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
		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;
		}
1570 1571 1572
		break;
	case NVME_NS_DPS_PI_TYPE1:
	case NVME_NS_DPS_PI_TYPE2:
1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
		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;
		}
1588 1589 1590 1591 1592
		break;
	default:
		integrity.profile = NULL;
		break;
	}
1593 1594

	integrity.tuple_size = ns->ms;
1595
	blk_integrity_register(disk, &integrity);
1596
	blk_queue_max_integrity_segments(disk->queue, max_integrity_segments);
1597 1598
}
#else
1599
static void nvme_init_integrity(struct gendisk *disk, struct nvme_ns *ns,
1600
				u32 max_integrity_segments)
1601 1602 1603 1604
{
}
#endif /* CONFIG_BLK_DEV_INTEGRITY */

1605
static void nvme_config_discard(struct gendisk *disk, struct nvme_ns *ns)
1606
{
1607
	struct nvme_ctrl *ctrl = ns->ctrl;
1608
	struct request_queue *queue = disk->queue;
1609 1610
	u32 size = queue_logical_block_size(queue);

1611
	if (ctrl->max_discard_sectors == 0) {
1612 1613 1614 1615
		blk_queue_flag_clear(QUEUE_FLAG_DISCARD, queue);
		return;
	}

1616 1617 1618
	BUILD_BUG_ON(PAGE_SIZE / sizeof(struct nvme_dsm_range) <
			NVME_DSM_MAX_RANGES);

1619
	queue->limits.discard_alignment = 0;
1620
	queue->limits.discard_granularity = size;
1621

1622 1623 1624 1625
	/* If discard is already enabled, don't reset queue limits */
	if (blk_queue_flag_test_and_set(QUEUE_FLAG_DISCARD, queue))
		return;

1626 1627
	blk_queue_max_discard_sectors(queue, ctrl->max_discard_sectors);
	blk_queue_max_discard_segments(queue, ctrl->max_discard_segments);
1628 1629

	if (ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
1630
		blk_queue_max_write_zeroes_sectors(queue, UINT_MAX);
1631 1632
}

1633 1634 1635 1636
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 &&
1637 1638
		memcmp(&a->eui64, &b->eui64, sizeof(a->eui64)) == 0 &&
		a->csi == b->csi;
1639 1640
}

1641
static int nvme_init_ms(struct nvme_ns *ns, struct nvme_id_ns *id)
1642
{
1643 1644
	bool first = id->dps & NVME_NS_DPS_PI_FIRST;
	unsigned lbaf = nvme_lbaf_index(id->flbas);
1645
	struct nvme_ctrl *ctrl = ns->ctrl;
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657
	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;
	}
1658

1659 1660 1661
	nvm = kzalloc(sizeof(*nvm), GFP_KERNEL);
	if (!nvm)
		return -ENOMEM;
1662

1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693
	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))
1694 1695 1696 1697
		ns->pi_type = id->dps & NVME_NS_DPS_PI_MASK;
	else
		ns->pi_type = 0;

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

1708 1709
	ns->features &= ~(NVME_NS_METADATA_SUPPORTED | NVME_NS_EXT_LBAS);
	if (!ns->ms || !(ctrl->ops->flags & NVME_F_METADATA_SUPPORTED))
1710 1711
		return;

1712 1713 1714 1715 1716 1717 1718
	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)))
1719
			return;
1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733

		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;
1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747
	} 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;
	}
}

1748 1749 1750
static void nvme_set_queue_limits(struct nvme_ctrl *ctrl,
		struct request_queue *q)
{
1751
	bool vwc = ctrl->vwc & NVME_CTRL_VWC_PRESENT;
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765

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

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

1766 1767 1768
static void nvme_update_disk_info(struct gendisk *disk,
		struct nvme_ns *ns, struct nvme_id_ns *id)
{
1769
	sector_t capacity = nvme_lba_to_sect(ns, le64_to_cpu(id->nsze));
1770
	unsigned short bs = 1 << ns->lba_shift;
D
Damien Le Moal 已提交
1771
	u32 atomic_bs, phys_bs, io_opt = 0;
1772

1773 1774 1775 1776
	/*
	 * 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.
	 */
1777
	if (ns->lba_shift > PAGE_SHIFT) {
1778
		capacity = 0;
1779 1780
		bs = (1 << 9);
	}
1781

1782 1783
	blk_integrity_unregister(disk);

D
Damien Le Moal 已提交
1784
	atomic_bs = phys_bs = bs;
1785 1786 1787 1788 1789 1790
	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.
		 */
1791
		if (id->nsfeat & NVME_NS_FEAT_ATOMICS && id->nawupf)
1792 1793 1794 1795
			atomic_bs = (1 + le16_to_cpu(id->nawupf)) * bs;
		else
			atomic_bs = (1 + ns->ctrl->subsys->awupf) * bs;
	}
K
Keith Busch 已提交
1796

1797
	if (id->nsfeat & NVME_NS_FEAT_IO_OPT) {
1798
		/* NPWG = Namespace Preferred Write Granularity */
K
Keith Busch 已提交
1799
		phys_bs = bs * (1 + le16_to_cpu(id->npwg));
1800
		/* NOWS = Namespace Optimal Write Size */
K
Keith Busch 已提交
1801
		io_opt = bs * (1 + le16_to_cpu(id->nows));
1802 1803
	}

1804
	blk_queue_logical_block_size(disk->queue, bs);
1805 1806 1807 1808 1809 1810 1811 1812
	/*
	 * 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);
1813

1814 1815 1816 1817 1818 1819 1820 1821 1822
	/*
	 * 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))
1823
			nvme_init_integrity(disk, ns,
1824
					    ns->ctrl->max_integrity_segments);
1825 1826 1827 1828
		else if (!nvme_ns_has_pi(ns))
			capacity = 0;
	}

1829
	set_capacity_and_notify(disk, capacity);
1830

1831
	nvme_config_discard(disk, ns);
1832 1833
	blk_queue_max_write_zeroes_sectors(disk->queue,
					   ns->ctrl->max_zeroes_sectors);
1834 1835
}

1836 1837 1838
static inline bool nvme_first_scan(struct gendisk *disk)
{
	/* nvme_alloc_ns() scans the disk prior to adding it */
C
Christoph Hellwig 已提交
1839
	return !disk_live(disk);
1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872
}

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

1873
static int nvme_update_ns_info(struct nvme_ns *ns, struct nvme_id_ns *id)
1874
{
1875
	unsigned lbaf = nvme_lbaf_index(id->flbas);
K
Keith Busch 已提交
1876
	int ret;
1877

1878
	blk_mq_freeze_queue(ns->disk->queue);
K
Keith Busch 已提交
1879
	ns->lba_shift = id->lbaf[lbaf].ds;
1880
	nvme_set_queue_limits(ns->ctrl, ns->queue);
1881

1882
	nvme_configure_metadata(ns, id);
1883 1884 1885
	nvme_set_chunk_sectors(ns, id);
	nvme_update_disk_info(ns->disk, ns, id);

1886
	if (ns->head->ids.csi == NVME_CSI_ZNS) {
1887
		ret = nvme_update_zone_info(ns, lbaf);
1888
		if (ret)
1889
			goto out_unfreeze;
1890 1891
	}

1892 1893
	set_disk_ro(ns->disk, (id->nsattr & NVME_NS_ATTR_RO) ||
		test_bit(NVME_NS_FORCE_RO, &ns->flags));
1894
	set_bit(NVME_NS_READY, &ns->flags);
1895
	blk_mq_unfreeze_queue(ns->disk->queue);
1896

1897 1898
	if (blk_queue_is_zoned(ns->queue)) {
		ret = nvme_revalidate_zones(ns);
1899
		if (ret && !nvme_first_scan(ns->disk))
1900
			return ret;
1901 1902
	}

1903
	if (nvme_ns_head_multipath(ns->head)) {
1904
		blk_mq_freeze_queue(ns->head->disk->queue);
1905
		nvme_update_disk_info(ns->head->disk, ns, id);
1906 1907 1908
		set_disk_ro(ns->head->disk,
			    (id->nsattr & NVME_NS_ATTR_RO) ||
				    test_bit(NVME_NS_FORCE_RO, &ns->flags));
1909
		nvme_mpath_revalidate_paths(ns);
1910 1911
		blk_stack_limits(&ns->head->disk->queue->limits,
				 &ns->queue->limits, 0);
1912
		disk_update_readahead(ns->head->disk);
1913
		blk_mq_unfreeze_queue(ns->head->disk->queue);
1914
	}
1915
	return 0;
1916

1917
out_unfreeze:
1918 1919 1920 1921 1922 1923
	/*
	 * 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;
1924
		set_bit(NVME_NS_READY, &ns->flags);
1925 1926
		ret = 0;
	}
1927
	blk_mq_unfreeze_queue(ns->disk->queue);
K
Keith Busch 已提交
1928 1929 1930
	return ret;
}

1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948
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;
	}
1949
}
1950

1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973
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);
}

1974 1975 1976
static int nvme_pr_command(struct block_device *bdev, u32 cdw10,
				u64 key, u64 sa_key, u8 op)
{
1977
	struct nvme_command c = { };
1978 1979 1980 1981 1982 1983
	u8 data[16] = { 0, };

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

	c.common.opcode = op;
1984
	c.common.cdw10 = cpu_to_le32(cdw10);
1985

1986 1987 1988 1989
	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);
1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021
}

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

2024 2025 2026 2027 2028
	return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire);
}

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

2031 2032 2033 2034 2035
	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_register);
}

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

2038 2039 2040
	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release);
}

2041
const struct pr_ops nvme_pr_ops = {
2042 2043 2044 2045 2046 2047 2048
	.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,
};

2049
#ifdef CONFIG_BLK_SED_OPAL
2050 2051
int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
		bool send)
2052
{
2053
	struct nvme_ctrl *ctrl = data;
2054
	struct nvme_command cmd = { };
2055 2056 2057 2058 2059 2060

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

2064
	return __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, NULL, buffer, len, 0,
2065
			NVME_QID_ANY, 1, 0);
2066 2067 2068 2069
}
EXPORT_SYMBOL_GPL(nvme_sec_submit);
#endif /* CONFIG_BLK_SED_OPAL */

2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
#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 已提交
2081
static const struct block_device_operations nvme_bdev_ops = {
2082 2083 2084 2085 2086
	.owner		= THIS_MODULE,
	.ioctl		= nvme_ioctl,
	.open		= nvme_open,
	.release	= nvme_release,
	.getgeo		= nvme_getgeo,
K
Keith Busch 已提交
2087
	.report_zones	= nvme_report_zones,
2088 2089 2090
	.pr_ops		= &nvme_pr_ops,
};

2091 2092 2093 2094 2095 2096 2097 2098
static int nvme_wait_ready(struct nvme_ctrl *ctrl, u64 cap, bool enabled)
{
	unsigned long timeout =
		((NVME_CAP_TIMEOUT(cap) + 1) * HZ / 2) + jiffies;
	u32 csts, bit = enabled ? NVME_CSTS_RDY : 0;
	int ret;

	while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) {
K
Keith Busch 已提交
2099 2100
		if (csts == ~0)
			return -ENODEV;
2101 2102 2103
		if ((csts & NVME_CSTS_RDY) == bit)
			break;

2104
		usleep_range(1000, 2000);
2105 2106 2107
		if (fatal_signal_pending(current))
			return -EINTR;
		if (time_after(jiffies, timeout)) {
2108
			dev_err(ctrl->device,
2109 2110
				"Device not ready; aborting %s, CSTS=0x%x\n",
				enabled ? "initialisation" : "reset", csts);
2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123
			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!
 */
2124
int nvme_disable_ctrl(struct nvme_ctrl *ctrl)
2125 2126 2127 2128 2129 2130 2131 2132 2133
{
	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;
2134

2135
	if (ctrl->quirks & NVME_QUIRK_DELAY_BEFORE_CHK_RDY)
2136 2137
		msleep(NVME_QUIRK_DELAY_AMOUNT);

2138
	return nvme_wait_ready(ctrl, ctrl->cap, false);
2139
}
2140
EXPORT_SYMBOL_GPL(nvme_disable_ctrl);
2141

2142
int nvme_enable_ctrl(struct nvme_ctrl *ctrl)
2143
{
2144
	unsigned dev_page_min;
2145 2146
	int ret;

2147 2148 2149 2150 2151 2152 2153
	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;

2154
	if (NVME_CTRL_PAGE_SHIFT < dev_page_min) {
2155
		dev_err(ctrl->device,
2156
			"Minimum device page size %u too large for host (%u)\n",
2157
			1 << dev_page_min, 1 << NVME_CTRL_PAGE_SHIFT);
2158 2159 2160
		return -ENODEV;
	}

2161 2162 2163 2164
	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;
2165
	ctrl->ctrl_config |= (NVME_CTRL_PAGE_SHIFT - 12) << NVME_CC_MPS_SHIFT;
2166
	ctrl->ctrl_config |= NVME_CC_AMS_RR | NVME_CC_SHN_NONE;
2167 2168 2169 2170 2171 2172
	ctrl->ctrl_config |= NVME_CC_IOSQES | NVME_CC_IOCQES;
	ctrl->ctrl_config |= NVME_CC_ENABLE;

	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
	if (ret)
		return ret;
2173
	return nvme_wait_ready(ctrl, ctrl->cap, true);
2174
}
2175
EXPORT_SYMBOL_GPL(nvme_enable_ctrl);
2176 2177 2178

int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl)
{
2179
	unsigned long timeout = jiffies + (ctrl->shutdown_timeout * HZ);
2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197
	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)) {
2198
			dev_err(ctrl->device,
2199 2200 2201 2202 2203 2204 2205
				"Device shutdown incomplete; abort shutdown\n");
			return -ENODEV;
		}
	}

	return ret;
}
2206
EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl);
2207

2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224
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;
}

2225
static int nvme_configure_host_options(struct nvme_ctrl *ctrl)
2226 2227
{
	struct nvme_feat_host_behavior *host;
2228
	u8 acre = 0, lbafee = 0;
2229 2230 2231
	int ret;

	/* Don't bother enabling the feature if retry delay is not reported */
2232 2233 2234 2235 2236 2237
	if (ctrl->crdt[0])
		acre = NVME_ENABLE_ACRE;
	if (ctrl->ctratt & NVME_CTRL_ATTR_ELBAS)
		lbafee = NVME_ENABLE_LBAFEE;

	if (!acre && !lbafee)
2238 2239 2240 2241 2242 2243
		return 0;

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

2244 2245
	host->acre = acre;
	host->lbafee = lbafee;
2246 2247 2248 2249 2250 2251
	ret = nvme_set_features(ctrl, NVME_FEAT_HOST_BEHAVIOR, 0,
				host, sizeof(*host), NULL);
	kfree(host);
	return ret;
}

2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
/*
 * 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;
}

2281 2282 2283
/*
 * APST (Autonomous Power State Transition) lets us program a table of power
 * state transitions that the controller will perform automatically.
2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299
 *
 * 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.
2300 2301 2302 2303 2304 2305
 *
 * 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.
 */
2306
static int nvme_configure_apst(struct nvme_ctrl *ctrl)
2307 2308
{
	struct nvme_feat_auto_pst *table;
2309
	unsigned apste = 0;
2310
	u64 max_lat_us = 0;
2311
	__le64 target = 0;
2312
	int max_ps = -1;
2313
	int state;
2314
	int ret;
2315
	unsigned last_lt_index = UINT_MAX;
2316 2317 2318 2319 2320 2321

	/*
	 * If APST isn't supported or if we haven't been initialized yet,
	 * then don't do anything.
	 */
	if (!ctrl->apsta)
2322
		return 0;
2323 2324 2325

	if (ctrl->npss > 31) {
		dev_warn(ctrl->device, "NPSS is invalid; not using APST\n");
2326
		return 0;
2327 2328 2329 2330
	}

	table = kzalloc(sizeof(*table), GFP_KERNEL);
	if (!table)
2331
		return 0;
2332

2333
	if (!ctrl->apst_enabled || ctrl->ps_max_latency_us == 0) {
2334
		/* Turn off APST. */
2335
		dev_dbg(ctrl->device, "APST disabled\n");
2336 2337
		goto done;
	}
2338

2339 2340 2341 2342 2343 2344 2345 2346
	/*
	 * 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;
2347

2348 2349
		if (target)
			table->entries[state] = target;
2350 2351

		/*
2352 2353
		 * Don't allow transitions to the deepest state if it's quirked
		 * off.
2354
		 */
2355 2356 2357
		if (state == ctrl->npss &&
		    (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS))
			continue;
2358

2359 2360 2361 2362 2363 2364
		/*
		 * 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;
2365

2366 2367 2368
		exit_latency_us = (u64)le32_to_cpu(ctrl->psd[state].exit_lat);
		if (exit_latency_us > ctrl->ps_max_latency_us)
			continue;
2369

2370 2371
		total_latency_us = exit_latency_us +
			le32_to_cpu(ctrl->psd[state].entry_lat);
2372

2373
		/*
2374 2375
		 * This state is good. It can be used as the APST idle target
		 * for higher power states.
2376
		 */
2377 2378 2379 2380 2381 2382 2383 2384 2385 2386
		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;
		}
2387 2388 2389 2390 2391 2392

		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;
2393 2394
	}

2395 2396 2397 2398 2399 2400 2401 2402
	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:
2403 2404 2405 2406 2407
	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);
2408
	return ret;
2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
}

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;
2428 2429
		if (ctrl->state == NVME_CTRL_LIVE)
			nvme_configure_apst(ctrl);
2430 2431 2432
	}
}

2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445
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[] = {
2446
	{
2447 2448 2449 2450 2451 2452
		/*
		 * 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",
2453
		.quirks = NVME_QUIRK_NO_APST,
2454 2455 2456 2457 2458 2459 2460 2461 2462 2463
	},
	{
		/*
		 * 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,
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477
	},
	{
		/*
		 * 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,
2478
	}
2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509
};

/* 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 已提交
2510 2511
static void nvme_init_subnqn(struct nvme_subsystem *subsys, struct nvme_ctrl *ctrl,
		struct nvme_id_ctrl *id)
2512 2513 2514 2515
{
	size_t nqnlen;
	int off;

2516 2517 2518 2519 2520 2521
	if(!(ctrl->quirks & NVME_QUIRK_IGNORE_DEV_SUBNQN)) {
		nqnlen = strnlen(id->subnqn, NVMF_NQN_SIZE);
		if (nqnlen > 0 && nqnlen < NVMF_NQN_SIZE) {
			strlcpy(subsys->subnqn, id->subnqn, NVMF_NQN_SIZE);
			return;
		}
2522

2523 2524 2525
		if (ctrl->vs >= NVME_VS(1, 2, 1))
			dev_warn(ctrl->device, "missing or invalid SUBNQN field.\n");
	}
2526 2527

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

2538
static void nvme_release_subsystem(struct device *dev)
C
Christoph Hellwig 已提交
2539
{
2540 2541 2542
	struct nvme_subsystem *subsys =
		container_of(dev, struct nvme_subsystem, dev);

2543
	if (subsys->instance >= 0)
2544
		ida_free(&nvme_instance_ida, subsys->instance);
C
Christoph Hellwig 已提交
2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556
	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 已提交
2557
	ida_destroy(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572
	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);

2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583
	/*
	 * 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 已提交
2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594
	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;
}

2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605
#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);

2606
	return sysfs_emit(buf, "%s\n", subsys->subnqn);
2607 2608 2609
}
static SUBSYS_ATTR_RO(subsysnqn, S_IRUGO, nvme_subsys_show_nqn);

2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627
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);

2628 2629 2630 2631 2632 2633
#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);		\
2634 2635
	return sysfs_emit(buf, "%.*s\n",				\
			   (int)sizeof(subsys->field), subsys->field);	\
2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647
}									\
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,
2648
	&subsys_attr_subsystype.attr,
2649 2650 2651
#ifdef CONFIG_NVME_MULTIPATH
	&subsys_attr_iopolicy.attr,
#endif
2652 2653 2654
	NULL,
};

2655
static const struct attribute_group nvme_subsys_attrs_group = {
2656 2657 2658 2659 2660 2661 2662 2663
	.attrs = nvme_subsys_attrs,
};

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

2664 2665 2666 2667 2668
static inline bool nvme_discovery_ctrl(struct nvme_ctrl *ctrl)
{
	return ctrl->opts && ctrl->opts->discovery_nqn;
}

2669 2670
static bool nvme_validate_cntlid(struct nvme_subsystem *subsys,
		struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
2671
{
2672
	struct nvme_ctrl *tmp;
2673

2674 2675
	lockdep_assert_held(&nvme_subsystems_lock);

2676
	list_for_each_entry(tmp, &subsys->ctrls, subsys_entry) {
2677
		if (nvme_state_terminal(tmp))
2678 2679 2680 2681
			continue;

		if (tmp->cntlid == ctrl->cntlid) {
			dev_err(ctrl->device,
2682 2683 2684
				"Duplicate cntlid %u with %s, subsys %s, rejecting\n",
				ctrl->cntlid, dev_name(tmp->device),
				subsys->subnqn);
2685 2686
			return false;
		}
2687

2688
		if ((id->cmic & NVME_CTRL_CMIC_MULTI_CTRL) ||
2689
		    nvme_discovery_ctrl(ctrl))
2690 2691 2692 2693 2694
			continue;

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

2697
	return true;
2698 2699
}

C
Christoph Hellwig 已提交
2700 2701 2702 2703 2704 2705 2706 2707
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;
2708 2709

	subsys->instance = -1;
C
Christoph Hellwig 已提交
2710 2711 2712
	mutex_init(&subsys->lock);
	kref_init(&subsys->ref);
	INIT_LIST_HEAD(&subsys->ctrls);
C
Christoph Hellwig 已提交
2713
	INIT_LIST_HEAD(&subsys->nsheads);
C
Christoph Hellwig 已提交
2714 2715 2716 2717 2718 2719
	nvme_init_subnqn(subsys, ctrl, id);
	memcpy(subsys->serial, id->sn, sizeof(subsys->serial));
	memcpy(subsys->model, id->mn, sizeof(subsys->model));
	memcpy(subsys->firmware_rev, id->fr, sizeof(subsys->firmware_rev));
	subsys->vendor_id = le16_to_cpu(id->vid);
	subsys->cmic = id->cmic;
2720 2721 2722 2723 2724 2725 2726 2727

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

2728 2729 2730 2731 2732 2733 2734
	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;
	}
2735
	subsys->awupf = le16_to_cpu(id->awupf);
2736
	nvme_mpath_default_iopolicy(subsys);
C
Christoph Hellwig 已提交
2737 2738 2739

	subsys->dev.class = nvme_subsys_class;
	subsys->dev.release = nvme_release_subsystem;
2740
	subsys->dev.groups = nvme_subsys_attrs_groups;
2741
	dev_set_name(&subsys->dev, "nvme-subsys%d", ctrl->instance);
C
Christoph Hellwig 已提交
2742 2743 2744 2745 2746
	device_initialize(&subsys->dev);

	mutex_lock(&nvme_subsystems_lock);
	found = __nvme_find_get_subsystem(subsys->subnqn);
	if (found) {
2747
		put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2748
		subsys = found;
2749

2750
		if (!nvme_validate_cntlid(subsys, ctrl, id)) {
C
Christoph Hellwig 已提交
2751
			ret = -EINVAL;
2752
			goto out_put_subsystem;
C
Christoph Hellwig 已提交
2753 2754 2755 2756 2757 2758
		}
	} else {
		ret = device_add(&subsys->dev);
		if (ret) {
			dev_err(ctrl->device,
				"failed to register subsystem device.\n");
2759
			put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2760 2761
			goto out_unlock;
		}
C
Christoph Hellwig 已提交
2762
		ida_init(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2763 2764 2765
		list_add_tail(&subsys->entry, &nvme_subsystems);
	}

2766 2767 2768
	ret = sysfs_create_link(&subsys->dev.kobj, &ctrl->device->kobj,
				dev_name(ctrl->device));
	if (ret) {
C
Christoph Hellwig 已提交
2769 2770
		dev_err(ctrl->device,
			"failed to create sysfs link from subsystem.\n");
2771
		goto out_put_subsystem;
C
Christoph Hellwig 已提交
2772 2773
	}

2774 2775
	if (!found)
		subsys->instance = ctrl->instance;
2776
	ctrl->subsys = subsys;
C
Christoph Hellwig 已提交
2777
	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
2778
	mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
2779 2780
	return 0;

2781 2782
out_put_subsystem:
	nvme_put_subsystem(subsys);
C
Christoph Hellwig 已提交
2783 2784 2785
out_unlock:
	mutex_unlock(&nvme_subsystems_lock);
	return ret;
2786 2787
}

2788
int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
2789
		void *log, size_t size, u64 offset)
K
Keith Busch 已提交
2790 2791
{
	struct nvme_command c = { };
K
Keith Busch 已提交
2792
	u32 dwlen = nvme_bytes_to_numd(size);
2793 2794

	c.get_log_page.opcode = nvme_admin_get_log_page;
2795
	c.get_log_page.nsid = cpu_to_le32(nsid);
2796
	c.get_log_page.lid = log_page;
2797
	c.get_log_page.lsp = lsp;
2798 2799
	c.get_log_page.numdl = cpu_to_le16(dwlen & ((1 << 16) - 1));
	c.get_log_page.numdu = cpu_to_le16(dwlen >> 16);
2800 2801
	c.get_log_page.lpol = cpu_to_le32(lower_32_bits(offset));
	c.get_log_page.lpou = cpu_to_le32(upper_32_bits(offset));
2802
	c.get_log_page.csi = csi;
K
Keith Busch 已提交
2803 2804 2805 2806

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

2807 2808
static int nvme_get_effects_log(struct nvme_ctrl *ctrl, u8 csi,
				struct nvme_effects_log **log)
2809
{
2810
	struct nvme_effects_log	*cel = xa_load(&ctrl->cels, csi);
2811 2812
	int ret;

2813 2814
	if (cel)
		goto out;
2815

2816 2817 2818
	cel = kzalloc(sizeof(*cel), GFP_KERNEL);
	if (!cel)
		return -ENOMEM;
2819

2820
	ret = nvme_get_log(ctrl, 0x00, NVME_LOG_CMD_EFFECTS, 0, csi,
2821
			cel, sizeof(*cel), 0);
2822
	if (ret) {
2823 2824
		kfree(cel);
		return ret;
2825
	}
2826

2827
	xa_store(&ctrl->cels, csi, cel, GFP_KERNEL);
2828
out:
2829
	*log = cel;
2830
	return 0;
2831 2832
}

2833
static inline u32 nvme_mps_to_sectors(struct nvme_ctrl *ctrl, u32 units)
2834
{
2835
	u32 page_shift = NVME_CAP_MPSMIN(ctrl->cap) + 12, val;
2836

2837 2838 2839
	if (check_shl_overflow(1U, units + page_shift - 9, &val))
		return UINT_MAX;
	return val;
2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853
}

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;
2854
	}
2855

2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894
	/*
	 * Even though NVMe spec explicitly states that MDTS is not applicable
	 * to the write-zeroes, we are cautious and limit the size to the
	 * controllers max_hw_sectors value, which is based on the MDTS field
	 * and possibly other limiting factors.
	 */
	if ((ctrl->oncs & NVME_CTRL_ONCS_WRITE_ZEROES) &&
	    !(ctrl->quirks & NVME_QUIRK_DISABLE_WRITE_ZEROES))
		ctrl->max_zeroes_sectors = ctrl->max_hw_sectors;
	else
		ctrl->max_zeroes_sectors = 0;

	if (nvme_ctrl_limited_cns(ctrl))
		return 0;

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

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

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

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

free_data:
	kfree(id);
	return ret;
}

2895
static int nvme_init_identify(struct nvme_ctrl *ctrl)
2896 2897
{
	struct nvme_id_ctrl *id;
2898
	u32 max_hw_sectors;
2899
	bool prev_apst_enabled;
2900
	int ret;
2901

2902 2903
	ret = nvme_identify_ctrl(ctrl, &id);
	if (ret) {
2904
		dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret);
2905 2906 2907
		return -EIO;
	}

2908
	if (id->lpa & NVME_CTRL_LPA_CMD_EFFECTS_LOG) {
2909
		ret = nvme_get_effects_log(ctrl, NVME_CSI_NVM, &ctrl->effects);
2910
		if (ret < 0)
2911
			goto out_free;
2912
	}
2913

2914 2915 2916
	if (!(ctrl->ops->flags & NVME_F_FABRICS))
		ctrl->cntlid = le16_to_cpu(id->cntlid);

2917
	if (!ctrl->identified) {
2918
		unsigned int i;
C
Christoph Hellwig 已提交
2919 2920 2921 2922 2923

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

2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937
		/*
		 * 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;
		}
	}

2938
	if (force_apst && (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) {
2939
		dev_warn(ctrl->device, "forcibly allowing all power states due to nvme_core.force_apst -- use at your own risk\n");
2940 2941 2942
		ctrl->quirks &= ~NVME_QUIRK_NO_DEEPEST_PS;
	}

2943 2944 2945 2946
	ctrl->crdt[0] = le16_to_cpu(id->crdt1);
	ctrl->crdt[1] = le16_to_cpu(id->crdt2);
	ctrl->crdt[2] = le16_to_cpu(id->crdt3);

2947
	ctrl->oacs = le16_to_cpu(id->oacs);
2948
	ctrl->oncs = le16_to_cpu(id->oncs);
2949
	ctrl->mtfa = le16_to_cpu(id->mtfa);
2950
	ctrl->oaes = le32_to_cpu(id->oaes);
2951 2952 2953
	ctrl->wctemp = le16_to_cpu(id->wctemp);
	ctrl->cctemp = le16_to_cpu(id->cctemp);

2954
	atomic_set(&ctrl->abort_limit, id->acl + 1);
2955 2956
	ctrl->vwc = id->vwc;
	if (id->mdts)
2957
		max_hw_sectors = nvme_mps_to_sectors(ctrl, id->mdts);
2958
	else
2959 2960 2961
		max_hw_sectors = UINT_MAX;
	ctrl->max_hw_sectors =
		min_not_zero(ctrl->max_hw_sectors, max_hw_sectors);
2962

2963
	nvme_set_queue_limits(ctrl, ctrl->admin_q);
2964
	ctrl->sgls = le32_to_cpu(id->sgls);
S
Sagi Grimberg 已提交
2965
	ctrl->kas = le16_to_cpu(id->kas);
C
Christoph Hellwig 已提交
2966
	ctrl->max_namespaces = le32_to_cpu(id->mnan);
S
Sagi Grimberg 已提交
2967
	ctrl->ctratt = le32_to_cpu(id->ctratt);
2968

2969 2970 2971
	ctrl->cntrltype = id->cntrltype;
	ctrl->dctype = id->dctype;

2972 2973
	if (id->rtd3e) {
		/* us -> s */
2974
		u32 transition_time = le32_to_cpu(id->rtd3e) / USEC_PER_SEC;
2975 2976 2977 2978 2979

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

		if (ctrl->shutdown_timeout != shutdown_timeout)
2980
			dev_info(ctrl->device,
2981 2982 2983 2984 2985
				 "Shutdown timeout set to %u seconds\n",
				 ctrl->shutdown_timeout);
	} else
		ctrl->shutdown_timeout = shutdown_timeout;

2986
	ctrl->npss = id->npss;
2987 2988
	ctrl->apsta = id->apsta;
	prev_apst_enabled = ctrl->apst_enabled;
2989 2990
	if (ctrl->quirks & NVME_QUIRK_NO_APST) {
		if (force_apst && id->apsta) {
2991
			dev_warn(ctrl->device, "forcibly allowing APST due to nvme_core.force_apst -- use at your own risk\n");
2992
			ctrl->apst_enabled = true;
2993
		} else {
2994
			ctrl->apst_enabled = false;
2995 2996
		}
	} else {
2997
		ctrl->apst_enabled = id->apsta;
2998
	}
2999 3000
	memcpy(ctrl->psd, id->psd, sizeof(ctrl->psd));

3001
	if (ctrl->ops->flags & NVME_F_FABRICS) {
3002 3003 3004 3005 3006 3007 3008 3009 3010
		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
		 */
3011
		if (ctrl->cntlid != le16_to_cpu(id->cntlid)) {
3012 3013 3014 3015
			dev_err(ctrl->device,
				"Mismatching cntlid: Connect %u vs Identify "
				"%u, rejecting\n",
				ctrl->cntlid, le16_to_cpu(id->cntlid));
3016
			ret = -EINVAL;
3017 3018
			goto out_free;
		}
S
Sagi Grimberg 已提交
3019

3020
		if (!nvme_discovery_ctrl(ctrl) && !ctrl->kas) {
3021
			dev_err(ctrl->device,
S
Sagi Grimberg 已提交
3022 3023
				"keep-alive support is mandatory for fabrics\n");
			ret = -EINVAL;
3024
			goto out_free;
S
Sagi Grimberg 已提交
3025
		}
3026
	} else {
3027 3028
		ctrl->hmpre = le32_to_cpu(id->hmpre);
		ctrl->hmmin = le32_to_cpu(id->hmmin);
3029 3030
		ctrl->hmminds = le32_to_cpu(id->hmminds);
		ctrl->hmmaxd = le16_to_cpu(id->hmmaxd);
3031
	}
3032

3033
	ret = nvme_mpath_init_identify(ctrl, id);
C
Christoph Hellwig 已提交
3034
	if (ret < 0)
3035
		goto out_free;
C
Christoph Hellwig 已提交
3036

3037
	if (ctrl->apst_enabled && !prev_apst_enabled)
3038
		dev_pm_qos_expose_latency_tolerance(ctrl->device);
3039
	else if (!ctrl->apst_enabled && prev_apst_enabled)
3040 3041
		dev_pm_qos_hide_latency_tolerance(ctrl->device);

3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070
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;

3071 3072 3073 3074
	ret = nvme_init_non_mdts_limits(ctrl);
	if (ret < 0)
		return ret;

3075 3076 3077
	ret = nvme_configure_apst(ctrl);
	if (ret < 0)
		return ret;
3078

3079 3080 3081
	ret = nvme_configure_timestamp(ctrl);
	if (ret < 0)
		return ret;
3082

3083
	ret = nvme_configure_host_options(ctrl);
3084 3085 3086
	if (ret < 0)
		return ret;

3087
	if (!ctrl->identified && !nvme_discovery_ctrl(ctrl)) {
K
Keith Busch 已提交
3088 3089 3090 3091
		ret = nvme_hwmon_init(ctrl);
		if (ret < 0)
			return ret;
	}
3092

3093
	ctrl->identified = true;
3094

3095
	return 0;
3096
}
3097
EXPORT_SYMBOL_GPL(nvme_init_ctrl_finish);
3098

3099
static int nvme_dev_open(struct inode *inode, struct file *file)
3100
{
3101 3102
	struct nvme_ctrl *ctrl =
		container_of(inode->i_cdev, struct nvme_ctrl, cdev);
3103

3104 3105 3106 3107
	switch (ctrl->state) {
	case NVME_CTRL_LIVE:
		break;
	default:
3108
		return -EWOULDBLOCK;
3109 3110
	}

3111
	nvme_get_ctrl(ctrl);
3112 3113
	if (!try_module_get(ctrl->ops->module)) {
		nvme_put_ctrl(ctrl);
3114
		return -EINVAL;
3115
	}
3116

3117
	file->private_data = ctrl;
3118 3119 3120
	return 0;
}

3121 3122 3123 3124 3125 3126 3127 3128 3129 3130
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;
}

3131 3132 3133
static const struct file_operations nvme_dev_fops = {
	.owner		= THIS_MODULE,
	.open		= nvme_dev_open,
3134
	.release	= nvme_dev_release,
3135
	.unlocked_ioctl	= nvme_dev_ioctl,
3136
	.compat_ioctl	= compat_ptr_ioctl,
3137 3138 3139 3140 3141 3142 3143 3144 3145
};

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;

3146
	ret = nvme_reset_ctrl_sync(ctrl);
3147 3148 3149
	if (ret < 0)
		return ret;
	return count;
3150
}
3151
static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset);
3152

K
Keith Busch 已提交
3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163
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);

3164 3165 3166 3167
static inline struct nvme_ns_head *dev_to_ns_head(struct device *dev)
{
	struct gendisk *disk = dev_to_disk(dev);

J
Javier González 已提交
3168
	if (disk->fops == &nvme_bdev_ops)
3169 3170 3171 3172 3173
		return nvme_get_ns_from_dev(dev)->head;
	else
		return disk->private_data;
}

3174
static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
3175
		char *buf)
3176
{
3177 3178 3179
	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 已提交
3180 3181
	int serial_len = sizeof(subsys->serial);
	int model_len = sizeof(subsys->model);
3182

3183
	if (!uuid_is_null(&ids->uuid))
3184
		return sysfs_emit(buf, "uuid.%pU\n", &ids->uuid);
3185

3186
	if (memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3187
		return sysfs_emit(buf, "eui.%16phN\n", ids->nguid);
3188

3189
	if (memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3190
		return sysfs_emit(buf, "eui.%8phN\n", ids->eui64);
3191

C
Christoph Hellwig 已提交
3192 3193
	while (serial_len > 0 && (subsys->serial[serial_len - 1] == ' ' ||
				  subsys->serial[serial_len - 1] == '\0'))
3194
		serial_len--;
C
Christoph Hellwig 已提交
3195 3196
	while (model_len > 0 && (subsys->model[model_len - 1] == ' ' ||
				 subsys->model[model_len - 1] == '\0'))
3197 3198
		model_len--;

3199
	return sysfs_emit(buf, "nvme.%04x-%*phN-%*phN-%08x\n", subsys->vendor_id,
C
Christoph Hellwig 已提交
3200
		serial_len, subsys->serial, model_len, subsys->model,
3201
		head->ns_id);
3202
}
J
Joe Perches 已提交
3203
static DEVICE_ATTR_RO(wwid);
3204

3205
static ssize_t nguid_show(struct device *dev, struct device_attribute *attr,
3206
		char *buf)
3207
{
3208
	return sysfs_emit(buf, "%pU\n", dev_to_ns_head(dev)->ids.nguid);
3209
}
J
Joe Perches 已提交
3210
static DEVICE_ATTR_RO(nguid);
3211

3212
static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
3213
		char *buf)
3214
{
3215
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3216 3217 3218 3219

	/* For backward compatibility expose the NGUID to userspace if
	 * we have no UUID set
	 */
3220
	if (uuid_is_null(&ids->uuid)) {
3221 3222
		printk_ratelimited(KERN_WARNING
				   "No UUID available providing old NGUID\n");
3223
		return sysfs_emit(buf, "%pU\n", ids->nguid);
3224
	}
3225
	return sysfs_emit(buf, "%pU\n", &ids->uuid);
3226
}
J
Joe Perches 已提交
3227
static DEVICE_ATTR_RO(uuid);
3228 3229

static ssize_t eui_show(struct device *dev, struct device_attribute *attr,
3230
		char *buf)
3231
{
3232
	return sysfs_emit(buf, "%8ph\n", dev_to_ns_head(dev)->ids.eui64);
3233
}
J
Joe Perches 已提交
3234
static DEVICE_ATTR_RO(eui);
3235 3236

static ssize_t nsid_show(struct device *dev, struct device_attribute *attr,
3237
		char *buf)
3238
{
3239
	return sysfs_emit(buf, "%d\n", dev_to_ns_head(dev)->ns_id);
3240
}
J
Joe Perches 已提交
3241
static DEVICE_ATTR_RO(nsid);
3242

3243
static struct attribute *nvme_ns_id_attrs[] = {
3244
	&dev_attr_wwid.attr,
3245
	&dev_attr_uuid.attr,
3246
	&dev_attr_nguid.attr,
3247 3248
	&dev_attr_eui.attr,
	&dev_attr_nsid.attr,
C
Christoph Hellwig 已提交
3249 3250 3251 3252
#ifdef CONFIG_NVME_MULTIPATH
	&dev_attr_ana_grpid.attr,
	&dev_attr_ana_state.attr,
#endif
3253 3254 3255
	NULL,
};

3256
static umode_t nvme_ns_id_attrs_are_visible(struct kobject *kobj,
3257 3258 3259
		struct attribute *a, int n)
{
	struct device *dev = container_of(kobj, struct device, kobj);
3260
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3261 3262

	if (a == &dev_attr_uuid.attr) {
3263
		if (uuid_is_null(&ids->uuid) &&
3264
		    !memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3265 3266 3267
			return 0;
	}
	if (a == &dev_attr_nguid.attr) {
3268
		if (!memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3269 3270 3271
			return 0;
	}
	if (a == &dev_attr_eui.attr) {
3272
		if (!memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3273 3274
			return 0;
	}
C
Christoph Hellwig 已提交
3275 3276
#ifdef CONFIG_NVME_MULTIPATH
	if (a == &dev_attr_ana_grpid.attr || a == &dev_attr_ana_state.attr) {
J
Javier González 已提交
3277
		if (dev_to_disk(dev)->fops != &nvme_bdev_ops) /* per-path attr */
C
Christoph Hellwig 已提交
3278 3279 3280 3281 3282
			return 0;
		if (!nvme_ctrl_use_ana(nvme_get_ns_from_dev(dev)->ctrl))
			return 0;
	}
#endif
3283 3284 3285
	return a->mode;
}

3286
static const struct attribute_group nvme_ns_id_attr_group = {
3287 3288
	.attrs		= nvme_ns_id_attrs,
	.is_visible	= nvme_ns_id_attrs_are_visible,
3289 3290
};

3291 3292 3293 3294 3295
const struct attribute_group *nvme_ns_id_attr_groups[] = {
	&nvme_ns_id_attr_group,
	NULL,
};

M
Ming Lin 已提交
3296
#define nvme_show_str_function(field)						\
3297 3298 3299 3300
static ssize_t  field##_show(struct device *dev,				\
			    struct device_attribute *attr, char *buf)		\
{										\
        struct nvme_ctrl *ctrl = dev_get_drvdata(dev);				\
3301
        return sysfs_emit(buf, "%.*s\n",					\
C
Christoph Hellwig 已提交
3302
		(int)sizeof(ctrl->subsys->field), ctrl->subsys->field);		\
3303 3304 3305
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

C
Christoph Hellwig 已提交
3306 3307 3308 3309
nvme_show_str_function(model);
nvme_show_str_function(serial);
nvme_show_str_function(firmware_rev);

M
Ming Lin 已提交
3310 3311 3312 3313 3314
#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);				\
3315
        return sysfs_emit(buf, "%d\n", ctrl->field);				\
M
Ming Lin 已提交
3316 3317 3318 3319
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

nvme_show_int_function(cntlid);
3320
nvme_show_int_function(numa_node);
3321 3322
nvme_show_int_function(queue_count);
nvme_show_int_function(sqsize);
3323
nvme_show_int_function(kato);
3324

M
Ming Lin 已提交
3325 3326 3327 3328 3329 3330 3331
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))
3332
		nvme_delete_ctrl_sync(ctrl);
M
Ming Lin 已提交
3333 3334 3335 3336 3337 3338 3339 3340 3341 3342
	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);

3343
	return sysfs_emit(buf, "%s\n", ctrl->ops->name);
M
Ming Lin 已提交
3344 3345 3346
}
static DEVICE_ATTR(transport, S_IRUGO, nvme_sysfs_show_transport, NULL);

3347 3348 3349 3350 3351 3352 3353 3354 3355
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",
3356
		[NVME_CTRL_CONNECTING]	= "connecting",
3357
		[NVME_CTRL_DELETING]	= "deleting",
3358
		[NVME_CTRL_DELETING_NOIO]= "deleting (no IO)",
3359 3360 3361 3362 3363
		[NVME_CTRL_DEAD]	= "dead",
	};

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

3366
	return sysfs_emit(buf, "unknown state\n");
3367 3368 3369 3370
}

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

M
Ming Lin 已提交
3371 3372 3373 3374 3375 3376
static ssize_t nvme_sysfs_show_subsysnqn(struct device *dev,
					 struct device_attribute *attr,
					 char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3377
	return sysfs_emit(buf, "%s\n", ctrl->subsys->subnqn);
M
Ming Lin 已提交
3378 3379 3380
}
static DEVICE_ATTR(subsysnqn, S_IRUGO, nvme_sysfs_show_subsysnqn, NULL);

3381 3382 3383 3384 3385 3386
static ssize_t nvme_sysfs_show_hostnqn(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3387
	return sysfs_emit(buf, "%s\n", ctrl->opts->host->nqn);
3388 3389 3390
}
static DEVICE_ATTR(hostnqn, S_IRUGO, nvme_sysfs_show_hostnqn, NULL);

3391 3392 3393 3394 3395 3396
static ssize_t nvme_sysfs_show_hostid(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3397
	return sysfs_emit(buf, "%pU\n", &ctrl->opts->host->id);
3398 3399 3400
}
static DEVICE_ATTR(hostid, S_IRUGO, nvme_sysfs_show_hostid, NULL);

M
Ming Lin 已提交
3401 3402 3403 3404 3405 3406 3407 3408 3409 3410
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);

3411 3412 3413 3414 3415 3416 3417
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)
3418 3419 3420
		return sysfs_emit(buf, "off\n");
	return sysfs_emit(buf, "%d\n",
			  opts->max_reconnects * opts->reconnect_delay);
3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433
}

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;

3434
	if (ctrl_loss_tmo < 0)
3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449
		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)
3450 3451
		return sysfs_emit(buf, "off\n");
	return sysfs_emit(buf, "%d\n", ctrl->opts->reconnect_delay);
3452 3453 3454 3455 3456 3457 3458 3459 3460 3461
}

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);
3462 3463
	if (err)
		return err;
3464 3465 3466 3467 3468 3469 3470

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

3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500
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);

3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534
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);

3535 3536
static struct attribute *nvme_dev_attrs[] = {
	&dev_attr_reset_controller.attr,
K
Keith Busch 已提交
3537
	&dev_attr_rescan_controller.attr,
3538 3539 3540
	&dev_attr_model.attr,
	&dev_attr_serial.attr,
	&dev_attr_firmware_rev.attr,
M
Ming Lin 已提交
3541
	&dev_attr_cntlid.attr,
M
Ming Lin 已提交
3542 3543 3544 3545
	&dev_attr_delete_controller.attr,
	&dev_attr_transport.attr,
	&dev_attr_subsysnqn.attr,
	&dev_attr_address.attr,
3546
	&dev_attr_state.attr,
3547
	&dev_attr_numa_node.attr,
3548 3549
	&dev_attr_queue_count.attr,
	&dev_attr_sqsize.attr,
3550
	&dev_attr_hostnqn.attr,
3551
	&dev_attr_hostid.attr,
3552 3553
	&dev_attr_ctrl_loss_tmo.attr,
	&dev_attr_reconnect_delay.attr,
3554
	&dev_attr_fast_io_fail_tmo.attr,
3555
	&dev_attr_kato.attr,
3556 3557
	&dev_attr_cntrltype.attr,
	&dev_attr_dctype.attr,
3558 3559 3560
	NULL
};

M
Ming Lin 已提交
3561 3562 3563 3564 3565 3566
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);

3567 3568 3569 3570
	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;
3571 3572
	if (a == &dev_attr_hostnqn.attr && !ctrl->opts)
		return 0;
3573 3574
	if (a == &dev_attr_hostid.attr && !ctrl->opts)
		return 0;
3575 3576 3577 3578
	if (a == &dev_attr_ctrl_loss_tmo.attr && !ctrl->opts)
		return 0;
	if (a == &dev_attr_reconnect_delay.attr && !ctrl->opts)
		return 0;
3579 3580
	if (a == &dev_attr_fast_io_fail_tmo.attr && !ctrl->opts)
		return 0;
M
Ming Lin 已提交
3581 3582 3583 3584

	return a->mode;
}

3585
static const struct attribute_group nvme_dev_attrs_group = {
M
Ming Lin 已提交
3586 3587
	.attrs		= nvme_dev_attrs,
	.is_visible	= nvme_dev_attrs_are_visible,
3588 3589 3590 3591 3592 3593 3594
};

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

3595
static struct nvme_ns_head *nvme_find_ns_head(struct nvme_ctrl *ctrl,
C
Christoph Hellwig 已提交
3596 3597 3598 3599
		unsigned nsid)
{
	struct nvme_ns_head *h;

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

3602 3603 3604 3605 3606 3607 3608
	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))
3609 3610
			continue;
		if (!list_empty(&h->list) && nvme_tryget_ns_head(h))
C
Christoph Hellwig 已提交
3611 3612 3613 3614 3615 3616
			return h;
	}

	return NULL;
}

3617 3618
static int nvme_subsys_check_duplicate_ids(struct nvme_subsystem *subsys,
		struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
3619
{
3620 3621 3622
	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 已提交
3623 3624 3625 3626 3627
	struct nvme_ns_head *h;

	lockdep_assert_held(&subsys->lock);

	list_for_each_entry(h, &subsys->nsheads, entry) {
3628 3629 3630 3631 3632 3633 3634
		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 已提交
3635 3636 3637 3638 3639 3640
			return -EINVAL;
	}

	return 0;
}

3641 3642
static void nvme_cdev_rel(struct device *dev)
{
3643
	ida_free(&nvme_ns_chr_minor_ida, MINOR(dev->devt));
3644 3645
}

3646 3647 3648
void nvme_cdev_del(struct cdev *cdev, struct device *cdev_device)
{
	cdev_device_del(cdev, cdev_device);
3649
	put_device(cdev_device);
3650 3651 3652 3653 3654 3655 3656
}

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

3657
	minor = ida_alloc(&nvme_ns_chr_minor_ida, GFP_KERNEL);
3658 3659 3660 3661
	if (minor < 0)
		return minor;
	cdev_device->devt = MKDEV(MAJOR(nvme_ns_chr_devt), minor);
	cdev_device->class = nvme_ns_chr_class;
3662
	cdev_device->release = nvme_cdev_rel;
3663 3664 3665 3666
	device_initialize(cdev_device);
	cdev_init(cdev, fops);
	cdev->owner = owner;
	ret = cdev_device_add(cdev, cdev_device);
3667
	if (ret)
3668
		put_device(cdev_device);
3669

3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700
	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,
};

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;
3701 3702 3703

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

C
Christoph Hellwig 已提交
3706
static struct nvme_ns_head *nvme_alloc_ns_head(struct nvme_ctrl *ctrl,
K
Keith Busch 已提交
3707
		unsigned nsid, struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
3708 3709
{
	struct nvme_ns_head *head;
3710
	size_t size = sizeof(*head);
C
Christoph Hellwig 已提交
3711 3712
	int ret = -ENOMEM;

3713 3714 3715 3716 3717
#ifdef CONFIG_NVME_MULTIPATH
	size += num_possible_nodes() * sizeof(struct nvme_ns *);
#endif

	head = kzalloc(size, GFP_KERNEL);
C
Christoph Hellwig 已提交
3718 3719
	if (!head)
		goto out;
3720
	ret = ida_alloc_min(&ctrl->subsys->ns_ida, 1, GFP_KERNEL);
C
Christoph Hellwig 已提交
3721 3722 3723 3724
	if (ret < 0)
		goto out_free_head;
	head->instance = ret;
	INIT_LIST_HEAD(&head->list);
3725 3726 3727
	ret = init_srcu_struct(&head->srcu);
	if (ret)
		goto out_ida_remove;
C
Christoph Hellwig 已提交
3728 3729
	head->subsys = ctrl->subsys;
	head->ns_id = nsid;
3730
	head->ids = *ids;
C
Christoph Hellwig 已提交
3731 3732
	kref_init(&head->ref);

3733 3734 3735 3736 3737 3738 3739
	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;

3740 3741 3742 3743
	ret = nvme_mpath_alloc_disk(ctrl, head);
	if (ret)
		goto out_cleanup_srcu;

C
Christoph Hellwig 已提交
3744
	list_add_tail(&head->entry, &ctrl->subsys->nsheads);
3745 3746 3747

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

C
Christoph Hellwig 已提交
3748 3749 3750
	return head;
out_cleanup_srcu:
	cleanup_srcu_struct(&head->srcu);
3751
out_ida_remove:
3752
	ida_free(&ctrl->subsys->ns_ida, head->instance);
C
Christoph Hellwig 已提交
3753 3754 3755
out_free_head:
	kfree(head);
out:
3756 3757
	if (ret > 0)
		ret = blk_status_to_errno(nvme_error_status(ret));
C
Christoph Hellwig 已提交
3758 3759 3760
	return ERR_PTR(ret);
}

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

C
Christoph Hellwig 已提交
3787
static int nvme_init_ns_head(struct nvme_ns *ns, unsigned nsid,
3788
		struct nvme_ns_ids *ids, bool is_shared)
C
Christoph Hellwig 已提交
3789 3790 3791
{
	struct nvme_ctrl *ctrl = ns->ctrl;
	struct nvme_ns_head *head = NULL;
3792 3793 3794 3795 3796 3797 3798 3799
	int ret;

	ret = nvme_global_check_duplicate_ids(ctrl->subsys, ids);
	if (ret) {
		dev_err(ctrl->device,
			"globally duplicate IDs for nsid %d\n", nsid);
		return ret;
	}
C
Christoph Hellwig 已提交
3800 3801

	mutex_lock(&ctrl->subsys->lock);
3802
	head = nvme_find_ns_head(ctrl, nsid);
C
Christoph Hellwig 已提交
3803
	if (!head) {
3804 3805 3806
		ret = nvme_subsys_check_duplicate_ids(ctrl->subsys, ids);
		if (ret) {
			dev_err(ctrl->device,
3807 3808
				"duplicate IDs in subsystem for nsid %d\n",
				nsid);
3809 3810
			goto out_unlock;
		}
3811
		head = nvme_alloc_ns_head(ctrl, nsid, ids);
C
Christoph Hellwig 已提交
3812 3813 3814 3815
		if (IS_ERR(head)) {
			ret = PTR_ERR(head);
			goto out_unlock;
		}
3816
		head->shared = is_shared;
C
Christoph Hellwig 已提交
3817
	} else {
3818
		ret = -EINVAL;
3819
		if (!is_shared || !head->shared) {
3820
			dev_err(ctrl->device,
3821 3822
				"Duplicate unshared namespace %d\n", nsid);
			goto out_put_ns_head;
3823
		}
3824
		if (!nvme_ns_ids_equal(&head->ids, ids)) {
C
Christoph Hellwig 已提交
3825 3826 3827
			dev_err(ctrl->device,
				"IDs don't match for shared namespace %d\n",
					nsid);
3828
			goto out_put_ns_head;
C
Christoph Hellwig 已提交
3829
		}
3830 3831 3832 3833 3834 3835 3836 3837

		if (!multipath && !list_empty(&head->list)) {
			dev_warn(ctrl->device,
				"Found shared namespace %d, but multipathing not supported.\n",
				nsid);
			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 已提交
3838 3839
	}

3840
	list_add_tail_rcu(&ns->siblings, &head->list);
C
Christoph Hellwig 已提交
3841
	ns->head = head;
3842 3843
	mutex_unlock(&ctrl->subsys->lock);
	return 0;
C
Christoph Hellwig 已提交
3844

3845 3846
out_put_ns_head:
	nvme_put_ns_head(head);
C
Christoph Hellwig 已提交
3847 3848 3849 3850 3851
out_unlock:
	mutex_unlock(&ctrl->subsys->lock);
	return ret;
}

3852
struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid)
3853
{
3854
	struct nvme_ns *ns, *ret = NULL;
3855

3856
	down_read(&ctrl->namespaces_rwsem);
3857
	list_for_each_entry(ns, &ctrl->namespaces, list) {
C
Christoph Hellwig 已提交
3858
		if (ns->head->ns_id == nsid) {
K
Kanchan Joshi 已提交
3859
			if (!nvme_get_ns(ns))
3860
				continue;
3861 3862 3863
			ret = ns;
			break;
		}
C
Christoph Hellwig 已提交
3864
		if (ns->head->ns_id > nsid)
3865 3866
			break;
	}
3867
	up_read(&ctrl->namespaces_rwsem);
3868
	return ret;
3869
}
3870
EXPORT_SYMBOL_NS_GPL(nvme_find_get_ns, NVME_TARGET_PASSTHRU);
3871

3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887
/*
 * 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);
}

3888 3889
static void nvme_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid,
		struct nvme_ns_ids *ids)
3890 3891 3892
{
	struct nvme_ns *ns;
	struct gendisk *disk;
3893
	struct nvme_id_ns *id;
3894
	int node = ctrl->numa_node;
3895

3896
	if (nvme_identify_ns(ctrl, nsid, ids, &id))
3897 3898
		return;

3899 3900
	ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
	if (!ns)
3901
		goto out_free_id;
3902

C
Christoph Hellwig 已提交
3903 3904
	disk = blk_mq_alloc_disk(ctrl->tagset, ns);
	if (IS_ERR(disk))
C
Christoph Hellwig 已提交
3905
		goto out_free_ns;
C
Christoph Hellwig 已提交
3906 3907 3908 3909 3910
	disk->fops = &nvme_bdev_ops;
	disk->private_data = ns;

	ns->disk = disk;
	ns->queue = disk->queue;
3911

3912
	if (ctrl->opts && ctrl->opts->data_digest)
3913
		blk_queue_flag_set(QUEUE_FLAG_STABLE_WRITES, ns->queue);
3914

3915
	blk_queue_flag_set(QUEUE_FLAG_NONROT, ns->queue);
3916 3917 3918
	if (ctrl->ops->flags & NVME_F_PCI_P2PDMA)
		blk_queue_flag_set(QUEUE_FLAG_PCI_P2PDMA, ns->queue);

3919 3920 3921
	ns->ctrl = ctrl;
	kref_init(&ns->kref);

3922
	if (nvme_init_ns_head(ns, nsid, ids, id->nmic & NVME_NS_NMIC_SHARED))
C
Christoph Hellwig 已提交
3923
		goto out_cleanup_disk;
3924

3925
	/*
3926 3927 3928 3929 3930 3931 3932 3933 3934
	 * 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.
3935
	 */
3936 3937 3938 3939 3940 3941 3942 3943
	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 {
3944 3945
		sprintf(disk->disk_name, "nvme%dn%d", ctrl->instance,
			ns->head->instance);
3946
	}
3947

3948
	if (nvme_update_ns_info(ns, id))
C
Christoph Hellwig 已提交
3949
		goto out_unlink_ns;
3950

3951
	down_write(&ctrl->namespaces_rwsem);
3952
	nvme_ns_add_to_ctrl_list(ns);
3953
	up_write(&ctrl->namespaces_rwsem);
3954
	nvme_get_ctrl(ctrl);
3955

3956 3957 3958
	if (device_add_disk(ctrl->device, ns->disk, nvme_ns_id_attr_groups))
		goto out_cleanup_ns_from_list;

3959 3960
	if (!nvme_ns_head_multipath(ns->head))
		nvme_add_ns_cdev(ns);
3961

C
Christoph Hellwig 已提交
3962
	nvme_mpath_add_disk(ns, id);
3963
	nvme_fault_inject_init(&ns->fault_inject, ns->disk->disk_name);
C
Christoph Hellwig 已提交
3964 3965
	kfree(id);

3966
	return;
C
Christoph Hellwig 已提交
3967

3968 3969 3970 3971 3972
 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 已提交
3973 3974 3975
 out_unlink_ns:
	mutex_lock(&ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
3976 3977
	if (list_empty(&ns->head->list))
		list_del_init(&ns->head->entry);
C
Christoph Hellwig 已提交
3978
	mutex_unlock(&ctrl->subsys->lock);
3979
	nvme_put_ns_head(ns->head);
C
Christoph Hellwig 已提交
3980 3981
 out_cleanup_disk:
	blk_cleanup_disk(disk);
3982 3983
 out_free_ns:
	kfree(ns);
3984 3985
 out_free_id:
	kfree(id);
3986 3987 3988 3989
}

static void nvme_ns_remove(struct nvme_ns *ns)
{
3990 3991
	bool last_path = false;

3992 3993
	if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
		return;
3994

3995
	clear_bit(NVME_NS_READY, &ns->flags);
3996
	set_capacity(ns->disk, 0);
3997
	nvme_fault_inject_fini(&ns->fault_inject);
3998

3999 4000 4001 4002 4003 4004 4005 4006 4007 4008
	/*
	 * 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);

4009 4010
	mutex_lock(&ns->ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
4011 4012 4013 4014
	if (list_empty(&ns->head->list)) {
		list_del_init(&ns->head->entry);
		last_path = true;
	}
4015
	mutex_unlock(&ns->ctrl->subsys->lock);
4016

4017 4018 4019
	/* guarantee not available in head->list */
	synchronize_rcu();

4020 4021 4022 4023
	if (!nvme_ns_head_multipath(ns->head))
		nvme_cdev_del(&ns->cdev, &ns->cdev_device);
	del_gendisk(ns->disk);
	blk_cleanup_queue(ns->queue);
4024

4025
	down_write(&ns->ctrl->namespaces_rwsem);
4026
	list_del_init(&ns->list);
4027
	up_write(&ns->ctrl->namespaces_rwsem);
4028

4029 4030
	if (last_path)
		nvme_mpath_shutdown_disk(ns->head);
4031 4032 4033
	nvme_put_ns(ns);
}

4034 4035 4036 4037 4038 4039 4040 4041 4042 4043
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);
	}
}

4044
static void nvme_validate_ns(struct nvme_ns *ns, struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
4045 4046
{
	struct nvme_id_ns *id;
4047
	int ret = NVME_SC_INVALID_NS | NVME_SC_DNR;
C
Christoph Hellwig 已提交
4048

4049 4050
	if (test_bit(NVME_NS_DEAD, &ns->flags))
		goto out;
C
Christoph Hellwig 已提交
4051

4052
	ret = nvme_identify_ns(ns->ctrl, ns->head->ns_id, ids, &id);
C
Christoph Hellwig 已提交
4053 4054 4055
	if (ret)
		goto out;

4056
	ret = NVME_SC_INVALID_NS | NVME_SC_DNR;
C
Christoph Hellwig 已提交
4057
	if (!nvme_ns_ids_equal(&ns->head->ids, ids)) {
4058
		dev_err(ns->ctrl->device,
C
Christoph Hellwig 已提交
4059
			"identifiers changed for nsid %d\n", ns->head->ns_id);
4060
		goto out_free_id;
C
Christoph Hellwig 已提交
4061 4062 4063
	}

	ret = nvme_update_ns_info(ns, id);
4064 4065

out_free_id:
C
Christoph Hellwig 已提交
4066 4067 4068
	kfree(id);
out:
	/*
4069
	 * Only remove the namespace if we got a fatal error back from the
C
Christoph Hellwig 已提交
4070
	 * device, otherwise ignore the error and just move on.
4071 4072
	 *
	 * TODO: we should probably schedule a delayed retry here.
C
Christoph Hellwig 已提交
4073
	 */
4074
	if (ret > 0 && (ret & NVME_SC_DNR))
4075
		nvme_ns_remove(ns);
C
Christoph Hellwig 已提交
4076 4077
}

4078
static void nvme_validate_or_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid)
4079
{
4080
	struct nvme_ns_ids ids = { };
4081 4082
	struct nvme_ns *ns;

4083 4084
	if (nvme_identify_ns_descs(ctrl, nsid, &ids))
		return;
4085

4086
	ns = nvme_find_get_ns(ctrl, nsid);
4087
	if (ns) {
4088
		nvme_validate_ns(ns, &ids);
4089
		nvme_put_ns(ns);
4090 4091 4092
		return;
	}

4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103
	switch (ids.csi) {
	case NVME_CSI_NVM:
		nvme_alloc_ns(ctrl, nsid, &ids);
		break;
	case NVME_CSI_ZNS:
		if (!IS_ENABLED(CONFIG_BLK_DEV_ZONED)) {
			dev_warn(ctrl->device,
				"nsid %u not supported without CONFIG_BLK_DEV_ZONED\n",
				nsid);
			break;
		}
4104 4105 4106
		if (!nvme_multi_css(ctrl)) {
			dev_warn(ctrl->device,
				"command set not reported for nsid: %d\n",
4107
				nsid);
4108 4109
			break;
		}
4110 4111 4112 4113 4114 4115 4116
		nvme_alloc_ns(ctrl, nsid, &ids);
		break;
	default:
		dev_warn(ctrl->device, "unknown csi %u for nsid %u\n",
			ids.csi, nsid);
		break;
	}
4117 4118
}

4119 4120 4121 4122
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					unsigned nsid)
{
	struct nvme_ns *ns, *next;
4123
	LIST_HEAD(rm_list);
4124

4125
	down_write(&ctrl->namespaces_rwsem);
4126
	list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) {
4127
		if (ns->head->ns_id > nsid || test_bit(NVME_NS_DEAD, &ns->flags))
4128
			list_move_tail(&ns->list, &rm_list);
4129
	}
4130
	up_write(&ctrl->namespaces_rwsem);
4131 4132 4133 4134

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

4135 4136
}

4137
static int nvme_scan_ns_list(struct nvme_ctrl *ctrl)
4138
{
4139
	const int nr_entries = NVME_IDENTIFY_DATA_SIZE / sizeof(__le32);
4140
	__le32 *ns_list;
4141 4142
	u32 prev = 0;
	int ret = 0, i;
4143

4144 4145
	if (nvme_ctrl_limited_cns(ctrl))
		return -EOPNOTSUPP;
4146

4147
	ns_list = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
4148 4149 4150
	if (!ns_list)
		return -ENOMEM;

4151
	for (;;) {
4152 4153 4154 4155 4156 4157 4158 4159
		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);
4160 4161 4162
		if (ret) {
			dev_warn(ctrl->device,
				"Identify NS List failed (status=0x%x)\n", ret);
4163
			goto free;
4164
		}
4165

4166
		for (i = 0; i < nr_entries; i++) {
4167
			u32 nsid = le32_to_cpu(ns_list[i]);
4168

4169 4170
			if (!nsid)	/* end of the list? */
				goto out;
4171
			nvme_validate_or_alloc_ns(ctrl, nsid);
4172 4173
			while (++prev < nsid)
				nvme_ns_remove_by_nsid(ctrl, prev);
4174 4175 4176
		}
	}
 out:
4177 4178
	nvme_remove_invalid_namespaces(ctrl, prev);
 free:
4179 4180 4181 4182
	kfree(ns_list);
	return ret;
}

4183
static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl)
4184
{
4185 4186 4187 4188 4189 4190 4191
	struct nvme_id_ctrl *id;
	u32 nn, i;

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

4193
	for (i = 1; i <= nn; i++)
4194
		nvme_validate_or_alloc_ns(ctrl, i);
4195

4196
	nvme_remove_invalid_namespaces(ctrl, nn);
4197 4198
}

4199
static void nvme_clear_changed_ns_log(struct nvme_ctrl *ctrl)
4200 4201 4202
{
	size_t log_size = NVME_MAX_CHANGED_NAMESPACES * sizeof(__le32);
	__le32 *log;
4203
	int error;
4204 4205 4206

	log = kzalloc(log_size, GFP_KERNEL);
	if (!log)
4207
		return;
4208

4209 4210 4211 4212 4213 4214
	/*
	 * 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.
	 */
4215 4216
	error = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CHANGED_NS, 0,
			NVME_CSI_NVM, log, log_size, 0);
4217
	if (error)
4218 4219 4220 4221 4222 4223
		dev_warn(ctrl->device,
			"reading changed ns log failed: %d\n", error);

	kfree(log);
}

4224
static void nvme_scan_work(struct work_struct *work)
4225
{
4226 4227
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, scan_work);
4228

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

D
Dan Carpenter 已提交
4233
	if (test_and_clear_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events)) {
4234
		dev_info(ctrl->device, "rescanning namespaces.\n");
4235
		nvme_clear_changed_ns_log(ctrl);
4236 4237
	}

4238
	mutex_lock(&ctrl->scan_lock);
4239 4240
	if (nvme_scan_ns_list(ctrl) != 0)
		nvme_scan_ns_sequential(ctrl);
4241
	mutex_unlock(&ctrl->scan_lock);
4242
}
4243

4244 4245 4246 4247 4248
/*
 * 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.
 */
4249 4250 4251
void nvme_remove_namespaces(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns, *next;
4252
	LIST_HEAD(ns_list);
4253

4254 4255 4256 4257 4258 4259 4260
	/*
	 * 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);

4261 4262 4263
	/* prevent racing with ns scanning */
	flush_work(&ctrl->scan_work);

4264 4265 4266 4267 4268 4269 4270 4271 4272
	/*
	 * 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);

4273 4274 4275
	/* this is a no-op when called from the controller reset handler */
	nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING_NOIO);

4276
	down_write(&ctrl->namespaces_rwsem);
4277
	list_splice_init(&ctrl->namespaces, &ns_list);
4278
	up_write(&ctrl->namespaces_rwsem);
4279 4280

	list_for_each_entry_safe(ns, next, &ns_list, list)
4281 4282
		nvme_ns_remove(ns);
}
4283
EXPORT_SYMBOL_GPL(nvme_remove_namespaces);
4284

4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307
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");
4308 4309 4310 4311 4312
		if (ret)
			return ret;

		ret = add_uevent_var(env, "NVME_HOST_IFACE=%s",
				opts->host_iface ?: "none");
4313 4314 4315 4316
	}
	return ret;
}

4317 4318 4319 4320 4321 4322 4323
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);
}

4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339
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]);
}

4340 4341 4342 4343 4344
static void nvme_async_event_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, async_event_work);

4345
	nvme_aen_uevent(ctrl);
4346 4347 4348 4349 4350 4351 4352 4353

	/*
	 * 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);
4354 4355
}

4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377
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;

4378 4379
	if (nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_FW_SLOT, 0, NVME_CSI_NVM,
			log, sizeof(*log), 0))
4380
		dev_warn(ctrl->device, "Get FW SLOT INFO log error\n");
4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401
	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");
4402 4403
			nvme_try_sched_reset(ctrl);
			return;
4404 4405 4406 4407
		}
		msleep(100);
	}

4408
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE))
4409 4410 4411
		return;

	nvme_start_queues(ctrl);
4412
	/* read FW slot information to clear the AER */
4413 4414 4415
	nvme_get_fw_slot_info(ctrl);
}

4416 4417
static void nvme_handle_aen_notice(struct nvme_ctrl *ctrl, u32 result)
{
4418 4419
	u32 aer_notice_type = (result & 0xff00) >> 8;

4420 4421
	trace_nvme_async_event(ctrl, aer_notice_type);

4422
	switch (aer_notice_type) {
4423
	case NVME_AER_NOTICE_NS_CHANGED:
D
Dan Carpenter 已提交
4424
		set_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events);
4425 4426 4427
		nvme_queue_scan(ctrl);
		break;
	case NVME_AER_NOTICE_FW_ACT_STARTING:
4428 4429 4430 4431 4432 4433 4434
		/*
		 * We are (ab)using the RESETTING state to prevent subsequent
		 * recovery actions from interfering with the controller's
		 * firmware activation.
		 */
		if (nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
			queue_work(nvme_wq, &ctrl->fw_act_work);
4435
		break;
C
Christoph Hellwig 已提交
4436 4437 4438 4439 4440 4441 4442
#ifdef CONFIG_NVME_MULTIPATH
	case NVME_AER_NOTICE_ANA:
		if (!ctrl->ana_log_buf)
			break;
		queue_work(nvme_wq, &ctrl->ana_work);
		break;
#endif
4443 4444 4445
	case NVME_AER_NOTICE_DISC_CHANGED:
		ctrl->aen_result = result;
		break;
4446 4447 4448 4449 4450
	default:
		dev_warn(ctrl->device, "async event result %08x\n", result);
	}
}

4451
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
4452
		volatile union nvme_result *res)
4453
{
4454
	u32 result = le32_to_cpu(res->u32);
4455
	u32 aer_type = result & 0x07;
4456

4457
	if (le16_to_cpu(status) >> 1 != NVME_SC_SUCCESS)
4458 4459
		return;

4460
	switch (aer_type) {
4461 4462 4463
	case NVME_AER_NOTICE:
		nvme_handle_aen_notice(ctrl, result);
		break;
4464 4465 4466 4467
	case NVME_AER_ERROR:
	case NVME_AER_SMART:
	case NVME_AER_CSS:
	case NVME_AER_VS:
4468
		trace_nvme_async_event(ctrl, aer_type);
4469
		ctrl->aen_result = result;
4470 4471 4472
		break;
	default:
		break;
4473
	}
4474
	queue_work(nvme_wq, &ctrl->async_event_work);
4475 4476
}
EXPORT_SYMBOL_GPL(nvme_complete_async_event);
4477

4478
void nvme_stop_ctrl(struct nvme_ctrl *ctrl)
4479
{
C
Christoph Hellwig 已提交
4480
	nvme_mpath_stop(ctrl);
4481
	nvme_stop_keep_alive(ctrl);
4482
	nvme_stop_failfast_work(ctrl);
4483
	flush_work(&ctrl->async_event_work);
4484
	cancel_work_sync(&ctrl->fw_act_work);
4485 4486 4487 4488 4489
}
EXPORT_SYMBOL_GPL(nvme_stop_ctrl);

void nvme_start_ctrl(struct nvme_ctrl *ctrl)
{
4490
	nvme_start_keep_alive(ctrl);
4491

4492 4493
	nvme_enable_aen(ctrl);

4494 4495 4496
	if (ctrl->queue_count > 1) {
		nvme_queue_scan(ctrl);
		nvme_start_queues(ctrl);
4497
		nvme_mpath_update(ctrl);
4498
	}
4499 4500

	nvme_change_uevent(ctrl, "NVME_EVENT=connected");
4501 4502
}
EXPORT_SYMBOL_GPL(nvme_start_ctrl);
4503

4504 4505
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl)
{
4506
	nvme_hwmon_exit(ctrl);
4507
	nvme_fault_inject_fini(&ctrl->fault_inject);
4508
	dev_pm_qos_hide_latency_tolerance(ctrl->device);
4509
	cdev_device_del(&ctrl->cdev, ctrl->device);
4510
	nvme_put_ctrl(ctrl);
4511
}
4512
EXPORT_SYMBOL_GPL(nvme_uninit_ctrl);
4513

4514 4515 4516 4517 4518
static void nvme_free_cels(struct nvme_ctrl *ctrl)
{
	struct nvme_effects_log	*cel;
	unsigned long i;

4519
	xa_for_each(&ctrl->cels, i, cel) {
4520 4521 4522 4523 4524 4525 4526
		xa_erase(&ctrl->cels, i);
		kfree(cel);
	}

	xa_destroy(&ctrl->cels);
}

4527
static void nvme_free_ctrl(struct device *dev)
4528
{
4529 4530
	struct nvme_ctrl *ctrl =
		container_of(dev, struct nvme_ctrl, ctrl_device);
C
Christoph Hellwig 已提交
4531
	struct nvme_subsystem *subsys = ctrl->subsys;
4532

K
Keith Busch 已提交
4533
	if (!subsys || ctrl->instance != subsys->instance)
4534
		ida_free(&nvme_instance_ida, ctrl->instance);
4535

4536
	nvme_free_cels(ctrl);
C
Christoph Hellwig 已提交
4537
	nvme_mpath_uninit(ctrl);
S
Sagi Grimberg 已提交
4538
	__free_page(ctrl->discard_page);
4539

C
Christoph Hellwig 已提交
4540
	if (subsys) {
4541
		mutex_lock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4542 4543
		list_del(&ctrl->subsys_entry);
		sysfs_remove_link(&subsys->dev.kobj, dev_name(ctrl->device));
4544
		mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4545
	}
4546 4547 4548

	ctrl->ops->free_ctrl(ctrl);

C
Christoph Hellwig 已提交
4549 4550
	if (subsys)
		nvme_put_subsystem(subsys);
4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562
}

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

4563
	ctrl->state = NVME_CTRL_NEW;
4564
	clear_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags);
4565
	spin_lock_init(&ctrl->lock);
4566
	mutex_init(&ctrl->scan_lock);
4567
	INIT_LIST_HEAD(&ctrl->namespaces);
4568
	xa_init(&ctrl->cels);
4569
	init_rwsem(&ctrl->namespaces_rwsem);
4570 4571 4572
	ctrl->dev = dev;
	ctrl->ops = ops;
	ctrl->quirks = quirks;
4573
	ctrl->numa_node = NUMA_NO_NODE;
4574
	INIT_WORK(&ctrl->scan_work, nvme_scan_work);
4575
	INIT_WORK(&ctrl->async_event_work, nvme_async_event_work);
4576
	INIT_WORK(&ctrl->fw_act_work, nvme_fw_act_work);
4577
	INIT_WORK(&ctrl->delete_work, nvme_delete_ctrl_work);
4578
	init_waitqueue_head(&ctrl->state_wq);
4579

4580
	INIT_DELAYED_WORK(&ctrl->ka_work, nvme_keep_alive_work);
4581
	INIT_DELAYED_WORK(&ctrl->failfast_work, nvme_failfast_work);
4582 4583 4584
	memset(&ctrl->ka_cmd, 0, sizeof(ctrl->ka_cmd));
	ctrl->ka_cmd.common.opcode = nvme_admin_keep_alive;

4585 4586 4587 4588 4589 4590 4591 4592
	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;
	}

4593
	ret = ida_alloc(&nvme_instance_ida, GFP_KERNEL);
4594
	if (ret < 0)
4595
		goto out;
4596
	ctrl->instance = ret;
4597

4598 4599
	device_initialize(&ctrl->ctrl_device);
	ctrl->device = &ctrl->ctrl_device;
4600 4601
	ctrl->device->devt = MKDEV(MAJOR(nvme_ctrl_base_chr_devt),
			ctrl->instance);
4602 4603 4604 4605 4606 4607 4608
	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)
4609 4610
		goto out_release_instance;

4611
	nvme_get_ctrl(ctrl);
4612 4613 4614
	cdev_init(&ctrl->cdev, &nvme_dev_fops);
	ctrl->cdev.owner = ops->module;
	ret = cdev_device_add(&ctrl->cdev, ctrl->device);
4615 4616
	if (ret)
		goto out_free_name;
4617

4618 4619 4620 4621 4622 4623 4624 4625
	/*
	 * 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));

4626
	nvme_fault_inject_init(&ctrl->fault_inject, dev_name(ctrl->device));
4627
	nvme_mpath_init_ctrl(ctrl);
4628

4629
	return 0;
4630
out_free_name:
4631
	nvme_put_ctrl(ctrl);
4632
	kfree_const(ctrl->device->kobj.name);
4633
out_release_instance:
4634
	ida_free(&nvme_instance_ida, ctrl->instance);
4635
out:
4636 4637
	if (ctrl->discard_page)
		__free_page(ctrl->discard_page);
4638 4639
	return ret;
}
4640
EXPORT_SYMBOL_GPL(nvme_init_ctrl);
4641

4642 4643
static void nvme_start_ns_queue(struct nvme_ns *ns)
{
M
Ming Lei 已提交
4644 4645
	if (test_and_clear_bit(NVME_NS_STOPPED, &ns->flags))
		blk_mq_unquiesce_queue(ns->queue);
4646 4647 4648 4649
}

static void nvme_stop_ns_queue(struct nvme_ns *ns)
{
M
Ming Lei 已提交
4650 4651
	if (!test_and_set_bit(NVME_NS_STOPPED, &ns->flags))
		blk_mq_quiesce_queue(ns->queue);
M
Ming Lei 已提交
4652 4653
	else
		blk_mq_wait_quiesce_done(ns->queue);
4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668
}

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

4669
	blk_mark_disk_dead(ns->disk);
4670 4671 4672 4673 4674
	nvme_start_ns_queue(ns);

	set_capacity_and_notify(ns->disk, 0);
}

4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685
/**
 * 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;

4686
	down_read(&ctrl->namespaces_rwsem);
M
Ming Lei 已提交
4687

4688
	/* Forcibly unquiesce queues to avoid blocking dispatch */
I
Igor Konopko 已提交
4689
	if (ctrl->admin_q && !blk_queue_dying(ctrl->admin_q))
4690
		nvme_start_admin_queue(ctrl);
4691

4692 4693
	list_for_each_entry(ns, &ctrl->namespaces, list)
		nvme_set_queue_dying(ns);
4694

4695
	up_read(&ctrl->namespaces_rwsem);
4696
}
4697
EXPORT_SYMBOL_GPL(nvme_kill_queues);
4698

K
Keith Busch 已提交
4699 4700 4701 4702
void nvme_unfreeze(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

4703
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4704 4705
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_unfreeze_queue(ns->queue);
4706
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4707 4708 4709
}
EXPORT_SYMBOL_GPL(nvme_unfreeze);

4710
int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout)
K
Keith Busch 已提交
4711 4712 4713
{
	struct nvme_ns *ns;

4714
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4715 4716 4717 4718 4719
	list_for_each_entry(ns, &ctrl->namespaces, list) {
		timeout = blk_mq_freeze_queue_wait_timeout(ns->queue, timeout);
		if (timeout <= 0)
			break;
	}
4720
	up_read(&ctrl->namespaces_rwsem);
4721
	return timeout;
K
Keith Busch 已提交
4722 4723 4724 4725 4726 4727 4728
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze_timeout);

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

4729
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4730 4731
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_freeze_queue_wait(ns->queue);
4732
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4733 4734 4735 4736 4737 4738 4739
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze);

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

4740
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4741
	list_for_each_entry(ns, &ctrl->namespaces, list)
4742
		blk_freeze_queue_start(ns->queue);
4743
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4744 4745 4746
}
EXPORT_SYMBOL_GPL(nvme_start_freeze);

4747
void nvme_stop_queues(struct nvme_ctrl *ctrl)
4748 4749 4750
{
	struct nvme_ns *ns;

4751
	down_read(&ctrl->namespaces_rwsem);
4752
	list_for_each_entry(ns, &ctrl->namespaces, list)
4753
		nvme_stop_ns_queue(ns);
4754
	up_read(&ctrl->namespaces_rwsem);
4755
}
4756
EXPORT_SYMBOL_GPL(nvme_stop_queues);
4757

4758
void nvme_start_queues(struct nvme_ctrl *ctrl)
4759 4760 4761
{
	struct nvme_ns *ns;

4762
	down_read(&ctrl->namespaces_rwsem);
4763
	list_for_each_entry(ns, &ctrl->namespaces, list)
4764
		nvme_start_ns_queue(ns);
4765
	up_read(&ctrl->namespaces_rwsem);
4766
}
4767
EXPORT_SYMBOL_GPL(nvme_start_queues);
4768

4769 4770
void nvme_stop_admin_queue(struct nvme_ctrl *ctrl)
{
M
Ming Lei 已提交
4771 4772
	if (!test_and_set_bit(NVME_CTRL_ADMIN_Q_STOPPED, &ctrl->flags))
		blk_mq_quiesce_queue(ctrl->admin_q);
M
Ming Lei 已提交
4773 4774
	else
		blk_mq_wait_quiesce_done(ctrl->admin_q);
4775 4776 4777 4778 4779
}
EXPORT_SYMBOL_GPL(nvme_stop_admin_queue);

void nvme_start_admin_queue(struct nvme_ctrl *ctrl)
{
M
Ming Lei 已提交
4780 4781
	if (test_and_clear_bit(NVME_CTRL_ADMIN_Q_STOPPED, &ctrl->flags))
		blk_mq_unquiesce_queue(ctrl->admin_q);
4782 4783 4784
}
EXPORT_SYMBOL_GPL(nvme_start_admin_queue);

C
Chao Leng 已提交
4785
void nvme_sync_io_queues(struct nvme_ctrl *ctrl)
K
Keith Busch 已提交
4786 4787 4788 4789 4790 4791 4792
{
	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 已提交
4793 4794
}
EXPORT_SYMBOL_GPL(nvme_sync_io_queues);
4795

C
Chao Leng 已提交
4796 4797 4798
void nvme_sync_queues(struct nvme_ctrl *ctrl)
{
	nvme_sync_io_queues(ctrl);
4799 4800
	if (ctrl->admin_q)
		blk_sync_queue(ctrl->admin_q);
K
Keith Busch 已提交
4801 4802 4803
}
EXPORT_SYMBOL_GPL(nvme_sync_queues);

4804
struct nvme_ctrl *nvme_ctrl_from_file(struct file *file)
4805
{
4806 4807 4808
	if (file->f_op != &nvme_dev_fops)
		return NULL;
	return file->private_data;
4809
}
4810
EXPORT_SYMBOL_NS_GPL(nvme_ctrl_from_file, NVME_TARGET_PASSTHRU);
4811

4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829
/*
 * Check we didn't inadvertently grow the command structure sizes:
 */
static inline void _nvme_check_size(void)
{
	BUILD_BUG_ON(sizeof(struct nvme_common_command) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_rw_command) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_identify) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_features) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_download_firmware) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_format_cmd) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_dsm_cmd) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_write_zeroes_cmd) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_abort_cmd) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_get_log_page_command) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_command) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl) != NVME_IDENTIFY_DATA_SIZE);
	BUILD_BUG_ON(sizeof(struct nvme_id_ns) != NVME_IDENTIFY_DATA_SIZE);
K
Keith Busch 已提交
4830
	BUILD_BUG_ON(sizeof(struct nvme_id_ns_zns) != NVME_IDENTIFY_DATA_SIZE);
4831
	BUILD_BUG_ON(sizeof(struct nvme_id_ns_nvm) != NVME_IDENTIFY_DATA_SIZE);
K
Keith Busch 已提交
4832
	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl_zns) != NVME_IDENTIFY_DATA_SIZE);
4833
	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl_nvm) != NVME_IDENTIFY_DATA_SIZE);
4834 4835 4836 4837
	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);
4838
	BUILD_BUG_ON(sizeof(struct nvme_feat_host_behavior) != 512);
4839 4840 4841
}


4842
static int __init nvme_core_init(void)
4843
{
4844
	int result = -ENOMEM;
4845

4846 4847
	_nvme_check_size();

4848 4849 4850
	nvme_wq = alloc_workqueue("nvme-wq",
			WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0);
	if (!nvme_wq)
4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861
		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;
4862

4863 4864
	result = alloc_chrdev_region(&nvme_ctrl_base_chr_devt, 0,
			NVME_MINORS, "nvme");
4865
	if (result < 0)
4866
		goto destroy_delete_wq;
4867 4868 4869 4870 4871 4872

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

C
Christoph Hellwig 已提交
4875 4876 4877 4878 4879
	nvme_subsys_class = class_create(THIS_MODULE, "nvme-subsystem");
	if (IS_ERR(nvme_subsys_class)) {
		result = PTR_ERR(nvme_subsys_class);
		goto destroy_class;
	}
4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891

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

4892
	return 0;
4893

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

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

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