/*- * BSD LICENSE * * Copyright (c) Intel Corporation. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * Neither the name of Intel Corporation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include "spdk/stdinc.h" #include "nvmf_internal.h" #include "ctrlr.h" #include "subsystem.h" #include "transport.h" #include "spdk/likely.h" #include "spdk/string.h" #include "spdk/trace.h" #include "spdk/nvmf_spec.h" #include "spdk_internal/bdev.h" #include "spdk_internal/log.h" struct spdk_nvmf_subsystem * spdk_nvmf_find_subsystem(const char *subnqn) { struct spdk_nvmf_subsystem *subsystem; if (!subnqn) { return NULL; } TAILQ_FOREACH(subsystem, &g_nvmf_tgt.subsystems, entries) { if (strcmp(subnqn, subsystem->subnqn) == 0) { return subsystem; } } return NULL; } struct spdk_nvmf_subsystem * spdk_nvmf_find_subsystem_with_cntlid(uint16_t cntlid) { struct spdk_nvmf_subsystem *subsystem; struct spdk_nvmf_ctrlr *ctrlr; TAILQ_FOREACH(subsystem, &g_nvmf_tgt.subsystems, entries) { TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { if (ctrlr->cntlid == cntlid) { return subsystem; } } } return NULL; } int spdk_nvmf_subsystem_start(struct spdk_nvmf_subsystem *subsystem) { return spdk_nvmf_subsystem_bdev_attach(subsystem); } static bool nvmf_subsystem_removable(struct spdk_nvmf_subsystem *subsystem) { struct spdk_nvmf_ctrlr *ctrlr; struct spdk_nvmf_qpair *qpair; if (subsystem->is_removed) { TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { TAILQ_FOREACH(qpair, &ctrlr->qpairs, link) { if (!spdk_nvmf_transport_qpair_is_idle(qpair)) { return false; } } } return true; } return false; } void spdk_nvmf_subsystem_poll(struct spdk_nvmf_subsystem *subsystem) { struct spdk_nvmf_ctrlr *ctrlr; TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { /* For each connection in the ctrlr, check for completions */ spdk_nvmf_ctrlr_poll(ctrlr); } if (nvmf_subsystem_removable(subsystem)) { spdk_nvmf_subsystem_bdev_detach(subsystem); } } static bool spdk_nvmf_valid_nqn(const char *nqn) { size_t len; len = strlen(nqn); if (len > SPDK_NVMF_NQN_MAX_LEN) { SPDK_ERRLOG("Invalid NQN \"%s\": length %zu > max %d\n", nqn, len, SPDK_NVMF_NQN_MAX_LEN); return false; } if (strncmp(nqn, "nqn.", 4) != 0) { SPDK_ERRLOG("Invalid NQN \"%s\": NQN must begin with \"nqn.\".\n", nqn); return false; } /* yyyy-mm. */ if (!(isdigit(nqn[4]) && isdigit(nqn[5]) && isdigit(nqn[6]) && isdigit(nqn[7]) && nqn[8] == '-' && isdigit(nqn[9]) && isdigit(nqn[10]) && nqn[11] == '.')) { SPDK_ERRLOG("Invalid date code in NQN \"%s\"\n", nqn); return false; } return true; } struct spdk_nvmf_subsystem * spdk_nvmf_create_subsystem(const char *nqn, enum spdk_nvmf_subtype type, void *cb_ctx, spdk_nvmf_subsystem_connect_fn connect_cb, spdk_nvmf_subsystem_disconnect_fn disconnect_cb) { struct spdk_nvmf_subsystem *subsystem; if (!spdk_nvmf_valid_nqn(nqn)) { return NULL; } subsystem = calloc(1, sizeof(struct spdk_nvmf_subsystem)); if (subsystem == NULL) { return NULL; } g_nvmf_tgt.current_subsystem_id++; subsystem->id = g_nvmf_tgt.current_subsystem_id; subsystem->subtype = type; subsystem->cb_ctx = cb_ctx; subsystem->connect_cb = connect_cb; subsystem->disconnect_cb = disconnect_cb; snprintf(subsystem->subnqn, sizeof(subsystem->subnqn), "%s", nqn); TAILQ_INIT(&subsystem->listeners); TAILQ_INIT(&subsystem->hosts); TAILQ_INIT(&subsystem->ctrlrs); TAILQ_INSERT_TAIL(&g_nvmf_tgt.subsystems, subsystem, entries); g_nvmf_tgt.discovery_genctr++; return subsystem; } void spdk_nvmf_delete_subsystem(struct spdk_nvmf_subsystem *subsystem) { struct spdk_nvmf_listener *listener, *listener_tmp; struct spdk_nvmf_host *host, *host_tmp; struct spdk_nvmf_ctrlr *ctrlr, *ctrlr_tmp; if (!subsystem) { return; } SPDK_TRACELOG(SPDK_TRACE_NVMF, "subsystem is %p\n", subsystem); TAILQ_FOREACH_SAFE(listener, &subsystem->listeners, link, listener_tmp) { TAILQ_REMOVE(&subsystem->listeners, listener, link); free(listener); } TAILQ_FOREACH_SAFE(host, &subsystem->hosts, link, host_tmp) { TAILQ_REMOVE(&subsystem->hosts, host, link); free(host->nqn); free(host); } TAILQ_FOREACH_SAFE(ctrlr, &subsystem->ctrlrs, link, ctrlr_tmp) { spdk_nvmf_ctrlr_destruct(ctrlr); } spdk_nvmf_subsystem_bdev_detach(subsystem); TAILQ_REMOVE(&g_nvmf_tgt.subsystems, subsystem, entries); g_nvmf_tgt.discovery_genctr++; free(subsystem); } int spdk_nvmf_subsystem_add_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn) { struct spdk_nvmf_host *host; if (!spdk_nvmf_valid_nqn(hostnqn)) { return -1; } host = calloc(1, sizeof(*host)); if (!host) { return -1; } host->nqn = strdup(hostnqn); if (!host->nqn) { free(host); return -1; } TAILQ_INSERT_HEAD(&subsystem->hosts, host, link); g_nvmf_tgt.discovery_genctr++; return 0; } bool spdk_nvmf_subsystem_host_allowed(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn) { struct spdk_nvmf_host *host; if (!hostnqn) { return false; } if (TAILQ_EMPTY(&subsystem->hosts)) { /* No hosts means any host can connect */ return true; } TAILQ_FOREACH(host, &subsystem->hosts, link) { if (strcmp(hostnqn, host->nqn) == 0) { return true; } } return false; } struct spdk_nvmf_host * spdk_nvmf_subsystem_get_first_host(struct spdk_nvmf_subsystem *subsystem) { return TAILQ_FIRST(&subsystem->hosts); } struct spdk_nvmf_host * spdk_nvmf_subsystem_get_next_host(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_host *prev_host) { return TAILQ_NEXT(prev_host, link); } const char * spdk_nvmf_host_get_nqn(struct spdk_nvmf_host *host) { return host->nqn; } struct spdk_nvmf_listen_addr * spdk_nvmf_tgt_listen(struct spdk_nvme_transport_id *trid) { struct spdk_nvmf_listen_addr *listen_addr; struct spdk_nvmf_transport *transport; int rc; TAILQ_FOREACH(listen_addr, &g_nvmf_tgt.listen_addrs, link) { if (spdk_nvme_transport_id_compare(&listen_addr->trid, trid) == 0) { return listen_addr; } } transport = spdk_nvmf_tgt_get_transport(&g_nvmf_tgt, trid->trtype); if (!transport) { transport = spdk_nvmf_transport_create(&g_nvmf_tgt, trid->trtype); if (!transport) { SPDK_ERRLOG("Transport initialization failed\n"); return NULL; } TAILQ_INSERT_TAIL(&g_nvmf_tgt.transports, transport, link); } listen_addr = spdk_nvmf_listen_addr_create(trid); if (!listen_addr) { return NULL; } rc = spdk_nvmf_transport_listen(transport, trid); if (rc < 0) { free(listen_addr); SPDK_ERRLOG("Unable to listen on address '%s'\n", trid->traddr); return NULL; } TAILQ_INSERT_HEAD(&g_nvmf_tgt.listen_addrs, listen_addr, link); g_nvmf_tgt.discovery_genctr++; return listen_addr; } int spdk_nvmf_subsystem_add_listener(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_listen_addr *listen_addr) { struct spdk_nvmf_listener *listener; listener = calloc(1, sizeof(*listener)); if (!listener) { return -1; } listener->listen_addr = listen_addr; TAILQ_INSERT_HEAD(&subsystem->listeners, listener, link); return 0; } /* * TODO: this is the whitelist and will be called during connection setup */ bool spdk_nvmf_subsystem_listener_allowed(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_listen_addr *listen_addr) { struct spdk_nvmf_listener *listener; if (TAILQ_EMPTY(&subsystem->listeners)) { return true; } TAILQ_FOREACH(listener, &subsystem->listeners, link) { if (listener->listen_addr == listen_addr) { return true; } } return false; } struct spdk_nvmf_listener * spdk_nvmf_subsystem_get_first_listener(struct spdk_nvmf_subsystem *subsystem) { return TAILQ_FIRST(&subsystem->listeners); } struct spdk_nvmf_listener * spdk_nvmf_subsystem_get_next_listener(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_listener *prev_listener) { return TAILQ_NEXT(prev_listener, link); } const struct spdk_nvme_transport_id * spdk_nvmf_listener_get_trid(struct spdk_nvmf_listener *listener) { return &listener->listen_addr->trid; } static void spdk_nvmf_ctrlr_hot_remove(void *remove_ctx) { struct spdk_nvmf_subsystem *subsystem = (struct spdk_nvmf_subsystem *)remove_ctx; subsystem->is_removed = true; } uint32_t spdk_nvmf_subsystem_add_ns(struct spdk_nvmf_subsystem *subsystem, struct spdk_bdev *bdev, uint32_t nsid) { struct spdk_nvmf_ns *ns; uint32_t i; int rc; if (nsid == 0) { /* NSID not specified - find a free index */ for (i = 0; i < MAX_VIRTUAL_NAMESPACE; i++) { if (_spdk_nvmf_subsystem_get_ns(subsystem, i + 1) == NULL) { nsid = i + 1; break; } } if (nsid == 0) { SPDK_ERRLOG("All available NSIDs in use\n"); return 0; } } else { /* Specific NSID requested */ i = nsid - 1; if (i >= MAX_VIRTUAL_NAMESPACE) { SPDK_ERRLOG("Requested NSID %" PRIu32 " out of range\n", nsid); return 0; } if (_spdk_nvmf_subsystem_get_ns(subsystem, nsid)) { SPDK_ERRLOG("Requested NSID %" PRIu32 " already in use\n", nsid); return 0; } } ns = &subsystem->ns[i]; memset(ns, 0, sizeof(*ns)); ns->bdev = bdev; ns->id = nsid; rc = spdk_bdev_open(bdev, true, spdk_nvmf_ctrlr_hot_remove, subsystem, &ns->desc); if (rc != 0) { SPDK_ERRLOG("Subsystem %s: bdev %s cannot be opened, error=%d\n", subsystem->subnqn, spdk_bdev_get_name(bdev), rc); return 0; } ns->allocated = true; SPDK_TRACELOG(SPDK_TRACE_NVMF, "Subsystem %s: bdev %s assigned nsid %" PRIu32 "\n", spdk_nvmf_subsystem_get_nqn(subsystem), spdk_bdev_get_name(bdev), nsid); subsystem->max_nsid = spdk_max(subsystem->max_nsid, nsid); return nsid; } static uint32_t spdk_nvmf_subsystem_get_next_allocated_nsid(struct spdk_nvmf_subsystem *subsystem, uint32_t prev_nsid) { uint32_t nsid; if (prev_nsid >= subsystem->max_nsid) { return 0; } for (nsid = prev_nsid + 1; nsid <= subsystem->max_nsid; nsid++) { if (subsystem->ns[nsid - 1].allocated) { return nsid; } } return 0; } struct spdk_nvmf_ns * spdk_nvmf_subsystem_get_first_ns(struct spdk_nvmf_subsystem *subsystem) { uint32_t first_nsid; first_nsid = spdk_nvmf_subsystem_get_next_allocated_nsid(subsystem, 0); return _spdk_nvmf_subsystem_get_ns(subsystem, first_nsid); } struct spdk_nvmf_ns * spdk_nvmf_subsystem_get_next_ns(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ns *prev_ns) { uint32_t next_nsid; next_nsid = spdk_nvmf_subsystem_get_next_allocated_nsid(subsystem, prev_ns->id); return _spdk_nvmf_subsystem_get_ns(subsystem, next_nsid); } struct spdk_nvmf_ns * spdk_nvmf_subsystem_get_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid) { return _spdk_nvmf_subsystem_get_ns(subsystem, nsid); } uint32_t spdk_nvmf_ns_get_id(const struct spdk_nvmf_ns *ns) { return ns->id; } struct spdk_bdev * spdk_nvmf_ns_get_bdev(struct spdk_nvmf_ns *ns) { return ns->bdev; } const char * spdk_nvmf_subsystem_get_sn(const struct spdk_nvmf_subsystem *subsystem) { return subsystem->sn; } int spdk_nvmf_subsystem_set_sn(struct spdk_nvmf_subsystem *subsystem, const char *sn) { size_t len, max_len; max_len = sizeof(subsystem->sn) - 1; len = strlen(sn); if (len > max_len) { SPDK_TRACELOG(SPDK_TRACE_NVMF, "Invalid sn \"%s\": length %zu > max %zu\n", sn, len, max_len); return -1; } snprintf(subsystem->sn, sizeof(subsystem->sn), "%s", sn); return 0; } const char * spdk_nvmf_subsystem_get_nqn(struct spdk_nvmf_subsystem *subsystem) { return subsystem->subnqn; } /* Workaround for astyle formatting bug */ typedef enum spdk_nvmf_subtype nvmf_subtype_t; nvmf_subtype_t spdk_nvmf_subsystem_get_type(struct spdk_nvmf_subsystem *subsystem) { return subsystem->subtype; }