1 // SPDX-License-Identifier: GPL-2.0
3 * NVMe over Fabrics common host code.
4 * Copyright (c) 2015-2016 HGST, a Western Digital Company.
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
7 #include <linux/init.h>
8 #include <linux/miscdevice.h>
9 #include <linux/module.h>
10 #include <linux/mutex.h>
11 #include <linux/parser.h>
12 #include <linux/seq_file.h>
16 static LIST_HEAD(nvmf_transports);
17 static DECLARE_RWSEM(nvmf_transports_rwsem);
19 static LIST_HEAD(nvmf_hosts);
20 static DEFINE_MUTEX(nvmf_hosts_mutex);
22 static struct nvmf_host *nvmf_default_host;
24 static struct nvmf_host *__nvmf_host_find(const char *hostnqn)
26 struct nvmf_host *host;
28 list_for_each_entry(host, &nvmf_hosts, list) {
29 if (!strcmp(host->nqn, hostnqn))
36 static struct nvmf_host *nvmf_host_add(const char *hostnqn)
38 struct nvmf_host *host;
40 mutex_lock(&nvmf_hosts_mutex);
41 host = __nvmf_host_find(hostnqn);
47 host = kmalloc(sizeof(*host), GFP_KERNEL);
51 kref_init(&host->ref);
52 strlcpy(host->nqn, hostnqn, NVMF_NQN_SIZE);
54 list_add_tail(&host->list, &nvmf_hosts);
56 mutex_unlock(&nvmf_hosts_mutex);
60 static struct nvmf_host *nvmf_host_default(void)
62 struct nvmf_host *host;
64 host = kmalloc(sizeof(*host), GFP_KERNEL);
68 kref_init(&host->ref);
70 snprintf(host->nqn, NVMF_NQN_SIZE,
71 "nqn.2014-08.org.nvmexpress:uuid:%pUb", &host->id);
73 mutex_lock(&nvmf_hosts_mutex);
74 list_add_tail(&host->list, &nvmf_hosts);
75 mutex_unlock(&nvmf_hosts_mutex);
80 static void nvmf_host_destroy(struct kref *ref)
82 struct nvmf_host *host = container_of(ref, struct nvmf_host, ref);
84 mutex_lock(&nvmf_hosts_mutex);
85 list_del(&host->list);
86 mutex_unlock(&nvmf_hosts_mutex);
91 static void nvmf_host_put(struct nvmf_host *host)
94 kref_put(&host->ref, nvmf_host_destroy);
98 * nvmf_get_address() - Get address/port
99 * @ctrl: Host NVMe controller instance which we got the address
100 * @buf: OUTPUT parameter that will contain the address/port
103 int nvmf_get_address(struct nvme_ctrl *ctrl, char *buf, int size)
107 if (ctrl->opts->mask & NVMF_OPT_TRADDR)
108 len += scnprintf(buf, size, "traddr=%s", ctrl->opts->traddr);
109 if (ctrl->opts->mask & NVMF_OPT_TRSVCID)
110 len += scnprintf(buf + len, size - len, "%strsvcid=%s",
111 (len) ? "," : "", ctrl->opts->trsvcid);
112 if (ctrl->opts->mask & NVMF_OPT_HOST_TRADDR)
113 len += scnprintf(buf + len, size - len, "%shost_traddr=%s",
114 (len) ? "," : "", ctrl->opts->host_traddr);
115 if (ctrl->opts->mask & NVMF_OPT_HOST_IFACE)
116 len += scnprintf(buf + len, size - len, "%shost_iface=%s",
117 (len) ? "," : "", ctrl->opts->host_iface);
118 len += scnprintf(buf + len, size - len, "\n");
122 EXPORT_SYMBOL_GPL(nvmf_get_address);
125 * nvmf_reg_read32() - NVMe Fabrics "Property Get" API function.
126 * @ctrl: Host NVMe controller instance maintaining the admin
127 * queue used to submit the property read command to
128 * the allocated NVMe controller resource on the target system.
129 * @off: Starting offset value of the targeted property
130 * register (see the fabrics section of the NVMe standard).
131 * @val: OUTPUT parameter that will contain the value of
132 * the property after a successful read.
134 * Used by the host system to retrieve a 32-bit capsule property value
135 * from an NVMe controller on the target system.
137 * ("Capsule property" is an "PCIe register concept" applied to the
138 * NVMe fabrics space.)
142 * > 0: NVMe error status code
143 * < 0: Linux errno error code
145 int nvmf_reg_read32(struct nvme_ctrl *ctrl, u32 off, u32 *val)
147 struct nvme_command cmd = { };
148 union nvme_result res;
151 cmd.prop_get.opcode = nvme_fabrics_command;
152 cmd.prop_get.fctype = nvme_fabrics_type_property_get;
153 cmd.prop_get.offset = cpu_to_le32(off);
155 ret = __nvme_submit_sync_cmd(ctrl->fabrics_q, &cmd, &res, NULL, 0,
159 *val = le64_to_cpu(res.u64);
160 if (unlikely(ret != 0))
161 dev_err(ctrl->device,
162 "Property Get error: %d, offset %#x\n",
163 ret > 0 ? ret & ~NVME_SC_DNR : ret, off);
167 EXPORT_SYMBOL_GPL(nvmf_reg_read32);
170 * nvmf_reg_read64() - NVMe Fabrics "Property Get" API function.
171 * @ctrl: Host NVMe controller instance maintaining the admin
172 * queue used to submit the property read command to
173 * the allocated controller resource on the target system.
174 * @off: Starting offset value of the targeted property
175 * register (see the fabrics section of the NVMe standard).
176 * @val: OUTPUT parameter that will contain the value of
177 * the property after a successful read.
179 * Used by the host system to retrieve a 64-bit capsule property value
180 * from an NVMe controller on the target system.
182 * ("Capsule property" is an "PCIe register concept" applied to the
183 * NVMe fabrics space.)
187 * > 0: NVMe error status code
188 * < 0: Linux errno error code
190 int nvmf_reg_read64(struct nvme_ctrl *ctrl, u32 off, u64 *val)
192 struct nvme_command cmd = { };
193 union nvme_result res;
196 cmd.prop_get.opcode = nvme_fabrics_command;
197 cmd.prop_get.fctype = nvme_fabrics_type_property_get;
198 cmd.prop_get.attrib = 1;
199 cmd.prop_get.offset = cpu_to_le32(off);
201 ret = __nvme_submit_sync_cmd(ctrl->fabrics_q, &cmd, &res, NULL, 0,
205 *val = le64_to_cpu(res.u64);
206 if (unlikely(ret != 0))
207 dev_err(ctrl->device,
208 "Property Get error: %d, offset %#x\n",
209 ret > 0 ? ret & ~NVME_SC_DNR : ret, off);
212 EXPORT_SYMBOL_GPL(nvmf_reg_read64);
215 * nvmf_reg_write32() - NVMe Fabrics "Property Write" API function.
216 * @ctrl: Host NVMe controller instance maintaining the admin
217 * queue used to submit the property read command to
218 * the allocated NVMe controller resource on the target system.
219 * @off: Starting offset value of the targeted property
220 * register (see the fabrics section of the NVMe standard).
221 * @val: Input parameter that contains the value to be
222 * written to the property.
224 * Used by the NVMe host system to write a 32-bit capsule property value
225 * to an NVMe controller on the target system.
227 * ("Capsule property" is an "PCIe register concept" applied to the
228 * NVMe fabrics space.)
231 * 0: successful write
232 * > 0: NVMe error status code
233 * < 0: Linux errno error code
235 int nvmf_reg_write32(struct nvme_ctrl *ctrl, u32 off, u32 val)
237 struct nvme_command cmd = { };
240 cmd.prop_set.opcode = nvme_fabrics_command;
241 cmd.prop_set.fctype = nvme_fabrics_type_property_set;
242 cmd.prop_set.attrib = 0;
243 cmd.prop_set.offset = cpu_to_le32(off);
244 cmd.prop_set.value = cpu_to_le64(val);
246 ret = __nvme_submit_sync_cmd(ctrl->fabrics_q, &cmd, NULL, NULL, 0,
249 dev_err(ctrl->device,
250 "Property Set error: %d, offset %#x\n",
251 ret > 0 ? ret & ~NVME_SC_DNR : ret, off);
254 EXPORT_SYMBOL_GPL(nvmf_reg_write32);
257 * nvmf_log_connect_error() - Error-parsing-diagnostic print out function for
259 * @ctrl: The specific /dev/nvmeX device that had the error.
260 * @errval: Error code to be decoded in a more human-friendly
262 * @offset: For use with the NVMe error code
263 * NVME_SC_CONNECT_INVALID_PARAM.
264 * @cmd: This is the SQE portion of a submission capsule.
265 * @data: This is the "Data" portion of a submission capsule.
267 static void nvmf_log_connect_error(struct nvme_ctrl *ctrl,
268 int errval, int offset, struct nvme_command *cmd,
269 struct nvmf_connect_data *data)
271 int err_sctype = errval & ~NVME_SC_DNR;
274 dev_err(ctrl->device,
275 "Connect command failed, errno: %d\n", errval);
279 switch (err_sctype) {
280 case NVME_SC_CONNECT_INVALID_PARAM:
282 char *inv_data = "Connect Invalid Data Parameter";
284 switch (offset & 0xffff) {
285 case (offsetof(struct nvmf_connect_data, cntlid)):
286 dev_err(ctrl->device,
288 inv_data, data->cntlid);
290 case (offsetof(struct nvmf_connect_data, hostnqn)):
291 dev_err(ctrl->device,
292 "%s, hostnqn \"%s\"\n",
293 inv_data, data->hostnqn);
295 case (offsetof(struct nvmf_connect_data, subsysnqn)):
296 dev_err(ctrl->device,
297 "%s, subsysnqn \"%s\"\n",
298 inv_data, data->subsysnqn);
301 dev_err(ctrl->device,
302 "%s, starting byte offset: %d\n",
303 inv_data, offset & 0xffff);
307 char *inv_sqe = "Connect Invalid SQE Parameter";
310 case (offsetof(struct nvmf_connect_command, qid)):
311 dev_err(ctrl->device,
313 inv_sqe, cmd->connect.qid);
316 dev_err(ctrl->device,
317 "%s, starting byte offset: %d\n",
322 case NVME_SC_CONNECT_INVALID_HOST:
323 dev_err(ctrl->device,
324 "Connect for subsystem %s is not allowed, hostnqn: %s\n",
325 data->subsysnqn, data->hostnqn);
327 case NVME_SC_CONNECT_CTRL_BUSY:
328 dev_err(ctrl->device,
329 "Connect command failed: controller is busy or not available\n");
331 case NVME_SC_CONNECT_FORMAT:
332 dev_err(ctrl->device,
333 "Connect incompatible format: %d",
334 cmd->connect.recfmt);
336 case NVME_SC_HOST_PATH_ERROR:
337 dev_err(ctrl->device,
338 "Connect command failed: host path error\n");
340 case NVME_SC_AUTH_REQUIRED:
341 dev_err(ctrl->device,
342 "Connect command failed: authentication required\n");
345 dev_err(ctrl->device,
346 "Connect command failed, error wo/DNR bit: %d\n",
353 * nvmf_connect_admin_queue() - NVMe Fabrics Admin Queue "Connect"
355 * @ctrl: Host nvme controller instance used to request
356 * a new NVMe controller allocation on the target
357 * system and establish an NVMe Admin connection to
360 * This function enables an NVMe host device to request a new allocation of
361 * an NVMe controller resource on a target system as well establish a
362 * fabrics-protocol connection of the NVMe Admin queue between the
363 * host system device and the allocated NVMe controller on the
364 * target system via a NVMe Fabrics "Connect" command.
368 * > 0: NVMe error status code
369 * < 0: Linux errno error code
372 int nvmf_connect_admin_queue(struct nvme_ctrl *ctrl)
374 struct nvme_command cmd = { };
375 union nvme_result res;
376 struct nvmf_connect_data *data;
380 cmd.connect.opcode = nvme_fabrics_command;
381 cmd.connect.fctype = nvme_fabrics_type_connect;
383 cmd.connect.sqsize = cpu_to_le16(NVME_AQ_DEPTH - 1);
386 * Set keep-alive timeout in seconds granularity (ms * 1000)
388 cmd.connect.kato = cpu_to_le32(ctrl->kato * 1000);
390 if (ctrl->opts->disable_sqflow)
391 cmd.connect.cattr |= NVME_CONNECT_DISABLE_SQFLOW;
393 data = kzalloc(sizeof(*data), GFP_KERNEL);
397 uuid_copy(&data->hostid, &ctrl->opts->host->id);
398 data->cntlid = cpu_to_le16(0xffff);
399 strncpy(data->subsysnqn, ctrl->opts->subsysnqn, NVMF_NQN_SIZE);
400 strncpy(data->hostnqn, ctrl->opts->host->nqn, NVMF_NQN_SIZE);
402 ret = __nvme_submit_sync_cmd(ctrl->fabrics_q, &cmd, &res,
403 data, sizeof(*data), NVME_QID_ANY, 1,
404 BLK_MQ_REQ_RESERVED | BLK_MQ_REQ_NOWAIT);
406 nvmf_log_connect_error(ctrl, ret, le32_to_cpu(res.u32),
411 result = le32_to_cpu(res.u32);
412 ctrl->cntlid = result & 0xFFFF;
413 if ((result >> 16) & 0x3) {
414 /* Authentication required */
415 ret = nvme_auth_negotiate(ctrl, 0);
417 dev_warn(ctrl->device,
418 "qid 0: authentication setup failed\n");
419 ret = NVME_SC_AUTH_REQUIRED;
422 ret = nvme_auth_wait(ctrl, 0);
424 dev_warn(ctrl->device,
425 "qid 0: authentication failed\n");
427 dev_info(ctrl->device,
428 "qid 0: authenticated\n");
434 EXPORT_SYMBOL_GPL(nvmf_connect_admin_queue);
437 * nvmf_connect_io_queue() - NVMe Fabrics I/O Queue "Connect"
439 * @ctrl: Host nvme controller instance used to establish an
440 * NVMe I/O queue connection to the already allocated NVMe
441 * controller on the target system.
442 * @qid: NVMe I/O queue number for the new I/O connection between
443 * host and target (note qid == 0 is illegal as this is
444 * the Admin queue, per NVMe standard).
446 * This function issues a fabrics-protocol connection
447 * of a NVMe I/O queue (via NVMe Fabrics "Connect" command)
448 * between the host system device and the allocated NVMe controller
449 * on the target system.
453 * > 0: NVMe error status code
454 * < 0: Linux errno error code
456 int nvmf_connect_io_queue(struct nvme_ctrl *ctrl, u16 qid)
458 struct nvme_command cmd = { };
459 struct nvmf_connect_data *data;
460 union nvme_result res;
464 cmd.connect.opcode = nvme_fabrics_command;
465 cmd.connect.fctype = nvme_fabrics_type_connect;
466 cmd.connect.qid = cpu_to_le16(qid);
467 cmd.connect.sqsize = cpu_to_le16(ctrl->sqsize);
469 if (ctrl->opts->disable_sqflow)
470 cmd.connect.cattr |= NVME_CONNECT_DISABLE_SQFLOW;
472 data = kzalloc(sizeof(*data), GFP_KERNEL);
476 uuid_copy(&data->hostid, &ctrl->opts->host->id);
477 data->cntlid = cpu_to_le16(ctrl->cntlid);
478 strncpy(data->subsysnqn, ctrl->opts->subsysnqn, NVMF_NQN_SIZE);
479 strncpy(data->hostnqn, ctrl->opts->host->nqn, NVMF_NQN_SIZE);
481 ret = __nvme_submit_sync_cmd(ctrl->connect_q, &cmd, &res,
482 data, sizeof(*data), qid, 1,
483 BLK_MQ_REQ_RESERVED | BLK_MQ_REQ_NOWAIT);
485 nvmf_log_connect_error(ctrl, ret, le32_to_cpu(res.u32),
488 result = le32_to_cpu(res.u32);
489 if ((result >> 16) & 2) {
490 /* Authentication required */
491 ret = nvme_auth_negotiate(ctrl, qid);
493 dev_warn(ctrl->device,
494 "qid %d: authentication setup failed\n", qid);
495 ret = NVME_SC_AUTH_REQUIRED;
497 ret = nvme_auth_wait(ctrl, qid);
499 dev_warn(ctrl->device,
500 "qid %u: authentication failed\n", qid);
506 EXPORT_SYMBOL_GPL(nvmf_connect_io_queue);
508 bool nvmf_should_reconnect(struct nvme_ctrl *ctrl)
510 if (ctrl->opts->max_reconnects == -1 ||
511 ctrl->nr_reconnects < ctrl->opts->max_reconnects)
516 EXPORT_SYMBOL_GPL(nvmf_should_reconnect);
519 * nvmf_register_transport() - NVMe Fabrics Library registration function.
520 * @ops: Transport ops instance to be registered to the
521 * common fabrics library.
523 * API function that registers the type of specific transport fabric
524 * being implemented to the common NVMe fabrics library. Part of
525 * the overall init sequence of starting up a fabrics driver.
527 int nvmf_register_transport(struct nvmf_transport_ops *ops)
529 if (!ops->create_ctrl)
532 down_write(&nvmf_transports_rwsem);
533 list_add_tail(&ops->entry, &nvmf_transports);
534 up_write(&nvmf_transports_rwsem);
538 EXPORT_SYMBOL_GPL(nvmf_register_transport);
541 * nvmf_unregister_transport() - NVMe Fabrics Library unregistration function.
542 * @ops: Transport ops instance to be unregistered from the
543 * common fabrics library.
545 * Fabrics API function that unregisters the type of specific transport
546 * fabric being implemented from the common NVMe fabrics library.
547 * Part of the overall exit sequence of unloading the implemented driver.
549 void nvmf_unregister_transport(struct nvmf_transport_ops *ops)
551 down_write(&nvmf_transports_rwsem);
552 list_del(&ops->entry);
553 up_write(&nvmf_transports_rwsem);
555 EXPORT_SYMBOL_GPL(nvmf_unregister_transport);
557 static struct nvmf_transport_ops *nvmf_lookup_transport(
558 struct nvmf_ctrl_options *opts)
560 struct nvmf_transport_ops *ops;
562 lockdep_assert_held(&nvmf_transports_rwsem);
564 list_for_each_entry(ops, &nvmf_transports, entry) {
565 if (strcmp(ops->name, opts->transport) == 0)
572 static const match_table_t opt_tokens = {
573 { NVMF_OPT_TRANSPORT, "transport=%s" },
574 { NVMF_OPT_TRADDR, "traddr=%s" },
575 { NVMF_OPT_TRSVCID, "trsvcid=%s" },
576 { NVMF_OPT_NQN, "nqn=%s" },
577 { NVMF_OPT_QUEUE_SIZE, "queue_size=%d" },
578 { NVMF_OPT_NR_IO_QUEUES, "nr_io_queues=%d" },
579 { NVMF_OPT_RECONNECT_DELAY, "reconnect_delay=%d" },
580 { NVMF_OPT_CTRL_LOSS_TMO, "ctrl_loss_tmo=%d" },
581 { NVMF_OPT_KATO, "keep_alive_tmo=%d" },
582 { NVMF_OPT_HOSTNQN, "hostnqn=%s" },
583 { NVMF_OPT_HOST_TRADDR, "host_traddr=%s" },
584 { NVMF_OPT_HOST_IFACE, "host_iface=%s" },
585 { NVMF_OPT_HOST_ID, "hostid=%s" },
586 { NVMF_OPT_DUP_CONNECT, "duplicate_connect" },
587 { NVMF_OPT_DISABLE_SQFLOW, "disable_sqflow" },
588 { NVMF_OPT_HDR_DIGEST, "hdr_digest" },
589 { NVMF_OPT_DATA_DIGEST, "data_digest" },
590 { NVMF_OPT_NR_WRITE_QUEUES, "nr_write_queues=%d" },
591 { NVMF_OPT_NR_POLL_QUEUES, "nr_poll_queues=%d" },
592 { NVMF_OPT_TOS, "tos=%d" },
593 { NVMF_OPT_FAIL_FAST_TMO, "fast_io_fail_tmo=%d" },
594 { NVMF_OPT_DISCOVERY, "discovery" },
595 { NVMF_OPT_DHCHAP_SECRET, "dhchap_secret=%s" },
596 { NVMF_OPT_DHCHAP_CTRL_SECRET, "dhchap_ctrl_secret=%s" },
597 { NVMF_OPT_ERR, NULL }
600 static int nvmf_parse_options(struct nvmf_ctrl_options *opts,
603 substring_t args[MAX_OPT_ARGS];
604 char *options, *o, *p;
607 int ctrl_loss_tmo = NVMF_DEF_CTRL_LOSS_TMO;
611 opts->queue_size = NVMF_DEF_QUEUE_SIZE;
612 opts->nr_io_queues = num_online_cpus();
613 opts->reconnect_delay = NVMF_DEF_RECONNECT_DELAY;
615 opts->duplicate_connect = false;
616 opts->fast_io_fail_tmo = NVMF_DEF_FAIL_FAST_TMO;
617 opts->hdr_digest = false;
618 opts->data_digest = false;
619 opts->tos = -1; /* < 0 == use transport default */
621 options = o = kstrdup(buf, GFP_KERNEL);
627 while ((p = strsep(&o, ",\n")) != NULL) {
631 token = match_token(p, opt_tokens, args);
634 case NVMF_OPT_TRANSPORT:
635 p = match_strdup(args);
640 kfree(opts->transport);
644 p = match_strdup(args);
649 kfree(opts->subsysnqn);
651 nqnlen = strlen(opts->subsysnqn);
652 if (nqnlen >= NVMF_NQN_SIZE) {
653 pr_err("%s needs to be < %d bytes\n",
654 opts->subsysnqn, NVMF_NQN_SIZE);
658 opts->discovery_nqn =
659 !(strcmp(opts->subsysnqn,
660 NVME_DISC_SUBSYS_NAME));
662 case NVMF_OPT_TRADDR:
663 p = match_strdup(args);
671 case NVMF_OPT_TRSVCID:
672 p = match_strdup(args);
677 kfree(opts->trsvcid);
680 case NVMF_OPT_QUEUE_SIZE:
681 if (match_int(args, &token)) {
685 if (token < NVMF_MIN_QUEUE_SIZE ||
686 token > NVMF_MAX_QUEUE_SIZE) {
687 pr_err("Invalid queue_size %d\n", token);
691 opts->queue_size = token;
693 case NVMF_OPT_NR_IO_QUEUES:
694 if (match_int(args, &token)) {
699 pr_err("Invalid number of IOQs %d\n", token);
703 if (opts->discovery_nqn) {
704 pr_debug("Ignoring nr_io_queues value for discovery controller\n");
708 opts->nr_io_queues = min_t(unsigned int,
709 num_online_cpus(), token);
712 if (match_int(args, &token)) {
718 pr_err("Invalid keep_alive_tmo %d\n", token);
721 } else if (token == 0 && !opts->discovery_nqn) {
722 /* Allowed for debug */
723 pr_warn("keep_alive_tmo 0 won't execute keep alives!!!\n");
727 case NVMF_OPT_CTRL_LOSS_TMO:
728 if (match_int(args, &token)) {
734 pr_warn("ctrl_loss_tmo < 0 will reconnect forever\n");
735 ctrl_loss_tmo = token;
737 case NVMF_OPT_FAIL_FAST_TMO:
738 if (match_int(args, &token)) {
744 pr_warn("I/O fail on reconnect controller after %d sec\n",
749 opts->fast_io_fail_tmo = token;
751 case NVMF_OPT_HOSTNQN:
753 pr_err("hostnqn already user-assigned: %s\n",
758 p = match_strdup(args);
764 if (nqnlen >= NVMF_NQN_SIZE) {
765 pr_err("%s needs to be < %d bytes\n",
771 opts->host = nvmf_host_add(p);
778 case NVMF_OPT_RECONNECT_DELAY:
779 if (match_int(args, &token)) {
784 pr_err("Invalid reconnect_delay %d\n", token);
788 opts->reconnect_delay = token;
790 case NVMF_OPT_HOST_TRADDR:
791 p = match_strdup(args);
796 kfree(opts->host_traddr);
797 opts->host_traddr = p;
799 case NVMF_OPT_HOST_IFACE:
800 p = match_strdup(args);
805 kfree(opts->host_iface);
806 opts->host_iface = p;
808 case NVMF_OPT_HOST_ID:
809 p = match_strdup(args);
814 ret = uuid_parse(p, &hostid);
816 pr_err("Invalid hostid %s\n", p);
823 case NVMF_OPT_DUP_CONNECT:
824 opts->duplicate_connect = true;
826 case NVMF_OPT_DISABLE_SQFLOW:
827 opts->disable_sqflow = true;
829 case NVMF_OPT_HDR_DIGEST:
830 opts->hdr_digest = true;
832 case NVMF_OPT_DATA_DIGEST:
833 opts->data_digest = true;
835 case NVMF_OPT_NR_WRITE_QUEUES:
836 if (match_int(args, &token)) {
841 pr_err("Invalid nr_write_queues %d\n", token);
845 opts->nr_write_queues = token;
847 case NVMF_OPT_NR_POLL_QUEUES:
848 if (match_int(args, &token)) {
853 pr_err("Invalid nr_poll_queues %d\n", token);
857 opts->nr_poll_queues = token;
860 if (match_int(args, &token)) {
865 pr_err("Invalid type of service %d\n", token);
870 pr_warn("Clamping type of service to 255\n");
875 case NVMF_OPT_DISCOVERY:
876 opts->discovery_nqn = true;
878 case NVMF_OPT_DHCHAP_SECRET:
879 p = match_strdup(args);
884 if (strlen(p) < 11 || strncmp(p, "DHHC-1:", 7)) {
885 pr_err("Invalid DH-CHAP secret %s\n", p);
889 kfree(opts->dhchap_secret);
890 opts->dhchap_secret = p;
892 case NVMF_OPT_DHCHAP_CTRL_SECRET:
893 p = match_strdup(args);
898 if (strlen(p) < 11 || strncmp(p, "DHHC-1:", 7)) {
899 pr_err("Invalid DH-CHAP secret %s\n", p);
903 kfree(opts->dhchap_ctrl_secret);
904 opts->dhchap_ctrl_secret = p;
907 pr_warn("unknown parameter or missing value '%s' in ctrl creation request\n",
914 if (opts->discovery_nqn) {
915 opts->nr_io_queues = 0;
916 opts->nr_write_queues = 0;
917 opts->nr_poll_queues = 0;
918 opts->duplicate_connect = true;
921 opts->kato = NVME_DEFAULT_KATO;
923 if (ctrl_loss_tmo < 0) {
924 opts->max_reconnects = -1;
926 opts->max_reconnects = DIV_ROUND_UP(ctrl_loss_tmo,
927 opts->reconnect_delay);
928 if (ctrl_loss_tmo < opts->fast_io_fail_tmo)
929 pr_warn("failfast tmo (%d) larger than controller loss tmo (%d)\n",
930 opts->fast_io_fail_tmo, ctrl_loss_tmo);
934 kref_get(&nvmf_default_host->ref);
935 opts->host = nvmf_default_host;
938 uuid_copy(&opts->host->id, &hostid);
945 static int nvmf_check_required_opts(struct nvmf_ctrl_options *opts,
946 unsigned int required_opts)
948 if ((opts->mask & required_opts) != required_opts) {
951 for (i = 0; i < ARRAY_SIZE(opt_tokens); i++) {
952 if ((opt_tokens[i].token & required_opts) &&
953 !(opt_tokens[i].token & opts->mask)) {
954 pr_warn("missing parameter '%s'\n",
955 opt_tokens[i].pattern);
965 bool nvmf_ip_options_match(struct nvme_ctrl *ctrl,
966 struct nvmf_ctrl_options *opts)
968 if (!nvmf_ctlr_matches_baseopts(ctrl, opts) ||
969 strcmp(opts->traddr, ctrl->opts->traddr) ||
970 strcmp(opts->trsvcid, ctrl->opts->trsvcid))
974 * Checking the local address is rough. In most cases, none is specified
975 * and the host port is selected by the stack.
977 * Assume no match if:
978 * - local address is specified and address is not the same
979 * - local address is not specified but remote is, or vice versa
980 * (admin using specific host_traddr when it matters).
982 if ((opts->mask & NVMF_OPT_HOST_TRADDR) &&
983 (ctrl->opts->mask & NVMF_OPT_HOST_TRADDR)) {
984 if (strcmp(opts->host_traddr, ctrl->opts->host_traddr))
986 } else if ((opts->mask & NVMF_OPT_HOST_TRADDR) ||
987 (ctrl->opts->mask & NVMF_OPT_HOST_TRADDR)) {
993 EXPORT_SYMBOL_GPL(nvmf_ip_options_match);
995 static int nvmf_check_allowed_opts(struct nvmf_ctrl_options *opts,
996 unsigned int allowed_opts)
998 if (opts->mask & ~allowed_opts) {
1001 for (i = 0; i < ARRAY_SIZE(opt_tokens); i++) {
1002 if ((opt_tokens[i].token & opts->mask) &&
1003 (opt_tokens[i].token & ~allowed_opts)) {
1004 pr_warn("invalid parameter '%s'\n",
1005 opt_tokens[i].pattern);
1015 void nvmf_free_options(struct nvmf_ctrl_options *opts)
1017 nvmf_host_put(opts->host);
1018 kfree(opts->transport);
1019 kfree(opts->traddr);
1020 kfree(opts->trsvcid);
1021 kfree(opts->subsysnqn);
1022 kfree(opts->host_traddr);
1023 kfree(opts->host_iface);
1024 kfree(opts->dhchap_secret);
1025 kfree(opts->dhchap_ctrl_secret);
1028 EXPORT_SYMBOL_GPL(nvmf_free_options);
1030 #define NVMF_REQUIRED_OPTS (NVMF_OPT_TRANSPORT | NVMF_OPT_NQN)
1031 #define NVMF_ALLOWED_OPTS (NVMF_OPT_QUEUE_SIZE | NVMF_OPT_NR_IO_QUEUES | \
1032 NVMF_OPT_KATO | NVMF_OPT_HOSTNQN | \
1033 NVMF_OPT_HOST_ID | NVMF_OPT_DUP_CONNECT |\
1034 NVMF_OPT_DISABLE_SQFLOW | NVMF_OPT_DISCOVERY |\
1035 NVMF_OPT_FAIL_FAST_TMO | NVMF_OPT_DHCHAP_SECRET |\
1036 NVMF_OPT_DHCHAP_CTRL_SECRET)
1038 static struct nvme_ctrl *
1039 nvmf_create_ctrl(struct device *dev, const char *buf)
1041 struct nvmf_ctrl_options *opts;
1042 struct nvmf_transport_ops *ops;
1043 struct nvme_ctrl *ctrl;
1046 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
1048 return ERR_PTR(-ENOMEM);
1050 ret = nvmf_parse_options(opts, buf);
1055 request_module("nvme-%s", opts->transport);
1058 * Check the generic options first as we need a valid transport for
1059 * the lookup below. Then clear the generic flags so that transport
1060 * drivers don't have to care about them.
1062 ret = nvmf_check_required_opts(opts, NVMF_REQUIRED_OPTS);
1065 opts->mask &= ~NVMF_REQUIRED_OPTS;
1067 down_read(&nvmf_transports_rwsem);
1068 ops = nvmf_lookup_transport(opts);
1070 pr_info("no handler found for transport %s.\n",
1076 if (!try_module_get(ops->module)) {
1080 up_read(&nvmf_transports_rwsem);
1082 ret = nvmf_check_required_opts(opts, ops->required_opts);
1084 goto out_module_put;
1085 ret = nvmf_check_allowed_opts(opts, NVMF_ALLOWED_OPTS |
1086 ops->allowed_opts | ops->required_opts);
1088 goto out_module_put;
1090 ctrl = ops->create_ctrl(dev, opts);
1092 ret = PTR_ERR(ctrl);
1093 goto out_module_put;
1096 module_put(ops->module);
1100 module_put(ops->module);
1103 up_read(&nvmf_transports_rwsem);
1105 nvmf_free_options(opts);
1106 return ERR_PTR(ret);
1109 static struct class *nvmf_class;
1110 static struct device *nvmf_device;
1111 static DEFINE_MUTEX(nvmf_dev_mutex);
1113 static ssize_t nvmf_dev_write(struct file *file, const char __user *ubuf,
1114 size_t count, loff_t *pos)
1116 struct seq_file *seq_file = file->private_data;
1117 struct nvme_ctrl *ctrl;
1121 if (count > PAGE_SIZE)
1124 buf = memdup_user_nul(ubuf, count);
1126 return PTR_ERR(buf);
1128 mutex_lock(&nvmf_dev_mutex);
1129 if (seq_file->private) {
1134 ctrl = nvmf_create_ctrl(nvmf_device, buf);
1136 ret = PTR_ERR(ctrl);
1140 seq_file->private = ctrl;
1143 mutex_unlock(&nvmf_dev_mutex);
1145 return ret ? ret : count;
1148 static void __nvmf_concat_opt_tokens(struct seq_file *seq_file)
1150 const struct match_token *tok;
1154 * Add dummy entries for instance and cntlid to
1155 * signal an invalid/non-existing controller
1157 seq_puts(seq_file, "instance=-1,cntlid=-1");
1158 for (idx = 0; idx < ARRAY_SIZE(opt_tokens); idx++) {
1159 tok = &opt_tokens[idx];
1160 if (tok->token == NVMF_OPT_ERR)
1162 seq_puts(seq_file, ",");
1163 seq_puts(seq_file, tok->pattern);
1165 seq_puts(seq_file, "\n");
1168 static int nvmf_dev_show(struct seq_file *seq_file, void *private)
1170 struct nvme_ctrl *ctrl;
1172 mutex_lock(&nvmf_dev_mutex);
1173 ctrl = seq_file->private;
1175 __nvmf_concat_opt_tokens(seq_file);
1179 seq_printf(seq_file, "instance=%d,cntlid=%d\n",
1180 ctrl->instance, ctrl->cntlid);
1183 mutex_unlock(&nvmf_dev_mutex);
1187 static int nvmf_dev_open(struct inode *inode, struct file *file)
1190 * The miscdevice code initializes file->private_data, but doesn't
1191 * make use of it later.
1193 file->private_data = NULL;
1194 return single_open(file, nvmf_dev_show, NULL);
1197 static int nvmf_dev_release(struct inode *inode, struct file *file)
1199 struct seq_file *seq_file = file->private_data;
1200 struct nvme_ctrl *ctrl = seq_file->private;
1203 nvme_put_ctrl(ctrl);
1204 return single_release(inode, file);
1207 static const struct file_operations nvmf_dev_fops = {
1208 .owner = THIS_MODULE,
1209 .write = nvmf_dev_write,
1211 .open = nvmf_dev_open,
1212 .release = nvmf_dev_release,
1215 static struct miscdevice nvmf_misc = {
1216 .minor = MISC_DYNAMIC_MINOR,
1217 .name = "nvme-fabrics",
1218 .fops = &nvmf_dev_fops,
1221 static int __init nvmf_init(void)
1225 nvmf_default_host = nvmf_host_default();
1226 if (!nvmf_default_host)
1229 nvmf_class = class_create(THIS_MODULE, "nvme-fabrics");
1230 if (IS_ERR(nvmf_class)) {
1231 pr_err("couldn't register class nvme-fabrics\n");
1232 ret = PTR_ERR(nvmf_class);
1237 device_create(nvmf_class, NULL, MKDEV(0, 0), NULL, "ctl");
1238 if (IS_ERR(nvmf_device)) {
1239 pr_err("couldn't create nvme-fabrics device!\n");
1240 ret = PTR_ERR(nvmf_device);
1241 goto out_destroy_class;
1244 ret = misc_register(&nvmf_misc);
1246 pr_err("couldn't register misc device: %d\n", ret);
1247 goto out_destroy_device;
1253 device_destroy(nvmf_class, MKDEV(0, 0));
1255 class_destroy(nvmf_class);
1257 nvmf_host_put(nvmf_default_host);
1261 static void __exit nvmf_exit(void)
1263 misc_deregister(&nvmf_misc);
1264 device_destroy(nvmf_class, MKDEV(0, 0));
1265 class_destroy(nvmf_class);
1266 nvmf_host_put(nvmf_default_host);
1268 BUILD_BUG_ON(sizeof(struct nvmf_common_command) != 64);
1269 BUILD_BUG_ON(sizeof(struct nvmf_connect_command) != 64);
1270 BUILD_BUG_ON(sizeof(struct nvmf_property_get_command) != 64);
1271 BUILD_BUG_ON(sizeof(struct nvmf_property_set_command) != 64);
1272 BUILD_BUG_ON(sizeof(struct nvmf_auth_send_command) != 64);
1273 BUILD_BUG_ON(sizeof(struct nvmf_auth_receive_command) != 64);
1274 BUILD_BUG_ON(sizeof(struct nvmf_connect_data) != 1024);
1275 BUILD_BUG_ON(sizeof(struct nvmf_auth_dhchap_negotiate_data) != 8);
1276 BUILD_BUG_ON(sizeof(struct nvmf_auth_dhchap_challenge_data) != 16);
1277 BUILD_BUG_ON(sizeof(struct nvmf_auth_dhchap_reply_data) != 16);
1278 BUILD_BUG_ON(sizeof(struct nvmf_auth_dhchap_success1_data) != 16);
1279 BUILD_BUG_ON(sizeof(struct nvmf_auth_dhchap_success2_data) != 16);
1282 MODULE_LICENSE("GPL v2");
1284 module_init(nvmf_init);
1285 module_exit(nvmf_exit);