mm/hmm.c: remove superfluous RCU protection around radix tree lookup
[linux/fpc-iii.git] / drivers / nvme / host / fabrics.c
blob8f0f34d06d46965168e4472ea2f9f5b5daca6a20
1 /*
2 * NVMe over Fabrics common host code.
3 * Copyright (c) 2015-2016 HGST, a Western Digital Company.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15 #include <linux/init.h>
16 #include <linux/miscdevice.h>
17 #include <linux/module.h>
18 #include <linux/mutex.h>
19 #include <linux/parser.h>
20 #include <linux/seq_file.h>
21 #include "nvme.h"
22 #include "fabrics.h"
24 static LIST_HEAD(nvmf_transports);
25 static DECLARE_RWSEM(nvmf_transports_rwsem);
27 static LIST_HEAD(nvmf_hosts);
28 static DEFINE_MUTEX(nvmf_hosts_mutex);
30 static struct nvmf_host *nvmf_default_host;
32 static struct nvmf_host *__nvmf_host_find(const char *hostnqn)
34 struct nvmf_host *host;
36 list_for_each_entry(host, &nvmf_hosts, list) {
37 if (!strcmp(host->nqn, hostnqn))
38 return host;
41 return NULL;
44 static struct nvmf_host *nvmf_host_add(const char *hostnqn)
46 struct nvmf_host *host;
48 mutex_lock(&nvmf_hosts_mutex);
49 host = __nvmf_host_find(hostnqn);
50 if (host) {
51 kref_get(&host->ref);
52 goto out_unlock;
55 host = kmalloc(sizeof(*host), GFP_KERNEL);
56 if (!host)
57 goto out_unlock;
59 kref_init(&host->ref);
60 memcpy(host->nqn, hostnqn, NVMF_NQN_SIZE);
62 list_add_tail(&host->list, &nvmf_hosts);
63 out_unlock:
64 mutex_unlock(&nvmf_hosts_mutex);
65 return host;
68 static struct nvmf_host *nvmf_host_default(void)
70 struct nvmf_host *host;
72 host = kmalloc(sizeof(*host), GFP_KERNEL);
73 if (!host)
74 return NULL;
76 kref_init(&host->ref);
77 uuid_gen(&host->id);
78 snprintf(host->nqn, NVMF_NQN_SIZE,
79 "nqn.2014-08.org.nvmexpress:uuid:%pUb", &host->id);
81 mutex_lock(&nvmf_hosts_mutex);
82 list_add_tail(&host->list, &nvmf_hosts);
83 mutex_unlock(&nvmf_hosts_mutex);
85 return host;
88 static void nvmf_host_destroy(struct kref *ref)
90 struct nvmf_host *host = container_of(ref, struct nvmf_host, ref);
92 mutex_lock(&nvmf_hosts_mutex);
93 list_del(&host->list);
94 mutex_unlock(&nvmf_hosts_mutex);
96 kfree(host);
99 static void nvmf_host_put(struct nvmf_host *host)
101 if (host)
102 kref_put(&host->ref, nvmf_host_destroy);
106 * nvmf_get_address() - Get address/port
107 * @ctrl: Host NVMe controller instance which we got the address
108 * @buf: OUTPUT parameter that will contain the address/port
109 * @size: buffer size
111 int nvmf_get_address(struct nvme_ctrl *ctrl, char *buf, int size)
113 int len = 0;
115 if (ctrl->opts->mask & NVMF_OPT_TRADDR)
116 len += snprintf(buf, size, "traddr=%s", ctrl->opts->traddr);
117 if (ctrl->opts->mask & NVMF_OPT_TRSVCID)
118 len += snprintf(buf + len, size - len, "%strsvcid=%s",
119 (len) ? "," : "", ctrl->opts->trsvcid);
120 if (ctrl->opts->mask & NVMF_OPT_HOST_TRADDR)
121 len += snprintf(buf + len, size - len, "%shost_traddr=%s",
122 (len) ? "," : "", ctrl->opts->host_traddr);
123 len += snprintf(buf + len, size - len, "\n");
125 return len;
127 EXPORT_SYMBOL_GPL(nvmf_get_address);
130 * nvmf_reg_read32() - NVMe Fabrics "Property Get" API function.
131 * @ctrl: Host NVMe controller instance maintaining the admin
132 * queue used to submit the property read command to
133 * the allocated NVMe controller resource on the target system.
134 * @off: Starting offset value of the targeted property
135 * register (see the fabrics section of the NVMe standard).
136 * @val: OUTPUT parameter that will contain the value of
137 * the property after a successful read.
139 * Used by the host system to retrieve a 32-bit capsule property value
140 * from an NVMe controller on the target system.
142 * ("Capsule property" is an "PCIe register concept" applied to the
143 * NVMe fabrics space.)
145 * Return:
146 * 0: successful read
147 * > 0: NVMe error status code
148 * < 0: Linux errno error code
150 int nvmf_reg_read32(struct nvme_ctrl *ctrl, u32 off, u32 *val)
152 struct nvme_command cmd;
153 union nvme_result res;
154 int ret;
156 memset(&cmd, 0, sizeof(cmd));
157 cmd.prop_get.opcode = nvme_fabrics_command;
158 cmd.prop_get.fctype = nvme_fabrics_type_property_get;
159 cmd.prop_get.offset = cpu_to_le32(off);
161 ret = __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, &res, NULL, 0, 0,
162 NVME_QID_ANY, 0, 0);
164 if (ret >= 0)
165 *val = le64_to_cpu(res.u64);
166 if (unlikely(ret != 0))
167 dev_err(ctrl->device,
168 "Property Get error: %d, offset %#x\n",
169 ret > 0 ? ret & ~NVME_SC_DNR : ret, off);
171 return ret;
173 EXPORT_SYMBOL_GPL(nvmf_reg_read32);
176 * nvmf_reg_read64() - NVMe Fabrics "Property Get" API function.
177 * @ctrl: Host NVMe controller instance maintaining the admin
178 * queue used to submit the property read command to
179 * the allocated controller resource on the target system.
180 * @off: Starting offset value of the targeted property
181 * register (see the fabrics section of the NVMe standard).
182 * @val: OUTPUT parameter that will contain the value of
183 * the property after a successful read.
185 * Used by the host system to retrieve a 64-bit capsule property value
186 * from an NVMe controller on the target system.
188 * ("Capsule property" is an "PCIe register concept" applied to the
189 * NVMe fabrics space.)
191 * Return:
192 * 0: successful read
193 * > 0: NVMe error status code
194 * < 0: Linux errno error code
196 int nvmf_reg_read64(struct nvme_ctrl *ctrl, u32 off, u64 *val)
198 struct nvme_command cmd;
199 union nvme_result res;
200 int ret;
202 memset(&cmd, 0, sizeof(cmd));
203 cmd.prop_get.opcode = nvme_fabrics_command;
204 cmd.prop_get.fctype = nvme_fabrics_type_property_get;
205 cmd.prop_get.attrib = 1;
206 cmd.prop_get.offset = cpu_to_le32(off);
208 ret = __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, &res, NULL, 0, 0,
209 NVME_QID_ANY, 0, 0);
211 if (ret >= 0)
212 *val = le64_to_cpu(res.u64);
213 if (unlikely(ret != 0))
214 dev_err(ctrl->device,
215 "Property Get error: %d, offset %#x\n",
216 ret > 0 ? ret & ~NVME_SC_DNR : ret, off);
217 return ret;
219 EXPORT_SYMBOL_GPL(nvmf_reg_read64);
222 * nvmf_reg_write32() - NVMe Fabrics "Property Write" API function.
223 * @ctrl: Host NVMe controller instance maintaining the admin
224 * queue used to submit the property read command to
225 * the allocated NVMe controller resource on the target system.
226 * @off: Starting offset value of the targeted property
227 * register (see the fabrics section of the NVMe standard).
228 * @val: Input parameter that contains the value to be
229 * written to the property.
231 * Used by the NVMe host system to write a 32-bit capsule property value
232 * to an NVMe controller on the target system.
234 * ("Capsule property" is an "PCIe register concept" applied to the
235 * NVMe fabrics space.)
237 * Return:
238 * 0: successful write
239 * > 0: NVMe error status code
240 * < 0: Linux errno error code
242 int nvmf_reg_write32(struct nvme_ctrl *ctrl, u32 off, u32 val)
244 struct nvme_command cmd;
245 int ret;
247 memset(&cmd, 0, sizeof(cmd));
248 cmd.prop_set.opcode = nvme_fabrics_command;
249 cmd.prop_set.fctype = nvme_fabrics_type_property_set;
250 cmd.prop_set.attrib = 0;
251 cmd.prop_set.offset = cpu_to_le32(off);
252 cmd.prop_set.value = cpu_to_le64(val);
254 ret = __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, NULL, NULL, 0, 0,
255 NVME_QID_ANY, 0, 0);
256 if (unlikely(ret))
257 dev_err(ctrl->device,
258 "Property Set error: %d, offset %#x\n",
259 ret > 0 ? ret & ~NVME_SC_DNR : ret, off);
260 return ret;
262 EXPORT_SYMBOL_GPL(nvmf_reg_write32);
265 * nvmf_log_connect_error() - Error-parsing-diagnostic print
266 * out function for connect() errors.
268 * @ctrl: the specific /dev/nvmeX device that had the error.
270 * @errval: Error code to be decoded in a more human-friendly
271 * printout.
273 * @offset: For use with the NVMe error code NVME_SC_CONNECT_INVALID_PARAM.
275 * @cmd: This is the SQE portion of a submission capsule.
277 * @data: This is the "Data" portion of a submission capsule.
279 static void nvmf_log_connect_error(struct nvme_ctrl *ctrl,
280 int errval, int offset, struct nvme_command *cmd,
281 struct nvmf_connect_data *data)
283 int err_sctype = errval & (~NVME_SC_DNR);
285 switch (err_sctype) {
287 case (NVME_SC_CONNECT_INVALID_PARAM):
288 if (offset >> 16) {
289 char *inv_data = "Connect Invalid Data Parameter";
291 switch (offset & 0xffff) {
292 case (offsetof(struct nvmf_connect_data, cntlid)):
293 dev_err(ctrl->device,
294 "%s, cntlid: %d\n",
295 inv_data, data->cntlid);
296 break;
297 case (offsetof(struct nvmf_connect_data, hostnqn)):
298 dev_err(ctrl->device,
299 "%s, hostnqn \"%s\"\n",
300 inv_data, data->hostnqn);
301 break;
302 case (offsetof(struct nvmf_connect_data, subsysnqn)):
303 dev_err(ctrl->device,
304 "%s, subsysnqn \"%s\"\n",
305 inv_data, data->subsysnqn);
306 break;
307 default:
308 dev_err(ctrl->device,
309 "%s, starting byte offset: %d\n",
310 inv_data, offset & 0xffff);
311 break;
313 } else {
314 char *inv_sqe = "Connect Invalid SQE Parameter";
316 switch (offset) {
317 case (offsetof(struct nvmf_connect_command, qid)):
318 dev_err(ctrl->device,
319 "%s, qid %d\n",
320 inv_sqe, cmd->connect.qid);
321 break;
322 default:
323 dev_err(ctrl->device,
324 "%s, starting byte offset: %d\n",
325 inv_sqe, offset);
328 break;
330 case NVME_SC_CONNECT_INVALID_HOST:
331 dev_err(ctrl->device,
332 "Connect for subsystem %s is not allowed, hostnqn: %s\n",
333 data->subsysnqn, data->hostnqn);
334 break;
336 case NVME_SC_CONNECT_CTRL_BUSY:
337 dev_err(ctrl->device,
338 "Connect command failed: controller is busy or not available\n");
339 break;
341 case NVME_SC_CONNECT_FORMAT:
342 dev_err(ctrl->device,
343 "Connect incompatible format: %d",
344 cmd->connect.recfmt);
345 break;
347 default:
348 dev_err(ctrl->device,
349 "Connect command failed, error wo/DNR bit: %d\n",
350 err_sctype);
351 break;
352 } /* switch (err_sctype) */
356 * nvmf_connect_admin_queue() - NVMe Fabrics Admin Queue "Connect"
357 * API function.
358 * @ctrl: Host nvme controller instance used to request
359 * a new NVMe controller allocation on the target
360 * system and establish an NVMe Admin connection to
361 * that controller.
363 * This function enables an NVMe host device to request a new allocation of
364 * an NVMe controller resource on a target system as well establish a
365 * fabrics-protocol connection of the NVMe Admin queue between the
366 * host system device and the allocated NVMe controller on the
367 * target system via a NVMe Fabrics "Connect" command.
369 * Return:
370 * 0: success
371 * > 0: NVMe error status code
372 * < 0: Linux errno error code
375 int nvmf_connect_admin_queue(struct nvme_ctrl *ctrl)
377 struct nvme_command cmd;
378 union nvme_result res;
379 struct nvmf_connect_data *data;
380 int ret;
382 memset(&cmd, 0, sizeof(cmd));
383 cmd.connect.opcode = nvme_fabrics_command;
384 cmd.connect.fctype = nvme_fabrics_type_connect;
385 cmd.connect.qid = 0;
386 cmd.connect.sqsize = cpu_to_le16(NVME_AQ_DEPTH - 1);
389 * Set keep-alive timeout in seconds granularity (ms * 1000)
390 * and add a grace period for controller kato enforcement
392 cmd.connect.kato = ctrl->opts->discovery_nqn ? 0 :
393 cpu_to_le32((ctrl->kato + NVME_KATO_GRACE) * 1000);
395 data = kzalloc(sizeof(*data), GFP_KERNEL);
396 if (!data)
397 return -ENOMEM;
399 uuid_copy(&data->hostid, &ctrl->opts->host->id);
400 data->cntlid = cpu_to_le16(0xffff);
401 strncpy(data->subsysnqn, ctrl->opts->subsysnqn, NVMF_NQN_SIZE);
402 strncpy(data->hostnqn, ctrl->opts->host->nqn, NVMF_NQN_SIZE);
404 ret = __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, &res,
405 data, sizeof(*data), 0, NVME_QID_ANY, 1,
406 BLK_MQ_REQ_RESERVED | BLK_MQ_REQ_NOWAIT);
407 if (ret) {
408 nvmf_log_connect_error(ctrl, ret, le32_to_cpu(res.u32),
409 &cmd, data);
410 goto out_free_data;
413 ctrl->cntlid = le16_to_cpu(res.u16);
415 out_free_data:
416 kfree(data);
417 return ret;
419 EXPORT_SYMBOL_GPL(nvmf_connect_admin_queue);
422 * nvmf_connect_io_queue() - NVMe Fabrics I/O Queue "Connect"
423 * API function.
424 * @ctrl: Host nvme controller instance used to establish an
425 * NVMe I/O queue connection to the already allocated NVMe
426 * controller on the target system.
427 * @qid: NVMe I/O queue number for the new I/O connection between
428 * host and target (note qid == 0 is illegal as this is
429 * the Admin queue, per NVMe standard).
431 * This function issues a fabrics-protocol connection
432 * of a NVMe I/O queue (via NVMe Fabrics "Connect" command)
433 * between the host system device and the allocated NVMe controller
434 * on the target system.
436 * Return:
437 * 0: success
438 * > 0: NVMe error status code
439 * < 0: Linux errno error code
441 int nvmf_connect_io_queue(struct nvme_ctrl *ctrl, u16 qid)
443 struct nvme_command cmd;
444 struct nvmf_connect_data *data;
445 union nvme_result res;
446 int ret;
448 memset(&cmd, 0, sizeof(cmd));
449 cmd.connect.opcode = nvme_fabrics_command;
450 cmd.connect.fctype = nvme_fabrics_type_connect;
451 cmd.connect.qid = cpu_to_le16(qid);
452 cmd.connect.sqsize = cpu_to_le16(ctrl->sqsize);
454 data = kzalloc(sizeof(*data), GFP_KERNEL);
455 if (!data)
456 return -ENOMEM;
458 uuid_copy(&data->hostid, &ctrl->opts->host->id);
459 data->cntlid = cpu_to_le16(ctrl->cntlid);
460 strncpy(data->subsysnqn, ctrl->opts->subsysnqn, NVMF_NQN_SIZE);
461 strncpy(data->hostnqn, ctrl->opts->host->nqn, NVMF_NQN_SIZE);
463 ret = __nvme_submit_sync_cmd(ctrl->connect_q, &cmd, &res,
464 data, sizeof(*data), 0, qid, 1,
465 BLK_MQ_REQ_RESERVED | BLK_MQ_REQ_NOWAIT);
466 if (ret) {
467 nvmf_log_connect_error(ctrl, ret, le32_to_cpu(res.u32),
468 &cmd, data);
470 kfree(data);
471 return ret;
473 EXPORT_SYMBOL_GPL(nvmf_connect_io_queue);
475 bool nvmf_should_reconnect(struct nvme_ctrl *ctrl)
477 if (ctrl->opts->max_reconnects != -1 &&
478 ctrl->nr_reconnects < ctrl->opts->max_reconnects)
479 return true;
481 return false;
483 EXPORT_SYMBOL_GPL(nvmf_should_reconnect);
486 * nvmf_register_transport() - NVMe Fabrics Library registration function.
487 * @ops: Transport ops instance to be registered to the
488 * common fabrics library.
490 * API function that registers the type of specific transport fabric
491 * being implemented to the common NVMe fabrics library. Part of
492 * the overall init sequence of starting up a fabrics driver.
494 int nvmf_register_transport(struct nvmf_transport_ops *ops)
496 if (!ops->create_ctrl)
497 return -EINVAL;
499 down_write(&nvmf_transports_rwsem);
500 list_add_tail(&ops->entry, &nvmf_transports);
501 up_write(&nvmf_transports_rwsem);
503 return 0;
505 EXPORT_SYMBOL_GPL(nvmf_register_transport);
508 * nvmf_unregister_transport() - NVMe Fabrics Library unregistration function.
509 * @ops: Transport ops instance to be unregistered from the
510 * common fabrics library.
512 * Fabrics API function that unregisters the type of specific transport
513 * fabric being implemented from the common NVMe fabrics library.
514 * Part of the overall exit sequence of unloading the implemented driver.
516 void nvmf_unregister_transport(struct nvmf_transport_ops *ops)
518 down_write(&nvmf_transports_rwsem);
519 list_del(&ops->entry);
520 up_write(&nvmf_transports_rwsem);
522 EXPORT_SYMBOL_GPL(nvmf_unregister_transport);
524 static struct nvmf_transport_ops *nvmf_lookup_transport(
525 struct nvmf_ctrl_options *opts)
527 struct nvmf_transport_ops *ops;
529 lockdep_assert_held(&nvmf_transports_rwsem);
531 list_for_each_entry(ops, &nvmf_transports, entry) {
532 if (strcmp(ops->name, opts->transport) == 0)
533 return ops;
536 return NULL;
539 static const match_table_t opt_tokens = {
540 { NVMF_OPT_TRANSPORT, "transport=%s" },
541 { NVMF_OPT_TRADDR, "traddr=%s" },
542 { NVMF_OPT_TRSVCID, "trsvcid=%s" },
543 { NVMF_OPT_NQN, "nqn=%s" },
544 { NVMF_OPT_QUEUE_SIZE, "queue_size=%d" },
545 { NVMF_OPT_NR_IO_QUEUES, "nr_io_queues=%d" },
546 { NVMF_OPT_RECONNECT_DELAY, "reconnect_delay=%d" },
547 { NVMF_OPT_CTRL_LOSS_TMO, "ctrl_loss_tmo=%d" },
548 { NVMF_OPT_KATO, "keep_alive_tmo=%d" },
549 { NVMF_OPT_HOSTNQN, "hostnqn=%s" },
550 { NVMF_OPT_HOST_TRADDR, "host_traddr=%s" },
551 { NVMF_OPT_HOST_ID, "hostid=%s" },
552 { NVMF_OPT_DUP_CONNECT, "duplicate_connect" },
553 { NVMF_OPT_ERR, NULL }
556 static int nvmf_parse_options(struct nvmf_ctrl_options *opts,
557 const char *buf)
559 substring_t args[MAX_OPT_ARGS];
560 char *options, *o, *p;
561 int token, ret = 0;
562 size_t nqnlen = 0;
563 int ctrl_loss_tmo = NVMF_DEF_CTRL_LOSS_TMO;
564 uuid_t hostid;
566 /* Set defaults */
567 opts->queue_size = NVMF_DEF_QUEUE_SIZE;
568 opts->nr_io_queues = num_online_cpus();
569 opts->reconnect_delay = NVMF_DEF_RECONNECT_DELAY;
570 opts->kato = NVME_DEFAULT_KATO;
571 opts->duplicate_connect = false;
573 options = o = kstrdup(buf, GFP_KERNEL);
574 if (!options)
575 return -ENOMEM;
577 uuid_gen(&hostid);
579 while ((p = strsep(&o, ",\n")) != NULL) {
580 if (!*p)
581 continue;
583 token = match_token(p, opt_tokens, args);
584 opts->mask |= token;
585 switch (token) {
586 case NVMF_OPT_TRANSPORT:
587 p = match_strdup(args);
588 if (!p) {
589 ret = -ENOMEM;
590 goto out;
592 opts->transport = p;
593 break;
594 case NVMF_OPT_NQN:
595 p = match_strdup(args);
596 if (!p) {
597 ret = -ENOMEM;
598 goto out;
600 opts->subsysnqn = p;
601 nqnlen = strlen(opts->subsysnqn);
602 if (nqnlen >= NVMF_NQN_SIZE) {
603 pr_err("%s needs to be < %d bytes\n",
604 opts->subsysnqn, NVMF_NQN_SIZE);
605 ret = -EINVAL;
606 goto out;
608 opts->discovery_nqn =
609 !(strcmp(opts->subsysnqn,
610 NVME_DISC_SUBSYS_NAME));
611 if (opts->discovery_nqn)
612 opts->nr_io_queues = 0;
613 break;
614 case NVMF_OPT_TRADDR:
615 p = match_strdup(args);
616 if (!p) {
617 ret = -ENOMEM;
618 goto out;
620 opts->traddr = p;
621 break;
622 case NVMF_OPT_TRSVCID:
623 p = match_strdup(args);
624 if (!p) {
625 ret = -ENOMEM;
626 goto out;
628 opts->trsvcid = p;
629 break;
630 case NVMF_OPT_QUEUE_SIZE:
631 if (match_int(args, &token)) {
632 ret = -EINVAL;
633 goto out;
635 if (token < NVMF_MIN_QUEUE_SIZE ||
636 token > NVMF_MAX_QUEUE_SIZE) {
637 pr_err("Invalid queue_size %d\n", token);
638 ret = -EINVAL;
639 goto out;
641 opts->queue_size = token;
642 break;
643 case NVMF_OPT_NR_IO_QUEUES:
644 if (match_int(args, &token)) {
645 ret = -EINVAL;
646 goto out;
648 if (token <= 0) {
649 pr_err("Invalid number of IOQs %d\n", token);
650 ret = -EINVAL;
651 goto out;
653 if (opts->discovery_nqn) {
654 pr_debug("Ignoring nr_io_queues value for discovery controller\n");
655 break;
658 opts->nr_io_queues = min_t(unsigned int,
659 num_online_cpus(), token);
660 break;
661 case NVMF_OPT_KATO:
662 if (match_int(args, &token)) {
663 ret = -EINVAL;
664 goto out;
667 if (token < 0) {
668 pr_err("Invalid keep_alive_tmo %d\n", token);
669 ret = -EINVAL;
670 goto out;
671 } else if (token == 0 && !opts->discovery_nqn) {
672 /* Allowed for debug */
673 pr_warn("keep_alive_tmo 0 won't execute keep alives!!!\n");
675 opts->kato = token;
677 if (opts->discovery_nqn && opts->kato) {
678 pr_err("Discovery controllers cannot accept KATO != 0\n");
679 ret = -EINVAL;
680 goto out;
683 break;
684 case NVMF_OPT_CTRL_LOSS_TMO:
685 if (match_int(args, &token)) {
686 ret = -EINVAL;
687 goto out;
690 if (token < 0)
691 pr_warn("ctrl_loss_tmo < 0 will reconnect forever\n");
692 ctrl_loss_tmo = token;
693 break;
694 case NVMF_OPT_HOSTNQN:
695 if (opts->host) {
696 pr_err("hostnqn already user-assigned: %s\n",
697 opts->host->nqn);
698 ret = -EADDRINUSE;
699 goto out;
701 p = match_strdup(args);
702 if (!p) {
703 ret = -ENOMEM;
704 goto out;
706 nqnlen = strlen(p);
707 if (nqnlen >= NVMF_NQN_SIZE) {
708 pr_err("%s needs to be < %d bytes\n",
709 p, NVMF_NQN_SIZE);
710 kfree(p);
711 ret = -EINVAL;
712 goto out;
714 opts->host = nvmf_host_add(p);
715 kfree(p);
716 if (!opts->host) {
717 ret = -ENOMEM;
718 goto out;
720 break;
721 case NVMF_OPT_RECONNECT_DELAY:
722 if (match_int(args, &token)) {
723 ret = -EINVAL;
724 goto out;
726 if (token <= 0) {
727 pr_err("Invalid reconnect_delay %d\n", token);
728 ret = -EINVAL;
729 goto out;
731 opts->reconnect_delay = token;
732 break;
733 case NVMF_OPT_HOST_TRADDR:
734 p = match_strdup(args);
735 if (!p) {
736 ret = -ENOMEM;
737 goto out;
739 opts->host_traddr = p;
740 break;
741 case NVMF_OPT_HOST_ID:
742 p = match_strdup(args);
743 if (!p) {
744 ret = -ENOMEM;
745 goto out;
747 ret = uuid_parse(p, &hostid);
748 if (ret) {
749 pr_err("Invalid hostid %s\n", p);
750 ret = -EINVAL;
751 kfree(p);
752 goto out;
754 kfree(p);
755 break;
756 case NVMF_OPT_DUP_CONNECT:
757 opts->duplicate_connect = true;
758 break;
759 default:
760 pr_warn("unknown parameter or missing value '%s' in ctrl creation request\n",
762 ret = -EINVAL;
763 goto out;
767 if (ctrl_loss_tmo < 0)
768 opts->max_reconnects = -1;
769 else
770 opts->max_reconnects = DIV_ROUND_UP(ctrl_loss_tmo,
771 opts->reconnect_delay);
773 if (!opts->host) {
774 kref_get(&nvmf_default_host->ref);
775 opts->host = nvmf_default_host;
778 uuid_copy(&opts->host->id, &hostid);
780 out:
781 kfree(options);
782 return ret;
785 static int nvmf_check_required_opts(struct nvmf_ctrl_options *opts,
786 unsigned int required_opts)
788 if ((opts->mask & required_opts) != required_opts) {
789 int i;
791 for (i = 0; i < ARRAY_SIZE(opt_tokens); i++) {
792 if ((opt_tokens[i].token & required_opts) &&
793 !(opt_tokens[i].token & opts->mask)) {
794 pr_warn("missing parameter '%s'\n",
795 opt_tokens[i].pattern);
799 return -EINVAL;
802 return 0;
805 static int nvmf_check_allowed_opts(struct nvmf_ctrl_options *opts,
806 unsigned int allowed_opts)
808 if (opts->mask & ~allowed_opts) {
809 int i;
811 for (i = 0; i < ARRAY_SIZE(opt_tokens); i++) {
812 if ((opt_tokens[i].token & opts->mask) &&
813 (opt_tokens[i].token & ~allowed_opts)) {
814 pr_warn("invalid parameter '%s'\n",
815 opt_tokens[i].pattern);
819 return -EINVAL;
822 return 0;
825 void nvmf_free_options(struct nvmf_ctrl_options *opts)
827 nvmf_host_put(opts->host);
828 kfree(opts->transport);
829 kfree(opts->traddr);
830 kfree(opts->trsvcid);
831 kfree(opts->subsysnqn);
832 kfree(opts->host_traddr);
833 kfree(opts);
835 EXPORT_SYMBOL_GPL(nvmf_free_options);
837 #define NVMF_REQUIRED_OPTS (NVMF_OPT_TRANSPORT | NVMF_OPT_NQN)
838 #define NVMF_ALLOWED_OPTS (NVMF_OPT_QUEUE_SIZE | NVMF_OPT_NR_IO_QUEUES | \
839 NVMF_OPT_KATO | NVMF_OPT_HOSTNQN | \
840 NVMF_OPT_HOST_ID | NVMF_OPT_DUP_CONNECT)
842 static struct nvme_ctrl *
843 nvmf_create_ctrl(struct device *dev, const char *buf, size_t count)
845 struct nvmf_ctrl_options *opts;
846 struct nvmf_transport_ops *ops;
847 struct nvme_ctrl *ctrl;
848 int ret;
850 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
851 if (!opts)
852 return ERR_PTR(-ENOMEM);
854 ret = nvmf_parse_options(opts, buf);
855 if (ret)
856 goto out_free_opts;
859 request_module("nvme-%s", opts->transport);
862 * Check the generic options first as we need a valid transport for
863 * the lookup below. Then clear the generic flags so that transport
864 * drivers don't have to care about them.
866 ret = nvmf_check_required_opts(opts, NVMF_REQUIRED_OPTS);
867 if (ret)
868 goto out_free_opts;
869 opts->mask &= ~NVMF_REQUIRED_OPTS;
871 down_read(&nvmf_transports_rwsem);
872 ops = nvmf_lookup_transport(opts);
873 if (!ops) {
874 pr_info("no handler found for transport %s.\n",
875 opts->transport);
876 ret = -EINVAL;
877 goto out_unlock;
880 if (!try_module_get(ops->module)) {
881 ret = -EBUSY;
882 goto out_unlock;
885 ret = nvmf_check_required_opts(opts, ops->required_opts);
886 if (ret)
887 goto out_module_put;
888 ret = nvmf_check_allowed_opts(opts, NVMF_ALLOWED_OPTS |
889 ops->allowed_opts | ops->required_opts);
890 if (ret)
891 goto out_module_put;
893 ctrl = ops->create_ctrl(dev, opts);
894 if (IS_ERR(ctrl)) {
895 ret = PTR_ERR(ctrl);
896 goto out_module_put;
899 if (strcmp(ctrl->subsys->subnqn, opts->subsysnqn)) {
900 dev_warn(ctrl->device,
901 "controller returned incorrect NQN: \"%s\".\n",
902 ctrl->subsys->subnqn);
903 module_put(ops->module);
904 up_read(&nvmf_transports_rwsem);
905 nvme_delete_ctrl_sync(ctrl);
906 return ERR_PTR(-EINVAL);
909 module_put(ops->module);
910 up_read(&nvmf_transports_rwsem);
911 return ctrl;
913 out_module_put:
914 module_put(ops->module);
915 out_unlock:
916 up_read(&nvmf_transports_rwsem);
917 out_free_opts:
918 nvmf_free_options(opts);
919 return ERR_PTR(ret);
922 static struct class *nvmf_class;
923 static struct device *nvmf_device;
924 static DEFINE_MUTEX(nvmf_dev_mutex);
926 static ssize_t nvmf_dev_write(struct file *file, const char __user *ubuf,
927 size_t count, loff_t *pos)
929 struct seq_file *seq_file = file->private_data;
930 struct nvme_ctrl *ctrl;
931 const char *buf;
932 int ret = 0;
934 if (count > PAGE_SIZE)
935 return -ENOMEM;
937 buf = memdup_user_nul(ubuf, count);
938 if (IS_ERR(buf))
939 return PTR_ERR(buf);
941 mutex_lock(&nvmf_dev_mutex);
942 if (seq_file->private) {
943 ret = -EINVAL;
944 goto out_unlock;
947 ctrl = nvmf_create_ctrl(nvmf_device, buf, count);
948 if (IS_ERR(ctrl)) {
949 ret = PTR_ERR(ctrl);
950 goto out_unlock;
953 seq_file->private = ctrl;
955 out_unlock:
956 mutex_unlock(&nvmf_dev_mutex);
957 kfree(buf);
958 return ret ? ret : count;
961 static int nvmf_dev_show(struct seq_file *seq_file, void *private)
963 struct nvme_ctrl *ctrl;
964 int ret = 0;
966 mutex_lock(&nvmf_dev_mutex);
967 ctrl = seq_file->private;
968 if (!ctrl) {
969 ret = -EINVAL;
970 goto out_unlock;
973 seq_printf(seq_file, "instance=%d,cntlid=%d\n",
974 ctrl->instance, ctrl->cntlid);
976 out_unlock:
977 mutex_unlock(&nvmf_dev_mutex);
978 return ret;
981 static int nvmf_dev_open(struct inode *inode, struct file *file)
984 * The miscdevice code initializes file->private_data, but doesn't
985 * make use of it later.
987 file->private_data = NULL;
988 return single_open(file, nvmf_dev_show, NULL);
991 static int nvmf_dev_release(struct inode *inode, struct file *file)
993 struct seq_file *seq_file = file->private_data;
994 struct nvme_ctrl *ctrl = seq_file->private;
996 if (ctrl)
997 nvme_put_ctrl(ctrl);
998 return single_release(inode, file);
1001 static const struct file_operations nvmf_dev_fops = {
1002 .owner = THIS_MODULE,
1003 .write = nvmf_dev_write,
1004 .read = seq_read,
1005 .open = nvmf_dev_open,
1006 .release = nvmf_dev_release,
1009 static struct miscdevice nvmf_misc = {
1010 .minor = MISC_DYNAMIC_MINOR,
1011 .name = "nvme-fabrics",
1012 .fops = &nvmf_dev_fops,
1015 static int __init nvmf_init(void)
1017 int ret;
1019 nvmf_default_host = nvmf_host_default();
1020 if (!nvmf_default_host)
1021 return -ENOMEM;
1023 nvmf_class = class_create(THIS_MODULE, "nvme-fabrics");
1024 if (IS_ERR(nvmf_class)) {
1025 pr_err("couldn't register class nvme-fabrics\n");
1026 ret = PTR_ERR(nvmf_class);
1027 goto out_free_host;
1030 nvmf_device =
1031 device_create(nvmf_class, NULL, MKDEV(0, 0), NULL, "ctl");
1032 if (IS_ERR(nvmf_device)) {
1033 pr_err("couldn't create nvme-fabris device!\n");
1034 ret = PTR_ERR(nvmf_device);
1035 goto out_destroy_class;
1038 ret = misc_register(&nvmf_misc);
1039 if (ret) {
1040 pr_err("couldn't register misc device: %d\n", ret);
1041 goto out_destroy_device;
1044 return 0;
1046 out_destroy_device:
1047 device_destroy(nvmf_class, MKDEV(0, 0));
1048 out_destroy_class:
1049 class_destroy(nvmf_class);
1050 out_free_host:
1051 nvmf_host_put(nvmf_default_host);
1052 return ret;
1055 static void __exit nvmf_exit(void)
1057 misc_deregister(&nvmf_misc);
1058 device_destroy(nvmf_class, MKDEV(0, 0));
1059 class_destroy(nvmf_class);
1060 nvmf_host_put(nvmf_default_host);
1062 BUILD_BUG_ON(sizeof(struct nvmf_connect_command) != 64);
1063 BUILD_BUG_ON(sizeof(struct nvmf_property_get_command) != 64);
1064 BUILD_BUG_ON(sizeof(struct nvmf_property_set_command) != 64);
1065 BUILD_BUG_ON(sizeof(struct nvmf_connect_data) != 1024);
1068 MODULE_LICENSE("GPL v2");
1070 module_init(nvmf_init);
1071 module_exit(nvmf_exit);