Skip to content

NEWS.md

Latest commit

 

History

History
261 lines (212 loc) · 11.8 KB

NEWS.md

File metadata and controls

261 lines (212 loc) · 11.8 KB
Raw

NEWS

Changes in 3.0 (unreleased)

Feature removals and incompatible changes

  • A new INI-format connection configuration parser and writer have been added (nvme-fabrics.conf + nvme-fabrics.conf.d/ drop-ins, replacing config.json/discovery.conf). See libnvme/design/CONFIG.md for the format. Existing configuration can be explicietly converted by 'nvme config convert' or implicitly by the first call of any fabric command.

  • Key management has moved into a new nvme keys plugin. gen-dhchap-key, check-dhchap-key, gen-tls-key, check-tls-key, and tls-key are now nvme keys gen-kxchap, check-kxchap, gen-tls, check-tls, insert-tls, import, export, and revoke. The old commands still work as deprecated aliases (needs to be enabled at build time), except check-tls-key --insert, which has no equivalent there. Use nvme keys insert-tls instead. The DH-HMAC-CHAP naming is also renamed to KX-HMAC-CHAP throughout, matching TP4201. See nvme-keys-gen-kxchap(1) and nvme-keys-check-kxchap(1).

  • nvme disconnect-all with no options no longer disconnects every fabric controller. It now only disconnects controllers with no recorded owner in the new ownership registry. A controller owned by another orchestrator is silently skipped. To restore the old disconnect-everything behavior.

  • libnvme itself no longer resolves hostnames. libnvmf_add_ctrl() and libnvmf_connect_ctrl() now fail immediately on a hostname traddr/host_traddr instead of resolving it internally. The caller is responsible for resolving first.

  • --dump-config has been removed from nvme discover, connect-all, and connect.

  • In libnvme, the per-command nvme_<cmd>() wrapper functions and their struct nvme_<cmd>_args argument bundles have been replaced by an nvme_init_<cmd>() helper that fills a caller-owned struct libnvme_passthru_cmd, submitted separately with libnvme_exec_admin_passthru() / libnvme_exec_io_passthru() (or the async equivalents).

  • The public NBFT parsing API has moved from the libnvme_* namespace to libnvmf_*, and every function now takes the global context as its first argument (for example, libnvmf_read_nbft(ctx, ...)). Update both the prefix and the call signature.

  • The -Dpdc-enabled meson build option has been removed. Whether a discovery controller connection is kept persistent is now decided at runtime, via --persistent/nvme-fabrics.conf, not at build time.

New: Windows support

  • nvme-cli and libnvme now build and run on Windows (MSYS2 UCRT64). Direct PCIe access via ioctl works; NVMe-oF fabrics, MI, nvme-discoverd, and nvme top are not yet available on this platform.

New: nvme top

  • nvme top is a new interactive, top-like dashboard for NVMe devices. It lists subsystems and lets you drill into one to see live namespace, path, and controller stats, including command retry/error counts and multipath failover/reconnect counts.

New: ownership registry and exclusion list

  • A new ownership registry (nvme registry, backed by /run/nvme/registry/) records which orchestrator owns each connected controller. This is what lets disconnect-all (above) and future orchestrator tooling avoid tearing down a connection another component depends on. See libnvme/design/REGISTRY.md.

  • A new system-wide exclusion list (nvme exclusion, backed by /etc/nvme/exclusions.conf and exclusions.conf.d/ drop-ins) lets an administrator block specific controls from being auto-connected. It's aimed primarily at auto-discovered controllers, which have no config entry to remove in order to suppress an unwanted connection. See libnvme/design/EXCLUSIONS.md.

nvme-cli

  • A new global config file, /etc/nvme/nvme-cli.conf, sets machine-wide defaults for global options like --timeout, --output-format, --no-retries, and --no-ioctl-probing. See nvme-cli.conf(5).

  • nvme disconnect now accepts the same identifying options as nvme connect (--nqn, --transport, --traddr, --host-iface, --hostnqn, --hostid). A new -x/--exclude also writes a matching entry to the exclusion list before disconnecting. See nvme-disconnect(1).

  • nvme discover and nvme config-create gained --epcsd/--no-epcsd, to request or refuse Explicit Persistent Connection Support for Discovery. See nvme-config-create(1).

  • nvme utils dump-command-metadata prints the full command and option tree as JSON. It is meant to drive shell-completion generation.

  • nvme connect gained --idempotent and --devid-file. --idempotent makes connecting to an already-connected controller succeed instead of erroring. --devid-file writes the resulting nvmeX device name to the given file on success, so a caller that doesn't know the device name at connect time (for example, a systemd unit spawned before the device exists) can look it up afterward instead of scraping dmesg or polling sysfs.

  • nvme config-convert converts the legacy config.json and discovery.conf files to the new INI-format nvme-fabrics.conf. By default it reads the system paths and writes to /etc/nvme/nvme-fabrics.conf. --config overrides the config.json path, --output the destination, and --force allows overwriting an existing target. On success each converted legacy file is renamed to <name>.converted so running the command again is a safe no-op. See nvme-config-convert(1).

libnvme

  • The library has been renamed from libnvme to libnvme3, and the previously separate libnvme-mi has been merged into it. The shared library SONAME is libnvme3.so.1. Headers install under include/libnvme3/ and man pages under a versioned path, enabling parallel installation alongside libnvme v1 packages. The Python binding is now named libnvme3. Packages, build systems, and Python scripts that reference the library, its headers, or the Python module by name must update.

  • nvme-fabrics.conf entries can now record persistent and epcsd settings per discovery controller, matching the CLI flags above.

  • New diagnostic accessors report per-path, per-namespace, and per-controller command retry/error counts, multipath failover count, and controller reset/reconnect counts. These are always read live rather than cached, and back nvme top.

  • The Python bindings' object-oriented surface has been polished: connected() and is_registration_supported() are now read-only properties (connected, registration_supported), registration_ctrl() is renamed registration_control(), and set_symname() has been removed. Set host.hostsymname directly instead.

  • The NBFT parser has been updated for NVMe Boot Specification rev. 1.3, including Security Profile Descriptors, and hardened against malformed or malicious NBFT ACPI tables.

  • ioctl version probing is now deferred until the first command on a transport handle, instead of happening eagerly on open. The probe prefers the 64-bit ioctl and falls back to the 32-bit one only if it isn't supported; the result is cached per handle. The new --no-ioctl-probing global option skips probing and forces the 32-bit ioctl.

  • Controller and namespace sysfs attributes are now read lazily, on first access, instead of all at once when the topology tree is scanned. This cuts overhead when scanning large fabric setups.

  • Connect and discover now share a common struct libnvmf_context internally, replacing the old discovery-only context. Relevant to developers extending the fabrics API, not to CLI end users.

  • A new internal shared/ static library holds code with no natural home in nvme-cli, libnvme, nvme-discoverd, or the Python bindings (INI parsing, base64, CRC32, filesystem/network helpers).

  • Read-only Python bindings for the new config format (config_read(), config_validate()) are available now for early adopters (e.g. nvme-stas) that want to start reading the new format ahead of the CLI's own switch-over.

  • The accessor generator that produces libnvme's getter/setter boilerplate (accessors.c/.h) has been rewritten in Python, with the struct annotations it reads now living in-source in private.h instead of a separate spec file. Relevant to developers extending libnvme's public structs, not to CLI end users.

  • <nvme/nvme-cmds.h> and <nvme/nvme-types.h> have each been split into per-spec-section sub-headers (nvme-cmds-base.h, nvme-cmds-fabrics.h, nvme-cmds-mi.h, similarly for nvme-types). The top-level headers still exist and include all sub-headers, so code that includes them is unaffected. Code that already included a sub-header by its old combined-file path must update the include path.

  • nvme_root_t has been replaced by struct libnvme_global_ctx * throughout the public API. Code that stored or passed nvme_root_t must update to the new type.

  • A new transport handle abstraction (struct nvme_transport_handle, libnvme_transport_handle_*) decouples command issuing from the underlying transport. A handle may wrap either a direct ioctl file descriptor or an MI endpoint.

  • An explicit async passthru API has been added. libnvme_submit_admin_passthru() / libnvme_submit_io_passthru() submit a command without waiting; libnvme_wait_passthru() / libnvme_reap_passthru() collect the result later. The synchronous path is libnvme_exec_admin_passthru() / libnvme_exec_io_passthru().

  • libnvmf_host_get_ids() has been promoted from an internal helper to a public API. It resolves the hostnqn and hostid from all available sources and is the recommended way for callers to obtain host identity before connect or discover.

  • The implicit hostnqn/hostid lookup inside the fabrics connect and discover code paths has been removed. Callers must now resolve host identity before connecting; use the newly public libnvmf_host_get_ids() helper or set values explicitly with libnvme_global_ctx_set_hostnqn() / libnvme_global_ctx_set_hostid().

  • The sizeof_args backward-compatibility macro and the old struct-based command-argument shim have been removed. The macro returned incorrect values on 32-bit architectures; there is no intention to fix it.

  • The platform-specific filter helpers (nvme_filter_*) are no longer exported from libnvme. Only the libnvme_scan_* interfaces remain public. Plugins that called filter helpers directly must be updated to use the scan API.

  • libnvme_ctrl_match_config() has been removed. It was exported but had no callers outside the library.

  • libnvmf_ctrl_get_fabrics_config() has been removed. The individual field accessors generated by the new accessor machinery provide equivalent access without exposing the internal nested struct.

  • nvme_mi_ctrl_t has been removed. MI functionality is now accessed through struct nvme_transport_handle, the same abstraction used for direct ioctl access; the transport is chosen at handle construction. nvme_mi_admin_identify() and nvme_mi_admin_identify_partial() are gone; use libnvme_ctrl_identify() with a transport handle opened for MI.

  • Several deprecated identifiers have been removed for 3.0: the duplicate NVME_SC_FEAT_IOCS_COMBINATION_REJECTED define, the old notification-mask enum names, MI backward-compatibility #defines, and nvme_cmd_get_log_telemetry_host_lsp (renamed to nvme_log_telemetry_host_lsp). Update any code using these names.

  • The environment-variable configuration knobs for libnvme have been removed. LIBNVME_MI_PROBE_ENABLED, LIBNVME_TEST_BASE_DIR, and similar variables no longer have any effect. Replace them with explicit setter calls on the global context: libnvme_set_probe_enabled(), libnvme_set_test_base_dir(), libnvme_set_test_sysfs_dir(), libnvme_set_force_4k(), etc.