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

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

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

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

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

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

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

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

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

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

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

60 61 62 63 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
static bool streams;
module_param(streams, bool, 0644);
MODULE_PARM_DESC(streams, "turn on support for Streams write directives");

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

98 99 100 101 102 103
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 已提交
104 105
static LIST_HEAD(nvme_subsystems);
static DEFINE_MUTEX(nvme_subsystems_lock);
106

107
static DEFINE_IDA(nvme_instance_ida);
108
static dev_t nvme_ctrl_base_chr_devt;
109
static struct class *nvme_class;
C
Christoph Hellwig 已提交
110
static struct class *nvme_subsys_class;
111

112 113 114 115
static DEFINE_IDA(nvme_ns_chr_minor_ida);
static dev_t nvme_ns_chr_devt;
static struct class *nvme_ns_chr_class;

116
static void nvme_put_subsystem(struct nvme_subsystem *subsys);
117 118
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					   unsigned nsid);
119 120
static void nvme_update_keep_alive(struct nvme_ctrl *ctrl,
				   struct nvme_command *cmd);
121

122 123 124 125 126 127 128 129
/*
 * 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.
 */
130 131
static void nvme_set_queue_dying(struct nvme_ns *ns)
{
C
Christoph Hellwig 已提交
132
	if (test_and_set_bit(NVME_NS_DEAD, &ns->flags))
133
		return;
134

135 136
	blk_set_queue_dying(ns->queue);
	blk_mq_unquiesce_queue(ns->queue);
137

138
	set_capacity_and_notify(ns->disk, 0);
139
}
140

141
void nvme_queue_scan(struct nvme_ctrl *ctrl)
142 143 144 145
{
	/*
	 * Only new queue scan work when admin and IO queues are both alive
	 */
K
Keith Busch 已提交
146
	if (ctrl->state == NVME_CTRL_LIVE && ctrl->tagset)
147 148 149
		queue_work(nvme_wq, &ctrl->scan_work);
}

150 151 152 153 154 155
/*
 * 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.
 */
156
int nvme_try_sched_reset(struct nvme_ctrl *ctrl)
157 158 159 160 161 162 163
{
	if (ctrl->state != NVME_CTRL_RESETTING)
		return -EBUSY;
	if (!queue_work(nvme_reset_wq, &ctrl->reset_work))
		return -EBUSY;
	return 0;
}
164
EXPORT_SYMBOL_GPL(nvme_try_sched_reset);
165

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
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);
}


198 199 200 201
int nvme_reset_ctrl(struct nvme_ctrl *ctrl)
{
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
		return -EBUSY;
202
	if (!queue_work(nvme_reset_wq, &ctrl->reset_work))
203 204 205 206 207
		return -EBUSY;
	return 0;
}
EXPORT_SYMBOL_GPL(nvme_reset_ctrl);

208
int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl)
209 210 211 212
{
	int ret;

	ret = nvme_reset_ctrl(ctrl);
213
	if (!ret) {
214
		flush_work(&ctrl->reset_work);
K
Keith Busch 已提交
215
		if (ctrl->state != NVME_CTRL_LIVE)
216 217 218
			ret = -ENETRESET;
	}

219 220 221
	return ret;
}

222
static void nvme_do_delete_ctrl(struct nvme_ctrl *ctrl)
223
{
224 225 226
	dev_info(ctrl->device,
		 "Removing ctrl: NQN \"%s\"\n", ctrl->opts->subsysnqn);

227
	flush_work(&ctrl->reset_work);
228 229
	nvme_stop_ctrl(ctrl);
	nvme_remove_namespaces(ctrl);
230
	ctrl->ops->delete_ctrl(ctrl);
231
	nvme_uninit_ctrl(ctrl);
232 233
}

234 235 236 237 238 239 240 241
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);
}

242 243 244 245
int nvme_delete_ctrl(struct nvme_ctrl *ctrl)
{
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
		return -EBUSY;
246
	if (!queue_work(nvme_delete_wq, &ctrl->delete_work))
247 248 249 250 251
		return -EBUSY;
	return 0;
}
EXPORT_SYMBOL_GPL(nvme_delete_ctrl);

252
static void nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl)
253 254
{
	/*
255 256
	 * Keep a reference until nvme_do_delete_ctrl() complete,
	 * since ->delete_ctrl can free the controller.
257 258
	 */
	nvme_get_ctrl(ctrl);
259
	if (nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
260
		nvme_do_delete_ctrl(ctrl);
261 262 263
	nvme_put_ctrl(ctrl);
}

264
static blk_status_t nvme_error_status(u16 status)
265
{
266
	switch (status & 0x7ff) {
267
	case NVME_SC_SUCCESS:
268
		return BLK_STS_OK;
269
	case NVME_SC_CAP_EXCEEDED:
270
		return BLK_STS_NOSPC;
271
	case NVME_SC_LBA_RANGE:
272 273
	case NVME_SC_CMD_INTERRUPTED:
	case NVME_SC_NS_NOT_READY:
274 275
		return BLK_STS_TARGET;
	case NVME_SC_BAD_ATTRIBUTES:
276
	case NVME_SC_ONCS_NOT_SUPPORTED:
277 278 279
	case NVME_SC_INVALID_OPCODE:
	case NVME_SC_INVALID_FIELD:
	case NVME_SC_INVALID_NS:
280
		return BLK_STS_NOTSUPP;
281 282 283
	case NVME_SC_WRITE_FAULT:
	case NVME_SC_READ_ERROR:
	case NVME_SC_UNWRITTEN_BLOCK:
284 285
	case NVME_SC_ACCESS_DENIED:
	case NVME_SC_READ_ONLY:
286
	case NVME_SC_COMPARE_FAILED:
287
		return BLK_STS_MEDIUM;
288 289 290 291 292 293 294
	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;
295 296
	case NVME_SC_HOST_PATH_ERROR:
		return BLK_STS_TRANSPORT;
K
Keith Busch 已提交
297 298 299 300
	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;
301 302
	default:
		return BLK_STS_IOERR;
303 304 305
	}
}

306 307 308 309 310 311 312
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;
313 314
	if (crd)
		delay = nvme_req(req)->ctrl->crdt[crd - 1] * 100;
315 316 317 318 319 320

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

321 322 323 324 325 326 327
enum nvme_disposition {
	COMPLETE,
	RETRY,
	FAILOVER,
};

static inline enum nvme_disposition nvme_decide_disposition(struct request *req)
328
{
329 330
	if (likely(nvme_req(req)->status == 0))
		return COMPLETE;
331

332 333 334 335
	if (blk_noretry_request(req) ||
	    (nvme_req(req)->status & NVME_SC_DNR) ||
	    nvme_req(req)->retries >= nvme_max_retries)
		return COMPLETE;
336

337
	if (req->cmd_flags & REQ_NVME_MPATH) {
338 339
		if (nvme_is_path_error(nvme_req(req)->status) ||
		    blk_queue_dying(req->q))
340
			return FAILOVER;
341 342 343
	} else {
		if (blk_queue_dying(req->q))
			return COMPLETE;
344
	}
345

346 347
	return RETRY;
}
348

349 350 351
static inline void nvme_end_req(struct request *req)
{
	blk_status_t status = nvme_error_status(nvme_req(req)->status);
352

353 354
	if (IS_ENABLED(CONFIG_BLK_DEV_ZONED) &&
	    req_op(req) == REQ_OP_ZONE_APPEND)
K
Keith Busch 已提交
355 356
		req->__sector = nvme_lba_to_sect(req->q->queuedata,
			le64_to_cpu(nvme_req(req)->result.u64));
H
Hannes Reinecke 已提交
357

358
	nvme_trace_bio_complete(req);
359
	blk_mq_end_request(req, status);
360
}
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381

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;
	}
}
382 383
EXPORT_SYMBOL_GPL(nvme_complete_rq);

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
/*
 * 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);

399
bool nvme_cancel_request(struct request *req, void *data, bool reserved)
400 401 402 403
{
	dev_dbg_ratelimited(((struct nvme_ctrl *) data)->device,
				"Cancelling I/O %d", req->tag);

404 405 406 407
	/* don't abort one completed request */
	if (blk_mq_request_completed(req))
		return true;

408
	nvme_req(req)->status = NVME_SC_HOST_ABORTED_CMD;
409
	nvme_req(req)->flags |= NVME_REQ_CANCELLED;
410
	blk_mq_complete_request(req);
411
	return true;
412 413 414
}
EXPORT_SYMBOL_GPL(nvme_cancel_request);

C
Chao Leng 已提交
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
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);

435 436 437
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state)
{
438
	enum nvme_ctrl_state old_state;
439
	unsigned long flags;
440 441
	bool changed = false;

442
	spin_lock_irqsave(&ctrl->lock, flags);
443 444

	old_state = ctrl->state;
445 446 447
	switch (new_state) {
	case NVME_CTRL_LIVE:
		switch (old_state) {
448
		case NVME_CTRL_NEW:
449
		case NVME_CTRL_RESETTING:
450
		case NVME_CTRL_CONNECTING:
451
			changed = true;
452
			fallthrough;
453 454 455 456 457 458 459
		default:
			break;
		}
		break;
	case NVME_CTRL_RESETTING:
		switch (old_state) {
		case NVME_CTRL_NEW:
460 461
		case NVME_CTRL_LIVE:
			changed = true;
462
			fallthrough;
463 464 465 466
		default:
			break;
		}
		break;
467
	case NVME_CTRL_CONNECTING:
468
		switch (old_state) {
469
		case NVME_CTRL_NEW:
470
		case NVME_CTRL_RESETTING:
471
			changed = true;
472
			fallthrough;
473 474 475 476 477 478 479 480
		default:
			break;
		}
		break;
	case NVME_CTRL_DELETING:
		switch (old_state) {
		case NVME_CTRL_LIVE:
		case NVME_CTRL_RESETTING:
481
		case NVME_CTRL_CONNECTING:
482
			changed = true;
483
			fallthrough;
484 485 486 487
		default:
			break;
		}
		break;
488 489 490 491 492
	case NVME_CTRL_DELETING_NOIO:
		switch (old_state) {
		case NVME_CTRL_DELETING:
		case NVME_CTRL_DEAD:
			changed = true;
493
			fallthrough;
494 495 496 497
		default:
			break;
		}
		break;
498 499 500 501
	case NVME_CTRL_DEAD:
		switch (old_state) {
		case NVME_CTRL_DELETING:
			changed = true;
502
			fallthrough;
503 504 505 506
		default:
			break;
		}
		break;
507 508 509 510
	default:
		break;
	}

511
	if (changed) {
512
		ctrl->state = new_state;
513 514
		wake_up_all(&ctrl->state_wq);
	}
515

516
	spin_unlock_irqrestore(&ctrl->lock, flags);
517 518 519 520 521 522
	if (!changed)
		return false;

	if (ctrl->state == NVME_CTRL_LIVE) {
		if (old_state == NVME_CTRL_CONNECTING)
			nvme_stop_failfast_work(ctrl);
523
		nvme_kick_requeue_lists(ctrl);
524 525 526 527
	} else if (ctrl->state == NVME_CTRL_CONNECTING &&
		old_state == NVME_CTRL_RESETTING) {
		nvme_start_failfast_work(ctrl);
	}
528 529 530 531
	return changed;
}
EXPORT_SYMBOL_GPL(nvme_change_ctrl_state);

532 533 534 535 536 537 538 539 540 541 542 543
/*
 * 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:
544
	case NVME_CTRL_DELETING_NOIO:
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
	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 已提交
566 567 568 569 570
static void nvme_free_ns_head(struct kref *ref)
{
	struct nvme_ns_head *head =
		container_of(ref, struct nvme_ns_head, ref);

571
	nvme_mpath_remove_disk(head);
C
Christoph Hellwig 已提交
572
	ida_simple_remove(&head->subsys->ns_ida, head->instance);
573
	cleanup_srcu_struct(&head->srcu);
574
	nvme_put_subsystem(head->subsys);
C
Christoph Hellwig 已提交
575 576 577
	kfree(head);
}

578
bool nvme_tryget_ns_head(struct nvme_ns_head *head)
579 580 581 582
{
	return kref_get_unless_zero(&head->ref);
}

583
void nvme_put_ns_head(struct nvme_ns_head *head)
C
Christoph Hellwig 已提交
584 585 586 587
{
	kref_put(&head->ref, nvme_free_ns_head);
}

588 589 590 591 592
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 已提交
593
	nvme_put_ns_head(ns->head);
594
	nvme_put_ctrl(ns->ctrl);
595 596 597
	kfree(ns);
}

K
Kanchan Joshi 已提交
598 599 600 601 602
static inline bool nvme_get_ns(struct nvme_ns *ns)
{
	return kref_get_unless_zero(&ns->kref);
}

603
void nvme_put_ns(struct nvme_ns *ns)
604 605 606
{
	kref_put(&ns->kref, nvme_free_ns);
}
607
EXPORT_SYMBOL_NS_GPL(nvme_put_ns, NVME_TARGET_PASSTHRU);
608

609 610
static inline void nvme_clear_nvme_request(struct request *req)
{
611
	nvme_req(req)->status = 0;
612 613 614
	nvme_req(req)->retries = 0;
	nvme_req(req)->flags = 0;
	req->rq_flags |= RQF_DONTPREP;
615 616
}

617
static inline unsigned int nvme_req_op(struct nvme_command *cmd)
618
{
619 620
	return nvme_is_write(cmd) ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN;
}
621

622 623 624
static inline void nvme_init_request(struct request *req,
		struct nvme_command *cmd)
{
625 626 627
	if (req->q->queuedata)
		req->timeout = NVME_IO_TIMEOUT;
	else /* no queuedata implies admin queue */
628
		req->timeout = NVME_ADMIN_TIMEOUT;
629

630 631 632
	/* passthru commands should let the driver set the SGL flags */
	cmd->common.flags &= ~NVME_CMD_SGL_ALL;

633
	req->cmd_flags |= REQ_FAILFAST_DRIVER;
634 635
	if (req->mq_hctx->type == HCTX_TYPE_POLL)
		req->cmd_flags |= REQ_HIPRI;
636
	nvme_clear_nvme_request(req);
637
	memcpy(nvme_req(req)->cmd, cmd, sizeof(*cmd));
638
}
639

640 641 642 643 644 645 646 647
struct request *nvme_alloc_request(struct request_queue *q,
		struct nvme_command *cmd, blk_mq_req_flags_t flags)
{
	struct request *req;

	req = blk_mq_alloc_request(q, nvme_req_op(cmd), flags);
	if (!IS_ERR(req))
		nvme_init_request(req, cmd);
648 649
	return req;
}
650
EXPORT_SYMBOL_GPL(nvme_alloc_request);
651

652
static struct request *nvme_alloc_request_qid(struct request_queue *q,
653 654 655 656 657 658 659 660 661 662 663
		struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid)
{
	struct request *req;

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

664 665 666 667 668 669 670 671 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 719 720 721 722 723
/*
 * 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 &&
	    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);

724 725
static int nvme_toggle_streams(struct nvme_ctrl *ctrl, bool enable)
{
726
	struct nvme_command c = { };
727 728

	c.directive.opcode = nvme_admin_directive_send;
A
Arnav Dawn 已提交
729
	c.directive.nsid = cpu_to_le32(NVME_NSID_ALL);
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
	c.directive.doper = NVME_DIR_SND_ID_OP_ENABLE;
	c.directive.dtype = NVME_DIR_IDENTIFY;
	c.directive.tdtype = NVME_DIR_STREAMS;
	c.directive.endir = enable ? NVME_DIR_ENDIR : 0;

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

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

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

static int nvme_get_stream_params(struct nvme_ctrl *ctrl,
				  struct streams_directive_params *s, u32 nsid)
{
751
	struct nvme_command c = { };
752 753 754 755 756

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

	c.directive.opcode = nvme_admin_directive_recv;
	c.directive.nsid = cpu_to_le32(nsid);
K
Keith Busch 已提交
757
	c.directive.numd = cpu_to_le32(nvme_bytes_to_numd(sizeof(*s)));
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
	c.directive.doper = NVME_DIR_RCV_ST_OP_PARAM;
	c.directive.dtype = NVME_DIR_STREAMS;

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

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

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

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

A
Arnav Dawn 已提交
778
	ret = nvme_get_stream_params(ctrl, &s, NVME_NSID_ALL);
779
	if (ret)
780
		goto out_disable_stream;
781 782 783 784 785

	ctrl->nssa = le16_to_cpu(s.nssa);
	if (ctrl->nssa < BLK_MAX_WRITE_HINTS - 1) {
		dev_info(ctrl->device, "too few streams (%u) available\n",
					ctrl->nssa);
786
		goto out_disable_stream;
787 788
	}

789
	ctrl->nr_streams = min_t(u16, ctrl->nssa, BLK_MAX_WRITE_HINTS - 1);
790 791
	dev_info(ctrl->device, "Using %u streams\n", ctrl->nr_streams);
	return 0;
792 793 794 795

out_disable_stream:
	nvme_disable_streams(ctrl);
	return ret;
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
}

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

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

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

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

M
Ming Lin 已提交
823 824 825 826
static inline void nvme_setup_flush(struct nvme_ns *ns,
		struct nvme_command *cmnd)
{
	cmnd->common.opcode = nvme_cmd_flush;
C
Christoph Hellwig 已提交
827
	cmnd->common.nsid = cpu_to_le32(ns->head->ns_id);
M
Ming Lin 已提交
828 829
}

830
static blk_status_t nvme_setup_discard(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
831 832
		struct nvme_command *cmnd)
{
833
	unsigned short segments = blk_rq_nr_discard_segments(req), n = 0;
M
Ming Lin 已提交
834
	struct nvme_dsm_range *range;
835
	struct bio *bio;
M
Ming Lin 已提交
836

837 838 839 840 841 842 843 844
	/*
	 * 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);
845 846 847 848 849 850 851 852 853 854 855
	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 已提交
856

857
	__rq_for_each_bio(bio, req) {
858
		u64 slba = nvme_sect_to_lba(ns, bio->bi_iter.bi_sector);
859 860
		u32 nlb = bio->bi_iter.bi_size >> ns->lba_shift;

K
Keith Busch 已提交
861 862 863 864 865
		if (n < segments) {
			range[n].cattr = cpu_to_le32(0);
			range[n].nlb = cpu_to_le32(nlb);
			range[n].slba = cpu_to_le64(slba);
		}
866 867 868 869
		n++;
	}

	if (WARN_ON_ONCE(n != segments)) {
870 871 872 873
		if (virt_to_page(range) == ns->ctrl->discard_page)
			clear_bit_unlock(0, &ns->ctrl->discard_page_busy);
		else
			kfree(range);
874
		return BLK_STS_IOERR;
875
	}
M
Ming Lin 已提交
876 877

	cmnd->dsm.opcode = nvme_cmd_dsm;
C
Christoph Hellwig 已提交
878
	cmnd->dsm.nsid = cpu_to_le32(ns->head->ns_id);
879
	cmnd->dsm.nr = cpu_to_le32(segments - 1);
M
Ming Lin 已提交
880 881
	cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);

882 883
	req->special_vec.bv_page = virt_to_page(range);
	req->special_vec.bv_offset = offset_in_page(range);
884
	req->special_vec.bv_len = alloc_size;
885
	req->rq_flags |= RQF_SPECIAL_PAYLOAD;
M
Ming Lin 已提交
886

887
	return BLK_STS_OK;
M
Ming Lin 已提交
888 889
}

890 891 892 893 894 895 896 897 898
static inline blk_status_t nvme_setup_write_zeroes(struct nvme_ns *ns,
		struct request *req, struct nvme_command *cmnd)
{
	if (ns->ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
		return nvme_setup_discard(ns, req, cmnd);

	cmnd->write_zeroes.opcode = nvme_cmd_write_zeroes;
	cmnd->write_zeroes.nsid = cpu_to_le32(ns->head->ns_id);
	cmnd->write_zeroes.slba =
899
		cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
900 901
	cmnd->write_zeroes.length =
		cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
902 903 904 905
	if (nvme_ns_has_pi(ns))
		cmnd->write_zeroes.control = cpu_to_le16(NVME_RW_PRINFO_PRACT);
	else
		cmnd->write_zeroes.control = 0;
906 907 908
	return BLK_STS_OK;
}

909
static inline blk_status_t nvme_setup_rw(struct nvme_ns *ns,
K
Keith Busch 已提交
910 911
		struct request *req, struct nvme_command *cmnd,
		enum nvme_opcode op)
M
Ming Lin 已提交
912
{
913
	struct nvme_ctrl *ctrl = ns->ctrl;
M
Ming Lin 已提交
914 915 916 917 918 919 920 921 922 923 924
	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 已提交
925
	cmnd->rw.opcode = op;
C
Christoph Hellwig 已提交
926
	cmnd->rw.nsid = cpu_to_le32(ns->head->ns_id);
927
	cmnd->rw.slba = cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
M
Ming Lin 已提交
928 929
	cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);

930 931 932
	if (req_op(req) == REQ_OP_WRITE && ctrl->nr_streams)
		nvme_assign_write_stream(ctrl, req, &control, &dsmgmt);

M
Ming Lin 已提交
933
	if (ns->ms) {
934 935 936 937 938 939 940 941 942 943 944 945
		/*
		 * 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 已提交
946 947 948 949 950 951 952 953
		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 已提交
954 955
			if (op == nvme_cmd_zone_append)
				control |= NVME_RW_APPEND_PIREMAP;
956
			cmnd->rw.reftag = cpu_to_le32(t10_pi_ref_tag(req));
M
Ming Lin 已提交
957 958 959 960 961 962
			break;
		}
	}

	cmnd->rw.control = cpu_to_le16(control);
	cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
963
	return 0;
M
Ming Lin 已提交
964 965
}

966 967 968
void nvme_cleanup_cmd(struct request *req)
{
	if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
M
Minwoo Im 已提交
969
		struct nvme_ctrl *ctrl = nvme_req(req)->ctrl;
970

C
Christoph Hellwig 已提交
971
		if (req->special_vec.bv_page == ctrl->discard_page)
M
Minwoo Im 已提交
972
			clear_bit_unlock(0, &ctrl->discard_page_busy);
973
		else
C
Christoph Hellwig 已提交
974
			kfree(bvec_virt(&req->special_vec));
975 976 977 978
	}
}
EXPORT_SYMBOL_GPL(nvme_cleanup_cmd);

979
blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req)
M
Ming Lin 已提交
980
{
981
	struct nvme_command *cmd = nvme_req(req)->cmd;
982
	blk_status_t ret = BLK_STS_OK;
M
Ming Lin 已提交
983

984
	if (!(req->rq_flags & RQF_DONTPREP)) {
985
		nvme_clear_nvme_request(req);
986 987
		memset(cmd, 0, sizeof(*cmd));
	}
988

989 990 991
	switch (req_op(req)) {
	case REQ_OP_DRV_IN:
	case REQ_OP_DRV_OUT:
992
		/* these are setup prior to execution in nvme_init_request() */
993 994
		break;
	case REQ_OP_FLUSH:
M
Ming Lin 已提交
995
		nvme_setup_flush(ns, cmd);
996
		break;
K
Keith Busch 已提交
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
	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;
1010
	case REQ_OP_WRITE_ZEROES:
1011 1012
		ret = nvme_setup_write_zeroes(ns, req, cmd);
		break;
1013
	case REQ_OP_DISCARD:
M
Ming Lin 已提交
1014
		ret = nvme_setup_discard(ns, req, cmd);
1015 1016
		break;
	case REQ_OP_READ:
K
Keith Busch 已提交
1017 1018
		ret = nvme_setup_rw(ns, req, cmd, nvme_cmd_read);
		break;
1019
	case REQ_OP_WRITE:
K
Keith Busch 已提交
1020 1021 1022 1023
		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);
1024 1025 1026
		break;
	default:
		WARN_ON_ONCE(1);
1027
		return BLK_STS_IOERR;
1028
	}
M
Ming Lin 已提交
1029

1030 1031
	nvme_req(req)->genctr++;
	cmd->common.command_id = nvme_cid(req);
K
Keith Busch 已提交
1032
	trace_nvme_setup_cmd(req, cmd);
M
Ming Lin 已提交
1033 1034 1035 1036
	return ret;
}
EXPORT_SYMBOL_GPL(nvme_setup_cmd);

1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
/*
 * Return values:
 * 0:  success
 * >0: nvme controller's cqe status response
 * <0: kernel error in lieu of controller response
 */
static int nvme_execute_rq(struct gendisk *disk, struct request *rq,
		bool at_head)
{
	blk_status_t status;

	status = blk_execute_rq(disk, rq, at_head);
	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);
}

1056 1057 1058 1059 1060
/*
 * 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,
1061
		union nvme_result *result, void *buffer, unsigned bufflen,
1062
		unsigned timeout, int qid, int at_head,
1063
		blk_mq_req_flags_t flags)
1064 1065 1066 1067
{
	struct request *req;
	int ret;

1068 1069 1070 1071
	if (qid == NVME_QID_ANY)
		req = nvme_alloc_request(q, cmd, flags);
	else
		req = nvme_alloc_request_qid(q, cmd, flags, qid);
1072 1073 1074
	if (IS_ERR(req))
		return PTR_ERR(req);

1075 1076
	if (timeout)
		req->timeout = timeout;
1077

1078 1079 1080 1081
	if (buffer && bufflen) {
		ret = blk_rq_map_kern(q, req, buffer, bufflen, GFP_KERNEL);
		if (ret)
			goto out;
1082 1083
	}

1084 1085
	ret = nvme_execute_rq(NULL, req, at_head);
	if (result && ret >= 0)
1086
		*result = nvme_req(req)->result;
1087 1088 1089 1090
 out:
	blk_mq_free_request(req);
	return ret;
}
1091
EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd);
1092 1093 1094 1095

int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
		void *buffer, unsigned bufflen)
{
1096
	return __nvme_submit_sync_cmd(q, cmd, NULL, buffer, bufflen, 0,
1097
			NVME_QID_ANY, 0, 0);
1098
}
1099
EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd);
1100

1101 1102 1103 1104
static u32 nvme_known_admin_effects(u8 opcode)
{
	switch (opcode) {
	case nvme_admin_format_nvm:
1105
		return NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_NCC |
1106 1107
			NVME_CMD_EFFECTS_CSE_MASK;
	case nvme_admin_sanitize_nvm:
1108
		return NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_CSE_MASK;
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
	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))
1123 1124 1125
			dev_warn_once(ctrl->device,
				"IO command:%02x has unhandled effects:%08x\n",
				opcode, effects);
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
		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.
	 */
1146
	if (effects & NVME_CMD_EFFECTS_CSE_MASK) {
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
		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;
}

1157 1158
static void nvme_passthru_end(struct nvme_ctrl *ctrl, u32 effects,
			      struct nvme_command *cmd, int status)
1159
{
1160
	if (effects & NVME_CMD_EFFECTS_CSE_MASK) {
1161 1162 1163 1164 1165 1166 1167
		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)
1168
		nvme_init_ctrl_finish(ctrl);
1169 1170 1171 1172
	if (effects & (NVME_CMD_EFFECTS_NIC | NVME_CMD_EFFECTS_NCC)) {
		nvme_queue_scan(ctrl);
		flush_work(&ctrl->scan_work);
	}
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192

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

1195
int nvme_execute_passthru_rq(struct request *rq)
1196 1197 1198 1199 1200 1201
{
	struct nvme_command *cmd = nvme_req(rq)->cmd;
	struct nvme_ctrl *ctrl = nvme_req(rq)->ctrl;
	struct nvme_ns *ns = rq->q->queuedata;
	struct gendisk *disk = ns ? ns->disk : NULL;
	u32 effects;
1202
	int  ret;
1203 1204

	effects = nvme_passthru_start(ctrl, ns, cmd->common.opcode);
1205
	ret = nvme_execute_rq(disk, rq, false);
1206
	if (effects) /* nothing to be done for zero cmd effects */
1207
		nvme_passthru_end(ctrl, effects, cmd, ret);
1208 1209

	return ret;
1210 1211 1212
}
EXPORT_SYMBOL_NS_GPL(nvme_execute_passthru_rq, NVME_TARGET_PASSTHRU);

H
Hannes Reinecke 已提交
1213 1214 1215 1216 1217 1218 1219
/*
 * 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)
1220
{
H
Hannes Reinecke 已提交
1221
	queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ / 2);
1222 1223
}

1224
static void nvme_keep_alive_end_io(struct request *rq, blk_status_t status)
S
Sagi Grimberg 已提交
1225 1226
{
	struct nvme_ctrl *ctrl = rq->end_io_data;
1227 1228
	unsigned long flags;
	bool startka = false;
S
Sagi Grimberg 已提交
1229 1230 1231

	blk_mq_free_request(rq);

1232
	if (status) {
S
Sagi Grimberg 已提交
1233
		dev_err(ctrl->device,
1234 1235
			"failed nvme_keep_alive_end_io error=%d\n",
				status);
S
Sagi Grimberg 已提交
1236 1237 1238
		return;
	}

1239
	ctrl->comp_seen = false;
1240 1241 1242 1243 1244 1245
	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 已提交
1246
		nvme_queue_keep_alive_work(ctrl);
S
Sagi Grimberg 已提交
1247 1248 1249 1250 1251 1252
}

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);
1253
	bool comp_seen = ctrl->comp_seen;
1254
	struct request *rq;
1255 1256 1257 1258 1259

	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 已提交
1260
		nvme_queue_keep_alive_work(ctrl);
1261 1262
		return;
	}
S
Sagi Grimberg 已提交
1263

1264
	rq = nvme_alloc_request(ctrl->admin_q, &ctrl->ka_cmd,
1265
				BLK_MQ_REQ_RESERVED | BLK_MQ_REQ_NOWAIT);
1266
	if (IS_ERR(rq)) {
S
Sagi Grimberg 已提交
1267
		/* allocation failure, reset the controller */
1268
		dev_err(ctrl->device, "keep-alive failed: %ld\n", PTR_ERR(rq));
1269
		nvme_reset_ctrl(ctrl);
S
Sagi Grimberg 已提交
1270 1271
		return;
	}
1272 1273 1274 1275

	rq->timeout = ctrl->kato * HZ;
	rq->end_io_data = ctrl;
	blk_execute_rq_nowait(NULL, rq, 0, nvme_keep_alive_end_io);
S
Sagi Grimberg 已提交
1276 1277
}

1278
static void nvme_start_keep_alive(struct nvme_ctrl *ctrl)
S
Sagi Grimberg 已提交
1279 1280 1281 1282
{
	if (unlikely(ctrl->kato == 0))
		return;

H
Hannes Reinecke 已提交
1283
	nvme_queue_keep_alive_work(ctrl);
S
Sagi Grimberg 已提交
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
}

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

1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
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);
}

1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
/*
 * 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 已提交
1323
static int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id)
1324 1325 1326 1327 1328 1329
{
	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;
1330
	c.identify.cns = NVME_ID_CNS_CTRL;
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342

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

1343
static int nvme_process_ns_desc(struct nvme_ctrl *ctrl, struct nvme_ns_ids *ids,
1344
		struct nvme_ns_id_desc *cur, bool *csi_seen)
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
{
	const char *warn_str = "ctrl returned bogus length:";
	void *data = cur;

	switch (cur->nidt) {
	case NVME_NIDT_EUI64:
		if (cur->nidl != NVME_NIDT_EUI64_LEN) {
			dev_warn(ctrl->device, "%s %d for NVME_NIDT_EUI64\n",
				 warn_str, cur->nidl);
			return -1;
		}
		memcpy(ids->eui64, data + sizeof(*cur), NVME_NIDT_EUI64_LEN);
		return NVME_NIDT_EUI64_LEN;
	case NVME_NIDT_NGUID:
		if (cur->nidl != NVME_NIDT_NGUID_LEN) {
			dev_warn(ctrl->device, "%s %d for NVME_NIDT_NGUID\n",
				 warn_str, cur->nidl);
			return -1;
		}
		memcpy(ids->nguid, data + sizeof(*cur), NVME_NIDT_NGUID_LEN);
		return NVME_NIDT_NGUID_LEN;
	case NVME_NIDT_UUID:
		if (cur->nidl != NVME_NIDT_UUID_LEN) {
			dev_warn(ctrl->device, "%s %d for NVME_NIDT_UUID\n",
				 warn_str, cur->nidl);
			return -1;
		}
		uuid_copy(&ids->uuid, data + sizeof(*cur));
		return NVME_NIDT_UUID_LEN;
1374 1375 1376 1377 1378 1379 1380 1381 1382
	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;
1383 1384 1385 1386 1387 1388
	default:
		/* Skip unknown types */
		return cur->nidl;
	}
}

1389
static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl, unsigned nsid,
1390
		struct nvme_ns_ids *ids)
1391 1392
{
	struct nvme_command c = { };
1393 1394
	bool csi_seen = false;
	int status, pos, len;
1395 1396
	void *data;

1397 1398
	if (ctrl->vs < NVME_VS(1, 3, 0) && !nvme_multi_css(ctrl))
		return 0;
1399 1400 1401
	if (ctrl->quirks & NVME_QUIRK_NO_NS_DESC_LIST)
		return 0;

1402 1403 1404 1405 1406 1407 1408 1409
	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;

1410
	status = nvme_submit_sync_cmd(ctrl->admin_q, &c, data,
1411
				      NVME_IDENTIFY_DATA_SIZE);
1412 1413
	if (status) {
		dev_warn(ctrl->device,
1414 1415
			"Identify Descriptors failed (nsid=%u, status=0x%x)\n",
			nsid, status);
1416
		goto free_data;
1417
	}
1418 1419 1420 1421 1422 1423 1424

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

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

1425
		len = nvme_process_ns_desc(ctrl, ids, cur, &csi_seen);
1426
		if (len < 0)
1427
			break;
1428 1429 1430

		len += sizeof(*cur);
	}
1431 1432 1433 1434 1435 1436 1437

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

1438 1439 1440 1441 1442
free_data:
	kfree(data);
	return status;
}

1443 1444
static int nvme_identify_ns(struct nvme_ctrl *ctrl, unsigned nsid,
			struct nvme_ns_ids *ids, struct nvme_id_ns **id)
1445 1446 1447 1448 1449
{
	struct nvme_command c = { };
	int error;

	/* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1450 1451
	c.identify.opcode = nvme_admin_identify;
	c.identify.nsid = cpu_to_le32(nsid);
1452
	c.identify.cns = NVME_ID_CNS_NS;
1453

1454 1455 1456
	*id = kmalloc(sizeof(**id), GFP_KERNEL);
	if (!*id)
		return -ENOMEM;
1457

1458
	error = nvme_submit_sync_cmd(ctrl->admin_q, &c, *id, sizeof(**id));
1459
	if (error) {
1460
		dev_warn(ctrl->device, "Identify namespace failed (%d)\n", error);
1461
		goto out_free_id;
1462 1463
	}

1464
	error = NVME_SC_INVALID_NS | NVME_SC_DNR;
1465 1466
	if ((*id)->ncap == 0) /* namespace not allocated or attached */
		goto out_free_id;
1467 1468 1469 1470 1471 1472 1473 1474

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

1475 1476 1477 1478
	return 0;

out_free_id:
	kfree(*id);
1479
	return error;
1480 1481
}

K
Keith Busch 已提交
1482 1483
static int nvme_features(struct nvme_ctrl *dev, u8 op, unsigned int fid,
		unsigned int dword11, void *buffer, size_t buflen, u32 *result)
1484
{
1485
	union nvme_result res = { 0 };
1486
	struct nvme_command c = { };
1487
	int ret;
1488

K
Keith Busch 已提交
1489
	c.features.opcode = op;
1490 1491 1492
	c.features.fid = cpu_to_le32(fid);
	c.features.dword11 = cpu_to_le32(dword11);

1493
	ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &res,
1494
			buffer, buflen, 0, NVME_QID_ANY, 0, 0);
1495
	if (ret >= 0 && result)
1496
		*result = le32_to_cpu(res.u32);
1497
	return ret;
1498 1499
}

K
Keith Busch 已提交
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
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 已提交
1518 1519 1520 1521 1522 1523
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;

1524
	status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, NULL, 0,
C
Christoph Hellwig 已提交
1525
			&result);
1526
	if (status < 0)
C
Christoph Hellwig 已提交
1527 1528
		return status;

1529 1530 1531 1532 1533 1534
	/*
	 * 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) {
1535
		dev_err(ctrl->device, "Could not set queue count (%d)\n", status);
1536 1537 1538 1539 1540 1541
		*count = 0;
	} else {
		nr_io_queues = min(result & 0xffff, result >> 16) + 1;
		*count = min(*count, nr_io_queues);
	}

C
Christoph Hellwig 已提交
1542 1543
	return 0;
}
1544
EXPORT_SYMBOL_GPL(nvme_set_queue_count);
C
Christoph Hellwig 已提交
1545

1546
#define NVME_AEN_SUPPORTED \
1547 1548
	(NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_FW_ACT | \
	 NVME_AEN_CFG_ANA_CHANGE | NVME_AEN_CFG_DISC_CHANGE)
1549 1550 1551

static void nvme_enable_aen(struct nvme_ctrl *ctrl)
{
1552
	u32 result, supported_aens = ctrl->oaes & NVME_AEN_SUPPORTED;
1553 1554
	int status;

1555 1556 1557 1558 1559
	if (!supported_aens)
		return;

	status = nvme_set_features(ctrl, NVME_FEAT_ASYNC_EVENT, supported_aens,
			NULL, 0, &result);
1560 1561
	if (status)
		dev_warn(ctrl->device, "Failed to configure AEN (cfg %x)\n",
1562
			 supported_aens);
1563 1564

	queue_work(nvme_wq, &ctrl->async_event_work);
1565 1566
}

1567
static int nvme_ns_open(struct nvme_ns *ns)
1568 1569
{

1570
	/* should never be called due to GENHD_FL_HIDDEN */
1571
	if (WARN_ON_ONCE(nvme_ns_head_multipath(ns->head)))
1572
		goto fail;
K
Kanchan Joshi 已提交
1573
	if (!nvme_get_ns(ns))
1574 1575 1576 1577
		goto fail;
	if (!try_module_get(ns->ctrl->ops->module))
		goto fail_put_ns;

C
Christoph Hellwig 已提交
1578
	return 0;
1579 1580 1581 1582 1583

fail_put_ns:
	nvme_put_ns(ns);
fail:
	return -ENXIO;
1584 1585
}

1586
static void nvme_ns_release(struct nvme_ns *ns)
1587
{
1588 1589 1590

	module_put(ns->ctrl->ops->module);
	nvme_put_ns(ns);
1591 1592
}

1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
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);
}

1603
int nvme_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1604 1605 1606 1607 1608 1609 1610 1611 1612
{
	/* 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
1613 1614
static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type,
				u32 max_integrity_segments)
1615
{
1616
	struct blk_integrity integrity = { };
1617

1618
	switch (pi_type) {
1619 1620
	case NVME_NS_DPS_PI_TYPE3:
		integrity.profile = &t10_pi_type3_crc;
1621 1622
		integrity.tag_size = sizeof(u16) + sizeof(u32);
		integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1623 1624 1625 1626
		break;
	case NVME_NS_DPS_PI_TYPE1:
	case NVME_NS_DPS_PI_TYPE2:
		integrity.profile = &t10_pi_type1_crc;
1627 1628
		integrity.tag_size = sizeof(u16);
		integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1629 1630 1631 1632 1633
		break;
	default:
		integrity.profile = NULL;
		break;
	}
1634 1635
	integrity.tuple_size = ms;
	blk_integrity_register(disk, &integrity);
1636
	blk_queue_max_integrity_segments(disk->queue, max_integrity_segments);
1637 1638
}
#else
1639 1640
static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type,
				u32 max_integrity_segments)
1641 1642 1643 1644
{
}
#endif /* CONFIG_BLK_DEV_INTEGRITY */

1645
static void nvme_config_discard(struct gendisk *disk, struct nvme_ns *ns)
1646
{
1647
	struct nvme_ctrl *ctrl = ns->ctrl;
1648
	struct request_queue *queue = disk->queue;
1649 1650
	u32 size = queue_logical_block_size(queue);

1651
	if (ctrl->max_discard_sectors == 0) {
1652 1653 1654 1655 1656 1657
		blk_queue_flag_clear(QUEUE_FLAG_DISCARD, queue);
		return;
	}

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

1659 1660 1661
	BUILD_BUG_ON(PAGE_SIZE / sizeof(struct nvme_dsm_range) <
			NVME_DSM_MAX_RANGES);

1662
	queue->limits.discard_alignment = 0;
1663
	queue->limits.discard_granularity = size;
1664

1665 1666 1667 1668
	/* If discard is already enabled, don't reset queue limits */
	if (blk_queue_flag_test_and_set(QUEUE_FLAG_DISCARD, queue))
		return;

1669 1670
	blk_queue_max_discard_sectors(queue, ctrl->max_discard_sectors);
	blk_queue_max_discard_segments(queue, ctrl->max_discard_segments);
1671 1672

	if (ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
1673
		blk_queue_max_write_zeroes_sectors(queue, UINT_MAX);
1674 1675
}

C
Christoph Hellwig 已提交
1676 1677 1678 1679 1680 1681 1682
static bool nvme_ns_ids_valid(struct nvme_ns_ids *ids)
{
	return !uuid_is_null(&ids->uuid) ||
		memchr_inv(ids->nguid, 0, sizeof(ids->nguid)) ||
		memchr_inv(ids->eui64, 0, sizeof(ids->eui64));
}

1683 1684 1685 1686
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 &&
1687 1688
		memcmp(&a->eui64, &b->eui64, sizeof(a->eui64)) == 0 &&
		a->csi == b->csi;
1689 1690
}

K
Keith Busch 已提交
1691 1692
static int nvme_setup_streams_ns(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
				 u32 *phys_bs, u32 *io_opt)
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707
{
	struct streams_directive_params s;
	int ret;

	if (!ctrl->nr_streams)
		return 0;

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

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

	if (ns->sws) {
K
Keith Busch 已提交
1708
		*phys_bs = ns->sws * (1 << ns->lba_shift);
1709
		if (ns->sgs)
K
Keith Busch 已提交
1710
			*io_opt = *phys_bs * ns->sgs;
1711 1712 1713 1714 1715
	}

	return 0;
}

1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
static int nvme_configure_metadata(struct nvme_ns *ns, struct nvme_id_ns *id)
{
	struct nvme_ctrl *ctrl = ns->ctrl;

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

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

	return 0;
}

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

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

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

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

1842
	set_capacity_and_notify(disk, capacity);
1843

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

1848 1849
	set_disk_ro(disk, (id->nsattr & NVME_NS_ATTR_RO) ||
		test_bit(NVME_NS_FORCE_RO, &ns->flags));
1850 1851
}

1852 1853 1854
static inline bool nvme_first_scan(struct gendisk *disk)
{
	/* nvme_alloc_ns() scans the disk prior to adding it */
C
Christoph Hellwig 已提交
1855
	return !disk_live(disk);
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 1885 1886 1887 1888
}

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

1889
static int nvme_update_ns_info(struct nvme_ns *ns, struct nvme_id_ns *id)
1890
{
K
Keith Busch 已提交
1891 1892
	unsigned lbaf = id->flbas & NVME_NS_FLBAS_LBA_MASK;
	int ret;
1893

1894
	blk_mq_freeze_queue(ns->disk->queue);
K
Keith Busch 已提交
1895
	ns->lba_shift = id->lbaf[lbaf].ds;
1896
	nvme_set_queue_limits(ns->ctrl, ns->queue);
1897

1898 1899 1900 1901 1902 1903
	ret = nvme_configure_metadata(ns, id);
	if (ret)
		goto out_unfreeze;
	nvme_set_chunk_sectors(ns, id);
	nvme_update_disk_info(ns->disk, ns, id);

1904
	if (ns->head->ids.csi == NVME_CSI_ZNS) {
1905
		ret = nvme_update_zone_info(ns, lbaf);
1906
		if (ret)
1907
			goto out_unfreeze;
1908 1909
	}

1910
	set_bit(NVME_NS_READY, &ns->flags);
1911
	blk_mq_unfreeze_queue(ns->disk->queue);
1912

1913 1914
	if (blk_queue_is_zoned(ns->queue)) {
		ret = nvme_revalidate_zones(ns);
1915
		if (ret && !nvme_first_scan(ns->disk))
1916
			goto out;
1917 1918
	}

1919
	if (nvme_ns_head_multipath(ns->head)) {
1920
		blk_mq_freeze_queue(ns->head->disk->queue);
1921
		nvme_update_disk_info(ns->head->disk, ns, id);
1922
		nvme_mpath_revalidate_paths(ns);
1923 1924
		blk_stack_limits(&ns->head->disk->queue->limits,
				 &ns->queue->limits, 0);
1925
		disk_update_readahead(ns->head->disk);
1926
		blk_mq_unfreeze_queue(ns->head->disk->queue);
1927
	}
1928
	return 0;
1929

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

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

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

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

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

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

1999 2000 2001 2002
	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);
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 2034
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return ret;
}
2219
EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl);
2220

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

2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257
static int nvme_configure_acre(struct nvme_ctrl *ctrl)
{
	struct nvme_feat_host_behavior *host;
	int ret;

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

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

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

2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286
/*
 * 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;
}

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

	/*
	 * If APST isn't supported or if we haven't been initialized yet,
	 * then don't do anything.
	 */
	if (!ctrl->apsta)
2328
		return 0;
2329 2330 2331

	if (ctrl->npss > 31) {
		dev_warn(ctrl->device, "NPSS is invalid; not using APST\n");
2332
		return 0;
2333 2334 2335 2336
	}

	table = kzalloc(sizeof(*table), GFP_KERNEL);
	if (!table)
2337
		return 0;
2338

2339
	if (!ctrl->apst_enabled || ctrl->ps_max_latency_us == 0) {
2340
		/* Turn off APST. */
2341
		dev_dbg(ctrl->device, "APST disabled\n");
2342 2343
		goto done;
	}
2344

2345 2346 2347 2348 2349 2350 2351 2352
	/*
	 * 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;
2353

2354 2355
		if (target)
			table->entries[state] = target;
2356 2357

		/*
2358 2359
		 * Don't allow transitions to the deepest state if it's quirked
		 * off.
2360
		 */
2361 2362 2363
		if (state == ctrl->npss &&
		    (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS))
			continue;
2364

2365 2366 2367 2368 2369 2370
		/*
		 * 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;
2371

2372 2373 2374
		exit_latency_us = (u64)le32_to_cpu(ctrl->psd[state].exit_lat);
		if (exit_latency_us > ctrl->ps_max_latency_us)
			continue;
2375

2376 2377
		total_latency_us = exit_latency_us +
			le32_to_cpu(ctrl->psd[state].entry_lat);
2378

2379
		/*
2380 2381
		 * This state is good. It can be used as the APST idle target
		 * for higher power states.
2382
		 */
2383 2384 2385 2386 2387 2388 2389 2390 2391 2392
		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;
		}
2393 2394 2395 2396 2397 2398

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

2401 2402 2403 2404 2405 2406 2407 2408
	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:
2409 2410 2411 2412 2413
	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);
2414
	return ret;
2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433
}

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;
2434 2435
		if (ctrl->state == NVME_CTRL_LIVE)
			nvme_configure_apst(ctrl);
2436 2437 2438
	}
}

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

/* 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 已提交
2502 2503
static void nvme_init_subnqn(struct nvme_subsystem *subsys, struct nvme_ctrl *ctrl,
		struct nvme_id_ctrl *id)
2504 2505 2506 2507
{
	size_t nqnlen;
	int off;

2508 2509 2510 2511 2512 2513
	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;
		}
2514

2515 2516 2517
		if (ctrl->vs >= NVME_VS(1, 2, 1))
			dev_warn(ctrl->device, "missing or invalid SUBNQN field.\n");
	}
2518 2519

	/* Generate a "fake" NQN per Figure 254 in NVMe 1.3 + ECN 001 */
C
Christoph Hellwig 已提交
2520
	off = snprintf(subsys->subnqn, NVMF_NQN_SIZE,
2521
			"nqn.2014.08.org.nvmexpress:%04x%04x",
2522
			le16_to_cpu(id->vid), le16_to_cpu(id->ssvid));
C
Christoph Hellwig 已提交
2523
	memcpy(subsys->subnqn + off, id->sn, sizeof(id->sn));
2524
	off += sizeof(id->sn);
C
Christoph Hellwig 已提交
2525
	memcpy(subsys->subnqn + off, id->mn, sizeof(id->mn));
2526
	off += sizeof(id->mn);
C
Christoph Hellwig 已提交
2527 2528 2529
	memset(subsys->subnqn + off, 0, sizeof(subsys->subnqn) - off);
}

2530
static void nvme_release_subsystem(struct device *dev)
C
Christoph Hellwig 已提交
2531
{
2532 2533 2534
	struct nvme_subsystem *subsys =
		container_of(dev, struct nvme_subsystem, dev);

2535 2536
	if (subsys->instance >= 0)
		ida_simple_remove(&nvme_instance_ida, subsys->instance);
C
Christoph Hellwig 已提交
2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548
	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 已提交
2549
	ida_destroy(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564
	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);

2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575
	/*
	 * 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 已提交
2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586
	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;
}

2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597
#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);

2598
	return sysfs_emit(buf, "%s\n", subsys->subnqn);
2599 2600 2601 2602 2603 2604 2605 2606 2607
}
static SUBSYS_ATTR_RO(subsysnqn, S_IRUGO, nvme_subsys_show_nqn);

#define nvme_subsys_show_str_function(field)				\
static ssize_t subsys_##field##_show(struct device *dev,		\
			    struct device_attribute *attr, char *buf)	\
{									\
	struct nvme_subsystem *subsys =					\
		container_of(dev, struct nvme_subsystem, dev);		\
2608 2609
	return sysfs_emit(buf, "%.*s\n",				\
			   (int)sizeof(subsys->field), subsys->field);	\
2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621
}									\
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,
2622 2623 2624
#ifdef CONFIG_NVME_MULTIPATH
	&subsys_attr_iopolicy.attr,
#endif
2625 2626 2627
	NULL,
};

2628
static const struct attribute_group nvme_subsys_attrs_group = {
2629 2630 2631 2632 2633 2634 2635 2636
	.attrs = nvme_subsys_attrs,
};

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

2637 2638 2639 2640 2641
static inline bool nvme_discovery_ctrl(struct nvme_ctrl *ctrl)
{
	return ctrl->opts && ctrl->opts->discovery_nqn;
}

2642 2643
static bool nvme_validate_cntlid(struct nvme_subsystem *subsys,
		struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
2644
{
2645
	struct nvme_ctrl *tmp;
2646

2647 2648
	lockdep_assert_held(&nvme_subsystems_lock);

2649
	list_for_each_entry(tmp, &subsys->ctrls, subsys_entry) {
2650
		if (nvme_state_terminal(tmp))
2651 2652 2653 2654 2655 2656 2657 2658
			continue;

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

2660
		if ((id->cmic & NVME_CTRL_CMIC_MULTI_CTRL) ||
2661
		    nvme_discovery_ctrl(ctrl))
2662 2663 2664 2665 2666
			continue;

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

2669
	return true;
2670 2671
}

C
Christoph Hellwig 已提交
2672 2673 2674 2675 2676 2677 2678 2679
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;
2680 2681

	subsys->instance = -1;
C
Christoph Hellwig 已提交
2682 2683 2684
	mutex_init(&subsys->lock);
	kref_init(&subsys->ref);
	INIT_LIST_HEAD(&subsys->ctrls);
C
Christoph Hellwig 已提交
2685
	INIT_LIST_HEAD(&subsys->nsheads);
C
Christoph Hellwig 已提交
2686 2687 2688 2689 2690 2691
	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;
2692
	subsys->awupf = le16_to_cpu(id->awupf);
2693 2694 2695
#ifdef CONFIG_NVME_MULTIPATH
	subsys->iopolicy = NVME_IOPOLICY_NUMA;
#endif
C
Christoph Hellwig 已提交
2696 2697 2698

	subsys->dev.class = nvme_subsys_class;
	subsys->dev.release = nvme_release_subsystem;
2699
	subsys->dev.groups = nvme_subsys_attrs_groups;
2700
	dev_set_name(&subsys->dev, "nvme-subsys%d", ctrl->instance);
C
Christoph Hellwig 已提交
2701 2702 2703 2704 2705
	device_initialize(&subsys->dev);

	mutex_lock(&nvme_subsystems_lock);
	found = __nvme_find_get_subsystem(subsys->subnqn);
	if (found) {
2706
		put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2707
		subsys = found;
2708

2709
		if (!nvme_validate_cntlid(subsys, ctrl, id)) {
C
Christoph Hellwig 已提交
2710
			ret = -EINVAL;
2711
			goto out_put_subsystem;
C
Christoph Hellwig 已提交
2712 2713 2714 2715 2716 2717
		}
	} else {
		ret = device_add(&subsys->dev);
		if (ret) {
			dev_err(ctrl->device,
				"failed to register subsystem device.\n");
2718
			put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2719 2720
			goto out_unlock;
		}
C
Christoph Hellwig 已提交
2721
		ida_init(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2722 2723 2724
		list_add_tail(&subsys->entry, &nvme_subsystems);
	}

2725 2726 2727
	ret = sysfs_create_link(&subsys->dev.kobj, &ctrl->device->kobj,
				dev_name(ctrl->device));
	if (ret) {
C
Christoph Hellwig 已提交
2728 2729
		dev_err(ctrl->device,
			"failed to create sysfs link from subsystem.\n");
2730
		goto out_put_subsystem;
C
Christoph Hellwig 已提交
2731 2732
	}

2733 2734
	if (!found)
		subsys->instance = ctrl->instance;
2735
	ctrl->subsys = subsys;
C
Christoph Hellwig 已提交
2736
	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
2737
	mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
2738 2739
	return 0;

2740 2741
out_put_subsystem:
	nvme_put_subsystem(subsys);
C
Christoph Hellwig 已提交
2742 2743 2744
out_unlock:
	mutex_unlock(&nvme_subsystems_lock);
	return ret;
2745 2746
}

2747
int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
2748
		void *log, size_t size, u64 offset)
K
Keith Busch 已提交
2749 2750
{
	struct nvme_command c = { };
K
Keith Busch 已提交
2751
	u32 dwlen = nvme_bytes_to_numd(size);
2752 2753

	c.get_log_page.opcode = nvme_admin_get_log_page;
2754
	c.get_log_page.nsid = cpu_to_le32(nsid);
2755
	c.get_log_page.lid = log_page;
2756
	c.get_log_page.lsp = lsp;
2757 2758
	c.get_log_page.numdl = cpu_to_le16(dwlen & ((1 << 16) - 1));
	c.get_log_page.numdu = cpu_to_le16(dwlen >> 16);
2759 2760
	c.get_log_page.lpol = cpu_to_le32(lower_32_bits(offset));
	c.get_log_page.lpou = cpu_to_le32(upper_32_bits(offset));
2761
	c.get_log_page.csi = csi;
K
Keith Busch 已提交
2762 2763 2764 2765

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

2766 2767
static int nvme_get_effects_log(struct nvme_ctrl *ctrl, u8 csi,
				struct nvme_effects_log **log)
2768
{
2769
	struct nvme_effects_log	*cel = xa_load(&ctrl->cels, csi);
2770 2771
	int ret;

2772 2773
	if (cel)
		goto out;
2774

2775 2776 2777
	cel = kzalloc(sizeof(*cel), GFP_KERNEL);
	if (!cel)
		return -ENOMEM;
2778

2779
	ret = nvme_get_log(ctrl, 0x00, NVME_LOG_CMD_EFFECTS, 0, csi,
2780
			cel, sizeof(*cel), 0);
2781
	if (ret) {
2782 2783
		kfree(cel);
		return ret;
2784
	}
2785

2786
	xa_store(&ctrl->cels, csi, cel, GFP_KERNEL);
2787
out:
2788
	*log = cel;
2789
	return 0;
2790 2791
}

2792
static inline u32 nvme_mps_to_sectors(struct nvme_ctrl *ctrl, u32 units)
2793
{
2794
	u32 page_shift = NVME_CAP_MPSMIN(ctrl->cap) + 12, val;
2795

2796 2797 2798
	if (check_shl_overflow(1U, units + page_shift - 9, &val))
		return UINT_MAX;
	return val;
2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812
}

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

2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853
	/*
	 * 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;
}

2854
static int nvme_init_identify(struct nvme_ctrl *ctrl)
2855 2856
{
	struct nvme_id_ctrl *id;
2857
	u32 max_hw_sectors;
2858
	bool prev_apst_enabled;
2859
	int ret;
2860

2861 2862
	ret = nvme_identify_ctrl(ctrl, &id);
	if (ret) {
2863
		dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret);
2864 2865 2866
		return -EIO;
	}

2867
	if (id->lpa & NVME_CTRL_LPA_CMD_EFFECTS_LOG) {
2868
		ret = nvme_get_effects_log(ctrl, NVME_CSI_NVM, &ctrl->effects);
2869
		if (ret < 0)
2870
			goto out_free;
2871
	}
2872

2873 2874 2875
	if (!(ctrl->ops->flags & NVME_F_FABRICS))
		ctrl->cntlid = le16_to_cpu(id->cntlid);

2876
	if (!ctrl->identified) {
2877
		unsigned int i;
C
Christoph Hellwig 已提交
2878 2879 2880 2881 2882

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

2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896
		/*
		 * 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;
		}
	}

2897
	if (force_apst && (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) {
2898
		dev_warn(ctrl->device, "forcibly allowing all power states due to nvme_core.force_apst -- use at your own risk\n");
2899 2900 2901
		ctrl->quirks &= ~NVME_QUIRK_NO_DEEPEST_PS;
	}

2902 2903 2904 2905
	ctrl->crdt[0] = le16_to_cpu(id->crdt1);
	ctrl->crdt[1] = le16_to_cpu(id->crdt2);
	ctrl->crdt[2] = le16_to_cpu(id->crdt3);

2906
	ctrl->oacs = le16_to_cpu(id->oacs);
2907
	ctrl->oncs = le16_to_cpu(id->oncs);
2908
	ctrl->mtfa = le16_to_cpu(id->mtfa);
2909
	ctrl->oaes = le32_to_cpu(id->oaes);
2910 2911 2912
	ctrl->wctemp = le16_to_cpu(id->wctemp);
	ctrl->cctemp = le16_to_cpu(id->cctemp);

2913
	atomic_set(&ctrl->abort_limit, id->acl + 1);
2914 2915
	ctrl->vwc = id->vwc;
	if (id->mdts)
2916
		max_hw_sectors = nvme_mps_to_sectors(ctrl, id->mdts);
2917
	else
2918 2919 2920
		max_hw_sectors = UINT_MAX;
	ctrl->max_hw_sectors =
		min_not_zero(ctrl->max_hw_sectors, max_hw_sectors);
2921

2922
	nvme_set_queue_limits(ctrl, ctrl->admin_q);
2923
	ctrl->sgls = le32_to_cpu(id->sgls);
S
Sagi Grimberg 已提交
2924
	ctrl->kas = le16_to_cpu(id->kas);
C
Christoph Hellwig 已提交
2925
	ctrl->max_namespaces = le32_to_cpu(id->mnan);
S
Sagi Grimberg 已提交
2926
	ctrl->ctratt = le32_to_cpu(id->ctratt);
2927

2928 2929
	if (id->rtd3e) {
		/* us -> s */
2930
		u32 transition_time = le32_to_cpu(id->rtd3e) / USEC_PER_SEC;
2931 2932 2933 2934 2935

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

		if (ctrl->shutdown_timeout != shutdown_timeout)
2936
			dev_info(ctrl->device,
2937 2938 2939 2940 2941
				 "Shutdown timeout set to %u seconds\n",
				 ctrl->shutdown_timeout);
	} else
		ctrl->shutdown_timeout = shutdown_timeout;

2942
	ctrl->npss = id->npss;
2943 2944
	ctrl->apsta = id->apsta;
	prev_apst_enabled = ctrl->apst_enabled;
2945 2946
	if (ctrl->quirks & NVME_QUIRK_NO_APST) {
		if (force_apst && id->apsta) {
2947
			dev_warn(ctrl->device, "forcibly allowing APST due to nvme_core.force_apst -- use at your own risk\n");
2948
			ctrl->apst_enabled = true;
2949
		} else {
2950
			ctrl->apst_enabled = false;
2951 2952
		}
	} else {
2953
		ctrl->apst_enabled = id->apsta;
2954
	}
2955 2956
	memcpy(ctrl->psd, id->psd, sizeof(ctrl->psd));

2957
	if (ctrl->ops->flags & NVME_F_FABRICS) {
2958 2959 2960 2961 2962 2963 2964 2965 2966
		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
		 */
2967
		if (ctrl->cntlid != le16_to_cpu(id->cntlid)) {
2968 2969 2970 2971
			dev_err(ctrl->device,
				"Mismatching cntlid: Connect %u vs Identify "
				"%u, rejecting\n",
				ctrl->cntlid, le16_to_cpu(id->cntlid));
2972
			ret = -EINVAL;
2973 2974
			goto out_free;
		}
S
Sagi Grimberg 已提交
2975

2976
		if (!nvme_discovery_ctrl(ctrl) && !ctrl->kas) {
2977
			dev_err(ctrl->device,
S
Sagi Grimberg 已提交
2978 2979
				"keep-alive support is mandatory for fabrics\n");
			ret = -EINVAL;
2980
			goto out_free;
S
Sagi Grimberg 已提交
2981
		}
2982
	} else {
2983 2984
		ctrl->hmpre = le32_to_cpu(id->hmpre);
		ctrl->hmmin = le32_to_cpu(id->hmmin);
2985 2986
		ctrl->hmminds = le32_to_cpu(id->hmminds);
		ctrl->hmmaxd = le16_to_cpu(id->hmmaxd);
2987
	}
2988

2989
	ret = nvme_mpath_init_identify(ctrl, id);
C
Christoph Hellwig 已提交
2990
	if (ret < 0)
2991
		goto out_free;
C
Christoph Hellwig 已提交
2992

2993
	if (ctrl->apst_enabled && !prev_apst_enabled)
2994
		dev_pm_qos_expose_latency_tolerance(ctrl->device);
2995
	else if (!ctrl->apst_enabled && prev_apst_enabled)
2996 2997
		dev_pm_qos_hide_latency_tolerance(ctrl->device);

2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026
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;

3027 3028 3029 3030
	ret = nvme_init_non_mdts_limits(ctrl);
	if (ret < 0)
		return ret;

3031 3032 3033
	ret = nvme_configure_apst(ctrl);
	if (ret < 0)
		return ret;
3034

3035 3036 3037
	ret = nvme_configure_timestamp(ctrl);
	if (ret < 0)
		return ret;
3038 3039 3040 3041

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

3043 3044 3045 3046
	ret = nvme_configure_acre(ctrl);
	if (ret < 0)
		return ret;

3047
	if (!ctrl->identified && !nvme_discovery_ctrl(ctrl)) {
K
Keith Busch 已提交
3048 3049 3050 3051
		ret = nvme_hwmon_init(ctrl);
		if (ret < 0)
			return ret;
	}
3052

3053
	ctrl->identified = true;
3054

3055
	return 0;
3056
}
3057
EXPORT_SYMBOL_GPL(nvme_init_ctrl_finish);
3058

3059
static int nvme_dev_open(struct inode *inode, struct file *file)
3060
{
3061 3062
	struct nvme_ctrl *ctrl =
		container_of(inode->i_cdev, struct nvme_ctrl, cdev);
3063

3064 3065 3066 3067
	switch (ctrl->state) {
	case NVME_CTRL_LIVE:
		break;
	default:
3068
		return -EWOULDBLOCK;
3069 3070
	}

3071
	nvme_get_ctrl(ctrl);
3072 3073
	if (!try_module_get(ctrl->ops->module)) {
		nvme_put_ctrl(ctrl);
3074
		return -EINVAL;
3075
	}
3076

3077
	file->private_data = ctrl;
3078 3079 3080
	return 0;
}

3081 3082 3083 3084 3085 3086 3087 3088 3089 3090
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;
}

3091 3092 3093
static const struct file_operations nvme_dev_fops = {
	.owner		= THIS_MODULE,
	.open		= nvme_dev_open,
3094
	.release	= nvme_dev_release,
3095
	.unlocked_ioctl	= nvme_dev_ioctl,
3096
	.compat_ioctl	= compat_ptr_ioctl,
3097 3098 3099 3100 3101 3102 3103 3104 3105
};

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;

3106
	ret = nvme_reset_ctrl_sync(ctrl);
3107 3108 3109
	if (ret < 0)
		return ret;
	return count;
3110
}
3111
static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset);
3112

K
Keith Busch 已提交
3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123
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);

3124 3125 3126 3127
static inline struct nvme_ns_head *dev_to_ns_head(struct device *dev)
{
	struct gendisk *disk = dev_to_disk(dev);

J
Javier González 已提交
3128
	if (disk->fops == &nvme_bdev_ops)
3129 3130 3131 3132 3133
		return nvme_get_ns_from_dev(dev)->head;
	else
		return disk->private_data;
}

3134
static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
3135
		char *buf)
3136
{
3137 3138 3139
	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 已提交
3140 3141
	int serial_len = sizeof(subsys->serial);
	int model_len = sizeof(subsys->model);
3142

3143
	if (!uuid_is_null(&ids->uuid))
3144
		return sysfs_emit(buf, "uuid.%pU\n", &ids->uuid);
3145

3146
	if (memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3147
		return sysfs_emit(buf, "eui.%16phN\n", ids->nguid);
3148

3149
	if (memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3150
		return sysfs_emit(buf, "eui.%8phN\n", ids->eui64);
3151

C
Christoph Hellwig 已提交
3152 3153
	while (serial_len > 0 && (subsys->serial[serial_len - 1] == ' ' ||
				  subsys->serial[serial_len - 1] == '\0'))
3154
		serial_len--;
C
Christoph Hellwig 已提交
3155 3156
	while (model_len > 0 && (subsys->model[model_len - 1] == ' ' ||
				 subsys->model[model_len - 1] == '\0'))
3157 3158
		model_len--;

3159
	return sysfs_emit(buf, "nvme.%04x-%*phN-%*phN-%08x\n", subsys->vendor_id,
C
Christoph Hellwig 已提交
3160
		serial_len, subsys->serial, model_len, subsys->model,
3161
		head->ns_id);
3162
}
J
Joe Perches 已提交
3163
static DEVICE_ATTR_RO(wwid);
3164

3165
static ssize_t nguid_show(struct device *dev, struct device_attribute *attr,
3166
		char *buf)
3167
{
3168
	return sysfs_emit(buf, "%pU\n", dev_to_ns_head(dev)->ids.nguid);
3169
}
J
Joe Perches 已提交
3170
static DEVICE_ATTR_RO(nguid);
3171

3172
static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
3173
		char *buf)
3174
{
3175
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3176 3177 3178 3179

	/* For backward compatibility expose the NGUID to userspace if
	 * we have no UUID set
	 */
3180
	if (uuid_is_null(&ids->uuid)) {
3181 3182
		printk_ratelimited(KERN_WARNING
				   "No UUID available providing old NGUID\n");
3183
		return sysfs_emit(buf, "%pU\n", ids->nguid);
3184
	}
3185
	return sysfs_emit(buf, "%pU\n", &ids->uuid);
3186
}
J
Joe Perches 已提交
3187
static DEVICE_ATTR_RO(uuid);
3188 3189

static ssize_t eui_show(struct device *dev, struct device_attribute *attr,
3190
		char *buf)
3191
{
3192
	return sysfs_emit(buf, "%8ph\n", dev_to_ns_head(dev)->ids.eui64);
3193
}
J
Joe Perches 已提交
3194
static DEVICE_ATTR_RO(eui);
3195 3196

static ssize_t nsid_show(struct device *dev, struct device_attribute *attr,
3197
		char *buf)
3198
{
3199
	return sysfs_emit(buf, "%d\n", dev_to_ns_head(dev)->ns_id);
3200
}
J
Joe Perches 已提交
3201
static DEVICE_ATTR_RO(nsid);
3202

3203
static struct attribute *nvme_ns_id_attrs[] = {
3204
	&dev_attr_wwid.attr,
3205
	&dev_attr_uuid.attr,
3206
	&dev_attr_nguid.attr,
3207 3208
	&dev_attr_eui.attr,
	&dev_attr_nsid.attr,
C
Christoph Hellwig 已提交
3209 3210 3211 3212
#ifdef CONFIG_NVME_MULTIPATH
	&dev_attr_ana_grpid.attr,
	&dev_attr_ana_state.attr,
#endif
3213 3214 3215
	NULL,
};

3216
static umode_t nvme_ns_id_attrs_are_visible(struct kobject *kobj,
3217 3218 3219
		struct attribute *a, int n)
{
	struct device *dev = container_of(kobj, struct device, kobj);
3220
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3221 3222

	if (a == &dev_attr_uuid.attr) {
3223
		if (uuid_is_null(&ids->uuid) &&
3224
		    !memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3225 3226 3227
			return 0;
	}
	if (a == &dev_attr_nguid.attr) {
3228
		if (!memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3229 3230 3231
			return 0;
	}
	if (a == &dev_attr_eui.attr) {
3232
		if (!memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3233 3234
			return 0;
	}
C
Christoph Hellwig 已提交
3235 3236
#ifdef CONFIG_NVME_MULTIPATH
	if (a == &dev_attr_ana_grpid.attr || a == &dev_attr_ana_state.attr) {
J
Javier González 已提交
3237
		if (dev_to_disk(dev)->fops != &nvme_bdev_ops) /* per-path attr */
C
Christoph Hellwig 已提交
3238 3239 3240 3241 3242
			return 0;
		if (!nvme_ctrl_use_ana(nvme_get_ns_from_dev(dev)->ctrl))
			return 0;
	}
#endif
3243 3244 3245
	return a->mode;
}

3246
static const struct attribute_group nvme_ns_id_attr_group = {
3247 3248
	.attrs		= nvme_ns_id_attrs,
	.is_visible	= nvme_ns_id_attrs_are_visible,
3249 3250
};

3251 3252 3253 3254 3255
const struct attribute_group *nvme_ns_id_attr_groups[] = {
	&nvme_ns_id_attr_group,
	NULL,
};

M
Ming Lin 已提交
3256
#define nvme_show_str_function(field)						\
3257 3258 3259 3260
static ssize_t  field##_show(struct device *dev,				\
			    struct device_attribute *attr, char *buf)		\
{										\
        struct nvme_ctrl *ctrl = dev_get_drvdata(dev);				\
3261
        return sysfs_emit(buf, "%.*s\n",					\
C
Christoph Hellwig 已提交
3262
		(int)sizeof(ctrl->subsys->field), ctrl->subsys->field);		\
3263 3264 3265
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

C
Christoph Hellwig 已提交
3266 3267 3268 3269
nvme_show_str_function(model);
nvme_show_str_function(serial);
nvme_show_str_function(firmware_rev);

M
Ming Lin 已提交
3270 3271 3272 3273 3274
#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);				\
3275
        return sysfs_emit(buf, "%d\n", ctrl->field);				\
M
Ming Lin 已提交
3276 3277 3278 3279
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

nvme_show_int_function(cntlid);
3280
nvme_show_int_function(numa_node);
3281 3282
nvme_show_int_function(queue_count);
nvme_show_int_function(sqsize);
3283
nvme_show_int_function(kato);
3284

M
Ming Lin 已提交
3285 3286 3287 3288 3289 3290 3291
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))
3292
		nvme_delete_ctrl_sync(ctrl);
M
Ming Lin 已提交
3293 3294 3295 3296 3297 3298 3299 3300 3301 3302
	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);

3303
	return sysfs_emit(buf, "%s\n", ctrl->ops->name);
M
Ming Lin 已提交
3304 3305 3306
}
static DEVICE_ATTR(transport, S_IRUGO, nvme_sysfs_show_transport, NULL);

3307 3308 3309 3310 3311 3312 3313 3314 3315
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",
3316
		[NVME_CTRL_CONNECTING]	= "connecting",
3317
		[NVME_CTRL_DELETING]	= "deleting",
3318
		[NVME_CTRL_DELETING_NOIO]= "deleting (no IO)",
3319 3320 3321 3322 3323
		[NVME_CTRL_DEAD]	= "dead",
	};

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

3326
	return sysfs_emit(buf, "unknown state\n");
3327 3328 3329 3330
}

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

M
Ming Lin 已提交
3331 3332 3333 3334 3335 3336
static ssize_t nvme_sysfs_show_subsysnqn(struct device *dev,
					 struct device_attribute *attr,
					 char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3337
	return sysfs_emit(buf, "%s\n", ctrl->subsys->subnqn);
M
Ming Lin 已提交
3338 3339 3340
}
static DEVICE_ATTR(subsysnqn, S_IRUGO, nvme_sysfs_show_subsysnqn, NULL);

3341 3342 3343 3344 3345 3346
static ssize_t nvme_sysfs_show_hostnqn(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3347
	return sysfs_emit(buf, "%s\n", ctrl->opts->host->nqn);
3348 3349 3350
}
static DEVICE_ATTR(hostnqn, S_IRUGO, nvme_sysfs_show_hostnqn, NULL);

3351 3352 3353 3354 3355 3356
static ssize_t nvme_sysfs_show_hostid(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

3357
	return sysfs_emit(buf, "%pU\n", &ctrl->opts->host->id);
3358 3359 3360
}
static DEVICE_ATTR(hostid, S_IRUGO, nvme_sysfs_show_hostid, NULL);

M
Ming Lin 已提交
3361 3362 3363 3364 3365 3366 3367 3368 3369 3370
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);

3371 3372 3373 3374 3375 3376 3377
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)
3378 3379 3380
		return sysfs_emit(buf, "off\n");
	return sysfs_emit(buf, "%d\n",
			  opts->max_reconnects * opts->reconnect_delay);
3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393
}

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;

3394
	if (ctrl_loss_tmo < 0)
3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409
		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)
3410 3411
		return sysfs_emit(buf, "off\n");
	return sysfs_emit(buf, "%d\n", ctrl->opts->reconnect_delay);
3412 3413 3414 3415 3416 3417 3418 3419 3420 3421
}

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);
3422 3423
	if (err)
		return err;
3424 3425 3426 3427 3428 3429 3430

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

3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460
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);

3461 3462
static struct attribute *nvme_dev_attrs[] = {
	&dev_attr_reset_controller.attr,
K
Keith Busch 已提交
3463
	&dev_attr_rescan_controller.attr,
3464 3465 3466
	&dev_attr_model.attr,
	&dev_attr_serial.attr,
	&dev_attr_firmware_rev.attr,
M
Ming Lin 已提交
3467
	&dev_attr_cntlid.attr,
M
Ming Lin 已提交
3468 3469 3470 3471
	&dev_attr_delete_controller.attr,
	&dev_attr_transport.attr,
	&dev_attr_subsysnqn.attr,
	&dev_attr_address.attr,
3472
	&dev_attr_state.attr,
3473
	&dev_attr_numa_node.attr,
3474 3475
	&dev_attr_queue_count.attr,
	&dev_attr_sqsize.attr,
3476
	&dev_attr_hostnqn.attr,
3477
	&dev_attr_hostid.attr,
3478 3479
	&dev_attr_ctrl_loss_tmo.attr,
	&dev_attr_reconnect_delay.attr,
3480
	&dev_attr_fast_io_fail_tmo.attr,
3481
	&dev_attr_kato.attr,
3482 3483 3484
	NULL
};

M
Ming Lin 已提交
3485 3486 3487 3488 3489 3490
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);

3491 3492 3493 3494
	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;
3495 3496
	if (a == &dev_attr_hostnqn.attr && !ctrl->opts)
		return 0;
3497 3498
	if (a == &dev_attr_hostid.attr && !ctrl->opts)
		return 0;
3499 3500 3501 3502
	if (a == &dev_attr_ctrl_loss_tmo.attr && !ctrl->opts)
		return 0;
	if (a == &dev_attr_reconnect_delay.attr && !ctrl->opts)
		return 0;
3503 3504
	if (a == &dev_attr_fast_io_fail_tmo.attr && !ctrl->opts)
		return 0;
M
Ming Lin 已提交
3505 3506 3507 3508

	return a->mode;
}

3509
static const struct attribute_group nvme_dev_attrs_group = {
M
Ming Lin 已提交
3510 3511
	.attrs		= nvme_dev_attrs,
	.is_visible	= nvme_dev_attrs_are_visible,
3512 3513 3514 3515 3516 3517 3518
};

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

3519
static struct nvme_ns_head *nvme_find_ns_head(struct nvme_subsystem *subsys,
C
Christoph Hellwig 已提交
3520 3521 3522 3523 3524 3525 3526
		unsigned nsid)
{
	struct nvme_ns_head *h;

	lockdep_assert_held(&subsys->lock);

	list_for_each_entry(h, &subsys->nsheads, entry) {
3527
		if (h->ns_id == nsid && nvme_tryget_ns_head(h))
C
Christoph Hellwig 已提交
3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549
			return h;
	}

	return NULL;
}

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

	lockdep_assert_held(&subsys->lock);

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

	return 0;
}

3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569
void nvme_cdev_del(struct cdev *cdev, struct device *cdev_device)
{
	cdev_device_del(cdev, cdev_device);
	ida_simple_remove(&nvme_ns_chr_minor_ida, MINOR(cdev_device->devt));
}

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

	minor = ida_simple_get(&nvme_ns_chr_minor_ida, 0, 0, GFP_KERNEL);
	if (minor < 0)
		return minor;
	cdev_device->devt = MKDEV(MAJOR(nvme_ns_chr_devt), minor);
	cdev_device->class = nvme_ns_chr_class;
	device_initialize(cdev_device);
	cdev_init(cdev, fops);
	cdev->owner = owner;
	ret = cdev_device_add(cdev, cdev_device);
3570 3571
	if (ret) {
		put_device(cdev_device);
3572
		ida_simple_remove(&nvme_ns_chr_minor_ida, minor);
3573
	}
3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611
	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;
	ret = nvme_cdev_add(&ns->cdev, &ns->cdev_device, &nvme_ns_chr_fops,
			    ns->ctrl->ops->module);
	if (ret)
		kfree_const(ns->cdev_device.kobj.name);
	return ret;
}

C
Christoph Hellwig 已提交
3612
static struct nvme_ns_head *nvme_alloc_ns_head(struct nvme_ctrl *ctrl,
K
Keith Busch 已提交
3613
		unsigned nsid, struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
3614 3615
{
	struct nvme_ns_head *head;
3616
	size_t size = sizeof(*head);
C
Christoph Hellwig 已提交
3617 3618
	int ret = -ENOMEM;

3619 3620 3621 3622 3623
#ifdef CONFIG_NVME_MULTIPATH
	size += num_possible_nodes() * sizeof(struct nvme_ns *);
#endif

	head = kzalloc(size, GFP_KERNEL);
C
Christoph Hellwig 已提交
3624 3625 3626 3627 3628 3629 3630
	if (!head)
		goto out;
	ret = ida_simple_get(&ctrl->subsys->ns_ida, 1, 0, GFP_KERNEL);
	if (ret < 0)
		goto out_free_head;
	head->instance = ret;
	INIT_LIST_HEAD(&head->list);
3631 3632 3633
	ret = init_srcu_struct(&head->srcu);
	if (ret)
		goto out_ida_remove;
C
Christoph Hellwig 已提交
3634 3635
	head->subsys = ctrl->subsys;
	head->ns_id = nsid;
3636
	head->ids = *ids;
C
Christoph Hellwig 已提交
3637 3638 3639 3640 3641 3642 3643 3644 3645
	kref_init(&head->ref);

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

3646 3647 3648 3649 3650 3651 3652
	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;

3653 3654 3655 3656
	ret = nvme_mpath_alloc_disk(ctrl, head);
	if (ret)
		goto out_cleanup_srcu;

C
Christoph Hellwig 已提交
3657
	list_add_tail(&head->entry, &ctrl->subsys->nsheads);
3658 3659 3660

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

C
Christoph Hellwig 已提交
3661 3662 3663
	return head;
out_cleanup_srcu:
	cleanup_srcu_struct(&head->srcu);
3664
out_ida_remove:
C
Christoph Hellwig 已提交
3665 3666 3667 3668
	ida_simple_remove(&ctrl->subsys->ns_ida, head->instance);
out_free_head:
	kfree(head);
out:
3669 3670
	if (ret > 0)
		ret = blk_status_to_errno(nvme_error_status(ret));
C
Christoph Hellwig 已提交
3671 3672 3673 3674
	return ERR_PTR(ret);
}

static int nvme_init_ns_head(struct nvme_ns *ns, unsigned nsid,
3675
		struct nvme_ns_ids *ids, bool is_shared)
C
Christoph Hellwig 已提交
3676 3677 3678 3679 3680 3681
{
	struct nvme_ctrl *ctrl = ns->ctrl;
	struct nvme_ns_head *head = NULL;
	int ret = 0;

	mutex_lock(&ctrl->subsys->lock);
3682
	head = nvme_find_ns_head(ctrl->subsys, nsid);
C
Christoph Hellwig 已提交
3683
	if (!head) {
3684
		head = nvme_alloc_ns_head(ctrl, nsid, ids);
C
Christoph Hellwig 已提交
3685 3686 3687 3688
		if (IS_ERR(head)) {
			ret = PTR_ERR(head);
			goto out_unlock;
		}
3689
		head->shared = is_shared;
C
Christoph Hellwig 已提交
3690
	} else {
3691
		ret = -EINVAL;
3692
		if (!is_shared || !head->shared) {
3693
			dev_err(ctrl->device,
3694 3695
				"Duplicate unshared namespace %d\n", nsid);
			goto out_put_ns_head;
3696
		}
3697
		if (!nvme_ns_ids_equal(&head->ids, ids)) {
C
Christoph Hellwig 已提交
3698 3699 3700
			dev_err(ctrl->device,
				"IDs don't match for shared namespace %d\n",
					nsid);
3701
			goto out_put_ns_head;
C
Christoph Hellwig 已提交
3702 3703 3704
		}
	}

3705
	list_add_tail_rcu(&ns->siblings, &head->list);
C
Christoph Hellwig 已提交
3706
	ns->head = head;
3707 3708
	mutex_unlock(&ctrl->subsys->lock);
	return 0;
C
Christoph Hellwig 已提交
3709

3710 3711
out_put_ns_head:
	nvme_put_ns_head(head);
C
Christoph Hellwig 已提交
3712 3713 3714 3715 3716
out_unlock:
	mutex_unlock(&ctrl->subsys->lock);
	return ret;
}

3717 3718
static int ns_cmp(void *priv, const struct list_head *a,
		const struct list_head *b)
3719 3720 3721 3722
{
	struct nvme_ns *nsa = container_of(a, struct nvme_ns, list);
	struct nvme_ns *nsb = container_of(b, struct nvme_ns, list);

C
Christoph Hellwig 已提交
3723
	return nsa->head->ns_id - nsb->head->ns_id;
3724 3725
}

3726
struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid)
3727
{
3728
	struct nvme_ns *ns, *ret = NULL;
3729

3730
	down_read(&ctrl->namespaces_rwsem);
3731
	list_for_each_entry(ns, &ctrl->namespaces, list) {
C
Christoph Hellwig 已提交
3732
		if (ns->head->ns_id == nsid) {
K
Kanchan Joshi 已提交
3733
			if (!nvme_get_ns(ns))
3734
				continue;
3735 3736 3737
			ret = ns;
			break;
		}
C
Christoph Hellwig 已提交
3738
		if (ns->head->ns_id > nsid)
3739 3740
			break;
	}
3741
	up_read(&ctrl->namespaces_rwsem);
3742
	return ret;
3743
}
3744
EXPORT_SYMBOL_NS_GPL(nvme_find_get_ns, NVME_TARGET_PASSTHRU);
3745

3746 3747
static void nvme_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid,
		struct nvme_ns_ids *ids)
3748 3749 3750
{
	struct nvme_ns *ns;
	struct gendisk *disk;
3751
	struct nvme_id_ns *id;
3752
	int node = ctrl->numa_node;
3753

3754
	if (nvme_identify_ns(ctrl, nsid, ids, &id))
3755 3756
		return;

3757 3758
	ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
	if (!ns)
3759
		goto out_free_id;
3760

C
Christoph Hellwig 已提交
3761 3762
	disk = blk_mq_alloc_disk(ctrl->tagset, ns);
	if (IS_ERR(disk))
C
Christoph Hellwig 已提交
3763
		goto out_free_ns;
C
Christoph Hellwig 已提交
3764 3765 3766 3767 3768
	disk->fops = &nvme_bdev_ops;
	disk->private_data = ns;

	ns->disk = disk;
	ns->queue = disk->queue;
3769

3770
	if (ctrl->opts && ctrl->opts->data_digest)
3771
		blk_queue_flag_set(QUEUE_FLAG_STABLE_WRITES, ns->queue);
3772

3773
	blk_queue_flag_set(QUEUE_FLAG_NONROT, ns->queue);
3774 3775 3776
	if (ctrl->ops->flags & NVME_F_PCI_P2PDMA)
		blk_queue_flag_set(QUEUE_FLAG_PCI_P2PDMA, ns->queue);

3777 3778 3779
	ns->ctrl = ctrl;
	kref_init(&ns->kref);

3780
	if (nvme_init_ns_head(ns, nsid, ids, id->nmic & NVME_NS_NMIC_SHARED))
C
Christoph Hellwig 已提交
3781
		goto out_cleanup_disk;
3782

3783 3784 3785 3786 3787 3788 3789 3790
	/*
	 * Without the multipath code enabled, multiple controller per
	 * subsystems are visible as devices and thus we cannot use the
	 * subsystem instance.
	 */
	if (!nvme_mpath_set_disk_name(ns, disk->disk_name, &disk->flags))
		sprintf(disk->disk_name, "nvme%dn%d", ctrl->instance,
			ns->head->instance);
3791

3792
	if (nvme_update_ns_info(ns, id))
C
Christoph Hellwig 已提交
3793
		goto out_unlink_ns;
3794

3795
	down_write(&ctrl->namespaces_rwsem);
3796
	list_add_tail(&ns->list, &ctrl->namespaces);
3797
	up_write(&ctrl->namespaces_rwsem);
3798

3799
	nvme_get_ctrl(ctrl);
3800

3801 3802 3803
	if (device_add_disk(ctrl->device, ns->disk, nvme_ns_id_attr_groups))
		goto out_cleanup_ns_from_list;

3804 3805
	if (!nvme_ns_head_multipath(ns->head))
		nvme_add_ns_cdev(ns);
3806

C
Christoph Hellwig 已提交
3807
	nvme_mpath_add_disk(ns, id);
3808
	nvme_fault_inject_init(&ns->fault_inject, ns->disk->disk_name);
C
Christoph Hellwig 已提交
3809 3810
	kfree(id);

3811
	return;
C
Christoph Hellwig 已提交
3812

3813 3814 3815 3816 3817
 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 已提交
3818 3819 3820
 out_unlink_ns:
	mutex_lock(&ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
3821 3822
	if (list_empty(&ns->head->list))
		list_del_init(&ns->head->entry);
C
Christoph Hellwig 已提交
3823
	mutex_unlock(&ctrl->subsys->lock);
3824
	nvme_put_ns_head(ns->head);
C
Christoph Hellwig 已提交
3825 3826
 out_cleanup_disk:
	blk_cleanup_disk(disk);
3827 3828
 out_free_ns:
	kfree(ns);
3829 3830
 out_free_id:
	kfree(id);
3831 3832 3833 3834
}

static void nvme_ns_remove(struct nvme_ns *ns)
{
3835 3836
	bool last_path = false;

3837 3838
	if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
		return;
3839

3840
	clear_bit(NVME_NS_READY, &ns->flags);
3841
	set_capacity(ns->disk, 0);
3842
	nvme_fault_inject_fini(&ns->fault_inject);
3843 3844 3845 3846

	mutex_lock(&ns->ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
	mutex_unlock(&ns->ctrl->subsys->lock);
3847

3848 3849 3850 3851 3852 3853
	/* guarantee not available in head->list */
	synchronize_rcu();

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

3855 3856 3857 3858 3859 3860
	if (!nvme_ns_head_multipath(ns->head))
		nvme_cdev_del(&ns->cdev, &ns->cdev_device);
	del_gendisk(ns->disk);
	blk_cleanup_queue(ns->queue);
	if (blk_get_integrity(ns->disk))
		blk_integrity_unregister(ns->disk);
3861

3862
	down_write(&ns->ctrl->namespaces_rwsem);
3863
	list_del_init(&ns->list);
3864
	up_write(&ns->ctrl->namespaces_rwsem);
3865

3866 3867 3868 3869 3870 3871 3872 3873 3874
	/* Synchronize with nvme_init_ns_head() */
	mutex_lock(&ns->head->subsys->lock);
	if (list_empty(&ns->head->list)) {
		list_del_init(&ns->head->entry);
		last_path = true;
	}
	mutex_unlock(&ns->head->subsys->lock);
	if (last_path)
		nvme_mpath_shutdown_disk(ns->head);
3875 3876 3877
	nvme_put_ns(ns);
}

3878 3879 3880 3881 3882 3883 3884 3885 3886 3887
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);
	}
}

3888
static void nvme_validate_ns(struct nvme_ns *ns, struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
3889 3890
{
	struct nvme_id_ns *id;
3891
	int ret = NVME_SC_INVALID_NS | NVME_SC_DNR;
C
Christoph Hellwig 已提交
3892

3893 3894
	if (test_bit(NVME_NS_DEAD, &ns->flags))
		goto out;
C
Christoph Hellwig 已提交
3895

3896
	ret = nvme_identify_ns(ns->ctrl, ns->head->ns_id, ids, &id);
C
Christoph Hellwig 已提交
3897 3898 3899
	if (ret)
		goto out;

3900
	ret = NVME_SC_INVALID_NS | NVME_SC_DNR;
C
Christoph Hellwig 已提交
3901
	if (!nvme_ns_ids_equal(&ns->head->ids, ids)) {
3902
		dev_err(ns->ctrl->device,
C
Christoph Hellwig 已提交
3903
			"identifiers changed for nsid %d\n", ns->head->ns_id);
3904
		goto out_free_id;
C
Christoph Hellwig 已提交
3905 3906 3907
	}

	ret = nvme_update_ns_info(ns, id);
3908 3909

out_free_id:
C
Christoph Hellwig 已提交
3910 3911 3912
	kfree(id);
out:
	/*
3913
	 * Only remove the namespace if we got a fatal error back from the
C
Christoph Hellwig 已提交
3914
	 * device, otherwise ignore the error and just move on.
3915 3916
	 *
	 * TODO: we should probably schedule a delayed retry here.
C
Christoph Hellwig 已提交
3917
	 */
3918
	if (ret > 0 && (ret & NVME_SC_DNR))
3919
		nvme_ns_remove(ns);
C
Christoph Hellwig 已提交
3920 3921
}

3922
static void nvme_validate_or_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid)
3923
{
3924
	struct nvme_ns_ids ids = { };
3925 3926
	struct nvme_ns *ns;

3927 3928
	if (nvme_identify_ns_descs(ctrl, nsid, &ids))
		return;
3929

3930
	ns = nvme_find_get_ns(ctrl, nsid);
3931
	if (ns) {
3932
		nvme_validate_ns(ns, &ids);
3933
		nvme_put_ns(ns);
3934 3935 3936
		return;
	}

3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947
	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;
		}
3948 3949 3950
		if (!nvme_multi_css(ctrl)) {
			dev_warn(ctrl->device,
				"command set not reported for nsid: %d\n",
3951
				nsid);
3952 3953
			break;
		}
3954 3955 3956 3957 3958 3959 3960
		nvme_alloc_ns(ctrl, nsid, &ids);
		break;
	default:
		dev_warn(ctrl->device, "unknown csi %u for nsid %u\n",
			ids.csi, nsid);
		break;
	}
3961 3962
}

3963 3964 3965 3966
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					unsigned nsid)
{
	struct nvme_ns *ns, *next;
3967
	LIST_HEAD(rm_list);
3968

3969
	down_write(&ctrl->namespaces_rwsem);
3970
	list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) {
3971
		if (ns->head->ns_id > nsid || test_bit(NVME_NS_DEAD, &ns->flags))
3972
			list_move_tail(&ns->list, &rm_list);
3973
	}
3974
	up_write(&ctrl->namespaces_rwsem);
3975 3976 3977 3978

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

3979 3980
}

3981
static int nvme_scan_ns_list(struct nvme_ctrl *ctrl)
3982
{
3983
	const int nr_entries = NVME_IDENTIFY_DATA_SIZE / sizeof(__le32);
3984
	__le32 *ns_list;
3985 3986
	u32 prev = 0;
	int ret = 0, i;
3987

3988 3989
	if (nvme_ctrl_limited_cns(ctrl))
		return -EOPNOTSUPP;
3990

3991
	ns_list = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
3992 3993 3994
	if (!ns_list)
		return -ENOMEM;

3995
	for (;;) {
3996 3997 3998 3999 4000 4001 4002 4003
		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);
4004 4005 4006
		if (ret) {
			dev_warn(ctrl->device,
				"Identify NS List failed (status=0x%x)\n", ret);
4007
			goto free;
4008
		}
4009

4010
		for (i = 0; i < nr_entries; i++) {
4011
			u32 nsid = le32_to_cpu(ns_list[i]);
4012

4013 4014
			if (!nsid)	/* end of the list? */
				goto out;
4015
			nvme_validate_or_alloc_ns(ctrl, nsid);
4016 4017
			while (++prev < nsid)
				nvme_ns_remove_by_nsid(ctrl, prev);
4018 4019 4020
		}
	}
 out:
4021 4022
	nvme_remove_invalid_namespaces(ctrl, prev);
 free:
4023 4024 4025 4026
	kfree(ns_list);
	return ret;
}

4027
static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl)
4028
{
4029 4030 4031 4032 4033 4034 4035
	struct nvme_id_ctrl *id;
	u32 nn, i;

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

4037
	for (i = 1; i <= nn; i++)
4038
		nvme_validate_or_alloc_ns(ctrl, i);
4039

4040
	nvme_remove_invalid_namespaces(ctrl, nn);
4041 4042
}

4043
static void nvme_clear_changed_ns_log(struct nvme_ctrl *ctrl)
4044 4045 4046
{
	size_t log_size = NVME_MAX_CHANGED_NAMESPACES * sizeof(__le32);
	__le32 *log;
4047
	int error;
4048 4049 4050

	log = kzalloc(log_size, GFP_KERNEL);
	if (!log)
4051
		return;
4052

4053 4054 4055 4056 4057 4058
	/*
	 * 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.
	 */
4059 4060
	error = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CHANGED_NS, 0,
			NVME_CSI_NVM, log, log_size, 0);
4061
	if (error)
4062 4063 4064 4065 4066 4067
		dev_warn(ctrl->device,
			"reading changed ns log failed: %d\n", error);

	kfree(log);
}

4068
static void nvme_scan_work(struct work_struct *work)
4069
{
4070 4071
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, scan_work);
4072

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

D
Dan Carpenter 已提交
4077
	if (test_and_clear_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events)) {
4078
		dev_info(ctrl->device, "rescanning namespaces.\n");
4079
		nvme_clear_changed_ns_log(ctrl);
4080 4081
	}

4082
	mutex_lock(&ctrl->scan_lock);
4083 4084
	if (nvme_scan_ns_list(ctrl) != 0)
		nvme_scan_ns_sequential(ctrl);
4085
	mutex_unlock(&ctrl->scan_lock);
4086

4087
	down_write(&ctrl->namespaces_rwsem);
4088
	list_sort(NULL, &ctrl->namespaces, ns_cmp);
4089
	up_write(&ctrl->namespaces_rwsem);
4090
}
4091

4092 4093 4094 4095 4096
/*
 * 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.
 */
4097 4098 4099
void nvme_remove_namespaces(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns, *next;
4100
	LIST_HEAD(ns_list);
4101

4102 4103 4104 4105 4106 4107 4108
	/*
	 * 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);

4109 4110 4111
	/* prevent racing with ns scanning */
	flush_work(&ctrl->scan_work);

4112 4113 4114 4115 4116 4117 4118 4119 4120
	/*
	 * 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);

4121 4122 4123
	/* this is a no-op when called from the controller reset handler */
	nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING_NOIO);

4124
	down_write(&ctrl->namespaces_rwsem);
4125
	list_splice_init(&ctrl->namespaces, &ns_list);
4126
	up_write(&ctrl->namespaces_rwsem);
4127 4128

	list_for_each_entry_safe(ns, next, &ns_list, list)
4129 4130
		nvme_ns_remove(ns);
}
4131
EXPORT_SYMBOL_GPL(nvme_remove_namespaces);
4132

4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155
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");
4156 4157 4158 4159 4160
		if (ret)
			return ret;

		ret = add_uevent_var(env, "NVME_HOST_IFACE=%s",
				opts->host_iface ?: "none");
4161 4162 4163 4164
	}
	return ret;
}

4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180
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]);
}

4181 4182 4183 4184 4185
static void nvme_async_event_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, async_event_work);

4186
	nvme_aen_uevent(ctrl);
4187
	ctrl->ops->submit_async_event(ctrl);
4188 4189
}

4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211
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;

4212 4213
	if (nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_FW_SLOT, 0, NVME_CSI_NVM,
			log, sizeof(*log), 0))
4214
		dev_warn(ctrl->device, "Get FW SLOT INFO log error\n");
4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235
	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");
4236 4237
			nvme_try_sched_reset(ctrl);
			return;
4238 4239 4240 4241
		}
		msleep(100);
	}

4242
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE))
4243 4244 4245
		return;

	nvme_start_queues(ctrl);
4246
	/* read FW slot information to clear the AER */
4247 4248 4249
	nvme_get_fw_slot_info(ctrl);
}

4250 4251
static void nvme_handle_aen_notice(struct nvme_ctrl *ctrl, u32 result)
{
4252 4253
	u32 aer_notice_type = (result & 0xff00) >> 8;

4254 4255
	trace_nvme_async_event(ctrl, aer_notice_type);

4256
	switch (aer_notice_type) {
4257
	case NVME_AER_NOTICE_NS_CHANGED:
D
Dan Carpenter 已提交
4258
		set_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events);
4259 4260 4261
		nvme_queue_scan(ctrl);
		break;
	case NVME_AER_NOTICE_FW_ACT_STARTING:
4262 4263 4264 4265 4266 4267 4268
		/*
		 * 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);
4269
		break;
C
Christoph Hellwig 已提交
4270 4271 4272 4273 4274 4275 4276
#ifdef CONFIG_NVME_MULTIPATH
	case NVME_AER_NOTICE_ANA:
		if (!ctrl->ana_log_buf)
			break;
		queue_work(nvme_wq, &ctrl->ana_work);
		break;
#endif
4277 4278 4279
	case NVME_AER_NOTICE_DISC_CHANGED:
		ctrl->aen_result = result;
		break;
4280 4281 4282 4283 4284
	default:
		dev_warn(ctrl->device, "async event result %08x\n", result);
	}
}

4285
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
4286
		volatile union nvme_result *res)
4287
{
4288
	u32 result = le32_to_cpu(res->u32);
4289
	u32 aer_type = result & 0x07;
4290

4291
	if (le16_to_cpu(status) >> 1 != NVME_SC_SUCCESS)
4292 4293
		return;

4294
	switch (aer_type) {
4295 4296 4297
	case NVME_AER_NOTICE:
		nvme_handle_aen_notice(ctrl, result);
		break;
4298 4299 4300 4301
	case NVME_AER_ERROR:
	case NVME_AER_SMART:
	case NVME_AER_CSS:
	case NVME_AER_VS:
4302
		trace_nvme_async_event(ctrl, aer_type);
4303
		ctrl->aen_result = result;
4304 4305 4306
		break;
	default:
		break;
4307
	}
4308
	queue_work(nvme_wq, &ctrl->async_event_work);
4309 4310
}
EXPORT_SYMBOL_GPL(nvme_complete_async_event);
4311

4312
void nvme_stop_ctrl(struct nvme_ctrl *ctrl)
4313
{
C
Christoph Hellwig 已提交
4314
	nvme_mpath_stop(ctrl);
4315
	nvme_stop_keep_alive(ctrl);
4316
	nvme_stop_failfast_work(ctrl);
4317
	flush_work(&ctrl->async_event_work);
4318
	cancel_work_sync(&ctrl->fw_act_work);
4319 4320 4321 4322 4323
}
EXPORT_SYMBOL_GPL(nvme_stop_ctrl);

void nvme_start_ctrl(struct nvme_ctrl *ctrl)
{
4324
	nvme_start_keep_alive(ctrl);
4325

4326 4327
	nvme_enable_aen(ctrl);

4328 4329 4330 4331 4332 4333
	if (ctrl->queue_count > 1) {
		nvme_queue_scan(ctrl);
		nvme_start_queues(ctrl);
	}
}
EXPORT_SYMBOL_GPL(nvme_start_ctrl);
4334

4335 4336
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl)
{
4337
	nvme_hwmon_exit(ctrl);
4338
	nvme_fault_inject_fini(&ctrl->fault_inject);
4339
	dev_pm_qos_hide_latency_tolerance(ctrl->device);
4340
	cdev_device_del(&ctrl->cdev, ctrl->device);
4341
	nvme_put_ctrl(ctrl);
4342
}
4343
EXPORT_SYMBOL_GPL(nvme_uninit_ctrl);
4344

4345 4346 4347 4348 4349
static void nvme_free_cels(struct nvme_ctrl *ctrl)
{
	struct nvme_effects_log	*cel;
	unsigned long i;

4350
	xa_for_each(&ctrl->cels, i, cel) {
4351 4352 4353 4354 4355 4356 4357
		xa_erase(&ctrl->cels, i);
		kfree(cel);
	}

	xa_destroy(&ctrl->cels);
}

4358
static void nvme_free_ctrl(struct device *dev)
4359
{
4360 4361
	struct nvme_ctrl *ctrl =
		container_of(dev, struct nvme_ctrl, ctrl_device);
C
Christoph Hellwig 已提交
4362
	struct nvme_subsystem *subsys = ctrl->subsys;
4363

K
Keith Busch 已提交
4364
	if (!subsys || ctrl->instance != subsys->instance)
4365 4366
		ida_simple_remove(&nvme_instance_ida, ctrl->instance);

4367
	nvme_free_cels(ctrl);
C
Christoph Hellwig 已提交
4368
	nvme_mpath_uninit(ctrl);
S
Sagi Grimberg 已提交
4369
	__free_page(ctrl->discard_page);
4370

C
Christoph Hellwig 已提交
4371
	if (subsys) {
4372
		mutex_lock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4373 4374
		list_del(&ctrl->subsys_entry);
		sysfs_remove_link(&subsys->dev.kobj, dev_name(ctrl->device));
4375
		mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4376
	}
4377 4378 4379

	ctrl->ops->free_ctrl(ctrl);

C
Christoph Hellwig 已提交
4380 4381
	if (subsys)
		nvme_put_subsystem(subsys);
4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393
}

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

4394
	ctrl->state = NVME_CTRL_NEW;
4395
	clear_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags);
4396
	spin_lock_init(&ctrl->lock);
4397
	mutex_init(&ctrl->scan_lock);
4398
	INIT_LIST_HEAD(&ctrl->namespaces);
4399
	xa_init(&ctrl->cels);
4400
	init_rwsem(&ctrl->namespaces_rwsem);
4401 4402 4403
	ctrl->dev = dev;
	ctrl->ops = ops;
	ctrl->quirks = quirks;
4404
	ctrl->numa_node = NUMA_NO_NODE;
4405
	INIT_WORK(&ctrl->scan_work, nvme_scan_work);
4406
	INIT_WORK(&ctrl->async_event_work, nvme_async_event_work);
4407
	INIT_WORK(&ctrl->fw_act_work, nvme_fw_act_work);
4408
	INIT_WORK(&ctrl->delete_work, nvme_delete_ctrl_work);
4409
	init_waitqueue_head(&ctrl->state_wq);
4410

4411
	INIT_DELAYED_WORK(&ctrl->ka_work, nvme_keep_alive_work);
4412
	INIT_DELAYED_WORK(&ctrl->failfast_work, nvme_failfast_work);
4413 4414 4415
	memset(&ctrl->ka_cmd, 0, sizeof(ctrl->ka_cmd));
	ctrl->ka_cmd.common.opcode = nvme_admin_keep_alive;

4416 4417 4418 4419 4420 4421 4422 4423
	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;
	}

4424 4425
	ret = ida_simple_get(&nvme_instance_ida, 0, 0, GFP_KERNEL);
	if (ret < 0)
4426
		goto out;
4427
	ctrl->instance = ret;
4428

4429 4430
	device_initialize(&ctrl->ctrl_device);
	ctrl->device = &ctrl->ctrl_device;
4431 4432
	ctrl->device->devt = MKDEV(MAJOR(nvme_ctrl_base_chr_devt),
			ctrl->instance);
4433 4434 4435 4436 4437 4438 4439
	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)
4440 4441
		goto out_release_instance;

4442
	nvme_get_ctrl(ctrl);
4443 4444 4445
	cdev_init(&ctrl->cdev, &nvme_dev_fops);
	ctrl->cdev.owner = ops->module;
	ret = cdev_device_add(&ctrl->cdev, ctrl->device);
4446 4447
	if (ret)
		goto out_free_name;
4448

4449 4450 4451 4452 4453 4454 4455 4456
	/*
	 * 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));

4457
	nvme_fault_inject_init(&ctrl->fault_inject, dev_name(ctrl->device));
4458
	nvme_mpath_init_ctrl(ctrl);
4459

4460
	return 0;
4461
out_free_name:
4462
	nvme_put_ctrl(ctrl);
4463
	kfree_const(ctrl->device->kobj.name);
4464
out_release_instance:
4465
	ida_simple_remove(&nvme_instance_ida, ctrl->instance);
4466
out:
4467 4468
	if (ctrl->discard_page)
		__free_page(ctrl->discard_page);
4469 4470
	return ret;
}
4471
EXPORT_SYMBOL_GPL(nvme_init_ctrl);
4472

4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483
/**
 * 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;

4484
	down_read(&ctrl->namespaces_rwsem);
M
Ming Lei 已提交
4485

4486
	/* Forcibly unquiesce queues to avoid blocking dispatch */
I
Igor Konopko 已提交
4487
	if (ctrl->admin_q && !blk_queue_dying(ctrl->admin_q))
4488
		blk_mq_unquiesce_queue(ctrl->admin_q);
4489

4490 4491
	list_for_each_entry(ns, &ctrl->namespaces, list)
		nvme_set_queue_dying(ns);
4492

4493
	up_read(&ctrl->namespaces_rwsem);
4494
}
4495
EXPORT_SYMBOL_GPL(nvme_kill_queues);
4496

K
Keith Busch 已提交
4497 4498 4499 4500
void nvme_unfreeze(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

4501
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4502 4503
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_unfreeze_queue(ns->queue);
4504
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4505 4506 4507
}
EXPORT_SYMBOL_GPL(nvme_unfreeze);

4508
int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout)
K
Keith Busch 已提交
4509 4510 4511
{
	struct nvme_ns *ns;

4512
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4513 4514 4515 4516 4517
	list_for_each_entry(ns, &ctrl->namespaces, list) {
		timeout = blk_mq_freeze_queue_wait_timeout(ns->queue, timeout);
		if (timeout <= 0)
			break;
	}
4518
	up_read(&ctrl->namespaces_rwsem);
4519
	return timeout;
K
Keith Busch 已提交
4520 4521 4522 4523 4524 4525 4526
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze_timeout);

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

4527
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4528 4529
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_freeze_queue_wait(ns->queue);
4530
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4531 4532 4533 4534 4535 4536 4537
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze);

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

4538
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4539
	list_for_each_entry(ns, &ctrl->namespaces, list)
4540
		blk_freeze_queue_start(ns->queue);
4541
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4542 4543 4544
}
EXPORT_SYMBOL_GPL(nvme_start_freeze);

4545
void nvme_stop_queues(struct nvme_ctrl *ctrl)
4546 4547 4548
{
	struct nvme_ns *ns;

4549
	down_read(&ctrl->namespaces_rwsem);
4550
	list_for_each_entry(ns, &ctrl->namespaces, list)
4551
		blk_mq_quiesce_queue(ns->queue);
4552
	up_read(&ctrl->namespaces_rwsem);
4553
}
4554
EXPORT_SYMBOL_GPL(nvme_stop_queues);
4555

4556
void nvme_start_queues(struct nvme_ctrl *ctrl)
4557 4558 4559
{
	struct nvme_ns *ns;

4560
	down_read(&ctrl->namespaces_rwsem);
4561
	list_for_each_entry(ns, &ctrl->namespaces, list)
4562
		blk_mq_unquiesce_queue(ns->queue);
4563
	up_read(&ctrl->namespaces_rwsem);
4564
}
4565
EXPORT_SYMBOL_GPL(nvme_start_queues);
4566

C
Chao Leng 已提交
4567
void nvme_sync_io_queues(struct nvme_ctrl *ctrl)
K
Keith Busch 已提交
4568 4569 4570 4571 4572 4573 4574
{
	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 已提交
4575 4576
}
EXPORT_SYMBOL_GPL(nvme_sync_io_queues);
4577

C
Chao Leng 已提交
4578 4579 4580
void nvme_sync_queues(struct nvme_ctrl *ctrl)
{
	nvme_sync_io_queues(ctrl);
4581 4582
	if (ctrl->admin_q)
		blk_sync_queue(ctrl->admin_q);
K
Keith Busch 已提交
4583 4584 4585
}
EXPORT_SYMBOL_GPL(nvme_sync_queues);

4586
struct nvme_ctrl *nvme_ctrl_from_file(struct file *file)
4587
{
4588 4589 4590
	if (file->f_op != &nvme_dev_fops)
		return NULL;
	return file->private_data;
4591
}
4592
EXPORT_SYMBOL_NS_GPL(nvme_ctrl_from_file, NVME_TARGET_PASSTHRU);
4593

4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611
/*
 * 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 已提交
4612 4613
	BUILD_BUG_ON(sizeof(struct nvme_id_ns_zns) != NVME_IDENTIFY_DATA_SIZE);
	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl_zns) != NVME_IDENTIFY_DATA_SIZE);
4614
	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl_nvm) != NVME_IDENTIFY_DATA_SIZE);
4615 4616 4617 4618 4619 4620 4621
	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);
}


4622
static int __init nvme_core_init(void)
4623
{
4624
	int result = -ENOMEM;
4625

4626 4627
	_nvme_check_size();

4628 4629 4630
	nvme_wq = alloc_workqueue("nvme-wq",
			WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0);
	if (!nvme_wq)
4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641
		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;
4642

4643 4644
	result = alloc_chrdev_region(&nvme_ctrl_base_chr_devt, 0,
			NVME_MINORS, "nvme");
4645
	if (result < 0)
4646
		goto destroy_delete_wq;
4647 4648 4649 4650 4651 4652

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

C
Christoph Hellwig 已提交
4655 4656 4657 4658 4659
	nvme_subsys_class = class_create(THIS_MODULE, "nvme-subsystem");
	if (IS_ERR(nvme_subsys_class)) {
		result = PTR_ERR(nvme_subsys_class);
		goto destroy_class;
	}
4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671

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

4672
	return 0;
4673

4674 4675 4676 4677
unregister_generic_ns:
	unregister_chrdev_region(nvme_ns_chr_devt, NVME_MINORS);
destroy_subsys_class:
	class_destroy(nvme_subsys_class);
C
Christoph Hellwig 已提交
4678 4679
destroy_class:
	class_destroy(nvme_class);
4680
unregister_chrdev:
4681
	unregister_chrdev_region(nvme_ctrl_base_chr_devt, NVME_MINORS);
4682 4683 4684 4685
destroy_delete_wq:
	destroy_workqueue(nvme_delete_wq);
destroy_reset_wq:
	destroy_workqueue(nvme_reset_wq);
4686 4687
destroy_wq:
	destroy_workqueue(nvme_wq);
4688
out:
4689
	return result;
4690 4691
}

4692
static void __exit nvme_core_exit(void)
4693
{
4694
	class_destroy(nvme_ns_chr_class);
C
Christoph Hellwig 已提交
4695
	class_destroy(nvme_subsys_class);
4696
	class_destroy(nvme_class);
4697
	unregister_chrdev_region(nvme_ns_chr_devt, NVME_MINORS);
4698
	unregister_chrdev_region(nvme_ctrl_base_chr_devt, NVME_MINORS);
4699 4700
	destroy_workqueue(nvme_delete_wq);
	destroy_workqueue(nvme_reset_wq);
4701
	destroy_workqueue(nvme_wq);
4702
	ida_destroy(&nvme_ns_chr_minor_ida);
M
Max Gurtovoy 已提交
4703
	ida_destroy(&nvme_instance_ida);
4704
}
4705 4706 4707 4708 4709

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