core.c 94.0 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/*
 * NVM Express device driver
 * Copyright (c) 2011-2014, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 */

#include <linux/blkdev.h>
#include <linux/blk-mq.h>
17
#include <linux/delay.h>
18
#include <linux/errno.h>
19
#include <linux/hdreg.h>
20
#include <linux/kernel.h>
21 22
#include <linux/module.h>
#include <linux/list_sort.h>
23 24
#include <linux/slab.h>
#include <linux/types.h>
25 26 27 28
#include <linux/pr.h>
#include <linux/ptrace.h>
#include <linux/nvme_ioctl.h>
#include <linux/t10-pi.h>
29
#include <linux/pm_qos.h>
30
#include <asm/unaligned.h>
31

32 33 34
#define CREATE_TRACE_POINTS
#include "trace.h"

35
#include "nvme.h"
S
Sagi Grimberg 已提交
36
#include "fabrics.h"
37

38 39
#define NVME_MINORS		(1U << MINORBITS)

40 41
unsigned int admin_timeout = 60;
module_param(admin_timeout, uint, 0644);
42
MODULE_PARM_DESC(admin_timeout, "timeout in seconds for admin commands");
43
EXPORT_SYMBOL_GPL(admin_timeout);
44

45 46
unsigned int nvme_io_timeout = 30;
module_param_named(io_timeout, nvme_io_timeout, uint, 0644);
47
MODULE_PARM_DESC(io_timeout, "timeout in seconds for I/O");
48
EXPORT_SYMBOL_GPL(nvme_io_timeout);
49

50
static unsigned char shutdown_timeout = 5;
51 52 53
module_param(shutdown_timeout, byte, 0644);
MODULE_PARM_DESC(shutdown_timeout, "timeout in seconds for controller shutdown");

54 55
static u8 nvme_max_retries = 5;
module_param_named(max_retries, nvme_max_retries, byte, 0644);
K
Keith Busch 已提交
56
MODULE_PARM_DESC(max_retries, "max number of retries a command may have");
57

58
static unsigned long default_ps_max_latency_us = 100000;
59 60 61 62
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");

63 64 65 66
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");

67 68 69 70
static bool streams;
module_param(streams, bool, 0644);
MODULE_PARM_DESC(streams, "turn on support for Streams write directives");

71 72 73 74 75 76 77 78 79 80 81
/*
 * 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
 *
 * nvme_wq will host works such are scan, aen handling, fw activation,
 * keep-alive error recovery, periodic reconnects etc. nvme_reset_wq
 * 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.
 */
82 83 84
struct workqueue_struct *nvme_wq;
EXPORT_SYMBOL_GPL(nvme_wq);

85 86 87 88 89 90
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 已提交
91 92 93
static DEFINE_IDA(nvme_subsystems_ida);
static LIST_HEAD(nvme_subsystems);
static DEFINE_MUTEX(nvme_subsystems_lock);
94

95
static DEFINE_IDA(nvme_instance_ida);
96
static dev_t nvme_chr_devt;
97
static struct class *nvme_class;
C
Christoph Hellwig 已提交
98
static struct class *nvme_subsys_class;
99

100 101
static void nvme_ns_remove(struct nvme_ns *ns);
static int nvme_revalidate_disk(struct gendisk *disk);
102
static void nvme_put_subsystem(struct nvme_subsystem *subsys);
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
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;
	revalidate_disk(ns->disk);
	blk_set_queue_dying(ns->queue);
	/* Forcibly unquiesce queues to avoid blocking dispatch */
	blk_mq_unquiesce_queue(ns->queue);
}
119

120 121 122 123 124 125 126 127 128
static void nvme_queue_scan(struct nvme_ctrl *ctrl)
{
	/*
	 * Only new queue scan work when admin and IO queues are both alive
	 */
	if (ctrl->state == NVME_CTRL_LIVE)
		queue_work(nvme_wq, &ctrl->scan_work);
}

129 130 131 132
int nvme_reset_ctrl(struct nvme_ctrl *ctrl)
{
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
		return -EBUSY;
133
	if (!queue_work(nvme_reset_wq, &ctrl->reset_work))
134 135 136 137 138
		return -EBUSY;
	return 0;
}
EXPORT_SYMBOL_GPL(nvme_reset_ctrl);

S
Sagi Grimberg 已提交
139
int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl)
140 141 142 143
{
	int ret;

	ret = nvme_reset_ctrl(ctrl);
144
	if (!ret) {
145
		flush_work(&ctrl->reset_work);
146 147
		if (ctrl->state != NVME_CTRL_LIVE &&
		    ctrl->state != NVME_CTRL_ADMIN_ONLY)
148 149 150
			ret = -ENETRESET;
	}

151 152
	return ret;
}
S
Sagi Grimberg 已提交
153
EXPORT_SYMBOL_GPL(nvme_reset_ctrl_sync);
154

155 156 157 158 159
static void nvme_delete_ctrl_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, delete_work);

160 161 162
	dev_info(ctrl->device,
		 "Removing ctrl: NQN \"%s\"\n", ctrl->opts->subsysnqn);

163
	flush_work(&ctrl->reset_work);
164 165
	nvme_stop_ctrl(ctrl);
	nvme_remove_namespaces(ctrl);
166
	ctrl->ops->delete_ctrl(ctrl);
167 168
	nvme_uninit_ctrl(ctrl);
	nvme_put_ctrl(ctrl);
169 170 171 172 173 174
}

int nvme_delete_ctrl(struct nvme_ctrl *ctrl)
{
	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
		return -EBUSY;
175
	if (!queue_work(nvme_delete_wq, &ctrl->delete_work))
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
		return -EBUSY;
	return 0;
}
EXPORT_SYMBOL_GPL(nvme_delete_ctrl);

int nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl)
{
	int ret = 0;

	/*
	 * Keep a reference until the work is flushed since ->delete_ctrl
	 * can free the controller.
	 */
	nvme_get_ctrl(ctrl);
	ret = nvme_delete_ctrl(ctrl);
	if (!ret)
		flush_work(&ctrl->delete_work);
	nvme_put_ctrl(ctrl);
	return ret;
}
EXPORT_SYMBOL_GPL(nvme_delete_ctrl_sync);

198 199 200 201 202
static inline bool nvme_ns_has_pi(struct nvme_ns *ns)
{
	return ns->pi_type && ns->ms == sizeof(struct t10_pi_tuple);
}

203
static blk_status_t nvme_error_status(struct request *req)
204 205 206
{
	switch (nvme_req(req)->status & 0x7ff) {
	case NVME_SC_SUCCESS:
207
		return BLK_STS_OK;
208
	case NVME_SC_CAP_EXCEEDED:
209
		return BLK_STS_NOSPC;
210 211 212
	case NVME_SC_LBA_RANGE:
		return BLK_STS_TARGET;
	case NVME_SC_BAD_ATTRIBUTES:
213
	case NVME_SC_ONCS_NOT_SUPPORTED:
214 215 216
	case NVME_SC_INVALID_OPCODE:
	case NVME_SC_INVALID_FIELD:
	case NVME_SC_INVALID_NS:
217
		return BLK_STS_NOTSUPP;
218 219 220
	case NVME_SC_WRITE_FAULT:
	case NVME_SC_READ_ERROR:
	case NVME_SC_UNWRITTEN_BLOCK:
221 222
	case NVME_SC_ACCESS_DENIED:
	case NVME_SC_READ_ONLY:
223
	case NVME_SC_COMPARE_FAILED:
224
		return BLK_STS_MEDIUM;
225 226 227 228 229 230 231
	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;
232 233
	default:
		return BLK_STS_IOERR;
234 235 236
	}
}

237
static inline bool nvme_req_needs_retry(struct request *req)
238
{
239 240
	if (blk_noretry_request(req))
		return false;
241
	if (nvme_req(req)->status & NVME_SC_DNR)
242
		return false;
243
	if (nvme_req(req)->retries >= nvme_max_retries)
244 245
		return false;
	return true;
246 247 248 249
}

void nvme_complete_rq(struct request *req)
{
250 251
	blk_status_t status = nvme_error_status(req);

252 253
	trace_nvme_complete_rq(req);

254
	if (unlikely(status != BLK_STS_OK && nvme_req_needs_retry(req))) {
255 256
		if ((req->cmd_flags & REQ_NVME_MPATH) &&
		    blk_path_error(status)) {
257 258 259 260 261 262 263 264 265
			nvme_failover_req(req);
			return;
		}

		if (!blk_queue_dying(req->q)) {
			nvme_req(req)->retries++;
			blk_mq_requeue_request(req, true);
			return;
		}
266
	}
267
	blk_mq_end_request(req, status);
268 269 270
}
EXPORT_SYMBOL_GPL(nvme_complete_rq);

271 272 273 274 275
void nvme_cancel_request(struct request *req, void *data, bool reserved)
{
	dev_dbg_ratelimited(((struct nvme_ctrl *) data)->device,
				"Cancelling I/O %d", req->tag);

276
	nvme_req(req)->status = NVME_SC_ABORT_REQ;
277
	blk_mq_complete_request(req);
278

279 280 281
}
EXPORT_SYMBOL_GPL(nvme_cancel_request);

282 283 284
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state)
{
285
	enum nvme_ctrl_state old_state;
286
	unsigned long flags;
287 288
	bool changed = false;

289
	spin_lock_irqsave(&ctrl->lock, flags);
290 291

	old_state = ctrl->state;
292
	switch (new_state) {
293 294
	case NVME_CTRL_ADMIN_ONLY:
		switch (old_state) {
295
		case NVME_CTRL_CONNECTING:
296 297 298 299 300 301
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
302 303
	case NVME_CTRL_LIVE:
		switch (old_state) {
304
		case NVME_CTRL_NEW:
305
		case NVME_CTRL_RESETTING:
306
		case NVME_CTRL_CONNECTING:
307 308 309 310 311 312 313 314 315
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
	case NVME_CTRL_RESETTING:
		switch (old_state) {
		case NVME_CTRL_NEW:
316
		case NVME_CTRL_LIVE:
317
		case NVME_CTRL_ADMIN_ONLY:
318 319 320 321 322 323
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
324
	case NVME_CTRL_CONNECTING:
325
		switch (old_state) {
326
		case NVME_CTRL_NEW:
327
		case NVME_CTRL_RESETTING:
328 329 330 331 332 333 334 335 336
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
	case NVME_CTRL_DELETING:
		switch (old_state) {
		case NVME_CTRL_LIVE:
337
		case NVME_CTRL_ADMIN_ONLY:
338
		case NVME_CTRL_RESETTING:
339
		case NVME_CTRL_CONNECTING:
340 341 342 343 344 345
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
346 347 348 349 350 351 352 353 354
	case NVME_CTRL_DEAD:
		switch (old_state) {
		case NVME_CTRL_DELETING:
			changed = true;
			/* FALLTHRU */
		default:
			break;
		}
		break;
355 356 357 358 359 360 361
	default:
		break;
	}

	if (changed)
		ctrl->state = new_state;

362
	spin_unlock_irqrestore(&ctrl->lock, flags);
363 364
	if (changed && ctrl->state == NVME_CTRL_LIVE)
		nvme_kick_requeue_lists(ctrl);
365 366 367 368
	return changed;
}
EXPORT_SYMBOL_GPL(nvme_change_ctrl_state);

C
Christoph Hellwig 已提交
369 370 371 372 373
static void nvme_free_ns_head(struct kref *ref)
{
	struct nvme_ns_head *head =
		container_of(ref, struct nvme_ns_head, ref);

374
	nvme_mpath_remove_disk(head);
C
Christoph Hellwig 已提交
375 376
	ida_simple_remove(&head->subsys->ns_ida, head->instance);
	list_del_init(&head->entry);
377
	cleanup_srcu_struct_quiesced(&head->srcu);
378
	nvme_put_subsystem(head->subsys);
C
Christoph Hellwig 已提交
379 380 381 382 383 384 385 386
	kfree(head);
}

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

387 388 389 390
static void nvme_free_ns(struct kref *kref)
{
	struct nvme_ns *ns = container_of(kref, struct nvme_ns, kref);

391 392
	if (ns->ndev)
		nvme_nvm_unregister(ns);
393 394

	put_disk(ns->disk);
C
Christoph Hellwig 已提交
395
	nvme_put_ns_head(ns->head);
396
	nvme_put_ctrl(ns->ctrl);
397 398 399
	kfree(ns);
}

400
static void nvme_put_ns(struct nvme_ns *ns)
401 402 403 404
{
	kref_put(&ns->kref, nvme_free_ns);
}

405 406 407 408 409 410 411 412 413
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;
	}
}

414
struct request *nvme_alloc_request(struct request_queue *q,
415
		struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid)
416
{
417
	unsigned op = nvme_is_write(cmd) ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN;
418 419
	struct request *req;

420
	if (qid == NVME_QID_ANY) {
421
		req = blk_mq_alloc_request(q, op, flags);
422
	} else {
423
		req = blk_mq_alloc_request_hctx(q, op, flags,
424 425
				qid ? qid - 1 : 0);
	}
426
	if (IS_ERR(req))
427
		return req;
428 429

	req->cmd_flags |= REQ_FAILFAST_DRIVER;
430
	nvme_clear_nvme_request(req);
431
	nvme_req(req)->cmd = cmd;
432

433 434
	return req;
}
435
EXPORT_SYMBOL_GPL(nvme_alloc_request);
436

437 438 439 440 441 442 443
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 已提交
444
	c.directive.nsid = cpu_to_le32(NVME_NSID_ALL);
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
	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);
473
	c.directive.numd = cpu_to_le32((sizeof(*s) >> 2) - 1);
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
	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 已提交
494
	ret = nvme_get_stream_params(ctrl, &s, NVME_NSID_ALL);
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
	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 已提交
536 537 538 539 540
static inline void nvme_setup_flush(struct nvme_ns *ns,
		struct nvme_command *cmnd)
{
	memset(cmnd, 0, sizeof(*cmnd));
	cmnd->common.opcode = nvme_cmd_flush;
C
Christoph Hellwig 已提交
541
	cmnd->common.nsid = cpu_to_le32(ns->head->ns_id);
M
Ming Lin 已提交
542 543
}

544
static blk_status_t nvme_setup_discard(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
545 546
		struct nvme_command *cmnd)
{
547
	unsigned short segments = blk_rq_nr_discard_segments(req), n = 0;
M
Ming Lin 已提交
548
	struct nvme_dsm_range *range;
549
	struct bio *bio;
M
Ming Lin 已提交
550

551
	range = kmalloc_array(segments, sizeof(*range), GFP_ATOMIC);
M
Ming Lin 已提交
552
	if (!range)
553
		return BLK_STS_RESOURCE;
M
Ming Lin 已提交
554

555 556 557 558
	__rq_for_each_bio(bio, req) {
		u64 slba = nvme_block_nr(ns, bio->bi_iter.bi_sector);
		u32 nlb = bio->bi_iter.bi_size >> ns->lba_shift;

K
Keith Busch 已提交
559 560 561 562 563
		if (n < segments) {
			range[n].cattr = cpu_to_le32(0);
			range[n].nlb = cpu_to_le32(nlb);
			range[n].slba = cpu_to_le64(slba);
		}
564 565 566 567 568
		n++;
	}

	if (WARN_ON_ONCE(n != segments)) {
		kfree(range);
569
		return BLK_STS_IOERR;
570
	}
M
Ming Lin 已提交
571 572 573

	memset(cmnd, 0, sizeof(*cmnd));
	cmnd->dsm.opcode = nvme_cmd_dsm;
C
Christoph Hellwig 已提交
574
	cmnd->dsm.nsid = cpu_to_le32(ns->head->ns_id);
575
	cmnd->dsm.nr = cpu_to_le32(segments - 1);
M
Ming Lin 已提交
576 577
	cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);

578 579
	req->special_vec.bv_page = virt_to_page(range);
	req->special_vec.bv_offset = offset_in_page(range);
580
	req->special_vec.bv_len = sizeof(*range) * segments;
581
	req->rq_flags |= RQF_SPECIAL_PAYLOAD;
M
Ming Lin 已提交
582

583
	return BLK_STS_OK;
M
Ming Lin 已提交
584 585
}

586 587
static inline blk_status_t nvme_setup_rw(struct nvme_ns *ns,
		struct request *req, struct nvme_command *cmnd)
M
Ming Lin 已提交
588
{
589
	struct nvme_ctrl *ctrl = ns->ctrl;
M
Ming Lin 已提交
590 591 592 593 594 595 596 597 598 599 600 601 602
	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;

	memset(cmnd, 0, sizeof(*cmnd));
	cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
C
Christoph Hellwig 已提交
603
	cmnd->rw.nsid = cpu_to_le32(ns->head->ns_id);
M
Ming Lin 已提交
604 605 606
	cmnd->rw.slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
	cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);

607 608 609
	if (req_op(req) == REQ_OP_WRITE && ctrl->nr_streams)
		nvme_assign_write_stream(ctrl, req, &control, &dsmgmt);

M
Ming Lin 已提交
610
	if (ns->ms) {
611 612 613 614 615 616 617 618 619 620
		/*
		 * 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;
621 622
		} else if (req_op(req) == REQ_OP_WRITE) {
			t10_pi_prepare(req, ns->pi_type);
623 624
		}

M
Ming Lin 已提交
625 626 627 628 629 630 631 632
		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;
633
			cmnd->rw.reftag = cpu_to_le32(t10_pi_ref_tag(req));
M
Ming Lin 已提交
634 635 636 637 638 639
			break;
		}
	}

	cmnd->rw.control = cpu_to_le16(control);
	cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
640
	return 0;
M
Ming Lin 已提交
641 642
}

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
void nvme_cleanup_cmd(struct request *req)
{
	if (blk_integrity_rq(req) && req_op(req) == REQ_OP_READ &&
	    nvme_req(req)->status == 0) {
		struct nvme_ns *ns = req->rq_disk->private_data;

		t10_pi_complete(req, ns->pi_type,
				blk_rq_bytes(req) >> ns->lba_shift);
	}
	if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
		kfree(page_address(req->special_vec.bv_page) +
		      req->special_vec.bv_offset);
	}
}
EXPORT_SYMBOL_GPL(nvme_cleanup_cmd);

659
blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
660 661
		struct nvme_command *cmd)
{
662
	blk_status_t ret = BLK_STS_OK;
M
Ming Lin 已提交
663

664
	nvme_clear_nvme_request(req);
665

666 667 668
	switch (req_op(req)) {
	case REQ_OP_DRV_IN:
	case REQ_OP_DRV_OUT:
669
		memcpy(cmd, nvme_req(req)->cmd, sizeof(*cmd));
670 671
		break;
	case REQ_OP_FLUSH:
M
Ming Lin 已提交
672
		nvme_setup_flush(ns, cmd);
673
		break;
674 675
	case REQ_OP_WRITE_ZEROES:
		/* currently only aliased to deallocate for a few ctrls: */
676
	case REQ_OP_DISCARD:
M
Ming Lin 已提交
677
		ret = nvme_setup_discard(ns, req, cmd);
678 679 680
		break;
	case REQ_OP_READ:
	case REQ_OP_WRITE:
681
		ret = nvme_setup_rw(ns, req, cmd);
682 683 684
		break;
	default:
		WARN_ON_ONCE(1);
685
		return BLK_STS_IOERR;
686
	}
M
Ming Lin 已提交
687

688
	cmd->common.command_id = req->tag;
K
Keith Busch 已提交
689
	trace_nvme_setup_cmd(req, cmd);
M
Ming Lin 已提交
690 691 692 693
	return ret;
}
EXPORT_SYMBOL_GPL(nvme_setup_cmd);

694 695 696 697 698
/*
 * 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,
699
		union nvme_result *result, void *buffer, unsigned bufflen,
700 701
		unsigned timeout, int qid, int at_head,
		blk_mq_req_flags_t flags)
702 703 704 705
{
	struct request *req;
	int ret;

706
	req = nvme_alloc_request(q, cmd, flags, qid);
707 708 709 710 711
	if (IS_ERR(req))
		return PTR_ERR(req);

	req->timeout = timeout ? timeout : ADMIN_TIMEOUT;

712 713 714 715
	if (buffer && bufflen) {
		ret = blk_rq_map_kern(q, req, buffer, bufflen, GFP_KERNEL);
		if (ret)
			goto out;
716 717
	}

718
	blk_execute_rq(req->q, NULL, req, at_head);
719 720
	if (result)
		*result = nvme_req(req)->result;
721 722 723 724
	if (nvme_req(req)->flags & NVME_REQ_CANCELLED)
		ret = -EINTR;
	else
		ret = nvme_req(req)->status;
725 726 727 728
 out:
	blk_mq_free_request(req);
	return ret;
}
729
EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd);
730 731 732 733

int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
		void *buffer, unsigned bufflen)
{
734 735
	return __nvme_submit_sync_cmd(q, cmd, NULL, buffer, bufflen, 0,
			NVME_QID_ANY, 0, 0);
736
}
737
EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd);
738

739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
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);
}

773
static int nvme_submit_user_cmd(struct request_queue *q,
774 775 776
		struct nvme_command *cmd, void __user *ubuffer,
		unsigned bufflen, void __user *meta_buffer, unsigned meta_len,
		u32 meta_seed, u32 *result, unsigned timeout)
777
{
778
	bool write = nvme_is_write(cmd);
779 780
	struct nvme_ns *ns = q->queuedata;
	struct gendisk *disk = ns ? ns->disk : NULL;
781
	struct request *req;
782 783
	struct bio *bio = NULL;
	void *meta = NULL;
784 785
	int ret;

786
	req = nvme_alloc_request(q, cmd, 0, NVME_QID_ANY);
787 788 789 790
	if (IS_ERR(req))
		return PTR_ERR(req);

	req->timeout = timeout ? timeout : ADMIN_TIMEOUT;
791
	nvme_req(req)->flags |= NVME_REQ_USERCMD;
792 793

	if (ubuffer && bufflen) {
794 795 796 797 798
		ret = blk_rq_map_user(q, req, NULL, ubuffer, bufflen,
				GFP_KERNEL);
		if (ret)
			goto out;
		bio = req->bio;
799
		bio->bi_disk = disk;
800 801 802 803 804
		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);
805 806
				goto out_unmap;
			}
807
			req->cmd_flags |= REQ_INTEGRITY;
808 809
		}
	}
810

811
	blk_execute_rq(req->q, disk, req, 0);
812 813 814 815
	if (nvme_req(req)->flags & NVME_REQ_CANCELLED)
		ret = -EINTR;
	else
		ret = nvme_req(req)->status;
816
	if (result)
817
		*result = le32_to_cpu(nvme_req(req)->result.u32);
818 819 820 821 822 823
	if (meta && !ret && !write) {
		if (copy_to_user(meta_buffer, meta, meta_len))
			ret = -EFAULT;
	}
	kfree(meta);
 out_unmap:
824
	if (bio)
825
		blk_rq_unmap_user(bio);
826 827 828 829 830
 out:
	blk_mq_free_request(req);
	return ret;
}

831
static void nvme_keep_alive_end_io(struct request *rq, blk_status_t status)
S
Sagi Grimberg 已提交
832 833
{
	struct nvme_ctrl *ctrl = rq->end_io_data;
834 835
	unsigned long flags;
	bool startka = false;
S
Sagi Grimberg 已提交
836 837 838

	blk_mq_free_request(rq);

839
	if (status) {
S
Sagi Grimberg 已提交
840
		dev_err(ctrl->device,
841 842
			"failed nvme_keep_alive_end_io error=%d\n",
				status);
S
Sagi Grimberg 已提交
843 844 845
		return;
	}

846 847 848 849 850 851 852
	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)
		schedule_delayed_work(&ctrl->ka_work, ctrl->kato * HZ);
S
Sagi Grimberg 已提交
853 854 855 856 857 858
}

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

859
	rq = nvme_alloc_request(ctrl->admin_q, &ctrl->ka_cmd, BLK_MQ_REQ_RESERVED,
S
Sagi Grimberg 已提交
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
			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);

	if (nvme_keep_alive(ctrl)) {
		/* allocation failure, reset the controller */
		dev_err(ctrl->device, "keep-alive failed\n");
880
		nvme_reset_ctrl(ctrl);
S
Sagi Grimberg 已提交
881 882 883 884
		return;
	}
}

885
static void nvme_start_keep_alive(struct nvme_ctrl *ctrl)
S
Sagi Grimberg 已提交
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
{
	if (unlikely(ctrl->kato == 0))
		return;

	schedule_delayed_work(&ctrl->ka_work, ctrl->kato * HZ);
}

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 已提交
902
static int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id)
903 904 905 906 907 908
{
	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;
909
	c.identify.cns = NVME_ID_CNS_CTRL;
910 911 912 913 914 915 916 917 918 919 920 921

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

922
static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl, unsigned nsid,
923
		struct nvme_ns_ids *ids)
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
{
	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;

939
	status = nvme_submit_sync_cmd(ctrl->admin_q, &c, data,
940 941 942 943 944 945 946 947 948 949 950 951 952
				      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) {
953
				dev_warn(ctrl->device,
954 955 956 957 958
					 "ctrl returned bogus length: %d for NVME_NIDT_EUI64\n",
					 cur->nidl);
				goto free_data;
			}
			len = NVME_NIDT_EUI64_LEN;
959
			memcpy(ids->eui64, data + pos + sizeof(*cur), len);
960 961 962
			break;
		case NVME_NIDT_NGUID:
			if (cur->nidl != NVME_NIDT_NGUID_LEN) {
963
				dev_warn(ctrl->device,
964 965 966 967 968
					 "ctrl returned bogus length: %d for NVME_NIDT_NGUID\n",
					 cur->nidl);
				goto free_data;
			}
			len = NVME_NIDT_NGUID_LEN;
969
			memcpy(ids->nguid, data + pos + sizeof(*cur), len);
970 971 972
			break;
		case NVME_NIDT_UUID:
			if (cur->nidl != NVME_NIDT_UUID_LEN) {
973
				dev_warn(ctrl->device,
974 975 976 977 978
					 "ctrl returned bogus length: %d for NVME_NIDT_UUID\n",
					 cur->nidl);
				goto free_data;
			}
			len = NVME_NIDT_UUID_LEN;
979
			uuid_copy(&ids->uuid, data + pos + sizeof(*cur));
980 981 982 983 984 985 986 987 988 989 990 991 992 993
			break;
		default:
			/* Skip unnkown types */
			len = cur->nidl;
			break;
		}

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

994 995 996 997 998
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;
999
	c.identify.cns = NVME_ID_CNS_NS_ACTIVE_LIST;
1000
	c.identify.nsid = cpu_to_le32(nsid);
1001 1002
	return nvme_submit_sync_cmd(dev->admin_q, &c, ns_list,
				    NVME_IDENTIFY_DATA_SIZE);
1003 1004
}

1005 1006
static struct nvme_id_ns *nvme_identify_ns(struct nvme_ctrl *ctrl,
		unsigned nsid)
1007
{
1008
	struct nvme_id_ns *id;
1009 1010 1011 1012
	struct nvme_command c = { };
	int error;

	/* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1013 1014
	c.identify.opcode = nvme_admin_identify;
	c.identify.nsid = cpu_to_le32(nsid);
1015
	c.identify.cns = NVME_ID_CNS_NS;
1016

1017 1018 1019
	id = kmalloc(sizeof(*id), GFP_KERNEL);
	if (!id)
		return NULL;
1020

1021 1022 1023 1024 1025 1026 1027 1028
	error = nvme_submit_sync_cmd(ctrl->admin_q, &c, id, sizeof(*id));
	if (error) {
		dev_warn(ctrl->device, "Identify namespace failed\n");
		kfree(id);
		return NULL;
	}

	return id;
1029 1030
}

K
Keith Busch 已提交
1031
static int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
1032
		      void *buffer, size_t buflen, u32 *result)
1033 1034
{
	struct nvme_command c;
1035
	union nvme_result res;
1036
	int ret;
1037 1038 1039 1040 1041 1042

	memset(&c, 0, sizeof(c));
	c.features.opcode = nvme_admin_set_features;
	c.features.fid = cpu_to_le32(fid);
	c.features.dword11 = cpu_to_le32(dword11);

1043
	ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &res,
1044
			buffer, buflen, 0, NVME_QID_ANY, 0, 0);
1045
	if (ret >= 0 && result)
1046
		*result = le32_to_cpu(res.u32);
1047
	return ret;
1048 1049
}

C
Christoph Hellwig 已提交
1050 1051 1052 1053 1054 1055
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;

1056
	status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, NULL, 0,
C
Christoph Hellwig 已提交
1057
			&result);
1058
	if (status < 0)
C
Christoph Hellwig 已提交
1059 1060
		return status;

1061 1062 1063 1064 1065 1066
	/*
	 * 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) {
1067
		dev_err(ctrl->device, "Could not set queue count (%d)\n", status);
1068 1069 1070 1071 1072 1073
		*count = 0;
	} else {
		nr_io_queues = min(result & 0xffff, result >> 16) + 1;
		*count = min(*count, nr_io_queues);
	}

C
Christoph Hellwig 已提交
1074 1075
	return 0;
}
1076
EXPORT_SYMBOL_GPL(nvme_set_queue_count);
C
Christoph Hellwig 已提交
1077

1078
#define NVME_AEN_SUPPORTED \
C
Christoph Hellwig 已提交
1079
	(NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_FW_ACT | NVME_AEN_CFG_ANA_CHANGE)
1080 1081 1082

static void nvme_enable_aen(struct nvme_ctrl *ctrl)
{
1083
	u32 result, supported_aens = ctrl->oaes & NVME_AEN_SUPPORTED;
1084 1085
	int status;

1086 1087 1088 1089 1090
	if (!supported_aens)
		return;

	status = nvme_set_features(ctrl, NVME_FEAT_ASYNC_EVENT, supported_aens,
			NULL, 0, &result);
1091 1092
	if (status)
		dev_warn(ctrl->device, "Failed to configure AEN (cfg %x)\n",
1093
			 supported_aens);
1094 1095
}

1096 1097 1098 1099 1100 1101 1102 1103 1104
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;
1105 1106
	if (io.flags)
		return -EINVAL;
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131

	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 已提交
1132
	c.rw.nsid = cpu_to_le32(ns->head->ns_id);
1133 1134 1135 1136 1137 1138 1139 1140
	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);

1141
	return nvme_submit_user_cmd(ns->queue, &c,
1142 1143 1144 1145
			(void __user *)(uintptr_t)io.addr, length,
			metadata, meta_len, io.slba, NULL, 0);
}

1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
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]);
		if (effects & ~NVME_CMD_EFFECTS_CSUPP)
			dev_warn(ctrl->device,
				 "IO command:%02x has unhandled effects:%08x\n",
				 opcode, effects);
		return 0;
	}

	if (ctrl->effects)
1176
		effects = le32_to_cpu(ctrl->effects->acs[opcode]);
1177 1178 1179 1180 1181 1182 1183 1184
	else
		effects = nvme_known_admin_effects(opcode);

	/*
	 * 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)) {
1185
		mutex_lock(&ctrl->scan_lock);
1186 1187 1188 1189 1190 1191 1192 1193
		nvme_start_freeze(ctrl);
		nvme_wait_freeze(ctrl);
	}
	return effects;
}

static void nvme_update_formats(struct nvme_ctrl *ctrl)
{
1194
	struct nvme_ns *ns;
1195

1196 1197 1198 1199 1200
	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);
1201

1202
	nvme_remove_invalid_namespaces(ctrl, NVME_NSID_ALL);
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
}

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);
1214
	if (effects & (NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_CSE_MASK)) {
1215
		nvme_unfreeze(ctrl);
1216 1217
		mutex_unlock(&ctrl->scan_lock);
	}
1218 1219 1220 1221 1222 1223
	if (effects & NVME_CMD_EFFECTS_CCC)
		nvme_init_identify(ctrl);
	if (effects & (NVME_CMD_EFFECTS_NIC | NVME_CMD_EFFECTS_NCC))
		nvme_queue_scan(ctrl);
}

1224
static int nvme_user_cmd(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
1225 1226 1227 1228 1229
			struct nvme_passthru_cmd __user *ucmd)
{
	struct nvme_passthru_cmd cmd;
	struct nvme_command c;
	unsigned timeout = 0;
1230
	u32 effects;
1231 1232 1233 1234 1235 1236
	int status;

	if (!capable(CAP_SYS_ADMIN))
		return -EACCES;
	if (copy_from_user(&cmd, ucmd, sizeof(cmd)))
		return -EFAULT;
1237 1238
	if (cmd.flags)
		return -EINVAL;
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255

	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[0] = cpu_to_le32(cmd.cdw10);
	c.common.cdw10[1] = cpu_to_le32(cmd.cdw11);
	c.common.cdw10[2] = cpu_to_le32(cmd.cdw12);
	c.common.cdw10[3] = cpu_to_le32(cmd.cdw13);
	c.common.cdw10[4] = cpu_to_le32(cmd.cdw14);
	c.common.cdw10[5] = cpu_to_le32(cmd.cdw15);

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

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

1263 1264 1265 1266 1267 1268 1269 1270
	if (status >= 0) {
		if (put_user(cmd.result, &ucmd->result))
			return -EFAULT;
	}

	return status;
}

1271 1272 1273 1274 1275 1276
/*
 * 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)
1277
{
1278 1279
#ifdef CONFIG_NVME_MULTIPATH
	if (disk->fops == &nvme_ns_head_ops) {
1280 1281
		struct nvme_ns *ns;

1282 1283
		*head = disk->private_data;
		*srcu_idx = srcu_read_lock(&(*head)->srcu);
1284 1285 1286 1287
		ns = nvme_find_path(*head);
		if (!ns)
			srcu_read_unlock(&(*head)->srcu, *srcu_idx);
		return ns;
1288 1289 1290 1291 1292 1293
	}
#endif
	*head = NULL;
	*srcu_idx = -1;
	return disk->private_data;
}
1294

1295 1296 1297 1298 1299
static void nvme_put_ns_from_disk(struct nvme_ns_head *head, int idx)
{
	if (head)
		srcu_read_unlock(&head->srcu, idx);
}
1300

1301 1302
static int nvme_ioctl(struct block_device *bdev, fmode_t mode,
		unsigned int cmd, unsigned long arg)
1303
{
1304
	struct nvme_ns_head *head = NULL;
1305
	void __user *argp = (void __user *)arg;
1306 1307 1308 1309 1310
	struct nvme_ns *ns;
	int srcu_idx, ret;

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

1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
	/*
	 * 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.
	 */
	if (cmd == NVME_IOCTL_ADMIN_CMD || is_sed_ioctl(cmd)) {
		struct nvme_ctrl *ctrl = ns->ctrl;

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

		if (cmd == NVME_IOCTL_ADMIN_CMD)
			ret = nvme_user_cmd(ctrl, NULL, argp);
		else
			ret = sed_ioctl(ctrl->opal_dev, cmd, argp);

		nvme_put_ctrl(ctrl);
		return ret;
	}

1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350
	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;
	default:
		if (ns->ndev)
			ret = nvme_nvm_ioctl(ns, cmd, arg);
		else
			ret = -ENOTTY;
	}

1351 1352
	nvme_put_ns_from_disk(head, srcu_idx);
	return ret;
1353 1354 1355 1356
}

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

1359 1360 1361
#ifdef CONFIG_NVME_MULTIPATH
	/* should never be called due to GENHD_FL_HIDDEN */
	if (WARN_ON_ONCE(ns->head->disk))
1362
		goto fail;
1363
#endif
C
Christoph Hellwig 已提交
1364
	if (!kref_get_unless_zero(&ns->kref))
1365 1366 1367 1368
		goto fail;
	if (!try_module_get(ns->ctrl->ops->module))
		goto fail_put_ns;

C
Christoph Hellwig 已提交
1369
	return 0;
1370 1371 1372 1373 1374

fail_put_ns:
	nvme_put_ns(ns);
fail:
	return -ENXIO;
1375 1376 1377 1378
}

static void nvme_release(struct gendisk *disk, fmode_t mode)
{
1379 1380 1381 1382
	struct nvme_ns *ns = disk->private_data;

	module_put(ns->ctrl->ops->module);
	nvme_put_ns(ns);
1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
}

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
1395
static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type)
1396 1397 1398
{
	struct blk_integrity integrity;

1399
	memset(&integrity, 0, sizeof(integrity));
1400
	switch (pi_type) {
1401 1402
	case NVME_NS_DPS_PI_TYPE3:
		integrity.profile = &t10_pi_type3_crc;
1403 1404
		integrity.tag_size = sizeof(u16) + sizeof(u32);
		integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1405 1406 1407 1408
		break;
	case NVME_NS_DPS_PI_TYPE1:
	case NVME_NS_DPS_PI_TYPE2:
		integrity.profile = &t10_pi_type1_crc;
1409 1410
		integrity.tag_size = sizeof(u16);
		integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1411 1412 1413 1414 1415
		break;
	default:
		integrity.profile = NULL;
		break;
	}
1416 1417 1418
	integrity.tuple_size = ms;
	blk_integrity_register(disk, &integrity);
	blk_queue_max_integrity_segments(disk->queue, 1);
1419 1420
}
#else
1421
static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type)
1422 1423 1424 1425
{
}
#endif /* CONFIG_BLK_DEV_INTEGRITY */

1426 1427 1428 1429 1430 1431
static void nvme_set_chunk_size(struct nvme_ns *ns)
{
	u32 chunk_size = (((u32)ns->noiob) << (ns->lba_shift - 9));
	blk_queue_chunk_sectors(ns->queue, rounddown_pow_of_two(chunk_size));
}

1432
static void nvme_config_discard(struct nvme_ns *ns)
1433
{
1434 1435
	struct nvme_ctrl *ctrl = ns->ctrl;
	struct request_queue *queue = ns->queue;
1436 1437
	u32 size = queue_logical_block_size(queue);

1438 1439 1440 1441 1442 1443 1444
	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;
1445

1446 1447 1448
	BUILD_BUG_ON(PAGE_SIZE / sizeof(struct nvme_dsm_range) <
			NVME_DSM_MAX_RANGES);

1449
	queue->limits.discard_alignment = 0;
1450
	queue->limits.discard_granularity = size;
1451

1452 1453 1454 1455
	/* If discard is already enabled, don't reset queue limits */
	if (blk_queue_flag_test_and_set(QUEUE_FLAG_DISCARD, queue))
		return;

1456 1457
	blk_queue_max_discard_sectors(queue, UINT_MAX);
	blk_queue_max_discard_segments(queue, NVME_DSM_MAX_RANGES);
1458 1459

	if (ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
1460
		blk_queue_max_write_zeroes_sectors(queue, UINT_MAX);
1461 1462
}

1463
static void nvme_report_ns_ids(struct nvme_ctrl *ctrl, unsigned int nsid,
1464
		struct nvme_id_ns *id, struct nvme_ns_ids *ids)
1465
{
1466 1467
	memset(ids, 0, sizeof(*ids));

1468
	if (ctrl->vs >= NVME_VS(1, 1, 0))
1469
		memcpy(ids->eui64, id->eui64, sizeof(id->eui64));
1470
	if (ctrl->vs >= NVME_VS(1, 2, 0))
1471
		memcpy(ids->nguid, id->nguid, sizeof(id->nguid));
1472
	if (ctrl->vs >= NVME_VS(1, 3, 0)) {
1473 1474 1475
		 /* Don't treat error as fatal we potentially
		  * already have a NGUID or EUI-64
		  */
1476
		if (nvme_identify_ns_descs(ctrl, nsid, ids))
1477
			dev_warn(ctrl->device,
1478 1479
				 "%s: Identify Descriptors failed\n", __func__);
	}
1480 1481
}

C
Christoph Hellwig 已提交
1482 1483 1484 1485 1486 1487 1488
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));
}

1489 1490 1491 1492 1493 1494 1495
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;
}

1496 1497 1498 1499
static void nvme_update_disk_info(struct gendisk *disk,
		struct nvme_ns *ns, struct nvme_id_ns *id)
{
	sector_t capacity = le64_to_cpup(&id->nsze) << (ns->lba_shift - 9);
1500
	unsigned short bs = 1 << ns->lba_shift;
1501

1502 1503 1504 1505
	if (ns->lba_shift > PAGE_SHIFT) {
		/* unsupported block size, set capacity to 0 later */
		bs = (1 << 9);
	}
1506 1507 1508
	blk_mq_freeze_queue(disk->queue);
	blk_integrity_unregister(disk);

1509 1510 1511 1512
	blk_queue_logical_block_size(disk->queue, bs);
	blk_queue_physical_block_size(disk->queue, bs);
	blk_queue_io_min(disk->queue, bs);

1513 1514 1515
	if (ns->ms && !ns->ext &&
	    (ns->ctrl->ops->flags & NVME_F_METADATA_SUPPORTED))
		nvme_init_integrity(disk, ns->ms, ns->pi_type);
1516 1517
	if ((ns->ms && !nvme_ns_has_pi(ns) && !blk_get_integrity(disk)) ||
	    ns->lba_shift > PAGE_SHIFT)
1518 1519
		capacity = 0;

1520 1521
	set_capacity(disk, capacity);
	nvme_config_discard(ns);
1522 1523 1524 1525 1526 1527

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

1528 1529 1530
	blk_mq_unfreeze_queue(disk->queue);
}

1531 1532 1533
static void __nvme_revalidate_disk(struct gendisk *disk, struct nvme_id_ns *id)
{
	struct nvme_ns *ns = disk->private_data;
1534 1535 1536 1537 1538

	/*
	 * If identify namespace failed, use default 512 byte block size so
	 * block layer can use before failing read/write for 0 capacity.
	 */
1539
	ns->lba_shift = id->lbaf[id->flbas & NVME_NS_FLBAS_LBA_MASK].ds;
1540 1541
	if (ns->lba_shift == 0)
		ns->lba_shift = 9;
1542
	ns->noiob = le16_to_cpu(id->noiob);
1543
	ns->ms = le16_to_cpu(id->lbaf[id->flbas & NVME_NS_FLBAS_LBA_MASK].ms);
1544
	ns->ext = ns->ms && (id->flbas & NVME_NS_FLBAS_META_EXT);
1545 1546 1547 1548 1549
	/* 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;
1550

1551 1552
	if (ns->noiob)
		nvme_set_chunk_size(ns);
1553
	nvme_update_disk_info(disk, ns, id);
1554 1555
	if (ns->ndev)
		nvme_nvm_update_nvm_info(ns);
1556
#ifdef CONFIG_NVME_MULTIPATH
1557
	if (ns->head->disk) {
1558
		nvme_update_disk_info(ns->head->disk, ns, id);
1559 1560
		blk_queue_stack_limits(ns->head->disk->queue, ns->queue);
	}
1561
#endif
1562
}
1563

1564 1565 1566
static int nvme_revalidate_disk(struct gendisk *disk)
{
	struct nvme_ns *ns = disk->private_data;
1567 1568
	struct nvme_ctrl *ctrl = ns->ctrl;
	struct nvme_id_ns *id;
1569
	struct nvme_ns_ids ids;
1570
	int ret = 0;
1571 1572 1573 1574 1575 1576

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

C
Christoph Hellwig 已提交
1577
	id = nvme_identify_ns(ctrl, ns->head->ns_id);
1578 1579
	if (!id)
		return -ENODEV;
1580

1581 1582 1583 1584
	if (id->ncap == 0) {
		ret = -ENODEV;
		goto out;
	}
1585

1586
	__nvme_revalidate_disk(disk, id);
C
Christoph Hellwig 已提交
1587 1588
	nvme_report_ns_ids(ctrl, ns->head->ns_id, id, &ids);
	if (!nvme_ns_ids_equal(&ns->head->ids, &ids)) {
1589
		dev_err(ctrl->device,
C
Christoph Hellwig 已提交
1590
			"identifiers changed for nsid %d\n", ns->head->ns_id);
1591 1592 1593
		ret = -ENODEV;
	}

1594 1595 1596
out:
	kfree(id);
	return ret;
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621
}

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)
{
1622 1623
	struct nvme_ns_head *head = NULL;
	struct nvme_ns *ns;
1624
	struct nvme_command c;
1625
	int srcu_idx, ret;
1626 1627
	u8 data[16] = { 0, };

1628 1629 1630 1631
	ns = nvme_get_ns_from_disk(bdev->bd_disk, &head, &srcu_idx);
	if (unlikely(!ns))
		return -EWOULDBLOCK;

1632 1633 1634 1635 1636
	put_unaligned_le64(key, &data[0]);
	put_unaligned_le64(sa_key, &data[8]);

	memset(&c, 0, sizeof(c));
	c.common.opcode = op;
1637
	c.common.nsid = cpu_to_le32(ns->head->ns_id);
1638 1639
	c.common.cdw10[0] = cpu_to_le32(cdw10);

1640
	ret = nvme_submit_sync_cmd(ns->queue, &c, data, 16);
1641 1642
	nvme_put_ns_from_disk(head, srcu_idx);
	return ret;
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674
}

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)
{
1675
	u32 cdw10 = nvme_pr_type(type) << 8 | (abort ? 2 : 1);
1676 1677 1678 1679 1680
	return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire);
}

static int nvme_pr_clear(struct block_device *bdev, u64 key)
{
1681
	u32 cdw10 = 1 | (key ? 1 << 3 : 0);
1682 1683 1684 1685 1686
	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)
{
1687
	u32 cdw10 = nvme_pr_type(type) << 8 | (key ? 1 << 3 : 0);
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698
	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,
};

1699
#ifdef CONFIG_BLK_SED_OPAL
1700 1701
int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
		bool send)
1702
{
1703
	struct nvme_ctrl *ctrl = data;
1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
	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;
	cmd.common.cdw10[0] = cpu_to_le32(((u32)secp) << 24 | ((u32)spsp) << 8);
	cmd.common.cdw10[1] = cpu_to_le32(len);

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

1721
static const struct block_device_operations nvme_fops = {
1722 1723
	.owner		= THIS_MODULE,
	.ioctl		= nvme_ioctl,
1724
	.compat_ioctl	= nvme_ioctl,
1725 1726 1727 1728 1729 1730 1731
	.open		= nvme_open,
	.release	= nvme_release,
	.getgeo		= nvme_getgeo,
	.revalidate_disk= nvme_revalidate_disk,
	.pr_ops		= &nvme_pr_ops,
};

1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757
#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 */

1758 1759 1760 1761 1762 1763 1764 1765
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 已提交
1766 1767
		if (csts == ~0)
			return -ENODEV;
1768 1769 1770 1771 1772 1773 1774
		if ((csts & NVME_CSTS_RDY) == bit)
			break;

		msleep(100);
		if (fatal_signal_pending(current))
			return -EINTR;
		if (time_after(jiffies, timeout)) {
1775
			dev_err(ctrl->device,
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800
				"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!
 */
int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap)
{
	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;
1801

1802
	if (ctrl->quirks & NVME_QUIRK_DELAY_BEFORE_CHK_RDY)
1803 1804
		msleep(NVME_QUIRK_DELAY_AMOUNT);

1805 1806
	return nvme_wait_ready(ctrl, cap, false);
}
1807
EXPORT_SYMBOL_GPL(nvme_disable_ctrl);
1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819

int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap)
{
	/*
	 * 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.
	 */
	unsigned dev_page_min = NVME_CAP_MPSMIN(cap) + 12, page_shift = 12;
	int ret;

	if (page_shift < dev_page_min) {
1820
		dev_err(ctrl->device,
1821 1822 1823 1824 1825 1826 1827 1828 1829
			"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;
1830
	ctrl->ctrl_config |= NVME_CC_AMS_RR | NVME_CC_SHN_NONE;
1831 1832 1833 1834 1835 1836 1837 1838
	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;
	return nvme_wait_ready(ctrl, cap, true);
}
1839
EXPORT_SYMBOL_GPL(nvme_enable_ctrl);
1840 1841 1842

int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl)
{
1843
	unsigned long timeout = jiffies + (ctrl->shutdown_timeout * HZ);
1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861
	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)) {
1862
			dev_err(ctrl->device,
1863 1864 1865 1866 1867 1868 1869
				"Device shutdown incomplete; abort shutdown\n");
			return -ENODEV;
		}
	}

	return ret;
}
1870
EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl);
1871

1872 1873 1874
static void nvme_set_queue_limits(struct nvme_ctrl *ctrl,
		struct request_queue *q)
{
1875 1876
	bool vwc = false;

1877
	if (ctrl->max_hw_sectors) {
1878 1879 1880
		u32 max_segments =
			(ctrl->max_hw_sectors / (ctrl->page_size >> 9)) + 1;

1881
		max_segments = min_not_zero(max_segments, ctrl->max_segments);
1882
		blk_queue_max_hw_sectors(q, ctrl->max_hw_sectors);
1883
		blk_queue_max_segments(q, min_t(u32, max_segments, USHRT_MAX));
1884
	}
1885 1886
	if ((ctrl->quirks & NVME_QUIRK_STRIPE_SIZE) &&
	    is_power_of_2(ctrl->max_hw_sectors))
K
Keith Busch 已提交
1887
		blk_queue_chunk_sectors(q, ctrl->max_hw_sectors);
1888
	blk_queue_virt_boundary(q, ctrl->page_size - 1);
1889 1890 1891
	if (ctrl->vwc & NVME_CTRL_VWC_PRESENT)
		vwc = true;
	blk_queue_write_cache(q, vwc, vwc);
1892 1893
}

1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910
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;
}

1911
static int nvme_configure_apst(struct nvme_ctrl *ctrl)
1912 1913 1914 1915 1916 1917 1918 1919
{
	/*
	 * 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 已提交
1920
	 * non-operational state after waiting 50 * (enlat + exlat)
1921
	 * microseconds, as long as that state's exit latency is under
1922 1923 1924 1925 1926 1927 1928 1929 1930
	 * 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;
1931 1932
	u64 max_lat_us = 0;
	int max_ps = -1;
1933 1934 1935 1936 1937 1938 1939
	int ret;

	/*
	 * If APST isn't supported or if we haven't been initialized yet,
	 * then don't do anything.
	 */
	if (!ctrl->apsta)
1940
		return 0;
1941 1942 1943

	if (ctrl->npss > 31) {
		dev_warn(ctrl->device, "NPSS is invalid; not using APST\n");
1944
		return 0;
1945 1946 1947 1948
	}

	table = kzalloc(sizeof(*table), GFP_KERNEL);
	if (!table)
1949
		return 0;
1950

1951
	if (!ctrl->apst_enabled || ctrl->ps_max_latency_us == 0) {
1952 1953
		/* Turn off APST. */
		apste = 0;
1954
		dev_dbg(ctrl->device, "APST disabled\n");
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965
	} 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--) {
1966
			u64 total_latency_us, exit_latency_us, transition_ms;
1967 1968 1969 1970

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

1971 1972 1973 1974 1975 1976 1977 1978
			/*
			 * 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;

1979 1980 1981 1982 1983 1984 1985 1986
			/*
			 * 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;

1987 1988 1989
			exit_latency_us =
				(u64)le32_to_cpu(ctrl->psd[state].exit_lat);
			if (exit_latency_us > ctrl->ps_max_latency_us)
1990 1991
				continue;

1992 1993 1994 1995
			total_latency_us =
				exit_latency_us +
				le32_to_cpu(ctrl->psd[state].entry_lat);

1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006
			/*
			 * 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));
2007 2008 2009 2010 2011 2012

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

			if (total_latency_us > max_lat_us)
				max_lat_us = total_latency_us;
2013 2014 2015
		}

		apste = 1;
2016 2017 2018 2019 2020 2021 2022

		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);
		}
2023 2024 2025 2026 2027 2028 2029 2030
	}

	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);
2031
	return ret;
2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054
}

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

2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067
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[] = {
2068
	{
2069 2070 2071 2072 2073 2074
		/*
		 * 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",
2075
		.quirks = NVME_QUIRK_NO_APST,
2076
	}
2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107
};

/* 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 已提交
2108 2109
static void nvme_init_subnqn(struct nvme_subsystem *subsys, struct nvme_ctrl *ctrl,
		struct nvme_id_ctrl *id)
2110 2111 2112 2113 2114 2115
{
	size_t nqnlen;
	int off;

	nqnlen = strnlen(id->subnqn, NVMF_NQN_SIZE);
	if (nqnlen > 0 && nqnlen < NVMF_NQN_SIZE) {
C
Christoph Hellwig 已提交
2116
		strncpy(subsys->subnqn, id->subnqn, NVMF_NQN_SIZE);
2117 2118 2119 2120 2121 2122 2123
		return;
	}

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

	/* Generate a "fake" NQN per Figure 254 in NVMe 1.3 + ECN 001 */
C
Christoph Hellwig 已提交
2124
	off = snprintf(subsys->subnqn, NVMF_NQN_SIZE,
2125
			"nqn.2014.08.org.nvmexpress:%04x%04x",
2126
			le16_to_cpu(id->vid), le16_to_cpu(id->ssvid));
C
Christoph Hellwig 已提交
2127
	memcpy(subsys->subnqn + off, id->sn, sizeof(id->sn));
2128
	off += sizeof(id->sn);
C
Christoph Hellwig 已提交
2129
	memcpy(subsys->subnqn + off, id->mn, sizeof(id->mn));
2130
	off += sizeof(id->mn);
C
Christoph Hellwig 已提交
2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153
	memset(subsys->subnqn + off, 0, sizeof(subsys->subnqn) - off);
}

static void __nvme_release_subsystem(struct nvme_subsystem *subsys)
{
	ida_simple_remove(&nvme_subsystems_ida, subsys->instance);
	kfree(subsys);
}

static void nvme_release_subsystem(struct device *dev)
{
	__nvme_release_subsystem(container_of(dev, struct nvme_subsystem, dev));
}

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 已提交
2154
	ida_destroy(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180
	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);

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

2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227
#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,
	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,
};

2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243
static int nvme_active_ctrls(struct nvme_subsystem *subsys)
{
	int count = 0;
	struct nvme_ctrl *ctrl;

	mutex_lock(&subsys->lock);
	list_for_each_entry(ctrl, &subsys->ctrls, subsys_entry) {
		if (ctrl->state != NVME_CTRL_DELETING &&
		    ctrl->state != NVME_CTRL_DEAD)
			count++;
	}
	mutex_unlock(&subsys->lock);

	return count;
}

C
Christoph Hellwig 已提交
2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260
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;
	ret = ida_simple_get(&nvme_subsystems_ida, 0, 0, GFP_KERNEL);
	if (ret < 0) {
		kfree(subsys);
		return ret;
	}
	subsys->instance = ret;
	mutex_init(&subsys->lock);
	kref_init(&subsys->ref);
	INIT_LIST_HEAD(&subsys->ctrls);
C
Christoph Hellwig 已提交
2261
	INIT_LIST_HEAD(&subsys->nsheads);
C
Christoph Hellwig 已提交
2262 2263 2264 2265 2266 2267 2268 2269 2270
	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;

	subsys->dev.class = nvme_subsys_class;
	subsys->dev.release = nvme_release_subsystem;
2271
	subsys->dev.groups = nvme_subsys_attrs_groups;
C
Christoph Hellwig 已提交
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281
	dev_set_name(&subsys->dev, "nvme-subsys%d", subsys->instance);
	device_initialize(&subsys->dev);

	mutex_lock(&nvme_subsystems_lock);
	found = __nvme_find_get_subsystem(subsys->subnqn);
	if (found) {
		/*
		 * Verify that the subsystem actually supports multiple
		 * controllers, else bail out.
		 */
2282
		if (!(ctrl->opts && ctrl->opts->discovery_nqn) &&
2283
		    nvme_active_ctrls(found) && !(id->cmic & (1 << 1))) {
C
Christoph Hellwig 已提交
2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300
			dev_err(ctrl->device,
				"ignoring ctrl due to duplicate subnqn (%s).\n",
				found->subnqn);
			nvme_put_subsystem(found);
			ret = -EINVAL;
			goto out_unlock;
		}

		__nvme_release_subsystem(subsys);
		subsys = found;
	} else {
		ret = device_add(&subsys->dev);
		if (ret) {
			dev_err(ctrl->device,
				"failed to register subsystem device.\n");
			goto out_unlock;
		}
C
Christoph Hellwig 已提交
2301
		ida_init(&subsys->ns_ida);
C
Christoph Hellwig 已提交
2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325
		list_add_tail(&subsys->entry, &nvme_subsystems);
	}

	ctrl->subsys = subsys;
	mutex_unlock(&nvme_subsystems_lock);

	if (sysfs_create_link(&subsys->dev.kobj, &ctrl->device->kobj,
			dev_name(ctrl->device))) {
		dev_err(ctrl->device,
			"failed to create sysfs link from subsystem.\n");
		/* the transport driver will eventually put the subsystem */
		return -EINVAL;
	}

	mutex_lock(&subsys->lock);
	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
	mutex_unlock(&subsys->lock);

	return 0;

out_unlock:
	mutex_unlock(&nvme_subsystems_lock);
	put_device(&subsys->dev);
	return ret;
2326 2327
}

2328 2329
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 已提交
2330 2331
{
	struct nvme_command c = { };
2332 2333 2334
	unsigned long dwlen = size / 4 - 1;

	c.get_log_page.opcode = nvme_admin_get_log_page;
2335
	c.get_log_page.nsid = cpu_to_le32(nsid);
2336
	c.get_log_page.lid = log_page;
2337
	c.get_log_page.lsp = lsp;
2338 2339
	c.get_log_page.numdl = cpu_to_le16(dwlen & ((1 << 16) - 1));
	c.get_log_page.numdu = cpu_to_le16(dwlen >> 16);
2340 2341
	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 已提交
2342 2343 2344 2345

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

2346 2347 2348 2349 2350 2351 2352 2353 2354 2355
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;

2356 2357
	ret = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CMD_EFFECTS, 0,
			ctrl->effects, sizeof(*ctrl->effects), 0);
2358 2359 2360 2361 2362
	if (ret) {
		kfree(ctrl->effects);
		ctrl->effects = NULL;
	}
	return ret;
2363 2364
}

2365 2366 2367 2368 2369 2370 2371 2372 2373 2374
/*
 * 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;
	u64 cap;
	int ret, page_shift;
2375
	u32 max_hw_sectors;
2376
	bool prev_apst_enabled;
2377

2378 2379
	ret = ctrl->ops->reg_read32(ctrl, NVME_REG_VS, &ctrl->vs);
	if (ret) {
2380
		dev_err(ctrl->device, "Reading VS failed (%d)\n", ret);
2381 2382 2383
		return ret;
	}

2384 2385
	ret = ctrl->ops->reg_read64(ctrl, NVME_REG_CAP, &cap);
	if (ret) {
2386
		dev_err(ctrl->device, "Reading CAP failed (%d)\n", ret);
2387 2388 2389 2390
		return ret;
	}
	page_shift = NVME_CAP_MPSMIN(cap) + 12;

2391
	if (ctrl->vs >= NVME_VS(1, 1, 0))
2392 2393
		ctrl->subsystem = NVME_CAP_NSSRC(cap);

2394 2395
	ret = nvme_identify_ctrl(ctrl, &id);
	if (ret) {
2396
		dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret);
2397 2398 2399
		return -EIO;
	}

2400 2401 2402
	if (id->lpa & NVME_CTRL_LPA_CMD_EFFECTS_LOG) {
		ret = nvme_get_effects_log(ctrl);
		if (ret < 0)
2403
			goto out_free;
2404
	}
2405

2406
	if (!ctrl->identified) {
C
Christoph Hellwig 已提交
2407 2408 2409 2410 2411 2412
		int i;

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

2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426
		/*
		 * 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;
		}
	}

2427
	if (force_apst && (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) {
2428
		dev_warn(ctrl->device, "forcibly allowing all power states due to nvme_core.force_apst -- use at your own risk\n");
2429 2430 2431
		ctrl->quirks &= ~NVME_QUIRK_NO_DEEPEST_PS;
	}

2432
	ctrl->oacs = le16_to_cpu(id->oacs);
2433
	ctrl->oncs = le16_to_cpup(&id->oncs);
2434
	ctrl->oaes = le32_to_cpu(id->oaes);
2435
	atomic_set(&ctrl->abort_limit, id->acl + 1);
2436
	ctrl->vwc = id->vwc;
M
Ming Lin 已提交
2437
	ctrl->cntlid = le16_to_cpup(&id->cntlid);
2438
	if (id->mdts)
2439
		max_hw_sectors = 1 << (id->mdts + page_shift - 9);
2440
	else
2441 2442 2443
		max_hw_sectors = UINT_MAX;
	ctrl->max_hw_sectors =
		min_not_zero(ctrl->max_hw_sectors, max_hw_sectors);
2444

2445
	nvme_set_queue_limits(ctrl, ctrl->admin_q);
2446
	ctrl->sgls = le32_to_cpu(id->sgls);
S
Sagi Grimberg 已提交
2447
	ctrl->kas = le16_to_cpu(id->kas);
C
Christoph Hellwig 已提交
2448
	ctrl->max_namespaces = le32_to_cpu(id->mnan);
2449

2450 2451 2452 2453 2454 2455 2456 2457
	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)
2458
			dev_info(ctrl->device,
2459 2460 2461 2462 2463
				 "Shutdown timeout set to %u seconds\n",
				 ctrl->shutdown_timeout);
	} else
		ctrl->shutdown_timeout = shutdown_timeout;

2464
	ctrl->npss = id->npss;
2465 2466
	ctrl->apsta = id->apsta;
	prev_apst_enabled = ctrl->apst_enabled;
2467 2468
	if (ctrl->quirks & NVME_QUIRK_NO_APST) {
		if (force_apst && id->apsta) {
2469
			dev_warn(ctrl->device, "forcibly allowing APST due to nvme_core.force_apst -- use at your own risk\n");
2470
			ctrl->apst_enabled = true;
2471
		} else {
2472
			ctrl->apst_enabled = false;
2473 2474
		}
	} else {
2475
		ctrl->apst_enabled = id->apsta;
2476
	}
2477 2478
	memcpy(ctrl->psd, id->psd, sizeof(ctrl->psd));

2479
	if (ctrl->ops->flags & NVME_F_FABRICS) {
2480 2481 2482 2483 2484 2485 2486 2487 2488
		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
		 */
2489
		if (ctrl->cntlid != le16_to_cpu(id->cntlid)) {
2490
			ret = -EINVAL;
2491 2492
			goto out_free;
		}
S
Sagi Grimberg 已提交
2493 2494

		if (!ctrl->opts->discovery_nqn && !ctrl->kas) {
2495
			dev_err(ctrl->device,
S
Sagi Grimberg 已提交
2496 2497
				"keep-alive support is mandatory for fabrics\n");
			ret = -EINVAL;
2498
			goto out_free;
S
Sagi Grimberg 已提交
2499
		}
2500 2501
	} else {
		ctrl->cntlid = le16_to_cpu(id->cntlid);
2502 2503
		ctrl->hmpre = le32_to_cpu(id->hmpre);
		ctrl->hmmin = le32_to_cpu(id->hmmin);
2504 2505
		ctrl->hmminds = le32_to_cpu(id->hmminds);
		ctrl->hmmaxd = le16_to_cpu(id->hmmaxd);
2506
	}
2507

C
Christoph Hellwig 已提交
2508
	ret = nvme_mpath_init(ctrl, id);
2509
	kfree(id);
2510

C
Christoph Hellwig 已提交
2511 2512 2513
	if (ret < 0)
		return ret;

2514
	if (ctrl->apst_enabled && !prev_apst_enabled)
2515
		dev_pm_qos_expose_latency_tolerance(ctrl->device);
2516
	else if (!ctrl->apst_enabled && prev_apst_enabled)
2517 2518
		dev_pm_qos_hide_latency_tolerance(ctrl->device);

2519 2520 2521
	ret = nvme_configure_apst(ctrl);
	if (ret < 0)
		return ret;
2522 2523 2524 2525
	
	ret = nvme_configure_timestamp(ctrl);
	if (ret < 0)
		return ret;
2526 2527 2528 2529

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

2531
	ctrl->identified = true;
2532

2533 2534 2535 2536
	return 0;

out_free:
	kfree(id);
2537
	return ret;
2538
}
2539
EXPORT_SYMBOL_GPL(nvme_init_identify);
2540

2541
static int nvme_dev_open(struct inode *inode, struct file *file)
2542
{
2543 2544
	struct nvme_ctrl *ctrl =
		container_of(inode->i_cdev, struct nvme_ctrl, cdev);
2545

2546 2547 2548 2549 2550
	switch (ctrl->state) {
	case NVME_CTRL_LIVE:
	case NVME_CTRL_ADMIN_ONLY:
		break;
	default:
2551
		return -EWOULDBLOCK;
2552 2553
	}

2554
	file->private_data = ctrl;
2555 2556 2557
	return 0;
}

2558 2559 2560 2561 2562
static int nvme_dev_user_cmd(struct nvme_ctrl *ctrl, void __user *argp)
{
	struct nvme_ns *ns;
	int ret;

2563
	down_read(&ctrl->namespaces_rwsem);
2564 2565 2566 2567 2568 2569 2570
	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)) {
2571
		dev_warn(ctrl->device,
2572 2573 2574 2575 2576
			"NVME_IOCTL_IO_CMD not supported when multiple namespaces present!\n");
		ret = -EINVAL;
		goto out_unlock;
	}

2577
	dev_warn(ctrl->device,
2578 2579
		"using deprecated NVME_IOCTL_IO_CMD ioctl on the char device!\n");
	kref_get(&ns->kref);
2580
	up_read(&ctrl->namespaces_rwsem);
2581 2582 2583 2584 2585 2586

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

out_unlock:
2587
	up_read(&ctrl->namespaces_rwsem);
2588 2589 2590
	return ret;
}

2591 2592 2593 2594 2595 2596 2597 2598 2599 2600
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);
	case NVME_IOCTL_IO_CMD:
2601
		return nvme_dev_user_cmd(ctrl, argp);
2602
	case NVME_IOCTL_RESET:
2603
		dev_warn(ctrl->device, "resetting controller\n");
2604
		return nvme_reset_ctrl_sync(ctrl);
2605 2606
	case NVME_IOCTL_SUBSYS_RESET:
		return nvme_reset_subsystem(ctrl);
K
Keith Busch 已提交
2607 2608 2609
	case NVME_IOCTL_RESCAN:
		nvme_queue_scan(ctrl);
		return 0;
2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628
	default:
		return -ENOTTY;
	}
}

static const struct file_operations nvme_dev_fops = {
	.owner		= THIS_MODULE,
	.open		= nvme_dev_open,
	.unlocked_ioctl	= nvme_dev_ioctl,
	.compat_ioctl	= nvme_dev_ioctl,
};

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;

2629
	ret = nvme_reset_ctrl_sync(ctrl);
2630 2631 2632
	if (ret < 0)
		return ret;
	return count;
2633
}
2634
static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset);
2635

K
Keith Busch 已提交
2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646
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);

2647 2648 2649 2650 2651 2652 2653 2654 2655 2656
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;
}

2657
static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
2658
		char *buf)
2659
{
2660 2661 2662
	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 已提交
2663 2664
	int serial_len = sizeof(subsys->serial);
	int model_len = sizeof(subsys->model);
2665

2666 2667
	if (!uuid_is_null(&ids->uuid))
		return sprintf(buf, "uuid.%pU\n", &ids->uuid);
2668

2669 2670
	if (memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
		return sprintf(buf, "eui.%16phN\n", ids->nguid);
2671

2672 2673
	if (memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
		return sprintf(buf, "eui.%8phN\n", ids->eui64);
2674

C
Christoph Hellwig 已提交
2675 2676
	while (serial_len > 0 && (subsys->serial[serial_len - 1] == ' ' ||
				  subsys->serial[serial_len - 1] == '\0'))
2677
		serial_len--;
C
Christoph Hellwig 已提交
2678 2679
	while (model_len > 0 && (subsys->model[model_len - 1] == ' ' ||
				 subsys->model[model_len - 1] == '\0'))
2680 2681
		model_len--;

C
Christoph Hellwig 已提交
2682 2683
	return sprintf(buf, "nvme.%04x-%*phN-%*phN-%08x\n", subsys->vendor_id,
		serial_len, subsys->serial, model_len, subsys->model,
2684
		head->ns_id);
2685
}
J
Joe Perches 已提交
2686
static DEVICE_ATTR_RO(wwid);
2687

2688
static ssize_t nguid_show(struct device *dev, struct device_attribute *attr,
2689
		char *buf)
2690
{
2691
	return sprintf(buf, "%pU\n", dev_to_ns_head(dev)->ids.nguid);
2692
}
J
Joe Perches 已提交
2693
static DEVICE_ATTR_RO(nguid);
2694

2695
static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
2696
		char *buf)
2697
{
2698
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
2699 2700 2701 2702

	/* For backward compatibility expose the NGUID to userspace if
	 * we have no UUID set
	 */
2703
	if (uuid_is_null(&ids->uuid)) {
2704 2705
		printk_ratelimited(KERN_WARNING
				   "No UUID available providing old NGUID\n");
2706
		return sprintf(buf, "%pU\n", ids->nguid);
2707
	}
2708
	return sprintf(buf, "%pU\n", &ids->uuid);
2709
}
J
Joe Perches 已提交
2710
static DEVICE_ATTR_RO(uuid);
2711 2712

static ssize_t eui_show(struct device *dev, struct device_attribute *attr,
2713
		char *buf)
2714
{
2715
	return sprintf(buf, "%8ph\n", dev_to_ns_head(dev)->ids.eui64);
2716
}
J
Joe Perches 已提交
2717
static DEVICE_ATTR_RO(eui);
2718 2719

static ssize_t nsid_show(struct device *dev, struct device_attribute *attr,
2720
		char *buf)
2721
{
2722
	return sprintf(buf, "%d\n", dev_to_ns_head(dev)->ns_id);
2723
}
J
Joe Perches 已提交
2724
static DEVICE_ATTR_RO(nsid);
2725

2726
static struct attribute *nvme_ns_id_attrs[] = {
2727
	&dev_attr_wwid.attr,
2728
	&dev_attr_uuid.attr,
2729
	&dev_attr_nguid.attr,
2730 2731
	&dev_attr_eui.attr,
	&dev_attr_nsid.attr,
C
Christoph Hellwig 已提交
2732 2733 2734 2735
#ifdef CONFIG_NVME_MULTIPATH
	&dev_attr_ana_grpid.attr,
	&dev_attr_ana_state.attr,
#endif
2736 2737 2738
	NULL,
};

2739
static umode_t nvme_ns_id_attrs_are_visible(struct kobject *kobj,
2740 2741 2742
		struct attribute *a, int n)
{
	struct device *dev = container_of(kobj, struct device, kobj);
2743
	struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids;
2744 2745

	if (a == &dev_attr_uuid.attr) {
2746
		if (uuid_is_null(&ids->uuid) &&
2747
		    !memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
2748 2749 2750
			return 0;
	}
	if (a == &dev_attr_nguid.attr) {
2751
		if (!memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
2752 2753 2754
			return 0;
	}
	if (a == &dev_attr_eui.attr) {
2755
		if (!memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
2756 2757
			return 0;
	}
C
Christoph Hellwig 已提交
2758 2759 2760 2761 2762 2763 2764 2765
#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
2766 2767 2768
	return a->mode;
}

2769 2770 2771
const struct attribute_group nvme_ns_id_attr_group = {
	.attrs		= nvme_ns_id_attrs,
	.is_visible	= nvme_ns_id_attrs_are_visible,
2772 2773
};

M
Ming Lin 已提交
2774
#define nvme_show_str_function(field)						\
2775 2776 2777 2778
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 已提交
2779 2780
        return sprintf(buf, "%.*s\n",						\
		(int)sizeof(ctrl->subsys->field), ctrl->subsys->field);		\
2781 2782 2783
}										\
static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);

C
Christoph Hellwig 已提交
2784 2785 2786 2787
nvme_show_str_function(model);
nvme_show_str_function(serial);
nvme_show_str_function(firmware_rev);

M
Ming Lin 已提交
2788 2789 2790 2791 2792 2793 2794 2795 2796 2797
#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);
2798

M
Ming Lin 已提交
2799 2800 2801 2802 2803 2804 2805
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))
2806
		nvme_delete_ctrl_sync(ctrl);
M
Ming Lin 已提交
2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820
	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);

2821 2822 2823 2824 2825 2826 2827 2828
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",
2829
		[NVME_CTRL_ADMIN_ONLY]	= "only-admin",
2830
		[NVME_CTRL_RESETTING]	= "resetting",
2831
		[NVME_CTRL_CONNECTING]	= "connecting",
2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844
		[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 已提交
2845 2846 2847 2848 2849 2850
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 已提交
2851
	return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->subsys->subnqn);
M
Ming Lin 已提交
2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864
}
static DEVICE_ATTR(subsysnqn, S_IRUGO, nvme_sysfs_show_subsysnqn, NULL);

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

2865 2866
static struct attribute *nvme_dev_attrs[] = {
	&dev_attr_reset_controller.attr,
K
Keith Busch 已提交
2867
	&dev_attr_rescan_controller.attr,
2868 2869 2870
	&dev_attr_model.attr,
	&dev_attr_serial.attr,
	&dev_attr_firmware_rev.attr,
M
Ming Lin 已提交
2871
	&dev_attr_cntlid.attr,
M
Ming Lin 已提交
2872 2873 2874 2875
	&dev_attr_delete_controller.attr,
	&dev_attr_transport.attr,
	&dev_attr_subsysnqn.attr,
	&dev_attr_address.attr,
2876
	&dev_attr_state.attr,
2877 2878 2879
	NULL
};

M
Ming Lin 已提交
2880 2881 2882 2883 2884 2885
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);

2886 2887 2888 2889
	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;
M
Ming Lin 已提交
2890 2891 2892 2893

	return a->mode;
}

2894
static struct attribute_group nvme_dev_attrs_group = {
M
Ming Lin 已提交
2895 2896
	.attrs		= nvme_dev_attrs,
	.is_visible	= nvme_dev_attrs_are_visible,
2897 2898 2899 2900 2901 2902 2903
};

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

C
Christoph Hellwig 已提交
2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927
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) &&
2928
		    !list_empty(&h->list) &&
C
Christoph Hellwig 已提交
2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949
		    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;
	int ret = -ENOMEM;

	head = kzalloc(sizeof(*head), GFP_KERNEL);
	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);
2950 2951 2952
	ret = init_srcu_struct(&head->srcu);
	if (ret)
		goto out_ida_remove;
C
Christoph Hellwig 已提交
2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965
	head->subsys = ctrl->subsys;
	head->ns_id = nsid;
	kref_init(&head->ref);

	nvme_report_ns_ids(ctrl, nsid, id, &head->ids);

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

2966 2967 2968 2969
	ret = nvme_mpath_alloc_disk(ctrl, head);
	if (ret)
		goto out_cleanup_srcu;

C
Christoph Hellwig 已提交
2970
	list_add_tail(&head->entry, &ctrl->subsys->nsheads);
2971 2972 2973

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

C
Christoph Hellwig 已提交
2974 2975 2976
	return head;
out_cleanup_srcu:
	cleanup_srcu_struct(&head->srcu);
2977
out_ida_remove:
C
Christoph Hellwig 已提交
2978 2979 2980 2981 2982 2983 2984 2985
	ida_simple_remove(&ctrl->subsys->ns_ida, head->instance);
out_free_head:
	kfree(head);
out:
	return ERR_PTR(ret);
}

static int nvme_init_ns_head(struct nvme_ns *ns, unsigned nsid,
2986
		struct nvme_id_ns *id)
C
Christoph Hellwig 已提交
2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022
{
	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;

		nvme_report_ns_ids(ctrl, nsid, id, &ids);
		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);
	return ret;
}

3023 3024 3025 3026 3027
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 已提交
3028
	return nsa->head->ns_id - nsb->head->ns_id;
3029 3030
}

3031
static struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid)
3032
{
3033
	struct nvme_ns *ns, *ret = NULL;
3034

3035
	down_read(&ctrl->namespaces_rwsem);
3036
	list_for_each_entry(ns, &ctrl->namespaces, list) {
C
Christoph Hellwig 已提交
3037
		if (ns->head->ns_id == nsid) {
3038 3039
			if (!kref_get_unless_zero(&ns->kref))
				continue;
3040 3041 3042
			ret = ns;
			break;
		}
C
Christoph Hellwig 已提交
3043
		if (ns->head->ns_id > nsid)
3044 3045
			break;
	}
3046
	up_read(&ctrl->namespaces_rwsem);
3047
	return ret;
3048 3049
}

3050 3051 3052 3053 3054 3055 3056 3057
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 已提交
3058
	ret = nvme_get_stream_params(ctrl, &s, ns->head->ns_id);
3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075
	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;
}

3076 3077 3078 3079
static void nvme_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid)
{
	struct nvme_ns *ns;
	struct gendisk *disk;
3080 3081
	struct nvme_id_ns *id;
	char disk_name[DISK_NAME_LEN];
3082
	int node = dev_to_node(ctrl->dev), flags = GENHD_FL_EXT_DEVT;
3083 3084 3085 3086 3087 3088 3089

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

	ns->queue = blk_mq_init_queue(ctrl->tagset);
	if (IS_ERR(ns->queue))
C
Christoph Hellwig 已提交
3090
		goto out_free_ns;
3091
	blk_queue_flag_set(QUEUE_FLAG_NONROT, ns->queue);
3092 3093 3094 3095 3096 3097 3098
	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);
3099
	nvme_set_queue_limits(ctrl, ns->queue);
3100

3101 3102
	id = nvme_identify_ns(ctrl, nsid);
	if (!id)
3103 3104
		goto out_free_queue;

3105 3106 3107
	if (id->ncap == 0)
		goto out_free_id;

3108
	if (nvme_init_ns_head(ns, nsid, id))
C
Christoph Hellwig 已提交
3109
		goto out_free_id;
3110
	nvme_setup_streams_ns(ctrl, ns);
3111
	nvme_set_disk_name(disk_name, ns, ctrl, &flags);
3112

C
Christoph Hellwig 已提交
3113 3114 3115
	if ((ctrl->quirks & NVME_QUIRK_LIGHTNVM) && id->vs[0] == 0x1) {
		if (nvme_nvm_register(ns, disk_name, node)) {
			dev_warn(ctrl->device, "LightNVM init failure\n");
C
Christoph Hellwig 已提交
3116
			goto out_unlink_ns;
C
Christoph Hellwig 已提交
3117
		}
3118
	}
3119

3120 3121
	disk = alloc_disk_node(0, node);
	if (!disk)
C
Christoph Hellwig 已提交
3122
		goto out_unlink_ns;
3123

3124 3125 3126
	disk->fops = &nvme_fops;
	disk->private_data = ns;
	disk->queue = ns->queue;
3127
	disk->flags = flags;
3128 3129 3130 3131
	memcpy(disk->disk_name, disk_name, DISK_NAME_LEN);
	ns->disk = disk;

	__nvme_revalidate_disk(disk, id);
3132

3133
	down_write(&ctrl->namespaces_rwsem);
3134
	list_add_tail(&ns->list, &ctrl->namespaces);
3135
	up_write(&ctrl->namespaces_rwsem);
3136

3137
	nvme_get_ctrl(ctrl);
3138

3139
	device_add_disk(ctrl->device, ns->disk);
3140
	if (sysfs_create_group(&disk_to_dev(ns->disk)->kobj,
3141
					&nvme_ns_id_attr_group))
3142 3143
		pr_warn("%s: failed to create sysfs group for identification\n",
			ns->disk->disk_name);
3144 3145 3146
	if (ns->ndev && nvme_nvm_register_sysfs(ns))
		pr_warn("%s: failed to register lightnvm sysfs group for identification\n",
			ns->disk->disk_name);
3147

C
Christoph Hellwig 已提交
3148
	nvme_mpath_add_disk(ns, id);
T
Thomas Tai 已提交
3149
	nvme_fault_inject_init(ns);
C
Christoph Hellwig 已提交
3150 3151
	kfree(id);

3152
	return;
C
Christoph Hellwig 已提交
3153 3154 3155 3156
 out_unlink_ns:
	mutex_lock(&ctrl->subsys->lock);
	list_del_rcu(&ns->siblings);
	mutex_unlock(&ctrl->subsys->lock);
3157 3158
 out_free_id:
	kfree(id);
3159 3160 3161 3162 3163 3164 3165 3166
 out_free_queue:
	blk_cleanup_queue(ns->queue);
 out_free_ns:
	kfree(ns);
}

static void nvme_ns_remove(struct nvme_ns *ns)
{
3167 3168
	if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
		return;
3169

T
Thomas Tai 已提交
3170
	nvme_fault_inject_fini(ns);
3171
	if (ns->disk && ns->disk->flags & GENHD_FL_UP) {
3172
		sysfs_remove_group(&disk_to_dev(ns->disk)->kobj,
3173
					&nvme_ns_id_attr_group);
3174 3175
		if (ns->ndev)
			nvme_nvm_unregister_sysfs(ns);
3176 3177
		del_gendisk(ns->disk);
		blk_cleanup_queue(ns->queue);
3178 3179
		if (blk_get_integrity(ns->disk))
			blk_integrity_unregister(ns->disk);
3180
	}
3181

C
Christoph Hellwig 已提交
3182
	mutex_lock(&ns->ctrl->subsys->lock);
3183
	list_del_rcu(&ns->siblings);
3184
	nvme_mpath_clear_current_path(ns);
C
Christoph Hellwig 已提交
3185 3186
	mutex_unlock(&ns->ctrl->subsys->lock);

3187
	down_write(&ns->ctrl->namespaces_rwsem);
3188
	list_del_init(&ns->list);
3189
	up_write(&ns->ctrl->namespaces_rwsem);
3190

3191
	synchronize_srcu(&ns->head->srcu);
3192
	nvme_mpath_check_last_path(ns);
3193 3194 3195
	nvme_put_ns(ns);
}

3196 3197 3198 3199
static void nvme_validate_ns(struct nvme_ctrl *ctrl, unsigned nsid)
{
	struct nvme_ns *ns;

3200
	ns = nvme_find_get_ns(ctrl, nsid);
3201
	if (ns) {
3202
		if (ns->disk && revalidate_disk(ns->disk))
3203
			nvme_ns_remove(ns);
3204
		nvme_put_ns(ns);
3205 3206 3207 3208
	} else
		nvme_alloc_ns(ctrl, nsid);
}

3209 3210 3211 3212
static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
					unsigned nsid)
{
	struct nvme_ns *ns, *next;
3213
	LIST_HEAD(rm_list);
3214

3215
	down_write(&ctrl->namespaces_rwsem);
3216
	list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) {
3217
		if (ns->head->ns_id > nsid || test_bit(NVME_NS_DEAD, &ns->flags))
3218
			list_move_tail(&ns->list, &rm_list);
3219
	}
3220
	up_write(&ctrl->namespaces_rwsem);
3221 3222 3223 3224

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

3225 3226
}

3227 3228 3229 3230
static int nvme_scan_ns_list(struct nvme_ctrl *ctrl, unsigned nn)
{
	struct nvme_ns *ns;
	__le32 *ns_list;
3231 3232
	unsigned i, j, nsid, prev = 0;
	unsigned num_lists = DIV_ROUND_UP_ULL((u64)nn, 1024);
3233 3234
	int ret = 0;

3235
	ns_list = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
3236 3237 3238 3239 3240 3241
	if (!ns_list)
		return -ENOMEM;

	for (i = 0; i < num_lists; i++) {
		ret = nvme_identify_ns_list(ctrl, prev, ns_list);
		if (ret)
3242
			goto free;
3243 3244 3245 3246 3247 3248 3249 3250 3251

		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) {
3252 3253
				ns = nvme_find_get_ns(ctrl, prev);
				if (ns) {
3254
					nvme_ns_remove(ns);
3255 3256
					nvme_put_ns(ns);
				}
3257 3258 3259 3260 3261
			}
		}
		nn -= j;
	}
 out:
3262 3263
	nvme_remove_invalid_namespaces(ctrl, prev);
 free:
3264 3265 3266 3267
	kfree(ns_list);
	return ret;
}

3268
static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl, unsigned nn)
3269 3270 3271
{
	unsigned i;

3272 3273 3274
	for (i = 1; i <= nn; i++)
		nvme_validate_ns(ctrl, i);

3275
	nvme_remove_invalid_namespaces(ctrl, nn);
3276 3277
}

3278
static void nvme_clear_changed_ns_log(struct nvme_ctrl *ctrl)
3279 3280 3281
{
	size_t log_size = NVME_MAX_CHANGED_NAMESPACES * sizeof(__le32);
	__le32 *log;
3282
	int error;
3283 3284 3285

	log = kzalloc(log_size, GFP_KERNEL);
	if (!log)
3286
		return;
3287

3288 3289 3290 3291 3292 3293
	/*
	 * 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.
	 */
3294 3295
	error = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CHANGED_NS, 0, log,
			log_size, 0);
3296
	if (error)
3297 3298 3299 3300 3301 3302
		dev_warn(ctrl->device,
			"reading changed ns log failed: %d\n", error);

	kfree(log);
}

3303
static void nvme_scan_work(struct work_struct *work)
3304
{
3305 3306
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, scan_work);
3307
	struct nvme_id_ctrl *id;
3308
	unsigned nn;
3309

3310 3311 3312
	if (ctrl->state != NVME_CTRL_LIVE)
		return;

3313 3314
	WARN_ON_ONCE(!ctrl->tagset);

D
Dan Carpenter 已提交
3315
	if (test_and_clear_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events)) {
3316
		dev_info(ctrl->device, "rescanning namespaces.\n");
3317
		nvme_clear_changed_ns_log(ctrl);
3318 3319
	}

3320 3321
	if (nvme_identify_ctrl(ctrl, &id))
		return;
3322

3323
	mutex_lock(&ctrl->scan_lock);
3324
	nn = le32_to_cpu(id->nn);
3325
	if (ctrl->vs >= NVME_VS(1, 1, 0) &&
3326 3327
	    !(ctrl->quirks & NVME_QUIRK_IDENTIFY_CNS)) {
		if (!nvme_scan_ns_list(ctrl, nn))
3328
			goto out_free_id;
3329
	}
3330
	nvme_scan_ns_sequential(ctrl, nn);
3331
out_free_id:
3332
	mutex_unlock(&ctrl->scan_lock);
3333
	kfree(id);
3334
	down_write(&ctrl->namespaces_rwsem);
3335
	list_sort(NULL, &ctrl->namespaces, ns_cmp);
3336
	up_write(&ctrl->namespaces_rwsem);
3337
}
3338

3339 3340 3341 3342 3343
/*
 * 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.
 */
3344 3345 3346
void nvme_remove_namespaces(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns, *next;
3347
	LIST_HEAD(ns_list);
3348

3349 3350 3351
	/* prevent racing with ns scanning */
	flush_work(&ctrl->scan_work);

3352 3353 3354 3355 3356 3357 3358 3359 3360
	/*
	 * 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);

3361
	down_write(&ctrl->namespaces_rwsem);
3362
	list_splice_init(&ctrl->namespaces, &ns_list);
3363
	up_write(&ctrl->namespaces_rwsem);
3364 3365

	list_for_each_entry_safe(ns, next, &ns_list, list)
3366 3367
		nvme_ns_remove(ns);
}
3368
EXPORT_SYMBOL_GPL(nvme_remove_namespaces);
3369

3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385
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]);
}

3386 3387 3388 3389 3390
static void nvme_async_event_work(struct work_struct *work)
{
	struct nvme_ctrl *ctrl =
		container_of(work, struct nvme_ctrl, async_event_work);

3391
	nvme_aen_uevent(ctrl);
3392
	ctrl->ops->submit_async_event(ctrl);
3393 3394
}

3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416
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;

3417 3418 3419
	if (nvme_get_log(ctrl, NVME_NSID_ALL, 0, NVME_LOG_FW_SLOT, log,
			sizeof(*log), 0))
		dev_warn(ctrl->device, "Get FW SLOT INFO log error\n");
3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450
	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");
			nvme_reset_ctrl(ctrl);
			break;
		}
		msleep(100);
	}

	if (ctrl->state != NVME_CTRL_LIVE)
		return;

	nvme_start_queues(ctrl);
3451
	/* read FW slot information to clear the AER */
3452 3453 3454
	nvme_get_fw_slot_info(ctrl);
}

3455 3456 3457 3458
static void nvme_handle_aen_notice(struct nvme_ctrl *ctrl, u32 result)
{
	switch ((result & 0xff00) >> 8) {
	case NVME_AER_NOTICE_NS_CHANGED:
D
Dan Carpenter 已提交
3459
		set_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events);
3460 3461 3462 3463 3464
		nvme_queue_scan(ctrl);
		break;
	case NVME_AER_NOTICE_FW_ACT_STARTING:
		queue_work(nvme_wq, &ctrl->fw_act_work);
		break;
C
Christoph Hellwig 已提交
3465 3466 3467 3468 3469 3470 3471
#ifdef CONFIG_NVME_MULTIPATH
	case NVME_AER_NOTICE_ANA:
		if (!ctrl->ana_log_buf)
			break;
		queue_work(nvme_wq, &ctrl->ana_work);
		break;
#endif
3472 3473 3474 3475 3476
	default:
		dev_warn(ctrl->device, "async event result %08x\n", result);
	}
}

3477
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
3478
		volatile union nvme_result *res)
3479
{
3480
	u32 result = le32_to_cpu(res->u32);
3481

3482
	if (le16_to_cpu(status) >> 1 != NVME_SC_SUCCESS)
3483 3484
		return;

3485
	switch (result & 0x7) {
3486 3487 3488
	case NVME_AER_NOTICE:
		nvme_handle_aen_notice(ctrl, result);
		break;
3489 3490 3491 3492 3493
	case NVME_AER_ERROR:
	case NVME_AER_SMART:
	case NVME_AER_CSS:
	case NVME_AER_VS:
		ctrl->aen_result = result;
3494 3495 3496
		break;
	default:
		break;
3497
	}
3498
	queue_work(nvme_wq, &ctrl->async_event_work);
3499 3500
}
EXPORT_SYMBOL_GPL(nvme_complete_async_event);
3501

3502
void nvme_stop_ctrl(struct nvme_ctrl *ctrl)
3503
{
C
Christoph Hellwig 已提交
3504
	nvme_mpath_stop(ctrl);
3505
	nvme_stop_keep_alive(ctrl);
3506
	flush_work(&ctrl->async_event_work);
3507
	cancel_work_sync(&ctrl->fw_act_work);
3508 3509
	if (ctrl->ops->stop_ctrl)
		ctrl->ops->stop_ctrl(ctrl);
3510 3511 3512 3513 3514 3515 3516 3517 3518 3519
}
EXPORT_SYMBOL_GPL(nvme_stop_ctrl);

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

	if (ctrl->queue_count > 1) {
		nvme_queue_scan(ctrl);
3520
		nvme_enable_aen(ctrl);
3521
		queue_work(nvme_wq, &ctrl->async_event_work);
3522 3523 3524 3525
		nvme_start_queues(ctrl);
	}
}
EXPORT_SYMBOL_GPL(nvme_start_ctrl);
3526

3527 3528
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl)
{
3529
	dev_pm_qos_hide_latency_tolerance(ctrl->device);
3530
	cdev_device_del(&ctrl->cdev, ctrl->device);
3531
}
3532
EXPORT_SYMBOL_GPL(nvme_uninit_ctrl);
3533

3534
static void nvme_free_ctrl(struct device *dev)
3535
{
3536 3537
	struct nvme_ctrl *ctrl =
		container_of(dev, struct nvme_ctrl, ctrl_device);
C
Christoph Hellwig 已提交
3538
	struct nvme_subsystem *subsys = ctrl->subsys;
3539

3540
	ida_simple_remove(&nvme_instance_ida, ctrl->instance);
3541
	kfree(ctrl->effects);
C
Christoph Hellwig 已提交
3542
	nvme_mpath_uninit(ctrl);
3543

C
Christoph Hellwig 已提交
3544 3545 3546 3547 3548 3549
	if (subsys) {
		mutex_lock(&subsys->lock);
		list_del(&ctrl->subsys_entry);
		mutex_unlock(&subsys->lock);
		sysfs_remove_link(&subsys->dev.kobj, dev_name(ctrl->device));
	}
3550 3551 3552

	ctrl->ops->free_ctrl(ctrl);

C
Christoph Hellwig 已提交
3553 3554
	if (subsys)
		nvme_put_subsystem(subsys);
3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566
}

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

3567 3568
	ctrl->state = NVME_CTRL_NEW;
	spin_lock_init(&ctrl->lock);
3569
	mutex_init(&ctrl->scan_lock);
3570
	INIT_LIST_HEAD(&ctrl->namespaces);
3571
	init_rwsem(&ctrl->namespaces_rwsem);
3572 3573 3574
	ctrl->dev = dev;
	ctrl->ops = ops;
	ctrl->quirks = quirks;
3575
	INIT_WORK(&ctrl->scan_work, nvme_scan_work);
3576
	INIT_WORK(&ctrl->async_event_work, nvme_async_event_work);
3577
	INIT_WORK(&ctrl->fw_act_work, nvme_fw_act_work);
3578
	INIT_WORK(&ctrl->delete_work, nvme_delete_ctrl_work);
3579

3580 3581 3582 3583
	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;

3584 3585
	ret = ida_simple_get(&nvme_instance_ida, 0, 0, GFP_KERNEL);
	if (ret < 0)
3586
		goto out;
3587
	ctrl->instance = ret;
3588

3589 3590
	device_initialize(&ctrl->ctrl_device);
	ctrl->device = &ctrl->ctrl_device;
3591
	ctrl->device->devt = MKDEV(MAJOR(nvme_chr_devt), ctrl->instance);
3592 3593 3594 3595 3596 3597 3598
	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)
3599 3600
		goto out_release_instance;

3601 3602 3603
	cdev_init(&ctrl->cdev, &nvme_dev_fops);
	ctrl->cdev.owner = ops->module;
	ret = cdev_device_add(&ctrl->cdev, ctrl->device);
3604 3605
	if (ret)
		goto out_free_name;
3606

3607 3608 3609 3610 3611 3612 3613 3614
	/*
	 * 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));

3615
	return 0;
3616 3617
out_free_name:
	kfree_const(dev->kobj.name);
3618
out_release_instance:
3619
	ida_simple_remove(&nvme_instance_ida, ctrl->instance);
3620 3621 3622
out:
	return ret;
}
3623
EXPORT_SYMBOL_GPL(nvme_init_ctrl);
3624

3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635
/**
 * 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;

3636
	down_read(&ctrl->namespaces_rwsem);
M
Ming Lei 已提交
3637

3638
	/* Forcibly unquiesce queues to avoid blocking dispatch */
3639 3640
	if (ctrl->admin_q)
		blk_mq_unquiesce_queue(ctrl->admin_q);
3641

3642 3643
	list_for_each_entry(ns, &ctrl->namespaces, list)
		nvme_set_queue_dying(ns);
3644

3645
	up_read(&ctrl->namespaces_rwsem);
3646
}
3647
EXPORT_SYMBOL_GPL(nvme_kill_queues);
3648

K
Keith Busch 已提交
3649 3650 3651 3652
void nvme_unfreeze(struct nvme_ctrl *ctrl)
{
	struct nvme_ns *ns;

3653
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
3654 3655
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_unfreeze_queue(ns->queue);
3656
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
3657 3658 3659 3660 3661 3662 3663
}
EXPORT_SYMBOL_GPL(nvme_unfreeze);

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

3664
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
3665 3666 3667 3668 3669
	list_for_each_entry(ns, &ctrl->namespaces, list) {
		timeout = blk_mq_freeze_queue_wait_timeout(ns->queue, timeout);
		if (timeout <= 0)
			break;
	}
3670
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
3671 3672 3673 3674 3675 3676 3677
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze_timeout);

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

3678
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
3679 3680
	list_for_each_entry(ns, &ctrl->namespaces, list)
		blk_mq_freeze_queue_wait(ns->queue);
3681
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
3682 3683 3684 3685 3686 3687 3688
}
EXPORT_SYMBOL_GPL(nvme_wait_freeze);

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

3689
	down_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
3690
	list_for_each_entry(ns, &ctrl->namespaces, list)
3691
		blk_freeze_queue_start(ns->queue);
3692
	up_read(&ctrl->namespaces_rwsem);
K
Keith Busch 已提交
3693 3694 3695
}
EXPORT_SYMBOL_GPL(nvme_start_freeze);

3696
void nvme_stop_queues(struct nvme_ctrl *ctrl)
3697 3698 3699
{
	struct nvme_ns *ns;

3700
	down_read(&ctrl->namespaces_rwsem);
3701
	list_for_each_entry(ns, &ctrl->namespaces, list)
3702
		blk_mq_quiesce_queue(ns->queue);
3703
	up_read(&ctrl->namespaces_rwsem);
3704
}
3705
EXPORT_SYMBOL_GPL(nvme_stop_queues);
3706

3707
void nvme_start_queues(struct nvme_ctrl *ctrl)
3708 3709 3710
{
	struct nvme_ns *ns;

3711
	down_read(&ctrl->namespaces_rwsem);
3712
	list_for_each_entry(ns, &ctrl->namespaces, list)
3713
		blk_mq_unquiesce_queue(ns->queue);
3714
	up_read(&ctrl->namespaces_rwsem);
3715
}
3716
EXPORT_SYMBOL_GPL(nvme_start_queues);
3717

3718 3719
int __init nvme_core_init(void)
{
3720
	int result = -ENOMEM;
3721

3722 3723 3724
	nvme_wq = alloc_workqueue("nvme-wq",
			WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0);
	if (!nvme_wq)
3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735
		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;
3736

3737
	result = alloc_chrdev_region(&nvme_chr_devt, 0, NVME_MINORS, "nvme");
3738
	if (result < 0)
3739
		goto destroy_delete_wq;
3740 3741 3742 3743 3744 3745 3746

	nvme_class = class_create(THIS_MODULE, "nvme");
	if (IS_ERR(nvme_class)) {
		result = PTR_ERR(nvme_class);
		goto unregister_chrdev;
	}

C
Christoph Hellwig 已提交
3747 3748 3749 3750 3751
	nvme_subsys_class = class_create(THIS_MODULE, "nvme-subsystem");
	if (IS_ERR(nvme_subsys_class)) {
		result = PTR_ERR(nvme_subsys_class);
		goto destroy_class;
	}
3752
	return 0;
3753

C
Christoph Hellwig 已提交
3754 3755
destroy_class:
	class_destroy(nvme_class);
3756
unregister_chrdev:
3757
	unregister_chrdev_region(nvme_chr_devt, NVME_MINORS);
3758 3759 3760 3761
destroy_delete_wq:
	destroy_workqueue(nvme_delete_wq);
destroy_reset_wq:
	destroy_workqueue(nvme_reset_wq);
3762 3763
destroy_wq:
	destroy_workqueue(nvme_wq);
3764
out:
3765
	return result;
3766 3767 3768 3769
}

void nvme_core_exit(void)
{
C
Christoph Hellwig 已提交
3770 3771
	ida_destroy(&nvme_subsystems_ida);
	class_destroy(nvme_subsys_class);
3772
	class_destroy(nvme_class);
3773
	unregister_chrdev_region(nvme_chr_devt, NVME_MINORS);
3774 3775
	destroy_workqueue(nvme_delete_wq);
	destroy_workqueue(nvme_reset_wq);
3776
	destroy_workqueue(nvme_wq);
3777
}
3778 3779 3780 3781 3782

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