Skip to content

Commit 87e352d

Browse files
igawigaw
committed
libnvme: API review
Add a table which documents the renaming proposal. Signed-off-by: Daniel Wagner <[email protected]>
1 parent 270e812 commit 87e352d

1 file changed

Lines changed: 242 additions & 0 deletions

File tree

‎libnvme/doc/function-index.md‎

Lines changed: 242 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,242 @@
1+
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
2+
3+
# libnvme API review
4+
5+
This document lists the currently exported function names. The goal is to make
6+
the naming more consistent. Functions are grouped by common prefixes. Generic
7+
top-level functions use the nvme_ prefix, while functions operating on specific
8+
objects use the object type as a prefix (e.g., nvme_ns_). The prefix is
9+
typically followed by a verb, such as nvme_create_ctrl.
10+
11+
---
12+
13+
## tree.h — libnvme tree object interface
14+
15+
| Function | Suggested Name |
16+
|--------------------------------------|--------------------------|
17+
| `nvme_create_ctrl` | |
18+
| `nvme_ctrl_config_match` | `nvme_ctrl_match_config` |
19+
| `nvme_ctrl_first_ns` | |
20+
| `nvme_ctrl_first_path` | |
21+
| `nvme_ctrl_for_each_ns_safe` | |
22+
| `nvme_ctrl_for_each_ns` | |
23+
| `nvme_ctrl_for_each_path_safe` | |
24+
| `nvme_ctrl_for_each_path` | |
25+
| `nvme_ctrl_get_address` | |
26+
| `nvme_ctrl_get_config` | |
27+
| `nvme_ctrl_get_dhchap_host_key` | |
28+
| `nvme_ctrl_get_phy_slot` | |
29+
| `nvme_ctrl_get_src_addr` | |
30+
| `nvme_ctrl_get_state` | |
31+
| `nvme_ctrl_get_subsysnqn` | |
32+
| `nvme_ctrl_get_subsystem` | |
33+
| `nvme_ctrl_get_transport_handle` | |
34+
| `nvme_ctrl_identify` | `nvme_identify_ctrl` |
35+
| `nvme_ctrl_is_discovered` | |
36+
| `nvme_ctrl_is_discovery_ctrl` | |
37+
| `nvme_ctrl_is_persistent` | |
38+
| `nvme_ctrl_is_unique_discovery_ctrl` | |
39+
| `nvme_ctrl_next_ns` | |
40+
| `nvme_ctrl_next_path` | |
41+
| `nvme_ctrl_release_transport_handle` | |
42+
| `nvme_ctrl_set_dhchap_host_key` | |
43+
| `nvme_disconnect_ctrl` | |
44+
| `nvme_dump_config` | |
45+
| `nvme_dump_tree` | |
46+
| `nvme_first_host` | |
47+
| `nvme_first_subsystem` | |
48+
| `nvme_for_each_host_safe` | |
49+
| `nvme_for_each_host` | |
50+
| `nvme_for_each_subsystem_safe` | |
51+
| `nvme_for_each_subsystem` | |
52+
| `nvme_free_ctrl` | |
53+
| `nvme_free_host` | |
54+
| `nvme_free_ns` | |
55+
| `nvme_free_subsystem` | |
56+
| `nvme_get_application` | |
57+
| `nvme_get_attr` | |
58+
| `nvme_get_ctrl_attr` | |
59+
| `nvme_get_ns_attr` | |
60+
| `nvme_get_path_attr` | |
61+
| `nvme_get_subsys_attr` | |
62+
| `nvme_host_get_global_ctx` | |
63+
| `nvme_host_get_ids` | |
64+
| `nvme_host_get` | `nvme_get_host` |
65+
| `nvme_host_is_pdc_enabled` | |
66+
| `nvme_host_release_fds` | |
67+
| `nvme_host_set_pdc_enabled` | |
68+
| `nvme_init_ctrl` | |
69+
| `nvme_namespace_first_path` | |
70+
| `nvme_namespace_for_each_path_safe` | |
71+
| `nvme_namespace_for_each_path` | |
72+
| `nvme_namespace_next_path` | |
73+
| `nvme_next_host` | |
74+
| `nvme_next_subsystem` | |
75+
| `nvme_ns_compare` | |
76+
| `nvme_ns_flush` | |
77+
| `nvme_ns_get_csi` | |
78+
| `nvme_ns_get_ctrl` | |
79+
| `nvme_ns_get_eui64` | |
80+
| `nvme_ns_get_firmware` | |
81+
| `nvme_ns_get_generic_name` | |
82+
| `nvme_ns_get_model` | |
83+
| `nvme_ns_get_nguid` | |
84+
| `nvme_ns_get_serial` | |
85+
| `nvme_ns_get_subsystem` | |
86+
| `nvme_ns_get_uuid` | |
87+
| `nvme_ns_head_get_sysfs_dir` | |
88+
| `nvme_ns_identify_descs` | |
89+
| `nvme_ns_identify` | |
90+
| `nvme_ns_read` | |
91+
| `nvme_ns_verify` | |
92+
| `nvme_ns_write_uncorrectable` | |
93+
| `nvme_ns_write_zeros` | |
94+
| `nvme_ns_write` | |
95+
| `nvme_path_get_ctrl` | |
96+
| `nvme_path_get_ns` | |
97+
| `nvme_path_get_queue_depth` | |
98+
| `nvme_read_config` | |
99+
| `nvme_refresh_topology` | |
100+
| `nvme_release_fds` | |
101+
| `nvme_rescan_ctrl` | |
102+
| `nvme_scan_ctrl` | |
103+
| `nvme_scan_namespace` | |
104+
| `nvme_scan_topology` | |
105+
| `nvme_set_application` | |
106+
| `nvme_skip_namespaces` | |
107+
| `nvme_subsystem_first_ctrl` | |
108+
| `nvme_subsystem_first_ns` | |
109+
| `nvme_subsystem_for_each_ctrl_safe` | |
110+
| `nvme_subsystem_for_each_ctrl` | |
111+
| `nvme_subsystem_for_each_ns_safe` |
112+
| `nvme_subsystem_for_each_ns` | |
113+
| `nvme_subsystem_get_fw_rev` | |
114+
| `nvme_subsystem_get_host` | |
115+
| `nvme_subsystem_get_nqn` | |
116+
| `nvme_subsystem_get_type` | |
117+
| `nvme_subsystem_get` | `nvme_get_subsystem` |
118+
| `nvme_subsystem_lookup_namespace` | |
119+
| `nvme_subsystem_next_ctrl` | |
120+
| `nvme_subsystem_next_ns` | |
121+
| `nvme_subsystem_release_fds` | |
122+
| `nvme_unlink_ctrl` | |
123+
---
124+
125+
## linux.h — Linux-specific key and identity utilities
126+
127+
| Function | Suggested Name |
128+
|-----------------------------------------|-------------------------------------|
129+
| `nvme_describe_key_serial` | |
130+
| `nvme_export_tls_key_versioned` | |
131+
| `nvme_export_tls_key` | |
132+
| `nvme_gen_dhchap_key` | |
133+
| `nvme_generate_tls_key_identity_compat` | |
134+
| `nvme_generate_tls_key_identity` | |
135+
| `nvme_hostid_from_file` | `nvme_read_hostid` |
136+
| `nvme_hostid_generate` | `nvme_generate_hostid` |
137+
| `nvme_hostnqn_from_file` | `nvme_read_hostnqn` |
138+
| `nvme_hostnqn_generate_from_hostid` | `nvme_generate_hostnqn_from_hostid` |
139+
| `nvme_hostnqn_generate` | `nvme_generate_hostnqn` |
140+
| `nvme_import_tls_key_versioned` | |
141+
| `nvme_import_tls_key` | |
142+
| `nvme_insert_tls_key_compat` | |
143+
| `nvme_insert_tls_key_versioned` | |
144+
| `nvme_insert_tls_key` | |
145+
| `nvme_lookup_key` | |
146+
| `nvme_lookup_keyring` | |
147+
| `nvme_read_key` | |
148+
| `nvme_revoke_tls_key` | |
149+
| `nvme_scan_tls_keys` | |
150+
| `nvme_set_keyring` | |
151+
| `nvme_update_key` | |
152+
153+
---
154+
155+
## lib.h — libnvme library context and device management
156+
157+
| Function | Suggested Name |
158+
|------------------------------------------|----------------|
159+
| `nvme_close` | |
160+
| `nvme_create_global_ctx` | |
161+
| `nvme_free_global_ctx` | |
162+
| `nvme_get_logging_level` | |
163+
| `nvme_open` | |
164+
| `nvme_set_dry_run` | |
165+
| `nvme_set_ioctl_probing` | |
166+
| `nvme_set_logging_level` | |
167+
| `nvme_set_probe_enabled` | |
168+
| `nvme_transport_handle_get_fd` | |
169+
| `nvme_transport_handle_get_name` | |
170+
| `nvme_transport_handle_is_blkdev` | |
171+
| `nvme_transport_handle_is_chardev` | |
172+
| `nvme_transport_handle_is_direct` | |
173+
| `nvme_transport_handle_is_mi` | |
174+
| `nvme_transport_handle_set_decide_retry` | |
175+
| `nvme_transport_handle_set_submit_entry` | |
176+
| `nvme_transport_handle_set_submit_exit` | |
177+
178+
---
179+
180+
## ioctl.h — NVMe IOCTL passthrough interface
181+
182+
| Function | Suggested Name |
183+
|------------------------------|------------------------|
184+
| `nvme_ctrl_reset` | `nvme_reset_ctrl` |
185+
| `nvme_get_nsid` | |
186+
| `nvme_ns_rescan` | `nvme_rescan_ns` |
187+
| `nvme_submit_admin_passthru` | |
188+
| `nvme_submit_io_passthru` | |
189+
| `nvme_subsystem_reset` | `nvme_reset_subsystem` |
190+
191+
---
192+
193+
## filters.h — libnvme directory filter
194+
195+
| Function | Suggested Name |
196+
|----------------------------------|-------------------------|
197+
| `nvme_ctrls_filter` | `nvme_filter_ctrls` |
198+
| `nvme_namespace_filter` | `nvme_filter_namespace` |
199+
| `nvme_paths_filter` | `nvme_filter_paths` |
200+
| `nvme_scan_ctrl_namespace_paths` | |
201+
| `nvme_scan_ctrl_namespaces` | |
202+
| `nvme_scan_ctrls` | |
203+
| `nvme_scan_ns_head_paths` | |
204+
| `nvme_scan_subsystem_namespaces` | |
205+
| `nvme_scan_subsystems` | |
206+
| `nvme_subsys_filter` | `nvme_filter_subsys` |
207+
208+
---
209+
210+
## fabrics.h — NVMe-oF fabrics helper functions
211+
212+
| Function | Suggested Name |
213+
|------------------|----------------|
214+
| `nvme_parse_uri` | |
215+
216+
---
217+
218+
## nbft.h — NVM Express Boot Firmware Table (NBFT) parser
219+
220+
| Function | Suggested Name |
221+
|------------------|------------------|
222+
| `nvme_nbft_free` | `nvme_free_nbft` |
223+
| `nvme_nbft_read` | `nvme_read_nbft` |
224+
225+
---
226+
227+
## util.h — libnvme utility functions
228+
229+
| Function | Suggested Name |
230+
|-------------------------------------|--------------------|
231+
| `nvme_basename` | |
232+
| `nvme_errno_to_string` | |
233+
| `nvme_get_version` | |
234+
| `nvme_opcode_status_to_string` | |
235+
| `nvme_sanitize_ns_status_to_string` | |
236+
| `nvme_status_to_errno` | |
237+
| `nvme_status_to_string` | |
238+
| `nvme_strerror` | |
239+
| `nvme_uuid_find` | `nvme_find_uuid` |
240+
| `nvme_uuid_from_string` | |
241+
| `nvme_uuid_random` | `nvme_random_uuid` |
242+
| `nvme_uuid_to_string` | |

0 commit comments

Comments
 (0)