// SPDX-License-Identifier: LGPL-2.1-or-later /* * This file is part of libnvme. * Copyright (c) 2020 Western Digital Corporation or its affiliates. * * Authors: Keith Busch * Chaitanya Kulkarni */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "ioctl.h" #include "linux.h" #include "filters.h" #include "tree.h" #include "filters.h" #include "util.h" #include "fabrics.h" #include "log.h" #include "private.h" static struct nvme_host *default_host; static void __nvme_free_host(nvme_host_t h); static void __nvme_free_ctrl(nvme_ctrl_t c); static int nvme_subsystem_scan_namespace(nvme_root_t r, struct nvme_subsystem *s, char *name, nvme_scan_filter_t f, void *f_args); static int nvme_init_subsystem(nvme_subsystem_t s, const char *name); static int nvme_scan_subsystem(nvme_root_t r, const char *name, nvme_scan_filter_t f, void *f_args); static int nvme_ctrl_scan_namespace(nvme_root_t r, struct nvme_ctrl *c, char *name); static int nvme_ctrl_scan_path(nvme_root_t r, struct nvme_ctrl *c, char *name); static inline void nvme_free_dirents(struct dirent **d, int i) { while (i-- > 0) free(d[i]); free(d); } nvme_host_t nvme_default_host(nvme_root_t r) { struct nvme_host *h; char *hostnqn, *hostid; hostnqn = nvmf_hostnqn_from_file(); if (!hostnqn) hostnqn = nvmf_hostnqn_generate(); hostid = nvmf_hostid_from_file(); h = nvme_lookup_host(r, hostnqn, hostid); nvme_host_set_hostsymname(h, NULL); default_host = h; free(hostnqn); if (hostid) free(hostid); return h; } int nvme_scan_topology(struct nvme_root *r, nvme_scan_filter_t f, void *f_args) { struct dirent **subsys, **ctrls; int i, num_subsys, num_ctrls, ret; if (!r) return 0; num_ctrls = nvme_scan_ctrls(&ctrls); if (num_ctrls < 0) { nvme_msg(r, LOG_DEBUG, "failed to scan ctrls: %s\n", strerror(errno)); return num_ctrls; } for (i = 0; i < num_ctrls; i++) { nvme_ctrl_t c = nvme_scan_ctrl(r, ctrls[i]->d_name); if (!c) { nvme_msg(r, LOG_DEBUG, "failed to scan ctrl %s: %s\n", ctrls[i]->d_name, strerror(errno)); continue; } if ((f) && !f(NULL, c, NULL, f_args)) { nvme_msg(r, LOG_DEBUG, "filter out controller %s\n", ctrls[i]->d_name); nvme_free_ctrl(c); } } nvme_free_dirents(ctrls, i); num_subsys = nvme_scan_subsystems(&subsys); if (num_subsys < 0) { nvme_msg(r, LOG_DEBUG, "failed to scan subsystems: %s\n", strerror(errno)); return num_subsys; } for (i = 0; i < num_subsys; i++) { ret = nvme_scan_subsystem(r, subsys[i]->d_name, f, f_args); if (ret < 0) { nvme_msg(r, LOG_DEBUG, "failed to scan subsystem %s: %s\n", subsys[i]->d_name, strerror(errno)); } } nvme_free_dirents(subsys, i); return 0; } nvme_root_t nvme_create_root(FILE *fp, int log_level) { struct nvme_root *r = calloc(1, sizeof(*r)); if (!r) { errno = ENOMEM; return NULL; } r->log_level = log_level; r->fp = stderr; if (fp) r->fp = fp; list_head_init(&r->hosts); return r; } int nvme_read_config(nvme_root_t r, const char *config_file) { int err = -1; if (!r || !config_file) { errno = ENODEV; return err; } r->config_file = strdup(config_file); if (!r->config_file) { errno = ENOMEM; return err; } err = json_read_config(r, config_file); /* * The json configuration file is optional, * so ignore errors when opening the file. */ if (err < 0 && errno != EPROTO) err = 0; return err; } nvme_root_t nvme_scan(const char *config_file) { nvme_root_t r = nvme_create_root(NULL, DEFAULT_LOGLEVEL); nvme_scan_topology(r, NULL, NULL); nvme_read_config(r, config_file); return r; } int nvme_update_config(nvme_root_t r) { if (!r->modified || !r->config_file) return 0; return json_update_config(r, r->config_file); } int nvme_dump_config(nvme_root_t r) { return json_update_config(r, NULL); } int nvme_dump_tree(nvme_root_t r) { return json_dump_tree(r); } nvme_host_t nvme_first_host(nvme_root_t r) { return list_top(&r->hosts, struct nvme_host, entry); } nvme_host_t nvme_next_host(nvme_root_t r, nvme_host_t h) { return h ? list_next(&r->hosts, h, entry) : NULL; } nvme_root_t nvme_host_get_root(nvme_host_t h) { return h->r; } const char *nvme_host_get_hostnqn(nvme_host_t h) { return h->hostnqn; } const char *nvme_host_get_hostid(nvme_host_t h) { return h->hostid; } const char *nvme_host_get_hostsymname(nvme_host_t h) { return h->hostsymname; } void nvme_host_set_hostsymname(nvme_host_t h, const char *hostsymname) { if (h->hostsymname) { free(h->hostsymname); h->hostsymname = NULL; } if (hostsymname) h->hostsymname = strdup(hostsymname); } const char *nvme_host_get_dhchap_key(nvme_host_t h) { return h->dhchap_key; } void nvme_host_set_dhchap_key(nvme_host_t h, const char *key) { if (h->dhchap_key) { free(h->dhchap_key); h->dhchap_key = NULL; } if (key) h->dhchap_key = strdup(key); } nvme_subsystem_t nvme_first_subsystem(nvme_host_t h) { return list_top(&h->subsystems, struct nvme_subsystem, entry); } nvme_subsystem_t nvme_next_subsystem(nvme_host_t h, nvme_subsystem_t s) { return s ? list_next(&h->subsystems, s, entry) : NULL; } void nvme_refresh_topology(nvme_root_t r) { struct nvme_host *h, *_h; nvme_for_each_host_safe(r, h, _h) __nvme_free_host(h); nvme_scan_topology(r, NULL, NULL); } void nvme_free_tree(nvme_root_t r) { struct nvme_host *h, *_h; nvme_for_each_host_safe(r, h, _h) __nvme_free_host(h); if (r->config_file) free(r->config_file); free(r); } const char *nvme_subsystem_get_nqn(nvme_subsystem_t s) { return s->subsysnqn; } const char *nvme_subsystem_get_sysfs_dir(nvme_subsystem_t s) { return s->sysfs_dir; } const char *nvme_subsystem_get_name(nvme_subsystem_t s) { return s->name; } const char *nvme_subsystem_get_type(nvme_subsystem_t s) { return s->subsystype; } nvme_ctrl_t nvme_subsystem_first_ctrl(nvme_subsystem_t s) { return list_top(&s->ctrls, struct nvme_ctrl, entry); } nvme_ctrl_t nvme_subsystem_next_ctrl(nvme_subsystem_t s, nvme_ctrl_t c) { return c ? list_next(&s->ctrls, c, entry) : NULL; } nvme_host_t nvme_subsystem_get_host(nvme_subsystem_t s) { return s->h; } nvme_ns_t nvme_subsystem_first_ns(nvme_subsystem_t s) { return list_top(&s->namespaces, struct nvme_ns, entry); } nvme_ns_t nvme_subsystem_next_ns(nvme_subsystem_t s, nvme_ns_t n) { return n ? list_next(&s->namespaces, n, entry) : NULL; } nvme_path_t nvme_namespace_first_path(nvme_ns_t ns) { return list_top(&ns->paths, struct nvme_path, nentry); } nvme_path_t nvme_namespace_next_path(nvme_ns_t ns, nvme_path_t p) { return p ? list_next(&ns->paths, p, nentry) : NULL; } static void __nvme_free_ns(struct nvme_ns *n) { list_del_init(&n->entry); close(n->fd); free(n->generic_name); free(n->name); free(n->sysfs_dir); free(n); } /* Stub for SWIG */ void nvme_free_ns(struct nvme_ns *n) { } static void __nvme_free_subsystem(struct nvme_subsystem *s) { struct nvme_ctrl *c, *_c; struct nvme_ns *n, *_n; list_del_init(&s->entry); nvme_subsystem_for_each_ctrl_safe(s, c, _c) __nvme_free_ctrl(c); nvme_subsystem_for_each_ns_safe(s, n, _n) __nvme_free_ns(n); if (s->name) free(s->name); free(s->sysfs_dir); free(s->subsysnqn); if (s->model) free(s->model); if (s->serial) free(s->serial); if (s->firmware) free(s->firmware); if (s->subsystype) free(s->subsystype); free(s); } /* * Stub for SWIG */ void nvme_free_subsystem(nvme_subsystem_t s) { } struct nvme_subsystem *nvme_alloc_subsystem(struct nvme_host *h, const char *name, const char *subsysnqn) { struct nvme_subsystem *s; s = calloc(1, sizeof(*s)); if (!s) return NULL; s->h = h; s->subsysnqn = strdup(subsysnqn); if (name) nvme_init_subsystem(s, name); list_head_init(&s->ctrls); list_head_init(&s->namespaces); list_node_init(&s->entry); list_add(&h->subsystems, &s->entry); h->r->modified = true; return s; } struct nvme_subsystem *nvme_lookup_subsystem(struct nvme_host *h, const char *name, const char *subsysnqn) { struct nvme_subsystem *s; nvme_for_each_subsystem(h, s) { if (strcmp(s->subsysnqn, subsysnqn)) continue; if (name && s->name && strcmp(s->name, name)) continue; return s; } return nvme_alloc_subsystem(h, name, subsysnqn); } static void __nvme_free_host(struct nvme_host *h) { struct nvme_subsystem *s, *_s; list_del_init(&h->entry); nvme_for_each_subsystem_safe(h, s, _s) __nvme_free_subsystem(s); free(h->hostnqn); if (h->hostid) free(h->hostid); if (h->dhchap_key) free(h->dhchap_key); nvme_host_set_hostsymname(h, NULL); h->r->modified = true; free(h); } /* Stub for SWIG */ void nvme_free_host(struct nvme_host *h) { } struct nvme_host *nvme_lookup_host(nvme_root_t r, const char *hostnqn, const char *hostid) { struct nvme_host *h; if (!hostnqn) return NULL; nvme_for_each_host(r, h) { if (strcmp(h->hostnqn, hostnqn)) continue; if (hostid && (!h->hostid || strcmp(h->hostid, hostid))) continue; return h; } h = calloc(1,sizeof(*h)); if (!h) return NULL; h->hostnqn = strdup(hostnqn); if (hostid) h->hostid = strdup(hostid); list_head_init(&h->subsystems); list_node_init(&h->entry); h->r = r; list_add(&r->hosts, &h->entry); r->modified = true; return h; } static int nvme_subsystem_scan_namespaces(nvme_root_t r, nvme_subsystem_t s, nvme_scan_filter_t f, void *f_args) { struct dirent **namespaces; int i, num_ns, ret; num_ns = nvme_scan_subsystem_namespaces(s, &namespaces); if (num_ns < 0) { nvme_msg(r, LOG_DEBUG, "failed to scan namespaces for subsys %s: %s\n", s->subsysnqn, strerror(errno)); return num_ns; } for (i = 0; i < num_ns; i++) { ret = nvme_subsystem_scan_namespace(r, s, namespaces[i]->d_name, f, f_args); if (ret < 0) nvme_msg(r, LOG_DEBUG, "failed to scan namespace %s: %s\n", namespaces[i]->d_name, strerror(errno)); } nvme_free_dirents(namespaces, i); return 0; } static int nvme_init_subsystem(nvme_subsystem_t s, const char *name) { char *path; if (asprintf(&path, "%s/%s", nvme_subsys_sysfs_dir, name) < 0) return -1; s->model = nvme_get_attr(path, "model"); if (!s->model) s->model = strdup("undefined"); s->serial = nvme_get_attr(path, "serial"); s->firmware = nvme_get_attr(path, "firmware_rev"); s->subsystype = nvme_get_attr(path, "subsystype"); if (!s->subsystype) { if (!strcmp(s->subsysnqn, NVME_DISC_SUBSYS_NAME)) s->subsystype = strdup("discovery"); else s->subsystype = strdup("nvm"); } s->name = strdup(name); s->sysfs_dir = (char *)path; return 0; } static int nvme_scan_subsystem(struct nvme_root *r, const char *name, nvme_scan_filter_t f, void *f_args) { struct nvme_subsystem *s = NULL, *_s; char *path, *subsysnqn; nvme_host_t h = NULL; int ret; nvme_msg(r, LOG_DEBUG, "scan subsystem %s\n", name); ret = asprintf(&path, "%s/%s", nvme_subsys_sysfs_dir, name); if (ret < 0) return ret; subsysnqn = nvme_get_attr(path, "subsysnqn"); free(path); if (!subsysnqn) { errno = ENODEV; return -1; } nvme_for_each_host(r, h) { nvme_for_each_subsystem(h, _s) { /* * We are always called after nvme_scan_ctrl(), * so any subsystem we're interested at _must_ * have a name. */ if (!_s->name) continue; if (strcmp(_s->name, name)) continue; s = _s; } } if (!s) { /* * Subsystem with non-matching controller. odd. * Create a subsystem with the default host * and hope for the best. */ nvme_msg(r, LOG_DEBUG, "creating detached subsystem '%s'\n", name); h = nvme_default_host(r); s = nvme_alloc_subsystem(h, name, subsysnqn); if (!s) { errno = ENOMEM; } } else if (strcmp(s->subsysnqn, subsysnqn)) { nvme_msg(r, LOG_WARNING, "NQN mismatch for subsystem '%s'\n", name); s = NULL; errno = EINVAL; return -1; } free(subsysnqn); if (!s) return -1; if (f && !f(s, NULL, NULL, f_args)) { nvme_msg(r, LOG_DEBUG, "filter out subsystem %s\n", name); __nvme_free_subsystem(s); return 0; } nvme_subsystem_scan_namespaces(r, s, f, f_args); return 0; } nvme_ctrl_t nvme_path_get_ctrl(nvme_path_t p) { return p->c; } nvme_ns_t nvme_path_get_ns(nvme_path_t p) { return p->n; } const char *nvme_path_get_sysfs_dir(nvme_path_t p) { return p->sysfs_dir; } const char *nvme_path_get_name(nvme_path_t p) { return p->name; } const char *nvme_path_get_ana_state(nvme_path_t p) { return p->ana_state; } void nvme_free_path(struct nvme_path *p) { list_del_init(&p->entry); list_del_init(&p->nentry); free(p->name); free(p->sysfs_dir); free(p->ana_state); free(p); } static void nvme_subsystem_set_path_ns(nvme_subsystem_t s, nvme_path_t p) { char n_name[32] = { }; int i, c, nsid, ret; nvme_ns_t n; ret = sscanf(nvme_path_get_name(p), "nvme%dc%dn%d", &i, &c, &nsid); if (ret != 3) return; sprintf(n_name, "nvme%dn%d", i, nsid); nvme_subsystem_for_each_ns(s, n) { if (!strcmp(n_name, nvme_ns_get_name(n))) { list_add(&n->paths, &p->nentry); p->n = n; } } } static int nvme_ctrl_scan_path(nvme_root_t r, struct nvme_ctrl *c, char *name) { struct nvme_path *p; char *path, *grpid; int ret; nvme_msg(r, LOG_DEBUG, "scan controller %s path %s\n", c->name, name); if (!c->s) { errno = ENXIO; return -1; } ret = asprintf(&path, "%s/%s", c->sysfs_dir, name); if (ret < 0) { errno = ENOMEM; return -1; } p = calloc(1, sizeof(*p)); if (!p) { errno = ENOMEM; goto free_path; } p->c = c; p->name = strdup(name); p->sysfs_dir = path; p->ana_state = nvme_get_path_attr(p, "ana_state"); if (!p->ana_state) p->ana_state = strdup("optimized"); grpid = nvme_get_path_attr(p, "ana_grpid"); if (grpid) { sscanf(grpid, "%d", &p->grpid); free(grpid); } list_node_init(&p->nentry); nvme_subsystem_set_path_ns(c->s, p); list_node_init(&p->entry); list_add(&c->paths, &p->entry); return 0; free_path: free(path); return -1; } int nvme_ctrl_get_fd(nvme_ctrl_t c) { nvme_root_t r = c->s && c->s->h ? c->s->h->r : NULL; if (c->fd < 0) { c->fd = nvme_open(c->name); if (c->fd < 0) nvme_msg(r, LOG_ERR, "Failed to open ctrl %s, errno %d\n", c->name, errno); } return c->fd; } nvme_subsystem_t nvme_ctrl_get_subsystem(nvme_ctrl_t c) { return c->s; } const char *nvme_ctrl_get_name(nvme_ctrl_t c) { return c->name; } const char *nvme_ctrl_get_sysfs_dir(nvme_ctrl_t c) { return c->sysfs_dir; } const char *nvme_ctrl_get_subsysnqn(nvme_ctrl_t c) { return c->s ? c->s->subsysnqn : c->subsysnqn; } const char *nvme_ctrl_get_address(nvme_ctrl_t c) { return c->address ? c->address : ""; } const char *nvme_ctrl_get_firmware(nvme_ctrl_t c) { return c->firmware; } const char *nvme_ctrl_get_model(nvme_ctrl_t c) { return c->model; } const char *nvme_ctrl_get_state(nvme_ctrl_t c) { char *state = c->state; c->state = nvme_get_ctrl_attr(c, "state"); if (state) free(state); return c->state; } const char *nvme_ctrl_get_numa_node(nvme_ctrl_t c) { return c->numa_node; } const char *nvme_ctrl_get_queue_count(nvme_ctrl_t c) { return c->queue_count; } const char *nvme_ctrl_get_serial(nvme_ctrl_t c) { return c->serial; } const char *nvme_ctrl_get_sqsize(nvme_ctrl_t c) { return c->sqsize; } const char *nvme_ctrl_get_transport(nvme_ctrl_t c) { return c->transport; } const char *nvme_ctrl_get_traddr(nvme_ctrl_t c) { return c->traddr; } const char *nvme_ctrl_get_trsvcid(nvme_ctrl_t c) { return c->trsvcid; } const char *nvme_ctrl_get_host_traddr(nvme_ctrl_t c) { return c->cfg.host_traddr; } const char *nvme_ctrl_get_host_iface(nvme_ctrl_t c) { return c->cfg.host_iface; } struct nvme_fabrics_config *nvme_ctrl_get_config(nvme_ctrl_t c) { return &c->cfg; } const char *nvme_ctrl_get_dhchap_key(nvme_ctrl_t c) { return c->dhchap_key; } void nvme_ctrl_set_dhchap_key(nvme_ctrl_t c, const char *key) { if (c->dhchap_key) { free(c->dhchap_key); c->dhchap_key = NULL; } if (key) c->dhchap_key = strdup(key); } void nvme_ctrl_set_discovered(nvme_ctrl_t c, bool discovered) { c->discovered = discovered; } bool nvme_ctrl_is_discovered(nvme_ctrl_t c) { return c->discovered; } void nvme_ctrl_set_persistent(nvme_ctrl_t c, bool persistent) { c->persistent = persistent; } bool nvme_ctrl_is_persistent(nvme_ctrl_t c) { return c->persistent; } void nvme_ctrl_set_discovery_ctrl(nvme_ctrl_t c, bool discovery) { c->discovery_ctrl = discovery; } bool nvme_ctrl_is_discovery_ctrl(nvme_ctrl_t c) { return c->discovery_ctrl; } int nvme_ctrl_identify(nvme_ctrl_t c, struct nvme_id_ctrl *id) { return nvme_identify_ctrl(nvme_ctrl_get_fd(c), id); } nvme_ns_t nvme_ctrl_first_ns(nvme_ctrl_t c) { return list_top(&c->namespaces, struct nvme_ns, entry); } nvme_ns_t nvme_ctrl_next_ns(nvme_ctrl_t c, nvme_ns_t n) { return n ? list_next(&c->namespaces, n, entry) : NULL; } nvme_path_t nvme_ctrl_first_path(nvme_ctrl_t c) { return list_top(&c->paths, struct nvme_path, entry); } nvme_path_t nvme_ctrl_next_path(nvme_ctrl_t c, nvme_path_t p) { return p ? list_next(&c->paths, p, entry) : NULL; } #define FREE_CTRL_ATTR(a) \ do { if (a) { free(a); (a) = NULL; } } while (0) void nvme_deconfigure_ctrl(nvme_ctrl_t c) { if (c->fd >= 0) { close(c->fd); c->fd = -1; } FREE_CTRL_ATTR(c->name); FREE_CTRL_ATTR(c->sysfs_dir); FREE_CTRL_ATTR(c->firmware); FREE_CTRL_ATTR(c->model); FREE_CTRL_ATTR(c->state); FREE_CTRL_ATTR(c->numa_node); FREE_CTRL_ATTR(c->queue_count); FREE_CTRL_ATTR(c->serial); FREE_CTRL_ATTR(c->sqsize); FREE_CTRL_ATTR(c->address); FREE_CTRL_ATTR(c->dctype); FREE_CTRL_ATTR(c->cntrltype); } int nvme_disconnect_ctrl(nvme_ctrl_t c) { nvme_root_t r = c->s && c->s->h ? c->s->h->r : NULL; int ret; ret = nvme_set_attr(nvme_ctrl_get_sysfs_dir(c), "delete_controller", "1"); if (ret < 0) { nvme_msg(r, LOG_ERR, "%s: failed to disconnect, error %d\n", c->name, errno); return ret; } nvme_msg(r, LOG_INFO, "%s: disconnected\n", c->name); nvme_deconfigure_ctrl(c); return 0; } void nvme_unlink_ctrl(nvme_ctrl_t c) { list_del_init(&c->entry); c->s = NULL; } static void __nvme_free_ctrl(nvme_ctrl_t c) { struct nvme_path *p, *_p; struct nvme_ns *n, *_n; nvme_unlink_ctrl(c); nvme_ctrl_for_each_path_safe(c, p, _p) nvme_free_path(p); nvme_ctrl_for_each_ns_safe(c, n, _n) __nvme_free_ns(n); nvme_deconfigure_ctrl(c); FREE_CTRL_ATTR(c->transport); FREE_CTRL_ATTR(c->subsysnqn); FREE_CTRL_ATTR(c->traddr); FREE_CTRL_ATTR(c->cfg.host_traddr); FREE_CTRL_ATTR(c->cfg.host_iface); FREE_CTRL_ATTR(c->trsvcid); free(c); } void nvme_free_ctrl(nvme_ctrl_t c) { __nvme_free_ctrl(c); } static bool traddr_is_hostname(const char *transport, const char *traddr) { char addrstr[NVMF_TRADDR_SIZE]; if (!traddr || !transport) return false; if (strcmp(transport, "tcp") && strcmp(transport, "rdma")) return false; if (inet_pton(AF_INET, traddr, addrstr) > 0 || inet_pton(AF_INET6, traddr, addrstr) > 0) return false; return true; } struct nvme_ctrl *nvme_create_ctrl(nvme_root_t r, const char *subsysnqn, const char *transport, const char *traddr, const char *host_traddr, const char *host_iface, const char *trsvcid) { struct nvme_ctrl *c; if (!transport) { nvme_msg(r, LOG_ERR, "No transport specified\n"); errno = EINVAL; return NULL; } if (strncmp(transport, "loop", 4) && strncmp(transport, "pcie", 4) && !traddr) { nvme_msg(r, LOG_ERR, "No transport address for '%s'\n", transport); errno = EINVAL; return NULL; } if (!subsysnqn) { nvme_msg(r, LOG_ERR, "No subsystem NQN specified\n"); errno = EINVAL; return NULL; } c = calloc(1, sizeof(*c)); if (!c) { errno = ENOMEM; return NULL; } c->fd = -1; nvmf_default_config(&c->cfg); list_head_init(&c->namespaces); list_head_init(&c->paths); list_node_init(&c->entry); c->transport = strdup(transport); c->subsysnqn = strdup(subsysnqn); if (traddr) c->traddr = strdup(traddr); if (host_traddr) { if (traddr_is_hostname(transport, host_traddr)) c->cfg.host_traddr = hostname2traddr(r, host_traddr); if (!c->cfg.host_traddr) c->cfg.host_traddr = strdup(host_traddr); } if (host_iface) c->cfg.host_iface = strdup(host_iface); if (trsvcid) c->trsvcid = strdup(trsvcid); return c; } nvme_ctrl_t nvme_lookup_ctrl(nvme_subsystem_t s, const char *transport, const char *traddr, const char *host_traddr, const char *host_iface, const char *trsvcid, nvme_ctrl_t p) { nvme_root_t r; struct nvme_ctrl *c; if (!s || !transport) return NULL; r = s->h ? s->h->r : NULL; c = p ? nvme_subsystem_next_ctrl(s, p) : nvme_subsystem_first_ctrl(s); for (; c != NULL; c = nvme_subsystem_next_ctrl(s, c)) { if (strcmp(c->transport, transport)) continue; if (traddr && c->traddr && strcasecmp(c->traddr, traddr)) continue; if (host_traddr && c->cfg.host_traddr && strcmp(c->cfg.host_traddr, host_traddr)) continue; if (host_iface && c->cfg.host_iface && strcmp(c->cfg.host_iface, host_iface)) continue; if (trsvcid && c->trsvcid && strcmp(c->trsvcid, trsvcid)) continue; return c; } c = nvme_create_ctrl(r, s->subsysnqn, transport, traddr, host_traddr, host_iface, trsvcid); if (c) { c->s = s; list_add(&s->ctrls, &c->entry); s->h->r->modified = true; } return c; } static int nvme_ctrl_scan_paths(nvme_root_t r, struct nvme_ctrl *c) { struct dirent **paths; int i, ret; ret = nvme_scan_ctrl_namespace_paths(c, &paths); if (ret < 0) return ret; for (i = 0; i < ret; i++) nvme_ctrl_scan_path(r, c, paths[i]->d_name); nvme_free_dirents(paths, i); return 0; } static int nvme_ctrl_scan_namespaces(nvme_root_t r, struct nvme_ctrl *c) { struct dirent **namespaces; int i, ret; ret = nvme_scan_ctrl_namespaces(c, &namespaces); for (i = 0; i < ret; i++) nvme_ctrl_scan_namespace(r, c, namespaces[i]->d_name); nvme_free_dirents(namespaces, i); return 0; } static char *nvme_ctrl_lookup_subsystem_name(nvme_root_t r, const char *ctrl_name) { struct dirent **subsys; char *subsys_name = NULL; int ret, i; char path[PATH_MAX]; ret = nvme_scan_subsystems(&subsys); if (ret < 0) return NULL; for (i = 0; i < ret; i++) { struct stat st; sprintf(path, "%s/%s/%s", nvme_subsys_sysfs_dir, subsys[i]->d_name, ctrl_name); nvme_msg(r, LOG_DEBUG, "lookup subsystem %s\n", path); if (stat(path, &st) < 0) continue; subsys_name = strdup(subsys[i]->d_name); break; } nvme_free_dirents(subsys, ret); return subsys_name; } static int nvme_configure_ctrl(nvme_root_t r, nvme_ctrl_t c, const char *path, const char *name) { DIR *d; d = opendir(path); if (!d) { nvme_msg(r, LOG_ERR, "Failed to open ctrl dir %s, error %d\n", path, errno); errno = ENODEV; return -1; } closedir(d); c->fd = -1; c->name = strdup(name); c->sysfs_dir = (char *)path; c->firmware = nvme_get_ctrl_attr(c, "firmware_rev"); c->model = nvme_get_ctrl_attr(c, "model"); c->state = nvme_get_ctrl_attr(c, "state"); c->numa_node = nvme_get_ctrl_attr(c, "numa_node"); c->queue_count = nvme_get_ctrl_attr(c, "queue_count"); c->serial = nvme_get_ctrl_attr(c, "serial"); c->sqsize = nvme_get_ctrl_attr(c, "sqsize"); c->dhchap_key = nvme_get_ctrl_attr(c, "dhchap_ctrl_secret"); if (c->dhchap_key && !strcmp(c->dhchap_key, "none")) { free(c->dhchap_key); c->dhchap_key = NULL; } c->cntrltype = nvme_get_ctrl_attr(c, "cntrltype"); c->dctype = nvme_get_ctrl_attr(c, "dctype"); errno = 0; /* cleanup after nvme_get_ctrl_attr() */ return 0; } int nvme_init_ctrl(nvme_host_t h, nvme_ctrl_t c, int instance) { nvme_subsystem_t s; char *subsys_name = NULL; char *path, *name; int ret; ret = asprintf(&name, "nvme%d", instance); if (ret < 0) { errno = ENOMEM; return -1; } ret = asprintf(&path, "%s/nvme%d", nvme_ctrl_sysfs_dir, instance); if (ret < 0) { errno = ENOMEM; goto out_free_name; } ret = nvme_configure_ctrl(h->r, c, path, name); if (ret < 0) { free(path); goto out_free_name; } c->address = nvme_get_attr(path, "address"); if (!c->address && strcmp(c->transport, "loop")) { errno = ENVME_CONNECT_INVAL_TR; ret = -1; goto out_free_name; } subsys_name = nvme_ctrl_lookup_subsystem_name(h->r, name); if (!subsys_name) { nvme_msg(h->r, LOG_ERR, "Failed to lookup subsystem name for %s\n", c->name); errno = ENVME_CONNECT_LOOKUP_SUBSYS_NAME; ret = -1; goto out_free_name; } s = nvme_lookup_subsystem(h, subsys_name, c->subsysnqn); if (!s) { errno = ENVME_CONNECT_LOOKUP_SUBSYS; ret = -1; goto out_free_subsys; } if (s->subsystype && !strcmp(s->subsystype, "discovery")) c->discovery_ctrl = true; c->s = s; list_add(&s->ctrls, &c->entry); out_free_subsys: free(subsys_name); out_free_name: free(name); return ret; } static nvme_ctrl_t nvme_ctrl_alloc(nvme_root_t r, nvme_subsystem_t s, const char *path, const char *name) { nvme_ctrl_t c, p; char *addr = NULL, *address = NULL, *a, *e; char *transport, *traddr = NULL, *trsvcid = NULL; char *host_traddr = NULL, *host_iface = NULL; int ret; transport = nvme_get_attr(path, "transport"); if (!transport) { errno = ENXIO; return NULL; } /* Parse 'address' string into components */ addr = nvme_get_attr(path, "address"); if (!addr) { char *rpath = NULL, *p = NULL, *_a = NULL; /* loop transport might not have an address */ if (!strcmp(transport, "loop")) goto skip_address; /* Older kernel don't support pcie transport addresses */ if (strcmp(transport, "pcie")) { free(transport); errno = ENXIO; return NULL; } /* Figure out the PCI address from the attribute path */ rpath = realpath(path, NULL); if (!rpath) { free(transport); errno = ENOMEM; return NULL; } a = strtok_r(rpath, "/", &e); while(a && strlen(a)) { if (_a) p = _a; _a = a; if (!strncmp(a, "nvme", 4)) break; a = strtok_r(NULL, "/", &e); } if (p) addr = strdup(p); free(rpath); } else if (!strcmp(transport, "pcie")) { /* The 'address' string is the transport address */ traddr = addr; } else { address = strdup(addr); a = strtok_r(address, ",", &e); while (a && strlen(a)) { if (!strncmp(a, "traddr=", 7)) traddr = a + 7; else if (!strncmp(a, "trsvcid=", 8)) trsvcid = a + 8; else if (!strncmp(a, "host_traddr=", 12)) host_traddr = a + 12; else if (!strncmp(a, "host_iface=", 11)) host_iface = a + 11; a = strtok_r(NULL, ",", &e); } } skip_address: p = NULL; do { c = nvme_lookup_ctrl(s, transport, traddr, host_traddr, host_iface, trsvcid, p); if (c) { if (!c->name) break; if (!strcmp(c->name, name)) { nvme_msg(r, LOG_DEBUG, "found existing ctrl %s\n", c->name); break; } nvme_msg(r, LOG_DEBUG, "skipping ctrl %s\n", c->name); p = c; } } while (c); if (!c) c = p; free(transport); if (address) free(address); if (!c) { if (!p) { nvme_msg(r, LOG_ERR, "failed to lookup ctrl\n"); errno = ENODEV; } else errno = ENOMEM; return NULL; } c->address = addr; if (s->subsystype && !strcmp(s->subsystype, "discovery")) c->discovery_ctrl = true; ret = nvme_configure_ctrl(r, c, path, name); return (ret < 0) ? NULL : c; } nvme_ctrl_t nvme_scan_ctrl(nvme_root_t r, const char *name) { nvme_host_t h; nvme_subsystem_t s; nvme_ctrl_t c; char *path; char *hostnqn, *hostid, *subsysnqn, *subsysname; int ret; nvme_msg(r, LOG_DEBUG, "scan controller %s\n", name); ret = asprintf(&path, "%s/%s", nvme_ctrl_sysfs_dir, name); if (ret < 0) { errno = ENOMEM; return NULL; } hostnqn = nvme_get_attr(path, "hostnqn"); hostid = nvme_get_attr(path, "hostid"); h = nvme_lookup_host(r, hostnqn, hostid); if (hostnqn) free(hostnqn); if (hostid) free(hostid); if (h) { if (h->dhchap_key) free(h->dhchap_key); h->dhchap_key = nvme_get_attr(path, "dhchap_secret"); if (h->dhchap_key && !strcmp(h->dhchap_key, "none")) { free(h->dhchap_key); h->dhchap_key = NULL; } } if (!h) { h = nvme_default_host(r); if (!h) { free(path); errno = ENOMEM; return NULL; } } subsysnqn = nvme_get_attr(path, "subsysnqn"); if (!subsysnqn) { free(path); errno = ENXIO; return NULL; } subsysname = nvme_ctrl_lookup_subsystem_name(r, name); if (!subsysname) { nvme_msg(r, LOG_ERR, "failed to lookup subsystem for controller %s\n", name); free(path); errno = ENXIO; return NULL; } s = nvme_lookup_subsystem(h, subsysname, subsysnqn); free(subsysnqn); free(subsysname); if (!s) { free(path); errno = ENOMEM; return NULL; } c = nvme_ctrl_alloc(r, s, path, name); if (!c) { free(path); return NULL; } nvme_ctrl_scan_namespaces(r, c); nvme_ctrl_scan_paths(r, c); return c; } void nvme_rescan_ctrl(struct nvme_ctrl *c) { nvme_root_t r = c->s && c->s->h ? c->s->h->r : NULL; if (!c->s) return; nvme_ctrl_scan_namespaces(r, c); nvme_ctrl_scan_paths(r, c); nvme_subsystem_scan_namespaces(r, c->s, NULL, NULL); } static int nvme_bytes_to_lba(nvme_ns_t n, off_t offset, size_t count, __u64 *lba, __u16 *nlb) { int bs; bs = nvme_ns_get_lba_size(n); if (!count || offset & bs || count & bs) { errno = EINVAL; return -1; } *lba = offset >> n->lba_shift; *nlb = (count >> n->lba_shift) - 1; return 0; } int nvme_ns_get_fd(nvme_ns_t n) { return n->fd; } nvme_subsystem_t nvme_ns_get_subsystem(nvme_ns_t n) { return n->s; } nvme_ctrl_t nvme_ns_get_ctrl(nvme_ns_t n) { return n->c; } int nvme_ns_get_nsid(nvme_ns_t n) { return n->nsid; } const char *nvme_ns_get_sysfs_dir(nvme_ns_t n) { return n->sysfs_dir; } const char *nvme_ns_get_name(nvme_ns_t n) { return n->name; } const char *nvme_ns_get_generic_name(nvme_ns_t n) { return n->generic_name; } const char *nvme_ns_get_model(nvme_ns_t n) { return n->c ? n->c->model : n->s->model; } const char *nvme_ns_get_serial(nvme_ns_t n) { return n->c ? n->c->serial : n->s->serial; } const char *nvme_ns_get_firmware(nvme_ns_t n) { return n->c ? n->c->firmware : n->s->firmware; } int nvme_ns_get_lba_size(nvme_ns_t n) { return n->lba_size; } int nvme_ns_get_meta_size(nvme_ns_t n) { return n->meta_size; } uint64_t nvme_ns_get_lba_count(nvme_ns_t n) { return n->lba_count; } uint64_t nvme_ns_get_lba_util(nvme_ns_t n) { return n->lba_util; } enum nvme_csi nvme_ns_get_csi(nvme_ns_t n) { return n->csi; } const uint8_t *nvme_ns_get_eui64(nvme_ns_t n) { return n->eui64; } const uint8_t *nvme_ns_get_nguid(nvme_ns_t n) { return n->nguid; } void nvme_ns_get_uuid(nvme_ns_t n, uuid_t out) { uuid_copy(out, n->uuid); } int nvme_ns_identify(nvme_ns_t n, struct nvme_id_ns *ns) { return nvme_identify_ns(nvme_ns_get_fd(n), nvme_ns_get_nsid(n), ns); } int nvme_ns_identify_descs(nvme_ns_t n, struct nvme_ns_id_desc *descs) { return nvme_identify_ns_descs(nvme_ns_get_fd(n), nvme_ns_get_nsid(n), descs); } int nvme_ns_verify(nvme_ns_t n, off_t offset, size_t count) { struct nvme_io_args args = { .args_size = sizeof(args), .fd = nvme_ns_get_fd(n), .nsid = nvme_ns_get_nsid(n), .control = 0, .dsm = 0, .dspec = 0, .reftag = 0, .apptag = 0, .appmask = 0, .storage_tag = 0, .data_len = 0, .data = NULL, .metadata_len = 0, .metadata = NULL, .timeout = NVME_DEFAULT_IOCTL_TIMEOUT, .result = NULL, }; if (nvme_bytes_to_lba(n, offset, count, &args.slba, &args.nlb)) return -1; return nvme_verify(&args); } int nvme_ns_write_uncorrectable(nvme_ns_t n, off_t offset, size_t count) { struct nvme_io_args args = { .args_size = sizeof(args), .fd = nvme_ns_get_fd(n), .nsid = nvme_ns_get_nsid(n), .control = 0, .dsm = 0, .dspec = 0, .reftag = 0, .apptag = 0, .appmask = 0, .storage_tag = 0, .data_len = 0, .data = NULL, .metadata_len = 0, .metadata = NULL, .timeout = NVME_DEFAULT_IOCTL_TIMEOUT, .result = NULL, }; if (nvme_bytes_to_lba(n, offset, count, &args.slba, &args.nlb)) return -1; return nvme_write_uncorrectable(&args); } int nvme_ns_write_zeros(nvme_ns_t n, off_t offset, size_t count) { struct nvme_io_args args = { .args_size = sizeof(args), .fd = nvme_ns_get_fd(n), .nsid = nvme_ns_get_nsid(n), .control = 0, .dsm = 0, .dspec = 0, .reftag = 0, .apptag = 0, .appmask = 0, .storage_tag = 0, .data_len = 0, .data = NULL, .metadata_len = 0, .metadata = NULL, .timeout = NVME_DEFAULT_IOCTL_TIMEOUT, .result = NULL, }; if (nvme_bytes_to_lba(n, offset, count, &args.slba, &args.nlb)) return -1; return nvme_write_zeros(&args); } int nvme_ns_write(nvme_ns_t n, void *buf, off_t offset, size_t count) { struct nvme_io_args args = { .args_size = sizeof(args), .fd = nvme_ns_get_fd(n), .nsid = nvme_ns_get_nsid(n), .control = 0, .dsm = 0, .dspec = 0, .reftag = 0, .apptag = 0, .appmask = 0, .storage_tag = 0, .data_len = count, .data = buf, .metadata_len = 0, .metadata = NULL, .timeout = NVME_DEFAULT_IOCTL_TIMEOUT, .result = NULL, }; if (nvme_bytes_to_lba(n, offset, count, &args.slba, &args.nlb)) return -1; return nvme_write(&args); } int nvme_ns_read(nvme_ns_t n, void *buf, off_t offset, size_t count) { struct nvme_io_args args = { .args_size = sizeof(args), .fd = nvme_ns_get_fd(n), .nsid = nvme_ns_get_nsid(n), .control = 0, .dsm = 0, .dspec = 0, .reftag = 0, .apptag = 0, .appmask = 0, .storage_tag = 0, .data_len = count, .data = buf, .metadata_len = 0, .metadata = NULL, .timeout = NVME_DEFAULT_IOCTL_TIMEOUT, .result = NULL, }; if (nvme_bytes_to_lba(n, offset, count, &args.slba, &args.nlb)) return -1; return nvme_read(&args); } int nvme_ns_compare(nvme_ns_t n, void *buf, off_t offset, size_t count) { struct nvme_io_args args = { .args_size = sizeof(args), .fd = nvme_ns_get_fd(n), .nsid = nvme_ns_get_nsid(n), .control = 0, .dsm = 0, .dspec = 0, .reftag = 0, .apptag = 0, .appmask = 0, .storage_tag = 0, .data_len = count, .data = buf, .metadata_len = 0, .metadata = NULL, .timeout = NVME_DEFAULT_IOCTL_TIMEOUT, .result = NULL, }; if (nvme_bytes_to_lba(n, offset, count, &args.slba, &args.nlb)) return -1; return nvme_compare(&args); } int nvme_ns_flush(nvme_ns_t n) { return nvme_flush(nvme_ns_get_fd(n), nvme_ns_get_nsid(n)); } static void nvme_ns_parse_descriptors(struct nvme_ns *n, struct nvme_ns_id_desc *descs) { void *d = descs; int i, len; for (i = 0; i < NVME_IDENTIFY_DATA_SIZE; i += len) { struct nvme_ns_id_desc *desc = d + i; if (!desc->nidl) break; len = desc->nidl + sizeof(*desc); switch (desc->nidt) { case NVME_NIDT_EUI64: memcpy(n->eui64, desc->nid, sizeof(n->eui64)); break; case NVME_NIDT_NGUID: memcpy(n->nguid, desc->nid, sizeof(n->nguid)); break; case NVME_NIDT_UUID: memcpy(n->uuid, desc->nid, sizeof(n->uuid)); break; case NVME_NIDT_CSI: memcpy(&n->csi, desc->nid, sizeof(n->csi)); break; } } } static int nvme_ns_init(struct nvme_ns *n) { struct nvme_id_ns ns = { }; uint8_t buffer[NVME_IDENTIFY_DATA_SIZE] = { }; struct nvme_ns_id_desc *descs = (void *)buffer; uint8_t flbas; int ret; ret = nvme_ns_identify(n, &ns); if (ret) return ret; nvme_id_ns_flbas_to_lbaf_inuse(ns.flbas, &flbas); n->lba_shift = ns.lbaf[flbas].ds; n->lba_size = 1 << n->lba_shift; n->lba_count = le64_to_cpu(ns.nsze); n->lba_util = le64_to_cpu(ns.nuse); n->meta_size = le16_to_cpu(ns.lbaf[flbas].ms); if (!nvme_ns_identify_descs(n, descs)) nvme_ns_parse_descriptors(n, descs); return 0; } static void nvme_ns_set_generic_name(struct nvme_ns *n, const char *name) { char generic_name[PATH_MAX]; int instance, head_instance; int ret; ret = sscanf(name, "nvme%dn%d", &instance, &head_instance); if (ret != 2) return; sprintf(generic_name, "ng%dn%d", instance, head_instance); n->generic_name = strdup(generic_name); } static nvme_ns_t nvme_ns_open(const char *name) { struct nvme_ns *n; n = calloc(1, sizeof(*n)); if (!n) { errno = ENOMEM; return NULL; } n->name = strdup(name); n->fd = nvme_open(n->name); if (n->fd < 0) goto free_ns; nvme_ns_set_generic_name(n, name); if (nvme_get_nsid(n->fd, &n->nsid) < 0) goto close_fd; if (nvme_ns_init(n) != 0) goto close_fd; list_head_init(&n->paths); list_node_init(&n->entry); return n; close_fd: close(n->fd); free_ns: free(n->name); free(n); return NULL; } static struct nvme_ns *__nvme_scan_namespace(const char *sysfs_dir, const char *name) { struct nvme_ns *n; char *path; int ret; ret = asprintf(&path, "%s/%s", sysfs_dir, name); if (ret < 0) { errno = ENOMEM; return NULL; } n = nvme_ns_open(name); if (!n) goto free_path; n->sysfs_dir = path; return n; free_path: free(path); return NULL; } nvme_ns_t nvme_scan_namespace(const char *name) { return __nvme_scan_namespace(nvme_ns_sysfs_dir, name); } static int nvme_ctrl_scan_namespace(nvme_root_t r, struct nvme_ctrl *c, char *name) { struct nvme_ns *n; nvme_msg(r, LOG_DEBUG, "scan controller %s namespace %s\n", c->name, name); if (!c->s) { nvme_msg(r, LOG_DEBUG, "no subsystem for %s\n", name); errno = EINVAL; return -1; } n = __nvme_scan_namespace(c->sysfs_dir, name); if (!n) { nvme_msg(r, LOG_DEBUG, "failed to scan namespace %s\n", name); return -1; } n->s = c->s; n->c = c; list_add(&c->namespaces, &n->entry); return 0; } static void nvme_subsystem_set_ns_path(nvme_subsystem_t s, nvme_ns_t n) { nvme_ctrl_t c; nvme_path_t p; int ns_ctrl, ns_nsid, ret; ret = sscanf(nvme_ns_get_name(n), "nvme%dn%d", &ns_ctrl, &ns_nsid); if (ret != 2) return; nvme_subsystem_for_each_ctrl(s, c) { nvme_ctrl_for_each_path(c, p) { int p_subsys, p_ctrl, p_nsid; ret = sscanf(nvme_path_get_name(p), "nvme%dc%dn%d", &p_subsys, &p_ctrl, &p_nsid); if (ret != 3) continue; if (ns_ctrl == p_subsys && ns_nsid == p_nsid) { list_add(&n->paths, &p->nentry); p->n = n; } } } } static int nvme_subsystem_scan_namespace(nvme_root_t r, nvme_subsystem_t s, char *name, nvme_scan_filter_t f, void *f_args) { struct nvme_ns *n; nvme_msg(r, LOG_DEBUG, "scan subsystem %s namespace %s\n", s->name, name); n = __nvme_scan_namespace(s->sysfs_dir, name); if (!n) { nvme_msg(r, LOG_DEBUG, "failed to scan namespace %s\n", name); return -1; } if (f && !f(NULL, NULL, n, f_args)) { nvme_msg(r, LOG_DEBUG, "filter out namespace %s\n", name); __nvme_free_ns(n); return 0; } n->s = s; list_add(&s->namespaces, &n->entry); nvme_subsystem_set_ns_path(s, n); return 0; } struct nvme_ns *nvme_subsystem_lookup_namespace(struct nvme_subsystem *s, __u32 nsid) { nvme_root_t r = s->h ? s->h->r : NULL; struct nvme_ns *n; char *name; int ret; ret = asprintf(&name, "%sn%u", s->name, nsid); if (ret < 0) return NULL; n = __nvme_scan_namespace(s->sysfs_dir, name); free(name); if (!n) { nvme_msg(r, LOG_DEBUG, "failed to scan namespace %d\n", nsid); return NULL; } n->s = s; list_add(&s->namespaces, &n->entry); return n; }