1 /* 2 * NVMe over Fabrics common host code. 3 * Copyright (c) 2015-2016 HGST, a Western Digital Company. 4 * 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. 8 * 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. 13 */ 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" 23 24 static LIST_HEAD(nvmf_transports); 25 static DECLARE_RWSEM(nvmf_transports_rwsem); 26 27 static LIST_HEAD(nvmf_hosts); 28 static DEFINE_MUTEX(nvmf_hosts_mutex); 29 30 static struct nvmf_host *nvmf_default_host; 31 32 static struct nvmf_host *__nvmf_host_find(const char *hostnqn) 33 { 34 struct nvmf_host *host; 35 36 list_for_each_entry(host, &nvmf_hosts, list) { 37 if (!strcmp(host->nqn, hostnqn)) 38 return host; 39 } 40 41 return NULL; 42 } 43 44 static struct nvmf_host *nvmf_host_add(const char *hostnqn) 45 { 46 struct nvmf_host *host; 47 48 mutex_lock(&nvmf_hosts_mutex); 49 host = __nvmf_host_find(hostnqn); 50 if (host) { 51 kref_get(&host->ref); 52 goto out_unlock; 53 } 54 55 host = kmalloc(sizeof(*host), GFP_KERNEL); 56 if (!host) 57 goto out_unlock; 58 59 kref_init(&host->ref); 60 memcpy(host->nqn, hostnqn, NVMF_NQN_SIZE); 61 62 list_add_tail(&host->list, &nvmf_hosts); 63 out_unlock: 64 mutex_unlock(&nvmf_hosts_mutex); 65 return host; 66 } 67 68 static struct nvmf_host *nvmf_host_default(void) 69 { 70 struct nvmf_host *host; 71 72 host = kmalloc(sizeof(*host), GFP_KERNEL); 73 if (!host) 74 return NULL; 75 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); 80 81 mutex_lock(&nvmf_hosts_mutex); 82 list_add_tail(&host->list, &nvmf_hosts); 83 mutex_unlock(&nvmf_hosts_mutex); 84 85 return host; 86 } 87 88 static void nvmf_host_destroy(struct kref *ref) 89 { 90 struct nvmf_host *host = container_of(ref, struct nvmf_host, ref); 91 92 mutex_lock(&nvmf_hosts_mutex); 93 list_del(&host->list); 94 mutex_unlock(&nvmf_hosts_mutex); 95 96 kfree(host); 97 } 98 99 static void nvmf_host_put(struct nvmf_host *host) 100 { 101 if (host) 102 kref_put(&host->ref, nvmf_host_destroy); 103 } 104 105 /** 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 110 */ 111 int nvmf_get_address(struct nvme_ctrl *ctrl, char *buf, int size) 112 { 113 int len = 0; 114 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"); 124 125 return len; 126 } 127 EXPORT_SYMBOL_GPL(nvmf_get_address); 128 129 /** 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. 138 * 139 * Used by the host system to retrieve a 32-bit capsule property value 140 * from an NVMe controller on the target system. 141 * 142 * ("Capsule property" is an "PCIe register concept" applied to the 143 * NVMe fabrics space.) 144 * 145 * Return: 146 * 0: successful read 147 * > 0: NVMe error status code 148 * < 0: Linux errno error code 149 */ 150 int nvmf_reg_read32(struct nvme_ctrl *ctrl, u32 off, u32 *val) 151 { 152 struct nvme_command cmd; 153 union nvme_result res; 154 int ret; 155 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); 160 161 ret = __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, &res, NULL, 0, 0, 162 NVME_QID_ANY, 0, 0); 163 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); 170 171 return ret; 172 } 173 EXPORT_SYMBOL_GPL(nvmf_reg_read32); 174 175 /** 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. 184 * 185 * Used by the host system to retrieve a 64-bit capsule property value 186 * from an NVMe controller on the target system. 187 * 188 * ("Capsule property" is an "PCIe register concept" applied to the 189 * NVMe fabrics space.) 190 * 191 * Return: 192 * 0: successful read 193 * > 0: NVMe error status code 194 * < 0: Linux errno error code 195 */ 196 int nvmf_reg_read64(struct nvme_ctrl *ctrl, u32 off, u64 *val) 197 { 198 struct nvme_command cmd; 199 union nvme_result res; 200 int ret; 201 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); 207 208 ret = __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, &res, NULL, 0, 0, 209 NVME_QID_ANY, 0, 0); 210 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; 218 } 219 EXPORT_SYMBOL_GPL(nvmf_reg_read64); 220 221 /** 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. 230 * 231 * Used by the NVMe host system to write a 32-bit capsule property value 232 * to an NVMe controller on the target system. 233 * 234 * ("Capsule property" is an "PCIe register concept" applied to the 235 * NVMe fabrics space.) 236 * 237 * Return: 238 * 0: successful write 239 * > 0: NVMe error status code 240 * < 0: Linux errno error code 241 */ 242 int nvmf_reg_write32(struct nvme_ctrl *ctrl, u32 off, u32 val) 243 { 244 struct nvme_command cmd; 245 int ret; 246 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); 253 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; 261 } 262 EXPORT_SYMBOL_GPL(nvmf_reg_write32); 263 264 /** 265 * nvmf_log_connect_error() - Error-parsing-diagnostic print 266 * out function for connect() errors. 267 * 268 * @ctrl: the specific /dev/nvmeX device that had the error. 269 * 270 * @errval: Error code to be decoded in a more human-friendly 271 * printout. 272 * 273 * @offset: For use with the NVMe error code NVME_SC_CONNECT_INVALID_PARAM. 274 * 275 * @cmd: This is the SQE portion of a submission capsule. 276 * 277 * @data: This is the "Data" portion of a submission capsule. 278 */ 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) 282 { 283 int err_sctype = errval & (~NVME_SC_DNR); 284 285 switch (err_sctype) { 286 287 case (NVME_SC_CONNECT_INVALID_PARAM): 288 if (offset >> 16) { 289 char *inv_data = "Connect Invalid Data Parameter"; 290 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; 312 } 313 } else { 314 char *inv_sqe = "Connect Invalid SQE Parameter"; 315 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); 326 } 327 } 328 break; 329 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; 335 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; 340 341 case NVME_SC_CONNECT_FORMAT: 342 dev_err(ctrl->device, 343 "Connect incompatible format: %d", 344 cmd->connect.recfmt); 345 break; 346 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) */ 353 } 354 355 /** 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. 362 * 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. 368 * 369 * Return: 370 * 0: success 371 * > 0: NVMe error status code 372 * < 0: Linux errno error code 373 * 374 */ 375 int nvmf_connect_admin_queue(struct nvme_ctrl *ctrl) 376 { 377 struct nvme_command cmd; 378 union nvme_result res; 379 struct nvmf_connect_data *data; 380 int ret; 381 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); 387 388 /* 389 * Set keep-alive timeout in seconds granularity (ms * 1000) 390 * and add a grace period for controller kato enforcement 391 */ 392 cmd.connect.kato = ctrl->opts->discovery_nqn ? 0 : 393 cpu_to_le32((ctrl->kato + NVME_KATO_GRACE) * 1000); 394 395 data = kzalloc(sizeof(*data), GFP_KERNEL); 396 if (!data) 397 return -ENOMEM; 398 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); 403 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; 411 } 412 413 ctrl->cntlid = le16_to_cpu(res.u16); 414 415 out_free_data: 416 kfree(data); 417 return ret; 418 } 419 EXPORT_SYMBOL_GPL(nvmf_connect_admin_queue); 420 421 /** 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). 430 * 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. 435 * 436 * Return: 437 * 0: success 438 * > 0: NVMe error status code 439 * < 0: Linux errno error code 440 */ 441 int nvmf_connect_io_queue(struct nvme_ctrl *ctrl, u16 qid) 442 { 443 struct nvme_command cmd; 444 struct nvmf_connect_data *data; 445 union nvme_result res; 446 int ret; 447 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); 453 454 data = kzalloc(sizeof(*data), GFP_KERNEL); 455 if (!data) 456 return -ENOMEM; 457 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); 462 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); 469 } 470 kfree(data); 471 return ret; 472 } 473 EXPORT_SYMBOL_GPL(nvmf_connect_io_queue); 474 475 bool nvmf_should_reconnect(struct nvme_ctrl *ctrl) 476 { 477 if (ctrl->opts->max_reconnects != -1 && 478 ctrl->nr_reconnects < ctrl->opts->max_reconnects) 479 return true; 480 481 return false; 482 } 483 EXPORT_SYMBOL_GPL(nvmf_should_reconnect); 484 485 /** 486 * nvmf_register_transport() - NVMe Fabrics Library registration function. 487 * @ops: Transport ops instance to be registered to the 488 * common fabrics library. 489 * 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. 493 */ 494 int nvmf_register_transport(struct nvmf_transport_ops *ops) 495 { 496 if (!ops->create_ctrl) 497 return -EINVAL; 498 499 down_write(&nvmf_transports_rwsem); 500 list_add_tail(&ops->entry, &nvmf_transports); 501 up_write(&nvmf_transports_rwsem); 502 503 return 0; 504 } 505 EXPORT_SYMBOL_GPL(nvmf_register_transport); 506 507 /** 508 * nvmf_unregister_transport() - NVMe Fabrics Library unregistration function. 509 * @ops: Transport ops instance to be unregistered from the 510 * common fabrics library. 511 * 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. 515 */ 516 void nvmf_unregister_transport(struct nvmf_transport_ops *ops) 517 { 518 down_write(&nvmf_transports_rwsem); 519 list_del(&ops->entry); 520 up_write(&nvmf_transports_rwsem); 521 } 522 EXPORT_SYMBOL_GPL(nvmf_unregister_transport); 523 524 static struct nvmf_transport_ops *nvmf_lookup_transport( 525 struct nvmf_ctrl_options *opts) 526 { 527 struct nvmf_transport_ops *ops; 528 529 lockdep_assert_held(&nvmf_transports_rwsem); 530 531 list_for_each_entry(ops, &nvmf_transports, entry) { 532 if (strcmp(ops->name, opts->transport) == 0) 533 return ops; 534 } 535 536 return NULL; 537 } 538 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 } 554 }; 555 556 static int nvmf_parse_options(struct nvmf_ctrl_options *opts, 557 const char *buf) 558 { 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; 565 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; 572 573 options = o = kstrdup(buf, GFP_KERNEL); 574 if (!options) 575 return -ENOMEM; 576 577 uuid_gen(&hostid); 578 579 while ((p = strsep(&o, ",\n")) != NULL) { 580 if (!*p) 581 continue; 582 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; 591 } 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; 599 } 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; 607 } 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; 619 } 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; 627 } 628 opts->trsvcid = p; 629 break; 630 case NVMF_OPT_QUEUE_SIZE: 631 if (match_int(args, &token)) { 632 ret = -EINVAL; 633 goto out; 634 } 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; 640 } 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; 647 } 648 if (token <= 0) { 649 pr_err("Invalid number of IOQs %d\n", token); 650 ret = -EINVAL; 651 goto out; 652 } 653 if (opts->discovery_nqn) { 654 pr_debug("Ignoring nr_io_queues value for discovery controller\n"); 655 break; 656 } 657 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; 665 } 666 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"); 674 } 675 opts->kato = token; 676 677 if (opts->discovery_nqn && opts->kato) { 678 pr_err("Discovery controllers cannot accept KATO != 0\n"); 679 ret = -EINVAL; 680 goto out; 681 } 682 683 break; 684 case NVMF_OPT_CTRL_LOSS_TMO: 685 if (match_int(args, &token)) { 686 ret = -EINVAL; 687 goto out; 688 } 689 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; 700 } 701 p = match_strdup(args); 702 if (!p) { 703 ret = -ENOMEM; 704 goto out; 705 } 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; 713 } 714 opts->host = nvmf_host_add(p); 715 kfree(p); 716 if (!opts->host) { 717 ret = -ENOMEM; 718 goto out; 719 } 720 break; 721 case NVMF_OPT_RECONNECT_DELAY: 722 if (match_int(args, &token)) { 723 ret = -EINVAL; 724 goto out; 725 } 726 if (token <= 0) { 727 pr_err("Invalid reconnect_delay %d\n", token); 728 ret = -EINVAL; 729 goto out; 730 } 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; 738 } 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; 746 } 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; 753 } 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", 761 p); 762 ret = -EINVAL; 763 goto out; 764 } 765 } 766 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); 772 773 if (!opts->host) { 774 kref_get(&nvmf_default_host->ref); 775 opts->host = nvmf_default_host; 776 } 777 778 uuid_copy(&opts->host->id, &hostid); 779 780 out: 781 kfree(options); 782 return ret; 783 } 784 785 static int nvmf_check_required_opts(struct nvmf_ctrl_options *opts, 786 unsigned int required_opts) 787 { 788 if ((opts->mask & required_opts) != required_opts) { 789 int i; 790 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); 796 } 797 } 798 799 return -EINVAL; 800 } 801 802 return 0; 803 } 804 805 static int nvmf_check_allowed_opts(struct nvmf_ctrl_options *opts, 806 unsigned int allowed_opts) 807 { 808 if (opts->mask & ~allowed_opts) { 809 int i; 810 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); 816 } 817 } 818 819 return -EINVAL; 820 } 821 822 return 0; 823 } 824 825 void nvmf_free_options(struct nvmf_ctrl_options *opts) 826 { 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); 834 } 835 EXPORT_SYMBOL_GPL(nvmf_free_options); 836 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) 841 842 static struct nvme_ctrl * 843 nvmf_create_ctrl(struct device *dev, const char *buf, size_t count) 844 { 845 struct nvmf_ctrl_options *opts; 846 struct nvmf_transport_ops *ops; 847 struct nvme_ctrl *ctrl; 848 int ret; 849 850 opts = kzalloc(sizeof(*opts), GFP_KERNEL); 851 if (!opts) 852 return ERR_PTR(-ENOMEM); 853 854 ret = nvmf_parse_options(opts, buf); 855 if (ret) 856 goto out_free_opts; 857 858 859 request_module("nvme-%s", opts->transport); 860 861 /* 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. 865 */ 866 ret = nvmf_check_required_opts(opts, NVMF_REQUIRED_OPTS); 867 if (ret) 868 goto out_free_opts; 869 opts->mask &= ~NVMF_REQUIRED_OPTS; 870 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; 878 } 879 880 if (!try_module_get(ops->module)) { 881 ret = -EBUSY; 882 goto out_unlock; 883 } 884 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; 892 893 ctrl = ops->create_ctrl(dev, opts); 894 if (IS_ERR(ctrl)) { 895 ret = PTR_ERR(ctrl); 896 goto out_module_put; 897 } 898 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); 907 } 908 909 module_put(ops->module); 910 up_read(&nvmf_transports_rwsem); 911 return ctrl; 912 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); 920 } 921 922 static struct class *nvmf_class; 923 static struct device *nvmf_device; 924 static DEFINE_MUTEX(nvmf_dev_mutex); 925 926 static ssize_t nvmf_dev_write(struct file *file, const char __user *ubuf, 927 size_t count, loff_t *pos) 928 { 929 struct seq_file *seq_file = file->private_data; 930 struct nvme_ctrl *ctrl; 931 const char *buf; 932 int ret = 0; 933 934 if (count > PAGE_SIZE) 935 return -ENOMEM; 936 937 buf = memdup_user_nul(ubuf, count); 938 if (IS_ERR(buf)) 939 return PTR_ERR(buf); 940 941 mutex_lock(&nvmf_dev_mutex); 942 if (seq_file->private) { 943 ret = -EINVAL; 944 goto out_unlock; 945 } 946 947 ctrl = nvmf_create_ctrl(nvmf_device, buf, count); 948 if (IS_ERR(ctrl)) { 949 ret = PTR_ERR(ctrl); 950 goto out_unlock; 951 } 952 953 seq_file->private = ctrl; 954 955 out_unlock: 956 mutex_unlock(&nvmf_dev_mutex); 957 kfree(buf); 958 return ret ? ret : count; 959 } 960 961 static int nvmf_dev_show(struct seq_file *seq_file, void *private) 962 { 963 struct nvme_ctrl *ctrl; 964 int ret = 0; 965 966 mutex_lock(&nvmf_dev_mutex); 967 ctrl = seq_file->private; 968 if (!ctrl) { 969 ret = -EINVAL; 970 goto out_unlock; 971 } 972 973 seq_printf(seq_file, "instance=%d,cntlid=%d\n", 974 ctrl->instance, ctrl->cntlid); 975 976 out_unlock: 977 mutex_unlock(&nvmf_dev_mutex); 978 return ret; 979 } 980 981 static int nvmf_dev_open(struct inode *inode, struct file *file) 982 { 983 /* 984 * The miscdevice code initializes file->private_data, but doesn't 985 * make use of it later. 986 */ 987 file->private_data = NULL; 988 return single_open(file, nvmf_dev_show, NULL); 989 } 990 991 static int nvmf_dev_release(struct inode *inode, struct file *file) 992 { 993 struct seq_file *seq_file = file->private_data; 994 struct nvme_ctrl *ctrl = seq_file->private; 995 996 if (ctrl) 997 nvme_put_ctrl(ctrl); 998 return single_release(inode, file); 999 } 1000 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, 1007 }; 1008 1009 static struct miscdevice nvmf_misc = { 1010 .minor = MISC_DYNAMIC_MINOR, 1011 .name = "nvme-fabrics", 1012 .fops = &nvmf_dev_fops, 1013 }; 1014 1015 static int __init nvmf_init(void) 1016 { 1017 int ret; 1018 1019 nvmf_default_host = nvmf_host_default(); 1020 if (!nvmf_default_host) 1021 return -ENOMEM; 1022 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; 1028 } 1029 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; 1036 } 1037 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; 1042 } 1043 1044 return 0; 1045 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; 1053 } 1054 1055 static void __exit nvmf_exit(void) 1056 { 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); 1061 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); 1066 } 1067 1068 MODULE_LICENSE("GPL v2"); 1069 1070 module_init(nvmf_init); 1071 module_exit(nvmf_exit); 1072