build: add an option to specify a list of plugins to include

By default, nvme-cli builds with all available plugins. However, there
are some users who are not intersted in some particular plugins or they
aim to create the smallest binaries possible. This patch introduces that
feature into the nvme-cli's build system.

Closes: #2907
Signed-off-by: Michal Rábek <[email protected]>

Author: MichaelRabek

Makefile

@@ -9,12 +9,17 @@ NAME          := nvme
 .DEFAULT_GOAL := ${NAME}
 BUILD-DIR     := .build
 
+# Allow PLUGINS variable as a shorthand for MESON_ARGS
+ifdef PLUGINS
+	MESON_ARGS += -Dplugins=$(PLUGINS)
+endif
+
 .PHONY: update-subprojects
 update-subprojects:
 	meson subprojects update
 
 ${BUILD-DIR}:
-	meson setup $@
+	meson setup $@ ${MESON_ARGS}
 	@echo "Configuration located in: $@"
 	@echo "-------------------------------------------------------"
 
@@ -55,20 +60,21 @@ test-strict: ${NAME}
 
 .PHONY: rpm
 rpm:
-	meson setup ${BUILD-DIR} \
+	meson setup ${BUILD-DIR} ${MESON_ARGS} \
 		-Dudevrulesdir=$(shell rpm --eval '%{_udevrulesdir}') \
 		-Dsystemddir=$(shell rpm --eval '%{_unitdir}') \
 		-Ddocs=man -Ddocs-build=true
 	rpmbuild -ba ${BUILD-DIR}/nvme.spec --define "_builddir ${BUILD-DIR}" -v
 
 .PHONY: debug
 debug:
-	meson setup ${BUILD-DIR} --buildtype=debug
+	meson setup ${BUILD-DIR} ${MESON_ARGS} --buildtype=debug
 	meson compile -C ${BUILD-DIR}
 
 .PHONY: static
 static:
-	meson setup ${BUILD-DIR} --buildtype=release \
+	meson setup ${BUILD-DIR} ${MESON_ARGS}
+		--buildtype=release \
 		--wrap-mode=forcefallback \
 		--default-library=static \
 		--prefix=/usr \

README.md

@@ -113,7 +113,26 @@ If not sure how to use, find the top-level documentation with:
 Or find a short summary with:
 
 	$ nvme help
-	
+
+### Building with specific plugins
+
+By default, all vendor plugins are built. To build only specific plugins, use the `plugins` option:
+
+	$ meson setup .build -Dplugins=intel,wdc,ocp
+	$ meson compile -C .build
+
+Or with the Makefile wrapper:
+
+	$ make PLUGINS="intel,wdc,ocp"
+
+When `PLUGINS` is not used, the value defaults to `all`, which selects all plugins:
+
+	$ make PLUGINS="all"
+
+To build without any vendor plugins:
+
+	$ make PLUGINS=""
+
 ## Distro Support
 
 Many popular distributions (Alpine, Arch, Debian, Fedora, FreeBSD, Gentoo,

meson_options.txt

@@ -142,3 +142,9 @@ option(
   value : false,
   description : 'building for PyPI (use short soversion, e.g. libnvme.so.3)'
 )
+option(
+  'plugins',
+  type : 'array',
+  value: ['all'],
+  description : 'comma-separated list of plugins to build (all plugins are included if unset, [] = no plugins)'
+)

plugins/meson.build

@@ -1,45 +1,81 @@
 # SPDX-License-Identifier: GPL-2.0-or-later
 
-plugin_sources = [
-    'plugins/amzn/amzn-nvme.c',
-    'plugins/dapustor/dapustor-nvme.c',
-    'plugins/dell/dell-nvme.c',
-    'plugins/dera/dera-nvme.c',
-    'plugins/fdp/fdp.c',
-    'plugins/huawei/huawei-nvme.c',
-    'plugins/ibm/ibm-nvme.c',
-    'plugins/innogrit/innogrit-nvme.c',
-    'plugins/inspur/inspur-nvme.c',
-    'plugins/intel/intel-nvme.c',
-    'plugins/mangoboost/mangoboost-nvme.c',
-    'plugins/memblaze/memblaze-nvme.c',
-    'plugins/micron/micron-nvme.c',
-    'plugins/nbft/nbft-plugin.c',
-    'plugins/netapp/netapp-nvme.c',
-    'plugins/nvidia/nvidia-nvme.c',
-    'plugins/sandisk/sandisk-nvme.c',
-    'plugins/sandisk/sandisk-utils.c',
-    'plugins/scaleflux/sfx-nvme.c',
-    'plugins/seagate/seagate-nvme.c',
-    'plugins/shannon/shannon-nvme.c',
-    'plugins/ssstc/ssstc-nvme.c',
-    'plugins/toshiba/toshiba-nvme.c',
-    'plugins/transcend/transcend-nvme.c',
-    'plugins/virtium/virtium-nvme.c',
-    'plugins/wdc/wdc-nvme.c',
-    'plugins/wdc/wdc-utils.c',
-    'plugins/ymtc/ymtc-nvme.c',
-    'plugins/zns/zns.c',
-]
-
-subdir('feat')
-subdir('lm')
-subdir('ocp')
-
-if conf.get('HAVE_SED_OPAL') != 0
-    subdir('sed')
+# Define all available plugins and their source files
+all_plugins = {
+  'amzn': ['plugins/amzn/amzn-nvme.c'],
+  'dapustor': ['plugins/dapustor/dapustor-nvme.c'],
+  'dell': ['plugins/dell/dell-nvme.c'],
+  'dera': ['plugins/dera/dera-nvme.c'],
+  'fdp': ['plugins/fdp/fdp.c'],
+  'huawei': ['plugins/huawei/huawei-nvme.c'],
+  'ibm': ['plugins/ibm/ibm-nvme.c'],
+  'innogrit': ['plugins/innogrit/innogrit-nvme.c'],
+  'inspur': ['plugins/inspur/inspur-nvme.c'],
+  'intel': ['plugins/intel/intel-nvme.c'],
+  'mangoboost': ['plugins/mangoboost/mangoboost-nvme.c'],
+  'memblaze': ['plugins/memblaze/memblaze-nvme.c'],
+  'micron': ['plugins/micron/micron-nvme.c'],
+  'nbft': ['plugins/nbft/nbft-plugin.c'],
+  'netapp': ['plugins/netapp/netapp-nvme.c'],
+  'nvidia': ['plugins/nvidia/nvidia-nvme.c'],
+  'sandisk': ['plugins/sandisk/sandisk-nvme.c', 'plugins/sandisk/sandisk-utils.c'],
+  'scaleflux': ['plugins/scaleflux/sfx-nvme.c'],
+  'seagate': ['plugins/seagate/seagate-nvme.c'],
+  'shannon': ['plugins/shannon/shannon-nvme.c'],
+  'ssstc': ['plugins/ssstc/ssstc-nvme.c'],
+  'toshiba': ['plugins/toshiba/toshiba-nvme.c'],
+  'transcend': ['plugins/transcend/transcend-nvme.c'],
+  'virtium': ['plugins/virtium/virtium-nvme.c'],
+  'wdc': ['plugins/wdc/wdc-nvme.c', 'plugins/wdc/wdc-utils.c'],
+  'ymtc': ['plugins/ymtc/ymtc-nvme.c'],
+  'zns': ['plugins/zns/zns.c'],
+}
+
+# Get the list of plugins to build
+plugins_option = get_option('plugins')
+
+build_all = false
+if plugins_option == []
+  # Build no plugins when explicitly set to empty
+  selected_plugins = []
+elif plugins_option == ['all']
+  # Build all plugins (default)
+  selected_plugins = all_plugins.keys()
+  build_all = true
+else
+  selected_plugins = plugins_option
+endif
+
+# Build the plugin_sources list from simple plugins
+plugin_sources = []
+foreach plugin_name : selected_plugins
+  plugin_name_stripped = plugin_name.strip()
+  if plugin_name_stripped in all_plugins
+    plugin_sources += all_plugins[plugin_name_stripped]
+  elif plugin_name_stripped != ''
+    # Only warn if it's not a special plugin handled below
+    if plugin_name_stripped not in ['feat', 'lm', 'ocp', 'sed', 'solidigm']
+      warning('Unknown plugin: @0@'.format(plugin_name_stripped))
+    endif
+  endif
+endforeach
+
+if build_all or 'feat' in selected_plugins
+  subdir('feat')
+endif
+
+if build_all or 'lm' in selected_plugins
+  subdir('lm')
+endif
+
+if build_all or 'ocp' in selected_plugins
+  subdir('ocp')
+endif
+
+if (build_all or 'sed' in selected_plugins) and conf.get('HAVE_SED_OPAL') != 0
+  subdir('sed')
 endif
 
-if json_c_dep.found()
-    subdir('solidigm')
+if (build_all or 'solidigm' in selected_plugins) and json_c_dep.found()
+  subdir('solidigm')
 endif