xref: /openbmc/linux/drivers/nvme/target/core.c (revision 3b73c45e)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Common code for the NVMe target.
4  * Copyright (c) 2015-2016 HGST, a Western Digital Company.
5  */
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
7 #include <linux/module.h>
8 #include <linux/random.h>
9 #include <linux/rculist.h>
10 #include <linux/pci-p2pdma.h>
11 #include <linux/scatterlist.h>
12 
13 #define CREATE_TRACE_POINTS
14 #include "trace.h"
15 
16 #include "nvmet.h"
17 
18 struct workqueue_struct *buffered_io_wq;
19 struct workqueue_struct *zbd_wq;
20 static const struct nvmet_fabrics_ops *nvmet_transports[NVMF_TRTYPE_MAX];
21 static DEFINE_IDA(cntlid_ida);
22 
23 struct workqueue_struct *nvmet_wq;
24 EXPORT_SYMBOL_GPL(nvmet_wq);
25 
26 /*
27  * This read/write semaphore is used to synchronize access to configuration
28  * information on a target system that will result in discovery log page
29  * information change for at least one host.
30  * The full list of resources to protected by this semaphore is:
31  *
32  *  - subsystems list
33  *  - per-subsystem allowed hosts list
34  *  - allow_any_host subsystem attribute
35  *  - nvmet_genctr
36  *  - the nvmet_transports array
37  *
38  * When updating any of those lists/structures write lock should be obtained,
39  * while when reading (popolating discovery log page or checking host-subsystem
40  * link) read lock is obtained to allow concurrent reads.
41  */
42 DECLARE_RWSEM(nvmet_config_sem);
43 
44 u32 nvmet_ana_group_enabled[NVMET_MAX_ANAGRPS + 1];
45 u64 nvmet_ana_chgcnt;
46 DECLARE_RWSEM(nvmet_ana_sem);
47 
48 inline u16 errno_to_nvme_status(struct nvmet_req *req, int errno)
49 {
50 	switch (errno) {
51 	case 0:
52 		return NVME_SC_SUCCESS;
53 	case -ENOSPC:
54 		req->error_loc = offsetof(struct nvme_rw_command, length);
55 		return NVME_SC_CAP_EXCEEDED | NVME_SC_DNR;
56 	case -EREMOTEIO:
57 		req->error_loc = offsetof(struct nvme_rw_command, slba);
58 		return  NVME_SC_LBA_RANGE | NVME_SC_DNR;
59 	case -EOPNOTSUPP:
60 		req->error_loc = offsetof(struct nvme_common_command, opcode);
61 		switch (req->cmd->common.opcode) {
62 		case nvme_cmd_dsm:
63 		case nvme_cmd_write_zeroes:
64 			return NVME_SC_ONCS_NOT_SUPPORTED | NVME_SC_DNR;
65 		default:
66 			return NVME_SC_INVALID_OPCODE | NVME_SC_DNR;
67 		}
68 		break;
69 	case -ENODATA:
70 		req->error_loc = offsetof(struct nvme_rw_command, nsid);
71 		return NVME_SC_ACCESS_DENIED;
72 	case -EIO:
73 		fallthrough;
74 	default:
75 		req->error_loc = offsetof(struct nvme_common_command, opcode);
76 		return NVME_SC_INTERNAL | NVME_SC_DNR;
77 	}
78 }
79 
80 u16 nvmet_report_invalid_opcode(struct nvmet_req *req)
81 {
82 	pr_debug("unhandled cmd %d on qid %d\n", req->cmd->common.opcode,
83 		 req->sq->qid);
84 
85 	req->error_loc = offsetof(struct nvme_common_command, opcode);
86 	return NVME_SC_INVALID_OPCODE | NVME_SC_DNR;
87 }
88 
89 static struct nvmet_subsys *nvmet_find_get_subsys(struct nvmet_port *port,
90 		const char *subsysnqn);
91 
92 u16 nvmet_copy_to_sgl(struct nvmet_req *req, off_t off, const void *buf,
93 		size_t len)
94 {
95 	if (sg_pcopy_from_buffer(req->sg, req->sg_cnt, buf, len, off) != len) {
96 		req->error_loc = offsetof(struct nvme_common_command, dptr);
97 		return NVME_SC_SGL_INVALID_DATA | NVME_SC_DNR;
98 	}
99 	return 0;
100 }
101 
102 u16 nvmet_copy_from_sgl(struct nvmet_req *req, off_t off, void *buf, size_t len)
103 {
104 	if (sg_pcopy_to_buffer(req->sg, req->sg_cnt, buf, len, off) != len) {
105 		req->error_loc = offsetof(struct nvme_common_command, dptr);
106 		return NVME_SC_SGL_INVALID_DATA | NVME_SC_DNR;
107 	}
108 	return 0;
109 }
110 
111 u16 nvmet_zero_sgl(struct nvmet_req *req, off_t off, size_t len)
112 {
113 	if (sg_zero_buffer(req->sg, req->sg_cnt, len, off) != len) {
114 		req->error_loc = offsetof(struct nvme_common_command, dptr);
115 		return NVME_SC_SGL_INVALID_DATA | NVME_SC_DNR;
116 	}
117 	return 0;
118 }
119 
120 static u32 nvmet_max_nsid(struct nvmet_subsys *subsys)
121 {
122 	struct nvmet_ns *cur;
123 	unsigned long idx;
124 	u32 nsid = 0;
125 
126 	xa_for_each(&subsys->namespaces, idx, cur)
127 		nsid = cur->nsid;
128 
129 	return nsid;
130 }
131 
132 static u32 nvmet_async_event_result(struct nvmet_async_event *aen)
133 {
134 	return aen->event_type | (aen->event_info << 8) | (aen->log_page << 16);
135 }
136 
137 static void nvmet_async_events_failall(struct nvmet_ctrl *ctrl)
138 {
139 	struct nvmet_req *req;
140 
141 	mutex_lock(&ctrl->lock);
142 	while (ctrl->nr_async_event_cmds) {
143 		req = ctrl->async_event_cmds[--ctrl->nr_async_event_cmds];
144 		mutex_unlock(&ctrl->lock);
145 		nvmet_req_complete(req, NVME_SC_INTERNAL | NVME_SC_DNR);
146 		mutex_lock(&ctrl->lock);
147 	}
148 	mutex_unlock(&ctrl->lock);
149 }
150 
151 static void nvmet_async_events_process(struct nvmet_ctrl *ctrl)
152 {
153 	struct nvmet_async_event *aen;
154 	struct nvmet_req *req;
155 
156 	mutex_lock(&ctrl->lock);
157 	while (ctrl->nr_async_event_cmds && !list_empty(&ctrl->async_events)) {
158 		aen = list_first_entry(&ctrl->async_events,
159 				       struct nvmet_async_event, entry);
160 		req = ctrl->async_event_cmds[--ctrl->nr_async_event_cmds];
161 		nvmet_set_result(req, nvmet_async_event_result(aen));
162 
163 		list_del(&aen->entry);
164 		kfree(aen);
165 
166 		mutex_unlock(&ctrl->lock);
167 		trace_nvmet_async_event(ctrl, req->cqe->result.u32);
168 		nvmet_req_complete(req, 0);
169 		mutex_lock(&ctrl->lock);
170 	}
171 	mutex_unlock(&ctrl->lock);
172 }
173 
174 static void nvmet_async_events_free(struct nvmet_ctrl *ctrl)
175 {
176 	struct nvmet_async_event *aen, *tmp;
177 
178 	mutex_lock(&ctrl->lock);
179 	list_for_each_entry_safe(aen, tmp, &ctrl->async_events, entry) {
180 		list_del(&aen->entry);
181 		kfree(aen);
182 	}
183 	mutex_unlock(&ctrl->lock);
184 }
185 
186 static void nvmet_async_event_work(struct work_struct *work)
187 {
188 	struct nvmet_ctrl *ctrl =
189 		container_of(work, struct nvmet_ctrl, async_event_work);
190 
191 	nvmet_async_events_process(ctrl);
192 }
193 
194 void nvmet_add_async_event(struct nvmet_ctrl *ctrl, u8 event_type,
195 		u8 event_info, u8 log_page)
196 {
197 	struct nvmet_async_event *aen;
198 
199 	aen = kmalloc(sizeof(*aen), GFP_KERNEL);
200 	if (!aen)
201 		return;
202 
203 	aen->event_type = event_type;
204 	aen->event_info = event_info;
205 	aen->log_page = log_page;
206 
207 	mutex_lock(&ctrl->lock);
208 	list_add_tail(&aen->entry, &ctrl->async_events);
209 	mutex_unlock(&ctrl->lock);
210 
211 	queue_work(nvmet_wq, &ctrl->async_event_work);
212 }
213 
214 static void nvmet_add_to_changed_ns_log(struct nvmet_ctrl *ctrl, __le32 nsid)
215 {
216 	u32 i;
217 
218 	mutex_lock(&ctrl->lock);
219 	if (ctrl->nr_changed_ns > NVME_MAX_CHANGED_NAMESPACES)
220 		goto out_unlock;
221 
222 	for (i = 0; i < ctrl->nr_changed_ns; i++) {
223 		if (ctrl->changed_ns_list[i] == nsid)
224 			goto out_unlock;
225 	}
226 
227 	if (ctrl->nr_changed_ns == NVME_MAX_CHANGED_NAMESPACES) {
228 		ctrl->changed_ns_list[0] = cpu_to_le32(0xffffffff);
229 		ctrl->nr_changed_ns = U32_MAX;
230 		goto out_unlock;
231 	}
232 
233 	ctrl->changed_ns_list[ctrl->nr_changed_ns++] = nsid;
234 out_unlock:
235 	mutex_unlock(&ctrl->lock);
236 }
237 
238 void nvmet_ns_changed(struct nvmet_subsys *subsys, u32 nsid)
239 {
240 	struct nvmet_ctrl *ctrl;
241 
242 	lockdep_assert_held(&subsys->lock);
243 
244 	list_for_each_entry(ctrl, &subsys->ctrls, subsys_entry) {
245 		nvmet_add_to_changed_ns_log(ctrl, cpu_to_le32(nsid));
246 		if (nvmet_aen_bit_disabled(ctrl, NVME_AEN_BIT_NS_ATTR))
247 			continue;
248 		nvmet_add_async_event(ctrl, NVME_AER_TYPE_NOTICE,
249 				NVME_AER_NOTICE_NS_CHANGED,
250 				NVME_LOG_CHANGED_NS);
251 	}
252 }
253 
254 void nvmet_send_ana_event(struct nvmet_subsys *subsys,
255 		struct nvmet_port *port)
256 {
257 	struct nvmet_ctrl *ctrl;
258 
259 	mutex_lock(&subsys->lock);
260 	list_for_each_entry(ctrl, &subsys->ctrls, subsys_entry) {
261 		if (port && ctrl->port != port)
262 			continue;
263 		if (nvmet_aen_bit_disabled(ctrl, NVME_AEN_BIT_ANA_CHANGE))
264 			continue;
265 		nvmet_add_async_event(ctrl, NVME_AER_TYPE_NOTICE,
266 				NVME_AER_NOTICE_ANA, NVME_LOG_ANA);
267 	}
268 	mutex_unlock(&subsys->lock);
269 }
270 
271 void nvmet_port_send_ana_event(struct nvmet_port *port)
272 {
273 	struct nvmet_subsys_link *p;
274 
275 	down_read(&nvmet_config_sem);
276 	list_for_each_entry(p, &port->subsystems, entry)
277 		nvmet_send_ana_event(p->subsys, port);
278 	up_read(&nvmet_config_sem);
279 }
280 
281 int nvmet_register_transport(const struct nvmet_fabrics_ops *ops)
282 {
283 	int ret = 0;
284 
285 	down_write(&nvmet_config_sem);
286 	if (nvmet_transports[ops->type])
287 		ret = -EINVAL;
288 	else
289 		nvmet_transports[ops->type] = ops;
290 	up_write(&nvmet_config_sem);
291 
292 	return ret;
293 }
294 EXPORT_SYMBOL_GPL(nvmet_register_transport);
295 
296 void nvmet_unregister_transport(const struct nvmet_fabrics_ops *ops)
297 {
298 	down_write(&nvmet_config_sem);
299 	nvmet_transports[ops->type] = NULL;
300 	up_write(&nvmet_config_sem);
301 }
302 EXPORT_SYMBOL_GPL(nvmet_unregister_transport);
303 
304 void nvmet_port_del_ctrls(struct nvmet_port *port, struct nvmet_subsys *subsys)
305 {
306 	struct nvmet_ctrl *ctrl;
307 
308 	mutex_lock(&subsys->lock);
309 	list_for_each_entry(ctrl, &subsys->ctrls, subsys_entry) {
310 		if (ctrl->port == port)
311 			ctrl->ops->delete_ctrl(ctrl);
312 	}
313 	mutex_unlock(&subsys->lock);
314 }
315 
316 int nvmet_enable_port(struct nvmet_port *port)
317 {
318 	const struct nvmet_fabrics_ops *ops;
319 	int ret;
320 
321 	lockdep_assert_held(&nvmet_config_sem);
322 
323 	ops = nvmet_transports[port->disc_addr.trtype];
324 	if (!ops) {
325 		up_write(&nvmet_config_sem);
326 		request_module("nvmet-transport-%d", port->disc_addr.trtype);
327 		down_write(&nvmet_config_sem);
328 		ops = nvmet_transports[port->disc_addr.trtype];
329 		if (!ops) {
330 			pr_err("transport type %d not supported\n",
331 				port->disc_addr.trtype);
332 			return -EINVAL;
333 		}
334 	}
335 
336 	if (!try_module_get(ops->owner))
337 		return -EINVAL;
338 
339 	/*
340 	 * If the user requested PI support and the transport isn't pi capable,
341 	 * don't enable the port.
342 	 */
343 	if (port->pi_enable && !(ops->flags & NVMF_METADATA_SUPPORTED)) {
344 		pr_err("T10-PI is not supported by transport type %d\n",
345 		       port->disc_addr.trtype);
346 		ret = -EINVAL;
347 		goto out_put;
348 	}
349 
350 	ret = ops->add_port(port);
351 	if (ret)
352 		goto out_put;
353 
354 	/* If the transport didn't set inline_data_size, then disable it. */
355 	if (port->inline_data_size < 0)
356 		port->inline_data_size = 0;
357 
358 	port->enabled = true;
359 	port->tr_ops = ops;
360 	return 0;
361 
362 out_put:
363 	module_put(ops->owner);
364 	return ret;
365 }
366 
367 void nvmet_disable_port(struct nvmet_port *port)
368 {
369 	const struct nvmet_fabrics_ops *ops;
370 
371 	lockdep_assert_held(&nvmet_config_sem);
372 
373 	port->enabled = false;
374 	port->tr_ops = NULL;
375 
376 	ops = nvmet_transports[port->disc_addr.trtype];
377 	ops->remove_port(port);
378 	module_put(ops->owner);
379 }
380 
381 static void nvmet_keep_alive_timer(struct work_struct *work)
382 {
383 	struct nvmet_ctrl *ctrl = container_of(to_delayed_work(work),
384 			struct nvmet_ctrl, ka_work);
385 	bool reset_tbkas = ctrl->reset_tbkas;
386 
387 	ctrl->reset_tbkas = false;
388 	if (reset_tbkas) {
389 		pr_debug("ctrl %d reschedule traffic based keep-alive timer\n",
390 			ctrl->cntlid);
391 		queue_delayed_work(nvmet_wq, &ctrl->ka_work, ctrl->kato * HZ);
392 		return;
393 	}
394 
395 	pr_err("ctrl %d keep-alive timer (%d seconds) expired!\n",
396 		ctrl->cntlid, ctrl->kato);
397 
398 	nvmet_ctrl_fatal_error(ctrl);
399 }
400 
401 void nvmet_start_keep_alive_timer(struct nvmet_ctrl *ctrl)
402 {
403 	if (unlikely(ctrl->kato == 0))
404 		return;
405 
406 	pr_debug("ctrl %d start keep-alive timer for %d secs\n",
407 		ctrl->cntlid, ctrl->kato);
408 
409 	queue_delayed_work(nvmet_wq, &ctrl->ka_work, ctrl->kato * HZ);
410 }
411 
412 void nvmet_stop_keep_alive_timer(struct nvmet_ctrl *ctrl)
413 {
414 	if (unlikely(ctrl->kato == 0))
415 		return;
416 
417 	pr_debug("ctrl %d stop keep-alive\n", ctrl->cntlid);
418 
419 	cancel_delayed_work_sync(&ctrl->ka_work);
420 }
421 
422 u16 nvmet_req_find_ns(struct nvmet_req *req)
423 {
424 	u32 nsid = le32_to_cpu(req->cmd->common.nsid);
425 
426 	req->ns = xa_load(&nvmet_req_subsys(req)->namespaces, nsid);
427 	if (unlikely(!req->ns)) {
428 		req->error_loc = offsetof(struct nvme_common_command, nsid);
429 		return NVME_SC_INVALID_NS | NVME_SC_DNR;
430 	}
431 
432 	percpu_ref_get(&req->ns->ref);
433 	return NVME_SC_SUCCESS;
434 }
435 
436 static void nvmet_destroy_namespace(struct percpu_ref *ref)
437 {
438 	struct nvmet_ns *ns = container_of(ref, struct nvmet_ns, ref);
439 
440 	complete(&ns->disable_done);
441 }
442 
443 void nvmet_put_namespace(struct nvmet_ns *ns)
444 {
445 	percpu_ref_put(&ns->ref);
446 }
447 
448 static void nvmet_ns_dev_disable(struct nvmet_ns *ns)
449 {
450 	nvmet_bdev_ns_disable(ns);
451 	nvmet_file_ns_disable(ns);
452 }
453 
454 static int nvmet_p2pmem_ns_enable(struct nvmet_ns *ns)
455 {
456 	int ret;
457 	struct pci_dev *p2p_dev;
458 
459 	if (!ns->use_p2pmem)
460 		return 0;
461 
462 	if (!ns->bdev) {
463 		pr_err("peer-to-peer DMA is not supported by non-block device namespaces\n");
464 		return -EINVAL;
465 	}
466 
467 	if (!blk_queue_pci_p2pdma(ns->bdev->bd_disk->queue)) {
468 		pr_err("peer-to-peer DMA is not supported by the driver of %s\n",
469 		       ns->device_path);
470 		return -EINVAL;
471 	}
472 
473 	if (ns->p2p_dev) {
474 		ret = pci_p2pdma_distance(ns->p2p_dev, nvmet_ns_dev(ns), true);
475 		if (ret < 0)
476 			return -EINVAL;
477 	} else {
478 		/*
479 		 * Right now we just check that there is p2pmem available so
480 		 * we can report an error to the user right away if there
481 		 * is not. We'll find the actual device to use once we
482 		 * setup the controller when the port's device is available.
483 		 */
484 
485 		p2p_dev = pci_p2pmem_find(nvmet_ns_dev(ns));
486 		if (!p2p_dev) {
487 			pr_err("no peer-to-peer memory is available for %s\n",
488 			       ns->device_path);
489 			return -EINVAL;
490 		}
491 
492 		pci_dev_put(p2p_dev);
493 	}
494 
495 	return 0;
496 }
497 
498 /*
499  * Note: ctrl->subsys->lock should be held when calling this function
500  */
501 static void nvmet_p2pmem_ns_add_p2p(struct nvmet_ctrl *ctrl,
502 				    struct nvmet_ns *ns)
503 {
504 	struct device *clients[2];
505 	struct pci_dev *p2p_dev;
506 	int ret;
507 
508 	if (!ctrl->p2p_client || !ns->use_p2pmem)
509 		return;
510 
511 	if (ns->p2p_dev) {
512 		ret = pci_p2pdma_distance(ns->p2p_dev, ctrl->p2p_client, true);
513 		if (ret < 0)
514 			return;
515 
516 		p2p_dev = pci_dev_get(ns->p2p_dev);
517 	} else {
518 		clients[0] = ctrl->p2p_client;
519 		clients[1] = nvmet_ns_dev(ns);
520 
521 		p2p_dev = pci_p2pmem_find_many(clients, ARRAY_SIZE(clients));
522 		if (!p2p_dev) {
523 			pr_err("no peer-to-peer memory is available that's supported by %s and %s\n",
524 			       dev_name(ctrl->p2p_client), ns->device_path);
525 			return;
526 		}
527 	}
528 
529 	ret = radix_tree_insert(&ctrl->p2p_ns_map, ns->nsid, p2p_dev);
530 	if (ret < 0)
531 		pci_dev_put(p2p_dev);
532 
533 	pr_info("using p2pmem on %s for nsid %d\n", pci_name(p2p_dev),
534 		ns->nsid);
535 }
536 
537 bool nvmet_ns_revalidate(struct nvmet_ns *ns)
538 {
539 	loff_t oldsize = ns->size;
540 
541 	if (ns->bdev)
542 		nvmet_bdev_ns_revalidate(ns);
543 	else
544 		nvmet_file_ns_revalidate(ns);
545 
546 	return oldsize != ns->size;
547 }
548 
549 int nvmet_ns_enable(struct nvmet_ns *ns)
550 {
551 	struct nvmet_subsys *subsys = ns->subsys;
552 	struct nvmet_ctrl *ctrl;
553 	int ret;
554 
555 	mutex_lock(&subsys->lock);
556 	ret = 0;
557 
558 	if (nvmet_is_passthru_subsys(subsys)) {
559 		pr_info("cannot enable both passthru and regular namespaces for a single subsystem");
560 		goto out_unlock;
561 	}
562 
563 	if (ns->enabled)
564 		goto out_unlock;
565 
566 	ret = -EMFILE;
567 	if (subsys->nr_namespaces == NVMET_MAX_NAMESPACES)
568 		goto out_unlock;
569 
570 	ret = nvmet_bdev_ns_enable(ns);
571 	if (ret == -ENOTBLK)
572 		ret = nvmet_file_ns_enable(ns);
573 	if (ret)
574 		goto out_unlock;
575 
576 	ret = nvmet_p2pmem_ns_enable(ns);
577 	if (ret)
578 		goto out_dev_disable;
579 
580 	list_for_each_entry(ctrl, &subsys->ctrls, subsys_entry)
581 		nvmet_p2pmem_ns_add_p2p(ctrl, ns);
582 
583 	ret = percpu_ref_init(&ns->ref, nvmet_destroy_namespace,
584 				0, GFP_KERNEL);
585 	if (ret)
586 		goto out_dev_put;
587 
588 	if (ns->nsid > subsys->max_nsid)
589 		subsys->max_nsid = ns->nsid;
590 
591 	ret = xa_insert(&subsys->namespaces, ns->nsid, ns, GFP_KERNEL);
592 	if (ret)
593 		goto out_restore_subsys_maxnsid;
594 
595 	subsys->nr_namespaces++;
596 
597 	nvmet_ns_changed(subsys, ns->nsid);
598 	ns->enabled = true;
599 	ret = 0;
600 out_unlock:
601 	mutex_unlock(&subsys->lock);
602 	return ret;
603 
604 out_restore_subsys_maxnsid:
605 	subsys->max_nsid = nvmet_max_nsid(subsys);
606 	percpu_ref_exit(&ns->ref);
607 out_dev_put:
608 	list_for_each_entry(ctrl, &subsys->ctrls, subsys_entry)
609 		pci_dev_put(radix_tree_delete(&ctrl->p2p_ns_map, ns->nsid));
610 out_dev_disable:
611 	nvmet_ns_dev_disable(ns);
612 	goto out_unlock;
613 }
614 
615 void nvmet_ns_disable(struct nvmet_ns *ns)
616 {
617 	struct nvmet_subsys *subsys = ns->subsys;
618 	struct nvmet_ctrl *ctrl;
619 
620 	mutex_lock(&subsys->lock);
621 	if (!ns->enabled)
622 		goto out_unlock;
623 
624 	ns->enabled = false;
625 	xa_erase(&ns->subsys->namespaces, ns->nsid);
626 	if (ns->nsid == subsys->max_nsid)
627 		subsys->max_nsid = nvmet_max_nsid(subsys);
628 
629 	list_for_each_entry(ctrl, &subsys->ctrls, subsys_entry)
630 		pci_dev_put(radix_tree_delete(&ctrl->p2p_ns_map, ns->nsid));
631 
632 	mutex_unlock(&subsys->lock);
633 
634 	/*
635 	 * Now that we removed the namespaces from the lookup list, we
636 	 * can kill the per_cpu ref and wait for any remaining references
637 	 * to be dropped, as well as a RCU grace period for anyone only
638 	 * using the namepace under rcu_read_lock().  Note that we can't
639 	 * use call_rcu here as we need to ensure the namespaces have
640 	 * been fully destroyed before unloading the module.
641 	 */
642 	percpu_ref_kill(&ns->ref);
643 	synchronize_rcu();
644 	wait_for_completion(&ns->disable_done);
645 	percpu_ref_exit(&ns->ref);
646 
647 	mutex_lock(&subsys->lock);
648 
649 	subsys->nr_namespaces--;
650 	nvmet_ns_changed(subsys, ns->nsid);
651 	nvmet_ns_dev_disable(ns);
652 out_unlock:
653 	mutex_unlock(&subsys->lock);
654 }
655 
656 void nvmet_ns_free(struct nvmet_ns *ns)
657 {
658 	nvmet_ns_disable(ns);
659 
660 	down_write(&nvmet_ana_sem);
661 	nvmet_ana_group_enabled[ns->anagrpid]--;
662 	up_write(&nvmet_ana_sem);
663 
664 	kfree(ns->device_path);
665 	kfree(ns);
666 }
667 
668 struct nvmet_ns *nvmet_ns_alloc(struct nvmet_subsys *subsys, u32 nsid)
669 {
670 	struct nvmet_ns *ns;
671 
672 	ns = kzalloc(sizeof(*ns), GFP_KERNEL);
673 	if (!ns)
674 		return NULL;
675 
676 	init_completion(&ns->disable_done);
677 
678 	ns->nsid = nsid;
679 	ns->subsys = subsys;
680 
681 	down_write(&nvmet_ana_sem);
682 	ns->anagrpid = NVMET_DEFAULT_ANA_GRPID;
683 	nvmet_ana_group_enabled[ns->anagrpid]++;
684 	up_write(&nvmet_ana_sem);
685 
686 	uuid_gen(&ns->uuid);
687 	ns->buffered_io = false;
688 	ns->csi = NVME_CSI_NVM;
689 
690 	return ns;
691 }
692 
693 static void nvmet_update_sq_head(struct nvmet_req *req)
694 {
695 	if (req->sq->size) {
696 		u32 old_sqhd, new_sqhd;
697 
698 		do {
699 			old_sqhd = req->sq->sqhd;
700 			new_sqhd = (old_sqhd + 1) % req->sq->size;
701 		} while (cmpxchg(&req->sq->sqhd, old_sqhd, new_sqhd) !=
702 					old_sqhd);
703 	}
704 	req->cqe->sq_head = cpu_to_le16(req->sq->sqhd & 0x0000FFFF);
705 }
706 
707 static void nvmet_set_error(struct nvmet_req *req, u16 status)
708 {
709 	struct nvmet_ctrl *ctrl = req->sq->ctrl;
710 	struct nvme_error_slot *new_error_slot;
711 	unsigned long flags;
712 
713 	req->cqe->status = cpu_to_le16(status << 1);
714 
715 	if (!ctrl || req->error_loc == NVMET_NO_ERROR_LOC)
716 		return;
717 
718 	spin_lock_irqsave(&ctrl->error_lock, flags);
719 	ctrl->err_counter++;
720 	new_error_slot =
721 		&ctrl->slots[ctrl->err_counter % NVMET_ERROR_LOG_SLOTS];
722 
723 	new_error_slot->error_count = cpu_to_le64(ctrl->err_counter);
724 	new_error_slot->sqid = cpu_to_le16(req->sq->qid);
725 	new_error_slot->cmdid = cpu_to_le16(req->cmd->common.command_id);
726 	new_error_slot->status_field = cpu_to_le16(status << 1);
727 	new_error_slot->param_error_location = cpu_to_le16(req->error_loc);
728 	new_error_slot->lba = cpu_to_le64(req->error_slba);
729 	new_error_slot->nsid = req->cmd->common.nsid;
730 	spin_unlock_irqrestore(&ctrl->error_lock, flags);
731 
732 	/* set the more bit for this request */
733 	req->cqe->status |= cpu_to_le16(1 << 14);
734 }
735 
736 static void __nvmet_req_complete(struct nvmet_req *req, u16 status)
737 {
738 	if (!req->sq->sqhd_disabled)
739 		nvmet_update_sq_head(req);
740 	req->cqe->sq_id = cpu_to_le16(req->sq->qid);
741 	req->cqe->command_id = req->cmd->common.command_id;
742 
743 	if (unlikely(status))
744 		nvmet_set_error(req, status);
745 
746 	trace_nvmet_req_complete(req);
747 
748 	if (req->ns)
749 		nvmet_put_namespace(req->ns);
750 	req->ops->queue_response(req);
751 }
752 
753 void nvmet_req_complete(struct nvmet_req *req, u16 status)
754 {
755 	__nvmet_req_complete(req, status);
756 	percpu_ref_put(&req->sq->ref);
757 }
758 EXPORT_SYMBOL_GPL(nvmet_req_complete);
759 
760 void nvmet_cq_setup(struct nvmet_ctrl *ctrl, struct nvmet_cq *cq,
761 		u16 qid, u16 size)
762 {
763 	cq->qid = qid;
764 	cq->size = size;
765 }
766 
767 void nvmet_sq_setup(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq,
768 		u16 qid, u16 size)
769 {
770 	sq->sqhd = 0;
771 	sq->qid = qid;
772 	sq->size = size;
773 
774 	ctrl->sqs[qid] = sq;
775 }
776 
777 static void nvmet_confirm_sq(struct percpu_ref *ref)
778 {
779 	struct nvmet_sq *sq = container_of(ref, struct nvmet_sq, ref);
780 
781 	complete(&sq->confirm_done);
782 }
783 
784 void nvmet_sq_destroy(struct nvmet_sq *sq)
785 {
786 	struct nvmet_ctrl *ctrl = sq->ctrl;
787 
788 	/*
789 	 * If this is the admin queue, complete all AERs so that our
790 	 * queue doesn't have outstanding requests on it.
791 	 */
792 	if (ctrl && ctrl->sqs && ctrl->sqs[0] == sq)
793 		nvmet_async_events_failall(ctrl);
794 	percpu_ref_kill_and_confirm(&sq->ref, nvmet_confirm_sq);
795 	wait_for_completion(&sq->confirm_done);
796 	wait_for_completion(&sq->free_done);
797 	percpu_ref_exit(&sq->ref);
798 	nvmet_auth_sq_free(sq);
799 
800 	if (ctrl) {
801 		/*
802 		 * The teardown flow may take some time, and the host may not
803 		 * send us keep-alive during this period, hence reset the
804 		 * traffic based keep-alive timer so we don't trigger a
805 		 * controller teardown as a result of a keep-alive expiration.
806 		 */
807 		ctrl->reset_tbkas = true;
808 		sq->ctrl->sqs[sq->qid] = NULL;
809 		nvmet_ctrl_put(ctrl);
810 		sq->ctrl = NULL; /* allows reusing the queue later */
811 	}
812 }
813 EXPORT_SYMBOL_GPL(nvmet_sq_destroy);
814 
815 static void nvmet_sq_free(struct percpu_ref *ref)
816 {
817 	struct nvmet_sq *sq = container_of(ref, struct nvmet_sq, ref);
818 
819 	complete(&sq->free_done);
820 }
821 
822 int nvmet_sq_init(struct nvmet_sq *sq)
823 {
824 	int ret;
825 
826 	ret = percpu_ref_init(&sq->ref, nvmet_sq_free, 0, GFP_KERNEL);
827 	if (ret) {
828 		pr_err("percpu_ref init failed!\n");
829 		return ret;
830 	}
831 	init_completion(&sq->free_done);
832 	init_completion(&sq->confirm_done);
833 
834 	return 0;
835 }
836 EXPORT_SYMBOL_GPL(nvmet_sq_init);
837 
838 static inline u16 nvmet_check_ana_state(struct nvmet_port *port,
839 		struct nvmet_ns *ns)
840 {
841 	enum nvme_ana_state state = port->ana_state[ns->anagrpid];
842 
843 	if (unlikely(state == NVME_ANA_INACCESSIBLE))
844 		return NVME_SC_ANA_INACCESSIBLE;
845 	if (unlikely(state == NVME_ANA_PERSISTENT_LOSS))
846 		return NVME_SC_ANA_PERSISTENT_LOSS;
847 	if (unlikely(state == NVME_ANA_CHANGE))
848 		return NVME_SC_ANA_TRANSITION;
849 	return 0;
850 }
851 
852 static inline u16 nvmet_io_cmd_check_access(struct nvmet_req *req)
853 {
854 	if (unlikely(req->ns->readonly)) {
855 		switch (req->cmd->common.opcode) {
856 		case nvme_cmd_read:
857 		case nvme_cmd_flush:
858 			break;
859 		default:
860 			return NVME_SC_NS_WRITE_PROTECTED;
861 		}
862 	}
863 
864 	return 0;
865 }
866 
867 static u16 nvmet_parse_io_cmd(struct nvmet_req *req)
868 {
869 	struct nvme_command *cmd = req->cmd;
870 	u16 ret;
871 
872 	if (nvme_is_fabrics(cmd))
873 		return nvmet_parse_fabrics_io_cmd(req);
874 
875 	if (unlikely(!nvmet_check_auth_status(req)))
876 		return NVME_SC_AUTH_REQUIRED | NVME_SC_DNR;
877 
878 	ret = nvmet_check_ctrl_status(req);
879 	if (unlikely(ret))
880 		return ret;
881 
882 	if (nvmet_is_passthru_req(req))
883 		return nvmet_parse_passthru_io_cmd(req);
884 
885 	ret = nvmet_req_find_ns(req);
886 	if (unlikely(ret))
887 		return ret;
888 
889 	ret = nvmet_check_ana_state(req->port, req->ns);
890 	if (unlikely(ret)) {
891 		req->error_loc = offsetof(struct nvme_common_command, nsid);
892 		return ret;
893 	}
894 	ret = nvmet_io_cmd_check_access(req);
895 	if (unlikely(ret)) {
896 		req->error_loc = offsetof(struct nvme_common_command, nsid);
897 		return ret;
898 	}
899 
900 	switch (req->ns->csi) {
901 	case NVME_CSI_NVM:
902 		if (req->ns->file)
903 			return nvmet_file_parse_io_cmd(req);
904 		return nvmet_bdev_parse_io_cmd(req);
905 	case NVME_CSI_ZNS:
906 		if (IS_ENABLED(CONFIG_BLK_DEV_ZONED))
907 			return nvmet_bdev_zns_parse_io_cmd(req);
908 		return NVME_SC_INVALID_IO_CMD_SET;
909 	default:
910 		return NVME_SC_INVALID_IO_CMD_SET;
911 	}
912 }
913 
914 bool nvmet_req_init(struct nvmet_req *req, struct nvmet_cq *cq,
915 		struct nvmet_sq *sq, const struct nvmet_fabrics_ops *ops)
916 {
917 	u8 flags = req->cmd->common.flags;
918 	u16 status;
919 
920 	req->cq = cq;
921 	req->sq = sq;
922 	req->ops = ops;
923 	req->sg = NULL;
924 	req->metadata_sg = NULL;
925 	req->sg_cnt = 0;
926 	req->metadata_sg_cnt = 0;
927 	req->transfer_len = 0;
928 	req->metadata_len = 0;
929 	req->cqe->status = 0;
930 	req->cqe->sq_head = 0;
931 	req->ns = NULL;
932 	req->error_loc = NVMET_NO_ERROR_LOC;
933 	req->error_slba = 0;
934 
935 	/* no support for fused commands yet */
936 	if (unlikely(flags & (NVME_CMD_FUSE_FIRST | NVME_CMD_FUSE_SECOND))) {
937 		req->error_loc = offsetof(struct nvme_common_command, flags);
938 		status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
939 		goto fail;
940 	}
941 
942 	/*
943 	 * For fabrics, PSDT field shall describe metadata pointer (MPTR) that
944 	 * contains an address of a single contiguous physical buffer that is
945 	 * byte aligned.
946 	 */
947 	if (unlikely((flags & NVME_CMD_SGL_ALL) != NVME_CMD_SGL_METABUF)) {
948 		req->error_loc = offsetof(struct nvme_common_command, flags);
949 		status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
950 		goto fail;
951 	}
952 
953 	if (unlikely(!req->sq->ctrl))
954 		/* will return an error for any non-connect command: */
955 		status = nvmet_parse_connect_cmd(req);
956 	else if (likely(req->sq->qid != 0))
957 		status = nvmet_parse_io_cmd(req);
958 	else
959 		status = nvmet_parse_admin_cmd(req);
960 
961 	if (status)
962 		goto fail;
963 
964 	trace_nvmet_req_init(req, req->cmd);
965 
966 	if (unlikely(!percpu_ref_tryget_live(&sq->ref))) {
967 		status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
968 		goto fail;
969 	}
970 
971 	if (sq->ctrl)
972 		sq->ctrl->reset_tbkas = true;
973 
974 	return true;
975 
976 fail:
977 	__nvmet_req_complete(req, status);
978 	return false;
979 }
980 EXPORT_SYMBOL_GPL(nvmet_req_init);
981 
982 void nvmet_req_uninit(struct nvmet_req *req)
983 {
984 	percpu_ref_put(&req->sq->ref);
985 	if (req->ns)
986 		nvmet_put_namespace(req->ns);
987 }
988 EXPORT_SYMBOL_GPL(nvmet_req_uninit);
989 
990 bool nvmet_check_transfer_len(struct nvmet_req *req, size_t len)
991 {
992 	if (unlikely(len != req->transfer_len)) {
993 		req->error_loc = offsetof(struct nvme_common_command, dptr);
994 		nvmet_req_complete(req, NVME_SC_SGL_INVALID_DATA | NVME_SC_DNR);
995 		return false;
996 	}
997 
998 	return true;
999 }
1000 EXPORT_SYMBOL_GPL(nvmet_check_transfer_len);
1001 
1002 bool nvmet_check_data_len_lte(struct nvmet_req *req, size_t data_len)
1003 {
1004 	if (unlikely(data_len > req->transfer_len)) {
1005 		req->error_loc = offsetof(struct nvme_common_command, dptr);
1006 		nvmet_req_complete(req, NVME_SC_SGL_INVALID_DATA | NVME_SC_DNR);
1007 		return false;
1008 	}
1009 
1010 	return true;
1011 }
1012 
1013 static unsigned int nvmet_data_transfer_len(struct nvmet_req *req)
1014 {
1015 	return req->transfer_len - req->metadata_len;
1016 }
1017 
1018 static int nvmet_req_alloc_p2pmem_sgls(struct pci_dev *p2p_dev,
1019 		struct nvmet_req *req)
1020 {
1021 	req->sg = pci_p2pmem_alloc_sgl(p2p_dev, &req->sg_cnt,
1022 			nvmet_data_transfer_len(req));
1023 	if (!req->sg)
1024 		goto out_err;
1025 
1026 	if (req->metadata_len) {
1027 		req->metadata_sg = pci_p2pmem_alloc_sgl(p2p_dev,
1028 				&req->metadata_sg_cnt, req->metadata_len);
1029 		if (!req->metadata_sg)
1030 			goto out_free_sg;
1031 	}
1032 
1033 	req->p2p_dev = p2p_dev;
1034 
1035 	return 0;
1036 out_free_sg:
1037 	pci_p2pmem_free_sgl(req->p2p_dev, req->sg);
1038 out_err:
1039 	return -ENOMEM;
1040 }
1041 
1042 static struct pci_dev *nvmet_req_find_p2p_dev(struct nvmet_req *req)
1043 {
1044 	if (!IS_ENABLED(CONFIG_PCI_P2PDMA) ||
1045 	    !req->sq->ctrl || !req->sq->qid || !req->ns)
1046 		return NULL;
1047 	return radix_tree_lookup(&req->sq->ctrl->p2p_ns_map, req->ns->nsid);
1048 }
1049 
1050 int nvmet_req_alloc_sgls(struct nvmet_req *req)
1051 {
1052 	struct pci_dev *p2p_dev = nvmet_req_find_p2p_dev(req);
1053 
1054 	if (p2p_dev && !nvmet_req_alloc_p2pmem_sgls(p2p_dev, req))
1055 		return 0;
1056 
1057 	req->sg = sgl_alloc(nvmet_data_transfer_len(req), GFP_KERNEL,
1058 			    &req->sg_cnt);
1059 	if (unlikely(!req->sg))
1060 		goto out;
1061 
1062 	if (req->metadata_len) {
1063 		req->metadata_sg = sgl_alloc(req->metadata_len, GFP_KERNEL,
1064 					     &req->metadata_sg_cnt);
1065 		if (unlikely(!req->metadata_sg))
1066 			goto out_free;
1067 	}
1068 
1069 	return 0;
1070 out_free:
1071 	sgl_free(req->sg);
1072 out:
1073 	return -ENOMEM;
1074 }
1075 EXPORT_SYMBOL_GPL(nvmet_req_alloc_sgls);
1076 
1077 void nvmet_req_free_sgls(struct nvmet_req *req)
1078 {
1079 	if (req->p2p_dev) {
1080 		pci_p2pmem_free_sgl(req->p2p_dev, req->sg);
1081 		if (req->metadata_sg)
1082 			pci_p2pmem_free_sgl(req->p2p_dev, req->metadata_sg);
1083 		req->p2p_dev = NULL;
1084 	} else {
1085 		sgl_free(req->sg);
1086 		if (req->metadata_sg)
1087 			sgl_free(req->metadata_sg);
1088 	}
1089 
1090 	req->sg = NULL;
1091 	req->metadata_sg = NULL;
1092 	req->sg_cnt = 0;
1093 	req->metadata_sg_cnt = 0;
1094 }
1095 EXPORT_SYMBOL_GPL(nvmet_req_free_sgls);
1096 
1097 static inline bool nvmet_cc_en(u32 cc)
1098 {
1099 	return (cc >> NVME_CC_EN_SHIFT) & 0x1;
1100 }
1101 
1102 static inline u8 nvmet_cc_css(u32 cc)
1103 {
1104 	return (cc >> NVME_CC_CSS_SHIFT) & 0x7;
1105 }
1106 
1107 static inline u8 nvmet_cc_mps(u32 cc)
1108 {
1109 	return (cc >> NVME_CC_MPS_SHIFT) & 0xf;
1110 }
1111 
1112 static inline u8 nvmet_cc_ams(u32 cc)
1113 {
1114 	return (cc >> NVME_CC_AMS_SHIFT) & 0x7;
1115 }
1116 
1117 static inline u8 nvmet_cc_shn(u32 cc)
1118 {
1119 	return (cc >> NVME_CC_SHN_SHIFT) & 0x3;
1120 }
1121 
1122 static inline u8 nvmet_cc_iosqes(u32 cc)
1123 {
1124 	return (cc >> NVME_CC_IOSQES_SHIFT) & 0xf;
1125 }
1126 
1127 static inline u8 nvmet_cc_iocqes(u32 cc)
1128 {
1129 	return (cc >> NVME_CC_IOCQES_SHIFT) & 0xf;
1130 }
1131 
1132 static inline bool nvmet_css_supported(u8 cc_css)
1133 {
1134 	switch (cc_css << NVME_CC_CSS_SHIFT) {
1135 	case NVME_CC_CSS_NVM:
1136 	case NVME_CC_CSS_CSI:
1137 		return true;
1138 	default:
1139 		return false;
1140 	}
1141 }
1142 
1143 static void nvmet_start_ctrl(struct nvmet_ctrl *ctrl)
1144 {
1145 	lockdep_assert_held(&ctrl->lock);
1146 
1147 	/*
1148 	 * Only I/O controllers should verify iosqes,iocqes.
1149 	 * Strictly speaking, the spec says a discovery controller
1150 	 * should verify iosqes,iocqes are zeroed, however that
1151 	 * would break backwards compatibility, so don't enforce it.
1152 	 */
1153 	if (!nvmet_is_disc_subsys(ctrl->subsys) &&
1154 	    (nvmet_cc_iosqes(ctrl->cc) != NVME_NVM_IOSQES ||
1155 	     nvmet_cc_iocqes(ctrl->cc) != NVME_NVM_IOCQES)) {
1156 		ctrl->csts = NVME_CSTS_CFS;
1157 		return;
1158 	}
1159 
1160 	if (nvmet_cc_mps(ctrl->cc) != 0 ||
1161 	    nvmet_cc_ams(ctrl->cc) != 0 ||
1162 	    !nvmet_css_supported(nvmet_cc_css(ctrl->cc))) {
1163 		ctrl->csts = NVME_CSTS_CFS;
1164 		return;
1165 	}
1166 
1167 	ctrl->csts = NVME_CSTS_RDY;
1168 
1169 	/*
1170 	 * Controllers that are not yet enabled should not really enforce the
1171 	 * keep alive timeout, but we still want to track a timeout and cleanup
1172 	 * in case a host died before it enabled the controller.  Hence, simply
1173 	 * reset the keep alive timer when the controller is enabled.
1174 	 */
1175 	if (ctrl->kato)
1176 		mod_delayed_work(system_wq, &ctrl->ka_work, ctrl->kato * HZ);
1177 }
1178 
1179 static void nvmet_clear_ctrl(struct nvmet_ctrl *ctrl)
1180 {
1181 	lockdep_assert_held(&ctrl->lock);
1182 
1183 	/* XXX: tear down queues? */
1184 	ctrl->csts &= ~NVME_CSTS_RDY;
1185 	ctrl->cc = 0;
1186 }
1187 
1188 void nvmet_update_cc(struct nvmet_ctrl *ctrl, u32 new)
1189 {
1190 	u32 old;
1191 
1192 	mutex_lock(&ctrl->lock);
1193 	old = ctrl->cc;
1194 	ctrl->cc = new;
1195 
1196 	if (nvmet_cc_en(new) && !nvmet_cc_en(old))
1197 		nvmet_start_ctrl(ctrl);
1198 	if (!nvmet_cc_en(new) && nvmet_cc_en(old))
1199 		nvmet_clear_ctrl(ctrl);
1200 	if (nvmet_cc_shn(new) && !nvmet_cc_shn(old)) {
1201 		nvmet_clear_ctrl(ctrl);
1202 		ctrl->csts |= NVME_CSTS_SHST_CMPLT;
1203 	}
1204 	if (!nvmet_cc_shn(new) && nvmet_cc_shn(old))
1205 		ctrl->csts &= ~NVME_CSTS_SHST_CMPLT;
1206 	mutex_unlock(&ctrl->lock);
1207 }
1208 
1209 static void nvmet_init_cap(struct nvmet_ctrl *ctrl)
1210 {
1211 	/* command sets supported: NVMe command set: */
1212 	ctrl->cap = (1ULL << 37);
1213 	/* Controller supports one or more I/O Command Sets */
1214 	ctrl->cap |= (1ULL << 43);
1215 	/* CC.EN timeout in 500msec units: */
1216 	ctrl->cap |= (15ULL << 24);
1217 	/* maximum queue entries supported: */
1218 	if (ctrl->ops->get_max_queue_size)
1219 		ctrl->cap |= ctrl->ops->get_max_queue_size(ctrl) - 1;
1220 	else
1221 		ctrl->cap |= NVMET_QUEUE_SIZE - 1;
1222 
1223 	if (nvmet_is_passthru_subsys(ctrl->subsys))
1224 		nvmet_passthrough_override_cap(ctrl);
1225 }
1226 
1227 struct nvmet_ctrl *nvmet_ctrl_find_get(const char *subsysnqn,
1228 				       const char *hostnqn, u16 cntlid,
1229 				       struct nvmet_req *req)
1230 {
1231 	struct nvmet_ctrl *ctrl = NULL;
1232 	struct nvmet_subsys *subsys;
1233 
1234 	subsys = nvmet_find_get_subsys(req->port, subsysnqn);
1235 	if (!subsys) {
1236 		pr_warn("connect request for invalid subsystem %s!\n",
1237 			subsysnqn);
1238 		req->cqe->result.u32 = IPO_IATTR_CONNECT_DATA(subsysnqn);
1239 		goto out;
1240 	}
1241 
1242 	mutex_lock(&subsys->lock);
1243 	list_for_each_entry(ctrl, &subsys->ctrls, subsys_entry) {
1244 		if (ctrl->cntlid == cntlid) {
1245 			if (strncmp(hostnqn, ctrl->hostnqn, NVMF_NQN_SIZE)) {
1246 				pr_warn("hostnqn mismatch.\n");
1247 				continue;
1248 			}
1249 			if (!kref_get_unless_zero(&ctrl->ref))
1250 				continue;
1251 
1252 			/* ctrl found */
1253 			goto found;
1254 		}
1255 	}
1256 
1257 	ctrl = NULL; /* ctrl not found */
1258 	pr_warn("could not find controller %d for subsys %s / host %s\n",
1259 		cntlid, subsysnqn, hostnqn);
1260 	req->cqe->result.u32 = IPO_IATTR_CONNECT_DATA(cntlid);
1261 
1262 found:
1263 	mutex_unlock(&subsys->lock);
1264 	nvmet_subsys_put(subsys);
1265 out:
1266 	return ctrl;
1267 }
1268 
1269 u16 nvmet_check_ctrl_status(struct nvmet_req *req)
1270 {
1271 	if (unlikely(!(req->sq->ctrl->cc & NVME_CC_ENABLE))) {
1272 		pr_err("got cmd %d while CC.EN == 0 on qid = %d\n",
1273 		       req->cmd->common.opcode, req->sq->qid);
1274 		return NVME_SC_CMD_SEQ_ERROR | NVME_SC_DNR;
1275 	}
1276 
1277 	if (unlikely(!(req->sq->ctrl->csts & NVME_CSTS_RDY))) {
1278 		pr_err("got cmd %d while CSTS.RDY == 0 on qid = %d\n",
1279 		       req->cmd->common.opcode, req->sq->qid);
1280 		return NVME_SC_CMD_SEQ_ERROR | NVME_SC_DNR;
1281 	}
1282 
1283 	if (unlikely(!nvmet_check_auth_status(req))) {
1284 		pr_warn("qid %d not authenticated\n", req->sq->qid);
1285 		return NVME_SC_AUTH_REQUIRED | NVME_SC_DNR;
1286 	}
1287 	return 0;
1288 }
1289 
1290 bool nvmet_host_allowed(struct nvmet_subsys *subsys, const char *hostnqn)
1291 {
1292 	struct nvmet_host_link *p;
1293 
1294 	lockdep_assert_held(&nvmet_config_sem);
1295 
1296 	if (subsys->allow_any_host)
1297 		return true;
1298 
1299 	if (nvmet_is_disc_subsys(subsys)) /* allow all access to disc subsys */
1300 		return true;
1301 
1302 	list_for_each_entry(p, &subsys->hosts, entry) {
1303 		if (!strcmp(nvmet_host_name(p->host), hostnqn))
1304 			return true;
1305 	}
1306 
1307 	return false;
1308 }
1309 
1310 /*
1311  * Note: ctrl->subsys->lock should be held when calling this function
1312  */
1313 static void nvmet_setup_p2p_ns_map(struct nvmet_ctrl *ctrl,
1314 		struct nvmet_req *req)
1315 {
1316 	struct nvmet_ns *ns;
1317 	unsigned long idx;
1318 
1319 	if (!req->p2p_client)
1320 		return;
1321 
1322 	ctrl->p2p_client = get_device(req->p2p_client);
1323 
1324 	xa_for_each(&ctrl->subsys->namespaces, idx, ns)
1325 		nvmet_p2pmem_ns_add_p2p(ctrl, ns);
1326 }
1327 
1328 /*
1329  * Note: ctrl->subsys->lock should be held when calling this function
1330  */
1331 static void nvmet_release_p2p_ns_map(struct nvmet_ctrl *ctrl)
1332 {
1333 	struct radix_tree_iter iter;
1334 	void __rcu **slot;
1335 
1336 	radix_tree_for_each_slot(slot, &ctrl->p2p_ns_map, &iter, 0)
1337 		pci_dev_put(radix_tree_deref_slot(slot));
1338 
1339 	put_device(ctrl->p2p_client);
1340 }
1341 
1342 static void nvmet_fatal_error_handler(struct work_struct *work)
1343 {
1344 	struct nvmet_ctrl *ctrl =
1345 			container_of(work, struct nvmet_ctrl, fatal_err_work);
1346 
1347 	pr_err("ctrl %d fatal error occurred!\n", ctrl->cntlid);
1348 	ctrl->ops->delete_ctrl(ctrl);
1349 }
1350 
1351 u16 nvmet_alloc_ctrl(const char *subsysnqn, const char *hostnqn,
1352 		struct nvmet_req *req, u32 kato, struct nvmet_ctrl **ctrlp)
1353 {
1354 	struct nvmet_subsys *subsys;
1355 	struct nvmet_ctrl *ctrl;
1356 	int ret;
1357 	u16 status;
1358 
1359 	status = NVME_SC_CONNECT_INVALID_PARAM | NVME_SC_DNR;
1360 	subsys = nvmet_find_get_subsys(req->port, subsysnqn);
1361 	if (!subsys) {
1362 		pr_warn("connect request for invalid subsystem %s!\n",
1363 			subsysnqn);
1364 		req->cqe->result.u32 = IPO_IATTR_CONNECT_DATA(subsysnqn);
1365 		req->error_loc = offsetof(struct nvme_common_command, dptr);
1366 		goto out;
1367 	}
1368 
1369 	down_read(&nvmet_config_sem);
1370 	if (!nvmet_host_allowed(subsys, hostnqn)) {
1371 		pr_info("connect by host %s for subsystem %s not allowed\n",
1372 			hostnqn, subsysnqn);
1373 		req->cqe->result.u32 = IPO_IATTR_CONNECT_DATA(hostnqn);
1374 		up_read(&nvmet_config_sem);
1375 		status = NVME_SC_CONNECT_INVALID_HOST | NVME_SC_DNR;
1376 		req->error_loc = offsetof(struct nvme_common_command, dptr);
1377 		goto out_put_subsystem;
1378 	}
1379 	up_read(&nvmet_config_sem);
1380 
1381 	status = NVME_SC_INTERNAL;
1382 	ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
1383 	if (!ctrl)
1384 		goto out_put_subsystem;
1385 	mutex_init(&ctrl->lock);
1386 
1387 	ctrl->port = req->port;
1388 	ctrl->ops = req->ops;
1389 
1390 #ifdef CONFIG_NVME_TARGET_PASSTHRU
1391 	/* By default, set loop targets to clear IDS by default */
1392 	if (ctrl->port->disc_addr.trtype == NVMF_TRTYPE_LOOP)
1393 		subsys->clear_ids = 1;
1394 #endif
1395 
1396 	INIT_WORK(&ctrl->async_event_work, nvmet_async_event_work);
1397 	INIT_LIST_HEAD(&ctrl->async_events);
1398 	INIT_RADIX_TREE(&ctrl->p2p_ns_map, GFP_KERNEL);
1399 	INIT_WORK(&ctrl->fatal_err_work, nvmet_fatal_error_handler);
1400 	INIT_DELAYED_WORK(&ctrl->ka_work, nvmet_keep_alive_timer);
1401 
1402 	memcpy(ctrl->subsysnqn, subsysnqn, NVMF_NQN_SIZE);
1403 	memcpy(ctrl->hostnqn, hostnqn, NVMF_NQN_SIZE);
1404 
1405 	kref_init(&ctrl->ref);
1406 	ctrl->subsys = subsys;
1407 	nvmet_init_cap(ctrl);
1408 	WRITE_ONCE(ctrl->aen_enabled, NVMET_AEN_CFG_OPTIONAL);
1409 
1410 	ctrl->changed_ns_list = kmalloc_array(NVME_MAX_CHANGED_NAMESPACES,
1411 			sizeof(__le32), GFP_KERNEL);
1412 	if (!ctrl->changed_ns_list)
1413 		goto out_free_ctrl;
1414 
1415 	ctrl->sqs = kcalloc(subsys->max_qid + 1,
1416 			sizeof(struct nvmet_sq *),
1417 			GFP_KERNEL);
1418 	if (!ctrl->sqs)
1419 		goto out_free_changed_ns_list;
1420 
1421 	if (subsys->cntlid_min > subsys->cntlid_max)
1422 		goto out_free_sqs;
1423 
1424 	ret = ida_alloc_range(&cntlid_ida,
1425 			     subsys->cntlid_min, subsys->cntlid_max,
1426 			     GFP_KERNEL);
1427 	if (ret < 0) {
1428 		status = NVME_SC_CONNECT_CTRL_BUSY | NVME_SC_DNR;
1429 		goto out_free_sqs;
1430 	}
1431 	ctrl->cntlid = ret;
1432 
1433 	/*
1434 	 * Discovery controllers may use some arbitrary high value
1435 	 * in order to cleanup stale discovery sessions
1436 	 */
1437 	if (nvmet_is_disc_subsys(ctrl->subsys) && !kato)
1438 		kato = NVMET_DISC_KATO_MS;
1439 
1440 	/* keep-alive timeout in seconds */
1441 	ctrl->kato = DIV_ROUND_UP(kato, 1000);
1442 
1443 	ctrl->err_counter = 0;
1444 	spin_lock_init(&ctrl->error_lock);
1445 
1446 	nvmet_start_keep_alive_timer(ctrl);
1447 
1448 	mutex_lock(&subsys->lock);
1449 	list_add_tail(&ctrl->subsys_entry, &subsys->ctrls);
1450 	nvmet_setup_p2p_ns_map(ctrl, req);
1451 	mutex_unlock(&subsys->lock);
1452 
1453 	*ctrlp = ctrl;
1454 	return 0;
1455 
1456 out_free_sqs:
1457 	kfree(ctrl->sqs);
1458 out_free_changed_ns_list:
1459 	kfree(ctrl->changed_ns_list);
1460 out_free_ctrl:
1461 	kfree(ctrl);
1462 out_put_subsystem:
1463 	nvmet_subsys_put(subsys);
1464 out:
1465 	return status;
1466 }
1467 
1468 static void nvmet_ctrl_free(struct kref *ref)
1469 {
1470 	struct nvmet_ctrl *ctrl = container_of(ref, struct nvmet_ctrl, ref);
1471 	struct nvmet_subsys *subsys = ctrl->subsys;
1472 
1473 	mutex_lock(&subsys->lock);
1474 	nvmet_release_p2p_ns_map(ctrl);
1475 	list_del(&ctrl->subsys_entry);
1476 	mutex_unlock(&subsys->lock);
1477 
1478 	nvmet_stop_keep_alive_timer(ctrl);
1479 
1480 	flush_work(&ctrl->async_event_work);
1481 	cancel_work_sync(&ctrl->fatal_err_work);
1482 
1483 	nvmet_destroy_auth(ctrl);
1484 
1485 	ida_free(&cntlid_ida, ctrl->cntlid);
1486 
1487 	nvmet_async_events_free(ctrl);
1488 	kfree(ctrl->sqs);
1489 	kfree(ctrl->changed_ns_list);
1490 	kfree(ctrl);
1491 
1492 	nvmet_subsys_put(subsys);
1493 }
1494 
1495 void nvmet_ctrl_put(struct nvmet_ctrl *ctrl)
1496 {
1497 	kref_put(&ctrl->ref, nvmet_ctrl_free);
1498 }
1499 
1500 void nvmet_ctrl_fatal_error(struct nvmet_ctrl *ctrl)
1501 {
1502 	mutex_lock(&ctrl->lock);
1503 	if (!(ctrl->csts & NVME_CSTS_CFS)) {
1504 		ctrl->csts |= NVME_CSTS_CFS;
1505 		queue_work(nvmet_wq, &ctrl->fatal_err_work);
1506 	}
1507 	mutex_unlock(&ctrl->lock);
1508 }
1509 EXPORT_SYMBOL_GPL(nvmet_ctrl_fatal_error);
1510 
1511 static struct nvmet_subsys *nvmet_find_get_subsys(struct nvmet_port *port,
1512 		const char *subsysnqn)
1513 {
1514 	struct nvmet_subsys_link *p;
1515 
1516 	if (!port)
1517 		return NULL;
1518 
1519 	if (!strcmp(NVME_DISC_SUBSYS_NAME, subsysnqn)) {
1520 		if (!kref_get_unless_zero(&nvmet_disc_subsys->ref))
1521 			return NULL;
1522 		return nvmet_disc_subsys;
1523 	}
1524 
1525 	down_read(&nvmet_config_sem);
1526 	list_for_each_entry(p, &port->subsystems, entry) {
1527 		if (!strncmp(p->subsys->subsysnqn, subsysnqn,
1528 				NVMF_NQN_SIZE)) {
1529 			if (!kref_get_unless_zero(&p->subsys->ref))
1530 				break;
1531 			up_read(&nvmet_config_sem);
1532 			return p->subsys;
1533 		}
1534 	}
1535 	up_read(&nvmet_config_sem);
1536 	return NULL;
1537 }
1538 
1539 struct nvmet_subsys *nvmet_subsys_alloc(const char *subsysnqn,
1540 		enum nvme_subsys_type type)
1541 {
1542 	struct nvmet_subsys *subsys;
1543 	char serial[NVMET_SN_MAX_SIZE / 2];
1544 	int ret;
1545 
1546 	subsys = kzalloc(sizeof(*subsys), GFP_KERNEL);
1547 	if (!subsys)
1548 		return ERR_PTR(-ENOMEM);
1549 
1550 	subsys->ver = NVMET_DEFAULT_VS;
1551 	/* generate a random serial number as our controllers are ephemeral: */
1552 	get_random_bytes(&serial, sizeof(serial));
1553 	bin2hex(subsys->serial, &serial, sizeof(serial));
1554 
1555 	subsys->model_number = kstrdup(NVMET_DEFAULT_CTRL_MODEL, GFP_KERNEL);
1556 	if (!subsys->model_number) {
1557 		ret = -ENOMEM;
1558 		goto free_subsys;
1559 	}
1560 
1561 	switch (type) {
1562 	case NVME_NQN_NVME:
1563 		subsys->max_qid = NVMET_NR_QUEUES;
1564 		break;
1565 	case NVME_NQN_DISC:
1566 	case NVME_NQN_CURR:
1567 		subsys->max_qid = 0;
1568 		break;
1569 	default:
1570 		pr_err("%s: Unknown Subsystem type - %d\n", __func__, type);
1571 		ret = -EINVAL;
1572 		goto free_mn;
1573 	}
1574 	subsys->type = type;
1575 	subsys->subsysnqn = kstrndup(subsysnqn, NVMF_NQN_SIZE,
1576 			GFP_KERNEL);
1577 	if (!subsys->subsysnqn) {
1578 		ret = -ENOMEM;
1579 		goto free_mn;
1580 	}
1581 	subsys->cntlid_min = NVME_CNTLID_MIN;
1582 	subsys->cntlid_max = NVME_CNTLID_MAX;
1583 	kref_init(&subsys->ref);
1584 
1585 	mutex_init(&subsys->lock);
1586 	xa_init(&subsys->namespaces);
1587 	INIT_LIST_HEAD(&subsys->ctrls);
1588 	INIT_LIST_HEAD(&subsys->hosts);
1589 
1590 	return subsys;
1591 
1592 free_mn:
1593 	kfree(subsys->model_number);
1594 free_subsys:
1595 	kfree(subsys);
1596 	return ERR_PTR(ret);
1597 }
1598 
1599 static void nvmet_subsys_free(struct kref *ref)
1600 {
1601 	struct nvmet_subsys *subsys =
1602 		container_of(ref, struct nvmet_subsys, ref);
1603 
1604 	WARN_ON_ONCE(!xa_empty(&subsys->namespaces));
1605 
1606 	xa_destroy(&subsys->namespaces);
1607 	nvmet_passthru_subsys_free(subsys);
1608 
1609 	kfree(subsys->subsysnqn);
1610 	kfree(subsys->model_number);
1611 	kfree(subsys);
1612 }
1613 
1614 void nvmet_subsys_del_ctrls(struct nvmet_subsys *subsys)
1615 {
1616 	struct nvmet_ctrl *ctrl;
1617 
1618 	mutex_lock(&subsys->lock);
1619 	list_for_each_entry(ctrl, &subsys->ctrls, subsys_entry)
1620 		ctrl->ops->delete_ctrl(ctrl);
1621 	mutex_unlock(&subsys->lock);
1622 }
1623 
1624 void nvmet_subsys_put(struct nvmet_subsys *subsys)
1625 {
1626 	kref_put(&subsys->ref, nvmet_subsys_free);
1627 }
1628 
1629 static int __init nvmet_init(void)
1630 {
1631 	int error;
1632 
1633 	nvmet_ana_group_enabled[NVMET_DEFAULT_ANA_GRPID] = 1;
1634 
1635 	zbd_wq = alloc_workqueue("nvmet-zbd-wq", WQ_MEM_RECLAIM, 0);
1636 	if (!zbd_wq)
1637 		return -ENOMEM;
1638 
1639 	buffered_io_wq = alloc_workqueue("nvmet-buffered-io-wq",
1640 			WQ_MEM_RECLAIM, 0);
1641 	if (!buffered_io_wq) {
1642 		error = -ENOMEM;
1643 		goto out_free_zbd_work_queue;
1644 	}
1645 
1646 	nvmet_wq = alloc_workqueue("nvmet-wq", WQ_MEM_RECLAIM, 0);
1647 	if (!nvmet_wq) {
1648 		error = -ENOMEM;
1649 		goto out_free_buffered_work_queue;
1650 	}
1651 
1652 	error = nvmet_init_discovery();
1653 	if (error)
1654 		goto out_free_nvmet_work_queue;
1655 
1656 	error = nvmet_init_configfs();
1657 	if (error)
1658 		goto out_exit_discovery;
1659 	return 0;
1660 
1661 out_exit_discovery:
1662 	nvmet_exit_discovery();
1663 out_free_nvmet_work_queue:
1664 	destroy_workqueue(nvmet_wq);
1665 out_free_buffered_work_queue:
1666 	destroy_workqueue(buffered_io_wq);
1667 out_free_zbd_work_queue:
1668 	destroy_workqueue(zbd_wq);
1669 	return error;
1670 }
1671 
1672 static void __exit nvmet_exit(void)
1673 {
1674 	nvmet_exit_configfs();
1675 	nvmet_exit_discovery();
1676 	ida_destroy(&cntlid_ida);
1677 	destroy_workqueue(nvmet_wq);
1678 	destroy_workqueue(buffered_io_wq);
1679 	destroy_workqueue(zbd_wq);
1680 
1681 	BUILD_BUG_ON(sizeof(struct nvmf_disc_rsp_page_entry) != 1024);
1682 	BUILD_BUG_ON(sizeof(struct nvmf_disc_rsp_page_hdr) != 1024);
1683 }
1684 
1685 module_init(nvmet_init);
1686 module_exit(nvmet_exit);
1687 
1688 MODULE_LICENSE("GPL v2");
1689