xref: /linux/drivers/nvme/host/core.c (revision 7fe6ac157b7e15c8976bd62ad7cb98e248884e83)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * NVM Express device driver
4  * Copyright (c) 2011-2014, Intel Corporation.
5  */
6 
7 #include <linux/async.h>
8 #include <linux/blkdev.h>
9 #include <linux/blk-mq.h>
10 #include <linux/blk-integrity.h>
11 #include <linux/compat.h>
12 #include <linux/delay.h>
13 #include <linux/errno.h>
14 #include <linux/hdreg.h>
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/backing-dev.h>
18 #include <linux/slab.h>
19 #include <linux/types.h>
20 #include <linux/pr.h>
21 #include <linux/ptrace.h>
22 #include <linux/nvme_ioctl.h>
23 #include <linux/pm_qos.h>
24 #include <linux/ratelimit.h>
25 #include <linux/unaligned.h>
26 
27 #include "nvme.h"
28 #include "fabrics.h"
29 #include <linux/nvme-auth.h>
30 
31 #define CREATE_TRACE_POINTS
32 #include "trace.h"
33 
34 #define NVME_MINORS		(1U << MINORBITS)
35 
36 struct nvme_ns_info {
37 	struct nvme_ns_ids ids;
38 	u32 nsid;
39 	__le32 anagrpid;
40 	u8 pi_offset;
41 	u16 endgid;
42 	u64 runs;
43 	bool is_shared;
44 	bool is_readonly;
45 	bool is_ready;
46 	bool is_removed;
47 	bool is_rotational;
48 	bool no_vwc;
49 };
50 
51 unsigned int admin_timeout = 60;
52 module_param(admin_timeout, uint, 0644);
53 MODULE_PARM_DESC(admin_timeout, "timeout in seconds for admin commands");
54 EXPORT_SYMBOL_GPL(admin_timeout);
55 
56 unsigned int nvme_io_timeout = 30;
57 module_param_named(io_timeout, nvme_io_timeout, uint, 0644);
58 MODULE_PARM_DESC(io_timeout, "timeout in seconds for I/O");
59 EXPORT_SYMBOL_GPL(nvme_io_timeout);
60 
61 static unsigned char shutdown_timeout = 5;
62 module_param(shutdown_timeout, byte, 0644);
63 MODULE_PARM_DESC(shutdown_timeout, "timeout in seconds for controller shutdown");
64 
65 static u8 nvme_max_retries = 5;
66 module_param_named(max_retries, nvme_max_retries, byte, 0644);
67 MODULE_PARM_DESC(max_retries, "max number of retries a command may have");
68 
69 static unsigned long default_ps_max_latency_us = 100000;
70 module_param(default_ps_max_latency_us, ulong, 0644);
71 MODULE_PARM_DESC(default_ps_max_latency_us,
72 		 "max power saving latency for new devices; use PM QOS to change per device");
73 
74 static bool force_apst;
75 module_param(force_apst, bool, 0644);
76 MODULE_PARM_DESC(force_apst, "allow APST for newly enumerated devices even if quirked off");
77 
78 static unsigned long apst_primary_timeout_ms = 100;
79 module_param(apst_primary_timeout_ms, ulong, 0644);
80 MODULE_PARM_DESC(apst_primary_timeout_ms,
81 	"primary APST timeout in ms");
82 
83 static unsigned long apst_secondary_timeout_ms = 2000;
84 module_param(apst_secondary_timeout_ms, ulong, 0644);
85 MODULE_PARM_DESC(apst_secondary_timeout_ms,
86 	"secondary APST timeout in ms");
87 
88 static unsigned long apst_primary_latency_tol_us = 15000;
89 module_param(apst_primary_latency_tol_us, ulong, 0644);
90 MODULE_PARM_DESC(apst_primary_latency_tol_us,
91 	"primary APST latency tolerance in us");
92 
93 static unsigned long apst_secondary_latency_tol_us = 100000;
94 module_param(apst_secondary_latency_tol_us, ulong, 0644);
95 MODULE_PARM_DESC(apst_secondary_latency_tol_us,
96 	"secondary APST latency tolerance in us");
97 
98 /*
99  * Older kernels didn't enable protection information if it was at an offset.
100  * Newer kernels do, so it breaks reads on the upgrade if such formats were
101  * used in prior kernels since the metadata written did not contain a valid
102  * checksum.
103  */
104 static bool disable_pi_offsets = false;
105 module_param(disable_pi_offsets, bool, 0444);
106 MODULE_PARM_DESC(disable_pi_offsets,
107 	"disable protection information if it has an offset");
108 
109 /*
110  * nvme_wq - hosts nvme related works that are not reset or delete
111  * nvme_reset_wq - hosts nvme reset works
112  * nvme_delete_wq - hosts nvme delete works
113  *
114  * nvme_wq will host works such as scan, aen handling, fw activation,
115  * keep-alive, periodic reconnects etc. nvme_reset_wq
116  * runs reset works which also flush works hosted on nvme_wq for
117  * serialization purposes. nvme_delete_wq host controller deletion
118  * works which flush reset works for serialization.
119  */
120 struct workqueue_struct *nvme_wq;
121 EXPORT_SYMBOL_GPL(nvme_wq);
122 
123 struct workqueue_struct *nvme_reset_wq;
124 EXPORT_SYMBOL_GPL(nvme_reset_wq);
125 
126 struct workqueue_struct *nvme_delete_wq;
127 EXPORT_SYMBOL_GPL(nvme_delete_wq);
128 
129 static LIST_HEAD(nvme_subsystems);
130 DEFINE_MUTEX(nvme_subsystems_lock);
131 
132 static DEFINE_IDA(nvme_instance_ida);
133 static dev_t nvme_ctrl_base_chr_devt;
134 static int nvme_class_uevent(const struct device *dev, struct kobj_uevent_env *env);
135 static const struct class nvme_class = {
136 	.name = "nvme",
137 	.dev_uevent = nvme_class_uevent,
138 };
139 
140 static const struct class nvme_subsys_class = {
141 	.name = "nvme-subsystem",
142 };
143 
144 static DEFINE_IDA(nvme_ns_chr_minor_ida);
145 static dev_t nvme_ns_chr_devt;
146 static const struct class nvme_ns_chr_class = {
147 	.name = "nvme-generic",
148 };
149 
150 static void nvme_put_subsystem(struct nvme_subsystem *subsys);
151 static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
152 					   unsigned nsid);
153 static void nvme_update_keep_alive(struct nvme_ctrl *ctrl,
154 				   struct nvme_command *cmd);
155 static int nvme_get_log_lsi(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page,
156 		u8 lsp, u8 csi, void *log, size_t size, u64 offset, u16 lsi);
157 
nvme_queue_scan(struct nvme_ctrl * ctrl)158 void nvme_queue_scan(struct nvme_ctrl *ctrl)
159 {
160 	/*
161 	 * Only new queue scan work when admin and IO queues are both alive
162 	 */
163 	if (nvme_ctrl_state(ctrl) == NVME_CTRL_LIVE && ctrl->tagset)
164 		queue_work(nvme_wq, &ctrl->scan_work);
165 }
166 
167 /*
168  * Use this function to proceed with scheduling reset_work for a controller
169  * that had previously been set to the resetting state. This is intended for
170  * code paths that can't be interrupted by other reset attempts. A hot removal
171  * may prevent this from succeeding.
172  */
nvme_try_sched_reset(struct nvme_ctrl * ctrl)173 int nvme_try_sched_reset(struct nvme_ctrl *ctrl)
174 {
175 	if (nvme_ctrl_state(ctrl) != NVME_CTRL_RESETTING)
176 		return -EBUSY;
177 	if (!queue_work(nvme_reset_wq, &ctrl->reset_work))
178 		return -EBUSY;
179 	return 0;
180 }
181 EXPORT_SYMBOL_GPL(nvme_try_sched_reset);
182 
nvme_failfast_work(struct work_struct * work)183 static void nvme_failfast_work(struct work_struct *work)
184 {
185 	struct nvme_ctrl *ctrl = container_of(to_delayed_work(work),
186 			struct nvme_ctrl, failfast_work);
187 
188 	if (nvme_ctrl_state(ctrl) != NVME_CTRL_CONNECTING)
189 		return;
190 
191 	set_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags);
192 	dev_info(ctrl->device, "failfast expired\n");
193 	nvme_kick_requeue_lists(ctrl);
194 }
195 
nvme_start_failfast_work(struct nvme_ctrl * ctrl)196 static inline void nvme_start_failfast_work(struct nvme_ctrl *ctrl)
197 {
198 	if (!ctrl->opts || ctrl->opts->fast_io_fail_tmo == -1)
199 		return;
200 
201 	schedule_delayed_work(&ctrl->failfast_work,
202 			      ctrl->opts->fast_io_fail_tmo * HZ);
203 }
204 
nvme_stop_failfast_work(struct nvme_ctrl * ctrl)205 static inline void nvme_stop_failfast_work(struct nvme_ctrl *ctrl)
206 {
207 	if (!ctrl->opts)
208 		return;
209 
210 	cancel_delayed_work_sync(&ctrl->failfast_work);
211 	clear_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags);
212 }
213 
214 
nvme_reset_ctrl(struct nvme_ctrl * ctrl)215 int nvme_reset_ctrl(struct nvme_ctrl *ctrl)
216 {
217 	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
218 		return -EBUSY;
219 	if (!queue_work(nvme_reset_wq, &ctrl->reset_work))
220 		return -EBUSY;
221 	return 0;
222 }
223 EXPORT_SYMBOL_GPL(nvme_reset_ctrl);
224 
nvme_reset_ctrl_sync(struct nvme_ctrl * ctrl)225 int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl)
226 {
227 	int ret;
228 
229 	ret = nvme_reset_ctrl(ctrl);
230 	if (!ret) {
231 		flush_work(&ctrl->reset_work);
232 		if (nvme_ctrl_state(ctrl) != NVME_CTRL_LIVE)
233 			ret = -ENETRESET;
234 	}
235 
236 	return ret;
237 }
238 
nvme_do_delete_ctrl(struct nvme_ctrl * ctrl)239 static void nvme_do_delete_ctrl(struct nvme_ctrl *ctrl)
240 {
241 	dev_info(ctrl->device,
242 		 "Removing ctrl: NQN \"%s\"\n", nvmf_ctrl_subsysnqn(ctrl));
243 
244 	flush_work(&ctrl->reset_work);
245 	nvme_stop_ctrl(ctrl);
246 	nvme_remove_namespaces(ctrl);
247 	ctrl->ops->delete_ctrl(ctrl);
248 	nvme_uninit_ctrl(ctrl);
249 }
250 
nvme_delete_ctrl_work(struct work_struct * work)251 static void nvme_delete_ctrl_work(struct work_struct *work)
252 {
253 	struct nvme_ctrl *ctrl =
254 		container_of(work, struct nvme_ctrl, delete_work);
255 
256 	nvme_do_delete_ctrl(ctrl);
257 }
258 
nvme_delete_ctrl(struct nvme_ctrl * ctrl)259 int nvme_delete_ctrl(struct nvme_ctrl *ctrl)
260 {
261 	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
262 		return -EBUSY;
263 	if (!queue_work(nvme_delete_wq, &ctrl->delete_work))
264 		return -EBUSY;
265 	return 0;
266 }
267 EXPORT_SYMBOL_GPL(nvme_delete_ctrl);
268 
nvme_delete_ctrl_sync(struct nvme_ctrl * ctrl)269 void nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl)
270 {
271 	/*
272 	 * Keep a reference until nvme_do_delete_ctrl() complete,
273 	 * since ->delete_ctrl can free the controller.
274 	 */
275 	nvme_get_ctrl(ctrl);
276 	if (nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING))
277 		nvme_do_delete_ctrl(ctrl);
278 	nvme_put_ctrl(ctrl);
279 }
280 
nvme_error_status(u16 status)281 static blk_status_t nvme_error_status(u16 status)
282 {
283 	switch (status & NVME_SCT_SC_MASK) {
284 	case NVME_SC_SUCCESS:
285 		return BLK_STS_OK;
286 	case NVME_SC_CAP_EXCEEDED:
287 		return BLK_STS_NOSPC;
288 	case NVME_SC_LBA_RANGE:
289 	case NVME_SC_CMD_INTERRUPTED:
290 	case NVME_SC_NS_NOT_READY:
291 		return BLK_STS_TARGET;
292 	case NVME_SC_BAD_ATTRIBUTES:
293 	case NVME_SC_INVALID_OPCODE:
294 	case NVME_SC_INVALID_FIELD:
295 	case NVME_SC_INVALID_NS:
296 		return BLK_STS_NOTSUPP;
297 	case NVME_SC_WRITE_FAULT:
298 	case NVME_SC_READ_ERROR:
299 	case NVME_SC_UNWRITTEN_BLOCK:
300 	case NVME_SC_ACCESS_DENIED:
301 	case NVME_SC_READ_ONLY:
302 	case NVME_SC_COMPARE_FAILED:
303 		return BLK_STS_MEDIUM;
304 	case NVME_SC_GUARD_CHECK:
305 	case NVME_SC_APPTAG_CHECK:
306 	case NVME_SC_REFTAG_CHECK:
307 	case NVME_SC_INVALID_PI:
308 		return BLK_STS_PROTECTION;
309 	case NVME_SC_RESERVATION_CONFLICT:
310 		return BLK_STS_RESV_CONFLICT;
311 	case NVME_SC_HOST_PATH_ERROR:
312 		return BLK_STS_TRANSPORT;
313 	case NVME_SC_ZONE_TOO_MANY_ACTIVE:
314 		return BLK_STS_ZONE_ACTIVE_RESOURCE;
315 	case NVME_SC_ZONE_TOO_MANY_OPEN:
316 		return BLK_STS_ZONE_OPEN_RESOURCE;
317 	default:
318 		return BLK_STS_IOERR;
319 	}
320 }
321 
nvme_retry_req(struct request * req)322 static void nvme_retry_req(struct request *req)
323 {
324 	unsigned long delay = 0;
325 	u16 crd;
326 
327 	/* The mask and shift result must be <= 3 */
328 	crd = (nvme_req(req)->status & NVME_STATUS_CRD) >> 11;
329 	if (crd)
330 		delay = nvme_req(req)->ctrl->crdt[crd - 1] * 100;
331 
332 	nvme_req(req)->retries++;
333 	blk_mq_requeue_request(req, false);
334 	blk_mq_delay_kick_requeue_list(req->q, delay);
335 }
336 
nvme_log_error(struct request * req)337 static void nvme_log_error(struct request *req)
338 {
339 	struct nvme_ns *ns = req->q->queuedata;
340 	struct nvme_request *nr = nvme_req(req);
341 
342 	if (ns) {
343 		pr_err_ratelimited("%s: %s(0x%x) @ LBA %llu, %u blocks, %s (sct 0x%x / sc 0x%x) %s%s\n",
344 		       ns->disk ? ns->disk->disk_name : "?",
345 		       nvme_get_opcode_str(nr->cmd->common.opcode),
346 		       nr->cmd->common.opcode,
347 		       nvme_sect_to_lba(ns->head, blk_rq_pos(req)),
348 		       blk_rq_bytes(req) >> ns->head->lba_shift,
349 		       nvme_get_error_status_str(nr->status),
350 		       NVME_SCT(nr->status),		/* Status Code Type */
351 		       nr->status & NVME_SC_MASK,	/* Status Code */
352 		       nr->status & NVME_STATUS_MORE ? "MORE " : "",
353 		       nr->status & NVME_STATUS_DNR  ? "DNR "  : "");
354 		return;
355 	}
356 
357 	pr_err_ratelimited("%s: %s(0x%x), %s (sct 0x%x / sc 0x%x) %s%s\n",
358 			   dev_name(nr->ctrl->device),
359 			   nvme_get_admin_opcode_str(nr->cmd->common.opcode),
360 			   nr->cmd->common.opcode,
361 			   nvme_get_error_status_str(nr->status),
362 			   NVME_SCT(nr->status),	/* Status Code Type */
363 			   nr->status & NVME_SC_MASK,	/* Status Code */
364 			   nr->status & NVME_STATUS_MORE ? "MORE " : "",
365 			   nr->status & NVME_STATUS_DNR  ? "DNR "  : "");
366 }
367 
nvme_log_err_passthru(struct request * req)368 static void nvme_log_err_passthru(struct request *req)
369 {
370 	struct nvme_ns *ns = req->q->queuedata;
371 	struct nvme_request *nr = nvme_req(req);
372 
373 	pr_err_ratelimited("%s: %s(0x%x), %s (sct 0x%x / sc 0x%x) %s%s"
374 		"cdw10=0x%x cdw11=0x%x cdw12=0x%x cdw13=0x%x cdw14=0x%x cdw15=0x%x\n",
375 		ns ? ns->disk->disk_name : dev_name(nr->ctrl->device),
376 		ns ? nvme_get_opcode_str(nr->cmd->common.opcode) :
377 		     nvme_get_admin_opcode_str(nr->cmd->common.opcode),
378 		nr->cmd->common.opcode,
379 		nvme_get_error_status_str(nr->status),
380 		NVME_SCT(nr->status),		/* Status Code Type */
381 		nr->status & NVME_SC_MASK,	/* Status Code */
382 		nr->status & NVME_STATUS_MORE ? "MORE " : "",
383 		nr->status & NVME_STATUS_DNR  ? "DNR "  : "",
384 		le32_to_cpu(nr->cmd->common.cdw10),
385 		le32_to_cpu(nr->cmd->common.cdw11),
386 		le32_to_cpu(nr->cmd->common.cdw12),
387 		le32_to_cpu(nr->cmd->common.cdw13),
388 		le32_to_cpu(nr->cmd->common.cdw14),
389 		le32_to_cpu(nr->cmd->common.cdw15));
390 }
391 
392 enum nvme_disposition {
393 	COMPLETE,
394 	RETRY,
395 	FAILOVER,
396 	AUTHENTICATE,
397 };
398 
nvme_decide_disposition(struct request * req)399 static inline enum nvme_disposition nvme_decide_disposition(struct request *req)
400 {
401 	if (likely(nvme_req(req)->status == 0))
402 		return COMPLETE;
403 
404 	if (blk_noretry_request(req) ||
405 	    (nvme_req(req)->status & NVME_STATUS_DNR) ||
406 	    nvme_req(req)->retries >= nvme_max_retries)
407 		return COMPLETE;
408 
409 	if ((nvme_req(req)->status & NVME_SCT_SC_MASK) == NVME_SC_AUTH_REQUIRED)
410 		return AUTHENTICATE;
411 
412 	if (req->cmd_flags & REQ_NVME_MPATH) {
413 		if (nvme_is_path_error(nvme_req(req)->status) ||
414 		    blk_queue_dying(req->q))
415 			return FAILOVER;
416 	} else {
417 		if (blk_queue_dying(req->q))
418 			return COMPLETE;
419 	}
420 
421 	return RETRY;
422 }
423 
nvme_end_req_zoned(struct request * req)424 static inline void nvme_end_req_zoned(struct request *req)
425 {
426 	if (IS_ENABLED(CONFIG_BLK_DEV_ZONED) &&
427 	    req_op(req) == REQ_OP_ZONE_APPEND) {
428 		struct nvme_ns *ns = req->q->queuedata;
429 
430 		req->__sector = nvme_lba_to_sect(ns->head,
431 			le64_to_cpu(nvme_req(req)->result.u64));
432 	}
433 }
434 
__nvme_end_req(struct request * req)435 static inline void __nvme_end_req(struct request *req)
436 {
437 	if (unlikely(nvme_req(req)->status && !(req->rq_flags & RQF_QUIET))) {
438 		if (blk_rq_is_passthrough(req))
439 			nvme_log_err_passthru(req);
440 		else
441 			nvme_log_error(req);
442 	}
443 	nvme_end_req_zoned(req);
444 	nvme_trace_bio_complete(req);
445 	if (req->cmd_flags & REQ_NVME_MPATH)
446 		nvme_mpath_end_request(req);
447 }
448 
nvme_end_req(struct request * req)449 void nvme_end_req(struct request *req)
450 {
451 	blk_status_t status = nvme_error_status(nvme_req(req)->status);
452 
453 	__nvme_end_req(req);
454 	blk_mq_end_request(req, status);
455 }
456 
nvme_complete_rq(struct request * req)457 void nvme_complete_rq(struct request *req)
458 {
459 	struct nvme_ctrl *ctrl = nvme_req(req)->ctrl;
460 
461 	trace_nvme_complete_rq(req);
462 	nvme_cleanup_cmd(req);
463 
464 	/*
465 	 * Completions of long-running commands should not be able to
466 	 * defer sending of periodic keep alives, since the controller
467 	 * may have completed processing such commands a long time ago
468 	 * (arbitrarily close to command submission time).
469 	 * req->deadline - req->timeout is the command submission time
470 	 * in jiffies.
471 	 */
472 	if (ctrl->kas &&
473 	    req->deadline - req->timeout >= ctrl->ka_last_check_time)
474 		ctrl->comp_seen = true;
475 
476 	switch (nvme_decide_disposition(req)) {
477 	case COMPLETE:
478 		nvme_end_req(req);
479 		return;
480 	case RETRY:
481 		nvme_retry_req(req);
482 		return;
483 	case FAILOVER:
484 		nvme_failover_req(req);
485 		return;
486 	case AUTHENTICATE:
487 #ifdef CONFIG_NVME_HOST_AUTH
488 		queue_work(nvme_wq, &ctrl->dhchap_auth_work);
489 		nvme_retry_req(req);
490 #else
491 		nvme_end_req(req);
492 #endif
493 		return;
494 	}
495 }
496 EXPORT_SYMBOL_GPL(nvme_complete_rq);
497 
nvme_complete_batch_req(struct request * req)498 void nvme_complete_batch_req(struct request *req)
499 {
500 	trace_nvme_complete_rq(req);
501 	nvme_cleanup_cmd(req);
502 	__nvme_end_req(req);
503 }
504 EXPORT_SYMBOL_GPL(nvme_complete_batch_req);
505 
506 /*
507  * Called to unwind from ->queue_rq on a failed command submission so that the
508  * multipathing code gets called to potentially failover to another path.
509  * The caller needs to unwind all transport specific resource allocations and
510  * must return propagate the return value.
511  */
nvme_host_path_error(struct request * req)512 blk_status_t nvme_host_path_error(struct request *req)
513 {
514 	nvme_req(req)->status = NVME_SC_HOST_PATH_ERROR;
515 	blk_mq_set_request_complete(req);
516 	nvme_complete_rq(req);
517 	return BLK_STS_OK;
518 }
519 EXPORT_SYMBOL_GPL(nvme_host_path_error);
520 
nvme_cancel_request(struct request * req,void * data)521 bool nvme_cancel_request(struct request *req, void *data)
522 {
523 	dev_dbg_ratelimited(((struct nvme_ctrl *) data)->device,
524 				"Cancelling I/O %d", req->tag);
525 
526 	/* don't abort one completed or idle request */
527 	if (blk_mq_rq_state(req) != MQ_RQ_IN_FLIGHT)
528 		return true;
529 
530 	nvme_req(req)->status = NVME_SC_HOST_ABORTED_CMD;
531 	nvme_req(req)->flags |= NVME_REQ_CANCELLED;
532 	blk_mq_complete_request(req);
533 	return true;
534 }
535 EXPORT_SYMBOL_GPL(nvme_cancel_request);
536 
nvme_cancel_tagset(struct nvme_ctrl * ctrl)537 void nvme_cancel_tagset(struct nvme_ctrl *ctrl)
538 {
539 	if (ctrl->tagset) {
540 		blk_mq_tagset_busy_iter(ctrl->tagset,
541 				nvme_cancel_request, ctrl);
542 		blk_mq_tagset_wait_completed_request(ctrl->tagset);
543 	}
544 }
545 EXPORT_SYMBOL_GPL(nvme_cancel_tagset);
546 
nvme_cancel_admin_tagset(struct nvme_ctrl * ctrl)547 void nvme_cancel_admin_tagset(struct nvme_ctrl *ctrl)
548 {
549 	if (ctrl->admin_tagset) {
550 		blk_mq_tagset_busy_iter(ctrl->admin_tagset,
551 				nvme_cancel_request, ctrl);
552 		blk_mq_tagset_wait_completed_request(ctrl->admin_tagset);
553 	}
554 }
555 EXPORT_SYMBOL_GPL(nvme_cancel_admin_tagset);
556 
nvme_change_ctrl_state(struct nvme_ctrl * ctrl,enum nvme_ctrl_state new_state)557 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
558 		enum nvme_ctrl_state new_state)
559 {
560 	enum nvme_ctrl_state old_state;
561 	unsigned long flags;
562 	bool changed = false;
563 
564 	spin_lock_irqsave(&ctrl->lock, flags);
565 
566 	old_state = nvme_ctrl_state(ctrl);
567 	switch (new_state) {
568 	case NVME_CTRL_LIVE:
569 		switch (old_state) {
570 		case NVME_CTRL_CONNECTING:
571 			changed = true;
572 			fallthrough;
573 		default:
574 			break;
575 		}
576 		break;
577 	case NVME_CTRL_RESETTING:
578 		switch (old_state) {
579 		case NVME_CTRL_NEW:
580 		case NVME_CTRL_LIVE:
581 			changed = true;
582 			fallthrough;
583 		default:
584 			break;
585 		}
586 		break;
587 	case NVME_CTRL_CONNECTING:
588 		switch (old_state) {
589 		case NVME_CTRL_NEW:
590 		case NVME_CTRL_RESETTING:
591 			changed = true;
592 			fallthrough;
593 		default:
594 			break;
595 		}
596 		break;
597 	case NVME_CTRL_DELETING:
598 		switch (old_state) {
599 		case NVME_CTRL_LIVE:
600 		case NVME_CTRL_RESETTING:
601 		case NVME_CTRL_CONNECTING:
602 			changed = true;
603 			fallthrough;
604 		default:
605 			break;
606 		}
607 		break;
608 	case NVME_CTRL_DELETING_NOIO:
609 		switch (old_state) {
610 		case NVME_CTRL_DELETING:
611 		case NVME_CTRL_DEAD:
612 			changed = true;
613 			fallthrough;
614 		default:
615 			break;
616 		}
617 		break;
618 	case NVME_CTRL_DEAD:
619 		switch (old_state) {
620 		case NVME_CTRL_DELETING:
621 			changed = true;
622 			fallthrough;
623 		default:
624 			break;
625 		}
626 		break;
627 	default:
628 		break;
629 	}
630 
631 	if (changed) {
632 		WRITE_ONCE(ctrl->state, new_state);
633 		wake_up_all(&ctrl->state_wq);
634 	}
635 
636 	spin_unlock_irqrestore(&ctrl->lock, flags);
637 	if (!changed)
638 		return false;
639 
640 	if (new_state == NVME_CTRL_LIVE) {
641 		if (old_state == NVME_CTRL_CONNECTING)
642 			nvme_stop_failfast_work(ctrl);
643 		nvme_kick_requeue_lists(ctrl);
644 	} else if (new_state == NVME_CTRL_CONNECTING &&
645 		old_state == NVME_CTRL_RESETTING) {
646 		nvme_start_failfast_work(ctrl);
647 	}
648 	return changed;
649 }
650 EXPORT_SYMBOL_GPL(nvme_change_ctrl_state);
651 
652 /*
653  * Waits for the controller state to be resetting, or returns false if it is
654  * not possible to ever transition to that state.
655  */
nvme_wait_reset(struct nvme_ctrl * ctrl)656 bool nvme_wait_reset(struct nvme_ctrl *ctrl)
657 {
658 	wait_event(ctrl->state_wq,
659 		   nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING) ||
660 		   nvme_state_terminal(ctrl));
661 	return nvme_ctrl_state(ctrl) == NVME_CTRL_RESETTING;
662 }
663 EXPORT_SYMBOL_GPL(nvme_wait_reset);
664 
nvme_free_ns_head(struct kref * ref)665 static void nvme_free_ns_head(struct kref *ref)
666 {
667 	struct nvme_ns_head *head =
668 		container_of(ref, struct nvme_ns_head, ref);
669 
670 	nvme_mpath_put_disk(head);
671 	ida_free(&head->subsys->ns_ida, head->instance);
672 	cleanup_srcu_struct(&head->srcu);
673 	nvme_put_subsystem(head->subsys);
674 	kfree(head->plids);
675 	kfree(head);
676 }
677 
nvme_tryget_ns_head(struct nvme_ns_head * head)678 bool nvme_tryget_ns_head(struct nvme_ns_head *head)
679 {
680 	return kref_get_unless_zero(&head->ref);
681 }
682 
nvme_put_ns_head(struct nvme_ns_head * head)683 void nvme_put_ns_head(struct nvme_ns_head *head)
684 {
685 	kref_put(&head->ref, nvme_free_ns_head);
686 }
687 
nvme_free_ns(struct kref * kref)688 static void nvme_free_ns(struct kref *kref)
689 {
690 	struct nvme_ns *ns = container_of(kref, struct nvme_ns, kref);
691 
692 	put_disk(ns->disk);
693 	nvme_put_ns_head(ns->head);
694 	nvme_put_ctrl(ns->ctrl);
695 	kfree(ns);
696 }
697 
nvme_get_ns(struct nvme_ns * ns)698 bool nvme_get_ns(struct nvme_ns *ns)
699 {
700 	return kref_get_unless_zero(&ns->kref);
701 }
702 
nvme_put_ns(struct nvme_ns * ns)703 void nvme_put_ns(struct nvme_ns *ns)
704 {
705 	kref_put(&ns->kref, nvme_free_ns);
706 }
707 EXPORT_SYMBOL_NS_GPL(nvme_put_ns, "NVME_TARGET_PASSTHRU");
708 
nvme_clear_nvme_request(struct request * req)709 static inline void nvme_clear_nvme_request(struct request *req)
710 {
711 	nvme_req(req)->status = 0;
712 	nvme_req(req)->retries = 0;
713 	nvme_req(req)->flags = 0;
714 	req->rq_flags |= RQF_DONTPREP;
715 }
716 
717 /* initialize a passthrough request */
nvme_init_request(struct request * req,struct nvme_command * cmd)718 void nvme_init_request(struct request *req, struct nvme_command *cmd)
719 {
720 	struct nvme_request *nr = nvme_req(req);
721 	bool logging_enabled;
722 
723 	if (req->q->queuedata) {
724 		struct nvme_ns *ns = req->q->disk->private_data;
725 
726 		logging_enabled = ns->head->passthru_err_log_enabled;
727 		req->timeout = NVME_IO_TIMEOUT;
728 	} else { /* no queuedata implies admin queue */
729 		logging_enabled = nr->ctrl->passthru_err_log_enabled;
730 		req->timeout = NVME_ADMIN_TIMEOUT;
731 	}
732 
733 	if (!logging_enabled)
734 		req->rq_flags |= RQF_QUIET;
735 
736 	/* passthru commands should let the driver set the SGL flags */
737 	cmd->common.flags &= ~NVME_CMD_SGL_ALL;
738 
739 	req->cmd_flags |= REQ_FAILFAST_DRIVER;
740 	if (req->mq_hctx->type == HCTX_TYPE_POLL)
741 		req->cmd_flags |= REQ_POLLED;
742 	nvme_clear_nvme_request(req);
743 	memcpy(nr->cmd, cmd, sizeof(*cmd));
744 }
745 EXPORT_SYMBOL_GPL(nvme_init_request);
746 
747 /*
748  * For something we're not in a state to send to the device the default action
749  * is to busy it and retry it after the controller state is recovered.  However,
750  * if the controller is deleting or if anything is marked for failfast or
751  * nvme multipath it is immediately failed.
752  *
753  * Note: commands used to initialize the controller will be marked for failfast.
754  * Note: nvme cli/ioctl commands are marked for failfast.
755  */
nvme_fail_nonready_command(struct nvme_ctrl * ctrl,struct request * rq)756 blk_status_t nvme_fail_nonready_command(struct nvme_ctrl *ctrl,
757 		struct request *rq)
758 {
759 	enum nvme_ctrl_state state = nvme_ctrl_state(ctrl);
760 
761 	if (state != NVME_CTRL_DELETING_NOIO &&
762 	    state != NVME_CTRL_DELETING &&
763 	    state != NVME_CTRL_DEAD &&
764 	    !test_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags) &&
765 	    !blk_noretry_request(rq) && !(rq->cmd_flags & REQ_NVME_MPATH))
766 		return BLK_STS_RESOURCE;
767 
768 	if (!(rq->rq_flags & RQF_DONTPREP))
769 		nvme_clear_nvme_request(rq);
770 
771 	return nvme_host_path_error(rq);
772 }
773 EXPORT_SYMBOL_GPL(nvme_fail_nonready_command);
774 
__nvme_check_ready(struct nvme_ctrl * ctrl,struct request * rq,bool queue_live,enum nvme_ctrl_state state)775 bool __nvme_check_ready(struct nvme_ctrl *ctrl, struct request *rq,
776 		bool queue_live, enum nvme_ctrl_state state)
777 {
778 	struct nvme_request *req = nvme_req(rq);
779 
780 	/*
781 	 * currently we have a problem sending passthru commands
782 	 * on the admin_q if the controller is not LIVE because we can't
783 	 * make sure that they are going out after the admin connect,
784 	 * controller enable and/or other commands in the initialization
785 	 * sequence. until the controller will be LIVE, fail with
786 	 * BLK_STS_RESOURCE so that they will be rescheduled.
787 	 */
788 	if (rq->q == ctrl->admin_q && (req->flags & NVME_REQ_USERCMD))
789 		return false;
790 
791 	if (ctrl->ops->flags & NVME_F_FABRICS) {
792 		/*
793 		 * Only allow commands on a live queue, except for the connect
794 		 * command, which is require to set the queue live in the
795 		 * appropinquate states.
796 		 */
797 		switch (state) {
798 		case NVME_CTRL_CONNECTING:
799 			if (blk_rq_is_passthrough(rq) && nvme_is_fabrics(req->cmd) &&
800 			    (req->cmd->fabrics.fctype == nvme_fabrics_type_connect ||
801 			     req->cmd->fabrics.fctype == nvme_fabrics_type_auth_send ||
802 			     req->cmd->fabrics.fctype == nvme_fabrics_type_auth_receive))
803 				return true;
804 			break;
805 		default:
806 			break;
807 		case NVME_CTRL_DEAD:
808 			return false;
809 		}
810 	}
811 
812 	return queue_live;
813 }
814 EXPORT_SYMBOL_GPL(__nvme_check_ready);
815 
nvme_setup_flush(struct nvme_ns * ns,struct nvme_command * cmnd)816 static inline void nvme_setup_flush(struct nvme_ns *ns,
817 		struct nvme_command *cmnd)
818 {
819 	memset(cmnd, 0, sizeof(*cmnd));
820 	cmnd->common.opcode = nvme_cmd_flush;
821 	cmnd->common.nsid = cpu_to_le32(ns->head->ns_id);
822 }
823 
nvme_setup_discard(struct nvme_ns * ns,struct request * req,struct nvme_command * cmnd)824 static blk_status_t nvme_setup_discard(struct nvme_ns *ns, struct request *req,
825 		struct nvme_command *cmnd)
826 {
827 	unsigned short segments = blk_rq_nr_discard_segments(req), n = 0;
828 	struct nvme_dsm_range *range;
829 	struct bio *bio;
830 
831 	/*
832 	 * Some devices do not consider the DSM 'Number of Ranges' field when
833 	 * determining how much data to DMA. Always allocate memory for maximum
834 	 * number of segments to prevent device reading beyond end of buffer.
835 	 */
836 	static const size_t alloc_size = sizeof(*range) * NVME_DSM_MAX_RANGES;
837 
838 	range = kzalloc(alloc_size, GFP_ATOMIC | __GFP_NOWARN);
839 	if (!range) {
840 		/*
841 		 * If we fail allocation our range, fallback to the controller
842 		 * discard page. If that's also busy, it's safe to return
843 		 * busy, as we know we can make progress once that's freed.
844 		 */
845 		if (test_and_set_bit_lock(0, &ns->ctrl->discard_page_busy))
846 			return BLK_STS_RESOURCE;
847 
848 		range = page_address(ns->ctrl->discard_page);
849 	}
850 
851 	if (queue_max_discard_segments(req->q) == 1) {
852 		u64 slba = nvme_sect_to_lba(ns->head, blk_rq_pos(req));
853 		u32 nlb = blk_rq_sectors(req) >> (ns->head->lba_shift - 9);
854 
855 		range[0].cattr = cpu_to_le32(0);
856 		range[0].nlb = cpu_to_le32(nlb);
857 		range[0].slba = cpu_to_le64(slba);
858 		n = 1;
859 	} else {
860 		__rq_for_each_bio(bio, req) {
861 			u64 slba = nvme_sect_to_lba(ns->head,
862 						    bio->bi_iter.bi_sector);
863 			u32 nlb = bio->bi_iter.bi_size >> ns->head->lba_shift;
864 
865 			if (n < segments) {
866 				range[n].cattr = cpu_to_le32(0);
867 				range[n].nlb = cpu_to_le32(nlb);
868 				range[n].slba = cpu_to_le64(slba);
869 			}
870 			n++;
871 		}
872 	}
873 
874 	if (WARN_ON_ONCE(n != segments)) {
875 		if (virt_to_page(range) == ns->ctrl->discard_page)
876 			clear_bit_unlock(0, &ns->ctrl->discard_page_busy);
877 		else
878 			kfree(range);
879 		return BLK_STS_IOERR;
880 	}
881 
882 	memset(cmnd, 0, sizeof(*cmnd));
883 	cmnd->dsm.opcode = nvme_cmd_dsm;
884 	cmnd->dsm.nsid = cpu_to_le32(ns->head->ns_id);
885 	cmnd->dsm.nr = cpu_to_le32(segments - 1);
886 	cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);
887 
888 	bvec_set_virt(&req->special_vec, range, alloc_size);
889 	req->rq_flags |= RQF_SPECIAL_PAYLOAD;
890 
891 	return BLK_STS_OK;
892 }
893 
nvme_set_app_tag(struct request * req,struct nvme_command * cmnd)894 static void nvme_set_app_tag(struct request *req, struct nvme_command *cmnd)
895 {
896 	cmnd->rw.lbat = cpu_to_le16(bio_integrity(req->bio)->app_tag);
897 	cmnd->rw.lbatm = cpu_to_le16(0xffff);
898 }
899 
nvme_set_ref_tag(struct nvme_ns * ns,struct nvme_command * cmnd,struct request * req)900 static void nvme_set_ref_tag(struct nvme_ns *ns, struct nvme_command *cmnd,
901 			      struct request *req)
902 {
903 	u32 upper, lower;
904 	u64 ref48;
905 
906 	/* only type1 and type 2 PI formats have a reftag */
907 	switch (ns->head->pi_type) {
908 	case NVME_NS_DPS_PI_TYPE1:
909 	case NVME_NS_DPS_PI_TYPE2:
910 		break;
911 	default:
912 		return;
913 	}
914 
915 	/* both rw and write zeroes share the same reftag format */
916 	switch (ns->head->guard_type) {
917 	case NVME_NVM_NS_16B_GUARD:
918 		cmnd->rw.reftag = cpu_to_le32(t10_pi_ref_tag(req));
919 		break;
920 	case NVME_NVM_NS_64B_GUARD:
921 		ref48 = ext_pi_ref_tag(req);
922 		lower = lower_32_bits(ref48);
923 		upper = upper_32_bits(ref48);
924 
925 		cmnd->rw.reftag = cpu_to_le32(lower);
926 		cmnd->rw.cdw3 = cpu_to_le32(upper);
927 		break;
928 	default:
929 		break;
930 	}
931 }
932 
nvme_setup_write_zeroes(struct nvme_ns * ns,struct request * req,struct nvme_command * cmnd)933 static inline blk_status_t nvme_setup_write_zeroes(struct nvme_ns *ns,
934 		struct request *req, struct nvme_command *cmnd)
935 {
936 	memset(cmnd, 0, sizeof(*cmnd));
937 
938 	if (ns->ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
939 		return nvme_setup_discard(ns, req, cmnd);
940 
941 	cmnd->write_zeroes.opcode = nvme_cmd_write_zeroes;
942 	cmnd->write_zeroes.nsid = cpu_to_le32(ns->head->ns_id);
943 	cmnd->write_zeroes.slba =
944 		cpu_to_le64(nvme_sect_to_lba(ns->head, blk_rq_pos(req)));
945 	cmnd->write_zeroes.length =
946 		cpu_to_le16((blk_rq_bytes(req) >> ns->head->lba_shift) - 1);
947 
948 	if (!(req->cmd_flags & REQ_NOUNMAP) &&
949 	    (ns->head->features & NVME_NS_DEAC))
950 		cmnd->write_zeroes.control |= cpu_to_le16(NVME_WZ_DEAC);
951 
952 	if (nvme_ns_has_pi(ns->head)) {
953 		cmnd->write_zeroes.control |= cpu_to_le16(NVME_RW_PRINFO_PRACT);
954 		nvme_set_ref_tag(ns, cmnd, req);
955 	}
956 
957 	return BLK_STS_OK;
958 }
959 
960 /*
961  * NVMe does not support a dedicated command to issue an atomic write. A write
962  * which does adhere to the device atomic limits will silently be executed
963  * non-atomically. The request issuer should ensure that the write is within
964  * the queue atomic writes limits, but just validate this in case it is not.
965  */
nvme_valid_atomic_write(struct request * req)966 static bool nvme_valid_atomic_write(struct request *req)
967 {
968 	struct request_queue *q = req->q;
969 	u32 boundary_bytes = queue_atomic_write_boundary_bytes(q);
970 
971 	if (blk_rq_bytes(req) > queue_atomic_write_unit_max_bytes(q))
972 		return false;
973 
974 	if (boundary_bytes) {
975 		u64 mask = boundary_bytes - 1, imask = ~mask;
976 		u64 start = blk_rq_pos(req) << SECTOR_SHIFT;
977 		u64 end = start + blk_rq_bytes(req) - 1;
978 
979 		/* If greater then must be crossing a boundary */
980 		if (blk_rq_bytes(req) > boundary_bytes)
981 			return false;
982 
983 		if ((start & imask) != (end & imask))
984 			return false;
985 	}
986 
987 	return true;
988 }
989 
nvme_setup_rw(struct nvme_ns * ns,struct request * req,struct nvme_command * cmnd,enum nvme_opcode op)990 static inline blk_status_t nvme_setup_rw(struct nvme_ns *ns,
991 		struct request *req, struct nvme_command *cmnd,
992 		enum nvme_opcode op)
993 {
994 	u16 control = 0;
995 	u32 dsmgmt = 0;
996 
997 	if (req->cmd_flags & REQ_FUA)
998 		control |= NVME_RW_FUA;
999 	if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD))
1000 		control |= NVME_RW_LR;
1001 
1002 	if (req->cmd_flags & REQ_RAHEAD)
1003 		dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;
1004 
1005 	if (op == nvme_cmd_write && ns->head->nr_plids) {
1006 		u16 write_stream = req->bio->bi_write_stream;
1007 
1008 		if (WARN_ON_ONCE(write_stream > ns->head->nr_plids))
1009 			return BLK_STS_INVAL;
1010 
1011 		if (write_stream) {
1012 			dsmgmt |= ns->head->plids[write_stream - 1] << 16;
1013 			control |= NVME_RW_DTYPE_DPLCMT;
1014 		}
1015 	}
1016 
1017 	if (req->cmd_flags & REQ_ATOMIC && !nvme_valid_atomic_write(req))
1018 		return BLK_STS_INVAL;
1019 
1020 	cmnd->rw.opcode = op;
1021 	cmnd->rw.flags = 0;
1022 	cmnd->rw.nsid = cpu_to_le32(ns->head->ns_id);
1023 	cmnd->rw.cdw2 = 0;
1024 	cmnd->rw.cdw3 = 0;
1025 	cmnd->rw.metadata = 0;
1026 	cmnd->rw.slba =
1027 		cpu_to_le64(nvme_sect_to_lba(ns->head, blk_rq_pos(req)));
1028 	cmnd->rw.length =
1029 		cpu_to_le16((blk_rq_bytes(req) >> ns->head->lba_shift) - 1);
1030 	cmnd->rw.reftag = 0;
1031 	cmnd->rw.lbat = 0;
1032 	cmnd->rw.lbatm = 0;
1033 
1034 	if (ns->head->ms) {
1035 		/*
1036 		 * If formatted with metadata, the block layer always provides a
1037 		 * metadata buffer if CONFIG_BLK_DEV_INTEGRITY is enabled.  Else
1038 		 * we enable the PRACT bit for protection information or set the
1039 		 * namespace capacity to zero to prevent any I/O.
1040 		 */
1041 		if (!blk_integrity_rq(req)) {
1042 			if (WARN_ON_ONCE(!nvme_ns_has_pi(ns->head)))
1043 				return BLK_STS_NOTSUPP;
1044 			control |= NVME_RW_PRINFO_PRACT;
1045 			nvme_set_ref_tag(ns, cmnd, req);
1046 		}
1047 
1048 		if (bio_integrity_flagged(req->bio, BIP_CHECK_GUARD))
1049 			control |= NVME_RW_PRINFO_PRCHK_GUARD;
1050 		if (bio_integrity_flagged(req->bio, BIP_CHECK_REFTAG)) {
1051 			control |= NVME_RW_PRINFO_PRCHK_REF;
1052 			if (op == nvme_cmd_zone_append)
1053 				control |= NVME_RW_APPEND_PIREMAP;
1054 			nvme_set_ref_tag(ns, cmnd, req);
1055 		}
1056 		if (bio_integrity_flagged(req->bio, BIP_CHECK_APPTAG)) {
1057 			control |= NVME_RW_PRINFO_PRCHK_APP;
1058 			nvme_set_app_tag(req, cmnd);
1059 		}
1060 	}
1061 
1062 	cmnd->rw.control = cpu_to_le16(control);
1063 	cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
1064 	return 0;
1065 }
1066 
nvme_cleanup_cmd(struct request * req)1067 void nvme_cleanup_cmd(struct request *req)
1068 {
1069 	if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
1070 		struct nvme_ctrl *ctrl = nvme_req(req)->ctrl;
1071 
1072 		if (req->special_vec.bv_page == ctrl->discard_page)
1073 			clear_bit_unlock(0, &ctrl->discard_page_busy);
1074 		else
1075 			kfree(bvec_virt(&req->special_vec));
1076 		req->rq_flags &= ~RQF_SPECIAL_PAYLOAD;
1077 	}
1078 }
1079 EXPORT_SYMBOL_GPL(nvme_cleanup_cmd);
1080 
nvme_setup_cmd(struct nvme_ns * ns,struct request * req)1081 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req)
1082 {
1083 	struct nvme_command *cmd = nvme_req(req)->cmd;
1084 	blk_status_t ret = BLK_STS_OK;
1085 
1086 	if (!(req->rq_flags & RQF_DONTPREP))
1087 		nvme_clear_nvme_request(req);
1088 
1089 	switch (req_op(req)) {
1090 	case REQ_OP_DRV_IN:
1091 	case REQ_OP_DRV_OUT:
1092 		/* these are setup prior to execution in nvme_init_request() */
1093 		break;
1094 	case REQ_OP_FLUSH:
1095 		nvme_setup_flush(ns, cmd);
1096 		break;
1097 	case REQ_OP_ZONE_RESET_ALL:
1098 	case REQ_OP_ZONE_RESET:
1099 		ret = nvme_setup_zone_mgmt_send(ns, req, cmd, NVME_ZONE_RESET);
1100 		break;
1101 	case REQ_OP_ZONE_OPEN:
1102 		ret = nvme_setup_zone_mgmt_send(ns, req, cmd, NVME_ZONE_OPEN);
1103 		break;
1104 	case REQ_OP_ZONE_CLOSE:
1105 		ret = nvme_setup_zone_mgmt_send(ns, req, cmd, NVME_ZONE_CLOSE);
1106 		break;
1107 	case REQ_OP_ZONE_FINISH:
1108 		ret = nvme_setup_zone_mgmt_send(ns, req, cmd, NVME_ZONE_FINISH);
1109 		break;
1110 	case REQ_OP_WRITE_ZEROES:
1111 		ret = nvme_setup_write_zeroes(ns, req, cmd);
1112 		break;
1113 	case REQ_OP_DISCARD:
1114 		ret = nvme_setup_discard(ns, req, cmd);
1115 		break;
1116 	case REQ_OP_READ:
1117 		ret = nvme_setup_rw(ns, req, cmd, nvme_cmd_read);
1118 		break;
1119 	case REQ_OP_WRITE:
1120 		ret = nvme_setup_rw(ns, req, cmd, nvme_cmd_write);
1121 		break;
1122 	case REQ_OP_ZONE_APPEND:
1123 		ret = nvme_setup_rw(ns, req, cmd, nvme_cmd_zone_append);
1124 		break;
1125 	default:
1126 		WARN_ON_ONCE(1);
1127 		return BLK_STS_IOERR;
1128 	}
1129 
1130 	cmd->common.command_id = nvme_cid(req);
1131 	trace_nvme_setup_cmd(req, cmd);
1132 	return ret;
1133 }
1134 EXPORT_SYMBOL_GPL(nvme_setup_cmd);
1135 
1136 /*
1137  * Return values:
1138  * 0:  success
1139  * >0: nvme controller's cqe status response
1140  * <0: kernel error in lieu of controller response
1141  */
nvme_execute_rq(struct request * rq,bool at_head)1142 int nvme_execute_rq(struct request *rq, bool at_head)
1143 {
1144 	blk_status_t status;
1145 
1146 	status = blk_execute_rq(rq, at_head);
1147 	if (nvme_req(rq)->flags & NVME_REQ_CANCELLED)
1148 		return -EINTR;
1149 	if (nvme_req(rq)->status)
1150 		return nvme_req(rq)->status;
1151 	return blk_status_to_errno(status);
1152 }
1153 EXPORT_SYMBOL_NS_GPL(nvme_execute_rq, "NVME_TARGET_PASSTHRU");
1154 
1155 /*
1156  * Returns 0 on success.  If the result is negative, it's a Linux error code;
1157  * if the result is positive, it's an NVM Express status code
1158  */
__nvme_submit_sync_cmd(struct request_queue * q,struct nvme_command * cmd,union nvme_result * result,void * buffer,unsigned bufflen,int qid,nvme_submit_flags_t flags)1159 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
1160 		union nvme_result *result, void *buffer, unsigned bufflen,
1161 		int qid, nvme_submit_flags_t flags)
1162 {
1163 	struct request *req;
1164 	int ret;
1165 	blk_mq_req_flags_t blk_flags = 0;
1166 
1167 	if (flags & NVME_SUBMIT_NOWAIT)
1168 		blk_flags |= BLK_MQ_REQ_NOWAIT;
1169 	if (flags & NVME_SUBMIT_RESERVED)
1170 		blk_flags |= BLK_MQ_REQ_RESERVED;
1171 	if (qid == NVME_QID_ANY)
1172 		req = blk_mq_alloc_request(q, nvme_req_op(cmd), blk_flags);
1173 	else
1174 		req = blk_mq_alloc_request_hctx(q, nvme_req_op(cmd), blk_flags,
1175 						qid - 1);
1176 
1177 	if (IS_ERR(req))
1178 		return PTR_ERR(req);
1179 	nvme_init_request(req, cmd);
1180 	if (flags & NVME_SUBMIT_RETRY)
1181 		req->cmd_flags &= ~REQ_FAILFAST_DRIVER;
1182 
1183 	if (buffer && bufflen) {
1184 		ret = blk_rq_map_kern(req, buffer, bufflen, GFP_KERNEL);
1185 		if (ret)
1186 			goto out;
1187 	}
1188 
1189 	ret = nvme_execute_rq(req, flags & NVME_SUBMIT_AT_HEAD);
1190 	if (result && ret >= 0)
1191 		*result = nvme_req(req)->result;
1192  out:
1193 	blk_mq_free_request(req);
1194 	return ret;
1195 }
1196 EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd);
1197 
nvme_submit_sync_cmd(struct request_queue * q,struct nvme_command * cmd,void * buffer,unsigned bufflen)1198 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
1199 		void *buffer, unsigned bufflen)
1200 {
1201 	return __nvme_submit_sync_cmd(q, cmd, NULL, buffer, bufflen,
1202 			NVME_QID_ANY, 0);
1203 }
1204 EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd);
1205 
nvme_command_effects(struct nvme_ctrl * ctrl,struct nvme_ns * ns,u8 opcode)1206 u32 nvme_command_effects(struct nvme_ctrl *ctrl, struct nvme_ns *ns, u8 opcode)
1207 {
1208 	u32 effects = 0;
1209 
1210 	if (ns) {
1211 		effects = le32_to_cpu(ns->head->effects->iocs[opcode]);
1212 		if (effects & ~(NVME_CMD_EFFECTS_CSUPP | NVME_CMD_EFFECTS_LBCC))
1213 			dev_warn_once(ctrl->device,
1214 				"IO command:%02x has unusual effects:%08x\n",
1215 				opcode, effects);
1216 
1217 		/*
1218 		 * NVME_CMD_EFFECTS_CSE_MASK causes a freeze all I/O queues,
1219 		 * which would deadlock when done on an I/O command.  Note that
1220 		 * We already warn about an unusual effect above.
1221 		 */
1222 		effects &= ~NVME_CMD_EFFECTS_CSE_MASK;
1223 	} else {
1224 		effects = le32_to_cpu(ctrl->effects->acs[opcode]);
1225 
1226 		/* Ignore execution restrictions if any relaxation bits are set */
1227 		if (effects & NVME_CMD_EFFECTS_CSER_MASK)
1228 			effects &= ~NVME_CMD_EFFECTS_CSE_MASK;
1229 	}
1230 
1231 	return effects;
1232 }
1233 EXPORT_SYMBOL_NS_GPL(nvme_command_effects, "NVME_TARGET_PASSTHRU");
1234 
nvme_passthru_start(struct nvme_ctrl * ctrl,struct nvme_ns * ns,u8 opcode)1235 u32 nvme_passthru_start(struct nvme_ctrl *ctrl, struct nvme_ns *ns, u8 opcode)
1236 {
1237 	u32 effects = nvme_command_effects(ctrl, ns, opcode);
1238 
1239 	/*
1240 	 * For simplicity, IO to all namespaces is quiesced even if the command
1241 	 * effects say only one namespace is affected.
1242 	 */
1243 	if (effects & NVME_CMD_EFFECTS_CSE_MASK) {
1244 		mutex_lock(&ctrl->scan_lock);
1245 		mutex_lock(&ctrl->subsys->lock);
1246 		nvme_mpath_start_freeze(ctrl->subsys);
1247 		nvme_mpath_wait_freeze(ctrl->subsys);
1248 		nvme_start_freeze(ctrl);
1249 		nvme_wait_freeze(ctrl);
1250 	}
1251 	return effects;
1252 }
1253 EXPORT_SYMBOL_NS_GPL(nvme_passthru_start, "NVME_TARGET_PASSTHRU");
1254 
nvme_passthru_end(struct nvme_ctrl * ctrl,struct nvme_ns * ns,u32 effects,struct nvme_command * cmd,int status)1255 void nvme_passthru_end(struct nvme_ctrl *ctrl, struct nvme_ns *ns, u32 effects,
1256 		       struct nvme_command *cmd, int status)
1257 {
1258 	if (effects & NVME_CMD_EFFECTS_CSE_MASK) {
1259 		nvme_unfreeze(ctrl);
1260 		nvme_mpath_unfreeze(ctrl->subsys);
1261 		mutex_unlock(&ctrl->subsys->lock);
1262 		mutex_unlock(&ctrl->scan_lock);
1263 	}
1264 	if (effects & NVME_CMD_EFFECTS_CCC) {
1265 		if (!test_and_set_bit(NVME_CTRL_DIRTY_CAPABILITY,
1266 				      &ctrl->flags)) {
1267 			dev_info(ctrl->device,
1268 "controller capabilities changed, reset may be required to take effect.\n");
1269 		}
1270 	}
1271 	if (effects & (NVME_CMD_EFFECTS_NIC | NVME_CMD_EFFECTS_NCC)) {
1272 		nvme_queue_scan(ctrl);
1273 		flush_work(&ctrl->scan_work);
1274 	}
1275 	if (ns)
1276 		return;
1277 
1278 	switch (cmd->common.opcode) {
1279 	case nvme_admin_set_features:
1280 		switch (le32_to_cpu(cmd->common.cdw10) & 0xFF) {
1281 		case NVME_FEAT_KATO:
1282 			/*
1283 			 * Keep alive commands interval on the host should be
1284 			 * updated when KATO is modified by Set Features
1285 			 * commands.
1286 			 */
1287 			if (!status)
1288 				nvme_update_keep_alive(ctrl, cmd);
1289 			break;
1290 		default:
1291 			break;
1292 		}
1293 		break;
1294 	default:
1295 		break;
1296 	}
1297 }
1298 EXPORT_SYMBOL_NS_GPL(nvme_passthru_end, "NVME_TARGET_PASSTHRU");
1299 
1300 /*
1301  * Recommended frequency for KATO commands per NVMe 1.4 section 7.12.1:
1302  *
1303  *   The host should send Keep Alive commands at half of the Keep Alive Timeout
1304  *   accounting for transport roundtrip times [..].
1305  */
nvme_keep_alive_work_period(struct nvme_ctrl * ctrl)1306 static unsigned long nvme_keep_alive_work_period(struct nvme_ctrl *ctrl)
1307 {
1308 	unsigned long delay = ctrl->kato * HZ / 2;
1309 
1310 	/*
1311 	 * When using Traffic Based Keep Alive, we need to run
1312 	 * nvme_keep_alive_work at twice the normal frequency, as one
1313 	 * command completion can postpone sending a keep alive command
1314 	 * by up to twice the delay between runs.
1315 	 */
1316 	if (ctrl->ctratt & NVME_CTRL_ATTR_TBKAS)
1317 		delay /= 2;
1318 	return delay;
1319 }
1320 
nvme_queue_keep_alive_work(struct nvme_ctrl * ctrl)1321 static void nvme_queue_keep_alive_work(struct nvme_ctrl *ctrl)
1322 {
1323 	unsigned long now = jiffies;
1324 	unsigned long delay = nvme_keep_alive_work_period(ctrl);
1325 	unsigned long ka_next_check_tm = ctrl->ka_last_check_time + delay;
1326 
1327 	if (time_after(now, ka_next_check_tm))
1328 		delay = 0;
1329 	else
1330 		delay = ka_next_check_tm - now;
1331 
1332 	queue_delayed_work(nvme_wq, &ctrl->ka_work, delay);
1333 }
1334 
nvme_keep_alive_end_io(struct request * rq,blk_status_t status,const struct io_comp_batch * iob)1335 static enum rq_end_io_ret nvme_keep_alive_end_io(struct request *rq,
1336 						 blk_status_t status,
1337 						 const struct io_comp_batch *iob)
1338 {
1339 	struct nvme_ctrl *ctrl = rq->end_io_data;
1340 	unsigned long rtt = jiffies - (rq->deadline - rq->timeout);
1341 	unsigned long delay = nvme_keep_alive_work_period(ctrl);
1342 	enum nvme_ctrl_state state = nvme_ctrl_state(ctrl);
1343 
1344 	/*
1345 	 * Subtract off the keepalive RTT so nvme_keep_alive_work runs
1346 	 * at the desired frequency.
1347 	 */
1348 	if (rtt <= delay) {
1349 		delay -= rtt;
1350 	} else {
1351 		dev_warn(ctrl->device, "long keepalive RTT (%u ms)\n",
1352 			 jiffies_to_msecs(rtt));
1353 		delay = 0;
1354 	}
1355 
1356 	blk_mq_free_request(rq);
1357 
1358 	if (status) {
1359 		dev_err(ctrl->device,
1360 			"failed nvme_keep_alive_end_io error=%d\n",
1361 				status);
1362 		return RQ_END_IO_NONE;
1363 	}
1364 
1365 	ctrl->ka_last_check_time = jiffies;
1366 	ctrl->comp_seen = false;
1367 	if (state == NVME_CTRL_LIVE || state == NVME_CTRL_CONNECTING)
1368 		queue_delayed_work(nvme_wq, &ctrl->ka_work, delay);
1369 	return RQ_END_IO_NONE;
1370 }
1371 
nvme_keep_alive_work(struct work_struct * work)1372 static void nvme_keep_alive_work(struct work_struct *work)
1373 {
1374 	struct nvme_ctrl *ctrl = container_of(to_delayed_work(work),
1375 			struct nvme_ctrl, ka_work);
1376 	bool comp_seen = ctrl->comp_seen;
1377 	struct request *rq;
1378 
1379 	ctrl->ka_last_check_time = jiffies;
1380 
1381 	if ((ctrl->ctratt & NVME_CTRL_ATTR_TBKAS) && comp_seen) {
1382 		dev_dbg(ctrl->device,
1383 			"reschedule traffic based keep-alive timer\n");
1384 		ctrl->comp_seen = false;
1385 		nvme_queue_keep_alive_work(ctrl);
1386 		return;
1387 	}
1388 
1389 	rq = blk_mq_alloc_request(ctrl->admin_q, nvme_req_op(&ctrl->ka_cmd),
1390 				  BLK_MQ_REQ_RESERVED | BLK_MQ_REQ_NOWAIT);
1391 	if (IS_ERR(rq)) {
1392 		/* allocation failure, reset the controller */
1393 		dev_err(ctrl->device, "keep-alive failed: %ld\n", PTR_ERR(rq));
1394 		nvme_reset_ctrl(ctrl);
1395 		return;
1396 	}
1397 	nvme_init_request(rq, &ctrl->ka_cmd);
1398 
1399 	rq->timeout = ctrl->kato * HZ;
1400 	rq->end_io = nvme_keep_alive_end_io;
1401 	rq->end_io_data = ctrl;
1402 	blk_execute_rq_nowait(rq, false);
1403 }
1404 
nvme_start_keep_alive(struct nvme_ctrl * ctrl)1405 static void nvme_start_keep_alive(struct nvme_ctrl *ctrl)
1406 {
1407 	if (unlikely(ctrl->kato == 0))
1408 		return;
1409 
1410 	nvme_queue_keep_alive_work(ctrl);
1411 }
1412 
nvme_stop_keep_alive(struct nvme_ctrl * ctrl)1413 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl)
1414 {
1415 	if (unlikely(ctrl->kato == 0))
1416 		return;
1417 
1418 	cancel_delayed_work_sync(&ctrl->ka_work);
1419 }
1420 EXPORT_SYMBOL_GPL(nvme_stop_keep_alive);
1421 
nvme_update_keep_alive(struct nvme_ctrl * ctrl,struct nvme_command * cmd)1422 static void nvme_update_keep_alive(struct nvme_ctrl *ctrl,
1423 				   struct nvme_command *cmd)
1424 {
1425 	unsigned int new_kato =
1426 		DIV_ROUND_UP(le32_to_cpu(cmd->common.cdw11), 1000);
1427 
1428 	dev_info(ctrl->device,
1429 		 "keep alive interval updated from %u ms to %u ms\n",
1430 		 ctrl->kato * 1000 / 2, new_kato * 1000 / 2);
1431 
1432 	nvme_stop_keep_alive(ctrl);
1433 	ctrl->kato = new_kato;
1434 	nvme_start_keep_alive(ctrl);
1435 }
1436 
nvme_id_cns_ok(struct nvme_ctrl * ctrl,u8 cns)1437 static bool nvme_id_cns_ok(struct nvme_ctrl *ctrl, u8 cns)
1438 {
1439 	/*
1440 	 * The CNS field occupies a full byte starting with NVMe 1.2
1441 	 */
1442 	if (ctrl->vs >= NVME_VS(1, 2, 0))
1443 		return true;
1444 
1445 	/*
1446 	 * NVMe 1.1 expanded the CNS value to two bits, which means values
1447 	 * larger than that could get truncated and treated as an incorrect
1448 	 * value.
1449 	 *
1450 	 * Qemu implemented 1.0 behavior for controllers claiming 1.1
1451 	 * compliance, so they need to be quirked here.
1452 	 */
1453 	if (ctrl->vs >= NVME_VS(1, 1, 0) &&
1454 	    !(ctrl->quirks & NVME_QUIRK_IDENTIFY_CNS))
1455 		return cns <= 3;
1456 
1457 	/*
1458 	 * NVMe 1.0 used a single bit for the CNS value.
1459 	 */
1460 	return cns <= 1;
1461 }
1462 
nvme_identify_ctrl(struct nvme_ctrl * dev,struct nvme_id_ctrl ** id)1463 static int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id)
1464 {
1465 	struct nvme_command c = { };
1466 	int error;
1467 
1468 	/* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1469 	c.identify.opcode = nvme_admin_identify;
1470 	c.identify.cns = NVME_ID_CNS_CTRL;
1471 
1472 	*id = kmalloc_obj(struct nvme_id_ctrl);
1473 	if (!*id)
1474 		return -ENOMEM;
1475 
1476 	error = nvme_submit_sync_cmd(dev->admin_q, &c, *id,
1477 			sizeof(struct nvme_id_ctrl));
1478 	if (error) {
1479 		kfree(*id);
1480 		*id = NULL;
1481 	}
1482 	return error;
1483 }
1484 
nvme_process_ns_desc(struct nvme_ctrl * ctrl,struct nvme_ns_ids * ids,struct nvme_ns_id_desc * cur,bool * csi_seen)1485 static int nvme_process_ns_desc(struct nvme_ctrl *ctrl, struct nvme_ns_ids *ids,
1486 		struct nvme_ns_id_desc *cur, bool *csi_seen)
1487 {
1488 	const char *warn_str = "ctrl returned bogus length:";
1489 	void *data = cur;
1490 
1491 	switch (cur->nidt) {
1492 	case NVME_NIDT_EUI64:
1493 		if (cur->nidl != NVME_NIDT_EUI64_LEN) {
1494 			dev_warn(ctrl->device, "%s %d for NVME_NIDT_EUI64\n",
1495 				 warn_str, cur->nidl);
1496 			return -1;
1497 		}
1498 		if (ctrl->quirks & NVME_QUIRK_BOGUS_NID)
1499 			return NVME_NIDT_EUI64_LEN;
1500 		memcpy(ids->eui64, data + sizeof(*cur), NVME_NIDT_EUI64_LEN);
1501 		return NVME_NIDT_EUI64_LEN;
1502 	case NVME_NIDT_NGUID:
1503 		if (cur->nidl != NVME_NIDT_NGUID_LEN) {
1504 			dev_warn(ctrl->device, "%s %d for NVME_NIDT_NGUID\n",
1505 				 warn_str, cur->nidl);
1506 			return -1;
1507 		}
1508 		if (ctrl->quirks & NVME_QUIRK_BOGUS_NID)
1509 			return NVME_NIDT_NGUID_LEN;
1510 		memcpy(ids->nguid, data + sizeof(*cur), NVME_NIDT_NGUID_LEN);
1511 		return NVME_NIDT_NGUID_LEN;
1512 	case NVME_NIDT_UUID:
1513 		if (cur->nidl != NVME_NIDT_UUID_LEN) {
1514 			dev_warn(ctrl->device, "%s %d for NVME_NIDT_UUID\n",
1515 				 warn_str, cur->nidl);
1516 			return -1;
1517 		}
1518 		if (ctrl->quirks & NVME_QUIRK_BOGUS_NID)
1519 			return NVME_NIDT_UUID_LEN;
1520 		uuid_copy(&ids->uuid, data + sizeof(*cur));
1521 		return NVME_NIDT_UUID_LEN;
1522 	case NVME_NIDT_CSI:
1523 		if (cur->nidl != NVME_NIDT_CSI_LEN) {
1524 			dev_warn(ctrl->device, "%s %d for NVME_NIDT_CSI\n",
1525 				 warn_str, cur->nidl);
1526 			return -1;
1527 		}
1528 		memcpy(&ids->csi, data + sizeof(*cur), NVME_NIDT_CSI_LEN);
1529 		*csi_seen = true;
1530 		return NVME_NIDT_CSI_LEN;
1531 	default:
1532 		/* Skip unknown types */
1533 		return cur->nidl;
1534 	}
1535 }
1536 
nvme_identify_ns_descs(struct nvme_ctrl * ctrl,struct nvme_ns_info * info)1537 static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl,
1538 		struct nvme_ns_info *info)
1539 {
1540 	struct nvme_command c = { };
1541 	bool csi_seen = false;
1542 	int status, pos, len;
1543 	void *data;
1544 
1545 	if (ctrl->vs < NVME_VS(1, 3, 0) && !nvme_multi_css(ctrl))
1546 		return 0;
1547 	if (ctrl->quirks & NVME_QUIRK_NO_NS_DESC_LIST)
1548 		return 0;
1549 
1550 	c.identify.opcode = nvme_admin_identify;
1551 	c.identify.nsid = cpu_to_le32(info->nsid);
1552 	c.identify.cns = NVME_ID_CNS_NS_DESC_LIST;
1553 
1554 	data = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
1555 	if (!data)
1556 		return -ENOMEM;
1557 
1558 	status = nvme_submit_sync_cmd(ctrl->admin_q, &c, data,
1559 				      NVME_IDENTIFY_DATA_SIZE);
1560 	if (status) {
1561 		dev_warn(ctrl->device,
1562 			"Identify Descriptors failed (nsid=%u, status=0x%x)\n",
1563 			info->nsid, status);
1564 		goto free_data;
1565 	}
1566 
1567 	for (pos = 0; pos < NVME_IDENTIFY_DATA_SIZE; pos += len) {
1568 		struct nvme_ns_id_desc *cur = data + pos;
1569 
1570 		if (cur->nidl == 0)
1571 			break;
1572 
1573 		len = nvme_process_ns_desc(ctrl, &info->ids, cur, &csi_seen);
1574 		if (len < 0)
1575 			break;
1576 
1577 		len += sizeof(*cur);
1578 	}
1579 
1580 	if (nvme_multi_css(ctrl) && !csi_seen) {
1581 		dev_warn(ctrl->device, "Command set not reported for nsid:%d\n",
1582 			 info->nsid);
1583 		status = -EINVAL;
1584 	}
1585 
1586 free_data:
1587 	kfree(data);
1588 	return status;
1589 }
1590 
nvme_identify_ns(struct nvme_ctrl * ctrl,unsigned nsid,struct nvme_id_ns ** id)1591 int nvme_identify_ns(struct nvme_ctrl *ctrl, unsigned nsid,
1592 			struct nvme_id_ns **id)
1593 {
1594 	struct nvme_command c = { };
1595 	int error;
1596 
1597 	/* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1598 	c.identify.opcode = nvme_admin_identify;
1599 	c.identify.nsid = cpu_to_le32(nsid);
1600 	c.identify.cns = NVME_ID_CNS_NS;
1601 
1602 	*id = kmalloc_obj(**id);
1603 	if (!*id)
1604 		return -ENOMEM;
1605 
1606 	error = nvme_submit_sync_cmd(ctrl->admin_q, &c, *id, sizeof(**id));
1607 	if (error) {
1608 		dev_warn(ctrl->device, "Identify namespace failed (%d)\n", error);
1609 		kfree(*id);
1610 		*id = NULL;
1611 	}
1612 	return error;
1613 }
1614 
nvme_ns_info_from_identify(struct nvme_ctrl * ctrl,struct nvme_ns_info * info)1615 static int nvme_ns_info_from_identify(struct nvme_ctrl *ctrl,
1616 		struct nvme_ns_info *info)
1617 {
1618 	struct nvme_ns_ids *ids = &info->ids;
1619 	struct nvme_id_ns *id;
1620 	int ret;
1621 
1622 	ret = nvme_identify_ns(ctrl, info->nsid, &id);
1623 	if (ret)
1624 		return ret;
1625 
1626 	if (id->ncap == 0) {
1627 		/* namespace not allocated or attached */
1628 		info->is_removed = true;
1629 		ret = -ENODEV;
1630 		goto error;
1631 	}
1632 
1633 	info->anagrpid = id->anagrpid;
1634 	info->is_shared = id->nmic & NVME_NS_NMIC_SHARED;
1635 	info->is_readonly = id->nsattr & NVME_NS_ATTR_RO;
1636 	info->is_ready = true;
1637 	info->endgid = le16_to_cpu(id->endgid);
1638 	if (ctrl->quirks & NVME_QUIRK_BOGUS_NID) {
1639 		dev_info(ctrl->device,
1640 			 "Ignoring bogus Namespace Identifiers\n");
1641 	} else {
1642 		if (ctrl->vs >= NVME_VS(1, 1, 0) &&
1643 		    !memchr_inv(ids->eui64, 0, sizeof(ids->eui64)))
1644 			memcpy(ids->eui64, id->eui64, sizeof(ids->eui64));
1645 		if (ctrl->vs >= NVME_VS(1, 2, 0) &&
1646 		    !memchr_inv(ids->nguid, 0, sizeof(ids->nguid)))
1647 			memcpy(ids->nguid, id->nguid, sizeof(ids->nguid));
1648 	}
1649 
1650 error:
1651 	kfree(id);
1652 	return ret;
1653 }
1654 
nvme_ns_info_from_id_cs_indep(struct nvme_ctrl * ctrl,struct nvme_ns_info * info)1655 static int nvme_ns_info_from_id_cs_indep(struct nvme_ctrl *ctrl,
1656 		struct nvme_ns_info *info)
1657 {
1658 	struct nvme_id_ns_cs_indep *id;
1659 	struct nvme_command c = {
1660 		.identify.opcode	= nvme_admin_identify,
1661 		.identify.nsid		= cpu_to_le32(info->nsid),
1662 		.identify.cns		= NVME_ID_CNS_NS_CS_INDEP,
1663 	};
1664 	int ret;
1665 
1666 	id = kmalloc_obj(*id);
1667 	if (!id)
1668 		return -ENOMEM;
1669 
1670 	ret = nvme_submit_sync_cmd(ctrl->admin_q, &c, id, sizeof(*id));
1671 	if (!ret) {
1672 		info->anagrpid = id->anagrpid;
1673 		info->is_shared = id->nmic & NVME_NS_NMIC_SHARED;
1674 		info->is_readonly = id->nsattr & NVME_NS_ATTR_RO;
1675 		info->is_ready = id->nstat & NVME_NSTAT_NRDY;
1676 		info->is_rotational = id->nsfeat & NVME_NS_ROTATIONAL;
1677 		info->no_vwc = id->nsfeat & NVME_NS_VWC_NOT_PRESENT;
1678 		info->endgid = le16_to_cpu(id->endgid);
1679 	}
1680 	kfree(id);
1681 	return ret;
1682 }
1683 
nvme_features(struct nvme_ctrl * dev,u8 op,unsigned int fid,unsigned int dword11,void * buffer,size_t buflen,u32 * result)1684 static int nvme_features(struct nvme_ctrl *dev, u8 op, unsigned int fid,
1685 		unsigned int dword11, void *buffer, size_t buflen, u32 *result)
1686 {
1687 	union nvme_result res = { 0 };
1688 	struct nvme_command c = { };
1689 	int ret;
1690 
1691 	c.features.opcode = op;
1692 	c.features.fid = cpu_to_le32(fid);
1693 	c.features.dword11 = cpu_to_le32(dword11);
1694 
1695 	ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &res,
1696 			buffer, buflen, NVME_QID_ANY, 0);
1697 	if (ret >= 0 && result)
1698 		*result = le32_to_cpu(res.u32);
1699 	return ret;
1700 }
1701 
nvme_set_features(struct nvme_ctrl * dev,unsigned int fid,unsigned int dword11,void * buffer,size_t buflen,void * result)1702 int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid,
1703 		      unsigned int dword11, void *buffer, size_t buflen,
1704 		      void *result)
1705 {
1706 	return nvme_features(dev, nvme_admin_set_features, fid, dword11, buffer,
1707 			     buflen, result);
1708 }
1709 EXPORT_SYMBOL_GPL(nvme_set_features);
1710 
nvme_get_features(struct nvme_ctrl * dev,unsigned int fid,unsigned int dword11,void * buffer,size_t buflen,void * result)1711 int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid,
1712 		      unsigned int dword11, void *buffer, size_t buflen,
1713 		      void *result)
1714 {
1715 	return nvme_features(dev, nvme_admin_get_features, fid, dword11, buffer,
1716 			     buflen, result);
1717 }
1718 EXPORT_SYMBOL_GPL(nvme_get_features);
1719 
nvme_set_queue_count(struct nvme_ctrl * ctrl,int * count)1720 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count)
1721 {
1722 	u32 q_count = (*count - 1) | ((*count - 1) << 16);
1723 	u32 result;
1724 	int status, nr_io_queues;
1725 
1726 	status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, NULL, 0,
1727 			&result);
1728 
1729 	/*
1730 	 * It's either a kernel error or the host observed a connection
1731 	 * lost. In either case it's not possible communicate with the
1732 	 * controller and thus enter the error code path.
1733 	 */
1734 	if (status < 0 || status == NVME_SC_HOST_PATH_ERROR)
1735 		return status;
1736 
1737 	/*
1738 	 * Degraded controllers might return an error when setting the queue
1739 	 * count.  We still want to be able to bring them online and offer
1740 	 * access to the admin queue, as that might be only way to fix them up.
1741 	 */
1742 	if (status > 0) {
1743 		dev_err(ctrl->device, "Could not set queue count (%d)\n", status);
1744 		*count = 0;
1745 	} else {
1746 		nr_io_queues = min(result & 0xffff, result >> 16) + 1;
1747 		*count = min(*count, nr_io_queues);
1748 	}
1749 
1750 	return 0;
1751 }
1752 EXPORT_SYMBOL_GPL(nvme_set_queue_count);
1753 
1754 #define NVME_AEN_SUPPORTED \
1755 	(NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_FW_ACT | \
1756 	 NVME_AEN_CFG_ANA_CHANGE | NVME_AEN_CFG_DISC_CHANGE)
1757 
nvme_enable_aen(struct nvme_ctrl * ctrl)1758 static void nvme_enable_aen(struct nvme_ctrl *ctrl)
1759 {
1760 	u32 result, supported_aens = ctrl->oaes & NVME_AEN_SUPPORTED;
1761 	int status;
1762 
1763 	if (!supported_aens)
1764 		return;
1765 
1766 	status = nvme_set_features(ctrl, NVME_FEAT_ASYNC_EVENT, supported_aens,
1767 			NULL, 0, &result);
1768 	if (status)
1769 		dev_warn(ctrl->device, "Failed to configure AEN (cfg %x)\n",
1770 			 supported_aens);
1771 
1772 	queue_work(nvme_wq, &ctrl->async_event_work);
1773 }
1774 
nvme_ns_open(struct nvme_ns * ns)1775 static int nvme_ns_open(struct nvme_ns *ns)
1776 {
1777 
1778 	/* should never be called due to GENHD_FL_HIDDEN */
1779 	if (WARN_ON_ONCE(nvme_ns_head_multipath(ns->head)))
1780 		goto fail;
1781 	if (!nvme_get_ns(ns))
1782 		goto fail;
1783 	if (!try_module_get(ns->ctrl->ops->module))
1784 		goto fail_put_ns;
1785 
1786 	return 0;
1787 
1788 fail_put_ns:
1789 	nvme_put_ns(ns);
1790 fail:
1791 	return -ENXIO;
1792 }
1793 
nvme_ns_release(struct nvme_ns * ns)1794 static void nvme_ns_release(struct nvme_ns *ns)
1795 {
1796 
1797 	module_put(ns->ctrl->ops->module);
1798 	nvme_put_ns(ns);
1799 }
1800 
nvme_open(struct gendisk * disk,blk_mode_t mode)1801 static int nvme_open(struct gendisk *disk, blk_mode_t mode)
1802 {
1803 	return nvme_ns_open(disk->private_data);
1804 }
1805 
nvme_release(struct gendisk * disk)1806 static void nvme_release(struct gendisk *disk)
1807 {
1808 	nvme_ns_release(disk->private_data);
1809 }
1810 
nvme_getgeo(struct gendisk * disk,struct hd_geometry * geo)1811 int nvme_getgeo(struct gendisk *disk, struct hd_geometry *geo)
1812 {
1813 	/* some standard values */
1814 	geo->heads = 1 << 6;
1815 	geo->sectors = 1 << 5;
1816 	geo->cylinders = get_capacity(disk) >> 11;
1817 	return 0;
1818 }
1819 
nvme_init_integrity(struct nvme_ns_head * head,struct queue_limits * lim,struct nvme_ns_info * info)1820 static bool nvme_init_integrity(struct nvme_ns_head *head,
1821 		struct queue_limits *lim, struct nvme_ns_info *info)
1822 {
1823 	struct blk_integrity *bi = &lim->integrity;
1824 
1825 	memset(bi, 0, sizeof(*bi));
1826 
1827 	if (!head->ms)
1828 		return true;
1829 
1830 	/*
1831 	 * PI can always be supported as we can ask the controller to simply
1832 	 * insert/strip it, which is not possible for other kinds of metadata.
1833 	 */
1834 	if (!IS_ENABLED(CONFIG_BLK_DEV_INTEGRITY) ||
1835 	    !(head->features & NVME_NS_METADATA_SUPPORTED))
1836 		return nvme_ns_has_pi(head);
1837 
1838 	switch (head->pi_type) {
1839 	case NVME_NS_DPS_PI_TYPE3:
1840 		switch (head->guard_type) {
1841 		case NVME_NVM_NS_16B_GUARD:
1842 			bi->csum_type = BLK_INTEGRITY_CSUM_CRC;
1843 			bi->tag_size = sizeof(u16) + sizeof(u32);
1844 			bi->flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1845 			break;
1846 		case NVME_NVM_NS_64B_GUARD:
1847 			bi->csum_type = BLK_INTEGRITY_CSUM_CRC64;
1848 			bi->tag_size = sizeof(u16) + 6;
1849 			bi->flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1850 			break;
1851 		default:
1852 			break;
1853 		}
1854 		break;
1855 	case NVME_NS_DPS_PI_TYPE1:
1856 	case NVME_NS_DPS_PI_TYPE2:
1857 		switch (head->guard_type) {
1858 		case NVME_NVM_NS_16B_GUARD:
1859 			bi->csum_type = BLK_INTEGRITY_CSUM_CRC;
1860 			bi->tag_size = sizeof(u16);
1861 			bi->flags |= BLK_INTEGRITY_DEVICE_CAPABLE |
1862 				     BLK_INTEGRITY_REF_TAG;
1863 			break;
1864 		case NVME_NVM_NS_64B_GUARD:
1865 			bi->csum_type = BLK_INTEGRITY_CSUM_CRC64;
1866 			bi->tag_size = sizeof(u16);
1867 			bi->flags |= BLK_INTEGRITY_DEVICE_CAPABLE |
1868 				     BLK_INTEGRITY_REF_TAG;
1869 			break;
1870 		default:
1871 			break;
1872 		}
1873 		break;
1874 	default:
1875 		break;
1876 	}
1877 
1878 	bi->flags |= BLK_SPLIT_INTERVAL_CAPABLE;
1879 	bi->metadata_size = head->ms;
1880 	if (bi->csum_type) {
1881 		bi->pi_tuple_size = head->pi_size;
1882 		bi->pi_offset = info->pi_offset;
1883 	}
1884 	return true;
1885 }
1886 
nvme_ns_ids_equal(struct nvme_ns_ids * a,struct nvme_ns_ids * b)1887 static bool nvme_ns_ids_equal(struct nvme_ns_ids *a, struct nvme_ns_ids *b)
1888 {
1889 	return uuid_equal(&a->uuid, &b->uuid) &&
1890 		memcmp(&a->nguid, &b->nguid, sizeof(a->nguid)) == 0 &&
1891 		memcmp(&a->eui64, &b->eui64, sizeof(a->eui64)) == 0 &&
1892 		a->csi == b->csi;
1893 }
1894 
nvme_identify_ns_nvm(struct nvme_ctrl * ctrl,unsigned int nsid,struct nvme_id_ns_nvm ** nvmp)1895 static int nvme_identify_ns_nvm(struct nvme_ctrl *ctrl, unsigned int nsid,
1896 		struct nvme_id_ns_nvm **nvmp)
1897 {
1898 	struct nvme_command c = {
1899 		.identify.opcode	= nvme_admin_identify,
1900 		.identify.nsid		= cpu_to_le32(nsid),
1901 		.identify.cns		= NVME_ID_CNS_CS_NS,
1902 		.identify.csi		= NVME_CSI_NVM,
1903 	};
1904 	struct nvme_id_ns_nvm *nvm;
1905 	int ret;
1906 
1907 	nvm = kzalloc_obj(*nvm);
1908 	if (!nvm)
1909 		return -ENOMEM;
1910 
1911 	ret = nvme_submit_sync_cmd(ctrl->admin_q, &c, nvm, sizeof(*nvm));
1912 	if (ret)
1913 		kfree(nvm);
1914 	else
1915 		*nvmp = nvm;
1916 	return ret;
1917 }
1918 
nvme_configure_pi_elbas(struct nvme_ns_head * head,struct nvme_id_ns * id,struct nvme_id_ns_nvm * nvm)1919 static void nvme_configure_pi_elbas(struct nvme_ns_head *head,
1920 		struct nvme_id_ns *id, struct nvme_id_ns_nvm *nvm)
1921 {
1922 	u32 elbaf = le32_to_cpu(nvm->elbaf[nvme_lbaf_index(id->flbas)]);
1923 	u8 guard_type;
1924 
1925 	/* no support for storage tag formats right now */
1926 	if (nvme_elbaf_sts(elbaf))
1927 		return;
1928 
1929 	guard_type = nvme_elbaf_guard_type(elbaf);
1930 	if ((nvm->pic & NVME_ID_NS_NVM_QPIFS) &&
1931 	     guard_type == NVME_NVM_NS_QTYPE_GUARD)
1932 		guard_type = nvme_elbaf_qualified_guard_type(elbaf);
1933 
1934 	head->guard_type = guard_type;
1935 	switch (head->guard_type) {
1936 	case NVME_NVM_NS_64B_GUARD:
1937 		head->pi_size = sizeof(struct crc64_pi_tuple);
1938 		break;
1939 	case NVME_NVM_NS_16B_GUARD:
1940 		head->pi_size = sizeof(struct t10_pi_tuple);
1941 		break;
1942 	default:
1943 		break;
1944 	}
1945 }
1946 
nvme_configure_metadata(struct nvme_ctrl * ctrl,struct nvme_ns_head * head,struct nvme_id_ns * id,struct nvme_id_ns_nvm * nvm,struct nvme_ns_info * info)1947 static void nvme_configure_metadata(struct nvme_ctrl *ctrl,
1948 		struct nvme_ns_head *head, struct nvme_id_ns *id,
1949 		struct nvme_id_ns_nvm *nvm, struct nvme_ns_info *info)
1950 {
1951 	head->features &= ~(NVME_NS_METADATA_SUPPORTED | NVME_NS_EXT_LBAS);
1952 	head->pi_type = 0;
1953 	head->pi_size = 0;
1954 	head->ms = le16_to_cpu(id->lbaf[nvme_lbaf_index(id->flbas)].ms);
1955 	if (!head->ms || !(ctrl->ops->flags & NVME_F_METADATA_SUPPORTED))
1956 		return;
1957 
1958 	if (nvm && (ctrl->ctratt & NVME_CTRL_ATTR_ELBAS)) {
1959 		nvme_configure_pi_elbas(head, id, nvm);
1960 	} else {
1961 		head->pi_size = sizeof(struct t10_pi_tuple);
1962 		head->guard_type = NVME_NVM_NS_16B_GUARD;
1963 	}
1964 
1965 	if (head->pi_size && head->ms >= head->pi_size)
1966 		head->pi_type = id->dps & NVME_NS_DPS_PI_MASK;
1967 	if (!(id->dps & NVME_NS_DPS_PI_FIRST)) {
1968 		if (disable_pi_offsets)
1969 			head->pi_type = 0;
1970 		else
1971 			info->pi_offset = head->ms - head->pi_size;
1972 	}
1973 
1974 	if (ctrl->ops->flags & NVME_F_FABRICS) {
1975 		/*
1976 		 * The NVMe over Fabrics specification only supports metadata as
1977 		 * part of the extended data LBA.  We rely on HCA/HBA support to
1978 		 * remap the separate metadata buffer from the block layer.
1979 		 */
1980 		if (WARN_ON_ONCE(!(id->flbas & NVME_NS_FLBAS_META_EXT)))
1981 			return;
1982 
1983 		head->features |= NVME_NS_EXT_LBAS;
1984 
1985 		/*
1986 		 * The current fabrics transport drivers support namespace
1987 		 * metadata formats only if nvme_ns_has_pi() returns true.
1988 		 * Suppress support for all other formats so the namespace will
1989 		 * have a 0 capacity and not be usable through the block stack.
1990 		 *
1991 		 * Note, this check will need to be modified if any drivers
1992 		 * gain the ability to use other metadata formats.
1993 		 */
1994 		if (ctrl->max_integrity_segments && nvme_ns_has_pi(head))
1995 			head->features |= NVME_NS_METADATA_SUPPORTED;
1996 	} else {
1997 		/*
1998 		 * For PCIe controllers, we can't easily remap the separate
1999 		 * metadata buffer from the block layer and thus require a
2000 		 * separate metadata buffer for block layer metadata/PI support.
2001 		 * We allow extended LBAs for the passthrough interface, though.
2002 		 */
2003 		if (id->flbas & NVME_NS_FLBAS_META_EXT)
2004 			head->features |= NVME_NS_EXT_LBAS;
2005 		else
2006 			head->features |= NVME_NS_METADATA_SUPPORTED;
2007 	}
2008 }
2009 
2010 
nvme_configure_atomic_write(struct nvme_ns * ns,struct nvme_id_ns * id,struct queue_limits * lim,u32 bs)2011 static u32 nvme_configure_atomic_write(struct nvme_ns *ns,
2012 		struct nvme_id_ns *id, struct queue_limits *lim, u32 bs)
2013 {
2014 	u32 atomic_bs, boundary = 0;
2015 
2016 	/*
2017 	 * We do not support an offset for the atomic boundaries.
2018 	 */
2019 	if (id->nabo)
2020 		return bs;
2021 
2022 	if ((id->nsfeat & NVME_NS_FEAT_ATOMICS) && id->nawupf) {
2023 		/*
2024 		 * Use the per-namespace atomic write unit when available.
2025 		 */
2026 		atomic_bs = (1 + le16_to_cpu(id->nawupf)) * bs;
2027 		if (id->nabspf)
2028 			boundary = (le16_to_cpu(id->nabspf) + 1) * bs;
2029 	} else {
2030 		if (ns->ctrl->awupf)
2031 			dev_info_once(ns->ctrl->device,
2032 				"AWUPF ignored, only NAWUPF accepted\n");
2033 		atomic_bs = bs;
2034 	}
2035 
2036 	lim->atomic_write_hw_max = atomic_bs;
2037 	lim->atomic_write_hw_boundary = boundary;
2038 	lim->atomic_write_hw_unit_min = bs;
2039 	lim->atomic_write_hw_unit_max = rounddown_pow_of_two(atomic_bs);
2040 	lim->features |= BLK_FEAT_ATOMIC_WRITES;
2041 	return atomic_bs;
2042 }
2043 
nvme_max_drv_segments(struct nvme_ctrl * ctrl)2044 static u32 nvme_max_drv_segments(struct nvme_ctrl *ctrl)
2045 {
2046 	return ctrl->max_hw_sectors / (NVME_CTRL_PAGE_SIZE >> SECTOR_SHIFT) + 1;
2047 }
2048 
nvme_set_ctrl_limits(struct nvme_ctrl * ctrl,struct queue_limits * lim,bool is_admin)2049 static void nvme_set_ctrl_limits(struct nvme_ctrl *ctrl,
2050 		struct queue_limits *lim, bool is_admin)
2051 {
2052 	lim->max_hw_sectors = ctrl->max_hw_sectors;
2053 	lim->max_segments = min_t(u32, USHRT_MAX,
2054 		min_not_zero(nvme_max_drv_segments(ctrl), ctrl->max_segments));
2055 	lim->max_integrity_segments = ctrl->max_integrity_segments;
2056 	lim->virt_boundary_mask = ctrl->ops->get_virt_boundary(ctrl, is_admin);
2057 	lim->max_segment_size = UINT_MAX;
2058 	lim->dma_alignment = 3;
2059 }
2060 
nvme_update_disk_info(struct nvme_ns * ns,struct nvme_id_ns * id,struct nvme_id_ns_nvm * nvm,struct queue_limits * lim)2061 static bool nvme_update_disk_info(struct nvme_ns *ns, struct nvme_id_ns *id,
2062 		struct nvme_id_ns_nvm *nvm, struct queue_limits *lim)
2063 {
2064 	struct nvme_ns_head *head = ns->head;
2065 	struct nvme_ctrl *ctrl = ns->ctrl;
2066 	u32 bs = 1U << head->lba_shift;
2067 	u32 atomic_bs, phys_bs, io_opt = 0;
2068 	u32 npdg = 1, npda = 1;
2069 	bool valid = true;
2070 	u8 optperf;
2071 
2072 	/*
2073 	 * The block layer can't support LBA sizes larger than the page size
2074 	 * or smaller than a sector size yet, so catch this early and don't
2075 	 * allow block I/O.
2076 	 */
2077 	if (blk_validate_block_size(bs)) {
2078 		bs = (1 << 9);
2079 		valid = false;
2080 	}
2081 
2082 	phys_bs = bs;
2083 	atomic_bs = nvme_configure_atomic_write(ns, id, lim, bs);
2084 
2085 	optperf = id->nsfeat >> NVME_NS_FEAT_OPTPERF_SHIFT;
2086 	if (ctrl->vs >= NVME_VS(2, 1, 0))
2087 		optperf &= NVME_NS_FEAT_OPTPERF_MASK_2_1;
2088 	else
2089 		optperf &= NVME_NS_FEAT_OPTPERF_MASK;
2090 	if (optperf) {
2091 		/* NPWG = Namespace Preferred Write Granularity */
2092 		phys_bs = bs * (1 + le16_to_cpu(id->npwg));
2093 		/* NOWS = Namespace Optimal Write Size */
2094 		if (id->nows)
2095 			io_opt = bs * (1 + le16_to_cpu(id->nows));
2096 	}
2097 
2098 	/*
2099 	 * Linux filesystems assume writing a single physical block is
2100 	 * an atomic operation. Hence limit the physical block size to the
2101 	 * value of the Atomic Write Unit Power Fail parameter.
2102 	 */
2103 	lim->logical_block_size = bs;
2104 	lim->physical_block_size = min(phys_bs, atomic_bs);
2105 	lim->io_min = phys_bs;
2106 	lim->io_opt = io_opt;
2107 	if ((ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES) &&
2108 	    (ctrl->oncs & NVME_CTRL_ONCS_DSM))
2109 		lim->max_write_zeroes_sectors = UINT_MAX;
2110 	else
2111 		lim->max_write_zeroes_sectors = ctrl->max_zeroes_sectors;
2112 
2113 	if (ctrl->dmrsl && ctrl->dmrsl <= nvme_sect_to_lba(ns->head, UINT_MAX))
2114 		lim->max_hw_discard_sectors =
2115 			nvme_lba_to_sect(ns->head, ctrl->dmrsl);
2116 	else if (ctrl->oncs & NVME_CTRL_ONCS_DSM)
2117 		lim->max_hw_discard_sectors = UINT_MAX;
2118 	else
2119 		lim->max_hw_discard_sectors = 0;
2120 
2121 	/*
2122 	 * NVMe namespaces advertise both a preferred deallocate granularity
2123 	 * (for a discard length) and alignment (for a discard starting offset).
2124 	 * However, Linux block devices advertise a single discard_granularity.
2125 	 * From NVM Command Set specification 1.1 section 5.2.2, the NPDGL/NPDAL
2126 	 * fields in the NVM Command Set Specific Identify Namespace structure
2127 	 * are preferred to NPDG/NPDA in the Identify Namespace structure since
2128 	 * they can represent larger values. However, NPDGL or NPDAL may be 0 if
2129 	 * unsupported. NPDG and NPDA are 0's based.
2130 	 * From Figure 115 of NVM Command Set specification 1.1, NPDGL and NPDAL
2131 	 * are supported if the high bit of OPTPERF is set. NPDG is supported if
2132 	 * the low bit of OPTPERF is set. NPDA is supported if either is set.
2133 	 * NPDG should be a multiple of NPDA, and likewise NPDGL should be a
2134 	 * multiple of NPDAL, but the spec doesn't say anything about NPDG vs.
2135 	 * NPDAL or NPDGL vs. NPDA. So compute the maximum instead of assuming
2136 	 * NPDG(L) is the larger. If neither NPDG, NPDGL, NPDA, nor NPDAL are
2137 	 * supported, default the discard_granularity to the logical block size.
2138 	 */
2139 	if (optperf & 0x2 && nvm && nvm->npdgl)
2140 		npdg = le32_to_cpu(nvm->npdgl);
2141 	else if (optperf & 0x1)
2142 		npdg = from0based(id->npdg);
2143 	if (optperf & 0x2 && nvm && nvm->npdal)
2144 		npda = le32_to_cpu(nvm->npdal);
2145 	else if (optperf)
2146 		npda = from0based(id->npda);
2147 	if (check_mul_overflow(max(npdg, npda), lim->logical_block_size,
2148 			       &lim->discard_granularity))
2149 		lim->discard_granularity = lim->logical_block_size;
2150 
2151 	if (ctrl->dmrl)
2152 		lim->max_discard_segments = ctrl->dmrl;
2153 	else
2154 		lim->max_discard_segments = NVME_DSM_MAX_RANGES;
2155 	return valid;
2156 }
2157 
nvme_ns_is_readonly(struct nvme_ns * ns,struct nvme_ns_info * info)2158 static bool nvme_ns_is_readonly(struct nvme_ns *ns, struct nvme_ns_info *info)
2159 {
2160 	return info->is_readonly || test_bit(NVME_NS_FORCE_RO, &ns->flags);
2161 }
2162 
nvme_first_scan(struct gendisk * disk)2163 static inline bool nvme_first_scan(struct gendisk *disk)
2164 {
2165 	/* nvme_alloc_ns() scans the disk prior to adding it */
2166 	return !disk_live(disk);
2167 }
2168 
nvme_set_chunk_sectors(struct nvme_ns * ns,struct nvme_id_ns * id,struct queue_limits * lim)2169 static void nvme_set_chunk_sectors(struct nvme_ns *ns, struct nvme_id_ns *id,
2170 		struct queue_limits *lim)
2171 {
2172 	struct nvme_ctrl *ctrl = ns->ctrl;
2173 	u32 iob;
2174 
2175 	if ((ctrl->quirks & NVME_QUIRK_STRIPE_SIZE) &&
2176 	    is_power_of_2(ctrl->max_hw_sectors))
2177 		iob = ctrl->max_hw_sectors;
2178 	else
2179 		iob = nvme_lba_to_sect(ns->head, le16_to_cpu(id->noiob));
2180 
2181 	if (!iob)
2182 		return;
2183 
2184 	if (!is_power_of_2(iob)) {
2185 		if (nvme_first_scan(ns->disk))
2186 			pr_warn("%s: ignoring unaligned IO boundary:%u\n",
2187 				ns->disk->disk_name, iob);
2188 		return;
2189 	}
2190 
2191 	if (blk_queue_is_zoned(ns->disk->queue)) {
2192 		if (nvme_first_scan(ns->disk))
2193 			pr_warn("%s: ignoring zoned namespace IO boundary\n",
2194 				ns->disk->disk_name);
2195 		return;
2196 	}
2197 
2198 	lim->chunk_sectors = iob;
2199 }
2200 
nvme_update_ns_info_generic(struct nvme_ns * ns,struct nvme_ns_info * info)2201 static int nvme_update_ns_info_generic(struct nvme_ns *ns,
2202 		struct nvme_ns_info *info)
2203 {
2204 	struct queue_limits lim;
2205 	unsigned int memflags;
2206 	int ret;
2207 
2208 	lim = queue_limits_start_update(ns->disk->queue);
2209 	nvme_set_ctrl_limits(ns->ctrl, &lim, false);
2210 
2211 	memflags = blk_mq_freeze_queue(ns->disk->queue);
2212 	ret = queue_limits_commit_update(ns->disk->queue, &lim);
2213 	set_disk_ro(ns->disk, nvme_ns_is_readonly(ns, info));
2214 	blk_mq_unfreeze_queue(ns->disk->queue, memflags);
2215 
2216 	/* Hide the block-interface for these devices */
2217 	if (!ret)
2218 		ret = -ENODEV;
2219 	return ret;
2220 }
2221 
nvme_query_fdp_granularity(struct nvme_ctrl * ctrl,struct nvme_ns_info * info,u8 fdp_idx)2222 static int nvme_query_fdp_granularity(struct nvme_ctrl *ctrl,
2223 				      struct nvme_ns_info *info, u8 fdp_idx)
2224 {
2225 	struct nvme_fdp_config_log hdr, *h;
2226 	struct nvme_fdp_config_desc *desc;
2227 	size_t size = sizeof(hdr);
2228 	void *log, *end;
2229 	int i, n, ret;
2230 
2231 	ret = nvme_get_log_lsi(ctrl, 0, NVME_LOG_FDP_CONFIGS, 0,
2232 			       NVME_CSI_NVM, &hdr, size, 0, info->endgid);
2233 	if (ret) {
2234 		dev_warn(ctrl->device,
2235 			 "FDP configs log header status:0x%x endgid:%d\n", ret,
2236 			 info->endgid);
2237 		return ret;
2238 	}
2239 
2240 	size = le32_to_cpu(hdr.sze);
2241 	if (size > PAGE_SIZE * MAX_ORDER_NR_PAGES) {
2242 		dev_warn(ctrl->device, "FDP config size too large:%zu\n",
2243 			 size);
2244 		return 0;
2245 	}
2246 
2247 	h = kvmalloc(size, GFP_KERNEL);
2248 	if (!h)
2249 		return -ENOMEM;
2250 
2251 	ret = nvme_get_log_lsi(ctrl, 0, NVME_LOG_FDP_CONFIGS, 0,
2252 			       NVME_CSI_NVM, h, size, 0, info->endgid);
2253 	if (ret) {
2254 		dev_warn(ctrl->device,
2255 			 "FDP configs log status:0x%x endgid:%d\n", ret,
2256 			 info->endgid);
2257 		goto out;
2258 	}
2259 
2260 	n = le16_to_cpu(h->numfdpc) + 1;
2261 	if (fdp_idx > n) {
2262 		dev_warn(ctrl->device, "FDP index:%d out of range:%d\n",
2263 			 fdp_idx, n);
2264 		/* Proceed without registering FDP streams */
2265 		ret = 0;
2266 		goto out;
2267 	}
2268 
2269 	log = h + 1;
2270 	desc = log;
2271 	end = log + size - sizeof(*h);
2272 	for (i = 0; i < fdp_idx; i++) {
2273 		log += le16_to_cpu(desc->dsze);
2274 		desc = log;
2275 		if (log >= end) {
2276 			dev_warn(ctrl->device,
2277 				 "FDP invalid config descriptor list\n");
2278 			ret = 0;
2279 			goto out;
2280 		}
2281 	}
2282 
2283 	if (le32_to_cpu(desc->nrg) > 1) {
2284 		dev_warn(ctrl->device, "FDP NRG > 1 not supported\n");
2285 		ret = 0;
2286 		goto out;
2287 	}
2288 
2289 	info->runs = le64_to_cpu(desc->runs);
2290 out:
2291 	kvfree(h);
2292 	return ret;
2293 }
2294 
nvme_query_fdp_info(struct nvme_ns * ns,struct nvme_ns_info * info)2295 static int nvme_query_fdp_info(struct nvme_ns *ns, struct nvme_ns_info *info)
2296 {
2297 	struct nvme_ns_head *head = ns->head;
2298 	struct nvme_ctrl *ctrl = ns->ctrl;
2299 	struct nvme_fdp_ruh_status *ruhs;
2300 	struct nvme_fdp_config fdp;
2301 	struct nvme_command c = {};
2302 	size_t size;
2303 	int i, ret;
2304 
2305 	/*
2306 	 * The FDP configuration is static for the lifetime of the namespace,
2307 	 * so return immediately if we've already registered this namespace's
2308 	 * streams.
2309 	 */
2310 	if (head->nr_plids)
2311 		return 0;
2312 
2313 	ret = nvme_get_features(ctrl, NVME_FEAT_FDP, info->endgid, NULL, 0,
2314 				&fdp);
2315 	if (ret) {
2316 		dev_warn(ctrl->device, "FDP get feature status:0x%x\n", ret);
2317 		return ret;
2318 	}
2319 
2320 	if (!(fdp.flags & FDPCFG_FDPE))
2321 		return 0;
2322 
2323 	ret = nvme_query_fdp_granularity(ctrl, info, fdp.fdpcidx);
2324 	if (!info->runs)
2325 		return ret;
2326 
2327 	size = struct_size(ruhs, ruhsd, S8_MAX - 1);
2328 	ruhs = kzalloc(size, GFP_KERNEL);
2329 	if (!ruhs)
2330 		return -ENOMEM;
2331 
2332 	c.imr.opcode = nvme_cmd_io_mgmt_recv;
2333 	c.imr.nsid = cpu_to_le32(head->ns_id);
2334 	c.imr.mo = NVME_IO_MGMT_RECV_MO_RUHS;
2335 	c.imr.numd = cpu_to_le32(nvme_bytes_to_numd(size));
2336 	ret = nvme_submit_sync_cmd(ns->queue, &c, ruhs, size);
2337 	if (ret) {
2338 		dev_warn(ctrl->device, "FDP io-mgmt status:0x%x\n", ret);
2339 		goto free;
2340 	}
2341 
2342 	head->nr_plids = le16_to_cpu(ruhs->nruhsd);
2343 	if (!head->nr_plids)
2344 		goto free;
2345 
2346 	head->plids = kcalloc(head->nr_plids, sizeof(*head->plids),
2347 			      GFP_KERNEL);
2348 	if (!head->plids) {
2349 		dev_warn(ctrl->device,
2350 			 "failed to allocate %u FDP placement IDs\n",
2351 			 head->nr_plids);
2352 		head->nr_plids = 0;
2353 		ret = -ENOMEM;
2354 		goto free;
2355 	}
2356 
2357 	for (i = 0; i < head->nr_plids; i++)
2358 		head->plids[i] = le16_to_cpu(ruhs->ruhsd[i].pid);
2359 free:
2360 	kfree(ruhs);
2361 	return ret;
2362 }
2363 
nvme_update_ns_info_block(struct nvme_ns * ns,struct nvme_ns_info * info)2364 static int nvme_update_ns_info_block(struct nvme_ns *ns,
2365 		struct nvme_ns_info *info)
2366 {
2367 	struct queue_limits lim;
2368 	struct nvme_id_ns_nvm *nvm = NULL;
2369 	struct nvme_zone_info zi = {};
2370 	struct nvme_id_ns *id;
2371 	unsigned int memflags;
2372 	sector_t capacity;
2373 	unsigned lbaf;
2374 	int ret;
2375 
2376 	ret = nvme_identify_ns(ns->ctrl, info->nsid, &id);
2377 	if (ret)
2378 		return ret;
2379 
2380 	if (id->ncap == 0) {
2381 		/* namespace not allocated or attached */
2382 		info->is_removed = true;
2383 		ret = -ENXIO;
2384 		goto out;
2385 	}
2386 	lbaf = nvme_lbaf_index(id->flbas);
2387 
2388 	if (nvme_id_cns_ok(ns->ctrl, NVME_ID_CNS_CS_NS)) {
2389 		ret = nvme_identify_ns_nvm(ns->ctrl, info->nsid, &nvm);
2390 		if (ret < 0)
2391 			goto out;
2392 	}
2393 
2394 	if (IS_ENABLED(CONFIG_BLK_DEV_ZONED) &&
2395 	    ns->head->ids.csi == NVME_CSI_ZNS) {
2396 		ret = nvme_query_zone_info(ns, lbaf, &zi);
2397 		if (ret < 0)
2398 			goto out;
2399 	}
2400 
2401 	if (ns->ctrl->ctratt & NVME_CTRL_ATTR_FDPS) {
2402 		ret = nvme_query_fdp_info(ns, info);
2403 		if (ret < 0)
2404 			goto out;
2405 	}
2406 
2407 	lim = queue_limits_start_update(ns->disk->queue);
2408 
2409 	memflags = blk_mq_freeze_queue(ns->disk->queue);
2410 	ns->head->lba_shift = id->lbaf[lbaf].ds;
2411 	ns->head->nuse = le64_to_cpu(id->nuse);
2412 	capacity = nvme_lba_to_sect(ns->head, le64_to_cpu(id->nsze));
2413 	nvme_set_ctrl_limits(ns->ctrl, &lim, false);
2414 	nvme_configure_metadata(ns->ctrl, ns->head, id, nvm, info);
2415 	nvme_set_chunk_sectors(ns, id, &lim);
2416 	if (!nvme_update_disk_info(ns, id, nvm, &lim))
2417 		capacity = 0;
2418 
2419 	if (IS_ENABLED(CONFIG_BLK_DEV_ZONED) &&
2420 	    ns->head->ids.csi == NVME_CSI_ZNS)
2421 		nvme_update_zone_info(ns, &lim, &zi);
2422 
2423 	if ((ns->ctrl->vwc & NVME_CTRL_VWC_PRESENT) && !info->no_vwc)
2424 		lim.features |= BLK_FEAT_WRITE_CACHE | BLK_FEAT_FUA;
2425 	else
2426 		lim.features &= ~(BLK_FEAT_WRITE_CACHE | BLK_FEAT_FUA);
2427 
2428 	if (info->is_rotational)
2429 		lim.features |= BLK_FEAT_ROTATIONAL;
2430 
2431 	/*
2432 	 * Register a metadata profile for PI, or the plain non-integrity NVMe
2433 	 * metadata masquerading as Type 0 if supported, otherwise reject block
2434 	 * I/O to namespaces with metadata except when the namespace supports
2435 	 * PI, as it can strip/insert in that case.
2436 	 */
2437 	if (!nvme_init_integrity(ns->head, &lim, info))
2438 		capacity = 0;
2439 
2440 	lim.max_write_streams = ns->head->nr_plids;
2441 	if (lim.max_write_streams)
2442 		lim.write_stream_granularity = min(info->runs, U32_MAX);
2443 	else
2444 		lim.write_stream_granularity = 0;
2445 
2446 	/*
2447 	 * Only set the DEAC bit if the device guarantees that reads from
2448 	 * deallocated data return zeroes.  While the DEAC bit does not
2449 	 * require that, it must be a no-op if reads from deallocated data
2450 	 * do not return zeroes.
2451 	 */
2452 	if ((id->dlfeat & 0x7) == 0x1 && (id->dlfeat & (1 << 3))) {
2453 		ns->head->features |= NVME_NS_DEAC;
2454 		lim.max_hw_wzeroes_unmap_sectors = lim.max_write_zeroes_sectors;
2455 	}
2456 
2457 	ret = queue_limits_commit_update(ns->disk->queue, &lim);
2458 	if (ret) {
2459 		blk_mq_unfreeze_queue(ns->disk->queue, memflags);
2460 		goto out;
2461 	}
2462 
2463 	set_capacity_and_notify(ns->disk, capacity);
2464 	set_disk_ro(ns->disk, nvme_ns_is_readonly(ns, info));
2465 	set_bit(NVME_NS_READY, &ns->flags);
2466 	blk_mq_unfreeze_queue(ns->disk->queue, memflags);
2467 
2468 	if (blk_queue_is_zoned(ns->queue)) {
2469 		ret = blk_revalidate_disk_zones(ns->disk);
2470 		if (ret && !nvme_first_scan(ns->disk))
2471 			goto out;
2472 	}
2473 
2474 	ret = 0;
2475 out:
2476 	kfree(nvm);
2477 	kfree(id);
2478 	return ret;
2479 }
2480 
nvme_update_ns_info(struct nvme_ns * ns,struct nvme_ns_info * info)2481 static int nvme_update_ns_info(struct nvme_ns *ns, struct nvme_ns_info *info)
2482 {
2483 	bool unsupported = false;
2484 	int ret;
2485 
2486 	switch (info->ids.csi) {
2487 	case NVME_CSI_ZNS:
2488 		if (!IS_ENABLED(CONFIG_BLK_DEV_ZONED)) {
2489 			dev_info(ns->ctrl->device,
2490 	"block device for nsid %u not supported without CONFIG_BLK_DEV_ZONED\n",
2491 				info->nsid);
2492 			ret = nvme_update_ns_info_generic(ns, info);
2493 			break;
2494 		}
2495 		ret = nvme_update_ns_info_block(ns, info);
2496 		break;
2497 	case NVME_CSI_NVM:
2498 		ret = nvme_update_ns_info_block(ns, info);
2499 		break;
2500 	default:
2501 		dev_info(ns->ctrl->device,
2502 			"block device for nsid %u not supported (csi %u)\n",
2503 			info->nsid, info->ids.csi);
2504 		ret = nvme_update_ns_info_generic(ns, info);
2505 		break;
2506 	}
2507 
2508 	/*
2509 	 * If probing fails due an unsupported feature, hide the block device,
2510 	 * but still allow other access.
2511 	 */
2512 	if (ret == -ENODEV) {
2513 		ns->disk->flags |= GENHD_FL_HIDDEN;
2514 		set_bit(NVME_NS_READY, &ns->flags);
2515 		unsupported = true;
2516 		ret = 0;
2517 	}
2518 
2519 	if (!ret && nvme_ns_head_multipath(ns->head)) {
2520 		struct queue_limits *ns_lim = &ns->disk->queue->limits;
2521 		struct queue_limits lim;
2522 		unsigned int memflags;
2523 
2524 		lim = queue_limits_start_update(ns->head->disk->queue);
2525 		memflags = blk_mq_freeze_queue(ns->head->disk->queue);
2526 		/*
2527 		 * queue_limits mixes values that are the hardware limitations
2528 		 * for bio splitting with what is the device configuration.
2529 		 *
2530 		 * For NVMe the device configuration can change after e.g. a
2531 		 * Format command, and we really want to pick up the new format
2532 		 * value here.  But we must still stack the queue limits to the
2533 		 * least common denominator for multipathing to split the bios
2534 		 * properly.
2535 		 *
2536 		 * To work around this, we explicitly set the device
2537 		 * configuration to those that we just queried, but only stack
2538 		 * the splitting limits in to make sure we still obey possibly
2539 		 * lower limitations of other controllers.
2540 		 */
2541 		lim.logical_block_size = ns_lim->logical_block_size;
2542 		lim.physical_block_size = ns_lim->physical_block_size;
2543 		lim.io_min = ns_lim->io_min;
2544 		lim.io_opt = ns_lim->io_opt;
2545 		queue_limits_stack_bdev(&lim, ns->disk->part0, 0,
2546 					ns->head->disk->disk_name);
2547 		if (unsupported)
2548 			ns->head->disk->flags |= GENHD_FL_HIDDEN;
2549 		else
2550 			nvme_init_integrity(ns->head, &lim, info);
2551 		lim.max_write_streams = ns_lim->max_write_streams;
2552 		lim.write_stream_granularity = ns_lim->write_stream_granularity;
2553 		ret = queue_limits_commit_update(ns->head->disk->queue, &lim);
2554 
2555 		set_capacity_and_notify(ns->head->disk, get_capacity(ns->disk));
2556 		set_disk_ro(ns->head->disk, nvme_ns_is_readonly(ns, info));
2557 		nvme_mpath_revalidate_paths(ns);
2558 
2559 		blk_mq_unfreeze_queue(ns->head->disk->queue, memflags);
2560 	}
2561 
2562 	return ret;
2563 }
2564 
nvme_ns_get_unique_id(struct nvme_ns * ns,u8 id[16],enum blk_unique_id type)2565 int nvme_ns_get_unique_id(struct nvme_ns *ns, u8 id[16],
2566 		enum blk_unique_id type)
2567 {
2568 	struct nvme_ns_ids *ids = &ns->head->ids;
2569 
2570 	if (type != BLK_UID_EUI64)
2571 		return -EINVAL;
2572 
2573 	if (memchr_inv(ids->nguid, 0, sizeof(ids->nguid))) {
2574 		memcpy(id, &ids->nguid, sizeof(ids->nguid));
2575 		return sizeof(ids->nguid);
2576 	}
2577 	if (memchr_inv(ids->eui64, 0, sizeof(ids->eui64))) {
2578 		memcpy(id, &ids->eui64, sizeof(ids->eui64));
2579 		return sizeof(ids->eui64);
2580 	}
2581 
2582 	return -EINVAL;
2583 }
2584 
nvme_get_unique_id(struct gendisk * disk,u8 id[16],enum blk_unique_id type)2585 static int nvme_get_unique_id(struct gendisk *disk, u8 id[16],
2586 		enum blk_unique_id type)
2587 {
2588 	return nvme_ns_get_unique_id(disk->private_data, id, type);
2589 }
2590 
2591 #ifdef CONFIG_BLK_SED_OPAL
nvme_sec_submit(void * data,u16 spsp,u8 secp,void * buffer,size_t len,bool send)2592 static int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
2593 		bool send)
2594 {
2595 	struct nvme_ctrl *ctrl = data;
2596 	struct nvme_command cmd = { };
2597 
2598 	if (send)
2599 		cmd.common.opcode = nvme_admin_security_send;
2600 	else
2601 		cmd.common.opcode = nvme_admin_security_recv;
2602 	cmd.common.nsid = 0;
2603 	cmd.common.cdw10 = cpu_to_le32(((u32)secp) << 24 | ((u32)spsp) << 8);
2604 	cmd.common.cdw11 = cpu_to_le32(len);
2605 
2606 	return __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, NULL, buffer, len,
2607 			NVME_QID_ANY, NVME_SUBMIT_AT_HEAD);
2608 }
2609 
nvme_configure_opal(struct nvme_ctrl * ctrl,bool was_suspended)2610 static void nvme_configure_opal(struct nvme_ctrl *ctrl, bool was_suspended)
2611 {
2612 	if (ctrl->oacs & NVME_CTRL_OACS_SEC_SUPP) {
2613 		if (!ctrl->opal_dev)
2614 			ctrl->opal_dev = init_opal_dev(ctrl, &nvme_sec_submit);
2615 		else if (was_suspended)
2616 			opal_unlock_from_suspend(ctrl->opal_dev);
2617 	} else {
2618 		free_opal_dev(ctrl->opal_dev);
2619 		ctrl->opal_dev = NULL;
2620 	}
2621 }
2622 #else
nvme_configure_opal(struct nvme_ctrl * ctrl,bool was_suspended)2623 static void nvme_configure_opal(struct nvme_ctrl *ctrl, bool was_suspended)
2624 {
2625 }
2626 #endif /* CONFIG_BLK_SED_OPAL */
2627 
2628 #ifdef CONFIG_BLK_DEV_ZONED
nvme_report_zones(struct gendisk * disk,sector_t sector,unsigned int nr_zones,struct blk_report_zones_args * args)2629 static int nvme_report_zones(struct gendisk *disk, sector_t sector,
2630 		unsigned int nr_zones, struct blk_report_zones_args *args)
2631 {
2632 	return nvme_ns_report_zones(disk->private_data, sector, nr_zones, args);
2633 }
2634 #else
2635 #define nvme_report_zones	NULL
2636 #endif /* CONFIG_BLK_DEV_ZONED */
2637 
2638 const struct block_device_operations nvme_bdev_ops = {
2639 	.owner		= THIS_MODULE,
2640 	.ioctl		= nvme_ioctl,
2641 	.compat_ioctl	= blkdev_compat_ptr_ioctl,
2642 	.open		= nvme_open,
2643 	.release	= nvme_release,
2644 	.getgeo		= nvme_getgeo,
2645 	.get_unique_id	= nvme_get_unique_id,
2646 	.report_zones	= nvme_report_zones,
2647 	.pr_ops		= &nvme_pr_ops,
2648 };
2649 
nvme_wait_ready(struct nvme_ctrl * ctrl,u32 mask,u32 val,u32 timeout,const char * op)2650 static int nvme_wait_ready(struct nvme_ctrl *ctrl, u32 mask, u32 val,
2651 		u32 timeout, const char *op)
2652 {
2653 	unsigned long timeout_jiffies = jiffies + timeout * HZ;
2654 	u32 csts;
2655 	int ret;
2656 
2657 	while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) {
2658 		if (csts == ~0)
2659 			return -ENODEV;
2660 		if ((csts & mask) == val)
2661 			break;
2662 
2663 		usleep_range(1000, 2000);
2664 		if (fatal_signal_pending(current))
2665 			return -EINTR;
2666 		if (time_after(jiffies, timeout_jiffies)) {
2667 			dev_err(ctrl->device,
2668 				"Device not ready; aborting %s, CSTS=0x%x\n",
2669 				op, csts);
2670 			return -ENODEV;
2671 		}
2672 	}
2673 
2674 	return ret;
2675 }
2676 
nvme_disable_ctrl(struct nvme_ctrl * ctrl,bool shutdown)2677 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, bool shutdown)
2678 {
2679 	int ret;
2680 
2681 	ctrl->ctrl_config &= ~NVME_CC_SHN_MASK;
2682 	if (shutdown)
2683 		ctrl->ctrl_config |= NVME_CC_SHN_NORMAL;
2684 	else
2685 		ctrl->ctrl_config &= ~NVME_CC_ENABLE;
2686 
2687 	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
2688 	if (ret)
2689 		return ret;
2690 
2691 	if (shutdown) {
2692 		return nvme_wait_ready(ctrl, NVME_CSTS_SHST_MASK,
2693 				       NVME_CSTS_SHST_CMPLT,
2694 				       ctrl->shutdown_timeout, "shutdown");
2695 	}
2696 	if (ctrl->quirks & NVME_QUIRK_DELAY_BEFORE_CHK_RDY)
2697 		msleep(NVME_QUIRK_DELAY_AMOUNT);
2698 	return nvme_wait_ready(ctrl, NVME_CSTS_RDY, 0,
2699 			       (NVME_CAP_TIMEOUT(ctrl->cap) + 1) / 2, "reset");
2700 }
2701 EXPORT_SYMBOL_GPL(nvme_disable_ctrl);
2702 
nvme_enable_ctrl(struct nvme_ctrl * ctrl)2703 int nvme_enable_ctrl(struct nvme_ctrl *ctrl)
2704 {
2705 	unsigned dev_page_min;
2706 	u32 timeout;
2707 	int ret;
2708 
2709 	ret = ctrl->ops->reg_read64(ctrl, NVME_REG_CAP, &ctrl->cap);
2710 	if (ret) {
2711 		dev_err(ctrl->device, "Reading CAP failed (%d)\n", ret);
2712 		return ret;
2713 	}
2714 	dev_page_min = NVME_CAP_MPSMIN(ctrl->cap) + 12;
2715 
2716 	if (NVME_CTRL_PAGE_SHIFT < dev_page_min) {
2717 		dev_err(ctrl->device,
2718 			"Minimum device page size %u too large for host (%u)\n",
2719 			1 << dev_page_min, 1 << NVME_CTRL_PAGE_SHIFT);
2720 		return -ENODEV;
2721 	}
2722 
2723 	if (NVME_CAP_CSS(ctrl->cap) & NVME_CAP_CSS_CSI)
2724 		ctrl->ctrl_config = NVME_CC_CSS_CSI;
2725 	else
2726 		ctrl->ctrl_config = NVME_CC_CSS_NVM;
2727 
2728 	/*
2729 	 * Setting CRIME results in CSTS.RDY before the media is ready. This
2730 	 * makes it possible for media related commands to return the error
2731 	 * NVME_SC_ADMIN_COMMAND_MEDIA_NOT_READY. Until the driver is
2732 	 * restructured to handle retries, disable CC.CRIME.
2733 	 */
2734 	ctrl->ctrl_config &= ~NVME_CC_CRIME;
2735 
2736 	ctrl->ctrl_config |= (NVME_CTRL_PAGE_SHIFT - 12) << NVME_CC_MPS_SHIFT;
2737 	ctrl->ctrl_config |= NVME_CC_AMS_RR | NVME_CC_SHN_NONE;
2738 	ctrl->ctrl_config |= NVME_CC_IOSQES | NVME_CC_IOCQES;
2739 	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
2740 	if (ret)
2741 		return ret;
2742 
2743 	/* CAP value may change after initial CC write */
2744 	ret = ctrl->ops->reg_read64(ctrl, NVME_REG_CAP, &ctrl->cap);
2745 	if (ret)
2746 		return ret;
2747 
2748 	timeout = NVME_CAP_TIMEOUT(ctrl->cap);
2749 	if (ctrl->cap & NVME_CAP_CRMS_CRWMS) {
2750 		u32 crto, ready_timeout;
2751 
2752 		ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CRTO, &crto);
2753 		if (ret) {
2754 			dev_err(ctrl->device, "Reading CRTO failed (%d)\n",
2755 				ret);
2756 			return ret;
2757 		}
2758 
2759 		/*
2760 		 * CRTO should always be greater or equal to CAP.TO, but some
2761 		 * devices are known to get this wrong. Use the larger of the
2762 		 * two values.
2763 		 */
2764 		ready_timeout = NVME_CRTO_CRWMT(crto);
2765 
2766 		if (ready_timeout < timeout)
2767 			dev_warn_once(ctrl->device, "bad crto:%x cap:%llx\n",
2768 				      crto, ctrl->cap);
2769 		else
2770 			timeout = ready_timeout;
2771 	}
2772 
2773 	ctrl->ctrl_config |= NVME_CC_ENABLE;
2774 	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
2775 	if (ret)
2776 		return ret;
2777 	return nvme_wait_ready(ctrl, NVME_CSTS_RDY, NVME_CSTS_RDY,
2778 			       (timeout + 1) / 2, "initialisation");
2779 }
2780 EXPORT_SYMBOL_GPL(nvme_enable_ctrl);
2781 
nvme_configure_timestamp(struct nvme_ctrl * ctrl)2782 static int nvme_configure_timestamp(struct nvme_ctrl *ctrl)
2783 {
2784 	__le64 ts;
2785 	int ret;
2786 
2787 	if (!(ctrl->oncs & NVME_CTRL_ONCS_TIMESTAMP))
2788 		return 0;
2789 
2790 	ts = cpu_to_le64(ktime_to_ms(ktime_get_real()));
2791 	ret = nvme_set_features(ctrl, NVME_FEAT_TIMESTAMP, 0, &ts, sizeof(ts),
2792 			NULL);
2793 	if (ret)
2794 		dev_warn_once(ctrl->device,
2795 			"could not set timestamp (%d)\n", ret);
2796 	return ret;
2797 }
2798 
nvme_configure_host_options(struct nvme_ctrl * ctrl)2799 static int nvme_configure_host_options(struct nvme_ctrl *ctrl)
2800 {
2801 	struct nvme_feat_host_behavior *host;
2802 	u8 acre = 0, lbafee = 0;
2803 	int ret;
2804 
2805 	/* Don't bother enabling the feature if retry delay is not reported */
2806 	if (ctrl->crdt[0])
2807 		acre = NVME_ENABLE_ACRE;
2808 	if (ctrl->ctratt & NVME_CTRL_ATTR_ELBAS)
2809 		lbafee = NVME_ENABLE_LBAFEE;
2810 
2811 	if (!acre && !lbafee)
2812 		return 0;
2813 
2814 	host = kzalloc_obj(*host);
2815 	if (!host)
2816 		return 0;
2817 
2818 	host->acre = acre;
2819 	host->lbafee = lbafee;
2820 	ret = nvme_set_features(ctrl, NVME_FEAT_HOST_BEHAVIOR, 0,
2821 				host, sizeof(*host), NULL);
2822 	kfree(host);
2823 	return ret;
2824 }
2825 
2826 /*
2827  * The function checks whether the given total (exlat + enlat) latency of
2828  * a power state allows the latter to be used as an APST transition target.
2829  * It does so by comparing the latency to the primary and secondary latency
2830  * tolerances defined by module params. If there's a match, the corresponding
2831  * timeout value is returned and the matching tolerance index (1 or 2) is
2832  * reported.
2833  */
nvme_apst_get_transition_time(u64 total_latency,u64 * transition_time,unsigned * last_index)2834 static bool nvme_apst_get_transition_time(u64 total_latency,
2835 		u64 *transition_time, unsigned *last_index)
2836 {
2837 	if (total_latency <= apst_primary_latency_tol_us) {
2838 		if (*last_index == 1)
2839 			return false;
2840 		*last_index = 1;
2841 		*transition_time = apst_primary_timeout_ms;
2842 		return true;
2843 	}
2844 	if (apst_secondary_timeout_ms &&
2845 		total_latency <= apst_secondary_latency_tol_us) {
2846 		if (*last_index <= 2)
2847 			return false;
2848 		*last_index = 2;
2849 		*transition_time = apst_secondary_timeout_ms;
2850 		return true;
2851 	}
2852 	return false;
2853 }
2854 
2855 /*
2856  * APST (Autonomous Power State Transition) lets us program a table of power
2857  * state transitions that the controller will perform automatically.
2858  *
2859  * Depending on module params, one of the two supported techniques will be used:
2860  *
2861  * - If the parameters provide explicit timeouts and tolerances, they will be
2862  *   used to build a table with up to 2 non-operational states to transition to.
2863  *   The default parameter values were selected based on the values used by
2864  *   Microsoft's and Intel's NVMe drivers. Yet, since we don't implement dynamic
2865  *   regeneration of the APST table in the event of switching between external
2866  *   and battery power, the timeouts and tolerances reflect a compromise
2867  *   between values used by Microsoft for AC and battery scenarios.
2868  * - If not, we'll configure the table with a simple heuristic: we are willing
2869  *   to spend at most 2% of the time transitioning between power states.
2870  *   Therefore, when running in any given state, we will enter the next
2871  *   lower-power non-operational state after waiting 50 * (enlat + exlat)
2872  *   microseconds, as long as that state's exit latency is under the requested
2873  *   maximum latency.
2874  *
2875  * We will not autonomously enter any non-operational state for which the total
2876  * latency exceeds ps_max_latency_us.
2877  *
2878  * Users can set ps_max_latency_us to zero to turn off APST.
2879  */
nvme_configure_apst(struct nvme_ctrl * ctrl)2880 static int nvme_configure_apst(struct nvme_ctrl *ctrl)
2881 {
2882 	struct nvme_feat_auto_pst *table;
2883 	unsigned apste = 0;
2884 	u64 max_lat_us = 0;
2885 	__le64 target = 0;
2886 	int max_ps = -1;
2887 	int state;
2888 	int ret;
2889 	unsigned last_lt_index = UINT_MAX;
2890 
2891 	/*
2892 	 * If APST isn't supported or if we haven't been initialized yet,
2893 	 * then don't do anything.
2894 	 */
2895 	if (!ctrl->apsta)
2896 		return 0;
2897 
2898 	if (ctrl->npss > 31) {
2899 		dev_warn(ctrl->device, "NPSS is invalid; not using APST\n");
2900 		return 0;
2901 	}
2902 
2903 	table = kzalloc_obj(*table);
2904 	if (!table)
2905 		return 0;
2906 
2907 	if (!ctrl->apst_enabled || ctrl->ps_max_latency_us == 0) {
2908 		/* Turn off APST. */
2909 		dev_dbg(ctrl->device, "APST disabled\n");
2910 		goto done;
2911 	}
2912 
2913 	/*
2914 	 * Walk through all states from lowest- to highest-power.
2915 	 * According to the spec, lower-numbered states use more power.  NPSS,
2916 	 * despite the name, is the index of the lowest-power state, not the
2917 	 * number of states.
2918 	 */
2919 	for (state = (int)ctrl->npss; state >= 0; state--) {
2920 		u64 total_latency_us, exit_latency_us, transition_ms;
2921 
2922 		if (target)
2923 			table->entries[state] = target;
2924 
2925 		/*
2926 		 * Don't allow transitions to the deepest state if it's quirked
2927 		 * off.
2928 		 */
2929 		if (state == ctrl->npss &&
2930 		    (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS))
2931 			continue;
2932 
2933 		/*
2934 		 * Is this state a useful non-operational state for higher-power
2935 		 * states to autonomously transition to?
2936 		 */
2937 		if (!(ctrl->psd[state].flags & NVME_PS_FLAGS_NON_OP_STATE))
2938 			continue;
2939 
2940 		exit_latency_us = (u64)le32_to_cpu(ctrl->psd[state].exit_lat);
2941 		if (exit_latency_us > ctrl->ps_max_latency_us)
2942 			continue;
2943 
2944 		total_latency_us = exit_latency_us +
2945 			le32_to_cpu(ctrl->psd[state].entry_lat);
2946 
2947 		/*
2948 		 * This state is good. It can be used as the APST idle target
2949 		 * for higher power states.
2950 		 */
2951 		if (apst_primary_timeout_ms && apst_primary_latency_tol_us) {
2952 			if (!nvme_apst_get_transition_time(total_latency_us,
2953 					&transition_ms, &last_lt_index))
2954 				continue;
2955 		} else {
2956 			transition_ms = total_latency_us + 19;
2957 			do_div(transition_ms, 20);
2958 			if (transition_ms > (1 << 24) - 1)
2959 				transition_ms = (1 << 24) - 1;
2960 		}
2961 
2962 		target = cpu_to_le64((state << 3) | (transition_ms << 8));
2963 		if (max_ps == -1)
2964 			max_ps = state;
2965 		if (total_latency_us > max_lat_us)
2966 			max_lat_us = total_latency_us;
2967 	}
2968 
2969 	if (max_ps == -1)
2970 		dev_dbg(ctrl->device, "APST enabled but no non-operational states are available\n");
2971 	else
2972 		dev_dbg(ctrl->device, "APST enabled: max PS = %d, max round-trip latency = %lluus, table = %*phN\n",
2973 			max_ps, max_lat_us, (int)sizeof(*table), table);
2974 	apste = 1;
2975 
2976 done:
2977 	ret = nvme_set_features(ctrl, NVME_FEAT_AUTO_PST, apste,
2978 				table, sizeof(*table), NULL);
2979 	if (ret)
2980 		dev_err(ctrl->device, "failed to set APST feature (%d)\n", ret);
2981 	kfree(table);
2982 	return ret;
2983 }
2984 
nvme_set_latency_tolerance(struct device * dev,s32 val)2985 static void nvme_set_latency_tolerance(struct device *dev, s32 val)
2986 {
2987 	struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
2988 	u64 latency;
2989 
2990 	switch (val) {
2991 	case PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT:
2992 	case PM_QOS_LATENCY_ANY:
2993 		latency = U64_MAX;
2994 		break;
2995 
2996 	default:
2997 		latency = val;
2998 	}
2999 
3000 	if (ctrl->ps_max_latency_us != latency) {
3001 		ctrl->ps_max_latency_us = latency;
3002 		if (nvme_ctrl_state(ctrl) == NVME_CTRL_LIVE)
3003 			nvme_configure_apst(ctrl);
3004 	}
3005 }
3006 
3007 struct nvme_core_quirk_entry {
3008 	/*
3009 	 * NVMe model and firmware strings are padded with spaces.  For
3010 	 * simplicity, strings in the quirk table are padded with NULLs
3011 	 * instead.
3012 	 */
3013 	u16 vid;
3014 	const char *mn;
3015 	const char *fr;
3016 	unsigned long quirks;
3017 };
3018 
3019 static const struct nvme_core_quirk_entry core_quirks[] = {
3020 	{
3021 		/*
3022 		 * This Toshiba device seems to die using any APST states.  See:
3023 		 * https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1678184/comments/11
3024 		 */
3025 		.vid = 0x1179,
3026 		.mn = "THNSF5256GPUK TOSHIBA",
3027 		.quirks = NVME_QUIRK_NO_APST,
3028 	},
3029 	{
3030 		/*
3031 		 * This LiteON CL1-3D*-Q11 firmware version has a race
3032 		 * condition associated with actions related to suspend to idle
3033 		 * LiteON has resolved the problem in future firmware
3034 		 */
3035 		.vid = 0x14a4,
3036 		.fr = "22301111",
3037 		.quirks = NVME_QUIRK_SIMPLE_SUSPEND,
3038 	},
3039 	{
3040 		/*
3041 		 * This Kioxia CD6-V Series / HPE PE8030 device times out and
3042 		 * aborts I/O during any load, but more easily reproducible
3043 		 * with discards (fstrim).
3044 		 *
3045 		 * The device is left in a state where it is also not possible
3046 		 * to use "nvme set-feature" to disable APST, but booting with
3047 		 * nvme_core.default_ps_max_latency=0 works.
3048 		 */
3049 		.vid = 0x1e0f,
3050 		.mn = "KCD6XVUL6T40",
3051 		.quirks = NVME_QUIRK_NO_APST,
3052 	},
3053 	{
3054 		/*
3055 		 * The external Samsung X5 SSD fails initialization without a
3056 		 * delay before checking if it is ready and has a whole set of
3057 		 * other problems.  To make this even more interesting, it
3058 		 * shares the PCI ID with internal Samsung 970 Evo Plus that
3059 		 * does not need or want these quirks.
3060 		 */
3061 		.vid = 0x144d,
3062 		.mn = "Samsung Portable SSD X5",
3063 		.quirks = NVME_QUIRK_DELAY_BEFORE_CHK_RDY |
3064 			  NVME_QUIRK_NO_DEEPEST_PS |
3065 			  NVME_QUIRK_IGNORE_DEV_SUBNQN,
3066 	}
3067 };
3068 
3069 /* match is null-terminated but idstr is space-padded. */
string_matches(const char * idstr,const char * match,size_t len)3070 static bool string_matches(const char *idstr, const char *match, size_t len)
3071 {
3072 	size_t matchlen;
3073 
3074 	if (!match)
3075 		return true;
3076 
3077 	matchlen = strlen(match);
3078 	WARN_ON_ONCE(matchlen > len);
3079 
3080 	if (memcmp(idstr, match, matchlen))
3081 		return false;
3082 
3083 	for (; matchlen < len; matchlen++)
3084 		if (idstr[matchlen] != ' ')
3085 			return false;
3086 
3087 	return true;
3088 }
3089 
quirk_matches(const struct nvme_id_ctrl * id,const struct nvme_core_quirk_entry * q)3090 static bool quirk_matches(const struct nvme_id_ctrl *id,
3091 			  const struct nvme_core_quirk_entry *q)
3092 {
3093 	return q->vid == le16_to_cpu(id->vid) &&
3094 		string_matches(id->mn, q->mn, sizeof(id->mn)) &&
3095 		string_matches(id->fr, q->fr, sizeof(id->fr));
3096 }
3097 
nvme_init_subnqn(struct nvme_subsystem * subsys,struct nvme_ctrl * ctrl,struct nvme_id_ctrl * id)3098 static void nvme_init_subnqn(struct nvme_subsystem *subsys, struct nvme_ctrl *ctrl,
3099 		struct nvme_id_ctrl *id)
3100 {
3101 	size_t nqnlen;
3102 	int off;
3103 
3104 	if(!(ctrl->quirks & NVME_QUIRK_IGNORE_DEV_SUBNQN)) {
3105 		nqnlen = strnlen(id->subnqn, NVMF_NQN_SIZE);
3106 		if (nqnlen > 0 && nqnlen < NVMF_NQN_SIZE) {
3107 			strscpy(subsys->subnqn, id->subnqn, NVMF_NQN_SIZE);
3108 			return;
3109 		}
3110 
3111 		if (ctrl->vs >= NVME_VS(1, 2, 1))
3112 			dev_warn(ctrl->device, "missing or invalid SUBNQN field.\n");
3113 	}
3114 
3115 	/*
3116 	 * Generate a "fake" NQN similar to the one in Section 4.5 of the NVMe
3117 	 * Base Specification 2.0.  It is slightly different from the format
3118 	 * specified there due to historic reasons, and we can't change it now.
3119 	 */
3120 	off = snprintf(subsys->subnqn, NVMF_NQN_SIZE,
3121 			"nqn.2014.08.org.nvmexpress:%04x%04x",
3122 			le16_to_cpu(id->vid), le16_to_cpu(id->ssvid));
3123 	memcpy(subsys->subnqn + off, id->sn, sizeof(id->sn));
3124 	off += sizeof(id->sn);
3125 	memcpy(subsys->subnqn + off, id->mn, sizeof(id->mn));
3126 	off += sizeof(id->mn);
3127 	memset(subsys->subnqn + off, 0, sizeof(subsys->subnqn) - off);
3128 }
3129 
nvme_release_subsystem(struct device * dev)3130 static void nvme_release_subsystem(struct device *dev)
3131 {
3132 	struct nvme_subsystem *subsys =
3133 		container_of(dev, struct nvme_subsystem, dev);
3134 
3135 	if (subsys->instance >= 0)
3136 		ida_free(&nvme_instance_ida, subsys->instance);
3137 	kfree(subsys);
3138 }
3139 
nvme_destroy_subsystem(struct kref * ref)3140 static void nvme_destroy_subsystem(struct kref *ref)
3141 {
3142 	struct nvme_subsystem *subsys =
3143 			container_of(ref, struct nvme_subsystem, ref);
3144 
3145 	mutex_lock(&nvme_subsystems_lock);
3146 	list_del(&subsys->entry);
3147 	mutex_unlock(&nvme_subsystems_lock);
3148 
3149 	ida_destroy(&subsys->ns_ida);
3150 	device_del(&subsys->dev);
3151 	put_device(&subsys->dev);
3152 }
3153 
nvme_put_subsystem(struct nvme_subsystem * subsys)3154 static void nvme_put_subsystem(struct nvme_subsystem *subsys)
3155 {
3156 	kref_put(&subsys->ref, nvme_destroy_subsystem);
3157 }
3158 
__nvme_find_get_subsystem(const char * subsysnqn)3159 static struct nvme_subsystem *__nvme_find_get_subsystem(const char *subsysnqn)
3160 {
3161 	struct nvme_subsystem *subsys;
3162 
3163 	lockdep_assert_held(&nvme_subsystems_lock);
3164 
3165 	/*
3166 	 * Fail matches for discovery subsystems. This results
3167 	 * in each discovery controller bound to a unique subsystem.
3168 	 * This avoids issues with validating controller values
3169 	 * that can only be true when there is a single unique subsystem.
3170 	 * There may be multiple and completely independent entities
3171 	 * that provide discovery controllers.
3172 	 */
3173 	if (!strcmp(subsysnqn, NVME_DISC_SUBSYS_NAME))
3174 		return NULL;
3175 
3176 	list_for_each_entry(subsys, &nvme_subsystems, entry) {
3177 		if (strcmp(subsys->subnqn, subsysnqn))
3178 			continue;
3179 		if (!kref_get_unless_zero(&subsys->ref))
3180 			continue;
3181 		return subsys;
3182 	}
3183 
3184 	return NULL;
3185 }
3186 
nvme_discovery_ctrl(struct nvme_ctrl * ctrl)3187 static inline bool nvme_discovery_ctrl(struct nvme_ctrl *ctrl)
3188 {
3189 	return ctrl->opts && ctrl->opts->discovery_nqn;
3190 }
3191 
nvme_admin_ctrl(struct nvme_ctrl * ctrl)3192 static inline bool nvme_admin_ctrl(struct nvme_ctrl *ctrl)
3193 {
3194 	return ctrl->cntrltype == NVME_CTRL_ADMIN;
3195 }
3196 
nvme_is_io_ctrl(struct nvme_ctrl * ctrl)3197 static inline bool nvme_is_io_ctrl(struct nvme_ctrl *ctrl)
3198 {
3199 	return !nvme_discovery_ctrl(ctrl) && !nvme_admin_ctrl(ctrl);
3200 }
3201 
nvme_validate_cntlid(struct nvme_subsystem * subsys,struct nvme_ctrl * ctrl,struct nvme_id_ctrl * id)3202 static bool nvme_validate_cntlid(struct nvme_subsystem *subsys,
3203 		struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
3204 {
3205 	struct nvme_ctrl *tmp;
3206 
3207 	lockdep_assert_held(&nvme_subsystems_lock);
3208 
3209 	list_for_each_entry(tmp, &subsys->ctrls, subsys_entry) {
3210 		if (nvme_state_terminal(tmp))
3211 			continue;
3212 
3213 		if (tmp->cntlid == ctrl->cntlid) {
3214 			dev_err(ctrl->device,
3215 				"Duplicate cntlid %u with %s, subsys %s, rejecting\n",
3216 				ctrl->cntlid, dev_name(tmp->device),
3217 				subsys->subnqn);
3218 			return false;
3219 		}
3220 
3221 		if ((id->cmic & NVME_CTRL_CMIC_MULTI_CTRL) ||
3222 		    nvme_discovery_ctrl(ctrl))
3223 			continue;
3224 
3225 		dev_err(ctrl->device,
3226 			"Subsystem does not support multiple controllers\n");
3227 		return false;
3228 	}
3229 
3230 	return true;
3231 }
3232 
nvme_init_subsystem(struct nvme_ctrl * ctrl,struct nvme_id_ctrl * id)3233 static int nvme_init_subsystem(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
3234 {
3235 	struct nvme_subsystem *subsys, *found;
3236 	int ret;
3237 
3238 	subsys = kzalloc_obj(*subsys);
3239 	if (!subsys)
3240 		return -ENOMEM;
3241 
3242 	subsys->instance = -1;
3243 	mutex_init(&subsys->lock);
3244 	kref_init(&subsys->ref);
3245 	INIT_LIST_HEAD(&subsys->ctrls);
3246 	INIT_LIST_HEAD(&subsys->nsheads);
3247 	nvme_init_subnqn(subsys, ctrl, id);
3248 	memcpy(subsys->serial, id->sn, sizeof(subsys->serial));
3249 	memcpy(subsys->model, id->mn, sizeof(subsys->model));
3250 	subsys->vendor_id = le16_to_cpu(id->vid);
3251 	subsys->cmic = id->cmic;
3252 
3253 	/* Versions prior to 1.4 don't necessarily report a valid type */
3254 	if (id->cntrltype == NVME_CTRL_DISC ||
3255 	    !strcmp(subsys->subnqn, NVME_DISC_SUBSYS_NAME))
3256 		subsys->subtype = NVME_NQN_DISC;
3257 	else
3258 		subsys->subtype = NVME_NQN_NVME;
3259 
3260 	if (nvme_discovery_ctrl(ctrl) && subsys->subtype != NVME_NQN_DISC) {
3261 		dev_err(ctrl->device,
3262 			"Subsystem %s is not a discovery controller",
3263 			subsys->subnqn);
3264 		kfree(subsys);
3265 		return -EINVAL;
3266 	}
3267 	nvme_mpath_default_iopolicy(subsys);
3268 
3269 	subsys->dev.class = &nvme_subsys_class;
3270 	subsys->dev.release = nvme_release_subsystem;
3271 	subsys->dev.groups = nvme_subsys_attrs_groups;
3272 	dev_set_name(&subsys->dev, "nvme-subsys%d", ctrl->instance);
3273 	device_initialize(&subsys->dev);
3274 
3275 	mutex_lock(&nvme_subsystems_lock);
3276 	found = __nvme_find_get_subsystem(subsys->subnqn);
3277 	if (found) {
3278 		put_device(&subsys->dev);
3279 		subsys = found;
3280 
3281 		if (!nvme_validate_cntlid(subsys, ctrl, id)) {
3282 			ret = -EINVAL;
3283 			goto out_put_subsystem;
3284 		}
3285 	} else {
3286 		ret = device_add(&subsys->dev);
3287 		if (ret) {
3288 			dev_err(ctrl->device,
3289 				"failed to register subsystem device.\n");
3290 			put_device(&subsys->dev);
3291 			goto out_unlock;
3292 		}
3293 		ida_init(&subsys->ns_ida);
3294 		list_add_tail(&subsys->entry, &nvme_subsystems);
3295 	}
3296 
3297 	ret = sysfs_create_link(&subsys->dev.kobj, &ctrl->device->kobj,
3298 				dev_name(ctrl->device));
3299 	if (ret) {
3300 		dev_err(ctrl->device,
3301 			"failed to create sysfs link from subsystem.\n");
3302 		goto out_put_subsystem;
3303 	}
3304 
3305 	if (!found)
3306 		subsys->instance = ctrl->instance;
3307 	ctrl->subsys = subsys;
3308 	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
3309 	mutex_unlock(&nvme_subsystems_lock);
3310 	return 0;
3311 
3312 out_put_subsystem:
3313 	nvme_put_subsystem(subsys);
3314 out_unlock:
3315 	mutex_unlock(&nvme_subsystems_lock);
3316 	return ret;
3317 }
3318 
nvme_get_log_lsi(struct nvme_ctrl * ctrl,u32 nsid,u8 log_page,u8 lsp,u8 csi,void * log,size_t size,u64 offset,u16 lsi)3319 static int nvme_get_log_lsi(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page,
3320 		u8 lsp, u8 csi, void *log, size_t size, u64 offset, u16 lsi)
3321 {
3322 	struct nvme_command c = { };
3323 	u32 dwlen = nvme_bytes_to_numd(size);
3324 
3325 	c.get_log_page.opcode = nvme_admin_get_log_page;
3326 	c.get_log_page.nsid = cpu_to_le32(nsid);
3327 	c.get_log_page.lid = log_page;
3328 	c.get_log_page.lsp = lsp;
3329 	c.get_log_page.numdl = cpu_to_le16(dwlen & ((1 << 16) - 1));
3330 	c.get_log_page.numdu = cpu_to_le16(dwlen >> 16);
3331 	c.get_log_page.lpol = cpu_to_le32(lower_32_bits(offset));
3332 	c.get_log_page.lpou = cpu_to_le32(upper_32_bits(offset));
3333 	c.get_log_page.csi = csi;
3334 	c.get_log_page.lsi = cpu_to_le16(lsi);
3335 
3336 	return nvme_submit_sync_cmd(ctrl->admin_q, &c, log, size);
3337 }
3338 
nvme_get_log(struct nvme_ctrl * ctrl,u32 nsid,u8 log_page,u8 lsp,u8 csi,void * log,size_t size,u64 offset)3339 int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
3340 		void *log, size_t size, u64 offset)
3341 {
3342 	return nvme_get_log_lsi(ctrl, nsid, log_page, lsp, csi, log, size,
3343 			offset, 0);
3344 }
3345 
nvme_get_effects_log(struct nvme_ctrl * ctrl,u8 csi,struct nvme_effects_log ** log)3346 static int nvme_get_effects_log(struct nvme_ctrl *ctrl, u8 csi,
3347 				struct nvme_effects_log **log)
3348 {
3349 	struct nvme_effects_log *old, *cel = xa_load(&ctrl->cels, csi);
3350 	int ret;
3351 
3352 	if (cel)
3353 		goto out;
3354 
3355 	cel = kzalloc_obj(*cel);
3356 	if (!cel)
3357 		return -ENOMEM;
3358 
3359 	ret = nvme_get_log(ctrl, 0x00, NVME_LOG_CMD_EFFECTS, 0, csi,
3360 			cel, sizeof(*cel), 0);
3361 	if (ret) {
3362 		kfree(cel);
3363 		return ret;
3364 	}
3365 
3366 	old = xa_store(&ctrl->cels, csi, cel, GFP_KERNEL);
3367 	if (xa_is_err(old)) {
3368 		kfree(cel);
3369 		return xa_err(old);
3370 	}
3371 out:
3372 	*log = cel;
3373 	return 0;
3374 }
3375 
nvme_mps_to_sectors(struct nvme_ctrl * ctrl,u32 units)3376 static inline u32 nvme_mps_to_sectors(struct nvme_ctrl *ctrl, u32 units)
3377 {
3378 	u32 page_shift = NVME_CAP_MPSMIN(ctrl->cap) + 12, val;
3379 
3380 	if (check_shl_overflow(1U, units + page_shift - 9, &val))
3381 		return UINT_MAX;
3382 	return val;
3383 }
3384 
nvme_init_non_mdts_limits(struct nvme_ctrl * ctrl)3385 static int nvme_init_non_mdts_limits(struct nvme_ctrl *ctrl)
3386 {
3387 	struct nvme_command c = { };
3388 	struct nvme_id_ctrl_nvm *id;
3389 	int ret;
3390 
3391 	/*
3392 	 * Even though NVMe spec explicitly states that MDTS is not applicable
3393 	 * to the write-zeroes, we are cautious and limit the size to the
3394 	 * controllers max_hw_sectors value, which is based on the MDTS field
3395 	 * and possibly other limiting factors.
3396 	 */
3397 	if ((ctrl->oncs & NVME_CTRL_ONCS_WRITE_ZEROES) &&
3398 	    !(ctrl->quirks & NVME_QUIRK_DISABLE_WRITE_ZEROES))
3399 		ctrl->max_zeroes_sectors = ctrl->max_hw_sectors;
3400 	else
3401 		ctrl->max_zeroes_sectors = 0;
3402 
3403 	if (!nvme_is_io_ctrl(ctrl) ||
3404 	    !nvme_id_cns_ok(ctrl, NVME_ID_CNS_CS_CTRL) ||
3405 	    test_bit(NVME_CTRL_SKIP_ID_CNS_CS, &ctrl->flags))
3406 		return 0;
3407 
3408 	id = kzalloc_obj(*id);
3409 	if (!id)
3410 		return -ENOMEM;
3411 
3412 	c.identify.opcode = nvme_admin_identify;
3413 	c.identify.cns = NVME_ID_CNS_CS_CTRL;
3414 	c.identify.csi = NVME_CSI_NVM;
3415 
3416 	ret = nvme_submit_sync_cmd(ctrl->admin_q, &c, id, sizeof(*id));
3417 	if (ret)
3418 		goto free_data;
3419 
3420 	ctrl->dmrl = id->dmrl;
3421 	ctrl->dmrsl = le32_to_cpu(id->dmrsl);
3422 	if (id->wzsl && !(ctrl->quirks & NVME_QUIRK_DISABLE_WRITE_ZEROES))
3423 		ctrl->max_zeroes_sectors = nvme_mps_to_sectors(ctrl, id->wzsl);
3424 
3425 free_data:
3426 	if (ret > 0)
3427 		set_bit(NVME_CTRL_SKIP_ID_CNS_CS, &ctrl->flags);
3428 	kfree(id);
3429 	return ret;
3430 }
3431 
nvme_init_effects_log(struct nvme_ctrl * ctrl,u8 csi,struct nvme_effects_log ** log)3432 static int nvme_init_effects_log(struct nvme_ctrl *ctrl,
3433 		u8 csi, struct nvme_effects_log **log)
3434 {
3435 	struct nvme_effects_log *effects, *old;
3436 
3437 	effects = kzalloc_obj(*effects);
3438 	if (!effects)
3439 		return -ENOMEM;
3440 
3441 	old = xa_store(&ctrl->cels, csi, effects, GFP_KERNEL);
3442 	if (xa_is_err(old)) {
3443 		kfree(effects);
3444 		return xa_err(old);
3445 	}
3446 
3447 	*log = effects;
3448 	return 0;
3449 }
3450 
nvme_init_known_nvm_effects(struct nvme_ctrl * ctrl)3451 static void nvme_init_known_nvm_effects(struct nvme_ctrl *ctrl)
3452 {
3453 	struct nvme_effects_log	*log = ctrl->effects;
3454 
3455 	log->acs[nvme_admin_format_nvm] |= cpu_to_le32(NVME_CMD_EFFECTS_LBCC |
3456 						NVME_CMD_EFFECTS_NCC |
3457 						NVME_CMD_EFFECTS_CSE_MASK);
3458 	log->acs[nvme_admin_sanitize_nvm] |= cpu_to_le32(NVME_CMD_EFFECTS_LBCC |
3459 						NVME_CMD_EFFECTS_CSE_MASK);
3460 
3461 	/*
3462 	 * The spec says the result of a security receive command depends on
3463 	 * the previous security send command. As such, many vendors log this
3464 	 * command as one to submitted only when no other commands to the same
3465 	 * namespace are outstanding. The intention is to tell the host to
3466 	 * prevent mixing security send and receive.
3467 	 *
3468 	 * This driver can only enforce such exclusive access against IO
3469 	 * queues, though. We are not readily able to enforce such a rule for
3470 	 * two commands to the admin queue, which is the only queue that
3471 	 * matters for this command.
3472 	 *
3473 	 * Rather than blindly freezing the IO queues for this effect that
3474 	 * doesn't even apply to IO, mask it off.
3475 	 */
3476 	log->acs[nvme_admin_security_recv] &= cpu_to_le32(~NVME_CMD_EFFECTS_CSE_MASK);
3477 
3478 	log->iocs[nvme_cmd_write] |= cpu_to_le32(NVME_CMD_EFFECTS_LBCC);
3479 	log->iocs[nvme_cmd_write_zeroes] |= cpu_to_le32(NVME_CMD_EFFECTS_LBCC);
3480 	log->iocs[nvme_cmd_write_uncor] |= cpu_to_le32(NVME_CMD_EFFECTS_LBCC);
3481 }
3482 
nvme_init_effects(struct nvme_ctrl * ctrl,struct nvme_id_ctrl * id)3483 static int nvme_init_effects(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
3484 {
3485 	int ret = 0;
3486 
3487 	if (ctrl->effects)
3488 		return 0;
3489 
3490 	if (id->lpa & NVME_CTRL_LPA_CMD_EFFECTS_LOG) {
3491 		ret = nvme_get_effects_log(ctrl, NVME_CSI_NVM, &ctrl->effects);
3492 		if (ret < 0)
3493 			return ret;
3494 	}
3495 
3496 	if (!ctrl->effects) {
3497 		ret = nvme_init_effects_log(ctrl, NVME_CSI_NVM, &ctrl->effects);
3498 		if (ret < 0)
3499 			return ret;
3500 	}
3501 
3502 	nvme_init_known_nvm_effects(ctrl);
3503 	return 0;
3504 }
3505 
nvme_check_ctrl_fabric_info(struct nvme_ctrl * ctrl,struct nvme_id_ctrl * id)3506 static int nvme_check_ctrl_fabric_info(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
3507 {
3508 	/*
3509 	 * In fabrics we need to verify the cntlid matches the
3510 	 * admin connect
3511 	 */
3512 	if (ctrl->cntlid != le16_to_cpu(id->cntlid)) {
3513 		dev_err(ctrl->device,
3514 			"Mismatching cntlid: Connect %u vs Identify %u, rejecting\n",
3515 			ctrl->cntlid, le16_to_cpu(id->cntlid));
3516 		return -EINVAL;
3517 	}
3518 
3519 	if (!nvme_discovery_ctrl(ctrl) && !ctrl->kas) {
3520 		dev_err(ctrl->device,
3521 			"keep-alive support is mandatory for fabrics\n");
3522 		return -EINVAL;
3523 	}
3524 
3525 	if (nvme_is_io_ctrl(ctrl) && ctrl->ioccsz < 4) {
3526 		dev_err(ctrl->device,
3527 			"I/O queue command capsule supported size %d < 4\n",
3528 			ctrl->ioccsz);
3529 		return -EINVAL;
3530 	}
3531 
3532 	if (nvme_is_io_ctrl(ctrl) && ctrl->iorcsz < 1) {
3533 		dev_err(ctrl->device,
3534 			"I/O queue response capsule supported size %d < 1\n",
3535 			ctrl->iorcsz);
3536 		return -EINVAL;
3537 	}
3538 
3539 	if (!ctrl->maxcmd) {
3540 		dev_warn(ctrl->device,
3541 			"Firmware bug: maximum outstanding commands is 0\n");
3542 		ctrl->maxcmd = ctrl->sqsize + 1;
3543 	}
3544 
3545 	return 0;
3546 }
3547 
nvme_init_identify(struct nvme_ctrl * ctrl)3548 static int nvme_init_identify(struct nvme_ctrl *ctrl)
3549 {
3550 	struct queue_limits lim;
3551 	struct nvme_id_ctrl *id;
3552 	u32 max_hw_sectors;
3553 	bool prev_apst_enabled;
3554 	int ret;
3555 
3556 	ret = nvme_identify_ctrl(ctrl, &id);
3557 	if (ret) {
3558 		dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret);
3559 		return -EIO;
3560 	}
3561 
3562 	if (!(ctrl->ops->flags & NVME_F_FABRICS))
3563 		ctrl->cntlid = le16_to_cpu(id->cntlid);
3564 
3565 	if (!ctrl->identified) {
3566 		unsigned int i;
3567 
3568 		/*
3569 		 * Check for quirks.  Quirk can depend on firmware version,
3570 		 * so, in principle, the set of quirks present can change
3571 		 * across a reset.  As a possible future enhancement, we
3572 		 * could re-scan for quirks every time we reinitialize
3573 		 * the device, but we'd have to make sure that the driver
3574 		 * behaves intelligently if the quirks change.
3575 		 */
3576 		for (i = 0; i < ARRAY_SIZE(core_quirks); i++) {
3577 			if (quirk_matches(id, &core_quirks[i]))
3578 				ctrl->quirks |= core_quirks[i].quirks;
3579 		}
3580 
3581 		ret = nvme_init_subsystem(ctrl, id);
3582 		if (ret)
3583 			goto out_free;
3584 
3585 		ret = nvme_init_effects(ctrl, id);
3586 		if (ret)
3587 			goto out_free;
3588 	}
3589 	memcpy(ctrl->subsys->firmware_rev, id->fr,
3590 	       sizeof(ctrl->subsys->firmware_rev));
3591 
3592 	if (force_apst && (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) {
3593 		dev_warn(ctrl->device, "forcibly allowing all power states due to nvme_core.force_apst -- use at your own risk\n");
3594 		ctrl->quirks &= ~NVME_QUIRK_NO_DEEPEST_PS;
3595 	}
3596 
3597 	ctrl->crdt[0] = le16_to_cpu(id->crdt1);
3598 	ctrl->crdt[1] = le16_to_cpu(id->crdt2);
3599 	ctrl->crdt[2] = le16_to_cpu(id->crdt3);
3600 
3601 	ctrl->oacs = le16_to_cpu(id->oacs);
3602 	ctrl->oncs = le16_to_cpu(id->oncs);
3603 	ctrl->mtfa = le16_to_cpu(id->mtfa);
3604 	ctrl->oaes = le32_to_cpu(id->oaes);
3605 	ctrl->wctemp = le16_to_cpu(id->wctemp);
3606 	ctrl->cctemp = le16_to_cpu(id->cctemp);
3607 
3608 	atomic_set(&ctrl->abort_limit, id->acl + 1);
3609 	ctrl->vwc = id->vwc;
3610 	if (id->mdts)
3611 		max_hw_sectors = nvme_mps_to_sectors(ctrl, id->mdts);
3612 	else
3613 		max_hw_sectors = UINT_MAX;
3614 	ctrl->max_hw_sectors =
3615 		min_not_zero(ctrl->max_hw_sectors, max_hw_sectors);
3616 
3617 	lim = queue_limits_start_update(ctrl->admin_q);
3618 	nvme_set_ctrl_limits(ctrl, &lim, true);
3619 	ret = queue_limits_commit_update(ctrl->admin_q, &lim);
3620 	if (ret)
3621 		goto out_free;
3622 
3623 	ctrl->sgls = le32_to_cpu(id->sgls);
3624 	ctrl->kas = le16_to_cpu(id->kas);
3625 	ctrl->max_namespaces = le32_to_cpu(id->mnan);
3626 	ctrl->ctratt = le32_to_cpu(id->ctratt);
3627 
3628 	ctrl->cntrltype = id->cntrltype;
3629 	ctrl->dctype = id->dctype;
3630 
3631 	if (id->rtd3e) {
3632 		/* us -> s */
3633 		u32 transition_time = le32_to_cpu(id->rtd3e) / USEC_PER_SEC;
3634 
3635 		ctrl->shutdown_timeout = clamp_t(unsigned int, transition_time,
3636 						 shutdown_timeout, 60);
3637 
3638 		if (ctrl->shutdown_timeout != shutdown_timeout)
3639 			dev_info(ctrl->device,
3640 				 "D3 entry latency set to %u seconds\n",
3641 				 ctrl->shutdown_timeout);
3642 	} else
3643 		ctrl->shutdown_timeout = shutdown_timeout;
3644 
3645 	ctrl->npss = id->npss;
3646 	ctrl->apsta = id->apsta;
3647 	prev_apst_enabled = ctrl->apst_enabled;
3648 	if (ctrl->quirks & NVME_QUIRK_NO_APST) {
3649 		if (force_apst && id->apsta) {
3650 			dev_warn(ctrl->device, "forcibly allowing APST due to nvme_core.force_apst -- use at your own risk\n");
3651 			ctrl->apst_enabled = true;
3652 		} else {
3653 			ctrl->apst_enabled = false;
3654 		}
3655 	} else {
3656 		ctrl->apst_enabled = id->apsta;
3657 	}
3658 	memcpy(ctrl->psd, id->psd, sizeof(ctrl->psd));
3659 
3660 	if (ctrl->ops->flags & NVME_F_FABRICS) {
3661 		ctrl->icdoff = le16_to_cpu(id->icdoff);
3662 		ctrl->ioccsz = le32_to_cpu(id->ioccsz);
3663 		ctrl->iorcsz = le32_to_cpu(id->iorcsz);
3664 		ctrl->maxcmd = le16_to_cpu(id->maxcmd);
3665 
3666 		ret = nvme_check_ctrl_fabric_info(ctrl, id);
3667 		if (ret)
3668 			goto out_free;
3669 	} else {
3670 		ctrl->hmpre = le32_to_cpu(id->hmpre);
3671 		ctrl->hmmin = le32_to_cpu(id->hmmin);
3672 		ctrl->hmminds = le32_to_cpu(id->hmminds);
3673 		ctrl->hmmaxd = le16_to_cpu(id->hmmaxd);
3674 	}
3675 
3676 	ret = nvme_mpath_init_identify(ctrl, id);
3677 	if (ret < 0)
3678 		goto out_free;
3679 
3680 	if (ctrl->apst_enabled && !prev_apst_enabled)
3681 		dev_pm_qos_expose_latency_tolerance(ctrl->device);
3682 	else if (!ctrl->apst_enabled && prev_apst_enabled)
3683 		dev_pm_qos_hide_latency_tolerance(ctrl->device);
3684 	ctrl->awupf = le16_to_cpu(id->awupf);
3685 out_free:
3686 	kfree(id);
3687 	return ret;
3688 }
3689 
3690 /*
3691  * Initialize the cached copies of the Identify data and various controller
3692  * register in our nvme_ctrl structure.  This should be called as soon as
3693  * the admin queue is fully up and running.
3694  */
nvme_init_ctrl_finish(struct nvme_ctrl * ctrl,bool was_suspended)3695 int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl, bool was_suspended)
3696 {
3697 	int ret;
3698 
3699 	ret = ctrl->ops->reg_read32(ctrl, NVME_REG_VS, &ctrl->vs);
3700 	if (ret) {
3701 		dev_err(ctrl->device, "Reading VS failed (%d)\n", ret);
3702 		return ret;
3703 	}
3704 
3705 	ctrl->sqsize = min_t(u16, NVME_CAP_MQES(ctrl->cap), ctrl->sqsize);
3706 
3707 	if (ctrl->vs >= NVME_VS(1, 1, 0))
3708 		ctrl->subsystem = NVME_CAP_NSSRC(ctrl->cap);
3709 
3710 	ret = nvme_init_identify(ctrl);
3711 	if (ret)
3712 		return ret;
3713 
3714 	if (nvme_admin_ctrl(ctrl)) {
3715 		/*
3716 		 * An admin controller has one admin queue, but no I/O queues.
3717 		 * Override queue_count so it only creates an admin queue.
3718 		 */
3719 		dev_dbg(ctrl->device,
3720 			"Subsystem %s is an administrative controller",
3721 			ctrl->subsys->subnqn);
3722 		ctrl->queue_count = 1;
3723 	}
3724 
3725 	ret = nvme_configure_apst(ctrl);
3726 	if (ret < 0)
3727 		return ret;
3728 
3729 	ret = nvme_configure_timestamp(ctrl);
3730 	if (ret < 0)
3731 		return ret;
3732 
3733 	ret = nvme_configure_host_options(ctrl);
3734 	if (ret < 0)
3735 		return ret;
3736 
3737 	nvme_configure_opal(ctrl, was_suspended);
3738 
3739 	if (!ctrl->identified && !nvme_discovery_ctrl(ctrl)) {
3740 		/*
3741 		 * Do not return errors unless we are in a controller reset,
3742 		 * the controller works perfectly fine without hwmon.
3743 		 */
3744 		ret = nvme_hwmon_init(ctrl);
3745 		if (ret == -EINTR)
3746 			return ret;
3747 	}
3748 
3749 	clear_bit(NVME_CTRL_DIRTY_CAPABILITY, &ctrl->flags);
3750 	ctrl->identified = true;
3751 
3752 	nvme_start_keep_alive(ctrl);
3753 
3754 	return 0;
3755 }
3756 EXPORT_SYMBOL_GPL(nvme_init_ctrl_finish);
3757 
nvme_dev_open(struct inode * inode,struct file * file)3758 static int nvme_dev_open(struct inode *inode, struct file *file)
3759 {
3760 	struct nvme_ctrl *ctrl =
3761 		container_of(inode->i_cdev, struct nvme_ctrl, cdev);
3762 
3763 	switch (nvme_ctrl_state(ctrl)) {
3764 	case NVME_CTRL_LIVE:
3765 		break;
3766 	default:
3767 		return -EWOULDBLOCK;
3768 	}
3769 
3770 	nvme_get_ctrl(ctrl);
3771 	if (!try_module_get(ctrl->ops->module)) {
3772 		nvme_put_ctrl(ctrl);
3773 		return -EINVAL;
3774 	}
3775 
3776 	file->private_data = ctrl;
3777 	return 0;
3778 }
3779 
nvme_dev_release(struct inode * inode,struct file * file)3780 static int nvme_dev_release(struct inode *inode, struct file *file)
3781 {
3782 	struct nvme_ctrl *ctrl =
3783 		container_of(inode->i_cdev, struct nvme_ctrl, cdev);
3784 
3785 	module_put(ctrl->ops->module);
3786 	nvme_put_ctrl(ctrl);
3787 	return 0;
3788 }
3789 
3790 static const struct file_operations nvme_dev_fops = {
3791 	.owner		= THIS_MODULE,
3792 	.open		= nvme_dev_open,
3793 	.release	= nvme_dev_release,
3794 	.unlocked_ioctl	= nvme_dev_ioctl,
3795 	.compat_ioctl	= compat_ptr_ioctl,
3796 	.uring_cmd	= nvme_dev_uring_cmd,
3797 };
3798 
nvme_find_ns_head(struct nvme_ctrl * ctrl,unsigned nsid)3799 static struct nvme_ns_head *nvme_find_ns_head(struct nvme_ctrl *ctrl,
3800 		unsigned nsid)
3801 {
3802 	struct nvme_ns_head *h;
3803 
3804 	lockdep_assert_held(&ctrl->subsys->lock);
3805 
3806 	list_for_each_entry(h, &ctrl->subsys->nsheads, entry) {
3807 		/*
3808 		 * Private namespaces can share NSIDs under some conditions.
3809 		 * In that case we can't use the same ns_head for namespaces
3810 		 * with the same NSID.
3811 		 */
3812 		if (h->ns_id != nsid || !nvme_is_unique_nsid(ctrl, h))
3813 			continue;
3814 		if (nvme_tryget_ns_head(h))
3815 			return h;
3816 	}
3817 
3818 	return NULL;
3819 }
3820 
nvme_subsys_check_duplicate_ids(struct nvme_subsystem * subsys,struct nvme_ns_ids * ids)3821 static int nvme_subsys_check_duplicate_ids(struct nvme_subsystem *subsys,
3822 		struct nvme_ns_ids *ids)
3823 {
3824 	bool has_uuid = !uuid_is_null(&ids->uuid);
3825 	bool has_nguid = memchr_inv(ids->nguid, 0, sizeof(ids->nguid));
3826 	bool has_eui64 = memchr_inv(ids->eui64, 0, sizeof(ids->eui64));
3827 	struct nvme_ns_head *h;
3828 
3829 	lockdep_assert_held(&subsys->lock);
3830 
3831 	list_for_each_entry(h, &subsys->nsheads, entry) {
3832 		if (has_uuid && uuid_equal(&ids->uuid, &h->ids.uuid))
3833 			return -EINVAL;
3834 		if (has_nguid &&
3835 		    memcmp(&ids->nguid, &h->ids.nguid, sizeof(ids->nguid)) == 0)
3836 			return -EINVAL;
3837 		if (has_eui64 &&
3838 		    memcmp(&ids->eui64, &h->ids.eui64, sizeof(ids->eui64)) == 0)
3839 			return -EINVAL;
3840 	}
3841 
3842 	return 0;
3843 }
3844 
nvme_cdev_rel(struct device * dev)3845 static void nvme_cdev_rel(struct device *dev)
3846 {
3847 	ida_free(&nvme_ns_chr_minor_ida, MINOR(dev->devt));
3848 }
3849 
nvme_cdev_del(struct cdev * cdev,struct device * cdev_device)3850 void nvme_cdev_del(struct cdev *cdev, struct device *cdev_device)
3851 {
3852 	cdev_device_del(cdev, cdev_device);
3853 	put_device(cdev_device);
3854 }
3855 
nvme_cdev_add(struct cdev * cdev,struct device * cdev_device,const struct file_operations * fops,struct module * owner)3856 int nvme_cdev_add(struct cdev *cdev, struct device *cdev_device,
3857 		const struct file_operations *fops, struct module *owner)
3858 {
3859 	int minor, ret;
3860 
3861 	minor = ida_alloc(&nvme_ns_chr_minor_ida, GFP_KERNEL);
3862 	if (minor < 0)
3863 		return minor;
3864 	cdev_device->devt = MKDEV(MAJOR(nvme_ns_chr_devt), minor);
3865 	cdev_device->class = &nvme_ns_chr_class;
3866 	cdev_device->release = nvme_cdev_rel;
3867 	device_initialize(cdev_device);
3868 	cdev_init(cdev, fops);
3869 	cdev->owner = owner;
3870 	ret = cdev_device_add(cdev, cdev_device);
3871 	if (ret)
3872 		put_device(cdev_device);
3873 
3874 	return ret;
3875 }
3876 
nvme_ns_chr_open(struct inode * inode,struct file * file)3877 static int nvme_ns_chr_open(struct inode *inode, struct file *file)
3878 {
3879 	return nvme_ns_open(container_of(inode->i_cdev, struct nvme_ns, cdev));
3880 }
3881 
nvme_ns_chr_release(struct inode * inode,struct file * file)3882 static int nvme_ns_chr_release(struct inode *inode, struct file *file)
3883 {
3884 	nvme_ns_release(container_of(inode->i_cdev, struct nvme_ns, cdev));
3885 	return 0;
3886 }
3887 
3888 static const struct file_operations nvme_ns_chr_fops = {
3889 	.owner		= THIS_MODULE,
3890 	.open		= nvme_ns_chr_open,
3891 	.release	= nvme_ns_chr_release,
3892 	.unlocked_ioctl	= nvme_ns_chr_ioctl,
3893 	.compat_ioctl	= compat_ptr_ioctl,
3894 	.uring_cmd	= nvme_ns_chr_uring_cmd,
3895 	.uring_cmd_iopoll = nvme_ns_chr_uring_cmd_iopoll,
3896 };
3897 
nvme_add_ns_cdev(struct nvme_ns * ns)3898 static int nvme_add_ns_cdev(struct nvme_ns *ns)
3899 {
3900 	int ret;
3901 
3902 	ns->cdev_device.parent = ns->ctrl->device;
3903 	ret = dev_set_name(&ns->cdev_device, "ng%dn%d",
3904 			   ns->ctrl->instance, ns->head->instance);
3905 	if (ret)
3906 		return ret;
3907 
3908 	return nvme_cdev_add(&ns->cdev, &ns->cdev_device, &nvme_ns_chr_fops,
3909 			     ns->ctrl->ops->module);
3910 }
3911 
nvme_alloc_ns_head(struct nvme_ctrl * ctrl,struct nvme_ns_info * info)3912 static struct nvme_ns_head *nvme_alloc_ns_head(struct nvme_ctrl *ctrl,
3913 		struct nvme_ns_info *info)
3914 {
3915 	struct nvme_ns_head *head;
3916 	size_t size = sizeof(*head);
3917 	int ret = -ENOMEM;
3918 
3919 #ifdef CONFIG_NVME_MULTIPATH
3920 	size += num_possible_nodes() * sizeof(struct nvme_ns *);
3921 #endif
3922 
3923 	head = kzalloc(size, GFP_KERNEL);
3924 	if (!head)
3925 		goto out;
3926 	ret = ida_alloc_min(&ctrl->subsys->ns_ida, 1, GFP_KERNEL);
3927 	if (ret < 0)
3928 		goto out_free_head;
3929 	head->instance = ret;
3930 	INIT_LIST_HEAD(&head->list);
3931 	ret = init_srcu_struct(&head->srcu);
3932 	if (ret)
3933 		goto out_ida_remove;
3934 	head->subsys = ctrl->subsys;
3935 	head->ns_id = info->nsid;
3936 	head->ids = info->ids;
3937 	head->shared = info->is_shared;
3938 	head->rotational = info->is_rotational;
3939 	ratelimit_state_init(&head->rs_nuse, 5 * HZ, 1);
3940 	ratelimit_set_flags(&head->rs_nuse, RATELIMIT_MSG_ON_RELEASE);
3941 	kref_init(&head->ref);
3942 
3943 	if (head->ids.csi) {
3944 		ret = nvme_get_effects_log(ctrl, head->ids.csi, &head->effects);
3945 		if (ret)
3946 			goto out_cleanup_srcu;
3947 	} else
3948 		head->effects = ctrl->effects;
3949 
3950 	ret = nvme_mpath_alloc_disk(ctrl, head);
3951 	if (ret)
3952 		goto out_cleanup_srcu;
3953 
3954 	list_add_tail(&head->entry, &ctrl->subsys->nsheads);
3955 
3956 	kref_get(&ctrl->subsys->ref);
3957 
3958 	return head;
3959 out_cleanup_srcu:
3960 	cleanup_srcu_struct(&head->srcu);
3961 out_ida_remove:
3962 	ida_free(&ctrl->subsys->ns_ida, head->instance);
3963 out_free_head:
3964 	kfree(head);
3965 out:
3966 	if (ret > 0)
3967 		ret = blk_status_to_errno(nvme_error_status(ret));
3968 	return ERR_PTR(ret);
3969 }
3970 
nvme_global_check_duplicate_ids(struct nvme_subsystem * this,struct nvme_ns_ids * ids)3971 static int nvme_global_check_duplicate_ids(struct nvme_subsystem *this,
3972 		struct nvme_ns_ids *ids)
3973 {
3974 	struct nvme_subsystem *s;
3975 	int ret = 0;
3976 
3977 	/*
3978 	 * Note that this check is racy as we try to avoid holding the global
3979 	 * lock over the whole ns_head creation.  But it is only intended as
3980 	 * a sanity check anyway.
3981 	 */
3982 	mutex_lock(&nvme_subsystems_lock);
3983 	list_for_each_entry(s, &nvme_subsystems, entry) {
3984 		if (s == this)
3985 			continue;
3986 		mutex_lock(&s->lock);
3987 		ret = nvme_subsys_check_duplicate_ids(s, ids);
3988 		mutex_unlock(&s->lock);
3989 		if (ret)
3990 			break;
3991 	}
3992 	mutex_unlock(&nvme_subsystems_lock);
3993 
3994 	return ret;
3995 }
3996 
nvme_init_ns_head(struct nvme_ns * ns,struct nvme_ns_info * info)3997 static int nvme_init_ns_head(struct nvme_ns *ns, struct nvme_ns_info *info)
3998 {
3999 	struct nvme_ctrl *ctrl = ns->ctrl;
4000 	struct nvme_ns_head *head = NULL;
4001 	int ret;
4002 
4003 	ret = nvme_global_check_duplicate_ids(ctrl->subsys, &info->ids);
4004 	if (ret) {
4005 		/*
4006 		 * We've found two different namespaces on two different
4007 		 * subsystems that report the same ID.  This is pretty nasty
4008 		 * for anything that actually requires unique device
4009 		 * identification.  In the kernel we need this for multipathing,
4010 		 * and in user space the /dev/disk/by-id/ links rely on it.
4011 		 *
4012 		 * If the device also claims to be multi-path capable back off
4013 		 * here now and refuse the probe the second device as this is a
4014 		 * recipe for data corruption.  If not this is probably a
4015 		 * cheap consumer device if on the PCIe bus, so let the user
4016 		 * proceed and use the shiny toy, but warn that with changing
4017 		 * probing order (which due to our async probing could just be
4018 		 * device taking longer to startup) the other device could show
4019 		 * up at any time.
4020 		 */
4021 		nvme_print_device_info(ctrl);
4022 		if ((ns->ctrl->ops->flags & NVME_F_FABRICS) || /* !PCIe */
4023 		    ((ns->ctrl->subsys->cmic & NVME_CTRL_CMIC_MULTI_CTRL) &&
4024 		     info->is_shared)) {
4025 			dev_err(ctrl->device,
4026 				"ignoring nsid %d because of duplicate IDs\n",
4027 				info->nsid);
4028 			return ret;
4029 		}
4030 
4031 		dev_err(ctrl->device,
4032 			"clearing duplicate IDs for nsid %d\n", info->nsid);
4033 		dev_err(ctrl->device,
4034 			"use of /dev/disk/by-id/ may cause data corruption\n");
4035 		memset(&info->ids.nguid, 0, sizeof(info->ids.nguid));
4036 		memset(&info->ids.uuid, 0, sizeof(info->ids.uuid));
4037 		memset(&info->ids.eui64, 0, sizeof(info->ids.eui64));
4038 		ctrl->quirks |= NVME_QUIRK_BOGUS_NID;
4039 	}
4040 
4041 	mutex_lock(&ctrl->subsys->lock);
4042 	head = nvme_find_ns_head(ctrl, info->nsid);
4043 	if (!head) {
4044 		ret = nvme_subsys_check_duplicate_ids(ctrl->subsys, &info->ids);
4045 		if (ret) {
4046 			dev_err(ctrl->device,
4047 				"duplicate IDs in subsystem for nsid %d\n",
4048 				info->nsid);
4049 			goto out_unlock;
4050 		}
4051 		head = nvme_alloc_ns_head(ctrl, info);
4052 		if (IS_ERR(head)) {
4053 			ret = PTR_ERR(head);
4054 			goto out_unlock;
4055 		}
4056 	} else {
4057 		ret = -EINVAL;
4058 		if ((!info->is_shared || !head->shared) &&
4059 		    !list_empty(&head->list)) {
4060 			dev_err(ctrl->device,
4061 				"Duplicate unshared namespace %d\n",
4062 				info->nsid);
4063 			goto out_put_ns_head;
4064 		}
4065 		if (!nvme_ns_ids_equal(&head->ids, &info->ids)) {
4066 			dev_err(ctrl->device,
4067 				"IDs don't match for shared namespace %d\n",
4068 					info->nsid);
4069 			goto out_put_ns_head;
4070 		}
4071 
4072 		if (!multipath) {
4073 			dev_warn(ctrl->device,
4074 				"Found shared namespace %d, but multipathing not supported.\n",
4075 				info->nsid);
4076 			dev_warn_once(ctrl->device,
4077 				"Shared namespace support requires core_nvme.multipath=Y.\n");
4078 		}
4079 	}
4080 
4081 	list_add_tail_rcu(&ns->siblings, &head->list);
4082 	ns->head = head;
4083 	mutex_unlock(&ctrl->subsys->lock);
4084 
4085 #ifdef CONFIG_NVME_MULTIPATH
4086 	cancel_delayed_work(&head->remove_work);
4087 #endif
4088 	return 0;
4089 
4090 out_put_ns_head:
4091 	nvme_put_ns_head(head);
4092 out_unlock:
4093 	mutex_unlock(&ctrl->subsys->lock);
4094 	return ret;
4095 }
4096 
nvme_find_get_ns(struct nvme_ctrl * ctrl,unsigned nsid)4097 struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid)
4098 {
4099 	struct nvme_ns *ns, *ret = NULL;
4100 	int srcu_idx;
4101 
4102 	srcu_idx = srcu_read_lock(&ctrl->srcu);
4103 	list_for_each_entry_srcu(ns, &ctrl->namespaces, list,
4104 				 srcu_read_lock_held(&ctrl->srcu)) {
4105 		if (ns->head->ns_id == nsid) {
4106 			if (!nvme_get_ns(ns))
4107 				continue;
4108 			ret = ns;
4109 			break;
4110 		}
4111 		if (ns->head->ns_id > nsid)
4112 			break;
4113 	}
4114 	srcu_read_unlock(&ctrl->srcu, srcu_idx);
4115 	return ret;
4116 }
4117 EXPORT_SYMBOL_NS_GPL(nvme_find_get_ns, "NVME_TARGET_PASSTHRU");
4118 
4119 /*
4120  * Add the namespace to the controller list while keeping the list ordered.
4121  */
nvme_ns_add_to_ctrl_list(struct nvme_ns * ns)4122 static void nvme_ns_add_to_ctrl_list(struct nvme_ns *ns)
4123 {
4124 	struct nvme_ns *tmp;
4125 
4126 	list_for_each_entry_reverse(tmp, &ns->ctrl->namespaces, list) {
4127 		if (tmp->head->ns_id < ns->head->ns_id) {
4128 			list_add_rcu(&ns->list, &tmp->list);
4129 			return;
4130 		}
4131 	}
4132 	list_add_rcu(&ns->list, &ns->ctrl->namespaces);
4133 }
4134 
nvme_alloc_ns(struct nvme_ctrl * ctrl,struct nvme_ns_info * info)4135 static void nvme_alloc_ns(struct nvme_ctrl *ctrl, struct nvme_ns_info *info)
4136 {
4137 	struct queue_limits lim = { };
4138 	struct nvme_ns *ns;
4139 	struct gendisk *disk;
4140 	int node = ctrl->numa_node;
4141 	bool last_path = false;
4142 
4143 	ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
4144 	if (!ns)
4145 		return;
4146 
4147 	if (ctrl->opts && ctrl->opts->data_digest)
4148 		lim.features |= BLK_FEAT_STABLE_WRITES;
4149 	if (ctrl->ops->supports_pci_p2pdma &&
4150 	    ctrl->ops->supports_pci_p2pdma(ctrl))
4151 		lim.features |= BLK_FEAT_PCI_P2PDMA;
4152 
4153 	disk = blk_mq_alloc_disk(ctrl->tagset, &lim, ns);
4154 	if (IS_ERR(disk))
4155 		goto out_free_ns;
4156 	disk->fops = &nvme_bdev_ops;
4157 	disk->private_data = ns;
4158 
4159 	ns->disk = disk;
4160 	ns->queue = disk->queue;
4161 	ns->ctrl = ctrl;
4162 	kref_init(&ns->kref);
4163 
4164 	if (nvme_init_ns_head(ns, info))
4165 		goto out_cleanup_disk;
4166 
4167 	/*
4168 	 * If multipathing is enabled, the device name for all disks and not
4169 	 * just those that represent shared namespaces needs to be based on the
4170 	 * subsystem instance.  Using the controller instance for private
4171 	 * namespaces could lead to naming collisions between shared and private
4172 	 * namespaces if they don't use a common numbering scheme.
4173 	 *
4174 	 * If multipathing is not enabled, disk names must use the controller
4175 	 * instance as shared namespaces will show up as multiple block
4176 	 * devices.
4177 	 */
4178 	if (nvme_ns_head_multipath(ns->head)) {
4179 		sprintf(disk->disk_name, "nvme%dc%dn%d", ctrl->subsys->instance,
4180 			ctrl->instance, ns->head->instance);
4181 		disk->flags |= GENHD_FL_HIDDEN;
4182 	} else if (multipath) {
4183 		sprintf(disk->disk_name, "nvme%dn%d", ctrl->subsys->instance,
4184 			ns->head->instance);
4185 	} else {
4186 		sprintf(disk->disk_name, "nvme%dn%d", ctrl->instance,
4187 			ns->head->instance);
4188 	}
4189 
4190 	if (nvme_update_ns_info(ns, info))
4191 		goto out_unlink_ns;
4192 
4193 	mutex_lock(&ctrl->namespaces_lock);
4194 	/*
4195 	 * Ensure that no namespaces are added to the ctrl list after the queues
4196 	 * are frozen, thereby avoiding a deadlock between scan and reset.
4197 	 */
4198 	if (test_bit(NVME_CTRL_FROZEN, &ctrl->flags)) {
4199 		mutex_unlock(&ctrl->namespaces_lock);
4200 		goto out_unlink_ns;
4201 	}
4202 	nvme_ns_add_to_ctrl_list(ns);
4203 	mutex_unlock(&ctrl->namespaces_lock);
4204 	synchronize_srcu(&ctrl->srcu);
4205 	nvme_get_ctrl(ctrl);
4206 
4207 	if (device_add_disk(ctrl->device, ns->disk, nvme_ns_attr_groups))
4208 		goto out_cleanup_ns_from_list;
4209 
4210 	if (!nvme_ns_head_multipath(ns->head))
4211 		nvme_add_ns_cdev(ns);
4212 
4213 	nvme_mpath_add_disk(ns, info->anagrpid);
4214 	nvme_fault_inject_init(&ns->fault_inject, ns->disk->disk_name);
4215 
4216 	return;
4217 
4218  out_cleanup_ns_from_list:
4219 	nvme_put_ctrl(ctrl);
4220 	mutex_lock(&ctrl->namespaces_lock);
4221 	list_del_rcu(&ns->list);
4222 	mutex_unlock(&ctrl->namespaces_lock);
4223 	synchronize_srcu(&ctrl->srcu);
4224  out_unlink_ns:
4225 	mutex_lock(&ctrl->subsys->lock);
4226 	list_del_rcu(&ns->siblings);
4227 	if (list_empty(&ns->head->list)) {
4228 		list_del_init(&ns->head->entry);
4229 		/*
4230 		 * If multipath is not configured, we still create a namespace
4231 		 * head (nshead), but head->disk is not initialized in that
4232 		 * case.  As a result, only a single reference to nshead is held
4233 		 * (via kref_init()) when it is created. Therefore, ensure that
4234 		 * we do not release the reference to nshead twice if head->disk
4235 		 * is not present.
4236 		 */
4237 		if (ns->head->disk)
4238 			last_path = true;
4239 	}
4240 	mutex_unlock(&ctrl->subsys->lock);
4241 	if (last_path)
4242 		nvme_put_ns_head(ns->head);
4243 	nvme_put_ns_head(ns->head);
4244  out_cleanup_disk:
4245 	put_disk(disk);
4246  out_free_ns:
4247 	kfree(ns);
4248 }
4249 
nvme_ns_remove(struct nvme_ns * ns)4250 static void nvme_ns_remove(struct nvme_ns *ns)
4251 {
4252 	bool last_path = false;
4253 
4254 	if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
4255 		return;
4256 
4257 	clear_bit(NVME_NS_READY, &ns->flags);
4258 	set_capacity(ns->disk, 0);
4259 	nvme_fault_inject_fini(&ns->fault_inject);
4260 
4261 	/*
4262 	 * Ensure that !NVME_NS_READY is seen by other threads to prevent
4263 	 * this ns going back into current_path.
4264 	 */
4265 	synchronize_srcu(&ns->head->srcu);
4266 
4267 	/* wait for concurrent submissions */
4268 	if (nvme_mpath_clear_current_path(ns))
4269 		synchronize_srcu(&ns->head->srcu);
4270 
4271 	mutex_lock(&ns->ctrl->subsys->lock);
4272 	list_del_rcu(&ns->siblings);
4273 	if (list_empty(&ns->head->list)) {
4274 		if (!nvme_mpath_queue_if_no_path(ns->head))
4275 			list_del_init(&ns->head->entry);
4276 		last_path = true;
4277 	}
4278 	mutex_unlock(&ns->ctrl->subsys->lock);
4279 
4280 	/* guarantee not available in head->list */
4281 	synchronize_srcu(&ns->head->srcu);
4282 
4283 	if (!nvme_ns_head_multipath(ns->head))
4284 		nvme_cdev_del(&ns->cdev, &ns->cdev_device);
4285 
4286 	nvme_mpath_remove_sysfs_link(ns);
4287 
4288 	del_gendisk(ns->disk);
4289 
4290 	mutex_lock(&ns->ctrl->namespaces_lock);
4291 	list_del_rcu(&ns->list);
4292 	mutex_unlock(&ns->ctrl->namespaces_lock);
4293 	synchronize_srcu(&ns->ctrl->srcu);
4294 
4295 	if (last_path)
4296 		nvme_mpath_remove_disk(ns->head);
4297 	nvme_put_ns(ns);
4298 }
4299 
nvme_ns_remove_by_nsid(struct nvme_ctrl * ctrl,u32 nsid)4300 static void nvme_ns_remove_by_nsid(struct nvme_ctrl *ctrl, u32 nsid)
4301 {
4302 	struct nvme_ns *ns = nvme_find_get_ns(ctrl, nsid);
4303 
4304 	if (ns) {
4305 		nvme_ns_remove(ns);
4306 		nvme_put_ns(ns);
4307 	}
4308 }
4309 
nvme_validate_ns(struct nvme_ns * ns,struct nvme_ns_info * info)4310 static void nvme_validate_ns(struct nvme_ns *ns, struct nvme_ns_info *info)
4311 {
4312 	int ret = NVME_SC_INVALID_NS | NVME_STATUS_DNR;
4313 
4314 	if (!nvme_ns_ids_equal(&ns->head->ids, &info->ids)) {
4315 		dev_err(ns->ctrl->device,
4316 			"identifiers changed for nsid %d\n", ns->head->ns_id);
4317 		goto out;
4318 	}
4319 
4320 	ret = nvme_update_ns_info(ns, info);
4321 out:
4322 	/*
4323 	 * Only remove the namespace if we got a fatal error back from the
4324 	 * device, otherwise ignore the error and just move on.
4325 	 *
4326 	 * TODO: we should probably schedule a delayed retry here.
4327 	 */
4328 	if (ret > 0 && (ret & NVME_STATUS_DNR))
4329 		nvme_ns_remove(ns);
4330 }
4331 
nvme_scan_ns(struct nvme_ctrl * ctrl,unsigned nsid)4332 static void nvme_scan_ns(struct nvme_ctrl *ctrl, unsigned nsid)
4333 {
4334 	struct nvme_ns_info info = { .nsid = nsid };
4335 	struct nvme_ns *ns;
4336 	int ret = 1;
4337 
4338 	if (nvme_identify_ns_descs(ctrl, &info))
4339 		return;
4340 
4341 	if (info.ids.csi != NVME_CSI_NVM && !nvme_multi_css(ctrl)) {
4342 		dev_warn(ctrl->device,
4343 			"command set not reported for nsid: %d\n", nsid);
4344 		return;
4345 	}
4346 
4347 	/*
4348 	 * If available try to use the Command Set Independent Identify Namespace
4349 	 * data structure to find all the generic information that is needed to
4350 	 * set up a namespace.  If not fall back to the legacy version.
4351 	 */
4352 	if ((ctrl->cap & NVME_CAP_CRMS_CRIMS) ||
4353 	    (info.ids.csi != NVME_CSI_NVM && info.ids.csi != NVME_CSI_ZNS) ||
4354 	    ctrl->vs >= NVME_VS(2, 0, 0))
4355 		ret = nvme_ns_info_from_id_cs_indep(ctrl, &info);
4356 	if (ret > 0)
4357 		ret = nvme_ns_info_from_identify(ctrl, &info);
4358 
4359 	if (info.is_removed)
4360 		nvme_ns_remove_by_nsid(ctrl, nsid);
4361 
4362 	/*
4363 	 * Ignore the namespace if it is not ready. We will get an AEN once it
4364 	 * becomes ready and restart the scan.
4365 	 */
4366 	if (ret || !info.is_ready)
4367 		return;
4368 
4369 	ns = nvme_find_get_ns(ctrl, nsid);
4370 	if (ns) {
4371 		nvme_validate_ns(ns, &info);
4372 		nvme_put_ns(ns);
4373 	} else {
4374 		nvme_alloc_ns(ctrl, &info);
4375 	}
4376 }
4377 
4378 /**
4379  * struct async_scan_info - keeps track of controller & NSIDs to scan
4380  * @ctrl:	Controller on which namespaces are being scanned
4381  * @next_nsid:	Index of next NSID to scan in ns_list
4382  * @ns_list:	Pointer to list of NSIDs to scan
4383  *
4384  * Note: There is a single async_scan_info structure shared by all instances
4385  * of nvme_scan_ns_async() scanning a given controller, so the atomic
4386  * operations on next_nsid are critical to ensure each instance scans a unique
4387  * NSID.
4388  */
4389 struct async_scan_info {
4390 	struct nvme_ctrl *ctrl;
4391 	atomic_t next_nsid;
4392 	__le32 *ns_list;
4393 };
4394 
nvme_scan_ns_async(void * data,async_cookie_t cookie)4395 static void nvme_scan_ns_async(void *data, async_cookie_t cookie)
4396 {
4397 	struct async_scan_info *scan_info = data;
4398 	int idx;
4399 	u32 nsid;
4400 
4401 	idx = (u32)atomic_fetch_inc(&scan_info->next_nsid);
4402 	nsid = le32_to_cpu(scan_info->ns_list[idx]);
4403 
4404 	nvme_scan_ns(scan_info->ctrl, nsid);
4405 }
4406 
nvme_remove_invalid_namespaces(struct nvme_ctrl * ctrl,unsigned nsid)4407 static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
4408 					unsigned nsid)
4409 {
4410 	struct nvme_ns *ns, *next;
4411 	LIST_HEAD(rm_list);
4412 
4413 	mutex_lock(&ctrl->namespaces_lock);
4414 	list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) {
4415 		if (ns->head->ns_id > nsid) {
4416 			list_del_rcu(&ns->list);
4417 			synchronize_srcu(&ctrl->srcu);
4418 			list_add_tail_rcu(&ns->list, &rm_list);
4419 		}
4420 	}
4421 	mutex_unlock(&ctrl->namespaces_lock);
4422 
4423 	list_for_each_entry_safe(ns, next, &rm_list, list)
4424 		nvme_ns_remove(ns);
4425 }
4426 
nvme_scan_ns_list(struct nvme_ctrl * ctrl)4427 static int nvme_scan_ns_list(struct nvme_ctrl *ctrl)
4428 {
4429 	const int nr_entries = NVME_IDENTIFY_DATA_SIZE / sizeof(__le32);
4430 	__le32 *ns_list;
4431 	u32 prev = 0;
4432 	int ret = 0, i;
4433 	ASYNC_DOMAIN(domain);
4434 	struct async_scan_info scan_info;
4435 
4436 	ns_list = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
4437 	if (!ns_list)
4438 		return -ENOMEM;
4439 
4440 	scan_info.ctrl = ctrl;
4441 	scan_info.ns_list = ns_list;
4442 	for (;;) {
4443 		struct nvme_command cmd = {
4444 			.identify.opcode	= nvme_admin_identify,
4445 			.identify.cns		= NVME_ID_CNS_NS_ACTIVE_LIST,
4446 			.identify.nsid		= cpu_to_le32(prev),
4447 		};
4448 
4449 		ret = nvme_submit_sync_cmd(ctrl->admin_q, &cmd, ns_list,
4450 					    NVME_IDENTIFY_DATA_SIZE);
4451 		if (ret) {
4452 			dev_warn(ctrl->device,
4453 				"Identify NS List failed (status=0x%x)\n", ret);
4454 			goto free;
4455 		}
4456 
4457 		atomic_set(&scan_info.next_nsid, 0);
4458 		for (i = 0; i < nr_entries; i++) {
4459 			u32 nsid = le32_to_cpu(ns_list[i]);
4460 
4461 			if (!nsid)	/* end of the list? */
4462 				goto out;
4463 			async_schedule_domain(nvme_scan_ns_async, &scan_info,
4464 						&domain);
4465 			while (++prev < nsid)
4466 				nvme_ns_remove_by_nsid(ctrl, prev);
4467 		}
4468 		async_synchronize_full_domain(&domain);
4469 	}
4470  out:
4471 	nvme_remove_invalid_namespaces(ctrl, prev);
4472  free:
4473 	async_synchronize_full_domain(&domain);
4474 	kfree(ns_list);
4475 	return ret;
4476 }
4477 
nvme_scan_ns_sequential(struct nvme_ctrl * ctrl)4478 static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl)
4479 {
4480 	struct nvme_id_ctrl *id;
4481 	u32 nn, i;
4482 
4483 	if (nvme_identify_ctrl(ctrl, &id))
4484 		return;
4485 	nn = le32_to_cpu(id->nn);
4486 	kfree(id);
4487 
4488 	for (i = 1; i <= nn; i++)
4489 		nvme_scan_ns(ctrl, i);
4490 
4491 	nvme_remove_invalid_namespaces(ctrl, nn);
4492 }
4493 
nvme_clear_changed_ns_log(struct nvme_ctrl * ctrl)4494 static void nvme_clear_changed_ns_log(struct nvme_ctrl *ctrl)
4495 {
4496 	size_t log_size = NVME_MAX_CHANGED_NAMESPACES * sizeof(__le32);
4497 	__le32 *log;
4498 	int error;
4499 
4500 	log = kzalloc(log_size, GFP_KERNEL);
4501 	if (!log)
4502 		return;
4503 
4504 	/*
4505 	 * We need to read the log to clear the AEN, but we don't want to rely
4506 	 * on it for the changed namespace information as userspace could have
4507 	 * raced with us in reading the log page, which could cause us to miss
4508 	 * updates.
4509 	 */
4510 	error = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CHANGED_NS, 0,
4511 			NVME_CSI_NVM, log, log_size, 0);
4512 	if (error)
4513 		dev_warn(ctrl->device,
4514 			"reading changed ns log failed: %d\n", error);
4515 
4516 	kfree(log);
4517 }
4518 
nvme_scan_work(struct work_struct * work)4519 static void nvme_scan_work(struct work_struct *work)
4520 {
4521 	struct nvme_ctrl *ctrl =
4522 		container_of(work, struct nvme_ctrl, scan_work);
4523 	int ret;
4524 
4525 	/* No tagset on a live ctrl means IO queues could not created */
4526 	if (nvme_ctrl_state(ctrl) != NVME_CTRL_LIVE || !ctrl->tagset)
4527 		return;
4528 
4529 	/*
4530 	 * Identify controller limits can change at controller reset due to
4531 	 * new firmware download, even though it is not common we cannot ignore
4532 	 * such scenario. Controller's non-mdts limits are reported in the unit
4533 	 * of logical blocks that is dependent on the format of attached
4534 	 * namespace. Hence re-read the limits at the time of ns allocation.
4535 	 */
4536 	ret = nvme_init_non_mdts_limits(ctrl);
4537 	if (ret < 0) {
4538 		dev_warn(ctrl->device,
4539 			"reading non-mdts-limits failed: %d\n", ret);
4540 		return;
4541 	}
4542 
4543 	if (test_and_clear_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events)) {
4544 		dev_info(ctrl->device, "rescanning namespaces.\n");
4545 		nvme_clear_changed_ns_log(ctrl);
4546 	}
4547 
4548 	mutex_lock(&ctrl->scan_lock);
4549 	if (!nvme_id_cns_ok(ctrl, NVME_ID_CNS_NS_ACTIVE_LIST)) {
4550 		nvme_scan_ns_sequential(ctrl);
4551 	} else {
4552 		/*
4553 		 * Fall back to sequential scan if DNR is set to handle broken
4554 		 * devices which should support Identify NS List (as per the VS
4555 		 * they report) but don't actually support it.
4556 		 */
4557 		ret = nvme_scan_ns_list(ctrl);
4558 		if (ret > 0 && ret & NVME_STATUS_DNR)
4559 			nvme_scan_ns_sequential(ctrl);
4560 	}
4561 	mutex_unlock(&ctrl->scan_lock);
4562 
4563 	/* Requeue if we have missed AENs */
4564 	if (test_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events))
4565 		nvme_queue_scan(ctrl);
4566 #ifdef CONFIG_NVME_MULTIPATH
4567 	else if (ctrl->ana_log_buf)
4568 		/* Re-read the ANA log page to not miss updates */
4569 		queue_work(nvme_wq, &ctrl->ana_work);
4570 #endif
4571 }
4572 
4573 /*
4574  * This function iterates the namespace list unlocked to allow recovery from
4575  * controller failure. It is up to the caller to ensure the namespace list is
4576  * not modified by scan work while this function is executing.
4577  */
nvme_remove_namespaces(struct nvme_ctrl * ctrl)4578 void nvme_remove_namespaces(struct nvme_ctrl *ctrl)
4579 {
4580 	struct nvme_ns *ns, *next;
4581 	LIST_HEAD(ns_list);
4582 
4583 	/*
4584 	 * make sure to requeue I/O to all namespaces as these
4585 	 * might result from the scan itself and must complete
4586 	 * for the scan_work to make progress
4587 	 */
4588 	nvme_mpath_clear_ctrl_paths(ctrl);
4589 
4590 	/*
4591 	 * Unquiesce io queues so any pending IO won't hang, especially
4592 	 * those submitted from scan work
4593 	 */
4594 	nvme_unquiesce_io_queues(ctrl);
4595 
4596 	/* prevent racing with ns scanning */
4597 	flush_work(&ctrl->scan_work);
4598 
4599 	/*
4600 	 * The dead states indicates the controller was not gracefully
4601 	 * disconnected. In that case, we won't be able to flush any data while
4602 	 * removing the namespaces' disks; fail all the queues now to avoid
4603 	 * potentially having to clean up the failed sync later.
4604 	 */
4605 	if (nvme_ctrl_state(ctrl) == NVME_CTRL_DEAD)
4606 		nvme_mark_namespaces_dead(ctrl);
4607 
4608 	/* this is a no-op when called from the controller reset handler */
4609 	nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING_NOIO);
4610 
4611 	mutex_lock(&ctrl->namespaces_lock);
4612 	list_splice_init_rcu(&ctrl->namespaces, &ns_list, synchronize_rcu);
4613 	mutex_unlock(&ctrl->namespaces_lock);
4614 	synchronize_srcu(&ctrl->srcu);
4615 
4616 	list_for_each_entry_safe(ns, next, &ns_list, list)
4617 		nvme_ns_remove(ns);
4618 }
4619 EXPORT_SYMBOL_GPL(nvme_remove_namespaces);
4620 
nvme_class_uevent(const struct device * dev,struct kobj_uevent_env * env)4621 static int nvme_class_uevent(const struct device *dev, struct kobj_uevent_env *env)
4622 {
4623 	const struct nvme_ctrl *ctrl =
4624 		container_of(dev, struct nvme_ctrl, ctrl_device);
4625 	struct nvmf_ctrl_options *opts = ctrl->opts;
4626 	int ret;
4627 
4628 	ret = add_uevent_var(env, "NVME_TRTYPE=%s", ctrl->ops->name);
4629 	if (ret)
4630 		return ret;
4631 
4632 	if (opts) {
4633 		ret = add_uevent_var(env, "NVME_TRADDR=%s", opts->traddr);
4634 		if (ret)
4635 			return ret;
4636 
4637 		ret = add_uevent_var(env, "NVME_TRSVCID=%s",
4638 				opts->trsvcid ?: "none");
4639 		if (ret)
4640 			return ret;
4641 
4642 		ret = add_uevent_var(env, "NVME_HOST_TRADDR=%s",
4643 				opts->host_traddr ?: "none");
4644 		if (ret)
4645 			return ret;
4646 
4647 		ret = add_uevent_var(env, "NVME_HOST_IFACE=%s",
4648 				opts->host_iface ?: "none");
4649 	}
4650 	return ret;
4651 }
4652 
nvme_change_uevent(struct nvme_ctrl * ctrl,char * envdata)4653 static void nvme_change_uevent(struct nvme_ctrl *ctrl, char *envdata)
4654 {
4655 	char *envp[2] = { envdata, NULL };
4656 
4657 	kobject_uevent_env(&ctrl->device->kobj, KOBJ_CHANGE, envp);
4658 }
4659 
nvme_aen_uevent(struct nvme_ctrl * ctrl)4660 static void nvme_aen_uevent(struct nvme_ctrl *ctrl)
4661 {
4662 	char *envp[2] = { NULL, NULL };
4663 	u32 aen_result = ctrl->aen_result;
4664 
4665 	ctrl->aen_result = 0;
4666 	if (!aen_result)
4667 		return;
4668 
4669 	envp[0] = kasprintf(GFP_KERNEL, "NVME_AEN=%#08x", aen_result);
4670 	if (!envp[0])
4671 		return;
4672 	kobject_uevent_env(&ctrl->device->kobj, KOBJ_CHANGE, envp);
4673 	kfree(envp[0]);
4674 }
4675 
nvme_async_event_work(struct work_struct * work)4676 static void nvme_async_event_work(struct work_struct *work)
4677 {
4678 	struct nvme_ctrl *ctrl =
4679 		container_of(work, struct nvme_ctrl, async_event_work);
4680 
4681 	nvme_aen_uevent(ctrl);
4682 
4683 	/*
4684 	 * The transport drivers must guarantee AER submission here is safe by
4685 	 * flushing ctrl async_event_work after changing the controller state
4686 	 * from LIVE and before freeing the admin queue.
4687 	*/
4688 	if (nvme_ctrl_state(ctrl) == NVME_CTRL_LIVE)
4689 		ctrl->ops->submit_async_event(ctrl);
4690 }
4691 
nvme_ctrl_pp_status(struct nvme_ctrl * ctrl)4692 static bool nvme_ctrl_pp_status(struct nvme_ctrl *ctrl)
4693 {
4694 
4695 	u32 csts;
4696 
4697 	if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts))
4698 		return false;
4699 
4700 	if (csts == ~0)
4701 		return false;
4702 
4703 	return ((ctrl->ctrl_config & NVME_CC_ENABLE) && (csts & NVME_CSTS_PP));
4704 }
4705 
nvme_get_fw_slot_info(struct nvme_ctrl * ctrl)4706 static void nvme_get_fw_slot_info(struct nvme_ctrl *ctrl)
4707 {
4708 	struct nvme_fw_slot_info_log *log;
4709 	u8 next_fw_slot, cur_fw_slot;
4710 
4711 	log = kmalloc_obj(*log);
4712 	if (!log)
4713 		return;
4714 
4715 	if (nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_FW_SLOT, 0, NVME_CSI_NVM,
4716 			 log, sizeof(*log), 0)) {
4717 		dev_warn(ctrl->device, "Get FW SLOT INFO log error\n");
4718 		goto out_free_log;
4719 	}
4720 
4721 	cur_fw_slot = log->afi & 0x7;
4722 	next_fw_slot = (log->afi & 0x70) >> 4;
4723 	if (!cur_fw_slot || (next_fw_slot && (cur_fw_slot != next_fw_slot))) {
4724 		dev_info(ctrl->device,
4725 			 "Firmware is activated after next Controller Level Reset\n");
4726 		goto out_free_log;
4727 	}
4728 
4729 	memcpy(ctrl->subsys->firmware_rev, &log->frs[cur_fw_slot - 1],
4730 		sizeof(ctrl->subsys->firmware_rev));
4731 
4732 out_free_log:
4733 	kfree(log);
4734 }
4735 
nvme_fw_act_work(struct work_struct * work)4736 static void nvme_fw_act_work(struct work_struct *work)
4737 {
4738 	struct nvme_ctrl *ctrl = container_of(work,
4739 				struct nvme_ctrl, fw_act_work);
4740 	unsigned long fw_act_timeout;
4741 
4742 	nvme_auth_stop(ctrl);
4743 
4744 	if (ctrl->mtfa)
4745 		fw_act_timeout = jiffies + msecs_to_jiffies(ctrl->mtfa * 100);
4746 	else
4747 		fw_act_timeout = jiffies + secs_to_jiffies(admin_timeout);
4748 
4749 	nvme_quiesce_io_queues(ctrl);
4750 	while (nvme_ctrl_pp_status(ctrl)) {
4751 		if (time_after(jiffies, fw_act_timeout)) {
4752 			dev_warn(ctrl->device,
4753 				"Fw activation timeout, reset controller\n");
4754 			nvme_try_sched_reset(ctrl);
4755 			return;
4756 		}
4757 		msleep(100);
4758 	}
4759 
4760 	if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_CONNECTING) ||
4761 	    !nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE))
4762 		return;
4763 
4764 	nvme_unquiesce_io_queues(ctrl);
4765 	/* read FW slot information to clear the AER */
4766 	nvme_get_fw_slot_info(ctrl);
4767 
4768 	queue_work(nvme_wq, &ctrl->async_event_work);
4769 }
4770 
nvme_aer_type(u32 result)4771 static u32 nvme_aer_type(u32 result)
4772 {
4773 	return result & 0x7;
4774 }
4775 
nvme_aer_subtype(u32 result)4776 static u32 nvme_aer_subtype(u32 result)
4777 {
4778 	return (result & 0xff00) >> 8;
4779 }
4780 
nvme_handle_aen_notice(struct nvme_ctrl * ctrl,u32 result)4781 static bool nvme_handle_aen_notice(struct nvme_ctrl *ctrl, u32 result)
4782 {
4783 	u32 aer_notice_type = nvme_aer_subtype(result);
4784 	bool requeue = true;
4785 
4786 	switch (aer_notice_type) {
4787 	case NVME_AER_NOTICE_NS_CHANGED:
4788 		set_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events);
4789 		nvme_queue_scan(ctrl);
4790 		break;
4791 	case NVME_AER_NOTICE_FW_ACT_STARTING:
4792 		/*
4793 		 * We are (ab)using the RESETTING state to prevent subsequent
4794 		 * recovery actions from interfering with the controller's
4795 		 * firmware activation.
4796 		 */
4797 		if (nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING)) {
4798 			requeue = false;
4799 			queue_work(nvme_wq, &ctrl->fw_act_work);
4800 		}
4801 		break;
4802 #ifdef CONFIG_NVME_MULTIPATH
4803 	case NVME_AER_NOTICE_ANA:
4804 		if (!ctrl->ana_log_buf)
4805 			break;
4806 		queue_work(nvme_wq, &ctrl->ana_work);
4807 		break;
4808 #endif
4809 	case NVME_AER_NOTICE_DISC_CHANGED:
4810 		ctrl->aen_result = result;
4811 		break;
4812 	default:
4813 		dev_warn(ctrl->device, "async event result %08x\n", result);
4814 	}
4815 	return requeue;
4816 }
4817 
nvme_handle_aer_persistent_error(struct nvme_ctrl * ctrl)4818 static void nvme_handle_aer_persistent_error(struct nvme_ctrl *ctrl)
4819 {
4820 	dev_warn(ctrl->device,
4821 		"resetting controller due to persistent internal error\n");
4822 	nvme_reset_ctrl(ctrl);
4823 }
4824 
nvme_complete_async_event(struct nvme_ctrl * ctrl,__le16 status,volatile union nvme_result * res)4825 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
4826 		volatile union nvme_result *res)
4827 {
4828 	u32 result = le32_to_cpu(res->u32);
4829 	u32 aer_type = nvme_aer_type(result);
4830 	u32 aer_subtype = nvme_aer_subtype(result);
4831 	bool requeue = true;
4832 
4833 	if (le16_to_cpu(status) >> 1 != NVME_SC_SUCCESS)
4834 		return;
4835 
4836 	trace_nvme_async_event(ctrl, result);
4837 	switch (aer_type) {
4838 	case NVME_AER_NOTICE:
4839 		requeue = nvme_handle_aen_notice(ctrl, result);
4840 		break;
4841 	case NVME_AER_ERROR:
4842 		/*
4843 		 * For a persistent internal error, don't run async_event_work
4844 		 * to submit a new AER. The controller reset will do it.
4845 		 */
4846 		if (aer_subtype == NVME_AER_ERROR_PERSIST_INT_ERR) {
4847 			nvme_handle_aer_persistent_error(ctrl);
4848 			return;
4849 		}
4850 		fallthrough;
4851 	case NVME_AER_SMART:
4852 	case NVME_AER_CSS:
4853 	case NVME_AER_VS:
4854 		ctrl->aen_result = result;
4855 		break;
4856 	default:
4857 		break;
4858 	}
4859 
4860 	if (requeue)
4861 		queue_work(nvme_wq, &ctrl->async_event_work);
4862 }
4863 EXPORT_SYMBOL_GPL(nvme_complete_async_event);
4864 
nvme_alloc_admin_tag_set(struct nvme_ctrl * ctrl,struct blk_mq_tag_set * set,const struct blk_mq_ops * ops,unsigned int cmd_size)4865 int nvme_alloc_admin_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set,
4866 		const struct blk_mq_ops *ops, unsigned int cmd_size)
4867 {
4868 	int ret;
4869 
4870 	memset(set, 0, sizeof(*set));
4871 	set->ops = ops;
4872 	set->queue_depth = NVME_AQ_MQ_TAG_DEPTH;
4873 	if (ctrl->ops->flags & NVME_F_FABRICS)
4874 		/* Reserved for fabric connect and keep alive */
4875 		set->reserved_tags = 2;
4876 	set->numa_node = ctrl->numa_node;
4877 	if (ctrl->ops->flags & NVME_F_BLOCKING)
4878 		set->flags |= BLK_MQ_F_BLOCKING;
4879 	set->cmd_size = cmd_size;
4880 	set->driver_data = ctrl;
4881 	set->nr_hw_queues = 1;
4882 	set->timeout = NVME_ADMIN_TIMEOUT;
4883 	ret = blk_mq_alloc_tag_set(set);
4884 	if (ret)
4885 		return ret;
4886 
4887 	/*
4888 	 * If a previous admin queue exists (e.g., from before a reset),
4889 	 * put it now before allocating a new one to avoid orphaning it.
4890 	 */
4891 	if (ctrl->admin_q)
4892 		blk_put_queue(ctrl->admin_q);
4893 
4894 	ctrl->admin_q = blk_mq_alloc_queue(set, NULL, NULL);
4895 	if (IS_ERR(ctrl->admin_q)) {
4896 		ret = PTR_ERR(ctrl->admin_q);
4897 		goto out_free_tagset;
4898 	}
4899 
4900 	if (ctrl->ops->flags & NVME_F_FABRICS) {
4901 		ctrl->fabrics_q = blk_mq_alloc_queue(set, NULL, NULL);
4902 		if (IS_ERR(ctrl->fabrics_q)) {
4903 			ret = PTR_ERR(ctrl->fabrics_q);
4904 			goto out_cleanup_admin_q;
4905 		}
4906 	}
4907 
4908 	ctrl->admin_tagset = set;
4909 	return 0;
4910 
4911 out_cleanup_admin_q:
4912 	blk_mq_destroy_queue(ctrl->admin_q);
4913 	blk_put_queue(ctrl->admin_q);
4914 out_free_tagset:
4915 	blk_mq_free_tag_set(set);
4916 	ctrl->admin_q = NULL;
4917 	ctrl->fabrics_q = NULL;
4918 	return ret;
4919 }
4920 EXPORT_SYMBOL_GPL(nvme_alloc_admin_tag_set);
4921 
nvme_remove_admin_tag_set(struct nvme_ctrl * ctrl)4922 void nvme_remove_admin_tag_set(struct nvme_ctrl *ctrl)
4923 {
4924 	/*
4925 	 * As we're about to destroy the queue and free tagset
4926 	 * we can not have keep-alive work running.
4927 	 */
4928 	nvme_stop_keep_alive(ctrl);
4929 	blk_mq_destroy_queue(ctrl->admin_q);
4930 	if (ctrl->ops->flags & NVME_F_FABRICS) {
4931 		blk_mq_destroy_queue(ctrl->fabrics_q);
4932 		blk_put_queue(ctrl->fabrics_q);
4933 	}
4934 	blk_mq_free_tag_set(ctrl->admin_tagset);
4935 }
4936 EXPORT_SYMBOL_GPL(nvme_remove_admin_tag_set);
4937 
nvme_alloc_io_tag_set(struct nvme_ctrl * ctrl,struct blk_mq_tag_set * set,const struct blk_mq_ops * ops,unsigned int nr_maps,unsigned int cmd_size)4938 int nvme_alloc_io_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set,
4939 		const struct blk_mq_ops *ops, unsigned int nr_maps,
4940 		unsigned int cmd_size)
4941 {
4942 	int ret;
4943 
4944 	memset(set, 0, sizeof(*set));
4945 	set->ops = ops;
4946 	set->queue_depth = min_t(unsigned, ctrl->sqsize, BLK_MQ_MAX_DEPTH - 1);
4947 	/*
4948 	 * Some Apple controllers requires tags to be unique across admin and
4949 	 * the (only) I/O queue, so reserve the first 32 tags of the I/O queue.
4950 	 */
4951 	if (ctrl->quirks & NVME_QUIRK_SHARED_TAGS)
4952 		set->reserved_tags = NVME_AQ_DEPTH;
4953 	else if (ctrl->ops->flags & NVME_F_FABRICS)
4954 		/* Reserved for fabric connect */
4955 		set->reserved_tags = 1;
4956 	set->numa_node = ctrl->numa_node;
4957 	if (ctrl->ops->flags & NVME_F_BLOCKING)
4958 		set->flags |= BLK_MQ_F_BLOCKING;
4959 	set->cmd_size = cmd_size;
4960 	set->driver_data = ctrl;
4961 	set->nr_hw_queues = ctrl->queue_count - 1;
4962 	set->timeout = NVME_IO_TIMEOUT;
4963 	set->nr_maps = nr_maps;
4964 	ret = blk_mq_alloc_tag_set(set);
4965 	if (ret)
4966 		return ret;
4967 
4968 	if (ctrl->ops->flags & NVME_F_FABRICS) {
4969 		struct queue_limits lim = {
4970 			.features	= BLK_FEAT_SKIP_TAGSET_QUIESCE,
4971 		};
4972 
4973 		ctrl->connect_q = blk_mq_alloc_queue(set, &lim, NULL);
4974         	if (IS_ERR(ctrl->connect_q)) {
4975 			ret = PTR_ERR(ctrl->connect_q);
4976 			goto out_free_tag_set;
4977 		}
4978 	}
4979 
4980 	ctrl->tagset = set;
4981 	return 0;
4982 
4983 out_free_tag_set:
4984 	blk_mq_free_tag_set(set);
4985 	ctrl->connect_q = NULL;
4986 	return ret;
4987 }
4988 EXPORT_SYMBOL_GPL(nvme_alloc_io_tag_set);
4989 
nvme_remove_io_tag_set(struct nvme_ctrl * ctrl)4990 void nvme_remove_io_tag_set(struct nvme_ctrl *ctrl)
4991 {
4992 	if (ctrl->ops->flags & NVME_F_FABRICS) {
4993 		blk_mq_destroy_queue(ctrl->connect_q);
4994 		blk_put_queue(ctrl->connect_q);
4995 	}
4996 	blk_mq_free_tag_set(ctrl->tagset);
4997 }
4998 EXPORT_SYMBOL_GPL(nvme_remove_io_tag_set);
4999 
nvme_stop_ctrl(struct nvme_ctrl * ctrl)5000 void nvme_stop_ctrl(struct nvme_ctrl *ctrl)
5001 {
5002 	nvme_mpath_stop(ctrl);
5003 	nvme_auth_stop(ctrl);
5004 	nvme_stop_failfast_work(ctrl);
5005 	flush_work(&ctrl->async_event_work);
5006 	cancel_work_sync(&ctrl->fw_act_work);
5007 	if (ctrl->ops->stop_ctrl)
5008 		ctrl->ops->stop_ctrl(ctrl);
5009 }
5010 EXPORT_SYMBOL_GPL(nvme_stop_ctrl);
5011 
nvme_start_ctrl(struct nvme_ctrl * ctrl)5012 void nvme_start_ctrl(struct nvme_ctrl *ctrl)
5013 {
5014 	nvme_enable_aen(ctrl);
5015 
5016 	/*
5017 	 * persistent discovery controllers need to send indication to userspace
5018 	 * to re-read the discovery log page to learn about possible changes
5019 	 * that were missed. We identify persistent discovery controllers by
5020 	 * checking that they started once before, hence are reconnecting back.
5021 	 */
5022 	if (test_bit(NVME_CTRL_STARTED_ONCE, &ctrl->flags) &&
5023 	    nvme_discovery_ctrl(ctrl)) {
5024 		if (!ctrl->kato) {
5025 			nvme_stop_keep_alive(ctrl);
5026 			ctrl->kato = NVME_DEFAULT_KATO;
5027 			nvme_start_keep_alive(ctrl);
5028 		}
5029 		nvme_change_uevent(ctrl, "NVME_EVENT=rediscover");
5030 	}
5031 
5032 	if (ctrl->queue_count > 1) {
5033 		nvme_queue_scan(ctrl);
5034 		nvme_unquiesce_io_queues(ctrl);
5035 		nvme_mpath_update(ctrl);
5036 	}
5037 
5038 	nvme_change_uevent(ctrl, "NVME_EVENT=connected");
5039 	set_bit(NVME_CTRL_STARTED_ONCE, &ctrl->flags);
5040 }
5041 EXPORT_SYMBOL_GPL(nvme_start_ctrl);
5042 
nvme_uninit_ctrl(struct nvme_ctrl * ctrl)5043 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl)
5044 {
5045 	nvme_stop_keep_alive(ctrl);
5046 	nvme_hwmon_exit(ctrl);
5047 	nvme_fault_inject_fini(&ctrl->fault_inject);
5048 	dev_pm_qos_hide_latency_tolerance(ctrl->device);
5049 	cdev_device_del(&ctrl->cdev, ctrl->device);
5050 	nvme_put_ctrl(ctrl);
5051 }
5052 EXPORT_SYMBOL_GPL(nvme_uninit_ctrl);
5053 
nvme_free_cels(struct nvme_ctrl * ctrl)5054 static void nvme_free_cels(struct nvme_ctrl *ctrl)
5055 {
5056 	struct nvme_effects_log	*cel;
5057 	unsigned long i;
5058 
5059 	xa_for_each(&ctrl->cels, i, cel) {
5060 		xa_erase(&ctrl->cels, i);
5061 		kfree(cel);
5062 	}
5063 
5064 	xa_destroy(&ctrl->cels);
5065 }
5066 
nvme_free_ctrl(struct device * dev)5067 static void nvme_free_ctrl(struct device *dev)
5068 {
5069 	struct nvme_ctrl *ctrl =
5070 		container_of(dev, struct nvme_ctrl, ctrl_device);
5071 	struct nvme_subsystem *subsys = ctrl->subsys;
5072 
5073 	if (ctrl->admin_q)
5074 		blk_put_queue(ctrl->admin_q);
5075 	if (!subsys || ctrl->instance != subsys->instance)
5076 		ida_free(&nvme_instance_ida, ctrl->instance);
5077 	nvme_free_cels(ctrl);
5078 	nvme_mpath_uninit(ctrl);
5079 	cleanup_srcu_struct(&ctrl->srcu);
5080 	nvme_auth_stop(ctrl);
5081 	nvme_auth_free(ctrl);
5082 	__free_page(ctrl->discard_page);
5083 	free_opal_dev(ctrl->opal_dev);
5084 
5085 	if (subsys) {
5086 		mutex_lock(&nvme_subsystems_lock);
5087 		list_del(&ctrl->subsys_entry);
5088 		sysfs_remove_link(&subsys->dev.kobj, dev_name(ctrl->device));
5089 		mutex_unlock(&nvme_subsystems_lock);
5090 	}
5091 
5092 	ctrl->ops->free_ctrl(ctrl);
5093 
5094 	if (subsys)
5095 		nvme_put_subsystem(subsys);
5096 }
5097 
5098 /*
5099  * Initialize a NVMe controller structures.  This needs to be called during
5100  * earliest initialization so that we have the initialized structured around
5101  * during probing.
5102  *
5103  * On success, the caller must use the nvme_put_ctrl() to release this when
5104  * needed, which also invokes the ops->free_ctrl() callback.
5105  */
nvme_init_ctrl(struct nvme_ctrl * ctrl,struct device * dev,const struct nvme_ctrl_ops * ops,unsigned long quirks)5106 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
5107 		const struct nvme_ctrl_ops *ops, unsigned long quirks)
5108 {
5109 	int ret;
5110 
5111 	WRITE_ONCE(ctrl->state, NVME_CTRL_NEW);
5112 	ctrl->passthru_err_log_enabled = false;
5113 	clear_bit(NVME_CTRL_FAILFAST_EXPIRED, &ctrl->flags);
5114 	spin_lock_init(&ctrl->lock);
5115 	mutex_init(&ctrl->namespaces_lock);
5116 
5117 	ret = init_srcu_struct(&ctrl->srcu);
5118 	if (ret)
5119 		return ret;
5120 
5121 	mutex_init(&ctrl->scan_lock);
5122 	INIT_LIST_HEAD(&ctrl->namespaces);
5123 	xa_init(&ctrl->cels);
5124 	ctrl->dev = dev;
5125 	ctrl->ops = ops;
5126 	ctrl->quirks = quirks;
5127 	ctrl->numa_node = NUMA_NO_NODE;
5128 	INIT_WORK(&ctrl->scan_work, nvme_scan_work);
5129 	INIT_WORK(&ctrl->async_event_work, nvme_async_event_work);
5130 	INIT_WORK(&ctrl->fw_act_work, nvme_fw_act_work);
5131 	INIT_WORK(&ctrl->delete_work, nvme_delete_ctrl_work);
5132 	init_waitqueue_head(&ctrl->state_wq);
5133 
5134 	INIT_DELAYED_WORK(&ctrl->ka_work, nvme_keep_alive_work);
5135 	INIT_DELAYED_WORK(&ctrl->failfast_work, nvme_failfast_work);
5136 	memset(&ctrl->ka_cmd, 0, sizeof(ctrl->ka_cmd));
5137 	ctrl->ka_cmd.common.opcode = nvme_admin_keep_alive;
5138 	ctrl->ka_last_check_time = jiffies;
5139 
5140 	BUILD_BUG_ON(NVME_DSM_MAX_RANGES * sizeof(struct nvme_dsm_range) >
5141 			PAGE_SIZE);
5142 	ctrl->discard_page = alloc_page(GFP_KERNEL);
5143 	if (!ctrl->discard_page) {
5144 		ret = -ENOMEM;
5145 		goto out;
5146 	}
5147 
5148 	ret = ida_alloc(&nvme_instance_ida, GFP_KERNEL);
5149 	if (ret < 0)
5150 		goto out;
5151 	ctrl->instance = ret;
5152 
5153 	ret = nvme_auth_init_ctrl(ctrl);
5154 	if (ret)
5155 		goto out_release_instance;
5156 
5157 	nvme_mpath_init_ctrl(ctrl);
5158 
5159 	device_initialize(&ctrl->ctrl_device);
5160 	ctrl->device = &ctrl->ctrl_device;
5161 	ctrl->device->devt = MKDEV(MAJOR(nvme_ctrl_base_chr_devt),
5162 			ctrl->instance);
5163 	ctrl->device->class = &nvme_class;
5164 	ctrl->device->parent = ctrl->dev;
5165 	if (ops->dev_attr_groups)
5166 		ctrl->device->groups = ops->dev_attr_groups;
5167 	else
5168 		ctrl->device->groups = nvme_dev_attr_groups;
5169 	ctrl->device->release = nvme_free_ctrl;
5170 	dev_set_drvdata(ctrl->device, ctrl);
5171 
5172 	return ret;
5173 
5174 out_release_instance:
5175 	ida_free(&nvme_instance_ida, ctrl->instance);
5176 out:
5177 	if (ctrl->discard_page)
5178 		__free_page(ctrl->discard_page);
5179 	cleanup_srcu_struct(&ctrl->srcu);
5180 	return ret;
5181 }
5182 EXPORT_SYMBOL_GPL(nvme_init_ctrl);
5183 
5184 /*
5185  * On success, returns with an elevated controller reference and caller must
5186  * use nvme_uninit_ctrl() to properly free resources associated with the ctrl.
5187  */
nvme_add_ctrl(struct nvme_ctrl * ctrl)5188 int nvme_add_ctrl(struct nvme_ctrl *ctrl)
5189 {
5190 	int ret;
5191 
5192 	ret = dev_set_name(ctrl->device, "nvme%d", ctrl->instance);
5193 	if (ret)
5194 		return ret;
5195 
5196 	cdev_init(&ctrl->cdev, &nvme_dev_fops);
5197 	ctrl->cdev.owner = ctrl->ops->module;
5198 	ret = cdev_device_add(&ctrl->cdev, ctrl->device);
5199 	if (ret)
5200 		return ret;
5201 
5202 	/*
5203 	 * Initialize latency tolerance controls.  The sysfs files won't
5204 	 * be visible to userspace unless the device actually supports APST.
5205 	 */
5206 	ctrl->device->power.set_latency_tolerance = nvme_set_latency_tolerance;
5207 	dev_pm_qos_update_user_latency_tolerance(ctrl->device,
5208 		min(default_ps_max_latency_us, (unsigned long)S32_MAX));
5209 
5210 	nvme_fault_inject_init(&ctrl->fault_inject, dev_name(ctrl->device));
5211 	nvme_get_ctrl(ctrl);
5212 
5213 	return 0;
5214 }
5215 EXPORT_SYMBOL_GPL(nvme_add_ctrl);
5216 
5217 /* let I/O to all namespaces fail in preparation for surprise removal */
nvme_mark_namespaces_dead(struct nvme_ctrl * ctrl)5218 void nvme_mark_namespaces_dead(struct nvme_ctrl *ctrl)
5219 {
5220 	struct nvme_ns *ns;
5221 	int srcu_idx;
5222 
5223 	srcu_idx = srcu_read_lock(&ctrl->srcu);
5224 	list_for_each_entry_srcu(ns, &ctrl->namespaces, list,
5225 				 srcu_read_lock_held(&ctrl->srcu))
5226 		blk_mark_disk_dead(ns->disk);
5227 	srcu_read_unlock(&ctrl->srcu, srcu_idx);
5228 }
5229 EXPORT_SYMBOL_GPL(nvme_mark_namespaces_dead);
5230 
nvme_unfreeze(struct nvme_ctrl * ctrl)5231 void nvme_unfreeze(struct nvme_ctrl *ctrl)
5232 {
5233 	struct nvme_ns *ns;
5234 	int srcu_idx;
5235 
5236 	srcu_idx = srcu_read_lock(&ctrl->srcu);
5237 	list_for_each_entry_srcu(ns, &ctrl->namespaces, list,
5238 				 srcu_read_lock_held(&ctrl->srcu))
5239 		blk_mq_unfreeze_queue_non_owner(ns->queue);
5240 	srcu_read_unlock(&ctrl->srcu, srcu_idx);
5241 	clear_bit(NVME_CTRL_FROZEN, &ctrl->flags);
5242 }
5243 EXPORT_SYMBOL_GPL(nvme_unfreeze);
5244 
nvme_wait_freeze_timeout(struct nvme_ctrl * ctrl,long timeout)5245 int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout)
5246 {
5247 	struct nvme_ns *ns;
5248 	int srcu_idx;
5249 
5250 	srcu_idx = srcu_read_lock(&ctrl->srcu);
5251 	list_for_each_entry_srcu(ns, &ctrl->namespaces, list,
5252 				 srcu_read_lock_held(&ctrl->srcu)) {
5253 		timeout = blk_mq_freeze_queue_wait_timeout(ns->queue, timeout);
5254 		if (timeout <= 0)
5255 			break;
5256 	}
5257 	srcu_read_unlock(&ctrl->srcu, srcu_idx);
5258 	return timeout;
5259 }
5260 EXPORT_SYMBOL_GPL(nvme_wait_freeze_timeout);
5261 
nvme_wait_freeze(struct nvme_ctrl * ctrl)5262 void nvme_wait_freeze(struct nvme_ctrl *ctrl)
5263 {
5264 	struct nvme_ns *ns;
5265 	int srcu_idx;
5266 
5267 	srcu_idx = srcu_read_lock(&ctrl->srcu);
5268 	list_for_each_entry_srcu(ns, &ctrl->namespaces, list,
5269 				 srcu_read_lock_held(&ctrl->srcu))
5270 		blk_mq_freeze_queue_wait(ns->queue);
5271 	srcu_read_unlock(&ctrl->srcu, srcu_idx);
5272 }
5273 EXPORT_SYMBOL_GPL(nvme_wait_freeze);
5274 
nvme_start_freeze(struct nvme_ctrl * ctrl)5275 void nvme_start_freeze(struct nvme_ctrl *ctrl)
5276 {
5277 	struct nvme_ns *ns;
5278 	int srcu_idx;
5279 
5280 	set_bit(NVME_CTRL_FROZEN, &ctrl->flags);
5281 	srcu_idx = srcu_read_lock(&ctrl->srcu);
5282 	list_for_each_entry_srcu(ns, &ctrl->namespaces, list,
5283 				 srcu_read_lock_held(&ctrl->srcu))
5284 		/*
5285 		 * Typical non_owner use case is from pci driver, in which
5286 		 * start_freeze is called from timeout work function, but
5287 		 * unfreeze is done in reset work context
5288 		 */
5289 		blk_freeze_queue_start_non_owner(ns->queue);
5290 	srcu_read_unlock(&ctrl->srcu, srcu_idx);
5291 }
5292 EXPORT_SYMBOL_GPL(nvme_start_freeze);
5293 
nvme_quiesce_io_queues(struct nvme_ctrl * ctrl)5294 void nvme_quiesce_io_queues(struct nvme_ctrl *ctrl)
5295 {
5296 	if (!ctrl->tagset)
5297 		return;
5298 	if (!test_and_set_bit(NVME_CTRL_STOPPED, &ctrl->flags))
5299 		blk_mq_quiesce_tagset(ctrl->tagset);
5300 	else
5301 		blk_mq_wait_quiesce_done(ctrl->tagset);
5302 }
5303 EXPORT_SYMBOL_GPL(nvme_quiesce_io_queues);
5304 
nvme_unquiesce_io_queues(struct nvme_ctrl * ctrl)5305 void nvme_unquiesce_io_queues(struct nvme_ctrl *ctrl)
5306 {
5307 	if (!ctrl->tagset)
5308 		return;
5309 	if (test_and_clear_bit(NVME_CTRL_STOPPED, &ctrl->flags))
5310 		blk_mq_unquiesce_tagset(ctrl->tagset);
5311 }
5312 EXPORT_SYMBOL_GPL(nvme_unquiesce_io_queues);
5313 
nvme_quiesce_admin_queue(struct nvme_ctrl * ctrl)5314 void nvme_quiesce_admin_queue(struct nvme_ctrl *ctrl)
5315 {
5316 	if (!test_and_set_bit(NVME_CTRL_ADMIN_Q_STOPPED, &ctrl->flags))
5317 		blk_mq_quiesce_queue(ctrl->admin_q);
5318 	else
5319 		blk_mq_wait_quiesce_done(ctrl->admin_q->tag_set);
5320 }
5321 EXPORT_SYMBOL_GPL(nvme_quiesce_admin_queue);
5322 
nvme_unquiesce_admin_queue(struct nvme_ctrl * ctrl)5323 void nvme_unquiesce_admin_queue(struct nvme_ctrl *ctrl)
5324 {
5325 	if (test_and_clear_bit(NVME_CTRL_ADMIN_Q_STOPPED, &ctrl->flags))
5326 		blk_mq_unquiesce_queue(ctrl->admin_q);
5327 }
5328 EXPORT_SYMBOL_GPL(nvme_unquiesce_admin_queue);
5329 
nvme_sync_io_queues(struct nvme_ctrl * ctrl)5330 void nvme_sync_io_queues(struct nvme_ctrl *ctrl)
5331 {
5332 	struct nvme_ns *ns;
5333 	int srcu_idx;
5334 
5335 	srcu_idx = srcu_read_lock(&ctrl->srcu);
5336 	list_for_each_entry_srcu(ns, &ctrl->namespaces, list,
5337 				 srcu_read_lock_held(&ctrl->srcu))
5338 		blk_sync_queue(ns->queue);
5339 	srcu_read_unlock(&ctrl->srcu, srcu_idx);
5340 }
5341 EXPORT_SYMBOL_GPL(nvme_sync_io_queues);
5342 
nvme_sync_queues(struct nvme_ctrl * ctrl)5343 void nvme_sync_queues(struct nvme_ctrl *ctrl)
5344 {
5345 	nvme_sync_io_queues(ctrl);
5346 	if (ctrl->admin_q)
5347 		blk_sync_queue(ctrl->admin_q);
5348 }
5349 EXPORT_SYMBOL_GPL(nvme_sync_queues);
5350 
nvme_ctrl_from_file(struct file * file)5351 struct nvme_ctrl *nvme_ctrl_from_file(struct file *file)
5352 {
5353 	if (file->f_op != &nvme_dev_fops)
5354 		return NULL;
5355 	return file->private_data;
5356 }
5357 EXPORT_SYMBOL_NS_GPL(nvme_ctrl_from_file, "NVME_TARGET_PASSTHRU");
5358 
5359 /*
5360  * Check we didn't inadvertently grow the command structure sizes:
5361  */
_nvme_check_size(void)5362 static inline void _nvme_check_size(void)
5363 {
5364 	BUILD_BUG_ON(sizeof(struct nvme_common_command) != 64);
5365 	BUILD_BUG_ON(sizeof(struct nvme_rw_command) != 64);
5366 	BUILD_BUG_ON(sizeof(struct nvme_identify) != 64);
5367 	BUILD_BUG_ON(sizeof(struct nvme_features) != 64);
5368 	BUILD_BUG_ON(sizeof(struct nvme_download_firmware) != 64);
5369 	BUILD_BUG_ON(sizeof(struct nvme_format_cmd) != 64);
5370 	BUILD_BUG_ON(sizeof(struct nvme_dsm_cmd) != 64);
5371 	BUILD_BUG_ON(sizeof(struct nvme_write_zeroes_cmd) != 64);
5372 	BUILD_BUG_ON(sizeof(struct nvme_abort_cmd) != 64);
5373 	BUILD_BUG_ON(sizeof(struct nvme_get_log_page_command) != 64);
5374 	BUILD_BUG_ON(sizeof(struct nvme_command) != 64);
5375 	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl) != NVME_IDENTIFY_DATA_SIZE);
5376 	BUILD_BUG_ON(sizeof(struct nvme_id_ns) != NVME_IDENTIFY_DATA_SIZE);
5377 	BUILD_BUG_ON(sizeof(struct nvme_id_ns_cs_indep) !=
5378 			NVME_IDENTIFY_DATA_SIZE);
5379 	BUILD_BUG_ON(sizeof(struct nvme_id_ns_zns) != NVME_IDENTIFY_DATA_SIZE);
5380 	BUILD_BUG_ON(sizeof(struct nvme_id_ns_nvm) != NVME_IDENTIFY_DATA_SIZE);
5381 	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl_zns) != NVME_IDENTIFY_DATA_SIZE);
5382 	BUILD_BUG_ON(sizeof(struct nvme_id_ctrl_nvm) != NVME_IDENTIFY_DATA_SIZE);
5383 	BUILD_BUG_ON(sizeof(struct nvme_lba_range_type) != 64);
5384 	BUILD_BUG_ON(sizeof(struct nvme_smart_log) != 512);
5385 	BUILD_BUG_ON(sizeof(struct nvme_endurance_group_log) != 512);
5386 	BUILD_BUG_ON(sizeof(struct nvme_rotational_media_log) != 512);
5387 	BUILD_BUG_ON(sizeof(struct nvme_dbbuf) != 64);
5388 	BUILD_BUG_ON(sizeof(struct nvme_directive_cmd) != 64);
5389 	BUILD_BUG_ON(sizeof(struct nvme_feat_host_behavior) != 512);
5390 }
5391 
5392 
nvme_core_init(void)5393 static int __init nvme_core_init(void)
5394 {
5395 	unsigned int wq_flags = WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS;
5396 	int result = -ENOMEM;
5397 
5398 	_nvme_check_size();
5399 
5400 	nvme_wq = alloc_workqueue("nvme-wq", wq_flags, 0);
5401 	if (!nvme_wq)
5402 		goto out;
5403 
5404 	nvme_reset_wq = alloc_workqueue("nvme-reset-wq", wq_flags, 0);
5405 	if (!nvme_reset_wq)
5406 		goto destroy_wq;
5407 
5408 	nvme_delete_wq = alloc_workqueue("nvme-delete-wq", wq_flags, 0);
5409 	if (!nvme_delete_wq)
5410 		goto destroy_reset_wq;
5411 
5412 	result = alloc_chrdev_region(&nvme_ctrl_base_chr_devt, 0,
5413 			NVME_MINORS, "nvme");
5414 	if (result < 0)
5415 		goto destroy_delete_wq;
5416 
5417 	result = class_register(&nvme_class);
5418 	if (result)
5419 		goto unregister_chrdev;
5420 
5421 	result = class_register(&nvme_subsys_class);
5422 	if (result)
5423 		goto destroy_class;
5424 
5425 	result = alloc_chrdev_region(&nvme_ns_chr_devt, 0, NVME_MINORS,
5426 				     "nvme-generic");
5427 	if (result < 0)
5428 		goto destroy_subsys_class;
5429 
5430 	result = class_register(&nvme_ns_chr_class);
5431 	if (result)
5432 		goto unregister_generic_ns;
5433 
5434 	result = nvme_init_auth();
5435 	if (result)
5436 		goto destroy_ns_chr;
5437 	return 0;
5438 
5439 destroy_ns_chr:
5440 	class_unregister(&nvme_ns_chr_class);
5441 unregister_generic_ns:
5442 	unregister_chrdev_region(nvme_ns_chr_devt, NVME_MINORS);
5443 destroy_subsys_class:
5444 	class_unregister(&nvme_subsys_class);
5445 destroy_class:
5446 	class_unregister(&nvme_class);
5447 unregister_chrdev:
5448 	unregister_chrdev_region(nvme_ctrl_base_chr_devt, NVME_MINORS);
5449 destroy_delete_wq:
5450 	destroy_workqueue(nvme_delete_wq);
5451 destroy_reset_wq:
5452 	destroy_workqueue(nvme_reset_wq);
5453 destroy_wq:
5454 	destroy_workqueue(nvme_wq);
5455 out:
5456 	return result;
5457 }
5458 
nvme_core_exit(void)5459 static void __exit nvme_core_exit(void)
5460 {
5461 	nvme_exit_auth();
5462 	class_unregister(&nvme_ns_chr_class);
5463 	class_unregister(&nvme_subsys_class);
5464 	class_unregister(&nvme_class);
5465 	unregister_chrdev_region(nvme_ns_chr_devt, NVME_MINORS);
5466 	unregister_chrdev_region(nvme_ctrl_base_chr_devt, NVME_MINORS);
5467 	destroy_workqueue(nvme_delete_wq);
5468 	destroy_workqueue(nvme_reset_wq);
5469 	destroy_workqueue(nvme_wq);
5470 	ida_destroy(&nvme_ns_chr_minor_ida);
5471 	ida_destroy(&nvme_instance_ida);
5472 }
5473 
5474 MODULE_LICENSE("GPL");
5475 MODULE_VERSION("1.0");
5476 MODULE_DESCRIPTION("NVMe host core framework");
5477 module_init(nvme_core_init);
5478 module_exit(nvme_core_exit);
5479