diff --git a/.gitignore b/.gitignore index 53a8fcf..9768e37 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -SOURCES/libblockdev-2.25.tar.gz +SOURCES/libblockdev-2.28.tar.gz diff --git a/.libblockdev.metadata b/.libblockdev.metadata index 9d2a0a3..996b28a 100644 --- a/.libblockdev.metadata +++ b/.libblockdev.metadata @@ -1 +1 @@ -c16d236f95a7a88b1d0f5309fdc8823999d297d1 SOURCES/libblockdev-2.25.tar.gz +d32fce132c75d94ad9c033a636906d63027ffba5 SOURCES/libblockdev-2.28.tar.gz diff --git a/SOURCES/0001-Fix-comparing-DM-RAID-member-devices-UUID.patch b/SOURCES/0001-Fix-comparing-DM-RAID-member-devices-UUID.patch deleted file mode 100644 index 0c3eedc..0000000 --- a/SOURCES/0001-Fix-comparing-DM-RAID-member-devices-UUID.patch +++ /dev/null @@ -1,27 +0,0 @@ -From 2da13152619ee7233650339797657b45088b2219 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Tue, 18 Aug 2020 09:44:29 +0200 -Subject: [PATCH] dm: Fix comparing DM RAID member devices UUID - -There is no "UUID" property in UDev we must use the "ID_FS_UUID" -one. -This comparison works only because most DM RAID members don't have -UUID so the check is skipped, but it fails for DDF RAID members -which have a special GUID/UUID in UDev database. ---- - src/plugins/dm.c | 2 +- - 1 file changed, 1 insertion(+), 1 deletion(-) - -diff --git a/src/plugins/dm.c b/src/plugins/dm.c -index a6412028..4ab0d2a4 100644 ---- a/src/plugins/dm.c -+++ b/src/plugins/dm.c -@@ -482,7 +482,7 @@ static gboolean raid_dev_matches_spec (struct raid_dev *raid_dev, const gchar *n - - context = udev_new (); - device = udev_device_new_from_subsystem_sysname (context, "block", dev_name); -- dev_uuid = udev_device_get_property_value (device, "UUID"); -+ dev_uuid = udev_device_get_property_value (device, "ID_FS_UUID"); - major_str = udev_device_get_property_value (device, "MAJOR"); - minor_str = udev_device_get_property_value (device, "MINOR"); - diff --git a/SOURCES/0001-lvm-devices-file-support.patch b/SOURCES/0001-lvm-devices-file-support.patch new file mode 100644 index 0000000..9e38b41 --- /dev/null +++ b/SOURCES/0001-lvm-devices-file-support.patch @@ -0,0 +1,1808 @@ +From 94d707dd225104ba14422eeb43c73b1f742b12da Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Tue, 13 Jul 2021 13:22:05 +0200 +Subject: [PATCH 1/7] lvm: Allow configuring global "device filter" for LVM + commands + +Starting with 2.03.12 LVM introduces a new system for telling LVM +which devices it should use. The old device filters in config are +no longer working and we need to use either the system.devices +config file in /etc/lvm/devices (default behaviour) or specify +all allowed devices using the new --devices option. Because this +option must be specified for every call which might be incovenient +for our users, this commit introduces a new function to configure +this globally, which we already do for the --config option. +--- + src/lib/plugin_apis/lvm.api | 23 +++ + src/plugins/lvm-dbus.c | 75 ++++++++- + src/plugins/lvm.c | 97 ++++++++++-- + src/plugins/lvm.h | 4 + + tests/library_test.py | 304 ++++++++++++++++++++---------------- + tests/lvm_dbus_tests.py | 47 +++++- + tests/lvm_test.py | 50 ++++++ + tests/overrides_test.py | 23 ++- + 8 files changed, 470 insertions(+), 153 deletions(-) + +diff --git a/src/lib/plugin_apis/lvm.api b/src/lib/plugin_apis/lvm.api +index c695c111..23f68b81 100644 +--- a/src/lib/plugin_apis/lvm.api ++++ b/src/lib/plugin_apis/lvm.api +@@ -601,6 +601,7 @@ typedef enum { + BD_LVM_TECH_CACHE_CALCS, + BD_LVM_TECH_GLOB_CONF, + BD_LVM_TECH_VDO, ++ BD_LVM_TECH_DEVICES, + } BDLVMTech; + + typedef enum { +@@ -1214,6 +1215,28 @@ gboolean bd_lvm_set_global_config (const gchar *new_config, GError **error); + */ + gchar* bd_lvm_get_global_config (GError **error); + ++/** ++ * bd_lvm_set_devices_filter: ++ * @devices: (allow-none) (array zero-terminated=1): list of devices for lvm commands to work on ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the devices filter was successfully set or not ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gboolean bd_lvm_set_devices_filter (const gchar **devices, GError **error); ++ ++/** ++ * bd_lvm_get_devices_filter: ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: (transfer full) (array zero-terminated=1): a copy of a string representation of ++ * the currently set LVM devices filter ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gchar** bd_lvm_get_devices_filter (GError **error); ++ + /** + * bd_lvm_cache_get_default_md_size: + * @cache_size: size of the cache to determine MD size for +diff --git a/src/plugins/lvm-dbus.c b/src/plugins/lvm-dbus.c +index 51572c9a..b47ed0ef 100644 +--- a/src/plugins/lvm-dbus.c ++++ b/src/plugins/lvm-dbus.c +@@ -35,6 +35,8 @@ + static GMutex global_config_lock; + static gchar *global_config_str = NULL; + ++static gchar *global_devices_str = NULL; ++ + #define LVM_BUS_NAME "com.redhat.lvmdbus1" + #define LVM_OBJ_PREFIX "/com/redhat/lvmdbus1" + #define MANAGER_OBJ "/com/redhat/lvmdbus1/Manager" +@@ -241,11 +243,20 @@ static gboolean setup_dbus_connection (GError **error) { + return TRUE; + } + ++static volatile guint avail_deps = 0; + static volatile guint avail_dbus_deps = 0; + static volatile guint avail_features = 0; + static volatile guint avail_module_deps = 0; + static GMutex deps_check_lock; + ++#define DEPS_LVMDEVICES 0 ++#define DEPS_LVMDEVICES_MASK (1 << DEPS_LVMDEVICES) ++#define DEPS_LAST 1 ++ ++static const UtilDep deps[DEPS_LAST] = { ++ {"lvmdevices", NULL, NULL, NULL}, ++}; ++ + #define DBUS_DEPS_LVMDBUSD 0 + #define DBUS_DEPS_LVMDBUSD_MASK (1 << DBUS_DEPS_LVMDBUSD) + #define DBUS_DEPS_LAST 1 +@@ -378,6 +389,8 @@ gboolean bd_lvm_is_tech_avail (BDLVMTech tech, guint64 mode, GError **error) { + return check_dbus_deps (&avail_dbus_deps, DBUS_DEPS_LVMDBUSD_MASK, dbus_deps, DBUS_DEPS_LAST, &deps_check_lock, error) && + check_features (&avail_features, FEATURES_VDO_MASK, features, FEATURES_LAST, &deps_check_lock, error) && + check_module_deps (&avail_module_deps, MODULE_DEPS_VDO_MASK, module_deps, MODULE_DEPS_LAST, &deps_check_lock, error); ++ case BD_LVM_TECH_DEVICES: ++ return check_deps (&avail_deps, DEPS_LVMDEVICES_MASK, deps, DEPS_LAST, &deps_check_lock, error); + default: + /* everything is supported by this implementation of the plugin */ + return check_dbus_deps (&avail_dbus_deps, DBUS_DEPS_LVMDBUSD_MASK, dbus_deps, DBUS_DEPS_LAST, &deps_check_lock, error); +@@ -515,6 +528,7 @@ static gboolean unbox_params_and_add (GVariant *params, GVariantBuilder *builder + + static GVariant* call_lvm_method (const gchar *obj, const gchar *intf, const gchar *method, GVariant *params, GVariant *extra_params, const BDExtraArg **extra_args, guint64 *task_id, guint64 *progress_id, gboolean lock_config, GError **error) { + GVariant *config = NULL; ++ GVariant *devices = NULL; + GVariant *param = NULL; + GVariantIter iter; + GVariantBuilder builder; +@@ -536,8 +550,8 @@ static GVariant* call_lvm_method (const gchar *obj, const gchar *intf, const gch + if (lock_config) + g_mutex_lock (&global_config_lock); + +- if (global_config_str || extra_params || extra_args) { +- if (global_config_str || extra_args) { ++ if (global_config_str || global_devices_str || extra_params || extra_args) { ++ if (global_config_str || global_devices_str || extra_args) { + /* add the global config to the extra_params */ + g_variant_builder_init (&extra_builder, G_VARIANT_TYPE_DICTIONARY); + +@@ -558,6 +572,11 @@ static GVariant* call_lvm_method (const gchar *obj, const gchar *intf, const gch + g_variant_builder_add (&extra_builder, "{sv}", "--config", config); + added_extra = TRUE; + } ++ if (global_devices_str) { ++ devices = g_variant_new ("s", global_devices_str); ++ g_variant_builder_add (&extra_builder, "{sv}", "--devices", devices); ++ added_extra = TRUE; ++ } + + if (added_extra) + config_extra_params = g_variant_builder_end (&extra_builder); +@@ -2654,6 +2673,58 @@ gchar* bd_lvm_get_global_config (GError **error UNUSED) { + return ret; + } + ++/** ++ * bd_lvm_set_devices_filter: ++ * @devices: (allow-none) (array zero-terminated=1): list of devices for lvm commands to work on ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the devices filter was successfully set or not ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gboolean bd_lvm_set_devices_filter (const gchar **devices, GError **error) { ++ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) ++ return FALSE; ++ ++ g_mutex_lock (&global_config_lock); ++ ++ /* first free the old value */ ++ g_free (global_devices_str); ++ ++ /* now store the new one */ ++ if (!devices || !(*devices)) ++ global_devices_str = NULL; ++ else ++ global_devices_str = g_strjoinv (",", (gchar **) devices); ++ ++ g_mutex_unlock (&global_config_lock); ++ return TRUE; ++} ++ ++/** ++ * bd_lvm_get_devices_filter: ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: (transfer full) (array zero-terminated=1): a copy of a string representation of ++ * the currently set LVM devices filter ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gchar** bd_lvm_get_devices_filter (GError **error UNUSED) { ++ gchar **ret = NULL; ++ ++ g_mutex_lock (&global_config_lock); ++ ++ if (global_devices_str) ++ ret = g_strsplit (global_devices_str, ",", -1); ++ else ++ ret = NULL; ++ ++ g_mutex_unlock (&global_config_lock); ++ ++ return ret; ++} ++ + /** + * bd_lvm_cache_get_default_md_size: + * @cache_size: size of the cache to determine MD size for +diff --git a/src/plugins/lvm.c b/src/plugins/lvm.c +index 26af0d19..42ee0f90 100644 +--- a/src/plugins/lvm.c ++++ b/src/plugins/lvm.c +@@ -34,6 +34,8 @@ + static GMutex global_config_lock; + static gchar *global_config_str = NULL; + ++static gchar *global_devices_str = NULL; ++ + /** + * SECTION: lvm + * @short_description: plugin for operations with LVM +@@ -212,10 +214,13 @@ static GMutex deps_check_lock; + + #define DEPS_LVM 0 + #define DEPS_LVM_MASK (1 << DEPS_LVM) +-#define DEPS_LAST 1 ++#define DEPS_LVMDEVICES 1 ++#define DEPS_LVMDEVICES_MASK (1 << DEPS_LVMDEVICES) ++#define DEPS_LAST 2 + + static const UtilDep deps[DEPS_LAST] = { + {"lvm", LVM_MIN_VERSION, "version", "LVM version:\\s+([\\d\\.]+)"}, ++ {"lvmdevices", NULL, NULL, NULL}, + }; + + #define FEATURES_VDO 0 +@@ -327,6 +332,8 @@ gboolean bd_lvm_is_tech_avail (BDLVMTech tech, guint64 mode, GError **error) { + case BD_LVM_TECH_VDO: + return check_features (&avail_features, FEATURES_VDO_MASK, features, FEATURES_LAST, &deps_check_lock, error) && + check_module_deps (&avail_module_deps, MODULE_DEPS_VDO_MASK, module_deps, MODULE_DEPS_LAST, &deps_check_lock, error); ++ case BD_LVM_TECH_DEVICES: ++ return check_deps (&avail_deps, DEPS_LVMDEVICES_MASK, deps, DEPS_LAST, &deps_check_lock, error); + default: + /* everything is supported by this implementation of the plugin */ + return check_deps (&avail_deps, DEPS_LVM_MASK, deps, DEPS_LAST, &deps_check_lock, error); +@@ -337,6 +344,8 @@ static gboolean call_lvm_and_report_error (const gchar **args, const BDExtraArg + gboolean success = FALSE; + guint i = 0; + guint args_length = g_strv_length ((gchar **) args); ++ g_autofree gchar *config_arg = NULL; ++ g_autofree gchar *devices_arg = NULL; + + if (!check_deps (&avail_deps, DEPS_LVM_MASK, deps, DEPS_LAST, &deps_check_lock, error)) + return FALSE; +@@ -345,20 +354,26 @@ static gboolean call_lvm_and_report_error (const gchar **args, const BDExtraArg + if (lock_config) + g_mutex_lock (&global_config_lock); + +- /* allocate enough space for the args plus "lvm", "--config" and NULL */ +- const gchar **argv = g_new0 (const gchar*, args_length + 3); ++ /* allocate enough space for the args plus "lvm", "--config", "--devices" and NULL */ ++ const gchar **argv = g_new0 (const gchar*, args_length + 4); + + /* construct argv from args with "lvm" prepended */ + argv[0] = "lvm"; + for (i=0; i < args_length; i++) + argv[i+1] = args[i]; +- argv[args_length + 1] = global_config_str ? g_strdup_printf("--config=%s", global_config_str) : NULL; +- argv[args_length + 2] = NULL; ++ if (global_config_str) { ++ config_arg = g_strdup_printf("--config=%s", global_config_str); ++ argv[++args_length] = config_arg; ++ } ++ if (global_devices_str) { ++ devices_arg = g_strdup_printf("--devices=%s", global_devices_str); ++ argv[++args_length] = devices_arg; ++ } ++ argv[++args_length] = NULL; + + success = bd_utils_exec_and_report_error (argv, extra, error); + if (lock_config) + g_mutex_unlock (&global_config_lock); +- g_free ((gchar *) argv[args_length + 1]); + g_free (argv); + + return success; +@@ -368,6 +383,8 @@ static gboolean call_lvm_and_capture_output (const gchar **args, const BDExtraAr + gboolean success = FALSE; + guint i = 0; + guint args_length = g_strv_length ((gchar **) args); ++ g_autofree gchar *config_arg = NULL; ++ g_autofree gchar *devices_arg = NULL; + + if (!check_deps (&avail_deps, DEPS_LVM_MASK, deps, DEPS_LAST, &deps_check_lock, error)) + return FALSE; +@@ -375,19 +392,25 @@ static gboolean call_lvm_and_capture_output (const gchar **args, const BDExtraAr + /* don't allow global config string changes during the run */ + g_mutex_lock (&global_config_lock); + +- /* allocate enough space for the args plus "lvm", "--config" and NULL */ +- const gchar **argv = g_new0 (const gchar*, args_length + 3); ++ /* allocate enough space for the args plus "lvm", "--config", "--devices" and NULL */ ++ const gchar **argv = g_new0 (const gchar*, args_length + 4); + + /* construct argv from args with "lvm" prepended */ + argv[0] = "lvm"; + for (i=0; i < args_length; i++) + argv[i+1] = args[i]; +- argv[args_length + 1] = global_config_str ? g_strdup_printf("--config=%s", global_config_str) : NULL; +- argv[args_length + 2] = NULL; ++ if (global_config_str) { ++ config_arg = g_strdup_printf("--config=%s", global_config_str); ++ argv[++args_length] = config_arg; ++ } ++ if (global_devices_str) { ++ devices_arg = g_strdup_printf("--devices=%s", global_devices_str); ++ argv[++args_length] = devices_arg; ++ } ++ argv[++args_length] = NULL; + + success = bd_utils_exec_and_capture_output (argv, extra, output, error); + g_mutex_unlock (&global_config_lock); +- g_free ((gchar *) argv[args_length + 1]); + g_free (argv); + + return success; +@@ -2033,6 +2056,58 @@ gchar* bd_lvm_get_global_config (GError **error UNUSED) { + return ret; + } + ++/** ++ * bd_lvm_set_devices_filter: ++ * @devices: (allow-none) (array zero-terminated=1): list of devices for lvm commands to work on ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the devices filter was successfully set or not ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gboolean bd_lvm_set_devices_filter (const gchar **devices, GError **error) { ++ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) ++ return FALSE; ++ ++ g_mutex_lock (&global_config_lock); ++ ++ /* first free the old value */ ++ g_free (global_devices_str); ++ ++ /* now store the new one */ ++ if (!devices || !(*devices)) ++ global_devices_str = NULL; ++ else ++ global_devices_str = g_strjoinv (",", (gchar **) devices); ++ ++ g_mutex_unlock (&global_config_lock); ++ return TRUE; ++} ++ ++/** ++ * bd_lvm_get_devices_filter: ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: (transfer full) (array zero-terminated=1): a copy of a string representation of ++ * the currently set LVM devices filter ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gchar** bd_lvm_get_devices_filter (GError **error UNUSED) { ++ gchar **ret = NULL; ++ ++ g_mutex_lock (&global_config_lock); ++ ++ if (global_devices_str) ++ ret = g_strsplit (global_devices_str, ",", -1); ++ else ++ ret = NULL; ++ ++ g_mutex_unlock (&global_config_lock); ++ ++ return ret; ++} ++ + /** + * bd_lvm_cache_get_default_md_size: + * @cache_size: size of the cache to determine MD size for +diff --git a/src/plugins/lvm.h b/src/plugins/lvm.h +index 2162d769..8063693f 100644 +--- a/src/plugins/lvm.h ++++ b/src/plugins/lvm.h +@@ -216,6 +216,7 @@ typedef enum { + BD_LVM_TECH_CACHE_CALCS, + BD_LVM_TECH_GLOB_CONF, + BD_LVM_TECH_VDO, ++ BD_LVM_TECH_DEVICES, + } BDLVMTech; + + typedef enum { +@@ -289,6 +290,9 @@ gboolean bd_lvm_thsnapshotcreate (const gchar *vg_name, const gchar *origin_name + gboolean bd_lvm_set_global_config (const gchar *new_config, GError **error); + gchar* bd_lvm_get_global_config (GError **error); + ++gboolean bd_lvm_set_devices_filter (const gchar **devices, GError **error); ++gchar** bd_lvm_get_devices_filter (GError **error); ++ + guint64 bd_lvm_cache_get_default_md_size (guint64 cache_size, GError **error); + const gchar* bd_lvm_cache_get_mode_str (BDLVMCacheMode mode, GError **error); + BDLVMCacheMode bd_lvm_cache_get_mode_from_str (const gchar *mode_str, GError **error); +diff --git a/tests/library_test.py b/tests/library_test.py +index 08e44fdc..efd17bd2 100644 +--- a/tests/library_test.py ++++ b/tests/library_test.py +@@ -13,18 +13,178 @@ class LibraryOpsTestCase(unittest.TestCase): + # all plugins except for 'btrfs', 'fs' and 'mpath' -- these don't have all + # the dependencies on CentOS/Debian and we don't need them for this test + requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "dm", +- "kbd", "loop", "lvm", ++ "kbd", "loop", + "mdraid", "part", "swap")) + ++ @classmethod ++ def setUpClass(cls): ++ if not BlockDev.is_initialized(): ++ BlockDev.init(cls.requested_plugins, None) ++ else: ++ BlockDev.reinit(cls.requested_plugins, True, None) ++ ++ @classmethod ++ def tearDownClass(cls): ++ BlockDev.switch_init_checks(True) ++ ++ def my_log_func(self, level, msg): ++ # not much to verify here ++ self.assertTrue(isinstance(level, int)) ++ self.assertTrue(isinstance(msg, str)) ++ ++ self.log += msg + "\n" ++ ++ @tag_test(TestTags.CORE) ++ def test_logging_setup(self): ++ """Verify that setting up logging works as expected""" ++ ++ self.assertTrue(BlockDev.reinit(self.requested_plugins, False, self.my_log_func)) ++ ++ succ = BlockDev.utils_exec_and_report_error(["true"]) ++ self.assertTrue(succ) ++ ++ # reinit with no logging function should change nothing about logging ++ self.assertTrue(BlockDev.reinit(self.requested_plugins, False, None)) ++ ++ succ, out = BlockDev.utils_exec_and_capture_output(["echo", "hi"]) ++ self.assertTrue(succ) ++ self.assertEqual(out, "hi\n") ++ ++ match = re.search(r'Running \[(\d+)\] true', self.log) ++ self.assertIsNot(match, None) ++ task_id1 = match.group(1) ++ match = re.search(r'Running \[(\d+)\] echo hi', self.log) ++ self.assertIsNot(match, None) ++ task_id2 = match.group(1) ++ ++ self.assertIn("...done [%s] (exit code: 0)" % task_id1, self.log) ++ self.assertIn("stdout[%s]:" % task_id1, self.log) ++ self.assertIn("stderr[%s]:" % task_id1, self.log) ++ ++ self.assertIn("stdout[%s]: hi" % task_id2, self.log) ++ self.assertIn("stderr[%s]:" % task_id2, self.log) ++ self.assertIn("...done [%s] (exit code: 0)" % task_id2, self.log) ++ ++ @tag_test(TestTags.CORE) ++ def test_require_plugins(self): ++ """Verify that loading only required plugins works as expected""" ++ ++ ps = BlockDev.PluginSpec() ++ ps.name = BlockDev.Plugin.SWAP ++ ps.so_name = "" ++ self.assertTrue(BlockDev.reinit([ps], True, None)) ++ self.assertEqual(BlockDev.get_available_plugin_names(), ["swap"]) ++ self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) ++ ++ @tag_test(TestTags.CORE) ++ def test_not_implemented(self): ++ """Verify that unloaded/unimplemented functions report errors""" ++ ++ # should be loaded and working ++ self.assertTrue(BlockDev.md_canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236")) ++ ++ ps = BlockDev.PluginSpec() ++ ps.name = BlockDev.Plugin.SWAP ++ ps.so_name = "" ++ self.assertTrue(BlockDev.reinit([ps], True, None)) ++ self.assertEqual(BlockDev.get_available_plugin_names(), ["swap"]) ++ ++ # no longer loaded ++ with self.assertRaises(GLib.GError): ++ BlockDev.md_canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236") ++ ++ self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) ++ ++ # loaded again ++ self.assertTrue(BlockDev.md_canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236")) ++ ++ def test_ensure_init(self): ++ """Verify that ensure_init just returns when already initialized""" ++ ++ # the library is already initialized, ensure_init() shonuld do nothing ++ avail_plugs = BlockDev.get_available_plugin_names() ++ self.assertTrue(BlockDev.ensure_init(self.requested_plugins, None)) ++ self.assertEqual(avail_plugs, BlockDev.get_available_plugin_names()) ++ ++ # reinit with a subset of plugins ++ plugins = BlockDev.plugin_specs_from_names(["swap", "part"]) ++ self.assertTrue(BlockDev.reinit(plugins, True, None)) ++ self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "part"])) ++ ++ # ensure_init with the same subset -> nothing should change ++ self.assertTrue(BlockDev.ensure_init(plugins, None)) ++ self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "part"])) ++ ++ # ensure_init with more plugins -> extra plugins should be loaded ++ plugins = BlockDev.plugin_specs_from_names(["swap", "part", "crypto"]) ++ self.assertTrue(BlockDev.ensure_init(plugins, None)) ++ self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "part", "crypto"])) ++ ++ # reinit to unload all plugins ++ self.assertTrue(BlockDev.reinit([], True, None)) ++ self.assertEqual(BlockDev.get_available_plugin_names(), []) ++ ++ # ensure_init to load all plugins back ++ self.assertTrue(BlockDev.ensure_init(self.requested_plugins, None)) ++ self.assertGreaterEqual(len(BlockDev.get_available_plugin_names()), 7) ++ ++ def test_try_reinit(self): ++ """Verify that try_reinit() works as expected""" ++ ++ # try reinitializing with only some utilities being available and thus ++ # only some plugins able to load ++ with fake_path("tests/lib_missing_utils", keep_utils=["swapon", "swapoff", "mkswap", "swaplabel"]): ++ succ, loaded = BlockDev.try_reinit(self.requested_plugins, True, None) ++ self.assertFalse(succ) ++ for plug_name in ("swap", "crypto"): ++ self.assertIn(plug_name, loaded) ++ ++ # reset back to all plugins ++ self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) ++ ++ # now the same with a subset of plugins requested ++ plugins = BlockDev.plugin_specs_from_names(["swap", "crypto"]) ++ with fake_path("tests/lib_missing_utils", keep_utils=["swapon", "swapoff", "mkswap", "swaplabel"]): ++ succ, loaded = BlockDev.try_reinit(plugins, True, None) ++ self.assertTrue(succ) ++ self.assertEqual(set(loaded), set(["swap", "crypto"])) ++ ++ def test_non_en_init(self): ++ """Verify that the library initializes with lang different from en_US""" ++ ++ orig_lang = os.environ.get("LANG") ++ os.environ["LANG"] = "cs.CZ_UTF-8" ++ self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) ++ if orig_lang: ++ os.environ["LANG"] = orig_lang ++ else: ++ del os.environ["LANG"] ++ self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) ++ ++ ++class PluginsTestCase(unittest.TestCase): ++ # only LVM plugin for this test ++ requested_plugins = BlockDev.plugin_specs_from_names(("lvm",)) ++ + orig_config_dir = "" + + @classmethod + def setUpClass(cls): ++ BlockDev.switch_init_checks(False) + if not BlockDev.is_initialized(): + BlockDev.init(cls.requested_plugins, None) + else: + BlockDev.reinit(cls.requested_plugins, True, None) + ++ try: ++ cls.devices_avail = BlockDev.lvm_is_tech_avail(BlockDev.LVMTech.DEVICES, 0) ++ except: ++ cls.devices_avail = False ++ ++ @classmethod ++ def tearDownClass(cls): ++ BlockDev.switch_init_checks(True) ++ + def setUp(self): + self.orig_config_dir = os.environ.get("LIBBLOCKDEV_CONFIG_DIR", "") + self.addCleanup(self._clean_up) +@@ -185,6 +345,12 @@ class LibraryOpsTestCase(unittest.TestCase): + def test_plugin_fallback(self): + """Verify that fallback when loading plugins works as expected""" + ++ if not self.devices_avail: ++ self.skipTest("skipping plugin fallback test: missing some LVM dependencies") ++ ++ BlockDev.switch_init_checks(True) ++ self.addCleanup(BlockDev.switch_init_checks, False) ++ + # library should be successfully initialized + self.assertTrue(BlockDev.is_initialized()) + +@@ -206,7 +372,7 @@ class LibraryOpsTestCase(unittest.TestCase): + + # now reinit the library with the config preferring the new build + orig_conf_dir = os.environ.get("LIBBLOCKDEV_CONFIG_DIR") +- os.environ["LIBBLOCKDEV_CONFIG_DIR"] = "tests/plugin_prio_conf.d" ++ os.environ["LIBBLOCKDEV_CONFIG_DIR"] = "tests/test_configs/plugin_prio_conf.d" + self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) + + # the original plugin should be loaded because the new one should fail +@@ -243,139 +409,9 @@ class LibraryOpsTestCase(unittest.TestCase): + + self.assertEqual(BlockDev.lvm_get_max_lv_size(), orig_max_size) + +- def my_log_func(self, level, msg): +- # not much to verify here +- self.assertTrue(isinstance(level, int)) +- self.assertTrue(isinstance(msg, str)) +- +- self.log += msg + "\n" +- +- @tag_test(TestTags.CORE) +- def test_logging_setup(self): +- """Verify that setting up logging works as expected""" +- +- self.assertTrue(BlockDev.reinit(self.requested_plugins, False, self.my_log_func)) +- +- succ = BlockDev.utils_exec_and_report_error(["true"]) +- self.assertTrue(succ) +- +- # reinit with no logging function should change nothing about logging +- self.assertTrue(BlockDev.reinit(self.requested_plugins, False, None)) +- +- succ, out = BlockDev.utils_exec_and_capture_output(["echo", "hi"]) +- self.assertTrue(succ) +- self.assertEqual(out, "hi\n") +- +- match = re.search(r'Running \[(\d+)\] true', self.log) +- self.assertIsNot(match, None) +- task_id1 = match.group(1) +- match = re.search(r'Running \[(\d+)\] echo hi', self.log) +- self.assertIsNot(match, None) +- task_id2 = match.group(1) +- +- self.assertIn("...done [%s] (exit code: 0)" % task_id1, self.log) +- self.assertIn("stdout[%s]:" % task_id1, self.log) +- self.assertIn("stderr[%s]:" % task_id1, self.log) +- +- self.assertIn("stdout[%s]: hi" % task_id2, self.log) +- self.assertIn("stderr[%s]:" % task_id2, self.log) +- self.assertIn("...done [%s] (exit code: 0)" % task_id2, self.log) +- +- @tag_test(TestTags.CORE) +- def test_require_plugins(self): +- """Verify that loading only required plugins works as expected""" +- +- ps = BlockDev.PluginSpec() +- ps.name = BlockDev.Plugin.SWAP +- ps.so_name = "" +- self.assertTrue(BlockDev.reinit([ps], True, None)) +- self.assertEqual(BlockDev.get_available_plugin_names(), ["swap"]) +- self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) +- +- @tag_test(TestTags.CORE) +- def test_not_implemented(self): +- """Verify that unloaded/unimplemented functions report errors""" +- +- # should be loaded and working +- self.assertTrue(BlockDev.lvm_get_max_lv_size() > 0) + +- ps = BlockDev.PluginSpec() +- ps.name = BlockDev.Plugin.SWAP +- ps.so_name = "" +- self.assertTrue(BlockDev.reinit([ps], True, None)) +- self.assertEqual(BlockDev.get_available_plugin_names(), ["swap"]) +- +- # no longer loaded +- with self.assertRaises(GLib.GError): +- BlockDev.lvm_get_max_lv_size() +- +- self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) +- +- # loaded again +- self.assertTrue(BlockDev.lvm_get_max_lv_size() > 0) +- +- def test_ensure_init(self): +- """Verify that ensure_init just returns when already initialized""" +- +- # the library is already initialized, ensure_init() shonuld do nothing +- avail_plugs = BlockDev.get_available_plugin_names() +- self.assertTrue(BlockDev.ensure_init(self.requested_plugins, None)) +- self.assertEqual(avail_plugs, BlockDev.get_available_plugin_names()) +- +- # reinit with a subset of plugins +- plugins = BlockDev.plugin_specs_from_names(["swap", "lvm"]) +- self.assertTrue(BlockDev.reinit(plugins, True, None)) +- self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "lvm"])) +- +- # ensure_init with the same subset -> nothing should change +- self.assertTrue(BlockDev.ensure_init(plugins, None)) +- self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "lvm"])) +- +- # ensure_init with more plugins -> extra plugins should be loaded +- plugins = BlockDev.plugin_specs_from_names(["swap", "lvm", "crypto"]) +- self.assertTrue(BlockDev.ensure_init(plugins, None)) +- self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "lvm", "crypto"])) +- +- # reinit to unload all plugins +- self.assertTrue(BlockDev.reinit([], True, None)) +- self.assertEqual(BlockDev.get_available_plugin_names(), []) +- +- # ensure_init to load all plugins back +- self.assertTrue(BlockDev.ensure_init(self.requested_plugins, None)) +- self.assertGreaterEqual(len(BlockDev.get_available_plugin_names()), 8) +- +- def test_try_reinit(self): +- """Verify that try_reinit() works as expected""" +- +- # try reinitializing with only some utilities being available and thus +- # only some plugins able to load +- with fake_path("tests/lib_missing_utils", keep_utils=["swapon", "swapoff", "mkswap", "lvm", "swaplabel"]): +- succ, loaded = BlockDev.try_reinit(self.requested_plugins, True, None) +- self.assertFalse(succ) +- for plug_name in ("swap", "lvm", "crypto"): +- self.assertIn(plug_name, loaded) +- +- # reset back to all plugins +- self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) +- +- # now the same with a subset of plugins requested +- plugins = BlockDev.plugin_specs_from_names(["lvm", "swap", "crypto"]) +- with fake_path("tests/lib_missing_utils", keep_utils=["swapon", "swapoff", "mkswap", "lvm","swaplabel"]): +- succ, loaded = BlockDev.try_reinit(plugins, True, None) +- self.assertTrue(succ) +- self.assertEqual(set(loaded), set(["swap", "lvm", "crypto"])) +- +- def test_non_en_init(self): +- """Verify that the library initializes with lang different from en_US""" +- +- orig_lang = os.environ.get("LANG") +- os.environ["LANG"] = "cs.CZ_UTF-8" +- self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) +- if orig_lang: +- os.environ["LANG"] = orig_lang +- else: +- del os.environ["LANG"] +- self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) ++class DepChecksTestCase(unittest.TestCase): ++ requested_plugins = BlockDev.plugin_specs_from_names(( "swap",)) + + def test_dep_checks_disabled(self): + """Verify that disabling runtime dep checks works""" +diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py +index 3fb7946a..ae26c6d2 100644 +--- a/tests/lvm_dbus_tests.py ++++ b/tests/lvm_dbus_tests.py +@@ -50,6 +50,11 @@ class LVMTestCase(unittest.TestCase): + else: + BlockDev.reinit([cls.ps, cls.ps2], True, None) + ++ try: ++ cls.devices_avail = BlockDev.lvm_is_tech_avail(BlockDev.LVMTech.DEVICES, 0) ++ except: ++ cls.devices_avail = False ++ + @classmethod + def _get_lvm_version(cls): + _ret, out, _err = run_command("lvm version") +@@ -61,8 +66,7 @@ class LVMTestCase(unittest.TestCase): + @unittest.skipUnless(lvm_dbus_running, "LVM DBus not running") + class LvmNoDevTestCase(LVMTestCase): + +- def __init__(self, *args, **kwargs): +- super(LvmNoDevTestCase, self).__init__(*args, **kwargs) ++ def setUp(self): + self._log = "" + + @tag_test(TestTags.NOSTORAGE) +@@ -250,6 +254,45 @@ class LvmNoDevTestCase(LVMTestCase): + succ = BlockDev.lvm_set_global_config(None) + self.assertTrue(succ) + ++ @tag_test(TestTags.NOSTORAGE) ++ def test_get_set_global_devices_filter(self): ++ """Verify that getting and setting LVM devices filter works as expected""" ++ if not self.devices_avail: ++ self.skipTest("skipping LVM devices filter test: not supported") ++ ++ # setup logging ++ self.assertTrue(BlockDev.reinit([self.ps], False, self._store_log)) ++ ++ # no global config set initially ++ self.assertListEqual(BlockDev.lvm_get_devices_filter(), []) ++ ++ # set and try to get back ++ succ = BlockDev.lvm_set_devices_filter(["/dev/sda"]) ++ self.assertTrue(succ) ++ self.assertListEqual(BlockDev.lvm_get_devices_filter(), ["/dev/sda"]) ++ ++ # reset and try to get back ++ succ = BlockDev.lvm_set_devices_filter(None) ++ self.assertTrue(succ) ++ self.assertListEqual(BlockDev.lvm_get_devices_filter(), []) ++ ++ # set twice and try to get back twice ++ succ = BlockDev.lvm_set_devices_filter(["/dev/sda"]) ++ self.assertTrue(succ) ++ succ = BlockDev.lvm_set_devices_filter(["/dev/sdb"]) ++ self.assertTrue(succ) ++ self.assertEqual(BlockDev.lvm_get_devices_filter(), ["/dev/sdb"]) ++ ++ # set something sane and check it's really used ++ succ = BlockDev.lvm_set_devices_filter(["/dev/sdb", "/dev/sdc"]) ++ BlockDev.lvm_pvscan() ++ self.assertIn("'--devices'", self._log) ++ self.assertIn("'/dev/sdb,/dev/sdc'", self._log) ++ ++ # reset back to default ++ succ = BlockDev.lvm_set_devices_filter(None) ++ self.assertTrue(succ) ++ + @tag_test(TestTags.NOSTORAGE) + def test_cache_get_default_md_size(self): + """Verify that default cache metadata size is calculated properly""" +diff --git a/tests/lvm_test.py b/tests/lvm_test.py +index 7be8f1ab..11d8c94e 100644 +--- a/tests/lvm_test.py ++++ b/tests/lvm_test.py +@@ -39,10 +39,17 @@ class LVMTestCase(unittest.TestCase): + ps.so_name = "libbd_lvm.so.2" + cls.requested_plugins = [ps] + ++ BlockDev.switch_init_checks(False) + if not BlockDev.is_initialized(): + BlockDev.init(cls.requested_plugins, None) + else: + BlockDev.reinit(cls.requested_plugins, True, None) ++ BlockDev.switch_init_checks(True) ++ ++ try: ++ cls.devices_avail = BlockDev.lvm_is_tech_avail(BlockDev.LVMTech.DEVICES, 0) ++ except: ++ cls.devices_avail = False + + @classmethod + def _get_lvm_version(cls): +@@ -56,6 +63,8 @@ class LVMTestCase(unittest.TestCase): + class LvmNoDevTestCase(LVMTestCase): + def __init__(self, *args, **kwargs): + super(LvmNoDevTestCase, self).__init__(*args, **kwargs) ++ ++ def setUp(self): + self._log = "" + + @tag_test(TestTags.NOSTORAGE) +@@ -236,6 +245,44 @@ class LvmNoDevTestCase(LVMTestCase): + succ = BlockDev.lvm_set_global_config(None) + self.assertTrue(succ) + ++ @tag_test(TestTags.NOSTORAGE) ++ def test_get_set_global_devices_filter(self): ++ """Verify that getting and setting LVM devices filter works as expected""" ++ if not self.devices_avail: ++ self.skipTest("skipping LVM devices filter test: not supported") ++ ++ # setup logging ++ self.assertTrue(BlockDev.reinit(self.requested_plugins, False, self._store_log)) ++ ++ # no global config set initially ++ self.assertListEqual(BlockDev.lvm_get_devices_filter(), []) ++ ++ # set and try to get back ++ succ = BlockDev.lvm_set_devices_filter(["/dev/sda"]) ++ self.assertTrue(succ) ++ self.assertListEqual(BlockDev.lvm_get_devices_filter(), ["/dev/sda"]) ++ ++ # reset and try to get back ++ succ = BlockDev.lvm_set_devices_filter(None) ++ self.assertTrue(succ) ++ self.assertListEqual(BlockDev.lvm_get_devices_filter(), []) ++ ++ # set twice and try to get back twice ++ succ = BlockDev.lvm_set_devices_filter(["/dev/sda"]) ++ self.assertTrue(succ) ++ succ = BlockDev.lvm_set_devices_filter(["/dev/sdb"]) ++ self.assertTrue(succ) ++ self.assertEqual(BlockDev.lvm_get_devices_filter(), ["/dev/sdb"]) ++ ++ # set something sane and check it's really used ++ succ = BlockDev.lvm_set_devices_filter(["/dev/sdb", "/dev/sdc"]) ++ BlockDev.lvm_lvs(None) ++ self.assertIn("--devices=/dev/sdb,/dev/sdc", self._log) ++ ++ # reset back to default ++ succ = BlockDev.lvm_set_devices_filter(None) ++ self.assertTrue(succ) ++ + @tag_test(TestTags.NOSTORAGE) + def test_cache_get_default_md_size(self): + """Verify that default cache metadata size is calculated properly""" +@@ -1406,6 +1453,9 @@ class LvmPVVGcachedThpoolstatsTestCase(LvmPVVGLVTestCase): + + class LVMUnloadTest(LVMTestCase): + def setUp(self): ++ if not self.devices_avail: ++ self.skipTest("skipping LVM unload test: missing some LVM dependencies") ++ + # make sure the library is initialized with all plugins loaded for other + # tests + self.addCleanup(BlockDev.reinit, self.requested_plugins, True, None) +diff --git a/tests/overrides_test.py b/tests/overrides_test.py +index 8e7f5a5a..d3faf3cf 100644 +--- a/tests/overrides_test.py ++++ b/tests/overrides_test.py +@@ -15,10 +15,12 @@ class OverridesTest(unittest.TestCase): + + @classmethod + def setUpClass(cls): ++ BlockDev.switch_init_checks(False) + if not BlockDev.is_initialized(): + BlockDev.init(cls.requested_plugins, None) + else: + BlockDev.reinit(cls.requested_plugins, True, None) ++ BlockDev.switch_init_checks(True) + + class OverridesTestCase(OverridesTest): + @tag_test(TestTags.NOSTORAGE, TestTags.CORE) +@@ -65,7 +67,20 @@ class OverridesTestCase(OverridesTest): + self.assertEqual(BlockDev.lvm_get_thpool_padding(11 * 1024**2), + expected_padding) + +-class OverridesUnloadTestCase(OverridesTest): ++class OverridesUnloadTestCase(unittest.TestCase): ++ # all plugins except for 'btrfs', 'fs' and 'mpath' -- these don't have all ++ # the dependencies on CentOS/Debian and we don't need them for this test ++ requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "dm", ++ "kbd", "loop", ++ "mdraid", "part", "swap")) ++ ++ @classmethod ++ def setUpClass(cls): ++ if not BlockDev.is_initialized(): ++ BlockDev.init(cls.requested_plugins, None) ++ else: ++ BlockDev.reinit(cls.requested_plugins, True, None) ++ + def tearDown(self): + # make sure the library is initialized with all plugins loaded for other + # tests +@@ -80,7 +95,7 @@ class OverridesUnloadTestCase(OverridesTest): + + # no longer loaded + with self.assertRaises(BlockDev.BlockDevNotImplementedError): +- BlockDev.lvm.get_max_lv_size() ++ BlockDev.md.canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236") + + # load the plugins back + self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) +@@ -92,9 +107,9 @@ class OverridesUnloadTestCase(OverridesTest): + + # the exception should be properly inherited from two classes + with self.assertRaises(NotImplementedError): +- BlockDev.lvm.get_max_lv_size() ++ BlockDev.md.canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236") + with self.assertRaises(BlockDev.BlockDevError): +- BlockDev.lvm.get_max_lv_size() ++ BlockDev.md.canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236") + + # load the plugins back + self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) +-- +2.37.3 + + +From 707de091b8848b95cc78faa4299119844aab4172 Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Tue, 13 Jul 2021 13:27:32 +0200 +Subject: [PATCH 2/7] lvm: Add functions for managing LVM devices file + +Currently covers only --adddev and --deldev from the lvmdevices +command. +--- + src/lib/plugin_apis/lvm.api | 26 +++++++++++++++ + src/plugins/lvm-dbus.c | 52 +++++++++++++++++++++++++++++ + src/plugins/lvm.c | 52 +++++++++++++++++++++++++++++ + src/plugins/lvm.h | 3 ++ + src/python/gi/overrides/BlockDev.py | 15 +++++++++ + tests/lvm_dbus_tests.py | 37 +++++++++++++++++++- + tests/lvm_test.py | 37 +++++++++++++++++++- + 7 files changed, 220 insertions(+), 2 deletions(-) + +diff --git a/src/lib/plugin_apis/lvm.api b/src/lib/plugin_apis/lvm.api +index 23f68b81..b869afcc 100644 +--- a/src/lib/plugin_apis/lvm.api ++++ b/src/lib/plugin_apis/lvm.api +@@ -1685,4 +1685,30 @@ GHashTable* bd_lvm_vdo_get_stats_full (const gchar *vg_name, const gchar *pool_n + */ + BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_name, GError **error); + ++/** ++ * bd_lvm_devices_add: ++ * @device: device (PV) to add to the devices file ++ * @devices_file: (allow-none): LVM devices file or %NULL for default ++ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the @device was successfully added to @devices_file or not ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error); ++ ++/** ++ * bd_lvm_devices_delete: ++ * @device: device (PV) to delete from the devices file ++ * @devices_file: (allow-none): LVM devices file or %NULL for default ++ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the @device was successfully removed from @devices_file or not ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error); ++ + #endif /* BD_LVM_API */ +diff --git a/src/plugins/lvm-dbus.c b/src/plugins/lvm-dbus.c +index b47ed0ef..86ca28ca 100644 +--- a/src/plugins/lvm-dbus.c ++++ b/src/plugins/lvm-dbus.c +@@ -3950,3 +3950,55 @@ BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_nam + + return stats; + } ++ ++/** ++ * bd_lvm_devices_add: ++ * @device: device (PV) to add to the devices file ++ * @devices_file: (allow-none): LVM devices file or %NULL for default ++ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the @device was successfully added to @devices_file or not ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error) { ++ const gchar *args[5] = {"lvmdevices", "--adddev", device, NULL, NULL}; ++ g_autofree gchar *devfile = NULL; ++ ++ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) ++ return FALSE; ++ ++ if (devices_file) { ++ devfile = g_strdup_printf ("--devicesfile=%s", devices_file); ++ args[3] = devfile; ++ } ++ ++ return bd_utils_exec_and_report_error (args, extra, error); ++} ++ ++/** ++ * bd_lvm_devices_delete: ++ * @device: device (PV) to delete from the devices file ++ * @devices_file: (allow-none): LVM devices file or %NULL for default ++ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the @device was successfully removed from @devices_file or not ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error) { ++ const gchar *args[5] = {"lvmdevices", "--deldev", device, NULL, NULL}; ++ g_autofree gchar *devfile = NULL; ++ ++ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) ++ return FALSE; ++ ++ if (devices_file) { ++ devfile = g_strdup_printf ("--devicesfile=%s", devices_file); ++ args[3] = devfile; ++ } ++ ++ return bd_utils_exec_and_report_error (args, extra, error); ++} +diff --git a/src/plugins/lvm.c b/src/plugins/lvm.c +index 42ee0f90..3bd8fae1 100644 +--- a/src/plugins/lvm.c ++++ b/src/plugins/lvm.c +@@ -3250,3 +3250,55 @@ BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_nam + + return stats; + } ++ ++/** ++ * bd_lvm_devices_add: ++ * @device: device (PV) to add to the devices file ++ * @devices_file: (allow-none): LVM devices file or %NULL for default ++ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the @device was successfully added to @devices_file or not ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error) { ++ const gchar *args[5] = {"lvmdevices", "--adddev", device, NULL, NULL}; ++ g_autofree gchar *devfile = NULL; ++ ++ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) ++ return FALSE; ++ ++ if (devices_file) { ++ devfile = g_strdup_printf ("--devicesfile=%s", devices_file); ++ args[3] = devfile; ++ } ++ ++ return bd_utils_exec_and_report_error (args, extra, error); ++} ++ ++/** ++ * bd_lvm_devices_delete: ++ * @device: device (PV) to delete from the devices file ++ * @devices_file: (allow-none): LVM devices file or %NULL for default ++ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the @device was successfully removed from @devices_file or not ++ * ++ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) ++ */ ++gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error) { ++ const gchar *args[5] = {"lvmdevices", "--deldev", device, NULL, NULL}; ++ g_autofree gchar *devfile = NULL; ++ ++ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) ++ return FALSE; ++ ++ if (devices_file) { ++ devfile = g_strdup_printf ("--devicesfile=%s", devices_file); ++ args[3] = devfile; ++ } ++ ++ return bd_utils_exec_and_report_error (args, extra, error); ++} +diff --git a/src/plugins/lvm.h b/src/plugins/lvm.h +index 8063693f..5ca2a9d7 100644 +--- a/src/plugins/lvm.h ++++ b/src/plugins/lvm.h +@@ -333,4 +333,7 @@ BDLVMVDOWritePolicy bd_lvm_get_vdo_write_policy_from_str (const gchar *policy_st + BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_name, GError **error); + GHashTable* bd_lvm_vdo_get_stats_full (const gchar *vg_name, const gchar *pool_name, GError **error); + ++gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error); ++gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error); ++ + #endif /* BD_LVM */ +diff --git a/src/python/gi/overrides/BlockDev.py b/src/python/gi/overrides/BlockDev.py +index ea059060..8574ab04 100644 +--- a/src/python/gi/overrides/BlockDev.py ++++ b/src/python/gi/overrides/BlockDev.py +@@ -724,6 +724,21 @@ def lvm_vdo_pool_convert(vg_name, lv_name, pool_name, virtual_size, index_memory + return _lvm_vdo_pool_convert(vg_name, lv_name, pool_name, virtual_size, index_memory, compression, deduplication, write_policy, extra) + __all__.append("lvm_vdo_pool_convert") + ++_lvm_devices_add = BlockDev.lvm_devices_add ++@override(BlockDev.lvm_devices_add) ++def lvm_devices_add(device, devices_file=None, extra=None, **kwargs): ++ extra = _get_extra(extra, kwargs) ++ return _lvm_devices_add(device, devices_file, extra) ++__all__.append("lvm_devices_add") ++ ++_lvm_devices_delete = BlockDev.lvm_devices_delete ++@override(BlockDev.lvm_devices_delete) ++def lvm_devices_delete(device, devices_file=None, extra=None, **kwargs): ++ extra = _get_extra(extra, kwargs) ++ return _lvm_devices_delete(device, devices_file, extra) ++__all__.append("lvm_devices_delete") ++ ++ + _md_get_superblock_size = BlockDev.md_get_superblock_size + @override(BlockDev.md_get_superblock_size) + def md_get_superblock_size(size, version=None): +diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py +index ae26c6d2..82e4761d 100644 +--- a/tests/lvm_dbus_tests.py ++++ b/tests/lvm_dbus_tests.py +@@ -12,7 +12,7 @@ from contextlib import contextmanager + from distutils.version import LooseVersion + from itertools import chain + +-from utils import create_sparse_tempfile, create_lio_device, delete_lio_device, run_command, TestTags, tag_test ++from utils import create_sparse_tempfile, create_lio_device, delete_lio_device, run_command, TestTags, tag_test, read_file + from gi.repository import BlockDev, GLib + + import dbus +@@ -1785,3 +1785,38 @@ class LvmConfigTestPvremove(LvmPVonlyTestCase): + BlockDev.lvm_set_global_config("") + succ = BlockDev.lvm_pvremove(self.loop_dev) + self.assertTrue(succ) ++ ++ ++class LvmTestDevicesFile(LvmPVonlyTestCase): ++ devicefile = "bd_lvm_dbus_tests.devices" ++ ++ @classmethod ++ def tearDownClass(cls): ++ shutil.rmtree("/etc/lvm/devices/" + cls.devicefile, ignore_errors=True) ++ ++ super(LvmTestDevicesFile, cls).tearDownClass() ++ ++ def test_devices_add_delete(self): ++ if not self.devices_avail: ++ self.skipTest("skipping LVM devices file test: not supported") ++ ++ succ = BlockDev.lvm_pvcreate(self.loop_dev) ++ self.assertTrue(succ) ++ ++ with self.assertRaises(GLib.GError): ++ BlockDev.lvm_devices_add("/non/existing/device", self.devicefile) ++ ++ with self.assertRaises(GLib.GError): ++ BlockDev.lvm_devices_delete(self.loop_dev, self.devicefile) ++ ++ succ = BlockDev.lvm_devices_add(self.loop_dev, self.devicefile) ++ self.assertTrue(succ) ++ ++ dfile = read_file("/etc/lvm/devices/" + self.devicefile) ++ self.assertIn(self.loop_dev, dfile) ++ ++ succ = BlockDev.lvm_devices_delete(self.loop_dev, self.devicefile) ++ self.assertTrue(succ) ++ ++ dfile = read_file("/etc/lvm/devices/" + self.devicefile) ++ self.assertNotIn(self.loop_dev, dfile) +diff --git a/tests/lvm_test.py b/tests/lvm_test.py +index 11d8c94e..6ddeaa6a 100644 +--- a/tests/lvm_test.py ++++ b/tests/lvm_test.py +@@ -11,7 +11,7 @@ import time + from contextlib import contextmanager + from distutils.version import LooseVersion + +-from utils import create_sparse_tempfile, create_lio_device, delete_lio_device, fake_utils, fake_path, TestTags, tag_test, run_command ++from utils import create_sparse_tempfile, create_lio_device, delete_lio_device, fake_utils, fake_path, TestTags, tag_test, run_command, read_file + from gi.repository import BlockDev, GLib + + +@@ -1765,3 +1765,38 @@ class LvmConfigTestPvremove(LvmPVonlyTestCase): + BlockDev.lvm_set_global_config("") + succ = BlockDev.lvm_pvremove(self.loop_dev) + self.assertTrue(succ) ++ ++ ++class LvmTestDevicesFile(LvmPVonlyTestCase): ++ devicefile = "bd_lvm_test.devices" ++ ++ @classmethod ++ def tearDownClass(cls): ++ shutil.rmtree("/etc/lvm/devices/" + cls.devicefile, ignore_errors=True) ++ ++ super(LvmTestDevicesFile, cls).tearDownClass() ++ ++ def test_devices_add_delete(self): ++ if not self.devices_avail: ++ self.skipTest("skipping LVM devices file test: not supported") ++ ++ succ = BlockDev.lvm_pvcreate(self.loop_dev) ++ self.assertTrue(succ) ++ ++ with self.assertRaises(GLib.GError): ++ BlockDev.lvm_devices_add("/non/existing/device", self.devicefile) ++ ++ with self.assertRaises(GLib.GError): ++ BlockDev.lvm_devices_delete(self.loop_dev, self.devicefile) ++ ++ succ = BlockDev.lvm_devices_add(self.loop_dev, self.devicefile) ++ self.assertTrue(succ) ++ ++ dfile = read_file("/etc/lvm/devices/" + self.devicefile) ++ self.assertIn(self.loop_dev, dfile) ++ ++ succ = BlockDev.lvm_devices_delete(self.loop_dev, self.devicefile) ++ self.assertTrue(succ) ++ ++ dfile = read_file("/etc/lvm/devices/" + self.devicefile) ++ self.assertNotIn(self.loop_dev, dfile) +-- +2.37.3 + + +From 4c832576df8918c269db8fe2cb7eb74e45628d6c Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Fri, 15 Oct 2021 13:18:54 +0200 +Subject: [PATCH 3/7] lvm: Report special error when system.devices file is not + enabled + +This can be disabled either in LVM by a compile time option or +by a lvm.conf option so we should report a specific error for this +case so users can distinguish between the feature not being enabled +and not being supported at all. +--- + src/lib/plugin_apis/lvm.api | 1 + + src/plugins/lvm-dbus.c | 70 +++++++++++++++++++++++++++++++++++++ + src/plugins/lvm.c | 60 +++++++++++++++++++++++++++++++ + src/plugins/lvm.h | 1 + + tests/lvm_dbus_tests.py | 15 ++++++++ + tests/lvm_test.py | 15 ++++++++ + 6 files changed, 162 insertions(+) + +diff --git a/src/lib/plugin_apis/lvm.api b/src/lib/plugin_apis/lvm.api +index b869afcc..b8cde70b 100644 +--- a/src/lib/plugin_apis/lvm.api ++++ b/src/lib/plugin_apis/lvm.api +@@ -44,6 +44,7 @@ typedef enum { + BD_LVM_ERROR_FAIL, + BD_LVM_ERROR_NOT_SUPPORTED, + BD_LVM_ERROR_VDO_POLICY_INVAL, ++ BD_LVM_ERROR_DEVICES_DISABLED, + } BDLVMError; + + typedef enum { +diff --git a/src/plugins/lvm-dbus.c b/src/plugins/lvm-dbus.c +index 86ca28ca..7f48e422 100644 +--- a/src/plugins/lvm-dbus.c ++++ b/src/plugins/lvm-dbus.c +@@ -3951,6 +3951,64 @@ BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_nam + return stats; + } + ++/* check whether the LVM devices file is enabled by LVM ++ * we use the existence of the "lvmdevices" command to check whether the feature is available ++ * or not, but this can still be disabled either in LVM or in lvm.conf ++ */ ++static gboolean _lvm_devices_enabled () { ++ const gchar *args[6] = {"lvmconfig", "--typeconfig", NULL, "devices/use_devicesfile", NULL, NULL}; ++ gboolean ret = FALSE; ++ GError *loc_error = NULL; ++ gchar *output = NULL; ++ gboolean enabled = FALSE; ++ gint scanned = 0; ++ g_autofree gchar *config_arg = NULL; ++ ++ /* try current config first -- if we get something from this it means the feature is ++ explicitly enabled or disabled by system lvm.conf or using the --config option */ ++ args[2] = "current"; ++ ++ /* make sure to include the global config from us when getting the current config value */ ++ g_mutex_lock (&global_config_lock); ++ if (global_config_str) { ++ config_arg = g_strdup_printf ("--config=%s", global_config_str); ++ args[4] = config_arg; ++ } ++ ++ ret = bd_utils_exec_and_capture_output (args, NULL, &output, &loc_error); ++ g_mutex_unlock (&global_config_lock); ++ if (ret) { ++ scanned = sscanf (output, "use_devicesfile=%u", &enabled); ++ g_free (output); ++ if (scanned != 1) ++ return FALSE; ++ ++ return enabled; ++ } else { ++ g_clear_error (&loc_error); ++ g_free (output); ++ } ++ ++ output = NULL; ++ ++ /* now try default */ ++ args[2] = "default"; ++ ret = bd_utils_exec_and_capture_output (args, NULL, &output, &loc_error); ++ if (ret) { ++ scanned = sscanf (output, "# use_devicesfile=%u", &enabled); ++ g_free (output); ++ if (scanned != 1) ++ return FALSE; ++ ++ return enabled; ++ } else { ++ g_clear_error (&loc_error); ++ g_free (output); ++ } ++ ++ return FALSE; ++} ++ + /** + * bd_lvm_devices_add: + * @device: device (PV) to add to the devices file +@@ -3969,6 +4027,12 @@ gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, con + if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) + return FALSE; + ++ if (!_lvm_devices_enabled ()) { ++ g_set_error (error, BD_LVM_ERROR, BD_LVM_ERROR_DEVICES_DISABLED, ++ "LVM devices file not enabled."); ++ return FALSE; ++ } ++ + if (devices_file) { + devfile = g_strdup_printf ("--devicesfile=%s", devices_file); + args[3] = devfile; +@@ -3995,6 +4059,12 @@ gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, + if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) + return FALSE; + ++ if (!_lvm_devices_enabled ()) { ++ g_set_error (error, BD_LVM_ERROR, BD_LVM_ERROR_DEVICES_DISABLED, ++ "LVM devices file not enabled."); ++ return FALSE; ++ } ++ + if (devices_file) { + devfile = g_strdup_printf ("--devicesfile=%s", devices_file); + args[3] = devfile; +diff --git a/src/plugins/lvm.c b/src/plugins/lvm.c +index 3bd8fae1..73d5005f 100644 +--- a/src/plugins/lvm.c ++++ b/src/plugins/lvm.c +@@ -3251,6 +3251,54 @@ BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_nam + return stats; + } + ++/* check whether the LVM devices file is enabled by LVM ++ * we use the existence of the "lvmdevices" command to check whether the feature is available ++ * or not, but this can still be disabled either in LVM or in lvm.conf ++ */ ++static gboolean _lvm_devices_enabled () { ++ const gchar *args[5] = {"config", "--typeconfig", NULL, "devices/use_devicesfile", NULL}; ++ gboolean ret = FALSE; ++ GError *loc_error = NULL; ++ gchar *output = NULL; ++ gboolean enabled = FALSE; ++ gint scanned = 0; ++ ++ /* try current config first -- if we get something from this it means the feature is ++ explicitly enabled or disabled by system lvm.conf or using the --config option */ ++ args[2] = "current"; ++ ret = call_lvm_and_capture_output (args, NULL, &output, &loc_error); ++ if (ret) { ++ scanned = sscanf (output, "use_devicesfile=%u", &enabled); ++ g_free (output); ++ if (scanned != 1) ++ return FALSE; ++ ++ return enabled; ++ } else { ++ g_clear_error (&loc_error); ++ g_free (output); ++ } ++ ++ output = NULL; ++ ++ /* now try default */ ++ args[2] = "default"; ++ ret = call_lvm_and_capture_output (args, NULL, &output, &loc_error); ++ if (ret) { ++ scanned = sscanf (output, "# use_devicesfile=%u", &enabled); ++ g_free (output); ++ if (scanned != 1) ++ return FALSE; ++ ++ return enabled; ++ } else { ++ g_clear_error (&loc_error); ++ g_free (output); ++ } ++ ++ return FALSE; ++} ++ + /** + * bd_lvm_devices_add: + * @device: device (PV) to add to the devices file +@@ -3269,6 +3317,12 @@ gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, con + if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) + return FALSE; + ++ if (!_lvm_devices_enabled ()) { ++ g_set_error (error, BD_LVM_ERROR, BD_LVM_ERROR_DEVICES_DISABLED, ++ "LVM devices file not enabled."); ++ return FALSE; ++ } ++ + if (devices_file) { + devfile = g_strdup_printf ("--devicesfile=%s", devices_file); + args[3] = devfile; +@@ -3295,6 +3349,12 @@ gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, + if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) + return FALSE; + ++ if (!_lvm_devices_enabled ()) { ++ g_set_error (error, BD_LVM_ERROR, BD_LVM_ERROR_DEVICES_DISABLED, ++ "LVM devices file not enabled."); ++ return FALSE; ++ } ++ + if (devices_file) { + devfile = g_strdup_printf ("--devicesfile=%s", devices_file); + args[3] = devfile; +diff --git a/src/plugins/lvm.h b/src/plugins/lvm.h +index 5ca2a9d7..fabf091f 100644 +--- a/src/plugins/lvm.h ++++ b/src/plugins/lvm.h +@@ -53,6 +53,7 @@ typedef enum { + BD_LVM_ERROR_FAIL, + BD_LVM_ERROR_NOT_SUPPORTED, + BD_LVM_ERROR_VDO_POLICY_INVAL, ++ BD_LVM_ERROR_DEVICES_DISABLED, + } BDLVMError; + + typedef enum { +diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py +index 82e4761d..792c1cc8 100644 +--- a/tests/lvm_dbus_tests.py ++++ b/tests/lvm_dbus_tests.py +@@ -1820,3 +1820,18 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + + dfile = read_file("/etc/lvm/devices/" + self.devicefile) + self.assertNotIn(self.loop_dev, dfile) ++ ++ def test_devices_enabled(self): ++ if not self.devices_avail: ++ self.skipTest("skipping LVM devices file test: not supported") ++ ++ self.addCleanup(BlockDev.lvm_set_global_config, "") ++ ++ # checking if the feature is enabled or disabled is hard so lets just disable ++ # the devices file using the global config and check lvm_devices_add fails ++ # with the correct exception message ++ succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=0 }") ++ self.assertTrue(succ) ++ ++ with self.assertRaisesRegex(GLib.GError, "LVM devices file not enabled."): ++ BlockDev.lvm_devices_add("", self.devicefile) +diff --git a/tests/lvm_test.py b/tests/lvm_test.py +index 6ddeaa6a..73fb1030 100644 +--- a/tests/lvm_test.py ++++ b/tests/lvm_test.py +@@ -1800,3 +1800,18 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + + dfile = read_file("/etc/lvm/devices/" + self.devicefile) + self.assertNotIn(self.loop_dev, dfile) ++ ++ def test_devices_enabled(self): ++ if not self.devices_avail: ++ self.skipTest("skipping LVM devices file test: not supported") ++ ++ self.addCleanup(BlockDev.lvm_set_global_config, "") ++ ++ # checking if the feature is enabled or disabled is hard so lets just disable ++ # the devices file using the global config and check lvm_devices_add fails ++ # with the correct exception message ++ succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=0 }") ++ self.assertTrue(succ) ++ ++ with self.assertRaisesRegex(GLib.GError, "LVM devices file not enabled."): ++ BlockDev.lvm_devices_add("", self.devicefile) +-- +2.37.3 + + +From 2fdec5f7e42de869d4b2ec80dce597d22dd57617 Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Fri, 15 Oct 2021 14:21:03 +0200 +Subject: [PATCH 4/7] lvm: Force enable LVM devices file for LvmTestDevicesFile + +This feauture might be disabled in lvm.conf so to be able to test +it we need to override this. The correct handling of the disabled +state is checked in a separate test case. +--- + tests/lvm_dbus_tests.py | 8 ++++++++ + tests/lvm_test.py | 8 ++++++++ + 2 files changed, 16 insertions(+) + +diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py +index 792c1cc8..e55535cc 100644 +--- a/tests/lvm_dbus_tests.py ++++ b/tests/lvm_dbus_tests.py +@@ -1800,6 +1800,12 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + if not self.devices_avail: + self.skipTest("skipping LVM devices file test: not supported") + ++ self.addCleanup(BlockDev.lvm_set_global_config, "") ++ ++ # force-enable the feature, it might be disabled by default ++ succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=1 }") ++ self.assertTrue(succ) ++ + succ = BlockDev.lvm_pvcreate(self.loop_dev) + self.assertTrue(succ) + +@@ -1821,6 +1827,8 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + dfile = read_file("/etc/lvm/devices/" + self.devicefile) + self.assertNotIn(self.loop_dev, dfile) + ++ BlockDev.lvm_set_global_config("") ++ + def test_devices_enabled(self): + if not self.devices_avail: + self.skipTest("skipping LVM devices file test: not supported") +diff --git a/tests/lvm_test.py b/tests/lvm_test.py +index 73fb1030..907b4f59 100644 +--- a/tests/lvm_test.py ++++ b/tests/lvm_test.py +@@ -1780,6 +1780,12 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + if not self.devices_avail: + self.skipTest("skipping LVM devices file test: not supported") + ++ self.addCleanup(BlockDev.lvm_set_global_config, "") ++ ++ # force-enable the feature, it might be disabled by default ++ succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=1 }") ++ self.assertTrue(succ) ++ + succ = BlockDev.lvm_pvcreate(self.loop_dev) + self.assertTrue(succ) + +@@ -1801,6 +1807,8 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + dfile = read_file("/etc/lvm/devices/" + self.devicefile) + self.assertNotIn(self.loop_dev, dfile) + ++ BlockDev.lvm_set_global_config("") ++ + def test_devices_enabled(self): + if not self.devices_avail: + self.skipTest("skipping LVM devices file test: not supported") +-- +2.37.3 + + +From 1809a41c0b2b99c8d6a077b5aa70834686980181 Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Fri, 12 Nov 2021 14:51:39 +0100 +Subject: [PATCH 5/7] tests: Fix resetting global LVM config after LVM devices + file test + +We need to set the config to None/NULL not to an empty string. +--- + tests/lvm_dbus_tests.py | 6 +++--- + tests/lvm_test.py | 6 +++--- + 2 files changed, 6 insertions(+), 6 deletions(-) + +diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py +index e55535cc..8ae670d5 100644 +--- a/tests/lvm_dbus_tests.py ++++ b/tests/lvm_dbus_tests.py +@@ -1800,7 +1800,7 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + if not self.devices_avail: + self.skipTest("skipping LVM devices file test: not supported") + +- self.addCleanup(BlockDev.lvm_set_global_config, "") ++ self.addCleanup(BlockDev.lvm_set_global_config, None) + + # force-enable the feature, it might be disabled by default + succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=1 }") +@@ -1827,13 +1827,13 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + dfile = read_file("/etc/lvm/devices/" + self.devicefile) + self.assertNotIn(self.loop_dev, dfile) + +- BlockDev.lvm_set_global_config("") ++ BlockDev.lvm_set_global_config(None) + + def test_devices_enabled(self): + if not self.devices_avail: + self.skipTest("skipping LVM devices file test: not supported") + +- self.addCleanup(BlockDev.lvm_set_global_config, "") ++ self.addCleanup(BlockDev.lvm_set_global_config, None) + + # checking if the feature is enabled or disabled is hard so lets just disable + # the devices file using the global config and check lvm_devices_add fails +diff --git a/tests/lvm_test.py b/tests/lvm_test.py +index 907b4f59..095e4bac 100644 +--- a/tests/lvm_test.py ++++ b/tests/lvm_test.py +@@ -1780,7 +1780,7 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + if not self.devices_avail: + self.skipTest("skipping LVM devices file test: not supported") + +- self.addCleanup(BlockDev.lvm_set_global_config, "") ++ self.addCleanup(BlockDev.lvm_set_global_config, None) + + # force-enable the feature, it might be disabled by default + succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=1 }") +@@ -1807,13 +1807,13 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + dfile = read_file("/etc/lvm/devices/" + self.devicefile) + self.assertNotIn(self.loop_dev, dfile) + +- BlockDev.lvm_set_global_config("") ++ BlockDev.lvm_set_global_config(None) + + def test_devices_enabled(self): + if not self.devices_avail: + self.skipTest("skipping LVM devices file test: not supported") + +- self.addCleanup(BlockDev.lvm_set_global_config, "") ++ self.addCleanup(BlockDev.lvm_set_global_config, None) + + # checking if the feature is enabled or disabled is hard so lets just disable + # the devices file using the global config and check lvm_devices_add fails +-- +2.37.3 + + +From 1c2f1d20a3cfa522b78ab007e8e4f9a5a4bb579d Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Fri, 12 Nov 2021 15:10:45 +0100 +Subject: [PATCH 6/7] lvm: Do not set global config to and empty string + +If we set it to an empty string we end up running "--config" +without a parameter and lvm will use whatever is next parameter +like the device path for pvremove. +--- + tests/lvm_dbus_tests.py | 12 ++++++++++++ + tests/lvm_test.py | 12 ++++++++++++ + 2 files changed, 24 insertions(+) + +diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py +index 8ae670d5..61c898c1 100644 +--- a/tests/lvm_dbus_tests.py ++++ b/tests/lvm_dbus_tests.py +@@ -1843,3 +1843,15 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + + with self.assertRaisesRegex(GLib.GError, "LVM devices file not enabled."): + BlockDev.lvm_devices_add("", self.devicefile) ++ ++ ++class LvmConfigTestPvremove(LvmPVonlyTestCase): ++ ++ @tag_test(TestTags.REGRESSION) ++ def test_set_empty_config(self): ++ succ = BlockDev.lvm_pvcreate(self.loop_dev) ++ self.assertTrue(succ) ++ ++ BlockDev.lvm_set_global_config("") ++ succ = BlockDev.lvm_pvremove(self.loop_dev) ++ self.assertTrue(succ) +diff --git a/tests/lvm_test.py b/tests/lvm_test.py +index 095e4bac..36ff10ec 100644 +--- a/tests/lvm_test.py ++++ b/tests/lvm_test.py +@@ -1823,3 +1823,15 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): + + with self.assertRaisesRegex(GLib.GError, "LVM devices file not enabled."): + BlockDev.lvm_devices_add("", self.devicefile) ++ ++ ++class LvmConfigTestPvremove(LvmPVonlyTestCase): ++ ++ @tag_test(TestTags.REGRESSION) ++ def test_set_empty_config(self): ++ succ = BlockDev.lvm_pvcreate(self.loop_dev) ++ self.assertTrue(succ) ++ ++ BlockDev.lvm_set_global_config("") ++ succ = BlockDev.lvm_pvremove(self.loop_dev) ++ self.assertTrue(succ) +-- +2.37.3 + + +From 05cfb84777c5472550673a1f2150ca357718b3f2 Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Fri, 26 Nov 2021 15:19:55 +0100 +Subject: [PATCH 7/7] lvm: Use "lvmconfig full" to get valid config instead of + "current" + +"lvmconfig current" doesn't work together with --config even if we +don't override the "use_devicefile" key. "lvmconfig full" seems to +be working in all cases. +--- + src/plugins/lvm-dbus.c | 4 ++-- + src/plugins/lvm.c | 4 ++-- + 2 files changed, 4 insertions(+), 4 deletions(-) + +diff --git a/src/plugins/lvm-dbus.c b/src/plugins/lvm-dbus.c +index 7f48e422..d4b542e2 100644 +--- a/src/plugins/lvm-dbus.c ++++ b/src/plugins/lvm-dbus.c +@@ -3964,9 +3964,9 @@ static gboolean _lvm_devices_enabled () { + gint scanned = 0; + g_autofree gchar *config_arg = NULL; + +- /* try current config first -- if we get something from this it means the feature is ++ /* try full config first -- if we get something from this it means the feature is + explicitly enabled or disabled by system lvm.conf or using the --config option */ +- args[2] = "current"; ++ args[2] = "full"; + + /* make sure to include the global config from us when getting the current config value */ + g_mutex_lock (&global_config_lock); +diff --git a/src/plugins/lvm.c b/src/plugins/lvm.c +index 73d5005f..03211f8a 100644 +--- a/src/plugins/lvm.c ++++ b/src/plugins/lvm.c +@@ -3263,9 +3263,9 @@ static gboolean _lvm_devices_enabled () { + gboolean enabled = FALSE; + gint scanned = 0; + +- /* try current config first -- if we get something from this it means the feature is ++ /* try full config first -- if we get something from this it means the feature is + explicitly enabled or disabled by system lvm.conf or using the --config option */ +- args[2] = "current"; ++ args[2] = "full"; + ret = call_lvm_and_capture_output (args, NULL, &output, &loc_error); + if (ret) { + scanned = sscanf (output, "use_devicesfile=%u", &enabled); +-- +2.37.3 + diff --git a/SOURCES/0002-Add-support-for-creating-and-activating-integrity-de.patch b/SOURCES/0002-Add-support-for-creating-and-activating-integrity-de.patch new file mode 100644 index 0000000..163c812 --- /dev/null +++ b/SOURCES/0002-Add-support-for-creating-and-activating-integrity-de.patch @@ -0,0 +1,963 @@ +From 77e6a109043e87f88d2bd2b47d1cefce0eb9f5a9 Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Mon, 20 Sep 2021 16:38:16 +0200 +Subject: [PATCH 1/3] Add support for creating and activating integrity devices + +This adds support for create, open and close actions for standalone +integrity devices using cryptsetup. +--- + configure.ac | 2 +- + src/lib/plugin_apis/crypto.api | 157 +++++++++++++++++ + src/plugins/crypto.c | 261 +++++++++++++++++++++++++++- + src/plugins/crypto.h | 41 +++++ + src/python/gi/overrides/BlockDev.py | 24 +++ + tests/crypto_test.py | 96 +++++++++- + 6 files changed, 573 insertions(+), 8 deletions(-) + +diff --git a/configure.ac b/configure.ac +index 79bd97d8..79bf8045 100644 +--- a/configure.ac ++++ b/configure.ac +@@ -210,7 +210,7 @@ AS_IF([test "x$with_crypto" != "xno"], + AS_IF([$PKG_CONFIG --atleast-version=2.0.3 libcryptsetup], + [AC_DEFINE([LIBCRYPTSETUP_2])], []) + AS_IF([$PKG_CONFIG --atleast-version=2.3.0 libcryptsetup], +- [AC_DEFINE([LIBCRYPTSETUP_BITLK])], []) ++ [AC_DEFINE([LIBCRYPTSETUP_23])], []) + AS_IF([$PKG_CONFIG --atleast-version=2.4.0 libcryptsetup], + [AC_DEFINE([LIBCRYPTSETUP_24])], []) + AS_IF([test "x$with_escrow" != "xno"], +diff --git a/src/lib/plugin_apis/crypto.api b/src/lib/plugin_apis/crypto.api +index ef0217fe..40e32c89 100644 +--- a/src/lib/plugin_apis/crypto.api ++++ b/src/lib/plugin_apis/crypto.api +@@ -1,5 +1,6 @@ + #include + #include ++#include + + #define BD_CRYPTO_LUKS_METADATA_SIZE G_GUINT64_CONSTANT (2097152ULL) // 2 MiB + +@@ -245,6 +246,115 @@ GType bd_crypto_luks_extra_get_type () { + return type; + } + ++#define BD_CRYPTO_TYPE_INTEGRITY_EXTRA (bd_crypto_integrity_extra_get_type ()) ++GType bd_crypto_integrity_extra_get_type(); ++ ++/** ++ * BDCryptoIntegrityExtra: ++ * @sector_size: integrity sector size ++ * @journal_size: size of journal in bytes ++ * @journal_watermark: journal flush watermark in percents; in bitmap mode sectors-per-bit ++ * @journal_commit_time: journal commit time (or bitmap flush time) in ms ++ * @interleave_sectors: number of interleave sectors (power of two) ++ * @tag_size: tag size per-sector in bytes ++ * @buffer_sectors: number of sectors in one buffer ++ */ ++typedef struct BDCryptoIntegrityExtra { ++ guint32 sector_size; ++ guint64 journal_size; ++ guint journal_watermark; ++ guint journal_commit_time; ++ guint32 interleave_sectors; ++ guint32 tag_size; ++ guint32 buffer_sectors; ++} BDCryptoIntegrityExtra; ++ ++/** ++ * bd_crypto_integrity_extra_copy: (skip) ++ * @extra: (allow-none): %BDCryptoIntegrityExtra to copy ++ * ++ * Creates a new copy of @extra. ++ */ ++BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra *extra) { ++ if (extra == NULL) ++ return NULL; ++ ++ BDCryptoIntegrityExtra *new_extra = g_new0 (BDCryptoIntegrityExtra, 1); ++ ++ new_extra->sector_size = extra->sector_size; ++ new_extra->journal_size = extra->journal_size; ++ new_extra->journal_watermark = extra->journal_watermark; ++ new_extra->journal_commit_time = extra->journal_commit_time; ++ new_extra->interleave_sectors = extra->interleave_sectors; ++ new_extra->tag_size = extra->tag_size; ++ new_extra->buffer_sectors = extra->buffer_sectors; ++ ++ return new_extra; ++} ++ ++/** ++ * bd_crypto_integrity_extra_free: (skip) ++ * @extra: (allow-none): %BDCryptoIntegrityExtra to free ++ * ++ * Frees @extra. ++ */ ++void bd_crypto_integrity_extra_free (BDCryptoIntegrityExtra *extra) { ++ if (extra == NULL) ++ return; ++ ++ g_free (extra); ++} ++ ++/** ++ * bd_crypto_integrity_extra_new: (constructor) ++ * @sector_size: integrity sector size, 0 for default (512) ++ * @journal_size: size of journal in bytes ++ * @journal_watermark: journal flush watermark in percents; in bitmap mode sectors-per-bit ++ * @journal_commit_time: journal commit time (or bitmap flush time) in ms ++ * @interleave_sectors: number of interleave sectors (power of two) ++ * @tag_size: tag size per-sector in bytes ++ * @buffer_sectors: number of sectors in one buffer ++ * ++ * Returns: (transfer full): a new Integrity extra argument ++ */ ++BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors) { ++ BDCryptoIntegrityExtra *ret = g_new0 (BDCryptoIntegrityExtra, 1); ++ ret->sector_size = sector_size; ++ ret->journal_size = journal_size; ++ ret->journal_watermark = journal_watermark; ++ ret->journal_commit_time = journal_commit_time; ++ ret->interleave_sectors = interleave_sectors; ++ ret->tag_size = tag_size; ++ ret->buffer_sectors = buffer_sectors; ++ ++ return ret; ++} ++ ++GType bd_crypto_integrity_extra_get_type () { ++ static GType type = 0; ++ ++ if (G_UNLIKELY(type == 0)) { ++ type = g_boxed_type_register_static("BDCryptoIntegrityExtra", ++ (GBoxedCopyFunc) bd_crypto_integrity_extra_copy, ++ (GBoxedFreeFunc) bd_crypto_integrity_extra_free); ++ } ++ ++ return type; ++} ++ ++typedef enum { ++ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = CRYPT_ACTIVATE_NO_JOURNAL, ++ BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = CRYPT_ACTIVATE_RECOVERY, ++#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP ++ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP, ++#endif ++ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = CRYPT_ACTIVATE_RECALCULATE, ++#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET ++ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = CRYPT_ACTIVATE_RECALCULATE_RESET, ++#endif ++ BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = CRYPT_ACTIVATE_ALLOW_DISCARDS, ++} BDCryptoIntegrityOpenFlags; ++ + #define BD_CRYPTO_TYPE_LUKS_INFO (bd_crypto_luks_info_get_type ()) + GType bd_crypto_luks_info_get_type(); + +@@ -857,6 +967,53 @@ BDCryptoLUKSInfo* bd_crypto_luks_info (const gchar *luks_device, GError **error) + */ + BDCryptoIntegrityInfo* bd_crypto_integrity_info (const gchar *device, GError **error); + ++/** ++ * bd_crypto_integrity_format: ++ * @device: a device to format as integrity ++ * @algorithm: integrity algorithm specification (e.g. "crc32c" or "sha256") or %NULL to use the default ++ * @wipe: whether to wipe the device after format; a device that is not initially wiped will contain invalid checksums ++ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed ++ * @key_size: size the integrity key and @key_data ++ * @extra: (allow-none): extra arguments for integrity format creation ++ * @error: (out): place to store error (if any) ++ * ++ * Formats the given @device as integrity according to the other parameters given. ++ * ++ * Returns: whether the given @device was successfully formatted as integrity or not ++ * (the @error) contains the error in such cases) ++ * ++ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_CREATE ++ */ ++gboolean bd_crypto_integrity_format (const gchar *device, const gchar *algorithm, gboolean wipe, const guint8* key_data, gsize key_size, BDCryptoIntegrityExtra *extra, GError **error); ++ ++/** ++ * bd_crypto_integrity_open: ++ * @device: integrity device to open ++ * @name: name for the opened @device ++ * @algorithm: (allow-none): integrity algorithm specification (e.g. "crc32c" or "sha256") or %NULL to use the default ++ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed ++ * @key_size: size the integrity key and @key_data ++ * @flags: flags for the integrity device activation ++ * @extra: (allow-none): extra arguments for integrity open ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the @device was successfully opened or not ++ * ++ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE ++ */ ++gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const gchar *algorithm, const guint8* key_data, gsize key_size, BDCryptoIntegrityOpenFlags flags, BDCryptoIntegrityExtra *extra, GError **error); ++ ++/** ++ * bd_crypto_integrity_close: ++ * @integrity_device: integrity device to close ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the given @integrity_device was successfully closed or not ++ * ++ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE ++ */ ++gboolean bd_crypto_integrity_close (const gchar *integrity_device, GError **error); ++ + /** + * bd_crypto_device_seems_encrypted: + * @device: the queried device +diff --git a/src/plugins/crypto.c b/src/plugins/crypto.c +index 51908140..8549cf23 100644 +--- a/src/plugins/crypto.c ++++ b/src/plugins/crypto.c +@@ -50,6 +50,18 @@ + + #define SECTOR_SIZE 512 + ++#define DEFAULT_LUKS_KEYSIZE_BITS 256 ++#define DEFAULT_LUKS_CIPHER "aes-xts-plain64" ++ ++#ifdef LIBCRYPTSETUP_23 ++/* 0 for autodetect since 2.3.0 */ ++#define DEFAULT_INTEGRITY_TAG_SIZE 0 ++#else ++/* we need some sane default for older versions, users should specify tag size when using ++ other algorithms than the default crc32c */ ++#define DEFAULT_INTEGRITY_TAG_SIZE 4 ++#endif ++ + #define UNUSED __attribute__((unused)) + + /** +@@ -146,6 +158,43 @@ BDCryptoLUKSExtra* bd_crypto_luks_extra_new (guint64 data_alignment, const gchar + return ret; + } + ++BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors) { ++ BDCryptoIntegrityExtra *ret = g_new0 (BDCryptoIntegrityExtra, 1); ++ ret->sector_size = sector_size; ++ ret->journal_size = journal_size; ++ ret->journal_watermark = journal_watermark; ++ ret->journal_commit_time = journal_commit_time; ++ ret->interleave_sectors = interleave_sectors; ++ ret->tag_size = tag_size; ++ ret->buffer_sectors = buffer_sectors; ++ ++ return ret; ++} ++ ++BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra *extra) { ++ if (extra == NULL) ++ return NULL; ++ ++ BDCryptoIntegrityExtra *new_extra = g_new0 (BDCryptoIntegrityExtra, 1); ++ ++ new_extra->sector_size = extra->sector_size; ++ new_extra->journal_size = extra->journal_size; ++ new_extra->journal_watermark = extra->journal_watermark; ++ new_extra->journal_commit_time = extra->journal_commit_time; ++ new_extra->interleave_sectors = extra->interleave_sectors; ++ new_extra->tag_size = extra->tag_size; ++ new_extra->buffer_sectors = extra->buffer_sectors; ++ ++ return new_extra; ++} ++ ++void bd_crypto_integrity_extra_free (BDCryptoIntegrityExtra *extra) { ++ if (extra == NULL) ++ return; ++ ++ g_free (extra); ++} ++ + void bd_crypto_luks_info_free (BDCryptoLUKSInfo *info) { + if (info == NULL) + return; +@@ -346,15 +395,15 @@ gboolean bd_crypto_is_tech_avail (BDCryptoTech tech, guint64 mode, GError **erro + "Integrity technology requires libcryptsetup >= 2.0"); + return FALSE; + #endif +- ret = mode & (BD_CRYPTO_TECH_MODE_QUERY); ++ ret = mode & (BD_CRYPTO_TECH_MODE_CREATE|BD_CRYPTO_TECH_MODE_OPEN_CLOSE|BD_CRYPTO_TECH_MODE_QUERY); + if (ret != mode) { + g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL, +- "Only 'query' supported for Integrity"); ++ "Only 'create', 'open' and 'query' supported for Integrity"); + return FALSE; + } else + return TRUE; + case BD_CRYPTO_TECH_BITLK: +-#ifndef LIBCRYPTSETUP_BITLK ++#ifndef LIBCRYPTSETUP_23 + g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL, + "BITLK technology requires libcryptsetup >= 2.3.0"); + return FALSE; +@@ -2035,6 +2084,208 @@ BDCryptoIntegrityInfo* bd_crypto_integrity_info (const gchar *device, GError **e + } + #endif + ++static int _wipe_progress (guint64 size, guint64 offset, void *usrptr) { ++ /* "convert" the progress from 0-100 to 50-100 because wipe starts at 50 in bd_crypto_integrity_format */ ++ gdouble progress = 50 + (((gdouble) offset / size) * 100) / 2; ++ bd_utils_report_progress (*(guint64 *) usrptr, progress, "Integrity device wipe in progress"); ++ ++ return 0; ++} ++ ++/** ++ * bd_crypto_integrity_format: ++ * @device: a device to format as integrity ++ * @algorithm: integrity algorithm specification (e.g. "crc32c" or "sha256") ++ * @wipe: whether to wipe the device after format; a device that is not initially wiped will contain invalid checksums ++ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed ++ * @key_size: size the integrity key and @key_data ++ * @extra: (allow-none): extra arguments for integrity format creation ++ * @error: (out): place to store error (if any) ++ * ++ * Formats the given @device as integrity according to the other parameters given. ++ * ++ * Returns: whether the given @device was successfully formatted as integrity or not ++ * (the @error) contains the error in such cases) ++ * ++ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_CREATE ++ */ ++gboolean bd_crypto_integrity_format (const gchar *device, const gchar *algorithm, gboolean wipe, const guint8* key_data, gsize key_size, BDCryptoIntegrityExtra *extra, GError **error) { ++ struct crypt_device *cd = NULL; ++ gint ret; ++ guint64 progress_id = 0; ++ gchar *msg = NULL; ++ struct crypt_params_integrity params = ZERO_INIT; ++ g_autofree gchar *tmp_name = NULL; ++ g_autofree gchar *tmp_path = NULL; ++ g_autofree gchar *dev_name = NULL; ++ ++ msg = g_strdup_printf ("Started formatting '%s' as integrity device", device); ++ progress_id = bd_utils_report_started (msg); ++ g_free (msg); ++ ++ ret = crypt_init (&cd, device); ++ if (ret != 0) { ++ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, ++ "Failed to initialize device: %s", strerror_l (-ret, c_locale)); ++ bd_utils_report_finished (progress_id, (*error)->message); ++ return FALSE; ++ } ++ ++ if (extra) { ++ params.sector_size = extra->sector_size; ++ params.journal_size = extra->journal_size; ++ params.journal_watermark = extra->journal_watermark; ++ params.journal_commit_time = extra->journal_commit_time; ++ params.interleave_sectors = extra->interleave_sectors; ++ params.tag_size = extra->tag_size; ++ params.buffer_sectors = extra->buffer_sectors; ++ } ++ ++ params.integrity_key_size = key_size; ++ params.integrity = algorithm; ++ params.tag_size = params.tag_size ? params.tag_size : DEFAULT_INTEGRITY_TAG_SIZE; ++ ++ ret = crypt_format (cd, CRYPT_INTEGRITY, NULL, NULL, NULL, NULL, 0, ¶ms); ++ if (ret != 0) { ++ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_FORMAT_FAILED, ++ "Failed to format device: %s", strerror_l (-ret, c_locale)); ++ crypt_free (cd); ++ bd_utils_report_finished (progress_id, (*error)->message); ++ return FALSE; ++ } ++ ++ if (wipe) { ++ bd_utils_report_progress (progress_id, 50, "Format created"); ++ ++ dev_name = g_path_get_basename (device); ++ tmp_name = g_strdup_printf ("bd-temp-integrity-%s-%d", dev_name, g_random_int ()); ++ tmp_path = g_strdup_printf ("%s/%s", crypt_get_dir (), tmp_name); ++ ++ ret = crypt_activate_by_volume_key (cd, tmp_name, (const char *) key_data, key_size, ++ CRYPT_ACTIVATE_PRIVATE | CRYPT_ACTIVATE_NO_JOURNAL); ++ if (ret != 0) { ++ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, ++ "Failed to activate the newly created integrity device for wiping: %s", ++ strerror_l (-ret, c_locale)); ++ crypt_free (cd); ++ bd_utils_report_finished (progress_id, (*error)->message); ++ return FALSE; ++ } ++ ++ bd_utils_report_progress (progress_id, 50, "Starting to wipe the newly created integrity device"); ++ ret = crypt_wipe (cd, tmp_path, CRYPT_WIPE_ZERO, 0, 0, 1048576, ++ 0, &_wipe_progress, &progress_id); ++ bd_utils_report_progress (progress_id, 100, "Wipe finished"); ++ if (ret != 0) { ++ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, ++ "Failed to wipe the newly created integrity device: %s", ++ strerror_l (-ret, c_locale)); ++ ++ ret = crypt_deactivate (cd, tmp_name); ++ if (ret != 0) ++ g_warning ("Failed to deactivate temporary device %s", tmp_name); ++ ++ crypt_free (cd); ++ bd_utils_report_finished (progress_id, (*error)->message); ++ return FALSE; ++ } ++ ++ ret = crypt_deactivate (cd, tmp_name); ++ if (ret != 0) ++ g_warning ("Failed to deactivate temporary device %s", tmp_name); ++ ++ } else ++ bd_utils_report_finished (progress_id, "Completed"); ++ ++ crypt_free (cd); ++ ++ return TRUE; ++} ++ ++/** ++ * bd_crypto_integrity_open: ++ * @device: integrity device to open ++ * @name: name for the opened @device ++ * @algorithm: (allow-none): integrity algorithm specification (e.g. "crc32c" or "sha256") or %NULL to use the default ++ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed ++ * @key_size: size the integrity key and @key_data ++ * @flags: flags for the integrity device activation ++ * @extra: (allow-none): extra arguments for integrity open ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the @device was successfully opened or not ++ * ++ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE ++ */ ++gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const gchar *algorithm, const guint8* key_data, gsize key_size, BDCryptoIntegrityOpenFlags flags, BDCryptoIntegrityExtra *extra, GError **error) { ++ struct crypt_device *cd = NULL; ++ gint ret = 0; ++ guint64 progress_id = 0; ++ gchar *msg = NULL; ++ struct crypt_params_integrity params = ZERO_INIT; ++ ++ params.integrity = algorithm; ++ params.integrity_key_size = key_size; ++ ++ if (extra) { ++ params.sector_size = extra->sector_size; ++ params.journal_size = extra->journal_size; ++ params.journal_watermark = extra->journal_watermark; ++ params.journal_commit_time = extra->journal_commit_time; ++ params.interleave_sectors = extra->interleave_sectors; ++ params.tag_size = extra->tag_size; ++ params.buffer_sectors = extra->buffer_sectors; ++ } ++ ++ msg = g_strdup_printf ("Started opening '%s' integrity device", device); ++ progress_id = bd_utils_report_started (msg); ++ g_free (msg); ++ ++ ret = crypt_init (&cd, device); ++ if (ret != 0) { ++ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, ++ "Failed to initialize device: %s", strerror_l (-ret, c_locale)); ++ bd_utils_report_finished (progress_id, (*error)->message); ++ return FALSE; ++ } ++ ++ ret = crypt_load (cd, CRYPT_INTEGRITY, ¶ms); ++ if (ret != 0) { ++ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, ++ "Failed to load device's parameters: %s", strerror_l (-ret, c_locale)); ++ crypt_free (cd); ++ bd_utils_report_finished (progress_id, (*error)->message); ++ return FALSE; ++ } ++ ++ ret = crypt_activate_by_volume_key (cd, name, (const char *) key_data, key_size, flags); ++ if (ret < 0) { ++ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, ++ "Failed to activate device: %s", strerror_l (-ret, c_locale)); ++ ++ crypt_free (cd); ++ bd_utils_report_finished (progress_id, (*error)->message); ++ return FALSE; ++ } ++ ++ crypt_free (cd); ++ bd_utils_report_finished (progress_id, "Completed"); ++ return TRUE; ++} ++ ++/** ++ * bd_crypto_integrity_close: ++ * @integrity_device: integrity device to close ++ * @error: (out): place to store error (if any) ++ * ++ * Returns: whether the given @integrity_device was successfully closed or not ++ * ++ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE ++ */ ++gboolean bd_crypto_integrity_close (const gchar *integrity_device, GError **error) { ++ return _crypto_close (integrity_device, "integrity", error); ++} ++ + /** + * bd_crypto_device_seems_encrypted: + * @device: the queried device +@@ -2471,7 +2722,7 @@ gboolean bd_crypto_escrow_device (const gchar *device, const gchar *passphrase, + * + * Tech category: %BD_CRYPTO_TECH_BITLK-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE + */ +-#ifndef LIBCRYPTSETUP_BITLK ++#ifndef LIBCRYPTSETUP_23 + gboolean bd_crypto_bitlk_open (const gchar *device UNUSED, const gchar *name UNUSED, const guint8* pass_data UNUSED, gsize data_len UNUSED, gboolean read_only UNUSED, GError **error) { + /* this will return FALSE and set error, because BITLK technology is not available */ + return bd_crypto_is_tech_avail (BD_CRYPTO_TECH_BITLK, BD_CRYPTO_TECH_MODE_OPEN_CLOSE, error); +@@ -2541,7 +2792,7 @@ gboolean bd_crypto_bitlk_open (const gchar *device, const gchar *name, const gui + * + * Tech category: %BD_CRYPTO_TECH_BITLK-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE + */ +-#ifndef LIBCRYPTSETUP_BITLK ++#ifndef LIBCRYPTSETUP_23 + gboolean bd_crypto_bitlk_close (const gchar *bitlk_device UNUSED, GError **error) { + /* this will return FALSE and set error, because BITLK technology is not available */ + return bd_crypto_is_tech_avail (BD_CRYPTO_TECH_BITLK, BD_CRYPTO_TECH_MODE_OPEN_CLOSE, error); +diff --git a/src/plugins/crypto.h b/src/plugins/crypto.h +index 1c8f47ea..6c1d40dd 100644 +--- a/src/plugins/crypto.h ++++ b/src/plugins/crypto.h +@@ -122,6 +122,43 @@ void bd_crypto_luks_extra_free (BDCryptoLUKSExtra *extra); + BDCryptoLUKSExtra* bd_crypto_luks_extra_copy (BDCryptoLUKSExtra *extra); + BDCryptoLUKSExtra* bd_crypto_luks_extra_new (guint64 data_alignment, const gchar *data_device, const gchar *integrity, guint64 sector_size, const gchar *label, const gchar *subsystem, BDCryptoLUKSPBKDF *pbkdf); + ++/** ++ * BDCryptoIntegrityExtra: ++ * @sector_size: integrity sector size ++ * @journal_size: size of journal in bytes ++ * @journal_watermark: journal flush watermark in percents; in bitmap mode sectors-per-bit ++ * @journal_commit_time: journal commit time (or bitmap flush time) in ms ++ * @interleave_sectors: number of interleave sectors (power of two) ++ * @tag_size: tag size per-sector in bytes ++ * @buffer_sectors: number of sectors in one buffer ++ */ ++typedef struct BDCryptoIntegrityExtra { ++ guint32 sector_size; ++ guint64 journal_size; ++ guint journal_watermark; ++ guint journal_commit_time; ++ guint32 interleave_sectors; ++ guint32 tag_size; ++ guint32 buffer_sectors; ++} BDCryptoIntegrityExtra; ++ ++void bd_crypto_integrity_extra_free (BDCryptoIntegrityExtra *extra); ++BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra *extra); ++BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors); ++ ++typedef enum { ++ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = CRYPT_ACTIVATE_NO_JOURNAL, ++ BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = CRYPT_ACTIVATE_RECOVERY, ++#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP ++ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP, ++#endif ++ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = CRYPT_ACTIVATE_RECALCULATE, ++#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET ++ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = CRYPT_ACTIVATE_RECALCULATE_RESET, ++#endif ++ BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = CRYPT_ACTIVATE_ALLOW_DISCARDS, ++} BDCryptoIntegrityOpenFlags; ++ + /** + * BDCryptoLUKSInfo: + * @version: LUKS version +@@ -215,6 +252,10 @@ gboolean bd_crypto_luks_header_restore (const gchar *device, const gchar *backup + BDCryptoLUKSInfo* bd_crypto_luks_info (const gchar *luks_device, GError **error); + BDCryptoIntegrityInfo* bd_crypto_integrity_info (const gchar *device, GError **error); + ++gboolean bd_crypto_integrity_format (const gchar *device, const gchar *algorithm, gboolean wipe, const guint8* key_data, gsize key_size, BDCryptoIntegrityExtra *extra, GError **error); ++gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const gchar *algorithm, const guint8* key_data, gsize key_size, BDCryptoIntegrityOpenFlags flags, BDCryptoIntegrityExtra *extra, GError **error); ++gboolean bd_crypto_integrity_close (const gchar *integrity_device, GError **error); ++ + gboolean bd_crypto_device_seems_encrypted (const gchar *device, GError **error); + gboolean bd_crypto_tc_open (const gchar *device, const gchar *name, const guint8* pass_data, gsize data_len, gboolean read_only, GError **error); + gboolean bd_crypto_tc_open_full (const gchar *device, const gchar *name, const guint8* pass_data, gsize data_len, const gchar **keyfiles, gboolean hidden, gboolean system, gboolean veracrypt, guint32 veracrypt_pim, gboolean read_only, GError **error); +diff --git a/src/python/gi/overrides/BlockDev.py b/src/python/gi/overrides/BlockDev.py +index 8574ab04..8bd03cf8 100644 +--- a/src/python/gi/overrides/BlockDev.py ++++ b/src/python/gi/overrides/BlockDev.py +@@ -276,6 +276,30 @@ def crypto_bitlk_open(device, name, passphrase, read_only=False): + __all__.append("crypto_bitlk_open") + + ++class CryptoIntegrityExtra(BlockDev.CryptoIntegrityExtra): ++ def __new__(cls, sector_size=0, journal_size=0, journal_watermark=0, journal_commit_time=0, interleave_sectors=0, tag_size=0, buffer_sectors=0): ++ ret = BlockDev.CryptoIntegrityExtra.new(sector_size, journal_size, journal_watermark, journal_commit_time, interleave_sectors, tag_size, buffer_sectors) ++ ret.__class__ = cls ++ return ret ++ def __init__(self, *args, **kwargs): # pylint: disable=unused-argument ++ super(CryptoIntegrityExtra, self).__init__() #pylint: disable=bad-super-call ++CryptoIntegrityExtra = override(CryptoIntegrityExtra) ++__all__.append("CryptoIntegrityExtra") ++ ++ ++_crypto_integrity_format = BlockDev.crypto_integrity_format ++@override(BlockDev.crypto_integrity_format) ++def crypto_integrity_format(device, algorithm=None, wipe=True, key_data=None, extra=None): ++ return _crypto_integrity_format(device, algorithm, wipe, key_data, extra) ++__all__.append("crypto_integrity_format") ++ ++_crypto_integrity_open = BlockDev.crypto_integrity_open ++@override(BlockDev.crypto_integrity_open) ++def crypto_integrity_open(device, name, algorithm, key_data=None, flags=0, extra=None): ++ return _crypto_integrity_open(device, name, algorithm, key_data, flags, extra) ++__all__.append("crypto_integrity_open") ++ ++ + _dm_create_linear = BlockDev.dm_create_linear + @override(BlockDev.dm_create_linear) + def dm_create_linear(map_name, device, length, uuid=None): +diff --git a/tests/crypto_test.py b/tests/crypto_test.py +index 5e02c00d..a8fc8579 100644 +--- a/tests/crypto_test.py ++++ b/tests/crypto_test.py +@@ -2,6 +2,7 @@ import unittest + import os + import tempfile + import overrides_hack ++import secrets + import shutil + import subprocess + import six +@@ -34,6 +35,8 @@ class CryptoTestCase(unittest.TestCase): + + requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "loop")) + ++ _dm_name = "libblockdevTestLUKS" ++ + @classmethod + def setUpClass(cls): + unittest.TestCase.setUpClass() +@@ -64,7 +67,7 @@ class CryptoTestCase(unittest.TestCase): + + def _clean_up(self): + try: +- BlockDev.crypto_luks_close("libblockdevTestLUKS") ++ BlockDev.crypto_luks_close(self._dm_name) + except: + pass + +@@ -1029,7 +1032,7 @@ class CryptoTestLuksSectorSize(CryptoTestCase): + self.assertTrue(succ) + + +-class CryptoTestIntegrity(CryptoTestCase): ++class CryptoTestLUKS2Integrity(CryptoTestCase): + @tag_test(TestTags.SLOW) + @unittest.skipUnless(HAVE_LUKS2, "LUKS 2 not supported") + def test_luks2_integrity(self): +@@ -1216,3 +1219,92 @@ class CryptoTestBitlk(CryptoTestCase): + succ = BlockDev.crypto_bitlk_close("libblockdevTestBitlk") + self.assertTrue(succ) + self.assertFalse(os.path.exists("/dev/mapper/libblockdevTestBitlk")) ++ ++ ++class CryptoTestIntegrity(CryptoTestCase): ++ ++ _dm_name = "libblockdevTestIntegrity" ++ ++ @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported") ++ def test_integrity(self): ++ # basic format+open+close test ++ succ = BlockDev.crypto_integrity_format(self.loop_dev, "sha256", False) ++ self.assertTrue(succ) ++ ++ succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "sha256") ++ self.assertTrue(succ) ++ self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name)) ++ ++ info = BlockDev.crypto_integrity_info(self._dm_name) ++ self.assertEqual(info.algorithm, "sha256") ++ ++ succ = BlockDev.crypto_integrity_close(self._dm_name) ++ self.assertTrue(succ) ++ self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) ++ ++ # same now with a keyed algorithm ++ key = list(secrets.token_bytes(64)) ++ ++ succ = BlockDev.crypto_integrity_format(self.loop_dev, "hmac(sha256)", False, key) ++ self.assertTrue(succ) ++ ++ succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "hmac(sha256)", key) ++ self.assertTrue(succ) ++ self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name)) ++ ++ info = BlockDev.crypto_integrity_info(self._dm_name) ++ self.assertEqual(info.algorithm, "hmac(sha256)") ++ ++ succ = BlockDev.crypto_integrity_close(self._dm_name) ++ self.assertTrue(succ) ++ self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) ++ ++ # same with some custom parameters ++ extra = BlockDev.CryptoIntegrityExtra(sector_size=4096, interleave_sectors=65536) ++ succ = BlockDev.crypto_integrity_format(self.loop_dev, "crc32c", wipe=False, extra=extra) ++ self.assertTrue(succ) ++ ++ succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "crc32c") ++ self.assertTrue(succ) ++ self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name)) ++ ++ info = BlockDev.crypto_integrity_info(self._dm_name) ++ self.assertEqual(info.algorithm, "crc32c") ++ self.assertEqual(info.sector_size, 4096) ++ self.assertEqual(info.interleave_sectors, 65536) ++ ++ succ = BlockDev.crypto_integrity_close(self._dm_name) ++ self.assertTrue(succ) ++ self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) ++ ++ @tag_test(TestTags.SLOW) ++ @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported") ++ def test_integrity_wipe(self): ++ # also check that wipe progress reporting works ++ progress_log = [] ++ ++ def _my_progress_func(_task, _status, completion, msg): ++ progress_log.append((completion, msg)) ++ ++ succ = BlockDev.utils_init_prog_reporting(_my_progress_func) ++ self.assertTrue(succ) ++ self.addCleanup(BlockDev.utils_init_prog_reporting, None) ++ ++ succ = BlockDev.crypto_integrity_format(self.loop_dev, "sha256", True) ++ self.assertTrue(succ) ++ ++ # at least one message "Integrity device wipe in progress" should be logged ++ self.assertTrue(any(prog[1] == "Integrity device wipe in progress" for prog in progress_log)) ++ ++ succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "sha256") ++ self.assertTrue(succ) ++ self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name)) ++ ++ # check the devices was wiped and the checksums recalculated ++ # (mkfs reads some blocks first so without checksums it would fail) ++ ret, _out, err = run_command("mkfs.ext2 /dev/mapper/%s " % self._dm_name) ++ self.assertEqual(ret, 0, msg="Failed to create ext2 filesystem on integrity: %s" % err) ++ ++ succ = BlockDev.crypto_integrity_close(self._dm_name) ++ self.assertTrue(succ) ++ self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) +-- +2.37.3 + + +From ad4ac36520ec96af2a7b043189bbdf18cc3cffb9 Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Thu, 30 Sep 2021 16:01:40 +0200 +Subject: [PATCH 2/3] Create smaller test images for integrity tests + +We are going to overwrite the entire device in test_integrity_wipe +so we need to make sure the sparse actually fits to /tmp which +can be smaller than 1 GiB. +--- + tests/crypto_test.py | 6 ++++-- + 1 file changed, 4 insertions(+), 2 deletions(-) + +diff --git a/tests/crypto_test.py b/tests/crypto_test.py +index a8fc8579..9758bf81 100644 +--- a/tests/crypto_test.py ++++ b/tests/crypto_test.py +@@ -36,6 +36,7 @@ class CryptoTestCase(unittest.TestCase): + requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "loop")) + + _dm_name = "libblockdevTestLUKS" ++ _sparse_size = 1024**3 + + @classmethod + def setUpClass(cls): +@@ -49,8 +50,8 @@ class CryptoTestCase(unittest.TestCase): + + def setUp(self): + self.addCleanup(self._clean_up) +- self.dev_file = create_sparse_tempfile("crypto_test", 1024**3) +- self.dev_file2 = create_sparse_tempfile("crypto_test2", 1024**3) ++ self.dev_file = create_sparse_tempfile("crypto_test", self._sparse_size) ++ self.dev_file2 = create_sparse_tempfile("crypto_test2", self._sparse_size) + try: + self.loop_dev = create_lio_device(self.dev_file) + except RuntimeError as e: +@@ -1224,6 +1225,7 @@ class CryptoTestBitlk(CryptoTestCase): + class CryptoTestIntegrity(CryptoTestCase): + + _dm_name = "libblockdevTestIntegrity" ++ _sparse_size = 100 * 1024**2 + + @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported") + def test_integrity(self): +-- +2.37.3 + + +From 048a803be5186b30c0f0a7e67020486990ba6b81 Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Wed, 20 Oct 2021 10:27:41 +0200 +Subject: [PATCH 3/3] crypto: Do not use libcryptsetup flags directly in + crypto.h + +We can "translate" our flags in the implementation instead to +avoid including libcryptsetup.h in our header and API files. +--- + src/lib/plugin_apis/crypto.api | 17 ++++++----------- + src/plugins/crypto.c | 34 +++++++++++++++++++++++++++++++++- + src/plugins/crypto.h | 16 ++++++---------- + tests/crypto_test.py | 14 ++++++++++++++ + 4 files changed, 59 insertions(+), 22 deletions(-) + +diff --git a/src/lib/plugin_apis/crypto.api b/src/lib/plugin_apis/crypto.api +index 40e32c89..cf87979d 100644 +--- a/src/lib/plugin_apis/crypto.api ++++ b/src/lib/plugin_apis/crypto.api +@@ -1,6 +1,5 @@ + #include + #include +-#include + + #define BD_CRYPTO_LUKS_METADATA_SIZE G_GUINT64_CONSTANT (2097152ULL) // 2 MiB + +@@ -343,16 +342,12 @@ GType bd_crypto_integrity_extra_get_type () { + } + + typedef enum { +- BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = CRYPT_ACTIVATE_NO_JOURNAL, +- BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = CRYPT_ACTIVATE_RECOVERY, +-#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP +- BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP, +-#endif +- BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = CRYPT_ACTIVATE_RECALCULATE, +-#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET +- BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = CRYPT_ACTIVATE_RECALCULATE_RESET, +-#endif +- BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = CRYPT_ACTIVATE_ALLOW_DISCARDS, ++ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = 1 << 0, ++ BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = 1 << 1, ++ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = 1 << 2, ++ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = 1 << 3, ++ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = 1 << 4, ++ BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = 1 << 5, + } BDCryptoIntegrityOpenFlags; + + #define BD_CRYPTO_TYPE_LUKS_INFO (bd_crypto_luks_info_get_type ()) +diff --git a/src/plugins/crypto.c b/src/plugins/crypto.c +index 8549cf23..35c38410 100644 +--- a/src/plugins/crypto.c ++++ b/src/plugins/crypto.c +@@ -2223,6 +2223,7 @@ gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const + guint64 progress_id = 0; + gchar *msg = NULL; + struct crypt_params_integrity params = ZERO_INIT; ++ guint32 activate_flags = 0; + + params.integrity = algorithm; + params.integrity_key_size = key_size; +@@ -2237,6 +2238,37 @@ gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const + params.buffer_sectors = extra->buffer_sectors; + } + ++ ++ if (flags & BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL) ++ activate_flags |= CRYPT_ACTIVATE_NO_JOURNAL; ++ if (flags & BD_CRYPTO_INTEGRITY_OPEN_RECOVERY) ++ activate_flags |= CRYPT_ACTIVATE_RECOVERY; ++ if (flags & BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE) ++ activate_flags |= CRYPT_ACTIVATE_RECALCULATE; ++ if (flags & BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS) ++ activate_flags |= CRYPT_ACTIVATE_ALLOW_DISCARDS; ++ if (flags & BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP) { ++#ifndef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP ++ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL, ++ "Cannot activate %s with bitmap, installed version of cryptsetup doesn't support this option.", device); ++ bd_utils_report_finished (progress_id, (*error)->message); ++ return FALSE; ++#else ++ activate_flags |= CRYPT_ACTIVATE_NO_JOURNAL_BITMAP; ++#endif ++ } ++ ++ if (flags & BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET) { ++#ifndef CRYPT_ACTIVATE_RECALCULATE_RESET ++ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL, ++ "Cannot reset integrity recalculation while activating %s, installed version of cryptsetup doesn't support this option.", device); ++ bd_utils_report_finished (progress_id, (*error)->message); ++ return FALSE; ++#else ++ activate_flags |= CRYPT_ACTIVATE_RECALCULATE_RESET; ++#endif ++ } ++ + msg = g_strdup_printf ("Started opening '%s' integrity device", device); + progress_id = bd_utils_report_started (msg); + g_free (msg); +@@ -2258,7 +2290,7 @@ gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const + return FALSE; + } + +- ret = crypt_activate_by_volume_key (cd, name, (const char *) key_data, key_size, flags); ++ ret = crypt_activate_by_volume_key (cd, name, (const char *) key_data, key_size, activate_flags); + if (ret < 0) { + g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, + "Failed to activate device: %s", strerror_l (-ret, c_locale)); +diff --git a/src/plugins/crypto.h b/src/plugins/crypto.h +index 6c1d40dd..536accf9 100644 +--- a/src/plugins/crypto.h ++++ b/src/plugins/crypto.h +@@ -147,16 +147,12 @@ BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra * + BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors); + + typedef enum { +- BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = CRYPT_ACTIVATE_NO_JOURNAL, +- BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = CRYPT_ACTIVATE_RECOVERY, +-#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP +- BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP, +-#endif +- BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = CRYPT_ACTIVATE_RECALCULATE, +-#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET +- BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = CRYPT_ACTIVATE_RECALCULATE_RESET, +-#endif +- BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = CRYPT_ACTIVATE_ALLOW_DISCARDS, ++ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = 1 << 0, ++ BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = 1 << 1, ++ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = 1 << 2, ++ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = 1 << 3, ++ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = 1 << 4, ++ BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = 1 << 5, + } BDCryptoIntegrityOpenFlags; + + /** +diff --git a/tests/crypto_test.py b/tests/crypto_test.py +index 9758bf81..94b89131 100644 +--- a/tests/crypto_test.py ++++ b/tests/crypto_test.py +@@ -1279,6 +1279,20 @@ class CryptoTestIntegrity(CryptoTestCase): + self.assertTrue(succ) + self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) + ++ # open with flags ++ succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "crc32c", ++ flags=BlockDev.CryptoIntegrityOpenFlags.ALLOW_DISCARDS) ++ self.assertTrue(succ) ++ self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name)) ++ ++ # check that discard is enabled for the mapped device ++ _ret, out, _err = run_command("dmsetup table %s" % self._dm_name) ++ self.assertIn("allow_discards", out) ++ ++ succ = BlockDev.crypto_integrity_close(self._dm_name) ++ self.assertTrue(succ) ++ self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) ++ + @tag_test(TestTags.SLOW) + @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported") + def test_integrity_wipe(self): +-- +2.37.3 + diff --git a/SOURCES/0002-Fix-default-key-size-for-non-XTS-ciphers.patch b/SOURCES/0002-Fix-default-key-size-for-non-XTS-ciphers.patch deleted file mode 100644 index 6292ac7..0000000 --- a/SOURCES/0002-Fix-default-key-size-for-non-XTS-ciphers.patch +++ /dev/null @@ -1,97 +0,0 @@ -From 5d29bc014a33d9bdc1c5fb4b8add2f38850f46a8 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Wed, 24 Feb 2021 14:44:03 +0100 -Subject: [PATCH] crypto: Fix default key size for non XTS ciphers - -512 bits should be default only for AES-XTS which needs two keys, -default for other modes must be 256 bits. - -resolves: rhbz#1931847 ---- - src/plugins/crypto.c | 11 +++++++++-- - src/plugins/crypto.h | 2 +- - tests/crypto_test.py | 36 ++++++++++++++++++++++++++++++++++++ - 3 files changed, 46 insertions(+), 3 deletions(-) - -diff --git a/src/plugins/crypto.c b/src/plugins/crypto.c -index f4a2e8f0..1e7043fa 100644 ---- a/src/plugins/crypto.c -+++ b/src/plugins/crypto.c -@@ -774,8 +774,15 @@ static gboolean luks_format (const gchar *device, const gchar *cipher, guint64 k - return FALSE; - } - -- /* resolve requested/default key_size (should be in bytes) */ -- key_size = (key_size != 0) ? (key_size / 8) : (DEFAULT_LUKS_KEYSIZE_BITS / 8); -+ if (key_size == 0) { -+ if (g_str_has_prefix (cipher_specs[1], "xts-")) -+ key_size = DEFAULT_LUKS_KEYSIZE_BITS * 2; -+ else -+ key_size = DEFAULT_LUKS_KEYSIZE_BITS; -+ } -+ -+ /* key_size should be in bytes */ -+ key_size = key_size / 8; - - /* wait for enough random data entropy (if requested) */ - if (min_entropy > 0) { -diff --git a/src/plugins/crypto.h b/src/plugins/crypto.h -index 71a1438d..a38724d9 100644 ---- a/src/plugins/crypto.h -+++ b/src/plugins/crypto.h -@@ -36,7 +36,7 @@ typedef enum { - /* 20 chars * 6 bits per char (64-item charset) = 120 "bits of security" */ - #define BD_CRYPTO_BACKUP_PASSPHRASE_LENGTH 20 - --#define DEFAULT_LUKS_KEYSIZE_BITS 512 -+#define DEFAULT_LUKS_KEYSIZE_BITS 256 - #define DEFAULT_LUKS_CIPHER "aes-xts-plain64" - #define DEFAULT_LUKS2_SECTOR_SIZE 512 - -diff --git a/tests/crypto_test.py b/tests/crypto_test.py -index 0609a070..0aecc032 100644 ---- a/tests/crypto_test.py -+++ b/tests/crypto_test.py -@@ -236,6 +236,42 @@ def test_luks2_format(self): - self.fail("Failed to get pbkdf information from:\n%s %s" % (out, err)) - self.assertEqual(int(m.group(1)), 5) - -+ def _get_luks1_key_size(self, device): -+ _ret, out, err = run_command("cryptsetup luksDump %s" % device) -+ m = re.search(r"MK bits:\s*(\S+)\s*", out) -+ if not m or len(m.groups()) != 1: -+ self.fail("Failed to get key size information from:\n%s %s" % (out, err)) -+ key_size = m.group(1) -+ if not key_size.isnumeric(): -+ self.fail("Failed to get key size information from: %s" % key_size) -+ return int(key_size) -+ -+ @tag_test(TestTags.SLOW, TestTags.CORE) -+ def test_luks_format_key_size(self): -+ """Verify that formating device as LUKS works""" -+ -+ # aes-xts: key size should default to 512 -+ succ = BlockDev.crypto_luks_format(self.loop_dev, "aes-xts-plain64", 0, PASSWD, None, 0) -+ self.assertTrue(succ) -+ -+ key_size = self._get_luks1_key_size(self.loop_dev) -+ self.assertEqual(key_size, 512) -+ -+ # aes-cbc: key size should default to 256 -+ succ = BlockDev.crypto_luks_format(self.loop_dev, "aes-cbc-essiv:sha256", 0, PASSWD, None, 0) -+ self.assertTrue(succ) -+ -+ key_size = self._get_luks1_key_size(self.loop_dev) -+ self.assertEqual(key_size, 256) -+ -+ # try specifying key size for aes-xts -+ succ = BlockDev.crypto_luks_format(self.loop_dev, "aes-xts-plain64", 256, PASSWD, None, 0) -+ self.assertTrue(succ) -+ -+ key_size = self._get_luks1_key_size(self.loop_dev) -+ self.assertEqual(key_size, 256) -+ -+ - class CryptoTestResize(CryptoTestCase): - - def _get_key_location(self, device): diff --git a/SOURCES/0003-Memory-leaks-fixes-backport.patch b/SOURCES/0003-Memory-leaks-fixes-backport.patch deleted file mode 100644 index 5c19421..0000000 --- a/SOURCES/0003-Memory-leaks-fixes-backport.patch +++ /dev/null @@ -1,178 +0,0 @@ -From 98cb3b9cf2046ba6e33db6ff400449c6a4827932 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Thu, 29 Apr 2021 12:38:49 +0200 -Subject: [PATCH 1/8] kbd: Fix memory leak - ---- - src/plugins/kbd.c | 1 + - 1 file changed, 1 insertion(+) - -diff --git a/src/plugins/kbd.c b/src/plugins/kbd.c -index a2908ecb..d5ae0ed7 100644 ---- a/src/plugins/kbd.c -+++ b/src/plugins/kbd.c -@@ -1035,6 +1035,7 @@ gboolean bd_kbd_bcache_destroy (const gchar *bcache_device, GError **error) { - - if (c_set_uuid) { - path = g_strdup_printf ("/sys/fs/bcache/%s/stop", c_set_uuid); -+ g_free (c_set_uuid); - success = bd_utils_echo_str_to_file ("1", path, error); - g_free (path); - if (!success) { - -From c6d226c70996f6006a3f6eff13f8264f03e95c4f Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 25 Sep 2020 14:22:58 +0200 -Subject: [PATCH 2/8] crypto: Fix memory leak - ---- - src/plugins/crypto.c | 1 + - 1 file changed, 1 insertion(+) - -diff --git a/src/plugins/crypto.c b/src/plugins/crypto.c -index 1e7043fa..4fad9a85 100644 ---- a/src/plugins/crypto.c -+++ b/src/plugins/crypto.c -@@ -1275,6 +1275,7 @@ gboolean bd_crypto_luks_add_key (const gchar *device, const gchar *pass, const g - success = g_file_get_contents (nkey_file, &nkey_buf, &nbuf_len, error); - if (!success) { - g_prefix_error (error, "Failed to load key from file '%s': ", nkey_file); -+ g_free (key_buf); - return FALSE; - } - } else - -From 41b460fb81cf066e7ddc0bdda7f34db5e90b9f79 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 25 Sep 2020 14:23:24 +0200 -Subject: [PATCH 3/8] dm: Fix memory leak in the DM plugin and DM logging - redirect function - ---- - src/plugins/dm.c | 3 ++- - 1 file changed, 2 insertions(+), 1 deletion(-) - -diff --git a/src/plugins/dm.c b/src/plugins/dm.c -index fb4e50b5..c9a735ed 100644 ---- a/src/plugins/dm.c -+++ b/src/plugins/dm.c -@@ -245,7 +245,8 @@ gchar* bd_dm_name_from_node (const gchar *dm_node, GError **error) { - g_free (sys_path); - - if (!success) { -- /* errror is already populated */ -+ /* error is already populated */ -+ g_free (ret); - return NULL; - } - - -From 8d085fbb15c18ca91a5eff89192391c5a0b3bb7a Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 25 Sep 2020 14:24:14 +0200 -Subject: [PATCH 4/8] fs: Fix memory leak - ---- - src/plugins/fs/mount.c | 1 + - 1 file changed, 1 insertion(+) - -diff --git a/src/plugins/fs/mount.c b/src/plugins/fs/mount.c -index 43d64e8c..46e03ca4 100644 ---- a/src/plugins/fs/mount.c -+++ b/src/plugins/fs/mount.c -@@ -541,6 +541,7 @@ static gboolean run_as_user (MountFunc func, MountArgs *args, uid_t run_as_uid, - "Unknoen error while reading error."); - g_io_channel_unref (channel); - close (pipefd[0]); -+ g_free (error_msg); - return FALSE; - } - - -From 6c45f4ef1fc898d71cc2f13670adb508a6037c66 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 25 Sep 2020 14:26:24 +0200 -Subject: [PATCH 5/8] kbd: Fix memory leak - ---- - src/plugins/kbd.c | 1 + - 1 file changed, 1 insertion(+) - -diff --git a/src/plugins/kbd.c b/src/plugins/kbd.c -index d5ae0ed7..ff8bde17 100644 ---- a/src/plugins/kbd.c -+++ b/src/plugins/kbd.c -@@ -1255,6 +1255,7 @@ static gboolean get_cache_size_used (const gchar *cache_dev_sys, guint64 *size, - g_io_channel_unref (file); - - if (!found) { -+ g_free (line); - g_set_error (error, BD_KBD_ERROR, BD_KBD_ERROR_BCACHE_INVAL, - "Failed to get cache usage data"); - return FALSE; - -From 4f4e93dfca36421eb0e0cb2dec5d48df5bc2f363 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 25 Sep 2020 14:26:37 +0200 -Subject: [PATCH 6/8] lvm-dbus: Fix memory leak - ---- - src/plugins/lvm-dbus.c | 1 + - 1 file changed, 1 insertion(+) - -diff --git a/src/plugins/lvm-dbus.c b/src/plugins/lvm-dbus.c -index b7b4480e..144551f5 100644 ---- a/src/plugins/lvm-dbus.c -+++ b/src/plugins/lvm-dbus.c -@@ -2927,6 +2927,7 @@ gboolean bd_lvm_cache_detach (const gchar *vg_name, const gchar *cached_lv, gboo - lv_id = g_strdup_printf ("%s/%s", vg_name, cached_lv); - call_lvm_obj_method_sync (lv_id, CACHED_LV_INTF, "DetachCachePool", params, NULL, extra, TRUE, error); - g_free (lv_id); -+ g_free (cache_pool_name); - return ((*error) == NULL); - } - - -From 410a10bc2cfceeb550d72456573d4722b4207ddc Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 25 Sep 2020 14:27:22 +0200 -Subject: [PATCH 7/8] mdraid: Fix memory leak - ---- - src/plugins/mdraid.c | 1 + - 1 file changed, 1 insertion(+) - -diff --git a/src/plugins/mdraid.c b/src/plugins/mdraid.c -index 74af744c..b97bc641 100644 ---- a/src/plugins/mdraid.c -+++ b/src/plugins/mdraid.c -@@ -1332,6 +1332,7 @@ gchar* bd_md_name_from_node (const gchar *node, GError **error) { - continue; - } - node_name = g_path_get_basename (dev_path); -+ g_free (dev_path); - if (g_strcmp0 (node_name, node) == 0) { - found = TRUE; - name = g_path_get_basename (*path_p); - -From 0d49e5d190e24fa89ae2795714d0276f24285b19 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 25 Sep 2020 14:27:54 +0200 -Subject: [PATCH 8/8] swap: Fix memory leak - ---- - src/plugins/swap.c | 1 + - 1 file changed, 1 insertion(+) - -diff --git a/src/plugins/swap.c b/src/plugins/swap.c -index 102780a7..115f8fca 100644 ---- a/src/plugins/swap.c -+++ b/src/plugins/swap.c -@@ -417,6 +417,7 @@ gboolean bd_swap_swapstatus (const gchar *device, GError **error) { - if (!real_device) { - /* the device doesn't exist and thus is not an active swap */ - g_clear_error (error); -+ g_free (file_content); - return FALSE; - } - } diff --git a/SOURCES/0003-NVMe-plugin-backport.patch b/SOURCES/0003-NVMe-plugin-backport.patch new file mode 100644 index 0000000..083baa7 --- /dev/null +++ b/SOURCES/0003-NVMe-plugin-backport.patch @@ -0,0 +1,6467 @@ +From 35d0b1d43a901151a47478205b4e0cfcb8e350ed Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Thu, 22 Sep 2022 11:33:43 +0200 +Subject: [PATCH] NVMe plugin backport + +Resolves: rhbz#2123338 +--- + Makefile.am | 7 +- + configure.ac | 23 +- + data/conf.d/00-default.cfg | 3 + + dist/libblockdev.spec.in | 48 +- + docs/libblockdev-docs.xml.in | 1 + + docs/libblockdev-sections.txt | 70 ++ + features.rst | 12 + + include/blockdev/Makefile.am | 1 + + specs.rst | 1 + + src/lib/Makefile.am | 1 + + src/lib/blockdev.c.in | 18 +- + src/lib/plugin_apis/nvme.api | 1549 +++++++++++++++++++++++++++ + src/lib/plugins.h | 1 + + src/plugins/Makefile.am | 8 +- + src/plugins/nvme/Makefile.am | 22 + + src/plugins/nvme/nvme-error.c | 160 +++ + src/plugins/nvme/nvme-fabrics.c | 918 ++++++++++++++++ + src/plugins/nvme/nvme-info.c | 1028 ++++++++++++++++++ + src/plugins/nvme/nvme-op.c | 388 +++++++ + src/plugins/nvme/nvme-private.h | 25 + + src/plugins/nvme/nvme.c | 103 ++ + src/plugins/nvme/nvme.h | 700 ++++++++++++ + src/python/gi/overrides/BlockDev.py | 23 + + tests/library_test.py | 3 +- + tests/nvme_test.py | 638 +++++++++++ + tests/overrides_test.py | 3 +- + tests/run_tests.py | 3 +- + tests/utils.py | 240 +++++ + 28 files changed, 5986 insertions(+), 11 deletions(-) + create mode 100644 src/lib/plugin_apis/nvme.api + create mode 100644 src/plugins/nvme/Makefile.am + create mode 100644 src/plugins/nvme/nvme-error.c + create mode 100644 src/plugins/nvme/nvme-fabrics.c + create mode 100644 src/plugins/nvme/nvme-info.c + create mode 100644 src/plugins/nvme/nvme-op.c + create mode 100644 src/plugins/nvme/nvme-private.h + create mode 100644 src/plugins/nvme/nvme.c + create mode 100644 src/plugins/nvme/nvme.h + create mode 100644 tests/nvme_test.py + +diff --git a/Makefile.am b/Makefile.am +index 13090e36..324dad4c 100644 +--- a/Makefile.am ++++ b/Makefile.am +@@ -40,6 +40,10 @@ if !WITH_NVDIMM + DISTCHECK_CONFIGURE_FLAGS += --without-nvdimm + endif + ++if !WITH_NVME ++DISTCHECK_CONFIGURE_FLAGS += --without-nvme ++endif ++ + if !WITH_SWAP + DISTCHECK_CONFIGURE_FLAGS += --without-swap + endif +@@ -68,7 +72,7 @@ MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.guess config.sub \ + configure depcomp install-sh ltmain.sh missing py-compile compile ar-lib \ + m4/*.m4 + +-LIBDIRS = src/utils/.libs:src/plugins/.libs:src/plugins/fs/.libs:src/lib/.libs ++LIBDIRS = src/utils/.libs:src/plugins/.libs:src/plugins/fs/.libs:src/plugins/nvme/.libs:src/lib/.libs + GIDIR = src/lib + + if WITH_PYTHON3 +@@ -93,6 +97,7 @@ PLUGINS = btrfs \ + mdraid \ + mpath \ + nvdimm \ ++ nvme \ + part \ + s390 \ + swap \ +diff --git a/configure.ac b/configure.ac +index 79bf8045..ec789c91 100644 +--- a/configure.ac ++++ b/configure.ac +@@ -21,6 +21,7 @@ LT_INIT + AC_CONFIG_FILES([Makefile src/Makefile \ + src/plugins/Makefile \ + src/plugins/fs/Makefile \ ++ src/plugins/nvme/Makefile \ + src/utils/Makefile \ + src/utils/blockdev-utils.pc \ + src/lib/Makefile \ +@@ -181,6 +182,17 @@ AS_IF([test "x$with_tools" != "xno"], + [AC_SUBST([WITH_TOOLS], [1])], + []) + ++AC_ARG_WITH([nvme], ++ AS_HELP_STRING([--with-nvme], [support nvme @<:@default=yes@:>@]), ++ [], ++ [with_nvme=yes]) ++ ++AC_SUBST([WITH_NVME], [0]) ++AM_CONDITIONAL(WITH_NVME, test "x$with_nvme" != "xno") ++AS_IF([test "x$with_nvme" != "xno"], ++ [AC_DEFINE([WITH_BD_NVME], [], [Define if nvme is supported]) AC_SUBST([WITH_NVME], [1])], ++ []) ++ + LIBBLOCKDEV_PLUGIN([BTRFS], [btrfs]) + LIBBLOCKDEV_PLUGIN([CRYPTO], [crypto]) + LIBBLOCKDEV_PLUGIN([DM], [dm]) +@@ -194,6 +206,7 @@ LIBBLOCKDEV_PLUGIN([KBD], [kbd]) + LIBBLOCKDEV_PLUGIN([PART], [part]) + LIBBLOCKDEV_PLUGIN([FS], [fs]) + LIBBLOCKDEV_PLUGIN([NVDIMM], [nvdimm]) ++LIBBLOCKDEV_PLUGIN([NVME], [nvme]) + LIBBLOCKDEV_PLUGIN([VDO], [vdo]) + + AM_CONDITIONAL(WITH_PART_O_WITH_FS, test "x$with_part" != "xno" -o "x$with_fs" != "xno") +@@ -267,8 +280,15 @@ AS_IF([test "x$with_nvdimm" != "xno"], + [AC_DEFINE([LIBNDCTL_NEW_MODES])], [])] + []) + ++AS_IF([test "x$with_nvme" != "xno"], ++ [LIBBLOCKDEV_PKG_CHECK_MODULES([NVME], [libnvme >= 1.0]) ++ AS_IF([$PKG_CONFIG --atleast-version=1.1 libnvme], ++ [AC_DEFINE([HAVE_LIBNVME_1_1])], []) ++ ], ++ []) ++ + AS_IF([test "x$with_vdo" != "xno"], +- [LIBBLOCKDEV_PKG_CHECK_MODULES([YAML], [yaml-0.1])] ++ [LIBBLOCKDEV_PKG_CHECK_MODULES([YAML], [yaml-0.1])], + []) + + AC_SUBST([skip_patterns], [$skip_patterns]) +@@ -332,6 +352,7 @@ echo " + MDRAID plugin: ${with_mdraid} + MPath plugin ${with_mpath} + NVDIMM plugin: ${with_nvdimm} ++ NVMe plugin: ${with_nvme} + Part plugin: ${with_part} + S390 plugin: ${s390_info} + Swap plugin: ${with_swap} +diff --git a/data/conf.d/00-default.cfg b/data/conf.d/00-default.cfg +index 2a559204..696fc30b 100644 +--- a/data/conf.d/00-default.cfg ++++ b/data/conf.d/00-default.cfg +@@ -42,6 +42,9 @@ sonames=libbd_mpath.so.2 + [nvdimm] + sonames=libbd_nvdimm.so.2 + ++[nvme] ++sonames=libbd_nvme.so.2 ++ + [swap] + sonames=libbd_swap.so.2 + +diff --git a/dist/libblockdev.spec.in b/dist/libblockdev.spec.in +index e03737c8..d854cf87 100644 +--- a/dist/libblockdev.spec.in ++++ b/dist/libblockdev.spec.in +@@ -20,6 +20,7 @@ + %define with_escrow @WITH_ESCROW@ + %define with_dmraid @WITH_DMRAID@ + %define with_tools @WITH_TOOLS@ ++%define with_nvme @WITH_NVME@ + + # python2 is not available on RHEL > 7 and not needed on Fedora > 29 + %if 0%{?rhel} > 7 || 0%{?fedora} > 29 || %{with_python2} == 0 +@@ -120,8 +121,11 @@ + %if %{with_gi} != 1 + %define gi_copts --disable-introspection + %endif ++%if %{with_nvme} != 1 ++%define nvme_copts --without-nvme ++%endif + +-%define configure_opts %{?python2_copts} %{?python3_copts} %{?bcache_copts} %{?lvm_dbus_copts} %{?btrfs_copts} %{?crypto_copts} %{?dm_copts} %{?loop_copts} %{?lvm_copts} %{?lvm_dbus_copts} %{?mdraid_copts} %{?mpath_copts} %{?swap_copts} %{?kbd_copts} %{?part_copts} %{?fs_copts} %{?nvdimm_copts} %{?vdo_copts} %{?tools_copts} %{?gi_copts} ++%define configure_opts %{?python2_copts} %{?python3_copts} %{?bcache_copts} %{?lvm_dbus_copts} %{?btrfs_copts} %{?crypto_copts} %{?dm_copts} %{?loop_copts} %{?lvm_copts} %{?lvm_dbus_copts} %{?mdraid_copts} %{?mpath_copts} %{?swap_copts} %{?kbd_copts} %{?part_copts} %{?fs_copts} %{?nvdimm_copts} %{?nvme_copts} %{?vdo_copts} %{?tools_copts} %{?gi_copts} + + Name: libblockdev + Version: 2.28 +@@ -495,6 +499,29 @@ with the libblockdev-nvdimm plugin/library. + %endif + + ++%if %{with_nvme} ++%package nvme ++BuildRequires: libnvme-devel ++BuildRequires: libuuid-devel ++Summary: The NVMe plugin for the libblockdev library ++Requires: %{name}-utils%{?_isa} >= 0.11 ++ ++%description nvme ++The libblockdev library plugin (and in the same time a standalone library) ++providing the functionality related to operations with NVMe devices. ++ ++%package nvme-devel ++Summary: Development files for the libblockdev-nvme plugin/library ++Requires: %{name}-nvme%{?_isa} = %{version}-%{release} ++Requires: %{name}-utils-devel%{?_isa} ++Requires: glib2-devel ++ ++%description nvme-devel ++This package contains header files and pkg-config files needed for development ++with the libblockdev-nvme plugin/library. ++%endif ++ ++ + %if %{with_part} + %package part + BuildRequires: parted-devel +@@ -654,6 +681,10 @@ Requires: %{name}-mpath%{?_isa} = %{version}-%{release} + Requires: %{name}-nvdimm%{?_isa} = %{version}-%{release} + %endif + ++%if %{with_nvme} ++Requires: %{name}-nvme%{?_isa} = %{version}-%{release} ++%endif ++ + %if %{with_part} + Requires: %{name}-part%{?_isa} = %{version}-%{release} + %endif +@@ -730,6 +761,10 @@ find %{buildroot} -type f -name "*.la" | xargs %{__rm} + %ldconfig_scriptlets nvdimm + %endif + ++%if %{with_nvme} ++%ldconfig_scriptlets nvme ++%endif ++ + %if %{with_part} + %ldconfig_scriptlets part + %endif +@@ -929,6 +964,17 @@ find %{buildroot} -type f -name "*.la" | xargs %{__rm} + %endif + + ++%if %{with_nvme} ++%files nvme ++%{_libdir}/libbd_nvme.so.* ++ ++%files nvme-devel ++%{_libdir}/libbd_nvme.so ++%dir %{_includedir}/blockdev ++%{_includedir}/blockdev/nvme.h ++%endif ++ ++ + %if %{with_part} + %files part + %{_libdir}/libbd_part.so.* +diff --git a/docs/libblockdev-docs.xml.in b/docs/libblockdev-docs.xml.in +index f5b07e55..066e1475 100644 +--- a/docs/libblockdev-docs.xml.in ++++ b/docs/libblockdev-docs.xml.in +@@ -30,6 +30,7 @@ + + + ++ + + + +diff --git a/docs/libblockdev-sections.txt b/docs/libblockdev-sections.txt +index 512820c2..540e2b96 100644 +--- a/docs/libblockdev-sections.txt ++++ b/docs/libblockdev-sections.txt +@@ -642,6 +642,76 @@ BDNVDIMMTechMode + bd_nvdimm_is_tech_avail + + ++
++nvme ++bd_nvme_check_deps ++bd_nvme_close ++bd_nvme_init ++bd_nvme_error_quark ++BD_NVME_ERROR ++BDNVMEError ++BDNVMETech ++BDNVMETechMode ++bd_nvme_is_tech_avail ++BDNVMEControllerFeature ++BDNVMEControllerType ++BDNVMEControllerInfo ++bd_nvme_get_controller_info ++bd_nvme_controller_info_free ++bd_nvme_controller_info_copy ++BDNVMELBAFormatRelativePerformance ++BDNVMELBAFormat ++bd_nvme_lba_format_free ++bd_nvme_lba_format_copy ++BDNVMENamespaceFeature ++BDNVMENamespaceInfo ++bd_nvme_get_namespace_info ++bd_nvme_namespace_info_free ++bd_nvme_namespace_info_copy ++BDNVMESmartCriticalWarning ++BDNVMESmartLog ++bd_nvme_get_smart_log ++bd_nvme_smart_log_free ++bd_nvme_smart_log_copy ++BDNVMETransportType ++BDNVMEErrorLogEntry ++bd_nvme_get_error_log_entries ++bd_nvme_error_log_entry_free ++bd_nvme_error_log_entry_copy ++BDNVMESelfTestLog ++BDNVMESelfTestLogEntry ++BDNVMESelfTestAction ++BDNVMESelfTestResult ++bd_nvme_get_self_test_log ++bd_nvme_self_test_log_free ++bd_nvme_self_test_log_copy ++bd_nvme_self_test_log_entry_free ++bd_nvme_self_test_log_entry_copy ++bd_nvme_device_self_test ++BDNVMEFormatSecureErase ++bd_nvme_format ++BDNVMESanitizeStatus ++BDNVMESanitizeLog ++bd_nvme_get_sanitize_log ++bd_nvme_sanitize_log_free ++bd_nvme_sanitize_log_copy ++BDNVMESanitizeAction ++bd_nvme_sanitize ++bd_nvme_get_host_nqn ++bd_nvme_get_host_id ++bd_nvme_generate_host_nqn ++bd_nvme_set_host_nqn ++bd_nvme_set_host_id ++bd_nvme_connect ++bd_nvme_disconnect ++bd_nvme_disconnect_by_path ++BDNVMEDiscoveryLogEntry ++BDNVMEAddressFamily ++BDNVMETCPSecurity ++bd_nvme_discover ++bd_nvme_find_ctrls_for_ns ++
++ +
+ vdo + bd_vdo_check_deps +diff --git a/features.rst b/features.rst +index 67fa8de8..a223c26c 100644 +--- a/features.rst ++++ b/features.rst +@@ -303,6 +303,18 @@ NVDIMM + * namespace_reconfigure + * list_namespaces + ++NVMe ++----- ++ ++:supported technologies: ++ NVMe controller and namespace information ++ ++:functions: ++ * get_controller_info ++ * get_namespace_info ++ * get_smart_log ++ * get_error_log_entries ++ + VDO + --- + +diff --git a/include/blockdev/Makefile.am b/include/blockdev/Makefile.am +index 3e290505..e6246748 100644 +--- a/include/blockdev/Makefile.am ++++ b/include/blockdev/Makefile.am +@@ -1,5 +1,6 @@ + all-local: + for header in ${srcdir}/../../src/plugins/*.h; do ln -sf $${header} ./; done ++ for header in ${srcdir}/../../src/plugins/nvme/nvme.h; do ln -sf $${header} ./; done + for header in ${srcdir}/../../src/utils/*.h; do ln -sf $${header} ./; done + for header in ${srcdir}/../../src/lib/*.h; do ln -sf $${header} ./; done + mkdir -p fs; +diff --git a/specs.rst b/specs.rst +index 904adc3c..9a0cf702 100644 +--- a/specs.rst ++++ b/specs.rst +@@ -23,6 +23,7 @@ modules as well as udisks2. It supports the following storage technologies: + * multipath + * DASD + * NVDIMM namespaces ++* NVMe + * VDO volumes + + Of course some additional technologies may be supported in the future. +diff --git a/src/lib/Makefile.am b/src/lib/Makefile.am +index 6dfb5765..19cb2f11 100644 +--- a/src/lib/Makefile.am ++++ b/src/lib/Makefile.am +@@ -32,6 +32,7 @@ GIHEADERS = ${builddir}/plugin_apis/kbd.h \ + ${builddir}/plugin_apis/part.h \ + ${builddir}/plugin_apis/fs.h \ + ${builddir}/plugin_apis/nvdimm.h \ ++ ${builddir}/plugin_apis/nvme.h \ + ${builddir}/plugin_apis/vdo.h + + GIHEADERS += $(wildcard ${srcdir}/../utils/*.[ch]) +diff --git a/src/lib/blockdev.c.in b/src/lib/blockdev.c.in +index e96cc77f..447c1e23 100644 +--- a/src/lib/blockdev.c.in ++++ b/src/lib/blockdev.c.in +@@ -27,6 +27,8 @@ + #include "plugin_apis/fs.c" + #include "plugin_apis/nvdimm.h" + #include "plugin_apis/nvdimm.c" ++#include "plugin_apis/nvme.h" ++#include "plugin_apis/nvme.c" + #include "plugin_apis/vdo.h" + #include "plugin_apis/vdo.c" + +@@ -64,7 +66,8 @@ static gchar * default_plugin_so[BD_PLUGIN_UNDEF] = { + "libbd_dm.so."@MAJOR_VER@, "libbd_mdraid.so."@MAJOR_VER@, + "libbd_kbd.so."@MAJOR_VER@,"libbd_s390.so."@MAJOR_VER@, + "libbd_part.so."@MAJOR_VER@, "libbd_fs.so."@MAJOR_VER@, +- "libbd_nvdimm.so."@MAJOR_VER@, "libbd_vdo.so."@MAJOR_VER@ ++ "libbd_nvdimm.so."@MAJOR_VER@, "libbd_nvme.so."@MAJOR_VER@, ++ "libbd_vdo.so."@MAJOR_VER@ + }; + static BDPluginStatus plugins[BD_PLUGIN_UNDEF] = { + {{BD_PLUGIN_LVM, NULL}, NULL}, +@@ -80,10 +83,10 @@ static BDPluginStatus plugins[BD_PLUGIN_UNDEF] = { + {{BD_PLUGIN_PART, NULL}, NULL}, + {{BD_PLUGIN_FS, NULL}, NULL}, + {{BD_PLUGIN_NVDIMM, NULL}, NULL}, +- {{BD_PLUGIN_VDO, NULL}, NULL}, ++ {{BD_PLUGIN_NVME, NULL}, NULL}, + }; + static gchar* plugin_names[BD_PLUGIN_UNDEF] = { +- "lvm", "btrfs", "swap", "loop", "crypto", "mpath", "dm", "mdraid", "kbd", "s390", "part", "fs", "nvdimm", "vdo" ++ "lvm", "btrfs", "swap", "loop", "crypto", "mpath", "dm", "mdraid", "kbd", "s390", "part", "fs", "nvdimm", "nvme", "vdo" + }; + + static void set_plugin_so_name (BDPlugin name, const gchar *so_name) { +@@ -238,6 +241,10 @@ static void unload_plugins (void) { + g_warning ("Failed to close the nvdimm plugin"); + plugins[BD_PLUGIN_NVDIMM].handle = NULL; + ++ if (plugins[BD_PLUGIN_NVME].handle && !unload_nvme (plugins[BD_PLUGIN_NVME].handle)) ++ g_warning ("Failed to close the nvme plugin"); ++ plugins[BD_PLUGIN_NVME].handle = NULL; ++ + if (plugins[BD_PLUGIN_VDO].handle && !unload_vdo (plugins[BD_PLUGIN_VDO].handle)) + g_warning ("Failed to close the VDO plugin"); + plugins[BD_PLUGIN_VDO].handle = NULL; +@@ -281,6 +288,8 @@ static void do_load (GSList **plugins_sonames) { + load_plugin_from_sonames (BD_PLUGIN_FS, load_fs_from_plugin, &(plugins[BD_PLUGIN_FS].handle), plugins_sonames[BD_PLUGIN_FS]); + if (!plugins[BD_PLUGIN_NVDIMM].handle && plugins_sonames[BD_PLUGIN_NVDIMM]) + load_plugin_from_sonames (BD_PLUGIN_NVDIMM, load_nvdimm_from_plugin, &(plugins[BD_PLUGIN_NVDIMM].handle), plugins_sonames[BD_PLUGIN_NVDIMM]); ++ if (!plugins[BD_PLUGIN_NVME].handle && plugins_sonames[BD_PLUGIN_NVME]) ++ load_plugin_from_sonames (BD_PLUGIN_NVME, load_nvme_from_plugin, &(plugins[BD_PLUGIN_NVME].handle), plugins_sonames[BD_PLUGIN_NVME]); + if (!plugins[BD_PLUGIN_VDO].handle && plugins_sonames[BD_PLUGIN_VDO]) + load_plugin_from_sonames (BD_PLUGIN_VDO, load_vdo_from_plugin, &(plugins[BD_PLUGIN_VDO].handle), plugins_sonames[BD_PLUGIN_VDO]); + } +@@ -291,7 +300,8 @@ static gboolean load_plugins (BDPluginSpec **require_plugins, gboolean reload, g + GError *error = NULL; + GSequence *config_files = NULL; + GSList *plugins_sonames[BD_PLUGIN_UNDEF] = {NULL, NULL, NULL, NULL, NULL, +- NULL, NULL, NULL, NULL, NULL}; ++ NULL, NULL, NULL, NULL, NULL, ++ NULL}; + BDPlugin plugin_name = BD_PLUGIN_UNDEF; + guint64 required_plugins_mask = 0; + +diff --git a/src/lib/plugin_apis/nvme.api b/src/lib/plugin_apis/nvme.api +new file mode 100644 +index 00000000..79247a01 +--- /dev/null ++++ b/src/lib/plugin_apis/nvme.api +@@ -0,0 +1,1549 @@ ++#include ++#include ++#include ++#include ++ ++#ifndef BD_NVME_API ++#define BD_NVME_API ++ ++GQuark bd_nvme_error_quark (void) { ++ return g_quark_from_static_string ("g-bd-nvme-error-quark"); ++} ++ ++#define BD_NVME_ERROR bd_nvme_error_quark () ++/* BpG-skip */ ++/** ++ * BDNVMEError: ++ * @BD_NVME_ERROR_TECH_UNAVAIL: NVMe support not available. ++ * @BD_NVME_ERROR_FAILED: General error. ++ * @BD_NVME_ERROR_BUSY: The device is temporarily unavailable or in an inconsistent state. ++ * @BD_NVME_ERROR_INVALID_ARGUMENT: Invalid argument. ++ * @BD_NVME_ERROR_WOULD_FORMAT_ALL_NS: The NVMe controller indicates that it would format all namespaces in the NVM subsystem. ++ * @BD_NVME_ERROR_SC_GENERIC: Generic NVMe Command Status Code. ++ * @BD_NVME_ERROR_SC_CMD_SPECIFIC: NVMe Command Specific error. ++ * @BD_NVME_ERROR_SC_MEDIA: Media and Data Integrity Errors: media specific errors that occur in the NVM or data integrity type errors. ++ * @BD_NVME_ERROR_SC_PATH: Path related error. ++ * @BD_NVME_ERROR_SC_VENDOR_SPECIFIC: NVMe Vendor specific error. ++ * @BD_NVME_ERROR_NO_MATCH: No matching resource found (e.g. a Fabrics Controller). ++ * @BD_NVME_ERROR_CONNECT: General connection error. ++ * @BD_NVME_ERROR_CONNECT_ALREADY: Already connected. ++ * @BD_NVME_ERROR_CONNECT_INVALID: Invalid argument specified. ++ * @BD_NVME_ERROR_CONNECT_ADDRINUSE: HostNQN already in use. ++ * @BD_NVME_ERROR_CONNECT_NODEV: Invalid interface. ++ * @BD_NVME_ERROR_CONNECT_OPNOTSUPP: Operation not supported. ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_ERROR_TECH_UNAVAIL, ++ BD_NVME_ERROR_FAILED, ++ BD_NVME_ERROR_BUSY, ++ BD_NVME_ERROR_INVALID_ARGUMENT, ++ BD_NVME_ERROR_WOULD_FORMAT_ALL_NS, ++ BD_NVME_ERROR_SC_GENERIC, ++ BD_NVME_ERROR_SC_CMD_SPECIFIC, ++ BD_NVME_ERROR_SC_MEDIA, ++ BD_NVME_ERROR_SC_PATH, ++ BD_NVME_ERROR_SC_VENDOR_SPECIFIC, ++ BD_NVME_ERROR_NO_MATCH, ++ BD_NVME_ERROR_CONNECT, ++ BD_NVME_ERROR_CONNECT_ALREADY, ++ BD_NVME_ERROR_CONNECT_INVALID, ++ BD_NVME_ERROR_CONNECT_ADDRINUSE, ++ BD_NVME_ERROR_CONNECT_NODEV, ++ BD_NVME_ERROR_CONNECT_OPNOTSUPP, ++} BDNVMEError; ++ ++typedef enum { ++ BD_NVME_TECH_NVME = 0, ++ BD_NVME_TECH_FABRICS, ++} BDNVMETech; ++ ++typedef enum { ++ BD_NVME_TECH_MODE_INFO = 1 << 0, ++ BD_NVME_TECH_MODE_MANAGE = 1 << 1, ++ BD_NVME_TECH_MODE_INITIATOR = 1 << 2, ++} BDNVMETechMode; ++ ++ ++/* BpG-skip */ ++/** ++ * BDNVMEControllerFeature: ++ * @BD_NVME_CTRL_FEAT_MULTIPORT: if set, then the NVM subsystem may contain more than one NVM subsystem port, otherwise it's single-port only. ++ * @BD_NVME_CTRL_FEAT_MULTICTRL: if set, then the NVM subsystem may contain two or more controllers, otherwise contains only single controller. ++ * @BD_NVME_CTRL_FEAT_SRIOV: if set, then the controller is associated with an SR-IOV Virtual Function, otherwise it's associated with a PCI Function or a Fabrics connection. ++ * @BD_NVME_CTRL_FEAT_ANA_REPORTING: indicates that the NVM subsystem supports Asymmetric Namespace Access (ANA) Reporting. ++ * @BD_NVME_CTRL_FEAT_FORMAT: indicates that the controller supports the Format NVM command. ++ * @BD_NVME_CTRL_FEAT_FORMAT_ALL_NS: if set, then a format (excluding secure erase) of any namespace results in a format of all namespaces ++ * in an NVM subsystem with all namespaces in an NVM subsystem configured with the same attributes. ++ * If not set, then the controller supports format on a per namespace basis. ++ * @BD_NVME_CTRL_FEAT_NS_MGMT: indicates that the controller supports the Namespace Management and Attachment capability. ++ * @BD_NVME_CTRL_FEAT_SELFTEST: indicates that the controller supports the Device Self-test command. ++ * @BD_NVME_CTRL_FEAT_SELFTEST_SINGLE: indicates that the NVM subsystem supports only one device self-test operation in progress at a time. ++ * @BD_NVME_CTRL_FEAT_SANITIZE_CRYPTO: indicates that the controller supports the Crypto Erase sanitize operation. ++ * @BD_NVME_CTRL_FEAT_SANITIZE_BLOCK: indicates that the controller supports the Block Erase sanitize operation. ++ * @BD_NVME_CTRL_FEAT_SANITIZE_OVERWRITE: indicates that the controller supports the Overwrite sanitize operation. ++ * @BD_NVME_CTRL_FEAT_SECURE_ERASE_ALL_NS: if set, then any secure erase performed as part of a format operation ++ * results in a secure erase of all namespaces in the NVM subsystem. If not set, ++ * then any secure erase performed as part of a format results in a secure erase ++ * of the particular namespace specified. ++ * @BD_NVME_CTRL_FEAT_SECURE_ERASE_CRYPTO: indicates that the cryptographic erase is supported. ++ * @BD_NVME_CTRL_FEAT_STORAGE_DEVICE: indicates that the NVM subsystem is part of an NVMe Storage Device. ++ * @BD_NVME_CTRL_FEAT_ENCLOSURE: indicates that the NVM subsystem is part of an NVMe Enclosure. ++ * @BD_NVME_CTRL_FEAT_MGMT_PCIE: indicates that the NVM subsystem contains a Management Endpoint on a PCIe port. ++ * @BD_NVME_CTRL_FEAT_MGMT_SMBUS: indicates that the NVM subsystem contains a Management Endpoint on an SMBus/I2C port. ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_CTRL_FEAT_MULTIPORT = 1 << 0, ++ BD_NVME_CTRL_FEAT_MULTICTRL = 1 << 1, ++ BD_NVME_CTRL_FEAT_SRIOV = 1 << 2, ++ BD_NVME_CTRL_FEAT_ANA_REPORTING = 1 << 3, ++ BD_NVME_CTRL_FEAT_FORMAT = 1 << 4, ++ BD_NVME_CTRL_FEAT_FORMAT_ALL_NS = 1 << 5, ++ BD_NVME_CTRL_FEAT_NS_MGMT = 1 << 6, ++ BD_NVME_CTRL_FEAT_SELFTEST = 1 << 7, ++ BD_NVME_CTRL_FEAT_SELFTEST_SINGLE = 1 << 8, ++ BD_NVME_CTRL_FEAT_SANITIZE_CRYPTO = 1 << 9, ++ BD_NVME_CTRL_FEAT_SANITIZE_BLOCK = 1 << 10, ++ BD_NVME_CTRL_FEAT_SANITIZE_OVERWRITE = 1 << 11, ++ BD_NVME_CTRL_FEAT_SECURE_ERASE_ALL_NS = 1 << 12, ++ BD_NVME_CTRL_FEAT_SECURE_ERASE_CRYPTO = 1 << 13, ++ BD_NVME_CTRL_FEAT_STORAGE_DEVICE = 1 << 14, ++ BD_NVME_CTRL_FEAT_ENCLOSURE = 1 << 15, ++ BD_NVME_CTRL_FEAT_MGMT_PCIE = 1 << 16, ++ BD_NVME_CTRL_FEAT_MGMT_SMBUS = 1 << 17, ++} BDNVMEControllerFeature; ++ ++/* BpG-skip */ ++/** ++ * BDNVMEControllerType: ++ * @BD_NVME_CTRL_TYPE_UNKNOWN: Controller type not reported (as reported by older NVMe-compliant devices). ++ * @BD_NVME_CTRL_TYPE_IO: I/O controller. ++ * @BD_NVME_CTRL_TYPE_DISCOVERY: Discovery controller. ++ * @BD_NVME_CTRL_TYPE_ADMIN: Administrative controller. ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_CTRL_TYPE_UNKNOWN = 0, ++ BD_NVME_CTRL_TYPE_IO, ++ BD_NVME_CTRL_TYPE_DISCOVERY, ++ BD_NVME_CTRL_TYPE_ADMIN, ++} BDNVMEControllerType; ++ ++#define BD_NVME_TYPE_CONTROLLER_INFO (bd_nvme_controller_info_get_type ()) ++GType bd_nvme_controller_info_get_type (); ++ ++/** ++ * BDNVMEControllerInfo: ++ * @pci_vendor_id: The PCI Vendor ID. ++ * @pci_subsys_vendor_id: The PCI Subsystem Vendor ID. ++ * @ctrl_id: Controller ID, the NVM subsystem unique controller identifier associated with the controller. ++ * @fguid: FRU GUID, a 128-bit value that is globally unique for a given Field Replaceable Unit. ++ * @model_number: The model number. ++ * @serial_number: The serial number. ++ * @firmware_ver: The currently active firmware revision. ++ * @nvme_ver: The NVM Express base specification that the controller implementation supports. ++ * @features: features and capabilities present for this controller, see #BDNVMEControllerFeature. ++ * @controller_type: The controller type. ++ * @selftest_ext_time: Extended Device Self-test Time, if #BD_NVME_CTRL_FEAT_SELFTEST is supported then this field ++ * indicates the nominal amount of time in one minute units that the controller takes ++ * to complete an extended device self-test operation when in power state 0. ++ * @hmb_pref_size: Host Memory Buffer Preferred Size indicates the preferred size that the host ++ * is requested to allocate for the Host Memory Buffer feature in bytes. ++ * @hmb_min_size: Host Memory Buffer Minimum Size indicates the minimum size that the host ++ * is requested to allocate for the Host Memory Buffer feature in bytes. ++ * @size_total: Total NVM Capacity in the NVM subsystem in bytes. ++ * @size_unalloc: Unallocated NVM Capacity in the NVM subsystem in bytes. ++ * @num_namespaces: Maximum Number of Allowed Namespaces supported by the NVM subsystem. ++ * @subsysnqn: NVM Subsystem NVMe Qualified Name, UTF-8 null terminated string. ++ */ ++typedef struct BDNVMEControllerInfo { ++ guint16 pci_vendor_id; ++ guint16 pci_subsys_vendor_id; ++ guint16 ctrl_id; ++ gchar *fguid; ++ gchar *model_number; ++ gchar *serial_number; ++ gchar *firmware_ver; ++ gchar *nvme_ver; ++ guint64 features; ++ BDNVMEControllerType controller_type; ++ gint selftest_ext_time; ++ guint64 hmb_pref_size; ++ guint64 hmb_min_size; ++ guint64 size_total; ++ guint64 size_unalloc; ++ guint num_namespaces; ++ gchar *subsysnqn; ++} BDNVMEControllerInfo; ++ ++/** ++ * bd_nvme_controller_info_free: (skip) ++ * @info: (nullable): %BDNVMEControllerInfo to free ++ * ++ * Frees @info. ++ */ ++void bd_nvme_controller_info_free (BDNVMEControllerInfo *info) { ++ if (info == NULL) ++ return; ++ ++ g_free (info->fguid); ++ g_free (info->subsysnqn); ++ g_free (info->model_number); ++ g_free (info->serial_number); ++ g_free (info->firmware_ver); ++ g_free (info->nvme_ver); ++ g_free (info); ++} ++ ++/** ++ * bd_nvme_controller_info_copy: (skip) ++ * @info: (nullable): %BDNVMEControllerInfo to copy ++ * ++ * Creates a new copy of @info. ++ */ ++BDNVMEControllerInfo * bd_nvme_controller_info_copy (BDNVMEControllerInfo *info) { ++ BDNVMEControllerInfo *new_info; ++ ++ if (info == NULL) ++ return NULL; ++ ++ new_info = g_new0 (BDNVMEControllerInfo, 1); ++ memcpy (new_info, info, sizeof (BDNVMEControllerInfo)); ++ new_info->fguid = g_strdup (info->fguid); ++ new_info->subsysnqn = g_strdup (info->subsysnqn); ++ new_info->model_number = g_strdup (info->model_number); ++ new_info->serial_number = g_strdup (info->serial_number); ++ new_info->firmware_ver = g_strdup (info->firmware_ver); ++ new_info->nvme_ver = g_strdup (info->nvme_ver); ++ ++ return new_info; ++} ++ ++GType bd_nvme_controller_info_get_type () { ++ static GType type = 0; ++ ++ if (G_UNLIKELY (type == 0)) { ++ type = g_boxed_type_register_static ("BDNVMEControllerInfo", ++ (GBoxedCopyFunc) bd_nvme_controller_info_copy, ++ (GBoxedFreeFunc) bd_nvme_controller_info_free); ++ } ++ return type; ++} ++ ++ ++/* BpG-skip */ ++/** ++ * BDNVMELBAFormatRelativePerformance: ++ * Performance index of the LBA format relative to other LBA formats supported by the controller. ++ * @BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_UNKNOWN: Unknown relative performance index. ++ * @BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_BEST: Best performance. ++ * @BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_BETTER: Better performance. ++ * @BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_GOOD: Good performance. ++ * @BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_DEGRADED: Degraded performance. ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_UNKNOWN = 0, ++ BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_BEST = 1, ++ BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_BETTER = 2, ++ BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_GOOD = 3, ++ BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_DEGRADED = 4 ++} BDNVMELBAFormatRelativePerformance; ++ ++#define BD_NVME_TYPE_LBA_FORMAT (bd_nvme_lba_format_get_type ()) ++GType bd_nvme_lba_format_get_type (); ++ ++/** ++ * BDNVMELBAFormat: ++ * Namespace LBA Format Data Structure. ++ * @data_size: LBA data size (i.e. a sector size) in bytes. ++ * @metadata_size: metadata size in bytes or `0` in case of no metadata support. ++ * @relative_performance: Relative Performance index, see #BDNVMELBAFormatRelativePerformance. ++ */ ++typedef struct BDNVMELBAFormat { ++ guint16 data_size; ++ guint16 metadata_size; ++ BDNVMELBAFormatRelativePerformance relative_performance; ++} BDNVMELBAFormat; ++ ++/** ++ * bd_nvme_lba_format_free: (skip) ++ * @fmt: (nullable): %BDNVMELBAFormat to free ++ * ++ * Frees @fmt. ++ */ ++void bd_nvme_lba_format_free (BDNVMELBAFormat *fmt) { ++ g_free (fmt); ++} ++ ++/** ++ * bd_nvme_lba_format_copy: (skip) ++ * @fmt: (nullable): %BDNVMELBAFormat to copy ++ * ++ * Creates a new copy of @fmt. ++ */ ++BDNVMELBAFormat * bd_nvme_lba_format_copy (BDNVMELBAFormat *fmt) { ++ BDNVMELBAFormat *new_fmt; ++ ++ if (fmt == NULL) ++ return NULL; ++ ++ new_fmt = g_new0 (BDNVMELBAFormat, 1); ++ new_fmt->data_size = fmt->data_size; ++ new_fmt->metadata_size = fmt->metadata_size; ++ new_fmt->relative_performance = fmt->relative_performance; ++ ++ return new_fmt; ++} ++ ++GType bd_nvme_lba_format_get_type () { ++ static GType type = 0; ++ ++ if (G_UNLIKELY (type == 0)) { ++ type = g_boxed_type_register_static ("BDNVMELBAFormat", ++ (GBoxedCopyFunc) bd_nvme_lba_format_copy, ++ (GBoxedFreeFunc) bd_nvme_lba_format_free); ++ } ++ return type; ++} ++ ++/* BpG-skip */ ++/** ++ * BDNVMENamespaceFeature: ++ * @BD_NVME_NS_FEAT_THIN: indicates that the namespace supports thin provisioning. Specifically, the Namespace Capacity ++ * reported may be less than the Namespace Size. ++ * @BD_NVME_NS_FEAT_MULTIPATH_SHARED: indicates the capability to attach the namespace to two or more controllers ++ * in the NVM subsystem concurrently. ++ * @BD_NVME_NS_FEAT_FORMAT_PROGRESS: indicates the capability to report the percentage of the namespace ++ * that remains to be formatted. ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_NS_FEAT_THIN = 1 << 0, ++ BD_NVME_NS_FEAT_MULTIPATH_SHARED = 1 << 1, ++ BD_NVME_NS_FEAT_FORMAT_PROGRESS = 1 << 2, ++} BDNVMENamespaceFeature; ++ ++#define BD_NVME_TYPE_NAMESPACE_INFO (bd_nvme_namespace_info_get_type ()) ++GType bd_nvme_namespace_info_get_type (); ++ ++/** ++ * BDNVMENamespaceInfo: ++ * @nsid: The Namespace Identifier (NSID). ++ * @eui64: IEEE Extended Unique Identifier: a 64-bit IEEE Extended Unique Identifier (EUI-64) ++ * that is globally unique and assigned to the namespace when the namespace is created. ++ * Remains fixed throughout the life of the namespace and is preserved across namespace ++ * and controller operations. ++ * @nguid: Namespace Globally Unique Identifier: a 128-bit value that is globally unique and ++ * assigned to the namespace when the namespace is created. Remains fixed throughout ++ * the life of the namespace and is preserved across namespace and controller operations. ++ * @uuid: Namespace 128-bit Universally Unique Identifier (UUID) as specified in RFC 4122. ++ * @nsize: Namespace Size: total size of the namespace in logical blocks. The number of logical blocks ++ * is based on the formatted LBA size (see @current_lba_format). ++ * @ncap: Namespace Capacity: maximum number of logical blocks that may be allocated in the namespace ++ * at any point in time. The number of logical blocks is based on the formatted LBA size (see @current_lba_format). ++ * @nuse: Namespace Utilization: current number of logical blocks allocated in the namespace. ++ * This field is smaller than or equal to the Namespace Capacity. The number of logical ++ * blocks is based on the formatted LBA size (see @current_lba_format). ++ * @features: features and capabilities present for this namespace, see #BDNVMENamespaceFeature. ++ * @format_progress_remaining: The percentage value remaining of a format operation in progress. ++ * @write_protected: %TRUE if the namespace is currently write protected and all write access to the namespace shall fail. ++ * @lba_formats: (array zero-terminated=1) (element-type BDNVMELBAFormat): A list of supported LBA Formats. ++ * @current_lba_format: A LBA Format currently used for the namespace. Contains zeroes in case of ++ * an invalid or no supported LBA Format reported. ++ */ ++typedef struct BDNVMENamespaceInfo { ++ guint32 nsid; ++ gchar *eui64; ++ gchar *uuid; ++ gchar *nguid; ++ guint64 nsize; ++ guint64 ncap; ++ guint64 nuse; ++ guint64 features; ++ guint8 format_progress_remaining; ++ gboolean write_protected; ++ BDNVMELBAFormat **lba_formats; ++ BDNVMELBAFormat current_lba_format; ++} BDNVMENamespaceInfo; ++ ++/** ++ * bd_nvme_namespace_info_free: (skip) ++ * @info: (nullable): %BDNVMENamespaceInfo to free ++ * ++ * Frees @info. ++ */ ++void bd_nvme_namespace_info_free (BDNVMENamespaceInfo *info) { ++ BDNVMELBAFormat **lba_formats; ++ ++ if (info == NULL) ++ return; ++ ++ g_free (info->eui64); ++ g_free (info->uuid); ++ g_free (info->nguid); ++ ++ for (lba_formats = info->lba_formats; lba_formats && *lba_formats; lba_formats++) ++ bd_nvme_lba_format_free (*lba_formats); ++ g_free (info->lba_formats); ++ g_free (info); ++} ++ ++/** ++ * bd_nvme_namespace_info_copy: (skip) ++ * @info: (nullable): %BDNVMENamespaceInfo to copy ++ * ++ * Creates a new copy of @info. ++ */ ++BDNVMENamespaceInfo * bd_nvme_namespace_info_copy (BDNVMENamespaceInfo *info) { ++ BDNVMENamespaceInfo *new_info; ++ BDNVMELBAFormat **lba_formats; ++ GPtrArray *ptr_array; ++ ++ if (info == NULL) ++ return NULL; ++ ++ new_info = g_new0 (BDNVMENamespaceInfo, 1); ++ memcpy (new_info, info, sizeof (BDNVMENamespaceInfo)); ++ new_info->eui64 = g_strdup (info->eui64); ++ new_info->uuid = g_strdup (info->uuid); ++ new_info->nguid = g_strdup (info->nguid); ++ ++ ptr_array = g_ptr_array_new (); ++ for (lba_formats = info->lba_formats; lba_formats && *lba_formats; lba_formats++) ++ g_ptr_array_add (ptr_array, bd_nvme_lba_format_copy (*lba_formats)); ++ g_ptr_array_add (ptr_array, NULL); ++ new_info->lba_formats = (BDNVMELBAFormat **) g_ptr_array_free (ptr_array, FALSE); ++ ++ return new_info; ++} ++ ++GType bd_nvme_namespace_info_get_type () { ++ static GType type = 0; ++ ++ if (G_UNLIKELY (type == 0)) { ++ type = g_boxed_type_register_static ("BDNVMENamespaceInfo", ++ (GBoxedCopyFunc) bd_nvme_namespace_info_copy, ++ (GBoxedFreeFunc) bd_nvme_namespace_info_free); ++ } ++ return type; ++} ++ ++ ++/* BpG-skip */ ++/** ++ * BDNVMESmartCriticalWarning: ++ * @BD_NVME_SMART_CRITICAL_WARNING_SPARE: the available spare capacity has fallen below the threshold. ++ * @BD_NVME_SMART_CRITICAL_WARNING_TEMPERATURE: a temperature is either greater than or equal to an over temperature threshold; ++ * or less than or equal to an under temperature threshold. ++ * @BD_NVME_SMART_CRITICAL_WARNING_DEGRADED: the NVM subsystem reliability has been degraded due to significant media ++ * related errors or any internal error that degrades NVM subsystem reliability. ++ * @BD_NVME_SMART_CRITICAL_WARNING_READONLY: all of the media has been placed in read only mode. Unrelated to the write ++ * protection state of a namespace. ++ * @BD_NVME_SMART_CRITICAL_WARNING_VOLATILE_MEM: the volatile memory backup device has failed. Valid only if the controller ++ * has a volatile memory backup solution. ++ * @BD_NVME_SMART_CRITICAL_WARNING_PMR_READONLY: Persistent Memory Region has become read-only or unreliable. ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_SMART_CRITICAL_WARNING_SPARE = 1 << 0, ++ BD_NVME_SMART_CRITICAL_WARNING_TEMPERATURE = 1 << 1, ++ BD_NVME_SMART_CRITICAL_WARNING_DEGRADED = 1 << 2, ++ BD_NVME_SMART_CRITICAL_WARNING_READONLY = 1 << 3, ++ BD_NVME_SMART_CRITICAL_WARNING_VOLATILE_MEM = 1 << 4, ++ BD_NVME_SMART_CRITICAL_WARNING_PMR_READONLY = 1 << 5, ++} BDNVMESmartCriticalWarning; ++ ++#define BD_NVME_TYPE_SMART_LOG (bd_nvme_smart_log_get_type ()) ++GType bd_nvme_smart_log_get_type (); ++ ++/** ++ * BDNVMESmartLog: ++ * @critical_warning: critical warnings for the state of the controller, see #BDNVMESmartCriticalWarning. ++ * @avail_spare: Available Spare: a normalized percentage (0% to 100%) of the remaining spare capacity available. ++ * @spare_thresh: Available Spare Threshold: a normalized percentage (0% to 100%) of the available spare threshold. ++ * @percent_used: Percentage Used: a vendor specific estimate of the percentage drive life used based on the ++ * actual usage and the manufacturer's prediction. A value of 100 indicates that the estimated ++ * endurance has been consumed, but may not indicate an NVM subsystem failure. ++ * The value is allowed to exceed 100. ++ * @total_data_read: An estimated calculation of total data read in bytes based on calculation of data ++ * units read from the host. A value of 0 indicates that the number of Data Units Read ++ * is not reported. ++ * @total_data_written: An estimated calculation of total data written in bytes based on calculation ++ * of data units written by the host. A value of 0 indicates that the number ++ * of Data Units Written is not reported. ++ * @ctrl_busy_time: Amount of time the controller is busy with I/O commands, reported in minutes. ++ * @power_cycles: The number of power cycles. ++ * @power_on_hours: The number of power-on hours, excluding a non-operational power state. ++ * @unsafe_shutdowns: The number of unsafe shutdowns as a result of a Shutdown Notification not received prior to loss of power. ++ * @media_errors: Media and Data Integrity Errors: the number of occurrences where the controller detected ++ * an unrecovered data integrity error (e.g. uncorrectable ECC, CRC checksum failure, or LBA tag mismatch). ++ * @num_err_log_entries: Number of Error Information Log Entries: the number of Error Information log ++ * entries over the life of the controller. ++ * @temperature: Composite Temperature: temperature in Kelvins that represents the current composite ++ * temperature of the controller and associated namespaces or 0 when not applicable. ++ * @temp_sensors: Temperature Sensor 1-8: array of the current temperature reported by temperature sensors ++ * 1-8 in Kelvins or 0 when the particular sensor is not available. ++ * @wctemp: Warning Composite Temperature Threshold (WCTEMP): indicates the minimum Composite Temperature (@temperature) ++ * value that indicates an overheating condition during which controller operation continues. ++ * A value of 0 indicates that no warning temperature threshold value is reported by the controller. ++ * @cctemp: Critical Composite Temperature Threshold (CCTEMP): indicates the minimum Composite Temperature (@temperature) ++ * value that indicates a critical overheating condition (e.g., may prevent continued normal operation, ++ * possibility of data loss, automatic device shutdown, extreme performance throttling, or permanent damage). ++ * A value of 0 indicates that no critical temperature threshold value is reported by the controller. ++ * @warning_temp_time: Warning Composite Temperature Time: the amount of time in minutes that the Composite Temperature (@temperature) ++ * is greater than or equal to the Warning Composite Temperature Threshold (@wctemp) and less than the ++ * Critical Composite Temperature Threshold (@cctemp). ++ * @critical_temp_time: Critical Composite Temperature Time: the amount of time in minutes that the Composite Temperature (@temperature) ++ * is greater than or equal to the Critical Composite Temperature Threshold (@cctemp). ++ */ ++typedef struct BDNVMESmartLog { ++ guint critical_warning; ++ guint8 avail_spare; ++ guint8 spare_thresh; ++ guint8 percent_used; ++ guint64 total_data_read; ++ guint64 total_data_written; ++ guint64 ctrl_busy_time; ++ guint64 power_cycles; ++ guint64 power_on_hours; ++ guint64 unsafe_shutdowns; ++ guint64 media_errors; ++ guint64 num_err_log_entries; ++ guint16 temperature; ++ guint16 temp_sensors[8]; ++ guint16 wctemp; ++ guint16 cctemp; ++ guint warning_temp_time; ++ guint critical_temp_time; ++} BDNVMESmartLog; ++ ++/** ++ * bd_nvme_smart_log_free: (skip) ++ * @log: (nullable): %BDNVMESmartLog to free ++ * ++ * Frees @log. ++ */ ++void bd_nvme_smart_log_free (BDNVMESmartLog *log) { ++ g_free (log); ++} ++ ++/** ++ * bd_nvme_smart_log_copy: (skip) ++ * @log: (nullable): %BDNVMESmartLog to copy ++ * ++ * Creates a new copy of @log. ++ */ ++BDNVMESmartLog * bd_nvme_smart_log_copy (BDNVMESmartLog *log) { ++ BDNVMESmartLog *new_log; ++ ++ if (log == NULL) ++ return NULL; ++ ++ new_log = g_new0 (BDNVMESmartLog, 1); ++ memcpy (new_log, log, sizeof (BDNVMESmartLog)); ++ ++ return new_log; ++} ++ ++GType bd_nvme_smart_log_get_type () { ++ static GType type = 0; ++ ++ if (G_UNLIKELY (type == 0)) { ++ type = g_boxed_type_register_static ("BDNVMESmartLog", ++ (GBoxedCopyFunc) bd_nvme_smart_log_copy, ++ (GBoxedFreeFunc) bd_nvme_smart_log_free); ++ } ++ return type; ++} ++ ++ ++/* BpG-skip */ ++/** ++ * BDNVMETransportType: ++ * Transport Type. ++ * @BD_NVME_TRANSPORT_TYPE_UNSPECIFIED: Not indicated ++ * @BD_NVME_TRANSPORT_TYPE_RDMA: RDMA Transport ++ * @BD_NVME_TRANSPORT_TYPE_FC: Fibre Channel Transport ++ * @BD_NVME_TRANSPORT_TYPE_TCP: TCP Transport ++ * @BD_NVME_TRANSPORT_TYPE_LOOP: Intra-host Transport (loopback) ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_TRANSPORT_TYPE_UNSPECIFIED = 0, ++ BD_NVME_TRANSPORT_TYPE_RDMA = 1, ++ BD_NVME_TRANSPORT_TYPE_FC = 2, ++ BD_NVME_TRANSPORT_TYPE_TCP = 3, ++ BD_NVME_TRANSPORT_TYPE_LOOP = 254 ++} BDNVMETransportType; ++ ++/* BpG-skip */ ++/** ++ * BDNVMEAddressFamily: ++ * Address Family. ++ * @BD_NVME_ADDRESS_FAMILY_PCI: PCI Express. ++ * @BD_NVME_ADDRESS_FAMILY_INET: AF_INET: IPv4 address family. ++ * @BD_NVME_ADDRESS_FAMILY_INET6: AF_INET6: IPv6 address family. ++ * @BD_NVME_ADDRESS_FAMILY_IB: AF_IB: InfiniBand address family. ++ * @BD_NVME_ADDRESS_FAMILY_FC: Fibre Channel address family. ++ * @BD_NVME_ADDRESS_FAMILY_LOOP: Intra-host Transport (loopback). ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_ADDRESS_FAMILY_PCI = 0, ++ BD_NVME_ADDRESS_FAMILY_INET = 1, ++ BD_NVME_ADDRESS_FAMILY_INET6 = 2, ++ BD_NVME_ADDRESS_FAMILY_IB = 3, ++ BD_NVME_ADDRESS_FAMILY_FC = 4, ++ BD_NVME_ADDRESS_FAMILY_LOOP = 254 ++} BDNVMEAddressFamily; ++ ++#define BD_NVME_TYPE_ERROR_LOG_ENTRY (bd_nvme_error_log_entry_get_type ()) ++GType bd_nvme_error_log_entry_get_type (); ++ ++/** ++ * BDNVMEErrorLogEntry: ++ * @error_count: internal error counter, a unique identifier for the error. ++ * @command_id: the Command Identifier of the command that the error is associated with or `0xffff` if the error is not specific to a particular command. ++ * @command_specific: Command Specific Information specific to @command_id. ++ * @command_status: the Status code for the command that completed. ++ * @command_error: translated command error in the BD_NVME_ERROR domain or %NULL in case @command_status indicates success. ++ * @lba: the first LBA that experienced the error condition. ++ * @nsid: the NSID of the namespace that the error is associated with. ++ * @transport_type: type of the transport associated with the error. ++ */ ++typedef struct BDNVMEErrorLogEntry { ++ guint64 error_count; ++ guint16 command_id; ++ guint64 command_specific; ++ guint16 command_status; ++ GError *command_error; ++ guint64 lba; ++ guint32 nsid; ++ BDNVMETransportType transport_type; ++} BDNVMEErrorLogEntry; ++ ++/** ++ * bd_nvme_error_log_entry_free: (skip) ++ * @entry: (nullable): %BDNVMEErrorLogEntry to free ++ * ++ * Frees @entry. ++ */ ++void bd_nvme_error_log_entry_free (BDNVMEErrorLogEntry *entry) { ++ if (entry == NULL) ++ return; ++ ++ if (entry->command_error) ++ g_error_free (entry->command_error); ++ g_free (entry); ++} ++ ++/** ++ * bd_nvme_error_log_entry_copy: (skip) ++ * @entry: (nullable): %BDNVMEErrorLogEntry to copy ++ * ++ * Creates a new copy of @entry. ++ */ ++BDNVMEErrorLogEntry * bd_nvme_error_log_entry_copy (BDNVMEErrorLogEntry *entry) { ++ BDNVMEErrorLogEntry *new_entry; ++ ++ if (entry == NULL) ++ return NULL; ++ ++ new_entry = g_new0 (BDNVMEErrorLogEntry, 1); ++ memcpy (new_entry, entry, sizeof (BDNVMEErrorLogEntry)); ++ if (entry->command_error) ++ new_entry->command_error = g_error_copy (entry->command_error); ++ ++ return new_entry; ++} ++ ++GType bd_nvme_error_log_entry_get_type () { ++ static GType type = 0; ++ ++ if (G_UNLIKELY (type == 0)) { ++ type = g_boxed_type_register_static ("BDNVMEErrorLogEntry", ++ (GBoxedCopyFunc) bd_nvme_error_log_entry_copy, ++ (GBoxedFreeFunc) bd_nvme_error_log_entry_free); ++ } ++ return type; ++} ++ ++ ++/* BpG-skip */ ++/** ++ * BDNVMESelfTestAction: ++ * Action taken by the Device Self-test command. ++ * @BD_NVME_SELF_TEST_ACTION_NOT_RUNNING: No device self-test operation in progress. Not a valid argument for bd_nvme_device_self_test(). ++ * @BD_NVME_SELF_TEST_ACTION_SHORT: Start a short device self-test operation. ++ * @BD_NVME_SELF_TEST_ACTION_EXTENDED: Start an extended device self-test operation. ++ * @BD_NVME_SELF_TEST_ACTION_VENDOR_SPECIFIC: Start a vendor specific device self-test operation. ++ * @BD_NVME_SELF_TEST_ACTION_ABORT: Abort the device self-test operation. Only valid for bd_nvme_device_self_test(). ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_SELF_TEST_ACTION_NOT_RUNNING = 0, ++ BD_NVME_SELF_TEST_ACTION_SHORT = 1, ++ BD_NVME_SELF_TEST_ACTION_EXTENDED = 2, ++ BD_NVME_SELF_TEST_ACTION_VENDOR_SPECIFIC = 3, ++ BD_NVME_SELF_TEST_ACTION_ABORT = 4, ++} BDNVMESelfTestAction; ++ ++/* BpG-skip */ ++/** ++ * BDNVMESelfTestResult: ++ * Self-test log entry result value. ++ * @BD_NVME_SELF_TEST_RESULT_NO_ERROR: Operation completed without error. ++ * @BD_NVME_SELF_TEST_RESULT_ABORTED: Operation was aborted by a Device Self-test command. ++ * @BD_NVME_SELF_TEST_RESULT_CTRL_RESET: Operation was aborted by a Controller Level Reset. ++ * @BD_NVME_SELF_TEST_RESULT_NS_REMOVED: Operation was aborted due to a removal of a namespace from the namespace inventory. ++ * @BD_NVME_SELF_TEST_RESULT_ABORTED_FORMAT: Operation was aborted due to the processing of a Format NVM command. ++ * @BD_NVME_SELF_TEST_RESULT_FATAL_ERROR: A fatal error or unknown test error occurred while the controller was executing the device self-test operation and the operation did not complete. ++ * @BD_NVME_SELF_TEST_RESULT_UNKNOWN_SEG_FAIL: Operation completed with a segment that failed and the segment that failed is not known. ++ * @BD_NVME_SELF_TEST_RESULT_KNOWN_SEG_FAIL: Operation completed with one or more failed segments and the first segment that failed is indicated in the Segment Number field. ++ * @BD_NVME_SELF_TEST_RESULT_ABORTED_UNKNOWN: Operation was aborted for unknown reason. ++ * @BD_NVME_SELF_TEST_RESULT_ABORTED_SANITIZE: Operation was aborted due to a sanitize operation. ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_SELF_TEST_RESULT_NO_ERROR = 0, ++ BD_NVME_SELF_TEST_RESULT_ABORTED = 1, ++ BD_NVME_SELF_TEST_RESULT_CTRL_RESET = 2, ++ BD_NVME_SELF_TEST_RESULT_NS_REMOVED = 3, ++ BD_NVME_SELF_TEST_RESULT_ABORTED_FORMAT = 4, ++ BD_NVME_SELF_TEST_RESULT_FATAL_ERROR = 5, ++ BD_NVME_SELF_TEST_RESULT_UNKNOWN_SEG_FAIL = 6, ++ BD_NVME_SELF_TEST_RESULT_KNOWN_SEG_FAIL = 7, ++ BD_NVME_SELF_TEST_RESULT_ABORTED_UNKNOWN = 8, ++ BD_NVME_SELF_TEST_RESULT_ABORTED_SANITIZE = 9, ++} BDNVMESelfTestResult; ++ ++/** ++ * bd_nvme_self_test_result_to_string: ++ * @result: A %BDNVMESelfTestResult. ++ * @error: (out) (optional): place to store error (if any) ++ * ++ * Returns: (transfer none): A string representation of @result for use as an identifier string ++ * or %NULL when the code is unknown. ++ */ ++const gchar * bd_nvme_self_test_result_to_string (BDNVMESelfTestResult result, GError **error); ++ ++#define BD_NVME_TYPE_SELF_TEST_LOG_ENTRY (bd_nvme_self_test_log_entry_get_type ()) ++GType bd_nvme_self_test_log_entry_get_type (); ++ ++/** ++ * BDNVMESelfTestLogEntry: ++ * @result: Result of the device self-test operation. ++ * @action: The Self-test Code value (action) that was specified in the Device Self-test command that started this device self-test operation. ++ * @segment: Segment number where the first self-test failure occurred. Valid only when @result is set to #BD_NVME_SELF_TEST_RESULT_KNOWN_SEG_FAIL. ++ * @power_on_hours: Number of power-on hours at the time the device self-test operation was completed or aborted. Does not include time that the controller was powered and in a low power state condition. ++ * @nsid: Namespace ID that the Failing LBA occurred on. ++ * @failing_lba: LBA of the logical block that caused the test to fail. If the device encountered more than one failed logical block during the test, then this field only indicates one of those failed logical blocks. ++ * @status_code_error: Translated NVMe Command Status Code representing additional information related to errors or conditions. ++ */ ++typedef struct BDNVMESelfTestLogEntry { ++ BDNVMESelfTestResult result; ++ BDNVMESelfTestAction action; ++ guint8 segment; ++ guint64 power_on_hours; ++ guint32 nsid; ++ guint64 failing_lba; ++ GError *status_code_error; ++} BDNVMESelfTestLogEntry; ++ ++/** ++ * bd_nvme_self_test_log_entry_free: (skip) ++ * @entry: (nullable): %BDNVMESelfTestLogEntry to free ++ * ++ * Frees @entry. ++ */ ++void bd_nvme_self_test_log_entry_free (BDNVMESelfTestLogEntry *entry) { ++ if (entry == NULL) ++ return; ++ ++ if (entry->status_code_error) ++ g_error_free (entry->status_code_error); ++ g_free (entry); ++} ++ ++/** ++ * bd_nvme_self_test_log_entry_copy: (skip) ++ * @entry: (nullable): %BDNVMESelfTestLogEntry to copy ++ * ++ * Creates a new copy of @entry. ++ */ ++BDNVMESelfTestLogEntry * bd_nvme_self_test_log_entry_copy (BDNVMESelfTestLogEntry *entry) { ++ BDNVMESelfTestLogEntry *new_entry; ++ ++ if (entry == NULL) ++ return NULL; ++ ++ new_entry = g_new0 (BDNVMESelfTestLogEntry, 1); ++ memcpy (new_entry, entry, sizeof (BDNVMESelfTestLogEntry)); ++ if (entry->status_code_error) ++ new_entry->status_code_error = g_error_copy (entry->status_code_error); ++ ++ return new_entry; ++} ++ ++GType bd_nvme_self_test_log_entry_get_type () { ++ static GType type = 0; ++ ++ if (G_UNLIKELY (type == 0)) { ++ type = g_boxed_type_register_static ("BDNVMESelfTestLogEntry", ++ (GBoxedCopyFunc) bd_nvme_self_test_log_entry_copy, ++ (GBoxedFreeFunc) bd_nvme_self_test_log_entry_free); ++ } ++ return type; ++} ++ ++ ++#define BD_NVME_TYPE_SELF_TEST_LOG (bd_nvme_self_test_log_get_type ()) ++GType bd_nvme_self_test_log_get_type (); ++ ++/** ++ * BDNVMESelfTestLog: ++ * @current_operation: Current running device self-test operation. There's no corresponding record in @entries for a device self-test operation that is in progress. ++ * @current_operation_completion: Percentage of the currently running device self-test operation. Only valid when @current_operation is other than #BD_NVME_SELF_TEST_ACTION_NOT_RUNNING. ++ * @entries: (array zero-terminated=1) (element-type BDNVMESelfTestLogEntry): Self-test log entries for the last 20 operations, sorted from newest (first element) to oldest. ++ */ ++typedef struct BDNVMESelfTestLog { ++ BDNVMESelfTestAction current_operation; ++ guint8 current_operation_completion; ++ BDNVMESelfTestLogEntry **entries; ++} BDNVMESelfTestLog; ++ ++/** ++ * bd_nvme_self_test_log_free: (skip) ++ * @log: (nullable): %BDNVMESelfTestLog to free ++ * ++ * Frees @log. ++ */ ++void bd_nvme_self_test_log_free (BDNVMESelfTestLog *log) { ++ BDNVMESelfTestLogEntry **entries; ++ ++ if (log == NULL) ++ return; ++ ++ for (entries = log->entries; entries && *entries; entries++) ++ bd_nvme_self_test_log_entry_free (*entries); ++ g_free (log->entries); ++ g_free (log); ++} ++ ++/** ++ * bd_nvme_self_test_log_copy: (skip) ++ * @log: (nullable): %BDNVMESelfTestLog to copy ++ * ++ * Creates a new copy of @log. ++ */ ++BDNVMESelfTestLog * bd_nvme_self_test_log_copy (BDNVMESelfTestLog *log) { ++ BDNVMESelfTestLog *new_log; ++ BDNVMESelfTestLogEntry **entries; ++ GPtrArray *ptr_array; ++ ++ if (log == NULL) ++ return NULL; ++ ++ new_log = g_new0 (BDNVMESelfTestLog, 1); ++ memcpy (new_log, log, sizeof (BDNVMESelfTestLog)); ++ ++ ptr_array = g_ptr_array_new (); ++ for (entries = log->entries; entries && *entries; entries++) ++ g_ptr_array_add (ptr_array, bd_nvme_self_test_log_entry_copy (*entries)); ++ g_ptr_array_add (ptr_array, NULL); ++ new_log->entries = (BDNVMESelfTestLogEntry **) g_ptr_array_free (ptr_array, FALSE); ++ ++ return new_log; ++} ++ ++GType bd_nvme_self_test_log_get_type () { ++ static GType type = 0; ++ ++ if (G_UNLIKELY (type == 0)) { ++ type = g_boxed_type_register_static ("BDNVMESelfTestLog", ++ (GBoxedCopyFunc) bd_nvme_self_test_log_copy, ++ (GBoxedFreeFunc) bd_nvme_self_test_log_free); ++ } ++ return type; ++} ++ ++ ++/* BpG-skip */ ++/** ++ * BDNVMEFormatSecureErase: ++ * Optional Format NVM secure erase action. ++ * @BD_NVME_FORMAT_SECURE_ERASE_NONE: No secure erase operation requested. ++ * @BD_NVME_FORMAT_SECURE_ERASE_USER_DATA: User Data Erase: All user data shall be erased, contents of the user data after the erase is indeterminate ++ * (e.g., the user data may be zero filled, one filled, etc.). If a User Data Erase is requested and all affected ++ * user data is encrypted, then the controller is allowed to use a cryptographic erase to perform the requested User Data Erase. ++ * @BD_NVME_FORMAT_SECURE_ERASE_CRYPTO: Cryptographic Erase: All user data shall be erased cryptographically. This is accomplished by deleting the encryption key. ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_FORMAT_SECURE_ERASE_NONE = 0, ++ BD_NVME_FORMAT_SECURE_ERASE_USER_DATA = 1, ++ BD_NVME_FORMAT_SECURE_ERASE_CRYPTO = 2, ++} BDNVMEFormatSecureErase; ++ ++ ++/* BpG-skip */ ++/** ++ * BDNVMESanitizeStatus: ++ * @BD_NVME_SANITIZE_STATUS_NEVER_SANITIZED: The NVM subsystem has never been sanitized. ++ * @BD_NVME_SANITIZE_STATUS_IN_PROGESS: A sanitize operation is currently in progress. ++ * @BD_NVME_SANITIZE_STATUS_SUCCESS: The most recent sanitize operation completed successfully including any additional media modification. ++ * @BD_NVME_SANITIZE_STATUS_SUCCESS_NO_DEALLOC: The most recent sanitize operation for which No-Deallocate After Sanitize was requested has completed successfully with deallocation of all user data. ++ * @BD_NVME_SANITIZE_STATUS_FAILED: The most recent sanitize operation failed. ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_SANITIZE_STATUS_NEVER_SANITIZED = 0, ++ BD_NVME_SANITIZE_STATUS_IN_PROGESS = 1, ++ BD_NVME_SANITIZE_STATUS_SUCCESS = 2, ++ BD_NVME_SANITIZE_STATUS_SUCCESS_NO_DEALLOC = 3, ++ BD_NVME_SANITIZE_STATUS_FAILED = 4, ++} BDNVMESanitizeStatus; ++ ++ ++#define BD_NVME_TYPE_SANITIZE_LOG (bd_nvme_sanitize_log_get_type ()) ++GType bd_nvme_sanitize_log_get_type (); ++ ++/** ++ * BDNVMESanitizeLog: ++ * @sanitize_progress: The percentage complete of the sanitize operation. ++ * @sanitize_status: The status of the most recent sanitize operation. ++ * @global_data_erased: Indicates that no user data has been written either since the drive was manufactured and ++ * has never been sanitized or since the most recent successful sanitize operation. ++ * @overwrite_passes: Number of completed passes if the most recent sanitize operation was an Overwrite. ++ * @time_for_overwrite: Estimated time in seconds needed to complete an Overwrite sanitize operation with 16 passes in the background. ++ * A value of -1 means that no time estimate is reported. A value of 0 means that the operation is expected ++ * to be completed in the background when the Sanitize command is completed. ++ * @time_for_block_erase: Estimated time in seconds needed to complete a Block Erase sanitize operation in the background. ++ * A value of -1 means that no time estimate is reported. A value of 0 means that the operation is expected ++ * to be completed in the background when the Sanitize command is completed. ++ * @time_for_crypto_erase: Estimated time in seconds needed to complete a Crypto Erase sanitize operation in the background. ++ * A value of -1 means that no time estimate is reported. A value of 0 means that the operation is expected ++ * to be completed in the background when the Sanitize command is completed. ++ * @time_for_overwrite_nd: Estimated time in seconds needed to complete an Overwrite sanitize operation and the associated ++ * additional media modification in the background when the No-Deallocate After Sanitize or ++ * the No-Deallocate Modifies Media After Sanitize features have been requested. ++ * @time_for_block_erase_nd: Estimated time in seconds needed to complete a Block Erase sanitize operation and the associated ++ * additional media modification in the background when the No-Deallocate After Sanitize or ++ * the No-Deallocate Modifies Media After Sanitize features have been requested. ++ * @time_for_crypto_erase_nd: Estimated time in seconds needed to complete a Crypto Erase sanitize operation and the associated ++ * additional media modification in the background when the No-Deallocate After Sanitize or ++ * the No-Deallocate Modifies Media After Sanitize features have been requested. ++ */ ++typedef struct BDNVMESanitizeLog { ++ gdouble sanitize_progress; ++ BDNVMESanitizeStatus sanitize_status; ++ gboolean global_data_erased; ++ guint8 overwrite_passes; ++ gint64 time_for_overwrite; ++ gint64 time_for_block_erase; ++ gint64 time_for_crypto_erase; ++ gint64 time_for_overwrite_nd; ++ gint64 time_for_block_erase_nd; ++ gint64 time_for_crypto_erase_nd; ++} BDNVMESanitizeLog; ++ ++/** ++ * bd_nvme_sanitize_log_free: (skip) ++ * @log: (nullable): %BDNVMESanitizeLog to free ++ * ++ * Frees @log. ++ */ ++void bd_nvme_sanitize_log_free (BDNVMESanitizeLog *log) { ++ if (log == NULL) ++ return; ++ ++ g_free (log); ++} ++ ++/** ++ * bd_nvme_sanitize_log_copy: (skip) ++ * @log: (nullable): %BDNVMESanitizeLog to copy ++ * ++ * Creates a new copy of @log. ++ */ ++BDNVMESanitizeLog * bd_nvme_sanitize_log_copy (BDNVMESanitizeLog *log) { ++ BDNVMESanitizeLog *new_log; ++ ++ if (log == NULL) ++ return NULL; ++ ++ new_log = g_new0 (BDNVMESanitizeLog, 1); ++ memcpy (new_log, log, sizeof (BDNVMESanitizeLog)); ++ ++ return new_log; ++} ++ ++GType bd_nvme_sanitize_log_get_type () { ++ static GType type = 0; ++ ++ if (G_UNLIKELY (type == 0)) { ++ type = g_boxed_type_register_static ("BDNVMESanitizeLog", ++ (GBoxedCopyFunc) bd_nvme_sanitize_log_copy, ++ (GBoxedFreeFunc) bd_nvme_sanitize_log_free); ++ } ++ return type; ++} ++ ++ ++/* BpG-skip */ ++/** ++ * BDNVMESanitizeAction: ++ * @BD_NVME_SANITIZE_ACTION_EXIT_FAILURE: Exit Failure Mode. ++ * @BD_NVME_SANITIZE_ACTION_BLOCK_ERASE: Start a Block Erase sanitize operation - a low-level block erase method that is specific to the media. ++ * @BD_NVME_SANITIZE_ACTION_OVERWRITE: Start an Overwrite sanitize operation - writing a fixed data pattern or related patterns in multiple passes. ++ * @BD_NVME_SANITIZE_ACTION_CRYPTO_ERASE: Start a Crypto Erase sanitize operation - changing the media encryption keys for all locations on the media. ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_SANITIZE_ACTION_EXIT_FAILURE = 0, ++ BD_NVME_SANITIZE_ACTION_BLOCK_ERASE = 1, ++ BD_NVME_SANITIZE_ACTION_OVERWRITE = 2, ++ BD_NVME_SANITIZE_ACTION_CRYPTO_ERASE = 3, ++} BDNVMESanitizeAction; ++ ++ ++/* BpG-skip */ ++/** ++ * BDNVMETCPSecurity: ++ * @BD_NVME_TCP_SECURITY_NONE: No Security, the host shall set up a normal TCP connection. ++ * @BD_NVME_TCP_SECURITY_TLS12: Transport Layer Security (TLS) version 1.2 (NVMe-oF 1.1). ++ * @BD_NVME_TCP_SECURITY_TLS13: Transport Layer Security (TLS) version 1.3+. The TLS version and cipher is negotiated on every connection. ++ */ ++/* BpG-skip-end */ ++typedef enum { ++ BD_NVME_TCP_SECURITY_NONE = 0, ++ BD_NVME_TCP_SECURITY_TLS12 = 1, ++ BD_NVME_TCP_SECURITY_TLS13 = 2 ++} BDNVMETCPSecurity; ++ ++ ++#define BD_NVME_TYPE_DISCOVERY_LOG_ENTRY (bd_nvme_discovery_log_entry_get_type ()) ++GType bd_nvme_discovery_log_entry_get_type (); ++ ++/** ++ * BDNVMEDiscoveryLogEntry: ++ * @transport_type: The NVMe Transport type. ++ * @address_family: The address family. ++ * @sq_flow_control_disable: Indicates that the controller is capable of disabling SQ flow control. ++ * @sq_flow_control_required: Indicates that the controller requires use of SQ flow control. ++ * @port_id: A NVM subsystem port. Different NVMe Transports or address families may utilize the same Port ID value (eg. a Port ID may support both iWARP and RoCE). ++ * @ctrl_id: A Controller ID. Special value of `0xFFFF` indicates a dynamic controller model and a value of `0xFFFE` indicates a temporary ID in a static controller model that should be replaced by a real ID after a connection is established. ++ * @transport_addr: Transport Address. ++ * @transport_svcid: Transport Service Identifier. ++ * @subsys_nqn: Subsystem Qualified Name. For a Discovery Service the value should be the well-known Discovery Service NQN (`nqn.2014-08.org.nvmexpress.discovery`). ++ * @tcp_security: NVMe/TCP transport port security. ++ */ ++typedef struct BDNVMEDiscoveryLogEntry { ++ BDNVMETransportType transport_type; ++ BDNVMEAddressFamily address_family; ++ gboolean sq_flow_control_disable; ++ gboolean sq_flow_control_required; ++ guint16 port_id; ++ guint16 ctrl_id; ++ gchar *transport_addr; ++ gchar *transport_svcid; ++ gchar *subsys_nqn; ++ BDNVMETCPSecurity tcp_security; ++} BDNVMEDiscoveryLogEntry; ++ ++/** ++ * bd_nvme_discovery_log_entry_free: (skip) ++ * @entry: (nullable): %BDNVMEDiscoveryLogEntry to free ++ * ++ * Frees @entry. ++ */ ++void bd_nvme_discovery_log_entry_free (BDNVMEDiscoveryLogEntry *entry) { ++ if (entry == NULL) ++ return; ++ ++ g_free (entry->transport_addr); ++ g_free (entry->transport_svcid); ++ g_free (entry->subsys_nqn); ++ g_free (entry); ++} ++ ++/** ++ * bd_nvme_discovery_log_entry_copy: (skip) ++ * @entry: (nullable): %BDNVMEDiscoveryLogEntry to copy ++ * ++ * Creates a new copy of @entry. ++ */ ++BDNVMEDiscoveryLogEntry * bd_nvme_discovery_log_entry_copy (BDNVMEDiscoveryLogEntry *entry) { ++ BDNVMEDiscoveryLogEntry *new_entry; ++ ++ if (entry == NULL) ++ return NULL; ++ ++ new_entry = g_new0 (BDNVMEDiscoveryLogEntry, 1); ++ memcpy (new_entry, entry, sizeof (BDNVMEDiscoveryLogEntry)); ++ new_entry->transport_addr = g_strdup (entry->transport_addr); ++ new_entry->transport_svcid = g_strdup (entry->transport_svcid); ++ new_entry->subsys_nqn = g_strdup (entry->subsys_nqn); ++ ++ return new_entry; ++} ++ ++GType bd_nvme_discovery_log_entry_get_type () { ++ static GType type = 0; ++ ++ if (G_UNLIKELY (type == 0)) { ++ type = g_boxed_type_register_static ("BDNVMEDiscoveryLogEntry", ++ (GBoxedCopyFunc) bd_nvme_discovery_log_entry_copy, ++ (GBoxedFreeFunc) bd_nvme_discovery_log_entry_free); ++ } ++ return type; ++} ++ ++ ++/** ++ * bd_nvme_get_controller_info: ++ * @device: a NVMe controller device (e.g. `/dev/nvme0`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves information about the NVMe controller (the Identify Controller command) ++ * as specified by the @device block device path. ++ * ++ * Returns: (transfer full): information about given controller or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMEControllerInfo * bd_nvme_get_controller_info (const gchar *device, GError **error); ++ ++/** ++ * bd_nvme_get_namespace_info: ++ * @device: a NVMe namespace device (e.g. `/dev/nvme0n1`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves information about the NVMe namespace (the Identify Namespace command) ++ * as specified by the @device block device path. ++ * ++ * Returns: (transfer full): information about given namespace or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMENamespaceInfo * bd_nvme_get_namespace_info (const gchar *device, GError **error); ++ ++/** ++ * bd_nvme_get_smart_log: ++ * @device: a NVMe controller device (e.g. `/dev/nvme0`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves drive SMART and general health information (Log Identifier `02h`). ++ * The information provided is over the life of the controller and is retained across power cycles. ++ * ++ * Returns: (transfer full): health log data or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMESmartLog * bd_nvme_get_smart_log (const gchar *device, GError **error); ++ ++/** ++ * bd_nvme_get_error_log_entries: ++ * @device: a NVMe controller device (e.g. `/dev/nvme0`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves Error Information Log (Log Identifier `01h`) entries, used to describe ++ * extended error information for a command that completed with error or to report ++ * an error that is not specific to a particular command. This log is global to the ++ * controller. The ordering of the entries is based on the time when the error ++ * occurred, with the most recent error being returned as the first log entry. ++ * As the number of entries is typically limited by the drive implementation, only ++ * most recent entries are provided. ++ * ++ * Returns: (transfer full) (array zero-terminated=1): null-terminated list ++ * of error entries or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMEErrorLogEntry ** bd_nvme_get_error_log_entries (const gchar *device, GError **error); ++ ++/** ++ * bd_nvme_get_self_test_log: ++ * @device: a NVMe controller device (e.g. `/dev/nvme0`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves drive self-test log (Log Identifier `06h`). Provides the status of a self-test operation ++ * in progress and the percentage complete of that operation, along with the results of the last ++ * 20 device self-test operations. ++ * ++ * Returns: (transfer full): self-test log data or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMESelfTestLog * bd_nvme_get_self_test_log (const gchar *device, GError **error); ++ ++/** ++ * bd_nvme_get_sanitize_log: ++ * @device: a NVMe controller device (e.g. `/dev/nvme0`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves the drive sanitize status log (Log Identifier `81h`) that includes information ++ * about the most recent sanitize operation and the sanitize operation time estimates. ++ * ++ * As advised in the NVMe specification whitepaper the host should limit polling ++ * to retrieve progress of a running sanitize operations (e.g. to at most once every ++ * several minutes) to avoid interfering with the progress of the sanitize operation itself. ++ * ++ * Returns: (transfer full): sanitize log data or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMESanitizeLog * bd_nvme_get_sanitize_log (const gchar *device, GError **error); ++ ++/** ++ * bd_nvme_device_self_test: ++ * @device: a NVMe controller or namespace device (e.g. `/dev/nvme0`) ++ * @action: self-test action to take. ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Initiates or aborts the Device Self-test operation on the controller or a namespace, ++ * distinguished by the @device path specified. In case a controller device ++ * is specified then the self-test operation would include all active namespaces. ++ * ++ * To abort a running operation, pass #BD_NVME_SELF_TEST_ACTION_ABORT as @action. ++ * To retrieve progress of a current running operation, check the self-test log using ++ * bd_nvme_get_self_test_log(). ++ * ++ * Returns: %TRUE if the device self-test command was issued successfully, ++ * %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_MANAGE ++ */ ++gboolean bd_nvme_device_self_test (const gchar *device, BDNVMESelfTestAction action, GError **error); ++ ++/** ++ * bd_nvme_format: ++ * @device: NVMe namespace or controller device to format (e.g. `/dev/nvme0n1`) ++ * @lba_data_size: desired LBA data size (i.e. a sector size) in bytes or `0` to keep current. See #BDNVMELBAFormat and bd_nvme_get_namespace_info(). ++ * @metadata_size: desired metadata size in bytes or `0` for default. See #BDNVMELBAFormat and bd_nvme_get_namespace_info(). ++ * @secure_erase: optional secure erase action to take. ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Performs low level format of the NVM media, destroying all data and metadata for either ++ * a specific namespace or all attached namespaces to the controller. Use this command ++ * to change LBA sector size. Optional secure erase method can be specified as well. ++ * ++ * Supported LBA data sizes for a given namespace can be listed using the bd_nvme_get_namespace_info() ++ * call. In case of a special value `0` the current LBA format for a given namespace will be ++ * retained. When called on a controller device the first namespace is used as a reference. ++ * ++ * Note that the NVMe controller may define a Format NVM attribute indicating that the format ++ * operation would apply to all namespaces and a format (excluding secure erase) of any ++ * namespace results in a format of all namespaces in the NVM subsystem. In such case and ++ * when @device is a namespace block device the #BD_NVME_ERROR_WOULD_FORMAT_ALL_NS error ++ * is returned to prevent further damage. This is then supposed to be handled by the caller ++ * and bd_nvme_format() is supposed to be called on a controller device instead. ++ * ++ * This call blocks until the format operation has finished. To retrieve progress ++ * of a current running operation, check the namespace info using bd_nvme_get_namespace_info(). ++ * ++ * Returns: %TRUE if the format command finished successfully, %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_MANAGE ++ */ ++gboolean bd_nvme_format (const gchar *device, guint16 lba_data_size, guint16 metadata_size, BDNVMEFormatSecureErase secure_erase, GError **error); ++ ++/** ++ * bd_nvme_sanitize: ++ * @device: NVMe namespace or controller device to format (e.g. `/dev/nvme0n1`) ++ * @action: the sanitize action to perform. ++ * @no_dealloc: instruct the controller to not deallocate the affected media area. ++ * @overwrite_pass_count: number of overwrite passes [1-15] or 0 for the default (16 passes). ++ * @overwrite_pattern: a 32-bit pattern used for the Overwrite sanitize operation. ++ * @overwrite_invert_pattern: invert the overwrite pattern between passes. ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Starts a sanitize operation or recovers from a previously failed sanitize operation. ++ * By definition, a sanitize operation alters all user data in the NVM subsystem such ++ * that recovery of any previous user data from any cache, the non-volatile media, ++ * or any Controller Memory Buffer is not possible. The scope of a sanitize operation ++ * is all locations in the NVM subsystem that are able to contain user data, including ++ * caches, Persistent Memory Regions, and unallocated or deallocated areas of the media. ++ * ++ * Once started, a sanitize operation is not able to be aborted and continues after ++ * a Controller Level Reset including across power cycles. Once the sanitize operation ++ * has run the media affected may not be immediately ready for use unless additional ++ * media modification mechanism is run. This is often vendor specific and also depends ++ * on the sanitize method (@action) used. Callers to this sanitize operation should ++ * set @no_dealloc to %TRUE for the added convenience. ++ * ++ * The controller also ignores Critical Warning(s) in the SMART / Health Information ++ * log page (e.g., read only mode) and attempts to complete the sanitize operation requested. ++ * ++ * This call returns immediately and the actual sanitize operation is performed ++ * in the background. Use bd_nvme_get_sanitize_log() to retrieve status and progress ++ * of a running sanitize operation. In case a sanitize operation fails the controller ++ * may restrict its operation until a subsequent sanitize operation is started ++ * (i.e. retried) or an #BD_NVME_SANITIZE_ACTION_EXIT_FAILURE action is used ++ * to acknowledge the failure explicitly. ++ * ++ * The @overwrite_pass_count, @overwrite_pattern and @overwrite_invert_pattern ++ * arguments are only valid when @action is #BD_NVME_SANITIZE_ACTION_OVERWRITE. ++ * ++ * The sanitize operation is set to run under the Allow Unrestricted Sanitize Exit ++ * mode. ++ * ++ * Returns: %TRUE if the format command finished successfully, %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_MANAGE ++ */ ++gboolean bd_nvme_sanitize (const gchar *device, BDNVMESanitizeAction action, gboolean no_dealloc, gint overwrite_pass_count, guint32 overwrite_pattern, gboolean overwrite_invert_pattern, GError **error); ++ ++/** ++ * bd_nvme_get_host_nqn: ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Reads the Host NQN (NVM Qualified Name) value from the global `/etc/nvme/hostnqn` ++ * file. An empty string is an indication that no Host NQN has been set. ++ * ++ * Returns: (transfer full): the Host NQN string or an empty string if none set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gchar * bd_nvme_get_host_nqn (GError **error); ++ ++/** ++ * bd_nvme_generate_host_nqn: ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Compute new Host NQN (NVM Qualified Name) value for the current system. This ++ * takes in account various system identifiers (DMI, device tree) with the goal ++ * of a stable unique identifier whenever feasible. ++ * ++ * Returns: (transfer full): the Host NQN string or %NULL with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gchar * bd_nvme_generate_host_nqn (GError **error); ++ ++/** ++ * bd_nvme_get_host_id: ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Reads the Host ID value from the global `/etc/nvme/hostid` file. An empty ++ * string is an indication that no Host ID has been set. ++ * ++ * Returns: (transfer full): the Host ID string or an empty string if none set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gchar * bd_nvme_get_host_id (GError **error); ++ ++/** ++ * bd_nvme_set_host_nqn: ++ * @host_nqn: The Host NVM Qualified Name. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Writes the Host NQN (NVM Qualified Name) value to the system `/etc/nvme/hostnqn` file. ++ * No validation of the string is performed. ++ * ++ * Returns: %TRUE if the value was set successfully or %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gboolean bd_nvme_set_host_nqn (const gchar *host_nqn, GError **error); ++ ++/** ++ * bd_nvme_set_host_id: ++ * @host_id: The Host ID. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Writes the Host ID value to the system `/etc/nvme/hostid` file. ++ * No validation of the string is performed. ++ * ++ * Returns: %TRUE if the value was set successfully or %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gboolean bd_nvme_set_host_id (const gchar *host_id, GError **error); ++ ++/** ++ * bd_nvme_connect: ++ * @subsysnqn: The name for the NVMe subsystem to connect to. ++ * @transport: The network fabric used for a NVMe-over-Fabrics network. ++ * @transport_addr: (nullable): The network address of the Controller. For transports using IP addressing (e.g. `rdma`) this should be an IP-based address. ++ * @transport_svcid: (nullable): The transport service id. For transports using IP addressing (e.g. `rdma`) this field is the port number. By default, the IP port number for the `RDMA` transport is `4420`. ++ * @host_traddr: (nullable): The network address used on the host to connect to the Controller. For TCP, this sets the source address on the socket. ++ * @host_iface: (nullable): The network interface used on the host to connect to the Controller (e.g. IP `eth1`, `enp2s0`). This forces the connection to be made on a specific interface instead of letting the system decide. ++ * @host_nqn: (nullable): Overrides the default Host NQN that identifies the NVMe Host. If this option is %NULL, the default is read from `/etc/nvme/hostnqn` first. ++ * If that does not exist, the autogenerated NQN value from the NVMe Host kernel module is used next. The Host NQN uniquely identifies the NVMe Host. ++ * @host_id: (nullable): User-defined host UUID or %NULL to use default (as defined in `/etc/nvme/hostid`) ++ * @extra: (nullable) (array zero-terminated=1): Additional arguments. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Creates a transport connection to a remote system (specified by @transport_addr and @transport_svcid) ++ * and creates a NVMe over Fabrics controller for the NVMe subsystem specified by the @subsysnqn option. ++ * ++ * Valid values for @transport include: ++ * - `"rdma"`: An rdma network (RoCE, iWARP, Infiniband, basic rdma, etc.) ++ * - `"fc"`: A Fibre Channel network. ++ * - `"tcp"`: A TCP/IP network. ++ * - `"loop"`: A NVMe over Fabrics target on the local host. ++ * ++ * In addition to the primary options it's possible to supply @extra arguments: ++ * - `"config"`: Use the specified JSON configuration file instead of the default file (see below) or ++ * specify `"none"` to avoid reading any configuration file. ++ * - `"dhchap_key"`: NVMe In-band authentication secret in ASCII format as described ++ * in the NVMe 2.0 specification. When not specified, the secret is by default read ++ * from `/etc/nvme/hostkey`. In case that file does not exist no in-band authentication ++ * is attempted. ++ * - `"dhchap_ctrl_key"`: NVMe In-band authentication controller secret for bi-directional authentication. ++ * When not specified, no bi-directional authentication is attempted. ++ * - `"nr_io_queues"`: The number of I/O queues. ++ * - `"nr_write_queues"`: Number of additional queues that will be used for write I/O. ++ * - `"nr_poll_queues"`: Number of additional queues that will be used for polling latency sensitive I/O. ++ * - `"queue_size"`: Number of elements in the I/O queues. ++ * - `"keep_alive_tmo"`: The keep alive timeout (in seconds). ++ * - `"reconnect_delay"`: The delay (in seconds) before reconnect is attempted after a connect loss. ++ * - `"ctrl_loss_tmo"`: The controller loss timeout period (in seconds). A special value of `-1` will cause reconnecting forever. ++ * - `"fast_io_fail_tmo"`: Fast I/O Fail timeout (in seconds). ++ * - `"tos"`: Type of service. ++ * - `"duplicate_connect"`: Allow duplicated connections between same transport host and subsystem port. Boolean value. ++ * - `"disable_sqflow"`: Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions. Boolean value. ++ * - `"hdr_digest"`: Generates/verifies header digest (TCP). Boolean value. ++ * - `"data_digest"`: Generates/verifies data digest (TCP). Boolean value. ++ * - `"tls"`: Enable TLS encryption (TCP). Boolean value. ++ * - `"hostsymname"`: TP8010: NVMe host symbolic name. ++ * ++ * Boolean values can be expressed by "0"/"1", "on"/"off" or "True"/"False" case-insensitive ++ * strings. Failed numerical or boolean string conversions will result in the option being ignored. ++ * ++ * By default additional options are read from the default configuration file `/etc/nvme/config.json`. ++ * This follows the default behaviour of `nvme-cli`. Use the @extra `"config"` argument ++ * to either specify a different config file or disable use of it. The JSON configuration ++ * file format is documented in [https://raw.githubusercontent.com/linux-nvme/libnvme/master/doc/config-schema.json](https://raw.githubusercontent.com/linux-nvme/libnvme/master/doc/config-schema.json). ++ * As a rule @extra key names are kept consistent with the JSON config file schema. ++ * Any @extra option generally overrides particular option specified in a configuration file. ++ * ++ * Returns: %TRUE if the subsystem was connected successfully, %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gboolean bd_nvme_connect (const gchar *subsysnqn, const gchar *transport, const gchar *transport_addr, const gchar *transport_svcid, const gchar *host_traddr, const gchar *host_iface, const gchar *host_nqn, const gchar *host_id, const BDExtraArg **extra, GError **error); ++ ++/** ++ * bd_nvme_disconnect: ++ * @subsysnqn: The name of the NVMe subsystem to disconnect. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Disconnects and removes one or more existing NVMe over Fabrics controllers. ++ * This may disconnect multiple controllers with matching @subsysnqn and %TRUE ++ * is only returned when all controllers were disconnected successfully. ++ * ++ * Returns: %TRUE if all matching controllers were disconnected successfully, %FALSE with @error ++ * set in case of a disconnect error or when no matching controllers were found. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gboolean bd_nvme_disconnect (const gchar *subsysnqn, GError **error); ++ ++/** ++ * bd_nvme_disconnect_by_path: ++ * @path: NVMe controller device to disconnect (e.g. `/dev/nvme0`). ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Disconnects and removes a NVMe over Fabrics controller represented ++ * by a block device path. ++ * ++ * Returns: %TRUE if the controller was disconnected successfully, ++ * %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gboolean bd_nvme_disconnect_by_path (const gchar *path, GError **error); ++ ++/** ++ * bd_nvme_discover: ++ * @discovery_ctrl: (nullable): Use existing discovery controller device or %NULL to establish a new connection. ++ * @persistent: Persistent discovery connection. ++ * @transport: The network fabric used for a NVMe-over-Fabrics network. ++ * @transport_addr: (nullable): The network address of the Controller. For transports using IP addressing (e.g. `rdma`) this should be an IP-based address. ++ * @transport_svcid: (nullable): The transport service id. For transports using IP addressing (e.g. `rdma`) this field is the port number. By default, the IP port number for the `RDMA` transport is `4420`. ++ * @host_traddr: (nullable): The network address used on the host to connect to the Controller. For TCP, this sets the source address on the socket. ++ * @host_iface: (nullable): The network interface used on the host to connect to the Controller (e.g. IP `eth1`, `enp2s0`). This forces the connection to be made on a specific interface instead of letting the system decide. ++ * @host_nqn: (nullable): Overrides the default Host NQN that identifies the NVMe Host. If this option is %NULL, the default is read from `/etc/nvme/hostnqn` first. ++ * If that does not exist, the autogenerated NQN value from the NVMe Host kernel module is used next. The Host NQN uniquely identifies the NVMe Host. ++ * @host_id: (nullable): User-defined host UUID or %NULL to use default (as defined in `/etc/nvme/hostid`) ++ * @extra: (nullable) (array zero-terminated=1): Additional arguments. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Performs Discovery request on a Discovery Controller. If no connection to a Discovery Controller ++ * exists (i.e. @discovery_ctrl is %NULL) a new connection is established as specified by the @transport, ++ * @transport_addr and optionally @transport_svcid arguments. ++ * ++ * Note that the `nvme-cli`'s `/etc/nvme/discovery.conf` config file is not used at the moment. ++ * ++ * Valid values for @transport include: ++ * - `"rdma"`: An rdma network (RoCE, iWARP, Infiniband, basic rdma, etc.) ++ * - `"fc"`: A Fibre Channel network. ++ * - `"tcp"`: A TCP/IP network. ++ * - `"loop"`: A NVMe over Fabrics target on the local host. ++ * ++ * In addition to the primary options it's possible to supply @extra arguments: ++ * - `"config"`: Use the specified JSON configuration file instead of the default file (see below) or ++ * specify `"none"` to avoid reading any configuration file. ++ * - `"dhchap_key"`: NVMe In-band authentication secret in ASCII format as described ++ * in the NVMe 2.0 specification. When not specified, the secret is by default read ++ * from `/etc/nvme/hostkey`. In case that file does not exist no in-band authentication ++ * is attempted. ++ * - `"dhchap_ctrl_key"`: NVMe In-band authentication controller secret for bi-directional authentication. ++ * When not specified, no bi-directional authentication is attempted. ++ * - `"nr_io_queues"`: The number of I/O queues. ++ * - `"nr_write_queues"`: Number of additional queues that will be used for write I/O. ++ * - `"nr_poll_queues"`: Number of additional queues that will be used for polling latency sensitive I/O. ++ * - `"queue_size"`: Number of elements in the I/O queues. ++ * - `"keep_alive_tmo"`: The keep alive timeout (in seconds). ++ * - `"reconnect_delay"`: The delay (in seconds) before reconnect is attempted after a connect loss. ++ * - `"ctrl_loss_tmo"`: The controller loss timeout period (in seconds). A special value of `-1` will cause reconnecting forever. ++ * - `"fast_io_fail_tmo"`: Fast I/O Fail timeout (in seconds). ++ * - `"tos"`: Type of service. ++ * - `"duplicate_connect"`: Allow duplicated connections between same transport host and subsystem port. Boolean value. ++ * - `"disable_sqflow"`: Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions. Boolean value. ++ * - `"hdr_digest"`: Generates/verifies header digest (TCP). Boolean value. ++ * - `"data_digest"`: Generates/verifies data digest (TCP). Boolean value. ++ * - `"tls"`: Enable TLS encryption (TCP). Boolean value. ++ * - `"hostsymname"`: TP8010: NVMe host symbolic name. ++ * ++ * Boolean values can be expressed by "0"/"1", "on"/"off" or "True"/"False" case-insensitive ++ * strings. Failed numerical or boolean string conversions will result in the option being ignored. ++ * ++ * By default additional options are read from the default configuration file `/etc/nvme/config.json`. ++ * This follows the default behaviour of `nvme-cli`. Use the @extra `"config"` argument ++ * to either specify a different config file or disable use of it. The JSON configuration ++ * file format is documented in [https://raw.githubusercontent.com/linux-nvme/libnvme/master/doc/config-schema.json](https://raw.githubusercontent.com/linux-nvme/libnvme/master/doc/config-schema.json). ++ * As a rule @extra key names are kept consistent with the JSON config file schema. ++ * Any @extra option generally overrides particular option specified in a configuration file. ++ * ++ * Returns: (transfer full) (array zero-terminated=1): null-terminated list ++ * of discovery log entries or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++BDNVMEDiscoveryLogEntry ** bd_nvme_discover (const gchar *discovery_ctrl, gboolean persistent, const gchar *transport, const gchar *transport_addr, const gchar *transport_svcid, const gchar *host_traddr, const gchar *host_iface, const gchar *host_nqn, const gchar *host_id, const BDExtraArg **extra, GError **error); ++ ++/** ++ * bd_nvme_find_ctrls_for_ns: ++ * @ns_sysfs_path: NVMe namespace device file. ++ * @subsysnqn: (nullable): Limit matching to the specified subsystem NQN. ++ * @host_nqn: (nullable): Limit matching to the specified host NQN. ++ * @host_id: (nullable): Limit matching to the specified host ID. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * A convenient utility function to look up all controllers associated ++ * with a NVMe subsystem the specified namespace is part of. ++ * ++ * Returns: (transfer full) (array zero-terminated=1): list of controller sysfs paths ++ * or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gchar ** bd_nvme_find_ctrls_for_ns (const gchar *ns_sysfs_path, const gchar *subsysnqn, const gchar *host_nqn, const gchar *host_id, GError **error); ++ ++#endif /* BD_NVME_API */ +diff --git a/src/lib/plugins.h b/src/lib/plugins.h +index 8a23b6a2..d19bdc2c 100644 +--- a/src/lib/plugins.h ++++ b/src/lib/plugins.h +@@ -18,6 +18,7 @@ typedef enum { + BD_PLUGIN_PART, + BD_PLUGIN_FS, + BD_PLUGIN_NVDIMM, ++ BD_PLUGIN_NVME, + BD_PLUGIN_VDO, + BD_PLUGIN_UNDEF + } BDPlugin; +diff --git a/src/plugins/Makefile.am b/src/plugins/Makefile.am +index 8e8b3062..a2bfe2dc 100644 +--- a/src/plugins/Makefile.am ++++ b/src/plugins/Makefile.am +@@ -1,5 +1,11 @@ ++SUBDIRS = . ++ + if WITH_FS +-SUBDIRS = . fs ++SUBDIRS += fs ++endif ++ ++if WITH_NVME ++SUBDIRS += nvme + endif + + lib_LTLIBRARIES = +diff --git a/src/plugins/nvme/Makefile.am b/src/plugins/nvme/Makefile.am +new file mode 100644 +index 00000000..b4a10ce0 +--- /dev/null ++++ b/src/plugins/nvme/Makefile.am +@@ -0,0 +1,22 @@ ++AUTOMAKE_OPTIONS = subdir-objects ++ ++lib_LTLIBRARIES = libbd_nvme.la ++ ++libbd_nvme_la_CFLAGS = $(GLIB_CFLAGS) $(GIO_CFLAGS) $(UUID_CFLAGS) $(NVME_CFLAGS) -Wall -Wextra -Werror ++libbd_nvme_la_LIBADD = ${builddir}/../../utils/libbd_utils.la $(GLIB_LIBS) $(GIO_LIBS) $(UUID_LIBS) $(NVME_LIBS) ++libbd_nvme_la_LDFLAGS = -L${srcdir}/../../utils/ -version-info 2:0:0 -Wl,--no-undefined ++libbd_nvme_la_CPPFLAGS = -I${builddir}/../../../include/ -I${srcdir}/../ -I. -DPACKAGE_SYSCONF_DIR=\""$(sysconfdir)"\" ++ ++libbd_nvme_la_SOURCES = \ ++ nvme.h \ ++ nvme.c \ ++ nvme-private.h \ ++ nvme-info.c \ ++ nvme-error.c \ ++ nvme-op.c \ ++ nvme-fabrics.c \ ++ ../check_deps.c \ ++ ../check_deps.h ++ ++libbd_nvmeincludedir = $(includedir)/blockdev ++libbd_nvmeinclude_HEADERS = nvme.h +diff --git a/src/plugins/nvme/nvme-error.c b/src/plugins/nvme/nvme-error.c +new file mode 100644 +index 00000000..86f0d6a3 +--- /dev/null ++++ b/src/plugins/nvme/nvme-error.c +@@ -0,0 +1,160 @@ ++/* ++ * Copyright (C) 2014-2021 Red Hat, Inc. ++ * ++ * This library is free software; you can redistribute it and/or ++ * modify it under the terms of the GNU Lesser General Public ++ * License as published by the Free Software Foundation; either ++ * version 2.1 of the License, or (at your option) any later version. ++ * ++ * This library is distributed in the hope that it will be useful, ++ * but WITHOUT ANY WARRANTY; without even the implied warranty of ++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ++ * Lesser General Public License for more details. ++ * ++ * You should have received a copy of the GNU Lesser General Public ++ * License along with this library; if not, see . ++ * ++ * Author: Tomas Bzatek ++ */ ++ ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++ ++#include ++#include ++ ++#include ++#include ++#include "nvme.h" ++#include "nvme-private.h" ++ ++ ++/** ++ * bd_nvme_error_quark: (skip) ++ */ ++GQuark bd_nvme_error_quark (void) ++{ ++ return g_quark_from_static_string ("g-bd-nvme-error-quark"); ++} ++ ++void _nvme_status_to_error (gint status, gboolean fabrics, GError **error) ++{ ++ gint code; ++ ++ if (error == NULL) ++ return; ++ if (status == 0) { ++ g_clear_error (error); ++ return; ++ } ++ ++ if (status < 0) { ++ /* generic errno errors */ ++ switch (errno) { ++ case EWOULDBLOCK: ++ code = BD_NVME_ERROR_BUSY; ++ break; ++ default: ++ code = BD_NVME_ERROR_FAILED; ++ } ++ g_set_error_literal (error, BD_NVME_ERROR, code, ++ strerror_l (errno, _C_LOCALE)); ++ return; ++ } else { ++ /* NVMe status codes */ ++ switch (nvme_status_code_type (status)) { ++ case NVME_SCT_GENERIC: ++ code = BD_NVME_ERROR_SC_GENERIC; ++ break; ++ case NVME_SCT_CMD_SPECIFIC: ++ code = BD_NVME_ERROR_SC_CMD_SPECIFIC; ++ break; ++ case NVME_SCT_MEDIA: ++ code = BD_NVME_ERROR_SC_MEDIA; ++ break; ++ case NVME_SCT_PATH: ++ code = BD_NVME_ERROR_SC_PATH; ++ break; ++ case NVME_SCT_VS: ++ code = BD_NVME_ERROR_SC_VENDOR_SPECIFIC; ++ break; ++ default: ++ code = BD_NVME_ERROR_SC_GENERIC; ++ } ++ g_set_error_literal (error, BD_NVME_ERROR, code, nvme_status_to_string (status, fabrics)); ++ return; ++ } ++ g_warn_if_reached (); ++} ++ ++void _nvme_fabrics_errno_to_gerror (int result, int _errno, GError **error) ++{ ++ gint code; ++ ++ if (error == NULL) ++ return; ++ if (result == 0) { ++ g_clear_error (error); ++ return; ++ } ++ ++ if (_errno >= ENVME_CONNECT_RESOLVE) { ++ switch (_errno) { ++ case ENVME_CONNECT_ADDRFAM: ++ case ENVME_CONNECT_TRADDR: ++ case ENVME_CONNECT_TARG: ++ case ENVME_CONNECT_AARG: ++ case ENVME_CONNECT_INVAL_TR: ++ code = BD_NVME_ERROR_INVALID_ARGUMENT; ++ break; ++ case ENVME_CONNECT_RESOLVE: ++ case ENVME_CONNECT_OPEN: ++ case ENVME_CONNECT_WRITE: ++ case ENVME_CONNECT_READ: ++ case ENVME_CONNECT_PARSE: ++ case ENVME_CONNECT_LOOKUP_SUBSYS_NAME: ++ case ENVME_CONNECT_LOOKUP_SUBSYS: ++ code = BD_NVME_ERROR_CONNECT; ++ break; ++#ifdef HAVE_LIBNVME_1_1 ++ case ENVME_CONNECT_ALREADY: ++ code = BD_NVME_ERROR_CONNECT_ALREADY; ++ break; ++ case ENVME_CONNECT_INVAL: ++ code = BD_NVME_ERROR_CONNECT_INVALID; ++ break; ++ case ENVME_CONNECT_ADDRINUSE: ++ code = BD_NVME_ERROR_CONNECT_ADDRINUSE; ++ break; ++ case ENVME_CONNECT_NODEV: ++ code = BD_NVME_ERROR_CONNECT_NODEV; ++ break; ++ case ENVME_CONNECT_OPNOTSUPP: ++ code = BD_NVME_ERROR_CONNECT_OPNOTSUPP; ++ break; ++#endif ++ default: ++ code = BD_NVME_ERROR_CONNECT; ++ } ++ g_set_error_literal (error, BD_NVME_ERROR, code, nvme_errno_to_string (_errno)); ++ return; ++ } else { ++ switch (errno) { ++ case EWOULDBLOCK: ++ code = BD_NVME_ERROR_BUSY; ++ break; ++ default: ++ code = BD_NVME_ERROR_FAILED; ++ } ++ g_set_error_literal (error, BD_NVME_ERROR, code, strerror_l (errno, _C_LOCALE)); ++ return; ++ } ++ g_warn_if_reached (); ++} +diff --git a/src/plugins/nvme/nvme-fabrics.c b/src/plugins/nvme/nvme-fabrics.c +new file mode 100644 +index 00000000..20ed57f5 +--- /dev/null ++++ b/src/plugins/nvme/nvme-fabrics.c +@@ -0,0 +1,918 @@ ++/* ++ * Copyright (C) 2014-2021 Red Hat, Inc. ++ * ++ * This library is free software; you can redistribute it and/or ++ * modify it under the terms of the GNU Lesser General Public ++ * License as published by the Free Software Foundation; either ++ * version 2.1 of the License, or (at your option) any later version. ++ * ++ * This library is distributed in the hope that it will be useful, ++ * but WITHOUT ANY WARRANTY; without even the implied warranty of ++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ++ * Lesser General Public License for more details. ++ * ++ * You should have received a copy of the GNU Lesser General Public ++ * License along with this library; if not, see . ++ * ++ * Author: Tomas Bzatek ++ */ ++ ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++ ++#include ++#include ++ ++#include ++#include ++#include "nvme.h" ++#include "nvme-private.h" ++ ++ ++/* nvme-cli defaults */ ++#define PATH_NVMF_CONFIG "/etc/nvme/config.json" ++#define MAX_DISC_RETRIES 10 ++ ++ ++static void parse_extra_args (const BDExtraArg **extra, struct nvme_fabrics_config *cfg, const gchar **config_file, const gchar **hostkey, const gchar **ctrlkey, const gchar **hostsymname) { ++ const BDExtraArg **extra_i; ++ ++ if (!extra) ++ return; ++ ++#define SAFE_INT_CONV(target) { \ ++ gint64 v; \ ++ gchar *endptr = NULL; \ ++ \ ++ v = g_ascii_strtoll ((*extra_i)->val, &endptr, 0); \ ++ if (endptr != (*extra_i)->val) \ ++ target = v; \ ++ } ++#define SAFE_BOOL_CONV(target) { \ ++ if (g_ascii_strcasecmp ((*extra_i)->val, "on") == 0 || \ ++ g_ascii_strcasecmp ((*extra_i)->val, "1") == 0 || \ ++ g_ascii_strcasecmp ((*extra_i)->val, "true") == 0) \ ++ target = TRUE; \ ++ else \ ++ if (g_ascii_strcasecmp ((*extra_i)->val, "off") == 0 || \ ++ g_ascii_strcasecmp ((*extra_i)->val, "0") == 0 || \ ++ g_ascii_strcasecmp ((*extra_i)->val, "false") == 0) \ ++ target = FALSE; \ ++ } ++ ++ for (extra_i = extra; *extra_i; extra_i++) { ++ if (g_strcmp0 ((*extra_i)->opt, "config") == 0 && config_file) { ++ if (g_ascii_strcasecmp ((*extra_i)->val, "none") == 0) ++ *config_file = NULL; ++ else ++ *config_file = (*extra_i)->val; ++ } else ++ if (g_strcmp0 ((*extra_i)->opt, "dhchap_key") == 0 && hostkey) ++ *hostkey = (*extra_i)->val; ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "dhchap_ctrl_key") == 0 && ctrlkey) ++ *ctrlkey = (*extra_i)->val; ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "hostsymname") == 0 && hostsymname) ++ *hostsymname = (*extra_i)->val; ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "nr_io_queues") == 0) ++ SAFE_INT_CONV (cfg->nr_io_queues) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "nr_write_queues") == 0) ++ SAFE_INT_CONV (cfg->nr_write_queues) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "nr_poll_queues") == 0) ++ SAFE_INT_CONV (cfg->nr_poll_queues) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "queue_size") == 0) ++ SAFE_INT_CONV (cfg->queue_size) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "keep_alive_tmo") == 0) ++ SAFE_INT_CONV (cfg->keep_alive_tmo) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "reconnect_delay") == 0) ++ SAFE_INT_CONV (cfg->reconnect_delay) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "ctrl_loss_tmo") == 0) ++ SAFE_INT_CONV (cfg->ctrl_loss_tmo) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "fast_io_fail_tmo") == 0) ++ SAFE_INT_CONV (cfg->fast_io_fail_tmo) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "tos") == 0) ++ SAFE_INT_CONV (cfg->tos) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "duplicate_connect") == 0) ++ SAFE_BOOL_CONV (cfg->duplicate_connect) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "disable_sqflow") == 0) ++ SAFE_BOOL_CONV (cfg->disable_sqflow) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "hdr_digest") == 0) ++ SAFE_BOOL_CONV (cfg->hdr_digest) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "data_digest") == 0) ++ SAFE_BOOL_CONV (cfg->data_digest) ++ else ++ if (g_strcmp0 ((*extra_i)->opt, "tls") == 0) ++ SAFE_BOOL_CONV (cfg->tls) ++ } ++ ++#undef SAFE_INT_CONV ++#undef SAFE_BOOL_CONV ++} ++ ++ ++/** ++ * bd_nvme_connect: ++ * @subsysnqn: The name for the NVMe subsystem to connect to. ++ * @transport: The network fabric used for a NVMe-over-Fabrics network. ++ * @transport_addr: (nullable): The network address of the Controller. For transports using IP addressing (e.g. `rdma`) this should be an IP-based address. ++ * @transport_svcid: (nullable): The transport service id. For transports using IP addressing (e.g. `rdma`) this field is the port number. By default, the IP port number for the `RDMA` transport is `4420`. ++ * @host_traddr: (nullable): The network address used on the host to connect to the Controller. For TCP, this sets the source address on the socket. ++ * @host_iface: (nullable): The network interface used on the host to connect to the Controller (e.g. IP `eth1`, `enp2s0`). This forces the connection to be made on a specific interface instead of letting the system decide. ++ * @host_nqn: (nullable): Overrides the default Host NQN that identifies the NVMe Host. If this option is %NULL, the default is read from `/etc/nvme/hostnqn` first. ++ * If that does not exist, the autogenerated NQN value from the NVMe Host kernel module is used next. The Host NQN uniquely identifies the NVMe Host. ++ * @host_id: (nullable): User-defined host UUID or %NULL to use default (as defined in `/etc/nvme/hostid`) ++ * @extra: (nullable) (array zero-terminated=1): Additional arguments. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Creates a transport connection to a remote system (specified by @transport_addr and @transport_svcid) ++ * and creates a NVMe over Fabrics controller for the NVMe subsystem specified by the @subsysnqn option. ++ * ++ * Valid values for @transport include: ++ * - `"rdma"`: An rdma network (RoCE, iWARP, Infiniband, basic rdma, etc.) ++ * - `"fc"`: A Fibre Channel network. ++ * - `"tcp"`: A TCP/IP network. ++ * - `"loop"`: A NVMe over Fabrics target on the local host. ++ * ++ * In addition to the primary options it's possible to supply @extra arguments: ++ * - `"config"`: Use the specified JSON configuration file instead of the default file (see below) or ++ * specify `"none"` to avoid reading any configuration file. ++ * - `"dhchap_key"`: NVMe In-band authentication secret in ASCII format as described ++ * in the NVMe 2.0 specification. When not specified, the secret is by default read ++ * from `/etc/nvme/hostkey`. In case that file does not exist no in-band authentication ++ * is attempted. ++ * - `"dhchap_ctrl_key"`: NVMe In-band authentication controller secret for bi-directional authentication. ++ * When not specified, no bi-directional authentication is attempted. ++ * - `"nr_io_queues"`: The number of I/O queues. ++ * - `"nr_write_queues"`: Number of additional queues that will be used for write I/O. ++ * - `"nr_poll_queues"`: Number of additional queues that will be used for polling latency sensitive I/O. ++ * - `"queue_size"`: Number of elements in the I/O queues. ++ * - `"keep_alive_tmo"`: The keep alive timeout (in seconds). ++ * - `"reconnect_delay"`: The delay (in seconds) before reconnect is attempted after a connect loss. ++ * - `"ctrl_loss_tmo"`: The controller loss timeout period (in seconds). A special value of `-1` will cause reconnecting forever. ++ * - `"fast_io_fail_tmo"`: Fast I/O Fail timeout (in seconds). ++ * - `"tos"`: Type of service. ++ * - `"duplicate_connect"`: Allow duplicated connections between same transport host and subsystem port. Boolean value. ++ * - `"disable_sqflow"`: Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions. Boolean value. ++ * - `"hdr_digest"`: Generates/verifies header digest (TCP). Boolean value. ++ * - `"data_digest"`: Generates/verifies data digest (TCP). Boolean value. ++ * - `"tls"`: Enable TLS encryption (TCP). Boolean value. ++ * - `"hostsymname"`: TP8010: NVMe host symbolic name. ++ * ++ * Boolean values can be expressed by "0"/"1", "on"/"off" or "True"/"False" case-insensitive ++ * strings. Failed numerical or boolean string conversions will result in the option being ignored. ++ * ++ * By default additional options are read from the default configuration file `/etc/nvme/config.json`. ++ * This follows the default behaviour of `nvme-cli`. Use the @extra `"config"` argument ++ * to either specify a different config file or disable use of it. The JSON configuration ++ * file format is documented in [https://raw.githubusercontent.com/linux-nvme/libnvme/master/doc/config-schema.json](https://raw.githubusercontent.com/linux-nvme/libnvme/master/doc/config-schema.json). ++ * As a rule @extra key names are kept consistent with the JSON config file schema. ++ * Any @extra option generally overrides particular option specified in a configuration file. ++ * ++ * Returns: %TRUE if the subsystem was connected successfully, %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gboolean bd_nvme_connect (const gchar *subsysnqn, const gchar *transport, const gchar *transport_addr, const gchar *transport_svcid, const gchar *host_traddr, const gchar *host_iface, const gchar *host_nqn, const gchar *host_id, const BDExtraArg **extra, GError **error) { ++ int ret; ++ const gchar *config_file = PATH_NVMF_CONFIG; ++ gchar *host_nqn_val; ++ gchar *host_id_val; ++ const gchar *hostkey = NULL; ++ const gchar *ctrlkey = NULL; ++ const gchar *hostsymname = NULL; ++ nvme_root_t root; ++ nvme_host_t host; ++ nvme_ctrl_t ctrl; ++ struct nvme_fabrics_config cfg; ++ ++ if (subsysnqn == NULL) { ++ g_set_error_literal (error, BD_NVME_ERROR, BD_NVME_ERROR_INVALID_ARGUMENT, ++ "Invalid value specified for the subsysnqn argument"); ++ return FALSE; ++ } ++ if (transport == NULL) { ++ g_set_error_literal (error, BD_NVME_ERROR, BD_NVME_ERROR_INVALID_ARGUMENT, ++ "Invalid value specified for the transport argument"); ++ return FALSE; ++ } ++ if (transport_addr == NULL && !g_str_equal (transport, "loop") && !g_str_equal (transport, "pcie")) { ++ g_set_error_literal (error, BD_NVME_ERROR, BD_NVME_ERROR_INVALID_ARGUMENT, ++ "Invalid value specified for the transport address argument"); ++ return FALSE; ++ } ++ ++ /* parse extra arguments */ ++ nvmf_default_config (&cfg); ++ parse_extra_args (extra, &cfg, &config_file, &hostkey, &ctrlkey, &hostsymname); ++ ++ host_nqn_val = g_strdup (host_nqn); ++ if (host_nqn_val == NULL) ++ host_nqn_val = nvmf_hostnqn_from_file (); ++ if (host_nqn_val == NULL) ++ host_nqn_val = nvmf_hostnqn_generate (); ++ host_id_val = g_strdup (host_id); ++ if (host_id_val == NULL) ++ host_id_val = nvmf_hostid_from_file (); ++ ++ root = nvme_scan (config_file); ++ g_assert (root != NULL); ++ nvme_init_logging (root, -1, false, false); ++ host = nvme_lookup_host (root, host_nqn_val, host_id_val); ++ if (host == NULL) { ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_FAILED, ++ "Unable to lookup host for nqn '%s' and id '%s'", ++ host_nqn_val, host_id_val); ++ g_free (host_nqn_val); ++ g_free (host_id_val); ++ nvme_free_tree (root); ++ return FALSE; ++ } ++ g_free (host_nqn_val); ++ g_free (host_id_val); ++ if (hostkey) ++ nvme_host_set_dhchap_key (host, hostkey); ++ if (hostsymname) ++ nvme_host_set_hostsymname (host, hostsymname); ++ ++ ctrl = nvme_create_ctrl (root, subsysnqn, transport, transport_addr, host_traddr, host_iface, transport_svcid); ++ if (ctrl == NULL) { ++ _nvme_fabrics_errno_to_gerror (-1, errno, error); ++ g_prefix_error (error, "Error creating the controller: "); ++ nvme_free_tree (root); ++ return FALSE; ++ } ++ if (ctrlkey) ++ nvme_ctrl_set_dhchap_key (ctrl, ctrlkey); ++ ++ ret = nvmf_add_ctrl (host, ctrl, &cfg); ++ if (ret != 0) { ++ _nvme_fabrics_errno_to_gerror (ret, errno, error); ++ g_prefix_error (error, "Error connecting the controller: "); ++ nvme_free_ctrl (ctrl); ++ nvme_free_tree (root); ++ return FALSE; ++ } ++ nvme_free_ctrl (ctrl); ++ nvme_free_tree (root); ++ ++ return TRUE; ++} ++ ++/** ++ * bd_nvme_disconnect: ++ * @subsysnqn: The name of the NVMe subsystem to disconnect. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Disconnects and removes one or more existing NVMe over Fabrics controllers. ++ * This may disconnect multiple controllers with matching @subsysnqn and %TRUE ++ * is only returned when all controllers were disconnected successfully. ++ * ++ * Returns: %TRUE if all matching controllers were disconnected successfully, %FALSE with @error ++ * set in case of a disconnect error or when no matching controllers were found. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gboolean bd_nvme_disconnect (const gchar *subsysnqn, GError **error) { ++ nvme_root_t root; ++ nvme_host_t host; ++ nvme_subsystem_t subsys; ++ nvme_ctrl_t ctrl; ++ gboolean found = FALSE; ++ ++ root = nvme_scan (NULL); ++ nvme_init_logging (root, -1, false, false); ++ nvme_for_each_host (root, host) ++ nvme_for_each_subsystem (host, subsys) ++ if (g_strcmp0 (nvme_subsystem_get_nqn (subsys), subsysnqn) == 0) ++ nvme_subsystem_for_each_ctrl (subsys, ctrl) { ++ int ret; ++ ++ ret = nvme_disconnect_ctrl (ctrl); ++ if (ret != 0) { ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_FAILED, ++ "Error disconnecting the controller: %s", ++ strerror_l (errno, _C_LOCALE)); ++ nvme_free_tree (root); ++ return FALSE; ++ } ++ found = TRUE; ++ } ++ nvme_free_tree (root); ++ if (!found) { ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_NO_MATCH, ++ "No subsystems matching '%s' NQN found.", subsysnqn); ++ return FALSE; ++ } ++ ++ return TRUE; ++} ++ ++/** ++ * bd_nvme_disconnect_by_path: ++ * @path: NVMe controller device to disconnect (e.g. `/dev/nvme0`). ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Disconnects and removes a NVMe over Fabrics controller represented ++ * by a block device path. ++ * ++ * Returns: %TRUE if the controller was disconnected successfully, ++ * %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gboolean bd_nvme_disconnect_by_path (const gchar *path, GError **error) { ++ nvme_root_t root; ++ nvme_ctrl_t ctrl; ++ const gchar *p; ++ int ret; ++ ++ p = path; ++ if (g_str_has_prefix (p, "/dev/")) ++ p += 5; ++ ++ root = nvme_scan (NULL); ++ nvme_init_logging (root, -1, false, false); ++ ctrl = nvme_scan_ctrl (root, p); ++ if (!ctrl) { ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_NO_MATCH, ++ "Unable to match a NVMeoF controller for the specified block device %s.", ++ path); ++ nvme_free_tree (root); ++ return FALSE; ++ } ++ ++ ret = nvme_disconnect_ctrl (ctrl); ++ if (ret != 0) { ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_FAILED, ++ "Error disconnecting the controller: %s", ++ strerror_l (errno, _C_LOCALE)); ++ nvme_free_tree (root); ++ return FALSE; ++ } ++ nvme_free_tree (root); ++ ++ return TRUE; ++} ++ ++ ++/** ++ * bd_nvme_discovery_log_entry_free: (skip) ++ * @entry: (nullable): %BDNVMEDiscoveryLogEntry to free ++ * ++ * Frees @entry. ++ */ ++void bd_nvme_discovery_log_entry_free (BDNVMEDiscoveryLogEntry *entry) { ++ if (entry == NULL) ++ return; ++ ++ g_free (entry->transport_addr); ++ g_free (entry->transport_svcid); ++ g_free (entry->subsys_nqn); ++ g_free (entry); ++} ++ ++/** ++ * bd_nvme_discovery_log_entry_copy: (skip) ++ * @entry: (nullable): %BDNVMEDiscoveryLogEntry to copy ++ * ++ * Creates a new copy of @entry. ++ */ ++BDNVMEDiscoveryLogEntry * bd_nvme_discovery_log_entry_copy (BDNVMEDiscoveryLogEntry *entry) { ++ BDNVMEDiscoveryLogEntry *new_entry; ++ ++ if (entry == NULL) ++ return NULL; ++ ++ new_entry = g_new0 (BDNVMEDiscoveryLogEntry, 1); ++ memcpy (new_entry, entry, sizeof (BDNVMEDiscoveryLogEntry)); ++ new_entry->transport_addr = g_strdup (entry->transport_addr); ++ new_entry->transport_svcid = g_strdup (entry->transport_svcid); ++ new_entry->subsys_nqn = g_strdup (entry->subsys_nqn); ++ ++ return new_entry; ++} ++ ++/** ++ * bd_nvme_discover: ++ * @discovery_ctrl: (nullable): Use existing discovery controller device or %NULL to establish a new connection. ++ * @persistent: Persistent discovery connection. ++ * @transport: The network fabric used for a NVMe-over-Fabrics network. ++ * @transport_addr: (nullable): The network address of the Controller. For transports using IP addressing (e.g. `rdma`) this should be an IP-based address. ++ * @transport_svcid: (nullable): The transport service id. For transports using IP addressing (e.g. `rdma`) this field is the port number. By default, the IP port number for the `RDMA` transport is `4420`. ++ * @host_traddr: (nullable): The network address used on the host to connect to the Controller. For TCP, this sets the source address on the socket. ++ * @host_iface: (nullable): The network interface used on the host to connect to the Controller (e.g. IP `eth1`, `enp2s0`). This forces the connection to be made on a specific interface instead of letting the system decide. ++ * @host_nqn: (nullable): Overrides the default Host NQN that identifies the NVMe Host. If this option is %NULL, the default is read from `/etc/nvme/hostnqn` first. ++ * If that does not exist, the autogenerated NQN value from the NVMe Host kernel module is used next. The Host NQN uniquely identifies the NVMe Host. ++ * @host_id: (nullable): User-defined host UUID or %NULL to use default (as defined in `/etc/nvme/hostid`) ++ * @extra: (nullable) (array zero-terminated=1): Additional arguments. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Performs Discovery request on a Discovery Controller. If no connection to a Discovery Controller ++ * exists (i.e. @discovery_ctrl is %NULL) a new connection is established as specified by the @transport, ++ * @transport_addr and optionally @transport_svcid arguments. ++ * ++ * Note that the `nvme-cli`'s `/etc/nvme/discovery.conf` config file is not used at the moment. ++ * ++ * Valid values for @transport include: ++ * - `"rdma"`: An rdma network (RoCE, iWARP, Infiniband, basic rdma, etc.) ++ * - `"fc"`: A Fibre Channel network. ++ * - `"tcp"`: A TCP/IP network. ++ * - `"loop"`: A NVMe over Fabrics target on the local host. ++ * ++ * In addition to the primary options it's possible to supply @extra arguments: ++ * - `"config"`: Use the specified JSON configuration file instead of the default file (see below) or ++ * specify `"none"` to avoid reading any configuration file. ++ * - `"dhchap_key"`: NVMe In-band authentication secret in ASCII format as described ++ * in the NVMe 2.0 specification. When not specified, the secret is by default read ++ * from `/etc/nvme/hostkey`. In case that file does not exist no in-band authentication ++ * is attempted. ++ * - `"dhchap_ctrl_key"`: NVMe In-band authentication controller secret for bi-directional authentication. ++ * When not specified, no bi-directional authentication is attempted. ++ * - `"nr_io_queues"`: The number of I/O queues. ++ * - `"nr_write_queues"`: Number of additional queues that will be used for write I/O. ++ * - `"nr_poll_queues"`: Number of additional queues that will be used for polling latency sensitive I/O. ++ * - `"queue_size"`: Number of elements in the I/O queues. ++ * - `"keep_alive_tmo"`: The keep alive timeout (in seconds). ++ * - `"reconnect_delay"`: The delay (in seconds) before reconnect is attempted after a connect loss. ++ * - `"ctrl_loss_tmo"`: The controller loss timeout period (in seconds). A special value of `-1` will cause reconnecting forever. ++ * - `"fast_io_fail_tmo"`: Fast I/O Fail timeout (in seconds). ++ * - `"tos"`: Type of service. ++ * - `"duplicate_connect"`: Allow duplicated connections between same transport host and subsystem port. Boolean value. ++ * - `"disable_sqflow"`: Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions. Boolean value. ++ * - `"hdr_digest"`: Generates/verifies header digest (TCP). Boolean value. ++ * - `"data_digest"`: Generates/verifies data digest (TCP). Boolean value. ++ * - `"tls"`: Enable TLS encryption (TCP). Boolean value. ++ * - `"hostsymname"`: TP8010: NVMe host symbolic name. ++ * ++ * Boolean values can be expressed by "0"/"1", "on"/"off" or "True"/"False" case-insensitive ++ * strings. Failed numerical or boolean string conversions will result in the option being ignored. ++ * ++ * By default additional options are read from the default configuration file `/etc/nvme/config.json`. ++ * This follows the default behaviour of `nvme-cli`. Use the @extra `"config"` argument ++ * to either specify a different config file or disable use of it. The JSON configuration ++ * file format is documented in [https://raw.githubusercontent.com/linux-nvme/libnvme/master/doc/config-schema.json](https://raw.githubusercontent.com/linux-nvme/libnvme/master/doc/config-schema.json). ++ * As a rule @extra key names are kept consistent with the JSON config file schema. ++ * Any @extra option generally overrides particular option specified in a configuration file. ++ * ++ * Returns: (transfer full) (array zero-terminated=1): null-terminated list ++ * of discovery log entries or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++BDNVMEDiscoveryLogEntry ** bd_nvme_discover (const gchar *discovery_ctrl, gboolean persistent, const gchar *transport, const gchar *transport_addr, const gchar *transport_svcid, const gchar *host_traddr, const gchar *host_iface, const gchar *host_nqn, const gchar *host_id, const BDExtraArg **extra, GError **error) { ++ int ret; ++ const gchar *config_file = PATH_NVMF_CONFIG; ++ gchar *host_nqn_val; ++ gchar *host_id_val; ++ const gchar *hostkey = NULL; ++ const gchar *hostsymname = NULL; ++ nvme_root_t root; ++ nvme_host_t host; ++ nvme_ctrl_t ctrl = NULL; ++ struct nvme_fabrics_config cfg; ++ struct nvmf_discovery_log *log = NULL; ++ GPtrArray *ptr_array; ++ guint64 i; ++ ++ if (discovery_ctrl && strncmp (discovery_ctrl, "/dev/", 5) != 0) { ++ g_set_error_literal (error, BD_NVME_ERROR, BD_NVME_ERROR_INVALID_ARGUMENT, ++ "Invalid discovery controller device specified"); ++ return NULL; ++ } ++ if (transport == NULL) { ++ g_set_error_literal (error, BD_NVME_ERROR, BD_NVME_ERROR_INVALID_ARGUMENT, ++ "Invalid value specified for the transport argument"); ++ return NULL; ++ } ++ if (transport_addr == NULL && !g_str_equal (transport, "loop") && !g_str_equal (transport, "pcie")) { ++ g_set_error_literal (error, BD_NVME_ERROR, BD_NVME_ERROR_INVALID_ARGUMENT, ++ "Invalid value specified for the transport address argument"); ++ return NULL; ++ } ++ /* TODO: nvme-cli defaults to parsing /etc/nvme/discovery.conf to retrieve missing arguments */ ++ ++ /* parse extra arguments */ ++ nvmf_default_config (&cfg); ++ parse_extra_args (extra, &cfg, &config_file, &hostkey, NULL, &hostsymname); ++ ++ host_nqn_val = g_strdup (host_nqn); ++ if (host_nqn_val == NULL) ++ host_nqn_val = nvmf_hostnqn_from_file (); ++ if (host_nqn_val == NULL) ++ host_nqn_val = nvmf_hostnqn_generate (); ++ host_id_val = g_strdup (host_id); ++ if (host_id_val == NULL) ++ host_id_val = nvmf_hostid_from_file (); ++ ++ root = nvme_scan (config_file); ++ g_assert (root != NULL); ++ nvme_init_logging (root, -1, false, false); ++ host = nvme_lookup_host (root, host_nqn_val, host_id_val); ++ if (host == NULL) { ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_FAILED, ++ "Unable to lookup host for nqn '%s' and id '%s'", ++ host_nqn_val, host_id_val); ++ g_free (host_nqn_val); ++ g_free (host_id_val); ++ nvme_free_tree (root); ++ return NULL; ++ } ++ g_free (host_nqn_val); ++ g_free (host_id_val); ++ if (hostkey) ++ nvme_host_set_dhchap_key (host, hostkey); ++ if (hostsymname) ++ nvme_host_set_hostsymname (host, hostsymname); ++ ++ if (persistent && !cfg.keep_alive_tmo) ++ cfg.keep_alive_tmo = 30; ++ ++ /* check the supplied discovery controller validity */ ++ if (discovery_ctrl) { ++ ctrl = nvme_scan_ctrl (root, discovery_ctrl + 5); ++ if (!ctrl) { ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_NO_MATCH, ++ "Couldn't access the discovery controller device specified: %s", ++ strerror_l (errno, _C_LOCALE)); ++ nvme_free_tree (root); ++ return NULL; ++ } ++ if (g_strcmp0 (nvme_ctrl_get_subsysnqn (ctrl), NVME_DISC_SUBSYS_NAME) != 0 || ++ g_strcmp0 (nvme_ctrl_get_transport (ctrl), transport) != 0 || ++ (transport_addr && g_strcmp0 (nvme_ctrl_get_traddr (ctrl), transport_addr) != 0) || ++ (host_traddr && g_strcmp0 (nvme_ctrl_get_host_traddr (ctrl), host_traddr) != 0) || ++ (host_iface && g_strcmp0 (nvme_ctrl_get_host_iface (ctrl), host_iface) != 0) || ++ (transport_svcid && g_strcmp0 (nvme_ctrl_get_trsvcid (ctrl), transport_svcid) != 0)) { ++ g_set_error_literal (error, BD_NVME_ERROR, BD_NVME_ERROR_NO_MATCH, ++ "The existing discovery controller device specified doesn't match the specified transport arguments"); ++ nvme_free_tree (root); ++ return NULL; ++ } ++ /* existing discovery controllers need to be persistent */ ++ persistent = TRUE; ++ } ++ if (!ctrl) { ++ ctrl = nvme_create_ctrl (root, NVME_DISC_SUBSYS_NAME, transport, transport_addr, host_traddr, host_iface, transport_svcid); ++ if (ctrl == NULL) { ++ _nvme_fabrics_errno_to_gerror (-1, errno, error); ++ g_prefix_error (error, "Error creating the controller: "); ++ nvme_free_tree (root); ++ return NULL; ++ } ++ nvme_ctrl_set_discovery_ctrl (ctrl, TRUE); ++ ret = nvmf_add_ctrl (host, ctrl, &cfg); ++ if (ret != 0) { ++ _nvme_fabrics_errno_to_gerror (ret, errno, error); ++ g_prefix_error (error, "Error connecting the controller: "); ++ nvme_free_ctrl (ctrl); ++ nvme_free_tree (root); ++ return NULL; ++ } ++ } ++ ++ /* connected, perform actual discovery */ ++ ret = nvmf_get_discovery_log (ctrl, &log, MAX_DISC_RETRIES); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, TRUE, error); ++ g_prefix_error (error, "NVMe Get Log Page - Discovery Log Page command error: "); ++ if (!persistent) ++ nvme_disconnect_ctrl (ctrl); ++ nvme_free_ctrl (ctrl); ++ nvme_free_tree (root); ++ return NULL; ++ } ++ ++ ptr_array = g_ptr_array_new (); ++ for (i = 0; i < GUINT64_FROM_LE (log->numrec); i++) { ++ BDNVMEDiscoveryLogEntry *entry; ++ gchar *s; ++ ++ entry = g_new0 (BDNVMEDiscoveryLogEntry, 1); ++ switch (log->entries[i].trtype) { ++ case NVMF_TRTYPE_RDMA: ++ entry->transport_type = BD_NVME_TRANSPORT_TYPE_RDMA; ++ break; ++ case NVMF_TRTYPE_FC: ++ entry->transport_type = BD_NVME_TRANSPORT_TYPE_FC; ++ break; ++ case NVMF_TRTYPE_TCP: ++ entry->transport_type = BD_NVME_TRANSPORT_TYPE_TCP; ++ break; ++ case NVMF_TRTYPE_LOOP: ++ entry->transport_type = BD_NVME_TRANSPORT_TYPE_LOOP; ++ break; ++ case NVMF_TRTYPE_UNSPECIFIED: ++ default: ++ entry->transport_type = BD_NVME_TRANSPORT_TYPE_UNSPECIFIED; ++ } ++ switch (log->entries[i].adrfam) { ++ case NVMF_ADDR_FAMILY_PCI: ++ entry->address_family = BD_NVME_ADDRESS_FAMILY_PCI; ++ break; ++ case NVMF_ADDR_FAMILY_IP4: ++ entry->address_family = BD_NVME_ADDRESS_FAMILY_INET; ++ break; ++ case NVMF_ADDR_FAMILY_IP6: ++ entry->address_family = BD_NVME_ADDRESS_FAMILY_INET6; ++ break; ++ case NVMF_ADDR_FAMILY_IB: ++ entry->address_family = BD_NVME_ADDRESS_FAMILY_IB; ++ break; ++ case NVMF_ADDR_FAMILY_FC: ++ entry->address_family = BD_NVME_ADDRESS_FAMILY_FC; ++ break; ++ case NVMF_ADDR_FAMILY_LOOP: ++ entry->address_family = BD_NVME_ADDRESS_FAMILY_LOOP; ++ break; ++ } ++ entry->sq_flow_control_disable = (log->entries[i].treq & NVMF_TREQ_DISABLE_SQFLOW) == NVMF_TREQ_DISABLE_SQFLOW; ++ entry->sq_flow_control_required = (log->entries[i].treq & NVMF_TREQ_REQUIRED) == NVMF_TREQ_REQUIRED; ++ entry->port_id = GUINT16_FROM_LE (log->entries[i].portid); ++ entry->ctrl_id = GUINT16_FROM_LE (log->entries[i].cntlid); ++ s = g_strndup (log->entries[i].trsvcid, NVMF_TRSVCID_SIZE); ++ entry->transport_svcid = g_strdup (g_strstrip (s)); ++ g_free (s); ++ s = g_strndup (log->entries[i].traddr, NVMF_TRADDR_SIZE); ++ entry->transport_addr = g_strdup (g_strstrip (s)); ++ g_free (s); ++ s = g_strndup (log->entries[i].subnqn, NVME_NQN_LENGTH); ++ entry->subsys_nqn = g_strdup (g_strstrip (s)); ++ g_free (s); ++ ++ if (entry->transport_type == BD_NVME_TRANSPORT_TYPE_RDMA) { ++ /* TODO: expose any of the struct nvmf_disc_log_entry.tsas.rdma attributes? */ ++ } ++ ++ if (entry->transport_type == BD_NVME_TRANSPORT_TYPE_TCP) ++ switch (log->entries[i].tsas.tcp.sectype) { ++ case NVMF_TCP_SECTYPE_NONE: ++ entry->tcp_security = BD_NVME_TCP_SECURITY_NONE; ++ break; ++ case NVMF_TCP_SECTYPE_TLS: ++ entry->tcp_security = BD_NVME_TCP_SECURITY_TLS12; ++ break; ++ case NVMF_TCP_SECTYPE_TLS13: ++ entry->tcp_security = BD_NVME_TCP_SECURITY_TLS13; ++ break; ++ } ++ ++ g_ptr_array_add (ptr_array, entry); ++ } ++ g_free (log); ++ g_ptr_array_add (ptr_array, NULL); /* trailing NULL element */ ++ ++ if (!persistent) ++ nvme_disconnect_ctrl (ctrl); ++ nvme_free_ctrl (ctrl); ++ nvme_free_tree (root); ++ ++ return (BDNVMEDiscoveryLogEntry **) g_ptr_array_free (ptr_array, FALSE); ++} ++ ++ ++/** ++ * bd_nvme_find_ctrls_for_ns: ++ * @ns_sysfs_path: NVMe namespace device file. ++ * @subsysnqn: (nullable): Limit matching to the specified subsystem NQN. ++ * @host_nqn: (nullable): Limit matching to the specified host NQN. ++ * @host_id: (nullable): Limit matching to the specified host ID. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * A convenient utility function to look up all controllers associated ++ * with a NVMe subsystem the specified namespace is part of. ++ * ++ * Returns: (transfer full) (array zero-terminated=1): list of controller sysfs paths ++ * or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gchar ** bd_nvme_find_ctrls_for_ns (const gchar *ns_sysfs_path, const gchar *subsysnqn, const gchar *host_nqn, const gchar *host_id, GError **error G_GNUC_UNUSED) { ++ GPtrArray *ptr_array; ++ nvme_root_t root; ++ nvme_host_t h; ++ nvme_subsystem_t s; ++ nvme_ctrl_t c; ++ nvme_ns_t n; ++ char realp[PATH_MAX]; ++ ++ ptr_array = g_ptr_array_new (); ++ ++ root = nvme_scan (NULL); ++ g_warn_if_fail (root != NULL); ++ ++ nvme_for_each_host (root, h) { ++ if (host_nqn && g_strcmp0 (nvme_host_get_hostnqn (h), host_nqn) != 0) ++ continue; ++ if (host_id && g_strcmp0 (nvme_host_get_hostid (h), host_id) != 0) ++ continue; ++ ++ nvme_for_each_subsystem (h, s) { ++ gboolean found = FALSE; ++ ++ if (subsysnqn && g_strcmp0 (nvme_subsystem_get_nqn (s), subsysnqn) != 0) ++ continue; ++ ++ nvme_subsystem_for_each_ctrl (s, c) ++ nvme_ctrl_for_each_ns (c, n) ++ if (realpath (nvme_ns_get_sysfs_dir (n), realp) && ++ g_strcmp0 (realp, ns_sysfs_path) == 0) { ++ if (realpath (nvme_ctrl_get_sysfs_dir (c), realp)) { ++ g_ptr_array_add (ptr_array, g_strdup (realp)); ++ break; ++ } ++ } ++ ++ nvme_subsystem_for_each_ns (s, n) ++ if (realpath (nvme_ns_get_sysfs_dir (n), realp) && ++ g_strcmp0 (realp, ns_sysfs_path) == 0) { ++ found = TRUE; ++ /* at least one of the namespaces match, don't care about the rest */ ++ break; ++ } ++ ++ if (found) ++ /* add all controllers in the subsystem */ ++ nvme_subsystem_for_each_ctrl (s, c) { ++ if (realpath (nvme_ctrl_get_sysfs_dir (c), realp)) { ++ g_ptr_array_add (ptr_array, g_strdup (realp)); ++ } ++ } ++ } ++ } ++ nvme_free_tree (root); ++ ++ g_ptr_array_add (ptr_array, NULL); /* trailing NULL element */ ++ return (gchar **) g_ptr_array_free (ptr_array, FALSE); ++} ++ ++ ++/** ++ * bd_nvme_get_host_nqn: ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Reads the Host NQN (NVM Qualified Name) value from the global `/etc/nvme/hostnqn` ++ * file. An empty string is an indication that no Host NQN has been set. ++ * ++ * Returns: (transfer full): the Host NQN string or an empty string if none set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gchar * bd_nvme_get_host_nqn (G_GNUC_UNUSED GError **error) { ++ char *hostnqn; ++ ++ /* FIXME: libnvme SYSCONFDIR might be different from PACKAGE_SYSCONF_DIR */ ++ hostnqn = nvmf_hostnqn_from_file (); ++ return hostnqn ? hostnqn : g_strdup (""); ++} ++ ++/** ++ * bd_nvme_generate_host_nqn: ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Compute new Host NQN (NVM Qualified Name) value for the current system. This ++ * takes in account various system identifiers (DMI, device tree) with the goal ++ * of a stable unique identifier whenever feasible. ++ * ++ * Returns: (transfer full): the Host NQN string or %NULL with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gchar * bd_nvme_generate_host_nqn (GError **error) { ++ char *nqn; ++ ++ nqn = nvmf_hostnqn_generate (); ++ if (!nqn) ++ g_set_error_literal (error, BD_NVME_ERROR, BD_NVME_ERROR_INVALID_ARGUMENT, ++ "Unable to generate Host NQN."); ++ ++ return nqn; ++} ++ ++/** ++ * bd_nvme_get_host_id: ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Reads the Host ID value from the global `/etc/nvme/hostid` file. An empty ++ * string is an indication that no Host ID has been set. ++ * ++ * Returns: (transfer full): the Host ID string or an empty string if none set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gchar * bd_nvme_get_host_id (G_GNUC_UNUSED GError **error) { ++ char *hostid; ++ ++ hostid = nvmf_hostid_from_file (); ++ return hostid ? hostid : g_strdup (""); ++} ++ ++/** ++ * bd_nvme_set_host_nqn: ++ * @host_nqn: The Host NVM Qualified Name. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Writes the Host NQN (NVM Qualified Name) value to the system `/etc/nvme/hostnqn` file. ++ * No validation of the string is performed. ++ * ++ * Returns: %TRUE if the value was set successfully or %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gboolean bd_nvme_set_host_nqn (const gchar *host_nqn, GError **error) { ++ gchar *path; ++ gchar *filename; ++ gchar *s; ++ gboolean ret; ++ ++ g_return_val_if_fail (host_nqn != NULL, FALSE); ++ ++ path = g_build_path (G_DIR_SEPARATOR_S, PACKAGE_SYSCONF_DIR, "nvme", NULL); ++ if (g_mkdir_with_parents (path, 0755) != 0 && errno != EEXIST) { ++ g_set_error (error, G_FILE_ERROR, g_file_error_from_errno (errno), ++ "Error creating %s: %s", ++ path, strerror_l (errno, _C_LOCALE)); ++ g_free (path); ++ return FALSE; ++ } ++ filename = g_build_filename (path, "hostnqn", NULL); ++ if (host_nqn[strlen (host_nqn) - 1] != '\n') ++ s = g_strdup_printf ("%s\n", host_nqn); ++ else ++ s = g_strdup (host_nqn); ++ ret = g_file_set_contents (filename, s, -1, error); ++ if (ret) ++ g_chmod (filename, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); ++ ++ g_free (s); ++ g_free (path); ++ g_free (filename); ++ ++ return ret; ++} ++ ++/** ++ * bd_nvme_set_host_id: ++ * @host_id: The Host ID. ++ * @error: (out) (nullable): Place to store error (if any). ++ * ++ * Writes the Host ID value to the system `/etc/nvme/hostid` file. ++ * No validation of the string is performed. ++ * ++ * Returns: %TRUE if the value was set successfully or %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR ++ */ ++gboolean bd_nvme_set_host_id (const gchar *host_id, GError **error) { ++ gchar *path; ++ gchar *filename; ++ gchar *s; ++ gboolean ret; ++ ++ g_return_val_if_fail (host_id != NULL, FALSE); ++ ++ path = g_build_path (G_DIR_SEPARATOR_S, PACKAGE_SYSCONF_DIR, "nvme", NULL); ++ if (g_mkdir_with_parents (path, 0755) != 0 && errno != EEXIST) { ++ g_set_error (error, G_FILE_ERROR, g_file_error_from_errno (errno), ++ "Error creating %s: %s", ++ path, strerror_l (errno, _C_LOCALE)); ++ g_free (path); ++ return FALSE; ++ } ++ filename = g_build_filename (path, "hostid", NULL); ++ if (host_id[strlen (host_id) - 1] != '\n') ++ s = g_strdup_printf ("%s\n", host_id); ++ else ++ s = g_strdup (host_id); ++ ret = g_file_set_contents (filename, s, -1, error); ++ if (ret) ++ g_chmod (filename, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); ++ ++ g_free (s); ++ g_free (path); ++ g_free (filename); ++ ++ return ret; ++} +diff --git a/src/plugins/nvme/nvme-info.c b/src/plugins/nvme/nvme-info.c +new file mode 100644 +index 00000000..fdd90459 +--- /dev/null ++++ b/src/plugins/nvme/nvme-info.c +@@ -0,0 +1,1028 @@ ++/* ++ * Copyright (C) 2014-2021 Red Hat, Inc. ++ * ++ * This library is free software; you can redistribute it and/or ++ * modify it under the terms of the GNU Lesser General Public ++ * License as published by the Free Software Foundation; either ++ * version 2.1 of the License, or (at your option) any later version. ++ * ++ * This library is distributed in the hope that it will be useful, ++ * but WITHOUT ANY WARRANTY; without even the implied warranty of ++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ++ * Lesser General Public License for more details. ++ * ++ * You should have received a copy of the GNU Lesser General Public ++ * License along with this library; if not, see . ++ * ++ * Author: Tomas Bzatek ++ */ ++ ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++ ++#include ++#include ++ ++#include ++#include ++#include "nvme.h" ++#include "nvme-private.h" ++ ++ ++/** ++ * bd_nvme_controller_info_free: (skip) ++ * @info: (nullable): %BDNVMEControllerInfo to free ++ * ++ * Frees @info. ++ */ ++void bd_nvme_controller_info_free (BDNVMEControllerInfo *info) { ++ if (info == NULL) ++ return; ++ ++ g_free (info->fguid); ++ g_free (info->subsysnqn); ++ g_free (info->model_number); ++ g_free (info->serial_number); ++ g_free (info->firmware_ver); ++ g_free (info->nvme_ver); ++ g_free (info); ++} ++ ++/** ++ * bd_nvme_controller_info_copy: (skip) ++ * @info: (nullable): %BDNVMEControllerInfo to copy ++ * ++ * Creates a new copy of @info. ++ */ ++BDNVMEControllerInfo * bd_nvme_controller_info_copy (BDNVMEControllerInfo *info) { ++ BDNVMEControllerInfo *new_info; ++ ++ if (info == NULL) ++ return NULL; ++ ++ new_info = g_new0 (BDNVMEControllerInfo, 1); ++ memcpy (new_info, info, sizeof (BDNVMEControllerInfo)); ++ new_info->fguid = g_strdup (info->fguid); ++ new_info->subsysnqn = g_strdup (info->subsysnqn); ++ new_info->model_number = g_strdup (info->model_number); ++ new_info->serial_number = g_strdup (info->serial_number); ++ new_info->firmware_ver = g_strdup (info->firmware_ver); ++ new_info->nvme_ver = g_strdup (info->nvme_ver); ++ ++ return new_info; ++} ++ ++/** ++ * bd_nvme_lba_format_free: (skip) ++ * @fmt: (nullable): %BDNVMELBAFormat to free ++ * ++ * Frees @fmt. ++ */ ++void bd_nvme_lba_format_free (BDNVMELBAFormat *fmt) { ++ g_free (fmt); ++} ++ ++/** ++ * bd_nvme_lba_format_copy: (skip) ++ * @fmt: (nullable): %BDNVMELBAFormat to copy ++ * ++ * Creates a new copy of @fmt. ++ */ ++BDNVMELBAFormat * bd_nvme_lba_format_copy (BDNVMELBAFormat *fmt) { ++ BDNVMELBAFormat *new_fmt; ++ ++ if (fmt == NULL) ++ return NULL; ++ ++ new_fmt = g_new0 (BDNVMELBAFormat, 1); ++ new_fmt->data_size = fmt->data_size; ++ new_fmt->metadata_size = fmt->metadata_size; ++ new_fmt->relative_performance = fmt->relative_performance; ++ ++ return new_fmt; ++} ++ ++/** ++ * bd_nvme_namespace_info_free: (skip) ++ * @info: (nullable): %BDNVMENamespaceInfo to free ++ * ++ * Frees @info. ++ */ ++void bd_nvme_namespace_info_free (BDNVMENamespaceInfo *info) { ++ BDNVMELBAFormat **lba_formats; ++ ++ if (info == NULL) ++ return; ++ ++ g_free (info->eui64); ++ g_free (info->uuid); ++ g_free (info->nguid); ++ ++ for (lba_formats = info->lba_formats; lba_formats && *lba_formats; lba_formats++) ++ bd_nvme_lba_format_free (*lba_formats); ++ g_free (info->lba_formats); ++ g_free (info); ++} ++ ++/** ++ * bd_nvme_namespace_info_copy: (skip) ++ * @info: (nullable): %BDNVMENamespaceInfo to copy ++ * ++ * Creates a new copy of @info. ++ */ ++BDNVMENamespaceInfo * bd_nvme_namespace_info_copy (BDNVMENamespaceInfo *info) { ++ BDNVMENamespaceInfo *new_info; ++ BDNVMELBAFormat **lba_formats; ++ GPtrArray *ptr_array; ++ ++ if (info == NULL) ++ return NULL; ++ ++ new_info = g_new0 (BDNVMENamespaceInfo, 1); ++ memcpy (new_info, info, sizeof (BDNVMENamespaceInfo)); ++ new_info->eui64 = g_strdup (info->eui64); ++ new_info->uuid = g_strdup (info->uuid); ++ new_info->nguid = g_strdup (info->nguid); ++ ++ ptr_array = g_ptr_array_new (); ++ for (lba_formats = info->lba_formats; lba_formats && *lba_formats; lba_formats++) ++ g_ptr_array_add (ptr_array, bd_nvme_lba_format_copy (*lba_formats)); ++ g_ptr_array_add (ptr_array, NULL); ++ new_info->lba_formats = (BDNVMELBAFormat **) g_ptr_array_free (ptr_array, FALSE); ++ ++ return new_info; ++} ++ ++/** ++ * bd_nvme_smart_log_free: (skip) ++ * @log: (nullable): %BDNVMESmartLog to free ++ * ++ * Frees @log. ++ */ ++void bd_nvme_smart_log_free (BDNVMESmartLog *log) { ++ g_free (log); ++} ++ ++/** ++ * bd_nvme_smart_log_copy: (skip) ++ * @log: (nullable): %BDNVMESmartLog to copy ++ * ++ * Creates a new copy of @log. ++ */ ++BDNVMESmartLog * bd_nvme_smart_log_copy (BDNVMESmartLog *log) { ++ BDNVMESmartLog *new_log; ++ ++ if (log == NULL) ++ return NULL; ++ ++ new_log = g_new0 (BDNVMESmartLog, 1); ++ memcpy (new_log, log, sizeof (BDNVMESmartLog)); ++ ++ return new_log; ++} ++ ++/** ++ * bd_nvme_error_log_entry_free: (skip) ++ * @entry: (nullable): %BDNVMEErrorLogEntry to free ++ * ++ * Frees @entry. ++ */ ++void bd_nvme_error_log_entry_free (BDNVMEErrorLogEntry *entry) { ++ if (entry == NULL) ++ return; ++ ++ if (entry->command_error) ++ g_error_free (entry->command_error); ++ g_free (entry); ++} ++ ++/** ++ * bd_nvme_error_log_entry_copy: (skip) ++ * @entry: (nullable): %BDNVMEErrorLogEntry to copy ++ * ++ * Creates a new copy of @entry. ++ */ ++BDNVMEErrorLogEntry * bd_nvme_error_log_entry_copy (BDNVMEErrorLogEntry *entry) { ++ BDNVMEErrorLogEntry *new_entry; ++ ++ if (entry == NULL) ++ return NULL; ++ ++ new_entry = g_new0 (BDNVMEErrorLogEntry, 1); ++ memcpy (new_entry, entry, sizeof (BDNVMEErrorLogEntry)); ++ if (entry->command_error) ++ new_entry->command_error = g_error_copy (entry->command_error); ++ ++ return new_entry; ++} ++ ++/** ++ * bd_nvme_self_test_log_entry_free: (skip) ++ * @entry: (nullable): %BDNVMESelfTestLogEntry to free ++ * ++ * Frees @entry. ++ */ ++void bd_nvme_self_test_log_entry_free (BDNVMESelfTestLogEntry *entry) { ++ if (entry == NULL) ++ return; ++ ++ if (entry->status_code_error) ++ g_error_free (entry->status_code_error); ++ g_free (entry); ++} ++ ++/** ++ * bd_nvme_self_test_log_entry_copy: (skip) ++ * @entry: (nullable): %BDNVMESelfTestLogEntry to copy ++ * ++ * Creates a new copy of @entry. ++ */ ++BDNVMESelfTestLogEntry * bd_nvme_self_test_log_entry_copy (BDNVMESelfTestLogEntry *entry) { ++ BDNVMESelfTestLogEntry *new_entry; ++ ++ if (entry == NULL) ++ return NULL; ++ ++ new_entry = g_new0 (BDNVMESelfTestLogEntry, 1); ++ memcpy (new_entry, entry, sizeof (BDNVMESelfTestLogEntry)); ++ if (entry->status_code_error) ++ new_entry->status_code_error = g_error_copy (entry->status_code_error); ++ ++ return new_entry; ++} ++ ++/** ++ * bd_nvme_self_test_result_to_string: ++ * @result: A %BDNVMESelfTestResult. ++ * @error: (out) (optional): place to store error (if any) ++ * ++ * Returns: (transfer none): A string representation of @result for use as an identifier string ++ * or %NULL when the code is unknown. ++ */ ++const gchar * bd_nvme_self_test_result_to_string (BDNVMESelfTestResult result, GError **error) { ++ static const gchar * const str[] = { ++ [BD_NVME_SELF_TEST_RESULT_NO_ERROR] = "success", ++ [BD_NVME_SELF_TEST_RESULT_ABORTED] = "aborted", ++ [BD_NVME_SELF_TEST_RESULT_CTRL_RESET] = "ctrl_reset", ++ [BD_NVME_SELF_TEST_RESULT_NS_REMOVED] = "ns_removed", ++ [BD_NVME_SELF_TEST_RESULT_ABORTED_FORMAT] = "aborted_format", ++ [BD_NVME_SELF_TEST_RESULT_FATAL_ERROR] = "fatal_error", ++ [BD_NVME_SELF_TEST_RESULT_UNKNOWN_SEG_FAIL] = "unknown_seg_fail", ++ [BD_NVME_SELF_TEST_RESULT_KNOWN_SEG_FAIL] = "known_seg_fail", ++ [BD_NVME_SELF_TEST_RESULT_ABORTED_UNKNOWN] = "aborted_unknown", ++ [BD_NVME_SELF_TEST_RESULT_ABORTED_SANITIZE] = "aborted_sanitize" ++ }; ++ ++ if (result >= G_N_ELEMENTS (str)) { ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_INVALID_ARGUMENT, ++ "Invalid result code %d", result); ++ return NULL; ++ } ++ ++ return str[result]; ++} ++ ++/** ++ * bd_nvme_self_test_log_free: (skip) ++ * @log: (nullable): %BDNVMESelfTestLog to free ++ * ++ * Frees @log. ++ */ ++void bd_nvme_self_test_log_free (BDNVMESelfTestLog *log) { ++ BDNVMESelfTestLogEntry **entries; ++ ++ if (log == NULL) ++ return; ++ ++ for (entries = log->entries; entries && *entries; entries++) ++ bd_nvme_self_test_log_entry_free (*entries); ++ g_free (log->entries); ++ g_free (log); ++} ++ ++/** ++ * bd_nvme_self_test_log_copy: (skip) ++ * @log: (nullable): %BDNVMESelfTestLog to copy ++ * ++ * Creates a new copy of @log. ++ */ ++BDNVMESelfTestLog * bd_nvme_self_test_log_copy (BDNVMESelfTestLog *log) { ++ BDNVMESelfTestLog *new_log; ++ BDNVMESelfTestLogEntry **entries; ++ GPtrArray *ptr_array; ++ ++ if (log == NULL) ++ return NULL; ++ ++ new_log = g_new0 (BDNVMESelfTestLog, 1); ++ memcpy (new_log, log, sizeof (BDNVMESelfTestLog)); ++ ++ ptr_array = g_ptr_array_new (); ++ for (entries = log->entries; entries && *entries; entries++) ++ g_ptr_array_add (ptr_array, bd_nvme_self_test_log_entry_copy (*entries)); ++ g_ptr_array_add (ptr_array, NULL); ++ new_log->entries = (BDNVMESelfTestLogEntry **) g_ptr_array_free (ptr_array, FALSE); ++ ++ return new_log; ++} ++ ++ ++/** ++ * bd_nvme_sanitize_log_free: (skip) ++ * @log: (nullable): %BDNVMESanitizeLog to free ++ * ++ * Frees @log. ++ */ ++void bd_nvme_sanitize_log_free (BDNVMESanitizeLog *log) { ++ if (log == NULL) ++ return; ++ ++ g_free (log); ++} ++ ++/** ++ * bd_nvme_sanitize_log_copy: (skip) ++ * @log: (nullable): %BDNVMESanitizeLog to copy ++ * ++ * Creates a new copy of @log. ++ */ ++BDNVMESanitizeLog * bd_nvme_sanitize_log_copy (BDNVMESanitizeLog *log) { ++ BDNVMESanitizeLog *new_log; ++ ++ if (log == NULL) ++ return NULL; ++ ++ new_log = g_new0 (BDNVMESanitizeLog, 1); ++ memcpy (new_log, log, sizeof (BDNVMESanitizeLog)); ++ ++ return new_log; ++} ++ ++ ++static guint64 int128_to_guint64 (__u8 *data) ++{ ++ int i; ++ guint64 result = 0; ++ ++ /* FIXME: would overflow, need to find 128-bit int */ ++ for (i = 0; i < 16; i++) { ++ result *= 256; ++ result += data[15 - i]; ++ } ++ return result; ++} ++ ++gint _open_dev (const gchar *device, GError **error) { ++ int fd; ++ ++ fd = open (device, O_RDONLY); ++ if (fd < 0) { ++ _nvme_status_to_error (-1, FALSE, error); ++ g_prefix_error (error, "Failed to open device '%s': ", device); ++ return -1; ++ } ++ ++ return fd; ++} ++ ++static gchar *decode_nvme_rev (guint32 ver) { ++ guint16 mjr; ++ guint8 mnr, ter = 0; ++ ++ mjr = ver >> 16; ++ mnr = (ver >> 8) & 0xFF; ++ /* 'ter' is only valid for >= 1.2.1 */ ++ if (mjr >= 2 || mnr >= 2) ++ ter = ver & 0xFF; ++ ++ if (ter == 0) ++ return g_strdup_printf ("%u.%u", mjr, mnr); ++ else ++ return g_strdup_printf ("%u.%u.%u", mjr, mnr, ter); ++} ++ ++/** ++ * bd_nvme_get_controller_info: ++ * @device: a NVMe controller device (e.g. `/dev/nvme0`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves information about the NVMe controller (the Identify Controller command) ++ * as specified by the @device block device path. ++ * ++ * Returns: (transfer full): information about given controller or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMEControllerInfo * bd_nvme_get_controller_info (const gchar *device, GError **error) { ++ int ret; ++ int fd; ++ struct nvme_id_ctrl ctrl_id = ZERO_INIT; ++ BDNVMEControllerInfo *info; ++ ++ /* open the block device */ ++ fd = _open_dev (device, error); ++ if (fd < 0) ++ return NULL; ++ ++ /* send the NVME_IDENTIFY_CNS_NS + NVME_IDENTIFY_CNS_CTRL ioctl */ ++ ret = nvme_identify_ctrl (fd, &ctrl_id); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "NVMe Identify Controller command error: "); ++ close (fd); ++ return NULL; ++ } ++ close (fd); ++ ++ info = g_new0 (BDNVMEControllerInfo, 1); ++ if ((ctrl_id.cmic & NVME_CTRL_CMIC_MULTI_PORT) == NVME_CTRL_CMIC_MULTI_PORT) ++ info->features |= BD_NVME_CTRL_FEAT_MULTIPORT; ++ if ((ctrl_id.cmic & NVME_CTRL_CMIC_MULTI_CTRL) == NVME_CTRL_CMIC_MULTI_CTRL) ++ info->features |= BD_NVME_CTRL_FEAT_MULTICTRL; ++ if ((ctrl_id.cmic & NVME_CTRL_CMIC_MULTI_SRIOV) == NVME_CTRL_CMIC_MULTI_SRIOV) ++ info->features |= BD_NVME_CTRL_FEAT_SRIOV; ++ if ((ctrl_id.cmic & NVME_CTRL_CMIC_MULTI_ANA_REPORTING) == NVME_CTRL_CMIC_MULTI_ANA_REPORTING) ++ info->features |= BD_NVME_CTRL_FEAT_ANA_REPORTING; ++ if ((ctrl_id.nvmsr & NVME_CTRL_NVMSR_NVMESD) == NVME_CTRL_NVMSR_NVMESD) ++ info->features |= BD_NVME_CTRL_FEAT_STORAGE_DEVICE; ++ if ((ctrl_id.nvmsr & NVME_CTRL_NVMSR_NVMEE) == NVME_CTRL_NVMSR_NVMEE) ++ info->features |= BD_NVME_CTRL_FEAT_ENCLOSURE; ++ if ((ctrl_id.mec & NVME_CTRL_MEC_PCIEME) == NVME_CTRL_MEC_PCIEME) ++ info->features |= BD_NVME_CTRL_FEAT_MGMT_PCIE; ++ if ((ctrl_id.mec & NVME_CTRL_MEC_SMBUSME) == NVME_CTRL_MEC_SMBUSME) ++ info->features |= BD_NVME_CTRL_FEAT_MGMT_SMBUS; ++ info->pci_vendor_id = GUINT16_FROM_LE (ctrl_id.vid); ++ info->pci_subsys_vendor_id = GUINT16_FROM_LE (ctrl_id.ssvid); ++ info->ctrl_id = GUINT16_FROM_LE (ctrl_id.cntlid); ++ /* TODO: decode fguid as 128-bit hex string? */ ++ info->fguid = g_strdup_printf ("%-.*s", (int) sizeof (ctrl_id.fguid), ctrl_id.fguid); ++ g_strstrip (info->fguid); ++ info->model_number = g_strndup (ctrl_id.mn, sizeof (ctrl_id.mn)); ++ g_strstrip (info->model_number); ++ info->serial_number = g_strndup (ctrl_id.sn, sizeof (ctrl_id.sn)); ++ g_strstrip (info->serial_number); ++ info->firmware_ver = g_strndup (ctrl_id.fr, sizeof (ctrl_id.fr)); ++ g_strstrip (info->firmware_ver); ++ info->nvme_ver = decode_nvme_rev (GUINT32_FROM_LE (ctrl_id.ver)); ++ /* TODO: vwci: VPD Write Cycle Information */ ++ if ((ctrl_id.oacs & NVME_CTRL_OACS_FORMAT) == NVME_CTRL_OACS_FORMAT) ++ info->features |= BD_NVME_CTRL_FEAT_FORMAT; ++ if ((ctrl_id.oacs & NVME_CTRL_OACS_NS_MGMT) == NVME_CTRL_OACS_NS_MGMT) ++ info->features |= BD_NVME_CTRL_FEAT_NS_MGMT; ++ if ((ctrl_id.oacs & NVME_CTRL_OACS_SELF_TEST) == NVME_CTRL_OACS_SELF_TEST) ++ info->features |= BD_NVME_CTRL_FEAT_SELFTEST; ++ switch (ctrl_id.cntrltype) { ++ case NVME_CTRL_CNTRLTYPE_IO: ++ info->controller_type = BD_NVME_CTRL_TYPE_IO; ++ break; ++ case NVME_CTRL_CNTRLTYPE_DISCOVERY: ++ info->controller_type = BD_NVME_CTRL_TYPE_DISCOVERY; ++ break; ++ case NVME_CTRL_CNTRLTYPE_ADMIN: ++ info->controller_type = BD_NVME_CTRL_TYPE_ADMIN; ++ break; ++ default: ++ info->controller_type = BD_NVME_CTRL_TYPE_UNKNOWN; ++ } ++ info->hmb_pref_size = GUINT32_FROM_LE (ctrl_id.hmpre) * 4096LL; ++ info->hmb_min_size = GUINT32_FROM_LE (ctrl_id.hmmin) * 4096LL; ++ info->size_total = int128_to_guint64 (ctrl_id.tnvmcap); ++ info->size_unalloc = int128_to_guint64 (ctrl_id.unvmcap); ++ info->selftest_ext_time = GUINT16_FROM_LE (ctrl_id.edstt); ++ /* TODO: lpa: Log Page Attributes - NVME_CTRL_LPA_PERSETENT_EVENT: Persistent Event log */ ++ if ((ctrl_id.dsto & NVME_CTRL_DSTO_ONE_DST) == NVME_CTRL_DSTO_ONE_DST) ++ info->features |= BD_NVME_CTRL_FEAT_SELFTEST_SINGLE; ++ if ((ctrl_id.sanicap & NVME_CTRL_SANICAP_CES) == NVME_CTRL_SANICAP_CES) ++ info->features |= BD_NVME_CTRL_FEAT_SANITIZE_CRYPTO; ++ if ((ctrl_id.sanicap & NVME_CTRL_SANICAP_BES) == NVME_CTRL_SANICAP_BES) ++ info->features |= BD_NVME_CTRL_FEAT_SANITIZE_BLOCK; ++ if ((ctrl_id.sanicap & NVME_CTRL_SANICAP_OWS) == NVME_CTRL_SANICAP_OWS) ++ info->features |= BD_NVME_CTRL_FEAT_SANITIZE_OVERWRITE; ++ /* struct nvme_id_ctrl.nn: If the &struct nvme_id_ctrl.mnan field is cleared to 0h, ++ * then the struct nvme_id_ctrl.nn field also indicates the maximum number of namespaces ++ * supported by the NVM subsystem. ++ */ ++ info->num_namespaces = GUINT32_FROM_LE (ctrl_id.mnan) == 0 ? GUINT32_FROM_LE (ctrl_id.nn) : GUINT32_FROM_LE (ctrl_id.mnan); ++ if ((ctrl_id.fna & NVME_CTRL_FNA_FMT_ALL_NAMESPACES) == NVME_CTRL_FNA_FMT_ALL_NAMESPACES) ++ info->features |= BD_NVME_CTRL_FEAT_FORMAT_ALL_NS; ++ if ((ctrl_id.fna & NVME_CTRL_FNA_SEC_ALL_NAMESPACES) == NVME_CTRL_FNA_SEC_ALL_NAMESPACES) ++ info->features |= BD_NVME_CTRL_FEAT_SECURE_ERASE_ALL_NS; ++ if ((ctrl_id.fna & NVME_CTRL_FNA_CRYPTO_ERASE) == NVME_CTRL_FNA_CRYPTO_ERASE) ++ info->features |= BD_NVME_CTRL_FEAT_SECURE_ERASE_CRYPTO; ++ /* TODO: enum nvme_id_ctrl_oncs: NVME_CTRL_ONCS_WRITE_UNCORRECTABLE, NVME_CTRL_ONCS_WRITE_ZEROES... */ ++ /* TODO: nwpc: Namespace Write Protection Capabilities */ ++ info->subsysnqn = g_strndup (ctrl_id.subnqn, sizeof (ctrl_id.subnqn)); ++ g_strstrip (info->subsysnqn); ++ ++ return info; ++} ++ ++ ++/** ++ * bd_nvme_get_namespace_info: ++ * @device: a NVMe namespace device (e.g. `/dev/nvme0n1`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves information about the NVMe namespace (the Identify Namespace command) ++ * as specified by the @device block device path. ++ * ++ * Returns: (transfer full): information about given namespace or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **error) { ++ int ret; ++ int ret_desc; ++ int fd; ++ __u32 nsid = 0; ++ struct nvme_id_ns ns_info = ZERO_INIT; ++ uint8_t desc[NVME_IDENTIFY_DATA_SIZE] = ZERO_INIT; ++ guint8 flbas; ++ guint i; ++ guint len; ++ BDNVMENamespaceInfo *info; ++ GPtrArray *ptr_array; ++ ++ /* open the block device */ ++ fd = _open_dev (device, error); ++ if (fd < 0) ++ return NULL; ++ ++ /* get Namespace Identifier (NSID) for the @device (NVME_IOCTL_ID) */ ++ ret = nvme_get_nsid (fd, &nsid); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "Error getting Namespace Identifier (NSID): "); ++ close (fd); ++ return NULL; ++ } ++ ++ /* send the NVME_IDENTIFY_CNS_NS ioctl */ ++ ret_desc = nvme_identify_ns_descs (fd, nsid, (struct nvme_ns_id_desc *) &desc); ++ ret = nvme_identify_ns (fd, nsid, &ns_info); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "NVMe Identify Namespace command error: "); ++ close (fd); ++ return NULL; ++ } ++ close (fd); ++ ++ info = g_new0 (BDNVMENamespaceInfo, 1); ++ info->nsid = nsid; ++ info->nsize = GUINT64_FROM_LE (ns_info.nsze); ++ info->ncap = GUINT64_FROM_LE (ns_info.ncap); ++ info->nuse = GUINT64_FROM_LE (ns_info.nuse); ++ if ((ns_info.nsfeat & NVME_NS_FEAT_THIN) == NVME_NS_FEAT_THIN) ++ info->features |= BD_NVME_NS_FEAT_THIN; ++ if ((ns_info.nmic & NVME_NS_NMIC_SHARED) == NVME_NS_NMIC_SHARED) ++ info->features |= BD_NVME_NS_FEAT_MULTIPATH_SHARED; ++ if ((ns_info.fpi & NVME_NS_FPI_SUPPORTED) == NVME_NS_FPI_SUPPORTED) ++ info->features |= BD_NVME_NS_FEAT_FORMAT_PROGRESS; ++ info->format_progress_remaining = ns_info.fpi & NVME_NS_FPI_REMAINING; ++ /* TODO: what the ns_info.nvmcap really stands for? */ ++ info->write_protected = (ns_info.nsattr & NVME_NS_NSATTR_WRITE_PROTECTED) == NVME_NS_NSATTR_WRITE_PROTECTED; ++ info->nguid = g_malloc0 (sizeof (ns_info.nguid) * 2 + 1); ++ for (i = 0; i < G_N_ELEMENTS (ns_info.nguid); i++) ++ snprintf (info->nguid + i * 2, 3, "%02x", ns_info.nguid[i]); ++ info->eui64 = g_malloc0 (sizeof (ns_info.eui64) * 2 + 1); ++ for (i = 0; i < G_N_ELEMENTS (ns_info.eui64); i++) ++ snprintf (info->eui64 + i * 2, 3, "%02x", ns_info.eui64[i]); ++ if (ret_desc == 0) { ++ for (i = 0; i < NVME_IDENTIFY_DATA_SIZE; i += len) { ++ struct nvme_ns_id_desc *d = (void *) desc + i; ++ gchar uuid_buf[37] = ZERO_INIT; ++ ++ if (!d->nidl) ++ break; ++ len = d->nidl + sizeof (*d); ++ ++ switch (d->nidt) { ++ case NVME_NIDT_EUI64: ++ case NVME_NIDT_NGUID: ++ /* already have these from nvme_identify_ns() */ ++ break; ++ case NVME_NIDT_UUID: ++ uuid_unparse (d->nid, uuid_buf); ++ info->uuid = g_strdup (uuid_buf); ++ break; ++ case NVME_NIDT_CSI: ++ /* unused */ ++ break; ++ } ++ } ++ } ++ ++ /* translate the LBA Format array */ ++ ptr_array = g_ptr_array_new (); ++ nvme_id_ns_flbas_to_lbaf_inuse (ns_info.flbas, &flbas); ++ for (i = 0; i <= ns_info.nlbaf + ns_info.nulbaf; i++) { ++ BDNVMELBAFormat *lbaf = g_new0 (BDNVMELBAFormat, 1); ++ lbaf->data_size = 1 << ns_info.lbaf[i].ds; ++ lbaf->metadata_size = GUINT16_FROM_LE (ns_info.lbaf[i].ms); ++ lbaf->relative_performance = ns_info.lbaf[i].rp + 1; ++ g_ptr_array_add (ptr_array, lbaf); ++ if (i == flbas) { ++ info->current_lba_format.data_size = lbaf->data_size; ++ info->current_lba_format.metadata_size = lbaf->metadata_size; ++ info->current_lba_format.relative_performance = lbaf->relative_performance; ++ } ++ } ++ g_ptr_array_add (ptr_array, NULL); /* trailing NULL element */ ++ info->lba_formats = (BDNVMELBAFormat **) g_ptr_array_free (ptr_array, FALSE); ++ ++ return info; ++} ++ ++ ++/** ++ * bd_nvme_get_smart_log: ++ * @device: a NVMe controller device (e.g. `/dev/nvme0`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves drive SMART and general health information (Log Identifier `02h`). ++ * The information provided is over the life of the controller and is retained across power cycles. ++ * ++ * Returns: (transfer full): health log data or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMESmartLog * bd_nvme_get_smart_log (const gchar *device, GError **error) { ++ int ret; ++ int ret_identify; ++ int fd; ++ struct nvme_id_ctrl ctrl_id = ZERO_INIT; ++ struct nvme_smart_log smart_log = ZERO_INIT; ++ BDNVMESmartLog *log; ++ guint i; ++ ++ /* open the block device */ ++ fd = _open_dev (device, error); ++ if (fd < 0) ++ return NULL; ++ ++ /* send the NVME_IDENTIFY_CNS_NS + NVME_IDENTIFY_CNS_CTRL ioctl */ ++ ret_identify = nvme_identify_ctrl (fd, &ctrl_id); ++ if (ret_identify != 0) { ++ _nvme_status_to_error (ret_identify, FALSE, error); ++ g_prefix_error (error, "NVMe Identify Controller command error: "); ++ close (fd); ++ return NULL; ++ } ++ ++ /* send the NVME_LOG_LID_SMART ioctl */ ++ ret = nvme_get_log_smart (fd, NVME_NSID_ALL, FALSE /* rae */, &smart_log); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "NVMe Get Log Page - SMART / Health Information Log command error: "); ++ close (fd); ++ return NULL; ++ } ++ close (fd); ++ ++ log = g_new0 (BDNVMESmartLog, 1); ++ if ((smart_log.critical_warning & NVME_SMART_CRIT_SPARE) == NVME_SMART_CRIT_SPARE) ++ log->critical_warning |= BD_NVME_SMART_CRITICAL_WARNING_SPARE; ++ if ((smart_log.critical_warning & NVME_SMART_CRIT_TEMPERATURE) == NVME_SMART_CRIT_TEMPERATURE) ++ log->critical_warning |= BD_NVME_SMART_CRITICAL_WARNING_TEMPERATURE; ++ if ((smart_log.critical_warning & NVME_SMART_CRIT_DEGRADED) == NVME_SMART_CRIT_DEGRADED) ++ log->critical_warning |= BD_NVME_SMART_CRITICAL_WARNING_DEGRADED; ++ if ((smart_log.critical_warning & NVME_SMART_CRIT_MEDIA) == NVME_SMART_CRIT_MEDIA) ++ log->critical_warning |= BD_NVME_SMART_CRITICAL_WARNING_READONLY; ++ if ((smart_log.critical_warning & NVME_SMART_CRIT_VOLATILE_MEMORY) == NVME_SMART_CRIT_VOLATILE_MEMORY) ++ log->critical_warning |= BD_NVME_SMART_CRITICAL_WARNING_VOLATILE_MEM; ++ if ((smart_log.critical_warning & NVME_SMART_CRIT_PMR_RO) == NVME_SMART_CRIT_PMR_RO) ++ log->critical_warning |= BD_NVME_SMART_CRITICAL_WARNING_PMR_READONLY; ++ log->avail_spare = smart_log.avail_spare; ++ log->spare_thresh = smart_log.spare_thresh; ++ log->percent_used = smart_log.percent_used; ++ log->total_data_read = int128_to_guint64 (smart_log.data_units_read) * 1000 * 512; ++ log->total_data_written = int128_to_guint64 (smart_log.data_units_written) * 1000 * 512; ++ log->ctrl_busy_time = int128_to_guint64 (smart_log.ctrl_busy_time); ++ log->power_cycles = int128_to_guint64 (smart_log.power_cycles); ++ log->power_on_hours = int128_to_guint64 (smart_log.power_on_hours); ++ log->unsafe_shutdowns = int128_to_guint64 (smart_log.unsafe_shutdowns); ++ log->media_errors = int128_to_guint64 (smart_log.media_errors); ++ log->num_err_log_entries = int128_to_guint64 (smart_log.num_err_log_entries); ++ ++ log->temperature = (smart_log.temperature[1] << 8) | smart_log.temperature[0]; ++ for (i = 0; i < G_N_ELEMENTS (smart_log.temp_sensor); i++) ++ log->temp_sensors[i] = GUINT16_FROM_LE (smart_log.temp_sensor[i]); ++ log->warning_temp_time = GUINT32_FROM_LE (smart_log.warning_temp_time); ++ log->critical_temp_time = GUINT32_FROM_LE (smart_log.critical_comp_time); ++ ++ if (ret_identify == 0) { ++ log->wctemp = GUINT16_FROM_LE (ctrl_id.wctemp); ++ log->cctemp = GUINT16_FROM_LE (ctrl_id.cctemp); ++ } ++ ++ /* FIXME: intentionally not providing Host Controlled Thermal Management attributes ++ * at the moment (an optional NVMe feature), along with intentionally not providing ++ * Power State attributes. Subject to re-evaluation in the future. ++ */ ++ ++ return log; ++} ++ ++ ++/** ++ * bd_nvme_get_error_log_entries: ++ * @device: a NVMe controller device (e.g. `/dev/nvme0`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves Error Information Log (Log Identifier `01h`) entries, used to describe ++ * extended error information for a command that completed with error or to report ++ * an error that is not specific to a particular command. This log is global to the ++ * controller. The ordering of the entries is based on the time when the error ++ * occurred, with the most recent error being returned as the first log entry. ++ * As the number of entries is typically limited by the drive implementation, only ++ * most recent entries are provided. ++ * ++ * Returns: (transfer full) (array zero-terminated=1): null-terminated list ++ * of error entries or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMEErrorLogEntry ** bd_nvme_get_error_log_entries (const gchar *device, GError **error) { ++ int ret; ++ int fd; ++ guint elpe; ++ struct nvme_id_ctrl ctrl_id = ZERO_INIT; ++ struct nvme_error_log_page *err_log; ++ GPtrArray *ptr_array; ++ guint i; ++ ++ /* open the block device */ ++ fd = _open_dev (device, error); ++ if (fd < 0) ++ return NULL; ++ ++ /* find out the maximum number of error log entries as reported by the controller */ ++ ret = nvme_identify_ctrl (fd, &ctrl_id); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "NVMe Identify Controller command error: "); ++ close (fd); ++ return NULL; ++ } ++ ++ /* send the NVME_LOG_LID_ERROR ioctl */ ++ elpe = ctrl_id.elpe + 1; ++ err_log = g_new0 (struct nvme_error_log_page, elpe); ++ ret = nvme_get_log_error (fd, elpe, FALSE /* rae */, err_log); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "NVMe Get Log Page - Error Information Log Entry command error: "); ++ g_free (err_log); ++ close (fd); ++ return NULL; ++ } ++ close (fd); ++ ++ /* parse the log */ ++ ptr_array = g_ptr_array_new (); ++ for (i = 0; i < elpe; i++) { ++ if (GUINT64_FROM_LE (err_log[i].error_count) > 0) { ++ BDNVMEErrorLogEntry *entry; ++ ++ entry = g_new0 (BDNVMEErrorLogEntry, 1); ++ entry->error_count = GUINT64_FROM_LE (err_log[i].error_count); ++ entry->command_id = err_log[i].cmdid; ++ entry->command_specific = GUINT64_FROM_LE (err_log[i].cs); ++ entry->command_status = GUINT16_FROM_LE (err_log[i].status_field) >> 1; ++ _nvme_status_to_error (GUINT16_FROM_LE (err_log[i].status_field) >> 1, FALSE, &entry->command_error); ++ entry->lba = GUINT64_FROM_LE (err_log[i].lba); ++ entry->nsid = err_log[i].nsid; ++ entry->transport_type = err_log[i].trtype; ++ /* not providing Transport Type Specific Information here on purpose */ ++ ++ g_ptr_array_add (ptr_array, entry); ++ } ++ } ++ g_ptr_array_add (ptr_array, NULL); /* trailing NULL element */ ++ g_free (err_log); ++ ++ return (BDNVMEErrorLogEntry **) g_ptr_array_free (ptr_array, FALSE); ++} ++ ++ ++/** ++ * bd_nvme_get_self_test_log: ++ * @device: a NVMe controller device (e.g. `/dev/nvme0`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves drive self-test log (Log Identifier `06h`). Provides the status of a self-test operation ++ * in progress and the percentage complete of that operation, along with the results of the last ++ * 20 device self-test operations. ++ * ++ * Returns: (transfer full): self-test log data or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMESelfTestLog * bd_nvme_get_self_test_log (const gchar *device, GError **error) { ++ int ret; ++ int fd; ++ struct nvme_self_test_log self_test_log = ZERO_INIT; ++ BDNVMESelfTestLog *log; ++ GPtrArray *ptr_array; ++ guint i; ++ ++ /* open the block device */ ++ fd = _open_dev (device, error); ++ if (fd < 0) ++ return NULL; ++ ++ /* send the NVME_LOG_LID_DEVICE_SELF_TEST ioctl */ ++ ret = nvme_get_log_device_self_test (fd, &self_test_log); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "NVMe Get Log Page - Device Self-test Log command error: "); ++ close (fd); ++ return NULL; ++ } ++ close (fd); ++ ++ log = g_new0 (BDNVMESelfTestLog, 1); ++ switch (self_test_log.current_operation & NVME_ST_CURR_OP_MASK) { ++ case NVME_ST_CURR_OP_NOT_RUNNING: ++ log->current_operation = BD_NVME_SELF_TEST_ACTION_NOT_RUNNING; ++ break; ++ case NVME_ST_CURR_OP_SHORT: ++ log->current_operation = BD_NVME_SELF_TEST_ACTION_SHORT; ++ break; ++ case NVME_ST_CURR_OP_EXTENDED: ++ log->current_operation = BD_NVME_SELF_TEST_ACTION_EXTENDED; ++ break; ++ case NVME_ST_CURR_OP_VS: ++ case NVME_ST_CURR_OP_RESERVED: ++ default: ++ log->current_operation = BD_NVME_SELF_TEST_ACTION_VENDOR_SPECIFIC; ++ } ++ if ((self_test_log.current_operation & NVME_ST_CURR_OP_MASK) > 0) ++ log->current_operation_completion = self_test_log.completion & NVME_ST_CURR_OP_CMPL_MASK; ++ ++ ptr_array = g_ptr_array_new (); ++ for (i = 0; i < NVME_LOG_ST_MAX_RESULTS; i++) { ++ BDNVMESelfTestLogEntry *entry; ++ guint8 dsts; ++ guint8 code; ++ ++ dsts = self_test_log.result[i].dsts & NVME_ST_RESULT_MASK; ++ code = self_test_log.result[i].dsts >> NVME_ST_CODE_SHIFT; ++ if (dsts == NVME_ST_RESULT_NOT_USED) ++ continue; ++ ++ entry = g_new0 (BDNVMESelfTestLogEntry, 1); ++ switch (dsts) { ++ case NVME_ST_RESULT_NO_ERR: ++ entry->result = BD_NVME_SELF_TEST_RESULT_NO_ERROR; ++ break; ++ case NVME_ST_RESULT_ABORTED: ++ entry->result = BD_NVME_SELF_TEST_RESULT_ABORTED; ++ break; ++ case NVME_ST_RESULT_CLR: ++ entry->result = BD_NVME_SELF_TEST_RESULT_CTRL_RESET; ++ break; ++ case NVME_ST_RESULT_NS_REMOVED: ++ entry->result = BD_NVME_SELF_TEST_RESULT_NS_REMOVED; ++ break; ++ case NVME_ST_RESULT_ABORTED_FORMAT: ++ entry->result = BD_NVME_SELF_TEST_RESULT_ABORTED_FORMAT; ++ break; ++ case NVME_ST_RESULT_FATAL_ERR: ++ entry->result = BD_NVME_SELF_TEST_RESULT_FATAL_ERROR; ++ break; ++ case NVME_ST_RESULT_UNKNOWN_SEG_FAIL: ++ entry->result = BD_NVME_SELF_TEST_RESULT_UNKNOWN_SEG_FAIL; ++ break; ++ case NVME_ST_RESULT_KNOWN_SEG_FAIL: ++ entry->result = BD_NVME_SELF_TEST_RESULT_KNOWN_SEG_FAIL; ++ break; ++ case NVME_ST_RESULT_ABORTED_UNKNOWN: ++ entry->result = BD_NVME_SELF_TEST_RESULT_ABORTED_UNKNOWN; ++ break; ++ case NVME_ST_RESULT_ABORTED_SANITIZE: ++ entry->result = BD_NVME_SELF_TEST_RESULT_ABORTED_SANITIZE; ++ break; ++ default: ++ g_warning ("Unhandled self-test log entry result code: %d", dsts); ++ g_free (entry); ++ continue; ++ } ++ switch (code) { ++ case NVME_ST_CODE_SHORT: ++ entry->action = BD_NVME_SELF_TEST_ACTION_SHORT; ++ break; ++ case NVME_ST_CODE_EXTENDED: ++ entry->action = BD_NVME_SELF_TEST_ACTION_EXTENDED; ++ break; ++ case NVME_ST_CODE_VS: ++ case NVME_ST_CODE_RESERVED: ++ entry->action = BD_NVME_SELF_TEST_ACTION_VENDOR_SPECIFIC; ++ break; ++ default: ++ g_warning ("Unhandled self-test log entry action code: %d", code); ++ entry->action = BD_NVME_SELF_TEST_ACTION_VENDOR_SPECIFIC; ++ } ++ entry->segment = self_test_log.result[i].seg; ++ entry->power_on_hours = GUINT64_FROM_LE (self_test_log.result[i].poh); ++ if (self_test_log.result[i].vdi & NVME_ST_VALID_DIAG_INFO_NSID) ++ entry->nsid = GUINT32_FROM_LE (self_test_log.result[i].nsid); ++ if (self_test_log.result[i].vdi & NVME_ST_VALID_DIAG_INFO_FLBA) ++ entry->failing_lba = GUINT64_FROM_LE (self_test_log.result[i].flba); ++ if ((self_test_log.result[i].vdi & NVME_ST_VALID_DIAG_INFO_SC) && ++ (self_test_log.result[i].vdi & NVME_ST_VALID_DIAG_INFO_SCT)) ++ _nvme_status_to_error ((self_test_log.result[i].sct & 7) << 8 | self_test_log.result[i].sc, ++ FALSE, &entry->status_code_error); ++ ++ g_ptr_array_add (ptr_array, entry); ++ } ++ g_ptr_array_add (ptr_array, NULL); ++ log->entries = (BDNVMESelfTestLogEntry **) g_ptr_array_free (ptr_array, FALSE); ++ ++ return log; ++} ++ ++ ++/** ++ * bd_nvme_get_sanitize_log: ++ * @device: a NVMe controller device (e.g. `/dev/nvme0`) ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Retrieves the drive sanitize status log (Log Identifier `81h`) that includes information ++ * about the most recent sanitize operation and the sanitize operation time estimates. ++ * ++ * As advised in the NVMe specification whitepaper the host should limit polling ++ * to retrieve progress of a running sanitize operations (e.g. to at most once every ++ * several minutes) to avoid interfering with the progress of the sanitize operation itself. ++ * ++ * Returns: (transfer full): sanitize log data or %NULL in case of an error (with @error set). ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO ++ */ ++BDNVMESanitizeLog * bd_nvme_get_sanitize_log (const gchar *device, GError **error) { ++ int ret; ++ int fd; ++ struct nvme_sanitize_log_page sanitize_log = ZERO_INIT; ++ BDNVMESanitizeLog *log; ++ __u16 sstat; ++ ++ /* open the block device */ ++ fd = _open_dev (device, error); ++ if (fd < 0) ++ return NULL; ++ ++ /* send the NVME_LOG_LID_SANITIZE ioctl */ ++ ret = nvme_get_log_sanitize (fd, FALSE /* rae */, &sanitize_log); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "NVMe Get Log Page - Sanitize Status Log command error: "); ++ close (fd); ++ return NULL; ++ } ++ close (fd); ++ ++ sstat = GUINT16_FROM_LE (sanitize_log.sstat); ++ ++ log = g_new0 (BDNVMESanitizeLog, 1); ++ log->sanitize_progress = 0; ++ if ((sstat & NVME_SANITIZE_SSTAT_STATUS_MASK) == NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS) ++ log->sanitize_progress = ((gdouble) GUINT16_FROM_LE (sanitize_log.sprog) * 100) / 0x10000; ++ log->global_data_erased = sstat & NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED; ++ log->overwrite_passes = (sstat >> NVME_SANITIZE_SSTAT_COMPLETED_PASSES_SHIFT) & NVME_SANITIZE_SSTAT_COMPLETED_PASSES_MASK; ++ ++ switch (sstat & NVME_SANITIZE_SSTAT_STATUS_MASK) { ++ case NVME_SANITIZE_SSTAT_STATUS_COMPLETE_SUCCESS: ++ log->sanitize_status = BD_NVME_SANITIZE_STATUS_SUCCESS; ++ break; ++ case NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS: ++ log->sanitize_status = BD_NVME_SANITIZE_STATUS_IN_PROGESS; ++ break; ++ case NVME_SANITIZE_SSTAT_STATUS_COMPLETED_FAILED: ++ log->sanitize_status = BD_NVME_SANITIZE_STATUS_FAILED; ++ break; ++ case NVME_SANITIZE_SSTAT_STATUS_ND_COMPLETE_SUCCESS: ++ log->sanitize_status = BD_NVME_SANITIZE_STATUS_SUCCESS_NO_DEALLOC; ++ break; ++ case NVME_SANITIZE_SSTAT_STATUS_NEVER_SANITIZED: ++ default: ++ log->sanitize_status = BD_NVME_SANITIZE_STATUS_NEVER_SANITIZED; ++ break; ++ } ++ ++ log->time_for_overwrite = (GUINT32_FROM_LE (sanitize_log.eto) == 0xffffffff) ? -1 : (gint64) GUINT32_FROM_LE (sanitize_log.eto); ++ log->time_for_block_erase = (GUINT32_FROM_LE (sanitize_log.etbe) == 0xffffffff) ? -1 : (gint64) GUINT32_FROM_LE (sanitize_log.etbe); ++ log->time_for_crypto_erase = (GUINT32_FROM_LE (sanitize_log.etce) == 0xffffffff) ? -1 : (gint64) GUINT32_FROM_LE (sanitize_log.etce); ++ log->time_for_overwrite_nd = (GUINT32_FROM_LE (sanitize_log.etond) == 0xffffffff) ? -1 : (gint64) GUINT32_FROM_LE (sanitize_log.etond); ++ log->time_for_block_erase_nd = (GUINT32_FROM_LE (sanitize_log.etbend) == 0xffffffff) ? -1 : (gint64) GUINT32_FROM_LE (sanitize_log.etbend); ++ log->time_for_crypto_erase_nd = (GUINT32_FROM_LE (sanitize_log.etcend) == 0xffffffff) ? -1 : (gint64) GUINT32_FROM_LE (sanitize_log.etcend); ++ ++ return log; ++} +diff --git a/src/plugins/nvme/nvme-op.c b/src/plugins/nvme/nvme-op.c +new file mode 100644 +index 00000000..4568c453 +--- /dev/null ++++ b/src/plugins/nvme/nvme-op.c +@@ -0,0 +1,388 @@ ++/* ++ * Copyright (C) 2014-2021 Red Hat, Inc. ++ * ++ * This library is free software; you can redistribute it and/or ++ * modify it under the terms of the GNU Lesser General Public ++ * License as published by the Free Software Foundation; either ++ * version 2.1 of the License, or (at your option) any later version. ++ * ++ * This library is distributed in the hope that it will be useful, ++ * but WITHOUT ANY WARRANTY; without even the implied warranty of ++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ++ * Lesser General Public License for more details. ++ * ++ * You should have received a copy of the GNU Lesser General Public ++ * License along with this library; if not, see . ++ * ++ * Author: Tomas Bzatek ++ */ ++ ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++ ++#include ++#include ++ ++#include ++#include ++#include "nvme.h" ++#include "nvme-private.h" ++ ++ ++/** ++ * bd_nvme_device_self_test: ++ * @device: a NVMe controller or namespace device (e.g. `/dev/nvme0`) ++ * @action: self-test action to take. ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Initiates or aborts the Device Self-test operation on the controller or a namespace, ++ * distinguished by the @device path specified. In case a controller device ++ * is specified then the self-test operation would include all active namespaces. ++ * ++ * To abort a running operation, pass #BD_NVME_SELF_TEST_ACTION_ABORT as @action. ++ * To retrieve progress of a current running operation, check the self-test log using ++ * bd_nvme_get_self_test_log(). ++ * ++ * Returns: %TRUE if the device self-test command was issued successfully, ++ * %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_MANAGE ++ */ ++gboolean bd_nvme_device_self_test (const gchar *device, BDNVMESelfTestAction action, GError **error) { ++ int ret; ++ struct nvme_dev_self_test_args args = { ++ .args_size = sizeof(args), ++ .result = NULL, ++ .timeout = NVME_DEFAULT_IOCTL_TIMEOUT, ++ .nsid = 0xffffffff, ++ }; ++ ++ switch (action) { ++ case BD_NVME_SELF_TEST_ACTION_SHORT: ++ args.stc = NVME_DST_STC_SHORT; ++ break; ++ case BD_NVME_SELF_TEST_ACTION_EXTENDED: ++ args.stc = NVME_DST_STC_LONG; ++ break; ++ case BD_NVME_SELF_TEST_ACTION_VENDOR_SPECIFIC: ++ args.stc = NVME_DST_STC_VS; ++ break; ++ case BD_NVME_SELF_TEST_ACTION_ABORT: ++ args.stc = NVME_DST_STC_ABORT; ++ break; ++ default: ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_INVALID_ARGUMENT, ++ "Invalid value specified for the self-test action: %d", action); ++ return FALSE; ++ } ++ ++ /* open the block device */ ++ args.fd = _open_dev (device, error); ++ if (args.fd < 0) ++ return FALSE; ++ ++ /* get Namespace Identifier (NSID) for the @device (NVME_IOCTL_ID) */ ++ ret = nvme_get_nsid (args.fd, &args.nsid); ++ if (ret < 0 && errno == ENOTTY) ++ /* not a block device, assuming controller character device */ ++ args.nsid = 0xffffffff; ++ else if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "Error getting Namespace Identifier (NSID): "); ++ close (args.fd); ++ return FALSE; ++ } ++ ++ ret = nvme_dev_self_test (&args); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "NVMe Device Self-test command error: "); ++ close (args.fd); ++ return FALSE; ++ } ++ close (args.fd); ++ ++ return TRUE; ++} ++ ++ ++/* returns 0xff in case of error (the NVMe standard defines total of 16 flba records) */ ++static __u8 find_lbaf_for_size (int fd, __u32 nsid, guint16 lba_data_size, guint16 metadata_size, GError **error) { ++ int ret; ++ struct nvme_id_ns ns_info = ZERO_INIT; ++ __u8 flbas = 0; ++ guint i; ++ ++ /* TODO: find first attached namespace instead of hardcoding NSID = 1 */ ++ ret = nvme_identify_ns (fd, nsid == 0xffffffff ? 1 : nsid, &ns_info); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "NVMe Identify Namespace command error: "); ++ return 0xff; ++ } ++ ++ /* return currently used lbaf */ ++ if (lba_data_size == 0) { ++ nvme_id_ns_flbas_to_lbaf_inuse (ns_info.flbas, &flbas); ++ return flbas; ++ } ++ ++ for (i = 0; i <= ns_info.nlbaf + ns_info.nulbaf; i++) ++ if (1UL << ns_info.lbaf[i].ds == lba_data_size && GUINT16_FROM_LE (ns_info.lbaf[i].ms) == metadata_size) ++ return i; ++ ++ g_set_error_literal (error, BD_NVME_ERROR, BD_NVME_ERROR_INVALID_ARGUMENT, ++ "Couldn't match desired LBA data block size in a device supported LBA format data sizes"); ++ return 0xff; ++} ++ ++/** ++ * bd_nvme_format: ++ * @device: NVMe namespace or controller device to format (e.g. `/dev/nvme0n1`) ++ * @lba_data_size: desired LBA data size (i.e. a sector size) in bytes or `0` to keep current. See #BDNVMELBAFormat and bd_nvme_get_namespace_info(). ++ * @metadata_size: desired metadata size in bytes or `0` for default. See #BDNVMELBAFormat and bd_nvme_get_namespace_info(). ++ * @secure_erase: optional secure erase action to take. ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Performs low level format of the NVM media, destroying all data and metadata for either ++ * a specific namespace or all attached namespaces to the controller. Use this command ++ * to change LBA sector size. Optional secure erase method can be specified as well. ++ * ++ * Supported LBA data sizes for a given namespace can be listed using the bd_nvme_get_namespace_info() ++ * call. In case of a special value `0` the current LBA format for a given namespace will be ++ * retained. When called on a controller device the first namespace is used as a reference. ++ * ++ * Note that the NVMe controller may define a Format NVM attribute indicating that the format ++ * operation would apply to all namespaces and a format (excluding secure erase) of any ++ * namespace results in a format of all namespaces in the NVM subsystem. In such case and ++ * when @device is a namespace block device the #BD_NVME_ERROR_WOULD_FORMAT_ALL_NS error ++ * is returned to prevent further damage. This is then supposed to be handled by the caller ++ * and bd_nvme_format() is supposed to be called on a controller device instead. ++ * ++ * This call blocks until the format operation has finished. To retrieve progress ++ * of a current running operation, check the namespace info using bd_nvme_get_namespace_info(). ++ * ++ * Returns: %TRUE if the format command finished successfully, %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_MANAGE ++ */ ++gboolean bd_nvme_format (const gchar *device, guint16 lba_data_size, guint16 metadata_size, BDNVMEFormatSecureErase secure_erase, GError **error) { ++ int ret; ++ gboolean ctrl_device = FALSE; ++ struct nvme_id_ctrl ctrl_id = ZERO_INIT; ++ struct nvme_format_nvm_args args = { ++ .args_size = sizeof(args), ++ .result = NULL, ++ .timeout = NVME_DEFAULT_IOCTL_TIMEOUT, ++ .nsid = 0xffffffff, ++ .mset = NVME_FORMAT_MSET_SEPARATE /* 0 */, ++ .pi = NVME_FORMAT_PI_DISABLE /* 0 */, ++ .pil = NVME_FORMAT_PIL_LAST /* 0 */, ++ .ses = NVME_FORMAT_SES_NONE, ++ }; ++ ++ /* open the block device */ ++ args.fd = _open_dev (device, error); ++ if (args.fd < 0) ++ return FALSE; ++ ++ ret = nvme_get_nsid (args.fd, &args.nsid); ++ if (ret < 0 && errno == ENOTTY) { ++ /* not a block device, assuming controller character device */ ++ args.nsid = 0xffffffff; ++ ctrl_device = TRUE; ++ } else if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "Error getting Namespace Identifier (NSID): "); ++ close (args.fd); ++ return FALSE; ++ } ++ ++ /* check the FNA controller bit when formatting a single namespace */ ++ if (! ctrl_device) { ++ ret = nvme_identify_ctrl (args.fd, &ctrl_id); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "NVMe Identify Controller command error: "); ++ close (args.fd); ++ return FALSE; ++ } ++ /* from nvme-cli: ++ * FNA bit 0 set to 1: all namespaces ... shall be configured with the same ++ * attributes and a format (excluding secure erase) of any namespace results in a ++ * format of all namespaces. ++ */ ++ if ((ctrl_id.fna & NVME_CTRL_FNA_FMT_ALL_NAMESPACES) == NVME_CTRL_FNA_FMT_ALL_NAMESPACES) { ++ /* tell user that it would format other namespaces and that bd_nvme_format() ++ * should be called on a controller device instead */ ++ g_set_error_literal (error, BD_NVME_ERROR, BD_NVME_ERROR_WOULD_FORMAT_ALL_NS, ++ "The NVMe controller indicates it would format all namespaces."); ++ close (args.fd); ++ return FALSE; ++ } ++ } ++ ++ /* find out the desired LBA data format index */ ++ args.lbaf = find_lbaf_for_size (args.fd, args.nsid, lba_data_size, metadata_size, error); ++ if (args.lbaf == 0xff) { ++ close (args.fd); ++ return FALSE; ++ } ++ ++ switch (secure_erase) { ++ case BD_NVME_FORMAT_SECURE_ERASE_USER_DATA: ++ args.ses = NVME_FORMAT_SES_USER_DATA_ERASE; ++ break; ++ case BD_NVME_FORMAT_SECURE_ERASE_CRYPTO: ++ args.ses = NVME_FORMAT_SES_CRYPTO_ERASE; ++ break; ++ case BD_NVME_FORMAT_SECURE_ERASE_NONE: ++ default: ++ args.ses = NVME_FORMAT_SES_NONE; ++ } ++ ++ ret = nvme_format_nvm (&args); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "Format NVM command error: "); ++ close (args.fd); ++ return FALSE; ++ } ++ ++ /* rescan the namespaces if block size has changed */ ++ if (ctrl_device) { ++ if (ioctl (args.fd, NVME_IOCTL_RESCAN) < 0) { ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_FAILED, ++ "Failed to rescan namespaces after format: %s", strerror_l (errno, _C_LOCALE)); ++ close (args.fd); ++ return FALSE; ++ } ++ } else { ++ if (lba_data_size != 0) { ++ /* from nvme-cli: ++ * If block size has been changed by the format command up there, we should notify it to ++ * kernel blkdev to update its own block size to the given one because blkdev will not ++ * update by itself without re-opening fd. ++ */ ++ int block_size = lba_data_size; ++ ++ if (ioctl (args.fd, BLKBSZSET, &block_size) < 0) { ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_FAILED, ++ "Failed to set block size to %d after format: %s", block_size, strerror_l (errno, _C_LOCALE)); ++ close (args.fd); ++ return FALSE; ++ } ++ ++ if (ioctl (args.fd, BLKRRPART) < 0) { ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_FAILED, ++ "Failed to re-read partition table after format: %s", strerror_l (errno, _C_LOCALE)); ++ close (args.fd); ++ return FALSE; ++ } ++ } ++ } ++ ++ close (args.fd); ++ return TRUE; ++} ++ ++/** ++ * bd_nvme_sanitize: ++ * @device: NVMe namespace or controller device to format (e.g. `/dev/nvme0n1`) ++ * @action: the sanitize action to perform. ++ * @no_dealloc: instruct the controller to not deallocate the affected media area. ++ * @overwrite_pass_count: number of overwrite passes [1-15] or 0 for the default (16 passes). ++ * @overwrite_pattern: a 32-bit pattern used for the Overwrite sanitize operation. ++ * @overwrite_invert_pattern: invert the overwrite pattern between passes. ++ * @error: (out) (nullable): place to store error (if any) ++ * ++ * Starts a sanitize operation or recovers from a previously failed sanitize operation. ++ * By definition, a sanitize operation alters all user data in the NVM subsystem such ++ * that recovery of any previous user data from any cache, the non-volatile media, ++ * or any Controller Memory Buffer is not possible. The scope of a sanitize operation ++ * is all locations in the NVM subsystem that are able to contain user data, including ++ * caches, Persistent Memory Regions, and unallocated or deallocated areas of the media. ++ * ++ * Once started, a sanitize operation is not able to be aborted and continues after ++ * a Controller Level Reset including across power cycles. Once the sanitize operation ++ * has run the media affected may not be immediately ready for use unless additional ++ * media modification mechanism is run. This is often vendor specific and also depends ++ * on the sanitize method (@action) used. Callers to this sanitize operation should ++ * set @no_dealloc to %TRUE for the added convenience. ++ * ++ * The controller also ignores Critical Warning(s) in the SMART / Health Information ++ * log page (e.g., read only mode) and attempts to complete the sanitize operation requested. ++ * ++ * This call returns immediately and the actual sanitize operation is performed ++ * in the background. Use bd_nvme_get_sanitize_log() to retrieve status and progress ++ * of a running sanitize operation. In case a sanitize operation fails the controller ++ * may restrict its operation until a subsequent sanitize operation is started ++ * (i.e. retried) or an #BD_NVME_SANITIZE_ACTION_EXIT_FAILURE action is used ++ * to acknowledge the failure explicitly. ++ * ++ * The @overwrite_pass_count, @overwrite_pattern and @overwrite_invert_pattern ++ * arguments are only valid when @action is #BD_NVME_SANITIZE_ACTION_OVERWRITE. ++ * ++ * The sanitize operation is set to run under the Allow Unrestricted Sanitize Exit ++ * mode. ++ * ++ * Returns: %TRUE if the format command finished successfully, %FALSE otherwise with @error set. ++ * ++ * Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_MANAGE ++ */ ++gboolean bd_nvme_sanitize (const gchar *device, BDNVMESanitizeAction action, gboolean no_dealloc, gint overwrite_pass_count, guint32 overwrite_pattern, gboolean overwrite_invert_pattern, GError **error) { ++ int ret; ++ struct nvme_sanitize_nvm_args args = { ++ .args_size = sizeof(args), ++ .result = NULL, ++ .timeout = NVME_DEFAULT_IOCTL_TIMEOUT, ++ .ause = TRUE, ++ .owpass = overwrite_pass_count, ++ .oipbp = overwrite_invert_pattern, ++ .nodas = no_dealloc, ++ .ovrpat = GUINT32_TO_LE (overwrite_pattern), ++ }; ++ ++ switch (action) { ++ case BD_NVME_SANITIZE_ACTION_EXIT_FAILURE: ++ args.sanact = NVME_SANITIZE_SANACT_EXIT_FAILURE; ++ break; ++ case BD_NVME_SANITIZE_ACTION_BLOCK_ERASE: ++ args.sanact = NVME_SANITIZE_SANACT_START_BLOCK_ERASE; ++ break; ++ case BD_NVME_SANITIZE_ACTION_OVERWRITE: ++ args.sanact = NVME_SANITIZE_SANACT_START_OVERWRITE; ++ break; ++ case BD_NVME_SANITIZE_ACTION_CRYPTO_ERASE: ++ args.sanact = NVME_SANITIZE_SANACT_START_CRYPTO_ERASE; ++ break; ++ default: ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_INVALID_ARGUMENT, ++ "Invalid value specified for the sanitize action: %d", action); ++ return FALSE; ++ } ++ ++ /* open the block device */ ++ args.fd = _open_dev (device, error); ++ if (args.fd < 0) ++ return FALSE; ++ ++ ret = nvme_sanitize_nvm (&args); ++ if (ret != 0) { ++ _nvme_status_to_error (ret, FALSE, error); ++ g_prefix_error (error, "Sanitize command error: "); ++ close (args.fd); ++ return FALSE; ++ } ++ ++ close (args.fd); ++ return TRUE; ++} +diff --git a/src/plugins/nvme/nvme-private.h b/src/plugins/nvme/nvme-private.h +new file mode 100644 +index 00000000..3d4b2a99 +--- /dev/null ++++ b/src/plugins/nvme/nvme-private.h +@@ -0,0 +1,25 @@ ++#include ++#include ++#include ++ ++#ifndef BD_NVME_PRIVATE ++#define BD_NVME_PRIVATE ++ ++/* TODO: move to a common libblockdev header */ ++#ifdef __clang__ ++#define ZERO_INIT {} ++#else ++#define ZERO_INIT {0} ++#endif ++ ++/* "C" locale to get the locale-agnostic error messages */ ++#define _C_LOCALE (locale_t) 0 ++ ++/* nvme-error.c */ ++void _nvme_status_to_error (gint status, gboolean fabrics, GError **error); ++void _nvme_fabrics_errno_to_gerror (int result, int _errno, GError **error); ++ ++/* nvme-info.c */ ++gint _open_dev (const gchar *device, GError **error); ++ ++#endif /* BD_NVME_PRIVATE */ +diff --git a/src/plugins/nvme/nvme.c b/src/plugins/nvme/nvme.c +new file mode 100644 +index 00000000..00f2f76e +--- /dev/null ++++ b/src/plugins/nvme/nvme.c +@@ -0,0 +1,103 @@ ++/* ++ * Copyright (C) 2014-2021 Red Hat, Inc. ++ * ++ * This library is free software; you can redistribute it and/or ++ * modify it under the terms of the GNU Lesser General Public ++ * License as published by the Free Software Foundation; either ++ * version 2.1 of the License, or (at your option) any later version. ++ * ++ * This library is distributed in the hope that it will be useful, ++ * but WITHOUT ANY WARRANTY; without even the implied warranty of ++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ++ * Lesser General Public License for more details. ++ * ++ * You should have received a copy of the GNU Lesser General Public ++ * License along with this library; if not, see . ++ * ++ * Author: Tomas Bzatek ++ */ ++ ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++#include ++ ++#include ++#include ++ ++#include ++#include ++#include "nvme.h" ++#include "nvme-private.h" ++ ++/** ++ * SECTION: nvme ++ * @short_description: NVMe device reporting and management. ++ * @title: NVMe ++ * @include: nvme.h ++ * ++ * A plugin for NVMe device reporting and management, based around libnvme. ++ */ ++ ++ ++/** ++ * bd_nvme_check_deps: ++ * ++ * Returns: whether the plugin's runtime dependencies are satisfied or not ++ * ++ * Function checking plugin's runtime dependencies. ++ * ++ */ ++gboolean bd_nvme_check_deps (void) { ++ /* no runtime dependencies */ ++ return TRUE; ++} ++ ++/** ++ * bd_nvme_init: ++ * ++ * Initializes the plugin. **This function is called automatically by the ++ * library's initialization functions.** ++ * ++ */ ++gboolean bd_nvme_init (void) { ++ /* nothing to do here */ ++ return TRUE; ++}; ++ ++/** ++ * bd_nvme_close: ++ * ++ * Cleans up after the plugin. **This function is called automatically by the ++ * library's functions that unload it.** ++ * ++ */ ++void bd_nvme_close (void) { ++ /* nothing to do here */ ++} ++ ++/** ++ * bd_nvme_is_tech_avail: ++ * @tech: the queried tech ++ * @mode: a bit mask of queried modes of operation (#BDNVMETechMode) for @tech ++ * @error: (out) (nullable): place to store error (details about why the @tech-@mode combination is not available) ++ * ++ * Returns: whether the @tech-@mode combination is available -- supported by the ++ * plugin implementation and having all the runtime dependencies available ++ */ ++gboolean bd_nvme_is_tech_avail (BDNVMETech tech, G_GNUC_UNUSED guint64 mode, GError **error) { ++ switch (tech) { ++ case BD_NVME_TECH_NVME: ++ return TRUE; ++ case BD_NVME_TECH_FABRICS: ++ return TRUE; ++ default: ++ g_set_error (error, BD_NVME_ERROR, BD_NVME_ERROR_TECH_UNAVAIL, "Unknown technology"); ++ return FALSE; ++ } ++} +diff --git a/src/plugins/nvme/nvme.h b/src/plugins/nvme/nvme.h +new file mode 100644 +index 00000000..a7d30d79 +--- /dev/null ++++ b/src/plugins/nvme/nvme.h +@@ -0,0 +1,700 @@ ++#include ++#include ++#include ++ ++#ifndef BD_NVME ++#define BD_NVME ++ ++GQuark bd_nvme_error_quark (void); ++#define BD_NVME_ERROR bd_nvme_error_quark () ++ ++/** ++ * BDNVMEError: ++ * @BD_NVME_ERROR_TECH_UNAVAIL: NVMe support not available. ++ * @BD_NVME_ERROR_FAILED: General error. ++ * @BD_NVME_ERROR_BUSY: The device is temporarily unavailable or in an inconsistent state. ++ * @BD_NVME_ERROR_INVALID_ARGUMENT: Invalid argument. ++ * @BD_NVME_ERROR_WOULD_FORMAT_ALL_NS: The NVMe controller indicates that it would format all namespaces in the NVM subsystem. ++ * @BD_NVME_ERROR_SC_GENERIC: Generic NVMe Command Status Code. ++ * @BD_NVME_ERROR_SC_CMD_SPECIFIC: NVMe Command Specific error. ++ * @BD_NVME_ERROR_SC_MEDIA: Media and Data Integrity Errors: media specific errors that occur in the NVM or data integrity type errors. ++ * @BD_NVME_ERROR_SC_PATH: Path related error. ++ * @BD_NVME_ERROR_SC_VENDOR_SPECIFIC: NVMe Vendor specific error. ++ * @BD_NVME_ERROR_NO_MATCH: No matching resource found (e.g. a Fabrics Controller). ++ * @BD_NVME_ERROR_CONNECT: General connection error. ++ * @BD_NVME_ERROR_CONNECT_ALREADY: Already connected. ++ * @BD_NVME_ERROR_CONNECT_INVALID: Invalid argument specified. ++ * @BD_NVME_ERROR_CONNECT_ADDRINUSE: HostNQN already in use. ++ * @BD_NVME_ERROR_CONNECT_NODEV: Invalid interface. ++ * @BD_NVME_ERROR_CONNECT_OPNOTSUPP: Operation not supported. ++ */ ++typedef enum { ++ BD_NVME_ERROR_TECH_UNAVAIL, ++ BD_NVME_ERROR_FAILED, ++ BD_NVME_ERROR_BUSY, ++ BD_NVME_ERROR_INVALID_ARGUMENT, ++ BD_NVME_ERROR_WOULD_FORMAT_ALL_NS, ++ BD_NVME_ERROR_SC_GENERIC, ++ BD_NVME_ERROR_SC_CMD_SPECIFIC, ++ BD_NVME_ERROR_SC_MEDIA, ++ BD_NVME_ERROR_SC_PATH, ++ BD_NVME_ERROR_SC_VENDOR_SPECIFIC, ++ BD_NVME_ERROR_NO_MATCH, ++ BD_NVME_ERROR_CONNECT, ++ BD_NVME_ERROR_CONNECT_ALREADY, ++ BD_NVME_ERROR_CONNECT_INVALID, ++ BD_NVME_ERROR_CONNECT_ADDRINUSE, ++ BD_NVME_ERROR_CONNECT_NODEV, ++ BD_NVME_ERROR_CONNECT_OPNOTSUPP, ++} BDNVMEError; ++ ++typedef enum { ++ BD_NVME_TECH_NVME = 0, ++ BD_NVME_TECH_FABRICS, ++} BDNVMETech; ++ ++typedef enum { ++ BD_NVME_TECH_MODE_INFO = 1 << 0, ++ BD_NVME_TECH_MODE_MANAGE = 1 << 1, ++ BD_NVME_TECH_MODE_INITIATOR = 1 << 2, ++} BDNVMETechMode; ++ ++/** ++ * BDNVMEControllerFeature: ++ * @BD_NVME_CTRL_FEAT_MULTIPORT: if set, then the NVM subsystem may contain more than one NVM subsystem port, otherwise it's single-port only. ++ * @BD_NVME_CTRL_FEAT_MULTICTRL: if set, then the NVM subsystem may contain two or more controllers, otherwise contains only single controller. ++ * @BD_NVME_CTRL_FEAT_SRIOV: if set, then the controller is associated with an SR-IOV Virtual Function, otherwise it's associated with a PCI Function or a Fabrics connection. ++ * @BD_NVME_CTRL_FEAT_ANA_REPORTING: indicates that the NVM subsystem supports Asymmetric Namespace Access (ANA) Reporting. ++ * @BD_NVME_CTRL_FEAT_FORMAT: indicates that the controller supports the Format NVM command. ++ * @BD_NVME_CTRL_FEAT_FORMAT_ALL_NS: if set, then a format (excluding secure erase) of any namespace results in a format of all namespaces ++ * in an NVM subsystem with all namespaces in an NVM subsystem configured with the same attributes. ++ * If not set, then the controller supports format on a per namespace basis. ++ * @BD_NVME_CTRL_FEAT_NS_MGMT: indicates that the controller supports the Namespace Management and Attachment capability. ++ * @BD_NVME_CTRL_FEAT_SELFTEST: indicates that the controller supports the Device Self-test command. ++ * @BD_NVME_CTRL_FEAT_SELFTEST_SINGLE: indicates that the NVM subsystem supports only one device self-test operation in progress at a time. ++ * @BD_NVME_CTRL_FEAT_SANITIZE_CRYPTO: indicates that the controller supports the Crypto Erase sanitize operation. ++ * @BD_NVME_CTRL_FEAT_SANITIZE_BLOCK: indicates that the controller supports the Block Erase sanitize operation. ++ * @BD_NVME_CTRL_FEAT_SANITIZE_OVERWRITE: indicates that the controller supports the Overwrite sanitize operation. ++ * @BD_NVME_CTRL_FEAT_SECURE_ERASE_ALL_NS: if set, then any secure erase performed as part of a format operation ++ * results in a secure erase of all namespaces in the NVM subsystem. If not set, ++ * then any secure erase performed as part of a format results in a secure erase ++ * of the particular namespace specified. ++ * @BD_NVME_CTRL_FEAT_SECURE_ERASE_CRYPTO: indicates that the cryptographic erase is supported. ++ * @BD_NVME_CTRL_FEAT_STORAGE_DEVICE: indicates that the NVM subsystem is part of an NVMe Storage Device. ++ * @BD_NVME_CTRL_FEAT_ENCLOSURE: indicates that the NVM subsystem is part of an NVMe Enclosure. ++ * @BD_NVME_CTRL_FEAT_MGMT_PCIE: indicates that the NVM subsystem contains a Management Endpoint on a PCIe port. ++ * @BD_NVME_CTRL_FEAT_MGMT_SMBUS: indicates that the NVM subsystem contains a Management Endpoint on an SMBus/I2C port. ++ */ ++typedef enum { ++ BD_NVME_CTRL_FEAT_MULTIPORT = 1 << 0, ++ BD_NVME_CTRL_FEAT_MULTICTRL = 1 << 1, ++ BD_NVME_CTRL_FEAT_SRIOV = 1 << 2, ++ BD_NVME_CTRL_FEAT_ANA_REPORTING = 1 << 3, ++ BD_NVME_CTRL_FEAT_FORMAT = 1 << 4, ++ BD_NVME_CTRL_FEAT_FORMAT_ALL_NS = 1 << 5, ++ BD_NVME_CTRL_FEAT_NS_MGMT = 1 << 6, ++ BD_NVME_CTRL_FEAT_SELFTEST = 1 << 7, ++ BD_NVME_CTRL_FEAT_SELFTEST_SINGLE = 1 << 8, ++ BD_NVME_CTRL_FEAT_SANITIZE_CRYPTO = 1 << 9, ++ BD_NVME_CTRL_FEAT_SANITIZE_BLOCK = 1 << 10, ++ BD_NVME_CTRL_FEAT_SANITIZE_OVERWRITE = 1 << 11, ++ BD_NVME_CTRL_FEAT_SECURE_ERASE_ALL_NS = 1 << 12, ++ BD_NVME_CTRL_FEAT_SECURE_ERASE_CRYPTO = 1 << 13, ++ BD_NVME_CTRL_FEAT_STORAGE_DEVICE = 1 << 14, ++ BD_NVME_CTRL_FEAT_ENCLOSURE = 1 << 15, ++ BD_NVME_CTRL_FEAT_MGMT_PCIE = 1 << 16, ++ BD_NVME_CTRL_FEAT_MGMT_SMBUS = 1 << 17, ++} BDNVMEControllerFeature; ++ ++/** ++ * BDNVMEControllerType: ++ * @BD_NVME_CTRL_TYPE_UNKNOWN: Controller type not reported (as reported by older NVMe-compliant devices). ++ * @BD_NVME_CTRL_TYPE_IO: I/O controller. ++ * @BD_NVME_CTRL_TYPE_DISCOVERY: Discovery controller. ++ * @BD_NVME_CTRL_TYPE_ADMIN: Administrative controller. ++ */ ++typedef enum { ++ BD_NVME_CTRL_TYPE_UNKNOWN = 0, ++ BD_NVME_CTRL_TYPE_IO, ++ BD_NVME_CTRL_TYPE_DISCOVERY, ++ BD_NVME_CTRL_TYPE_ADMIN, ++} BDNVMEControllerType; ++ ++/** ++ * BDNVMEControllerInfo: ++ * @pci_vendor_id: The PCI Vendor ID. ++ * @pci_subsys_vendor_id: The PCI Subsystem Vendor ID. ++ * @ctrl_id: Controller ID, the NVM subsystem unique controller identifier associated with the controller. ++ * @fguid: FRU GUID, a 128-bit value that is globally unique for a given Field Replaceable Unit. ++ * @model_number: The model number. ++ * @serial_number: The serial number. ++ * @firmware_ver: The currently active firmware revision. ++ * @nvme_ver: The NVM Express base specification that the controller implementation supports. ++ * @features: features and capabilities present for this controller, see #BDNVMEControllerFeature. ++ * @controller_type: The controller type. ++ * @selftest_ext_time: Extended Device Self-test Time, if #BD_NVME_CTRL_FEAT_SELFTEST is supported then this field ++ * indicates the nominal amount of time in one minute units that the controller takes ++ * to complete an extended device self-test operation when in power state 0. ++ * @hmb_pref_size: Host Memory Buffer Preferred Size indicates the preferred size that the host ++ * is requested to allocate for the Host Memory Buffer feature in bytes. ++ * @hmb_min_size: Host Memory Buffer Minimum Size indicates the minimum size that the host ++ * is requested to allocate for the Host Memory Buffer feature in bytes. ++ * @size_total: Total NVM Capacity in the NVM subsystem in bytes. ++ * @size_unalloc: Unallocated NVM Capacity in the NVM subsystem in bytes. ++ * @num_namespaces: Maximum Number of Allowed Namespaces supported by the NVM subsystem. ++ * @subsysnqn: NVM Subsystem NVMe Qualified Name, UTF-8 null terminated string. ++ */ ++typedef struct BDNVMEControllerInfo { ++ guint16 pci_vendor_id; ++ guint16 pci_subsys_vendor_id; ++ guint16 ctrl_id; ++ gchar *fguid; ++ gchar *model_number; ++ gchar *serial_number; ++ gchar *firmware_ver; ++ gchar *nvme_ver; ++ guint64 features; ++ BDNVMEControllerType controller_type; ++ gint selftest_ext_time; ++ guint64 hmb_pref_size; ++ guint64 hmb_min_size; ++ guint64 size_total; ++ guint64 size_unalloc; ++ guint num_namespaces; ++ gchar *subsysnqn; ++} BDNVMEControllerInfo; ++ ++/** ++ * BDNVMELBAFormatRelativePerformance: ++ * Performance index of the LBA format relative to other LBA formats supported by the controller. ++ * @BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_UNKNOWN: Unknown relative performance index. ++ * @BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_BEST: Best performance. ++ * @BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_BETTER: Better performance. ++ * @BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_GOOD: Good performance. ++ * @BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_DEGRADED: Degraded performance. ++ */ ++typedef enum { ++ BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_UNKNOWN = 0, ++ BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_BEST = 1, ++ BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_BETTER = 2, ++ BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_GOOD = 3, ++ BD_NVME_LBA_FORMAT_RELATIVE_PERFORMANCE_DEGRADED = 4 ++} BDNVMELBAFormatRelativePerformance; ++ ++/** ++ * BDNVMELBAFormat: ++ * Namespace LBA Format Data Structure. ++ * @data_size: LBA data size (i.e. a sector size) in bytes. ++ * @metadata_size: metadata size in bytes or `0` in case of no metadata support. ++ * @relative_performance: Relative Performance index, see #BDNVMELBAFormatRelativePerformance. ++ */ ++typedef struct BDNVMELBAFormat { ++ guint16 data_size; ++ guint16 metadata_size; ++ BDNVMELBAFormatRelativePerformance relative_performance; ++} BDNVMELBAFormat; ++ ++/** ++ * BDNVMENamespaceFeature: ++ * @BD_NVME_NS_FEAT_THIN: indicates that the namespace supports thin provisioning. Specifically, the Namespace Capacity ++ * reported may be less than the Namespace Size. ++ * @BD_NVME_NS_FEAT_MULTIPATH_SHARED: indicates the capability to attach the namespace to two or more controllers ++ * in the NVM subsystem concurrently. ++ * @BD_NVME_NS_FEAT_FORMAT_PROGRESS: indicates the capability to report the percentage of the namespace ++ * that remains to be formatted. ++ */ ++typedef enum { ++ BD_NVME_NS_FEAT_THIN = 1 << 0, ++ BD_NVME_NS_FEAT_MULTIPATH_SHARED = 1 << 1, ++ BD_NVME_NS_FEAT_FORMAT_PROGRESS = 1 << 2, ++} BDNVMENamespaceFeature; ++ ++/** ++ * BDNVMENamespaceInfo: ++ * @nsid: The Namespace Identifier (NSID). ++ * @eui64: IEEE Extended Unique Identifier: a 64-bit IEEE Extended Unique Identifier (EUI-64) ++ * that is globally unique and assigned to the namespace when the namespace is created. ++ * Remains fixed throughout the life of the namespace and is preserved across namespace ++ * and controller operations. ++ * @nguid: Namespace Globally Unique Identifier: a 128-bit value that is globally unique and ++ * assigned to the namespace when the namespace is created. Remains fixed throughout ++ * the life of the namespace and is preserved across namespace and controller operations. ++ * @uuid: Namespace 128-bit Universally Unique Identifier (UUID) as specified in RFC 4122. ++ * @nsize: Namespace Size: total size of the namespace in logical blocks. The number of logical blocks ++ * is based on the formatted LBA size (see @current_lba_format). ++ * @ncap: Namespace Capacity: maximum number of logical blocks that may be allocated in the namespace ++ * at any point in time. The number of logical blocks is based on the formatted LBA size (see @current_lba_format). ++ * @nuse: Namespace Utilization: current number of logical blocks allocated in the namespace. ++ * This field is smaller than or equal to the Namespace Capacity. The number of logical ++ * blocks is based on the formatted LBA size (see @current_lba_format). ++ * @features: features and capabilities present for this namespace, see #BDNVMENamespaceFeature. ++ * @format_progress_remaining: The percentage value remaining of a format operation in progress. ++ * @write_protected: %TRUE if the namespace is currently write protected and all write access to the namespace shall fail. ++ * @lba_formats: (array zero-terminated=1) (element-type BDNVMELBAFormat): A list of supported LBA Formats. ++ * @current_lba_format: A LBA Format currently used for the namespace. Contains zeroes in case of ++ * an invalid or no supported LBA Format reported. ++ */ ++typedef struct BDNVMENamespaceInfo { ++ guint32 nsid; ++ gchar *eui64; ++ gchar *uuid; ++ gchar *nguid; ++ guint64 nsize; ++ guint64 ncap; ++ guint64 nuse; ++ guint64 features; ++ guint8 format_progress_remaining; ++ gboolean write_protected; ++ BDNVMELBAFormat **lba_formats; ++ BDNVMELBAFormat current_lba_format; ++} BDNVMENamespaceInfo; ++ ++/** ++ * BDNVMESmartCriticalWarning: ++ * @BD_NVME_SMART_CRITICAL_WARNING_SPARE: the available spare capacity has fallen below the threshold. ++ * @BD_NVME_SMART_CRITICAL_WARNING_TEMPERATURE: a temperature is either greater than or equal to an over temperature threshold; ++ * or less than or equal to an under temperature threshold. ++ * @BD_NVME_SMART_CRITICAL_WARNING_DEGRADED: the NVM subsystem reliability has been degraded due to significant media ++ * related errors or any internal error that degrades NVM subsystem reliability. ++ * @BD_NVME_SMART_CRITICAL_WARNING_READONLY: all of the media has been placed in read only mode. Unrelated to the write ++ * protection state of a namespace. ++ * @BD_NVME_SMART_CRITICAL_WARNING_VOLATILE_MEM: the volatile memory backup device has failed. Valid only if the controller ++ * has a volatile memory backup solution. ++ * @BD_NVME_SMART_CRITICAL_WARNING_PMR_READONLY: Persistent Memory Region has become read-only or unreliable. ++ */ ++typedef enum { ++ BD_NVME_SMART_CRITICAL_WARNING_SPARE = 1 << 0, ++ BD_NVME_SMART_CRITICAL_WARNING_TEMPERATURE = 1 << 1, ++ BD_NVME_SMART_CRITICAL_WARNING_DEGRADED = 1 << 2, ++ BD_NVME_SMART_CRITICAL_WARNING_READONLY = 1 << 3, ++ BD_NVME_SMART_CRITICAL_WARNING_VOLATILE_MEM = 1 << 4, ++ BD_NVME_SMART_CRITICAL_WARNING_PMR_READONLY = 1 << 5, ++} BDNVMESmartCriticalWarning; ++ ++/** ++ * BDNVMESmartLog: ++ * @critical_warning: critical warnings for the state of the controller, see #BDNVMESmartCriticalWarning. ++ * @avail_spare: Available Spare: a normalized percentage (0% to 100%) of the remaining spare capacity available. ++ * @spare_thresh: Available Spare Threshold: a normalized percentage (0% to 100%) of the available spare threshold. ++ * @percent_used: Percentage Used: a vendor specific estimate of the percentage drive life used based on the ++ * actual usage and the manufacturer's prediction. A value of 100 indicates that the estimated ++ * endurance has been consumed, but may not indicate an NVM subsystem failure. ++ * The value is allowed to exceed 100. ++ * @total_data_read: An estimated calculation of total data read in bytes based on calculation of data ++ * units read from the host. A value of 0 indicates that the number of Data Units Read ++ * is not reported. ++ * @total_data_written: An estimated calculation of total data written in bytes based on calculation ++ * of data units written by the host. A value of 0 indicates that the number ++ * of Data Units Written is not reported. ++ * @ctrl_busy_time: Amount of time the controller is busy with I/O commands, reported in minutes. ++ * @power_cycles: The number of power cycles. ++ * @power_on_hours: The number of power-on hours, excluding a non-operational power state. ++ * @unsafe_shutdowns: The number of unsafe shutdowns as a result of a Shutdown Notification not received prior to loss of power. ++ * @media_errors: Media and Data Integrity Errors: the number of occurrences where the controller detected ++ * an unrecovered data integrity error (e.g. uncorrectable ECC, CRC checksum failure, or LBA tag mismatch). ++ * @num_err_log_entries: Number of Error Information Log Entries: the number of Error Information log ++ * entries over the life of the controller. ++ * @temperature: Composite Temperature: temperature in Kelvins that represents the current composite ++ * temperature of the controller and associated namespaces or 0 when not applicable. ++ * @temp_sensors: Temperature Sensor 1-8: array of the current temperature reported by temperature sensors ++ * 1-8 in Kelvins or 0 when the particular sensor is not available. ++ * @wctemp: Warning Composite Temperature Threshold (WCTEMP): indicates the minimum Composite Temperature (@temperature) ++ * value that indicates an overheating condition during which controller operation continues. ++ * A value of 0 indicates that no warning temperature threshold value is reported by the controller. ++ * @cctemp: Critical Composite Temperature Threshold (CCTEMP): indicates the minimum Composite Temperature (@temperature) ++ * value that indicates a critical overheating condition (e.g., may prevent continued normal operation, ++ * possibility of data loss, automatic device shutdown, extreme performance throttling, or permanent damage). ++ * A value of 0 indicates that no critical temperature threshold value is reported by the controller. ++ * @warning_temp_time: Warning Composite Temperature Time: the amount of time in minutes that the Composite Temperature (@temperature) ++ * is greater than or equal to the Warning Composite Temperature Threshold (@wctemp) and less than the ++ * Critical Composite Temperature Threshold (@cctemp). ++ * @critical_temp_time: Critical Composite Temperature Time: the amount of time in minutes that the Composite Temperature (@temperature) ++ * is greater than or equal to the Critical Composite Temperature Threshold (@cctemp). ++ */ ++typedef struct BDNVMESmartLog { ++ guint critical_warning; ++ guint8 avail_spare; ++ guint8 spare_thresh; ++ guint8 percent_used; ++ guint64 total_data_read; ++ guint64 total_data_written; ++ guint64 ctrl_busy_time; ++ guint64 power_cycles; ++ guint64 power_on_hours; ++ guint64 unsafe_shutdowns; ++ guint64 media_errors; ++ guint64 num_err_log_entries; ++ guint16 temperature; ++ guint16 temp_sensors[8]; ++ guint16 wctemp; ++ guint16 cctemp; ++ guint warning_temp_time; ++ guint critical_temp_time; ++} BDNVMESmartLog; ++ ++/** ++ * BDNVMETransportType: ++ * Transport Type. ++ * @BD_NVME_TRANSPORT_TYPE_UNSPECIFIED: Not indicated ++ * @BD_NVME_TRANSPORT_TYPE_RDMA: RDMA Transport ++ * @BD_NVME_TRANSPORT_TYPE_FC: Fibre Channel Transport ++ * @BD_NVME_TRANSPORT_TYPE_TCP: TCP Transport ++ * @BD_NVME_TRANSPORT_TYPE_LOOP: Intra-host Transport (loopback) ++ */ ++typedef enum { ++ BD_NVME_TRANSPORT_TYPE_UNSPECIFIED = 0, ++ BD_NVME_TRANSPORT_TYPE_RDMA = 1, ++ BD_NVME_TRANSPORT_TYPE_FC = 2, ++ BD_NVME_TRANSPORT_TYPE_TCP = 3, ++ BD_NVME_TRANSPORT_TYPE_LOOP = 254 ++} BDNVMETransportType; ++ ++/** ++ * BDNVMEAddressFamily: ++ * Address Family. ++ * @BD_NVME_ADDRESS_FAMILY_PCI: PCI Express. ++ * @BD_NVME_ADDRESS_FAMILY_INET: AF_INET: IPv4 address family. ++ * @BD_NVME_ADDRESS_FAMILY_INET6: AF_INET6: IPv6 address family. ++ * @BD_NVME_ADDRESS_FAMILY_IB: AF_IB: InfiniBand address family. ++ * @BD_NVME_ADDRESS_FAMILY_FC: Fibre Channel address family. ++ * @BD_NVME_ADDRESS_FAMILY_LOOP: Intra-host Transport (loopback). ++ */ ++typedef enum { ++ BD_NVME_ADDRESS_FAMILY_PCI = 0, ++ BD_NVME_ADDRESS_FAMILY_INET = 1, ++ BD_NVME_ADDRESS_FAMILY_INET6 = 2, ++ BD_NVME_ADDRESS_FAMILY_IB = 3, ++ BD_NVME_ADDRESS_FAMILY_FC = 4, ++ BD_NVME_ADDRESS_FAMILY_LOOP = 254 ++} BDNVMEAddressFamily; ++ ++/** ++ * BDNVMEErrorLogEntry: ++ * @error_count: internal error counter, a unique identifier for the error. ++ * @command_id: the Command Identifier of the command that the error is associated with or `0xffff` if the error is not specific to a particular command. ++ * @command_specific: Command Specific Information specific to @command_id. ++ * @command_status: the Status code for the command that completed. ++ * @command_error: translated command error in the BD_NVME_ERROR domain or %NULL in case @command_status indicates success. ++ * @lba: the first LBA that experienced the error condition. ++ * @nsid: the NSID of the namespace that the error is associated with. ++ * @transport_type: type of the transport associated with the error. ++ */ ++typedef struct BDNVMEErrorLogEntry { ++ guint64 error_count; ++ guint16 command_id; ++ guint64 command_specific; ++ guint16 command_status; ++ GError *command_error; ++ guint64 lba; ++ guint32 nsid; ++ BDNVMETransportType transport_type; ++} BDNVMEErrorLogEntry; ++ ++/** ++ * BDNVMESelfTestAction: ++ * Action taken by the Device Self-test command. ++ * @BD_NVME_SELF_TEST_ACTION_NOT_RUNNING: No device self-test operation in progress. Not a valid argument for bd_nvme_device_self_test(). ++ * @BD_NVME_SELF_TEST_ACTION_SHORT: Start a short device self-test operation. ++ * @BD_NVME_SELF_TEST_ACTION_EXTENDED: Start an extended device self-test operation. ++ * @BD_NVME_SELF_TEST_ACTION_VENDOR_SPECIFIC: Start a vendor specific device self-test operation. ++ * @BD_NVME_SELF_TEST_ACTION_ABORT: Abort the device self-test operation. Only valid for bd_nvme_device_self_test(). ++ */ ++typedef enum { ++ BD_NVME_SELF_TEST_ACTION_NOT_RUNNING = 0, ++ BD_NVME_SELF_TEST_ACTION_SHORT = 1, ++ BD_NVME_SELF_TEST_ACTION_EXTENDED = 2, ++ BD_NVME_SELF_TEST_ACTION_VENDOR_SPECIFIC = 3, ++ BD_NVME_SELF_TEST_ACTION_ABORT = 4, ++} BDNVMESelfTestAction; ++ ++/** ++ * BDNVMESelfTestResult: ++ * @BD_NVME_SELF_TEST_RESULT_NO_ERROR: Operation completed without error. ++ * @BD_NVME_SELF_TEST_RESULT_ABORTED: Operation was aborted by a Device Self-test command. ++ * @BD_NVME_SELF_TEST_RESULT_CTRL_RESET: Operation was aborted by a Controller Level Reset. ++ * @BD_NVME_SELF_TEST_RESULT_NS_REMOVED: Operation was aborted due to a removal of a namespace from the namespace inventory. ++ * @BD_NVME_SELF_TEST_RESULT_ABORTED_FORMAT: Operation was aborted due to the processing of a Format NVM command. ++ * @BD_NVME_SELF_TEST_RESULT_FATAL_ERROR: A fatal error or unknown test error occurred while the controller was executing the device self-test operation and the operation did not complete. ++ * @BD_NVME_SELF_TEST_RESULT_UNKNOWN_SEG_FAIL: Operation completed with a segment that failed and the segment that failed is not known. ++ * @BD_NVME_SELF_TEST_RESULT_KNOWN_SEG_FAIL: Operation completed with one or more failed segments and the first segment that failed is indicated in the Segment Number field. ++ * @BD_NVME_SELF_TEST_RESULT_ABORTED_UNKNOWN: Operation was aborted for unknown reason. ++ * @BD_NVME_SELF_TEST_RESULT_ABORTED_SANITIZE: Operation was aborted due to a sanitize operation. ++ */ ++typedef enum { ++ BD_NVME_SELF_TEST_RESULT_NO_ERROR = 0, ++ BD_NVME_SELF_TEST_RESULT_ABORTED = 1, ++ BD_NVME_SELF_TEST_RESULT_CTRL_RESET = 2, ++ BD_NVME_SELF_TEST_RESULT_NS_REMOVED = 3, ++ BD_NVME_SELF_TEST_RESULT_ABORTED_FORMAT = 4, ++ BD_NVME_SELF_TEST_RESULT_FATAL_ERROR = 5, ++ BD_NVME_SELF_TEST_RESULT_UNKNOWN_SEG_FAIL = 6, ++ BD_NVME_SELF_TEST_RESULT_KNOWN_SEG_FAIL = 7, ++ BD_NVME_SELF_TEST_RESULT_ABORTED_UNKNOWN = 8, ++ BD_NVME_SELF_TEST_RESULT_ABORTED_SANITIZE = 9, ++} BDNVMESelfTestResult; ++ ++/** ++ * BDNVMESelfTestLogEntry: ++ * @result: Result of the device self-test operation. ++ * @action: The Self-test Code value (action) that was specified in the Device Self-test command that started this device self-test operation. ++ * @segment: Segment number where the first self-test failure occurred. Valid only when @result is set to #BD_NVME_SELF_TEST_RESULT_KNOWN_SEG_FAIL. ++ * @power_on_hours: Number of power-on hours at the time the device self-test operation was completed or aborted. Does not include time that the controller was powered and in a low power state condition. ++ * @nsid: Namespace ID that the Failing LBA occurred on. ++ * @failing_lba: LBA of the logical block that caused the test to fail. If the device encountered more than one failed logical block during the test, then this field only indicates one of those failed logical blocks. ++ * @status_code_error: Translated NVMe Command Status Code representing additional information related to errors or conditions. ++ */ ++typedef struct BDNVMESelfTestLogEntry { ++ BDNVMESelfTestResult result; ++ BDNVMESelfTestAction action; ++ guint8 segment; ++ guint64 power_on_hours; ++ guint32 nsid; ++ guint64 failing_lba; ++ GError *status_code_error; ++} BDNVMESelfTestLogEntry; ++ ++/** ++ * BDNVMESelfTestLog: ++ * @current_operation: Current running device self-test operation. There's no corresponding record in @entries for a device self-test operation that is in progress. ++ * @current_operation_completion: Percentage of the currently running device self-test operation. Only valid when @current_operation is other than #BD_NVME_SELF_TEST_ACTION_NOT_RUNNING. ++ * @entries: (array zero-terminated=1) (element-type BDNVMESelfTestLogEntry): Self-test log entries for the last 20 operations, sorted from newest (first element) to oldest. ++ */ ++typedef struct BDNVMESelfTestLog { ++ BDNVMESelfTestAction current_operation; ++ guint8 current_operation_completion; ++ BDNVMESelfTestLogEntry **entries; ++} BDNVMESelfTestLog; ++ ++/** ++ * BDNVMEFormatSecureErase: ++ * Optional Format NVM secure erase action. ++ * @BD_NVME_FORMAT_SECURE_ERASE_NONE: No secure erase operation requested. ++ * @BD_NVME_FORMAT_SECURE_ERASE_USER_DATA: User Data Erase: All user data shall be erased, contents of the user data after the erase is indeterminate ++ * (e.g., the user data may be zero filled, one filled, etc.). If a User Data Erase is requested and all affected ++ * user data is encrypted, then the controller is allowed to use a cryptographic erase to perform the requested User Data Erase. ++ * @BD_NVME_FORMAT_SECURE_ERASE_CRYPTO: Cryptographic Erase: All user data shall be erased cryptographically. This is accomplished by deleting the encryption key. ++ */ ++typedef enum { ++ BD_NVME_FORMAT_SECURE_ERASE_NONE = 0, ++ BD_NVME_FORMAT_SECURE_ERASE_USER_DATA = 1, ++ BD_NVME_FORMAT_SECURE_ERASE_CRYPTO = 2, ++} BDNVMEFormatSecureErase; ++ ++/** ++ * BDNVMESanitizeStatus: ++ * @BD_NVME_SANITIZE_STATUS_NEVER_SANITIZED: The NVM subsystem has never been sanitized. ++ * @BD_NVME_SANITIZE_STATUS_IN_PROGESS: A sanitize operation is currently in progress. ++ * @BD_NVME_SANITIZE_STATUS_SUCCESS: The most recent sanitize operation completed successfully including any additional media modification. ++ * @BD_NVME_SANITIZE_STATUS_SUCCESS_NO_DEALLOC: The most recent sanitize operation for which No-Deallocate After Sanitize was requested has completed successfully with deallocation of all user data. ++ * @BD_NVME_SANITIZE_STATUS_FAILED: The most recent sanitize operation failed. ++ */ ++typedef enum { ++ BD_NVME_SANITIZE_STATUS_NEVER_SANITIZED = 0, ++ BD_NVME_SANITIZE_STATUS_IN_PROGESS = 1, ++ BD_NVME_SANITIZE_STATUS_SUCCESS = 2, ++ BD_NVME_SANITIZE_STATUS_SUCCESS_NO_DEALLOC = 3, ++ BD_NVME_SANITIZE_STATUS_FAILED = 4, ++} BDNVMESanitizeStatus; ++ ++/** ++ * BDNVMESanitizeLog: ++ * @sanitize_progress: The percentage complete of the sanitize operation. ++ * @sanitize_status: The status of the most recent sanitize operation. ++ * @global_data_erased: Indicates that no user data has been written either since the drive was manufactured and ++ * has never been sanitized or since the most recent successful sanitize operation. ++ * @overwrite_passes: Number of completed passes if the most recent sanitize operation was an Overwrite. ++ * @time_for_overwrite: Estimated time in seconds needed to complete an Overwrite sanitize operation with 16 passes in the background. ++ * A value of -1 means that no time estimate is reported. A value of 0 means that the operation is expected ++ * to be completed in the background when the Sanitize command is completed. ++ * @time_for_block_erase: Estimated time in seconds needed to complete a Block Erase sanitize operation in the background. ++ * A value of -1 means that no time estimate is reported. A value of 0 means that the operation is expected ++ * to be completed in the background when the Sanitize command is completed. ++ * @time_for_crypto_erase: Estimated time in seconds needed to complete a Crypto Erase sanitize operation in the background. ++ * A value of -1 means that no time estimate is reported. A value of 0 means that the operation is expected ++ * to be completed in the background when the Sanitize command is completed. ++ * @time_for_overwrite_nd: Estimated time in seconds needed to complete an Overwrite sanitize operation and the associated ++ * additional media modification in the background when the No-Deallocate After Sanitize or ++ * the No-Deallocate Modifies Media After Sanitize features have been requested. ++ * @time_for_block_erase_nd: Estimated time in seconds needed to complete a Block Erase sanitize operation and the associated ++ * additional media modification in the background when the No-Deallocate After Sanitize or ++ * the No-Deallocate Modifies Media After Sanitize features have been requested. ++ * @time_for_crypto_erase_nd: Estimated time in seconds needed to complete a Crypto Erase sanitize operation and the associated ++ * additional media modification in the background when the No-Deallocate After Sanitize or ++ * the No-Deallocate Modifies Media After Sanitize features have been requested. ++ */ ++typedef struct BDNVMESanitizeLog { ++ gdouble sanitize_progress; ++ BDNVMESanitizeStatus sanitize_status; ++ gboolean global_data_erased; ++ guint8 overwrite_passes; ++ gint64 time_for_overwrite; ++ gint64 time_for_block_erase; ++ gint64 time_for_crypto_erase; ++ gint64 time_for_overwrite_nd; ++ gint64 time_for_block_erase_nd; ++ gint64 time_for_crypto_erase_nd; ++} BDNVMESanitizeLog; ++ ++/** ++ * BDNVMESanitizeAction: ++ * @BD_NVME_SANITIZE_ACTION_EXIT_FAILURE: Exit Failure Mode. ++ * @BD_NVME_SANITIZE_ACTION_BLOCK_ERASE: Start a Block Erase sanitize operation - a low-level block erase method that is specific to the media. ++ * @BD_NVME_SANITIZE_ACTION_OVERWRITE: Start an Overwrite sanitize operation - writing a fixed data pattern or related patterns in multiple passes. ++ * @BD_NVME_SANITIZE_ACTION_CRYPTO_ERASE: Start a Crypto Erase sanitize operation - changing the media encryption keys for all locations on the media. ++ */ ++typedef enum { ++ BD_NVME_SANITIZE_ACTION_EXIT_FAILURE = 0, ++ BD_NVME_SANITIZE_ACTION_BLOCK_ERASE = 1, ++ BD_NVME_SANITIZE_ACTION_OVERWRITE = 2, ++ BD_NVME_SANITIZE_ACTION_CRYPTO_ERASE = 3, ++} BDNVMESanitizeAction; ++ ++/** ++ * BDNVMETCPSecurity: ++ * @BD_NVME_TCP_SECURITY_NONE: No Security, the host shall set up a normal TCP connection. ++ * @BD_NVME_TCP_SECURITY_TLS12: Transport Layer Security (TLS) version 1.2 (NVMe-oF 1.1). ++ * @BD_NVME_TCP_SECURITY_TLS13: Transport Layer Security (TLS) version 1.3+. The TLS version and cipher is negotiated on every connection. ++ */ ++typedef enum { ++ BD_NVME_TCP_SECURITY_NONE = 0, ++ BD_NVME_TCP_SECURITY_TLS12 = 1, ++ BD_NVME_TCP_SECURITY_TLS13 = 2 ++} BDNVMETCPSecurity; ++ ++/** ++ * BDNVMEDiscoveryLogEntry: ++ * @transport_type: The NVMe Transport type. ++ * @address_family: The address family. ++ * @sq_flow_control_disable: Indicates that the controller is capable of disabling SQ flow control. ++ * @sq_flow_control_required: Indicates that the controller requires use of SQ flow control. ++ * @port_id: A NVM subsystem port. Different NVMe Transports or address families may utilize the same Port ID value (eg. a Port ID may support both iWARP and RoCE). ++ * @ctrl_id: A Controller ID. Special value of `0xFFFF` indicates a dynamic controller model and a value of `0xFFFE` indicates a temporary ID in a static controller model that should be replaced by a real ID after a connection is established. ++ * @transport_addr: Transport Address. ++ * @transport_svcid: Transport Service Identifier. ++ * @subsys_nqn: Subsystem Qualified Name. For a Discovery Service the value should be the well-known Discovery Service NQN (`nqn.2014-08.org.nvmexpress.discovery`). ++ * @tcp_security: NVMe/TCP transport port security. ++ */ ++typedef struct BDNVMEDiscoveryLogEntry { ++ BDNVMETransportType transport_type; ++ BDNVMEAddressFamily address_family; ++ gboolean sq_flow_control_disable; ++ gboolean sq_flow_control_required; ++ guint16 port_id; ++ guint16 ctrl_id; ++ gchar *transport_addr; ++ gchar *transport_svcid; ++ gchar *subsys_nqn; ++ BDNVMETCPSecurity tcp_security; ++} BDNVMEDiscoveryLogEntry; ++ ++ ++void bd_nvme_controller_info_free (BDNVMEControllerInfo *info); ++BDNVMEControllerInfo * bd_nvme_controller_info_copy (BDNVMEControllerInfo *info); ++ ++void bd_nvme_lba_format_free (BDNVMELBAFormat *fmt); ++BDNVMELBAFormat * bd_nvme_lba_format_copy (BDNVMELBAFormat *fmt); ++ ++void bd_nvme_namespace_info_free (BDNVMENamespaceInfo *info); ++BDNVMENamespaceInfo * bd_nvme_namespace_info_copy (BDNVMENamespaceInfo *info); ++ ++void bd_nvme_smart_log_free (BDNVMESmartLog *log); ++BDNVMESmartLog * bd_nvme_smart_log_copy (BDNVMESmartLog *log); ++ ++void bd_nvme_error_log_entry_free (BDNVMEErrorLogEntry *entry); ++BDNVMEErrorLogEntry * bd_nvme_error_log_entry_copy (BDNVMEErrorLogEntry *entry); ++ ++void bd_nvme_self_test_log_entry_free (BDNVMESelfTestLogEntry *entry); ++BDNVMESelfTestLogEntry * bd_nvme_self_test_log_entry_copy (BDNVMESelfTestLogEntry *entry); ++const gchar * bd_nvme_self_test_result_to_string (BDNVMESelfTestResult result, GError **error); ++ ++void bd_nvme_self_test_log_free (BDNVMESelfTestLog *log); ++BDNVMESelfTestLog * bd_nvme_self_test_log_copy (BDNVMESelfTestLog *log); ++ ++void bd_nvme_sanitize_log_free (BDNVMESanitizeLog *log); ++BDNVMESanitizeLog * bd_nvme_sanitize_log_copy (BDNVMESanitizeLog *log); ++ ++void bd_nvme_discovery_log_entry_free (BDNVMEDiscoveryLogEntry *entry); ++BDNVMEDiscoveryLogEntry * bd_nvme_discovery_log_entry_copy (BDNVMEDiscoveryLogEntry *entry); ++ ++/* ++ * If using the plugin as a standalone library, the following functions should ++ * be called to: ++ * ++ * check_deps() - check plugin's dependencies, returning TRUE if satisfied ++ * init() - initialize the plugin, returning TRUE on success ++ * close() - clean after the plugin at the end or if no longer used ++ * ++ */ ++gboolean bd_nvme_check_deps (void); ++gboolean bd_nvme_init (void); ++void bd_nvme_close (void); ++ ++gboolean bd_nvme_is_tech_avail (BDNVMETech tech, guint64 mode, GError **error); ++ ++ ++BDNVMEControllerInfo * bd_nvme_get_controller_info (const gchar *device, GError **error); ++BDNVMENamespaceInfo * bd_nvme_get_namespace_info (const gchar *device, GError **error); ++BDNVMESmartLog * bd_nvme_get_smart_log (const gchar *device, GError **error); ++BDNVMEErrorLogEntry ** bd_nvme_get_error_log_entries (const gchar *device, GError **error); ++BDNVMESelfTestLog * bd_nvme_get_self_test_log (const gchar *device, GError **error); ++BDNVMESanitizeLog * bd_nvme_get_sanitize_log (const gchar *device, GError **error); ++ ++gboolean bd_nvme_device_self_test (const gchar *device, ++ BDNVMESelfTestAction action, ++ GError **error); ++ ++gboolean bd_nvme_format (const gchar *device, ++ guint16 lba_data_size, ++ guint16 metadata_size, ++ BDNVMEFormatSecureErase secure_erase, ++ GError **error); ++gboolean bd_nvme_sanitize (const gchar *device, ++ BDNVMESanitizeAction action, ++ gboolean no_dealloc, ++ gint overwrite_pass_count, ++ guint32 overwrite_pattern, ++ gboolean overwrite_invert_pattern, ++ GError **error); ++ ++gchar * bd_nvme_get_host_nqn (GError **error); ++gchar * bd_nvme_generate_host_nqn (GError **error); ++gchar * bd_nvme_get_host_id (GError **error); ++gboolean bd_nvme_set_host_nqn (const gchar *host_nqn, ++ GError **error); ++gboolean bd_nvme_set_host_id (const gchar *host_id, ++ GError **error); ++ ++gboolean bd_nvme_connect (const gchar *subsysnqn, ++ const gchar *transport, ++ const gchar *transport_addr, ++ const gchar *transport_svcid, ++ const gchar *host_traddr, ++ const gchar *host_iface, ++ const gchar *host_nqn, ++ const gchar *host_id, ++ const BDExtraArg **extra, ++ GError **error); ++gboolean bd_nvme_disconnect (const gchar *subsysnqn, ++ GError **error); ++gboolean bd_nvme_disconnect_by_path (const gchar *path, ++ GError **error); ++BDNVMEDiscoveryLogEntry ** bd_nvme_discover (const gchar *discovery_ctrl, ++ gboolean persistent, ++ const gchar *transport, ++ const gchar *transport_addr, ++ const gchar *transport_svcid, ++ const gchar *host_traddr, ++ const gchar *host_iface, ++ const gchar *host_nqn, ++ const gchar *host_id, ++ const BDExtraArg **extra, ++ GError **error); ++ ++gchar ** bd_nvme_find_ctrls_for_ns (const gchar *ns_sysfs_path, ++ const gchar *subsysnqn, ++ const gchar *host_nqn, ++ const gchar *host_id, ++ GError **error); ++ ++ ++#endif /* BD_NVME */ +diff --git a/src/python/gi/overrides/BlockDev.py b/src/python/gi/overrides/BlockDev.py +index 8bd03cf8..795e0de4 100644 +--- a/src/python/gi/overrides/BlockDev.py ++++ b/src/python/gi/overrides/BlockDev.py +@@ -51,6 +51,7 @@ bd_plugins = { "lvm": BlockDev.Plugin.LVM, + "fs": BlockDev.Plugin.FS, + "s390": BlockDev.Plugin.S390, + "nvdimm": BlockDev.Plugin.NVDIMM, ++ "nvme": BlockDev.Plugin.NVME, + "vdo": BlockDev.Plugin.VDO, + } + +@@ -877,6 +878,21 @@ def nvdimm_namespace_disable(namespace, extra=None, **kwargs): + __all__.append("nvdimm_namespace_disable") + + ++_nvme_connect = BlockDev.nvme_connect ++@override(BlockDev.nvme_connect) ++def nvme_connect(subsysnqn, transport, transport_addr, transport_svcid, host_traddr, host_iface, host_nqn, host_id, extra=None, **kwargs): ++ extra = _get_extra(extra, kwargs) ++ return _nvme_connect(subsysnqn, transport, transport_addr, transport_svcid, host_traddr, host_iface, host_nqn, host_id, extra) ++__all__.append("nvme_connect") ++ ++_nvme_discover = BlockDev.nvme_discover ++@override(BlockDev.nvme_discover) ++def nvme_discover(discovery_ctrl, persistent, transport, transport_addr, transport_svcid, host_traddr, host_iface, host_nqn, host_id, extra=None, **kwargs): ++ extra = _get_extra(extra, kwargs) ++ return _nvme_discover(discovery_ctrl, persistent, transport, transport_addr, transport_svcid, host_traddr, host_iface, host_nqn, host_id, extra) ++__all__.append("nvme_discover") ++ ++ + _vdo_create = BlockDev.vdo_create + @override(BlockDev.vdo_create) + def vdo_create(name, backing_device, logical_size=0, index_memory=0, compression=True, deduplication=True, write_policy=BlockDev.VDOWritePolicy.AUTO, extra=None, **kwargs): +@@ -1175,6 +1191,10 @@ class NVDIMMError(BlockDevError): + pass + __all__.append("NVDIMMError") + ++class NVMEError(BlockDevError): ++ pass ++__all__.append("NVMEError") ++ + class VDOError(BlockDevError): + pass + __all__.append("VDOError") +@@ -1228,6 +1248,9 @@ __all__.append("fs") + nvdimm = ErrorProxy("nvdimm", BlockDev, [(GLib.Error, NVDIMMError)], [not_implemented_rule]) + __all__.append("nvdimm") + ++nvme = ErrorProxy("nvme", BlockDev, [(GLib.Error, NVMEError)], [not_implemented_rule]) ++__all__.append("nvme") ++ + s390 = ErrorProxy("s390", BlockDev, [(GLib.Error, S390Error)], [not_implemented_rule]) + __all__.append("s390") + +diff --git a/tests/library_test.py b/tests/library_test.py +index efd17bd2..73e122a6 100644 +--- a/tests/library_test.py ++++ b/tests/library_test.py +@@ -14,7 +14,8 @@ class LibraryOpsTestCase(unittest.TestCase): + # the dependencies on CentOS/Debian and we don't need them for this test + requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "dm", + "kbd", "loop", +- "mdraid", "part", "swap")) ++ "mdraid", "part", "swap", ++ "nvme")) + + @classmethod + def setUpClass(cls): +diff --git a/tests/nvme_test.py b/tests/nvme_test.py +new file mode 100644 +index 00000000..a46f7422 +--- /dev/null ++++ b/tests/nvme_test.py +@@ -0,0 +1,638 @@ ++import unittest ++import os ++import re ++import overrides_hack ++ ++from utils import create_sparse_tempfile, create_nvmet_device, delete_nvmet_device, setup_nvme_target, teardown_nvme_target, find_nvme_ctrl_devs_for_subnqn, find_nvme_ns_devs_for_subnqn, get_nvme_hostnqn, run_command, TestTags, tag_test, read_file, write_file ++from gi.repository import BlockDev, GLib ++from distutils.spawn import find_executable ++ ++ ++class NVMeTest(unittest.TestCase): ++ requested_plugins = BlockDev.plugin_specs_from_names(("nvme", "loop")) ++ ++ @classmethod ++ def setUpClass(cls): ++ if not find_executable("nvme"): ++ raise unittest.SkipTest("nvme executable (nvme-cli package) not found in $PATH, skipping.") ++ if not find_executable("nvmetcli"): ++ raise unittest.SkipTest("nvmetcli executable not found in $PATH, skipping.") ++ ret, out, err = run_command("modprobe nvme-fabrics") ++ if ret != 0: ++ raise unittest.SkipTest("nvme-fabrics kernel module unavailable, skipping.") ++ ++ if not BlockDev.is_initialized(): ++ BlockDev.init(cls.requested_plugins, None) ++ else: ++ BlockDev.reinit(cls.requested_plugins, True, None) ++ ++ ++class NVMeTestCase(NVMeTest): ++ def setUp(self): ++ self.dev_file = None ++ self.loop_dev = None ++ self.nvme_dev = None ++ self.nvme_ns_dev = None ++ ++ self.addCleanup(self._clean_up) ++ self.dev_file = create_sparse_tempfile("nvme_test", 1024**3) ++ ++ ret, loop = BlockDev.loop_setup(self.dev_file) ++ if not ret: ++ raise RuntimeError("Failed to setup loop device %s for testing" % self.dev_file) ++ self.loop_dev = "/dev/%s" % loop ++ ++ self.nvme_dev = create_nvmet_device(self.loop_dev) ++ self.nvme_ns_dev = self.nvme_dev + "n1" ++ ++ def _clean_up(self): ++ if self.nvme_dev: ++ try: ++ delete_nvmet_device(self.nvme_dev) ++ except RuntimeError: ++ # just move on, we can do no better here ++ pass ++ ++ # detach the loop device ++ BlockDev.loop_teardown(self.loop_dev) ++ if self.dev_file: ++ os.unlink(self.dev_file) ++ ++ @tag_test(TestTags.CORE) ++ def test_ns_info(self): ++ """Test namespace info""" ++ ++ with self.assertRaisesRegexp(GLib.GError, r".*Failed to open device .*': No such file or directory"): ++ BlockDev.nvme_get_namespace_info("/dev/nonexistent") ++ ++ with self.assertRaisesRegexp(GLib.GError, r"Error getting Namespace Identifier \(NSID\): Inappropriate ioctl for device"): ++ BlockDev.nvme_get_namespace_info(self.nvme_dev) ++ ++ # not much information can be gathered from loop-based NVMe target devices... ++ info = BlockDev.nvme_get_namespace_info(self.nvme_ns_dev) ++ self.assertFalse(info.features & BlockDev.NVMENamespaceFeature.THIN) ++ self.assertTrue (info.features & BlockDev.NVMENamespaceFeature.MULTIPATH_SHARED) ++ self.assertFalse(info.features & BlockDev.NVMENamespaceFeature.FORMAT_PROGRESS) ++ self.assertEqual(info.eui64, "0000000000000000") ++ self.assertEqual(info.format_progress_remaining, 0) ++ self.assertEqual(len(info.lba_formats), 1) ++ self.assertGreater(len(info.nguid), 0) ++ self.assertEqual(info.nsid, 1) ++ self.assertEqual(info.ncap, 2097152) ++ self.assertEqual(info.nsize, 2097152) ++ self.assertEqual(info.nuse, 2097152) ++ self.assertGreater(len(info.uuid), 0) ++ self.assertFalse(info.write_protected) ++ self.assertEqual(info.current_lba_format.data_size, 512) ++ self.assertEqual(info.current_lba_format.metadata_size, 0) ++ self.assertEqual(info.current_lba_format.relative_performance, BlockDev.NVMELBAFormatRelativePerformance.BEST) ++ ++ @tag_test(TestTags.CORE) ++ def test_ctrl_info(self): ++ """Test controller info""" ++ ++ with self.assertRaisesRegexp(GLib.GError, r".*Failed to open device .*': No such file or directory"): ++ BlockDev.nvme_get_controller_info("/dev/nonexistent") ++ ++ info = BlockDev.nvme_get_controller_info(self.nvme_dev) ++ self.assertEqual(info.ctrl_id, 1) ++ ++ self.assertTrue (info.features & BlockDev.NVMEControllerFeature.MULTIPORT) ++ self.assertTrue (info.features & BlockDev.NVMEControllerFeature.MULTICTRL) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.SRIOV) ++ self.assertTrue (info.features & BlockDev.NVMEControllerFeature.ANA_REPORTING) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.FORMAT) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.FORMAT_ALL_NS) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.NS_MGMT) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.SELFTEST) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.SELFTEST_SINGLE) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.SANITIZE_CRYPTO) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.SANITIZE_BLOCK) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.SANITIZE_OVERWRITE) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.SECURE_ERASE_ALL_NS) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.SECURE_ERASE_CRYPTO) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.STORAGE_DEVICE) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.ENCLOSURE) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.MGMT_PCIE) ++ self.assertFalse(info.features & BlockDev.NVMEControllerFeature.MGMT_SMBUS) ++ self.assertEqual(info.fguid, "") ++ self.assertEqual(info.pci_vendor_id, 0) ++ self.assertEqual(info.pci_subsys_vendor_id, 0) ++ self.assertIn("Linux", info.model_number) ++ self.assertGreater(len(info.serial_number), 0) ++ self.assertGreater(len(info.firmware_ver), 0) ++ self.assertGreater(len(info.nvme_ver), 0) ++ self.assertEqual(info.hmb_min_size, 0) ++ self.assertEqual(info.hmb_pref_size, 0) ++ self.assertEqual(info.num_namespaces, 1024) ++ self.assertEqual(info.selftest_ext_time, 0) ++ self.assertEqual(info.size_total, 0) ++ self.assertEqual(info.size_unalloc, 0) ++ self.assertEqual(info.subsysnqn, "libblockdev_subnqn") ++ ++ @tag_test(TestTags.CORE) ++ def test_smart_log(self): ++ """Test SMART health log""" ++ ++ with self.assertRaisesRegexp(GLib.GError, r".*Failed to open device .*': No such file or directory"): ++ BlockDev.nvme_get_smart_log("/dev/nonexistent") ++ ++ log = BlockDev.nvme_get_smart_log(self.nvme_dev) ++ ++ self.assertEqual(log.avail_spare, 0) ++ self.assertEqual(log.cctemp, 0) ++ self.assertEqual(log.critical_temp_time, 0) ++ self.assertEqual(log.ctrl_busy_time, 0) ++ self.assertEqual(log.media_errors, 0) ++ # self.assertEqual(log.num_err_log_entries, 0) ++ self.assertEqual(log.percent_used, 0) ++ self.assertEqual(log.power_cycles, 0) ++ self.assertEqual(log.power_on_hours, 0) ++ self.assertEqual(log.spare_thresh, 0) ++ self.assertEqual(log.temp_sensors, [0, 0, 0, 0, 0, 0, 0, 0]) ++ self.assertEqual(log.temperature, 0) ++ self.assertGreater(log.total_data_read, 1) ++ self.assertEqual(log.unsafe_shutdowns, 0) ++ self.assertEqual(log.warning_temp_time, 0) ++ self.assertEqual(log.wctemp, 0) ++ self.assertFalse(log.critical_warning & BlockDev.NVMESmartCriticalWarning.SPARE) ++ self.assertFalse(log.critical_warning & BlockDev.NVMESmartCriticalWarning.TEMPERATURE) ++ self.assertFalse(log.critical_warning & BlockDev.NVMESmartCriticalWarning.DEGRADED) ++ self.assertFalse(log.critical_warning & BlockDev.NVMESmartCriticalWarning.READONLY) ++ self.assertFalse(log.critical_warning & BlockDev.NVMESmartCriticalWarning.VOLATILE_MEM) ++ self.assertFalse(log.critical_warning & BlockDev.NVMESmartCriticalWarning.PMR_READONLY) ++ ++ ++ @tag_test(TestTags.CORE) ++ def test_error_log(self): ++ """Test error log retrieval""" ++ ++ with self.assertRaisesRegexp(GLib.GError, r".*Failed to open device .*': No such file or directory"): ++ BlockDev.nvme_get_error_log_entries("/dev/nonexistent") ++ ++ log = BlockDev.nvme_get_error_log_entries(self.nvme_dev) ++ self.assertIsNotNone(log) ++ # TODO: find a way to spoof drive errors ++ ++ ++ @tag_test(TestTags.CORE) ++ def test_self_test_log(self): ++ """Test self-test log retrieval""" ++ ++ with self.assertRaisesRegexp(GLib.GError, r".*Failed to open device .*': No such file or directory"): ++ BlockDev.nvme_get_self_test_log("/dev/nonexistent") ++ ++ message = r"NVMe Get Log Page - Device Self-test Log command error: Invalid Field in Command: A reserved coded value or an unsupported value in a defined field|NVMe Get Log Page - Device Self-test Log command error: unrecognized" ++ with self.assertRaisesRegexp(GLib.GError, message): ++ # Cannot retrieve self-test log on a nvme target loop devices ++ BlockDev.nvme_get_self_test_log(self.nvme_dev) ++ ++ self.assertEqual(BlockDev.nvme_self_test_result_to_string(BlockDev.NVMESelfTestResult.NO_ERROR), "success") ++ self.assertEqual(BlockDev.nvme_self_test_result_to_string(BlockDev.NVMESelfTestResult.ABORTED), "aborted") ++ self.assertEqual(BlockDev.nvme_self_test_result_to_string(BlockDev.NVMESelfTestResult.CTRL_RESET), "ctrl_reset") ++ self.assertEqual(BlockDev.nvme_self_test_result_to_string(BlockDev.NVMESelfTestResult.NS_REMOVED), "ns_removed") ++ self.assertEqual(BlockDev.nvme_self_test_result_to_string(BlockDev.NVMESelfTestResult.ABORTED_FORMAT), "aborted_format") ++ self.assertEqual(BlockDev.nvme_self_test_result_to_string(BlockDev.NVMESelfTestResult.FATAL_ERROR), "fatal_error") ++ self.assertEqual(BlockDev.nvme_self_test_result_to_string(BlockDev.NVMESelfTestResult.UNKNOWN_SEG_FAIL), "unknown_seg_fail") ++ self.assertEqual(BlockDev.nvme_self_test_result_to_string(BlockDev.NVMESelfTestResult.KNOWN_SEG_FAIL), "known_seg_fail") ++ self.assertEqual(BlockDev.nvme_self_test_result_to_string(BlockDev.NVMESelfTestResult.ABORTED_UNKNOWN), "aborted_unknown") ++ self.assertEqual(BlockDev.nvme_self_test_result_to_string(BlockDev.NVMESelfTestResult.ABORTED_SANITIZE), "aborted_sanitize") ++ ++ ++ @tag_test(TestTags.CORE) ++ def test_self_test(self): ++ """Test issuing the self-test command""" ++ ++ with self.assertRaisesRegexp(GLib.GError, r".*Failed to open device .*': No such file or directory"): ++ BlockDev.nvme_device_self_test("/dev/nonexistent", BlockDev.NVMESelfTestAction.SHORT) ++ ++ message = r"Invalid value specified for the self-test action" ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_device_self_test(self.nvme_dev, BlockDev.NVMESelfTestAction.NOT_RUNNING) ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_device_self_test(self.nvme_ns_dev, BlockDev.NVMESelfTestAction.NOT_RUNNING) ++ ++ message = r"NVMe Device Self-test command error: Invalid Command Opcode: A reserved coded value or an unsupported value in the command opcode field|NVMe Device Self-test command error: Invalid Queue Identifier: The creation of the I/O Completion Queue failed due to an invalid queue identifier specified as part of the command" ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_device_self_test(self.nvme_dev, BlockDev.NVMESelfTestAction.SHORT) ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_device_self_test(self.nvme_ns_dev, BlockDev.NVMESelfTestAction.SHORT) ++ ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_device_self_test(self.nvme_dev, BlockDev.NVMESelfTestAction.EXTENDED) ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_device_self_test(self.nvme_ns_dev, BlockDev.NVMESelfTestAction.EXTENDED) ++ ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_device_self_test(self.nvme_dev, BlockDev.NVMESelfTestAction.VENDOR_SPECIFIC) ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_device_self_test(self.nvme_ns_dev, BlockDev.NVMESelfTestAction.VENDOR_SPECIFIC) ++ ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_device_self_test(self.nvme_dev, BlockDev.NVMESelfTestAction.ABORT) ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_device_self_test(self.nvme_ns_dev, BlockDev.NVMESelfTestAction.ABORT) ++ ++ ++ @tag_test(TestTags.CORE) ++ def test_format(self): ++ """Test issuing the format command""" ++ ++ with self.assertRaisesRegexp(GLib.GError, r".*Failed to open device .*': No such file or directory"): ++ BlockDev.nvme_format("/dev/nonexistent", 0, 0, BlockDev.NVMEFormatSecureErase.NONE) ++ ++ message = r"Couldn't match desired LBA data block size in a device supported LBA format data sizes" ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_format(self.nvme_ns_dev, 123, 0, BlockDev.NVMEFormatSecureErase.NONE) ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_format(self.nvme_dev, 123, 0, BlockDev.NVMEFormatSecureErase.NONE) ++ ++ # format doesn't really work on the kernel loop target ++ message = r"Format NVM command error: Invalid Command Opcode: A reserved coded value or an unsupported value in the command opcode field|Format NVM command error: Invalid Queue Identifier: The creation of the I/O Completion Queue failed due to an invalid queue identifier specified as part of the command" ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_format(self.nvme_ns_dev, 0, 0, BlockDev.NVMEFormatSecureErase.NONE) ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_format(self.nvme_dev, 0, 0, BlockDev.NVMEFormatSecureErase.NONE) ++ ++ ++ @tag_test(TestTags.CORE) ++ def test_sanitize_log(self): ++ """Test sanitize log retrieval""" ++ ++ with self.assertRaisesRegexp(GLib.GError, r".*Failed to open device .*': No such file or directory"): ++ BlockDev.nvme_get_sanitize_log("/dev/nonexistent") ++ ++ message = r"NVMe Get Log Page - Sanitize Status Log command error: Invalid Field in Command: A reserved coded value or an unsupported value in a defined field|NVMe Get Log Page - Sanitize Status Log command error: unrecognized" ++ with self.assertRaisesRegexp(GLib.GError, message): ++ # Cannot retrieve sanitize log on a nvme target loop devices ++ BlockDev.nvme_get_sanitize_log(self.nvme_dev) ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_get_sanitize_log(self.nvme_ns_dev) ++ ++ ++ @tag_test(TestTags.CORE) ++ def test_sanitize(self): ++ """Test issuing the sanitize command""" ++ ++ message = r".*Failed to open device .*': No such file or directory" ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_sanitize("/dev/nonexistent", BlockDev.NVMESanitizeAction.BLOCK_ERASE, False, 0, 0, False) ++ ++ message = r"Sanitize command error: Invalid Command Opcode: A reserved coded value or an unsupported value in the command opcode field|Sanitize command error: Invalid Queue Identifier: The creation of the I/O Completion Queue failed due to an invalid queue identifier specified as part of the command" ++ for i in [BlockDev.NVMESanitizeAction.BLOCK_ERASE, BlockDev.NVMESanitizeAction.CRYPTO_ERASE, BlockDev.NVMESanitizeAction.OVERWRITE, BlockDev.NVMESanitizeAction.EXIT_FAILURE]: ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_sanitize(self.nvme_dev, i, False, 0, 0, False) ++ with self.assertRaisesRegexp(GLib.GError, message): ++ BlockDev.nvme_sanitize(self.nvme_ns_dev, i, False, 0, 0, False) ++ ++ ++class NVMeFabricsTestCase(NVMeTest): ++ SUBNQN = 'libblockdev_nvme' ++ ++ def setUp(self): ++ self.loop_devs = [] ++ self.dev_files = [] ++ self.hostnqn = get_nvme_hostnqn() ++ ++ def _setup_target(self, num_devices): ++ self.addCleanup(self._clean_up) ++ for i in range(num_devices): ++ self.dev_files += [create_sparse_tempfile("nvmeof_test%d" % i, 1024**3)] ++ ++ ret, loop = BlockDev.loop_setup(self.dev_files[i]) ++ if not ret: ++ raise RuntimeError("Failed to setup loop device %s for testing" % self.dev_files[i]) ++ self.loop_devs += ["/dev/%s" % loop] ++ setup_nvme_target(self.loop_devs, self.SUBNQN) ++ ++ def _clean_up(self): ++ teardown_nvme_target() ++ ++ # detach loop devices ++ for i in self.loop_devs: ++ BlockDev.loop_teardown(i) ++ for i in self.dev_files: ++ os.unlink(i) ++ ++ def _safe_unlink(self, f): ++ try: ++ os.unlink(f) ++ except FileNotFoundError: ++ pass ++ ++ def _nvme_disconnect(self, subnqn, ignore_errors=False): ++ ret, out, err = run_command("nvme disconnect --nqn=%s" % subnqn) ++ if not ignore_errors and (ret != 0 or 'disconnected 0 ' in out): ++ raise RuntimeError("Error disconnecting the '%s' subsystem NQN: '%s %s'" % (subnqn, out, err)) ++ ++ def _get_sysconf_dir(self): ++ try: ++ makefile = read_file(os.path.join(os.environ['LIBBLOCKDEV_PROJ_DIR'], 'Makefile')) ++ r = re.search(r'sysconfdir = (.*)', makefile) ++ return r.group(1) ++ except: ++ return None ++ ++ @tag_test(TestTags.CORE) ++ def test_connect_single_ns(self): ++ """Test simple connect and disconnect""" ++ ++ # test that no device node exists for given subsystem nqn ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 0) ++ ++ # nothing to disconnect ++ with self.assertRaisesRegexp(GLib.GError, r"No subsystems matching '.*' NQN found."): ++ BlockDev.nvme_disconnect(self.SUBNQN) ++ ++ # nothing to connect to ++ msg = r'Error connecting the controller: ' ++ with self.assertRaisesRegexp(GLib.GError, msg): ++ BlockDev.nvme_connect(self.SUBNQN, 'loop', None, None, None, None, self.hostnqn, None) ++ with self.assertRaisesRegexp(GLib.GError, msg): ++ BlockDev.nvme_connect(self.SUBNQN, 'loop', '127.0.0.1', None, None, None, self.hostnqn, None) ++ with self.assertRaisesRegexp(GLib.GError, msg): ++ BlockDev.nvme_connect(self.SUBNQN, 'loop', None, None, None, None, None, None) ++ ++ self._setup_target(1) ++ ++ # make a connection ++ ret = BlockDev.nvme_connect(self.SUBNQN, 'loop', None, None, None, None, self.hostnqn, None) ++ self.addCleanup(self._nvme_disconnect, self.SUBNQN, ignore_errors=True) ++ self.assertTrue(ret) ++ ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 1) ++ for c in ctrls: ++ self.assertTrue(re.match(r'/dev/nvme[0-9]+', c)) ++ self.assertTrue(os.path.exists(c)) ++ namespaces = find_nvme_ns_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(namespaces), 1) ++ for ns in namespaces: ++ self.assertTrue(re.match(r'/dev/nvme[0-9]+n[0-9]+', ns)) ++ self.assertTrue(os.path.exists(ns)) ++ ++ # make a duplicate connection ++ ret = BlockDev.nvme_connect(self.SUBNQN, 'loop', None, None, None, None, self.hostnqn, None) ++ self.assertTrue(ret) ++ ++ # should see two controllers now ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 2) ++ for c in ctrls: ++ self.assertTrue(re.match(r'/dev/nvme[0-9]+', c)) ++ self.assertTrue(os.path.exists(c)) ++ ++ # disconnect ++ with self.assertRaisesRegexp(GLib.GError, r"No subsystems matching '.*' NQN found."): ++ BlockDev.nvme_disconnect(self.SUBNQN + "xx") ++ with self.assertRaisesRegexp(GLib.GError, r"Unable to match a NVMeoF controller for the specified block device /dev/nvme.*xx"): ++ BlockDev.nvme_disconnect_by_path(ctrls[0] + "xx") ++ # should disconnect both connections as long the SUBNQN matches ++ BlockDev.nvme_disconnect(self.SUBNQN) ++ for c in ctrls: ++ self.assertFalse(os.path.exists(c)) ++ for ns in namespaces: ++ self.assertFalse(os.path.exists(ns)) ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 0) ++ namespaces = find_nvme_ns_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(namespaces), 0) ++ ++ ++ @tag_test(TestTags.CORE) ++ def test_connect_multiple_ns(self): ++ """Test connect and disconnect multiple namespaces""" ++ ++ NUM_NS = 3 ++ ++ # test that no device node exists for given subsystem nqn ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 0) ++ ++ self._setup_target(NUM_NS) ++ ++ # make a connection ++ ret = BlockDev.nvme_connect(self.SUBNQN, 'loop', None, None, None, None, self.hostnqn, None) ++ self.addCleanup(self._nvme_disconnect, self.SUBNQN, ignore_errors=True) ++ self.assertTrue(ret) ++ ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 1) ++ for c in ctrls: ++ self.assertTrue(re.match(r'/dev/nvme[0-9]+', c)) ++ self.assertTrue(os.path.exists(c)) ++ namespaces = find_nvme_ns_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(namespaces), NUM_NS) ++ for ns in namespaces: ++ self.assertTrue(re.match(r'/dev/nvme[0-9]+n[0-9]+', ns)) ++ self.assertTrue(os.path.exists(ns)) ++ ++ # verify the sysfs paths ++ ret, ns_sysfs_path, err = run_command("udevadm info --query=path %s" % ns) ++ if ret != 0: ++ raise RuntimeError("Error getting udev info for %s: '%s'" % (ns, err)) ++ self.assertIsNotNone(ns_sysfs_path) ++ self.assertGreater(len(ns_sysfs_path), 0) ++ ns_sysfs_path = "/sys" + ns_sysfs_path ++ ret, ctrl_sysfs_path, err = run_command("udevadm info --query=path %s" % ctrls[0]) ++ if ret != 0: ++ raise RuntimeError("Error getting udev info for %s: '%s'" % (ctrls[0], err)) ++ self.assertIsNotNone(ctrl_sysfs_path) ++ self.assertGreater(len(ctrl_sysfs_path), 0) ++ ctrl_sysfs_path = "/sys" + ctrl_sysfs_path ++ ++ ctrl_sysfs_paths = BlockDev.nvme_find_ctrls_for_ns(ns_sysfs_path, None, None, None) ++ self.assertIsNotNone(ctrl_sysfs_paths) ++ self.assertEqual(len(ctrl_sysfs_paths), 1) ++ self.assertEqual(ctrl_sysfs_path, ctrl_sysfs_paths[0]) ++ ++ ctrl_sysfs_paths = BlockDev.nvme_find_ctrls_for_ns(ns_sysfs_path + "xxx", None, None, None) ++ self.assertEqual(len(ctrl_sysfs_paths), 0) ++ ctrl_sysfs_paths = BlockDev.nvme_find_ctrls_for_ns(ns_sysfs_path, self.SUBNQN, None, None) ++ self.assertEqual(len(ctrl_sysfs_paths), 1) ++ self.assertEqual(ctrl_sysfs_path, ctrl_sysfs_paths[0]) ++ ctrl_sysfs_paths = BlockDev.nvme_find_ctrls_for_ns(ns_sysfs_path, self.SUBNQN, self.hostnqn, None) ++ self.assertEqual(len(ctrl_sysfs_paths), 1) ++ self.assertEqual(ctrl_sysfs_path, ctrl_sysfs_paths[0]) ++ ++ ctrl_sysfs_paths = BlockDev.nvme_find_ctrls_for_ns(ns_sysfs_path, "unknownsubsysnqn", None, None) ++ self.assertEqual(len(ctrl_sysfs_paths), 0) ++ ctrl_sysfs_paths = BlockDev.nvme_find_ctrls_for_ns(ns_sysfs_path, None, "unknownhostnqn", None) ++ self.assertEqual(len(ctrl_sysfs_paths), 0) ++ ctrl_sysfs_paths = BlockDev.nvme_find_ctrls_for_ns(ns_sysfs_path, self.SUBNQN, "unknownhostnqn", None) ++ self.assertEqual(len(ctrl_sysfs_paths), 0) ++ ctrl_sysfs_paths = BlockDev.nvme_find_ctrls_for_ns(ns_sysfs_path, None, None, "unknownhostid") ++ self.assertEqual(len(ctrl_sysfs_paths), 0) ++ ctrl_sysfs_paths = BlockDev.nvme_find_ctrls_for_ns(ns_sysfs_path, self.SUBNQN, self.hostnqn, "unknownhostid") ++ self.assertEqual(len(ctrl_sysfs_paths), 0) ++ ++ # disconnect ++ BlockDev.nvme_disconnect_by_path(ctrls[0]) ++ for c in ctrls: ++ self.assertFalse(os.path.exists(c)) ++ for ns in namespaces: ++ self.assertFalse(os.path.exists(ns)) ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 0) ++ namespaces = find_nvme_ns_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(namespaces), 0) ++ ++ ++ @tag_test(TestTags.CORE) ++ def test_discovery(self): ++ """Test discovery""" ++ ++ DISCOVERY_NQN = 'nqn.2014-08.org.nvmexpress.discovery' ++ ++ # nvme target unavailable ++ ctrls = find_nvme_ctrl_devs_for_subnqn(DISCOVERY_NQN) ++ self.assertEqual(len(ctrls), 0) ++ with self.assertRaisesRegexp(GLib.GError, r"Invalid discovery controller device specified"): ++ BlockDev.nvme_discover('nonsense', True, 'loop', None, None, None, None, self.hostnqn, None) ++ with self.assertRaisesRegexp(GLib.GError, r"Couldn't access the discovery controller device specified"): ++ BlockDev.nvme_discover('/dev/nvmenonsense', True, 'loop', None, None, None, None, self.hostnqn, None) ++ with self.assertRaisesRegexp(GLib.GError, r"Error connecting the controller: (Input/output error|No such file or directory|failed to write to nvme-fabrics device)"): ++ BlockDev.nvme_discover(None, False, 'loop', None, None, None, None, self.hostnqn, None) ++ ++ self._setup_target(1) ++ ++ # non-persistent discovery connection ++ entries = BlockDev.nvme_discover(None, False, 'loop', None, None, None, None, self.hostnqn, None) ++ self.assertGreater(len(entries), 0) ++ self.assertEqual(entries[0].transport_type, BlockDev.NVMETransportType.LOOP) ++ self.assertEqual(entries[0].address_family, BlockDev.NVMEAddressFamily.PCI) ++ self.assertEqual(entries[0].port_id, 1) ++ self.assertEqual(entries[0].ctrl_id, 65535) ++ self.assertIn(self.SUBNQN, [entry.subsys_nqn for entry in entries]) ++ self.assertEqual(entries[0].tcp_security, BlockDev.NVMETCPSecurity.NONE) ++ ctrls = find_nvme_ctrl_devs_for_subnqn(DISCOVERY_NQN) ++ self.assertEqual(len(ctrls), 0) ++ ++ # persistent discovery connection ++ entries = BlockDev.nvme_discover(None, True, 'loop', None, None, None, None, self.hostnqn, None) ++ self.addCleanup(self._nvme_disconnect, DISCOVERY_NQN, ignore_errors=True) ++ self.assertGreater(len(entries), 0) ++ self.assertIn(self.SUBNQN, [entry.subsys_nqn for entry in entries]) ++ ctrls = find_nvme_ctrl_devs_for_subnqn(DISCOVERY_NQN) ++ self.assertEqual(len(ctrls), 1) ++ ++ # reuse the persistent connection ++ entries = BlockDev.nvme_discover(ctrls[0], False, 'loop', None, None, None, None, self.hostnqn, None) ++ self.assertGreater(len(entries), 0) ++ self.assertIn(self.SUBNQN, [entry.subsys_nqn for entry in entries]) ++ ctrls = find_nvme_ctrl_devs_for_subnqn(DISCOVERY_NQN) ++ self.assertEqual(len(ctrls), 1) ++ ++ # close the persistent connection ++ BlockDev.nvme_disconnect(DISCOVERY_NQN) ++ ++ ++ @tag_test(TestTags.CORE) ++ def test_host_nqn(self): ++ """Test Host NQN/ID manipulation and a simple connect""" ++ ++ HOSTNQN_PATH = '/etc/nvme/hostnqn' ++ HOSTID_PATH = '/etc/nvme/hostid' ++ FAKE_HOSTNQN1 = 'nqn.2014-08.org.nvmexpress:uuid:ffffffff-ffff-ffff-ffff-ffffffffffff' ++ FAKE_HOSTNQN2 = 'nqn.2014-08.org.nvmexpress:uuid:beefbeef-beef-beef-beef-beefdeadbeef' ++ FAKE_HOSTID1 = 'eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee' ++ FAKE_HOSTID2 = 'beefbeef-beef-beef-beef-beefdeadbeef' ++ ++ # libnvme might have been configured with a different prefix than libblockdev ++ sysconf_dir = self._get_sysconf_dir() ++ if sysconf_dir != '/etc': ++ self.skipTest("libblockdev was not configured with standard prefix (/usr)") ++ ++ # test that no device node exists for given subsystem nqn ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 0) ++ ++ # save hostnqn and hostid files ++ try: ++ saved_hostnqn = read_file(HOSTNQN_PATH) ++ self.addCleanup(write_file, HOSTNQN_PATH, saved_hostnqn) ++ except: ++ self.addCleanup(self._safe_unlink, HOSTNQN_PATH) ++ pass ++ try: ++ saved_hostid = read_file(HOSTID_PATH) ++ self.addCleanup(write_file, HOSTID_PATH, saved_hostid) ++ except: ++ self.addCleanup(self._safe_unlink, HOSTID_PATH) ++ pass ++ ++ self._safe_unlink(HOSTNQN_PATH) ++ self._safe_unlink(HOSTID_PATH) ++ hostnqn = BlockDev.nvme_get_host_nqn() ++ self.assertEqual(len(hostnqn), 0) ++ hostnqn = BlockDev.nvme_generate_host_nqn() ++ self.assertTrue(hostnqn.startswith('nqn.2014-08.org.nvmexpress:uuid:')) ++ hostid = BlockDev.nvme_get_host_id() ++ self.assertEqual(len(hostid), 0) ++ ++ # connection without hostnqn set ++ self._setup_target(1) ++ ret = BlockDev.nvme_connect(self.SUBNQN, 'loop', None, None, None, None, None, None) ++ self.addCleanup(self._nvme_disconnect, self.SUBNQN, ignore_errors=True) ++ self.assertTrue(ret) ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 1) ++ sysfs_hostnqn = read_file('/sys/class/nvme/%s/hostnqn' % os.path.basename(ctrls[0])) ++ self.assertEqual(sysfs_hostnqn.strip(), BlockDev.nvme_generate_host_nqn()) ++ BlockDev.nvme_disconnect(self.SUBNQN) ++ ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 0) ++ ++ ret = BlockDev.nvme_connect(self.SUBNQN, 'loop', None, None, None, None, FAKE_HOSTNQN1, FAKE_HOSTID1) ++ self.assertTrue(ret) ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 1) ++ sysfs_hostnqn = read_file('/sys/class/nvme/%s/hostnqn' % os.path.basename(ctrls[0])) ++ sysfs_hostid = read_file('/sys/class/nvme/%s/hostid' % os.path.basename(ctrls[0])) ++ self.assertEqual(sysfs_hostnqn.strip(), FAKE_HOSTNQN1) ++ self.assertEqual(sysfs_hostid.strip(), FAKE_HOSTID1) ++ BlockDev.nvme_disconnect(self.SUBNQN) ++ ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 0) ++ ++ # fill with custom IDs ++ ret = BlockDev.nvme_set_host_nqn(FAKE_HOSTNQN1) ++ self.assertTrue(ret) ++ ret = BlockDev.nvme_set_host_id(FAKE_HOSTID1) ++ self.assertTrue(ret) ++ hostnqn = BlockDev.nvme_get_host_nqn() ++ self.assertEqual(hostnqn, FAKE_HOSTNQN1) ++ hostid = BlockDev.nvme_get_host_id() ++ self.assertEqual(hostid, FAKE_HOSTID1) ++ ++ ret = BlockDev.nvme_connect(self.SUBNQN, 'loop', None, None, None, None, None, None) ++ self.assertTrue(ret) ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 1) ++ sysfs_hostnqn = read_file('/sys/class/nvme/%s/hostnqn' % os.path.basename(ctrls[0])) ++ sysfs_hostid = read_file('/sys/class/nvme/%s/hostid' % os.path.basename(ctrls[0])) ++ self.assertEqual(sysfs_hostnqn.strip(), FAKE_HOSTNQN1) ++ self.assertEqual(sysfs_hostid.strip(), FAKE_HOSTID1) ++ BlockDev.nvme_disconnect(self.SUBNQN) ++ ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 0) ++ ++ ret = BlockDev.nvme_connect(self.SUBNQN, 'loop', None, None, None, None, FAKE_HOSTNQN2, FAKE_HOSTID2) ++ self.assertTrue(ret) ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 1) ++ sysfs_hostnqn = read_file('/sys/class/nvme/%s/hostnqn' % os.path.basename(ctrls[0])) ++ sysfs_hostid = read_file('/sys/class/nvme/%s/hostid' % os.path.basename(ctrls[0])) ++ self.assertEqual(sysfs_hostnqn.strip(), FAKE_HOSTNQN2) ++ self.assertEqual(sysfs_hostid.strip(), FAKE_HOSTID2) ++ BlockDev.nvme_disconnect(self.SUBNQN) ++ ++ ctrls = find_nvme_ctrl_devs_for_subnqn(self.SUBNQN) ++ self.assertEqual(len(ctrls), 0) ++ ++ self._safe_unlink(HOSTNQN_PATH) ++ self._safe_unlink(HOSTID_PATH) +diff --git a/tests/overrides_test.py b/tests/overrides_test.py +index d3faf3cf..903348cd 100644 +--- a/tests/overrides_test.py ++++ b/tests/overrides_test.py +@@ -11,7 +11,8 @@ class OverridesTest(unittest.TestCase): + # the dependencies on CentOS/Debian and we don't need them for this test + requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "dm", + "kbd", "loop", "lvm", +- "mdraid", "part", "swap")) ++ "mdraid", "part", "swap", ++ "nvme")) + + @classmethod + def setUpClass(cls): +diff --git a/tests/run_tests.py b/tests/run_tests.py +index 65c5529c..27e699c6 100644 +--- a/tests/run_tests.py ++++ b/tests/run_tests.py +@@ -14,7 +14,7 @@ import yaml + + from distutils.spawn import find_executable + +-LIBDIRS = 'src/utils/.libs:src/plugins/.libs:src/plugins/fs/.libs:src/lib/.libs' ++LIBDIRS = 'src/utils/.libs:src/plugins/.libs:src/plugins/fs/.libs:src/lib/.libs:src/plugins/nvme/.libs' + GIDIR = 'src/lib' + + SKIP_CONFIG = 'skip.yml' +@@ -188,6 +188,7 @@ if __name__ == '__main__': + + testdir = os.path.abspath(os.path.dirname(__file__)) + projdir = os.path.abspath(os.path.normpath(os.path.join(testdir, '..'))) ++ os.environ['LIBBLOCKDEV_PROJ_DIR'] = projdir + + args = parse_args() + if args.installed: +diff --git a/tests/utils.py b/tests/utils.py +index 584fde5c..354453c3 100644 +--- a/tests/utils.py ++++ b/tests/utils.py +@@ -1,6 +1,7 @@ + from __future__ import print_function + + import os ++import stat + import re + import glob + import subprocess +@@ -9,6 +10,8 @@ import dbus + import unittest + import time + import sys ++import json ++import uuid + from contextlib import contextmanager + from enum import Enum + from itertools import chain +@@ -21,6 +24,7 @@ except ImportError: + DEVNULL = open("/dev/null", "w") + + _lio_devs = dict() ++_nvmet_devs = dict() + + def create_sparse_tempfile(name, size): + """ Create a temporary sparse file. +@@ -209,6 +213,242 @@ def delete_lio_device(dev_path): + else: + raise RuntimeError("Unknown device '%s'" % dev_path) + ++def find_nvme_ctrl_devs_for_subnqn(subnqn): ++ """ ++ Find NVMe controller devices for the specified subsystem nqn ++ ++ :param str subnqn: subsystem nqn ++ """ ++ ++ def _check_subsys(subsys, dev_paths): ++ if subsys['SubsystemNQN'] == subnqn: ++ for ctrl in subsys['Controllers']: ++ path = os.path.join('/dev/', ctrl['Controller']) ++ try: ++ st = os.lstat(path) ++ # nvme controller node is a character device ++ if stat.S_ISCHR(st.st_mode): ++ dev_paths += [path] ++ except: ++ pass ++ ++ ret, out, err = run_command("nvme list --output-format=json --verbose") ++ if ret != 0: ++ raise RuntimeError("Error getting NVMe list: '%s %s'" % (out, err)) ++ ++ decoder = json.JSONDecoder() ++ decoded = decoder.decode(out) ++ if not decoded or 'Devices' not in decoded: ++ return [] ++ ++ dev_paths = [] ++ for dev in decoded['Devices']: ++ # nvme-cli 2.x ++ if 'Subsystems' in dev: ++ for subsys in dev['Subsystems']: ++ _check_subsys(subsys, dev_paths) ++ # nvme-cli 1.x ++ if 'SubsystemNQN' in dev: ++ _check_subsys(dev, dev_paths) ++ ++ return dev_paths ++ ++ ++def find_nvme_ns_devs_for_subnqn(subnqn): ++ """ ++ Find NVMe namespace block devices for the specified subsystem nqn ++ ++ :param str subnqn: subsystem nqn ++ """ ++ ++ def _check_namespaces(node, ns_dev_paths): ++ for ns in node['Namespaces']: ++ path = os.path.join('/dev/', ns['NameSpace']) ++ try: ++ st = os.lstat(path) ++ if stat.S_ISBLK(st.st_mode): ++ ns_dev_paths += [path] ++ except: ++ pass ++ ++ def _check_subsys(subsys, ns_dev_paths): ++ if subsys['SubsystemNQN'] == subnqn: ++ if 'Namespaces' in subsys: ++ _check_namespaces(subsys, ns_dev_paths) ++ # kernel 4.18 ++ if 'Controllers' in subsys: ++ for ctrl in subsys['Controllers']: ++ if 'Namespaces' in ctrl: ++ _check_namespaces(ctrl, ns_dev_paths) ++ ++ ret, out, err = run_command("nvme list --output-format=json --verbose") ++ if ret != 0: ++ raise RuntimeError("Error getting NVMe list: '%s %s'" % (out, err)) ++ ++ decoder = json.JSONDecoder() ++ decoded = decoder.decode(out) ++ if not decoded or 'Devices' not in decoded: ++ return [] ++ ++ ns_dev_paths = [] ++ for dev in decoded['Devices']: ++ # nvme-cli 2.x ++ if 'Subsystems' in dev: ++ for subsys in dev['Subsystems']: ++ _check_subsys(subsys, ns_dev_paths) ++ # nvme-cli 1.x ++ if 'SubsystemNQN' in dev: ++ _check_subsys(dev, ns_dev_paths) ++ ++ return ns_dev_paths ++ ++ ++def get_nvme_hostnqn(): ++ """ ++ Retrieves NVMe host NQN string from /etc/nvme/hostnqn or uses nvme-cli to generate ++ new one (stable, typically generated from machine DMI data) when not available. ++ """ ++ ++ hostnqn = None ++ try: ++ hostnqn = read_file('/etc/nvme/hostnqn') ++ except: ++ pass ++ ++ if hostnqn is None or len(hostnqn.strip()) < 1: ++ ret, hostnqn, err = run_command('nvme gen-hostnqn') ++ if ret != 0: ++ raise RuntimeError("Cannot get host NQN: '%s %s'" % (hostnqn, err)) ++ ++ return hostnqn.strip() ++ ++ ++def setup_nvme_target(dev_paths, subnqn): ++ """ ++ Sets up a new NVMe target loop device (using nvmetcli) on top of the ++ :param:`dev_paths` backing block devices. ++ ++ :param set dev_paths: set of backing block device paths ++ :param str subnqn: Subsystem NQN ++ """ ++ ++ # modprobe required nvme target modules ++ for module in ['nvmet', 'nvme-loop']: ++ ret, out, err = run_command("modprobe %s" % module) ++ if ret != 0: ++ raise RuntimeError("Cannot load required module %s: '%s %s'" % (module, out, err)) ++ ++ # create a JSON file for nvmetcli ++ with tempfile.NamedTemporaryFile(mode='wt',delete=False) as tmp: ++ tcli_json_file = tmp.name ++ namespaces = ",".join([""" ++ {{ ++ "device": {{ ++ "nguid": "{nguid}", ++ "path": "{path}" ++ }}, ++ "enable": 1, ++ "nsid": {nsid} ++ }} ++ """.format(nguid=uuid.uuid4(), path=dev_path, nsid=i) for i, dev_path in enumerate(dev_paths, start=1)]) ++ ++ json = """ ++{ ++ "ports": [ ++ { ++ "addr": { ++ "adrfam": "", ++ "traddr": "", ++ "treq": "not specified", ++ "trsvcid": "", ++ "trtype": "loop" ++ }, ++ "portid": 1, ++ "referrals": [], ++ "subsystems": [ ++ "%s" ++ ] ++ } ++ ], ++ "subsystems": [ ++ { ++ "attr": { ++ "allow_any_host": "1" ++ }, ++ "namespaces": [ ++%s ++ ], ++ "nqn": "%s" ++ } ++ ] ++} ++""" ++ tmp.write(json % (subnqn, namespaces, subnqn)) ++ ++ # export the loop device on the target ++ ret, out, err = run_command("nvmetcli restore %s" % tcli_json_file) ++ os.unlink(tcli_json_file) ++ if ret != 0: ++ raise RuntimeError("Error setting up the NVMe target: '%s %s'" % (out, err)) ++ ++ ++def teardown_nvme_target(): ++ """ ++ Tear down any previously set up kernel nvme target. ++ """ ++ ret, out, err = run_command("nvmetcli clear") ++ if ret != 0: ++ raise RuntimeError("Error clearing the NVMe target: '%s %s'" % (out, err)) ++ ++ ++def create_nvmet_device(dev_path): ++ """ ++ Creates a new NVMe target loop device (using nvmetcli) on top of the ++ :param:`dev_path` backing block device and initiates a connection to it. ++ ++ :param str dev_path: backing block device path ++ :returns: path of the NVMe controller device (e.g. "/dev/nvme0") ++ :rtype: str ++ """ ++ ++ SUBNQN = 'libblockdev_subnqn' ++ hostnqn = get_nvme_hostnqn() ++ ++ setup_nvme_target([dev_path], SUBNQN) ++ ++ # connect initiator to the newly created target ++ (ret, out, err) = run_command("nvme connect --transport=loop --hostnqn=%s --nqn=%s" % (hostnqn, SUBNQN)) ++ if ret != 0: ++ raise RuntimeError("Error connecting to the NVMe target: '%s %s'" % (out, err)) ++ ++ nvme_devs = find_nvme_ctrl_devs_for_subnqn(SUBNQN) ++ if len(nvme_devs) != 1: ++ raise RuntimeError("Error looking up block device for the '%s' nqn" % SUBNQN) ++ ++ _nvmet_devs[nvme_devs[0]] = (SUBNQN, dev_path) ++ return nvme_devs[0] ++ ++ ++def delete_nvmet_device(nvme_dev): ++ """ ++ Logout and tear down previously created NVMe target device. ++ ++ :param str nvme_dev: path of the NVMe device to delete ++ """ ++ if nvme_dev in _nvmet_devs: ++ subnqn, dev_path = _nvmet_devs[nvme_dev] ++ ++ # disconnect the initiator ++ ret, out, err = run_command("nvme disconnect --nqn=%s" % subnqn) ++ if ret != 0: ++ raise RuntimeError("Error disconnecting the '%s' nqn: '%s %s'" % (subnqn, out, err)) ++ ++ # clear the target ++ teardown_nvme_target() ++ else: ++ raise RuntimeError("Unknown device '%s'" % nvme_dev) ++ ++ + def read_file(filename): + with open(filename, "r") as f: + content = f.read() +-- +2.37.3 + diff --git a/SOURCES/0004-Adapt-to-dosfstools-4.2-changes.patch b/SOURCES/0004-Adapt-to-dosfstools-4.2-changes.patch deleted file mode 100644 index a32e4ae..0000000 --- a/SOURCES/0004-Adapt-to-dosfstools-4.2-changes.patch +++ /dev/null @@ -1,296 +0,0 @@ -From cc522ec3717d909370af6181c7859c62fa0167df Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Mon, 22 Feb 2021 15:40:56 +0100 -Subject: [PATCH 1/2] fs: Allow using empty label for vfat with newest - dosfstools - ---- - src/plugins/fs/vfat.c | 11 +++++++++++ - 1 file changed, 11 insertions(+) - -diff --git a/src/plugins/fs/vfat.c b/src/plugins/fs/vfat.c -index ff0c35a3..ce13f147 100644 ---- a/src/plugins/fs/vfat.c -+++ b/src/plugins/fs/vfat.c -@@ -232,10 +232,21 @@ gboolean bd_fs_vfat_repair (const gchar *device, const BDExtraArg **extra, GErro - */ - gboolean bd_fs_vfat_set_label (const gchar *device, const gchar *label, GError **error) { - const gchar *args[4] = {"fatlabel", device, label, NULL}; -+ UtilDep dep = {"fatlabel", "4.2", "--version", "fatlabel\\s+([\\d\\.]+).+"}; -+ gboolean new_vfat = FALSE; - - if (!check_deps (&avail_deps, DEPS_FATLABEL_MASK, deps, DEPS_LAST, &deps_check_lock, error)) - return FALSE; - -+ if (!label || g_strcmp0 (label, "") == 0) { -+ /* fatlabel >= 4.2 refuses to set empty label */ -+ new_vfat = bd_utils_check_util_version (dep.name, dep.version, -+ dep.ver_arg, dep.ver_regexp, -+ NULL); -+ if (new_vfat) -+ args[2] = "--reset"; -+ } -+ - return bd_utils_exec_and_report_error (args, NULL, error); - } - - -From c3c3583409c8ed8f99a840e0c70cc92ca1dd3c93 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Tue, 27 Apr 2021 14:06:59 +0200 -Subject: [PATCH 2/2] tests: Call fs_vfat_mkfs with "--mbr=n" extra option in - tests - -Without the option the newest dosfstools 4.2 will create a valid -MBR partition table with a simgle partition on the disk, see -dosfstools/dosfstools#95 for details. ---- - src/plugins/fs/vfat.c | 5 ++- - tests/fs_test.py | 76 +++++++++++++++++++++++++++++++++---------- - 2 files changed, 62 insertions(+), 19 deletions(-) - -diff --git a/src/plugins/fs/vfat.c b/src/plugins/fs/vfat.c -index ce13f147..6cb82537 100644 ---- a/src/plugins/fs/vfat.c -+++ b/src/plugins/fs/vfat.c -@@ -234,6 +234,7 @@ gboolean bd_fs_vfat_set_label (const gchar *device, const gchar *label, GError * - const gchar *args[4] = {"fatlabel", device, label, NULL}; - UtilDep dep = {"fatlabel", "4.2", "--version", "fatlabel\\s+([\\d\\.]+).+"}; - gboolean new_vfat = FALSE; -+ GError *loc_error = NULL; - - if (!check_deps (&avail_deps, DEPS_FATLABEL_MASK, deps, DEPS_LAST, &deps_check_lock, error)) - return FALSE; -@@ -242,9 +243,11 @@ gboolean bd_fs_vfat_set_label (const gchar *device, const gchar *label, GError * - /* fatlabel >= 4.2 refuses to set empty label */ - new_vfat = bd_utils_check_util_version (dep.name, dep.version, - dep.ver_arg, dep.ver_regexp, -- NULL); -+ &loc_error); - if (new_vfat) - args[2] = "--reset"; -+ else -+ g_clear_error (&loc_error); - } - - return bd_utils_exec_and_report_error (args, NULL, error); -diff --git a/tests/fs_test.py b/tests/fs_test.py -index 239cb47c..2233db4f 100644 ---- a/tests/fs_test.py -+++ b/tests/fs_test.py -@@ -5,10 +5,13 @@ - import tempfile - from contextlib import contextmanager - import utils --from utils import run, create_sparse_tempfile, mount, umount, TestTags, tag_test -+from utils import run, create_sparse_tempfile, mount, umount, TestTags, tag_test, run_command -+import re - import six - import overrides_hack - -+from distutils.version import LooseVersion -+ - from gi.repository import BlockDev, GLib - - -@@ -29,9 +32,20 @@ def mounted(device, where, ro=False): - yield - umount(where) - -+ -+def _get_dosfstools_version(): -+ _ret, out, _err = run_command("mkfs.vfat --help") -+ # mkfs.fat 4.1 (2017-01-24) -+ m = re.search(r"mkfs\.fat ([\d\.]+)", out) -+ if not m or len(m.groups()) != 1: -+ raise RuntimeError("Failed to determine dosfstools version from: %s" % out) -+ return LooseVersion(m.groups()[0]) -+ -+ - class FSTestCase(unittest.TestCase): - - requested_plugins = BlockDev.plugin_specs_from_names(("fs", "loop")) -+ _vfat_version = _get_dosfstools_version() - - @classmethod - def setUpClass(cls): -@@ -66,6 +80,11 @@ def setUp(self): - - self.mount_dir = tempfile.mkdtemp(prefix="libblockdev.", suffix="ext4_test") - -+ if self._vfat_version <= LooseVersion("4.1"): -+ self._mkfs_options = None -+ else: -+ self._mkfs_options = [BlockDev.ExtraArg.new("--mbr=n", "")] -+ - def _clean_up(self): - try: - utils.delete_lio_device(self.loop_dev) -@@ -120,7 +139,10 @@ def test_generic_wipe(self): - - # vfat has multiple signatures on the device so it allows us to test the - # 'all' argument of fs_wipe() -- ret = run("mkfs.vfat -I %s >/dev/null 2>&1" % self.loop_dev) -+ if self._vfat_version >= LooseVersion("4.2"): -+ ret = utils.run("mkfs.vfat -I %s >/dev/null 2>&1 --mbr=n" % self.loop_dev) -+ else: -+ ret = utils.run("mkfs.vfat -I %s >/dev/null 2>&1" % self.loop_dev) - self.assertEqual(ret, 0) - - time.sleep(0.5) -@@ -142,7 +164,10 @@ def test_generic_wipe(self): - self.assertEqual(fs_type, b"") - - # now do the wipe all in a one step -- ret = run("mkfs.vfat -I %s >/dev/null 2>&1" % self.loop_dev) -+ if self._vfat_version >= LooseVersion("4.2"): -+ ret = utils.run("mkfs.vfat -I %s >/dev/null 2>&1 --mbr=n" % self.loop_dev) -+ else: -+ ret = utils.run("mkfs.vfat -I %s >/dev/null 2>&1" % self.loop_dev) - self.assertEqual(ret, 0) - - succ = BlockDev.fs_wipe(self.loop_dev, True) -@@ -197,7 +222,10 @@ def test_clean(self): - - # vfat has multiple signatures on the device so it allows us to test - # that clean removes all signatures -- ret = run("mkfs.vfat -I %s >/dev/null 2>&1" % self.loop_dev) -+ if self._vfat_version >= LooseVersion("4.2"): -+ ret = utils.run("mkfs.vfat -I %s >/dev/null 2>&1 --mbr=n" % self.loop_dev) -+ else: -+ ret = utils.run("mkfs.vfat -I %s >/dev/null 2>&1" % self.loop_dev) - self.assertEqual(ret, 0) - - time.sleep(0.5) -@@ -744,9 +772,9 @@ def test_vfat_mkfs(self): - """Verify that it is possible to create a new vfat file system""" - - with self.assertRaises(GLib.GError): -- BlockDev.fs_vfat_mkfs("/non/existing/device", None) -+ BlockDev.fs_vfat_mkfs("/non/existing/device", self._mkfs_options) - -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, None) -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, self._mkfs_options) - self.assertTrue(succ) - - # just try if we can mount the file system -@@ -764,7 +792,10 @@ def test_vfat_mkfs_with_label(self): - """Verify that it is possible to create an vfat file system with label""" - - ea = BlockDev.ExtraArg.new("-n", "TEST_LABEL") -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, [ea]) -+ if self._mkfs_options: -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, [ea] + self._mkfs_options) -+ else: -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, [ea]) - self.assertTrue(succ) - - fi = BlockDev.fs_vfat_get_info(self.loop_dev) -@@ -775,7 +806,7 @@ class VfatTestWipe(FSTestCase): - def test_vfat_wipe(self): - """Verify that it is possible to wipe an vfat file system""" - -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, None) -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, self._mkfs_options) - self.assertTrue(succ) - - succ = BlockDev.fs_vfat_wipe(self.loop_dev) -@@ -805,7 +836,7 @@ class VfatTestCheck(FSTestCase): - def test_vfat_check(self): - """Verify that it is possible to check an vfat file system""" - -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, None) -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, self._mkfs_options) - self.assertTrue(succ) - - succ = BlockDev.fs_vfat_check(self.loop_dev, None) -@@ -818,7 +849,7 @@ class VfatTestRepair(FSTestCase): - def test_vfat_repair(self): - """Verify that it is possible to repair an vfat file system""" - -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, None) -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, self._mkfs_options) - self.assertTrue(succ) - - succ = BlockDev.fs_vfat_repair(self.loop_dev, None) -@@ -828,7 +859,7 @@ class VfatGetInfo(FSTestCase): - def test_vfat_get_info(self): - """Verify that it is possible to get info about an vfat file system""" - -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, None) -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, self._mkfs_options) - self.assertTrue(succ) - - fi = BlockDev.fs_vfat_get_info(self.loop_dev) -@@ -841,7 +872,7 @@ class VfatSetLabel(FSTestCase): - def test_vfat_set_label(self): - """Verify that it is possible to set label of an vfat file system""" - -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, None) -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, self._mkfs_options) - self.assertTrue(succ) - - fi = BlockDev.fs_vfat_get_info(self.loop_dev) -@@ -870,7 +901,7 @@ class VfatResize(FSTestCase): - def test_vfat_resize(self): - """Verify that it is possible to resize an vfat file system""" - -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, None) -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, self._mkfs_options) - self.assertTrue(succ) - - # shrink -@@ -999,7 +1030,7 @@ def _remove_user(self): - def test_mount(self): - """ Test basic mounting and unmounting """ - -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, None) -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, self._mkfs_options) - self.assertTrue(succ) - - tmp = tempfile.mkdtemp(prefix="libblockdev.", suffix="mount_test") -@@ -1104,7 +1135,7 @@ def test_mount_fstab(self): - fstab = utils.read_file("/etc/fstab") - self.addCleanup(utils.write_file, "/etc/fstab", fstab) - -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, None) -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, self._mkfs_options) - self.assertTrue(succ) - - tmp = tempfile.mkdtemp(prefix="libblockdev.", suffix="mount_fstab_test") -@@ -1139,7 +1170,7 @@ def test_mount_fstab_user(self): - fstab = utils.read_file("/etc/fstab") - self.addCleanup(utils.write_file, "/etc/fstab", fstab) - -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, None) -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, self._mkfs_options) - self.assertTrue(succ) - - tmp = tempfile.mkdtemp(prefix="libblockdev.", suffix="mount_fstab_user_test") -@@ -1423,7 +1454,16 @@ def expected_size(fi): - @tag_test(TestTags.UNSTABLE) - def test_vfat_generic_resize(self): - """Test generic resize function with a vfat file system""" -- self._test_generic_resize(mkfs_function=BlockDev.fs_vfat_mkfs) -+ def mkfs_vfat(device, options=None): -+ if self._vfat_version >= LooseVersion("4.2"): -+ if options: -+ return BlockDev.fs_vfat_mkfs(device, options + [BlockDev.ExtraArg.new("--mbr=n", "")]) -+ else: -+ return BlockDev.fs_vfat_mkfs(device, [BlockDev.ExtraArg.new("--mbr=n", "")]) -+ else: -+ return BlockDev.fs_vfat_mkfs(device, options) -+ -+ self._test_generic_resize(mkfs_function=mkfs_vfat) - - def _destroy_lvm(self): - run("vgremove --yes libbd_fs_tests >/dev/null 2>&1") -@@ -1539,7 +1579,7 @@ def test_freeze_xfs(self): - def test_freeze_vfat(self): - """ Test basic freezing and un-freezing with FAT """ - -- succ = BlockDev.fs_vfat_mkfs(self.loop_dev, None) -+ succ = BlockDev.fs_vfat_mkfs(self.loop_dev, self._mkfs_options) - self.assertTrue(succ) - - tmp = tempfile.mkdtemp(prefix="libblockdev.", suffix="freeze_test") diff --git a/SOURCES/0004-Fix-double-free-in-write_escrow_data_file.patch b/SOURCES/0004-Fix-double-free-in-write_escrow_data_file.patch new file mode 100644 index 0000000..4a5ee67 --- /dev/null +++ b/SOURCES/0004-Fix-double-free-in-write_escrow_data_file.patch @@ -0,0 +1,59 @@ +From 7a0e344d0642f76992c943158621d8ee7e5caea3 Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Tue, 15 Nov 2022 13:21:25 +0100 +Subject: [PATCH 1/2] crypto: Fix GError overwrite from libvolume_key + +--- + src/plugins/crypto.c | 7 ++++--- + 1 file changed, 4 insertions(+), 3 deletions(-) + +diff --git a/src/plugins/crypto.c b/src/plugins/crypto.c +index 35c38410..9064c8e3 100644 +--- a/src/plugins/crypto.c ++++ b/src/plugins/crypto.c +@@ -2552,13 +2552,14 @@ static gboolean write_escrow_data_file (struct libvk_volume *volume, struct libv + GIOChannel *out_file = NULL; + GIOStatus status = G_IO_STATUS_ERROR; + gsize bytes_written = 0; ++ GError *l_error = NULL; + + packet_data = libvk_volume_create_packet_asymmetric_with_format (volume, &packet_data_size, secret_type, cert, +- ui, LIBVK_PACKET_FORMAT_ASYMMETRIC_WRAP_SECRET_ONLY, error); +- ++ ui, LIBVK_PACKET_FORMAT_ASYMMETRIC_WRAP_SECRET_ONLY, &l_error); + if (!packet_data) { + g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_ESCROW_FAILED, +- "Failed to get escrow data"); ++ "Failed to get escrow data: %s", l_error->message); ++ g_clear_error (&l_error); + libvk_volume_free (volume); + return FALSE; + } +-- +2.38.1 + + +From 25bf34c4c03e37eb3782dfccf459b9a3f795ddb3 Mon Sep 17 00:00:00 2001 +From: Vojtech Trefny +Date: Wed, 16 Nov 2022 10:26:06 +0100 +Subject: [PATCH 2/2] crypto: Fix double free in write_escrow_data_file + +--- + src/plugins/crypto.c | 1 - + 1 file changed, 1 deletion(-) + +diff --git a/src/plugins/crypto.c b/src/plugins/crypto.c +index 9064c8e3..2086209e 100644 +--- a/src/plugins/crypto.c ++++ b/src/plugins/crypto.c +@@ -2560,7 +2560,6 @@ static gboolean write_escrow_data_file (struct libvk_volume *volume, struct libv + g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_ESCROW_FAILED, + "Failed to get escrow data: %s", l_error->message); + g_clear_error (&l_error); +- libvk_volume_free (volume); + return FALSE; + } + +-- +2.38.1 + diff --git a/SOURCES/0005-Add-workarounds-for-some-LVM-test-issues.patch b/SOURCES/0005-Add-workarounds-for-some-LVM-test-issues.patch deleted file mode 100644 index c41d687..0000000 --- a/SOURCES/0005-Add-workarounds-for-some-LVM-test-issues.patch +++ /dev/null @@ -1,157 +0,0 @@ -From 7c31cc534f96766dd2e3427b09d0affca66b0745 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Tue, 23 Mar 2021 13:54:02 +0100 -Subject: [PATCH 1/3] tests: Do not try to remove VG before removing the VDO - pool - ---- - tests/lvm_dbus_tests.py | 6 +++--- - tests/lvm_test.py | 6 +++--- - 2 files changed, 6 insertions(+), 6 deletions(-) - -diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py -index 8f2bb95d..b599fdd0 100644 ---- a/tests/lvm_dbus_tests.py -+++ b/tests/lvm_dbus_tests.py -@@ -1517,14 +1517,14 @@ def setUp(self): - self.assertTrue(succ) - - def _clean_up(self): -- BlockDev.lvm_vgremove("testVDOVG") -- BlockDev.lvm_pvremove(self.loop_dev) -- - try: - BlockDev.lvm_lvremove("testVDOVG", "vdoPool", True, None) - except: - pass - -+ BlockDev.lvm_vgremove("testVDOVG") -+ BlockDev.lvm_pvremove(self.loop_dev) -+ - try: - delete_lio_device(self.loop_dev) - except RuntimeError: -diff --git a/tests/lvm_test.py b/tests/lvm_test.py -index 6f80a3ba..6c04faf9 100644 ---- a/tests/lvm_test.py -+++ b/tests/lvm_test.py -@@ -1437,14 +1437,14 @@ def setUp(self): - self.assertTrue(succ) - - def _clean_up(self): -- BlockDev.lvm_vgremove("testVDOVG") -- BlockDev.lvm_pvremove(self.loop_dev) -- - try: - BlockDev.lvm_lvremove("testVDOVG", "vdoPool", True, None) - except: - pass - -+ BlockDev.lvm_vgremove("testVDOVG") -+ BlockDev.lvm_pvremove(self.loop_dev) -+ - try: - delete_lio_device(self.loop_dev) - except RuntimeError: - -From 41b9d745b8c1a33221e15683f390bae180d1e960 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Tue, 23 Mar 2021 13:59:24 +0100 -Subject: [PATCH 2/3] tests: Force remove LVM VG /dev/ entry not removed by - vgremove - -The directory is sometimes not removed. This is a known bug that -causes subsequent test cases to fail. ---- - tests/lvm_dbus_tests.py | 6 ++++++ - tests/lvm_test.py | 6 ++++++ - 2 files changed, 12 insertions(+) - -diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py -index b599fdd0..3278716e 100644 ---- a/tests/lvm_dbus_tests.py -+++ b/tests/lvm_dbus_tests.py -@@ -399,6 +399,9 @@ def _clean_up(self): - except: - pass - -+ # XXX remove lingering /dev entries -+ shutil.rmtree("/dev/testVG", ignore_errors=True) -+ - LvmPVonlyTestCase._clean_up(self) - - @unittest.skipUnless(lvm_dbus_running, "LVM DBus not running") -@@ -1525,6 +1528,9 @@ def _clean_up(self): - BlockDev.lvm_vgremove("testVDOVG") - BlockDev.lvm_pvremove(self.loop_dev) - -+ # XXX remove lingering /dev entries -+ shutil.rmtree("/dev/testVDOVG", ignore_errors=True) -+ - try: - delete_lio_device(self.loop_dev) - except RuntimeError: -diff --git a/tests/lvm_test.py b/tests/lvm_test.py -index 6c04faf9..d7e1f84c 100644 ---- a/tests/lvm_test.py -+++ b/tests/lvm_test.py -@@ -378,6 +378,9 @@ def _clean_up(self): - except: - pass - -+ # XXX remove lingering /dev entries -+ shutil.rmtree("/dev/testVG", ignore_errors=True) -+ - LvmPVonlyTestCase._clean_up(self) - - class LvmTestVGcreateRemove(LvmPVVGTestCase): -@@ -1445,6 +1448,9 @@ def _clean_up(self): - BlockDev.lvm_vgremove("testVDOVG") - BlockDev.lvm_pvremove(self.loop_dev) - -+ # XXX remove lingering /dev entries -+ shutil.rmtree("/dev/testVDOVG", ignore_errors=True) -+ - try: - delete_lio_device(self.loop_dev) - except RuntimeError: - -From 4ecf0075cedf3a1d275d34b94ce5bb512c4e970e Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Tue, 23 Mar 2021 14:03:44 +0100 -Subject: [PATCH 3/3] tests: Tag LvmPVVGLVcachePoolCreateRemoveTestCase as - unstable - -LVM randomly fails to activate the newly created metadata LV. -Issue is reported to LVM and not yet fixed. ---- - tests/lvm_dbus_tests.py | 2 +- - tests/lvm_test.py | 2 +- - 2 files changed, 2 insertions(+), 2 deletions(-) - -diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py -index 3278716e..4882da88 100644 ---- a/tests/lvm_dbus_tests.py -+++ b/tests/lvm_dbus_tests.py -@@ -1213,7 +1213,7 @@ def _clean_up(self): - - @unittest.skipUnless(lvm_dbus_running, "LVM DBus not running") - class LvmPVVGLVcachePoolCreateRemoveTestCase(LvmPVVGLVcachePoolTestCase): -- @tag_test(TestTags.SLOW) -+ @tag_test(TestTags.SLOW, TestTags.UNSTABLE) - def test_cache_pool_create_remove(self): - """Verify that is it possible to create and remove a cache pool""" - -diff --git a/tests/lvm_test.py b/tests/lvm_test.py -index d7e1f84c..eb94c917 100644 ---- a/tests/lvm_test.py -+++ b/tests/lvm_test.py -@@ -1129,7 +1129,7 @@ def _clean_up(self): - LvmPVVGLVTestCase._clean_up(self) - - class LvmPVVGLVcachePoolCreateRemoveTestCase(LvmPVVGLVcachePoolTestCase): -- @tag_test(TestTags.SLOW) -+ @tag_test(TestTags.SLOW, TestTags.UNSTABLE) - def test_cache_pool_create_remove(self): - """Verify that is it possible to create and remove a cache pool""" - diff --git a/SOURCES/0005-nvme-Fix-namespace-identifiers.patch b/SOURCES/0005-nvme-Fix-namespace-identifiers.patch new file mode 100644 index 0000000..7334ff1 --- /dev/null +++ b/SOURCES/0005-nvme-Fix-namespace-identifiers.patch @@ -0,0 +1,506 @@ +From b25fd9caca9b2fb34e5a4d7d4bee0031e4758d0a Mon Sep 17 00:00:00 2001 +From: Tomas Bzatek +Date: Thu, 22 Sep 2022 16:31:28 +0200 +Subject: [PATCH 1/5] nvme: Avoid sending NVME_IDENTIFY_CNS_NS_DESC_LIST on + older devices + +Turned out this Identify feature was introduced only with the NVMe 1.3 +specification. To find out device supported NVMe revision an extra +Identify Controller call is needed. +--- + src/plugins/nvme/nvme-info.c | 14 +++++++++++--- + 1 file changed, 11 insertions(+), 3 deletions(-) + +diff --git a/src/plugins/nvme/nvme-info.c b/src/plugins/nvme/nvme-info.c +index fdd90459..112b4054 100644 +--- a/src/plugins/nvme/nvme-info.c ++++ b/src/plugins/nvme/nvme-info.c +@@ -431,7 +431,7 @@ BDNVMEControllerInfo * bd_nvme_get_controller_info (const gchar *device, GError + if (fd < 0) + return NULL; + +- /* send the NVME_IDENTIFY_CNS_NS + NVME_IDENTIFY_CNS_CTRL ioctl */ ++ /* send the NVME_IDENTIFY_CNS_CTRL ioctl */ + ret = nvme_identify_ctrl (fd, &ctrl_id); + if (ret != 0) { + _nvme_status_to_error (ret, FALSE, error); +@@ -539,9 +539,11 @@ BDNVMEControllerInfo * bd_nvme_get_controller_info (const gchar *device, GError + */ + BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **error) { + int ret; +- int ret_desc; ++ int ret_ctrl; ++ int ret_desc = -1; + int fd; + __u32 nsid = 0; ++ struct nvme_id_ctrl ctrl_id = ZERO_INIT; + struct nvme_id_ns ns_info = ZERO_INIT; + uint8_t desc[NVME_IDENTIFY_DATA_SIZE] = ZERO_INIT; + guint8 flbas; +@@ -565,7 +567,6 @@ BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **e + } + + /* send the NVME_IDENTIFY_CNS_NS ioctl */ +- ret_desc = nvme_identify_ns_descs (fd, nsid, (struct nvme_ns_id_desc *) &desc); + ret = nvme_identify_ns (fd, nsid, &ns_info); + if (ret != 0) { + _nvme_status_to_error (ret, FALSE, error); +@@ -573,6 +574,13 @@ BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **e + close (fd); + return NULL; + } ++ ++ /* send the NVME_IDENTIFY_CNS_CTRL ioctl */ ++ ret_ctrl = nvme_identify_ctrl (fd, &ctrl_id); ++ ++ /* send the NVME_IDENTIFY_CNS_NS_DESC_LIST ioctl, NVMe 1.3 */ ++ if (ret_ctrl == 0 && GUINT32_FROM_LE (ctrl_id.ver) >= 0x10300) ++ ret_desc = nvme_identify_ns_descs (fd, nsid, (struct nvme_ns_id_desc *) &desc); + close (fd); + + info = g_new0 (BDNVMENamespaceInfo, 1); +-- +2.39.0 + + +From e6f7d0c4562623b03df96dc6b89ab00d8e4d6b90 Mon Sep 17 00:00:00 2001 +From: Tomas Bzatek +Date: Thu, 22 Sep 2022 16:56:26 +0200 +Subject: [PATCH 2/5] nvme: Add BD_NVME_NS_FEAT_ROTATIONAL + +A NVMe 2.0 feature indicating rotational medium on a namespace level. +Further information can be found in the Rotational Media Information Log +page (Log Identifier 16h) that is not implemented in libblockdev yet. +--- + src/lib/plugin_apis/nvme.api | 2 ++ + src/plugins/nvme/nvme-info.c | 10 ++++++++++ + src/plugins/nvme/nvme.h | 2 ++ + tests/nvme_test.py | 1 + + 4 files changed, 15 insertions(+) + +diff --git a/src/lib/plugin_apis/nvme.api b/src/lib/plugin_apis/nvme.api +index 79247a01..7bc2cf9e 100644 +--- a/src/lib/plugin_apis/nvme.api ++++ b/src/lib/plugin_apis/nvme.api +@@ -317,12 +317,14 @@ GType bd_nvme_lba_format_get_type () { + * in the NVM subsystem concurrently. + * @BD_NVME_NS_FEAT_FORMAT_PROGRESS: indicates the capability to report the percentage of the namespace + * that remains to be formatted. ++ * @BD_NVME_NS_FEAT_ROTATIONAL: indicates a rotational medium. + */ + /* BpG-skip-end */ + typedef enum { + BD_NVME_NS_FEAT_THIN = 1 << 0, + BD_NVME_NS_FEAT_MULTIPATH_SHARED = 1 << 1, + BD_NVME_NS_FEAT_FORMAT_PROGRESS = 1 << 2, ++ BD_NVME_NS_FEAT_ROTATIONAL = 1 << 3, + } BDNVMENamespaceFeature; + + #define BD_NVME_TYPE_NAMESPACE_INFO (bd_nvme_namespace_info_get_type ()) +diff --git a/src/plugins/nvme/nvme-info.c b/src/plugins/nvme/nvme-info.c +index 112b4054..c574a6f3 100644 +--- a/src/plugins/nvme/nvme-info.c ++++ b/src/plugins/nvme/nvme-info.c +@@ -541,10 +541,12 @@ BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **e + int ret; + int ret_ctrl; + int ret_desc = -1; ++ int ret_ns_ind = -1; + int fd; + __u32 nsid = 0; + struct nvme_id_ctrl ctrl_id = ZERO_INIT; + struct nvme_id_ns ns_info = ZERO_INIT; ++ struct nvme_id_independent_id_ns ns_info_ind = ZERO_INIT; + uint8_t desc[NVME_IDENTIFY_DATA_SIZE] = ZERO_INIT; + guint8 flbas; + guint i; +@@ -581,6 +583,10 @@ BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **e + /* send the NVME_IDENTIFY_CNS_NS_DESC_LIST ioctl, NVMe 1.3 */ + if (ret_ctrl == 0 && GUINT32_FROM_LE (ctrl_id.ver) >= 0x10300) + ret_desc = nvme_identify_ns_descs (fd, nsid, (struct nvme_ns_id_desc *) &desc); ++ ++ /* send the NVME_IDENTIFY_CNS_CSI_INDEPENDENT_ID_NS ioctl, NVMe 2.0 */ ++ if (ret_ctrl == 0 && GUINT32_FROM_LE (ctrl_id.ver) >= 0x20000) ++ ret_ns_ind = nvme_identify_independent_identify_ns (fd, nsid, &ns_info_ind); + close (fd); + + info = g_new0 (BDNVMENamespaceInfo, 1); +@@ -627,6 +633,10 @@ BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **e + } + } + } ++ if (ret_ns_ind == 0) { ++ if ((ns_info_ind.nsfeat & 1 << 4) == 1 << 4) ++ info->features |= BD_NVME_NS_FEAT_ROTATIONAL; ++ } + + /* translate the LBA Format array */ + ptr_array = g_ptr_array_new (); +diff --git a/src/plugins/nvme/nvme.h b/src/plugins/nvme/nvme.h +index a7d30d79..ad456a82 100644 +--- a/src/plugins/nvme/nvme.h ++++ b/src/plugins/nvme/nvme.h +@@ -202,11 +202,13 @@ typedef struct BDNVMELBAFormat { + * in the NVM subsystem concurrently. + * @BD_NVME_NS_FEAT_FORMAT_PROGRESS: indicates the capability to report the percentage of the namespace + * that remains to be formatted. ++ * @BD_NVME_NS_FEAT_ROTATIONAL: indicates a rotational medium. + */ + typedef enum { + BD_NVME_NS_FEAT_THIN = 1 << 0, + BD_NVME_NS_FEAT_MULTIPATH_SHARED = 1 << 1, + BD_NVME_NS_FEAT_FORMAT_PROGRESS = 1 << 2, ++ BD_NVME_NS_FEAT_ROTATIONAL = 1 << 3, + } BDNVMENamespaceFeature; + + /** +diff --git a/tests/nvme_test.py b/tests/nvme_test.py +index a46f7422..f205e539 100644 +--- a/tests/nvme_test.py ++++ b/tests/nvme_test.py +@@ -73,6 +73,7 @@ class NVMeTestCase(NVMeTest): + self.assertFalse(info.features & BlockDev.NVMENamespaceFeature.THIN) + self.assertTrue (info.features & BlockDev.NVMENamespaceFeature.MULTIPATH_SHARED) + self.assertFalse(info.features & BlockDev.NVMENamespaceFeature.FORMAT_PROGRESS) ++ self.assertFalse(info.features & BlockDev.NVMENamespaceFeature.ROTATIONAL) + self.assertEqual(info.eui64, "0000000000000000") + self.assertEqual(info.format_progress_remaining, 0) + self.assertEqual(len(info.lba_formats), 1) +-- +2.39.0 + + +From 4ff0df937dcd357623e7b7d960c08c476b1deffb Mon Sep 17 00:00:00 2001 +From: Tomas Bzatek +Date: Fri, 9 Dec 2022 16:13:43 +0100 +Subject: [PATCH 3/5] nvme: Fix namespace identifiers + +Use Namespace Identification Descriptor list (CNS 03h) data when available +and NVM Command Set Identify Namespace Data Structure (CNS 00h) as a fallback. + +Also, if the CNS 00h EUI64 or NGUID fields equal to zero, return NULL +instead of zeroes: + "If the controller is not able to provide a ... identifier in this field, + then this field shall be cleared to 0h." +--- + src/plugins/nvme/nvme-info.c | 26 +++++++++++++++++++------- + tests/nvme_test.py | 2 +- + 2 files changed, 20 insertions(+), 8 deletions(-) + +diff --git a/src/plugins/nvme/nvme-info.c b/src/plugins/nvme/nvme-info.c +index c574a6f3..ac189abe 100644 +--- a/src/plugins/nvme/nvme-info.c ++++ b/src/plugins/nvme/nvme-info.c +@@ -603,12 +603,7 @@ BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **e + info->format_progress_remaining = ns_info.fpi & NVME_NS_FPI_REMAINING; + /* TODO: what the ns_info.nvmcap really stands for? */ + info->write_protected = (ns_info.nsattr & NVME_NS_NSATTR_WRITE_PROTECTED) == NVME_NS_NSATTR_WRITE_PROTECTED; +- info->nguid = g_malloc0 (sizeof (ns_info.nguid) * 2 + 1); +- for (i = 0; i < G_N_ELEMENTS (ns_info.nguid); i++) +- snprintf (info->nguid + i * 2, 3, "%02x", ns_info.nguid[i]); +- info->eui64 = g_malloc0 (sizeof (ns_info.eui64) * 2 + 1); +- for (i = 0; i < G_N_ELEMENTS (ns_info.eui64); i++) +- snprintf (info->eui64 + i * 2, 3, "%02x", ns_info.eui64[i]); ++ + if (ret_desc == 0) { + for (i = 0; i < NVME_IDENTIFY_DATA_SIZE; i += len) { + struct nvme_ns_id_desc *d = (void *) desc + i; +@@ -620,8 +615,14 @@ BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **e + + switch (d->nidt) { + case NVME_NIDT_EUI64: ++ info->eui64 = g_malloc0 (d->nidl * 2 + 1); ++ for (i = 0; i < d->nidl; i++) ++ snprintf (info->eui64 + i * 2, 3, "%02x", d->nid[i]); ++ break; + case NVME_NIDT_NGUID: +- /* already have these from nvme_identify_ns() */ ++ info->nguid = g_malloc0 (d->nidl * 2 + 1); ++ for (i = 0; i < d->nidl; i++) ++ snprintf (info->nguid + i * 2, 3, "%02x", d->nid[i]); + break; + case NVME_NIDT_UUID: + uuid_unparse (d->nid, uuid_buf); +@@ -633,6 +634,17 @@ BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **e + } + } + } ++ ++ if (info->nguid == NULL && ns_info.nguid[G_N_ELEMENTS (ns_info.nguid) - 1] > 0) { ++ info->nguid = g_malloc0 (sizeof (ns_info.nguid) * 2 + 1); ++ for (i = 0; i < G_N_ELEMENTS (ns_info.nguid); i++) ++ snprintf (info->nguid + i * 2, 3, "%02x", ns_info.nguid[i]); ++ } ++ if (info->eui64 == NULL && ns_info.eui64[G_N_ELEMENTS (ns_info.eui64) - 1] > 0) { ++ info->eui64 = g_malloc0 (sizeof (ns_info.eui64) * 2 + 1); ++ for (i = 0; i < G_N_ELEMENTS (ns_info.eui64); i++) ++ snprintf (info->eui64 + i * 2, 3, "%02x", ns_info.eui64[i]); ++ } + if (ret_ns_ind == 0) { + if ((ns_info_ind.nsfeat & 1 << 4) == 1 << 4) + info->features |= BD_NVME_NS_FEAT_ROTATIONAL; +diff --git a/tests/nvme_test.py b/tests/nvme_test.py +index f205e539..a1822be6 100644 +--- a/tests/nvme_test.py ++++ b/tests/nvme_test.py +@@ -74,7 +74,7 @@ class NVMeTestCase(NVMeTest): + self.assertTrue (info.features & BlockDev.NVMENamespaceFeature.MULTIPATH_SHARED) + self.assertFalse(info.features & BlockDev.NVMENamespaceFeature.FORMAT_PROGRESS) + self.assertFalse(info.features & BlockDev.NVMENamespaceFeature.ROTATIONAL) +- self.assertEqual(info.eui64, "0000000000000000") ++ self.assertIsNone(info.eui64) + self.assertEqual(info.format_progress_remaining, 0) + self.assertEqual(len(info.lba_formats), 1) + self.assertGreater(len(info.nguid), 0) +-- +2.39.0 + + +From cdbb9a37a19d3f388910f68c4c384bafae8901ae Mon Sep 17 00:00:00 2001 +From: Tomas Bzatek +Date: Wed, 11 Jan 2023 18:19:36 +0100 +Subject: [PATCH 4/5] nvme: Use libnvme-1.2's nvme_uuid_to_string() + +This also bumps libnvme dependency to 1.2 +--- + configure.ac | 5 +---- + src/plugins/nvme/Makefile.am | 4 ++-- + src/plugins/nvme/nvme-error.c | 3 --- + src/plugins/nvme/nvme-fabrics.c | 1 - + src/plugins/nvme/nvme-info.c | 17 ++++++++++------- + src/plugins/nvme/nvme-op.c | 1 - + src/plugins/nvme/nvme.c | 1 - + 7 files changed, 13 insertions(+), 19 deletions(-) + +diff --git a/configure.ac b/configure.ac +index ec789c91..fbd70473 100644 +--- a/configure.ac ++++ b/configure.ac +@@ -281,10 +281,7 @@ AS_IF([test "x$with_nvdimm" != "xno"], + []) + + AS_IF([test "x$with_nvme" != "xno"], +- [LIBBLOCKDEV_PKG_CHECK_MODULES([NVME], [libnvme >= 1.0]) +- AS_IF([$PKG_CONFIG --atleast-version=1.1 libnvme], +- [AC_DEFINE([HAVE_LIBNVME_1_1])], []) +- ], ++ [LIBBLOCKDEV_PKG_CHECK_MODULES([NVME], [libnvme >= 1.2])], + []) + + AS_IF([test "x$with_vdo" != "xno"], +diff --git a/src/plugins/nvme/Makefile.am b/src/plugins/nvme/Makefile.am +index b4a10ce0..a8a856d4 100644 +--- a/src/plugins/nvme/Makefile.am ++++ b/src/plugins/nvme/Makefile.am +@@ -2,8 +2,8 @@ AUTOMAKE_OPTIONS = subdir-objects + + lib_LTLIBRARIES = libbd_nvme.la + +-libbd_nvme_la_CFLAGS = $(GLIB_CFLAGS) $(GIO_CFLAGS) $(UUID_CFLAGS) $(NVME_CFLAGS) -Wall -Wextra -Werror +-libbd_nvme_la_LIBADD = ${builddir}/../../utils/libbd_utils.la $(GLIB_LIBS) $(GIO_LIBS) $(UUID_LIBS) $(NVME_LIBS) ++libbd_nvme_la_CFLAGS = $(GLIB_CFLAGS) $(GIO_CFLAGS) $(NVME_CFLAGS) -Wall -Wextra -Werror ++libbd_nvme_la_LIBADD = ${builddir}/../../utils/libbd_utils.la $(GLIB_LIBS) $(GIO_LIBS) $(NVME_LIBS) + libbd_nvme_la_LDFLAGS = -L${srcdir}/../../utils/ -version-info 2:0:0 -Wl,--no-undefined + libbd_nvme_la_CPPFLAGS = -I${builddir}/../../../include/ -I${srcdir}/../ -I. -DPACKAGE_SYSCONF_DIR=\""$(sysconfdir)"\" + +diff --git a/src/plugins/nvme/nvme-error.c b/src/plugins/nvme/nvme-error.c +index 86f0d6a3..cb95a46d 100644 +--- a/src/plugins/nvme/nvme-error.c ++++ b/src/plugins/nvme/nvme-error.c +@@ -28,7 +28,6 @@ + #include + + #include +-#include + + #include + #include +@@ -123,7 +122,6 @@ void _nvme_fabrics_errno_to_gerror (int result, int _errno, GError **error) + case ENVME_CONNECT_LOOKUP_SUBSYS: + code = BD_NVME_ERROR_CONNECT; + break; +-#ifdef HAVE_LIBNVME_1_1 + case ENVME_CONNECT_ALREADY: + code = BD_NVME_ERROR_CONNECT_ALREADY; + break; +@@ -139,7 +137,6 @@ void _nvme_fabrics_errno_to_gerror (int result, int _errno, GError **error) + case ENVME_CONNECT_OPNOTSUPP: + code = BD_NVME_ERROR_CONNECT_OPNOTSUPP; + break; +-#endif + default: + code = BD_NVME_ERROR_CONNECT; + } +diff --git a/src/plugins/nvme/nvme-fabrics.c b/src/plugins/nvme/nvme-fabrics.c +index 20ed57f5..bba7392d 100644 +--- a/src/plugins/nvme/nvme-fabrics.c ++++ b/src/plugins/nvme/nvme-fabrics.c +@@ -30,7 +30,6 @@ + #include + + #include +-#include + + #include + #include +diff --git a/src/plugins/nvme/nvme-info.c b/src/plugins/nvme/nvme-info.c +index ac189abe..18719d51 100644 +--- a/src/plugins/nvme/nvme-info.c ++++ b/src/plugins/nvme/nvme-info.c +@@ -28,7 +28,6 @@ + #include + + #include +-#include + + #include + #include +@@ -408,6 +407,14 @@ static gchar *decode_nvme_rev (guint32 ver) { + return g_strdup_printf ("%u.%u.%u", mjr, mnr, ter); + } + ++static gchar *_uuid_to_str (unsigned char uuid[NVME_UUID_LEN]) { ++ gchar uuid_buf[NVME_UUID_LEN_STRING] = ZERO_INIT; ++ ++ if (nvme_uuid_to_string (uuid, uuid_buf) == 0) ++ return g_strdup (uuid_buf); ++ return NULL; ++} ++ + /** + * bd_nvme_get_controller_info: + * @device: a NVMe controller device (e.g. `/dev/nvme0`) +@@ -461,9 +468,7 @@ BDNVMEControllerInfo * bd_nvme_get_controller_info (const gchar *device, GError + info->pci_vendor_id = GUINT16_FROM_LE (ctrl_id.vid); + info->pci_subsys_vendor_id = GUINT16_FROM_LE (ctrl_id.ssvid); + info->ctrl_id = GUINT16_FROM_LE (ctrl_id.cntlid); +- /* TODO: decode fguid as 128-bit hex string? */ +- info->fguid = g_strdup_printf ("%-.*s", (int) sizeof (ctrl_id.fguid), ctrl_id.fguid); +- g_strstrip (info->fguid); ++ info->fguid = _uuid_to_str (ctrl_id.fguid); + info->model_number = g_strndup (ctrl_id.mn, sizeof (ctrl_id.mn)); + g_strstrip (info->model_number); + info->serial_number = g_strndup (ctrl_id.sn, sizeof (ctrl_id.sn)); +@@ -607,7 +612,6 @@ BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **e + if (ret_desc == 0) { + for (i = 0; i < NVME_IDENTIFY_DATA_SIZE; i += len) { + struct nvme_ns_id_desc *d = (void *) desc + i; +- gchar uuid_buf[37] = ZERO_INIT; + + if (!d->nidl) + break; +@@ -625,8 +629,7 @@ BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **e + snprintf (info->nguid + i * 2, 3, "%02x", d->nid[i]); + break; + case NVME_NIDT_UUID: +- uuid_unparse (d->nid, uuid_buf); +- info->uuid = g_strdup (uuid_buf); ++ info->uuid = _uuid_to_str (d->nid); + break; + case NVME_NIDT_CSI: + /* unused */ +diff --git a/src/plugins/nvme/nvme-op.c b/src/plugins/nvme/nvme-op.c +index 4568c453..c9e92697 100644 +--- a/src/plugins/nvme/nvme-op.c ++++ b/src/plugins/nvme/nvme-op.c +@@ -29,7 +29,6 @@ + #include + + #include +-#include + + #include + #include +diff --git a/src/plugins/nvme/nvme.c b/src/plugins/nvme/nvme.c +index 00f2f76e..4a32ac4e 100644 +--- a/src/plugins/nvme/nvme.c ++++ b/src/plugins/nvme/nvme.c +@@ -28,7 +28,6 @@ + #include + + #include +-#include + + #include + #include +-- +2.39.0 + + +From 64263599ec39b6b0f20d8e16c1169afcf66f5d9a Mon Sep 17 00:00:00 2001 +From: Tomas Bzatek +Date: Thu, 12 Jan 2023 16:01:28 +0100 +Subject: [PATCH 5/5] nvme: Fix zeroed struct fields detection + +As often stated in the NVMe specification, fields of features that +are either not implemented or not valid are typically cleared to zero (0h). +--- + src/plugins/nvme/nvme-info.c | 20 +++++++++++++++----- + tests/nvme_test.py | 2 +- + 2 files changed, 16 insertions(+), 6 deletions(-) + +diff --git a/src/plugins/nvme/nvme-info.c b/src/plugins/nvme/nvme-info.c +index 18719d51..85f94a32 100644 +--- a/src/plugins/nvme/nvme-info.c ++++ b/src/plugins/nvme/nvme-info.c +@@ -415,6 +415,15 @@ static gchar *_uuid_to_str (unsigned char uuid[NVME_UUID_LEN]) { + return NULL; + } + ++static gboolean _nvme_a_is_zero (const __u8 a[], int len) { ++ int i; ++ ++ for (i = 0; i < len; i++) ++ if (a[i] > 0) ++ return FALSE; ++ return TRUE; ++} ++ + /** + * bd_nvme_get_controller_info: + * @device: a NVMe controller device (e.g. `/dev/nvme0`) +@@ -468,7 +477,8 @@ BDNVMEControllerInfo * bd_nvme_get_controller_info (const gchar *device, GError + info->pci_vendor_id = GUINT16_FROM_LE (ctrl_id.vid); + info->pci_subsys_vendor_id = GUINT16_FROM_LE (ctrl_id.ssvid); + info->ctrl_id = GUINT16_FROM_LE (ctrl_id.cntlid); +- info->fguid = _uuid_to_str (ctrl_id.fguid); ++ if (!_nvme_a_is_zero (ctrl_id.fguid, sizeof (ctrl_id.fguid))) ++ info->fguid = _uuid_to_str (ctrl_id.fguid); + info->model_number = g_strndup (ctrl_id.mn, sizeof (ctrl_id.mn)); + g_strstrip (info->model_number); + info->serial_number = g_strndup (ctrl_id.sn, sizeof (ctrl_id.sn)); +@@ -638,14 +648,14 @@ BDNVMENamespaceInfo *bd_nvme_get_namespace_info (const gchar *device, GError **e + } + } + +- if (info->nguid == NULL && ns_info.nguid[G_N_ELEMENTS (ns_info.nguid) - 1] > 0) { ++ if (info->nguid == NULL && !_nvme_a_is_zero (ns_info.nguid, sizeof (ns_info.nguid))) { + info->nguid = g_malloc0 (sizeof (ns_info.nguid) * 2 + 1); +- for (i = 0; i < G_N_ELEMENTS (ns_info.nguid); i++) ++ for (i = 0; i < sizeof (ns_info.nguid); i++) + snprintf (info->nguid + i * 2, 3, "%02x", ns_info.nguid[i]); + } +- if (info->eui64 == NULL && ns_info.eui64[G_N_ELEMENTS (ns_info.eui64) - 1] > 0) { ++ if (info->eui64 == NULL && !_nvme_a_is_zero (ns_info.eui64, sizeof (ns_info.eui64))) { + info->eui64 = g_malloc0 (sizeof (ns_info.eui64) * 2 + 1); +- for (i = 0; i < G_N_ELEMENTS (ns_info.eui64); i++) ++ for (i = 0; i < sizeof (ns_info.eui64); i++) + snprintf (info->eui64 + i * 2, 3, "%02x", ns_info.eui64[i]); + } + if (ret_ns_ind == 0) { +diff --git a/tests/nvme_test.py b/tests/nvme_test.py +index a1822be6..a1494d9a 100644 +--- a/tests/nvme_test.py ++++ b/tests/nvme_test.py +@@ -116,7 +116,7 @@ class NVMeTestCase(NVMeTest): + self.assertFalse(info.features & BlockDev.NVMEControllerFeature.ENCLOSURE) + self.assertFalse(info.features & BlockDev.NVMEControllerFeature.MGMT_PCIE) + self.assertFalse(info.features & BlockDev.NVMEControllerFeature.MGMT_SMBUS) +- self.assertEqual(info.fguid, "") ++ self.assertIsNone(info.fguid) + self.assertEqual(info.pci_vendor_id, 0) + self.assertEqual(info.pci_subsys_vendor_id, 0) + self.assertIn("Linux", info.model_number) +-- +2.39.0 + diff --git a/SOURCES/0006-Misc-test-fixes-backport.patch b/SOURCES/0006-Misc-test-fixes-backport.patch deleted file mode 100644 index 12746c5..0000000 --- a/SOURCES/0006-Misc-test-fixes-backport.patch +++ /dev/null @@ -1,144 +0,0 @@ -From 77b8d17b0baf96a7a552fb8963afdbe8c3b18da7 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Wed, 2 Jun 2021 12:53:24 +0200 -Subject: [PATCH 1/4] tests: Make sure the test temp mount is always unmounted - -With try-finally the unmount function will always run even if the -test case fails. ---- - tests/fs_test.py | 6 ++++-- - 1 file changed, 4 insertions(+), 2 deletions(-) - -diff --git a/tests/fs_test.py b/tests/fs_test.py -index 2233db4f..de685b5f 100644 ---- a/tests/fs_test.py -+++ b/tests/fs_test.py -@@ -29,8 +29,10 @@ def check_output(args, ignore_retcode=True): - @contextmanager - def mounted(device, where, ro=False): - mount(device, where, ro) -- yield -- umount(where) -+ try: -+ yield -+ finally: -+ utils.umount(where) - - - def _get_dosfstools_version(): - -From aa802b6a2c9038069cfea7f821333367840a43ca Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Wed, 2 Jun 2021 13:05:17 +0200 -Subject: [PATCH 2/4] tests: Do not check that XFS shrink fails with xfsprogs - >= 5.12 - -xfsprogs 5.12 now has experimental support for shrinking, we need -more changes to support it properly so just skip this check for -now. ---- - tests/fs_test.py | 24 ++++++++++++++++++------ - 1 file changed, 18 insertions(+), 6 deletions(-) - -diff --git a/tests/fs_test.py b/tests/fs_test.py -index de685b5f..551b6a7b 100644 ---- a/tests/fs_test.py -+++ b/tests/fs_test.py -@@ -44,6 +44,14 @@ def _get_dosfstools_version(): - return LooseVersion(m.groups()[0]) - - -+def _get_xfs_version(): -+ _ret, out, _err = utils.run_command("mkfs.xfs -V") -+ m = re.search(r"mkfs\.xfs version ([\d\.]+)", out) -+ if not m or len(m.groups()) != 1: -+ raise RuntimeError("Failed to determine xfsprogs version from: %s" % out) -+ return LooseVersion(m.groups()[0]) -+ -+ - class FSTestCase(unittest.TestCase): - - requested_plugins = BlockDev.plugin_specs_from_names(("fs", "loop")) -@@ -736,9 +744,11 @@ def test_xfs_resize(self): - self.assertEqual(fi.block_size * fi.block_count, 50 * 1024**2) - - # (still) impossible to shrink an XFS file system -- with mounted(lv, self.mount_dir): -- with self.assertRaises(GLib.GError): -- succ = BlockDev.fs_xfs_resize(self.mount_dir, 40 * 1024**2 / fi.block_size, None) -+ xfs_version = _get_xfs_version() -+ if xfs_version < LooseVersion("5.1.12"): -+ with mounted(lv, self.mount_dir): -+ with self.assertRaises(GLib.GError): -+ succ = BlockDev.fs_resize(lv, 40 * 1024**2) - - run("lvresize -L70M libbd_fs_tests/xfs_test >/dev/null 2>&1") - # should grow -@@ -1503,9 +1513,11 @@ def test_xfs_generic_resize(self): - self.assertEqual(fi.block_size * fi.block_count, 50 * 1024**2) - - # (still) impossible to shrink an XFS file system -- with mounted(lv, self.mount_dir): -- with self.assertRaises(GLib.GError): -- succ = BlockDev.fs_resize(lv, 40 * 1024**2) -+ xfs_version = _get_xfs_version() -+ if xfs_version < LooseVersion("5.1.12"): -+ with mounted(lv, self.mount_dir): -+ with self.assertRaises(GLib.GError): -+ succ = BlockDev.fs_resize(lv, 40 * 1024**2) - - run("lvresize -L70M libbd_fs_tests/xfs_test >/dev/null 2>&1") - # should grow - -From ca01b6021cce3ea6a2318e74de408757f933d947 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Wed, 2 Jun 2021 13:06:41 +0200 -Subject: [PATCH 3/4] tests: Temporarily skip - test_snapshotcreate_lvorigin_snapshotmerge - -With LVM DBus API the lvconvert job is never finished which means -the test run never finishes in our CI. ---- - tests/skip.yml | 6 ++++++ - 1 file changed, 6 insertions(+) - -diff --git a/tests/skip.yml b/tests/skip.yml -index 145d321d..e22e712d 100644 ---- a/tests/skip.yml -+++ b/tests/skip.yml -@@ -137,3 +137,9 @@ - - distro: "fedora" - version: ["31", "32"] - reason: "working with old-style LVM snapshots leads to deadlock in LVM tools" -+ -+- test: lvm_dbus_tests.LvmTestLVsnapshots.test_snapshotcreate_lvorigin_snapshotmerge -+ skip_on: -+ - distro: "centos" -+ version: "9" -+ reason: "snapshot merge doesn't work on CentOS 9 Stream with LVM DBus API" - -From d0c44cd3d182599433f352901796af7c403239eb Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Wed, 2 Jun 2021 13:08:09 +0200 -Subject: [PATCH 4/4] Fix skipping tests on Debian testing - -Testing now identifies itself as "Debian GNU/Linux 11 (bullseye)" -so the tests that should be skipped on testing needs to be skipped -on "11" too. ---- - tests/skip.yml | 2 +- - 1 file changed, 1 insertion(+), 1 deletion(-) - -diff --git a/tests/skip.yml b/tests/skip.yml -index e22e712d..4134ee87 100644 ---- a/tests/skip.yml -+++ b/tests/skip.yml -@@ -37,7 +37,7 @@ - - test: fs_test.MountTest.test_mount_ntfs_ro - skip_on: - - distro: "debian" -- version: ["9", "10", "testing"] -+ version: ["9", "10", "11", "testing"] - reason: "NTFS mounting of read-only devices doesn't work as expected on Debian" - - - test: kbd_test.KbdZRAM* diff --git a/SOURCES/0007-lvm-devices-file-support.patch b/SOURCES/0007-lvm-devices-file-support.patch deleted file mode 100644 index bc7c55c..0000000 --- a/SOURCES/0007-lvm-devices-file-support.patch +++ /dev/null @@ -1,1908 +0,0 @@ -From e364883416785d51ff8eb132b63bd802ab0ccfe9 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Tue, 13 Jul 2021 13:22:05 +0200 -Subject: [PATCH 1/8] lvm: Allow configuring global "device filter" for LVM - commands - -Starting with 2.03.12 LVM introduces a new system for telling LVM -which devices it should use. The old device filters in config are -no longer working and we need to use either the system.devices -config file in /etc/lvm/devices (default behaviour) or specify -all allowed devices using the new --devices option. Because this -option must be specified for every call which might be incovenient -for our users, this commit introduces a new function to configure -this globally, which we already do for the --config option. ---- - src/lib/plugin_apis/lvm.api | 23 +++ - src/plugins/lvm-dbus.c | 74 ++++++++- - src/plugins/lvm.c | 97 ++++++++++-- - src/plugins/lvm.h | 4 + - tests/library_test.py | 304 ++++++++++++++++++++---------------- - tests/lvm_dbus_tests.py | 47 +++++- - tests/lvm_test.py | 50 ++++++ - tests/overrides_test.py | 23 ++- - 8 files changed, 469 insertions(+), 153 deletions(-) - -diff --git a/src/lib/plugin_apis/lvm.api b/src/lib/plugin_apis/lvm.api -index 563c104..62f602f 100644 ---- a/src/lib/plugin_apis/lvm.api -+++ b/src/lib/plugin_apis/lvm.api -@@ -601,6 +601,7 @@ typedef enum { - BD_LVM_TECH_CACHE_CALCS, - BD_LVM_TECH_GLOB_CONF, - BD_LVM_TECH_VDO, -+ BD_LVM_TECH_DEVICES, - } BDLVMTech; - - typedef enum { -@@ -1214,6 +1215,28 @@ gboolean bd_lvm_set_global_config (const gchar *new_config, GError **error); - */ - gchar* bd_lvm_get_global_config (GError **error); - -+/** -+ * bd_lvm_set_devices_filter: -+ * @devices: (allow-none) (array zero-terminated=1): list of devices for lvm commands to work on -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the devices filter was successfully set or not -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gboolean bd_lvm_set_devices_filter (const gchar **devices, GError **error); -+ -+/** -+ * bd_lvm_get_devices_filter: -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: (transfer full) (array zero-terminated=1): a copy of a string representation of -+ * the currently set LVM devices filter -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gchar** bd_lvm_get_devices_filter (GError **error); -+ - /** - * bd_lvm_cache_get_default_md_size: - * @cache_size: size of the cache to determine MD size for -diff --git a/src/plugins/lvm-dbus.c b/src/plugins/lvm-dbus.c -index 144551f..d1726ed 100644 ---- a/src/plugins/lvm-dbus.c -+++ b/src/plugins/lvm-dbus.c -@@ -35,6 +35,8 @@ - static GMutex global_config_lock; - static gchar *global_config_str = NULL; - -+static gchar *global_devices_str = NULL; -+ - #define LVM_BUS_NAME "com.redhat.lvmdbus1" - #define LVM_OBJ_PREFIX "/com/redhat/lvmdbus1" - #define MANAGER_OBJ "/com/redhat/lvmdbus1/Manager" -@@ -247,6 +249,14 @@ static volatile guint avail_features = 0; - static volatile guint avail_module_deps = 0; - static GMutex deps_check_lock; - -+#define DEPS_LVMDEVICES 0 -+#define DEPS_LVMDEVICES_MASK (1 << DEPS_LVMDEVICES) -+#define DEPS_LAST 1 -+ -+static const UtilDep deps[DEPS_LAST] = { -+ {"lvmdevices", NULL, NULL, NULL}, -+}; -+ - #define DBUS_DEPS_LVMDBUSD 0 - #define DBUS_DEPS_LVMDBUSD_MASK (1 << DBUS_DEPS_LVMDBUSD) - #define DBUS_DEPS_LAST 1 -@@ -385,6 +395,8 @@ gboolean bd_lvm_is_tech_avail (BDLVMTech tech, guint64 mode, GError **error) { - return check_dbus_deps (&avail_dbus_deps, DBUS_DEPS_LVMDBUSD_MASK, dbus_deps, DBUS_DEPS_LAST, &deps_check_lock, error) && - check_features (&avail_features, FEATURES_VDO_MASK, features, FEATURES_LAST, &deps_check_lock, error) && - check_module_deps (&avail_module_deps, MODULE_DEPS_VDO_MASK, module_deps, MODULE_DEPS_LAST, &deps_check_lock, error); -+ case BD_LVM_TECH_DEVICES: -+ return check_deps (&avail_deps, DEPS_LVMDEVICES_MASK, deps, DEPS_LAST, &deps_check_lock, error); - default: - /* everything is supported by this implementation of the plugin */ - return check_dbus_deps (&avail_dbus_deps, DBUS_DEPS_LVMDBUSD_MASK, dbus_deps, DBUS_DEPS_LAST, &deps_check_lock, error); -@@ -522,6 +534,7 @@ static gboolean unbox_params_and_add (GVariant *params, GVariantBuilder *builder - - static GVariant* call_lvm_method (const gchar *obj, const gchar *intf, const gchar *method, GVariant *params, GVariant *extra_params, const BDExtraArg **extra_args, guint64 *task_id, guint64 *progress_id, gboolean lock_config, GError **error) { - GVariant *config = NULL; -+ GVariant *devices = NULL; - GVariant *param = NULL; - GVariantIter iter; - GVariantBuilder builder; -@@ -543,8 +556,8 @@ static GVariant* call_lvm_method (const gchar *obj, const gchar *intf, const gch - if (lock_config) - g_mutex_lock (&global_config_lock); - -- if (global_config_str || extra_params || extra_args) { -- if (global_config_str || extra_args) { -+ if (global_config_str || global_devices_str || extra_params || extra_args) { -+ if (global_config_str || global_devices_str || extra_args) { - /* add the global config to the extra_params */ - g_variant_builder_init (&extra_builder, G_VARIANT_TYPE_DICTIONARY); - -@@ -565,6 +578,11 @@ static GVariant* call_lvm_method (const gchar *obj, const gchar *intf, const gch - g_variant_builder_add (&extra_builder, "{sv}", "--config", config); - added_extra = TRUE; - } -+ if (global_devices_str) { -+ devices = g_variant_new ("s", global_devices_str); -+ g_variant_builder_add (&extra_builder, "{sv}", "--devices", devices); -+ added_extra = TRUE; -+ } - - if (added_extra) - config_extra_params = g_variant_builder_end (&extra_builder); -@@ -2651,6 +2669,58 @@ gchar* bd_lvm_get_global_config (GError **error UNUSED) { - return ret; - } - -+/** -+ * bd_lvm_set_devices_filter: -+ * @devices: (allow-none) (array zero-terminated=1): list of devices for lvm commands to work on -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the devices filter was successfully set or not -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gboolean bd_lvm_set_devices_filter (const gchar **devices, GError **error) { -+ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) -+ return FALSE; -+ -+ g_mutex_lock (&global_config_lock); -+ -+ /* first free the old value */ -+ g_free (global_devices_str); -+ -+ /* now store the new one */ -+ if (!devices || !(*devices)) -+ global_devices_str = NULL; -+ else -+ global_devices_str = g_strjoinv (",", (gchar **) devices); -+ -+ g_mutex_unlock (&global_config_lock); -+ return TRUE; -+} -+ -+/** -+ * bd_lvm_get_devices_filter: -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: (transfer full) (array zero-terminated=1): a copy of a string representation of -+ * the currently set LVM devices filter -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gchar** bd_lvm_get_devices_filter (GError **error UNUSED) { -+ gchar **ret = NULL; -+ -+ g_mutex_lock (&global_config_lock); -+ -+ if (global_devices_str) -+ ret = g_strsplit (global_devices_str, ",", -1); -+ else -+ ret = NULL; -+ -+ g_mutex_unlock (&global_config_lock); -+ -+ return ret; -+} -+ - /** - * bd_lvm_cache_get_default_md_size: - * @cache_size: size of the cache to determine MD size for -diff --git a/src/plugins/lvm.c b/src/plugins/lvm.c -index 2be1dbd..c0d8198 100644 ---- a/src/plugins/lvm.c -+++ b/src/plugins/lvm.c -@@ -34,6 +34,8 @@ - static GMutex global_config_lock; - static gchar *global_config_str = NULL; - -+static gchar *global_devices_str = NULL; -+ - /** - * SECTION: lvm - * @short_description: plugin for operations with LVM -@@ -212,10 +214,13 @@ static GMutex deps_check_lock; - - #define DEPS_LVM 0 - #define DEPS_LVM_MASK (1 << DEPS_LVM) --#define DEPS_LAST 1 -+#define DEPS_LVMDEVICES 1 -+#define DEPS_LVMDEVICES_MASK (1 << DEPS_LVMDEVICES) -+#define DEPS_LAST 2 - - static const UtilDep deps[DEPS_LAST] = { - {"lvm", LVM_MIN_VERSION, "version", "LVM version:\\s+([\\d\\.]+)"}, -+ {"lvmdevices", NULL, NULL, NULL}, - }; - - #define FEATURES_VDO 0 -@@ -327,6 +332,8 @@ gboolean bd_lvm_is_tech_avail (BDLVMTech tech, guint64 mode, GError **error) { - case BD_LVM_TECH_VDO: - return check_features (&avail_features, FEATURES_VDO_MASK, features, FEATURES_LAST, &deps_check_lock, error) && - check_module_deps (&avail_module_deps, MODULE_DEPS_VDO_MASK, module_deps, MODULE_DEPS_LAST, &deps_check_lock, error); -+ case BD_LVM_TECH_DEVICES: -+ return check_deps (&avail_deps, DEPS_LVMDEVICES_MASK, deps, DEPS_LAST, &deps_check_lock, error); - default: - /* everything is supported by this implementation of the plugin */ - return check_deps (&avail_deps, DEPS_LVM_MASK, deps, DEPS_LAST, &deps_check_lock, error); -@@ -337,6 +344,8 @@ static gboolean call_lvm_and_report_error (const gchar **args, const BDExtraArg - gboolean success = FALSE; - guint i = 0; - guint args_length = g_strv_length ((gchar **) args); -+ g_autofree gchar *config_arg = NULL; -+ g_autofree gchar *devices_arg = NULL; - - if (!check_deps (&avail_deps, DEPS_LVM_MASK, deps, DEPS_LAST, &deps_check_lock, error)) - return FALSE; -@@ -345,20 +354,26 @@ static gboolean call_lvm_and_report_error (const gchar **args, const BDExtraArg - if (lock_config) - g_mutex_lock (&global_config_lock); - -- /* allocate enough space for the args plus "lvm", "--config" and NULL */ -- const gchar **argv = g_new0 (const gchar*, args_length + 3); -+ /* allocate enough space for the args plus "lvm", "--config", "--devices" and NULL */ -+ const gchar **argv = g_new0 (const gchar*, args_length + 4); - - /* construct argv from args with "lvm" prepended */ - argv[0] = "lvm"; - for (i=0; i < args_length; i++) - argv[i+1] = args[i]; -- argv[args_length + 1] = global_config_str ? g_strdup_printf("--config=%s", global_config_str) : NULL; -- argv[args_length + 2] = NULL; -+ if (global_config_str) { -+ config_arg = g_strdup_printf("--config=%s", global_config_str); -+ argv[++args_length] = config_arg; -+ } -+ if (global_devices_str) { -+ devices_arg = g_strdup_printf("--devices=%s", global_devices_str); -+ argv[++args_length] = devices_arg; -+ } -+ argv[++args_length] = NULL; - - success = bd_utils_exec_and_report_error (argv, extra, error); - if (lock_config) - g_mutex_unlock (&global_config_lock); -- g_free ((gchar *) argv[args_length + 1]); - g_free (argv); - - return success; -@@ -368,6 +383,8 @@ static gboolean call_lvm_and_capture_output (const gchar **args, const BDExtraAr - gboolean success = FALSE; - guint i = 0; - guint args_length = g_strv_length ((gchar **) args); -+ g_autofree gchar *config_arg = NULL; -+ g_autofree gchar *devices_arg = NULL; - - if (!check_deps (&avail_deps, DEPS_LVM_MASK, deps, DEPS_LAST, &deps_check_lock, error)) - return FALSE; -@@ -375,19 +392,25 @@ static gboolean call_lvm_and_capture_output (const gchar **args, const BDExtraAr - /* don't allow global config string changes during the run */ - g_mutex_lock (&global_config_lock); - -- /* allocate enough space for the args plus "lvm", "--config" and NULL */ -- const gchar **argv = g_new0 (const gchar*, args_length + 3); -+ /* allocate enough space for the args plus "lvm", "--config", "--devices" and NULL */ -+ const gchar **argv = g_new0 (const gchar*, args_length + 4); - - /* construct argv from args with "lvm" prepended */ - argv[0] = "lvm"; - for (i=0; i < args_length; i++) - argv[i+1] = args[i]; -- argv[args_length + 1] = global_config_str ? g_strdup_printf("--config=%s", global_config_str) : NULL; -- argv[args_length + 2] = NULL; -+ if (global_config_str) { -+ config_arg = g_strdup_printf("--config=%s", global_config_str); -+ argv[++args_length] = config_arg; -+ } -+ if (global_devices_str) { -+ devices_arg = g_strdup_printf("--devices=%s", global_devices_str); -+ argv[++args_length] = devices_arg; -+ } -+ argv[++args_length] = NULL; - - success = bd_utils_exec_and_capture_output (argv, extra, output, error); - g_mutex_unlock (&global_config_lock); -- g_free ((gchar *) argv[args_length + 1]); - g_free (argv); - - return success; -@@ -2018,6 +2041,58 @@ gchar* bd_lvm_get_global_config (GError **error UNUSED) { - return ret; - } - -+/** -+ * bd_lvm_set_devices_filter: -+ * @devices: (allow-none) (array zero-terminated=1): list of devices for lvm commands to work on -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the devices filter was successfully set or not -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gboolean bd_lvm_set_devices_filter (const gchar **devices, GError **error) { -+ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) -+ return FALSE; -+ -+ g_mutex_lock (&global_config_lock); -+ -+ /* first free the old value */ -+ g_free (global_devices_str); -+ -+ /* now store the new one */ -+ if (!devices || !(*devices)) -+ global_devices_str = NULL; -+ else -+ global_devices_str = g_strjoinv (",", (gchar **) devices); -+ -+ g_mutex_unlock (&global_config_lock); -+ return TRUE; -+} -+ -+/** -+ * bd_lvm_get_devices_filter: -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: (transfer full) (array zero-terminated=1): a copy of a string representation of -+ * the currently set LVM devices filter -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gchar** bd_lvm_get_devices_filter (GError **error UNUSED) { -+ gchar **ret = NULL; -+ -+ g_mutex_lock (&global_config_lock); -+ -+ if (global_devices_str) -+ ret = g_strsplit (global_devices_str, ",", -1); -+ else -+ ret = NULL; -+ -+ g_mutex_unlock (&global_config_lock); -+ -+ return ret; -+} -+ - /** - * bd_lvm_cache_get_default_md_size: - * @cache_size: size of the cache to determine MD size for -diff --git a/src/plugins/lvm.h b/src/plugins/lvm.h -index 2162d76..8063693 100644 ---- a/src/plugins/lvm.h -+++ b/src/plugins/lvm.h -@@ -216,6 +216,7 @@ typedef enum { - BD_LVM_TECH_CACHE_CALCS, - BD_LVM_TECH_GLOB_CONF, - BD_LVM_TECH_VDO, -+ BD_LVM_TECH_DEVICES, - } BDLVMTech; - - typedef enum { -@@ -289,6 +290,9 @@ gboolean bd_lvm_thsnapshotcreate (const gchar *vg_name, const gchar *origin_name - gboolean bd_lvm_set_global_config (const gchar *new_config, GError **error); - gchar* bd_lvm_get_global_config (GError **error); - -+gboolean bd_lvm_set_devices_filter (const gchar **devices, GError **error); -+gchar** bd_lvm_get_devices_filter (GError **error); -+ - guint64 bd_lvm_cache_get_default_md_size (guint64 cache_size, GError **error); - const gchar* bd_lvm_cache_get_mode_str (BDLVMCacheMode mode, GError **error); - BDLVMCacheMode bd_lvm_cache_get_mode_from_str (const gchar *mode_str, GError **error); -diff --git a/tests/library_test.py b/tests/library_test.py -index 08e44fd..efd17bd 100644 ---- a/tests/library_test.py -+++ b/tests/library_test.py -@@ -13,18 +13,178 @@ class LibraryOpsTestCase(unittest.TestCase): - # all plugins except for 'btrfs', 'fs' and 'mpath' -- these don't have all - # the dependencies on CentOS/Debian and we don't need them for this test - requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "dm", -- "kbd", "loop", "lvm", -+ "kbd", "loop", - "mdraid", "part", "swap")) - -+ @classmethod -+ def setUpClass(cls): -+ if not BlockDev.is_initialized(): -+ BlockDev.init(cls.requested_plugins, None) -+ else: -+ BlockDev.reinit(cls.requested_plugins, True, None) -+ -+ @classmethod -+ def tearDownClass(cls): -+ BlockDev.switch_init_checks(True) -+ -+ def my_log_func(self, level, msg): -+ # not much to verify here -+ self.assertTrue(isinstance(level, int)) -+ self.assertTrue(isinstance(msg, str)) -+ -+ self.log += msg + "\n" -+ -+ @tag_test(TestTags.CORE) -+ def test_logging_setup(self): -+ """Verify that setting up logging works as expected""" -+ -+ self.assertTrue(BlockDev.reinit(self.requested_plugins, False, self.my_log_func)) -+ -+ succ = BlockDev.utils_exec_and_report_error(["true"]) -+ self.assertTrue(succ) -+ -+ # reinit with no logging function should change nothing about logging -+ self.assertTrue(BlockDev.reinit(self.requested_plugins, False, None)) -+ -+ succ, out = BlockDev.utils_exec_and_capture_output(["echo", "hi"]) -+ self.assertTrue(succ) -+ self.assertEqual(out, "hi\n") -+ -+ match = re.search(r'Running \[(\d+)\] true', self.log) -+ self.assertIsNot(match, None) -+ task_id1 = match.group(1) -+ match = re.search(r'Running \[(\d+)\] echo hi', self.log) -+ self.assertIsNot(match, None) -+ task_id2 = match.group(1) -+ -+ self.assertIn("...done [%s] (exit code: 0)" % task_id1, self.log) -+ self.assertIn("stdout[%s]:" % task_id1, self.log) -+ self.assertIn("stderr[%s]:" % task_id1, self.log) -+ -+ self.assertIn("stdout[%s]: hi" % task_id2, self.log) -+ self.assertIn("stderr[%s]:" % task_id2, self.log) -+ self.assertIn("...done [%s] (exit code: 0)" % task_id2, self.log) -+ -+ @tag_test(TestTags.CORE) -+ def test_require_plugins(self): -+ """Verify that loading only required plugins works as expected""" -+ -+ ps = BlockDev.PluginSpec() -+ ps.name = BlockDev.Plugin.SWAP -+ ps.so_name = "" -+ self.assertTrue(BlockDev.reinit([ps], True, None)) -+ self.assertEqual(BlockDev.get_available_plugin_names(), ["swap"]) -+ self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) -+ -+ @tag_test(TestTags.CORE) -+ def test_not_implemented(self): -+ """Verify that unloaded/unimplemented functions report errors""" -+ -+ # should be loaded and working -+ self.assertTrue(BlockDev.md_canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236")) -+ -+ ps = BlockDev.PluginSpec() -+ ps.name = BlockDev.Plugin.SWAP -+ ps.so_name = "" -+ self.assertTrue(BlockDev.reinit([ps], True, None)) -+ self.assertEqual(BlockDev.get_available_plugin_names(), ["swap"]) -+ -+ # no longer loaded -+ with self.assertRaises(GLib.GError): -+ BlockDev.md_canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236") -+ -+ self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) -+ -+ # loaded again -+ self.assertTrue(BlockDev.md_canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236")) -+ -+ def test_ensure_init(self): -+ """Verify that ensure_init just returns when already initialized""" -+ -+ # the library is already initialized, ensure_init() shonuld do nothing -+ avail_plugs = BlockDev.get_available_plugin_names() -+ self.assertTrue(BlockDev.ensure_init(self.requested_plugins, None)) -+ self.assertEqual(avail_plugs, BlockDev.get_available_plugin_names()) -+ -+ # reinit with a subset of plugins -+ plugins = BlockDev.plugin_specs_from_names(["swap", "part"]) -+ self.assertTrue(BlockDev.reinit(plugins, True, None)) -+ self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "part"])) -+ -+ # ensure_init with the same subset -> nothing should change -+ self.assertTrue(BlockDev.ensure_init(plugins, None)) -+ self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "part"])) -+ -+ # ensure_init with more plugins -> extra plugins should be loaded -+ plugins = BlockDev.plugin_specs_from_names(["swap", "part", "crypto"]) -+ self.assertTrue(BlockDev.ensure_init(plugins, None)) -+ self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "part", "crypto"])) -+ -+ # reinit to unload all plugins -+ self.assertTrue(BlockDev.reinit([], True, None)) -+ self.assertEqual(BlockDev.get_available_plugin_names(), []) -+ -+ # ensure_init to load all plugins back -+ self.assertTrue(BlockDev.ensure_init(self.requested_plugins, None)) -+ self.assertGreaterEqual(len(BlockDev.get_available_plugin_names()), 7) -+ -+ def test_try_reinit(self): -+ """Verify that try_reinit() works as expected""" -+ -+ # try reinitializing with only some utilities being available and thus -+ # only some plugins able to load -+ with fake_path("tests/lib_missing_utils", keep_utils=["swapon", "swapoff", "mkswap", "swaplabel"]): -+ succ, loaded = BlockDev.try_reinit(self.requested_plugins, True, None) -+ self.assertFalse(succ) -+ for plug_name in ("swap", "crypto"): -+ self.assertIn(plug_name, loaded) -+ -+ # reset back to all plugins -+ self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) -+ -+ # now the same with a subset of plugins requested -+ plugins = BlockDev.plugin_specs_from_names(["swap", "crypto"]) -+ with fake_path("tests/lib_missing_utils", keep_utils=["swapon", "swapoff", "mkswap", "swaplabel"]): -+ succ, loaded = BlockDev.try_reinit(plugins, True, None) -+ self.assertTrue(succ) -+ self.assertEqual(set(loaded), set(["swap", "crypto"])) -+ -+ def test_non_en_init(self): -+ """Verify that the library initializes with lang different from en_US""" -+ -+ orig_lang = os.environ.get("LANG") -+ os.environ["LANG"] = "cs.CZ_UTF-8" -+ self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) -+ if orig_lang: -+ os.environ["LANG"] = orig_lang -+ else: -+ del os.environ["LANG"] -+ self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) -+ -+ -+class PluginsTestCase(unittest.TestCase): -+ # only LVM plugin for this test -+ requested_plugins = BlockDev.plugin_specs_from_names(("lvm",)) -+ - orig_config_dir = "" - - @classmethod - def setUpClass(cls): -+ BlockDev.switch_init_checks(False) - if not BlockDev.is_initialized(): - BlockDev.init(cls.requested_plugins, None) - else: - BlockDev.reinit(cls.requested_plugins, True, None) - -+ try: -+ cls.devices_avail = BlockDev.lvm_is_tech_avail(BlockDev.LVMTech.DEVICES, 0) -+ except: -+ cls.devices_avail = False -+ -+ @classmethod -+ def tearDownClass(cls): -+ BlockDev.switch_init_checks(True) -+ - def setUp(self): - self.orig_config_dir = os.environ.get("LIBBLOCKDEV_CONFIG_DIR", "") - self.addCleanup(self._clean_up) -@@ -185,6 +345,12 @@ class LibraryOpsTestCase(unittest.TestCase): - def test_plugin_fallback(self): - """Verify that fallback when loading plugins works as expected""" - -+ if not self.devices_avail: -+ self.skipTest("skipping plugin fallback test: missing some LVM dependencies") -+ -+ BlockDev.switch_init_checks(True) -+ self.addCleanup(BlockDev.switch_init_checks, False) -+ - # library should be successfully initialized - self.assertTrue(BlockDev.is_initialized()) - -@@ -206,7 +372,7 @@ class LibraryOpsTestCase(unittest.TestCase): - - # now reinit the library with the config preferring the new build - orig_conf_dir = os.environ.get("LIBBLOCKDEV_CONFIG_DIR") -- os.environ["LIBBLOCKDEV_CONFIG_DIR"] = "tests/plugin_prio_conf.d" -+ os.environ["LIBBLOCKDEV_CONFIG_DIR"] = "tests/test_configs/plugin_prio_conf.d" - self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) - - # the original plugin should be loaded because the new one should fail -@@ -243,139 +409,9 @@ class LibraryOpsTestCase(unittest.TestCase): - - self.assertEqual(BlockDev.lvm_get_max_lv_size(), orig_max_size) - -- def my_log_func(self, level, msg): -- # not much to verify here -- self.assertTrue(isinstance(level, int)) -- self.assertTrue(isinstance(msg, str)) -- -- self.log += msg + "\n" -- -- @tag_test(TestTags.CORE) -- def test_logging_setup(self): -- """Verify that setting up logging works as expected""" -- -- self.assertTrue(BlockDev.reinit(self.requested_plugins, False, self.my_log_func)) -- -- succ = BlockDev.utils_exec_and_report_error(["true"]) -- self.assertTrue(succ) -- -- # reinit with no logging function should change nothing about logging -- self.assertTrue(BlockDev.reinit(self.requested_plugins, False, None)) -- -- succ, out = BlockDev.utils_exec_and_capture_output(["echo", "hi"]) -- self.assertTrue(succ) -- self.assertEqual(out, "hi\n") -- -- match = re.search(r'Running \[(\d+)\] true', self.log) -- self.assertIsNot(match, None) -- task_id1 = match.group(1) -- match = re.search(r'Running \[(\d+)\] echo hi', self.log) -- self.assertIsNot(match, None) -- task_id2 = match.group(1) -- -- self.assertIn("...done [%s] (exit code: 0)" % task_id1, self.log) -- self.assertIn("stdout[%s]:" % task_id1, self.log) -- self.assertIn("stderr[%s]:" % task_id1, self.log) -- -- self.assertIn("stdout[%s]: hi" % task_id2, self.log) -- self.assertIn("stderr[%s]:" % task_id2, self.log) -- self.assertIn("...done [%s] (exit code: 0)" % task_id2, self.log) -- -- @tag_test(TestTags.CORE) -- def test_require_plugins(self): -- """Verify that loading only required plugins works as expected""" -- -- ps = BlockDev.PluginSpec() -- ps.name = BlockDev.Plugin.SWAP -- ps.so_name = "" -- self.assertTrue(BlockDev.reinit([ps], True, None)) -- self.assertEqual(BlockDev.get_available_plugin_names(), ["swap"]) -- self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) -- -- @tag_test(TestTags.CORE) -- def test_not_implemented(self): -- """Verify that unloaded/unimplemented functions report errors""" -- -- # should be loaded and working -- self.assertTrue(BlockDev.lvm_get_max_lv_size() > 0) - -- ps = BlockDev.PluginSpec() -- ps.name = BlockDev.Plugin.SWAP -- ps.so_name = "" -- self.assertTrue(BlockDev.reinit([ps], True, None)) -- self.assertEqual(BlockDev.get_available_plugin_names(), ["swap"]) -- -- # no longer loaded -- with self.assertRaises(GLib.GError): -- BlockDev.lvm_get_max_lv_size() -- -- self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) -- -- # loaded again -- self.assertTrue(BlockDev.lvm_get_max_lv_size() > 0) -- -- def test_ensure_init(self): -- """Verify that ensure_init just returns when already initialized""" -- -- # the library is already initialized, ensure_init() shonuld do nothing -- avail_plugs = BlockDev.get_available_plugin_names() -- self.assertTrue(BlockDev.ensure_init(self.requested_plugins, None)) -- self.assertEqual(avail_plugs, BlockDev.get_available_plugin_names()) -- -- # reinit with a subset of plugins -- plugins = BlockDev.plugin_specs_from_names(["swap", "lvm"]) -- self.assertTrue(BlockDev.reinit(plugins, True, None)) -- self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "lvm"])) -- -- # ensure_init with the same subset -> nothing should change -- self.assertTrue(BlockDev.ensure_init(plugins, None)) -- self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "lvm"])) -- -- # ensure_init with more plugins -> extra plugins should be loaded -- plugins = BlockDev.plugin_specs_from_names(["swap", "lvm", "crypto"]) -- self.assertTrue(BlockDev.ensure_init(plugins, None)) -- self.assertEqual(set(BlockDev.get_available_plugin_names()), set(["swap", "lvm", "crypto"])) -- -- # reinit to unload all plugins -- self.assertTrue(BlockDev.reinit([], True, None)) -- self.assertEqual(BlockDev.get_available_plugin_names(), []) -- -- # ensure_init to load all plugins back -- self.assertTrue(BlockDev.ensure_init(self.requested_plugins, None)) -- self.assertGreaterEqual(len(BlockDev.get_available_plugin_names()), 8) -- -- def test_try_reinit(self): -- """Verify that try_reinit() works as expected""" -- -- # try reinitializing with only some utilities being available and thus -- # only some plugins able to load -- with fake_path("tests/lib_missing_utils", keep_utils=["swapon", "swapoff", "mkswap", "lvm", "swaplabel"]): -- succ, loaded = BlockDev.try_reinit(self.requested_plugins, True, None) -- self.assertFalse(succ) -- for plug_name in ("swap", "lvm", "crypto"): -- self.assertIn(plug_name, loaded) -- -- # reset back to all plugins -- self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) -- -- # now the same with a subset of plugins requested -- plugins = BlockDev.plugin_specs_from_names(["lvm", "swap", "crypto"]) -- with fake_path("tests/lib_missing_utils", keep_utils=["swapon", "swapoff", "mkswap", "lvm","swaplabel"]): -- succ, loaded = BlockDev.try_reinit(plugins, True, None) -- self.assertTrue(succ) -- self.assertEqual(set(loaded), set(["swap", "lvm", "crypto"])) -- -- def test_non_en_init(self): -- """Verify that the library initializes with lang different from en_US""" -- -- orig_lang = os.environ.get("LANG") -- os.environ["LANG"] = "cs.CZ_UTF-8" -- self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) -- if orig_lang: -- os.environ["LANG"] = orig_lang -- else: -- del os.environ["LANG"] -- self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) -+class DepChecksTestCase(unittest.TestCase): -+ requested_plugins = BlockDev.plugin_specs_from_names(( "swap",)) - - def test_dep_checks_disabled(self): - """Verify that disabling runtime dep checks works""" -diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py -index 4882da8..35ace37 100644 ---- a/tests/lvm_dbus_tests.py -+++ b/tests/lvm_dbus_tests.py -@@ -33,6 +33,11 @@ class LVMTestCase(unittest.TestCase): - else: - BlockDev.reinit([cls.ps, cls.ps2], True, None) - -+ try: -+ cls.devices_avail = BlockDev.lvm_is_tech_avail(BlockDev.LVMTech.DEVICES, 0) -+ except: -+ cls.devices_avail = False -+ - @classmethod - def _get_lvm_version(cls): - _ret, out, _err = run_command("lvm version") -@@ -44,8 +49,7 @@ class LVMTestCase(unittest.TestCase): - @unittest.skipUnless(lvm_dbus_running, "LVM DBus not running") - class LvmNoDevTestCase(LVMTestCase): - -- def __init__(self, *args, **kwargs): -- super(LvmNoDevTestCase, self).__init__(*args, **kwargs) -+ def setUp(self): - self._log = "" - - @tag_test(TestTags.NOSTORAGE) -@@ -227,6 +231,45 @@ class LvmNoDevTestCase(LVMTestCase): - succ = BlockDev.lvm_set_global_config(None) - self.assertTrue(succ) - -+ @tag_test(TestTags.NOSTORAGE) -+ def test_get_set_global_devices_filter(self): -+ """Verify that getting and setting LVM devices filter works as expected""" -+ if not self.devices_avail: -+ self.skipTest("skipping LVM devices filter test: not supported") -+ -+ # setup logging -+ self.assertTrue(BlockDev.reinit([self.ps], False, self._store_log)) -+ -+ # no global config set initially -+ self.assertListEqual(BlockDev.lvm_get_devices_filter(), []) -+ -+ # set and try to get back -+ succ = BlockDev.lvm_set_devices_filter(["/dev/sda"]) -+ self.assertTrue(succ) -+ self.assertListEqual(BlockDev.lvm_get_devices_filter(), ["/dev/sda"]) -+ -+ # reset and try to get back -+ succ = BlockDev.lvm_set_devices_filter(None) -+ self.assertTrue(succ) -+ self.assertListEqual(BlockDev.lvm_get_devices_filter(), []) -+ -+ # set twice and try to get back twice -+ succ = BlockDev.lvm_set_devices_filter(["/dev/sda"]) -+ self.assertTrue(succ) -+ succ = BlockDev.lvm_set_devices_filter(["/dev/sdb"]) -+ self.assertTrue(succ) -+ self.assertEqual(BlockDev.lvm_get_devices_filter(), ["/dev/sdb"]) -+ -+ # set something sane and check it's really used -+ succ = BlockDev.lvm_set_devices_filter(["/dev/sdb", "/dev/sdc"]) -+ BlockDev.lvm_pvscan() -+ self.assertIn("'--devices'", self._log) -+ self.assertIn("'/dev/sdb,/dev/sdc'", self._log) -+ -+ # reset back to default -+ succ = BlockDev.lvm_set_devices_filter(None) -+ self.assertTrue(succ) -+ - @tag_test(TestTags.NOSTORAGE) - def test_cache_get_default_md_size(self): - """Verify that default cache metadata size is calculated properly""" -diff --git a/tests/lvm_test.py b/tests/lvm_test.py -index eb94c91..b37a879 100644 ---- a/tests/lvm_test.py -+++ b/tests/lvm_test.py -@@ -22,10 +22,17 @@ class LVMTestCase(unittest.TestCase): - ps.so_name = "libbd_lvm.so.2" - cls.requested_plugins = [ps] - -+ BlockDev.switch_init_checks(False) - if not BlockDev.is_initialized(): - BlockDev.init(cls.requested_plugins, None) - else: - BlockDev.reinit(cls.requested_plugins, True, None) -+ BlockDev.switch_init_checks(True) -+ -+ try: -+ cls.devices_avail = BlockDev.lvm_is_tech_avail(BlockDev.LVMTech.DEVICES, 0) -+ except: -+ cls.devices_avail = False - - @classmethod - def _get_lvm_version(cls): -@@ -39,6 +46,8 @@ class LVMTestCase(unittest.TestCase): - class LvmNoDevTestCase(LVMTestCase): - def __init__(self, *args, **kwargs): - super(LvmNoDevTestCase, self).__init__(*args, **kwargs) -+ -+ def setUp(self): - self._log = "" - - @tag_test(TestTags.NOSTORAGE) -@@ -213,6 +222,44 @@ class LvmNoDevTestCase(LVMTestCase): - succ = BlockDev.lvm_set_global_config(None) - self.assertTrue(succ) - -+ @tag_test(TestTags.NOSTORAGE) -+ def test_get_set_global_devices_filter(self): -+ """Verify that getting and setting LVM devices filter works as expected""" -+ if not self.devices_avail: -+ self.skipTest("skipping LVM devices filter test: not supported") -+ -+ # setup logging -+ self.assertTrue(BlockDev.reinit(self.requested_plugins, False, self._store_log)) -+ -+ # no global config set initially -+ self.assertListEqual(BlockDev.lvm_get_devices_filter(), []) -+ -+ # set and try to get back -+ succ = BlockDev.lvm_set_devices_filter(["/dev/sda"]) -+ self.assertTrue(succ) -+ self.assertListEqual(BlockDev.lvm_get_devices_filter(), ["/dev/sda"]) -+ -+ # reset and try to get back -+ succ = BlockDev.lvm_set_devices_filter(None) -+ self.assertTrue(succ) -+ self.assertListEqual(BlockDev.lvm_get_devices_filter(), []) -+ -+ # set twice and try to get back twice -+ succ = BlockDev.lvm_set_devices_filter(["/dev/sda"]) -+ self.assertTrue(succ) -+ succ = BlockDev.lvm_set_devices_filter(["/dev/sdb"]) -+ self.assertTrue(succ) -+ self.assertEqual(BlockDev.lvm_get_devices_filter(), ["/dev/sdb"]) -+ -+ # set something sane and check it's really used -+ succ = BlockDev.lvm_set_devices_filter(["/dev/sdb", "/dev/sdc"]) -+ BlockDev.lvm_lvs(None) -+ self.assertIn("--devices=/dev/sdb,/dev/sdc", self._log) -+ -+ # reset back to default -+ succ = BlockDev.lvm_set_devices_filter(None) -+ self.assertTrue(succ) -+ - @tag_test(TestTags.NOSTORAGE) - def test_cache_get_default_md_size(self): - """Verify that default cache metadata size is calculated properly""" -@@ -1335,6 +1382,9 @@ class LvmPVVGcachedThpoolstatsTestCase(LvmPVVGLVTestCase): - - class LVMUnloadTest(LVMTestCase): - def setUp(self): -+ if not self.devices_avail: -+ self.skipTest("skipping LVM unload test: missing some LVM dependencies") -+ - # make sure the library is initialized with all plugins loaded for other - # tests - self.addCleanup(BlockDev.reinit, self.requested_plugins, True, None) -diff --git a/tests/overrides_test.py b/tests/overrides_test.py -index 8e7f5a5..d3faf3c 100644 ---- a/tests/overrides_test.py -+++ b/tests/overrides_test.py -@@ -15,10 +15,12 @@ class OverridesTest(unittest.TestCase): - - @classmethod - def setUpClass(cls): -+ BlockDev.switch_init_checks(False) - if not BlockDev.is_initialized(): - BlockDev.init(cls.requested_plugins, None) - else: - BlockDev.reinit(cls.requested_plugins, True, None) -+ BlockDev.switch_init_checks(True) - - class OverridesTestCase(OverridesTest): - @tag_test(TestTags.NOSTORAGE, TestTags.CORE) -@@ -65,7 +67,20 @@ class OverridesTestCase(OverridesTest): - self.assertEqual(BlockDev.lvm_get_thpool_padding(11 * 1024**2), - expected_padding) - --class OverridesUnloadTestCase(OverridesTest): -+class OverridesUnloadTestCase(unittest.TestCase): -+ # all plugins except for 'btrfs', 'fs' and 'mpath' -- these don't have all -+ # the dependencies on CentOS/Debian and we don't need them for this test -+ requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "dm", -+ "kbd", "loop", -+ "mdraid", "part", "swap")) -+ -+ @classmethod -+ def setUpClass(cls): -+ if not BlockDev.is_initialized(): -+ BlockDev.init(cls.requested_plugins, None) -+ else: -+ BlockDev.reinit(cls.requested_plugins, True, None) -+ - def tearDown(self): - # make sure the library is initialized with all plugins loaded for other - # tests -@@ -80,7 +95,7 @@ class OverridesUnloadTestCase(OverridesTest): - - # no longer loaded - with self.assertRaises(BlockDev.BlockDevNotImplementedError): -- BlockDev.lvm.get_max_lv_size() -+ BlockDev.md.canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236") - - # load the plugins back - self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) -@@ -92,9 +107,9 @@ class OverridesUnloadTestCase(OverridesTest): - - # the exception should be properly inherited from two classes - with self.assertRaises(NotImplementedError): -- BlockDev.lvm.get_max_lv_size() -+ BlockDev.md.canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236") - with self.assertRaises(BlockDev.BlockDevError): -- BlockDev.lvm.get_max_lv_size() -+ BlockDev.md.canonicalize_uuid("3386ff85:f5012621:4a435f06:1eb47236") - - # load the plugins back - self.assertTrue(BlockDev.reinit(self.requested_plugins, True, None)) --- -2.31.1 - - -From bebd74962db6fb7b5314be411a4d02b21554d80f Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Tue, 13 Jul 2021 13:27:32 +0200 -Subject: [PATCH 2/8] lvm: Add functions for managing LVM devices file - -Currently covers only --adddev and --deldev from the lvmdevices -command. ---- - src/lib/plugin_apis/lvm.api | 26 +++++++++++++++ - src/plugins/lvm-dbus.c | 52 +++++++++++++++++++++++++++++ - src/plugins/lvm.c | 52 +++++++++++++++++++++++++++++ - src/plugins/lvm.h | 3 ++ - src/python/gi/overrides/BlockDev.py | 15 +++++++++ - tests/lvm_dbus_tests.py | 37 +++++++++++++++++++- - tests/lvm_test.py | 37 +++++++++++++++++++- - 7 files changed, 220 insertions(+), 2 deletions(-) - -diff --git a/src/lib/plugin_apis/lvm.api b/src/lib/plugin_apis/lvm.api -index 62f602f..bce2920 100644 ---- a/src/lib/plugin_apis/lvm.api -+++ b/src/lib/plugin_apis/lvm.api -@@ -1685,4 +1685,30 @@ GHashTable* bd_lvm_vdo_get_stats_full (const gchar *vg_name, const gchar *pool_n - */ - BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_name, GError **error); - -+/** -+ * bd_lvm_devices_add: -+ * @device: device (PV) to add to the devices file -+ * @devices_file: (allow-none): LVM devices file or %NULL for default -+ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the @device was successfully added to @devices_file or not -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error); -+ -+/** -+ * bd_lvm_devices_delete: -+ * @device: device (PV) to delete from the devices file -+ * @devices_file: (allow-none): LVM devices file or %NULL for default -+ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the @device was successfully removed from @devices_file or not -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error); -+ - #endif /* BD_LVM_API */ -diff --git a/src/plugins/lvm-dbus.c b/src/plugins/lvm-dbus.c -index d1726ed..44d2794 100644 ---- a/src/plugins/lvm-dbus.c -+++ b/src/plugins/lvm-dbus.c -@@ -3938,3 +3938,55 @@ BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_nam - - return stats; - } -+ -+/** -+ * bd_lvm_devices_add: -+ * @device: device (PV) to add to the devices file -+ * @devices_file: (allow-none): LVM devices file or %NULL for default -+ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the @device was successfully added to @devices_file or not -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error) { -+ const gchar *args[5] = {"lvmdevices", "--adddev", device, NULL, NULL}; -+ g_autofree gchar *devfile = NULL; -+ -+ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) -+ return FALSE; -+ -+ if (devices_file) { -+ devfile = g_strdup_printf ("--devicesfile=%s", devices_file); -+ args[3] = devfile; -+ } -+ -+ return bd_utils_exec_and_report_error (args, extra, error); -+} -+ -+/** -+ * bd_lvm_devices_delete: -+ * @device: device (PV) to delete from the devices file -+ * @devices_file: (allow-none): LVM devices file or %NULL for default -+ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the @device was successfully removed from @devices_file or not -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error) { -+ const gchar *args[5] = {"lvmdevices", "--deldev", device, NULL, NULL}; -+ g_autofree gchar *devfile = NULL; -+ -+ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) -+ return FALSE; -+ -+ if (devices_file) { -+ devfile = g_strdup_printf ("--devicesfile=%s", devices_file); -+ args[3] = devfile; -+ } -+ -+ return bd_utils_exec_and_report_error (args, extra, error); -+} -diff --git a/src/plugins/lvm.c b/src/plugins/lvm.c -index c0d8198..94c6a22 100644 ---- a/src/plugins/lvm.c -+++ b/src/plugins/lvm.c -@@ -3235,3 +3235,55 @@ BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_nam - - return stats; - } -+ -+/** -+ * bd_lvm_devices_add: -+ * @device: device (PV) to add to the devices file -+ * @devices_file: (allow-none): LVM devices file or %NULL for default -+ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the @device was successfully added to @devices_file or not -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error) { -+ const gchar *args[5] = {"lvmdevices", "--adddev", device, NULL, NULL}; -+ g_autofree gchar *devfile = NULL; -+ -+ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) -+ return FALSE; -+ -+ if (devices_file) { -+ devfile = g_strdup_printf ("--devicesfile=%s", devices_file); -+ args[3] = devfile; -+ } -+ -+ return bd_utils_exec_and_report_error (args, extra, error); -+} -+ -+/** -+ * bd_lvm_devices_delete: -+ * @device: device (PV) to delete from the devices file -+ * @devices_file: (allow-none): LVM devices file or %NULL for default -+ * @extra: (allow-none) (array zero-terminated=1): extra options for the lvmdevices command -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the @device was successfully removed from @devices_file or not -+ * -+ * Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) -+ */ -+gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error) { -+ const gchar *args[5] = {"lvmdevices", "--deldev", device, NULL, NULL}; -+ g_autofree gchar *devfile = NULL; -+ -+ if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) -+ return FALSE; -+ -+ if (devices_file) { -+ devfile = g_strdup_printf ("--devicesfile=%s", devices_file); -+ args[3] = devfile; -+ } -+ -+ return bd_utils_exec_and_report_error (args, extra, error); -+} -diff --git a/src/plugins/lvm.h b/src/plugins/lvm.h -index 8063693..5ca2a9d 100644 ---- a/src/plugins/lvm.h -+++ b/src/plugins/lvm.h -@@ -333,4 +333,7 @@ BDLVMVDOWritePolicy bd_lvm_get_vdo_write_policy_from_str (const gchar *policy_st - BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_name, GError **error); - GHashTable* bd_lvm_vdo_get_stats_full (const gchar *vg_name, const gchar *pool_name, GError **error); - -+gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error); -+gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, const BDExtraArg **extra, GError **error); -+ - #endif /* BD_LVM */ -diff --git a/src/python/gi/overrides/BlockDev.py b/src/python/gi/overrides/BlockDev.py -index f768c8b..715a262 100644 ---- a/src/python/gi/overrides/BlockDev.py -+++ b/src/python/gi/overrides/BlockDev.py -@@ -724,6 +724,21 @@ def lvm_vdo_pool_convert(vg_name, lv_name, pool_name, virtual_size, index_memory - return _lvm_vdo_pool_convert(vg_name, lv_name, pool_name, virtual_size, index_memory, compression, deduplication, write_policy, extra) - __all__.append("lvm_vdo_pool_convert") - -+_lvm_devices_add = BlockDev.lvm_devices_add -+@override(BlockDev.lvm_devices_add) -+def lvm_devices_add(device, devices_file=None, extra=None, **kwargs): -+ extra = _get_extra(extra, kwargs) -+ return _lvm_devices_add(device, devices_file, extra) -+__all__.append("lvm_devices_add") -+ -+_lvm_devices_delete = BlockDev.lvm_devices_delete -+@override(BlockDev.lvm_devices_delete) -+def lvm_devices_delete(device, devices_file=None, extra=None, **kwargs): -+ extra = _get_extra(extra, kwargs) -+ return _lvm_devices_delete(device, devices_file, extra) -+__all__.append("lvm_devices_delete") -+ -+ - _md_get_superblock_size = BlockDev.md_get_superblock_size - @override(BlockDev.md_get_superblock_size) - def md_get_superblock_size(size, version=None): -diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py -index 35ace37..fb1a9ed 100644 ---- a/tests/lvm_dbus_tests.py -+++ b/tests/lvm_dbus_tests.py -@@ -10,7 +10,7 @@ import subprocess - from distutils.version import LooseVersion - from itertools import chain - --from utils import create_sparse_tempfile, create_lio_device, delete_lio_device, run_command, TestTags, tag_test -+from utils import create_sparse_tempfile, create_lio_device, delete_lio_device, run_command, TestTags, tag_test, read_file - from gi.repository import BlockDev, GLib - - import dbus -@@ -1696,3 +1696,38 @@ class LVMVDOTest(LVMTestCase): - - full_stats = BlockDev.lvm_vdo_get_stats_full("testVDOVG", "vdoPool") - self.assertIn("writeAmplificationRatio", full_stats.keys()) -+ -+ -+class LvmTestDevicesFile(LvmPVonlyTestCase): -+ devicefile = "bd_lvm_dbus_tests.devices" -+ -+ @classmethod -+ def tearDownClass(cls): -+ shutil.rmtree("/etc/lvm/devices/" + cls.devicefile, ignore_errors=True) -+ -+ super(LvmTestDevicesFile, cls).tearDownClass() -+ -+ def test_devices_add_delete(self): -+ if not self.devices_avail: -+ self.skipTest("skipping LVM devices file test: not supported") -+ -+ succ = BlockDev.lvm_pvcreate(self.loop_dev) -+ self.assertTrue(succ) -+ -+ with self.assertRaises(GLib.GError): -+ BlockDev.lvm_devices_add("/non/existing/device", self.devicefile) -+ -+ with self.assertRaises(GLib.GError): -+ BlockDev.lvm_devices_delete(self.loop_dev, self.devicefile) -+ -+ succ = BlockDev.lvm_devices_add(self.loop_dev, self.devicefile) -+ self.assertTrue(succ) -+ -+ dfile = read_file("/etc/lvm/devices/" + self.devicefile) -+ self.assertIn(self.loop_dev, dfile) -+ -+ succ = BlockDev.lvm_devices_delete(self.loop_dev, self.devicefile) -+ self.assertTrue(succ) -+ -+ dfile = read_file("/etc/lvm/devices/" + self.devicefile) -+ self.assertNotIn(self.loop_dev, dfile) -diff --git a/tests/lvm_test.py b/tests/lvm_test.py -index b37a879..786434f 100644 ---- a/tests/lvm_test.py -+++ b/tests/lvm_test.py -@@ -9,7 +9,7 @@ import shutil - import subprocess - from distutils.version import LooseVersion - --from utils import create_sparse_tempfile, create_lio_device, delete_lio_device, fake_utils, fake_path, TestTags, tag_test, run_command -+from utils import create_sparse_tempfile, create_lio_device, delete_lio_device, fake_utils, fake_path, TestTags, tag_test, run_command, read_file - from gi.repository import BlockDev, GLib - - -@@ -1682,3 +1682,38 @@ class LVMVDOTest(LVMTestCase): - - full_stats = BlockDev.lvm_vdo_get_stats_full("testVDOVG", "vdoPool") - self.assertIn("writeAmplificationRatio", full_stats.keys()) -+ -+ -+class LvmTestDevicesFile(LvmPVonlyTestCase): -+ devicefile = "bd_lvm_test.devices" -+ -+ @classmethod -+ def tearDownClass(cls): -+ shutil.rmtree("/etc/lvm/devices/" + cls.devicefile, ignore_errors=True) -+ -+ super(LvmTestDevicesFile, cls).tearDownClass() -+ -+ def test_devices_add_delete(self): -+ if not self.devices_avail: -+ self.skipTest("skipping LVM devices file test: not supported") -+ -+ succ = BlockDev.lvm_pvcreate(self.loop_dev) -+ self.assertTrue(succ) -+ -+ with self.assertRaises(GLib.GError): -+ BlockDev.lvm_devices_add("/non/existing/device", self.devicefile) -+ -+ with self.assertRaises(GLib.GError): -+ BlockDev.lvm_devices_delete(self.loop_dev, self.devicefile) -+ -+ succ = BlockDev.lvm_devices_add(self.loop_dev, self.devicefile) -+ self.assertTrue(succ) -+ -+ dfile = read_file("/etc/lvm/devices/" + self.devicefile) -+ self.assertIn(self.loop_dev, dfile) -+ -+ succ = BlockDev.lvm_devices_delete(self.loop_dev, self.devicefile) -+ self.assertTrue(succ) -+ -+ dfile = read_file("/etc/lvm/devices/" + self.devicefile) -+ self.assertNotIn(self.loop_dev, dfile) --- -2.31.1 - - -From 8d8cbe7169cb94b01e7064a0d00b7d86baf5e652 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 15 Oct 2021 13:18:54 +0200 -Subject: [PATCH 3/8] lvm: Report special error when system.devices file is not - enabled - -This can be disabled either in LVM by a compile time option or -by a lvm.conf option so we should report a specific error for this -case so users can distinguish between the feature not being enabled -and not being supported at all. ---- - src/lib/plugin_apis/lvm.api | 1 + - src/plugins/lvm-dbus.c | 70 +++++++++++++++++++++++++++++++++++++ - src/plugins/lvm.c | 60 +++++++++++++++++++++++++++++++ - src/plugins/lvm.h | 1 + - tests/lvm_dbus_tests.py | 15 ++++++++ - tests/lvm_test.py | 15 ++++++++ - 6 files changed, 162 insertions(+) - -diff --git a/src/lib/plugin_apis/lvm.api b/src/lib/plugin_apis/lvm.api -index bce2920..b96bcfd 100644 ---- a/src/lib/plugin_apis/lvm.api -+++ b/src/lib/plugin_apis/lvm.api -@@ -44,6 +44,7 @@ typedef enum { - BD_LVM_ERROR_FAIL, - BD_LVM_ERROR_NOT_SUPPORTED, - BD_LVM_ERROR_VDO_POLICY_INVAL, -+ BD_LVM_ERROR_DEVICES_DISABLED, - } BDLVMError; - - typedef enum { -diff --git a/src/plugins/lvm-dbus.c b/src/plugins/lvm-dbus.c -index 44d2794..22204d5 100644 ---- a/src/plugins/lvm-dbus.c -+++ b/src/plugins/lvm-dbus.c -@@ -3939,6 +3939,64 @@ BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_nam - return stats; - } - -+/* check whether the LVM devices file is enabled by LVM -+ * we use the existence of the "lvmdevices" command to check whether the feature is available -+ * or not, but this can still be disabled either in LVM or in lvm.conf -+ */ -+static gboolean _lvm_devices_enabled () { -+ const gchar *args[6] = {"lvmconfig", "--typeconfig", NULL, "devices/use_devicesfile", NULL, NULL}; -+ gboolean ret = FALSE; -+ GError *loc_error = NULL; -+ gchar *output = NULL; -+ gboolean enabled = FALSE; -+ gint scanned = 0; -+ g_autofree gchar *config_arg = NULL; -+ -+ /* try current config first -- if we get something from this it means the feature is -+ explicitly enabled or disabled by system lvm.conf or using the --config option */ -+ args[2] = "current"; -+ -+ /* make sure to include the global config from us when getting the current config value */ -+ g_mutex_lock (&global_config_lock); -+ if (global_config_str) { -+ config_arg = g_strdup_printf ("--config=%s", global_config_str); -+ args[4] = config_arg; -+ } -+ -+ ret = bd_utils_exec_and_capture_output (args, NULL, &output, &loc_error); -+ g_mutex_unlock (&global_config_lock); -+ if (ret) { -+ scanned = sscanf (output, "use_devicesfile=%u", &enabled); -+ g_free (output); -+ if (scanned != 1) -+ return FALSE; -+ -+ return enabled; -+ } else { -+ g_clear_error (&loc_error); -+ g_free (output); -+ } -+ -+ output = NULL; -+ -+ /* now try default */ -+ args[2] = "default"; -+ ret = bd_utils_exec_and_capture_output (args, NULL, &output, &loc_error); -+ if (ret) { -+ scanned = sscanf (output, "# use_devicesfile=%u", &enabled); -+ g_free (output); -+ if (scanned != 1) -+ return FALSE; -+ -+ return enabled; -+ } else { -+ g_clear_error (&loc_error); -+ g_free (output); -+ } -+ -+ return FALSE; -+} -+ - /** - * bd_lvm_devices_add: - * @device: device (PV) to add to the devices file -@@ -3957,6 +4015,12 @@ gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, con - if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) - return FALSE; - -+ if (!_lvm_devices_enabled ()) { -+ g_set_error (error, BD_LVM_ERROR, BD_LVM_ERROR_DEVICES_DISABLED, -+ "LVM devices file not enabled."); -+ return FALSE; -+ } -+ - if (devices_file) { - devfile = g_strdup_printf ("--devicesfile=%s", devices_file); - args[3] = devfile; -@@ -3983,6 +4047,12 @@ gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, - if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) - return FALSE; - -+ if (!_lvm_devices_enabled ()) { -+ g_set_error (error, BD_LVM_ERROR, BD_LVM_ERROR_DEVICES_DISABLED, -+ "LVM devices file not enabled."); -+ return FALSE; -+ } -+ - if (devices_file) { - devfile = g_strdup_printf ("--devicesfile=%s", devices_file); - args[3] = devfile; -diff --git a/src/plugins/lvm.c b/src/plugins/lvm.c -index 94c6a22..605fcb0 100644 ---- a/src/plugins/lvm.c -+++ b/src/plugins/lvm.c -@@ -3236,6 +3236,54 @@ BDLVMVDOStats* bd_lvm_vdo_get_stats (const gchar *vg_name, const gchar *pool_nam - return stats; - } - -+/* check whether the LVM devices file is enabled by LVM -+ * we use the existence of the "lvmdevices" command to check whether the feature is available -+ * or not, but this can still be disabled either in LVM or in lvm.conf -+ */ -+static gboolean _lvm_devices_enabled () { -+ const gchar *args[5] = {"config", "--typeconfig", NULL, "devices/use_devicesfile", NULL}; -+ gboolean ret = FALSE; -+ GError *loc_error = NULL; -+ gchar *output = NULL; -+ gboolean enabled = FALSE; -+ gint scanned = 0; -+ -+ /* try current config first -- if we get something from this it means the feature is -+ explicitly enabled or disabled by system lvm.conf or using the --config option */ -+ args[2] = "current"; -+ ret = call_lvm_and_capture_output (args, NULL, &output, &loc_error); -+ if (ret) { -+ scanned = sscanf (output, "use_devicesfile=%u", &enabled); -+ g_free (output); -+ if (scanned != 1) -+ return FALSE; -+ -+ return enabled; -+ } else { -+ g_clear_error (&loc_error); -+ g_free (output); -+ } -+ -+ output = NULL; -+ -+ /* now try default */ -+ args[2] = "default"; -+ ret = call_lvm_and_capture_output (args, NULL, &output, &loc_error); -+ if (ret) { -+ scanned = sscanf (output, "# use_devicesfile=%u", &enabled); -+ g_free (output); -+ if (scanned != 1) -+ return FALSE; -+ -+ return enabled; -+ } else { -+ g_clear_error (&loc_error); -+ g_free (output); -+ } -+ -+ return FALSE; -+} -+ - /** - * bd_lvm_devices_add: - * @device: device (PV) to add to the devices file -@@ -3254,6 +3302,12 @@ gboolean bd_lvm_devices_add (const gchar *device, const gchar *devices_file, con - if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) - return FALSE; - -+ if (!_lvm_devices_enabled ()) { -+ g_set_error (error, BD_LVM_ERROR, BD_LVM_ERROR_DEVICES_DISABLED, -+ "LVM devices file not enabled."); -+ return FALSE; -+ } -+ - if (devices_file) { - devfile = g_strdup_printf ("--devicesfile=%s", devices_file); - args[3] = devfile; -@@ -3280,6 +3334,12 @@ gboolean bd_lvm_devices_delete (const gchar *device, const gchar *devices_file, - if (!bd_lvm_is_tech_avail (BD_LVM_TECH_DEVICES, 0, error)) - return FALSE; - -+ if (!_lvm_devices_enabled ()) { -+ g_set_error (error, BD_LVM_ERROR, BD_LVM_ERROR_DEVICES_DISABLED, -+ "LVM devices file not enabled."); -+ return FALSE; -+ } -+ - if (devices_file) { - devfile = g_strdup_printf ("--devicesfile=%s", devices_file); - args[3] = devfile; -diff --git a/src/plugins/lvm.h b/src/plugins/lvm.h -index 5ca2a9d..fabf091 100644 ---- a/src/plugins/lvm.h -+++ b/src/plugins/lvm.h -@@ -53,6 +53,7 @@ typedef enum { - BD_LVM_ERROR_FAIL, - BD_LVM_ERROR_NOT_SUPPORTED, - BD_LVM_ERROR_VDO_POLICY_INVAL, -+ BD_LVM_ERROR_DEVICES_DISABLED, - } BDLVMError; - - typedef enum { -diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py -index fb1a9ed..c411c9e 100644 ---- a/tests/lvm_dbus_tests.py -+++ b/tests/lvm_dbus_tests.py -@@ -1731,3 +1731,18 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - - dfile = read_file("/etc/lvm/devices/" + self.devicefile) - self.assertNotIn(self.loop_dev, dfile) -+ -+ def test_devices_enabled(self): -+ if not self.devices_avail: -+ self.skipTest("skipping LVM devices file test: not supported") -+ -+ self.addCleanup(BlockDev.lvm_set_global_config, "") -+ -+ # checking if the feature is enabled or disabled is hard so lets just disable -+ # the devices file using the global config and check lvm_devices_add fails -+ # with the correct exception message -+ succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=0 }") -+ self.assertTrue(succ) -+ -+ with self.assertRaisesRegex(GLib.GError, "LVM devices file not enabled."): -+ BlockDev.lvm_devices_add("", self.devicefile) -diff --git a/tests/lvm_test.py b/tests/lvm_test.py -index 786434f..315dd07 100644 ---- a/tests/lvm_test.py -+++ b/tests/lvm_test.py -@@ -1717,3 +1717,18 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - - dfile = read_file("/etc/lvm/devices/" + self.devicefile) - self.assertNotIn(self.loop_dev, dfile) -+ -+ def test_devices_enabled(self): -+ if not self.devices_avail: -+ self.skipTest("skipping LVM devices file test: not supported") -+ -+ self.addCleanup(BlockDev.lvm_set_global_config, "") -+ -+ # checking if the feature is enabled or disabled is hard so lets just disable -+ # the devices file using the global config and check lvm_devices_add fails -+ # with the correct exception message -+ succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=0 }") -+ self.assertTrue(succ) -+ -+ with self.assertRaisesRegex(GLib.GError, "LVM devices file not enabled."): -+ BlockDev.lvm_devices_add("", self.devicefile) --- -2.31.1 - - -From 81df85e7ea6e129e78074b6967f80c505d1b08f0 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 15 Oct 2021 14:21:03 +0200 -Subject: [PATCH 4/8] lvm: Force enable LVM devices file for LvmTestDevicesFile - -This feauture might be disabled in lvm.conf so to be able to test -it we need to override this. The correct handling of the disabled -state is checked in a separate test case. ---- - tests/lvm_dbus_tests.py | 8 ++++++++ - tests/lvm_test.py | 8 ++++++++ - 2 files changed, 16 insertions(+) - -diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py -index c411c9e..9cfc647 100644 ---- a/tests/lvm_dbus_tests.py -+++ b/tests/lvm_dbus_tests.py -@@ -1711,6 +1711,12 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - if not self.devices_avail: - self.skipTest("skipping LVM devices file test: not supported") - -+ self.addCleanup(BlockDev.lvm_set_global_config, "") -+ -+ # force-enable the feature, it might be disabled by default -+ succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=1 }") -+ self.assertTrue(succ) -+ - succ = BlockDev.lvm_pvcreate(self.loop_dev) - self.assertTrue(succ) - -@@ -1732,6 +1738,8 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - dfile = read_file("/etc/lvm/devices/" + self.devicefile) - self.assertNotIn(self.loop_dev, dfile) - -+ BlockDev.lvm_set_global_config("") -+ - def test_devices_enabled(self): - if not self.devices_avail: - self.skipTest("skipping LVM devices file test: not supported") -diff --git a/tests/lvm_test.py b/tests/lvm_test.py -index 315dd07..ea3b7f8 100644 ---- a/tests/lvm_test.py -+++ b/tests/lvm_test.py -@@ -1697,6 +1697,12 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - if not self.devices_avail: - self.skipTest("skipping LVM devices file test: not supported") - -+ self.addCleanup(BlockDev.lvm_set_global_config, "") -+ -+ # force-enable the feature, it might be disabled by default -+ succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=1 }") -+ self.assertTrue(succ) -+ - succ = BlockDev.lvm_pvcreate(self.loop_dev) - self.assertTrue(succ) - -@@ -1718,6 +1724,8 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - dfile = read_file("/etc/lvm/devices/" + self.devicefile) - self.assertNotIn(self.loop_dev, dfile) - -+ BlockDev.lvm_set_global_config("") -+ - def test_devices_enabled(self): - if not self.devices_avail: - self.skipTest("skipping LVM devices file test: not supported") --- -2.31.1 - - -From 01237b62bb8ad67def7c937185c42152503fbc6f Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 12 Nov 2021 14:51:39 +0100 -Subject: [PATCH 5/8] tests: Fix resetting global LVM config after LVM devices - file test - -We need to set the config to None/NULL not to an empty string. ---- - tests/lvm_dbus_tests.py | 6 +++--- - tests/lvm_test.py | 6 +++--- - 2 files changed, 6 insertions(+), 6 deletions(-) - -diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py -index 9cfc647..d422869 100644 ---- a/tests/lvm_dbus_tests.py -+++ b/tests/lvm_dbus_tests.py -@@ -1711,7 +1711,7 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - if not self.devices_avail: - self.skipTest("skipping LVM devices file test: not supported") - -- self.addCleanup(BlockDev.lvm_set_global_config, "") -+ self.addCleanup(BlockDev.lvm_set_global_config, None) - - # force-enable the feature, it might be disabled by default - succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=1 }") -@@ -1738,13 +1738,13 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - dfile = read_file("/etc/lvm/devices/" + self.devicefile) - self.assertNotIn(self.loop_dev, dfile) - -- BlockDev.lvm_set_global_config("") -+ BlockDev.lvm_set_global_config(None) - - def test_devices_enabled(self): - if not self.devices_avail: - self.skipTest("skipping LVM devices file test: not supported") - -- self.addCleanup(BlockDev.lvm_set_global_config, "") -+ self.addCleanup(BlockDev.lvm_set_global_config, None) - - # checking if the feature is enabled or disabled is hard so lets just disable - # the devices file using the global config and check lvm_devices_add fails -diff --git a/tests/lvm_test.py b/tests/lvm_test.py -index ea3b7f8..882cdf2 100644 ---- a/tests/lvm_test.py -+++ b/tests/lvm_test.py -@@ -1697,7 +1697,7 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - if not self.devices_avail: - self.skipTest("skipping LVM devices file test: not supported") - -- self.addCleanup(BlockDev.lvm_set_global_config, "") -+ self.addCleanup(BlockDev.lvm_set_global_config, None) - - # force-enable the feature, it might be disabled by default - succ = BlockDev.lvm_set_global_config("devices { use_devicesfile=1 }") -@@ -1724,13 +1724,13 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - dfile = read_file("/etc/lvm/devices/" + self.devicefile) - self.assertNotIn(self.loop_dev, dfile) - -- BlockDev.lvm_set_global_config("") -+ BlockDev.lvm_set_global_config(None) - - def test_devices_enabled(self): - if not self.devices_avail: - self.skipTest("skipping LVM devices file test: not supported") - -- self.addCleanup(BlockDev.lvm_set_global_config, "") -+ self.addCleanup(BlockDev.lvm_set_global_config, None) - - # checking if the feature is enabled or disabled is hard so lets just disable - # the devices file using the global config and check lvm_devices_add fails --- -2.31.1 - - -From 2f33f2af18efa0b337f8383cb6f137d6211fe7fb Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 12 Nov 2021 15:10:45 +0100 -Subject: [PATCH 6/8] lvm: Do not set global config to and empty string - -If we set it to an empty string we end up running "--config" -without a parameter and lvm will use whatever is next parameter -like the device path for pvremove. ---- - src/plugins/lvm-dbus.c | 5 ++++- - src/plugins/lvm.c | 5 ++++- - tests/lvm_dbus_tests.py | 12 ++++++++++++ - tests/lvm_test.py | 12 ++++++++++++ - 4 files changed, 32 insertions(+), 2 deletions(-) - -diff --git a/src/plugins/lvm-dbus.c b/src/plugins/lvm-dbus.c -index 22204d5..b7bd019 100644 ---- a/src/plugins/lvm-dbus.c -+++ b/src/plugins/lvm-dbus.c -@@ -2644,7 +2644,10 @@ gboolean bd_lvm_set_global_config (const gchar *new_config, GError **error UNUSE - g_free (global_config_str); - - /* now store the new one */ -- global_config_str = g_strdup (new_config); -+ if (!new_config || g_strcmp0 (new_config, "") == 0) -+ global_config_str = NULL; -+ else -+ global_config_str = g_strdup (new_config); - - g_mutex_unlock (&global_config_lock); - return TRUE; -diff --git a/src/plugins/lvm.c b/src/plugins/lvm.c -index 605fcb0..124fce7 100644 ---- a/src/plugins/lvm.c -+++ b/src/plugins/lvm.c -@@ -2016,7 +2016,10 @@ gboolean bd_lvm_set_global_config (const gchar *new_config, GError **error UNUSE - g_free (global_config_str); - - /* now store the new one */ -- global_config_str = g_strdup (new_config); -+ if (!new_config || g_strcmp0 (new_config, "") == 0) -+ global_config_str = NULL; -+ else -+ global_config_str = g_strdup (new_config); - - g_mutex_unlock (&global_config_lock); - return TRUE; -diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py -index d422869..5516afe 100644 ---- a/tests/lvm_dbus_tests.py -+++ b/tests/lvm_dbus_tests.py -@@ -1754,3 +1754,15 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - - with self.assertRaisesRegex(GLib.GError, "LVM devices file not enabled."): - BlockDev.lvm_devices_add("", self.devicefile) -+ -+ -+class LvmConfigTestPvremove(LvmPVonlyTestCase): -+ -+ @tag_test(TestTags.REGRESSION) -+ def test_set_empty_config(self): -+ succ = BlockDev.lvm_pvcreate(self.loop_dev) -+ self.assertTrue(succ) -+ -+ BlockDev.lvm_set_global_config("") -+ succ = BlockDev.lvm_pvremove(self.loop_dev) -+ self.assertTrue(succ) -diff --git a/tests/lvm_test.py b/tests/lvm_test.py -index 882cdf2..e349817 100644 ---- a/tests/lvm_test.py -+++ b/tests/lvm_test.py -@@ -1740,3 +1740,15 @@ class LvmTestDevicesFile(LvmPVonlyTestCase): - - with self.assertRaisesRegex(GLib.GError, "LVM devices file not enabled."): - BlockDev.lvm_devices_add("", self.devicefile) -+ -+ -+class LvmConfigTestPvremove(LvmPVonlyTestCase): -+ -+ @tag_test(TestTags.REGRESSION) -+ def test_set_empty_config(self): -+ succ = BlockDev.lvm_pvcreate(self.loop_dev) -+ self.assertTrue(succ) -+ -+ BlockDev.lvm_set_global_config("") -+ succ = BlockDev.lvm_pvremove(self.loop_dev) -+ self.assertTrue(succ) --- -2.31.1 - - -From 2a4e610027a2c2a315054b84a323ce973939ca2d Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Tue, 16 Mar 2021 12:05:37 +0100 -Subject: [PATCH 7/8] vdo: Do not use g_memdup in bd_vdo_stats_copy - -g_memdup is deprecated and the replacement g_memdup2 is not yet -available so lets just do the copy manually. ---- - src/lib/plugin_apis/vdo.api | 17 ++++++++++++++++- - src/plugins/vdo.c | 17 ++++++++++++++++- - 2 files changed, 32 insertions(+), 2 deletions(-) - -diff --git a/src/lib/plugin_apis/vdo.api b/src/lib/plugin_apis/vdo.api -index 936f8e0..312de4e 100644 ---- a/src/lib/plugin_apis/vdo.api -+++ b/src/lib/plugin_apis/vdo.api -@@ -170,7 +170,22 @@ void bd_vdo_stats_free (BDVDOStats *stats) { - * Deprecated: 2.24: Use LVM-VDO integration instead. - */ - BDVDOStats* bd_vdo_stats_copy (BDVDOStats *stats) { -- return g_memdup (stats, sizeof (BDVDOStats)); -+ if (stats == NULL) -+ return NULL; -+ -+ BDVDOStats *new_stats = g_new0 (BDVDOStats, 1); -+ -+ new_stats->block_size = stats->block_size; -+ new_stats->logical_block_size = stats->logical_block_size; -+ new_stats->physical_blocks = stats->physical_blocks; -+ new_stats->data_blocks_used = stats->data_blocks_used; -+ new_stats->overhead_blocks_used = stats->overhead_blocks_used; -+ new_stats->logical_blocks_used = stats->logical_blocks_used; -+ new_stats->used_percent = stats->used_percent; -+ new_stats->saving_percent = stats->saving_percent; -+ new_stats->write_amplification_ratio = stats->write_amplification_ratio; -+ -+ return new_stats; - } - - GType bd_vdo_stats_get_type () { -diff --git a/src/plugins/vdo.c b/src/plugins/vdo.c -index 2352394..d443099 100644 ---- a/src/plugins/vdo.c -+++ b/src/plugins/vdo.c -@@ -81,7 +81,22 @@ void bd_vdo_stats_free (BDVDOStats *stats) { - } - - BDVDOStats* bd_vdo_stats_copy (BDVDOStats *stats) { -- return g_memdup (stats, sizeof (BDVDOStats)); -+ if (stats == NULL) -+ return NULL; -+ -+ BDVDOStats *new_stats = g_new0 (BDVDOStats, 1); -+ -+ new_stats->block_size = stats->block_size; -+ new_stats->logical_block_size = stats->logical_block_size; -+ new_stats->physical_blocks = stats->physical_blocks; -+ new_stats->data_blocks_used = stats->data_blocks_used; -+ new_stats->overhead_blocks_used = stats->overhead_blocks_used; -+ new_stats->logical_blocks_used = stats->logical_blocks_used; -+ new_stats->used_percent = stats->used_percent; -+ new_stats->saving_percent = stats->saving_percent; -+ new_stats->write_amplification_ratio = stats->write_amplification_ratio; -+ -+ return new_stats; - } - - --- -2.31.1 - - -From 577ea466e3b7af464137e087907ba980ad3994ee Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 26 Nov 2021 15:19:55 +0100 -Subject: [PATCH 8/8] lvm: Use "lvmconfig full" to get valid config instead of - "current" - -"lvmconfig current" doesn't work together with --config even if we -don't override the "use_devicefile" key. "lvmconfig full" seems to -be working in all cases. ---- - src/plugins/lvm-dbus.c | 4 ++-- - src/plugins/lvm.c | 4 ++-- - 2 files changed, 4 insertions(+), 4 deletions(-) - -diff --git a/src/plugins/lvm-dbus.c b/src/plugins/lvm-dbus.c -index b7bd019..825c5e9 100644 ---- a/src/plugins/lvm-dbus.c -+++ b/src/plugins/lvm-dbus.c -@@ -3955,9 +3955,9 @@ static gboolean _lvm_devices_enabled () { - gint scanned = 0; - g_autofree gchar *config_arg = NULL; - -- /* try current config first -- if we get something from this it means the feature is -+ /* try full config first -- if we get something from this it means the feature is - explicitly enabled or disabled by system lvm.conf or using the --config option */ -- args[2] = "current"; -+ args[2] = "full"; - - /* make sure to include the global config from us when getting the current config value */ - g_mutex_lock (&global_config_lock); -diff --git a/src/plugins/lvm.c b/src/plugins/lvm.c -index 124fce7..21320f3 100644 ---- a/src/plugins/lvm.c -+++ b/src/plugins/lvm.c -@@ -3251,9 +3251,9 @@ static gboolean _lvm_devices_enabled () { - gboolean enabled = FALSE; - gint scanned = 0; - -- /* try current config first -- if we get something from this it means the feature is -+ /* try full config first -- if we get something from this it means the feature is - explicitly enabled or disabled by system lvm.conf or using the --config option */ -- args[2] = "current"; -+ args[2] = "full"; - ret = call_lvm_and_capture_output (args, NULL, &output, &loc_error); - if (ret) { - scanned = sscanf (output, "use_devicesfile=%u", &enabled); --- -2.31.1 - diff --git a/SOURCES/0008-lvm-Fix-reading-statistics-for-VDO-pools-with-VDO-8.patch b/SOURCES/0008-lvm-Fix-reading-statistics-for-VDO-pools-with-VDO-8.patch deleted file mode 100644 index 4d3796b..0000000 --- a/SOURCES/0008-lvm-Fix-reading-statistics-for-VDO-pools-with-VDO-8.patch +++ /dev/null @@ -1,80 +0,0 @@ -From e0fcbae856454dba9df3f8df800d74fde66731e5 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Tue, 31 Aug 2021 14:07:23 +0200 -Subject: [PATCH] lvm: Fix reading statistics for VDO pools with VDO 8 - -The statistics are no longer available in /sys/kvdo, in the latest -version of kvdo we need to use /sys/block//vdo/statistics. - -Resolves: rhbz#1994220 ---- - src/plugins/vdo_stats.c | 42 +++++++++++++++++++++++++++++++++++++---- - 1 file changed, 38 insertions(+), 4 deletions(-) - -diff --git a/src/plugins/vdo_stats.c b/src/plugins/vdo_stats.c -index ed04b51..2e244aa 100644 ---- a/src/plugins/vdo_stats.c -+++ b/src/plugins/vdo_stats.c -@@ -133,6 +133,23 @@ static void add_computed_stats (GHashTable *stats) { - add_journal_stats (stats); - } - -+static gchar* _dm_node_from_name (const gchar *map_name, GError **error) { -+ gchar *dev_path = NULL; -+ gchar *ret = NULL; -+ gchar *dev_mapper_path = g_strdup_printf ("/dev/mapper/%s", map_name); -+ -+ dev_path = bd_utils_resolve_device (dev_mapper_path, error); -+ g_free (dev_mapper_path); -+ if (!dev_path) -+ /* error is already populated */ -+ return NULL; -+ -+ ret = g_path_get_basename (dev_path); -+ g_free (dev_path); -+ -+ return ret; -+} -+ - GHashTable __attribute__ ((visibility ("hidden"))) - *vdo_get_stats_full (const gchar *name, GError **error) { - GHashTable *stats; -@@ -141,14 +158,31 @@ GHashTable __attribute__ ((visibility ("hidden"))) - const gchar *direntry; - gchar *s; - gchar *val = NULL; -+ g_autofree gchar *dm_node = NULL; - -- /* TODO: does the `name` need to be escaped? */ -- stats_dir = g_build_path (G_DIR_SEPARATOR_S, VDO_SYS_PATH, name, "statistics", NULL); -+ /* try "new" (kvdo >= 8) path first -- /sys/block/dm-X/vdo/statistics */ -+ dm_node = _dm_node_from_name (name, error); -+ if (dm_node == NULL) { -+ g_prefix_error (error, "Failed to get DM node for %s: ", name); -+ return NULL; -+ } -+ -+ stats_dir = g_build_path (G_DIR_SEPARATOR_S, "/sys/block", dm_node, "vdo/statistics", NULL); - dir = g_dir_open (stats_dir, 0, error); - if (dir == NULL) { -- g_prefix_error (error, "Error reading statistics from %s: ", stats_dir); -+ g_debug ("Failed to read VDO stats using the new API, falling back to %s: %s", -+ VDO_SYS_PATH, (*error)->message); - g_free (stats_dir); -- return NULL; -+ g_clear_error (error); -+ -+ /* lets try /sys/kvdo */ -+ stats_dir = g_build_path (G_DIR_SEPARATOR_S, VDO_SYS_PATH, name, "statistics", NULL); -+ dir = g_dir_open (stats_dir, 0, error); -+ if (dir == NULL) { -+ g_prefix_error (error, "Error reading statistics from %s: ", stats_dir); -+ g_free (stats_dir); -+ return NULL; -+ } - } - - stats = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free); --- -2.31.1 - diff --git a/SOURCES/0009-vdo_stats-Default-to-100-savings-for-invalid-savings.patch b/SOURCES/0009-vdo_stats-Default-to-100-savings-for-invalid-savings.patch deleted file mode 100644 index f1ada49..0000000 --- a/SOURCES/0009-vdo_stats-Default-to-100-savings-for-invalid-savings.patch +++ /dev/null @@ -1,30 +0,0 @@ -From 940346f14ee5644f2593817b4196c18de8a713f0 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Mon, 22 Nov 2021 14:16:02 +0100 -Subject: [PATCH] vdo_stats: Default to 100 % savings for invalid savings - values - -We are currently using "-1" when VDO logical_blocks_used is 0 -which doesn't match the LVM logic which returns 100 so to make -both values in vdo_info and vdo_stats equal we should return 100 -in this case too. ---- - src/plugins/vdo_stats.c | 2 +- - 1 file changed, 1 insertion(+), 1 deletion(-) - -diff --git a/src/plugins/vdo_stats.c b/src/plugins/vdo_stats.c -index 3ec2d60..f3f0390 100644 ---- a/src/plugins/vdo_stats.c -+++ b/src/plugins/vdo_stats.c -@@ -96,7 +96,7 @@ static void add_block_stats (GHashTable *stats) { - g_hash_table_replace (stats, g_strdup ("oneKBlocksUsed"), g_strdup_printf ("%"G_GINT64_FORMAT, (data_blocks_used + overhead_blocks_used) * block_size / 1024)); - g_hash_table_replace (stats, g_strdup ("oneKBlocksAvailable"), g_strdup_printf ("%"G_GINT64_FORMAT, (physical_blocks - data_blocks_used - overhead_blocks_used) * block_size / 1024)); - g_hash_table_replace (stats, g_strdup ("usedPercent"), g_strdup_printf ("%.0f", 100.0 * (gfloat) (data_blocks_used + overhead_blocks_used) / (gfloat) physical_blocks + 0.5)); -- savings = (logical_blocks_used > 0) ? (gint64) (100.0 * (gfloat) (logical_blocks_used - data_blocks_used) / (gfloat) logical_blocks_used) : -1; -+ savings = (logical_blocks_used > 0) ? (gint64) (100.0 * (gfloat) (logical_blocks_used - data_blocks_used) / (gfloat) logical_blocks_used) : 100; - g_hash_table_replace (stats, g_strdup ("savings"), g_strdup_printf ("%"G_GINT64_FORMAT, savings)); - if (savings >= 0) - g_hash_table_replace (stats, g_strdup ("savingPercent"), g_strdup_printf ("%"G_GINT64_FORMAT, savings)); --- -2.31.1 - diff --git a/SOURCES/0010-Add-support-for-creating-and-activating-integrity-de.patch b/SOURCES/0010-Add-support-for-creating-and-activating-integrity-de.patch deleted file mode 100644 index 77d6bc8..0000000 --- a/SOURCES/0010-Add-support-for-creating-and-activating-integrity-de.patch +++ /dev/null @@ -1,966 +0,0 @@ -From 37f1aff5f5f967d6a4440d176f3de877aab789ac Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Mon, 20 Sep 2021 16:38:16 +0200 -Subject: [PATCH 1/3] Add support for creating and activating integrity devices - -This adds support for create, open and close actions for standalone -integrity devices using cryptsetup. ---- - configure.ac | 4 +- - src/lib/plugin_apis/crypto.api | 157 +++++++++++++++++ - src/plugins/crypto.c | 261 +++++++++++++++++++++++++++- - src/plugins/crypto.h | 41 +++++ - src/python/gi/overrides/BlockDev.py | 24 +++ - tests/crypto_test.py | 97 ++++++++++- - 6 files changed, 576 insertions(+), 8 deletions(-) - -diff --git a/configure.ac b/configure.ac -index abe1412..13830ae 100644 ---- a/configure.ac -+++ b/configure.ac -@@ -210,7 +210,9 @@ AS_IF([test "x$with_crypto" != "xno"], - AS_IF([$PKG_CONFIG --atleast-version=2.0.3 libcryptsetup], - [AC_DEFINE([LIBCRYPTSETUP_2])], []) - AS_IF([$PKG_CONFIG --atleast-version=2.3.0 libcryptsetup], -- [AC_DEFINE([LIBCRYPTSETUP_BITLK])], []) -+ [AC_DEFINE([LIBCRYPTSETUP_23])], []) -+ AS_IF([$PKG_CONFIG --atleast-version=2.4.0 libcryptsetup], -+ [AC_DEFINE([LIBCRYPTSETUP_24])], []) - AS_IF([test "x$with_escrow" != "xno"], - [LIBBLOCKDEV_PKG_CHECK_MODULES([NSS], [nss >= 3.18.0]) - LIBBLOCKDEV_CHECK_HEADER([volume_key/libvolume_key.h], [$GLIB_CFLAGS $NSS_CFLAGS], [libvolume_key.h not available])], -diff --git a/src/lib/plugin_apis/crypto.api b/src/lib/plugin_apis/crypto.api -index ef0217f..40e32c8 100644 ---- a/src/lib/plugin_apis/crypto.api -+++ b/src/lib/plugin_apis/crypto.api -@@ -1,5 +1,6 @@ - #include - #include -+#include - - #define BD_CRYPTO_LUKS_METADATA_SIZE G_GUINT64_CONSTANT (2097152ULL) // 2 MiB - -@@ -245,6 +246,115 @@ GType bd_crypto_luks_extra_get_type () { - return type; - } - -+#define BD_CRYPTO_TYPE_INTEGRITY_EXTRA (bd_crypto_integrity_extra_get_type ()) -+GType bd_crypto_integrity_extra_get_type(); -+ -+/** -+ * BDCryptoIntegrityExtra: -+ * @sector_size: integrity sector size -+ * @journal_size: size of journal in bytes -+ * @journal_watermark: journal flush watermark in percents; in bitmap mode sectors-per-bit -+ * @journal_commit_time: journal commit time (or bitmap flush time) in ms -+ * @interleave_sectors: number of interleave sectors (power of two) -+ * @tag_size: tag size per-sector in bytes -+ * @buffer_sectors: number of sectors in one buffer -+ */ -+typedef struct BDCryptoIntegrityExtra { -+ guint32 sector_size; -+ guint64 journal_size; -+ guint journal_watermark; -+ guint journal_commit_time; -+ guint32 interleave_sectors; -+ guint32 tag_size; -+ guint32 buffer_sectors; -+} BDCryptoIntegrityExtra; -+ -+/** -+ * bd_crypto_integrity_extra_copy: (skip) -+ * @extra: (allow-none): %BDCryptoIntegrityExtra to copy -+ * -+ * Creates a new copy of @extra. -+ */ -+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra *extra) { -+ if (extra == NULL) -+ return NULL; -+ -+ BDCryptoIntegrityExtra *new_extra = g_new0 (BDCryptoIntegrityExtra, 1); -+ -+ new_extra->sector_size = extra->sector_size; -+ new_extra->journal_size = extra->journal_size; -+ new_extra->journal_watermark = extra->journal_watermark; -+ new_extra->journal_commit_time = extra->journal_commit_time; -+ new_extra->interleave_sectors = extra->interleave_sectors; -+ new_extra->tag_size = extra->tag_size; -+ new_extra->buffer_sectors = extra->buffer_sectors; -+ -+ return new_extra; -+} -+ -+/** -+ * bd_crypto_integrity_extra_free: (skip) -+ * @extra: (allow-none): %BDCryptoIntegrityExtra to free -+ * -+ * Frees @extra. -+ */ -+void bd_crypto_integrity_extra_free (BDCryptoIntegrityExtra *extra) { -+ if (extra == NULL) -+ return; -+ -+ g_free (extra); -+} -+ -+/** -+ * bd_crypto_integrity_extra_new: (constructor) -+ * @sector_size: integrity sector size, 0 for default (512) -+ * @journal_size: size of journal in bytes -+ * @journal_watermark: journal flush watermark in percents; in bitmap mode sectors-per-bit -+ * @journal_commit_time: journal commit time (or bitmap flush time) in ms -+ * @interleave_sectors: number of interleave sectors (power of two) -+ * @tag_size: tag size per-sector in bytes -+ * @buffer_sectors: number of sectors in one buffer -+ * -+ * Returns: (transfer full): a new Integrity extra argument -+ */ -+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors) { -+ BDCryptoIntegrityExtra *ret = g_new0 (BDCryptoIntegrityExtra, 1); -+ ret->sector_size = sector_size; -+ ret->journal_size = journal_size; -+ ret->journal_watermark = journal_watermark; -+ ret->journal_commit_time = journal_commit_time; -+ ret->interleave_sectors = interleave_sectors; -+ ret->tag_size = tag_size; -+ ret->buffer_sectors = buffer_sectors; -+ -+ return ret; -+} -+ -+GType bd_crypto_integrity_extra_get_type () { -+ static GType type = 0; -+ -+ if (G_UNLIKELY(type == 0)) { -+ type = g_boxed_type_register_static("BDCryptoIntegrityExtra", -+ (GBoxedCopyFunc) bd_crypto_integrity_extra_copy, -+ (GBoxedFreeFunc) bd_crypto_integrity_extra_free); -+ } -+ -+ return type; -+} -+ -+typedef enum { -+ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = CRYPT_ACTIVATE_NO_JOURNAL, -+ BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = CRYPT_ACTIVATE_RECOVERY, -+#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP -+ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP, -+#endif -+ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = CRYPT_ACTIVATE_RECALCULATE, -+#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET -+ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = CRYPT_ACTIVATE_RECALCULATE_RESET, -+#endif -+ BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = CRYPT_ACTIVATE_ALLOW_DISCARDS, -+} BDCryptoIntegrityOpenFlags; -+ - #define BD_CRYPTO_TYPE_LUKS_INFO (bd_crypto_luks_info_get_type ()) - GType bd_crypto_luks_info_get_type(); - -@@ -857,6 +967,53 @@ BDCryptoLUKSInfo* bd_crypto_luks_info (const gchar *luks_device, GError **error) - */ - BDCryptoIntegrityInfo* bd_crypto_integrity_info (const gchar *device, GError **error); - -+/** -+ * bd_crypto_integrity_format: -+ * @device: a device to format as integrity -+ * @algorithm: integrity algorithm specification (e.g. "crc32c" or "sha256") or %NULL to use the default -+ * @wipe: whether to wipe the device after format; a device that is not initially wiped will contain invalid checksums -+ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed -+ * @key_size: size the integrity key and @key_data -+ * @extra: (allow-none): extra arguments for integrity format creation -+ * @error: (out): place to store error (if any) -+ * -+ * Formats the given @device as integrity according to the other parameters given. -+ * -+ * Returns: whether the given @device was successfully formatted as integrity or not -+ * (the @error) contains the error in such cases) -+ * -+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_CREATE -+ */ -+gboolean bd_crypto_integrity_format (const gchar *device, const gchar *algorithm, gboolean wipe, const guint8* key_data, gsize key_size, BDCryptoIntegrityExtra *extra, GError **error); -+ -+/** -+ * bd_crypto_integrity_open: -+ * @device: integrity device to open -+ * @name: name for the opened @device -+ * @algorithm: (allow-none): integrity algorithm specification (e.g. "crc32c" or "sha256") or %NULL to use the default -+ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed -+ * @key_size: size the integrity key and @key_data -+ * @flags: flags for the integrity device activation -+ * @extra: (allow-none): extra arguments for integrity open -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the @device was successfully opened or not -+ * -+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE -+ */ -+gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const gchar *algorithm, const guint8* key_data, gsize key_size, BDCryptoIntegrityOpenFlags flags, BDCryptoIntegrityExtra *extra, GError **error); -+ -+/** -+ * bd_crypto_integrity_close: -+ * @integrity_device: integrity device to close -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the given @integrity_device was successfully closed or not -+ * -+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE -+ */ -+gboolean bd_crypto_integrity_close (const gchar *integrity_device, GError **error); -+ - /** - * bd_crypto_device_seems_encrypted: - * @device: the queried device -diff --git a/src/plugins/crypto.c b/src/plugins/crypto.c -index 4fad9a8..b1b0700 100644 ---- a/src/plugins/crypto.c -+++ b/src/plugins/crypto.c -@@ -50,6 +50,18 @@ - - #define SECTOR_SIZE 512 - -+#define DEFAULT_LUKS_KEYSIZE_BITS 256 -+#define DEFAULT_LUKS_CIPHER "aes-xts-plain64" -+ -+#ifdef LIBCRYPTSETUP_23 -+/* 0 for autodetect since 2.3.0 */ -+#define DEFAULT_INTEGRITY_TAG_SIZE 0 -+#else -+/* we need some sane default for older versions, users should specify tag size when using -+ other algorithms than the default crc32c */ -+#define DEFAULT_INTEGRITY_TAG_SIZE 4 -+#endif -+ - #define UNUSED __attribute__((unused)) - - /** -@@ -146,6 +158,43 @@ BDCryptoLUKSExtra* bd_crypto_luks_extra_new (guint64 data_alignment, const gchar - return ret; - } - -+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors) { -+ BDCryptoIntegrityExtra *ret = g_new0 (BDCryptoIntegrityExtra, 1); -+ ret->sector_size = sector_size; -+ ret->journal_size = journal_size; -+ ret->journal_watermark = journal_watermark; -+ ret->journal_commit_time = journal_commit_time; -+ ret->interleave_sectors = interleave_sectors; -+ ret->tag_size = tag_size; -+ ret->buffer_sectors = buffer_sectors; -+ -+ return ret; -+} -+ -+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra *extra) { -+ if (extra == NULL) -+ return NULL; -+ -+ BDCryptoIntegrityExtra *new_extra = g_new0 (BDCryptoIntegrityExtra, 1); -+ -+ new_extra->sector_size = extra->sector_size; -+ new_extra->journal_size = extra->journal_size; -+ new_extra->journal_watermark = extra->journal_watermark; -+ new_extra->journal_commit_time = extra->journal_commit_time; -+ new_extra->interleave_sectors = extra->interleave_sectors; -+ new_extra->tag_size = extra->tag_size; -+ new_extra->buffer_sectors = extra->buffer_sectors; -+ -+ return new_extra; -+} -+ -+void bd_crypto_integrity_extra_free (BDCryptoIntegrityExtra *extra) { -+ if (extra == NULL) -+ return; -+ -+ g_free (extra); -+} -+ - void bd_crypto_luks_info_free (BDCryptoLUKSInfo *info) { - if (info == NULL) - return; -@@ -346,15 +395,15 @@ gboolean bd_crypto_is_tech_avail (BDCryptoTech tech, guint64 mode, GError **erro - "Integrity technology requires libcryptsetup >= 2.0"); - return FALSE; - #endif -- ret = mode & (BD_CRYPTO_TECH_MODE_QUERY); -+ ret = mode & (BD_CRYPTO_TECH_MODE_CREATE|BD_CRYPTO_TECH_MODE_OPEN_CLOSE|BD_CRYPTO_TECH_MODE_QUERY); - if (ret != mode) { - g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL, -- "Only 'query' supported for Integrity"); -+ "Only 'create', 'open' and 'query' supported for Integrity"); - return FALSE; - } else - return TRUE; - case BD_CRYPTO_TECH_BITLK: --#ifndef LIBCRYPTSETUP_BITLK -+#ifndef LIBCRYPTSETUP_23 - g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL, - "BITLK technology requires libcryptsetup >= 2.3.0"); - return FALSE; -@@ -2035,6 +2084,208 @@ BDCryptoIntegrityInfo* bd_crypto_integrity_info (const gchar *device, GError **e - } - #endif - -+static int _wipe_progress (guint64 size, guint64 offset, void *usrptr) { -+ /* "convert" the progress from 0-100 to 50-100 because wipe starts at 50 in bd_crypto_integrity_format */ -+ gdouble progress = 50 + (((gdouble) offset / size) * 100) / 2; -+ bd_utils_report_progress (*(guint64 *) usrptr, progress, "Integrity device wipe in progress"); -+ -+ return 0; -+} -+ -+/** -+ * bd_crypto_integrity_format: -+ * @device: a device to format as integrity -+ * @algorithm: integrity algorithm specification (e.g. "crc32c" or "sha256") -+ * @wipe: whether to wipe the device after format; a device that is not initially wiped will contain invalid checksums -+ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed -+ * @key_size: size the integrity key and @key_data -+ * @extra: (allow-none): extra arguments for integrity format creation -+ * @error: (out): place to store error (if any) -+ * -+ * Formats the given @device as integrity according to the other parameters given. -+ * -+ * Returns: whether the given @device was successfully formatted as integrity or not -+ * (the @error) contains the error in such cases) -+ * -+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_CREATE -+ */ -+gboolean bd_crypto_integrity_format (const gchar *device, const gchar *algorithm, gboolean wipe, const guint8* key_data, gsize key_size, BDCryptoIntegrityExtra *extra, GError **error) { -+ struct crypt_device *cd = NULL; -+ gint ret; -+ guint64 progress_id = 0; -+ gchar *msg = NULL; -+ struct crypt_params_integrity params = ZERO_INIT; -+ g_autofree gchar *tmp_name = NULL; -+ g_autofree gchar *tmp_path = NULL; -+ g_autofree gchar *dev_name = NULL; -+ -+ msg = g_strdup_printf ("Started formatting '%s' as integrity device", device); -+ progress_id = bd_utils_report_started (msg); -+ g_free (msg); -+ -+ ret = crypt_init (&cd, device); -+ if (ret != 0) { -+ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, -+ "Failed to initialize device: %s", strerror_l (-ret, c_locale)); -+ bd_utils_report_finished (progress_id, (*error)->message); -+ return FALSE; -+ } -+ -+ if (extra) { -+ params.sector_size = extra->sector_size; -+ params.journal_size = extra->journal_size; -+ params.journal_watermark = extra->journal_watermark; -+ params.journal_commit_time = extra->journal_commit_time; -+ params.interleave_sectors = extra->interleave_sectors; -+ params.tag_size = extra->tag_size; -+ params.buffer_sectors = extra->buffer_sectors; -+ } -+ -+ params.integrity_key_size = key_size; -+ params.integrity = algorithm; -+ params.tag_size = params.tag_size ? params.tag_size : DEFAULT_INTEGRITY_TAG_SIZE; -+ -+ ret = crypt_format (cd, CRYPT_INTEGRITY, NULL, NULL, NULL, NULL, 0, ¶ms); -+ if (ret != 0) { -+ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_FORMAT_FAILED, -+ "Failed to format device: %s", strerror_l (-ret, c_locale)); -+ crypt_free (cd); -+ bd_utils_report_finished (progress_id, (*error)->message); -+ return FALSE; -+ } -+ -+ if (wipe) { -+ bd_utils_report_progress (progress_id, 50, "Format created"); -+ -+ dev_name = g_path_get_basename (device); -+ tmp_name = g_strdup_printf ("bd-temp-integrity-%s-%d", dev_name, g_random_int ()); -+ tmp_path = g_strdup_printf ("%s/%s", crypt_get_dir (), tmp_name); -+ -+ ret = crypt_activate_by_volume_key (cd, tmp_name, (const char *) key_data, key_size, -+ CRYPT_ACTIVATE_PRIVATE | CRYPT_ACTIVATE_NO_JOURNAL); -+ if (ret != 0) { -+ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, -+ "Failed to activate the newly created integrity device for wiping: %s", -+ strerror_l (-ret, c_locale)); -+ crypt_free (cd); -+ bd_utils_report_finished (progress_id, (*error)->message); -+ return FALSE; -+ } -+ -+ bd_utils_report_progress (progress_id, 50, "Starting to wipe the newly created integrity device"); -+ ret = crypt_wipe (cd, tmp_path, CRYPT_WIPE_ZERO, 0, 0, 1048576, -+ 0, &_wipe_progress, &progress_id); -+ bd_utils_report_progress (progress_id, 100, "Wipe finished"); -+ if (ret != 0) { -+ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, -+ "Failed to wipe the newly created integrity device: %s", -+ strerror_l (-ret, c_locale)); -+ -+ ret = crypt_deactivate (cd, tmp_name); -+ if (ret != 0) -+ g_warning ("Failed to deactivate temporary device %s", tmp_name); -+ -+ crypt_free (cd); -+ bd_utils_report_finished (progress_id, (*error)->message); -+ return FALSE; -+ } -+ -+ ret = crypt_deactivate (cd, tmp_name); -+ if (ret != 0) -+ g_warning ("Failed to deactivate temporary device %s", tmp_name); -+ -+ } else -+ bd_utils_report_finished (progress_id, "Completed"); -+ -+ crypt_free (cd); -+ -+ return TRUE; -+} -+ -+/** -+ * bd_crypto_integrity_open: -+ * @device: integrity device to open -+ * @name: name for the opened @device -+ * @algorithm: (allow-none): integrity algorithm specification (e.g. "crc32c" or "sha256") or %NULL to use the default -+ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed -+ * @key_size: size the integrity key and @key_data -+ * @flags: flags for the integrity device activation -+ * @extra: (allow-none): extra arguments for integrity open -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the @device was successfully opened or not -+ * -+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE -+ */ -+gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const gchar *algorithm, const guint8* key_data, gsize key_size, BDCryptoIntegrityOpenFlags flags, BDCryptoIntegrityExtra *extra, GError **error) { -+ struct crypt_device *cd = NULL; -+ gint ret = 0; -+ guint64 progress_id = 0; -+ gchar *msg = NULL; -+ struct crypt_params_integrity params = ZERO_INIT; -+ -+ params.integrity = algorithm; -+ params.integrity_key_size = key_size; -+ -+ if (extra) { -+ params.sector_size = extra->sector_size; -+ params.journal_size = extra->journal_size; -+ params.journal_watermark = extra->journal_watermark; -+ params.journal_commit_time = extra->journal_commit_time; -+ params.interleave_sectors = extra->interleave_sectors; -+ params.tag_size = extra->tag_size; -+ params.buffer_sectors = extra->buffer_sectors; -+ } -+ -+ msg = g_strdup_printf ("Started opening '%s' integrity device", device); -+ progress_id = bd_utils_report_started (msg); -+ g_free (msg); -+ -+ ret = crypt_init (&cd, device); -+ if (ret != 0) { -+ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, -+ "Failed to initialize device: %s", strerror_l (-ret, c_locale)); -+ bd_utils_report_finished (progress_id, (*error)->message); -+ return FALSE; -+ } -+ -+ ret = crypt_load (cd, CRYPT_INTEGRITY, ¶ms); -+ if (ret != 0) { -+ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, -+ "Failed to load device's parameters: %s", strerror_l (-ret, c_locale)); -+ crypt_free (cd); -+ bd_utils_report_finished (progress_id, (*error)->message); -+ return FALSE; -+ } -+ -+ ret = crypt_activate_by_volume_key (cd, name, (const char *) key_data, key_size, flags); -+ if (ret < 0) { -+ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, -+ "Failed to activate device: %s", strerror_l (-ret, c_locale)); -+ -+ crypt_free (cd); -+ bd_utils_report_finished (progress_id, (*error)->message); -+ return FALSE; -+ } -+ -+ crypt_free (cd); -+ bd_utils_report_finished (progress_id, "Completed"); -+ return TRUE; -+} -+ -+/** -+ * bd_crypto_integrity_close: -+ * @integrity_device: integrity device to close -+ * @error: (out): place to store error (if any) -+ * -+ * Returns: whether the given @integrity_device was successfully closed or not -+ * -+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE -+ */ -+gboolean bd_crypto_integrity_close (const gchar *integrity_device, GError **error) { -+ return _crypto_close (integrity_device, "integrity", error); -+} -+ - /** - * bd_crypto_device_seems_encrypted: - * @device: the queried device -@@ -2472,7 +2723,7 @@ gboolean bd_crypto_escrow_device (const gchar *device, const gchar *passphrase, - * - * Tech category: %BD_CRYPTO_TECH_BITLK-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE - */ --#ifndef LIBCRYPTSETUP_BITLK -+#ifndef LIBCRYPTSETUP_23 - gboolean bd_crypto_bitlk_open (const gchar *device UNUSED, const gchar *name UNUSED, const guint8* pass_data UNUSED, gsize data_len UNUSED, gboolean read_only UNUSED, GError **error) { - /* this will return FALSE and set error, because BITLK technology is not available */ - return bd_crypto_is_tech_avail (BD_CRYPTO_TECH_BITLK, BD_CRYPTO_TECH_MODE_OPEN_CLOSE, error); -@@ -2542,7 +2793,7 @@ gboolean bd_crypto_bitlk_open (const gchar *device, const gchar *name, const gui - * - * Tech category: %BD_CRYPTO_TECH_BITLK-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE - */ --#ifndef LIBCRYPTSETUP_BITLK -+#ifndef LIBCRYPTSETUP_23 - gboolean bd_crypto_bitlk_close (const gchar *bitlk_device UNUSED, GError **error) { - /* this will return FALSE and set error, because BITLK technology is not available */ - return bd_crypto_is_tech_avail (BD_CRYPTO_TECH_BITLK, BD_CRYPTO_TECH_MODE_OPEN_CLOSE, error); -diff --git a/src/plugins/crypto.h b/src/plugins/crypto.h -index a38724d..166e558 100644 ---- a/src/plugins/crypto.h -+++ b/src/plugins/crypto.h -@@ -116,6 +116,43 @@ void bd_crypto_luks_extra_free (BDCryptoLUKSExtra *extra); - BDCryptoLUKSExtra* bd_crypto_luks_extra_copy (BDCryptoLUKSExtra *extra); - BDCryptoLUKSExtra* bd_crypto_luks_extra_new (guint64 data_alignment, const gchar *data_device, const gchar *integrity, guint64 sector_size, const gchar *label, const gchar *subsystem, BDCryptoLUKSPBKDF *pbkdf); - -+/** -+ * BDCryptoIntegrityExtra: -+ * @sector_size: integrity sector size -+ * @journal_size: size of journal in bytes -+ * @journal_watermark: journal flush watermark in percents; in bitmap mode sectors-per-bit -+ * @journal_commit_time: journal commit time (or bitmap flush time) in ms -+ * @interleave_sectors: number of interleave sectors (power of two) -+ * @tag_size: tag size per-sector in bytes -+ * @buffer_sectors: number of sectors in one buffer -+ */ -+typedef struct BDCryptoIntegrityExtra { -+ guint32 sector_size; -+ guint64 journal_size; -+ guint journal_watermark; -+ guint journal_commit_time; -+ guint32 interleave_sectors; -+ guint32 tag_size; -+ guint32 buffer_sectors; -+} BDCryptoIntegrityExtra; -+ -+void bd_crypto_integrity_extra_free (BDCryptoIntegrityExtra *extra); -+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra *extra); -+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors); -+ -+typedef enum { -+ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = CRYPT_ACTIVATE_NO_JOURNAL, -+ BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = CRYPT_ACTIVATE_RECOVERY, -+#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP -+ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP, -+#endif -+ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = CRYPT_ACTIVATE_RECALCULATE, -+#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET -+ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = CRYPT_ACTIVATE_RECALCULATE_RESET, -+#endif -+ BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = CRYPT_ACTIVATE_ALLOW_DISCARDS, -+} BDCryptoIntegrityOpenFlags; -+ - /** - * BDCryptoLUKSInfo: - * @version: LUKS version -@@ -209,6 +246,10 @@ gboolean bd_crypto_luks_header_restore (const gchar *device, const gchar *backup - BDCryptoLUKSInfo* bd_crypto_luks_info (const gchar *luks_device, GError **error); - BDCryptoIntegrityInfo* bd_crypto_integrity_info (const gchar *device, GError **error); - -+gboolean bd_crypto_integrity_format (const gchar *device, const gchar *algorithm, gboolean wipe, const guint8* key_data, gsize key_size, BDCryptoIntegrityExtra *extra, GError **error); -+gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const gchar *algorithm, const guint8* key_data, gsize key_size, BDCryptoIntegrityOpenFlags flags, BDCryptoIntegrityExtra *extra, GError **error); -+gboolean bd_crypto_integrity_close (const gchar *integrity_device, GError **error); -+ - gboolean bd_crypto_device_seems_encrypted (const gchar *device, GError **error); - gboolean bd_crypto_tc_open (const gchar *device, const gchar *name, const guint8* pass_data, gsize data_len, gboolean read_only, GError **error); - gboolean bd_crypto_tc_open_full (const gchar *device, const gchar *name, const guint8* pass_data, gsize data_len, const gchar **keyfiles, gboolean hidden, gboolean system, gboolean veracrypt, guint32 veracrypt_pim, gboolean read_only, GError **error); -diff --git a/src/python/gi/overrides/BlockDev.py b/src/python/gi/overrides/BlockDev.py -index 715a262..71bcd31 100644 ---- a/src/python/gi/overrides/BlockDev.py -+++ b/src/python/gi/overrides/BlockDev.py -@@ -276,6 +276,30 @@ def crypto_bitlk_open(device, name, passphrase, read_only=False): - __all__.append("crypto_bitlk_open") - - -+class CryptoIntegrityExtra(BlockDev.CryptoIntegrityExtra): -+ def __new__(cls, sector_size=0, journal_size=0, journal_watermark=0, journal_commit_time=0, interleave_sectors=0, tag_size=0, buffer_sectors=0): -+ ret = BlockDev.CryptoIntegrityExtra.new(sector_size, journal_size, journal_watermark, journal_commit_time, interleave_sectors, tag_size, buffer_sectors) -+ ret.__class__ = cls -+ return ret -+ def __init__(self, *args, **kwargs): # pylint: disable=unused-argument -+ super(CryptoIntegrityExtra, self).__init__() #pylint: disable=bad-super-call -+CryptoIntegrityExtra = override(CryptoIntegrityExtra) -+__all__.append("CryptoIntegrityExtra") -+ -+ -+_crypto_integrity_format = BlockDev.crypto_integrity_format -+@override(BlockDev.crypto_integrity_format) -+def crypto_integrity_format(device, algorithm=None, wipe=True, key_data=None, extra=None): -+ return _crypto_integrity_format(device, algorithm, wipe, key_data, extra) -+__all__.append("crypto_integrity_format") -+ -+_crypto_integrity_open = BlockDev.crypto_integrity_open -+@override(BlockDev.crypto_integrity_open) -+def crypto_integrity_open(device, name, algorithm, key_data=None, flags=0, extra=None): -+ return _crypto_integrity_open(device, name, algorithm, key_data, flags, extra) -+__all__.append("crypto_integrity_open") -+ -+ - _dm_create_linear = BlockDev.dm_create_linear - @override(BlockDev.dm_create_linear) - def dm_create_linear(map_name, device, length, uuid=None): -diff --git a/tests/crypto_test.py b/tests/crypto_test.py -index 0aecc03..1c6832e 100644 ---- a/tests/crypto_test.py -+++ b/tests/crypto_test.py -@@ -2,6 +2,7 @@ import unittest - import os - import tempfile - import overrides_hack -+import secrets - import shutil - import subprocess - import six -@@ -42,6 +43,8 @@ class CryptoTestCase(unittest.TestCase): - - requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "loop")) - -+ _dm_name = "libblockdevTestLUKS" -+ - @classmethod - def setUpClass(cls): - unittest.TestCase.setUpClass() -@@ -72,7 +75,7 @@ class CryptoTestCase(unittest.TestCase): - - def _clean_up(self): - try: -- BlockDev.crypto_luks_close("libblockdevTestLUKS") -+ BlockDev.crypto_luks_close(self._dm_name) - except: - pass - -@@ -964,7 +967,8 @@ class CryptoTestInfo(CryptoTestCase): - succ = BlockDev.crypto_luks_close("libblockdevTestLUKS") - self.assertTrue(succ) - --class CryptoTestIntegrity(CryptoTestCase): -+ -+class CryptoTestLUKS2Integrity(CryptoTestCase): - @tag_test(TestTags.SLOW) - @unittest.skipUnless(HAVE_LUKS2, "LUKS 2 not supported") - def test_luks2_integrity(self): -@@ -1151,3 +1155,92 @@ class CryptoTestBitlk(CryptoTestCase): - succ = BlockDev.crypto_bitlk_close("libblockdevTestBitlk") - self.assertTrue(succ) - self.assertFalse(os.path.exists("/dev/mapper/libblockdevTestBitlk")) -+ -+ -+class CryptoTestIntegrity(CryptoTestCase): -+ -+ _dm_name = "libblockdevTestIntegrity" -+ -+ @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported") -+ def test_integrity(self): -+ # basic format+open+close test -+ succ = BlockDev.crypto_integrity_format(self.loop_dev, "sha256", False) -+ self.assertTrue(succ) -+ -+ succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "sha256") -+ self.assertTrue(succ) -+ self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name)) -+ -+ info = BlockDev.crypto_integrity_info(self._dm_name) -+ self.assertEqual(info.algorithm, "sha256") -+ -+ succ = BlockDev.crypto_integrity_close(self._dm_name) -+ self.assertTrue(succ) -+ self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) -+ -+ # same now with a keyed algorithm -+ key = list(secrets.token_bytes(64)) -+ -+ succ = BlockDev.crypto_integrity_format(self.loop_dev, "hmac(sha256)", False, key) -+ self.assertTrue(succ) -+ -+ succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "hmac(sha256)", key) -+ self.assertTrue(succ) -+ self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name)) -+ -+ info = BlockDev.crypto_integrity_info(self._dm_name) -+ self.assertEqual(info.algorithm, "hmac(sha256)") -+ -+ succ = BlockDev.crypto_integrity_close(self._dm_name) -+ self.assertTrue(succ) -+ self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) -+ -+ # same with some custom parameters -+ extra = BlockDev.CryptoIntegrityExtra(sector_size=4096, interleave_sectors=65536) -+ succ = BlockDev.crypto_integrity_format(self.loop_dev, "crc32c", wipe=False, extra=extra) -+ self.assertTrue(succ) -+ -+ succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "crc32c") -+ self.assertTrue(succ) -+ self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name)) -+ -+ info = BlockDev.crypto_integrity_info(self._dm_name) -+ self.assertEqual(info.algorithm, "crc32c") -+ self.assertEqual(info.sector_size, 4096) -+ self.assertEqual(info.interleave_sectors, 65536) -+ -+ succ = BlockDev.crypto_integrity_close(self._dm_name) -+ self.assertTrue(succ) -+ self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) -+ -+ @tag_test(TestTags.SLOW) -+ @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported") -+ def test_integrity_wipe(self): -+ # also check that wipe progress reporting works -+ progress_log = [] -+ -+ def _my_progress_func(_task, _status, completion, msg): -+ progress_log.append((completion, msg)) -+ -+ succ = BlockDev.utils_init_prog_reporting(_my_progress_func) -+ self.assertTrue(succ) -+ self.addCleanup(BlockDev.utils_init_prog_reporting, None) -+ -+ succ = BlockDev.crypto_integrity_format(self.loop_dev, "sha256", True) -+ self.assertTrue(succ) -+ -+ # at least one message "Integrity device wipe in progress" should be logged -+ self.assertTrue(any(prog[1] == "Integrity device wipe in progress" for prog in progress_log)) -+ -+ succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "sha256") -+ self.assertTrue(succ) -+ self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name)) -+ -+ # check the devices was wiped and the checksums recalculated -+ # (mkfs reads some blocks first so without checksums it would fail) -+ ret, _out, err = run_command("mkfs.ext2 /dev/mapper/%s " % self._dm_name) -+ self.assertEqual(ret, 0, msg="Failed to create ext2 filesystem on integrity: %s" % err) -+ -+ succ = BlockDev.crypto_integrity_close(self._dm_name) -+ self.assertTrue(succ) -+ self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) --- -2.31.1 - - -From 4dcb7a42a2cb33f7a63021d72889c9a9688adfd3 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Thu, 30 Sep 2021 16:01:40 +0200 -Subject: [PATCH 2/3] Create smaller test images for integrity tests - -We are going to overwrite the entire device in test_integrity_wipe -so we need to make sure the sparse actually fits to /tmp which -can be smaller than 1 GiB. ---- - tests/crypto_test.py | 6 ++++-- - 1 file changed, 4 insertions(+), 2 deletions(-) - -diff --git a/tests/crypto_test.py b/tests/crypto_test.py -index 1c6832e..b7ec251 100644 ---- a/tests/crypto_test.py -+++ b/tests/crypto_test.py -@@ -44,6 +44,7 @@ class CryptoTestCase(unittest.TestCase): - requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "loop")) - - _dm_name = "libblockdevTestLUKS" -+ _sparse_size = 1024**3 - - @classmethod - def setUpClass(cls): -@@ -57,8 +58,8 @@ class CryptoTestCase(unittest.TestCase): - - def setUp(self): - self.addCleanup(self._clean_up) -- self.dev_file = create_sparse_tempfile("crypto_test", 1024**3) -- self.dev_file2 = create_sparse_tempfile("crypto_test2", 1024**3) -+ self.dev_file = create_sparse_tempfile("crypto_test", self._sparse_size) -+ self.dev_file2 = create_sparse_tempfile("crypto_test2", self._sparse_size) - try: - self.loop_dev = create_lio_device(self.dev_file) - except RuntimeError as e: -@@ -1160,6 +1161,7 @@ class CryptoTestBitlk(CryptoTestCase): - class CryptoTestIntegrity(CryptoTestCase): - - _dm_name = "libblockdevTestIntegrity" -+ _sparse_size = 100 * 1024**2 - - @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported") - def test_integrity(self): --- -2.31.1 - - -From 3b82f9085c0df2e58b673716cdefd747495738e2 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Wed, 20 Oct 2021 10:27:41 +0200 -Subject: [PATCH 3/3] crypto: Do not use libcryptsetup flags directly in - crypto.h - -We can "translate" our flags in the implementation instead to -avoid including libcryptsetup.h in our header and API files. ---- - src/lib/plugin_apis/crypto.api | 17 ++++++----------- - src/plugins/crypto.c | 34 +++++++++++++++++++++++++++++++++- - src/plugins/crypto.h | 16 ++++++---------- - tests/crypto_test.py | 14 ++++++++++++++ - 4 files changed, 59 insertions(+), 22 deletions(-) - -diff --git a/src/lib/plugin_apis/crypto.api b/src/lib/plugin_apis/crypto.api -index 40e32c8..cf87979 100644 ---- a/src/lib/plugin_apis/crypto.api -+++ b/src/lib/plugin_apis/crypto.api -@@ -1,6 +1,5 @@ - #include - #include --#include - - #define BD_CRYPTO_LUKS_METADATA_SIZE G_GUINT64_CONSTANT (2097152ULL) // 2 MiB - -@@ -343,16 +342,12 @@ GType bd_crypto_integrity_extra_get_type () { - } - - typedef enum { -- BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = CRYPT_ACTIVATE_NO_JOURNAL, -- BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = CRYPT_ACTIVATE_RECOVERY, --#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP -- BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP, --#endif -- BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = CRYPT_ACTIVATE_RECALCULATE, --#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET -- BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = CRYPT_ACTIVATE_RECALCULATE_RESET, --#endif -- BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = CRYPT_ACTIVATE_ALLOW_DISCARDS, -+ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = 1 << 0, -+ BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = 1 << 1, -+ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = 1 << 2, -+ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = 1 << 3, -+ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = 1 << 4, -+ BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = 1 << 5, - } BDCryptoIntegrityOpenFlags; - - #define BD_CRYPTO_TYPE_LUKS_INFO (bd_crypto_luks_info_get_type ()) -diff --git a/src/plugins/crypto.c b/src/plugins/crypto.c -index b1b0700..8a4d64a 100644 ---- a/src/plugins/crypto.c -+++ b/src/plugins/crypto.c -@@ -2223,6 +2223,7 @@ gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const - guint64 progress_id = 0; - gchar *msg = NULL; - struct crypt_params_integrity params = ZERO_INIT; -+ guint32 activate_flags = 0; - - params.integrity = algorithm; - params.integrity_key_size = key_size; -@@ -2237,6 +2238,37 @@ gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const - params.buffer_sectors = extra->buffer_sectors; - } - -+ -+ if (flags & BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL) -+ activate_flags |= CRYPT_ACTIVATE_NO_JOURNAL; -+ if (flags & BD_CRYPTO_INTEGRITY_OPEN_RECOVERY) -+ activate_flags |= CRYPT_ACTIVATE_RECOVERY; -+ if (flags & BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE) -+ activate_flags |= CRYPT_ACTIVATE_RECALCULATE; -+ if (flags & BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS) -+ activate_flags |= CRYPT_ACTIVATE_ALLOW_DISCARDS; -+ if (flags & BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP) { -+#ifndef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP -+ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL, -+ "Cannot activate %s with bitmap, installed version of cryptsetup doesn't support this option.", device); -+ bd_utils_report_finished (progress_id, (*error)->message); -+ return FALSE; -+#else -+ activate_flags |= CRYPT_ACTIVATE_NO_JOURNAL_BITMAP; -+#endif -+ } -+ -+ if (flags & BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET) { -+#ifndef CRYPT_ACTIVATE_RECALCULATE_RESET -+ g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL, -+ "Cannot reset integrity recalculation while activating %s, installed version of cryptsetup doesn't support this option.", device); -+ bd_utils_report_finished (progress_id, (*error)->message); -+ return FALSE; -+#else -+ activate_flags |= CRYPT_ACTIVATE_RECALCULATE_RESET; -+#endif -+ } -+ - msg = g_strdup_printf ("Started opening '%s' integrity device", device); - progress_id = bd_utils_report_started (msg); - g_free (msg); -@@ -2258,7 +2290,7 @@ gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const - return FALSE; - } - -- ret = crypt_activate_by_volume_key (cd, name, (const char *) key_data, key_size, flags); -+ ret = crypt_activate_by_volume_key (cd, name, (const char *) key_data, key_size, activate_flags); - if (ret < 0) { - g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE, - "Failed to activate device: %s", strerror_l (-ret, c_locale)); -diff --git a/src/plugins/crypto.h b/src/plugins/crypto.h -index 166e558..b5f133c 100644 ---- a/src/plugins/crypto.h -+++ b/src/plugins/crypto.h -@@ -141,16 +141,12 @@ BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra * - BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors); - - typedef enum { -- BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = CRYPT_ACTIVATE_NO_JOURNAL, -- BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = CRYPT_ACTIVATE_RECOVERY, --#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP -- BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP, --#endif -- BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = CRYPT_ACTIVATE_RECALCULATE, --#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET -- BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = CRYPT_ACTIVATE_RECALCULATE_RESET, --#endif -- BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = CRYPT_ACTIVATE_ALLOW_DISCARDS, -+ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL = 1 << 0, -+ BD_CRYPTO_INTEGRITY_OPEN_RECOVERY = 1 << 1, -+ BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP = 1 << 2, -+ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE = 1 << 3, -+ BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET = 1 << 4, -+ BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS = 1 << 5, - } BDCryptoIntegrityOpenFlags; - - /** -diff --git a/tests/crypto_test.py b/tests/crypto_test.py -index b7ec251..673d8b8 100644 ---- a/tests/crypto_test.py -+++ b/tests/crypto_test.py -@@ -1215,6 +1215,20 @@ class CryptoTestIntegrity(CryptoTestCase): - self.assertTrue(succ) - self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) - -+ # open with flags -+ succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "crc32c", -+ flags=BlockDev.CryptoIntegrityOpenFlags.ALLOW_DISCARDS) -+ self.assertTrue(succ) -+ self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name)) -+ -+ # check that discard is enabled for the mapped device -+ _ret, out, _err = run_command("dmsetup table %s" % self._dm_name) -+ self.assertIn("allow_discards", out) -+ -+ succ = BlockDev.crypto_integrity_close(self._dm_name) -+ self.assertTrue(succ) -+ self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name)) -+ - @tag_test(TestTags.SLOW) - @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported") - def test_integrity_wipe(self): --- -2.31.1 - diff --git a/SOURCES/0011-tests-Wait-for-raid-and-mirrored-LVs-to-be-synced-be.patch b/SOURCES/0011-tests-Wait-for-raid-and-mirrored-LVs-to-be-synced-be.patch deleted file mode 100644 index 938a8a4..0000000 --- a/SOURCES/0011-tests-Wait-for-raid-and-mirrored-LVs-to-be-synced-be.patch +++ /dev/null @@ -1,278 +0,0 @@ -From d0ba031e679d480855bea61060acea597d5ffbbd Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Wed, 15 Dec 2021 14:14:19 +0100 -Subject: [PATCH 1/2] tests: Wait for raid and mirrored LVs to be synced before - removing - -Resolves: rhbz#2030647 ---- - tests/lvm_dbus_tests.py | 31 +++++++++++++++++++++++++------ - tests/lvm_test.py | 31 +++++++++++++++++++++++++------ - 2 files changed, 50 insertions(+), 12 deletions(-) - -diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py -index 5516afe..5ce653e 100644 ---- a/tests/lvm_dbus_tests.py -+++ b/tests/lvm_dbus_tests.py -@@ -7,6 +7,8 @@ import six - import re - import shutil - import subprocess -+import time -+from contextlib import contextmanager - from distutils.version import LooseVersion - from itertools import chain - -@@ -18,6 +20,21 @@ sb = dbus.SystemBus() - lvm_dbus_running = any("lvmdbus" in name for name in chain(sb.list_names(), sb.list_activatable_names())) - - -+@contextmanager -+def wait_for_sync(vg_name, lv_name): -+ try: -+ yield -+ finally: -+ time.sleep(2) -+ while True: -+ ret, out, _err = run_command("LC_ALL=C lvs -o copy_percent --noheadings %s/%s" % (vg_name, lv_name)) -+ if ret != 0: -+ break -+ if int(float(out)) == 100: -+ break -+ time.sleep(1) -+ -+ - class LVMTestCase(unittest.TestCase): - @classmethod - def setUpClass(cls): -@@ -801,9 +818,10 @@ class LvmTestLVcreateType(LvmPVVGLVTestCase): - succ = BlockDev.lvm_lvremove("testVG", "testLV", True, None) - self.assertTrue(succ) - -- # try to create a mirrored LV -- succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "mirror", [self.loop_dev, self.loop_dev2], None) -- self.assertTrue(succ) -+ with wait_for_sync("testVG", "testLV"): -+ # try to create a mirrored LV -+ succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "mirror", [self.loop_dev, self.loop_dev2], None) -+ self.assertTrue(succ) - - # verify that the LV has the requested segtype - info = BlockDev.lvm_lvinfo("testVG", "testLV") -@@ -812,9 +830,10 @@ class LvmTestLVcreateType(LvmPVVGLVTestCase): - succ = BlockDev.lvm_lvremove("testVG", "testLV", True, None) - self.assertTrue(succ) - -- # try to create a raid1 LV -- succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "raid1", [self.loop_dev, self.loop_dev2], None) -- self.assertTrue(succ) -+ with wait_for_sync("testVG", "testLV"): -+ # try to create a raid1 LV -+ succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "raid1", [self.loop_dev, self.loop_dev2], None) -+ self.assertTrue(succ) - - # verify that the LV has the requested segtype - info = BlockDev.lvm_lvinfo("testVG", "testLV") -diff --git a/tests/lvm_test.py b/tests/lvm_test.py -index e349817..12b78ca 100644 ---- a/tests/lvm_test.py -+++ b/tests/lvm_test.py -@@ -7,12 +7,29 @@ import six - import re - import shutil - import subprocess -+import time -+from contextlib import contextmanager - from distutils.version import LooseVersion - - from utils import create_sparse_tempfile, create_lio_device, delete_lio_device, fake_utils, fake_path, TestTags, tag_test, run_command, read_file - from gi.repository import BlockDev, GLib - - -+@contextmanager -+def wait_for_sync(vg_name, lv_name): -+ try: -+ yield -+ finally: -+ time.sleep(2) -+ while True: -+ info = BlockDev.lvm_lvinfo(vg_name, lv_name) -+ if not info: -+ break -+ if info.copy_percent == 100: -+ break -+ time.sleep(1) -+ -+ - class LVMTestCase(unittest.TestCase): - - @classmethod -@@ -737,9 +754,10 @@ class LvmTestLVcreateType(LvmPVVGLVTestCase): - succ = BlockDev.lvm_lvremove("testVG", "testLV", True, None) - self.assertTrue(succ) - -- # try to create a mirrored LV -- succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "mirror", [self.loop_dev, self.loop_dev2], None) -- self.assertTrue(succ) -+ with wait_for_sync("testVG", "testLV"): -+ # try to create a mirrored LV -+ succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "mirror", [self.loop_dev, self.loop_dev2], None) -+ self.assertTrue(succ) - - # verify that the LV has the requested segtype - info = BlockDev.lvm_lvinfo("testVG", "testLV") -@@ -748,9 +766,10 @@ class LvmTestLVcreateType(LvmPVVGLVTestCase): - succ = BlockDev.lvm_lvremove("testVG", "testLV", True, None) - self.assertTrue(succ) - -- # try to create a raid1 LV -- succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "raid1", [self.loop_dev, self.loop_dev2], None) -- self.assertTrue(succ) -+ with wait_for_sync("testVG", "testLV"): -+ # try to create a raid1 LV -+ succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "raid1", [self.loop_dev, self.loop_dev2], None) -+ self.assertTrue(succ) - - # verify that the LV has the requested segtype - info = BlockDev.lvm_lvinfo("testVG", "testLV") --- -2.31.1 - - -From 36dbac970bc4a052dbd97f51eb47379036d15b6e Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Thu, 16 Dec 2021 12:27:33 +0100 -Subject: [PATCH 2/2] tests: Make smaller images for test_lvcreate_type - -We are now waiting for the initial resync for the RAID/mirror LVs -which means we are trying to overwrite the entire 1 GB image which -doesn't fit in /tmp on our CI machines. ---- - tests/lvm_dbus_tests.py | 16 +++++++++++----- - tests/lvm_test.py | 15 ++++++++++----- - 2 files changed, 21 insertions(+), 10 deletions(-) - -diff --git a/tests/lvm_dbus_tests.py b/tests/lvm_dbus_tests.py -index 5ce653e..723aabb 100644 ---- a/tests/lvm_dbus_tests.py -+++ b/tests/lvm_dbus_tests.py -@@ -313,14 +313,17 @@ class LvmNoDevTestCase(LVMTestCase): - - @unittest.skipUnless(lvm_dbus_running, "LVM DBus not running") - class LvmPVonlyTestCase(LVMTestCase): -+ -+ _sparse_size = 1024**3 -+ - # :TODO: - # * test pvmove (must create two PVs, a VG, a VG and some data in it - # first) - # * some complex test for pvs, vgs, lvs, pvinfo, vginfo and lvinfo - def setUp(self): - self.addCleanup(self._clean_up) -- self.dev_file = create_sparse_tempfile("lvm_test", 1024**3) -- self.dev_file2 = create_sparse_tempfile("lvm_test", 1024**3) -+ self.dev_file = create_sparse_tempfile("lvm_test", self._sparse_size) -+ self.dev_file2 = create_sparse_tempfile("lvm_test", self._sparse_size) - try: - self.loop_dev = create_lio_device(self.dev_file) - except RuntimeError as e: -@@ -795,6 +798,9 @@ class LvmTestLVcreateWithExtra(LvmPVVGLVTestCase): - - @unittest.skipUnless(lvm_dbus_running, "LVM DBus not running") - class LvmTestLVcreateType(LvmPVVGLVTestCase): -+ -+ _sparse_size = 200 * 1024**2 -+ - def test_lvcreate_type(self): - """Verify it's possible to create LVs with various types""" - -@@ -808,7 +814,7 @@ class LvmTestLVcreateType(LvmPVVGLVTestCase): - self.assertTrue(succ) - - # try to create a striped LV -- succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "striped", [self.loop_dev, self.loop_dev2], None) -+ succ = BlockDev.lvm_lvcreate("testVG", "testLV", 100 * 1024**2, "striped", [self.loop_dev, self.loop_dev2], None) - self.assertTrue(succ) - - # verify that the LV has the requested segtype -@@ -820,7 +826,7 @@ class LvmTestLVcreateType(LvmPVVGLVTestCase): - - with wait_for_sync("testVG", "testLV"): - # try to create a mirrored LV -- succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "mirror", [self.loop_dev, self.loop_dev2], None) -+ succ = BlockDev.lvm_lvcreate("testVG", "testLV", 100 * 1024**2, "mirror", [self.loop_dev, self.loop_dev2], None) - self.assertTrue(succ) - - # verify that the LV has the requested segtype -@@ -832,7 +838,7 @@ class LvmTestLVcreateType(LvmPVVGLVTestCase): - - with wait_for_sync("testVG", "testLV"): - # try to create a raid1 LV -- succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "raid1", [self.loop_dev, self.loop_dev2], None) -+ succ = BlockDev.lvm_lvcreate("testVG", "testLV", 100 * 1024**2, "raid1", [self.loop_dev, self.loop_dev2], None) - self.assertTrue(succ) - - # verify that the LV has the requested segtype -diff --git a/tests/lvm_test.py b/tests/lvm_test.py -index 12b78ca..97f6c69 100644 ---- a/tests/lvm_test.py -+++ b/tests/lvm_test.py -@@ -302,14 +302,17 @@ class LvmNoDevTestCase(LVMTestCase): - BlockDev.lvm_cache_get_mode_from_str("bla") - - class LvmPVonlyTestCase(LVMTestCase): -+ -+ _sparse_size = 1024**3 -+ - # :TODO: - # * test pvmove (must create two PVs, a VG, a VG and some data in it - # first) - # * some complex test for pvs, vgs, lvs, pvinfo, vginfo and lvinfo - def setUp(self): - self.addCleanup(self._clean_up) -- self.dev_file = create_sparse_tempfile("lvm_test", 1024**3) -- self.dev_file2 = create_sparse_tempfile("lvm_test", 1024**3) -+ self.dev_file = create_sparse_tempfile("lvm_test", self._sparse_size) -+ self.dev_file2 = create_sparse_tempfile("lvm_test", self._sparse_size) - try: - self.loop_dev = create_lio_device(self.dev_file) - except RuntimeError as e: -@@ -731,6 +734,8 @@ class LvmTestLVcreateWithExtra(LvmPVVGLVTestCase): - self.assertTrue(succ) - - class LvmTestLVcreateType(LvmPVVGLVTestCase): -+ _sparse_size = 200 * 1024**2 -+ - def test_lvcreate_type(self): - """Verify it's possible to create LVs with various types""" - -@@ -744,7 +749,7 @@ class LvmTestLVcreateType(LvmPVVGLVTestCase): - self.assertTrue(succ) - - # try to create a striped LV -- succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "striped", [self.loop_dev, self.loop_dev2], None) -+ succ = BlockDev.lvm_lvcreate("testVG", "testLV", 100 * 1024**2, "striped", [self.loop_dev, self.loop_dev2], None) - self.assertTrue(succ) - - # verify that the LV has the requested segtype -@@ -756,7 +761,7 @@ class LvmTestLVcreateType(LvmPVVGLVTestCase): - - with wait_for_sync("testVG", "testLV"): - # try to create a mirrored LV -- succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "mirror", [self.loop_dev, self.loop_dev2], None) -+ succ = BlockDev.lvm_lvcreate("testVG", "testLV", 100 * 1024**2, "mirror", [self.loop_dev, self.loop_dev2], None) - self.assertTrue(succ) - - # verify that the LV has the requested segtype -@@ -768,7 +773,7 @@ class LvmTestLVcreateType(LvmPVVGLVTestCase): - - with wait_for_sync("testVG", "testLV"): - # try to create a raid1 LV -- succ = BlockDev.lvm_lvcreate("testVG", "testLV", 512 * 1024**2, "raid1", [self.loop_dev, self.loop_dev2], None) -+ succ = BlockDev.lvm_lvcreate("testVG", "testLV", 100 * 1024**2, "raid1", [self.loop_dev, self.loop_dev2], None) - self.assertTrue(succ) - - # verify that the LV has the requested segtype --- -2.31.1 - diff --git a/SOURCES/0012-tests-Lower-expected-free-space-on-newly-created-Ext-filesystems.patch b/SOURCES/0012-tests-Lower-expected-free-space-on-newly-created-Ext-filesystems.patch deleted file mode 100644 index 66b5999..0000000 --- a/SOURCES/0012-tests-Lower-expected-free-space-on-newly-created-Ext-filesystems.patch +++ /dev/null @@ -1,71 +0,0 @@ -From 8978b7e6913f904bea887b0c542f9f82c969c2cf Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Wed, 1 Sep 2021 11:36:29 +0200 -Subject: [PATCH] tests: Lower expected free space on newly created Ext - filesystems - -With e2fsprogs 1.46.4 we now see less than 90 % of free blocks on -newly created devices in our tests. ---- - tests/fs_test.py | 20 ++++++++++---------- - 1 file changed, 10 insertions(+), 10 deletions(-) - -diff --git a/tests/fs_test.py b/tests/fs_test.py -index 551b6a7b..6b0134bf 100644 ---- a/tests/fs_test.py -+++ b/tests/fs_test.py -@@ -425,8 +425,8 @@ def _test_ext_get_info(self, mkfs_function, info_function): - self.assertTrue(fi) - self.assertEqual(fi.block_size, 1024) - self.assertEqual(fi.block_count, 100 * 1024**2 / 1024) -- # at least 90 % should be available, so it should be reported -- self.assertGreater(fi.free_blocks, 0.90 * 100 * 1024**2 / 1024) -+ # at least 80 % should be available, so it should be reported -+ self.assertGreater(fi.free_blocks, 0.80 * 100 * 1024**2 / 1024) - self.assertEqual(fi.label, "") - # should be an non-empty string - self.assertTrue(fi.uuid) -@@ -436,8 +436,8 @@ def _test_ext_get_info(self, mkfs_function, info_function): - fi = BlockDev.fs_ext4_get_info(self.loop_dev) - self.assertEqual(fi.block_size, 1024) - self.assertEqual(fi.block_count, 100 * 1024**2 / 1024) -- # at least 90 % should be available, so it should be reported -- self.assertGreater(fi.free_blocks, 0.90 * 100 * 1024**2 / 1024) -+ # at least 80 % should be available, so it should be reported -+ self.assertGreater(fi.free_blocks, 0.80 * 100 * 1024**2 / 1024) - self.assertEqual(fi.label, "") - # should be an non-empty string - self.assertTrue(fi.uuid) -@@ -515,8 +515,8 @@ def _test_ext_resize(self, mkfs_function, info_function, resize_function): - self.assertTrue(fi) - self.assertEqual(fi.block_size, 1024) - self.assertEqual(fi.block_count, 100 * 1024**2 / 1024) -- # at least 90 % should be available, so it should be reported -- self.assertGreater(fi.free_blocks, 0.90 * 100 * 1024**2 / 1024) -+ # at least 80 % should be available, so it should be reported -+ self.assertGreater(fi.free_blocks, 0.80 * 100 * 1024**2 / 1024) - - succ = resize_function(self.loop_dev, 50 * 1024**2, None) - self.assertTrue(succ) -@@ -532,8 +532,8 @@ def _test_ext_resize(self, mkfs_function, info_function, resize_function): - self.assertTrue(fi) - self.assertEqual(fi.block_size, 1024) - self.assertEqual(fi.block_count, 100 * 1024**2 / 1024) -- # at least 90 % should be available, so it should be reported -- self.assertGreater(fi.free_blocks, 0.90 * 100 * 1024**2 / 1024) -+ # at least 80 % should be available, so it should be reported -+ self.assertGreater(fi.free_blocks, 0.80 * 100 * 1024**2 / 1024) - - # resize again - succ = resize_function(self.loop_dev, 50 * 1024**2, None) -@@ -550,8 +550,8 @@ def _test_ext_resize(self, mkfs_function, info_function, resize_function): - self.assertTrue(fi) - self.assertEqual(fi.block_size, 1024) - self.assertEqual(fi.block_count, 100 * 1024**2 / 1024) -- # at least 90 % should be available, so it should be reported -- self.assertGreater(fi.free_blocks, 0.90 * 100 * 1024**2 / 1024) -+ # at least 80 % should be available, so it should be reported -+ self.assertGreater(fi.free_blocks, 0.80 * 100 * 1024**2 / 1024) - - def test_ext2_resize(self): - """Verify that it is possible to resize an ext2 file system""" diff --git a/SOURCES/0013-ddf-mdadm-uuid-parse-fix.patch b/SOURCES/0013-ddf-mdadm-uuid-parse-fix.patch deleted file mode 100644 index 7206cee..0000000 --- a/SOURCES/0013-ddf-mdadm-uuid-parse-fix.patch +++ /dev/null @@ -1,275 +0,0 @@ -From 9bcaddbe97067f10e643a7d99fa13716126f6e60 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Tue, 25 Aug 2020 14:09:18 +0200 -Subject: [PATCH 1/4] mdraid: Do not ignore errors from bd_md_canonicalize_uuid - in bd_md_examine - ---- - src/plugins/mdraid.c | 12 ++++++++++++ - 1 file changed, 12 insertions(+) - -diff --git a/src/plugins/mdraid.c b/src/plugins/mdraid.c -index b97bc641..d41b6372 100644 ---- a/src/plugins/mdraid.c -+++ b/src/plugins/mdraid.c -@@ -983,12 +983,24 @@ BDMDExamineData* bd_md_examine (const gchar *device, GError **error) { - orig_data = ret->uuid; - if (orig_data) { - ret->uuid = bd_md_canonicalize_uuid (orig_data, error); -+ if (!ret->uuid) { -+ g_prefix_error (error, "Failed to canonicalize MD UUID '%s': ", orig_data); -+ g_free (orig_data); -+ bd_md_examine_data_free (ret); -+ return NULL; -+ } - g_free (orig_data); - } - - orig_data = ret->dev_uuid; - if (orig_data) { - ret->dev_uuid = bd_md_canonicalize_uuid (orig_data, error); -+ if (!ret->uuid) { -+ g_prefix_error (error, "Failed to canonicalize MD UUID '%s': ", orig_data); -+ g_free (orig_data); -+ bd_md_examine_data_free (ret); -+ return NULL; -+ } - g_free (orig_data); - } - --- -2.37.1 - - -From 1805734e8315d5fb73f036dae043312c88f3c3ec Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Tue, 25 Aug 2020 14:12:52 +0200 -Subject: [PATCH 2/4] mdraid: Try harder to get container UUID in bd_md_examine - -For containers UUID is not printed in 'mdadm --examine' but it is -printed when using the '--export' option. ---- - src/plugins/mdraid.c | 11 +++++++++++ - 1 file changed, 11 insertions(+) - -diff --git a/src/plugins/mdraid.c b/src/plugins/mdraid.c -index d41b6372..3a23cf2e 100644 ---- a/src/plugins/mdraid.c -+++ b/src/plugins/mdraid.c -@@ -1023,6 +1023,17 @@ BDMDExamineData* bd_md_examine (const gchar *device, GError **error) { - value++; - g_free (ret->level); - ret->level = g_strdup (value); -+ } else if (!ret->uuid && g_str_has_prefix (output_fields[i], "MD_UUID=")) { -+ value = strchr (output_fields[i], '='); -+ value++; -+ ret->uuid = bd_md_canonicalize_uuid (value, error); -+ if (!ret->uuid) { -+ g_prefix_error (error, "Failed to canonicalize MD UUID '%s': ", orig_data); -+ g_free (orig_data); -+ bd_md_examine_data_free (ret); -+ g_strfreev (output_fields); -+ return NULL; -+ } - } - g_strfreev (output_fields); - --- -2.37.1 - - -From 166756338f90d90b32ae0989db706dd52f7df234 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Thu, 4 Aug 2022 12:47:53 +0200 -Subject: [PATCH 3/4] mdraid: Try harder to get container UUID in bd_md_detail - -Similarly to bd_md_examine (see a10ad4e0), "mdadm --detail" -doesn't contain container UUID, we need to need "--export" for -that. ---- - src/plugins/mdraid.c | 43 +++++++++++++++++++++++++++++++++++-------- - 1 file changed, 35 insertions(+), 8 deletions(-) - -diff --git a/src/plugins/mdraid.c b/src/plugins/mdraid.c -index 3a23cf2e..67bdc1f9 100644 ---- a/src/plugins/mdraid.c -+++ b/src/plugins/mdraid.c -@@ -1093,13 +1093,16 @@ BDMDExamineData* bd_md_examine (const gchar *device, GError **error) { - * Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_QUERY - */ - BDMDDetailData* bd_md_detail (const gchar *raid_spec, GError **error) { -- const gchar *argv[] = {"mdadm", "--detail", NULL, NULL}; -+ const gchar *argv[] = {"mdadm", "--detail", NULL, NULL, NULL}; - gchar *output = NULL; - gboolean success = FALSE; - GHashTable *table = NULL; - guint num_items = 0; - gchar *orig_uuid = NULL; -- gchar *mdadm_spec = NULL; -+ g_autofree gchar *mdadm_spec = NULL; -+ gchar *value = NULL; -+ gchar **output_fields = NULL; -+ guint i = 0; - BDMDDetailData *ret = NULL; - - if (!check_deps (&avail_deps, DEPS_MDADM_MASK, deps, DEPS_LAST, &deps_check_lock, error)) -@@ -1113,16 +1116,13 @@ BDMDDetailData* bd_md_detail (const gchar *raid_spec, GError **error) { - argv[2] = mdadm_spec; - - success = bd_utils_exec_and_capture_output (argv, NULL, &output, error); -- if (!success) { -- g_free (mdadm_spec); -+ if (!success) - /* error is already populated */ - return NULL; -- } - - table = parse_mdadm_vars (output, "\n", ":", &num_items); - g_free (output); - if (!table || (num_items == 0)) { -- g_free (mdadm_spec); - /* something bad happened or some expected items were missing */ - g_set_error (error, BD_MD_ERROR, BD_MD_ERROR_PARSE, "Failed to parse mddetail data"); - if (table) -@@ -1132,7 +1132,6 @@ BDMDDetailData* bd_md_detail (const gchar *raid_spec, GError **error) { - - ret = get_detail_data_from_table (table, TRUE); - if (!ret) { -- g_free (mdadm_spec); - g_set_error (error, BD_MD_ERROR, BD_MD_ERROR_PARSE, "Failed to get mddetail data"); - return NULL; - } -@@ -1145,7 +1144,35 @@ BDMDDetailData* bd_md_detail (const gchar *raid_spec, GError **error) { - g_free (orig_uuid); - } - -- g_free (mdadm_spec); -+ if (!ret->uuid) { -+ argv[2] = "--export"; -+ argv[3] = mdadm_spec; -+ success = bd_utils_exec_and_capture_output (argv, NULL, &output, error); -+ if (!success) { -+ /* error is already populated */ -+ bd_md_detail_data_free (ret); -+ return NULL; -+ } -+ -+ /* try to get a better information about RAID level because it may be -+ missing in the output without --export */ -+ output_fields = g_strsplit (output, "\n", 0); -+ g_free (output); -+ output = NULL; -+ for (i = 0; (i < g_strv_length (output_fields) - 1); i++) -+ if (g_str_has_prefix (output_fields[i], "MD_UUID=")) { -+ value = strchr (output_fields[i], '='); -+ value++; -+ ret->uuid = bd_md_canonicalize_uuid (value, error); -+ if (!ret->uuid) { -+ g_prefix_error (error, "Failed to canonicalize MD UUID '%s': ", value); -+ bd_md_detail_data_free (ret); -+ g_strfreev (output_fields); -+ return NULL; -+ } -+ } -+ g_strfreev (output_fields); -+ } - - return ret; - } --- -2.37.1 - - -From 25dd2f8c7cc3cf540902fc40e808faabda3c691a Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Thu, 4 Aug 2022 12:51:48 +0200 -Subject: [PATCH 4/4] Add a test case for DDF arrays/containers - ---- - tests/mdraid_test.py | 51 ++++++++++++++++++++++++++++++++++++++++---- - 1 file changed, 47 insertions(+), 4 deletions(-) - -diff --git a/tests/mdraid_test.py b/tests/mdraid_test.py -index 0b2bdc9b..38f43a0d 100644 ---- a/tests/mdraid_test.py -+++ b/tests/mdraid_test.py -@@ -6,7 +6,7 @@ from contextlib import contextmanager - import overrides_hack - import six - --from utils import create_sparse_tempfile, create_lio_device, delete_lio_device, fake_utils, fake_path, TestTags, tag_test -+from utils import create_sparse_tempfile, create_lio_device, delete_lio_device, fake_utils, fake_path, TestTags, tag_test, run_command - from gi.repository import BlockDev, GLib - - -@@ -90,14 +90,16 @@ class MDNoDevTestCase(MDTest): - - class MDTestCase(MDTest): - -+ _sparse_size = 10 * 1024**2 -+ - def setUp(self): - if os.uname()[-1] == "i686": - self.skipTest("Skipping hanging MD RAID tests on i686") - - self.addCleanup(self._clean_up) -- self.dev_file = create_sparse_tempfile("md_test", 10 * 1024**2) -- self.dev_file2 = create_sparse_tempfile("md_test", 10 * 1024**2) -- self.dev_file3 = create_sparse_tempfile("md_test", 10 * 1024**2) -+ self.dev_file = create_sparse_tempfile("md_test", self._sparse_size) -+ self.dev_file2 = create_sparse_tempfile("md_test", self._sparse_size) -+ self.dev_file3 = create_sparse_tempfile("md_test", self._sparse_size) - - try: - self.loop_dev = create_lio_device(self.dev_file) -@@ -586,6 +588,47 @@ class MDTestRequestSyncAction(MDTestCase): - action = f.read().strip() - self.assertEqual(action, "check") - -+ -+class MDTestDDFRAID(MDTestCase): -+ -+ _sparse_size = 50 * 1024**2 -+ -+ def _clean_up(self): -+ try: -+ BlockDev.md_deactivate("bd_test_ddf") -+ except: -+ pass -+ try: -+ BlockDev.md_deactivate(BlockDev.md_node_from_name("bd_test_ddf")) -+ except: -+ pass -+ -+ super(MDTestDDFRAID, self)._clean_up() -+ -+ def test_examine_ddf_container(self): -+ succ = BlockDev.md_create("bd_test_md", "container", -+ [self.loop_dev, self.loop_dev2], -+ 0, "ddf", False) -+ self.assertTrue(succ) -+ -+ # we cannot create the array with libblockdev because we cannot pass the --raid-devices option -+ ret, _out, err = run_command("mdadm --create /dev/md/bd_test_ddf --run --level=raid0 --raid-devices=2 /dev/md/bd_test_md") -+ self.assertEqual(ret, 0, msg="Failed to create RAID for DDF test: %s" % err) -+ -+ edata = BlockDev.md_examine(self.loop_dev) -+ self.assertIsNotNone(edata) -+ self.assertIsNotNone(edata.uuid) -+ self.assertEqual(edata.level, "container") -+ self.assertEqual(edata.metadata, "ddf") -+ -+ ddata = BlockDev.md_detail("bd_test_md") -+ self.assertIsNotNone(ddata) -+ self.assertIsNotNone(ddata.uuid) -+ self.assertEqual(ddata.uuid, edata.uuid) -+ self.assertEqual(ddata.level, "container") -+ self.assertEqual(ddata.metadata, "ddf") -+ -+ - class FakeMDADMutilTest(MDTest): - # no setUp nor tearDown needed, we are gonna use fake utils - @tag_test(TestTags.NOSTORAGE) --- -2.37.1 - diff --git a/SOURCES/0014-mdraid-Fix-copy-paste-error-when-checking-return-val.patch b/SOURCES/0014-mdraid-Fix-copy-paste-error-when-checking-return-val.patch deleted file mode 100644 index 5ff61dc..0000000 --- a/SOURCES/0014-mdraid-Fix-copy-paste-error-when-checking-return-val.patch +++ /dev/null @@ -1,53 +0,0 @@ -From 04a8baf87820d8a13926e0b8db5cfa55f9f04420 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 25 Sep 2020 14:26:57 +0200 -Subject: [PATCH 1/2] mdraid: Fix copy-paste error when checking return value - ---- - src/plugins/mdraid.c | 2 +- - 1 file changed, 1 insertion(+), 1 deletion(-) - -diff --git a/src/plugins/mdraid.c b/src/plugins/mdraid.c -index 67bdc1f9..48abb72f 100644 ---- a/src/plugins/mdraid.c -+++ b/src/plugins/mdraid.c -@@ -995,7 +995,7 @@ BDMDExamineData* bd_md_examine (const gchar *device, GError **error) { - orig_data = ret->dev_uuid; - if (orig_data) { - ret->dev_uuid = bd_md_canonicalize_uuid (orig_data, error); -- if (!ret->uuid) { -+ if (!ret->dev_uuid) { - g_prefix_error (error, "Failed to canonicalize MD UUID '%s': ", orig_data); - g_free (orig_data); - bd_md_examine_data_free (ret); --- -2.37.1 - - -From 16a34bc5ddb19bc6dd1a845d87e8b748cbaedd2c Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Fri, 25 Sep 2020 14:41:20 +0200 -Subject: [PATCH 2/2] mdraid: Fix use after free - -Another copy-paste error. ---- - src/plugins/mdraid.c | 3 +-- - 1 file changed, 1 insertion(+), 2 deletions(-) - -diff --git a/src/plugins/mdraid.c b/src/plugins/mdraid.c -index 48abb72f..75143ea7 100644 ---- a/src/plugins/mdraid.c -+++ b/src/plugins/mdraid.c -@@ -1028,8 +1028,7 @@ BDMDExamineData* bd_md_examine (const gchar *device, GError **error) { - value++; - ret->uuid = bd_md_canonicalize_uuid (value, error); - if (!ret->uuid) { -- g_prefix_error (error, "Failed to canonicalize MD UUID '%s': ", orig_data); -- g_free (orig_data); -+ g_prefix_error (error, "Failed to canonicalize MD UUID '%s': ", value); - bd_md_examine_data_free (ret); - g_strfreev (output_fields); - return NULL; --- -2.37.1 - diff --git a/SOURCES/0015-tests-Fix-expected-extended-partition-flags-with-new.patch b/SOURCES/0015-tests-Fix-expected-extended-partition-flags-with-new.patch deleted file mode 100644 index 6acdd26..0000000 --- a/SOURCES/0015-tests-Fix-expected-extended-partition-flags-with-new.patch +++ /dev/null @@ -1,45 +0,0 @@ -From 33b1cda56fdc76fdf96fe409f0308e1913965d16 Mon Sep 17 00:00:00 2001 -From: Vojtech Trefny -Date: Thu, 26 May 2022 12:44:47 +0200 -Subject: [PATCH] tests: Fix expected extended partition flags with new parted - -Latest libparted now creates all extended partitions as -PARTITION_EXT_LBA with the lba flag enabled by default. ---- - tests/part_test.py | 6 +++--- - 1 file changed, 3 insertions(+), 3 deletions(-) - -diff --git a/tests/part_test.py b/tests/part_test.py -index 7408b479..762dc534 100644 ---- a/tests/part_test.py -+++ b/tests/part_test.py -@@ -356,7 +356,7 @@ class PartCreatePartFullCase(PartTestCase): - # as is the start of the first part from the start of the disk - self.assertTrue(abs(ps4.start - (ps3.start + ps3.size + 1)) < ps.start) - self.assertEqual(ps4.size, 10 * 1024**2) -- self.assertEqual(ps4.flags, 0) # no flags (combination of bit flags) -+ self.assertIn(ps4.flags, [0, 128]) # no flags or extended+lba (combination of bit flags) - - # no more primary partitions allowed in the MSDOS table - with self.assertRaises(GLib.GError): -@@ -404,7 +404,7 @@ class PartCreatePartFullCase(PartTestCase): - # as is the start of the first part from the start of the disk - self.assertTrue(abs(ps3.start - (ps2.start + ps2.size + 1)) < ps.start) - self.assertEqual(ps3.size, 30 * 1024**2) -- self.assertEqual(ps3.flags, 0) # no flags (combination of bit flags) -+ self.assertIn(ps3.flags, [0, 128]) # no flags or extended+lba (combination of bit flags) - - # the logical partition has number 5 even though the extended partition - # has number 3 -@@ -871,7 +871,7 @@ class PartGetPartByPos(PartTestCase): - # as is the start of the first part from the start of the disk - self.assertTrue(abs(ps3.start - (ps2.start + ps2.size + 1)) < ps.start) - self.assertEqual(ps3.size, 35 * 1024**2) -- self.assertEqual(ps3.flags, 0) # no flags (combination of bit flags) -+ self.assertIn(ps3.flags, [0, 128]) # no flags or extended+lba (combination of bit flags) - - # the logical partition has number 5 even though the extended partition - # has number 3 --- -2.37.1 - diff --git a/SPECS/libblockdev.spec b/SPECS/libblockdev.spec index 328f592..9d01c1e 100644 --- a/SPECS/libblockdev.spec +++ b/SPECS/libblockdev.spec @@ -20,6 +20,7 @@ %define with_escrow 1 %define with_dmraid 1 %define with_tools 1 +%define with_nvme 1 # python2 is not available on RHEL > 7 and not needed on Fedora > 29 %if 0%{?rhel} > 7 || 0%{?fedora} > 29 || %{with_python2} == 0 @@ -120,32 +121,25 @@ %if %{with_gi} != 1 %define gi_copts --disable-introspection %endif +%if %{with_nvme} != 1 +%define nvme_copts --without-nvme +%endif -%define configure_opts %{?python2_copts} %{?python3_copts} %{?bcache_copts} %{?lvm_dbus_copts} %{?btrfs_copts} %{?crypto_copts} %{?dm_copts} %{?loop_copts} %{?lvm_copts} %{?lvm_dbus_copts} %{?mdraid_copts} %{?mpath_copts} %{?swap_copts} %{?kbd_copts} %{?part_copts} %{?fs_copts} %{?nvdimm_copts} %{?vdo_copts} %{?tools_copts} %{?gi_copts} +%define configure_opts %{?python2_copts} %{?python3_copts} %{?bcache_copts} %{?lvm_dbus_copts} %{?btrfs_copts} %{?crypto_copts} %{?dm_copts} %{?loop_copts} %{?lvm_copts} %{?lvm_dbus_copts} %{?mdraid_copts} %{?mpath_copts} %{?swap_copts} %{?kbd_copts} %{?part_copts} %{?fs_copts} %{?nvdimm_copts} %{?nvme_copts} %{?vdo_copts} %{?tools_copts} %{?gi_copts} Name: libblockdev -Version: 2.25 -Release: 14%{?dist} +Version: 2.28 +Release: 4%{?dist} Summary: A library for low-level manipulation with block devices License: LGPLv2+ URL: https://github.com/storaged-project/libblockdev Source0: https://github.com/storaged-project/libblockdev/releases/download/%{version}-%{release}/%{name}-%{version}.tar.gz Patch0: libblockdev-gcc11.patch -Patch1: 0001-Fix-comparing-DM-RAID-member-devices-UUID.patch -Patch2: 0002-Fix-default-key-size-for-non-XTS-ciphers.patch -Patch3: 0003-Memory-leaks-fixes-backport.patch -Patch4: 0004-Adapt-to-dosfstools-4.2-changes.patch -Patch5: 0005-Add-workarounds-for-some-LVM-test-issues.patch -Patch6: 0006-Misc-test-fixes-backport.patch -Patch7: 0007-lvm-devices-file-support.patch -Patch8: 0008-lvm-Fix-reading-statistics-for-VDO-pools-with-VDO-8.patch -Patch9: 0009-vdo_stats-Default-to-100-savings-for-invalid-savings.patch -Patch10: 0010-Add-support-for-creating-and-activating-integrity-de.patch -Patch11: 0011-tests-Wait-for-raid-and-mirrored-LVs-to-be-synced-be.patch -Patch12: 0012-tests-Lower-expected-free-space-on-newly-created-Ext-filesystems.patch -Patch13: 0013-ddf-mdadm-uuid-parse-fix.patch -Patch14: 0014-mdraid-Fix-copy-paste-error-when-checking-return-val.patch -Patch15: 0015-tests-Fix-expected-extended-partition-flags-with-new.patch +Patch1: 0001-lvm-devices-file-support.patch +Patch2: 0002-Add-support-for-creating-and-activating-integrity-de.patch +Patch3: 0003-NVMe-plugin-backport.patch +Patch4: 0004-Fix-double-free-in-write_escrow_data_file.patch +Patch5: 0005-nvme-Fix-namespace-identifiers.patch BuildRequires: make BuildRequires: glib2-devel @@ -167,6 +161,8 @@ BuildRequires: gtk-doc BuildRequires: glib2-doc BuildRequires: autoconf-archive +Requires: %{name}-utils%{?_isa} = %{version}-%{release} + # Needed for the escrow tests in tests/crypto_test.py, but not used to build # BuildRequires: volume_key # BuildRequires: nss-tools @@ -188,6 +184,7 @@ no information about VGs when creating an LV). Summary: Development files for libblockdev Requires: %{name}%{?_isa} = %{version}-%{release} Requires: glib2-devel +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} %description devel This package contains header files and pkg-config files needed for development @@ -244,7 +241,7 @@ with the libblockdev-utils library. %package btrfs BuildRequires: libbytesize-devel Summary: The BTRFS plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} Requires: btrfs-progs %description btrfs @@ -255,7 +252,7 @@ providing the BTRFS-related functionality. Summary: Development files for the libblockdev-btrfs plugin/library Requires: %{name}-btrfs%{?_isa} = %{version}-%{release} Requires: glib2-devel -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} %description btrfs-devel This package contains header files and pkg-config files needed for development @@ -265,6 +262,7 @@ with the libblockdev-btrfs plugin/library. %if %{with_crypto} %package crypto +Requires: %{name}-utils%{?_isa} = %{version}-%{release} BuildRequires: cryptsetup-devel BuildRequires: libblkid-devel @@ -282,6 +280,7 @@ providing the functionality related to encrypted devices (LUKS). %package crypto-devel Summary: Development files for the libblockdev-crypto plugin/library Requires: %{name}-crypto%{?_isa} = %{version}-%{release} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} Requires: glib2-devel %description crypto-devel @@ -298,7 +297,7 @@ BuildRequires: dmraid-devel %endif BuildRequires: systemd-devel Summary: The Device Mapper plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} Requires: device-mapper %if %{with_dmraid} Requires: dmraid @@ -317,7 +316,7 @@ Requires: systemd-devel %if %{with_dmraid} Requires: dmraid-devel %endif -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} %description dm-devel This package contains header files and pkg-config files needed for development @@ -331,7 +330,7 @@ BuildRequires: parted-devel BuildRequires: libblkid-devel BuildRequires: libmount-devel Summary: The FS plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} %description fs The libblockdev library plugin (and in the same time a standalone library) @@ -340,7 +339,7 @@ providing the functionality related to operations with file systems. %package fs-devel Summary: Development files for the libblockdev-fs plugin/library Requires: %{name}-fs%{?_isa} = %{version}-%{release} -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} Requires: glib2-devel Requires: xfsprogs Requires: dosfstools @@ -355,7 +354,7 @@ with the libblockdev-fs plugin/library. %package kbd BuildRequires: libbytesize-devel Summary: The KBD plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} %if %{with_bcache} Requires: bcache-tools >= 1.0.8 %endif @@ -368,7 +367,7 @@ Bcache). %package kbd-devel Summary: Development files for the libblockdev-kbd plugin/library Requires: %{name}-kbd%{?_isa} = %{version}-%{release} -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} Requires: glib2-devel %description kbd-devel @@ -380,7 +379,7 @@ with the libblockdev-kbd plugin/library. %if %{with_loop} %package loop Summary: The loop plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} %description loop The libblockdev library plugin (and in the same time a standalone library) @@ -389,7 +388,7 @@ providing the functionality related to loop devices. %package loop-devel Summary: Development files for the libblockdev-loop plugin/library Requires: %{name}-loop%{?_isa} = %{version}-%{release} -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} Requires: glib2-devel %description loop-devel @@ -402,10 +401,8 @@ with the libblockdev-loop plugin/library. %package lvm BuildRequires: device-mapper-devel Summary: The LVM plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} Requires: lvm2 -# for thin_metadata_size -Requires: device-mapper-persistent-data %description lvm The libblockdev library plugin (and in the same time a standalone library) @@ -426,10 +423,8 @@ with the libblockdev-lvm plugin/library. %package lvm-dbus BuildRequires: device-mapper-devel Summary: The LVM plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 1.4 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} Requires: lvm2-dbusd >= 2.02.156 -# for thin_metadata_size -Requires: device-mapper-persistent-data %description lvm-dbus The libblockdev library plugin (and in the same time a standalone library) @@ -451,7 +446,7 @@ with the libblockdev-lvm-dbus plugin/library. %package mdraid BuildRequires: libbytesize-devel Summary: The MD RAID plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} Requires: mdadm %description mdraid @@ -461,7 +456,7 @@ providing the functionality related to MD RAID. %package mdraid-devel Summary: Development files for the libblockdev-mdraid plugin/library Requires: %{name}-mdraid%{?_isa} = %{version}-%{release} -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} Requires: glib2-devel %description mdraid-devel @@ -474,8 +469,8 @@ with the libblockdev-mdraid plugin/library. %package mpath BuildRequires: device-mapper-devel Summary: The multipath plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 -Recommends: device-mapper-multipath +Requires: %{name}-utils%{?_isa} = %{version}-%{release} +Requires: device-mapper-multipath %description mpath The libblockdev library plugin (and in the same time a standalone library) @@ -484,7 +479,7 @@ providing the functionality related to multipath devices. %package mpath-devel Summary: Development files for the libblockdev-mpath plugin/library Requires: %{name}-mpath%{?_isa} = %{version}-%{release} -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} Requires: glib2-devel %description mpath-devel @@ -497,7 +492,7 @@ with the libblockdev-mpath plugin/library. BuildRequires: ndctl-devel BuildRequires: libuuid-devel Summary: The NVDIMM plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} Requires: ndctl %description nvdimm @@ -507,7 +502,7 @@ providing the functionality related to operations with NVDIMM devices. %package nvdimm-devel Summary: Development files for the libblockdev-nvdimm plugin/library Requires: %{name}-nvdimm%{?_isa} = %{version}-%{release} -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} Requires: glib2-devel %description nvdimm-devel @@ -516,11 +511,34 @@ with the libblockdev-nvdimm plugin/library. %endif +%if %{with_nvme} +%package nvme +BuildRequires: libnvme-devel +BuildRequires: libuuid-devel +Summary: The NVMe plugin for the libblockdev library +Requires: %{name}-utils%{?_isa} = %{version}-%{release} + +%description nvme +The libblockdev library plugin (and in the same time a standalone library) +providing the functionality related to operations with NVMe devices. + +%package nvme-devel +Summary: Development files for the libblockdev-nvme plugin/library +Requires: %{name}-nvme%{?_isa} = %{version}-%{release} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} +Requires: glib2-devel + +%description nvme-devel +This package contains header files and pkg-config files needed for development +with the libblockdev-nvme plugin/library. +%endif + + %if %{with_part} %package part BuildRequires: parted-devel Summary: The partitioning plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} Requires: gdisk Requires: util-linux @@ -531,7 +549,7 @@ providing the functionality related to partitioning. %package part-devel Summary: Development files for the libblockdev-part plugin/library Requires: %{name}-part%{?_isa} = %{version}-%{release} -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} Requires: glib2-devel %description part-devel @@ -544,7 +562,7 @@ with the libblockdev-part plugin/library. %package swap BuildRequires: libblkid-devel Summary: The swap plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} Requires: util-linux %description swap @@ -554,7 +572,7 @@ providing the functionality related to swap devices. %package swap-devel Summary: Development files for the libblockdev-swap plugin/library Requires: %{name}-swap%{?_isa} = %{version}-%{release} -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} Requires: glib2-devel %description swap-devel @@ -568,7 +586,7 @@ with the libblockdev-swap plugin/library. BuildRequires: libbytesize-devel BuildRequires: libyaml-devel Summary: The vdo plugin for the libblockdev library -Requires: %{name}-utils%{?_isa} >= 0.11 +Requires: %{name}-utils%{?_isa} = %{version}-%{release} # weak dependencies doesn't work on older RHEL %if (0%{?rhel} && 0%{?rhel} <= 7) @@ -588,7 +606,7 @@ providing the functionality related to VDO devices. %package vdo-devel Summary: Development files for the libblockdev-vdo plugin/library Requires: %{name}-vdo%{?_isa} = %{version}-%{release} -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} Requires: glib2-devel %description vdo-devel @@ -599,8 +617,8 @@ with the libblockdev-vdo plugin/library. %if %{with_tools} %package tools Summary: Various nice tools based on libblockdev -Requires: %{name} -Requires: %{name}-lvm +Requires: %{name} = %{version}-%{release} +Requires: %{name}-lvm = %{version}-%{release} BuildRequires: libbytesize-devel %if %{with_lvm_dbus} == 1 Recommends: %{name}-lvm-dbus @@ -615,6 +633,7 @@ Various nice storage-related tools based on libblockdev. %package s390 Summary: The s390 plugin for the libblockdev library Requires: s390utils +Requires: %{name}-utils%{?_isa} = %{version}-%{release} %description s390 The libblockdev library plugin (and in the same time a standalone library) @@ -623,7 +642,7 @@ providing the functionality related to s390 devices. %package s390-devel Summary: Development files for the libblockdev-s390 plugin/library Requires: %{name}-s390%{?_isa} = %{version}-%{release} -Requires: %{name}-utils-devel%{?_isa} +Requires: %{name}-utils-devel%{?_isa} = %{version}-%{release} Requires: glib2-devel %description s390-devel @@ -675,6 +694,10 @@ Requires: %{name}-mpath%{?_isa} = %{version}-%{release} Requires: %{name}-nvdimm%{?_isa} = %{version}-%{release} %endif +%if %{with_nvme} +Requires: %{name}-nvme%{?_isa} = %{version}-%{release} +%endif + %if %{with_part} Requires: %{name}-part%{?_isa} = %{version}-%{release} %endif @@ -703,16 +726,6 @@ A meta-package that pulls all the libblockdev plugins as dependencies. %patch3 -p1 %patch4 -p1 %patch5 -p1 -%patch6 -p1 -%patch7 -p1 -%patch8 -p1 -%patch9 -p1 -%patch10 -p1 -%patch11 -p1 -%patch12 -p1 -%patch13 -p1 -%patch14 -p1 -%patch15 -p1 %build autoreconf -ivf @@ -767,6 +780,10 @@ find %{buildroot} -type f -name "*.la" | xargs %{__rm} %ldconfig_scriptlets nvdimm %endif +%if %{with_nvme} +%ldconfig_scriptlets nvme +%endif + %if %{with_part} %ldconfig_scriptlets part %endif @@ -966,6 +983,17 @@ find %{buildroot} -type f -name "*.la" | xargs %{__rm} %endif +%if %{with_nvme} +%files nvme +%{_libdir}/libbd_nvme.so.* + +%files nvme-devel +%{_libdir}/libbd_nvme.so +%dir %{_includedir}/blockdev +%{_includedir}/blockdev/nvme.h +%endif + + %if %{with_part} %files part %{_libdir}/libbd_part.so.* @@ -1016,6 +1044,28 @@ find %{buildroot} -type f -name "*.la" | xargs %{__rm} %files plugins-all %changelog +* Thu Jan 05 2023 Vojtech Trefny - 2.28-4 +- nvme: Fix namespace identifiers + Resolves: rhbz#2151535 +- nvme: Avoid sending NVME_IDENTIFY_CNS_NS_DESC_LIST on older devices + Related: rhbz#2151535 + +* Mon Nov 28 2022 Vojtech Trefny - 2.28-3 +- Fix double free in write_escrow_data_file + Resolves: rhbz#2143226 + +* Thu Sep 22 2022 Vojtech Trefny - 2.28-2 +- NVMe plugin backport + Resolves: rhbz#2123338 + +* Wed Sep 14 2022 Vojtech Trefny - 2.28-1 +- Rebase to the latest upstream release 2.28 + Resolves: rhbz#2123346 +- Add dependency on device-mapper-multipath to libblockdev-mpath + Resolves: rhbz#2121072 +- Fix spec issues found by rpminspect + Resolves: rhbz#2116544 + * Mon Aug 08 2022 Vojtech Trefny - 2.25-14 - tests: Fix expected extended partition flags with new parted Related: rhbz#2109026