core.c 108.6 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/delay.h>
10
#include <linux/errno.h>
11
#include <linux/hdreg.h>
12
#include <linux/kernel.h>
13
#include <linux/module.h>
14
#include <linux/backing-dev.h>
15
#include <linux/list_sort.h>
16 17
#include <linux/slab.h>
#include <linux/types.h>
18 19 20 21
#include <linux/pr.h>
#include <linux/ptrace.h>
#include <linux/nvme_ioctl.h>
#include <linux/t10-pi.h>
22
#include <linux/pm_qos.h>
23
#include <asm/unaligned.h>
24 25

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

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

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

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

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

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

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

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

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

60 61 62 63
static bool streams;
module_param(streams, bool, 0644);
MODULE_PARM_DESC(streams, "turn on support for Streams write directives");

64 65 66 67 68
/*
 * 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
 *
69 70
 * nvme_wq will host works such as scan, aen handling, fw activation,
 * keep-alive, periodic reconnects etc. nvme_reset_wq
71 72 73 74
 * 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.
 */
75 76 77
struct workqueue_struct *nvme_wq;
EXPORT_SYMBOL_GPL(nvme_wq);

78 79 80 81 82 83
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 已提交
84 85
static LIST_HEAD(nvme_subsystems);
static DEFINE_MUTEX(nvme_subsystems_lock);
86

87
static DEFINE_IDA(nvme_instance_ida);
88
static dev_t nvme_chr_devt;
89
static struct class *nvme_class;
C
Christoph Hellwig 已提交
90
static struct class *nvme_subsys_class;
91

92
static int nvme_revalidate_disk(struct gendisk *disk);
93
static void nvme_put_subsystem(struct nvme_subsystem *subsys);
94 95 96 97 98 99 100 101 102 103 104 105 106 107
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					   unsigned nsid);

static void nvme_set_queue_dying(struct nvme_ns *ns)
{
	/*
	 * Revalidating a dead namespace sets capacity to 0. This will end
	 * buffered writers dirtying pages that can't be synced.
	 */
	if (!ns->disk || test_and_set_bit(NVME_NS_DEAD, &ns->flags))
		return;
	blk_set_queue_dying(ns->queue);
	/* Forcibly unquiesce queues to avoid blocking dispatch */
	blk_mq_unquiesce_queue(ns->queue);
108 109 110 111
	/*
	 * Revalidate after unblocking dispatchers that may be holding bd_butex
	 */
	revalidate_disk(ns->disk);
112
}
113

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

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

139 140 141 142
int nvme_reset_ctrl(struct nvme_ctrl *ctrl)
{
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
		return -EBUSY;
143
	if (!queue_work(nvme_reset_wq, &ctrl->reset_work))
144 145 146 147 148
		return -EBUSY;
	return 0;
}
EXPORT_SYMBOL_GPL(nvme_reset_ctrl);

S
Sagi Grimberg 已提交
149
int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl)
150 151 152 153
{
	int ret;

	ret = nvme_reset_ctrl(ctrl);
154
	if (!ret) {
155
		flush_work(&ctrl->reset_work);
K
Keith Busch 已提交
156
		if (ctrl->state != NVME_CTRL_LIVE)
157 158 159
			ret = -ENETRESET;
	}

160 161
	return ret;
}
S
Sagi Grimberg 已提交
162
EXPORT_SYMBOL_GPL(nvme_reset_ctrl_sync);
163

164
static void nvme_do_delete_ctrl(struct nvme_ctrl *ctrl)
165
{
166 167 168
	dev_info(ctrl->device,
		 "Removing ctrl: NQN \"%s\"\n", ctrl->opts->subsysnqn);

169
	flush_work(&ctrl->reset_work);
170 171
	nvme_stop_ctrl(ctrl);
	nvme_remove_namespaces(ctrl);
172
	ctrl->ops->delete_ctrl(ctrl);
173 174
	nvme_uninit_ctrl(ctrl);
	nvme_put_ctrl(ctrl);
175 176
}

177 178 179 180 181 182 183 184
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);
}

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

195
static int nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl)
196 197 198 199
{
	int ret = 0;

	/*
200 201
	 * Keep a reference until nvme_do_delete_ctrl() complete,
	 * since ->delete_ctrl can free the controller.
202 203
	 */
	nvme_get_ctrl(ctrl);
204 205
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
		ret = -EBUSY;
206
	if (!ret)
207
		nvme_do_delete_ctrl(ctrl);
208 209 210 211
	nvme_put_ctrl(ctrl);
	return ret;
}

212 213 214 215 216
static inline bool nvme_ns_has_pi(struct nvme_ns *ns)
{
	return ns->pi_type && ns->ms == sizeof(struct t10_pi_tuple);
}

217
static blk_status_t nvme_error_status(u16 status)
218
{
219
	switch (status & 0x7ff) {
220
	case NVME_SC_SUCCESS:
221
		return BLK_STS_OK;
222
	case NVME_SC_CAP_EXCEEDED:
223
		return BLK_STS_NOSPC;
224
	case NVME_SC_LBA_RANGE:
225 226
	case NVME_SC_CMD_INTERRUPTED:
	case NVME_SC_NS_NOT_READY:
227 228
		return BLK_STS_TARGET;
	case NVME_SC_BAD_ATTRIBUTES:
229
	case NVME_SC_ONCS_NOT_SUPPORTED:
230 231 232
	case NVME_SC_INVALID_OPCODE:
	case NVME_SC_INVALID_FIELD:
	case NVME_SC_INVALID_NS:
233
		return BLK_STS_NOTSUPP;
234 235 236
	case NVME_SC_WRITE_FAULT:
	case NVME_SC_READ_ERROR:
	case NVME_SC_UNWRITTEN_BLOCK:
237 238
	case NVME_SC_ACCESS_DENIED:
	case NVME_SC_READ_ONLY:
239
	case NVME_SC_COMPARE_FAILED:
240
		return BLK_STS_MEDIUM;
241 242 243 244 245 246 247
	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;
248 249
	case NVME_SC_HOST_PATH_ERROR:
		return BLK_STS_TRANSPORT;
250 251
	default:
		return BLK_STS_IOERR;
252 253 254
	}
}

255
static inline bool nvme_req_needs_retry(struct request *req)
256
{
257 258
	if (blk_noretry_request(req))
		return false;
259
	if (nvme_req(req)->status & NVME_SC_DNR)
260
		return false;
261
	if (nvme_req(req)->retries >= nvme_max_retries)
262 263
		return false;
	return true;
264 265
}

266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
static void nvme_retry_req(struct request *req)
{
	struct nvme_ns *ns = req->q->queuedata;
	unsigned long delay = 0;
	u16 crd;

	/* The mask and shift result must be <= 3 */
	crd = (nvme_req(req)->status & NVME_SC_CRD) >> 11;
	if (ns && crd)
		delay = ns->ctrl->crdt[crd - 1] * 100;

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

282 283
void nvme_complete_rq(struct request *req)
{
284
	blk_status_t status = nvme_error_status(nvme_req(req)->status);
285

286 287
	trace_nvme_complete_rq(req);

288 289
	nvme_cleanup_cmd(req);

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

293
	if (unlikely(status != BLK_STS_OK && nvme_req_needs_retry(req))) {
294 295
		if ((req->cmd_flags & REQ_NVME_MPATH) &&
		    blk_path_error(status)) {
296 297 298 299 300
			nvme_failover_req(req);
			return;
		}

		if (!blk_queue_dying(req->q)) {
301
			nvme_retry_req(req);
302 303
			return;
		}
304
	}
H
Hannes Reinecke 已提交
305 306

	nvme_trace_bio_complete(req, status);
307
	blk_mq_end_request(req, status);
308 309 310
}
EXPORT_SYMBOL_GPL(nvme_complete_rq);

311
bool nvme_cancel_request(struct request *req, void *data, bool reserved)
312 313 314 315
{
	dev_dbg_ratelimited(((struct nvme_ctrl *) data)->device,
				"Cancelling I/O %d", req->tag);

316 317 318 319
	/* don't abort one completed request */
	if (blk_mq_request_completed(req))
		return true;

320
	nvme_req(req)->status = NVME_SC_HOST_ABORTED_CMD;
321
	blk_mq_complete_request(req);
322
	return true;
323 324 325
}
EXPORT_SYMBOL_GPL(nvme_cancel_request);

326 327 328
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state)
{
329
	enum nvme_ctrl_state old_state;
330
	unsigned long flags;
331 332
	bool changed = false;

333
	spin_lock_irqsave(&ctrl->lock, flags);
334 335

	old_state = ctrl->state;
336 337 338
	switch (new_state) {
	case NVME_CTRL_LIVE:
		switch (old_state) {
339
		case NVME_CTRL_NEW:
340
		case NVME_CTRL_RESETTING:
341
		case NVME_CTRL_CONNECTING:
342 343 344 345 346 347 348 349 350
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
	case NVME_CTRL_RESETTING:
		switch (old_state) {
		case NVME_CTRL_NEW:
351 352 353 354 355 356 357
		case NVME_CTRL_LIVE:
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
358
	case NVME_CTRL_CONNECTING:
359
		switch (old_state) {
360
		case NVME_CTRL_NEW:
361
		case NVME_CTRL_RESETTING:
362 363 364 365 366 367 368 369 370 371
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
	case NVME_CTRL_DELETING:
		switch (old_state) {
		case NVME_CTRL_LIVE:
		case NVME_CTRL_RESETTING:
372
		case NVME_CTRL_CONNECTING:
373 374 375 376 377 378
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
379 380 381 382 383 384 385 386 387
	case NVME_CTRL_DEAD:
		switch (old_state) {
		case NVME_CTRL_DELETING:
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
388 389 390 391
	default:
		break;
	}

392
	if (changed) {
393
		ctrl->state = new_state;
394 395
		wake_up_all(&ctrl->state_wq);
	}
396

397
	spin_unlock_irqrestore(&ctrl->lock, flags);
398 399
	if (changed && ctrl->state == NVME_CTRL_LIVE)
		nvme_kick_requeue_lists(ctrl);
400 401 402 403
	return changed;
}
EXPORT_SYMBOL_GPL(nvme_change_ctrl_state);

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
/*
 * 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:
	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 已提交
437 438 439 440 441
static void nvme_free_ns_head(struct kref *ref)
{
	struct nvme_ns_head *head =
		container_of(ref, struct nvme_ns_head, ref);

442
	nvme_mpath_remove_disk(head);
C
Christoph Hellwig 已提交
443 444
	ida_simple_remove(&head->subsys->ns_ida, head->instance);
	list_del_init(&head->entry);
445
	cleanup_srcu_struct(&head->srcu);
446
	nvme_put_subsystem(head->subsys);
C
Christoph Hellwig 已提交
447 448 449 450 451 452 453 454
	kfree(head);
}

static void nvme_put_ns_head(struct nvme_ns_head *head)
{
	kref_put(&head->ref, nvme_free_ns_head);
}

455 456 457 458
static void nvme_free_ns(struct kref *kref)
{
	struct nvme_ns *ns = container_of(kref, struct nvme_ns, kref);

459 460
	if (ns->ndev)
		nvme_nvm_unregister(ns);
461 462

	put_disk(ns->disk);
C
Christoph Hellwig 已提交
463
	nvme_put_ns_head(ns->head);
464
	nvme_put_ctrl(ns->ctrl);
465 466 467
	kfree(ns);
}

468
static void nvme_put_ns(struct nvme_ns *ns)
469 470 471 472
{
	kref_put(&ns->kref, nvme_free_ns);
}

473 474 475 476 477 478 479 480 481
static inline void nvme_clear_nvme_request(struct request *req)
{
	if (!(req->rq_flags & RQF_DONTPREP)) {
		nvme_req(req)->retries = 0;
		nvme_req(req)->flags = 0;
		req->rq_flags |= RQF_DONTPREP;
	}
}

482
struct request *nvme_alloc_request(struct request_queue *q,
483
		struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid)
484
{
485
	unsigned op = nvme_is_write(cmd) ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN;
486 487
	struct request *req;

488
	if (qid == NVME_QID_ANY) {
489
		req = blk_mq_alloc_request(q, op, flags);
490
	} else {
491
		req = blk_mq_alloc_request_hctx(q, op, flags,
492 493
				qid ? qid - 1 : 0);
	}
494
	if (IS_ERR(req))
495
		return req;
496 497

	req->cmd_flags |= REQ_FAILFAST_DRIVER;
498
	nvme_clear_nvme_request(req);
499
	nvme_req(req)->cmd = cmd;
500

501 502
	return req;
}
503
EXPORT_SYMBOL_GPL(nvme_alloc_request);
504

505 506 507 508 509 510 511
static int nvme_toggle_streams(struct nvme_ctrl *ctrl, bool enable)
{
	struct nvme_command c;

	memset(&c, 0, sizeof(c));

	c.directive.opcode = nvme_admin_directive_send;
A
Arnav Dawn 已提交
512
	c.directive.nsid = cpu_to_le32(NVME_NSID_ALL);
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
	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)
{
	struct nvme_command c;

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

	c.directive.opcode = nvme_admin_directive_recv;
	c.directive.nsid = cpu_to_le32(nsid);
541
	c.directive.numd = cpu_to_le32((sizeof(*s) >> 2) - 1);
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
	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 已提交
562
	ret = nvme_get_stream_params(ctrl, &s, NVME_NSID_ALL);
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
	if (ret)
		return ret;

	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);
		nvme_disable_streams(ctrl);
		return 0;
	}

	ctrl->nr_streams = min_t(unsigned, ctrl->nssa, BLK_MAX_WRITE_HINTS - 1);
	dev_info(ctrl->device, "Using %u streams\n", ctrl->nr_streams);
	return 0;
}

/*
 * 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 已提交
604 605 606 607
static inline void nvme_setup_flush(struct nvme_ns *ns,
		struct nvme_command *cmnd)
{
	cmnd->common.opcode = nvme_cmd_flush;
C
Christoph Hellwig 已提交
608
	cmnd->common.nsid = cpu_to_le32(ns->head->ns_id);
M
Ming Lin 已提交
609 610
}

611
static blk_status_t nvme_setup_discard(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
612 613
		struct nvme_command *cmnd)
{
614
	unsigned short segments = blk_rq_nr_discard_segments(req), n = 0;
M
Ming Lin 已提交
615
	struct nvme_dsm_range *range;
616
	struct bio *bio;
M
Ming Lin 已提交
617

618 619 620 621 622 623 624 625
	/*
	 * 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);
626 627 628 629 630 631 632 633 634 635 636
	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 已提交
637

638
	__rq_for_each_bio(bio, req) {
639
		u64 slba = nvme_sect_to_lba(ns, bio->bi_iter.bi_sector);
640 641
		u32 nlb = bio->bi_iter.bi_size >> ns->lba_shift;

K
Keith Busch 已提交
642 643 644 645 646
		if (n < segments) {
			range[n].cattr = cpu_to_le32(0);
			range[n].nlb = cpu_to_le32(nlb);
			range[n].slba = cpu_to_le64(slba);
		}
647 648 649 650
		n++;
	}

	if (WARN_ON_ONCE(n != segments)) {
651 652 653 654
		if (virt_to_page(range) == ns->ctrl->discard_page)
			clear_bit_unlock(0, &ns->ctrl->discard_page_busy);
		else
			kfree(range);
655
		return BLK_STS_IOERR;
656
	}
M
Ming Lin 已提交
657 658

	cmnd->dsm.opcode = nvme_cmd_dsm;
C
Christoph Hellwig 已提交
659
	cmnd->dsm.nsid = cpu_to_le32(ns->head->ns_id);
660
	cmnd->dsm.nr = cpu_to_le32(segments - 1);
M
Ming Lin 已提交
661 662
	cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);

663 664
	req->special_vec.bv_page = virt_to_page(range);
	req->special_vec.bv_offset = offset_in_page(range);
665
	req->special_vec.bv_len = alloc_size;
666
	req->rq_flags |= RQF_SPECIAL_PAYLOAD;
M
Ming Lin 已提交
667

668
	return BLK_STS_OK;
M
Ming Lin 已提交
669 670
}

671 672 673 674 675 676 677 678 679
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 =
680
		cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
681 682 683 684 685 686
	cmnd->write_zeroes.length =
		cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
	cmnd->write_zeroes.control = 0;
	return BLK_STS_OK;
}

687 688
static inline blk_status_t nvme_setup_rw(struct nvme_ns *ns,
		struct request *req, struct nvme_command *cmnd)
M
Ming Lin 已提交
689
{
690
	struct nvme_ctrl *ctrl = ns->ctrl;
M
Ming Lin 已提交
691 692 693 694 695 696 697 698 699 700 701 702
	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;

	cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
C
Christoph Hellwig 已提交
703
	cmnd->rw.nsid = cpu_to_le32(ns->head->ns_id);
704
	cmnd->rw.slba = cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req)));
M
Ming Lin 已提交
705 706
	cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);

707 708 709
	if (req_op(req) == REQ_OP_WRITE && ctrl->nr_streams)
		nvme_assign_write_stream(ctrl, req, &control, &dsmgmt);

M
Ming Lin 已提交
710
	if (ns->ms) {
711 712 713 714 715 716 717 718 719 720 721 722
		/*
		 * 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 已提交
723 724 725 726 727 728 729 730
		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;
731
			cmnd->rw.reftag = cpu_to_le32(t10_pi_ref_tag(req));
M
Ming Lin 已提交
732 733 734 735 736 737
			break;
		}
	}

	cmnd->rw.control = cpu_to_le16(control);
	cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
738
	return 0;
M
Ming Lin 已提交
739 740
}

741 742 743
void nvme_cleanup_cmd(struct request *req)
{
	if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
744 745 746 747 748 749 750
		struct nvme_ns *ns = req->rq_disk->private_data;
		struct page *page = req->special_vec.bv_page;

		if (page == ns->ctrl->discard_page)
			clear_bit_unlock(0, &ns->ctrl->discard_page_busy);
		else
			kfree(page_address(page) + req->special_vec.bv_offset);
751 752 753 754
	}
}
EXPORT_SYMBOL_GPL(nvme_cleanup_cmd);

755
blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
756 757
		struct nvme_command *cmd)
{
758
	blk_status_t ret = BLK_STS_OK;
M
Ming Lin 已提交
759

760
	nvme_clear_nvme_request(req);
761

762
	memset(cmd, 0, sizeof(*cmd));
763 764 765
	switch (req_op(req)) {
	case REQ_OP_DRV_IN:
	case REQ_OP_DRV_OUT:
766
		memcpy(cmd, nvme_req(req)->cmd, sizeof(*cmd));
767 768
		break;
	case REQ_OP_FLUSH:
M
Ming Lin 已提交
769
		nvme_setup_flush(ns, cmd);
770
		break;
771
	case REQ_OP_WRITE_ZEROES:
772 773
		ret = nvme_setup_write_zeroes(ns, req, cmd);
		break;
774
	case REQ_OP_DISCARD:
M
Ming Lin 已提交
775
		ret = nvme_setup_discard(ns, req, cmd);
776 777 778
		break;
	case REQ_OP_READ:
	case REQ_OP_WRITE:
779
		ret = nvme_setup_rw(ns, req, cmd);
780 781 782
		break;
	default:
		WARN_ON_ONCE(1);
783
		return BLK_STS_IOERR;
784
	}
M
Ming Lin 已提交
785

786
	cmd->common.command_id = req->tag;
K
Keith Busch 已提交
787
	trace_nvme_setup_cmd(req, cmd);
M
Ming Lin 已提交
788 789 790 791
	return ret;
}
EXPORT_SYMBOL_GPL(nvme_setup_cmd);

792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
static void nvme_end_sync_rq(struct request *rq, blk_status_t error)
{
	struct completion *waiting = rq->end_io_data;

	rq->end_io_data = NULL;
	complete(waiting);
}

static void nvme_execute_rq_polled(struct request_queue *q,
		struct gendisk *bd_disk, struct request *rq, int at_head)
{
	DECLARE_COMPLETION_ONSTACK(wait);

	WARN_ON_ONCE(!test_bit(QUEUE_FLAG_POLL, &q->queue_flags));

	rq->cmd_flags |= REQ_HIPRI;
	rq->end_io_data = &wait;
	blk_execute_rq_nowait(q, bd_disk, rq, at_head, nvme_end_sync_rq);

	while (!completion_done(&wait)) {
		blk_poll(q, request_to_qc_t(rq->mq_hctx, rq), true);
		cond_resched();
	}
}

817 818 819 820 821
/*
 * 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,
822
		union nvme_result *result, void *buffer, unsigned bufflen,
823
		unsigned timeout, int qid, int at_head,
824
		blk_mq_req_flags_t flags, bool poll)
825 826 827 828
{
	struct request *req;
	int ret;

829
	req = nvme_alloc_request(q, cmd, flags, qid);
830 831 832 833 834
	if (IS_ERR(req))
		return PTR_ERR(req);

	req->timeout = timeout ? timeout : ADMIN_TIMEOUT;

835 836 837 838
	if (buffer && bufflen) {
		ret = blk_rq_map_kern(q, req, buffer, bufflen, GFP_KERNEL);
		if (ret)
			goto out;
839 840
	}

841 842 843 844
	if (poll)
		nvme_execute_rq_polled(req->q, NULL, req, at_head);
	else
		blk_execute_rq(req->q, NULL, req, at_head);
845 846
	if (result)
		*result = nvme_req(req)->result;
847 848 849 850
	if (nvme_req(req)->flags & NVME_REQ_CANCELLED)
		ret = -EINTR;
	else
		ret = nvme_req(req)->status;
851 852 853 854
 out:
	blk_mq_free_request(req);
	return ret;
}
855
EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd);
856 857 858 859

int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
		void *buffer, unsigned bufflen)
{
860
	return __nvme_submit_sync_cmd(q, cmd, NULL, buffer, bufflen, 0,
861
			NVME_QID_ANY, 0, 0, false);
862
}
863
EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd);
864

865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
static void *nvme_add_user_metadata(struct bio *bio, void __user *ubuf,
		unsigned len, u32 seed, bool write)
{
	struct bio_integrity_payload *bip;
	int ret = -ENOMEM;
	void *buf;

	buf = kmalloc(len, GFP_KERNEL);
	if (!buf)
		goto out;

	ret = -EFAULT;
	if (write && copy_from_user(buf, ubuf, len))
		goto out_free_meta;

	bip = bio_integrity_alloc(bio, GFP_KERNEL, 1);
	if (IS_ERR(bip)) {
		ret = PTR_ERR(bip);
		goto out_free_meta;
	}

	bip->bip_iter.bi_size = len;
	bip->bip_iter.bi_sector = seed;
	ret = bio_integrity_add_page(bio, virt_to_page(buf), len,
			offset_in_page(buf));
	if (ret == len)
		return buf;
	ret = -ENOMEM;
out_free_meta:
	kfree(buf);
out:
	return ERR_PTR(ret);
}

899
static int nvme_submit_user_cmd(struct request_queue *q,
900 901
		struct nvme_command *cmd, void __user *ubuffer,
		unsigned bufflen, void __user *meta_buffer, unsigned meta_len,
902
		u32 meta_seed, u64 *result, unsigned timeout)
903
{
904
	bool write = nvme_is_write(cmd);
905 906
	struct nvme_ns *ns = q->queuedata;
	struct gendisk *disk = ns ? ns->disk : NULL;
907
	struct request *req;
908 909
	struct bio *bio = NULL;
	void *meta = NULL;
910 911
	int ret;

912
	req = nvme_alloc_request(q, cmd, 0, NVME_QID_ANY);
913 914 915 916
	if (IS_ERR(req))
		return PTR_ERR(req);

	req->timeout = timeout ? timeout : ADMIN_TIMEOUT;
917
	nvme_req(req)->flags |= NVME_REQ_USERCMD;
918 919

	if (ubuffer && bufflen) {
920 921 922 923 924
		ret = blk_rq_map_user(q, req, NULL, ubuffer, bufflen,
				GFP_KERNEL);
		if (ret)
			goto out;
		bio = req->bio;
925
		bio->bi_disk = disk;
926 927 928 929 930
		if (disk && meta_buffer && meta_len) {
			meta = nvme_add_user_metadata(bio, meta_buffer, meta_len,
					meta_seed, write);
			if (IS_ERR(meta)) {
				ret = PTR_ERR(meta);
931 932
				goto out_unmap;
			}
933
			req->cmd_flags |= REQ_INTEGRITY;
934 935
		}
	}
936

937
	blk_execute_rq(req->q, disk, req, 0);
938 939 940 941
	if (nvme_req(req)->flags & NVME_REQ_CANCELLED)
		ret = -EINTR;
	else
		ret = nvme_req(req)->status;
942
	if (result)
943
		*result = le64_to_cpu(nvme_req(req)->result.u64);
944 945 946 947 948 949
	if (meta && !ret && !write) {
		if (copy_to_user(meta_buffer, meta, meta_len))
			ret = -EFAULT;
	}
	kfree(meta);
 out_unmap:
950
	if (bio)
951
		blk_rq_unmap_user(bio);
952 953 954 955 956
 out:
	blk_mq_free_request(req);
	return ret;
}

957
static void nvme_keep_alive_end_io(struct request *rq, blk_status_t status)
S
Sagi Grimberg 已提交
958 959
{
	struct nvme_ctrl *ctrl = rq->end_io_data;
960 961
	unsigned long flags;
	bool startka = false;
S
Sagi Grimberg 已提交
962 963 964

	blk_mq_free_request(rq);

965
	if (status) {
S
Sagi Grimberg 已提交
966
		dev_err(ctrl->device,
967 968
			"failed nvme_keep_alive_end_io error=%d\n",
				status);
S
Sagi Grimberg 已提交
969 970 971
		return;
	}

972
	ctrl->comp_seen = false;
973 974 975 976 977 978
	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)
979
		queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ);
S
Sagi Grimberg 已提交
980 981 982 983 984 985
}

static int nvme_keep_alive(struct nvme_ctrl *ctrl)
{
	struct request *rq;

986
	rq = nvme_alloc_request(ctrl->admin_q, &ctrl->ka_cmd, BLK_MQ_REQ_RESERVED,
S
Sagi Grimberg 已提交
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
			NVME_QID_ANY);
	if (IS_ERR(rq))
		return PTR_ERR(rq);

	rq->timeout = ctrl->kato * HZ;
	rq->end_io_data = ctrl;

	blk_execute_rq_nowait(rq->q, NULL, rq, 0, nvme_keep_alive_end_io);

	return 0;
}

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);
1003 1004 1005 1006 1007 1008
	bool comp_seen = ctrl->comp_seen;

	if ((ctrl->ctratt & NVME_CTRL_ATTR_TBKAS) && comp_seen) {
		dev_dbg(ctrl->device,
			"reschedule traffic based keep-alive timer\n");
		ctrl->comp_seen = false;
1009
		queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ);
1010 1011
		return;
	}
S
Sagi Grimberg 已提交
1012 1013 1014 1015

	if (nvme_keep_alive(ctrl)) {
		/* allocation failure, reset the controller */
		dev_err(ctrl->device, "keep-alive failed\n");
1016
		nvme_reset_ctrl(ctrl);
S
Sagi Grimberg 已提交
1017 1018 1019 1020
		return;
	}
}

1021
static void nvme_start_keep_alive(struct nvme_ctrl *ctrl)
S
Sagi Grimberg 已提交
1022 1023 1024 1025
{
	if (unlikely(ctrl->kato == 0))
		return;

1026
	queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ);
S
Sagi Grimberg 已提交
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
}

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

K
Keith Busch 已提交
1038
static int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id)
1039 1040 1041 1042 1043 1044
{
	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;
1045
	c.identify.cns = NVME_ID_CNS_CTRL;
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057

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

1058
static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl, unsigned nsid,
1059
		struct nvme_ns_ids *ids)
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
{
	struct nvme_command c = { };
	int status;
	void *data;
	int pos;
	int len;

	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;

1075
	status = nvme_submit_sync_cmd(ctrl->admin_q, &c, data,
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
				      NVME_IDENTIFY_DATA_SIZE);
	if (status)
		goto free_data;

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

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

		switch (cur->nidt) {
		case NVME_NIDT_EUI64:
			if (cur->nidl != NVME_NIDT_EUI64_LEN) {
1089
				dev_warn(ctrl->device,
1090 1091 1092 1093 1094
					 "ctrl returned bogus length: %d for NVME_NIDT_EUI64\n",
					 cur->nidl);
				goto free_data;
			}
			len = NVME_NIDT_EUI64_LEN;
1095
			memcpy(ids->eui64, data + pos + sizeof(*cur), len);
1096 1097 1098
			break;
		case NVME_NIDT_NGUID:
			if (cur->nidl != NVME_NIDT_NGUID_LEN) {
1099
				dev_warn(ctrl->device,
1100 1101 1102 1103 1104
					 "ctrl returned bogus length: %d for NVME_NIDT_NGUID\n",
					 cur->nidl);
				goto free_data;
			}
			len = NVME_NIDT_NGUID_LEN;
1105
			memcpy(ids->nguid, data + pos + sizeof(*cur), len);
1106 1107 1108
			break;
		case NVME_NIDT_UUID:
			if (cur->nidl != NVME_NIDT_UUID_LEN) {
1109
				dev_warn(ctrl->device,
1110 1111 1112 1113 1114
					 "ctrl returned bogus length: %d for NVME_NIDT_UUID\n",
					 cur->nidl);
				goto free_data;
			}
			len = NVME_NIDT_UUID_LEN;
1115
			uuid_copy(&ids->uuid, data + pos + sizeof(*cur));
1116 1117
			break;
		default:
1118
			/* Skip unknown types */
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
			len = cur->nidl;
			break;
		}

		len += sizeof(*cur);
	}
free_data:
	kfree(data);
	return status;
}

1130 1131 1132 1133 1134
static int nvme_identify_ns_list(struct nvme_ctrl *dev, unsigned nsid, __le32 *ns_list)
{
	struct nvme_command c = { };

	c.identify.opcode = nvme_admin_identify;
1135
	c.identify.cns = NVME_ID_CNS_NS_ACTIVE_LIST;
1136
	c.identify.nsid = cpu_to_le32(nsid);
1137 1138
	return nvme_submit_sync_cmd(dev->admin_q, &c, ns_list,
				    NVME_IDENTIFY_DATA_SIZE);
1139 1140
}

1141 1142
static int nvme_identify_ns(struct nvme_ctrl *ctrl,
		unsigned nsid, struct nvme_id_ns **id)
1143 1144 1145 1146 1147
{
	struct nvme_command c = { };
	int error;

	/* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1148 1149
	c.identify.opcode = nvme_admin_identify;
	c.identify.nsid = cpu_to_le32(nsid);
1150
	c.identify.cns = NVME_ID_CNS_NS;
1151

1152 1153 1154
	*id = kmalloc(sizeof(**id), GFP_KERNEL);
	if (!*id)
		return -ENOMEM;
1155

1156
	error = nvme_submit_sync_cmd(ctrl->admin_q, &c, *id, sizeof(**id));
1157
	if (error) {
1158
		dev_warn(ctrl->device, "Identify namespace failed (%d)\n", error);
1159
		kfree(*id);
1160 1161
	}

1162
	return error;
1163 1164
}

K
Keith Busch 已提交
1165 1166
static int nvme_features(struct nvme_ctrl *dev, u8 op, unsigned int fid,
		unsigned int dword11, void *buffer, size_t buflen, u32 *result)
1167
{
1168
	union nvme_result res = { 0 };
1169
	struct nvme_command c;
1170
	int ret;
1171 1172

	memset(&c, 0, sizeof(c));
K
Keith Busch 已提交
1173
	c.features.opcode = op;
1174 1175 1176
	c.features.fid = cpu_to_le32(fid);
	c.features.dword11 = cpu_to_le32(dword11);

1177
	ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &res,
1178
			buffer, buflen, 0, NVME_QID_ANY, 0, 0, false);
1179
	if (ret >= 0 && result)
1180
		*result = le32_to_cpu(res.u32);
1181
	return ret;
1182 1183
}

K
Keith Busch 已提交
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
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 已提交
1202 1203 1204 1205 1206 1207
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;

1208
	status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, NULL, 0,
C
Christoph Hellwig 已提交
1209
			&result);
1210
	if (status < 0)
C
Christoph Hellwig 已提交
1211 1212
		return status;

1213 1214 1215 1216 1217 1218
	/*
	 * 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) {
1219
		dev_err(ctrl->device, "Could not set queue count (%d)\n", status);
1220 1221 1222 1223 1224 1225
		*count = 0;
	} else {
		nr_io_queues = min(result & 0xffff, result >> 16) + 1;
		*count = min(*count, nr_io_queues);
	}

C
Christoph Hellwig 已提交
1226 1227
	return 0;
}
1228
EXPORT_SYMBOL_GPL(nvme_set_queue_count);
C
Christoph Hellwig 已提交
1229

1230
#define NVME_AEN_SUPPORTED \
1231 1232
	(NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_FW_ACT | \
	 NVME_AEN_CFG_ANA_CHANGE | NVME_AEN_CFG_DISC_CHANGE)
1233 1234 1235

static void nvme_enable_aen(struct nvme_ctrl *ctrl)
{
1236
	u32 result, supported_aens = ctrl->oaes & NVME_AEN_SUPPORTED;
1237 1238
	int status;

1239 1240 1241 1242 1243
	if (!supported_aens)
		return;

	status = nvme_set_features(ctrl, NVME_FEAT_ASYNC_EVENT, supported_aens,
			NULL, 0, &result);
1244 1245
	if (status)
		dev_warn(ctrl->device, "Failed to configure AEN (cfg %x)\n",
1246
			 supported_aens);
1247 1248

	queue_work(nvme_wq, &ctrl->async_event_work);
1249 1250
}

1251 1252 1253 1254 1255 1256 1257 1258 1259
static int nvme_submit_io(struct nvme_ns *ns, struct nvme_user_io __user *uio)
{
	struct nvme_user_io io;
	struct nvme_command c;
	unsigned length, meta_len;
	void __user *metadata;

	if (copy_from_user(&io, uio, sizeof(io)))
		return -EFAULT;
1260 1261
	if (io.flags)
		return -EINVAL;
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286

	switch (io.opcode) {
	case nvme_cmd_write:
	case nvme_cmd_read:
	case nvme_cmd_compare:
		break;
	default:
		return -EINVAL;
	}

	length = (io.nblocks + 1) << ns->lba_shift;
	meta_len = (io.nblocks + 1) * ns->ms;
	metadata = (void __user *)(uintptr_t)io.metadata;

	if (ns->ext) {
		length += meta_len;
		meta_len = 0;
	} else if (meta_len) {
		if ((io.metadata & 3) || !io.metadata)
			return -EINVAL;
	}

	memset(&c, 0, sizeof(c));
	c.rw.opcode = io.opcode;
	c.rw.flags = io.flags;
C
Christoph Hellwig 已提交
1287
	c.rw.nsid = cpu_to_le32(ns->head->ns_id);
1288 1289 1290 1291 1292 1293 1294 1295
	c.rw.slba = cpu_to_le64(io.slba);
	c.rw.length = cpu_to_le16(io.nblocks);
	c.rw.control = cpu_to_le16(io.control);
	c.rw.dsmgmt = cpu_to_le32(io.dsmgmt);
	c.rw.reftag = cpu_to_le32(io.reftag);
	c.rw.apptag = cpu_to_le16(io.apptag);
	c.rw.appmask = cpu_to_le16(io.appmask);

1296
	return nvme_submit_user_cmd(ns->queue, &c,
1297
			(void __user *)(uintptr_t)io.addr, length,
1298
			metadata, meta_len, lower_32_bits(io.slba), NULL, 0);
1299 1300
}

1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
static u32 nvme_known_admin_effects(u8 opcode)
{
	switch (opcode) {
	case nvme_admin_format_nvm:
		return NVME_CMD_EFFECTS_CSUPP | NVME_CMD_EFFECTS_LBCC |
					NVME_CMD_EFFECTS_CSE_MASK;
	case nvme_admin_sanitize_nvm:
		return NVME_CMD_EFFECTS_CSE_MASK;
	default:
		break;
	}
	return 0;
}

static u32 nvme_passthru_start(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
								u8 opcode)
{
	u32 effects = 0;

	if (ns) {
		if (ctrl->effects)
			effects = le32_to_cpu(ctrl->effects->iocs[opcode]);
1323
		if (effects & ~(NVME_CMD_EFFECTS_CSUPP | NVME_CMD_EFFECTS_LBCC))
1324 1325 1326 1327 1328 1329 1330
			dev_warn(ctrl->device,
				 "IO command:%02x has unhandled effects:%08x\n",
				 opcode, effects);
		return 0;
	}

	if (ctrl->effects)
1331
		effects = le32_to_cpu(ctrl->effects->acs[opcode]);
K
Keith Busch 已提交
1332
	effects |= nvme_known_admin_effects(opcode);
1333 1334 1335 1336 1337 1338

	/*
	 * For simplicity, IO to all namespaces is quiesced even if the command
	 * effects say only one namespace is affected.
	 */
	if (effects & (NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_CSE_MASK)) {
1339
		mutex_lock(&ctrl->scan_lock);
1340 1341 1342
		mutex_lock(&ctrl->subsys->lock);
		nvme_mpath_start_freeze(ctrl->subsys);
		nvme_mpath_wait_freeze(ctrl->subsys);
1343 1344 1345 1346 1347 1348 1349 1350
		nvme_start_freeze(ctrl);
		nvme_wait_freeze(ctrl);
	}
	return effects;
}

static void nvme_update_formats(struct nvme_ctrl *ctrl)
{
1351
	struct nvme_ns *ns;
1352

1353 1354 1355 1356 1357
	down_read(&ctrl->namespaces_rwsem);
	list_for_each_entry(ns, &ctrl->namespaces, list)
		if (ns->disk && nvme_revalidate_disk(ns->disk))
			nvme_set_queue_dying(ns);
	up_read(&ctrl->namespaces_rwsem);
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
}

static void nvme_passthru_end(struct nvme_ctrl *ctrl, u32 effects)
{
	/*
	 * Revalidate LBA changes prior to unfreezing. This is necessary to
	 * prevent memory corruption if a logical block size was changed by
	 * this command.
	 */
	if (effects & NVME_CMD_EFFECTS_LBCC)
		nvme_update_formats(ctrl);
1369
	if (effects & (NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_CSE_MASK)) {
1370
		nvme_unfreeze(ctrl);
1371 1372
		nvme_mpath_unfreeze(ctrl->subsys);
		mutex_unlock(&ctrl->subsys->lock);
1373
		nvme_remove_invalid_namespaces(ctrl, NVME_NSID_ALL);
1374 1375
		mutex_unlock(&ctrl->scan_lock);
	}
1376 1377 1378 1379 1380 1381
	if (effects & NVME_CMD_EFFECTS_CCC)
		nvme_init_identify(ctrl);
	if (effects & (NVME_CMD_EFFECTS_NIC | NVME_CMD_EFFECTS_NCC))
		nvme_queue_scan(ctrl);
}

1382
static int nvme_user_cmd(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
1383 1384 1385 1386 1387
			struct nvme_passthru_cmd __user *ucmd)
{
	struct nvme_passthru_cmd cmd;
	struct nvme_command c;
	unsigned timeout = 0;
1388
	u32 effects;
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436
	u64 result;
	int status;

	if (!capable(CAP_SYS_ADMIN))
		return -EACCES;
	if (copy_from_user(&cmd, ucmd, sizeof(cmd)))
		return -EFAULT;
	if (cmd.flags)
		return -EINVAL;

	memset(&c, 0, sizeof(c));
	c.common.opcode = cmd.opcode;
	c.common.flags = cmd.flags;
	c.common.nsid = cpu_to_le32(cmd.nsid);
	c.common.cdw2[0] = cpu_to_le32(cmd.cdw2);
	c.common.cdw2[1] = cpu_to_le32(cmd.cdw3);
	c.common.cdw10 = cpu_to_le32(cmd.cdw10);
	c.common.cdw11 = cpu_to_le32(cmd.cdw11);
	c.common.cdw12 = cpu_to_le32(cmd.cdw12);
	c.common.cdw13 = cpu_to_le32(cmd.cdw13);
	c.common.cdw14 = cpu_to_le32(cmd.cdw14);
	c.common.cdw15 = cpu_to_le32(cmd.cdw15);

	if (cmd.timeout_ms)
		timeout = msecs_to_jiffies(cmd.timeout_ms);

	effects = nvme_passthru_start(ctrl, ns, cmd.opcode);
	status = nvme_submit_user_cmd(ns ? ns->queue : ctrl->admin_q, &c,
			(void __user *)(uintptr_t)cmd.addr, cmd.data_len,
			(void __user *)(uintptr_t)cmd.metadata,
			cmd.metadata_len, 0, &result, timeout);
	nvme_passthru_end(ctrl, effects);

	if (status >= 0) {
		if (put_user(result, &ucmd->result))
			return -EFAULT;
	}

	return status;
}

static int nvme_user_cmd64(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
			struct nvme_passthru_cmd64 __user *ucmd)
{
	struct nvme_passthru_cmd64 cmd;
	struct nvme_command c;
	unsigned timeout = 0;
	u32 effects;
1437 1438 1439 1440 1441 1442
	int status;

	if (!capable(CAP_SYS_ADMIN))
		return -EACCES;
	if (copy_from_user(&cmd, ucmd, sizeof(cmd)))
		return -EFAULT;
1443 1444
	if (cmd.flags)
		return -EINVAL;
1445 1446 1447 1448 1449 1450 1451

	memset(&c, 0, sizeof(c));
	c.common.opcode = cmd.opcode;
	c.common.flags = cmd.flags;
	c.common.nsid = cpu_to_le32(cmd.nsid);
	c.common.cdw2[0] = cpu_to_le32(cmd.cdw2);
	c.common.cdw2[1] = cpu_to_le32(cmd.cdw3);
1452 1453 1454 1455 1456 1457
	c.common.cdw10 = cpu_to_le32(cmd.cdw10);
	c.common.cdw11 = cpu_to_le32(cmd.cdw11);
	c.common.cdw12 = cpu_to_le32(cmd.cdw12);
	c.common.cdw13 = cpu_to_le32(cmd.cdw13);
	c.common.cdw14 = cpu_to_le32(cmd.cdw14);
	c.common.cdw15 = cpu_to_le32(cmd.cdw15);
1458 1459 1460 1461

	if (cmd.timeout_ms)
		timeout = msecs_to_jiffies(cmd.timeout_ms);

1462
	effects = nvme_passthru_start(ctrl, ns, cmd.opcode);
1463
	status = nvme_submit_user_cmd(ns ? ns->queue : ctrl->admin_q, &c,
1464
			(void __user *)(uintptr_t)cmd.addr, cmd.data_len,
1465
			(void __user *)(uintptr_t)cmd.metadata, cmd.metadata_len,
1466
			0, &cmd.result, timeout);
1467 1468
	nvme_passthru_end(ctrl, effects);

1469 1470 1471 1472 1473 1474 1475 1476
	if (status >= 0) {
		if (put_user(cmd.result, &ucmd->result))
			return -EFAULT;
	}

	return status;
}

1477 1478 1479 1480 1481 1482
/*
 * Issue ioctl requests on the first available path.  Note that unlike normal
 * block layer requests we will not retry failed request on another controller.
 */
static struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk,
		struct nvme_ns_head **head, int *srcu_idx)
1483
{
1484 1485
#ifdef CONFIG_NVME_MULTIPATH
	if (disk->fops == &nvme_ns_head_ops) {
1486 1487
		struct nvme_ns *ns;

1488 1489
		*head = disk->private_data;
		*srcu_idx = srcu_read_lock(&(*head)->srcu);
1490 1491 1492 1493
		ns = nvme_find_path(*head);
		if (!ns)
			srcu_read_unlock(&(*head)->srcu, *srcu_idx);
		return ns;
1494 1495 1496 1497 1498 1499
	}
#endif
	*head = NULL;
	*srcu_idx = -1;
	return disk->private_data;
}
1500

1501 1502 1503 1504 1505
static void nvme_put_ns_from_disk(struct nvme_ns_head *head, int idx)
{
	if (head)
		srcu_read_unlock(&head->srcu, idx);
}
1506

1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
static bool is_ctrl_ioctl(unsigned int cmd)
{
	if (cmd == NVME_IOCTL_ADMIN_CMD || cmd == NVME_IOCTL_ADMIN64_CMD)
		return true;
	if (is_sed_ioctl(cmd))
		return true;
	return false;
}

static int nvme_handle_ctrl_ioctl(struct nvme_ns *ns, unsigned int cmd,
				  void __user *argp,
				  struct nvme_ns_head *head,
				  int srcu_idx)
{
	struct nvme_ctrl *ctrl = ns->ctrl;
	int ret;

	nvme_get_ctrl(ns->ctrl);
	nvme_put_ns_from_disk(head, srcu_idx);

	switch (cmd) {
	case NVME_IOCTL_ADMIN_CMD:
		ret = nvme_user_cmd(ctrl, NULL, argp);
		break;
	case NVME_IOCTL_ADMIN64_CMD:
		ret = nvme_user_cmd64(ctrl, NULL, argp);
		break;
	default:
		ret = sed_ioctl(ctrl->opal_dev, cmd, argp);
		break;
	}
	nvme_put_ctrl(ctrl);
	return ret;
}

1542 1543
static int nvme_ioctl(struct block_device *bdev, fmode_t mode,
		unsigned int cmd, unsigned long arg)
1544
{
1545
	struct nvme_ns_head *head = NULL;
1546
	void __user *argp = (void __user *)arg;
1547 1548 1549 1550 1551
	struct nvme_ns *ns;
	int srcu_idx, ret;

	ns = nvme_get_ns_from_disk(bdev->bd_disk, &head, &srcu_idx);
	if (unlikely(!ns))
1552 1553
		return -EWOULDBLOCK;

1554 1555 1556 1557 1558
	/*
	 * Handle ioctls that apply to the controller instead of the namespace
	 * seperately and drop the ns SRCU reference early.  This avoids a
	 * deadlock when deleting namespaces using the passthrough interface.
	 */
1559 1560
	if (is_ctrl_ioctl(cmd))
		return nvme_handle_ctrl_ioctl(ns, cmd, argp, head, srcu_idx);
1561

1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
	switch (cmd) {
	case NVME_IOCTL_ID:
		force_successful_syscall_return();
		ret = ns->head->ns_id;
		break;
	case NVME_IOCTL_IO_CMD:
		ret = nvme_user_cmd(ns->ctrl, ns, argp);
		break;
	case NVME_IOCTL_SUBMIT_IO:
		ret = nvme_submit_io(ns, argp);
		break;
1573 1574 1575
	case NVME_IOCTL_IO64_CMD:
		ret = nvme_user_cmd64(ns->ctrl, ns, argp);
		break;
1576 1577 1578 1579 1580 1581 1582
	default:
		if (ns->ndev)
			ret = nvme_nvm_ioctl(ns, cmd, arg);
		else
			ret = -ENOTTY;
	}

1583 1584
	nvme_put_ns_from_disk(head, srcu_idx);
	return ret;
1585 1586 1587 1588
}

static int nvme_open(struct block_device *bdev, fmode_t mode)
{
C
Christoph Hellwig 已提交
1589 1590
	struct nvme_ns *ns = bdev->bd_disk->private_data;

1591 1592 1593
#ifdef CONFIG_NVME_MULTIPATH
	/* should never be called due to GENHD_FL_HIDDEN */
	if (WARN_ON_ONCE(ns->head->disk))
1594
		goto fail;
1595
#endif
C
Christoph Hellwig 已提交
1596
	if (!kref_get_unless_zero(&ns->kref))
1597 1598 1599 1600
		goto fail;
	if (!try_module_get(ns->ctrl->ops->module))
		goto fail_put_ns;

C
Christoph Hellwig 已提交
1601
	return 0;
1602 1603 1604 1605 1606

fail_put_ns:
	nvme_put_ns(ns);
fail:
	return -ENXIO;
1607 1608 1609 1610
}

static void nvme_release(struct gendisk *disk, fmode_t mode)
{
1611 1612 1613 1614
	struct nvme_ns *ns = disk->private_data;

	module_put(ns->ctrl->ops->module);
	nvme_put_ns(ns);
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
}

static int nvme_getgeo(struct block_device *bdev, struct hd_geometry *geo)
{
	/* 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
1627
static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type)
1628 1629 1630
{
	struct blk_integrity integrity;

1631
	memset(&integrity, 0, sizeof(integrity));
1632
	switch (pi_type) {
1633 1634
	case NVME_NS_DPS_PI_TYPE3:
		integrity.profile = &t10_pi_type3_crc;
1635 1636
		integrity.tag_size = sizeof(u16) + sizeof(u32);
		integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1637 1638 1639 1640
		break;
	case NVME_NS_DPS_PI_TYPE1:
	case NVME_NS_DPS_PI_TYPE2:
		integrity.profile = &t10_pi_type1_crc;
1641 1642
		integrity.tag_size = sizeof(u16);
		integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1643 1644 1645 1646 1647
		break;
	default:
		integrity.profile = NULL;
		break;
	}
1648 1649 1650
	integrity.tuple_size = ms;
	blk_integrity_register(disk, &integrity);
	blk_queue_max_integrity_segments(disk->queue, 1);
1651 1652
}
#else
1653
static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type)
1654 1655 1656 1657
{
}
#endif /* CONFIG_BLK_DEV_INTEGRITY */

1658 1659
static void nvme_set_chunk_size(struct nvme_ns *ns)
{
1660
	u32 chunk_size = nvme_lba_to_sect(ns, ns->noiob);
1661 1662 1663
	blk_queue_chunk_sectors(ns->queue, rounddown_pow_of_two(chunk_size));
}

1664
static void nvme_config_discard(struct gendisk *disk, struct nvme_ns *ns)
1665
{
1666
	struct nvme_ctrl *ctrl = ns->ctrl;
1667
	struct request_queue *queue = disk->queue;
1668 1669
	u32 size = queue_logical_block_size(queue);

1670 1671 1672 1673 1674 1675 1676
	if (!(ctrl->oncs & NVME_CTRL_ONCS_DSM)) {
		blk_queue_flag_clear(QUEUE_FLAG_DISCARD, queue);
		return;
	}

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

1678 1679 1680
	BUILD_BUG_ON(PAGE_SIZE / sizeof(struct nvme_dsm_range) <
			NVME_DSM_MAX_RANGES);

1681
	queue->limits.discard_alignment = 0;
1682
	queue->limits.discard_granularity = size;
1683

1684 1685 1686 1687
	/* If discard is already enabled, don't reset queue limits */
	if (blk_queue_flag_test_and_set(QUEUE_FLAG_DISCARD, queue))
		return;

1688 1689
	blk_queue_max_discard_sectors(queue, UINT_MAX);
	blk_queue_max_discard_segments(queue, NVME_DSM_MAX_RANGES);
1690 1691

	if (ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
1692
		blk_queue_max_write_zeroes_sectors(queue, UINT_MAX);
1693 1694
}

1695
static void nvme_config_write_zeroes(struct gendisk *disk, struct nvme_ns *ns)
1696
{
1697
	u64 max_blocks;
1698

1699 1700
	if (!(ns->ctrl->oncs & NVME_CTRL_ONCS_WRITE_ZEROES) ||
	    (ns->ctrl->quirks & NVME_QUIRK_DISABLE_WRITE_ZEROES))
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712
		return;
	/*
	 * Even though NVMe spec explicitly states that MDTS is not
	 * applicable to the write-zeroes:- "The restriction does not apply to
	 * commands that do not transfer data between the host and the
	 * controller (e.g., Write Uncorrectable ro Write Zeroes command).".
	 * In order to be more cautious use controller's max_hw_sectors value
	 * to configure the maximum sectors for the write-zeroes which is
	 * configured based on the controller's MDTS field in the
	 * nvme_init_identify() if available.
	 */
	if (ns->ctrl->max_hw_sectors == UINT_MAX)
1713
		max_blocks = (u64)USHRT_MAX + 1;
1714
	else
1715
		max_blocks = ns->ctrl->max_hw_sectors + 1;
1716

1717 1718
	blk_queue_max_write_zeroes_sectors(disk->queue,
					   nvme_lba_to_sect(ns, max_blocks));
1719 1720
}

1721
static int nvme_report_ns_ids(struct nvme_ctrl *ctrl, unsigned int nsid,
1722
		struct nvme_id_ns *id, struct nvme_ns_ids *ids)
1723
{
1724 1725
	int ret = 0;

1726 1727
	memset(ids, 0, sizeof(*ids));

1728
	if (ctrl->vs >= NVME_VS(1, 1, 0))
1729
		memcpy(ids->eui64, id->eui64, sizeof(id->eui64));
1730
	if (ctrl->vs >= NVME_VS(1, 2, 0))
1731
		memcpy(ids->nguid, id->nguid, sizeof(id->nguid));
1732
	if (ctrl->vs >= NVME_VS(1, 3, 0)) {
1733 1734 1735
		 /* Don't treat error as fatal we potentially
		  * already have a NGUID or EUI-64
		  */
1736 1737
		ret = nvme_identify_ns_descs(ctrl, nsid, ids);
		if (ret)
1738
			dev_warn(ctrl->device,
1739
				 "Identify Descriptors failed (%d)\n", ret);
1740 1741
		if (ret > 0)
			ret = 0;
1742
	}
1743
	return ret;
1744 1745
}

C
Christoph Hellwig 已提交
1746 1747 1748 1749 1750 1751 1752
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));
}

1753 1754 1755 1756 1757 1758 1759
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 &&
		memcmp(&a->eui64, &b->eui64, sizeof(a->eui64)) == 0;
}

1760 1761 1762
static void nvme_update_disk_info(struct gendisk *disk,
		struct nvme_ns *ns, struct nvme_id_ns *id)
{
1763
	sector_t capacity = nvme_lba_to_sect(ns, le64_to_cpu(id->nsze));
1764
	unsigned short bs = 1 << ns->lba_shift;
1765
	u32 atomic_bs, phys_bs, io_opt;
1766

1767 1768 1769 1770
	if (ns->lba_shift > PAGE_SHIFT) {
		/* unsupported block size, set capacity to 0 later */
		bs = (1 << 9);
	}
1771 1772 1773
	blk_mq_freeze_queue(disk->queue);
	blk_integrity_unregister(disk);

1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
	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.
		 */
		if (id->nsfeat & (1 << 1) && id->nawupf)
			atomic_bs = (1 + le16_to_cpu(id->nawupf)) * bs;
		else
			atomic_bs = (1 + ns->ctrl->subsys->awupf) * bs;
	} else {
		atomic_bs = bs;
	}
	phys_bs = bs;
	io_opt = bs;
	if (id->nsfeat & (1 << 4)) {
		/* NPWG = Namespace Preferred Write Granularity */
		phys_bs *= 1 + le16_to_cpu(id->npwg);
		/* NOWS = Namespace Optimal Write Size */
		io_opt *= 1 + le16_to_cpu(id->nows);
	}

1796
	blk_queue_logical_block_size(disk->queue, bs);
1797 1798 1799 1800 1801 1802 1803 1804
	/*
	 * 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);
1805

1806 1807 1808
	if (ns->ms && !ns->ext &&
	    (ns->ctrl->ops->flags & NVME_F_METADATA_SUPPORTED))
		nvme_init_integrity(disk, ns->ms, ns->pi_type);
1809 1810
	if ((ns->ms && !nvme_ns_has_pi(ns) && !blk_get_integrity(disk)) ||
	    ns->lba_shift > PAGE_SHIFT)
1811 1812
		capacity = 0;

1813
	set_capacity(disk, capacity);
1814

1815
	nvme_config_discard(disk, ns);
1816
	nvme_config_write_zeroes(disk, ns);
1817 1818 1819 1820 1821 1822

	if (id->nsattr & (1 << 0))
		set_disk_ro(disk, true);
	else
		set_disk_ro(disk, false);

1823 1824 1825
	blk_mq_unfreeze_queue(disk->queue);
}

1826 1827 1828
static void __nvme_revalidate_disk(struct gendisk *disk, struct nvme_id_ns *id)
{
	struct nvme_ns *ns = disk->private_data;
1829 1830 1831 1832 1833

	/*
	 * If identify namespace failed, use default 512 byte block size so
	 * block layer can use before failing read/write for 0 capacity.
	 */
1834
	ns->lba_shift = id->lbaf[id->flbas & NVME_NS_FLBAS_LBA_MASK].ds;
1835 1836
	if (ns->lba_shift == 0)
		ns->lba_shift = 9;
1837
	ns->noiob = le16_to_cpu(id->noiob);
1838
	ns->ms = le16_to_cpu(id->lbaf[id->flbas & NVME_NS_FLBAS_LBA_MASK].ms);
1839
	ns->ext = ns->ms && (id->flbas & NVME_NS_FLBAS_META_EXT);
1840 1841 1842 1843 1844
	/* the PI implementation requires metadata equal t10 pi tuple size */
	if (ns->ms == sizeof(struct t10_pi_tuple))
		ns->pi_type = id->dps & NVME_NS_DPS_PI_MASK;
	else
		ns->pi_type = 0;
1845

1846 1847
	if (ns->noiob)
		nvme_set_chunk_size(ns);
1848
	nvme_update_disk_info(disk, ns, id);
1849
#ifdef CONFIG_NVME_MULTIPATH
1850
	if (ns->head->disk) {
1851
		nvme_update_disk_info(ns->head->disk, ns, id);
1852
		blk_queue_stack_limits(ns->head->disk->queue, ns->queue);
1853
		revalidate_disk(ns->head->disk);
1854
	}
1855
#endif
1856
}
1857

1858 1859 1860
static int nvme_revalidate_disk(struct gendisk *disk)
{
	struct nvme_ns *ns = disk->private_data;
1861 1862
	struct nvme_ctrl *ctrl = ns->ctrl;
	struct nvme_id_ns *id;
1863
	struct nvme_ns_ids ids;
1864
	int ret = 0;
1865 1866 1867 1868 1869 1870

	if (test_bit(NVME_NS_DEAD, &ns->flags)) {
		set_capacity(disk, 0);
		return -ENODEV;
	}

1871 1872 1873
	ret = nvme_identify_ns(ctrl, ns->head->ns_id, &id);
	if (ret)
		goto out;
1874

1875 1876
	if (id->ncap == 0) {
		ret = -ENODEV;
1877
		goto free_id;
1878
	}
1879

1880
	__nvme_revalidate_disk(disk, id);
1881 1882 1883 1884
	ret = nvme_report_ns_ids(ctrl, ns->head->ns_id, id, &ids);
	if (ret)
		goto free_id;

C
Christoph Hellwig 已提交
1885
	if (!nvme_ns_ids_equal(&ns->head->ids, &ids)) {
1886
		dev_err(ctrl->device,
C
Christoph Hellwig 已提交
1887
			"identifiers changed for nsid %d\n", ns->head->ns_id);
1888 1889 1890
		ret = -ENODEV;
	}

1891
free_id:
1892
	kfree(id);
1893
out:
1894 1895 1896 1897 1898 1899 1900
	/*
	 * Only fail the function if we got a fatal error back from the
	 * device, otherwise ignore the error and just move on.
	 */
	if (ret == -ENOMEM || (ret > 0 && !(ret & NVME_SC_DNR)))
		ret = 0;
	else if (ret > 0)
1901
		ret = blk_status_to_errno(nvme_error_status(ret));
1902
	return ret;
1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
}

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

static int nvme_pr_command(struct block_device *bdev, u32 cdw10,
				u64 key, u64 sa_key, u8 op)
{
1928 1929
	struct nvme_ns_head *head = NULL;
	struct nvme_ns *ns;
1930
	struct nvme_command c;
1931
	int srcu_idx, ret;
1932 1933
	u8 data[16] = { 0, };

1934 1935 1936 1937
	ns = nvme_get_ns_from_disk(bdev->bd_disk, &head, &srcu_idx);
	if (unlikely(!ns))
		return -EWOULDBLOCK;

1938 1939 1940 1941 1942
	put_unaligned_le64(key, &data[0]);
	put_unaligned_le64(sa_key, &data[8]);

	memset(&c, 0, sizeof(c));
	c.common.opcode = op;
1943
	c.common.nsid = cpu_to_le32(ns->head->ns_id);
1944
	c.common.cdw10 = cpu_to_le32(cdw10);
1945

1946
	ret = nvme_submit_sync_cmd(ns->queue, &c, data, 16);
1947 1948
	nvme_put_ns_from_disk(head, srcu_idx);
	return ret;
1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980
}

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)
{
1981
	u32 cdw10 = nvme_pr_type(type) << 8 | (abort ? 2 : 1);
1982 1983 1984 1985 1986
	return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire);
}

static int nvme_pr_clear(struct block_device *bdev, u64 key)
{
1987
	u32 cdw10 = 1 | (key ? 1 << 3 : 0);
1988 1989 1990 1991 1992
	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)
{
1993
	u32 cdw10 = nvme_pr_type(type) << 8 | (key ? 1 << 3 : 0);
1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release);
}

static const struct pr_ops nvme_pr_ops = {
	.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,
};

2005
#ifdef CONFIG_BLK_SED_OPAL
2006 2007
int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
		bool send)
2008
{
2009
	struct nvme_ctrl *ctrl = data;
2010 2011 2012 2013 2014 2015 2016 2017
	struct nvme_command cmd;

	memset(&cmd, 0, sizeof(cmd));
	if (send)
		cmd.common.opcode = nvme_admin_security_send;
	else
		cmd.common.opcode = nvme_admin_security_recv;
	cmd.common.nsid = 0;
2018 2019
	cmd.common.cdw10 = cpu_to_le32(((u32)secp) << 24 | ((u32)spsp) << 8);
	cmd.common.cdw11 = cpu_to_le32(len);
2020 2021

	return __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, NULL, buffer, len,
2022
				      ADMIN_TIMEOUT, NVME_QID_ANY, 1, 0, false);
2023 2024 2025 2026
}
EXPORT_SYMBOL_GPL(nvme_sec_submit);
#endif /* CONFIG_BLK_SED_OPAL */

2027
static const struct block_device_operations nvme_fops = {
2028 2029
	.owner		= THIS_MODULE,
	.ioctl		= nvme_ioctl,
2030
	.compat_ioctl	= nvme_ioctl,
2031 2032 2033 2034 2035 2036 2037
	.open		= nvme_open,
	.release	= nvme_release,
	.getgeo		= nvme_getgeo,
	.revalidate_disk= nvme_revalidate_disk,
	.pr_ops		= &nvme_pr_ops,
};

2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063
#ifdef CONFIG_NVME_MULTIPATH
static int nvme_ns_head_open(struct block_device *bdev, fmode_t mode)
{
	struct nvme_ns_head *head = bdev->bd_disk->private_data;

	if (!kref_get_unless_zero(&head->ref))
		return -ENXIO;
	return 0;
}

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

const struct block_device_operations nvme_ns_head_ops = {
	.owner		= THIS_MODULE,
	.open		= nvme_ns_head_open,
	.release	= nvme_ns_head_release,
	.ioctl		= nvme_ioctl,
	.compat_ioctl	= nvme_ioctl,
	.getgeo		= nvme_getgeo,
	.pr_ops		= &nvme_pr_ops,
};
#endif /* CONFIG_NVME_MULTIPATH */

2064 2065 2066 2067 2068 2069 2070 2071
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 已提交
2072 2073
		if (csts == ~0)
			return -ENODEV;
2074 2075 2076 2077 2078 2079 2080
		if ((csts & NVME_CSTS_RDY) == bit)
			break;

		msleep(100);
		if (fatal_signal_pending(current))
			return -EINTR;
		if (time_after(jiffies, timeout)) {
2081
			dev_err(ctrl->device,
2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096
				"Device not ready; aborting %s\n", enabled ?
						"initialisation" : "reset");
			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!
 */
2097
int nvme_disable_ctrl(struct nvme_ctrl *ctrl)
2098 2099 2100 2101 2102 2103 2104 2105 2106
{
	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;
2107

2108
	if (ctrl->quirks & NVME_QUIRK_DELAY_BEFORE_CHK_RDY)
2109 2110
		msleep(NVME_QUIRK_DELAY_AMOUNT);

2111
	return nvme_wait_ready(ctrl, ctrl->cap, false);
2112
}
2113
EXPORT_SYMBOL_GPL(nvme_disable_ctrl);
2114

2115
int nvme_enable_ctrl(struct nvme_ctrl *ctrl)
2116 2117 2118 2119 2120 2121
{
	/*
	 * Default to a 4K page size, with the intention to update this
	 * path in the future to accomodate architectures with differing
	 * kernel and IO page sizes.
	 */
2122
	unsigned dev_page_min, page_shift = 12;
2123 2124
	int ret;

2125 2126 2127 2128 2129 2130 2131
	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;

2132
	if (page_shift < dev_page_min) {
2133
		dev_err(ctrl->device,
2134 2135 2136 2137 2138 2139 2140 2141 2142
			"Minimum device page size %u too large for host (%u)\n",
			1 << dev_page_min, 1 << page_shift);
		return -ENODEV;
	}

	ctrl->page_size = 1 << page_shift;

	ctrl->ctrl_config = NVME_CC_CSS_NVM;
	ctrl->ctrl_config |= (page_shift - 12) << NVME_CC_MPS_SHIFT;
2143
	ctrl->ctrl_config |= NVME_CC_AMS_RR | NVME_CC_SHN_NONE;
2144 2145 2146 2147 2148 2149
	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;
2150
	return nvme_wait_ready(ctrl, ctrl->cap, true);
2151
}
2152
EXPORT_SYMBOL_GPL(nvme_enable_ctrl);
2153 2154 2155

int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl)
{
2156
	unsigned long timeout = jiffies + (ctrl->shutdown_timeout * HZ);
2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174
	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)) {
2175
			dev_err(ctrl->device,
2176 2177 2178 2179 2180 2181 2182
				"Device shutdown incomplete; abort shutdown\n");
			return -ENODEV;
		}
	}

	return ret;
}
2183
EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl);
2184

2185 2186 2187
static void nvme_set_queue_limits(struct nvme_ctrl *ctrl,
		struct request_queue *q)
{
2188 2189
	bool vwc = false;

2190
	if (ctrl->max_hw_sectors) {
2191 2192 2193
		u32 max_segments =
			(ctrl->max_hw_sectors / (ctrl->page_size >> 9)) + 1;

2194
		max_segments = min_not_zero(max_segments, ctrl->max_segments);
2195
		blk_queue_max_hw_sectors(q, ctrl->max_hw_sectors);
2196
		blk_queue_max_segments(q, min_t(u32, max_segments, USHRT_MAX));
2197
	}
2198 2199
	if ((ctrl->quirks & NVME_QUIRK_STRIPE_SIZE) &&
	    is_power_of_2(ctrl->max_hw_sectors))
K
Keith Busch 已提交
2200
		blk_queue_chunk_sectors(q, ctrl->max_hw_sectors);
2201
	blk_queue_virt_boundary(q, ctrl->page_size - 1);
2202 2203 2204
	if (ctrl->vwc & NVME_CTRL_VWC_PRESENT)
		vwc = true;
	blk_queue_write_cache(q, vwc, vwc);
2205 2206
}

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

2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243
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;
}

2244
static int nvme_configure_apst(struct nvme_ctrl *ctrl)
2245 2246 2247 2248 2249 2250 2251 2252
{
	/*
	 * APST (Autonomous Power State Transition) lets us program a
	 * table of power state transitions that the controller will
	 * perform automatically.  We configure it 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
A
Andy Lutomirski 已提交
2253
	 * non-operational state after waiting 50 * (enlat + exlat)
2254
	 * microseconds, as long as that state's exit latency is under
2255 2256 2257 2258 2259 2260 2261 2262 2263
	 * the requested maximum latency.
	 *
	 * 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.
	 */

	unsigned apste;
	struct nvme_feat_auto_pst *table;
2264 2265
	u64 max_lat_us = 0;
	int max_ps = -1;
2266 2267 2268 2269 2270 2271 2272
	int ret;

	/*
	 * If APST isn't supported or if we haven't been initialized yet,
	 * then don't do anything.
	 */
	if (!ctrl->apsta)
2273
		return 0;
2274 2275 2276

	if (ctrl->npss > 31) {
		dev_warn(ctrl->device, "NPSS is invalid; not using APST\n");
2277
		return 0;
2278 2279 2280 2281
	}

	table = kzalloc(sizeof(*table), GFP_KERNEL);
	if (!table)
2282
		return 0;
2283

2284
	if (!ctrl->apst_enabled || ctrl->ps_max_latency_us == 0) {
2285 2286
		/* Turn off APST. */
		apste = 0;
2287
		dev_dbg(ctrl->device, "APST disabled\n");
2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298
	} else {
		__le64 target = cpu_to_le64(0);
		int state;

		/*
		 * 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--) {
2299
			u64 total_latency_us, exit_latency_us, transition_ms;
2300 2301 2302 2303

			if (target)
				table->entries[state] = target;

2304 2305 2306 2307 2308 2309 2310 2311
			/*
			 * Don't allow transitions to the deepest state
			 * if it's quirked off.
			 */
			if (state == ctrl->npss &&
			    (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS))
				continue;

2312 2313 2314 2315 2316 2317 2318 2319
			/*
			 * 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;

2320 2321 2322
			exit_latency_us =
				(u64)le32_to_cpu(ctrl->psd[state].exit_lat);
			if (exit_latency_us > ctrl->ps_max_latency_us)
2323 2324
				continue;

2325 2326 2327 2328
			total_latency_us =
				exit_latency_us +
				le32_to_cpu(ctrl->psd[state].entry_lat);

2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339
			/*
			 * This state is good.  Use it as the APST idle
			 * target for higher power states.
			 */
			transition_ms = total_latency_us + 19;
			do_div(transition_ms, 20);
			if (transition_ms > (1 << 24) - 1)
				transition_ms = (1 << 24) - 1;

			target = cpu_to_le64((state << 3) |
					     (transition_ms << 8));
2340 2341 2342 2343 2344 2345

			if (max_ps == -1)
				max_ps = state;

			if (total_latency_us > max_lat_us)
				max_lat_us = total_latency_us;
2346 2347 2348
		}

		apste = 1;
2349 2350 2351 2352 2353 2354 2355

		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);
		}
2356 2357 2358 2359 2360 2361 2362 2363
	}

	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);
2364
	return ret;
2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387
}

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;
		nvme_configure_apst(ctrl);
	}
}

2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400
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[] = {
2401
	{
2402 2403 2404 2405 2406 2407
		/*
		 * 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",
2408
		.quirks = NVME_QUIRK_NO_APST,
2409 2410 2411 2412 2413 2414 2415 2416 2417 2418
	},
	{
		/*
		 * 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,
2419
	}
2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450
};

/* 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 已提交
2451 2452
static void nvme_init_subnqn(struct nvme_subsystem *subsys, struct nvme_ctrl *ctrl,
		struct nvme_id_ctrl *id)
2453 2454 2455 2456
{
	size_t nqnlen;
	int off;

2457 2458 2459 2460 2461 2462
	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;
		}
2463

2464 2465 2466
		if (ctrl->vs >= NVME_VS(1, 2, 1))
			dev_warn(ctrl->device, "missing or invalid SUBNQN field.\n");
	}
2467 2468

	/* Generate a "fake" NQN per Figure 254 in NVMe 1.3 + ECN 001 */
C
Christoph Hellwig 已提交
2469
	off = snprintf(subsys->subnqn, NVMF_NQN_SIZE,
2470
			"nqn.2014.08.org.nvmexpress:%04x%04x",
2471
			le16_to_cpu(id->vid), le16_to_cpu(id->ssvid));
C
Christoph Hellwig 已提交
2472
	memcpy(subsys->subnqn + off, id->sn, sizeof(id->sn));
2473
	off += sizeof(id->sn);
C
Christoph Hellwig 已提交
2474
	memcpy(subsys->subnqn + off, id->mn, sizeof(id->mn));
2475
	off += sizeof(id->mn);
C
Christoph Hellwig 已提交
2476 2477 2478
	memset(subsys->subnqn + off, 0, sizeof(subsys->subnqn) - off);
}

2479
static void nvme_release_subsystem(struct device *dev)
C
Christoph Hellwig 已提交
2480
{
2481 2482 2483
	struct nvme_subsystem *subsys =
		container_of(dev, struct nvme_subsystem, dev);

2484 2485
	if (subsys->instance >= 0)
		ida_simple_remove(&nvme_instance_ida, subsys->instance);
C
Christoph Hellwig 已提交
2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497
	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 已提交
2498
	ida_destroy(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513
	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);

2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524
	/*
	 * 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 已提交
2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535
	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;
}

2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570
#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);

	return snprintf(buf, PAGE_SIZE, "%s\n", subsys->subnqn);
}
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);		\
	return sprintf(buf, "%.*s\n",					\
		       (int)sizeof(subsys->field), subsys->field);	\
}									\
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,
2571 2572 2573
#ifdef CONFIG_NVME_MULTIPATH
	&subsys_attr_iopolicy.attr,
#endif
2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585
	NULL,
};

static struct attribute_group nvme_subsys_attrs_group = {
	.attrs = nvme_subsys_attrs,
};

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

2586 2587
static bool nvme_validate_cntlid(struct nvme_subsystem *subsys,
		struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
2588
{
2589
	struct nvme_ctrl *tmp;
2590

2591 2592
	lockdep_assert_held(&nvme_subsystems_lock);

2593
	list_for_each_entry(tmp, &subsys->ctrls, subsys_entry) {
2594 2595
		if (tmp->state == NVME_CTRL_DELETING ||
		    tmp->state == NVME_CTRL_DEAD)
2596 2597 2598 2599 2600 2601 2602 2603
			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;
		}
2604

2605 2606 2607 2608 2609 2610 2611
		if ((id->cmic & (1 << 1)) ||
		    (ctrl->opts && ctrl->opts->discovery_nqn))
			continue;

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

2614
	return true;
2615 2616
}

C
Christoph Hellwig 已提交
2617 2618 2619 2620 2621 2622 2623 2624
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;
2625 2626

	subsys->instance = -1;
C
Christoph Hellwig 已提交
2627 2628 2629
	mutex_init(&subsys->lock);
	kref_init(&subsys->ref);
	INIT_LIST_HEAD(&subsys->ctrls);
C
Christoph Hellwig 已提交
2630
	INIT_LIST_HEAD(&subsys->nsheads);
C
Christoph Hellwig 已提交
2631 2632 2633 2634 2635 2636
	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;
2637
	subsys->awupf = le16_to_cpu(id->awupf);
2638 2639 2640
#ifdef CONFIG_NVME_MULTIPATH
	subsys->iopolicy = NVME_IOPOLICY_NUMA;
#endif
C
Christoph Hellwig 已提交
2641 2642 2643

	subsys->dev.class = nvme_subsys_class;
	subsys->dev.release = nvme_release_subsystem;
2644
	subsys->dev.groups = nvme_subsys_attrs_groups;
2645
	dev_set_name(&subsys->dev, "nvme-subsys%d", ctrl->instance);
C
Christoph Hellwig 已提交
2646 2647 2648 2649 2650
	device_initialize(&subsys->dev);

	mutex_lock(&nvme_subsystems_lock);
	found = __nvme_find_get_subsystem(subsys->subnqn);
	if (found) {
2651
		put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2652
		subsys = found;
2653

2654
		if (!nvme_validate_cntlid(subsys, ctrl, id)) {
C
Christoph Hellwig 已提交
2655
			ret = -EINVAL;
2656
			goto out_put_subsystem;
C
Christoph Hellwig 已提交
2657 2658 2659 2660 2661 2662
		}
	} else {
		ret = device_add(&subsys->dev);
		if (ret) {
			dev_err(ctrl->device,
				"failed to register subsystem device.\n");
2663
			put_device(&subsys->dev);
C
Christoph Hellwig 已提交
2664 2665
			goto out_unlock;
		}
C
Christoph Hellwig 已提交
2666
		ida_init(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2667 2668 2669
		list_add_tail(&subsys->entry, &nvme_subsystems);
	}

2670 2671 2672
	ret = sysfs_create_link(&subsys->dev.kobj, &ctrl->device->kobj,
				dev_name(ctrl->device));
	if (ret) {
C
Christoph Hellwig 已提交
2673 2674
		dev_err(ctrl->device,
			"failed to create sysfs link from subsystem.\n");
2675
		goto out_put_subsystem;
C
Christoph Hellwig 已提交
2676 2677
	}

2678 2679
	if (!found)
		subsys->instance = ctrl->instance;
2680
	ctrl->subsys = subsys;
C
Christoph Hellwig 已提交
2681
	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
2682
	mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
2683 2684
	return 0;

2685 2686
out_put_subsystem:
	nvme_put_subsystem(subsys);
C
Christoph Hellwig 已提交
2687 2688 2689
out_unlock:
	mutex_unlock(&nvme_subsystems_lock);
	return ret;
2690 2691
}

2692 2693
int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp,
		void *log, size_t size, u64 offset)
K
Keith Busch 已提交
2694 2695
{
	struct nvme_command c = { };
2696 2697 2698
	unsigned long dwlen = size / 4 - 1;

	c.get_log_page.opcode = nvme_admin_get_log_page;
2699
	c.get_log_page.nsid = cpu_to_le32(nsid);
2700
	c.get_log_page.lid = log_page;
2701
	c.get_log_page.lsp = lsp;
2702 2703
	c.get_log_page.numdl = cpu_to_le16(dwlen & ((1 << 16) - 1));
	c.get_log_page.numdu = cpu_to_le16(dwlen >> 16);
2704 2705
	c.get_log_page.lpol = cpu_to_le32(lower_32_bits(offset));
	c.get_log_page.lpou = cpu_to_le32(upper_32_bits(offset));
K
Keith Busch 已提交
2706 2707 2708 2709

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

2710 2711 2712 2713 2714 2715 2716 2717 2718 2719
static int nvme_get_effects_log(struct nvme_ctrl *ctrl)
{
	int ret;

	if (!ctrl->effects)
		ctrl->effects = kzalloc(sizeof(*ctrl->effects), GFP_KERNEL);

	if (!ctrl->effects)
		return 0;

2720 2721
	ret = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CMD_EFFECTS, 0,
			ctrl->effects, sizeof(*ctrl->effects), 0);
2722 2723 2724 2725 2726
	if (ret) {
		kfree(ctrl->effects);
		ctrl->effects = NULL;
	}
	return ret;
2727 2728
}

2729 2730 2731 2732 2733 2734 2735 2736 2737
/*
 * 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_identify(struct nvme_ctrl *ctrl)
{
	struct nvme_id_ctrl *id;
	int ret, page_shift;
2738
	u32 max_hw_sectors;
2739
	bool prev_apst_enabled;
2740

2741 2742
	ret = ctrl->ops->reg_read32(ctrl, NVME_REG_VS, &ctrl->vs);
	if (ret) {
2743
		dev_err(ctrl->device, "Reading VS failed (%d)\n", ret);
2744 2745
		return ret;
	}
2746
	page_shift = NVME_CAP_MPSMIN(ctrl->cap) + 12;
2747
	ctrl->sqsize = min_t(int, NVME_CAP_MQES(ctrl->cap), ctrl->sqsize);
2748

2749
	if (ctrl->vs >= NVME_VS(1, 1, 0))
2750
		ctrl->subsystem = NVME_CAP_NSSRC(ctrl->cap);
2751

2752 2753
	ret = nvme_identify_ctrl(ctrl, &id);
	if (ret) {
2754
		dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret);
2755 2756 2757
		return -EIO;
	}

2758 2759 2760
	if (id->lpa & NVME_CTRL_LPA_CMD_EFFECTS_LOG) {
		ret = nvme_get_effects_log(ctrl);
		if (ret < 0)
2761
			goto out_free;
2762
	}
2763

2764 2765 2766
	if (!(ctrl->ops->flags & NVME_F_FABRICS))
		ctrl->cntlid = le16_to_cpu(id->cntlid);

2767
	if (!ctrl->identified) {
C
Christoph Hellwig 已提交
2768 2769 2770 2771 2772 2773
		int i;

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

2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787
		/*
		 * 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;
		}
	}

2788
	if (force_apst && (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) {
2789
		dev_warn(ctrl->device, "forcibly allowing all power states due to nvme_core.force_apst -- use at your own risk\n");
2790 2791 2792
		ctrl->quirks &= ~NVME_QUIRK_NO_DEEPEST_PS;
	}

2793 2794 2795 2796
	ctrl->crdt[0] = le16_to_cpu(id->crdt1);
	ctrl->crdt[1] = le16_to_cpu(id->crdt2);
	ctrl->crdt[2] = le16_to_cpu(id->crdt3);

2797
	ctrl->oacs = le16_to_cpu(id->oacs);
2798
	ctrl->oncs = le16_to_cpu(id->oncs);
2799
	ctrl->mtfa = le16_to_cpu(id->mtfa);
2800
	ctrl->oaes = le32_to_cpu(id->oaes);
2801 2802 2803
	ctrl->wctemp = le16_to_cpu(id->wctemp);
	ctrl->cctemp = le16_to_cpu(id->cctemp);

2804
	atomic_set(&ctrl->abort_limit, id->acl + 1);
2805 2806
	ctrl->vwc = id->vwc;
	if (id->mdts)
2807
		max_hw_sectors = 1 << (id->mdts + page_shift - 9);
2808
	else
2809 2810 2811
		max_hw_sectors = UINT_MAX;
	ctrl->max_hw_sectors =
		min_not_zero(ctrl->max_hw_sectors, max_hw_sectors);
2812

2813
	nvme_set_queue_limits(ctrl, ctrl->admin_q);
2814
	ctrl->sgls = le32_to_cpu(id->sgls);
S
Sagi Grimberg 已提交
2815
	ctrl->kas = le16_to_cpu(id->kas);
C
Christoph Hellwig 已提交
2816
	ctrl->max_namespaces = le32_to_cpu(id->mnan);
S
Sagi Grimberg 已提交
2817
	ctrl->ctratt = le32_to_cpu(id->ctratt);
2818

2819 2820 2821 2822 2823 2824 2825 2826
	if (id->rtd3e) {
		/* us -> s */
		u32 transition_time = le32_to_cpu(id->rtd3e) / 1000000;

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

		if (ctrl->shutdown_timeout != shutdown_timeout)
2827
			dev_info(ctrl->device,
2828 2829 2830 2831 2832
				 "Shutdown timeout set to %u seconds\n",
				 ctrl->shutdown_timeout);
	} else
		ctrl->shutdown_timeout = shutdown_timeout;

2833
	ctrl->npss = id->npss;
2834 2835
	ctrl->apsta = id->apsta;
	prev_apst_enabled = ctrl->apst_enabled;
2836 2837
	if (ctrl->quirks & NVME_QUIRK_NO_APST) {
		if (force_apst && id->apsta) {
2838
			dev_warn(ctrl->device, "forcibly allowing APST due to nvme_core.force_apst -- use at your own risk\n");
2839
			ctrl->apst_enabled = true;
2840
		} else {
2841
			ctrl->apst_enabled = false;
2842 2843
		}
	} else {
2844
		ctrl->apst_enabled = id->apsta;
2845
	}
2846 2847
	memcpy(ctrl->psd, id->psd, sizeof(ctrl->psd));

2848
	if (ctrl->ops->flags & NVME_F_FABRICS) {
2849 2850 2851 2852 2853 2854 2855 2856 2857
		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
		 */
2858
		if (ctrl->cntlid != le16_to_cpu(id->cntlid)) {
2859 2860 2861 2862
			dev_err(ctrl->device,
				"Mismatching cntlid: Connect %u vs Identify "
				"%u, rejecting\n",
				ctrl->cntlid, le16_to_cpu(id->cntlid));
2863
			ret = -EINVAL;
2864 2865
			goto out_free;
		}
S
Sagi Grimberg 已提交
2866 2867

		if (!ctrl->opts->discovery_nqn && !ctrl->kas) {
2868
			dev_err(ctrl->device,
S
Sagi Grimberg 已提交
2869 2870
				"keep-alive support is mandatory for fabrics\n");
			ret = -EINVAL;
2871
			goto out_free;
S
Sagi Grimberg 已提交
2872
		}
2873
	} else {
2874 2875
		ctrl->hmpre = le32_to_cpu(id->hmpre);
		ctrl->hmmin = le32_to_cpu(id->hmmin);
2876 2877
		ctrl->hmminds = le32_to_cpu(id->hmminds);
		ctrl->hmmaxd = le16_to_cpu(id->hmmaxd);
2878
	}
2879

C
Christoph Hellwig 已提交
2880
	ret = nvme_mpath_init(ctrl, id);
2881
	kfree(id);
2882

C
Christoph Hellwig 已提交
2883 2884 2885
	if (ret < 0)
		return ret;

2886
	if (ctrl->apst_enabled && !prev_apst_enabled)
2887
		dev_pm_qos_expose_latency_tolerance(ctrl->device);
2888
	else if (!ctrl->apst_enabled && prev_apst_enabled)
2889 2890
		dev_pm_qos_hide_latency_tolerance(ctrl->device);

2891 2892 2893
	ret = nvme_configure_apst(ctrl);
	if (ret < 0)
		return ret;
2894 2895 2896 2897
	
	ret = nvme_configure_timestamp(ctrl);
	if (ret < 0)
		return ret;
2898 2899 2900 2901

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

2903 2904 2905 2906
	ret = nvme_configure_acre(ctrl);
	if (ret < 0)
		return ret;

2907 2908 2909
	if (!ctrl->identified)
		nvme_hwmon_init(ctrl);

2910
	ctrl->identified = true;
2911

2912 2913 2914 2915
	return 0;

out_free:
	kfree(id);
2916
	return ret;
2917
}
2918
EXPORT_SYMBOL_GPL(nvme_init_identify);
2919

2920
static int nvme_dev_open(struct inode *inode, struct file *file)
2921
{
2922 2923
	struct nvme_ctrl *ctrl =
		container_of(inode->i_cdev, struct nvme_ctrl, cdev);
2924

2925 2926 2927 2928
	switch (ctrl->state) {
	case NVME_CTRL_LIVE:
		break;
	default:
2929
		return -EWOULDBLOCK;
2930 2931
	}

2932
	file->private_data = ctrl;
2933 2934 2935
	return 0;
}

2936 2937 2938 2939 2940
static int nvme_dev_user_cmd(struct nvme_ctrl *ctrl, void __user *argp)
{
	struct nvme_ns *ns;
	int ret;

2941
	down_read(&ctrl->namespaces_rwsem);
2942 2943 2944 2945 2946 2947 2948
	if (list_empty(&ctrl->namespaces)) {
		ret = -ENOTTY;
		goto out_unlock;
	}

	ns = list_first_entry(&ctrl->namespaces, struct nvme_ns, list);
	if (ns != list_last_entry(&ctrl->namespaces, struct nvme_ns, list)) {
2949
		dev_warn(ctrl->device,
2950 2951 2952 2953 2954
			"NVME_IOCTL_IO_CMD not supported when multiple namespaces present!\n");
		ret = -EINVAL;
		goto out_unlock;
	}

2955
	dev_warn(ctrl->device,
2956 2957
		"using deprecated NVME_IOCTL_IO_CMD ioctl on the char device!\n");
	kref_get(&ns->kref);
2958
	up_read(&ctrl->namespaces_rwsem);
2959 2960 2961 2962 2963 2964

	ret = nvme_user_cmd(ctrl, ns, argp);
	nvme_put_ns(ns);
	return ret;

out_unlock:
2965
	up_read(&ctrl->namespaces_rwsem);
2966 2967 2968
	return ret;
}

2969 2970 2971 2972 2973 2974 2975 2976 2977
static long nvme_dev_ioctl(struct file *file, unsigned int cmd,
		unsigned long arg)
{
	struct nvme_ctrl *ctrl = file->private_data;
	void __user *argp = (void __user *)arg;

	switch (cmd) {
	case NVME_IOCTL_ADMIN_CMD:
		return nvme_user_cmd(ctrl, NULL, argp);
2978 2979
	case NVME_IOCTL_ADMIN64_CMD:
		return nvme_user_cmd64(ctrl, NULL, argp);
2980
	case NVME_IOCTL_IO_CMD:
2981
		return nvme_dev_user_cmd(ctrl, argp);
2982
	case NVME_IOCTL_RESET:
2983
		dev_warn(ctrl->device, "resetting controller\n");
2984
		return nvme_reset_ctrl_sync(ctrl);
2985 2986
	case NVME_IOCTL_SUBSYS_RESET:
		return nvme_reset_subsystem(ctrl);
K
Keith Busch 已提交
2987 2988 2989
	case NVME_IOCTL_RESCAN:
		nvme_queue_scan(ctrl);
		return 0;
2990 2991 2992 2993 2994 2995 2996 2997 2998
	default:
		return -ENOTTY;
	}
}

static const struct file_operations nvme_dev_fops = {
	.owner		= THIS_MODULE,
	.open		= nvme_dev_open,
	.unlocked_ioctl	= nvme_dev_ioctl,
2999
	.compat_ioctl	= compat_ptr_ioctl,
3000 3001 3002 3003 3004 3005 3006 3007 3008
};

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;

3009
	ret = nvme_reset_ctrl_sync(ctrl);
3010 3011 3012
	if (ret < 0)
		return ret;
	return count;
3013
}
3014
static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset);
3015

K
Keith Busch 已提交
3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026
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);

3027 3028 3029 3030 3031 3032 3033 3034 3035 3036
static inline struct nvme_ns_head *dev_to_ns_head(struct device *dev)
{
	struct gendisk *disk = dev_to_disk(dev);

	if (disk->fops == &nvme_fops)
		return nvme_get_ns_from_dev(dev)->head;
	else
		return disk->private_data;
}

3037
static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
3038
		char *buf)
3039
{
3040 3041 3042
	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 已提交
3043 3044
	int serial_len = sizeof(subsys->serial);
	int model_len = sizeof(subsys->model);
3045

3046 3047
	if (!uuid_is_null(&ids->uuid))
		return sprintf(buf, "uuid.%pU\n", &ids->uuid);
3048

3049 3050
	if (memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
		return sprintf(buf, "eui.%16phN\n", ids->nguid);
3051

3052 3053
	if (memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
		return sprintf(buf, "eui.%8phN\n", ids->eui64);
3054

C
Christoph Hellwig 已提交
3055 3056
	while (serial_len > 0 && (subsys->serial[serial_len - 1] == ' ' ||
				  subsys->serial[serial_len - 1] == '\0'))
3057
		serial_len--;
C
Christoph Hellwig 已提交
3058 3059
	while (model_len > 0 && (subsys->model[model_len - 1] == ' ' ||
				 subsys->model[model_len - 1] == '\0'))
3060 3061
		model_len--;

C
Christoph Hellwig 已提交
3062 3063
	return sprintf(buf, "nvme.%04x-%*phN-%*phN-%08x\n", subsys->vendor_id,
		serial_len, subsys->serial, model_len, subsys->model,
3064
		head->ns_id);
3065
}
J
Joe Perches 已提交
3066
static DEVICE_ATTR_RO(wwid);
3067

3068
static ssize_t nguid_show(struct device *dev, struct device_attribute *attr,
3069
		char *buf)
3070
{
3071
	return sprintf(buf, "%pU\n", dev_to_ns_head(dev)->ids.nguid);
3072
}
J
Joe Perches 已提交
3073
static DEVICE_ATTR_RO(nguid);
3074

3075
static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
3076
		char *buf)
3077
{
3078
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3079 3080 3081 3082

	/* For backward compatibility expose the NGUID to userspace if
	 * we have no UUID set
	 */
3083
	if (uuid_is_null(&ids->uuid)) {
3084 3085
		printk_ratelimited(KERN_WARNING
				   "No UUID available providing old NGUID\n");
3086
		return sprintf(buf, "%pU\n", ids->nguid);
3087
	}
3088
	return sprintf(buf, "%pU\n", &ids->uuid);
3089
}
J
Joe Perches 已提交
3090
static DEVICE_ATTR_RO(uuid);
3091 3092

static ssize_t eui_show(struct device *dev, struct device_attribute *attr,
3093
		char *buf)
3094
{
3095
	return sprintf(buf, "%8ph\n", dev_to_ns_head(dev)->ids.eui64);
3096
}
J
Joe Perches 已提交
3097
static DEVICE_ATTR_RO(eui);
3098 3099

static ssize_t nsid_show(struct device *dev, struct device_attribute *attr,
3100
		char *buf)
3101
{
3102
	return sprintf(buf, "%d\n", dev_to_ns_head(dev)->ns_id);
3103
}
J
Joe Perches 已提交
3104
static DEVICE_ATTR_RO(nsid);
3105

3106
static struct attribute *nvme_ns_id_attrs[] = {
3107
	&dev_attr_wwid.attr,
3108
	&dev_attr_uuid.attr,
3109
	&dev_attr_nguid.attr,
3110 3111
	&dev_attr_eui.attr,
	&dev_attr_nsid.attr,
C
Christoph Hellwig 已提交
3112 3113 3114 3115
#ifdef CONFIG_NVME_MULTIPATH
	&dev_attr_ana_grpid.attr,
	&dev_attr_ana_state.attr,
#endif
3116 3117 3118
	NULL,
};

3119
static umode_t nvme_ns_id_attrs_are_visible(struct kobject *kobj,
3120 3121 3122
		struct attribute *a, int n)
{
	struct device *dev = container_of(kobj, struct device, kobj);
3123
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
3124 3125

	if (a == &dev_attr_uuid.attr) {
3126
		if (uuid_is_null(&ids->uuid) &&
3127
		    !memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3128 3129 3130
			return 0;
	}
	if (a == &dev_attr_nguid.attr) {
3131
		if (!memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
3132 3133 3134
			return 0;
	}
	if (a == &dev_attr_eui.attr) {
3135
		if (!memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
3136 3137
			return 0;
	}
C
Christoph Hellwig 已提交
3138 3139 3140 3141 3142 3143 3144 3145
#ifdef CONFIG_NVME_MULTIPATH
	if (a == &dev_attr_ana_grpid.attr || a == &dev_attr_ana_state.attr) {
		if (dev_to_disk(dev)->fops != &nvme_fops) /* per-path attr */
			return 0;
		if (!nvme_ctrl_use_ana(nvme_get_ns_from_dev(dev)->ctrl))
			return 0;
	}
#endif
3146 3147 3148
	return a->mode;
}

3149
static const struct attribute_group nvme_ns_id_attr_group = {
3150 3151
	.attrs		= nvme_ns_id_attrs,
	.is_visible	= nvme_ns_id_attrs_are_visible,
3152 3153
};

3154 3155 3156 3157 3158 3159 3160 3161
const struct attribute_group *nvme_ns_id_attr_groups[] = {
	&nvme_ns_id_attr_group,
#ifdef CONFIG_NVM
	&nvme_nvm_attr_group,
#endif
	NULL,
};

M
Ming Lin 已提交
3162
#define nvme_show_str_function(field)						\
3163 3164 3165 3166
static ssize_t  field##_show(struct device *dev,				\
			    struct device_attribute *attr, char *buf)		\
{										\
        struct nvme_ctrl *ctrl = dev_get_drvdata(dev);				\
C
Christoph Hellwig 已提交
3167 3168
        return sprintf(buf, "%.*s\n",						\
		(int)sizeof(ctrl->subsys->field), ctrl->subsys->field);		\
3169 3170 3171
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

C
Christoph Hellwig 已提交
3172 3173 3174 3175
nvme_show_str_function(model);
nvme_show_str_function(serial);
nvme_show_str_function(firmware_rev);

M
Ming Lin 已提交
3176 3177 3178 3179 3180 3181 3182 3183 3184 3185
#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);				\
        return sprintf(buf, "%d\n", ctrl->field);	\
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

nvme_show_int_function(cntlid);
3186
nvme_show_int_function(numa_node);
3187 3188
nvme_show_int_function(queue_count);
nvme_show_int_function(sqsize);
3189

M
Ming Lin 已提交
3190 3191 3192 3193 3194 3195 3196
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))
3197
		nvme_delete_ctrl_sync(ctrl);
M
Ming Lin 已提交
3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211
	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);

	return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->ops->name);
}
static DEVICE_ATTR(transport, S_IRUGO, nvme_sysfs_show_transport, NULL);

3212 3213 3214 3215 3216 3217 3218 3219 3220
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",
3221
		[NVME_CTRL_CONNECTING]	= "connecting",
3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234
		[NVME_CTRL_DELETING]	= "deleting",
		[NVME_CTRL_DEAD]	= "dead",
	};

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

	return sprintf(buf, "unknown state\n");
}

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

M
Ming Lin 已提交
3235 3236 3237 3238 3239 3240
static ssize_t nvme_sysfs_show_subsysnqn(struct device *dev,
					 struct device_attribute *attr,
					 char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

C
Christoph Hellwig 已提交
3241
	return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->subsys->subnqn);
M
Ming Lin 已提交
3242 3243 3244
}
static DEVICE_ATTR(subsysnqn, S_IRUGO, nvme_sysfs_show_subsysnqn, NULL);

3245 3246 3247 3248 3249 3250 3251 3252 3253 3254
static ssize_t nvme_sysfs_show_hostnqn(struct device *dev,
					struct device_attribute *attr,
					char *buf)
{
	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);

	return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->opts->host->nqn);
}
static DEVICE_ATTR(hostnqn, S_IRUGO, nvme_sysfs_show_hostnqn, NULL);

M
Ming Lin 已提交
3255 3256 3257 3258 3259 3260 3261 3262 3263 3264
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);

3265 3266
static struct attribute *nvme_dev_attrs[] = {
	&dev_attr_reset_controller.attr,
K
Keith Busch 已提交
3267
	&dev_attr_rescan_controller.attr,
3268 3269 3270
	&dev_attr_model.attr,
	&dev_attr_serial.attr,
	&dev_attr_firmware_rev.attr,
M
Ming Lin 已提交
3271
	&dev_attr_cntlid.attr,
M
Ming Lin 已提交
3272 3273 3274 3275
	&dev_attr_delete_controller.attr,
	&dev_attr_transport.attr,
	&dev_attr_subsysnqn.attr,
	&dev_attr_address.attr,
3276
	&dev_attr_state.attr,
3277
	&dev_attr_numa_node.attr,
3278 3279
	&dev_attr_queue_count.attr,
	&dev_attr_sqsize.attr,
3280
	&dev_attr_hostnqn.attr,
3281 3282 3283
	NULL
};

M
Ming Lin 已提交
3284 3285 3286 3287 3288 3289
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);

3290 3291 3292 3293
	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;
3294 3295
	if (a == &dev_attr_hostnqn.attr && !ctrl->opts)
		return 0;
M
Ming Lin 已提交
3296 3297 3298 3299

	return a->mode;
}

3300
static struct attribute_group nvme_dev_attrs_group = {
M
Ming Lin 已提交
3301 3302
	.attrs		= nvme_dev_attrs,
	.is_visible	= nvme_dev_attrs_are_visible,
3303 3304 3305 3306 3307 3308 3309
};

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

C
Christoph Hellwig 已提交
3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333
static struct nvme_ns_head *__nvme_find_ns_head(struct nvme_subsystem *subsys,
		unsigned nsid)
{
	struct nvme_ns_head *h;

	lockdep_assert_held(&subsys->lock);

	list_for_each_entry(h, &subsys->nsheads, entry) {
		if (h->ns_id == nsid && kref_get_unless_zero(&h->ref))
			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) &&
3334
		    !list_empty(&h->list) &&
C
Christoph Hellwig 已提交
3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345
		    nvme_ns_ids_equal(&new->ids, &h->ids))
			return -EINVAL;
	}

	return 0;
}

static struct nvme_ns_head *nvme_alloc_ns_head(struct nvme_ctrl *ctrl,
		unsigned nsid, struct nvme_id_ns *id)
{
	struct nvme_ns_head *head;
3346
	size_t size = sizeof(*head);
C
Christoph Hellwig 已提交
3347 3348
	int ret = -ENOMEM;

3349 3350 3351 3352 3353
#ifdef CONFIG_NVME_MULTIPATH
	size += num_possible_nodes() * sizeof(struct nvme_ns *);
#endif

	head = kzalloc(size, GFP_KERNEL);
C
Christoph Hellwig 已提交
3354 3355 3356 3357 3358 3359 3360
	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);
3361 3362 3363
	ret = init_srcu_struct(&head->srcu);
	if (ret)
		goto out_ida_remove;
C
Christoph Hellwig 已提交
3364 3365 3366 3367
	head->subsys = ctrl->subsys;
	head->ns_id = nsid;
	kref_init(&head->ref);

3368 3369 3370
	ret = nvme_report_ns_ids(ctrl, nsid, id, &head->ids);
	if (ret)
		goto out_cleanup_srcu;
C
Christoph Hellwig 已提交
3371 3372 3373 3374 3375 3376 3377 3378

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

3379 3380 3381 3382
	ret = nvme_mpath_alloc_disk(ctrl, head);
	if (ret)
		goto out_cleanup_srcu;

C
Christoph Hellwig 已提交
3383
	list_add_tail(&head->entry, &ctrl->subsys->nsheads);
3384 3385 3386

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

C
Christoph Hellwig 已提交
3387 3388 3389
	return head;
out_cleanup_srcu:
	cleanup_srcu_struct(&head->srcu);
3390
out_ida_remove:
C
Christoph Hellwig 已提交
3391 3392 3393 3394
	ida_simple_remove(&ctrl->subsys->ns_ida, head->instance);
out_free_head:
	kfree(head);
out:
3395 3396
	if (ret > 0)
		ret = blk_status_to_errno(nvme_error_status(ret));
C
Christoph Hellwig 已提交
3397 3398 3399 3400
	return ERR_PTR(ret);
}

static int nvme_init_ns_head(struct nvme_ns *ns, unsigned nsid,
3401
		struct nvme_id_ns *id)
C
Christoph Hellwig 已提交
3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419
{
	struct nvme_ctrl *ctrl = ns->ctrl;
	bool is_shared = id->nmic & (1 << 0);
	struct nvme_ns_head *head = NULL;
	int ret = 0;

	mutex_lock(&ctrl->subsys->lock);
	if (is_shared)
		head = __nvme_find_ns_head(ctrl->subsys, nsid);
	if (!head) {
		head = nvme_alloc_ns_head(ctrl, nsid, id);
		if (IS_ERR(head)) {
			ret = PTR_ERR(head);
			goto out_unlock;
		}
	} else {
		struct nvme_ns_ids ids;

3420 3421 3422 3423
		ret = nvme_report_ns_ids(ctrl, nsid, id, &ids);
		if (ret)
			goto out_unlock;

C
Christoph Hellwig 已提交
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437
		if (!nvme_ns_ids_equal(&head->ids, &ids)) {
			dev_err(ctrl->device,
				"IDs don't match for shared namespace %d\n",
					nsid);
			ret = -EINVAL;
			goto out_unlock;
		}
	}

	list_add_tail(&ns->siblings, &head->list);
	ns->head = head;

out_unlock:
	mutex_unlock(&ctrl->subsys->lock);
3438 3439
	if (ret > 0)
		ret = blk_status_to_errno(nvme_error_status(ret));
C
Christoph Hellwig 已提交
3440 3441 3442
	return ret;
}

3443 3444 3445 3446 3447
static int ns_cmp(void *priv, struct list_head *a, struct list_head *b)
{
	struct nvme_ns *nsa = container_of(a, struct nvme_ns, list);
	struct nvme_ns *nsb = container_of(b, struct nvme_ns, list);

C
Christoph Hellwig 已提交
3448
	return nsa->head->ns_id - nsb->head->ns_id;
3449 3450
}

3451
static struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid)
3452
{
3453
	struct nvme_ns *ns, *ret = NULL;
3454

3455
	down_read(&ctrl->namespaces_rwsem);
3456
	list_for_each_entry(ns, &ctrl->namespaces, list) {
C
Christoph Hellwig 已提交
3457
		if (ns->head->ns_id == nsid) {
3458 3459
			if (!kref_get_unless_zero(&ns->kref))
				continue;
3460 3461 3462
			ret = ns;
			break;
		}
C
Christoph Hellwig 已提交
3463
		if (ns->head->ns_id > nsid)
3464 3465
			break;
	}
3466
	up_read(&ctrl->namespaces_rwsem);
3467
	return ret;
3468 3469
}

3470 3471 3472 3473 3474 3475 3476 3477
static int nvme_setup_streams_ns(struct nvme_ctrl *ctrl, struct nvme_ns *ns)
{
	struct streams_directive_params s;
	int ret;

	if (!ctrl->nr_streams)
		return 0;

C
Christoph Hellwig 已提交
3478
	ret = nvme_get_stream_params(ctrl, &s, ns->head->ns_id);
3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495
	if (ret)
		return ret;

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

	if (ns->sws) {
		unsigned int bs = 1 << ns->lba_shift;

		blk_queue_io_min(ns->queue, bs * ns->sws);
		if (ns->sgs)
			blk_queue_io_opt(ns->queue, bs * ns->sws * ns->sgs);
	}

	return 0;
}

3496
static void nvme_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid)
3497 3498 3499
{
	struct nvme_ns *ns;
	struct gendisk *disk;
3500 3501
	struct nvme_id_ns *id;
	char disk_name[DISK_NAME_LEN];
3502
	int node = ctrl->numa_node, flags = GENHD_FL_EXT_DEVT, ret;
3503 3504 3505

	ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
	if (!ns)
3506
		return;
3507 3508

	ns->queue = blk_mq_init_queue(ctrl->tagset);
3509
	if (IS_ERR(ns->queue))
C
Christoph Hellwig 已提交
3510
		goto out_free_ns;
3511

3512
	if (ctrl->opts && ctrl->opts->data_digest)
3513 3514 3515
		ns->queue->backing_dev_info->capabilities
			|= BDI_CAP_STABLE_WRITES;

3516
	blk_queue_flag_set(QUEUE_FLAG_NONROT, ns->queue);
3517 3518 3519
	if (ctrl->ops->flags & NVME_F_PCI_P2PDMA)
		blk_queue_flag_set(QUEUE_FLAG_PCI_P2PDMA, ns->queue);

3520 3521 3522 3523 3524 3525 3526
	ns->queue->queuedata = ns;
	ns->ctrl = ctrl;

	kref_init(&ns->kref);
	ns->lba_shift = 9; /* set to a default value for 512 until disk is validated */

	blk_queue_logical_block_size(ns->queue, 1 << ns->lba_shift);
3527
	nvme_set_queue_limits(ctrl, ns->queue);
3528

3529 3530
	ret = nvme_identify_ns(ctrl, nsid, &id);
	if (ret)
3531 3532
		goto out_free_queue;

3533
	if (id->ncap == 0)	/* no namespace (legacy quirk) */
3534 3535
		goto out_free_id;

3536 3537
	ret = nvme_init_ns_head(ns, nsid, id);
	if (ret)
C
Christoph Hellwig 已提交
3538
		goto out_free_id;
3539
	nvme_setup_streams_ns(ctrl, ns);
3540
	nvme_set_disk_name(disk_name, ns, ctrl, &flags);
3541

3542
	disk = alloc_disk_node(0, node);
3543
	if (!disk)
C
Christoph Hellwig 已提交
3544
		goto out_unlink_ns;
3545

3546 3547 3548
	disk->fops = &nvme_fops;
	disk->private_data = ns;
	disk->queue = ns->queue;
3549
	disk->flags = flags;
3550 3551 3552 3553
	memcpy(disk->disk_name, disk_name, DISK_NAME_LEN);
	ns->disk = disk;

	__nvme_revalidate_disk(disk, id);
3554

3555
	if ((ctrl->quirks & NVME_QUIRK_LIGHTNVM) && id->vs[0] == 0x1) {
3556 3557
		ret = nvme_nvm_register(ns, disk_name, node);
		if (ret) {
3558 3559 3560 3561 3562
			dev_warn(ctrl->device, "LightNVM init failure\n");
			goto out_put_disk;
		}
	}

3563
	down_write(&ctrl->namespaces_rwsem);
3564
	list_add_tail(&ns->list, &ctrl->namespaces);
3565
	up_write(&ctrl->namespaces_rwsem);
3566

3567
	nvme_get_ctrl(ctrl);
3568

3569
	device_add_disk(ctrl->device, ns->disk, nvme_ns_id_attr_groups);
3570

C
Christoph Hellwig 已提交
3571
	nvme_mpath_add_disk(ns, id);
3572
	nvme_fault_inject_init(&ns->fault_inject, ns->disk->disk_name);
C
Christoph Hellwig 已提交
3573 3574
	kfree(id);

3575
	return;
3576 3577
 out_put_disk:
	put_disk(ns->disk);
C
Christoph Hellwig 已提交
3578 3579 3580 3581
 out_unlink_ns:
	mutex_lock(&ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
	mutex_unlock(&ctrl->subsys->lock);
3582
	nvme_put_ns_head(ns->head);
3583 3584
 out_free_id:
	kfree(id);
3585 3586 3587 3588 3589 3590 3591 3592
 out_free_queue:
	blk_cleanup_queue(ns->queue);
 out_free_ns:
	kfree(ns);
}

static void nvme_ns_remove(struct nvme_ns *ns)
{
3593 3594
	if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
		return;
3595

3596
	nvme_fault_inject_fini(&ns->fault_inject);
3597 3598 3599 3600 3601 3602 3603 3604

	mutex_lock(&ns->ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
	mutex_unlock(&ns->ctrl->subsys->lock);
	synchronize_rcu(); /* guarantee not available in head->list */
	nvme_mpath_clear_current_path(ns);
	synchronize_srcu(&ns->head->srcu); /* wait for concurrent submissions */

3605
	if (ns->disk && ns->disk->flags & GENHD_FL_UP) {
3606 3607
		del_gendisk(ns->disk);
		blk_cleanup_queue(ns->queue);
3608 3609
		if (blk_get_integrity(ns->disk))
			blk_integrity_unregister(ns->disk);
3610
	}
3611

3612
	down_write(&ns->ctrl->namespaces_rwsem);
3613
	list_del_init(&ns->list);
3614
	up_write(&ns->ctrl->namespaces_rwsem);
3615

3616
	nvme_mpath_check_last_path(ns);
3617 3618 3619
	nvme_put_ns(ns);
}

3620 3621 3622 3623
static void nvme_validate_ns(struct nvme_ctrl *ctrl, unsigned nsid)
{
	struct nvme_ns *ns;

3624
	ns = nvme_find_get_ns(ctrl, nsid);
3625
	if (ns) {
3626
		if (ns->disk && revalidate_disk(ns->disk))
3627
			nvme_ns_remove(ns);
3628
		nvme_put_ns(ns);
3629 3630 3631 3632
	} else
		nvme_alloc_ns(ctrl, nsid);
}

3633 3634 3635 3636
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					unsigned nsid)
{
	struct nvme_ns *ns, *next;
3637
	LIST_HEAD(rm_list);
3638

3639
	down_write(&ctrl->namespaces_rwsem);
3640
	list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) {
3641
		if (ns->head->ns_id > nsid || test_bit(NVME_NS_DEAD, &ns->flags))
3642
			list_move_tail(&ns->list, &rm_list);
3643
	}
3644
	up_write(&ctrl->namespaces_rwsem);
3645 3646 3647 3648

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

3649 3650
}

3651 3652 3653 3654
static int nvme_scan_ns_list(struct nvme_ctrl *ctrl, unsigned nn)
{
	struct nvme_ns *ns;
	__le32 *ns_list;
3655 3656
	unsigned i, j, nsid, prev = 0;
	unsigned num_lists = DIV_ROUND_UP_ULL((u64)nn, 1024);
3657 3658
	int ret = 0;

3659
	ns_list = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
3660 3661 3662 3663 3664 3665
	if (!ns_list)
		return -ENOMEM;

	for (i = 0; i < num_lists; i++) {
		ret = nvme_identify_ns_list(ctrl, prev, ns_list);
		if (ret)
3666
			goto free;
3667 3668 3669 3670 3671 3672 3673 3674 3675

		for (j = 0; j < min(nn, 1024U); j++) {
			nsid = le32_to_cpu(ns_list[j]);
			if (!nsid)
				goto out;

			nvme_validate_ns(ctrl, nsid);

			while (++prev < nsid) {
3676 3677
				ns = nvme_find_get_ns(ctrl, prev);
				if (ns) {
3678
					nvme_ns_remove(ns);
3679 3680
					nvme_put_ns(ns);
				}
3681 3682 3683 3684 3685
			}
		}
		nn -= j;
	}
 out:
3686 3687
	nvme_remove_invalid_namespaces(ctrl, prev);
 free:
3688 3689 3690 3691
	kfree(ns_list);
	return ret;
}

3692
static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl, unsigned nn)
3693 3694 3695
{
	unsigned i;

3696 3697 3698
	for (i = 1; i <= nn; i++)
		nvme_validate_ns(ctrl, i);

3699
	nvme_remove_invalid_namespaces(ctrl, nn);
3700 3701
}

3702
static void nvme_clear_changed_ns_log(struct nvme_ctrl *ctrl)
3703 3704 3705
{
	size_t log_size = NVME_MAX_CHANGED_NAMESPACES * sizeof(__le32);
	__le32 *log;
3706
	int error;
3707 3708 3709

	log = kzalloc(log_size, GFP_KERNEL);
	if (!log)
3710
		return;
3711

3712 3713 3714 3715 3716 3717
	/*
	 * 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.
	 */
3718 3719
	error = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CHANGED_NS, 0, log,
			log_size, 0);
3720
	if (error)
3721 3722 3723 3724 3725 3726
		dev_warn(ctrl->device,
			"reading changed ns log failed: %d\n", error);

	kfree(log);
}

3727
static void nvme_scan_work(struct work_struct *work)
3728
{
3729 3730
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, scan_work);
3731
	struct nvme_id_ctrl *id;
3732
	unsigned nn;
3733

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

D
Dan Carpenter 已提交
3738
	if (test_and_clear_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events)) {
3739
		dev_info(ctrl->device, "rescanning namespaces.\n");
3740
		nvme_clear_changed_ns_log(ctrl);
3741 3742
	}

3743 3744
	if (nvme_identify_ctrl(ctrl, &id))
		return;
3745

3746
	mutex_lock(&ctrl->scan_lock);
3747
	nn = le32_to_cpu(id->nn);
3748
	if (ctrl->vs >= NVME_VS(1, 1, 0) &&
3749 3750
	    !(ctrl->quirks & NVME_QUIRK_IDENTIFY_CNS)) {
		if (!nvme_scan_ns_list(ctrl, nn))
3751
			goto out_free_id;
3752
	}
3753
	nvme_scan_ns_sequential(ctrl, nn);
3754
out_free_id:
3755
	mutex_unlock(&ctrl->scan_lock);
3756
	kfree(id);
3757
	down_write(&ctrl->namespaces_rwsem);
3758
	list_sort(NULL, &ctrl->namespaces, ns_cmp);
3759
	up_write(&ctrl->namespaces_rwsem);
3760
}
3761

3762 3763 3764 3765 3766
/*
 * 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.
 */
3767 3768 3769
void nvme_remove_namespaces(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns, *next;
3770
	LIST_HEAD(ns_list);
3771

3772 3773 3774 3775 3776 3777 3778
	/*
	 * 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);

3779 3780 3781
	/* prevent racing with ns scanning */
	flush_work(&ctrl->scan_work);

3782 3783 3784 3785 3786 3787 3788 3789 3790
	/*
	 * 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);

3791
	down_write(&ctrl->namespaces_rwsem);
3792
	list_splice_init(&ctrl->namespaces, &ns_list);
3793
	up_write(&ctrl->namespaces_rwsem);
3794 3795

	list_for_each_entry_safe(ns, next, &ns_list, list)
3796 3797
		nvme_ns_remove(ns);
}
3798
EXPORT_SYMBOL_GPL(nvme_remove_namespaces);
3799

3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826
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");
	}
	return ret;
}

3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842
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]);
}

3843 3844 3845 3846 3847
static void nvme_async_event_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, async_event_work);

3848
	nvme_aen_uevent(ctrl);
3849
	ctrl->ops->submit_async_event(ctrl);
3850 3851
}

3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873
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;

3874
	if (nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_FW_SLOT, 0, log,
3875 3876
			sizeof(*log), 0))
		dev_warn(ctrl->device, "Get FW SLOT INFO log error\n");
3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897
	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");
3898 3899
			nvme_try_sched_reset(ctrl);
			return;
3900 3901 3902 3903
		}
		msleep(100);
	}

3904
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE))
3905 3906 3907
		return;

	nvme_start_queues(ctrl);
3908
	/* read FW slot information to clear the AER */
3909 3910 3911
	nvme_get_fw_slot_info(ctrl);
}

3912 3913
static void nvme_handle_aen_notice(struct nvme_ctrl *ctrl, u32 result)
{
3914 3915
	u32 aer_notice_type = (result & 0xff00) >> 8;

3916 3917
	trace_nvme_async_event(ctrl, aer_notice_type);

3918
	switch (aer_notice_type) {
3919
	case NVME_AER_NOTICE_NS_CHANGED:
D
Dan Carpenter 已提交
3920
		set_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events);
3921 3922 3923
		nvme_queue_scan(ctrl);
		break;
	case NVME_AER_NOTICE_FW_ACT_STARTING:
3924 3925 3926 3927 3928 3929 3930
		/*
		 * 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);
3931
		break;
C
Christoph Hellwig 已提交
3932 3933 3934 3935 3936 3937 3938
#ifdef CONFIG_NVME_MULTIPATH
	case NVME_AER_NOTICE_ANA:
		if (!ctrl->ana_log_buf)
			break;
		queue_work(nvme_wq, &ctrl->ana_work);
		break;
#endif
3939 3940 3941
	case NVME_AER_NOTICE_DISC_CHANGED:
		ctrl->aen_result = result;
		break;
3942 3943 3944 3945 3946
	default:
		dev_warn(ctrl->device, "async event result %08x\n", result);
	}
}

3947
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
3948
		volatile union nvme_result *res)
3949
{
3950
	u32 result = le32_to_cpu(res->u32);
3951
	u32 aer_type = result & 0x07;
3952

3953
	if (le16_to_cpu(status) >> 1 != NVME_SC_SUCCESS)
3954 3955
		return;

3956
	switch (aer_type) {
3957 3958 3959
	case NVME_AER_NOTICE:
		nvme_handle_aen_notice(ctrl, result);
		break;
3960 3961 3962 3963
	case NVME_AER_ERROR:
	case NVME_AER_SMART:
	case NVME_AER_CSS:
	case NVME_AER_VS:
3964
		trace_nvme_async_event(ctrl, aer_type);
3965
		ctrl->aen_result = result;
3966 3967 3968
		break;
	default:
		break;
3969
	}
3970
	queue_work(nvme_wq, &ctrl->async_event_work);
3971 3972
}
EXPORT_SYMBOL_GPL(nvme_complete_async_event);
3973

3974
void nvme_stop_ctrl(struct nvme_ctrl *ctrl)
3975
{
C
Christoph Hellwig 已提交
3976
	nvme_mpath_stop(ctrl);
3977
	nvme_stop_keep_alive(ctrl);
3978
	flush_work(&ctrl->async_event_work);
3979
	cancel_work_sync(&ctrl->fw_act_work);
3980 3981 3982 3983 3984 3985 3986 3987
}
EXPORT_SYMBOL_GPL(nvme_stop_ctrl);

void nvme_start_ctrl(struct nvme_ctrl *ctrl)
{
	if (ctrl->kato)
		nvme_start_keep_alive(ctrl);

3988 3989
	nvme_enable_aen(ctrl);

3990 3991 3992 3993 3994 3995
	if (ctrl->queue_count > 1) {
		nvme_queue_scan(ctrl);
		nvme_start_queues(ctrl);
	}
}
EXPORT_SYMBOL_GPL(nvme_start_ctrl);
3996

3997 3998
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl)
{
3999
	nvme_fault_inject_fini(&ctrl->fault_inject);
4000
	dev_pm_qos_hide_latency_tolerance(ctrl->device);
4001
	cdev_device_del(&ctrl->cdev, ctrl->device);
4002
}
4003
EXPORT_SYMBOL_GPL(nvme_uninit_ctrl);
4004

4005
static void nvme_free_ctrl(struct device *dev)
4006
{
4007 4008
	struct nvme_ctrl *ctrl =
		container_of(dev, struct nvme_ctrl, ctrl_device);
C
Christoph Hellwig 已提交
4009
	struct nvme_subsystem *subsys = ctrl->subsys;
4010

4011 4012 4013
	if (subsys && ctrl->instance != subsys->instance)
		ida_simple_remove(&nvme_instance_ida, ctrl->instance);

4014
	kfree(ctrl->effects);
C
Christoph Hellwig 已提交
4015
	nvme_mpath_uninit(ctrl);
S
Sagi Grimberg 已提交
4016
	__free_page(ctrl->discard_page);
4017

C
Christoph Hellwig 已提交
4018
	if (subsys) {
4019
		mutex_lock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4020 4021
		list_del(&ctrl->subsys_entry);
		sysfs_remove_link(&subsys->dev.kobj, dev_name(ctrl->device));
4022
		mutex_unlock(&nvme_subsystems_lock);
C
Christoph Hellwig 已提交
4023
	}
4024 4025 4026

	ctrl->ops->free_ctrl(ctrl);

C
Christoph Hellwig 已提交
4027 4028
	if (subsys)
		nvme_put_subsystem(subsys);
4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040
}

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

4041 4042
	ctrl->state = NVME_CTRL_NEW;
	spin_lock_init(&ctrl->lock);
4043
	mutex_init(&ctrl->scan_lock);
4044
	INIT_LIST_HEAD(&ctrl->namespaces);
4045
	init_rwsem(&ctrl->namespaces_rwsem);
4046 4047 4048
	ctrl->dev = dev;
	ctrl->ops = ops;
	ctrl->quirks = quirks;
4049
	INIT_WORK(&ctrl->scan_work, nvme_scan_work);
4050
	INIT_WORK(&ctrl->async_event_work, nvme_async_event_work);
4051
	INIT_WORK(&ctrl->fw_act_work, nvme_fw_act_work);
4052
	INIT_WORK(&ctrl->delete_work, nvme_delete_ctrl_work);
4053
	init_waitqueue_head(&ctrl->state_wq);
4054

4055 4056 4057 4058
	INIT_DELAYED_WORK(&ctrl->ka_work, nvme_keep_alive_work);
	memset(&ctrl->ka_cmd, 0, sizeof(ctrl->ka_cmd));
	ctrl->ka_cmd.common.opcode = nvme_admin_keep_alive;

4059 4060 4061 4062 4063 4064 4065 4066
	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;
	}

4067 4068
	ret = ida_simple_get(&nvme_instance_ida, 0, 0, GFP_KERNEL);
	if (ret < 0)
4069
		goto out;
4070
	ctrl->instance = ret;
4071

4072 4073
	device_initialize(&ctrl->ctrl_device);
	ctrl->device = &ctrl->ctrl_device;
4074
	ctrl->device->devt = MKDEV(MAJOR(nvme_chr_devt), ctrl->instance);
4075 4076 4077 4078 4079 4080 4081
	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)
4082 4083
		goto out_release_instance;

4084 4085 4086
	cdev_init(&ctrl->cdev, &nvme_dev_fops);
	ctrl->cdev.owner = ops->module;
	ret = cdev_device_add(&ctrl->cdev, ctrl->device);
4087 4088
	if (ret)
		goto out_free_name;
4089

4090 4091 4092 4093 4094 4095 4096 4097
	/*
	 * 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));

4098 4099
	nvme_fault_inject_init(&ctrl->fault_inject, dev_name(ctrl->device));

4100
	return 0;
4101
out_free_name:
4102
	kfree_const(ctrl->device->kobj.name);
4103
out_release_instance:
4104
	ida_simple_remove(&nvme_instance_ida, ctrl->instance);
4105
out:
4106 4107
	if (ctrl->discard_page)
		__free_page(ctrl->discard_page);
4108 4109
	return ret;
}
4110
EXPORT_SYMBOL_GPL(nvme_init_ctrl);
4111

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

4123
	down_read(&ctrl->namespaces_rwsem);
M
Ming Lei 已提交
4124

4125
	/* Forcibly unquiesce queues to avoid blocking dispatch */
I
Igor Konopko 已提交
4126
	if (ctrl->admin_q && !blk_queue_dying(ctrl->admin_q))
4127
		blk_mq_unquiesce_queue(ctrl->admin_q);
4128

4129 4130
	list_for_each_entry(ns, &ctrl->namespaces, list)
		nvme_set_queue_dying(ns);
4131

4132
	up_read(&ctrl->namespaces_rwsem);
4133
}
4134
EXPORT_SYMBOL_GPL(nvme_kill_queues);
4135

K
Keith Busch 已提交
4136 4137 4138 4139
void nvme_unfreeze(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

4140
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4141 4142
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_unfreeze_queue(ns->queue);
4143
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4144 4145 4146 4147 4148 4149 4150
}
EXPORT_SYMBOL_GPL(nvme_unfreeze);

void nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout)
{
	struct nvme_ns *ns;

4151
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4152 4153 4154 4155 4156
	list_for_each_entry(ns, &ctrl->namespaces, list) {
		timeout = blk_mq_freeze_queue_wait_timeout(ns->queue, timeout);
		if (timeout <= 0)
			break;
	}
4157
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4158 4159 4160 4161 4162 4163 4164
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze_timeout);

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

4165
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4166 4167
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_freeze_queue_wait(ns->queue);
4168
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4169 4170 4171 4172 4173 4174 4175
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze);

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

4176
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4177
	list_for_each_entry(ns, &ctrl->namespaces, list)
4178
		blk_freeze_queue_start(ns->queue);
4179
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
4180 4181 4182
}
EXPORT_SYMBOL_GPL(nvme_start_freeze);

4183
void nvme_stop_queues(struct nvme_ctrl *ctrl)
4184 4185 4186
{
	struct nvme_ns *ns;

4187
	down_read(&ctrl->namespaces_rwsem);
4188
	list_for_each_entry(ns, &ctrl->namespaces, list)
4189
		blk_mq_quiesce_queue(ns->queue);
4190
	up_read(&ctrl->namespaces_rwsem);
4191
}
4192
EXPORT_SYMBOL_GPL(nvme_stop_queues);
4193

4194
void nvme_start_queues(struct nvme_ctrl *ctrl)
4195 4196 4197
{
	struct nvme_ns *ns;

4198
	down_read(&ctrl->namespaces_rwsem);
4199
	list_for_each_entry(ns, &ctrl->namespaces, list)
4200
		blk_mq_unquiesce_queue(ns->queue);
4201
	up_read(&ctrl->namespaces_rwsem);
4202
}
4203
EXPORT_SYMBOL_GPL(nvme_start_queues);
4204

K
Keith Busch 已提交
4205 4206 4207 4208 4209 4210 4211 4212 4213

void nvme_sync_queues(struct nvme_ctrl *ctrl)
{
	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);
4214 4215 4216

	if (ctrl->admin_q)
		blk_sync_queue(ctrl->admin_q);
K
Keith Busch 已提交
4217 4218 4219
}
EXPORT_SYMBOL_GPL(nvme_sync_queues);

4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244
/*
 * 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);
	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);
}


4245
static int __init nvme_core_init(void)
4246
{
4247
	int result = -ENOMEM;
4248

4249 4250
	_nvme_check_size();

4251 4252 4253
	nvme_wq = alloc_workqueue("nvme-wq",
			WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0);
	if (!nvme_wq)
4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264
		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;
4265

4266
	result = alloc_chrdev_region(&nvme_chr_devt, 0, NVME_MINORS, "nvme");
4267
	if (result < 0)
4268
		goto destroy_delete_wq;
4269 4270 4271 4272 4273 4274

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

C
Christoph Hellwig 已提交
4277 4278 4279 4280 4281
	nvme_subsys_class = class_create(THIS_MODULE, "nvme-subsystem");
	if (IS_ERR(nvme_subsys_class)) {
		result = PTR_ERR(nvme_subsys_class);
		goto destroy_class;
	}
4282
	return 0;
4283

C
Christoph Hellwig 已提交
4284 4285
destroy_class:
	class_destroy(nvme_class);
4286
unregister_chrdev:
4287
	unregister_chrdev_region(nvme_chr_devt, NVME_MINORS);
4288 4289 4290 4291
destroy_delete_wq:
	destroy_workqueue(nvme_delete_wq);
destroy_reset_wq:
	destroy_workqueue(nvme_reset_wq);
4292 4293
destroy_wq:
	destroy_workqueue(nvme_wq);
4294
out:
4295
	return result;
4296 4297
}

4298
static void __exit nvme_core_exit(void)
4299
{
C
Christoph Hellwig 已提交
4300
	class_destroy(nvme_subsys_class);
4301
	class_destroy(nvme_class);
4302
	unregister_chrdev_region(nvme_chr_devt, NVME_MINORS);
4303 4304
	destroy_workqueue(nvme_delete_wq);
	destroy_workqueue(nvme_reset_wq);
4305
	destroy_workqueue(nvme_wq);
4306
}
4307 4308 4309 4310 4311

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