libnvme: make fabrics optional

The fabrics part is rather large and usually is not necessary for
embedded use cases. Also it is very Linux specific and makes any porting
attempts really hard. Thus make the fabrics part optional.

Signed-off-by: Daniel Wagner <[email protected]>

Author: igaw

libnvme/examples/meson.build

@@ -35,15 +35,17 @@ executable(
     ],
 )
 
-executable(
-    'discover-loop',
-    ['discover-loop.c'],
-    dependencies: [
-        config_dep,
-        ccan_dep,
-        libnvme_dep,
-    ],
-)
+if want_fabrics
+    executable(
+        'discover-loop',
+        ['discover-loop.c'],
+        dependencies: [
+            config_dep,
+            ccan_dep,
+            libnvme_dep,
+        ],
+    )
+endif
 
 executable(
     'mi-mctp',

libnvme/src/libnvme.h libnvme/src/libnvme.h.inlibnvme/src/libnvme.h renamed to libnvme/src/libnvme.h.in

@@ -15,7 +15,7 @@ extern "C" {
 #endif
 
 #include <nvme/cmds.h>
-#include <nvme/fabrics.h>
+@FABRICS_INCLUDE@
 #include <nvme/filters.h>
 #include <nvme/ioctl.h>
 #include <nvme/lib-types.h>

libnvme/src/libnvme.ld

@@ -270,70 +270,6 @@ LIBNVME_3 {
 		nvme_uuid_from_string;
 		nvme_uuid_random;
 		nvme_uuid_to_string;
-		nvmf_add_ctrl;
-		nvmf_adrfam_str;
-		nvmf_cms_str;
-		nvmf_config_modify;
-		nvmf_connect;
-		nvmf_connect_config_json;
-		nvmf_connect_ctrl;
-		nvmf_context_create;
-		nvmf_context_set_connection;
-		nvmf_context_set_crypto;
-		nvmf_context_set_device;
-		nvmf_context_set_discovery_cbs;
-		nvmf_context_set_discovery_defaults;
-		nvmf_context_set_fabrics_config;
-		nvmf_context_set_hostnqn;
-		nvmf_context_set_persistent;
-		nvmf_default_config;
-		nvmf_discovery;
-		nvmf_discovery_config_file;
-		nvmf_discovery_config_json;
-		nvmf_discovery_ctx_already_connected_set;
-		nvmf_discovery_ctx_connected_set;
-		nvmf_discovery_ctx_create;
-		nvmf_discovery_ctx_ctrlkey_set;
-		nvmf_discovery_ctx_decide_retry_set;
-		nvmf_discovery_ctx_default_fabrics_config_set;
-		nvmf_discovery_ctx_device_set;
-		nvmf_discovery_ctx_discovery_log_set;
-		nvmf_discovery_ctx_host_iface_set;
-		nvmf_discovery_ctx_host_traddr_set;
-		nvmf_discovery_ctx_hostid_set;
-		nvmf_discovery_ctx_hostkey_set;
-		nvmf_discovery_ctx_hostnqn_set;
-		nvmf_discovery_ctx_keep_alive_timeout;
-		nvmf_discovery_ctx_keyring_set;
-		nvmf_discovery_ctx_max_retries;
-		nvmf_discovery_ctx_parser_cleanup_set;
-		nvmf_discovery_ctx_parser_init_set;
-		nvmf_discovery_ctx_parser_next_line_set;
-		nvmf_discovery_ctx_persistent_set;
-		nvmf_discovery_ctx_subsysnqn_set;
-		nvmf_discovery_ctx_tls_key_identity_set;
-		nvmf_discovery_ctx_tls_key_set;
-		nvmf_discovery_ctx_traddr_set;
-		nvmf_discovery_ctx_transport_set;
-		nvmf_discovery_ctx_trsvcid_set;
-		nvmf_discovery_nbft;
-		nvmf_eflags_str;
-		nvmf_exat_ptr_next;
-		nvmf_free_uri;
-		nvmf_get_default_trsvcid;
-		nvmf_get_discovery_log;
-		nvmf_get_discovery_wargs;
-		nvmf_is_registration_supported;
-		nvmf_nbft_free;
-		nvmf_nbft_read_files;
-		nvmf_prtype_str;
-		nvmf_qptype_str;
-		nvmf_register_ctrl;
-		nvmf_sectype_str;
-		nvmf_subtype_str;
-		nvmf_treq_str;
-		nvmf_trtype_str;
-		nvmf_update_config;
 	local:
 		*;
 };

libnvme/src/meson.build

@@ -9,7 +9,6 @@ sources = [
     'nvme/base64.c',
     'nvme/cmds.c',
     'nvme/crc32.c',
-    'nvme/fabrics.c',
     'nvme/filters.c',
     'nvme/ioctl.c',
     'nvme/lib.c',
@@ -22,6 +21,28 @@ sources = [
     'nvme/tree.c',
     'nvme/util.c',
 ]
+headers = [
+    'nvme/cmds.h',
+    'nvme/filters.h',
+    'nvme/ioctl.h',
+    'nvme/lib-types.h',
+    'nvme/lib.h',
+    'nvme/linux.h',
+    'nvme/mi.h',
+    'nvme/nbft.h',
+    'nvme/tree.h',
+    'nvme/types.h',
+    'nvme/util.h',
+]
+
+if want_fabrics
+    sources += [
+        'nvme/fabrics.c',
+    ]
+    headers += [
+        'nvme/fabrics.h',
+    ]
+endif
 
 if json_c_dep.found()
     sources += 'nvme/json.c'
@@ -43,16 +64,35 @@ deps = [
     accessors_dep,
 ]
 
-ldfile = 'libnvme.ld'
+nvme_ld = meson.current_source_dir() / 'libnvme.ld'
+nvmf_ld = meson.current_source_dir() / 'libnvmf.ld'
+
+link_args = [
+    '-Wl,--version-script=@0@'.format(nvme_ld),
+    '-Wl,--version-script=@0@'.format(accessors_ld_full_path),
+]
+
+libconf = configuration_data()
+if want_fabrics
+    link_args += '-Wl,--version-script=@0@'.format(nvmf_ld)
+    libconf.set('FABRICS_INCLUDE', '#include <nvme/fabrics.h>')
+else
+    libconf.set('FABRICS_INCLUDE', '')
+endif
+
+libnvme_header = configure_file(
+    input: 'libnvme.h.in',
+    output: 'libnvme.h',
+    configuration: libconf,
+    install: true,
+    install_dir: prefixdir / get_option('includedir') / 'nvme'
+)
 
 libnvme = library(
     'nvme', # produces libnvme.so
     sources,
     version: libnvme_so_version,
-    link_args: [
-        '-Wl,--version-script=@0@'.format(meson.current_source_dir() / ldfile),
-        '-Wl,--version-script=@0@'.format(accessors_ld_full_path),
-    ],
+    link_args: link_args,
     dependencies: deps,
     install: true,
 )
@@ -91,26 +131,12 @@ libnvme_test_dep = declare_dependency(
 mode = 'rw-r--r--'
 install_headers(
     [
-       'libnvme.h',
        'libnvme-mi.h',
     ],
     install_mode: mode,
 )
 install_headers(
-    [
-        'nvme/cmds.h',
-        'nvme/fabrics.h',
-        'nvme/filters.h',
-        'nvme/ioctl.h',
-        'nvme/lib-types.h',
-        'nvme/lib.h',
-        'nvme/linux.h',
-        'nvme/mi.h',
-        'nvme/nbft.h',
-        'nvme/tree.h',
-        'nvme/types.h',
-        'nvme/util.h',
-    ],
+    headers,
     subdir: 'nvme',
     install_mode: mode,
 )

libnvme/src/nvme/tree.c

@@ -1389,7 +1389,10 @@ int nvme_create_ctrl(struct nvme_global_ctx *ctx,
 
 	c->ctx = ctx;
 	c->hdl = NULL;
+#ifdef CONFIG_FABRICS
+	// XXX it's necessary to initialize the defaults...
 	nvmf_default_config(&c->cfg);
+#endif // !CONFIG_FABRICS
 	list_head_init(&c->namespaces);
 	list_head_init(&c->paths);
 	list_node_init(&c->entry);

libnvme/test/ioctl/meson.build

@@ -52,17 +52,19 @@ ana = executable(
 )
 test('libnvme - ana', ana, env: mock_ioctl_env)
 
-discovery = executable(
-    'test-discovery',
-    'discovery.c',
-    dependencies: [
-        config_dep,
-        ccan_dep,
-        libnvme_dep,
-    ],
-    link_with: mock_ioctl,
-)
-test('libnvme - discovery', discovery, env: mock_ioctl_env)
+if want_fabrics
+    discovery = executable(
+        'test-discovery',
+        'discovery.c',
+        dependencies: [
+            config_dep,
+            ccan_dep,
+            libnvme_dep,
+        ],
+        link_with: mock_ioctl,
+    )
+    test('libnvme - discovery', discovery, env: mock_ioctl_env)
+endif
 
 features = executable(
     'test-features',

libnvme/test/meson.build

@@ -101,17 +101,19 @@ uuid = executable(
 
 test('libnvme - uuid', uuid)
 
-uriparser = executable(
-    'test-uriparser',
-    ['uriparser.c'],
-    dependencies: [
-        config_dep,
-        ccan_dep,
-        libnvme_dep,
-    ],
-)
+if want_fabrics
+    uriparser = executable(
+        'test-uriparser',
+        ['uriparser.c'],
+        dependencies: [
+            config_dep,
+            ccan_dep,
+            libnvme_dep,
+        ],
+    )
 
 test('libnvme - uriparser', uriparser)
+endif
 
 if conf.get('HAVE_NETDB')
     mock_ifaddrs = library(

meson.build

@@ -51,6 +51,7 @@ cxx_available = add_languages('cpp', required: false, native: false)
 # dependencies are present. Also, -Dpython=enabled forces -Dlibnvme=enabled.
 want_nvme = get_option('nvme').disabled() == false
 want_libnvme = get_option('libnvme').disabled() == false
+want_fabrics = get_option('fabrics').disabled() == false
 want_docs = get_option('docs')
 want_docs_build = get_option('docs-build')
 
@@ -128,6 +129,8 @@ endif
 conf.set('SYSCONFDIR', '"@0@"'.format(sysconfdir))
 conf.set('RUNDIR', '"@0@"'.format(rundir))
 
+conf.set('CONFIG_FABRICS', want_fabrics, description: 'Is fabrics enabled')
+
 # Check for libjson-c availability
 if get_option('json-c').disabled()
     json_c_dep = dependency('', required: false)
@@ -277,14 +280,14 @@ else
 endif
 
 
-if get_option('liburing').disabled()
+if not want_fabrics or get_option('liburing').disabled()
     liburing_dep = dependency('', required: false)
 else
     liburing_dep = dependency('liburing', version: '>=2.2', required: get_option('liburing'))
 endif
 conf.set('CONFIG_LIBURING', liburing_dep.found(), description: 'Is liburing available?')
 
-if get_option('openssl').disabled()
+if not want_fabrics or get_option('openssl').disabled()
     openssl_dep = dependency('', required: false)
 else
     openssl_dep = dependency(
@@ -313,14 +316,14 @@ if openssl_dep.found()
 endif
 conf.set('CONFIG_OPENSSL', openssl_dep.found(), description: 'Is OpenSSL/LibreSSL available?')
 
-if get_option('keyutils').disabled()
+if not want_fabrics or get_option('keyutils').disabled()
     keyutils_dep = dependency('', required: false)
 else
     keyutils_dep = dependency('libkeyutils', required : get_option('keyutils'))
 endif
 conf.set('CONFIG_KEYUTILS', keyutils_dep.found(), description: 'Is libkeyutils available?')
 
-if get_option('libdbus').disabled()
+if not want_fabrics or get_option('libdbus').disabled()
     libdbus_dep = dependency('', required: false)
 else
     # Check for libdbus availability. Optional, only required for MCTP dbus scan
@@ -630,6 +633,7 @@ summary(dep_dict, section: 'Dependencies', bool_yn: true)
 wanted_dict = {
     'nvme':             want_nvme,
     'libnvme':          want_libnvme,
+    'fabrics':          want_fabrics,
     'python bindings ': want_python,
     'build docs':       want_docs_build,
 }

meson_options.txt

@@ -11,6 +11,12 @@ option(
   value: 'enabled',
   description: 'Build libnvme library'
 )
+option(
+  'fabrics',
+  type : 'feature',
+  value: 'enabled',
+  description : 'NVMeoF support'
+)
 option(
   'python',
   type : 'feature',