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

#include <linux/blkdev.h>
#include <linux/blk-mq.h>
9
#include <linux/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 17
#include <linux/slab.h>
#include <linux/types.h>
18 19 20
#include <linux/pr.h>
#include <linux/ptrace.h>
#include <linux/nvme_ioctl.h>
21
#include <linux/pm_qos.h>
22
#include <asm/unaligned.h>
23 24

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

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

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

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

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

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

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

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

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

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

79 80 81 82
static bool streams;
module_param(streams, bool, 0644);
MODULE_PARM_DESC(streams, "turn on support for Streams write directives");

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

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

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

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

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

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

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

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

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

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

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


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

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

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

218 219 220
	return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

345 346
	return RETRY;
}
347

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

639 640 641 642 643 644 645 646
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);
647 648
	return req;
}
649
EXPORT_SYMBOL_GPL(nvme_alloc_request);
650

651
static struct request *nvme_alloc_request_qid(struct request_queue *q,
652 653 654 655 656 657 658 659 660 661 662
		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;
}

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

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

	c.directive.opcode = nvme_admin_directive_send;
A
Arnav Dawn 已提交
728
	c.directive.nsid = cpu_to_le32(NVME_NSID_ALL);
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
	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)
{
750
	struct nvme_command c = { };
751 752 753 754 755

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

	c.directive.opcode = nvme_admin_directive_recv;
	c.directive.nsid = cpu_to_le32(nsid);
K
Keith Busch 已提交
756
	c.directive.numd = cpu_to_le32(nvme_bytes_to_numd(sizeof(*s)));
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
	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 已提交
777
	ret = nvme_get_stream_params(ctrl, &s, NVME_NSID_ALL);
778
	if (ret)
779
		goto out_disable_stream;
780 781 782 783 784

	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);
785
		goto out_disable_stream;
786 787
	}

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

out_disable_stream:
	nvme_disable_streams(ctrl);
	return ret;
795 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
}

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

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

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

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

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

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

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

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

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

889 890 891 892 893 894 895 896 897
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 =
898
		cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
899 900
	cmnd->write_zeroes.length =
		cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
901 902 903 904
	if (nvme_ns_has_pi(ns))
		cmnd->write_zeroes.control = cpu_to_le16(NVME_RW_PRINFO_PRACT);
	else
		cmnd->write_zeroes.control = 0;
905 906 907
	return BLK_STS_OK;
}

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

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

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

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

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

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

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

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

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

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

1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
/*
 * 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);
}

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

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

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

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

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

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

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

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

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

1194
int nvme_execute_passthru_rq(struct request *rq)
1195 1196 1197 1198 1199 1200
{
	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;
1201
	int  ret;
1202 1203

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

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

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

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

	blk_mq_free_request(rq);

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

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

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

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

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

	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 已提交
1275 1276
}

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

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

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

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

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

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

1342
static int nvme_process_ns_desc(struct nvme_ctrl *ctrl, struct nvme_ns_ids *ids,
1343
		struct nvme_ns_id_desc *cur, bool *csi_seen)
1344 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
{
	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;
1373 1374 1375 1376 1377 1378 1379 1380 1381
	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;
1382 1383 1384 1385 1386 1387
	default:
		/* Skip unknown types */
		return cur->nidl;
	}
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1474 1475 1476 1477
	return 0;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

C
Christoph Hellwig 已提交
1675 1676 1677 1678 1679 1680 1681
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));
}

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

K
Keith Busch 已提交
1690 1691
static int nvme_setup_streams_ns(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
				 u32 *phys_bs, u32 *io_opt)
1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706
{
	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 已提交
1707
		*phys_bs = ns->sws * (1 << ns->lba_shift);
1708
		if (ns->sgs)
K
Keith Busch 已提交
1709
			*io_opt = *phys_bs * ns->sgs;
1710 1711 1712 1713 1714
	}

	return 0;
}

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

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

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

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

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

1793 1794
	blk_integrity_unregister(disk);

D
Damien Le Moal 已提交
1795
	atomic_bs = phys_bs = bs;
K
Keith Busch 已提交
1796
	nvme_setup_streams_ns(ns->ctrl, ns, &phys_bs, &io_opt);
1797 1798 1799 1800 1801 1802
	if (id->nabo == 0) {
		/*
		 * Bit 1 indicates whether NAWUPF is defined for this namespace
		 * and whether it should be used instead of AWUPF. If NAWUPF ==
		 * 0 then AWUPF must be used instead.
		 */
1803
		if (id->nsfeat & NVME_NS_FEAT_ATOMICS && id->nawupf)
1804 1805 1806 1807
			atomic_bs = (1 + le16_to_cpu(id->nawupf)) * bs;
		else
			atomic_bs = (1 + ns->ctrl->subsys->awupf) * bs;
	}
K
Keith Busch 已提交
1808

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

1816
	blk_queue_logical_block_size(disk->queue, bs);
1817 1818 1819 1820 1821 1822 1823 1824
	/*
	 * Linux filesystems assume writing a single physical block is
	 * an atomic operation. Hence limit the physical block size to the
	 * value of the Atomic Write Unit Power Fail parameter.
	 */
	blk_queue_physical_block_size(disk->queue, min(phys_bs, atomic_bs));
	blk_queue_io_min(disk->queue, phys_bs);
	blk_queue_io_opt(disk->queue, io_opt);
1825

1826 1827 1828 1829 1830 1831 1832 1833 1834
	/*
	 * Register a metadata profile for PI, or the plain non-integrity NVMe
	 * metadata masquerading as Type 0 if supported, otherwise reject block
	 * I/O to namespaces with metadata except when the namespace supports
	 * PI, as it can strip/insert in that case.
	 */
	if (ns->ms) {
		if (IS_ENABLED(CONFIG_BLK_DEV_INTEGRITY) &&
		    (ns->features & NVME_NS_METADATA_SUPPORTED))
1835 1836
			nvme_init_integrity(disk, ns->ms, ns->pi_type,
					    ns->ctrl->max_integrity_segments);
1837 1838 1839 1840
		else if (!nvme_ns_has_pi(ns))
			capacity = 0;
	}

1841
	set_capacity_and_notify(disk, capacity);
1842

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

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

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

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

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

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

1897 1898 1899 1900 1901 1902
	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);

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

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

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

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

1929 1930
out_unfreeze:
	blk_mq_unfreeze_queue(ns->disk->queue);
1931 1932 1933 1934 1935 1936 1937 1938 1939
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 已提交
1940 1941 1942
	return ret;
}

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

1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985
static int nvme_send_ns_head_pr_command(struct block_device *bdev,
		struct nvme_command *c, u8 data[16])
{
	struct nvme_ns_head *head = bdev->bd_disk->private_data;
	int srcu_idx = srcu_read_lock(&head->srcu);
	struct nvme_ns *ns = nvme_find_path(head);
	int ret = -EWOULDBLOCK;

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

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

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

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

1998 1999 2000 2001
	if (IS_ENABLED(CONFIG_NVME_MULTIPATH) &&
	    bdev->bd_disk->fops == &nvme_ns_head_ops)
		return nvme_send_ns_head_pr_command(bdev, &c, data);
	return nvme_send_ns_pr_command(bdev->bd_disk->private_data, &c, data);
2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033
}

static int nvme_pr_register(struct block_device *bdev, u64 old,
		u64 new, unsigned flags)
{
	u32 cdw10;

	if (flags & ~PR_FL_IGNORE_KEY)
		return -EOPNOTSUPP;

	cdw10 = old ? 2 : 0;
	cdw10 |= (flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0;
	cdw10 |= (1 << 30) | (1 << 31); /* PTPL=1 */
	return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_register);
}

static int nvme_pr_reserve(struct block_device *bdev, u64 key,
		enum pr_type type, unsigned flags)
{
	u32 cdw10;

	if (flags & ~PR_FL_IGNORE_KEY)
		return -EOPNOTSUPP;

	cdw10 = nvme_pr_type(type) << 8;
	cdw10 |= ((flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0);
	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_acquire);
}

static int nvme_pr_preempt(struct block_device *bdev, u64 old, u64 new,
		enum pr_type type, bool abort)
{
2034
	u32 cdw10 = nvme_pr_type(type) << 8 | (abort ? 2 : 1);
2035

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

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

2043 2044 2045 2046 2047
	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_register);
}

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

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

2053
const struct pr_ops nvme_pr_ops = {
2054 2055 2056 2057 2058 2059 2060
	.pr_register	= nvme_pr_register,
	.pr_reserve	= nvme_pr_reserve,
	.pr_release	= nvme_pr_release,
	.pr_preempt	= nvme_pr_preempt,
	.pr_clear	= nvme_pr_clear,
};

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

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

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

2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092
#ifdef CONFIG_BLK_DEV_ZONED
static int nvme_report_zones(struct gendisk *disk, sector_t sector,
		unsigned int nr_zones, report_zones_cb cb, void *data)
{
	return nvme_ns_report_zones(disk->private_data, sector, nr_zones, cb,
			data);
}
#else
#define nvme_report_zones	NULL
#endif /* CONFIG_BLK_DEV_ZONED */

J
Javier González 已提交
2093
static const struct block_device_operations nvme_bdev_ops = {
2094 2095 2096 2097 2098
	.owner		= THIS_MODULE,
	.ioctl		= nvme_ioctl,
	.open		= nvme_open,
	.release	= nvme_release,
	.getgeo		= nvme_getgeo,
K
Keith Busch 已提交
2099
	.report_zones	= nvme_report_zones,
2100 2101 2102
	.pr_ops		= &nvme_pr_ops,
};

2103 2104 2105 2106 2107 2108 2109 2110
static int nvme_wait_ready(struct nvme_ctrl *ctrl, u64 cap, bool enabled)
{
	unsigned long timeout =
		((NVME_CAP_TIMEOUT(cap) + 1) * HZ / 2) + jiffies;
	u32 csts, bit = enabled ? NVME_CSTS_RDY : 0;
	int ret;

	while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) {
K
Keith Busch 已提交
2111 2112
		if (csts == ~0)
			return -ENODEV;
2113 2114 2115
		if ((csts & NVME_CSTS_RDY) == bit)
			break;

2116
		usleep_range(1000, 2000);
2117 2118 2119
		if (fatal_signal_pending(current))
			return -EINTR;
		if (time_after(jiffies, timeout)) {
2120
			dev_err(ctrl->device,
2121 2122
				"Device not ready; aborting %s, CSTS=0x%x\n",
				enabled ? "initialisation" : "reset", csts);
2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135
			return -ENODEV;
		}
	}

	return ret;
}

/*
 * If the device has been passed off to us in an enabled state, just clear
 * the enabled bit.  The spec says we should set the 'shutdown notification
 * bits', but doing so may cause the device to complete commands to the
 * admin queue ... and we don't know what memory that might be pointing at!
 */
2136
int nvme_disable_ctrl(struct nvme_ctrl *ctrl)
2137 2138 2139 2140 2141 2142 2143 2144 2145
{
	int ret;

	ctrl->ctrl_config &= ~NVME_CC_SHN_MASK;
	ctrl->ctrl_config &= ~NVME_CC_ENABLE;

	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
	if (ret)
		return ret;
2146

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

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

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

2159 2160 2161 2162 2163 2164 2165
	ret = ctrl->ops->reg_read64(ctrl, NVME_REG_CAP, &ctrl->cap);
	if (ret) {
		dev_err(ctrl->device, "Reading CAP failed (%d)\n", ret);
		return ret;
	}
	dev_page_min = NVME_CAP_MPSMIN(ctrl->cap) + 12;

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

2173 2174 2175 2176
	if (NVME_CAP_CSS(ctrl->cap) & NVME_CAP_CSS_CSI)
		ctrl->ctrl_config = NVME_CC_CSS_CSI;
	else
		ctrl->ctrl_config = NVME_CC_CSS_NVM;
2177
	ctrl->ctrl_config |= (NVME_CTRL_PAGE_SHIFT - 12) << NVME_CC_MPS_SHIFT;
2178
	ctrl->ctrl_config |= NVME_CC_AMS_RR | NVME_CC_SHN_NONE;
2179 2180 2181 2182 2183 2184
	ctrl->ctrl_config |= NVME_CC_IOSQES | NVME_CC_IOCQES;
	ctrl->ctrl_config |= NVME_CC_ENABLE;

	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
	if (ret)
		return ret;
2185
	return nvme_wait_ready(ctrl, ctrl->cap, true);
2186
}
2187
EXPORT_SYMBOL_GPL(nvme_enable_ctrl);
2188 2189 2190

int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl)
{
2191
	unsigned long timeout = jiffies + (ctrl->shutdown_timeout * HZ);
2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209
	u32 csts;
	int ret;

	ctrl->ctrl_config &= ~NVME_CC_SHN_MASK;
	ctrl->ctrl_config |= NVME_CC_SHN_NORMAL;

	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
	if (ret)
		return ret;

	while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) {
		if ((csts & NVME_CSTS_SHST_MASK) == NVME_CSTS_SHST_CMPLT)
			break;

		msleep(100);
		if (fatal_signal_pending(current))
			return -EINTR;
		if (time_after(jiffies, timeout)) {
2210
			dev_err(ctrl->device,
2211 2212 2213 2214 2215 2216 2217
				"Device shutdown incomplete; abort shutdown\n");
			return -ENODEV;
		}
	}

	return ret;
}
2218
EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl);
2219

2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236
static int nvme_configure_timestamp(struct nvme_ctrl *ctrl)
{
	__le64 ts;
	int ret;

	if (!(ctrl->oncs & NVME_CTRL_ONCS_TIMESTAMP))
		return 0;

	ts = cpu_to_le64(ktime_to_ms(ktime_get_real()));
	ret = nvme_set_features(ctrl, NVME_FEAT_TIMESTAMP, 0, &ts, sizeof(ts),
			NULL);
	if (ret)
		dev_warn_once(ctrl->device,
			"could not set timestamp (%d)\n", ret);
	return ret;
}

2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256
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;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450
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[] = {
2451
	{
2452 2453 2454 2455 2456 2457
		/*
		 * 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",
2458
		.quirks = NVME_QUIRK_NO_APST,
2459 2460 2461 2462 2463 2464 2465 2466 2467 2468
	},
	{
		/*
		 * 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,
2469
	}
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
};

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

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

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

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

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

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

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

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

2597
	return sysfs_emit(buf, "%s\n", subsys->subnqn);
2598 2599 2600 2601 2602 2603 2604 2605 2606
}
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);		\
2607 2608
	return sysfs_emit(buf, "%.*s\n",				\
			   (int)sizeof(subsys->field), subsys->field);	\
2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620
}									\
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,
2621 2622 2623
#ifdef CONFIG_NVME_MULTIPATH
	&subsys_attr_iopolicy.attr,
#endif
2624 2625 2626
	NULL,
};

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

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

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

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

2646 2647
	lockdep_assert_held(&nvme_subsystems_lock);

2648
	list_for_each_entry(tmp, &subsys->ctrls, subsys_entry) {
2649
		if (nvme_state_terminal(tmp))
2650 2651 2652 2653 2654 2655 2656 2657
			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;
		}
2658

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

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

2668
	return true;
2669 2670
}

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

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

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

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

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

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

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

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

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

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

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

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

2771 2772
	if (cel)
		goto out;
2773

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3052
	ctrl->identified = true;
3053

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

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

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

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

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

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

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

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;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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;

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

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

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

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

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

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

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

	return a->mode;
}

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

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

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

	lockdep_assert_held(&subsys->lock);

	list_for_each_entry(h, &subsys->nsheads, entry) {
3526 3527 3528
		if (h->ns_id != nsid)
			continue;
		if (!list_empty(&h->list) && nvme_tryget_ns_head(h))
C
Christoph Hellwig 已提交
3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550
			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;
}

3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570
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);
3571 3572
	if (ret) {
		put_device(cdev_device);
3573
		ida_simple_remove(&nvme_ns_chr_minor_ida, minor);
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 3612
	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 已提交
3613
static struct nvme_ns_head *nvme_alloc_ns_head(struct nvme_ctrl *ctrl,
K
Keith Busch 已提交
3614
		unsigned nsid, struct nvme_ns_ids *ids)
C
Christoph Hellwig 已提交
3615 3616
{
	struct nvme_ns_head *head;
3617
	size_t size = sizeof(*head);
C
Christoph Hellwig 已提交
3618 3619
	int ret = -ENOMEM;

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

	head = kzalloc(size, GFP_KERNEL);
C
Christoph Hellwig 已提交
3625 3626 3627 3628 3629 3630 3631
	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);
3632 3633 3634
	ret = init_srcu_struct(&head->srcu);
	if (ret)
		goto out_ida_remove;
C
Christoph Hellwig 已提交
3635 3636
	head->subsys = ctrl->subsys;
	head->ns_id = nsid;
3637
	head->ids = *ids;
C
Christoph Hellwig 已提交
3638 3639 3640 3641 3642 3643 3644 3645 3646
	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;
	}

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

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

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

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

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

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

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

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

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

3718
struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid)
3719
{
3720
	struct nvme_ns *ns, *ret = NULL;
3721

3722
	down_read(&ctrl->namespaces_rwsem);
3723
	list_for_each_entry(ns, &ctrl->namespaces, list) {
C
Christoph Hellwig 已提交
3724
		if (ns->head->ns_id == nsid) {
K
Kanchan Joshi 已提交
3725
			if (!nvme_get_ns(ns))
3726
				continue;
3727 3728 3729
			ret = ns;
			break;
		}
C
Christoph Hellwig 已提交
3730
		if (ns->head->ns_id > nsid)
3731 3732
			break;
	}
3733
	up_read(&ctrl->namespaces_rwsem);
3734
	return ret;
3735
}
3736
EXPORT_SYMBOL_NS_GPL(nvme_find_get_ns, NVME_TARGET_PASSTHRU);
3737

3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753
/*
 * Add the namespace to the controller list while keeping the list ordered.
 */
static void nvme_ns_add_to_ctrl_list(struct nvme_ns *ns)
{
	struct nvme_ns *tmp;

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

3754 3755
static void nvme_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid,
		struct nvme_ns_ids *ids)
3756 3757 3758
{
	struct nvme_ns *ns;
	struct gendisk *disk;
3759
	struct nvme_id_ns *id;
3760
	int node = ctrl->numa_node;
3761

3762
	if (nvme_identify_ns(ctrl, nsid, ids, &id))
3763 3764
		return;

3765 3766
	ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
	if (!ns)
3767
		goto out_free_id;
3768

C
Christoph Hellwig 已提交
3769 3770
	disk = blk_mq_alloc_disk(ctrl->tagset, ns);
	if (IS_ERR(disk))
C
Christoph Hellwig 已提交
3771
		goto out_free_ns;
C
Christoph Hellwig 已提交
3772 3773 3774 3775 3776
	disk->fops = &nvme_bdev_ops;
	disk->private_data = ns;

	ns->disk = disk;
	ns->queue = disk->queue;
3777

3778
	if (ctrl->opts && ctrl->opts->data_digest)
3779
		blk_queue_flag_set(QUEUE_FLAG_STABLE_WRITES, ns->queue);
3780

3781
	blk_queue_flag_set(QUEUE_FLAG_NONROT, ns->queue);
3782 3783 3784
	if (ctrl->ops->flags & NVME_F_PCI_P2PDMA)
		blk_queue_flag_set(QUEUE_FLAG_PCI_P2PDMA, ns->queue);

3785 3786 3787
	ns->ctrl = ctrl;
	kref_init(&ns->kref);

3788
	if (nvme_init_ns_head(ns, nsid, ids, id->nmic & NVME_NS_NMIC_SHARED))
C
Christoph Hellwig 已提交
3789
		goto out_cleanup_disk;
3790

3791 3792 3793 3794 3795 3796 3797 3798
	/*
	 * 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);
3799

3800
	if (nvme_update_ns_info(ns, id))
C
Christoph Hellwig 已提交
3801
		goto out_unlink_ns;
3802

3803
	down_write(&ctrl->namespaces_rwsem);
3804
	nvme_ns_add_to_ctrl_list(ns);
3805
	up_write(&ctrl->namespaces_rwsem);
3806
	nvme_get_ctrl(ctrl);
3807

3808 3809 3810
	if (device_add_disk(ctrl->device, ns->disk, nvme_ns_id_attr_groups))
		goto out_cleanup_ns_from_list;

3811 3812
	if (!nvme_ns_head_multipath(ns->head))
		nvme_add_ns_cdev(ns);
3813

C
Christoph Hellwig 已提交
3814
	nvme_mpath_add_disk(ns, id);
3815
	nvme_fault_inject_init(&ns->fault_inject, ns->disk->disk_name);
C
Christoph Hellwig 已提交
3816 3817
	kfree(id);

3818
	return;
C
Christoph Hellwig 已提交
3819

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

static void nvme_ns_remove(struct nvme_ns *ns)
{
3842 3843
	bool last_path = false;

3844 3845
	if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
		return;
3846

3847
	clear_bit(NVME_NS_READY, &ns->flags);
3848
	set_capacity(ns->disk, 0);
3849
	nvme_fault_inject_fini(&ns->fault_inject);
3850 3851 3852

	mutex_lock(&ns->ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
3853 3854 3855 3856
	if (list_empty(&ns->head->list)) {
		list_del_init(&ns->head->entry);
		last_path = true;
	}
3857
	mutex_unlock(&ns->ctrl->subsys->lock);
3858

3859 3860 3861 3862 3863 3864
	/* guarantee not available in head->list */
	synchronize_rcu();

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

3866 3867 3868 3869
	if (!nvme_ns_head_multipath(ns->head))
		nvme_cdev_del(&ns->cdev, &ns->cdev_device);
	del_gendisk(ns->disk);
	blk_cleanup_queue(ns->queue);
3870

3871
	down_write(&ns->ctrl->namespaces_rwsem);
3872
	list_del_init(&ns->list);
3873
	up_write(&ns->ctrl->namespaces_rwsem);
3874

3875 3876
	if (last_path)
		nvme_mpath_shutdown_disk(ns->head);
3877 3878 3879
	nvme_put_ns(ns);
}

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

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

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

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

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

	ret = nvme_update_ns_info(ns, id);
3910 3911

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

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

3929 3930
	if (nvme_identify_ns_descs(ctrl, nsid, &ids))
		return;
3931

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

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

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

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

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

3981 3982
}

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

3990 3991
	if (nvme_ctrl_limited_cns(ctrl))
		return -EOPNOTSUPP;
3992

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

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

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

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

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

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

4039
	for (i = 1; i <= nn; i++)
4040
		nvme_validate_or_alloc_ns(ctrl, i);
4041

4042
	nvme_remove_invalid_namespaces(ctrl, nn);
4043 4044
}

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

	log = kzalloc(log_size, GFP_KERNEL);
	if (!log)
4053
		return;
4054

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

	kfree(log);
}

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

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

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

4084
	mutex_lock(&ctrl->scan_lock);
4085 4086
	if (nvme_scan_ns_list(ctrl) != 0)
		nvme_scan_ns_sequential(ctrl);
4087
	mutex_unlock(&ctrl->scan_lock);
4088
}
4089

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

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

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

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

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

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

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

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

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

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

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

4184
	nvme_aen_uevent(ctrl);
4185
	ctrl->ops->submit_async_event(ctrl);
4186 4187
}

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

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

4240
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE))
4241 4242 4243
		return;

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

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

4252 4253
	trace_nvme_async_event(ctrl, aer_notice_type);

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

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

4289
	if (le16_to_cpu(status) >> 1 != NVME_SC_SUCCESS)
4290 4291
		return;

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

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

void nvme_start_ctrl(struct nvme_ctrl *ctrl)
{
4322
	nvme_start_keep_alive(ctrl);
4323

4324 4325
	nvme_enable_aen(ctrl);

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

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

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

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

	xa_destroy(&ctrl->cels);
}

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

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

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

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

	ctrl->ops->free_ctrl(ctrl);

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

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

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

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

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

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

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

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

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

4455
	nvme_fault_inject_init(&ctrl->fault_inject, dev_name(ctrl->device));
4456
	nvme_mpath_init_ctrl(ctrl);
4457

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

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

4482
	down_read(&ctrl->namespaces_rwsem);
M
Ming Lei 已提交
4483

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

4488 4489
	list_for_each_entry(ns, &ctrl->namespaces, list)
		nvme_set_queue_dying(ns);
4490

4491
	up_read(&ctrl->namespaces_rwsem);
4492
}
4493
EXPORT_SYMBOL_GPL(nvme_kill_queues);
4494

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

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

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

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

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

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

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

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

4543
void nvme_stop_queues(struct nvme_ctrl *ctrl)
4544 4545 4546
{
	struct nvme_ns *ns;

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

4554
void nvme_start_queues(struct nvme_ctrl *ctrl)
4555 4556 4557
{
	struct nvme_ns *ns;

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

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

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

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

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


4620
static int __init nvme_core_init(void)
4621
{
4622
	int result = -ENOMEM;
4623

4624 4625
	_nvme_check_size();

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

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

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

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

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

4670
	return 0;
4671

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

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

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