Skip to content

libnvme: rename sysfs to attrs, move generated files to a subdir #3787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
igaw merged 2 commits into from
Aug 10, 2026
Merged

libnvme: rename sysfs to attrs, move generated files to a subdir #3787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e422638
libnvme: rename sysfs to attrs and move generated files to a subdir
Aug 7, 2026
d9336c5
libnvme: move accessors.[ch] and accessors-fabrics.[ch] to generated …
Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,8 @@ The script atomically updates the `.h` and `.c` files when their content
changes. Commit the updated files afterward:

```shell
$ git add libnvme/src/nvme/accessors.h libnvme/src/nvme/accessors.c
$ git add libnvme/src/nvme/accessors-fabrics.h libnvme/src/nvme/accessors-fabrics.c
$ git add libnvme/src/nvme/generated/accessors.h libnvme/src/nvme/generated/accessors.c
$ git add libnvme/src/nvme/generated/accessors-fabrics.h libnvme/src/nvme/generated/accessors-fabrics.c
$ git commit -m "libnvme: regenerate accessors following <struct> changes"
```

Expand Down
2 changes: 1 addition & 1 deletion discoverd/src/tid.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

#include <stdbool.h>

#include <nvme/accessors-fabrics.h>
#include <nvme/generated/accessors-fabrics.h>
#include <nvme/tid.h>

#include <string-util.h>
Expand Down
4 changes: 2 additions & 2 deletions libnvme/design/tooling/generate_accessors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,8 +407,8 @@ What each member demonstrates:

```
python3 generate_accessors.py \
--h-out src/nvme/accessors-fabrics.h \
--c-out src/nvme/accessors-fabrics.c \
--h-out src/nvme/generated/accessors-fabrics.h \
--c-out src/nvme/generated/accessors-fabrics.c \
--ld-out src/accessors-fabrics.ld \
src/nvme/private-fabrics.h
```
Expand Down
70 changes: 36 additions & 34 deletions ...esign/tooling/generate_sysfs_accessors.md → ...design/tooling/generate_attr_accessors.md
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions libnvme/doc/meson.build
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
#

api_files = [
'accessors-fabrics.h',
'accessors.h',
'generated/accessors-fabrics.h',
'generated/accessors.h',
'fabrics.h',
'ioctl.h',
'lib-types.h',
Expand Down
2 changes: 1 addition & 1 deletion libnvme/libnvme3/ctrl-sysfs.i → libnvme/libnvme3/ctrl-attrs.i
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* Or: make update-accessors
*/

/* struct libnvme_ctrl -- sysfs-backed properties */
/* struct libnvme_ctrl -- lazily-loaded properties */
%rename(libnvme_ctrl_firmware_set) libnvme_ctrl_set_firmware;
%rename(libnvme_ctrl_model_set) libnvme_ctrl_set_model;
%rename(libnvme_ctrl_serial_set) libnvme_ctrl_set_serial;
Expand Down
4 changes: 2 additions & 2 deletions libnvme/libnvme3/meson.build
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ if want_python
depend_files: [
'accessors.i',
'accessors-fabrics.i',
'ctrl-sysfs.i',
'subsys-sysfs.i',
'ctrl-attrs.i',
'subsys-attrs.i',
'nvme-manual-bridges.i',
'fctx_field_tables.h',
],
Expand Down
2 changes: 1 addition & 1 deletion libnvme/libnvme3/ns-sysfs.i → libnvme/libnvme3/ns-attrs.i
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* Or: make update-accessors
*/

/* struct libnvme_ns -- sysfs-backed properties */
/* struct libnvme_ns -- lazily-loaded properties */
%{
static PyObject *libnvme_ns_lba_size_get(const struct libnvme_ns *p)
{
Expand Down
8 changes: 4 additions & 4 deletions libnvme/libnvme3/nvme.i
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1300,10 +1300,10 @@ def exclusion_match(ctx, transport=None, traddr=None, trsvcid=None,
*/
%include "nvme-manual-bridges.i"
%include "accessors.i"
%include "ctrl-sysfs.i"
%include "path-sysfs.i"
%include "ns-sysfs.i"
%include "subsys-sysfs.i"
%include "ctrl-attrs.i"
%include "path-attrs.i"
%include "ns-attrs.i"
%include "subsys-attrs.i"
%include "accessors-fabrics.i"

/* Propagate any Python exception set inside the helper function.
Expand Down
2 changes: 1 addition & 1 deletion libnvme/libnvme3/path-sysfs.i → libnvme/libnvme3/path-attrs.i
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* Or: make update-accessors
*/

/* struct libnvme_path -- sysfs-backed properties */
/* struct libnvme_path -- lazily-loaded properties */
%{
static const char *libnvme_path_ana_state_get(const struct libnvme_path *p)
{
Expand Down
2 changes: 1 addition & 1 deletion libnvme/libnvme3/subsys-sysfs.i → libnvme/libnvme3/subsys-attrs.i
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* Or: make update-accessors
*/

/* struct libnvme_subsystem -- sysfs-backed properties */
/* struct libnvme_subsystem -- lazily-loaded properties */
%rename(libnvme_subsystem_model_set) libnvme_subsystem_set_model;
%rename(libnvme_subsystem_serial_set) libnvme_subsystem_set_serial;
%rename(libnvme_subsystem_firmware_set) libnvme_subsystem_set_firmware;
Expand Down
2 changes: 1 addition & 1 deletion libnvme/src/ctrl-sysfs.ld → libnvme/src/ctrl-attrs.ld
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* Or: make update-accessors
*/

LIBNVME_CTRL_SYSFS_3 {
LIBNVME_CTRL_ATTRS_3 {
global:
libnvme_ctrl_get_numa_node;
libnvme_ctrl_get_queue_count;
Expand Down
2 changes: 1 addition & 1 deletion libnvme/src/fabrics-includes.h.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#include <nvme/accessors-fabrics.h>
#include <nvme/generated/accessors-fabrics.h>
#include <nvme/config.h>
#include <nvme/crypto.h>
#include <nvme/exclusion.h>
Expand Down
10 changes: 5 additions & 5 deletions libnvme/src/libnvme.h.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
extern "C" {
#endif

#include <nvme/accessors.h>
#include <nvme/ctrl-sysfs.h>
#include <nvme/path-sysfs.h>
#include <nvme/ns-sysfs.h>
#include <nvme/subsys-sysfs.h>
#include <nvme/generated/accessors.h>
#include <nvme/generated/ctrl-attrs.h>
#include <nvme/generated/path-attrs.h>
#include <nvme/generated/ns-attrs.h>
#include <nvme/generated/subsys-attrs.h>
#include <nvme/ioctl.h>
#include <nvme/lib-types.h>
#include <nvme/lib.h>
Expand Down
59 changes: 36 additions & 23 deletions libnvme/src/meson.build
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@
# Authors: Martin Belanger <Martin.Belanger@dell.com>
#
sources = [
'nvme/accessors.c',
'nvme/generated/accessors.c',
'nvme/generated/subsys-attrs.c',
'nvme/ioctl.c',
'nvme/lib.c',
'nvme/log.c',
'nvme/nvme-cmds.c',
'nvme/subsys-sysfs.c',
'nvme/tree.c',
'nvme/util.c',
]
if host_system == 'linux'
sources += [
'nvme/ctrl-sysfs-custom-linux.c',
'nvme/path-sysfs-custom-linux.c',
'nvme/ns-sysfs-custom-linux.c',
'nvme/ctrl-attrs-custom-linux.c',
'nvme/path-attrs-custom-linux.c',
'nvme/ns-attrs-custom-linux.c',
'nvme/ioctl-linux.c',
'nvme/lib-linux.c',
'nvme/mem-linux.c',
Expand All @@ -29,9 +29,9 @@ if host_system == 'linux'
elif host_system == 'windows'
sources += [
'nvme/ctrl-map.c',
'nvme/ctrl-sysfs-custom-win.c',
'nvme/path-sysfs-custom-win.c',
'nvme/ns-sysfs-custom-win.c',
'nvme/ctrl-attrs-custom-win.c',
'nvme/path-attrs-custom-win.c',
'nvme/ns-attrs-custom-win.c',
'nvme/ioctl-win.c',
'nvme/lib-win.c',
'nvme/mem-win.c',
Expand All @@ -40,10 +40,6 @@ elif host_system == 'windows'
]
endif
headers = [
'nvme/accessors.h',
'nvme/ctrl-sysfs.h',
'nvme/path-sysfs.h',
'nvme/ns-sysfs.h',
'nvme/endian.h',
'nvme/ioctl.h',
'nvme/lib-types.h',
Expand All @@ -62,15 +58,25 @@ headers = [
'nvme/nvme-types-zns.h',
'nvme/nvme-types.h',
'nvme/scan.h',
'nvme/subsys-sysfs.h',
'nvme/tree.h',
'nvme/types.h',
'nvme/util.h',
]

# Generator-owned headers (never hand-touched, unlike everything else in
# headers above) -- kept in their own subdirectory and installed under
# nvme/generated/ so libnvme.h.in can #include them by that same path.
generated_headers = [
'nvme/generated/accessors.h',
'nvme/generated/ctrl-attrs.h',
'nvme/generated/path-attrs.h',
'nvme/generated/ns-attrs.h',
'nvme/generated/subsys-attrs.h',
]

if want_fabrics
sources += [
'nvme/accessors-fabrics.c',
'nvme/generated/accessors-fabrics.c',
'nvme/crypto.c',
'nvme/config.c',
'nvme/config-emit.c',
Expand All @@ -84,8 +90,10 @@ if want_fabrics
'nvme/tree-fabrics.c',
'nvme/util-fabrics.c',
]
generated_headers += [
'nvme/generated/accessors-fabrics.h',
]
headers += [
'nvme/accessors-fabrics.h',
'nvme/config.h',
'nvme/crypto.h',
'nvme/exclusion.h',
Expand Down Expand Up @@ -147,10 +155,10 @@ nvmf_ld = meson.current_source_dir() / 'libnvmf.ld'
mi_ld = meson.current_source_dir() / 'libnvme-mi.ld'
accessors_ld = meson.current_source_dir() / 'accessors.ld'
nvmf_accessors_ld = meson.current_source_dir() / 'accessors-fabrics.ld'
ctrl_sysfs_ld = meson.current_source_dir() / 'ctrl-sysfs.ld'
path_sysfs_ld = meson.current_source_dir() / 'path-sysfs.ld'
ns_sysfs_ld = meson.current_source_dir() / 'ns-sysfs.ld'
subsys_sysfs_ld = meson.current_source_dir() / 'subsys-sysfs.ld'
ctrl_attrs_ld = meson.current_source_dir() / 'ctrl-attrs.ld'
path_attrs_ld = meson.current_source_dir() / 'path-attrs.ld'
ns_attrs_ld = meson.current_source_dir() / 'ns-attrs.ld'
subsys_attrs_ld = meson.current_source_dir() / 'subsys-attrs.ld'

# Version scripts filter the exported symbols. GNU ld honours --version-script
# for PE/COFF too, but LLVM's lld does not accept the option at all, so the
Expand All @@ -170,10 +178,10 @@ if want_version_scripts
link_args += [
'-Wl,--version-script=@0@'.format(nvme_ld),
'-Wl,--version-script=@0@'.format(accessors_ld),
'-Wl,--version-script=@0@'.format(ctrl_sysfs_ld),
'-Wl,--version-script=@0@'.format(path_sysfs_ld),
'-Wl,--version-script=@0@'.format(ns_sysfs_ld),
'-Wl,--version-script=@0@'.format(subsys_sysfs_ld),
'-Wl,--version-script=@0@'.format(ctrl_attrs_ld),
'-Wl,--version-script=@0@'.format(path_attrs_ld),
'-Wl,--version-script=@0@'.format(ns_attrs_ld),
'-Wl,--version-script=@0@'.format(subsys_attrs_ld),
]
endif

Expand Down Expand Up @@ -252,6 +260,11 @@ install_headers(
subdir: libnvme_api_name / 'nvme',
install_mode: mode,
)
install_headers(
generated_headers,
subdir: libnvme_api_name / 'nvme' / 'generated',
install_mode: mode,
)
if want_mi
install_headers(
[
Expand Down
2 changes: 1 addition & 1 deletion libnvme/src/ns-sysfs.ld → libnvme/src/ns-attrs.ld
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* Or: make update-accessors
*/

LIBNVME_NS_SYSFS_3 {
LIBNVME_NS_ATTRS_3 {
global:
libnvme_ns_get_lba_size;
libnvme_ns_get_lba_shift;
Expand Down
Loading
Loading