Skip to content

libnvme: introduce libnvme prefix for library API #3234

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 3 commits into from
Apr 7, 2026
Merged

libnvme: introduce libnvme prefix for library API #3234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c23ecbe
libnvme: introduce libnvme prefix for library API
igaw Apr 2, 2026
0690776
mi: move types into mi-types.h
igaw Apr 3, 2026
0143df1
mi: use libnvme prefix for mi API
igaw Apr 3, 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
222 changes: 111 additions & 111 deletions fabrics.c
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions libnvme/examples/discover-loop.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,29 +52,29 @@ static void print_discover_log(struct nvmf_discovery_log *log)
int main()
{
struct nvmf_discovery_log *log;
struct nvme_global_ctx *ctx;
nvme_host_t h;
nvme_ctrl_t c;
struct libnvme_global_ctx *ctx;
libnvme_host_t h;
libnvme_ctrl_t c;
int ret;
struct nvme_fabrics_config cfg;
struct libnvme_fabrics_config cfg;

nvmf_default_config(&cfg);

ctx = nvme_create_global_ctx(stdout, DEFAULT_LOGLEVEL);
ctx = libnvme_create_global_ctx(stdout, DEFAULT_LOGLEVEL);
if (!ctx)
return 1;

ret = nvme_scan_topology(ctx, NULL, NULL);
ret = libnvme_scan_topology(ctx, NULL, NULL);
if (ret) {
nvme_free_global_ctx(ctx);
libnvme_free_global_ctx(ctx);
return 1;
}
ret = nvme_get_host(ctx, NULL, NULL, &h);
ret = libnvme_get_host(ctx, NULL, NULL, &h);
if (ret) {
fprintf(stderr, "Failed to allocated memory\n");
return 1;
}
ret = nvme_create_ctrl(ctx, NVME_DISC_SUBSYS_NAME, "loop",
ret = libnvme_create_ctrl(ctx, NVME_DISC_SUBSYS_NAME, "loop",
NULL, NULL, NULL, NULL, &c);
if (ret) {
fprintf(stderr, "Failed to allocate memory\n");
Expand All @@ -87,15 +87,15 @@ int main()
}

ret = nvmf_get_discovery_log(c, &log, 4);
nvme_disconnect_ctrl(c);
nvme_free_ctrl(c);
libnvme_disconnect_ctrl(c);
libnvme_free_ctrl(c);

if (ret)
fprintf(stderr, "nvmf-discover-log:%x\n", ret);
else
print_discover_log(log);

nvme_free_global_ctx(ctx);
libnvme_free_global_ctx(ctx);
free(log);
return 0;
}
92 changes: 46 additions & 46 deletions libnvme/examples/display-columnar.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,36 +17,36 @@
static const char dash[101] = {[0 ... 99] = '-'};
int main()
{
struct nvme_global_ctx *ctx;
nvme_host_t h;
nvme_subsystem_t s;
nvme_ctrl_t c;
nvme_path_t p;
nvme_ns_t n;
struct libnvme_global_ctx *ctx;
libnvme_host_t h;
libnvme_subsystem_t s;
libnvme_ctrl_t c;
libnvme_path_t p;
libnvme_ns_t n;
int err;

ctx = nvme_create_global_ctx(stdout, DEFAULT_LOGLEVEL);
ctx = libnvme_create_global_ctx(stdout, DEFAULT_LOGLEVEL);
if (!ctx)
return 1;

err = nvme_scan_topology(ctx, NULL, NULL);
err = libnvme_scan_topology(ctx, NULL, NULL);
if (err) {
nvme_free_global_ctx(ctx);
libnvme_free_global_ctx(ctx);
return 1;
}

printf("%-16s %-96s %-.16s\n", "Subsystem", "Subsystem-NQN", "Controllers");
printf("%-.16s %-.96s %-.16s\n", dash, dash, dash);

nvme_for_each_host(ctx, h) {
nvme_for_each_subsystem(h, s) {
libnvme_for_each_host(ctx, h) {
libnvme_for_each_subsystem(h, s) {
bool first = true;
printf("%-16s %-96s ", nvme_subsystem_get_name(s),
nvme_subsystem_get_subsysnqn(s));
printf("%-16s %-96s ", libnvme_subsystem_get_name(s),
libnvme_subsystem_get_subsysnqn(s));

nvme_subsystem_for_each_ctrl(s, c) {
libnvme_subsystem_for_each_ctrl(s, c) {
printf("%s%s", first ? "": ", ",
nvme_ctrl_get_name(c));
libnvme_ctrl_get_name(c));
first = false;
}
printf("\n");
Expand All @@ -59,29 +59,29 @@
printf("%-.8s %-.20s %-.40s %-.8s %-.6s %-.14s %-.12s %-.16s\n", dash, dash,
dash, dash, dash, dash, dash, dash);

nvme_for_each_host(ctx, h) {
nvme_for_each_subsystem(h, s) {
nvme_subsystem_for_each_ctrl(s, c) {
libnvme_for_each_host(ctx, h) {
libnvme_for_each_subsystem(h, s) {
libnvme_subsystem_for_each_ctrl(s, c) {
bool first = true;

printf("%-8s %-20s %-40s %-8s %-6s %-14s %-12s ",
nvme_ctrl_get_name(c),
nvme_ctrl_get_serial(c),
nvme_ctrl_get_model(c),
nvme_ctrl_get_firmware(c),
nvme_ctrl_get_transport(c),
nvme_ctrl_get_traddr(c),
nvme_subsystem_get_name(s));

nvme_ctrl_for_each_ns(c, n) {
libnvme_ctrl_get_name(c),
libnvme_ctrl_get_serial(c),
libnvme_ctrl_get_model(c),
libnvme_ctrl_get_firmware(c),
libnvme_ctrl_get_transport(c),
libnvme_ctrl_get_traddr(c),
libnvme_subsystem_get_name(s));

libnvme_ctrl_for_each_ns(c, n) {
printf("%s%s", first ? "": ", ",
nvme_ns_get_name(n));
libnvme_ns_get_name(n));
first = false;
}

nvme_ctrl_for_each_path(c, p) {
libnvme_ctrl_for_each_path(c, p) {
printf("%s%s", first ? "": ", ",
nvme_ns_get_name(nvme_path_get_ns(p)));
libnvme_ns_get_name(libnvme_path_get_ns(p)));

Check failure on line 84 in libnvme/examples/display-columnar.c

View workflow job for this annotation

GitHub Actions / checkpatch review 

WARNING: line length of 92 exceeds 80 columns
first = false;
}
printf("\n");
Expand All @@ -93,29 +93,29 @@
printf("%-12s %-8s %-16s %-8s %-16s\n", "Device", "NSID", "Sectors", "Format", "Controllers");
printf("%-.12s %-.8s %-.16s %-.8s %-.16s\n", dash, dash, dash, dash, dash);

nvme_for_each_host(ctx, h) {
nvme_for_each_subsystem(h, s) {
nvme_subsystem_for_each_ctrl(s, c) {
nvme_ctrl_for_each_ns(c, n)
libnvme_for_each_host(ctx, h) {
libnvme_for_each_subsystem(h, s) {
libnvme_subsystem_for_each_ctrl(s, c) {
libnvme_ctrl_for_each_ns(c, n)
printf("%-12s %-8d %-16" PRIu64 " %-8d %s\n",
nvme_ns_get_name(n),
nvme_ns_get_nsid(n),
nvme_ns_get_lba_count(n),
nvme_ns_get_lba_size(n),
nvme_ctrl_get_name(c));
libnvme_ns_get_name(n),
libnvme_ns_get_nsid(n),
libnvme_ns_get_lba_count(n),
libnvme_ns_get_lba_size(n),
libnvme_ctrl_get_name(c));
}

nvme_subsystem_for_each_ns(s, n) {
libnvme_subsystem_for_each_ns(s, n) {
bool first = true;

printf("%-12s %-8d %-16" PRIu64 " %-8d ",
nvme_ns_get_name(n),
nvme_ns_get_nsid(n),
nvme_ns_get_lba_count(n),
nvme_ns_get_lba_size(n));
nvme_subsystem_for_each_ctrl(s, c) {
libnvme_ns_get_name(n),
libnvme_ns_get_nsid(n),
libnvme_ns_get_lba_count(n),
libnvme_ns_get_lba_size(n));
libnvme_subsystem_for_each_ctrl(s, c) {
printf("%s%s", first ? "" : ", ",
nvme_ctrl_get_name(c));
libnvme_ctrl_get_name(c));
first = false;
}
printf("\n");
Expand Down
60 changes: 30 additions & 30 deletions libnvme/examples/display-tree.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,64 +16,64 @@

int main()
{
struct nvme_global_ctx *ctx;
nvme_host_t h;
nvme_subsystem_t s, _s;
nvme_ctrl_t c, _c;
nvme_path_t p, _p;
nvme_ns_t n, _n;
struct libnvme_global_ctx *ctx;
libnvme_host_t h;
libnvme_subsystem_t s, _s;
libnvme_ctrl_t c, _c;
libnvme_path_t p, _p;
libnvme_ns_t n, _n;
int err;

ctx = nvme_create_global_ctx(stdout, DEFAULT_LOGLEVEL);
ctx = libnvme_create_global_ctx(stdout, DEFAULT_LOGLEVEL);
if (!ctx)
return 1;

err = nvme_scan_topology(ctx, NULL, NULL);
err = libnvme_scan_topology(ctx, NULL, NULL);
if (err) {
nvme_free_global_ctx(ctx);
libnvme_free_global_ctx(ctx);
return 1;
}

printf(".\n");
nvme_for_each_host(ctx, h) {
nvme_for_each_subsystem_safe(h, s, _s) {
libnvme_for_each_host(ctx, h) {
libnvme_for_each_subsystem_safe(h, s, _s) {
printf("%c-- %s - NQN=%s\n", _s ? '|' : '`',
nvme_subsystem_get_name(s),
nvme_subsystem_get_subsysnqn(s));
libnvme_subsystem_get_name(s),
libnvme_subsystem_get_subsysnqn(s));

nvme_subsystem_for_each_ns_safe(s, n, _n) {
libnvme_subsystem_for_each_ns_safe(s, n, _n) {
printf("%c |-- %s lba size:%d lba max:%" PRIu64 "\n",
_s ? '|' : ' ',
nvme_ns_get_name(n),
nvme_ns_get_lba_size(n),
nvme_ns_get_lba_count(n));
libnvme_ns_get_name(n),
libnvme_ns_get_lba_size(n),
libnvme_ns_get_lba_count(n));
}

nvme_subsystem_for_each_ctrl_safe(s, c, _c) {
libnvme_subsystem_for_each_ctrl_safe(s, c, _c) {
printf("%c %c-- %s %s %s %s\n",
_s ? '|' : ' ', _c ? '|' : '`',
nvme_ctrl_get_name(c),
nvme_ctrl_get_transport(c),
nvme_ctrl_get_traddr(c),
nvme_ctrl_get_state(c));
libnvme_ctrl_get_name(c),
libnvme_ctrl_get_transport(c),
libnvme_ctrl_get_traddr(c),
libnvme_ctrl_get_state(c));

nvme_ctrl_for_each_ns_safe(c, n, _n)
libnvme_ctrl_for_each_ns_safe(c, n, _n)
printf("%c %c %c-- %s lba size:%d lba max:%" PRIu64 "\n",
_s ? '|' : ' ', _c ? '|' : ' ',
_n ? '|' : '`',
nvme_ns_get_name(n),
nvme_ns_get_lba_size(n),
nvme_ns_get_lba_count(n));
libnvme_ns_get_name(n),
libnvme_ns_get_lba_size(n),
libnvme_ns_get_lba_count(n));

nvme_ctrl_for_each_path_safe(c, p, _p)
libnvme_ctrl_for_each_path_safe(c, p, _p)
printf("%c %c %c-- %s %s\n",
_s ? '|' : ' ', _c ? '|' : ' ',
_p ? '|' : '`',
nvme_path_get_name(p),
nvme_path_get_ana_state(p));
libnvme_path_get_name(p),
libnvme_path_get_ana_state(p));
}
}
}
nvme_free_global_ctx(ctx);
libnvme_free_global_ctx(ctx);
return 0;
}
24 changes: 12 additions & 12 deletions libnvme/examples/mi-conf.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ static int parse_mctp(const char *devstr, unsigned int *net, uint8_t *eid)
return 0;
}

int find_port(nvme_mi_ep_t ep, uint8_t *portp, uint16_t *mtup)
int find_port(libnvme_mi_ep_t ep, uint8_t *portp, uint16_t *mtup)
{
struct nvme_mi_read_nvm_ss_info ss_info;
struct nvme_mi_read_port_info port_info;
Expand All @@ -49,15 +49,15 @@ int find_port(nvme_mi_ep_t ep, uint8_t *portp, uint16_t *mtup)
int rc;

/* query number of ports */
rc = nvme_mi_mi_read_mi_data_subsys(ep, &ss_info);
rc = libnvme_mi_mi_read_mi_data_subsys(ep, &ss_info);
if (rc) {
warn("Failed reading subsystem info");
return -1;
}

found = false;
for (port = 0; port <= ss_info.nump; port++) {
rc = nvme_mi_mi_read_mi_data_port(ep, port, &port_info);
rc = libnvme_mi_mi_read_mi_data_port(ep, port, &port_info);
if (rc) {
warn("Failed reading port info for port %ud", port);
return -1;
Expand Down Expand Up @@ -137,13 +137,13 @@ int set_local_mtu(DBusConnection *bus, unsigned int net, uint8_t eid,

int main(int argc, char **argv)
{
struct nvme_global_ctx *ctx;
struct libnvme_global_ctx *ctx;
uint16_t cur_mtu, mtu;
DBusConnection *bus;
const char *devstr;
uint8_t eid, port;
unsigned int net;
nvme_mi_ep_t ep;
libnvme_mi_ep_t ep;
DBusError berr;
int rc;

Expand All @@ -157,11 +157,11 @@ int main(int argc, char **argv)
if (rc)
errx(EXIT_FAILURE, "can't parse MI device string '%s'", devstr);

ctx = nvme_create_global_ctx(stderr, DEFAULT_LOGLEVEL);
ctx = libnvme_create_global_ctx(stderr, DEFAULT_LOGLEVEL);
if (!ctx)
err(EXIT_FAILURE, "can't create global context");

ep = nvme_mi_open_mctp(ctx, net, eid);
ep = libnvme_mi_open_mctp(ctx, net, eid);
if (!ep) {
warnx("can't open MCTP endpoint %d:%d", net, eid);
goto out_free_ctx;
Expand All @@ -182,7 +182,7 @@ int main(int argc, char **argv)
goto out_close_bus;
}

rc = nvme_mi_mi_config_get_mctp_mtu(ep, port, &cur_mtu);
rc = libnvme_mi_mi_config_get_mctp_mtu(ep, port, &cur_mtu);
if (rc) {
cur_mtu = 0;
warn("Can't query current MTU; no way to revert on failure");
Expand All @@ -193,7 +193,7 @@ int main(int argc, char **argv)
goto out_close_bus;
}

rc = nvme_mi_mi_config_set_mctp_mtu(ep, port, mtu);
rc = libnvme_mi_mi_config_set_mctp_mtu(ep, port, mtu);
if (rc) {
warn("Can't set MCTP MTU");
goto out_close_bus;
Expand All @@ -203,7 +203,7 @@ int main(int argc, char **argv)
if (rc) {
/* revert if we have an old setting */
if (cur_mtu) {
rc = nvme_mi_mi_config_set_mctp_mtu(ep, port, cur_mtu);
rc = libnvme_mi_mi_config_set_mctp_mtu(ep, port, cur_mtu);
if (rc)
warn("Failed to restore previous MTU!");
rc = -1;
Expand All @@ -217,9 +217,9 @@ int main(int argc, char **argv)
dbus_connection_unref(bus);
out_close_ep:
dbus_error_free(&berr);
nvme_mi_close(ep);
libnvme_mi_close(ep);
out_free_ctx:
nvme_free_global_ctx(ctx);
libnvme_free_global_ctx(ctx);

return rc ? EXIT_FAILURE : EXIT_SUCCESS;
}
Expand Down
Loading
Loading