core.c 128.1 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
{
	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;
		}
1291 1292
		if (ctrl->quirks & NVME_QUIRK_BOGUS_NID)
			return NVME_NIDT_EUI64_LEN;
1293 1294 1295 1296 1297 1298 1299 1300
		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;
		}
1301 1302
		if (ctrl->quirks & NVME_QUIRK_BOGUS_NID)
			return NVME_NIDT_NGUID_LEN;
1303 1304 1305 1306 1307 1308 1309 1310
		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;
		}
1311 1312
		if (ctrl->quirks & NVME_QUIRK_BOGUS_NID)
			return NVME_NIDT_UUID_LEN;
1313 1314
		uuid_copy(&ids->uuid, data + sizeof(*cur));
		return NVME_NIDT_UUID_LEN;
1315 1316 1317 1318 1319 1320 1321 1322 1323
	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;
1324 1325 1326 1327 1328 1329
	default:
		/* Skip unknown types */
		return cur->nidl;
	}
}

1330
static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl, unsigned nsid,
1331
		struct nvme_ns_ids *ids)
1332 1333
{
	struct nvme_command c = { };
1334 1335
	bool csi_seen = false;
	int status, pos, len;
1336 1337
	void *data;

1338 1339
	if (ctrl->vs < NVME_VS(1, 3, 0) && !nvme_multi_css(ctrl))
		return 0;
1340 1341 1342
	if (ctrl->quirks & NVME_QUIRK_NO_NS_DESC_LIST)
		return 0;

1343 1344 1345 1346 1347 1348 1349 1350
	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;

1351
	status = nvme_submit_sync_cmd(ctrl->admin_q, &c, data,
1352
				      NVME_IDENTIFY_DATA_SIZE);
1353 1354
	if (status) {
		dev_warn(ctrl->device,
1355 1356
			"Identify Descriptors failed (nsid=%u, status=0x%x)\n",
			nsid, status);
1357
		goto free_data;
1358
	}
1359 1360 1361 1362 1363 1364 1365

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

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

1366
		len = nvme_process_ns_desc(ctrl, ids, cur, &csi_seen);
1367
		if (len < 0)
1368
			break;
1369 1370 1371

		len += sizeof(*cur);
	}
1372 1373 1374 1375 1376 1377 1378

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

1379 1380 1381 1382 1383
free_data:
	kfree(data);
	return status;
}

1384 1385
static int nvme_identify_ns(struct nvme_ctrl *ctrl, unsigned nsid,
			struct nvme_ns_ids *ids, struct nvme_id_ns **id)
1386 1387 1388 1389 1390
{
	struct nvme_command c = { };
	int error;

	/* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1391 1392
	c.identify.opcode = nvme_admin_identify;
	c.identify.nsid = cpu_to_le32(nsid);
1393
	c.identify.cns = NVME_ID_CNS_NS;
1394

1395 1396 1397
	*id = kmalloc(sizeof(**id), GFP_KERNEL);
	if (!*id)
		return -ENOMEM;
1398

1399
	error = nvme_submit_sync_cmd(ctrl->admin_q, &c, *id, sizeof(**id));
1400
	if (error) {
1401
		dev_warn(ctrl->device, "Identify namespace failed (%d)\n", error);
1402
		goto out_free_id;
1403 1404
	}

1405
	error = NVME_SC_INVALID_NS | NVME_SC_DNR;
1406 1407
	if ((*id)->ncap == 0) /* namespace not allocated or attached */
		goto out_free_id;
1408

1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420

	if (ctrl->quirks & NVME_QUIRK_BOGUS_NID) {
		dev_info(ctrl->device,
			 "Ignoring bogus Namespace Identifiers\n");
	} else {
		if (ctrl->vs >= NVME_VS(1, 1, 0) &&
		    !memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
			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));
	}
1421

1422 1423 1424 1425
	return 0;

out_free_id:
	kfree(*id);
1426
	return error;
1427 1428
}

K
Keith Busch 已提交
1429 1430
static int nvme_features(struct nvme_ctrl *dev, u8 op, unsigned int fid,
		unsigned int dword11, void *buffer, size_t buflen, u32 *result)
1431
{
1432
	union nvme_result res = { 0 };
1433
	struct nvme_command c = { };
1434
	int ret;
1435

K
Keith Busch 已提交
1436
	c.features.opcode = op;
1437 1438 1439
	c.features.fid = cpu_to_le32(fid);
	c.features.dword11 = cpu_to_le32(dword11);

1440
	ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &res,
1441
			buffer, buflen, 0, NVME_QID_ANY, 0, 0);
1442
	if (ret >= 0 && result)
1443
		*result = le32_to_cpu(res.u32);
1444
	return ret;
1445 1446
}

K
Keith Busch 已提交
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464
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 已提交
1465 1466 1467 1468 1469 1470
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;

1471
	status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, NULL, 0,
C
Christoph Hellwig 已提交
1472
			&result);
1473
	if (status < 0)
C
Christoph Hellwig 已提交
1474 1475
		return status;

1476 1477 1478 1479 1480 1481
	/*
	 * 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) {
1482
		dev_err(ctrl->device, "Could not set queue count (%d)\n", status);
1483 1484 1485 1486 1487 1488
		*count = 0;
	} else {
		nr_io_queues = min(result & 0xffff, result >> 16) + 1;
		*count = min(*count, nr_io_queues);
	}

C
Christoph Hellwig 已提交
1489 1490
	return 0;
}
1491
EXPORT_SYMBOL_GPL(nvme_set_queue_count);
C
Christoph Hellwig 已提交
1492

1493
#define NVME_AEN_SUPPORTED \
1494 1495
	(NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_FW_ACT | \
	 NVME_AEN_CFG_ANA_CHANGE | NVME_AEN_CFG_DISC_CHANGE)
1496 1497 1498

static void nvme_enable_aen(struct nvme_ctrl *ctrl)
{
1499
	u32 result, supported_aens = ctrl->oaes & NVME_AEN_SUPPORTED;
1500 1501
	int status;

1502 1503 1504 1505 1506
	if (!supported_aens)
		return;

	status = nvme_set_features(ctrl, NVME_FEAT_ASYNC_EVENT, supported_aens,
			NULL, 0, &result);
1507 1508
	if (status)
		dev_warn(ctrl->device, "Failed to configure AEN (cfg %x)\n",
1509
			 supported_aens);
1510 1511

	queue_work(nvme_wq, &ctrl->async_event_work);
1512 1513
}

1514
static int nvme_ns_open(struct nvme_ns *ns)
1515 1516
{

1517
	/* should never be called due to GENHD_FL_HIDDEN */
1518
	if (WARN_ON_ONCE(nvme_ns_head_multipath(ns->head)))
1519
		goto fail;
K
Kanchan Joshi 已提交
1520
	if (!nvme_get_ns(ns))
1521 1522 1523 1524
		goto fail;
	if (!try_module_get(ns->ctrl->ops->module))
		goto fail_put_ns;

C
Christoph Hellwig 已提交
1525
	return 0;
1526 1527 1528 1529 1530

fail_put_ns:
	nvme_put_ns(ns);
fail:
	return -ENXIO;
1531 1532
}

1533
static void nvme_ns_release(struct nvme_ns *ns)
1534
{
1535 1536 1537

	module_put(ns->ctrl->ops->module);
	nvme_put_ns(ns);
1538 1539
}

1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
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);
}

1550
int nvme_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1551 1552 1553 1554 1555 1556 1557 1558 1559
{
	/* 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
1560
static void nvme_init_integrity(struct gendisk *disk, struct nvme_ns *ns,
1561
				u32 max_integrity_segments)
1562
{
1563
	struct blk_integrity integrity = { };
1564

1565
	switch (ns->pi_type) {
1566
	case NVME_NS_DPS_PI_TYPE3:
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581
		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;
		}
1582 1583 1584
		break;
	case NVME_NS_DPS_PI_TYPE1:
	case NVME_NS_DPS_PI_TYPE2:
1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
		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;
		}
1600 1601 1602 1603 1604
		break;
	default:
		integrity.profile = NULL;
		break;
	}
1605 1606

	integrity.tuple_size = ns->ms;
1607
	blk_integrity_register(disk, &integrity);
1608
	blk_queue_max_integrity_segments(disk->queue, max_integrity_segments);
1609 1610
}
#else
1611
static void nvme_init_integrity(struct gendisk *disk, struct nvme_ns *ns,
1612
				u32 max_integrity_segments)
1613 1614 1615 1616
{
}
#endif /* CONFIG_BLK_DEV_INTEGRITY */

1617
static void nvme_config_discard(struct gendisk *disk, struct nvme_ns *ns)
1618
{
1619
	struct nvme_ctrl *ctrl = ns->ctrl;
1620
	struct request_queue *queue = disk->queue;
1621 1622
	u32 size = queue_logical_block_size(queue);

1623
	if (ctrl->max_discard_sectors == 0) {
1624 1625 1626 1627
		blk_queue_flag_clear(QUEUE_FLAG_DISCARD, queue);
		return;
	}

1628 1629 1630
	BUILD_BUG_ON(PAGE_SIZE / sizeof(struct nvme_dsm_range) <
			NVME_DSM_MAX_RANGES);

1631
	queue->limits.discard_alignment = 0;
1632
	queue->limits.discard_granularity = size;
1633

1634 1635 1636 1637
	/* If discard is already enabled, don't reset queue limits */
	if (blk_queue_flag_test_and_set(QUEUE_FLAG_DISCARD, queue))
		return;

1638 1639
	blk_queue_max_discard_sectors(queue, ctrl->max_discard_sectors);
	blk_queue_max_discard_segments(queue, ctrl->max_discard_segments);
1640 1641

	if (ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
1642
		blk_queue_max_write_zeroes_sectors(queue, UINT_MAX);
1643 1644
}

1645 1646 1647 1648
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 &&
1649 1650
		memcmp(&a->eui64, &b->eui64, sizeof(a->eui64)) == 0 &&
		a->csi == b->csi;
1651 1652
}

1653
static int nvme_init_ms(struct nvme_ns *ns, struct nvme_id_ns *id)
1654
{
1655 1656
	bool first = id->dps & NVME_NS_DPS_PI_FIRST;
	unsigned lbaf = nvme_lbaf_index(id->flbas);
1657
	struct nvme_ctrl *ctrl = ns->ctrl;
1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669
	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;
	}
1670

1671 1672 1673
	nvm = kzalloc(sizeof(*nvm), GFP_KERNEL);
	if (!nvm)
		return -ENOMEM;
1674

1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705
	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))
1706 1707 1708 1709
		ns->pi_type = id->dps & NVME_NS_DPS_PI_MASK;
	else
		ns->pi_type = 0;

1710 1711 1712 1713 1714 1715 1716 1717 1718 1719
	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;

1720 1721
	ns->features &= ~(NVME_NS_METADATA_SUPPORTED | NVME_NS_EXT_LBAS);
	if (!ns->ms || !(ctrl->ops->flags & NVME_F_METADATA_SUPPORTED))
1722 1723
		return;

1724 1725 1726 1727 1728 1729 1730
	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)))
1731
			return;
1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745

		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;
1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
	} 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;
	}
}

1760 1761 1762
static void nvme_set_queue_limits(struct nvme_ctrl *ctrl,
		struct request_queue *q)
{
1763
	bool vwc = ctrl->vwc & NVME_CTRL_VWC_PRESENT;
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777

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

1778 1779 1780
static void nvme_update_disk_info(struct gendisk *disk,
		struct nvme_ns *ns, struct nvme_id_ns *id)
{
1781
	sector_t capacity = nvme_lba_to_sect(ns, le64_to_cpu(id->nsze));
1782
	unsigned short bs = 1 << ns->lba_shift;
D
Damien Le Moal 已提交
1783
	u32 atomic_bs, phys_bs, io_opt = 0;
1784

1785 1786 1787 1788
	/*
	 * 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.
	 */
1789
	if (ns->lba_shift > PAGE_SHIFT) {
1790
		capacity = 0;
1791 1792
		bs = (1 << 9);
	}
1793

1794 1795
	blk_integrity_unregister(disk);

D
Damien Le Moal 已提交
1796
	atomic_bs = phys_bs = bs;
1797 1798 1799 1800 1801 1802
	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.
		 */
1803
		if (id->nsfeat & NVME_NS_FEAT_ATOMICS && id->nawupf)
1804 1805 1806 1807
			atomic_bs = (1 + le16_to_cpu(id->nawupf)) * bs;
		else
			atomic_bs = (1 + ns->ctrl->subsys->awupf) * bs;
	}
K
Keith Busch 已提交
1808

1809
	if (id->nsfeat & NVME_NS_FEAT_IO_OPT) {
1810
		/* NPWG = Namespace Preferred Write Granularity */
K
Keith Busch 已提交
1811
		phys_bs = bs * (1 + le16_to_cpu(id->npwg));
1812
		/* NOWS = Namespace Optimal Write Size */
K
Keith Busch 已提交
1813
		io_opt = bs * (1 + le16_to_cpu(id->nows));
1814 1815
	}

1816
	blk_queue_logical_block_size(disk->queue, bs);
1817 1818 1819 1820 1821 1822 1823 1824
	/*
	 * 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);
1825

1826 1827 1828 1829 1830 1831 1832 1833 1834
	/*
	 * 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))
1835
			nvme_init_integrity(disk, ns,
1836
					    ns->ctrl->max_integrity_segments);
1837 1838 1839 1840
		else if (!nvme_ns_has_pi(ns))
			capacity = 0;
	}

1841
	set_capacity_and_notify(disk, capacity);
1842

1843
	nvme_config_discard(disk, ns);
1844 1845
	blk_queue_max_write_zeroes_sectors(disk->queue,
					   ns->ctrl->max_zeroes_sectors);
1846 1847
}

1848 1849 1850
static inline bool nvme_first_scan(struct gendisk *disk)
{
	/* nvme_alloc_ns() scans the disk prior to adding it */
C
Christoph Hellwig 已提交
1851
	return !disk_live(disk);
1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884
}

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

1885
static int nvme_update_ns_info(struct nvme_ns *ns, struct nvme_id_ns *id)
1886
{
1887
	unsigned lbaf = nvme_lbaf_index(id->flbas);
K
Keith Busch 已提交
1888
	int ret;
1889

1890
	blk_mq_freeze_queue(ns->disk->queue);
K
Keith Busch 已提交
1891
	ns->lba_shift = id->lbaf[lbaf].ds;
1892
	nvme_set_queue_limits(ns->ctrl, ns->queue);
1893

1894
	nvme_configure_metadata(ns, id);
1895 1896 1897
	nvme_set_chunk_sectors(ns, id);
	nvme_update_disk_info(ns->disk, ns, id);

1898
	if (ns->head->ids.csi == NVME_CSI_ZNS) {
1899
		ret = nvme_update_zone_info(ns, lbaf);
1900
		if (ret)
1901
			goto out_unfreeze;
1902 1903
	}

1904 1905
	set_disk_ro(ns->disk, (id->nsattr & NVME_NS_ATTR_RO) ||
		test_bit(NVME_NS_FORCE_RO, &ns->flags));
1906
	set_bit(NVME_NS_READY, &ns->flags);
1907
	blk_mq_unfreeze_queue(ns->disk->queue);
1908

1909 1910
	if (blk_queue_is_zoned(ns->queue)) {
		ret = nvme_revalidate_zones(ns);
1911
		if (ret && !nvme_first_scan(ns->disk))
1912
			return ret;
1913 1914
	}

1915
	if (nvme_ns_head_multipath(ns->head)) {
1916
		blk_mq_freeze_queue(ns->head->disk->queue);
1917
		nvme_update_disk_info(ns->head->disk, ns, id);
1918 1919 1920
		set_disk_ro(ns->head->disk,
			    (id->nsattr & NVME_NS_ATTR_RO) ||
				    test_bit(NVME_NS_FORCE_RO, &ns->flags));
1921
		nvme_mpath_revalidate_paths(ns);
1922 1923
		blk_stack_limits(&ns->head->disk->queue->limits,
				 &ns->queue->limits, 0);
1924
		disk_update_readahead(ns->head->disk);
1925
		blk_mq_unfreeze_queue(ns->head->disk->queue);
1926
	}
1927
	return 0;
1928

1929
out_unfreeze:
1930 1931 1932 1933 1934 1935
	/*
	 * 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;
1936
		set_bit(NVME_NS_READY, &ns->flags);
1937 1938
		ret = 0;
	}
1939
	blk_mq_unfreeze_queue(ns->disk->queue);
K
Keith Busch 已提交
1940 1941 1942
	return ret;
}

1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960
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;
	}
1961
}
1962

1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985
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);
}

1986 1987 1988
static int nvme_pr_command(struct block_device *bdev, u32 cdw10,
				u64 key, u64 sa_key, u8 op)
{
1989
	struct nvme_command c = { };
1990 1991 1992 1993 1994 1995
	u8 data[16] = { 0, };

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

	c.common.opcode = op;
1996
	c.common.cdw10 = cpu_to_le32(cdw10);
1997

1998 1999 2000 2001
	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);
2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033
}

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

2036 2037 2038 2039 2040
	return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire);
}

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

2043 2044 2045 2046 2047
	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)
{
2048
	u32 cdw10 = nvme_pr_type(type) << 8 | (key ? 1 << 3 : 0);
2049

2050 2051 2052
	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release);
}

2053
const struct pr_ops nvme_pr_ops = {
2054 2055 2056 2057 2058 2059 2060
	.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,
};

2061
#ifdef CONFIG_BLK_SED_OPAL
2062 2063
int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
		bool send)
2064
{
2065
	struct nvme_ctrl *ctrl = data;
2066
	struct nvme_command cmd = { };
2067 2068 2069 2070 2071 2072

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

2076
	return __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, NULL, buffer, len, 0,
2077
			NVME_QID_ANY, 1, 0);
2078 2079 2080 2081
}
EXPORT_SYMBOL_GPL(nvme_sec_submit);
#endif /* CONFIG_BLK_SED_OPAL */

2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092
#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 已提交
2093
static const struct block_device_operations nvme_bdev_ops = {
2094 2095 2096 2097 2098
	.owner		= THIS_MODULE,
	.ioctl		= nvme_ioctl,
	.open		= nvme_open,
	.release	= nvme_release,
	.getgeo		= nvme_getgeo,
K
Keith Busch 已提交
2099
	.report_zones	= nvme_report_zones,
2100 2101 2102
	.pr_ops		= &nvme_pr_ops,
};

2103 2104 2105 2106 2107 2108 2109 2110
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 已提交
2111 2112
		if (csts == ~0)
			return -ENODEV;
2113 2114 2115
		if ((csts & NVME_CSTS_RDY) == bit)
			break;

2116
		usleep_range(1000, 2000);
2117 2118 2119
		if (fatal_signal_pending(current))
			return -EINTR;
		if (time_after(jiffies, timeout)) {
2120
			dev_err(ctrl->device,
2121 2122
				"Device not ready; aborting %s, CSTS=0x%x\n",
				enabled ? "initialisation" : "reset", csts);
2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135
			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!
 */
2136
int nvme_disable_ctrl(struct nvme_ctrl *ctrl)
2137 2138 2139 2140 2141 2142 2143 2144 2145
{
	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;
2146

2147
	if (ctrl->quirks & NVME_QUIRK_DELAY_BEFORE_CHK_RDY)
2148 2149
		msleep(NVME_QUIRK_DELAY_AMOUNT);

2150
	return nvme_wait_ready(ctrl, ctrl->cap, false);
2151
}
2152
EXPORT_SYMBOL_GPL(nvme_disable_ctrl);
2153

2154
int nvme_enable_ctrl(struct nvme_ctrl *ctrl)
2155
{
2156
	unsigned dev_page_min;
2157 2158
	int ret;

2159 2160 2161 2162 2163 2164 2165
	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;

2166
	if (NVME_CTRL_PAGE_SHIFT < dev_page_min) {
2167
		dev_err(ctrl->device,
2168
			"Minimum device page size %u too large for host (%u)\n",
2169
			1 << dev_page_min, 1 << NVME_CTRL_PAGE_SHIFT);
2170 2171 2172
		return -ENODEV;
	}

2173 2174 2175 2176
	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;
2177
	ctrl->ctrl_config |= (NVME_CTRL_PAGE_SHIFT - 12) << NVME_CC_MPS_SHIFT;
2178
	ctrl->ctrl_config |= NVME_CC_AMS_RR | NVME_CC_SHN_NONE;
2179 2180 2181 2182 2183 2184
	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;
2185
	return nvme_wait_ready(ctrl, ctrl->cap, true);
2186
}
2187
EXPORT_SYMBOL_GPL(nvme_enable_ctrl);
2188 2189 2190

int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl)
{
2191
	unsigned long timeout = jiffies + (ctrl->shutdown_timeout * HZ);
2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209
	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)) {
2210
			dev_err(ctrl->device,
2211 2212 2213 2214 2215 2216 2217
				"Device shutdown incomplete; abort shutdown\n");
			return -ENODEV;
		}
	}

	return ret;
}
2218
EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl);
2219

2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236
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;
}

2237
static int nvme_configure_host_options(struct nvme_ctrl *ctrl)
2238 2239
{
	struct nvme_feat_host_behavior *host;
2240
	u8 acre = 0, lbafee = 0;
2241 2242 2243
	int ret;

	/* Don't bother enabling the feature if retry delay is not reported */
2244 2245 2246 2247 2248 2249
	if (ctrl->crdt[0])
		acre = NVME_ENABLE_ACRE;
	if (ctrl->ctratt & NVME_CTRL_ATTR_ELBAS)
		lbafee = NVME_ENABLE_LBAFEE;

	if (!acre && !lbafee)
2250 2251 2252 2253 2254 2255
		return 0;

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

2256 2257
	host->acre = acre;
	host->lbafee = lbafee;
2258 2259 2260 2261 2262 2263
	ret = nvme_set_features(ctrl, NVME_FEAT_HOST_BEHAVIOR, 0,
				host, sizeof(*host), NULL);
	kfree(host);
	return ret;
}

2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292
/*
 * 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;
}

2293 2294 2295
/*
 * APST (Autonomous Power State Transition) lets us program a table of power
 * state transitions that the controller will perform automatically.
2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311
 *
 * 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.
2312 2313 2314 2315 2316 2317
 *
 * 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.
 */
2318
static int nvme_configure_apst(struct nvme_ctrl *ctrl)
2319 2320
{
	struct nvme_feat_auto_pst *table;
2321
	unsigned apste = 0;
2322
	u64 max_lat_us = 0;
2323
	__le64 target = 0;
2324
	int max_ps = -1;
2325
	int state;
2326
	int ret;
2327
	unsigned last_lt_index = UINT_MAX;
2328 2329 2330 2331 2332 2333

	/*
	 * If APST isn't supported or if we haven't been initialized yet,
	 * then don't do anything.
	 */
	if (!ctrl->apsta)
2334
		return 0;
2335 2336 2337

	if (ctrl->npss > 31) {
		dev_warn(ctrl->device, "NPSS is invalid; not using APST\n");
2338
		return 0;
2339 2340 2341 2342
	}

	table = kzalloc(sizeof(*table), GFP_KERNEL);
	if (!table)
2343
		return 0;
2344

2345
	if (!ctrl->apst_enabled || ctrl->ps_max_latency_us == 0) {
2346
		/* Turn off APST. */
2347
		dev_dbg(ctrl->device, "APST disabled\n");
2348 2349
		goto done;
	}
2350

2351 2352 2353 2354 2355 2356 2357 2358
	/*
	 * 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;
2359

2360 2361
		if (target)
			table->entries[state] = target;
2362 2363

		/*
2364 2365
		 * Don't allow transitions to the deepest state if it's quirked
		 * off.
2366
		 */
2367 2368 2369
		if (state == ctrl->npss &&
		    (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS))
			continue;
2370

2371 2372 2373 2374 2375 2376
		/*
		 * 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;
2377

2378 2379 2380
		exit_latency_us = (u64)le32_to_cpu(ctrl->psd[state].exit_lat);
		if (exit_latency_us > ctrl->ps_max_latency_us)
			continue;
2381

2382 2383
		total_latency_us = exit_latency_us +
			le32_to_cpu(ctrl->psd[state].entry_lat);
2384

2385
		/*
2386 2387
		 * This state is good. It can be used as the APST idle target
		 * for higher power states.
2388
		 */
2389 2390 2391 2392 2393 2394 2395 2396 2397 2398
		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;
		}
2399 2400 2401 2402 2403 2404

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

2407 2408 2409 2410 2411 2412 2413 2414
	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:
2415 2416 2417 2418 2419
	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);
2420
	return ret;
2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439
}

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;
2440 2441
		if (ctrl->state == NVME_CTRL_LIVE)
			nvme_configure_apst(ctrl);
2442 2443 2444
	}
}

2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457
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[] = {
2458
	{
2459 2460 2461 2462 2463 2464
		/*
		 * 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",
2465
		.quirks = NVME_QUIRK_NO_APST,
2466 2467 2468 2469 2470 2471 2472 2473 2474 2475
	},
	{
		/*
		 * 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,
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489
	},
	{
		/*
		 * 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,
2490
	}
2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521
};

/* 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 已提交
2522 2523
static void nvme_init_subnqn(struct nvme_subsystem *subsys, struct nvme_ctrl *ctrl,
		struct nvme_id_ctrl *id)
2524 2525 2526 2527
{
	size_t nqnlen;
	int off;

2528 2529 2530 2531 2532 2533
	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;
		}
2534

2535 2536 2537
		if (ctrl->vs >= NVME_VS(1, 2, 1))
			dev_warn(ctrl->device, "missing or invalid SUBNQN field.\n");
	}
2538 2539

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

2550
static void nvme_release_subsystem(struct device *dev)
C
Christoph Hellwig 已提交
2551
{
2552 2553 2554
	struct nvme_subsystem *subsys =
		container_of(dev, struct nvme_subsystem, dev);

2555
	if (subsys->instance >= 0)
2556
		ida_free(&nvme_instance_ida, subsys->instance);
C
Christoph Hellwig 已提交
2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568
	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 已提交
2569
	ida_destroy(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584
	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);

2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595
	/*
	 * 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 已提交
2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606
	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;
}

2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617
#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);

2618
	return sysfs_emit(buf, "%s\n", subsys->subnqn);
2619 2620 2621
}
static SUBSYS_ATTR_RO(subsysnqn, S_IRUGO, nvme_subsys_show_nqn);

2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639
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);

2640 2641 2642 2643 2644 2645
#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);		\
2646 2647
	return sysfs_emit(buf, "%.*s\n",				\
			   (int)sizeof(subsys->field), subsys->field);	\
2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659
}									\
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,
2660
	&subsys_attr_subsystype.attr,
2661 2662 2663
#ifdef CONFIG_NVME_MULTIPATH
	&subsys_attr_iopolicy.attr,
#endif
2664 2665 2666
	NULL,
};

2667
static const struct attribute_group nvme_subsys_attrs_group = {
2668 2669 2670 2671 2672 2673 2674 2675
	.attrs = nvme_subsys_attrs,
};

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

2676 2677 2678 2679 2680
static inline bool nvme_discovery_ctrl(struct nvme_ctrl *ctrl)
{
	return ctrl->opts && ctrl->opts->discovery_nqn;
}

2681 2682
static bool nvme_validate_cntlid(struct nvme_subsystem *subsys,
		struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
2683
{
2684
	struct nvme_ctrl *tmp;
2685

2686 2687
	lockdep_assert_held(&nvme_subsystems_lock);

2688
	list_for_each_entry(tmp, &subsys->ctrls, subsys_entry) {
2689
		if (nvme_state_terminal(tmp))
2690 2691 2692 2693
			continue;

		if (tmp->cntlid == ctrl->cntlid) {
			dev_err(ctrl->device,
2694 2695 2696
				"Duplicate cntlid %u with %s, subsys %s, rejecting\n",
				ctrl->cntlid, dev_name(tmp->device),
				subsys->subnqn);
2697 2698
			return false;
		}
2699

2700
		if ((id->cmic & NVME_CTRL_CMIC_MULTI_CTRL) ||
2701
		    nvme_discovery_ctrl(ctrl))
2702 2703 2704 2705 2706
			continue;

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

2709
	return true;
2710 2711
}

C
Christoph Hellwig 已提交
2712 2713 2714 2715 2716 2717 2718 2719
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;
2720 2721

	subsys->instance = -1;
C
Christoph Hellwig 已提交
2722 2723 2724
	mutex_init(&subsys->lock);
	kref_init(&subsys->ref);
	INIT_LIST_HEAD(&subsys->ctrls);
C
Christoph Hellwig 已提交
2725
	INIT_LIST_HEAD(&subsys->nsheads);
C
Christoph Hellwig 已提交
2726 2727 2728 2729 2730 2731
	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;
2732 2733 2734 2735 2736 2737 2738 2739

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

2740 2741 2742 2743 2744 2745 2746
	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;
	}
2747
	subsys->awupf = le16_to_cpu(id->awupf);
2748
	nvme_mpath_default_iopolicy(subsys);
C
Christoph Hellwig 已提交
2749 2750 2751

	subsys->dev.class = nvme_subsys_class;
	subsys->dev.release = nvme_release_subsystem;
2752
	subsys->dev.groups = nvme_subsys_attrs_groups;
2753
	dev_set_name(&subsys->dev, "nvme-subsys%d", ctrl->instance);
C
Christoph Hellwig 已提交
2754 2755 2756 2757 2758
	device_initialize(&subsys->dev);

	mutex_lock(&nvme_subsystems_lock);
	found = __nvme_find_get_subsystem(subsys->subnqn);
	if (found) {
2759
		put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2760
		subsys = found;
2761

2762
		if (!nvme_validate_cntlid(subsys, ctrl, id)) {
C
Christoph Hellwig 已提交
2763
			ret = -EINVAL;
2764
			goto out_put_subsystem;
C
Christoph Hellwig 已提交
2765 2766 2767 2768 2769 2770
		}
	} else {
		ret = device_add(&subsys->dev);
		if (ret) {
			dev_err(ctrl->device,
				"failed to register subsystem device.\n");
2771
			put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2772 2773
			goto out_unlock;
		}
C
Christoph Hellwig 已提交
2774
		ida_init(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2775 2776 2777
		list_add_tail(&subsys->entry, &nvme_subsystems);
	}

2778 2779 2780
	ret = sysfs_create_link(&subsys->dev.kobj, &ctrl->device->kobj,
				dev_name(ctrl->device));
	if (ret) {
C
Christoph Hellwig 已提交
2781 2782
		dev_err(ctrl->device,
			"failed to create sysfs link from subsystem.\n");
2783
		goto out_put_subsystem;
C
Christoph Hellwig 已提交
2784 2785
	}

2786 2787
	if (!found)
		subsys->instance = ctrl->instance;
2788
	ctrl->subsys = subsys;
C
Christoph Hellwig 已提交
2789
	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
2790
	mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
2791 2792
	return 0;

2793 2794
out_put_subsystem:
	nvme_put_subsystem(subsys);
C
Christoph Hellwig 已提交
2795 2796 2797
out_unlock:
	mutex_unlock(&nvme_subsystems_lock);
	return ret;
2798 2799
}

2800
int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
2801
		void *log, size_t size, u64 offset)
K
Keith Busch 已提交
2802 2803
{
	struct nvme_command c = { };
K
Keith Busch 已提交
2804
	u32 dwlen = nvme_bytes_to_numd(size);
2805 2806

	c.get_log_page.opcode = nvme_admin_get_log_page;
2807
	c.get_log_page.nsid = cpu_to_le32(nsid);
2808
	c.get_log_page.lid = log_page;
2809
	c.get_log_page.lsp = lsp;
2810 2811
	c.get_log_page.numdl = cpu_to_le16(dwlen & ((1 << 16) - 1));
	c.get_log_page.numdu = cpu_to_le16(dwlen >> 16);
2812 2813
	c.get_log_page.lpol = cpu_to_le32(lower_32_bits(offset));
	c.get_log_page.lpou = cpu_to_le32(upper_32_bits(offset));
2814
	c.get_log_page.csi = csi;
K
Keith Busch 已提交
2815 2816 2817 2818

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

2819 2820
static int nvme_get_effects_log(struct nvme_ctrl *ctrl, u8 csi,
				struct nvme_effects_log **log)
2821
{
2822
	struct nvme_effects_log	*cel = xa_load(&ctrl->cels, csi);
2823 2824
	int ret;

2825 2826
	if (cel)
		goto out;
2827

2828 2829 2830
	cel = kzalloc(sizeof(*cel), GFP_KERNEL);
	if (!cel)
		return -ENOMEM;
2831

2832
	ret = nvme_get_log(ctrl, 0x00, NVME_LOG_CMD_EFFECTS, 0, csi,
2833
			cel, sizeof(*cel), 0);
2834
	if (ret) {
2835 2836
		kfree(cel);
		return ret;
2837
	}
2838

2839
	xa_store(&ctrl->cels, csi, cel, GFP_KERNEL);
2840
out:
2841
	*log = cel;
2842
	return 0;
2843 2844
}

2845
static inline u32 nvme_mps_to_sectors(struct nvme_ctrl *ctrl, u32 units)
2846
{
2847
	u32 page_shift = NVME_CAP_MPSMIN(ctrl->cap) + 12, val;
2848

2849 2850 2851
	if (check_shl_overflow(1U, units + page_shift - 9, &val))
		return UINT_MAX;
	return val;
2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865
}

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;
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 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906
	/*
	 * 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;
}

2907
static int nvme_init_identify(struct nvme_ctrl *ctrl)
2908 2909
{
	struct nvme_id_ctrl *id;
2910
	u32 max_hw_sectors;
2911
	bool prev_apst_enabled;
2912
	int ret;
2913

2914 2915
	ret = nvme_identify_ctrl(ctrl, &id);
	if (ret) {
2916
		dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret);
2917 2918 2919
		return -EIO;
	}

2920
	if (id->lpa & NVME_CTRL_LPA_CMD_EFFECTS_LOG) {
2921
		ret = nvme_get_effects_log(ctrl, NVME_CSI_NVM, &ctrl->effects);
2922
		if (ret < 0)
2923
			goto out_free;
2924
	}
2925

2926 2927 2928
	if (!(ctrl->ops->flags & NVME_F_FABRICS))
		ctrl->cntlid = le16_to_cpu(id->cntlid);

2929
	if (!ctrl->identified) {
2930
		unsigned int i;
C
Christoph Hellwig 已提交
2931 2932 2933 2934 2935

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

2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949
		/*
		 * 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;
		}
	}

2950
	if (force_apst && (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) {
2951
		dev_warn(ctrl->device, "forcibly allowing all power states due to nvme_core.force_apst -- use at your own risk\n");
2952 2953 2954
		ctrl->quirks &= ~NVME_QUIRK_NO_DEEPEST_PS;
	}

2955 2956 2957 2958
	ctrl->crdt[0] = le16_to_cpu(id->crdt1);
	ctrl->crdt[1] = le16_to_cpu(id->crdt2);
	ctrl->crdt[2] = le16_to_cpu(id->crdt3);

2959
	ctrl->oacs = le16_to_cpu(id->oacs);
2960
	ctrl->oncs = le16_to_cpu(id->oncs);
2961
	ctrl->mtfa = le16_to_cpu(id->mtfa);
2962
	ctrl->oaes = le32_to_cpu(id->oaes);
2963 2964 2965
	ctrl->wctemp = le16_to_cpu(id->wctemp);
	ctrl->cctemp = le16_to_cpu(id->cctemp);

2966
	atomic_set(&ctrl->abort_limit, id->acl + 1);
2967 2968
	ctrl->vwc = id->vwc;
	if (id->mdts)
2969
		max_hw_sectors = nvme_mps_to_sectors(ctrl, id->mdts);
2970
	else
2971 2972 2973
		max_hw_sectors = UINT_MAX;
	ctrl->max_hw_sectors =
		min_not_zero(ctrl->max_hw_sectors, max_hw_sectors);
2974

2975
	nvme_set_queue_limits(ctrl, ctrl->admin_q);
2976
	ctrl->sgls = le32_to_cpu(id->sgls);
S
Sagi Grimberg 已提交
2977
	ctrl->kas = le16_to_cpu(id->kas);
C
Christoph Hellwig 已提交
2978
	ctrl->max_namespaces = le32_to_cpu(id->mnan);
S
Sagi Grimberg 已提交
2979
	ctrl->ctratt = le32_to_cpu(id->ctratt);
2980

2981 2982 2983
	ctrl->cntrltype = id->cntrltype;
	ctrl->dctype = id->dctype;

2984 2985
	if (id->rtd3e) {
		/* us -> s */
2986
		u32 transition_time = le32_to_cpu(id->rtd3e) / USEC_PER_SEC;
2987 2988 2989 2990 2991

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

		if (ctrl->shutdown_timeout != shutdown_timeout)
2992
			dev_info(ctrl->device,
2993 2994 2995 2996 2997
				 "Shutdown timeout set to %u seconds\n",
				 ctrl->shutdown_timeout);
	} else
		ctrl->shutdown_timeout = shutdown_timeout;

2998
	ctrl->npss = id->npss;
2999 3000
	ctrl->apsta = id->apsta;
	prev_apst_enabled = ctrl->apst_enabled;
3001 3002
	if (ctrl->quirks & NVME_QUIRK_NO_APST) {
		if (force_apst && id->apsta) {
3003
			dev_warn(ctrl->device, "forcibly allowing APST due to nvme_core.force_apst -- use at your own risk\n");
3004
			ctrl->apst_enabled = true;
3005
		} else {
3006
			ctrl->apst_enabled = false;
3007 3008
		}
	} else {
3009
		ctrl->apst_enabled = id->apsta;
3010
	}
3011 3012
	memcpy(ctrl->psd, id->psd, sizeof(ctrl->psd));

3013
	if (ctrl->ops->flags & NVME_F_FABRICS) {
3014 3015 3016 3017 3018 3019 3020 3021 3022
		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
		 */
3023
		if (ctrl->cntlid != le16_to_cpu(id->cntlid)) {
3024 3025 3026 3027
			dev_err(ctrl->device,
				"Mismatching cntlid: Connect %u vs Identify "
				"%u, rejecting\n",
				ctrl->cntlid, le16_to_cpu(id->cntlid));
3028
			ret = -EINVAL;
3029 3030
			goto out_free;
		}
S
Sagi Grimberg 已提交
3031

3032
		if (!nvme_discovery_ctrl(ctrl) && !ctrl->kas) {
3033
			dev_err(ctrl->device,
S
Sagi Grimberg 已提交
3034 3035
				"keep-alive support is mandatory for fabrics\n");
			ret = -EINVAL;
3036
			goto out_free;
S
Sagi Grimberg 已提交
3037
		}
3038
	} else {
3039 3040
		ctrl->hmpre = le32_to_cpu(id->hmpre);
		ctrl->hmmin = le32_to_cpu(id->hmmin);
3041 3042
		ctrl->hmminds = le32_to_cpu(id->hmminds);
		ctrl->hmmaxd = le16_to_cpu(id->hmmaxd);
3043
	}
3044

3045
	ret = nvme_mpath_init_identify(ctrl, id);
C
Christoph Hellwig 已提交
3046
	if (ret < 0)
3047
		goto out_free;
C
Christoph Hellwig 已提交
3048

3049
	if (ctrl->apst_enabled && !prev_apst_enabled)
3050
		dev_pm_qos_expose_latency_tolerance(ctrl->device);
3051
	else if (!ctrl->apst_enabled && prev_apst_enabled)
3052 3053
		dev_pm_qos_hide_latency_tolerance(ctrl->device);

3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082
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;

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

3087 3088 3089
	ret = nvme_configure_apst(ctrl);
	if (ret < 0)
		return ret;
3090

3091 3092 3093
	ret = nvme_configure_timestamp(ctrl);
	if (ret < 0)
		return ret;
3094

3095
	ret = nvme_configure_host_options(ctrl);
3096 3097 3098
	if (ret < 0)
		return ret;

3099
	if (!ctrl->identified && !nvme_discovery_ctrl(ctrl)) {
K
Keith Busch 已提交
3100 3101 3102 3103
		ret = nvme_hwmon_init(ctrl);
		if (ret < 0)
			return ret;
	}
3104

3105
	ctrl->identified = true;
3106

3107
	return 0;
3108
}
3109
EXPORT_SYMBOL_GPL(nvme_init_ctrl_finish);
3110

3111
static int nvme_dev_open(struct inode *inode, struct file *file)
3112
{
3113 3114
	struct nvme_ctrl *ctrl =
		container_of(inode->i_cdev, struct nvme_ctrl, cdev);
3115

3116 3117 3118 3119
	switch (ctrl->state) {
	case NVME_CTRL_LIVE:
		break;
	default:
3120
		return -EWOULDBLOCK;
3121 3122
	}

3123
	nvme_get_ctrl(ctrl);
3124 3125
	if (!try_module_get(ctrl->ops->module)) {
		nvme_put_ctrl(ctrl);
3126
		return -EINVAL;
3127
	}
3128

3129
	file->private_data = ctrl;
3130 3131 3132
	return 0;
}

3133 3134 3135 3136 3137 3138 3139 3140 3141 3142
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;
}

3143 3144 3145
static const struct file_operations nvme_dev_fops = {
	.owner		= THIS_MODULE,
	.open		= nvme_dev_open,
3146
	.release	= nvme_dev_release,
3147
	.unlocked_ioctl	= nvme_dev_ioctl,
3148
	.compat_ioctl	= compat_ptr_ioctl,
3149 3150 3151 3152 3153 3154 3155 3156 3157
};

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;

3158
	ret = nvme_reset_ctrl_sync(ctrl);
3159 3160 3161
	if (ret < 0)
		return ret;
	return count;
3162
}
3163
static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset);
3164

K
Keith Busch 已提交
3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175
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);

3176 3177 3178 3179
static inline struct nvme_ns_head *dev_to_ns_head(struct device *dev)
{
	struct gendisk *disk = dev_to_disk(dev);

J
Javier González 已提交
3180
	if (disk->fops == &nvme_bdev_ops)
3181 3182 3183 3184 3185
		return nvme_get_ns_from_dev(dev)->head;
	else
		return disk->private_data;
}

3186
static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
3187
		char *buf)
3188
{
3189 3190 3191
	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 已提交
3192 3193
	int serial_len = sizeof(subsys->serial);
	int model_len = sizeof(subsys->model);
3194

3195
	if (!uuid_is_null(&ids->uuid))
3196
		return sysfs_emit(buf, "uuid.%pU\n", &ids->uuid);
3197

3198
	if (memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3199
		return sysfs_emit(buf, "eui.%16phN\n", ids->nguid);
3200

3201
	if (memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3202
		return sysfs_emit(buf, "eui.%8phN\n", ids->eui64);
3203

C
Christoph Hellwig 已提交
3204 3205
	while (serial_len > 0 && (subsys->serial[serial_len - 1] == ' ' ||
				  subsys->serial[serial_len - 1] == '\0'))
3206
		serial_len--;
C
Christoph Hellwig 已提交
3207 3208
	while (model_len > 0 && (subsys->model[model_len - 1] == ' ' ||
				 subsys->model[model_len - 1] == '\0'))
3209 3210
		model_len--;

3211
	return sysfs_emit(buf, "nvme.%04x-%*phN-%*phN-%08x\n", subsys->vendor_id,
C
Christoph Hellwig 已提交
3212
		serial_len, subsys->serial, model_len, subsys->model,
3213
		head->ns_id);
3214
}
J
Joe Perches 已提交
3215
static DEVICE_ATTR_RO(wwid);
3216

3217
static ssize_t nguid_show(struct device *dev, struct device_attribute *attr,
3218
		char *buf)
3219
{
3220
	return sysfs_emit(buf, "%pU\n", dev_to_ns_head(dev)->ids.nguid);
3221
}
J
Joe Perches 已提交
3222
static DEVICE_ATTR_RO(nguid);
3223

3224
static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
3225
		char *buf)
3226
{
3227
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3228 3229 3230 3231

	/* For backward compatibility expose the NGUID to userspace if
	 * we have no UUID set
	 */
3232
	if (uuid_is_null(&ids->uuid)) {
3233 3234
		printk_ratelimited(KERN_WARNING
				   "No UUID available providing old NGUID\n");
3235
		return sysfs_emit(buf, "%pU\n", ids->nguid);
3236
	}
3237
	return sysfs_emit(buf, "%pU\n", &ids->uuid);
3238
}
J
Joe Perches 已提交
3239
static DEVICE_ATTR_RO(uuid);
3240 3241

static ssize_t eui_show(struct device *dev, struct device_attribute *attr,
3242
		char *buf)
3243
{
3244
	return sysfs_emit(buf, "%8ph\n", dev_to_ns_head(dev)->ids.eui64);
3245
}
J
Joe Perches 已提交
3246
static DEVICE_ATTR_RO(eui);
3247 3248

static ssize_t nsid_show(struct device *dev, struct device_attribute *attr,
3249
		char *buf)
3250
{
3251
	return sysfs_emit(buf, "%d\n", dev_to_ns_head(dev)->ns_id);
3252
}
J
Joe Perches 已提交
3253
static DEVICE_ATTR_RO(nsid);
3254

3255
static struct attribute *nvme_ns_id_attrs[] = {
3256
	&dev_attr_wwid.attr,
3257
	&dev_attr_uuid.attr,
3258
	&dev_attr_nguid.attr,
3259 3260
	&dev_attr_eui.attr,
	&dev_attr_nsid.attr,
C
Christoph Hellwig 已提交
3261 3262 3263 3264
#ifdef CONFIG_NVME_MULTIPATH
	&dev_attr_ana_grpid.attr,
	&dev_attr_ana_state.attr,
#endif
3265 3266 3267
	NULL,
};

3268
static umode_t nvme_ns_id_attrs_are_visible(struct kobject *kobj,
3269 3270 3271
		struct attribute *a, int n)
{
	struct device *dev = container_of(kobj, struct device, kobj);
3272
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3273 3274

	if (a == &dev_attr_uuid.attr) {
3275
		if (uuid_is_null(&ids->uuid) &&
3276
		    !memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3277 3278 3279
			return 0;
	}
	if (a == &dev_attr_nguid.attr) {
3280
		if (!memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3281 3282 3283
			return 0;
	}
	if (a == &dev_attr_eui.attr) {
3284
		if (!memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3285 3286
			return 0;
	}
C
Christoph Hellwig 已提交
3287 3288
#ifdef CONFIG_NVME_MULTIPATH
	if (a == &dev_attr_ana_grpid.attr || a == &dev_attr_ana_state.attr) {
J
Javier González 已提交
3289
		if (dev_to_disk(dev)->fops != &nvme_bdev_ops) /* per-path attr */
C
Christoph Hellwig 已提交
3290 3291 3292 3293 3294
			return 0;
		if (!nvme_ctrl_use_ana(nvme_get_ns_from_dev(dev)->ctrl))
			return 0;
	}
#endif
3295 3296 3297
	return a->mode;
}

3298
static const struct attribute_group nvme_ns_id_attr_group = {
3299 3300
	.attrs		= nvme_ns_id_attrs,
	.is_visible	= nvme_ns_id_attrs_are_visible,
3301 3302
};

3303 3304 3305 3306 3307
const struct attribute_group *nvme_ns_id_attr_groups[] = {
	&nvme_ns_id_attr_group,
	NULL,
};

M
Ming Lin 已提交
3308
#define nvme_show_str_function(field)						\
3309 3310 3311 3312
static ssize_t  field##_show(struct device *dev,				\
			    struct device_attribute *attr, char *buf)		\
{										\
        struct nvme_ctrl *ctrl = dev_get_drvdata(dev);				\
3313
        return sysfs_emit(buf, "%.*s\n",					\
C
Christoph Hellwig 已提交
3314
		(int)sizeof(ctrl->subsys->field), ctrl->subsys->field);		\
3315 3316 3317
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

C
Christoph Hellwig 已提交
3318 3319 3320 3321
nvme_show_str_function(model);
nvme_show_str_function(serial);
nvme_show_str_function(firmware_rev);

M
Ming Lin 已提交
3322 3323 3324 3325 3326
#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);				\
3327
        return sysfs_emit(buf, "%d\n", ctrl->field);				\
M
Ming Lin 已提交
3328 3329 3330 3331
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

nvme_show_int_function(cntlid);
3332
nvme_show_int_function(numa_node);
3333 3334
nvme_show_int_function(queue_count);
nvme_show_int_function(sqsize);
3335
nvme_show_int_function(kato);
3336

M
Ming Lin 已提交
3337 3338 3339 3340 3341 3342 3343
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))
3344
		nvme_delete_ctrl_sync(ctrl);
M
Ming Lin 已提交
3345 3346 3347 3348 3349 3350 3351 3352 3353 3354
	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);

3355
	return sysfs_emit(buf, "%s\n", ctrl->ops->name);
M
Ming Lin 已提交
3356 3357 3358
}
static DEVICE_ATTR(transport, S_IRUGO, nvme_sysfs_show_transport, NULL);

3359 3360 3361 3362 3363 3364 3365 3366 3367
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",
3368
		[NVME_CTRL_CONNECTING]	= "connecting",
3369
		[NVME_CTRL_DELETING]	= "deleting",
3370
		[NVME_CTRL_DELETING_NOIO]= "deleting (no IO)",
3371 3372 3373 3374 3375
		[NVME_CTRL_DEAD]	= "dead",
	};

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

3378
	return sysfs_emit(buf, "unknown state\n");
3379 3380 3381 3382
}

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

M
Ming Lin 已提交
3383 3384 3385 3386 3387 3388
static ssize_t nvme_sysfs_show_subsysnqn(struct device *dev,
					 struct device_attribute *attr,
					 char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3389
	return sysfs_emit(buf, "%s\n", ctrl->subsys->subnqn);
M
Ming Lin 已提交
3390 3391 3392
}
static DEVICE_ATTR(subsysnqn, S_IRUGO, nvme_sysfs_show_subsysnqn, NULL);

3393 3394 3395 3396 3397 3398
static ssize_t nvme_sysfs_show_hostnqn(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3399
	return sysfs_emit(buf, "%s\n", ctrl->opts->host->nqn);
3400 3401 3402
}
static DEVICE_ATTR(hostnqn, S_IRUGO, nvme_sysfs_show_hostnqn, NULL);

3403 3404 3405 3406 3407 3408
static ssize_t nvme_sysfs_show_hostid(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3409
	return sysfs_emit(buf, "%pU\n", &ctrl->opts->host->id);
3410 3411 3412
}
static DEVICE_ATTR(hostid, S_IRUGO, nvme_sysfs_show_hostid, NULL);

M
Ming Lin 已提交
3413 3414 3415 3416 3417 3418 3419 3420 3421 3422
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);

3423 3424 3425 3426 3427 3428 3429
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)
3430 3431 3432
		return sysfs_emit(buf, "off\n");
	return sysfs_emit(buf, "%d\n",
			  opts->max_reconnects * opts->reconnect_delay);
3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445
}

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;

3446
	if (ctrl_loss_tmo < 0)
3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461
		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)
3462 3463
		return sysfs_emit(buf, "off\n");
	return sysfs_emit(buf, "%d\n", ctrl->opts->reconnect_delay);
3464 3465 3466 3467 3468 3469 3470 3471 3472 3473
}

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);
3474 3475
	if (err)
		return err;
3476 3477 3478 3479 3480 3481 3482

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

3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512
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);

3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546
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);

3547 3548
static struct attribute *nvme_dev_attrs[] = {
	&dev_attr_reset_controller.attr,
K
Keith Busch 已提交
3549
	&dev_attr_rescan_controller.attr,
3550 3551 3552
	&dev_attr_model.attr,
	&dev_attr_serial.attr,
	&dev_attr_firmware_rev.attr,
M
Ming Lin 已提交
3553
	&dev_attr_cntlid.attr,
M
Ming Lin 已提交
3554 3555 3556 3557
	&dev_attr_delete_controller.attr,
	&dev_attr_transport.attr,
	&dev_attr_subsysnqn.attr,
	&dev_attr_address.attr,
3558
	&dev_attr_state.attr,
3559
	&dev_attr_numa_node.attr,
3560 3561
	&dev_attr_queue_count.attr,
	&dev_attr_sqsize.attr,
3562
	&dev_attr_hostnqn.attr,
3563
	&dev_attr_hostid.attr,
3564 3565
	&dev_attr_ctrl_loss_tmo.attr,
	&dev_attr_reconnect_delay.attr,
3566
	&dev_attr_fast_io_fail_tmo.attr,
3567
	&dev_attr_kato.attr,
3568 3569
	&dev_attr_cntrltype.attr,
	&dev_attr_dctype.attr,
3570 3571 3572
	NULL
};

M
Ming Lin 已提交
3573 3574 3575 3576 3577 3578
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);

3579 3580 3581 3582
	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;
3583 3584
	if (a == &dev_attr_hostnqn.attr && !ctrl->opts)
		return 0;
3585 3586
	if (a == &dev_attr_hostid.attr && !ctrl->opts)
		return 0;
3587 3588 3589 3590
	if (a == &dev_attr_ctrl_loss_tmo.attr && !ctrl->opts)
		return 0;
	if (a == &dev_attr_reconnect_delay.attr && !ctrl->opts)
		return 0;
3591 3592
	if (a == &dev_attr_fast_io_fail_tmo.attr && !ctrl->opts)
		return 0;
M
Ming Lin 已提交
3593 3594 3595 3596

	return a->mode;
}

3597
static const struct attribute_group nvme_dev_attrs_group = {
M
Ming Lin 已提交
3598 3599
	.attrs		= nvme_dev_attrs,
	.is_visible	= nvme_dev_attrs_are_visible,
3600 3601 3602 3603 3604 3605 3606
};

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

3607
static struct nvme_ns_head *nvme_find_ns_head(struct nvme_ctrl *ctrl,
C
Christoph Hellwig 已提交
3608 3609 3610 3611
		unsigned nsid)
{
	struct nvme_ns_head *h;

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

3614 3615 3616 3617 3618 3619 3620
	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))
3621 3622
			continue;
		if (!list_empty(&h->list) && nvme_tryget_ns_head(h))
C
Christoph Hellwig 已提交
3623 3624 3625 3626 3627 3628
			return h;
	}

	return NULL;
}

3629 3630
static int nvme_subsys_check_duplicate_ids(struct nvme_subsystem *subsys,
		struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
3631
{
3632 3633 3634
	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 已提交
3635 3636 3637 3638 3639
	struct nvme_ns_head *h;

	lockdep_assert_held(&subsys->lock);

	list_for_each_entry(h, &subsys->nsheads, entry) {
3640 3641 3642 3643 3644 3645 3646
		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 已提交
3647 3648 3649 3650 3651 3652
			return -EINVAL;
	}

	return 0;
}

3653 3654
static void nvme_cdev_rel(struct device *dev)
{
3655
	ida_free(&nvme_ns_chr_minor_ida, MINOR(dev->devt));
3656 3657
}

3658 3659 3660
void nvme_cdev_del(struct cdev *cdev, struct device *cdev_device)
{
	cdev_device_del(cdev, cdev_device);
3661
	put_device(cdev_device);
3662 3663 3664 3665 3666 3667 3668
}

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

3669
	minor = ida_alloc(&nvme_ns_chr_minor_ida, GFP_KERNEL);
3670 3671 3672 3673
	if (minor < 0)
		return minor;
	cdev_device->devt = MKDEV(MAJOR(nvme_ns_chr_devt), minor);
	cdev_device->class = nvme_ns_chr_class;
3674
	cdev_device->release = nvme_cdev_rel;
3675 3676 3677 3678
	device_initialize(cdev_device);
	cdev_init(cdev, fops);
	cdev->owner = owner;
	ret = cdev_device_add(cdev, cdev_device);
3679
	if (ret)
3680
		put_device(cdev_device);
3681

3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712
	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;
3713 3714 3715

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

C
Christoph Hellwig 已提交
3718
static struct nvme_ns_head *nvme_alloc_ns_head(struct nvme_ctrl *ctrl,
K
Keith Busch 已提交
3719
		unsigned nsid, struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
3720 3721
{
	struct nvme_ns_head *head;
3722
	size_t size = sizeof(*head);
C
Christoph Hellwig 已提交
3723 3724
	int ret = -ENOMEM;

3725 3726 3727 3728 3729
#ifdef CONFIG_NVME_MULTIPATH
	size += num_possible_nodes() * sizeof(struct nvme_ns *);
#endif

	head = kzalloc(size, GFP_KERNEL);
C
Christoph Hellwig 已提交
3730 3731
	if (!head)
		goto out;
3732
	ret = ida_alloc_min(&ctrl->subsys->ns_ida, 1, GFP_KERNEL);
C
Christoph Hellwig 已提交
3733 3734 3735 3736
	if (ret < 0)
		goto out_free_head;
	head->instance = ret;
	INIT_LIST_HEAD(&head->list);
3737 3738 3739
	ret = init_srcu_struct(&head->srcu);
	if (ret)
		goto out_ida_remove;
C
Christoph Hellwig 已提交
3740 3741
	head->subsys = ctrl->subsys;
	head->ns_id = nsid;
3742
	head->ids = *ids;
C
Christoph Hellwig 已提交
3743 3744
	kref_init(&head->ref);

3745 3746 3747 3748 3749 3750 3751
	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;

3752 3753 3754 3755
	ret = nvme_mpath_alloc_disk(ctrl, head);
	if (ret)
		goto out_cleanup_srcu;

C
Christoph Hellwig 已提交
3756
	list_add_tail(&head->entry, &ctrl->subsys->nsheads);
3757 3758 3759

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

C
Christoph Hellwig 已提交
3760 3761 3762
	return head;
out_cleanup_srcu:
	cleanup_srcu_struct(&head->srcu);
3763
out_ida_remove:
3764
	ida_free(&ctrl->subsys->ns_ida, head->instance);
C
Christoph Hellwig 已提交
3765 3766 3767
out_free_head:
	kfree(head);
out:
3768 3769
	if (ret > 0)
		ret = blk_status_to_errno(nvme_error_status(ret));
C
Christoph Hellwig 已提交
3770 3771 3772
	return ERR_PTR(ret);
}

3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798
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 已提交
3799
static int nvme_init_ns_head(struct nvme_ns *ns, unsigned nsid,
3800
		struct nvme_ns_ids *ids, bool is_shared)
C
Christoph Hellwig 已提交
3801 3802 3803
{
	struct nvme_ctrl *ctrl = ns->ctrl;
	struct nvme_ns_head *head = NULL;
3804 3805 3806 3807 3808 3809 3810 3811
	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 已提交
3812 3813

	mutex_lock(&ctrl->subsys->lock);
3814
	head = nvme_find_ns_head(ctrl, nsid);
C
Christoph Hellwig 已提交
3815
	if (!head) {
3816 3817 3818
		ret = nvme_subsys_check_duplicate_ids(ctrl->subsys, ids);
		if (ret) {
			dev_err(ctrl->device,
3819 3820
				"duplicate IDs in subsystem for nsid %d\n",
				nsid);
3821 3822
			goto out_unlock;
		}
3823
		head = nvme_alloc_ns_head(ctrl, nsid, ids);
C
Christoph Hellwig 已提交
3824 3825 3826 3827
		if (IS_ERR(head)) {
			ret = PTR_ERR(head);
			goto out_unlock;
		}
3828
		head->shared = is_shared;
C
Christoph Hellwig 已提交
3829
	} else {
3830
		ret = -EINVAL;
3831
		if (!is_shared || !head->shared) {
3832
			dev_err(ctrl->device,
3833 3834
				"Duplicate unshared namespace %d\n", nsid);
			goto out_put_ns_head;
3835
		}
3836
		if (!nvme_ns_ids_equal(&head->ids, ids)) {
C
Christoph Hellwig 已提交
3837 3838 3839
			dev_err(ctrl->device,
				"IDs don't match for shared namespace %d\n",
					nsid);
3840
			goto out_put_ns_head;
C
Christoph Hellwig 已提交
3841
		}
3842 3843 3844 3845 3846 3847 3848 3849

		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 已提交
3850 3851
	}

3852
	list_add_tail_rcu(&ns->siblings, &head->list);
C
Christoph Hellwig 已提交
3853
	ns->head = head;
3854 3855
	mutex_unlock(&ctrl->subsys->lock);
	return 0;
C
Christoph Hellwig 已提交
3856

3857 3858
out_put_ns_head:
	nvme_put_ns_head(head);
C
Christoph Hellwig 已提交
3859 3860 3861 3862 3863
out_unlock:
	mutex_unlock(&ctrl->subsys->lock);
	return ret;
}

3864
struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid)
3865
{
3866
	struct nvme_ns *ns, *ret = NULL;
3867

3868
	down_read(&ctrl->namespaces_rwsem);
3869
	list_for_each_entry(ns, &ctrl->namespaces, list) {
C
Christoph Hellwig 已提交
3870
		if (ns->head->ns_id == nsid) {
K
Kanchan Joshi 已提交
3871
			if (!nvme_get_ns(ns))
3872
				continue;
3873 3874 3875
			ret = ns;
			break;
		}
C
Christoph Hellwig 已提交
3876
		if (ns->head->ns_id > nsid)
3877 3878
			break;
	}
3879
	up_read(&ctrl->namespaces_rwsem);
3880
	return ret;
3881
}
3882
EXPORT_SYMBOL_NS_GPL(nvme_find_get_ns, NVME_TARGET_PASSTHRU);
3883

3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899
/*
 * 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);
}

3900 3901
static void nvme_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid,
		struct nvme_ns_ids *ids)
3902 3903 3904
{
	struct nvme_ns *ns;
	struct gendisk *disk;
3905
	struct nvme_id_ns *id;
3906
	int node = ctrl->numa_node;
3907

3908
	if (nvme_identify_ns(ctrl, nsid, ids, &id))
3909 3910
		return;

3911 3912
	ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
	if (!ns)
3913
		goto out_free_id;
3914

C
Christoph Hellwig 已提交
3915 3916
	disk = blk_mq_alloc_disk(ctrl->tagset, ns);
	if (IS_ERR(disk))
C
Christoph Hellwig 已提交
3917
		goto out_free_ns;
C
Christoph Hellwig 已提交
3918 3919 3920 3921 3922
	disk->fops = &nvme_bdev_ops;
	disk->private_data = ns;

	ns->disk = disk;
	ns->queue = disk->queue;
3923

3924
	if (ctrl->opts && ctrl->opts->data_digest)
3925
		blk_queue_flag_set(QUEUE_FLAG_STABLE_WRITES, ns->queue);
3926

3927
	blk_queue_flag_set(QUEUE_FLAG_NONROT, ns->queue);
3928 3929 3930
	if (ctrl->ops->flags & NVME_F_PCI_P2PDMA)
		blk_queue_flag_set(QUEUE_FLAG_PCI_P2PDMA, ns->queue);

3931 3932 3933
	ns->ctrl = ctrl;
	kref_init(&ns->kref);

3934
	if (nvme_init_ns_head(ns, nsid, ids, id->nmic & NVME_NS_NMIC_SHARED))
C
Christoph Hellwig 已提交
3935
		goto out_cleanup_disk;
3936

3937
	/*
3938 3939 3940 3941 3942 3943 3944 3945 3946
	 * 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.
3947
	 */
3948 3949 3950 3951 3952 3953 3954 3955
	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 {
3956 3957
		sprintf(disk->disk_name, "nvme%dn%d", ctrl->instance,
			ns->head->instance);
3958
	}
3959

3960
	if (nvme_update_ns_info(ns, id))
C
Christoph Hellwig 已提交
3961
		goto out_unlink_ns;
3962

3963
	down_write(&ctrl->namespaces_rwsem);
3964
	nvme_ns_add_to_ctrl_list(ns);
3965
	up_write(&ctrl->namespaces_rwsem);
3966
	nvme_get_ctrl(ctrl);
3967

3968 3969 3970
	if (device_add_disk(ctrl->device, ns->disk, nvme_ns_id_attr_groups))
		goto out_cleanup_ns_from_list;

3971 3972
	if (!nvme_ns_head_multipath(ns->head))
		nvme_add_ns_cdev(ns);
3973

C
Christoph Hellwig 已提交
3974
	nvme_mpath_add_disk(ns, id);
3975
	nvme_fault_inject_init(&ns->fault_inject, ns->disk->disk_name);
C
Christoph Hellwig 已提交
3976 3977
	kfree(id);

3978
	return;
C
Christoph Hellwig 已提交
3979

3980 3981 3982 3983 3984
 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 已提交
3985 3986 3987
 out_unlink_ns:
	mutex_lock(&ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
3988 3989
	if (list_empty(&ns->head->list))
		list_del_init(&ns->head->entry);
C
Christoph Hellwig 已提交
3990
	mutex_unlock(&ctrl->subsys->lock);
3991
	nvme_put_ns_head(ns->head);
C
Christoph Hellwig 已提交
3992 3993
 out_cleanup_disk:
	blk_cleanup_disk(disk);
3994 3995
 out_free_ns:
	kfree(ns);
3996 3997
 out_free_id:
	kfree(id);
3998 3999 4000 4001
}

static void nvme_ns_remove(struct nvme_ns *ns)
{
4002 4003
	bool last_path = false;

4004 4005
	if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
		return;
4006

4007
	clear_bit(NVME_NS_READY, &ns->flags);
4008
	set_capacity(ns->disk, 0);
4009
	nvme_fault_inject_fini(&ns->fault_inject);
4010

4011 4012 4013 4014 4015 4016 4017 4018 4019 4020
	/*
	 * 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);

4021 4022
	mutex_lock(&ns->ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
4023 4024 4025 4026
	if (list_empty(&ns->head->list)) {
		list_del_init(&ns->head->entry);
		last_path = true;
	}
4027
	mutex_unlock(&ns->ctrl->subsys->lock);
4028

4029 4030 4031
	/* guarantee not available in head->list */
	synchronize_rcu();

4032 4033 4034 4035
	if (!nvme_ns_head_multipath(ns->head))
		nvme_cdev_del(&ns->cdev, &ns->cdev_device);
	del_gendisk(ns->disk);
	blk_cleanup_queue(ns->queue);
4036

4037
	down_write(&ns->ctrl->namespaces_rwsem);
4038
	list_del_init(&ns->list);
4039
	up_write(&ns->ctrl->namespaces_rwsem);
4040

4041 4042
	if (last_path)
		nvme_mpath_shutdown_disk(ns->head);
4043 4044 4045
	nvme_put_ns(ns);
}

4046 4047 4048 4049 4050 4051 4052 4053 4054 4055
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);
	}
}

4056
static void nvme_validate_ns(struct nvme_ns *ns, struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
4057 4058
{
	struct nvme_id_ns *id;
4059
	int ret = NVME_SC_INVALID_NS | NVME_SC_DNR;
C
Christoph Hellwig 已提交
4060

4061 4062
	if (test_bit(NVME_NS_DEAD, &ns->flags))
		goto out;
C
Christoph Hellwig 已提交
4063

4064
	ret = nvme_identify_ns(ns->ctrl, ns->head->ns_id, ids, &id);
C
Christoph Hellwig 已提交
4065 4066 4067
	if (ret)
		goto out;

4068
	ret = NVME_SC_INVALID_NS | NVME_SC_DNR;
C
Christoph Hellwig 已提交
4069
	if (!nvme_ns_ids_equal(&ns->head->ids, ids)) {
4070
		dev_err(ns->ctrl->device,
C
Christoph Hellwig 已提交
4071
			"identifiers changed for nsid %d\n", ns->head->ns_id);
4072
		goto out_free_id;
C
Christoph Hellwig 已提交
4073 4074 4075
	}

	ret = nvme_update_ns_info(ns, id);
4076 4077

out_free_id:
C
Christoph Hellwig 已提交
4078 4079 4080
	kfree(id);
out:
	/*
4081
	 * Only remove the namespace if we got a fatal error back from the
C
Christoph Hellwig 已提交
4082
	 * device, otherwise ignore the error and just move on.
4083 4084
	 *
	 * TODO: we should probably schedule a delayed retry here.
C
Christoph Hellwig 已提交
4085
	 */
4086
	if (ret > 0 && (ret & NVME_SC_DNR))
4087
		nvme_ns_remove(ns);
C
Christoph Hellwig 已提交
4088 4089
}

4090
static void nvme_validate_or_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid)
4091
{
4092
	struct nvme_ns_ids ids = { };
4093 4094
	struct nvme_ns *ns;

4095 4096
	if (nvme_identify_ns_descs(ctrl, nsid, &ids))
		return;
4097

4098
	ns = nvme_find_get_ns(ctrl, nsid);
4099
	if (ns) {
4100
		nvme_validate_ns(ns, &ids);
4101
		nvme_put_ns(ns);
4102 4103 4104
		return;
	}

4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115
	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;
		}
4116 4117 4118
		if (!nvme_multi_css(ctrl)) {
			dev_warn(ctrl->device,
				"command set not reported for nsid: %d\n",
4119
				nsid);
4120 4121
			break;
		}
4122 4123 4124 4125 4126 4127 4128
		nvme_alloc_ns(ctrl, nsid, &ids);
		break;
	default:
		dev_warn(ctrl->device, "unknown csi %u for nsid %u\n",
			ids.csi, nsid);
		break;
	}
4129 4130
}

4131 4132 4133 4134
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					unsigned nsid)
{
	struct nvme_ns *ns, *next;
4135
	LIST_HEAD(rm_list);
4136

4137
	down_write(&ctrl->namespaces_rwsem);
4138
	list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) {
4139
		if (ns->head->ns_id > nsid || test_bit(NVME_NS_DEAD, &ns->flags))
4140
			list_move_tail(&ns->list, &rm_list);
4141
	}
4142
	up_write(&ctrl->namespaces_rwsem);
4143 4144 4145 4146

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

4147 4148
}

4149
static int nvme_scan_ns_list(struct nvme_ctrl *ctrl)
4150
{
4151
	const int nr_entries = NVME_IDENTIFY_DATA_SIZE / sizeof(__le32);
4152
	__le32 *ns_list;
4153 4154
	u32 prev = 0;
	int ret = 0, i;
4155

4156 4157
	if (nvme_ctrl_limited_cns(ctrl))
		return -EOPNOTSUPP;
4158

4159
	ns_list = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
4160 4161 4162
	if (!ns_list)
		return -ENOMEM;

4163
	for (;;) {
4164 4165 4166 4167 4168 4169 4170 4171
		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);
4172 4173 4174
		if (ret) {
			dev_warn(ctrl->device,
				"Identify NS List failed (status=0x%x)\n", ret);
4175
			goto free;
4176
		}
4177

4178
		for (i = 0; i < nr_entries; i++) {
4179
			u32 nsid = le32_to_cpu(ns_list[i]);
4180

4181 4182
			if (!nsid)	/* end of the list? */
				goto out;
4183
			nvme_validate_or_alloc_ns(ctrl, nsid);
4184 4185
			while (++prev < nsid)
				nvme_ns_remove_by_nsid(ctrl, prev);
4186 4187 4188
		}
	}
 out:
4189 4190
	nvme_remove_invalid_namespaces(ctrl, prev);
 free:
4191 4192 4193 4194
	kfree(ns_list);
	return ret;
}

4195
static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl)
4196
{
4197 4198 4199 4200 4201 4202 4203
	struct nvme_id_ctrl *id;
	u32 nn, i;

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

4205
	for (i = 1; i <= nn; i++)
4206
		nvme_validate_or_alloc_ns(ctrl, i);
4207

4208
	nvme_remove_invalid_namespaces(ctrl, nn);
4209 4210
}

4211
static void nvme_clear_changed_ns_log(struct nvme_ctrl *ctrl)
4212 4213 4214
{
	size_t log_size = NVME_MAX_CHANGED_NAMESPACES * sizeof(__le32);
	__le32 *log;
4215
	int error;
4216 4217 4218

	log = kzalloc(log_size, GFP_KERNEL);
	if (!log)
4219
		return;
4220

4221 4222 4223 4224 4225 4226
	/*
	 * 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.
	 */
4227 4228
	error = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CHANGED_NS, 0,
			NVME_CSI_NVM, log, log_size, 0);
4229
	if (error)
4230 4231 4232 4233 4234 4235
		dev_warn(ctrl->device,
			"reading changed ns log failed: %d\n", error);

	kfree(log);
}

4236
static void nvme_scan_work(struct work_struct *work)
4237
{
4238 4239
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, scan_work);
4240

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

D
Dan Carpenter 已提交
4245
	if (test_and_clear_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events)) {
4246
		dev_info(ctrl->device, "rescanning namespaces.\n");
4247
		nvme_clear_changed_ns_log(ctrl);
4248 4249
	}

4250
	mutex_lock(&ctrl->scan_lock);
4251 4252
	if (nvme_scan_ns_list(ctrl) != 0)
		nvme_scan_ns_sequential(ctrl);
4253
	mutex_unlock(&ctrl->scan_lock);
4254
}
4255

4256 4257 4258 4259 4260
/*
 * 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.
 */
4261 4262 4263
void nvme_remove_namespaces(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns, *next;
4264
	LIST_HEAD(ns_list);
4265

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

4273 4274 4275
	/* prevent racing with ns scanning */
	flush_work(&ctrl->scan_work);

4276 4277 4278 4279 4280 4281 4282 4283 4284
	/*
	 * 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);

4285 4286 4287
	/* this is a no-op when called from the controller reset handler */
	nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING_NOIO);

4288
	down_write(&ctrl->namespaces_rwsem);
4289
	list_splice_init(&ctrl->namespaces, &ns_list);
4290
	up_write(&ctrl->namespaces_rwsem);
4291 4292

	list_for_each_entry_safe(ns, next, &ns_list, list)
4293 4294
		nvme_ns_remove(ns);
}
4295
EXPORT_SYMBOL_GPL(nvme_remove_namespaces);
4296

4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319
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");
4320 4321 4322 4323 4324
		if (ret)
			return ret;

		ret = add_uevent_var(env, "NVME_HOST_IFACE=%s",
				opts->host_iface ?: "none");
4325 4326 4327 4328
	}
	return ret;
}

4329 4330 4331 4332 4333 4334 4335
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);
}

4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351
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]);
}

4352 4353 4354 4355 4356
static void nvme_async_event_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, async_event_work);

4357
	nvme_aen_uevent(ctrl);
4358 4359 4360 4361 4362 4363 4364 4365

	/*
	 * 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);
4366 4367
}

4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389
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;

4390 4391
	if (nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_FW_SLOT, 0, NVME_CSI_NVM,
			log, sizeof(*log), 0))
4392
		dev_warn(ctrl->device, "Get FW SLOT INFO log error\n");
4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413
	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");
4414 4415
			nvme_try_sched_reset(ctrl);
			return;
4416 4417 4418 4419
		}
		msleep(100);
	}

4420
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE))
4421 4422 4423
		return;

	nvme_start_queues(ctrl);
4424
	/* read FW slot information to clear the AER */
4425 4426 4427
	nvme_get_fw_slot_info(ctrl);
}

4428 4429
static void nvme_handle_aen_notice(struct nvme_ctrl *ctrl, u32 result)
{
4430 4431
	u32 aer_notice_type = (result & 0xff00) >> 8;

4432 4433
	trace_nvme_async_event(ctrl, aer_notice_type);

4434
	switch (aer_notice_type) {
4435
	case NVME_AER_NOTICE_NS_CHANGED:
D
Dan Carpenter 已提交
4436
		set_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events);
4437 4438 4439
		nvme_queue_scan(ctrl);
		break;
	case NVME_AER_NOTICE_FW_ACT_STARTING:
4440 4441 4442 4443 4444 4445 4446
		/*
		 * 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);
4447
		break;
C
Christoph Hellwig 已提交
4448 4449 4450 4451 4452 4453 4454
#ifdef CONFIG_NVME_MULTIPATH
	case NVME_AER_NOTICE_ANA:
		if (!ctrl->ana_log_buf)
			break;
		queue_work(nvme_wq, &ctrl->ana_work);
		break;
#endif
4455 4456 4457
	case NVME_AER_NOTICE_DISC_CHANGED:
		ctrl->aen_result = result;
		break;
4458 4459 4460 4461 4462
	default:
		dev_warn(ctrl->device, "async event result %08x\n", result);
	}
}

4463
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
4464
		volatile union nvme_result *res)
4465
{
4466
	u32 result = le32_to_cpu(res->u32);
4467
	u32 aer_type = result & 0x07;
4468

4469
	if (le16_to_cpu(status) >> 1 != NVME_SC_SUCCESS)
4470 4471
		return;

4472
	switch (aer_type) {
4473 4474 4475
	case NVME_AER_NOTICE:
		nvme_handle_aen_notice(ctrl, result);
		break;
4476 4477 4478 4479
	case NVME_AER_ERROR:
	case NVME_AER_SMART:
	case NVME_AER_CSS:
	case NVME_AER_VS:
4480
		trace_nvme_async_event(ctrl, aer_type);
4481
		ctrl->aen_result = result;
4482 4483 4484
		break;
	default:
		break;
4485
	}
4486
	queue_work(nvme_wq, &ctrl->async_event_work);
4487 4488
}
EXPORT_SYMBOL_GPL(nvme_complete_async_event);
4489

4490
void nvme_stop_ctrl(struct nvme_ctrl *ctrl)
4491
{
C
Christoph Hellwig 已提交
4492
	nvme_mpath_stop(ctrl);
4493
	nvme_stop_keep_alive(ctrl);
4494
	nvme_stop_failfast_work(ctrl);
4495
	flush_work(&ctrl->async_event_work);
4496
	cancel_work_sync(&ctrl->fw_act_work);
4497 4498 4499 4500 4501
}
EXPORT_SYMBOL_GPL(nvme_stop_ctrl);

void nvme_start_ctrl(struct nvme_ctrl *ctrl)
{
4502
	nvme_start_keep_alive(ctrl);
4503

4504 4505
	nvme_enable_aen(ctrl);

4506 4507 4508
	if (ctrl->queue_count > 1) {
		nvme_queue_scan(ctrl);
		nvme_start_queues(ctrl);
4509
		nvme_mpath_update(ctrl);
4510
	}
4511 4512

	nvme_change_uevent(ctrl, "NVME_EVENT=connected");
4513 4514
}
EXPORT_SYMBOL_GPL(nvme_start_ctrl);
4515

4516 4517
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl)
{
4518
	nvme_hwmon_exit(ctrl);
4519
	nvme_fault_inject_fini(&ctrl->fault_inject);
4520
	dev_pm_qos_hide_latency_tolerance(ctrl->device);
4521
	cdev_device_del(&ctrl->cdev, ctrl->device);
4522
	nvme_put_ctrl(ctrl);
4523
}
4524
EXPORT_SYMBOL_GPL(nvme_uninit_ctrl);
4525

4526 4527 4528 4529 4530
static void nvme_free_cels(struct nvme_ctrl *ctrl)
{
	struct nvme_effects_log	*cel;
	unsigned long i;

4531
	xa_for_each(&ctrl->cels, i, cel) {
4532 4533 4534 4535 4536 4537 4538
		xa_erase(&ctrl->cels, i);
		kfree(cel);
	}

	xa_destroy(&ctrl->cels);
}

4539
static void nvme_free_ctrl(struct device *dev)
4540
{
4541 4542
	struct nvme_ctrl *ctrl =
		container_of(dev, struct nvme_ctrl, ctrl_device);
C
Christoph Hellwig 已提交
4543
	struct nvme_subsystem *subsys = ctrl->subsys;
4544

K
Keith Busch 已提交
4545
	if (!subsys || ctrl->instance != subsys->instance)
4546
		ida_free(&nvme_instance_ida, ctrl->instance);
4547

4548
	nvme_free_cels(ctrl);
C
Christoph Hellwig 已提交
4549
	nvme_mpath_uninit(ctrl);
S
Sagi Grimberg 已提交
4550
	__free_page(ctrl->discard_page);
4551

C
Christoph Hellwig 已提交
4552
	if (subsys) {
4553
		mutex_lock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4554 4555
		list_del(&ctrl->subsys_entry);
		sysfs_remove_link(&subsys->dev.kobj, dev_name(ctrl->device));
4556
		mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4557
	}
4558 4559 4560

	ctrl->ops->free_ctrl(ctrl);

C
Christoph Hellwig 已提交
4561 4562
	if (subsys)
		nvme_put_subsystem(subsys);
4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574
}

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

4575
	ctrl->state = NVME_CTRL_NEW;
4576
	clear_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags);
4577
	spin_lock_init(&ctrl->lock);
4578
	mutex_init(&ctrl->scan_lock);
4579
	INIT_LIST_HEAD(&ctrl->namespaces);
4580
	xa_init(&ctrl->cels);
4581
	init_rwsem(&ctrl->namespaces_rwsem);
4582 4583 4584
	ctrl->dev = dev;
	ctrl->ops = ops;
	ctrl->quirks = quirks;
4585
	ctrl->numa_node = NUMA_NO_NODE;
4586
	INIT_WORK(&ctrl->scan_work, nvme_scan_work);
4587
	INIT_WORK(&ctrl->async_event_work, nvme_async_event_work);
4588
	INIT_WORK(&ctrl->fw_act_work, nvme_fw_act_work);
4589
	INIT_WORK(&ctrl->delete_work, nvme_delete_ctrl_work);
4590
	init_waitqueue_head(&ctrl->state_wq);
4591

4592
	INIT_DELAYED_WORK(&ctrl->ka_work, nvme_keep_alive_work);
4593
	INIT_DELAYED_WORK(&ctrl->failfast_work, nvme_failfast_work);
4594 4595 4596
	memset(&ctrl->ka_cmd, 0, sizeof(ctrl->ka_cmd));
	ctrl->ka_cmd.common.opcode = nvme_admin_keep_alive;

4597 4598 4599 4600 4601 4602 4603 4604
	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;
	}

4605
	ret = ida_alloc(&nvme_instance_ida, GFP_KERNEL);
4606
	if (ret < 0)
4607
		goto out;
4608
	ctrl->instance = ret;
4609

4610 4611
	device_initialize(&ctrl->ctrl_device);
	ctrl->device = &ctrl->ctrl_device;
4612 4613
	ctrl->device->devt = MKDEV(MAJOR(nvme_ctrl_base_chr_devt),
			ctrl->instance);
4614 4615 4616 4617 4618 4619 4620
	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)
4621 4622
		goto out_release_instance;

4623
	nvme_get_ctrl(ctrl);
4624 4625 4626
	cdev_init(&ctrl->cdev, &nvme_dev_fops);
	ctrl->cdev.owner = ops->module;
	ret = cdev_device_add(&ctrl->cdev, ctrl->device);
4627 4628
	if (ret)
		goto out_free_name;
4629

4630 4631 4632 4633 4634 4635 4636 4637
	/*
	 * 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));

4638
	nvme_fault_inject_init(&ctrl->fault_inject, dev_name(ctrl->device));
4639
	nvme_mpath_init_ctrl(ctrl);
4640

4641
	return 0;
4642
out_free_name:
4643
	nvme_put_ctrl(ctrl);
4644
	kfree_const(ctrl->device->kobj.name);
4645
out_release_instance:
4646
	ida_free(&nvme_instance_ida, ctrl->instance);
4647
out:
4648 4649
	if (ctrl->discard_page)
		__free_page(ctrl->discard_page);
4650 4651
	return ret;
}
4652
EXPORT_SYMBOL_GPL(nvme_init_ctrl);
4653

4654 4655
static void nvme_start_ns_queue(struct nvme_ns *ns)
{
M
Ming Lei 已提交
4656 4657
	if (test_and_clear_bit(NVME_NS_STOPPED, &ns->flags))
		blk_mq_unquiesce_queue(ns->queue);
4658 4659 4660 4661
}

static void nvme_stop_ns_queue(struct nvme_ns *ns)
{
M
Ming Lei 已提交
4662 4663
	if (!test_and_set_bit(NVME_NS_STOPPED, &ns->flags))
		blk_mq_quiesce_queue(ns->queue);
M
Ming Lei 已提交
4664 4665
	else
		blk_mq_wait_quiesce_done(ns->queue);
4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680
}

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

4681
	blk_mark_disk_dead(ns->disk);
4682 4683 4684 4685 4686
	nvme_start_ns_queue(ns);

	set_capacity_and_notify(ns->disk, 0);
}

4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697
/**
 * 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;

4698
	down_read(&ctrl->namespaces_rwsem);
M
Ming Lei 已提交
4699

4700
	/* Forcibly unquiesce queues to avoid blocking dispatch */
I
Igor Konopko 已提交
4701
	if (ctrl->admin_q && !blk_queue_dying(ctrl->admin_q))
4702
		nvme_start_admin_queue(ctrl);
4703

4704 4705
	list_for_each_entry(ns, &ctrl->namespaces, list)
		nvme_set_queue_dying(ns);
4706

4707
	up_read(&ctrl->namespaces_rwsem);
4708
}
4709
EXPORT_SYMBOL_GPL(nvme_kill_queues);
4710

K
Keith Busch 已提交
4711 4712 4713 4714
void nvme_unfreeze(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

4715
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4716 4717
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_unfreeze_queue(ns->queue);
4718
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4719 4720 4721
}
EXPORT_SYMBOL_GPL(nvme_unfreeze);

4722
int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout)
K
Keith Busch 已提交
4723 4724 4725
{
	struct nvme_ns *ns;

4726
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4727 4728 4729 4730 4731
	list_for_each_entry(ns, &ctrl->namespaces, list) {
		timeout = blk_mq_freeze_queue_wait_timeout(ns->queue, timeout);
		if (timeout <= 0)
			break;
	}
4732
	up_read(&ctrl->namespaces_rwsem);
4733
	return timeout;
K
Keith Busch 已提交
4734 4735 4736 4737 4738 4739 4740
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze_timeout);

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

4741
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4742 4743
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_freeze_queue_wait(ns->queue);
4744
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4745 4746 4747 4748 4749 4750 4751
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze);

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

4752
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4753
	list_for_each_entry(ns, &ctrl->namespaces, list)
4754
		blk_freeze_queue_start(ns->queue);
4755
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4756 4757 4758
}
EXPORT_SYMBOL_GPL(nvme_start_freeze);

4759
void nvme_stop_queues(struct nvme_ctrl *ctrl)
4760 4761 4762
{
	struct nvme_ns *ns;

4763
	down_read(&ctrl->namespaces_rwsem);
4764
	list_for_each_entry(ns, &ctrl->namespaces, list)
4765
		nvme_stop_ns_queue(ns);
4766
	up_read(&ctrl->namespaces_rwsem);
4767
}
4768
EXPORT_SYMBOL_GPL(nvme_stop_queues);
4769

4770
void nvme_start_queues(struct nvme_ctrl *ctrl)
4771 4772 4773
{
	struct nvme_ns *ns;

4774
	down_read(&ctrl->namespaces_rwsem);
4775
	list_for_each_entry(ns, &ctrl->namespaces, list)
4776
		nvme_start_ns_queue(ns);
4777
	up_read(&ctrl->namespaces_rwsem);
4778
}
4779
EXPORT_SYMBOL_GPL(nvme_start_queues);
4780

4781 4782
void nvme_stop_admin_queue(struct nvme_ctrl *ctrl)
{
M
Ming Lei 已提交
4783 4784
	if (!test_and_set_bit(NVME_CTRL_ADMIN_Q_STOPPED, &ctrl->flags))
		blk_mq_quiesce_queue(ctrl->admin_q);
M
Ming Lei 已提交
4785 4786
	else
		blk_mq_wait_quiesce_done(ctrl->admin_q);
4787 4788 4789 4790 4791
}
EXPORT_SYMBOL_GPL(nvme_stop_admin_queue);

void nvme_start_admin_queue(struct nvme_ctrl *ctrl)
{
M
Ming Lei 已提交
4792 4793
	if (test_and_clear_bit(NVME_CTRL_ADMIN_Q_STOPPED, &ctrl->flags))
		blk_mq_unquiesce_queue(ctrl->admin_q);
4794 4795 4796
}
EXPORT_SYMBOL_GPL(nvme_start_admin_queue);

C
Chao Leng 已提交
4797
void nvme_sync_io_queues(struct nvme_ctrl *ctrl)
K
Keith Busch 已提交
4798 4799 4800 4801 4802 4803 4804
{
	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 已提交
4805 4806
}
EXPORT_SYMBOL_GPL(nvme_sync_io_queues);
4807

C
Chao Leng 已提交
4808 4809 4810
void nvme_sync_queues(struct nvme_ctrl *ctrl)
{
	nvme_sync_io_queues(ctrl);
4811 4812
	if (ctrl->admin_q)
		blk_sync_queue(ctrl->admin_q);
K
Keith Busch 已提交
4813 4814 4815
}
EXPORT_SYMBOL_GPL(nvme_sync_queues);

4816
struct nvme_ctrl *nvme_ctrl_from_file(struct file *file)
4817
{
4818 4819 4820
	if (file->f_op != &nvme_dev_fops)
		return NULL;
	return file->private_data;
4821
}
4822
EXPORT_SYMBOL_NS_GPL(nvme_ctrl_from_file, NVME_TARGET_PASSTHRU);
4823

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


4854
static int __init nvme_core_init(void)
4855
{
4856
	int result = -ENOMEM;
4857

4858 4859
	_nvme_check_size();

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

4875 4876
	result = alloc_chrdev_region(&nvme_ctrl_base_chr_devt, 0,
			NVME_MINORS, "nvme");
4877
	if (result < 0)
4878
		goto destroy_delete_wq;
4879 4880 4881 4882 4883 4884

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

C
Christoph Hellwig 已提交
4887 4888 4889 4890 4891
	nvme_subsys_class = class_create(THIS_MODULE, "nvme-subsystem");
	if (IS_ERR(nvme_subsys_class)) {
		result = PTR_ERR(nvme_subsys_class);
		goto destroy_class;
	}
4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903

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

4904
	return 0;
4905

4906 4907 4908 4909
unregister_generic_ns:
	unregister_chrdev_region(nvme_ns_chr_devt, NVME_MINORS);
destroy_subsys_class:
	class_destroy(nvme_subsys_class);
C
Christoph Hellwig 已提交
4910 4911
destroy_class:
	class_destroy(nvme_class);
4912
unregister_chrdev:
4913
	unregister_chrdev_region(nvme_ctrl_base_chr_devt, NVME_MINORS);
4914 4915 4916 4917
destroy_delete_wq:
	destroy_workqueue(nvme_delete_wq);
destroy_reset_wq:
	destroy_workqueue(nvme_reset_wq);
4918 4919
destroy_wq:
	destroy_workqueue(nvme_wq);
4920
out:
4921
	return result;
4922 4923
}

4924
static void __exit nvme_core_exit(void)
4925
{
4926
	class_destroy(nvme_ns_chr_class);
C
Christoph Hellwig 已提交
4927
	class_destroy(nvme_subsys_class);
4928
	class_destroy(nvme_class);
4929
	unregister_chrdev_region(nvme_ns_chr_devt, NVME_MINORS);
4930
	unregister_chrdev_region(nvme_ctrl_base_chr_devt, NVME_MINORS);
4931 4932
	destroy_workqueue(nvme_delete_wq);
	destroy_workqueue(nvme_reset_wq);
4933
	destroy_workqueue(nvme_wq);
4934
	ida_destroy(&nvme_ns_chr_minor_ida);
M
Max Gurtovoy 已提交
4935
	ida_destroy(&nvme_instance_ida);
4936
}
4937 4938 4939 4940 4941

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