ID of the device path of the device size of the device size of the used space Creates a new copy of @info. %BDBtrfsDeviceInfo to copy Frees @info. %BDBtrfsDeviceInfo to free label of the filesystem uuid of the filesystem number of device in the filesystem size of the used space Creates a new copy of @info. %BDBtrfsFilesystemInfo to copy Frees @info. %BDBtrfsFilesystemInfo to free ID of the subvolume ID of the parent (sub)volume path of the subvolume Creates a new copy of @info. %BDBtrfsSubvolumeInfo to copy Frees @info. %BDBtrfsSubvolumeInfo to free used cipher (e.g. "aes") used cipher mode (e.g. "xts-plain") UUID of the BITLK device name of the underlying block device size (in bytes) of encryption sector Creates a new copy of @info. %BDCryptoBITLKInfo to copy Frees @info. %BDCryptoBITLKInfo to free integrity sector size size of journal in bytes journal flush watermark in percents; in bitmap mode sectors-per-bit journal commit time (or bitmap flush time) in ms number of interleave sectors (power of two) tag size per-sector in bytes number of sectors in one buffer a new Integrity extra argument integrity sector size, 0 for default (512) size of journal in bytes journal flush watermark in percents; in bitmap mode sectors-per-bit journal commit time (or bitmap flush time) in ms number of interleave sectors (power of two) tag size per-sector in bytes number of sectors in one buffer Creates a new copy of @extra. %BDCryptoIntegrityExtra to copy Frees @extra. %BDCryptoIntegrityExtra to free integrity algorithm integrity key size in bytes sector size in bytes tag size per-sector in bytes number of interleave sectors size of journal in bytes journal encryption algorithm journal integrity algorithm Creates a new copy of @info. %BDCryptoIntegrityInfo to copy Frees @info. %BDCryptoIntegrityInfo to free Returns (transfer full): new %BDCryptoKeyslotContext initialized by key file or %NULL in case of error Tech category: always available a key file for the new context number of bytes to read from @keyfile or 0 for unlimited number of bytes to skip at start of @keyfile Returns (transfer full): new %BDCryptoKeyslotContext initialized by @key_desc or %NULL in case of error Note: Keyslot passphrase must be stored in 'user' key type and the key has to be reachable by process context on behalf of which this function is called. Tech category: always available kernel keyring key description Returns (transfer full): new %BDCryptoKeyslotContext initialized by passphrase or %NULL in case of error Tech category: always available a passphrase for the new context (may contain arbitrary binary data) length of the @pass_data buffer Returns (transfer full): new %BDCryptoKeyslotContext initialized by volume key or %NULL in case of error Tech category: always available a volume key for the new context (may contain arbitrary binary data) length of the @volume_key_size buffer Creates a new copy of @context. %BDCryptoKeyslotContext to copy Frees @context. %BDCryptoKeyslotContext to free data alignment in sectors, 0 for default/auto detection detached encrypted data device or NULL integrity algorithm (e.g. "hmac-sha256") or NULL for no integrity support Note: this field is valid only for LUKS 2 encryption sector size, 0 for default (512) Note: this field is valid only for LUKS 2 LUKS header label or NULL Note: this field is valid only for LUKS 2 LUKS header subsystem or NULL Note: this field is valid only for LUKS 2 key derivation function specification or NULL for default Note: this field is valid only for LUKS 2 a new LUKS extra argument data alignment in sectors, 0 for default/auto detection detached encrypted data device or NULL integrity algorithm (e.g. "hmac-sha256") or NULL for no integrity support encryption sector size, 0 for default (512) LUKS header label or NULL LUKS header subsystem or NULL key derivation function specification or NULL for default Creates a new copy of @extra. %BDCryptoLUKSExtra to copy Frees @extra. %BDCryptoLUKSExtra to free LUKS version used cipher (e.g. "aes") used cipher mode (e.g. "xts-plain") UUID of the LUKS device name of the underlying block device size (in bytes) of encryption sector Note: sector size is valid only for LUKS 2 LUKS metadata size label of the LUKS device (valid only for LUKS 2) subsystem of the LUKS device (valid only for LUKS 2) Creates a new copy of @info. %BDCryptoLUKSInfo to copy Frees @info. %BDCryptoLUKSInfo to free PBKDF algorithm hash for LUKS header or NULL requested memory cost (in KiB) or 0 for default (benchmark) requested iterations or 0 for default (benchmark) requested time cost or 0 for default (benchmark) requested parallel cost (threads) or 0 for default (benchmark) a new pbkdf argument PBKDF algorithm hash for LUKS header or NULL for default requested memory cost (in KiB) or 0 for default (benchmark) requested iterations or 0 for default (benchmark) requested time cost or 0 for default (benchmark) requested parallel cost (threads) or 0 for default (benchmark) Creates a new copy of @pbkdf. %BDCryptoLUKSPBKDF to copy Frees @pbkdf. %BDCryptoLUKSPBKDF to free ID of the token type of the token keyslot this token is assigned to or -1 for inactive/unassigned tokens Creates a new copy of @info. %BDCryptoLUKSTokenInfo to copy Frees @info. %BDCryptoLUKSTokenInfo to free See bd_extra_arg_new() for an example on how to construct the extra args. extra option (command line option for most functions that allow extra options to be passed, e.g. "-L" to call `mkfs.xfs -L`) value for @opt, can be an empty string or %NULL for options without parameter Example of calling bd_fs_xfs_mkfs() with an extra argument. This will result in calling `mkfs.xfs` with `-L label`. |[<!-- language="C" --> BDExtraArg label_arg = {"-L", "label"}; const BDExtraArg *extra_args[2] = {&label_arg, NULL}; ret = bd_fs_xfs_mkfs ("/dev/sda", extra_args, error); ]| a new extra argument extra option value for the extra option @opt Creates a new copy of @arg. %BDExtraArg to copy Frees @arg. %BDExtraArg to free Frees @args and all its elements. A list of %BDExtraArg to free label of the filesystem uuid of the filesystem size of the filesystem in bytes free space on the filesystem in bytes Creates a new copy of @data. %BDFSBtrfsInfo to copy Frees @data. %BDFSBtrfsInfo to free label of the filesystem uuid of the filesystem sector size used by the filesystem number of sectors in the filesystem number of clusters in the filesystem Creates a new copy of @data. %BDFSExfatInfo to copy Frees @data. %BDFSExfatInfo to free label of the filesystem uuid of the filesystem state of the filesystem (e.g. "clean") block size used by the filesystem number of blocks in the filesystem number of free blocks in the filesystem Creates a new copy of @data. %BDFSExt2Info to copy label of the filesystem uuid of the filesystem state of the filesystem (e.g. "clean") block size used by the filesystem number of blocks in the filesystem number of free blocks in the filesystem Creates a new copy of @data. %BDFSExt3Info to copy Frees @data. %BDFSExt3Info to free label of the filesystem uuid of the filesystem state of the filesystem (e.g. "clean") block size used by the filesystem number of blocks in the filesystem number of free blocks in the filesystem Creates a new copy of @data. %BDFSExt4Info to copy Frees @data. %BDFSExt4Info to free label of the filesystem uuid of the filesystem state of the filesystem (e.g. "clean") block size used by the filesystem number of blocks in the filesystem number of free blocks in the filesystem label of the filesystem uuid of the filesystem sector size used by the filesystem number of sectors in the filesystem features enabled for this filesystem, see #BDFSF2FSFeature Creates a new copy of @data. %BDFSF2FSInfo to copy Frees @data. %BDFSF2FSInfo to free supported resizes modes supported options for mkfs support for fsck operations (check and repair) support for changing properties of an existing filesystem other supported features partition ID used for this filesystem on MSDOS partitions partition type/GUID used for this filesystem GPT partitions Creates a new copy of @data. %BDFSFeatures to copy Frees @data. %BDFSFeatures to free label of the filesystem uuid of the filesystem whether to run mkfs in dry run mode (no changes written to the device) whether to avoid discarding blocks at mkfs time whether to run mkfs with the `--force` (or similar) option, the behaviour of this option depends on the filesystem, but in general it allows overwriting other preexisting formats detected on the device whether to disable (protective) partition table creation during mkfs reserve for future expansion Creates a new copy of @data. %BDFSMkfsOptions to copy Frees @data. %BDFSMkfsOptions to free Flags indicating mkfs options are available for given filesystem type. label of the filesystem uuid of the filesystem size of the filesystem block size used by the filesystem number of free blocks in the filesystem Creates a new copy of @data. %BDFSNILFS2Info to copy Frees @data. %BDFSNILFS2Info to free label of the filesystem uuid of the filesystem size of the filesystem in bytes number of free space in the filesystem in bytes Creates a new copy of @data. %BDFSNtfsInfo to copy Frees @data. %BDFSNtfsInfo to free Flags indicating whether a filesystem resize action supports growing and/or shrinking if mounted or unmounted. label of the filesystem uuid of the filesystem UDF revision Logical Volume Identifier (most UDF implementations use this identifier as a disk label) Volume Identifier block size used by the filesystem number of blocks in the filesystem number of free blocks in the filesystem Creates a new copy of @data. %BDFSUdfInfo to copy Frees @data. %BDFSUdfInfo to free label of the filesystem uuid of the filesystem cluster size used by the filesystem number of clusters in the filesystem number of free clusters in the filesystem Creates a new copy of @data. %BDFSVfatInfo to copy Frees @data. %BDFSVfatInfo to free label of the filesystem uuid of the filesystem block size used by the filesystem number of blocks in the filesystem Creates a new copy of @data. %BDFSXfsInfo to copy Frees @data. %BDFSXfsInfo to free block size used by the cache size of the cache size of the used space in the cache block size used for cache metadata size of the metadata space of the cache size of the used metadata space in the cache number of read hits number of read misses number of write hits number of write misses mode the cache is operating in Creates a new copy of @data. %BDLVMCacheStats to copy Frees @data. %BDLVMCacheStats to free The @segs, @data_lvs, and @metadata_lvs fields are only filled by a call to bd_lvm_lvinfo_tree or bd_lvm_lvs_tree. They are all NULL normally. If they are filled, they follow these rules: A LV is either stored directly on physical volumes, or is made up of sub-LVs. If it is stored on PVs, the @segs list is non-empty and the @data_lvs and @metadata_lvs fields are both NULL. If it is made up of sub-LVs, then @segs is NULL, @data_lvs is non-empty and @metadata_lvs might or might not be empty but is non-NULL. The sub-LVs contained in @data_lv and @metadata_lv are always included in @data_lvs and @metadata_lvs, respectively. For a partial LV, the @segs list might not be complete; i.e., the sum of the sizes of the listed segments might not be equal to the size reported for the LV itself. Also, the order of entries in @segs must be assumed to be random; it does not correspond to the order of segments in the logical volume itself. name of the LV name of the VG the LV belongs to UUID of the LV size of the LV attributes of the LV segment type of the LV origin of the LV (for snapshots, etc.) pool LV of the LV (for thin and cached LVs) data LV of the LV (for thin and cache pools) metadata LV of the LV (for thin and cache pools) comma separated list of this LV's roles source physical volume of a temporary logical volume created with the pvmove command available data space in a thin pool available metadata space in a thin pool synchronization percentage of a mirrored logical volume list of LVM tags for this LV list of data sub-LVs this LV (for raids, etc). list of metadata sub-LVS for this LV (for raids, etc). The segments of this LV. Creates a new copy of @data. %BDLVMLVdata to copy Frees @data. %BDLVMLVdata to free name of the PV UUID of the PV size of the free space in the PV size of the PV start of the physical extents area (i.e. offset of the first PE) name of the VG the PV belongs to UUID of the VG the PV belongs to size of the VG the PV belongs to size of the free space in the PV's VG extent size used by the PV's VG number of extents in the PV's VG number of free extents in the PV's VG number of PVs that belong to this PV's VG list of LVM tags for this PV whether this PV is missing from the system or not Creates a new copy of @data. %BDLVMPVdata to copy Frees @data. %BDLVMPVdata to free Size of this segment in extents Where it starts in the physical volume in extents Device name of the physical volume or NULL Creates a new copy of @data. %BDLVMSEGdata to copy Frees @data. %BDLVMSEGdata to free operating mode of the VDO pool (e.g. %BD_LVM_VDO_MODE_NORMAL) state of the compression state of the VDO index write policy of the VDO LV currently used space percentage of physical blocks saved index memory size of the VDO volume whether deduplication is enabled whether compression is enabled Creates a new copy of @data. %BDLVMVDOPooldata to copy Frees @data. %BDLVMVDOPooldata to free The block size of a VDO volume, in bytes. The logical block size, in bytes. The total number of physical blocks allocated for a VDO volume. The number of physical blocks currently in use by a VDO volume to store data. The number of physical blocks currently in use by a VDO volume to store VDO metadata. The number of logical blocks currently mapped. The percentage of physical blocks used on a VDO volume (= used blocks / allocated blocks * 100). The percentage of physical blocks saved on a VDO volume (= [logical blocks used - physical blocks used] / logical blocks used). The average number of block writes to the underlying storage per block written to the VDO device. Creates a new copy of @stats. %BDLVMVDOStats to copy Frees @stats. %BDLVMVDOStats to free name of the VG UUID of the VG size of the VG size of the free space in the VG extent size used by the VG number of extents in the VG number of free extents in the VG number of PVs that belong to the VG whether the VG is exported or not list of LVM tags for this VG Creates a new copy of @data. %BDLVMVGdata to copy Frees @data. %BDLVMVGdata to free backing file for the give loop device; offset of the start of the device (in @backing_file); whether the autoclear flag is set or not; whether direct IO is enabled or not; whether the partition scan is enforced or not; whether the device is read-only or not; Creates a new copy of @info. %BDLoopInfo to copy Frees @info. %BDLoopInfo to free path of the device version of the metadata used by the device creation time level of the MD RAID name of the MD device size of the MD array size of the used space number of devices in the MD array total number of devices in the MD array number of active devices in the MD array number of working devices in the MD array number of failed devices in the MD array number of spare devices in the MD array whether the MD array is clean or not uuid of the MD array path of the MD container this device belongs to Creates a new copy of @data. %BDMDDetailData to copy Frees @data. %BDMDDetailData to free path of the MD device RAID level of the device number of devices used by the MD device name of the MD device size of the MD device array UUID update time of the MD device UUID of the member device number of events on the MD device version of the metadata used by the MD device chunk size used by the MD device Creates a new copy of @data. %BDMDExamineData to copy Frees @data. %BDMDExamineData to free namespace device name ("namespaceX.Y") mode of the namespace (BDNVDIMMNamespaceMode) size of the namespace UUID of the namespace sector size of the namespace (0 for non-sector namespaces) name of the block device for the namespace whether the namespace is enabled or not Creates a new copy of @info. %BDNVDIMMNamespaceInfo to copy Frees @info. %BDNVDIMMNamespaceInfo to free The PCI Vendor ID. The PCI Subsystem Vendor ID. Controller ID, the NVM subsystem unique controller identifier associated with the controller. FRU GUID, a 128-bit value that is globally unique for a given Field Replaceable Unit. The model number. The serial number. The currently active firmware revision. The NVM Express base specification that the controller implementation supports or %NULL when not reported by the device. features and capabilities present for this controller, see #BDNVMEControllerFeature. The controller type. 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. Host Memory Buffer Preferred Size indicates the preferred size that the host is requested to allocate for the Host Memory Buffer feature in bytes. Host Memory Buffer Minimum Size indicates the minimum size that the host is requested to allocate for the Host Memory Buffer feature in bytes. Total NVM Capacity in the NVM subsystem in bytes. Unallocated NVM Capacity in the NVM subsystem in bytes. Maximum Number of Allowed Namespaces supported by the NVM subsystem. NVM Subsystem NVMe Qualified Name, UTF-8 null terminated string. Creates a new copy of @info. %BDNVMEControllerInfo to copy Frees @info. %BDNVMEControllerInfo to free internal error counter, a unique identifier for the error. 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 Information specific to @command_id. the Status code for the command that completed. translated command error in the BD_NVME_ERROR domain or %NULL in case @command_status indicates success. the first LBA that experienced the error condition. the NSID of the namespace that the error is associated with. type of the transport associated with the error. Creates a new copy of @entry. %BDNVMEErrorLogEntry to copy Frees @entry. %BDNVMEErrorLogEntry to free Namespace LBA Format Data Structure. LBA data size (i.e. a sector size) in bytes. metadata size in bytes or `0` in case of no metadata support. Relative Performance index, see #BDNVMELBAFormatRelativePerformance. Creates a new copy of @fmt. %BDNVMELBAFormat to copy Frees @fmt. %BDNVMELBAFormat to free The Namespace Identifier (NSID). 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. Namespace 128-bit Universally Unique Identifier (UUID) as specified in RFC 4122. 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. 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). 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). 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 and capabilities present for this namespace, see #BDNVMENamespaceFeature. The percentage value remaining of a format operation in progress. %TRUE if the namespace is currently write protected and all write access to the namespace shall fail. A list of supported LBA Formats. A LBA Format currently used for the namespace. Contains zeroes in case of an invalid or no supported LBA Format reported. Creates a new copy of @info. %BDNVMENamespaceInfo to copy Frees @info. %BDNVMENamespaceInfo to free The percentage complete of the sanitize operation. The status of the most recent sanitize operation. 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. Number of completed passes if the most recent sanitize operation was an 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. 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. 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. 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. 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. 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. Creates a new copy of @log. %BDNVMESanitizeLog to copy Frees @log. %BDNVMESanitizeLog to free Current running device self-test operation. There's no corresponding record in @entries for a device self-test operation that is in progress. Percentage of the currently running device self-test operation. Only valid when @current_operation is other than #BD_NVME_SELF_TEST_ACTION_NOT_RUNNING. Self-test log entries for the last 20 operations, sorted from newest (first element) to oldest. Creates a new copy of @log. %BDNVMESelfTestLog to copy Frees @log. %BDNVMESelfTestLog to free Result of the device self-test operation. The Self-test Code value (action) that was specified in the Device Self-test command that started this device self-test operation. Segment number where the first self-test failure occurred. Valid only when @result is set to #BD_NVME_SELF_TEST_RESULT_KNOWN_SEG_FAIL. 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. Namespace ID that the Failing LBA occurred on. 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. Translated NVMe Command Status Code representing additional information related to errors or conditions. Creates a new copy of @entry. %BDNVMESelfTestLogEntry to copy Frees @entry. %BDNVMESelfTestLogEntry to free critical warnings for the state of the controller, see #BDNVMESmartCriticalWarning. Available Spare: a normalized percentage (0% to 100%) of the remaining spare capacity available. Available Spare Threshold: a normalized percentage (0% to 100%) of the available spare threshold. 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. 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. 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. Amount of time the controller is busy with I/O commands, reported in minutes. The number of power cycles. The number of power-on hours, excluding a non-operational power state. The number of unsafe shutdowns as a result of a Shutdown Notification not received prior to loss of power. 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). Number of Error Information Log Entries: the number of Error Information log entries over the life of the controller. Composite Temperature: temperature in Kelvins that represents the current composite temperature of the controller and associated namespaces or 0 when not applicable. 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. 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. 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 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 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). Creates a new copy of @log. %BDNVMESmartLog to copy Frees @log. %BDNVMESmartLog to free path of the disk (block device) type of the disk's partition table size of the disk disk's sector size path of the partition (block device) name of the partition (for GPT partitions) UUID of the partition (for GPT partitions) id of the partition (for MSDOS partitions) GUID of the partition's type (GPT) bit combination of partition's types (#BDPartType) start of the partition size of the partition whether the bootable flag is set or not (for MSDOS partitions) partition GPT attributes %BDPlugin name, e.g. %BD_PLUGIN_LVM SO name of the plugin to load or %NULL for default a new plugin spec %BDPlugin name, e.g. %BD_PLUGIN_LVM SO name of the plugin to load or %NULL for default Creates a new copy of @spec. %BDPluginSpec to copy Frees @spec. %BDPluginSpec to free Function type for logging function used by the libblockdev's exec utils to log the information about program executing. log level (as understood by syslog(3)) log message Callback function used to process a line captured from spawned command's standard output and standard error output. Typically used to extract completion percentage of a long-running job. Note that both outputs are read simultaneously with no guarantees of message order this function is called with. The value the @completion points to may contain value previously returned from this callback or zero when called for the first time. This is useful for extractors where only some kind of a tick mark is printed out as a progress and previous value is needed to compute an incremented value. It's important to keep in mind that this function is only called over lines, i.e. progress reporting printing out tick marks (e.g. dots) without a newline character might not work properly. The @line string usually contains trailing newline character, which may be absent however in case the spawned command exits without printing one. It's guaranteed this function is called over remaining buffer no matter what the trailing character is. whether the line was a progress reporting line and should be excluded from the collected standard output string or not. line to extract progress from percentage of completion ID of the task/action the progress is reported for progress status percentage of completion arbitrary progress message (for the user) whether the @device was successfully added to the @mountpoint btrfs volume or not Tech category: %BD_BTRFS_TECH_MULTI_DEV-%BD_BTRFS_TECH_MODE_MODIFY mountpoint of the btrfs volume to add new device to a device to add to the btrfs volume extra options for the addition (right now passed to the 'btrfs' utility) whether the label of the @mountpoint filesystem was successfully set to @label or not Tech category: %BD_BTRFS_TECH_FS-%BD_BTRFS_TECH_MODE_MODIFY a mountpoint of the btrfs filesystem to change label of new label for the filesystem whether the filesystem was successfully checked or not Tech category: %BD_BTRFS_TECH_FS-%BD_BTRFS_TECH_MODE_QUERY a device that is part of the checked btrfs volume extra options for the check (right now passed to the 'btrfs' utility) whether the @dest snapshot of @source was successfully created or not Tech category: %BD_BTRFS_TECH_SNAPSHOT-%BD_BTRFS_TECH_MODE_CREATE path to source subvolume path to new snapshot volume whether the snapshot should be read-only extra options for the snapshot creation (right now passed to the 'btrfs' utility) whether the @mountpoint/@name subvolume was successfully created or not Tech category: %BD_BTRFS_TECH_SUBVOL-%BD_BTRFS_TECH_MODE_CREATE mountpoint of the btrfs volume to create subvolume under name of the subvolume extra options for the subvolume creation (right now passed to the 'btrfs' utility) whether the new btrfs volume was created from @devices or not See mkfs.btrfs(8) for details about @data_level, @md_level and btrfs in general. Tech category: %BD_BTRFS_TECH_MULTI_DEV-%BD_BTRFS_TECH_MODE_CREATE list of devices to create btrfs volume from label for the volume RAID level for the data or %NULL to use the default RAID level for the metadata or %NULL to use the default extra options for the volume creation (right now passed to the 'mkfs.btrfs' utility) whether the @mountpoint/@name subvolume was successfully deleted or not Tech category: %BD_BTRFS_TECH_SUBVOL-%BD_BTRFS_TECH_MODE_DELETE mountpoint of the btrfs volume to delete subvolume from name of the subvolume extra options for the subvolume deletion (right now passed to the 'btrfs' utility) information about the @device's volume's filesystem or %NULL in case of error Tech category: %BD_BTRFS_TECH_FS-%BD_BTRFS_TECH_MODE_QUERY a device that is part of the queried btrfs volume ID of the @mountpoint volume's default subvolume. If 0, @error may be set to indicate error Tech category: %BD_BTRFS_TECH_SUBVOL-%BD_BTRFS_TECH_MODE_QUERY mountpoint of the volume to get the default subvolume ID of whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation (#BDBtrfsTechMode) for @tech information about the devices that are part of the btrfs volume containing @device or %NULL in case of error Tech category: %BD_BTRFS_TECH_MULTI_DEV-%BD_BTRFS_TECH_MODE_QUERY a device that is part of the queried btrfs volume information about the subvolumes that are part of the btrfs volume mounted at @mountpoint or %NULL in case of error The subvolumes are sorted in a way that no child subvolume appears in the list before its parent (sub)volume. Tech category: %BD_BTRFS_TECH_SUBVOL-%BD_BTRFS_TECH_MODE_QUERY a mountpoint of the queried btrfs volume whether to list only snapshot subvolumes or not whether the new btrfs volume was created from @devices or not See mkfs.btrfs(8) for details about @data_level, @md_level and btrfs in general. Tech category: %BD_BTRFS_TECH_FS-%BD_BTRFS_TECH_MODE_CREATE list of devices to create btrfs volume from label for the volume RAID level for the data or %NULL to use the default RAID level for the metadata or %NULL to use the default extra options for the volume creation (right now passed to the 'btrfs' utility) whether the @device was successfully removed from the @mountpoint btrfs volume or not Tech category: %BD_BTRFS_TECH_MULTI_DEV-%BD_BTRFS_TECH_MODE_MODIFY mountpoint of the btrfs volume to remove device from a device to remove from the btrfs volume extra options for the removal (right now passed to the 'btrfs' utility) whether the filesystem was successfully checked and repaired or not Tech category: %BD_BTRFS_TECH_FS-%BD_BTRFS_TECH_MODE_MODIFY a device that is part of the to be repaired btrfs volume extra options for the repair (right now passed to the 'btrfs' utility) whether the @mountpoint filesystem was successfully resized to @size or not Tech category: %BD_BTRFS_TECH_FS-%BD_BTRFS_TECH_MODE_MODIFY a mountpoint of the to be resized btrfs filesystem requested new size extra options for the volume resize (right now passed to the 'btrfs' utility) whether the @mountpoint volume's default subvolume was correctly set to @subvol_id or not Tech category: %BD_BTRFS_TECH_SUBVOL-%BD_BTRFS_TECH_MODE_MODIFY mountpoint of the volume to set the default subvolume ID of ID of the subvolume to be set as the default subvolume extra options for the setting (right now passed to the 'btrfs' utility) whether the given @bitlk_device was successfully closed or not Tech category: %BD_CRYPTO_TECH_BITLK-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE BITLK device to close Returns (transfer full): information about the @device or %NULL in case of error Tech category: %BD_CRYPTO_TECH_BITLK-%BD_CRYPTO_TECH_MODE_QUERY a device to get information about Supported @context types for this function: passphrase, key file whether the @device was successfully opened or not Tech category: %BD_CRYPTO_TECH_BITLK-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE the device to open name for the BITLK device key slot context (passphrase/keyfile/token...) for this BITLK device whether to open as read-only or not (meaning read-write) %TRUE if the given @device is a LUKS device or %FALSE if not or failed to determine (the @error) is populated with the error in such cases) Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_QUERY the queried device Determines whether a block device seems to be encrypted. TCRYPT volumes are not easily identifiable, because they have no cleartext header, but are completely encrypted. This function is used to determine whether a block device is a candidate for being TCRYPT encrypted. To achieve this, we calculate the chi square value of the first 512 Bytes and treat devices with a chi square value between 136 and 426 as candidates for being encrypted. For the reasoning, see: https://tails.boum.org/blueprint/veracrypt/ %TRUE if the given @device seems to be encrypted or %FALSE if not or failed to determine (the @error) is populated with the error in such cases) Tech category: %BD_CRYPTO_TECH_TRUECRYPT-%BD_CRYPTO_TECH_MODE_QUERY the queried device whether the escrow data was successfully created for @device or not Tech category: %BD_CRYPTO_TECH_ESCROW-%BD_CRYPTO_TECH_MODE_CREATE path of the device to create escrow data for passphrase used for the device certificate data to use for escrow directory to put escrow data into backup passphrase for the device or %NULL whether the given @fvault2_device was successfully closed or not Tech category: %BD_CRYPTO_TECH_FVAULT2-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE FVAULT2 device to close Supported @context types for this function: passphrase, key file whether the @device was successfully opened or not Tech category: %BD_CRYPTO_TECH_FVAULT2-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE the device to open name for the FVAULT2 device key slot context (passphrase/keyfile/token...) for this FVAULT2 volume whether to open as read-only or not (meaning read-write) A newly generated %BD_CRYPTO_BACKUP_PASSPHRASE_LENGTH-long passphrase. See %BD_CRYPTO_BACKUP_PASSPHRASE_CHARSET for the definition of the charset used for the passphrase. Tech category: always available whether the given @integrity_device was successfully closed or not Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE integrity device to close Formats the given @device as integrity according to the other parameters given. Supported @context types for this function: volume key 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 a device to format as integrity integrity algorithm specification (e.g. "crc32c" or "sha256") whether to wipe the device after format; a device that is not initially wiped will contain invalid checksums key slot context (passphrase/keyfile/token...) for this device extra arguments for integrity format creation information about the @device or %NULL in case of error Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_QUERY a device to get information about Supported @context types for this function: volume key whether the @device was successfully opened or not Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE integrity device to open name for the opened @device integrity algorithm specification (e.g. "crc32c" or "sha256") key slot context (passphrase/keyfile/token...) for this device flags for the integrity device activation extra arguments for integrity open whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation (#BDCryptoTechMode) for @tech whether the given key was successfully saved to kernel keyring or not Tech category: %BD_CRYPTO_TECH_KEYRING-%BD_CRYPTO_TECH_MODE_ADD_KEY kernel keyring key description a key to add to kernel keyring (may contain arbitrary binary data) length of the @key_data buffer Supported @context types for this function: passphrase, key file whether the @ncontext was successfully added to @device or not Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_ADD_KEY device to add new key to key slot context (passphrase/keyfile/token...) to for this LUKS @device new key slot context (passphrase/keyfile/token...) to add to this LUKS @device Supported @context types for this function: passphrase, key file whether the key was successfully changed or not Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_ADD_KEY&%BD_CRYPTO_TECH_MODE_REMOVE_KEY device to change key of key slot context (passphrase/keyfile/token...) for this LUKS @device new key slot context (passphrase/keyfile/token...) to add to this LUKS @device whether the given @luks_device was successfully closed or not Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE LUKS device to close Formats the given @device as LUKS according to the other parameters given. If @min_entropy is specified (greater than 0), the function waits for enough entropy to be available in the random data pool (WHICH MAY POTENTIALLY TAKE FOREVER). Supported @context types for this function: passphrase, key file whether the given @device was successfully formatted as LUKS or not (the @error) contains the error in such cases) Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_CREATE a device to format as LUKS cipher specification (type-mode, e.g. "aes-xts-plain64") or %NULL to use the default size of the volume key in bits or 0 to use the default key slot context (passphrase/keyfile/token...) for this LUKS device minimum random data entropy (in bits) required to format @device as LUKS whether to use LUKS v1 or LUKS v2 extra arguments for LUKS format creation whether the given backup of @device was successfully written to @backup_file or not Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_BACKUP_RESTORE device to backup the LUKS header file to save the header backup to whether the given @device LUKS header was successfully restored from @backup_file Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_BACKUP_RESTORE device to restore the LUKS header to existing file with a LUKS header backup information about the @device or %NULL in case of error Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_QUERY a device to get information about Note: This can destroy last remaining keyslot without confirmation making the LUKS device permanently inaccessible. whether the given @slot was successfully destroyed or not Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_REMOVE_KEY device to kill slot on keyslot to destroy Supported @context types for this function: passphrase, key file, keyring whether the @device was successfully opened or not Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE Example of using %bd_crypto_luks_open with %BDCryptoKeyslotContext: |[<!-- language="C" --> BDCryptoKeyslotContext *context = NULL; context = bd_crypto_keyslot_context_new_passphrase ("passphrase", 10, NULL); bd_crypto_luks_open ("/dev/vda1", "luks-device", context, FALSE, NULL); ]| the device to open name for the LUKS device key slot context (passphrase/keyfile/token...) to open this LUKS @device whether to open as read-only or not (meaning read-write) Supported @context types for this function: passphrase, key file whether the key was successfully removed or not Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_REMOVE_KEY device to add new key to key slot context (passphrase/keyfile/token...) to remove from this LUKS @device Supported @context types for this function: passphrase, key file whether the @luks_device was successfully resized or not You need to specify either @context for LUKS 2 devices that don't have verified key loaded in kernel. For LUKS 1 devices you can set @context %NULL. Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_RESIZE opened LUKS device to resize requested size in sectors or 0 to adapt to the backing device key slot context (passphrase/keyfile/token...) for this LUKS @device Supported @context types for this function: passphrase, key file whether the given @luks_device was successfully resumed or not Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_SUSPEND_RESUME LUKS device to resume key slot context (passphrase/keyfile/token...) for @luks_device whether the given @label and @subsystem were successfully set or not Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_MODIFY device to set label on label to set subsystem to set whether the given @uuid was successfully set or not Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_MODIFY device to set UUID on UUID to set or %NULL to generate a new one one of "invalid", "inactive", "active" or "busy" or %NULL if failed to determine (@error is populated with the error in such cases) Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_QUERY the queried LUKS device whether the given @luks_device was successfully suspended or not Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_SUSPEND_RESUME LUKS device to suspend information about tokens on @device Tech category: %BD_CRYPTO_TECH_LUKS-%BD_CRYPTO_TECH_MODE_QUERY a device to get LUKS2 token information about whether the given @tc_device was successfully closed or not Tech category: %BD_CRYPTO_TECH_TRUECRYPT-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE TrueCrypt/VeraCrypt device to close Supported @context types for this function: passphrase whether the @device was successfully opened or not Tech category: %BD_CRYPTO_TECH_TRUECRYPT-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE the device to open name for the TrueCrypt/VeraCrypt device passphrase key slot context for this TrueCrypt/VeraCrypt volume paths to the keyfiles for the TrueCrypt/VeraCrypt volume whether a hidden volume inside the volume should be opened whether to try opening as an encrypted system (with boot loader) whether to try VeraCrypt modes (TrueCrypt modes are tried anyway) VeraCrypt PIM value (only used if @veracrypt is %TRUE) whether to open as read-only or not (meaning read-write) whether the new linear mapping @map_name was successfully created for the @device or not Tech category: %BD_DM_TECH_MAP-%BD_DM_TECH_MODE_CREATE_ACTIVATE name of the map device to create map for length of the mapping in sectors UUID for the new dev mapper device or %NULL if not specified subsystem of the given device Tech category: %BD_DM_TECH_MAP-%BD_DM_TECH_MODE_QUERY name of the device whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation (#BDDMTechMode) for @tech whether the given @map_name exists (and is live if @live_only is %TRUE (and is active if @active_only is %TRUE)). Tech category: %BD_DM_TECH_MAP-%BD_DM_TECH_MODE_QUERY name of the queried map whether to go through the live maps only or not whether to ignore suspended maps or not map name of the map providing the @dm_node device or %NULL (@error) contains the error in such cases Tech category: %BD_DM_TECH_MAP-%BD_DM_TECH_MODE_QUERY name of the DM node (e.g. "dm-0") DM node name for the @map_name map or %NULL (@error) contains the error in such cases Tech category: %BD_DM_TECH_MAP-%BD_DM_TECH_MODE_QUERY name of the queried DM map whether the @map_name map was successfully removed or not Tech category: %BD_DM_TECH_MAP-%BD_DM_TECH_MODE_REMOVE_DEACTIVATE name of the map to remove Checks the state of the library and if it is uninitialized or not all the @require_plugins plugins are available, tries to (re)initialize it. Otherwise just returns early. The difference between: |[<!-- language="C" --> if (!bd_is_initialized()) bd_init(None, None, &error); ]| and this function is that this function does the check and init in an atomic way (holding the lock preventing other threads from doing changes in between). whether the library was successfully initialized with all the required or default (see @require_plugins) plugins or not either before or by this call %NULL-terminated list of plugins that should be loaded (if no so_name is specified for the plugin, the default is used) or %NULL to load all plugins logging function to use Frees @args and all its elements. A list of %BDExtraArg to free whether the filesystem was successfully checked or not Tech category: %BD_FS_TECH_BTRFS-%BD_FS_TECH_MODE_CHECK the device containing the file system to check extra options for the check (right now passed to the 'btrfsck' utility) whether @label is a valid label for the Btrfs file system or not (reason is provided in @error) Note: This function is intended to be used for btrfs filesystem on a single device, for more complicated setups use the btrfs plugin instead. Tech category: always available label to check whether @uuid is a valid UUID for the Btrfs file system or not (reason is provided in @error) Note: This function is intended to be used for btrfs filesystem on a single device, for more complicated setups use the btrfs plugin instead. Tech category: always available UUID to check information about the file system on @device or %NULL in case of error Note: This function WON'T WORK for multi device btrfs filesystems, for more complicated setups use the btrfs plugin instead. Tech category: %BD_FS_TECH_BTRFS-%BD_FS_TECH_MODE_QUERY a mountpoint of the btrfs filesystem to get information about whether a new btrfs fs was successfully created on @device or not Tech category: %BD_FS_TECH_BTRFS-%BD_FS_TECH_MODE_MKFS the device to create a new btrfs fs on extra options for the creation (right now passed to the 'mkfs.btrfs' utility) whether the filesystem was successfully checked and repaired or not Tech category: %BD_FS_TECH_BTRFS-%BD_FS_TECH_MODE_REPAIR the device containing the file system to repair extra options for the repair (right now passed to the 'btrfs' utility) whether the @mpoint filesystem was successfully resized to @new_size or not Note: This function WON'T WORK for multi device btrfs filesystems, for more complicated setups use the btrfs plugin instead. Tech category: %BD_BTRFS_TECH_FS-%BD_BTRFS_TECH_MODE_MODIFY a mountpoint of the to be resized btrfs filesystem requested new size extra options for the volume resize (right now passed to the 'btrfs' utility) whether the label of Btrfs file system on the @mpoint was successfully set or not Note: This function is intended to be used for btrfs filesystem on a single device, for more complicated setups use the btrfs plugin instead. Tech category: %BD_FS_TECH_BTRFS-%BD_FS_TECH_MODE_SET_LABEL the mount point of the file system to set label for label to set whether the UUID of the Btrfs file system on the @device was successfully set or not Note: This function is intended to be used for btrfs filesystem on a single device, for more complicated setups use the btrfs plugin instead. Tech category: %BD_FS_TECH_BTRFS-%BD_FS_TECH_MODE_SET_UUID the device containing the file system to set the UUID (serial number) for UUID to set or %NULL to generate a new one Searches for the required utility to check the given filesystem and returns whether it is installed. Unknown filesystems or filesystems which do not support checking result in errors. whether filesystem check is available Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the filesystem type to be tested for installed consistency check support the utility binary which is required for checking (if missing i.e. returns FALSE but no error) Searches for the required utility to get free space of the given filesystem and returns whether it is installed. Unknown filesystems or filesystems which do not support free space querying result in errors. whether getting filesystem free space is available Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the filesystem type to be tested for installed free space querying support the utility binary which is required for free space querying (if missing i.e. return FALSE but no error) Searches for the required utility to get info of the given filesystem and returns whether it is installed. Unknown filesystems or filesystems which do not support info querying result in errors. whether getting filesystem info is available Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the filesystem type to be tested for info querying support the utility binary which is required for info querying (if missing i.e. return FALSE but no error) Searches for the required utility to get minimum size of the given filesystem and returns whether it is installed. Unknown filesystems or filesystems which do not support minimum size querying result in errors. whether getting filesystem size is available Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the filesystem type to be tested for installed minimum size querying support the utility binary which is required for size querying (if missing i.e. return FALSE but no error) Searches for the required utility to get size of the given filesystem and returns whether it is installed. Unknown filesystems or filesystems which do not support size querying result in errors. whether getting filesystem size is available Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the filesystem type to be tested for installed size querying support the utility binary which is required for size querying (if missing i.e. return FALSE but no error) Searches for the required utility to create the given filesystem and returns whether it is installed. The options flags indicate what additional options can be specified for @type. Unknown filesystems result in errors. whether filesystem mkfs tool is available Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the filesystem type to be tested for installed mkfs support flags for allowed mkfs options (i.e. support for setting label or UUID when creating the filesystem) the utility binary which is required for creating (if missing returns %FALSE but no @error) Searches for the required utility to repair the given filesystem and returns whether it is installed. Unknown filesystems or filesystems which do not support reparing result in errors. whether filesystem repair is available Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the filesystem type to be tested for installed repair support the utility binary which is required for repairing (if missing i.e. return FALSE but no error) Searches for the required utility to resize the given filesystem and returns whether it is installed. The mode flags indicate if growing and/or shrinking resize is available if mounted/unmounted. Unknown filesystems or filesystems which do not support resizing result in errors. whether filesystem resize is available Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the filesystem type to be tested for installed resize support flags for allowed resizing (i.e. growing/shrinking support for online/offline) the utility binary which is required for resizing (if missing i.e. returns FALSE but no error) Searches for the required utility to set the label of the given filesystem and returns whether it is installed. Unknown filesystems or filesystems which do not support setting the label result in errors. whether setting filesystem label is available Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the filesystem type to be tested for installed label support the utility binary which is required for relabeling (if missing i.e. return FALSE but no error) Searches for the required utility to set the UUID of the given filesystem and returns whether it is installed. Unknown filesystems or filesystems which do not support setting the UUID result in errors. whether setting filesystem UUID is available Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the filesystem type to be tested for installed UUID support the utility binary which is required for setting UUID (if missing i.e. return FALSE but no error) Check filesystem on @device avoiding any modifications or repairs. This calls other fs check functions from this plugin based on detected filesystem (e.g. bd_fs_xfs_check for XFS). This function will return an error for unknown/unsupported filesystems. Note that depending on a corresponding filesystem type and configured features running this function on a mounted filesystem may result in false errors reported. whether the file system on @device passed the consistency check or not Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_CHECK the device the file system of which to check the filesystem type on @device or %NULL to detect This calls other fs check label functions from this plugin based on the provided filesystem (e.g. bd_fs_xfs_check_label for XFS). This function will return an error for unknown/unsupported filesystems. whether @label is a valid label for the @fstype file system or not (reason is provided in @error) Tech category: always available the filesystem type to check @label for label to check This calls other fs check uuid functions from this plugin based on the provided filesystem (e.g. bd_fs_xfs_check_uuid for XFS). This function will return an error for unknown/unsupported filesystems. whether @uuid is a valid UUID for the @fstype file system or not (reason is provided in @error) Tech category: always available the filesystem type to check @uuid for uuid to check Clean all signatures from @device. Difference between this and bd_fs_wipe() is that this function doesn't return error if @device is already empty. This will also always remove all signatures from @device, not only the first one. whether @device was successfully cleaned or not Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_WIPE the device to clean whether to wipe signatures on a mounted @device whether the exfat file system on the @device is clean or not Tech category: %BD_FS_TECH_EXFAT-%BD_FS_TECH_MODE_CHECK the device containing the file system to check extra options for the repair (right now passed to the 'exfatfsck' utility) whether @label is a valid label for the exfat file system or not (reason is provided in @error) Tech category: always available label to check whether @uuid is a valid UUID for the exFAT file system or not (reason is provided in @error) Tech category: always available UUID to check information about the file system on @device or %NULL in case of error Tech category: %BD_FS_TECH_EXFAT-%BD_FS_TECH_MODE_QUERY the device containing the file system to get info for whether a new exfat fs was successfully created on @device or not Tech category: %BD_FS_TECH_EXFAT-%BD_FS_TECH_MODE_MKFS the device to create a new exfat fs on extra options for the creation (right now passed to the 'mkexfatfs' utility) whether the exfat file system on the @device was successfully repaired (if needed) or not (error is set in that case) Tech category: %BD_FS_TECH_EXFAT-%BD_FS_TECH_MODE_REPAIR the device containing the file system to repair extra options for the repair (right now passed to the 'exfatfsck' utility) whether the label of exfat file system on the @device was successfully set or not Tech category: %BD_FS_TECH_EXFAT-%BD_FS_TECH_MODE_SET_LABEL the device containing the file system to set label for label to set whether the volume ID of exFAT file system on the @device was successfully set or not Tech category: %BD_FS_TECH_EXFAT-%BD_FS_TECH_MODE_SET_UUID the device containing the file system to set uuid for volume ID to set or %NULL to generate a new one whether an ext2 file system on the @device is clean or not Tech category: %BD_FS_TECH_EXT2-%BD_FS_TECH_MODE_CHECK the device the file system on which to check extra options for the check (right now passed to the 'e2fsck' utility) whether @label is a valid label for the ext2 file system or not (reason is provided in @error) Tech category: always available label to check whether @uuid is a valid UUID for the ext2 file system or not (reason is provided in @error) Tech category: always available UUID to check information about the file system on @device or %NULL in case of error Tech category: %BD_FS_TECH_EXT2-%BD_FS_TECH_MODE_QUERY the device the file system of which to get info for smallest shrunken filesystem size as reported by ntfsresize in case of error 0 is returned and @error is set Tech category: %BD_FS_TECH_EXT2-%BD_FS_TECH_MODE_RESIZE the device containing the file system to get min size for whether a new ext2 fs was successfully created on @device or not Tech category: %BD_FS_TECH_EXT2-%BD_FS_TECH_MODE_MKFS the device to create a new ext2 fs on extra options for the creation (right now passed to the 'mke2fs' utility) whether an ext2 file system on the @device was successfully repaired (if needed) or not (error is set in that case) Tech category: %BD_FS_TECH_EXT2-%BD_FS_TECH_MODE_REPAIR the device the file system on which to repair whether to do unsafe operations too extra options for the repair (right now passed to the 'e2fsck' utility) whether the file system on @device was successfully resized or not Tech category: %BD_FS_TECH_EXT2-%BD_FS_TECH_MODE_RESIZE the device the file system of which to resize new requested size for the file system (if 0, the file system is adapted to the underlying block device) extra options for the resize (right now passed to the 'resize2fs' utility) whether the label of ext2 file system on the @device was successfully set or not Tech category: %BD_FS_TECH_EXT2-%BD_FS_TECH_MODE_SET_LABEL the device the file system on which to set label for label to set whether the UUID of ext2 file system on the @device was successfully set or not Tech category: %BD_FS_TECH_EXT2-%BD_FS_TECH_MODE_SET_UUID the device the file system on which to set UUID for UUID to set %NULL to generate a new one UUID can also be one of "clear", "random" and "time" to clear, generate a new random/time-based UUID whether an ext3 file system on the @device is clean or not Tech category: %BD_FS_TECH_EXT3-%BD_FS_TECH_MODE_CHECK the device the file system on which to check extra options for the check (right now passed to the 'e2fsck' utility) whether @label is a valid label for the ext3 file system or not (reason is provided in @error) Tech category: always available label to check whether @uuid is a valid UUID for the ext3 file system or not (reason is provided in @error) Tech category: always available UUID to check information about the file system on @device or %NULL in case of error Tech category: %BD_FS_TECH_EXT3-%BD_FS_TECH_MODE_QUERY the device the file system of which to get info for smallest shrunken filesystem size as reported by ntfsresize in case of error 0 is returned and @error is set Tech category: %BD_FS_TECH_EXT3-%BD_FS_TECH_MODE_RESIZE the device containing the file system to get min size for whether a new ext3 fs was successfully created on @device or not Tech category: %BD_FS_TECH_EXT3-%BD_FS_TECH_MODE_MKFS the device to create a new ext3 fs on extra options for the creation (right now passed to the 'mke2fs' utility) whether an ext3 file system on the @device was successfully repaired (if needed) or not (error is set in that case) Tech category: %BD_FS_TECH_EXT3-%BD_FS_TECH_MODE_REPAIR the device the file system on which to repair whether to do unsafe operations too extra options for the repair (right now passed to the 'e2fsck' utility) whether the file system on @device was successfully resized or not Tech category: %BD_FS_TECH_EXT3-%BD_FS_TECH_MODE_RESIZE the device the file system of which to resize new requested size for the file system (if 0, the file system is adapted to the underlying block device) extra options for the resize (right now passed to the 'resize2fs' utility) whether the label of ext3 file system on the @device was successfully set or not Tech category: %BD_FS_TECH_EXT3-%BD_FS_TECH_MODE_SET_LABEL the device the file system on which to set label for label to set whether the UUID of ext3 file system on the @device was successfully set or not Tech category: %BD_FS_TECH_EXT3-%BD_FS_TECH_MODE_SET_UUID the device the file system on which to set UUID for UUID to set %NULL to generate a new one UUID can also be one of "clear", "random" and "time" to clear, generate a new random/time-based UUID whether an ext4 file system on the @device is clean or not Tech category: %BD_FS_TECH_EXT4-%BD_FS_TECH_MODE_CHECK the device the file system on which to check extra options for the check (right now passed to the 'e2fsck' utility) whether @label is a valid label for the ext4 file system or not (reason is provided in @error) Tech category: always available label to check whether @uuid is a valid UUID for the ext4 file system or not (reason is provided in @error) Tech category: always available UUID to check information about the file system on @device or %NULL in case of error Tech category: %BD_FS_TECH_EXT3-%BD_FS_TECH_MODE_QUERY the device the file system of which to get info for smallest shrunken filesystem size as reported by ntfsresize in case of error 0 is returned and @error is set Tech category: %BD_FS_TECH_EXT4-%BD_FS_TECH_MODE_RESIZE the device containing the file system to get min size for whether a new ext4 fs was successfully created on @device or not Tech category: %BD_FS_TECH_EXT4-%BD_FS_TECH_MODE_MKFS the device to create a new ext4 fs on extra options for the creation (right now passed to the 'mkfs.ext4' utility) whether an ext4 file system on the @device was successfully repaired (if needed) or not (error is set in that case) Tech category: %BD_FS_TECH_EXT4-%BD_FS_TECH_MODE_REPAIR the device the file system on which to repair whether to do unsafe operations too extra options for the repair (right now passed to the 'e2fsck' utility) whether the file system on @device was successfully resized or not Tech category: %BD_FS_TECH_EXT4-%BD_FS_TECH_MODE_RESIZE the device the file system of which to resize new requested size for the file system (if 0, the file system is adapted to the underlying block device) extra options for the resize (right now passed to the 'resize2fs' utility) whether the label of ext4 file system on the @device was successfully set or not Tech category: %BD_FS_TECH_EXT3-%BD_FS_TECH_MODE_SET_LABEL the device the file system on which to set label for label to set whether the UUID of ext4 file system on the @device was successfully set or not Tech category: %BD_FS_TECH_EXT4-%BD_FS_TECH_MODE_SET_UUID the device the file system on which to set UUID for UUID to set %NULL to generate a new one UUID can also be one of "clear", "random" and "time" to clear, generate a new random/time-based UUID whether an f2fs file system on the @device is clean or not Tech category: %BD_FS_TECH_F2FS-%BD_FS_TECH_MODE_CHECK the device containing the file system to check extra options for the repair (right now passed to the 'fsck.f2fs' utility) whether @label is a valid label for the f2fs file system or not (reason is provided in @error) Tech category: always available label to check information about the file system on @device or %NULL in case of error Tech category: %BD_FS_TECH_F2FS-%BD_FS_TECH_MODE_QUERY the device containing the file system to get info for whether a new f2fs fs was successfully created on @device or not Tech category: %BD_FS_TECH_F2FS-%BD_FS_TECH_MODE_MKFS the device to create a new f2fs fs on extra options for the creation (right now passed to the 'mkfs.f2fs' utility) whether an f2fs file system on the @device was successfully repaired (if needed) or not (error is set in that case) Tech category: %BD_FS_TECH_F2FS-%BD_FS_TECH_MODE_REPAIR the device containing the file system to repair extra options for the repair (right now passed to the 'fsck.f2fs' utility) whether the file system on @device was successfully resized or not Tech category: %BD_FS_TECH_F2FS-%BD_FS_TECH_MODE_RESIZE the device containing the file system to resize new requested size for the file system *in file system sectors* (see bd_fs_f2fs_get_info()) (if 0, the file system is adapted to the underlying block device) whether to perform safe resize or not (does not resize metadata) extra options for the resize (right now passed to the 'resize.f2fs' utility) Returns (transfer-none): features supported by @fstype, see %BDFSFeatures for more information. Tech category: always available name of the filesystem to get features for (e.g. "ext4") Freezes filesystem mounted on @mountpoint. The filesystem must support freezing. whether @mountpoint was successfully freezed or not mountpoint of the device (filesystem) to freeze Get free space for filesystem on @device. This calls other fs info functions from this plugin based on detected filesystem (e.g. bd_fs_ext4_get_info for ext4). This function will return an error for unknown/unsupported filesystems. free space of filesystem on @device, 0 in case of error. Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the device with file system to get free space for the filesystem type on @device or %NULL to detect Get first signature on @device as a string. type of filesystem found on @device, %NULL in case no signature has been detected or in case of error (@error is set in this case) Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the device to probe Get minimum size for filesystem on @device. This calls other fs info functions from this plugin based on detected filesystem (e.g. bd_fs_ext4_get_min_size for ext4). This function will return an error for unknown/unsupported filesystems. minimum size of filesystem on @device, 0 in case of error. Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_RESIZE the device with file system to get minimum size for the filesystem type on @device or %NULL to detect Get mountpoint for @device. If @device is mounted multiple times only one mountpoint will be returned. mountpoint for @device, %NULL in case device is not mounted or in case of an error (@error is set in this case) Tech category: %BD_FS_TECH_MOUNT (no mode, ignored) device to find mountpoint for Get size for filesystem on @device. This calls other fs info functions from this plugin based on detected filesystem (e.g. bd_fs_xfs_get_info for XFS). This function will return an error for unknown/unsupported filesystems. Note: This function will mount @device for filesystems that need to be mounted to gather information (like btrfs). size of filesystem on @device, 0 in case of error. Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_QUERY the device with file system to get size for the filesystem type on @device or %NULL to detect whether @path is a mountpoint or not Tech category: %BD_FS_TECH_MOUNT (no mode, ignored) path (folder) to check whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation (#BDFSTechMode) for @tech This is a helper function for creating filesystems with extra options. This is the same as running a filesystem-specific function like %bd_fs_ext4_mkfs and manually specifying the extra command line options. %BDFSMkfsOptions removes the need to specify supported options for selected filesystems, make sure to check whether @fstype supports these options (see %bd_fs_can_mkfs) for details. When specifying additional mkfs options using @extra, it's caller's responsibility to make sure these options do not conflict with options specified using @options. Extra options are added after the @options and there are no additional checks for duplicate and/or conflicting options. whether @fstype was successfully created on @device or not. Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_MKFS the device to create the new filesystem on name of the filesystem to create (e.g. "ext4") additional options like label or UUID for the filesystem extra mkfs options not provided in @options whether @device (or @mountpoint) was successfully mounted or not Tech category: %BD_FS_TECH_MOUNT (no mode, ignored) device to mount, if not specified @mountpoint entry from fstab will be used mountpoint for @device, if not specified @device entry from fstab will be used filesystem type comma delimited options for mount extra options for the mount; currently only 'run_as_uid' and 'run_as_gid' are supported; value must be a valid non zero uid (gid), if you specify one of these, the function will run in a child process with real user whether @label is a valid label for the nilfs2 file system or not (reason is provided in @error) Tech category: always available label to check whether @uuid is a valid UUID for the nilfs file system or not (reason is provided in @error) Tech category: always available UUID to check information about the file system on @device or %NULL in case of error Tech category: %BD_FS_TECH_NILFS2-%BD_FS_TECH_MODE_QUERY the device containing the file system to get info for whether a new nilfs fs was successfully created on @device or not Tech category: %BD_FS_TECH_NILFS2-%BD_FS_TECH_MODE_MKFS the device to create a new nilfs fs on extra options for the creation (right now passed to the 'mkfs.nilfs2' utility) whether the file system on @device was successfully resized or not Tech category: %BD_FS_TECH_NILFS2-%BD_FS_TECH_MODE_RESIZE the device the file system of which to resize new requested size for the file system (if 0, the file system is adapted to the underlying block device) whether the label of nilfs file system on the @device was successfully set or not Tech category: %BD_FS_TECH_NILFS2-%BD_FS_TECH_MODE_SET_LABEL the device containing the file system to set label for label to set whether the uuid of nilfs file system on the @device was successfully set or not Tech category: %BD_FS_TECH_NILFS2-%BD_FS_TECH_MODE_SET_UUID the device containing the file system to set UUID for UUID to set or %NULL to generate a new one whether an ntfs file system on the @device is clean or not Tech category: %BD_FS_TECH_NTFS-%BD_FS_TECH_MODE_CHECK the device containing the file system to check extra options for the repair (right now passed to the 'ntfsfix' utility) whether @label is a valid label for the ntfs file system or not (reason is provided in @error) Tech category: always available label to check whether @uuid is a valid UUID for the ntfs file system or not (reason is provided in @error) Tech category: always available UUID to check information about the file system on @device or %NULL in case of error Tech category: %BD_FS_TECH_NTFS-%BD_FS_TECH_MODE_QUERY the device containing the file system to get info for (device must not be mounted, trying to get info for a mounted device will result in an error) smallest shrunken filesystem size as reported by ntfsresize in case of error 0 is returned and @error is set Tech category: %BD_FS_TECH_NTFS-%BD_FS_TECH_MODE_RESIZE the device containing the file system to get min size for whether a new NTFS fs was successfully created on @device or not Tech category: %BD_FS_TECH_NTFS-%BD_FS_TECH_MODE_MKFS the device to create a new ntfs fs on extra options for the creation (right now passed to the 'mkntfs' utility) whether an NTFS file system on the @device was successfully repaired (if needed) or not (error is set in that case) Tech category: %BD_FS_TECH_NTFS-%BD_FS_TECH_MODE_REPAIR the device containing the file system to repair extra options for the repair (right now passed to the 'ntfsfix' utility) whether the file system on @device was successfully resized or not Tech category: %BD_FS_TECH_NTFS-%BD_FS_TECH_MODE_RESIZE the device the file system of which to resize new requested size for the file system in bytes (if 0, the file system is adapted to the underlying block device) whether the label of the NTFS file system on the @device was successfully set or not Tech category: %BD_FS_TECH_NTFS-%BD_FS_TECH_MODE_SET_LABEL the device containing the file system to set the label for label to set whether the UUID of the NTFS file system on the @device was successfully set or not Tech category: %BD_FS_TECH_NTFS-%BD_FS_TECH_MODE_SET_UUID the device containing the file system to set the UUID (serial number) for UUID to set or %NULL to generate a new one Repair filesystem on @device. This calls other fs repair functions from this plugin based on detected filesystem (e.g. bd_fs_xfs_repair for XFS). This function will return an error for unknown/unsupported filesystems. Most filesystem tools typically require the filesystem not to be mounted. whether the file system on @device was successfully repaired or not Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_REPAIR the device the file system of which to repair the filesystem type on @device or %NULL to detect Resize filesystem on @device. This calls other fs resize functions from this plugin based on provides or detected filesystem (e.g. bd_fs_xfs_resize for XFS). This function will return an error for unknown/unsupported filesystems. Note: This function will mount @device for filesystems that can be resized only when mounted (like XFS or Btrfs). whether the file system on @device was successfully resized or not Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_RESIZE the device the file system of which to resize new requested size for the file system (if 0, the file system is adapted to the underlying block device) the filesystem type on @device or %NULL to detect Set label for filesystem on @device. This calls other fs label functions from this plugin based on detected filesystem (e.g. bd_fs_xfs_set_label for XFS). This function will return an error for unknown/unsupported filesystems. Note: This function will mount @device for filesystems that need to be mounted to set label (like btrfs). whether the file system on @device was successfully relabeled or not Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_SET_LABEL the device with file system to set the label for label to set the filesystem type on @device or %NULL to detect Set UUID for filesystem on @device. This calls other fs UUID functions from this plugin based on detected filesystem (e.g. bd_fs_xfs_set_uuid for XFS). This function will return an error for unknown/unsupported filesystems. whether the UUID on the file system on @device was successfully changed or not Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_SET_UUID the device with file system to set the UUID for UUID to set or %NULL to generate a new one the filesystem type on @device or %NULL to detect list of filesystems supported by this plugin Note: This returns filesystems supported by libblockdev, but not necessarily by the systems this is running on, for this information you need to run one of the `bd_fs_can_` functions. Tech category: always available Note: This checks only whether @label adheres the length limits for Logical Volume Identifier, not the stricter limits for Volume Identifier. whether @label is a valid label for the UDF file system or not (reason is provided in @error) Tech category: always available label to check whether @uuid is a valid UUID for the UDF file system or not (reason is provided in @error) Tech category: always available UUID to check information about the file system on @device or %NULL in case of error Tech category: %BD_FS_TECH_UDF-%BD_FS_TECH_MODE_QUERY the device containing the file system to get info for whether a new UDF fs was successfully created on @device or not Tech category: %BD_FS_TECH_UDF-%BD_FS_TECH_MODE_MKFS the device to create a new UDF fs on specify the media type or %NULL for default ('hd') UDF revision to use or %NULL for default ('2.01') block size in bytes or 0 for auto detection (device logical block size) extra options for the creation (right now passed to the 'mkudffs' utility) Note: This sets both Volume Identifier and Logical Volume Identifier. Volume Identifier is truncated to 30 or 15 characters to accommodate to the different length limits of these labels. whether the label of UDF file system on the @device was successfully set or not Tech category: %BD_FS_TECH_UDF-%BD_FS_TECH_MODE_SET_LABEL the device containing the file system to set label for label to set whether the UUID of the UDF file system on the @device was successfully set or not Tech category: %BD_FS_TECH_UDF-%BD_FS_TECH_MODE_SET_UUID the device containing the file system to set the UUID (serial number) for UUID to set or %NULL to generate a new one Un-freezes filesystem mounted on @mountpoint. The filesystem must support freezing. whether @mountpoint was successfully unfreezed or not mountpoint of the device (filesystem) to un-freeze whether @spec was successfully unmounted or not Tech category: %BD_FS_TECH_MOUNT (no mode, ignored) mount point or device to unmount enable/disable lazy unmount enable/disable force unmount extra options for the unmount; currently only 'run_as_uid' and 'run_as_gid' are supported; value must be a valid non zero uid (gid), if you specify one of these, the function will run in a child process with real user whether an vfat file system on the @device is clean or not Tech category: %BD_FS_TECH_VFAT-%BD_FS_TECH_MODE_CHECK the device containing the file system to check extra options for the repair (right now passed to the 'fsck.vfat' utility) whether @label is a valid label for the vfat file system or not (reason is provided in @error) Tech category: always available label to check whether @uuid is a valid UUID for the vfat file system or not (reason is provided in @error) Tech category: always available UUID to check information about the file system on @device or %NULL in case of error Tech category: %BD_FS_TECH_VFAT-%BD_FS_TECH_MODE_QUERY the device containing the file system to get info for Please remember that FAT labels should always be uppercase. whether a new vfat fs was successfully created on @device or not Tech category: %BD_FS_TECH_VFAT-%BD_FS_TECH_MODE_MKFS the device to create a new vfat fs on extra options for the creation (right now passed to the 'mkfs.vfat' utility) whether an vfat file system on the @device was successfully repaired (if needed) or not (error is set in that case) Tech category: %BD_FS_TECH_VFAT-%BD_FS_TECH_MODE_REPAIR the device containing the file system to repair extra options for the repair (right now passed to the 'fsck.vfat' utility) whether the file system on @device was successfully resized or not Tech category: %BD_FS_TECH_VFAT-%BD_FS_TECH_MODE_RESIZE the device the file system of which to resize new requested size for the file system (if 0, the file system is adapted to the underlying block device) whether the label of vfat file system on the @device was successfully set or not Tech category: %BD_FS_TECH_VFAT-%BD_FS_TECH_MODE_SET_LABEL the device containing the file system to set label for label to set whether the volume ID of vfat file system on the @device was successfully set or not Tech category: %BD_FS_TECH_VFAT-%BD_FS_TECH_MODE_SET_UUID the device containing the file system to set uuid for volume ID to set or %NULL to generate a new one whether signatures were successfully wiped on @device or not Tech category: %BD_FS_TECH_GENERIC-%BD_FS_TECH_MODE_WIPE the device to wipe signatures from whether to wipe all (%TRUE) signatures or just the first (%FALSE) one whether to wipe signatures on a mounted @device whether an xfs file system on the @device is clean or not Note: If the file system is mounted RW, it will always be reported as not clean! Tech category: %BD_FS_TECH_XFS-%BD_FS_TECH_MODE_CHECK the device containing the file system to check extra options for the repair (right now passed to the 'xfs_repair' utility) whether @label is a valid label for the xfs file system or not (reason is provided in @error) Tech category: always available label to check whether @uuid is a valid UUID for the xfs file system or not (reason is provided in @error) Tech category: always available UUID to check information about the file system on @device or %NULL in case of error Tech category: %BD_FS_TECH_XFS-%BD_FS_TECH_MODE_QUERY the device containing the file system to get info for (device must be mounted, trying to get info for an unmounted device will result in an error) whether a new xfs fs was successfully created on @device or not Tech category: %BD_FS_TECH_XFS-%BD_FS_TECH_MODE_MKFS the device to create a new xfs fs on extra options for the creation (right now passed to the 'mkfs.xfs' utility) whether an xfs file system on the @device was successfully repaired (if needed) or not (error is set in that case) Tech category: %BD_FS_TECH_XFS-%BD_FS_TECH_MODE_REPAIR the device containing the file system to repair extra options for the repair (right now passed to the 'xfs_repair' utility) whether the file system mounted on @mpoint was successfully resized or not Tech category: %BD_FS_TECH_XFS-%BD_FS_TECH_MODE_RESIZE the mount point of the file system to resize new requested size for the file system *in file system blocks* (see bd_fs_xfs_get_info()) (if 0, the file system is adapted to the underlying block device) extra options for the resize (right now passed to the 'xfs_growfs' utility) whether the label of xfs file system on the @device was successfully set or not Tech category: %BD_FS_TECH_XFS-%BD_FS_TECH_MODE_SET_LABEL the device containing the file system to set label for label to set whether the UUID of xfs file system on the @device was successfully set or not Tech category: %BD_FS_TECH_XFS-%BD_FS_TECH_MODE_SET_UUID the device containing the file system to set uuid for UUID to set %NULL to generate a new one UUID can also be one of "nil" and "generate" to clear or generate a new UUID an array of string names of plugins that are available name of the plugin the queried plugin name of the shared object loaded for the plugin or %NULL if none is loaded the queried plugin whether the library was successfully initialized with all the required or default (see @require_plugins) plugins or not Example of libblockdev initialization with 'fs' and 'lvm' plugins. Specific version of the lvm plugin is required: |[<!-- language="C" --> GError *error = NULL; gboolean ret = FALSE; BDPluginSpec fs_plugin = {BD_PLUGIN_FS, NULL}; BDPluginSpec lvm_plugin = {BD_PLUGIN_LVM, "libbd_lvm.so.3"}; BDPluginSpec *plugins[] = {&fs_plugin, &lvm_plugin, NULL}; ret = bd_init (plugins, NULL, &error); ]| %NULL-terminated list of plugins that should be loaded (if no so_name is specified for the plugin, the default is used) or %NULL to load all plugins logging function to use whether the library is initialized or not The library is considered initialized if some of the *init*() functions was/were called and either at least one plugin is loaded or 0 plugins are loaded after an explicit call that requested 0 plugins to be loaded. whether the given plugin is available or not the queried plugin name of the loop device associated with the given @file Tech category: %BD_LOOP_TECH_LOOP-%BD_LOOP_TECH_MODE_QUERY path of the backing file to get loop name for information about the @loop device or %NULL in case of error Tech category: %BD_LOOP_TECH_LOOP-%BD_LOOP_TECH_MODE_QUERY name of the loop device to get information about (e.g. "loop0") whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation (#BDLoopTechMode) for @tech whether the autoclear flag was successfully set on the @loop device or not Tech category: %BD_LOOP_TECH_LOOP-%BD_LOOP_TECH_MODE_MODIFY path or name of the loop device whether to set or unset the autoclear flag whether the @file was successfully setup as a loop device or not Tech category: %BD_LOOP_TECH_LOOP-%BD_LOOP_TECH_MODE_CREATE file to setup as a loop device offset of the start of the device (in @file) maximum size of the device (or 0 to leave unspecified) whether to setup as read-only (%TRUE) or read-write (%FALSE) whether to enforce partition scan on the newly created device or not logical sector size for the loop device in bytes (or 0 for default) if not %NULL, it is used to store the name of the loop device whether an new loop device was successfully setup for @fd or not Tech category: %BD_LOOP_TECH_LOOP-%BD_LOOP_TECH_MODE_CREATE file descriptor for a file to setup as a new loop device offset of the start of the device (in file given by @fd) maximum size of the device (or 0 to leave unspecified) whether to setup as read-only (%TRUE) or read-write (%FALSE) whether to enforce partition scan on the newly created device or not logical sector size for the loop device in bytes (or 0 for default) if not %NULL, it is used to store the name of the loop device whether the @loop device was successfully torn down or not Tech category: %BD_LOOP_TECH_LOOP-%BD_LOOP_TECH_MODE_DESTROY path or name of the loop device to tear down whether the tags were successfully added to @device or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY name of the VG that contains the LV to set tags on name of the LV to set tags on list of tags to add whether the tags were successfully added to @device or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY the device to set PV tags for list of tags to add whether the tags were successfully added to @vg_name or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY the VG to set tags on list of tags to add whether the @cache_pool_lv was successfully attached to the @data_lv or not Note: Both @data_lv and @cache_lv will be deactivated before the operation. Tech category: %BD_LVM_TECH_CACHE-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the @data_lv and the @cache_pool_lv LVs data LV to attach the @cache_pool_lv to cache pool LV to attach to the @data_lv extra options for the cache attachment (just passed to LVM as is) whether the cached LV @lv_name was successfully created or not Tech category: %BD_LVM_TECH_CACHE-%BD_LVM_TECH_MODE_CREATE name of the VG to create a cached LV in name of the cached LV to create size of the data LV size of the cache (or cached LV more precisely) size of the cache metadata LV or 0 to use the default cache mode for the cached LV a combination of (ORed) #BDLVMCachePoolFlags list of slow PVs (used for the data LV) list of fast PVs (used for the cache LV) whether the cache pool @vg_name/@pool_name was successfully created or not Tech category: %BD_LVM_TECH_CACHE-%BD_LVM_TECH_MODE_CREATE name of the VG to create @pool_name in name of the cache pool LV to create desired size of the cache pool @pool_name desired size of the @pool_name cache pool's metadata LV or 0 to use the default cache mode of the @pool_name cache pool a combination of (ORed) #BDLVMCachePoolFlags list of (fast) PVs to create the @pool_name cache pool (and the metadata LV) whether the cache was successfully detached from the @cached_lv or not Note: synces the cache first Tech category: %BD_LVM_TECH_CACHE-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the @cached_lv name of the cached LV to detach its cache from whether to destroy the cache after detach or not extra options for the cache detachment (just passed to LVM as is) recommended default size of the cache metadata LV or 0 in case of error Tech category: %BD_LVM_TECH_CACHE_CALCS no mode (it is ignored) size of the cache to determine MD size for cache mode for the @mode_str or %BD_LVM_CACHE_MODE_UNKNOWN if failed to determine Tech category: always provided/supported string representation of a cache mode string representation of @mode or %NULL in case of error Tech category: always provided/supported mode to get the string representation for Converts the @data_lv and @metadata_lv into a new cache pool in the @vg_name VG. whether the new cache pool was successfully created from @data_lv and @metadata_lv or not Tech category: %BD_LVM_TECH_CACHE-%BD_LVM_TECH_MODE_CREATE name of the VG to create the new thin pool in name of the LV that should become the data part of the new pool name of the LV that should become the metadata part of the new pool name for the thin pool (if %NULL, the name @data_lv is inherited) extra options for the thin pool creation (just passed to LVM as is) name of the cache pool LV used by the @cached_lv or %NULL in case of error Tech category: %BD_LVM_TECH_CACHE-%BD_LVM_TECH_MODE_QUERY name of the VG containing the @cached_lv cached LV to get the name of the its pool LV for stats for the @cached_lv or %NULL in case of error Tech category: %BD_LVM_TECH_CACHE-%BD_LVM_TECH_MODE_QUERY name of the VG containing the @cached_lv cached LV to get stats for Frees @data. %BDLVMCacheStats to free whether the tags were successfully removed from @device or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY name of the VG that contains the LV to set tags on name of the LV to set tags on list of tags to remove whether the tags were successfully removed from @device or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY the device to set PV tags for list of tags to remove whether the tags were successfully removed from @vg_name or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY the VG to set tags on list of tags to remove whether the @device was successfully added to @devices_file or not Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) device (PV) to add to the devices file LVM devices file or %NULL for default extra options for the lvmdevices command whether the @device was successfully removed from @devices_file or not Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) device (PV) to delete from the devices file LVM devices file or %NULL for default extra options for the lvmdevices command a copy of a string representation of the currently set LVM devices filter Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) a copy of a string representation of the currently set LVM global configuration Tech category: %BD_LVM_TECH_GLOB_CONF no mode (it is ignored) space taken on disk(s) by the LV with given @size Gives number of bytes needed for an LV with the size @lv_size on an LVM stack using given @pe_size. Tech category: %BD_LVM_TECH_CALCS no mode (it is ignored) LV size PE size maximum LV size in bytes Tech category: %BD_LVM_TECH_CALCS no mode (it is ignored) list of supported PE sizes Tech category: %BD_LVM_TECH_CALCS no mode (it is ignored) Note: This function will be changed in 3.0: the @n_snapshots parameter is currently not used and will be removed. recommended size of the metadata space for the specified pool Tech category: %BD_LVM_TECH_THIN_CALCS no mode (it is ignored) size of the thin pool chunk size of the thin pool or 0 to use the default ignored size of the padding needed for a thin pool with the given @size according to the @pe_size and @included Tech category: %BD_LVM_TECH_THIN_CALCS no mode (it is ignored) size of the thin pool PE size or 0 if the default value should be used if padding is already included in the size string representation of @state or %NULL in case of error Tech category: always provided/supported state to get the string representation for string representation of @state or %NULL in case of error Tech category: always provided/supported state to get the string representation for string representation of @mode or %NULL in case of error Tech category: always provided/supported mode to get the string representation for write policy for the @policy_str or %BD_LVM_VDO_WRITE_POLICY_UNKNOWN if failed to determine Tech category: always provided/supported string representation of a policy string representation of @policy or %NULL in case of error Tech category: always provided/supported policy to get the string representation for whether the given size is supported physical extent size or not Tech category: %BD_LVM_TECH_CALCS no mode (it is ignored) size (in bytes) to test whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation (#BDLVMTechMode) for @tech whether the given size is a valid thin pool chunk size or not Tech category: %BD_LVM_TECH_THIN_CALCS no mode (it is ignored) the size to be tested whether discard/TRIM is required to be supported or not whether the given size is a valid thin pool metadata size or not Tech category: %BD_LVM_TECH_THIN_CALCS no mode (it is ignored) the size to be tested whether the @vg_name/@lv_name LV was successfully activated or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-activated LV name of the to-be-activated LV whether to ignore the skip flag or not whether to activate the LV in shared mode (used for shared LVM setups with lvmlockd, use %FALSE if not sure) extra options for the LV activation (just passed to LVM as is) whether the given @vg_name/@lv_name LV was successfully created or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_CREATE name of the VG to create a new LV in name of the to-be-created LV requested size of the new LV type of the new LV ("striped", "raid1",..., see lvcreate (8)) list of PVs the newly created LV should use or %NULL if not specified extra options for the LV creation (just passed to LVM as is) whether the @vg_name/@lv_name LV was successfully deactivated or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-deactivated LV name of the to-be-deactivated LV extra options for the LV deactivation (just passed to LVM as is) information about the @vg_name/@lv_name LV or %NULL in case of error (the @error) gets populated in those cases) Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY name of the VG that contains the LV to get information about name of the LV to get information about This function will fill out the data_lvs, metadata_lvs, and segs fields as well. information about the @vg_name/@lv_name LV or %NULL in case of error (the @error) gets populated in those cases) Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY name of the VG that contains the LV to get information about name of the LV to get information about the origin volume for the @vg_name/@lv_name LV or %NULL if failed to determine (@error) is set in those cases) Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY name of the VG containing the queried LV name of the queried LV whether the @vg_name/@lv_name LV was successfully removed or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_REMOVE name of the VG containing the to-be-removed LV name of the to-be-removed LV whether to force removal or not extra options for the LV removal (just passed to LVM as is) whether the @vg_name/@lv_name LV was successfully renamed to @vg_name/@new_name or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-renamed LV name of the to-be-renamed LV new name for the @vg_name/@lv_name LV extra options for the LV rename (just passed to LVM as is) whether the @vg_name/@lv_name LV was successfully repaired or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-repaired LV name of the to-be-repaired LV list of PVs to be used for the repair extra options for the LV repair (just passed to LVM as is) whether the @vg_name/@lv_name LV was successfully resized or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-resized LV name of the to-be-resized LV the requested new size of the LV extra options for the LV resize (just passed to LVM as is) information about LVs found in the given @vg_name VG or in system if @vg_name is %NULL Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY name of the VG to get information about LVs from This function will fill out the data_lvs, metadata_lvs, and segs fields as well. information about LVs found in the given @vg_name VG or in system if @vg_name is %NULL. Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY name of the VG to get information about LVs from whether the @snapshot_name snapshot of the @vg_name/@origin_name LV was successfully created or not. Tech category: %BD_LVM_TECH_BASIC_SNAP-%BD_LVM_TECH_MODE_CREATE name of the VG containing the LV a new snapshot should be created of name of the LV a new snapshot should be created of name of the to-be-created snapshot requested size for the snapshot extra options for the LV snapshot creation (just passed to LVM as is) whether the @vg_name/@snapshot_name LV snapshot was successfully merged or not Tech category: %BD_LVM_TECH_BASIC_SNAP-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-merged LV snapshot name of the to-be-merged LV snapshot extra options for the LV snapshot merge (just passed to LVM as is) whether the PV was successfully created or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_CREATE the device to make PV from data (first PE) alignment or 0 to use the default size of the area reserved for metadata or 0 to use the default extra options for the PV creation (just passed to LVM as is) information about the PV on the given @device or %NULL in case of error (the @error) gets populated in those cases) Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY a PV to get information about or %NULL whether the extents from the @src PV where successfully moved or not If @dest is %NULL, VG allocation rules are used for the extents from the @src PV (see pvmove(8)). Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY the PV device to move extents off of the PV device to move extents onto or %NULL extra options for the PV move (just passed to LVM as is) whether the PV was successfully removed/destroyed or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_REMOVE the PV device to be removed/destroyed extra options for the PV removal (just passed to LVM as is) whether the PV's size was successfully changed or not If given @size different from 0, sets the PV's size to the given value (see pvresize(8)). If given @size 0, adjusts the PV's size to the underlying block device's size. Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY the device to resize the new requested size of the PV or 0 if it should be adjusted to device's size extra options for the PV resize (just passed to LVM as is) information about PVs found in the system Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY whether the system or @device was successfully scanned for PVs or not The @device argument is used only if @update_cache is %TRUE. Otherwise the whole system is scanned for PVs. Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY the device to scan for PVs or %NULL whether to update the lvmetad cache or not extra options for the PV scan (just passed to LVM as is) @size rounded to @pe_size according to the @roundup Rounds given @size up/down to a multiple of @pe_size according to the value of the @roundup parameter. If the rounded value is too big to fit in the return type, the result is rounded down (floored) regardless of the @roundup parameter. Tech category: %BD_LVM_TECH_CALCS no mode (it is ignored) size to be rounded physical extent (PE) size or 0 to use the default whether to round up or down (ceil or floor) whether the devices filter was successfully set or not Tech category: %BD_LVM_TECH_DEVICES no mode (it is ignored) list of devices for lvm commands to work on whether the new requested global config @new_config was successfully set or not Tech category: %BD_LVM_TECH_GLOB_CONF no mode (it is ignored) string representation of the new global LVM configuration to set or %NULL to reset to default whether the @vg_name/@lv_name thin LV was successfully created or not Tech category: %BD_LVM_TECH_THIN-%BD_LVM_TECH_MODE_CREATE name of the VG containing the thin pool providing extents for the to-be-created thin LV name of the pool LV providing extents for the to-be-created thin LV name of the to-be-created thin LV requested virtual size of the to-be-created thin LV extra options for the thin LV creation (just passed to LVM as is) the name of the pool volume for the @vg_name/@lv_name thin LV or %NULL if failed to determine (@error) is set in those cases) Tech category: %BD_LVM_TECH_THIN-%BD_LVM_TECH_MODE_QUERY name of the VG containing the queried thin LV name of the queried thin LV Converts the @data_lv and @metadata_lv into a new thin pool in the @vg_name VG. whether the new thin pool was successfully created from @data_lv and @metadata_lv or not Tech category: %BD_LVM_TECH_THIN-%BD_LVM_TECH_MODE_CREATE name of the VG to create the new thin pool in name of the LV that should become the data part of the new pool name of the LV that should become the metadata part of the new pool name for the thin pool (if %NULL, the name @data_lv is inherited) extra options for the thin pool creation (just passed to LVM as is) whether the @vg_name/@lv_name thin pool was successfully created or not Tech category: %BD_LVM_TECH_THIN-%BD_LVM_TECH_MODE_CREATE name of the VG to create a thin pool in name of the to-be-created pool LV requested size of the to-be-created pool requested metadata size or 0 to use the default requested chunk size or 0 to use the default profile to use (see lvm(8) for more information) or %NULL to use the default extra options for the thin pool creation (just passed to LVM as is) whether the @snapshot_name snapshot of the @vg_name/@origin_name thin LV was successfully created or not. Tech category: %BD_LVM_TECH_THIN-%BD_LVM_TECH_MODE_CREATE name of the VG containing the thin LV a new snapshot should be created of name of the thin LV a new snapshot should be created of name of the to-be-created snapshot name of the thin pool to create the snapshot in or %NULL if not specified extra options for the thin LV snapshot creation (just passed to LVM as is) whether compression was successfully disabled on @vg_name/@pool_name LV or not Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-changed VDO pool LV name of the VDO pool LV to disable compression on extra options for the VDO change (just passed to LVM as is) whether deduplication was successfully disabled on @vg_name/@pool_name LV or not Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-changed VDO pool LV name of the VDO pool LV to disable deduplication on extra options for the VDO change (just passed to LVM as is) whether compression was successfully enabled on @vg_name/@pool_name LV or not Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-changed VDO pool LV name of the VDO pool LV to enable compression on extra options for the VDO change (just passed to LVM as is) whether deduplication was successfully enabled on @vg_name/@pool_name LV or not Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-changed VDO pool LV name of the VDO pool LV to enable deduplication on extra options for the VDO change (just passed to LVM as is) a structure containing selected statistics or %NULL in case of error (@error gets populated in those cases) In contrast to @bd_lvm_vdo_get_stats_full this function will only return selected statistics in a fixed structure. In case a value is not available, -1 would be returned. Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_QUERY name of the VG that contains @pool_name VDO pool name of the VDO pool to get statistics for hashtable of type string - string of available statistics or %NULL in case of error (@error gets populated in those cases) Statistics are collected from the values exposed by the kernel `kvdo` module at the `/sys/kvdo/<VDO_NAME>/statistics/` path. Some of the keys are computed to mimic the information produced by the vdo tools. Please note the contents of the hashtable may vary depending on the actual kvdo module version. Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_QUERY name of the VG that contains @pool_name VDO pool name of the VDO pool to get statistics for information about the @vg_name/@lv_name LV or %NULL in case of error (the @error) gets populated in those cases) Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_QUERY name of the VG that contains the LV to get information about name of the LV to get information about Converts the @pool_lv into a new VDO pool LV in the @vg_name VG and creates a new @name VDO LV with size @virtual_size. Note: All data on @pool_lv will be irreversibly destroyed. whether the new VDO pool LV was successfully created from @pool_lv and or not Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_CREATE&%BD_LVM_TECH_MODE_MODIFY name of the VG that contains @pool_lv name of the LV that should become the new VDO pool LV name for the VDO LV or %NULL for default name virtual size for the new VDO LV amount of index memory (in bytes) or 0 for default whether to enable compression or not whether to enable deduplication or not write policy for the volume extra options for the VDO pool creation (just passed to LVM as is) whether the given @vg_name/@lv_name VDO LV was successfully created or not Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_CREATE name of the VG to create a new LV in name of the to-be-created VDO LV name of the to-be-created VDO pool LV or %NULL for default name requested size of the data VDO LV (physical size of the @pool_name VDO pool LV) requested virtual_size of the @lv_name VDO LV amount of index memory (in bytes) or 0 for default whether to enable compression or not whether to enable deduplication or not write policy for the volume extra options for the VDO LV creation (just passed to LVM as is) whether the @vg_name/@pool_name VDO pool LV was successfully resized or not Note: Size of the VDO pool LV can be only extended, not reduced. Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-resized VDO pool LV name of the to-be-resized VDO pool LV the requested new size of the VDO pool LV extra options for the VDO pool LV resize (just passed to LVM as is) whether the @vg_name/@lv_name VDO LV was successfully resized or not Note: Reduction needs to process TRIM for reduced disk area to unmap used data blocks from the VDO pool LV and it may take a long time. Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the to-be-resized VDO LV name of the to-be-resized VDO LV the requested new size of the VDO LV extra options for the VDO LV resize (just passed to LVM as is) the name of the pool volume for the @vg_name/@lv_name VDO LV or %NULL if failed to determine (@error) is set in those cases) Tech category: %BD_LVM_TECH_VDO-%BD_LVM_TECH_MODE_QUERY name of the VG containing the queried VDO LV name of the queried VDO LV whether the VG was successfully activated or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY name of the to be activated VG extra options for the VG activation (just passed to LVM as is) whether the VG @name was successfully created or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_CREATE name of the newly created VG list of PVs the newly created VG should use PE size or 0 if the default value should be used extra options for the VG creation (just passed to LVM as is) whether the VG was successfully deactivated or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY name of the to be deactivated VG extra options for the VG deactivation (just passed to LVM as is) whether the VG @vg_name was successfully extended with the given @device or not. Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY name of the to be extended VG PV device to extend the @vg_name VG with extra options for the VG extension (just passed to LVM as is) information about the @vg_name VG or %NULL in case of error (the @error) gets populated in those cases) Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY a VG to get information about whether the lock was successfully started for @vg_name or not Tech category: %BD_LVM_TECH_SHARED-%BD_LVM_TECH_MODE_MODIFY a shared VG to start the lockspace in lvmlockd extra options for the vgchange command (just passed to LVM as is) whether the lock was successfully stopped for @vg_name or not Tech category: %BD_LVM_TECH_SHARED-%BD_LVM_TECH_MODE_MODIFY a shared VG to stop the lockspace in lvmlockd extra options for the vgchange command (just passed to LVM as is) whether the VG @vg_name was successfully reduced of the given @device or not Note: This function does not move extents off of the PV before removing it from the VG. You must do that first by calling #bd_lvm_pvmove. Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY name of the to be reduced VG PV device the @vg_name VG should be reduced of or %NULL if the VG should be reduced of the missing PVs extra options for the VG reduction (just passed to LVM as is) whether the VG was successfully removed or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_REMOVE name of the to be removed VG extra options for the VG removal (just passed to LVM as is) whether the VG was successfully renamed or not Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_MODIFY old name of the VG to rename new name for the @old_vg_name VG extra options for the VG rename (just passed to LVM as is) information about VGs found in the system Tech category: %BD_LVM_TECH_BASIC-%BD_LVM_TECH_MODE_QUERY whether the @cache_lv was successfully attached to the @data_lv or not Tech category: %BD_LVM_TECH_WRITECACHE-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the @data_lv and the @cache_pool_lv LVs data LV to attach the @cache_lv to cache (fast) LV to attach to the @data_lv extra options for the cache attachment (just passed to LVM as is) whether the cached LV @lv_name was successfully created or not Tech category: %BD_LVM_TECH_WRITECACHE-%BD_LVM_TECH_MODE_CREATE name of the VG to create a cached LV in name of the cached LV to create size of the data LV size of the cache (or cached LV more precisely) list of slow PVs (used for the data LV) list of fast PVs (used for the cache LV) whether the cache was successfully detached from the @cached_lv or not Note: synces the cache first Tech category: %BD_LVM_TECH_WRITECACHE-%BD_LVM_TECH_MODE_MODIFY name of the VG containing the @cached_lv name of the cached LV to detach its cache from whether to destroy the cache after detach or not extra options for the cache detachment (just passed to LVM as is) whether the MD RAID @device was successfully activated or not Note: either @members or @uuid (or both) have to be specified. Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_MODIFY specification of the RAID device (name, node or path) to activate (if not given "--scan" is implied and @members is ignored) member devices to be considered for @device activation UUID (in the MD RAID format!) of the MD RAID to activate whether to start the array even if it's degraded extra options for the activation (right now passed to the 'mdadm' utility) whether the @device was successfully added to the @raid_spec RAID or not The @raid_devs parameter is used when adding devices to a raid array that has no actual redundancy. In this case it is necessary to explicitly grow the array all at once rather than manage it in the sense of adding spares. Whether the new device will be added as a spare or an active member is decided by mdadm. Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_MODIFY specification of the RAID device (name, node or path) to add @device into name of the device to add to the @raid_spec RAID device number of devices the @raid_spec RAID should actively use or 0 to leave unspecified (see below) extra options for the addition (right now passed to the 'mdadm' utility) canonicalized form of @uuid This function expects a UUID in the form that mdadm returns. The change is as follows: 3386ff85:f5012621:4a435f06:1eb47236 -> 3386ff85-f501-2621-4a43-5f061eb47236 Tech category: always available UUID to canonicalize whether the new MD RAID device @device_name was successfully created or not Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_CREATE name of the device to create RAID level (as understood by mdadm, see mdadm(8)) disks to use for the new RAID (including spares) number of spare devices metadata version write-intent bitmap location ('none', 'internal') or %NULL to let mdadm decide (i.e. internal > 100GB) chunk size of the device to create extra options for the creation (right now passed to the 'mdadm' utility) whether the RAID device @raid_spec was successfully deactivated or not Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_MODIFY specification of the RAID device (name, node or path) whether the @device was successfully denominated (added to its appropriate RAID) or not Note: may start the MD RAID if it becomes ready by adding @device. Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_MODIFY device to denominate (remove from its appropriate RAID) as a MD RAID device whether the MD RAID metadata was successfully destroyed on @device or not Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_DELETE device to destroy MD RAID metadata on information about the MD RAID @raid_spec Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_QUERY specification of the RAID device (name, node or path) to examine information about the MD RAID extracted from the @device Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_QUERY name of the device (a member of an MD RAID) to examine bitmap location for @raid_spec Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_QUERY specification of the RAID device (name, node or path) to get the bitmap location transformed form of @uuid This function expects a UUID in the canonical (traditional format) and returns a UUID in the format used by MD RAID and is thus reverse to bd_md_canonicalize_uuid(). The change is as follows: 3386ff85-f501-2621-4a43-5f061eb47236 -> 3386ff85:f5012621:4a435f06:1eb47236 Tech category: always available UUID to transform into format used by MD RAID status of the @raid_spec RAID. Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_QUERY specification of the RAID device (name, node or path) to get status Calculated superblock size for an array with a given @member_size and metadata @version or default if unsupported @version is used. Tech category: always available size of an array member metadata version or %NULL to use the current default version whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation for @tech @name of the MD RAID the device node belongs to or %NULL in case of error Tech category: always available path of the MD RAID's device node device node of the @name MD RAID or %NULL in case of error Tech category: always available name of the MD RAID whether the @device was successfully nominated (added to its appropriate RAID) or not Note: may start the MD RAID if it becomes ready by adding @device. Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_MODIFY device to nominate (add to its appropriate RAID) as a MD RAID device whether the @device was successfully removed from the @raid_spec RAID or not. Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_MODIFY specification of the RAID device (name, node or path) to remove @device from device to remove from the @raid_spec RAID whether to mark the @device as failed before removing extra options for the removal (right now passed to the 'mdadm' utility) whether the @action was successfully requested for the @raid_spec RAID or not. Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_MODIFY specification of the RAID device (name, node or path) to request sync action on requested sync action (resync, recovery, check, repair or idle) whether the @raid_spec was successfully started or not Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_MODIFY specification of the (possibly degraded) RAID device (name, node or path) to be started whether @location was successfully set for @raid_spec Tech category: %BD_MD_TECH_MDRAID-%BD_MD_TECH_MODE_MODIFY specification of the RAID device (name, node or path) to set the bitmap location bitmap location (none, internal or path) whether multipath device maps were successfully flushed or not Flushes all unused multipath device maps. Tech category: %BD_MPATH_TECH_BASE-%BD_MPATH_TECH_MODE_MODIFY list of names of all devices that are members of the mpath mappings (or %NULL in case of error) Tech category: %BD_MPATH_TECH_BASE-%BD_MPATH_TECH_MODE_QUERY %TRUE if the device is a multipath member, %FALSE if not or an error appeared when queried (@error is set in those cases) Tech category: %BD_MPATH_TECH_BASE-%BD_MPATH_TECH_MODE_QUERY device to test whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation for @tech if successfully set or not Tech category: %BD_MPATH_TECH_FRIENDLY_NAMES-%BD_MPATH_TECH_MODE_MODIFY whether friendly names should be enabled or not NVDIMM plugin will be removed in the next major release whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation (#BDNVDIMMTechMode) for @tech NVDIMM plugin will be removed in the next major release information about the namespaces on @bus and @region or %NULL if no namespaces were found (@error may be set to indicate error) Tech category: %BD_NVDIMM_TECH_NAMESPACE-%BD_NVDIMM_TECH_MODE_QUERY return only namespaces on given bus (specified by name), %NULL may be specified to return namespaces from all buses return only namespaces on given region (specified by regionX name or region id), %NULL may be specified to return namespaces from all regions whether to list idle (not enabled) namespaces too extra options for the creation (right now passed to the 'ndctl' utility) NVDIMM plugin will be removed in the next major release whether the @namespace was successfully disabled or not Tech category: %BD_NVDIMM_TECH_NAMESPACE-%BD_NVDIMM_TECH_MODE_ACTIVATE_DEACTIVATE name of the namespace to disable extra options (currently unused) NVDIMM plugin will be removed in the next major release whether the @namespace was successfully enabled or not Tech category: %BD_NVDIMM_TECH_NAMESPACE-%BD_NVDIMM_TECH_MODE_ACTIVATE_DEACTIVATE name of the namespace to enable extra options (currently unused) NVDIMM plugin will be removed in the next major release namespace device name (e.g. "namespaceX.Y") for @device or %NULL if @device is not a NVDIMM namespace (@error may be set to indicate error) Tech category: %BD_NVDIMM_TECH_NAMESPACE-%BD_NVDIMM_TECH_MODE_QUERY name or path of a block device (e.g. "/dev/pmem0") NVDIMM plugin will be removed in the next major release mode matching the @mode_str given or %BD_NVDIMM_NAMESPACE_MODE_UNKNOWN in case of no match Tech category: always available string representation of mode NVDIMM plugin will be removed in the next major release string representation of @mode or %NULL in case of error Tech category: always available mode to get string representation of NVDIMM plugin will be removed in the next major release list of supported sector sizes for @mode Tech category: %BD_NVDIMM_TECH_NAMESPACE-%BD_NVDIMM_TECH_MODE_QUERY namespace mode NVDIMM plugin will be removed in the next major release information about given namespace or %NULL if no such namespace was found (@error may be set to indicate error) Tech category: %BD_NVDIMM_TECH_NAMESPACE-%BD_NVDIMM_TECH_MODE_QUERY namespace to get information about extra options (currently unused) NVDIMM plugin will be removed in the next major release whether @namespace was successfully reconfigured or not name of the namespace to reconfigure mode type to set (memory/sector/raw/dax) whether to use force to reconfigure an active namespace extra options for the creation (right now passed to the 'ndctl' utility) 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. - `"keyring"`: Keyring to store and lookup keys. String value. - `"tls_key"`: TLS PSK for the connection. String value. 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. %TRUE if the subsystem was connected successfully, %FALSE otherwise with @error set. Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR The name for the NVMe subsystem to connect to. The network fabric used for a NVMe-over-Fabrics network. The network address of the Controller. For transports using IP addressing (e.g. `rdma`) this should be an IP-based address. 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`. The network address used on the host to connect to the Controller. For TCP, this sets the source address on the socket. 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. 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. User-defined host UUID or %NULL to use default (as defined in `/etc/nvme/hostid`) Additional arguments. 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(). %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 a NVMe controller or namespace device (e.g. `/dev/nvme0`) self-test action to take. 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. %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 The name of the NVMe subsystem to disconnect. Disconnects and removes a NVMe over Fabrics controller represented by a block device path. %TRUE if the controller was disconnected successfully, %FALSE otherwise with @error set. Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR NVMe controller device to disconnect (e.g. `/dev/nvme0`). A convenient utility function to look up all controllers associated with a NVMe subsystem the specified namespace is part of. 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 NVMe namespace device file. Limit matching to the specified subsystem NQN. Limit matching to the specified host NQN. Limit matching to the specified host ID. 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(). %TRUE if the format command finished successfully, %FALSE otherwise with @error set. Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_MANAGE NVMe namespace or controller device to format (e.g. `/dev/nvme0n1`) desired LBA data size (i.e. a sector size) in bytes or `0` to keep current. See #BDNVMELBAFormat and bd_nvme_get_namespace_info(). desired metadata size in bytes or `0` for default. See #BDNVMELBAFormat and bd_nvme_get_namespace_info(). optional secure erase action to take. 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. the Host NQN string or %NULL with @error set. Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR Retrieves information about the NVMe controller (the Identify Controller command) as specified by the @device block device path. 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 a NVMe controller device (e.g. `/dev/nvme0`) 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. 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 a NVMe controller device (e.g. `/dev/nvme0`) 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. the Host ID string or an empty string if none set. Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR 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. the Host NQN string or an empty string if none set. Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR Retrieves information about the NVMe namespace (the Identify Namespace command) as specified by the @device block device path. 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 a NVMe namespace device (e.g. `/dev/nvme0n1`) 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. sanitize log data or %NULL in case of an error (with @error set). Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO a NVMe controller device (e.g. `/dev/nvme0`) 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. 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 a NVMe controller device (e.g. `/dev/nvme0`) 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. health log data or %NULL in case of an error (with @error set). Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_INFO a NVMe controller device (e.g. `/dev/nvme0`) whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation (#BDNVMETechMode) for @tech 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. %TRUE if the format command finished successfully, %FALSE otherwise with @error set. Tech category: %BD_NVME_TECH_NVME-%BD_NVME_TECH_MODE_MANAGE NVMe namespace or controller device to format (e.g. `/dev/nvme0n1`) the sanitize action to perform. instruct the controller to not deallocate the affected media area. number of overwrite passes [1-15] or 0 for the default (16 passes). a 32-bit pattern used for the Overwrite sanitize operation. invert the overwrite pattern between passes. A string representation of @result for use as an identifier string or %NULL when the code is unknown. A %BDNVMESelfTestResult. Writes the Host ID value to the system `/etc/nvme/hostid` file. No validation of the string is performed. %TRUE if the value was set successfully or %FALSE otherwise with @error set. Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR The Host ID. Writes the Host NQN (NVM Qualified Name) value to the system `/etc/nvme/hostnqn` file. No validation of the string is performed. %TRUE if the value was set successfully or %FALSE otherwise with @error set. Tech category: %BD_NVME_TECH_FABRICS-%BD_NVME_TECH_MODE_INITIATOR The Host NVM Qualified Name. specification of the created partition or %NULL in case of error NOTE: The resulting partition may start at a different position than given by @start and can have different size than @size due to alignment. Tech category: %BD_PART_TECH_MODE_MODIFY_TABLE + the tech according to the partition table type disk to create partition on type of the partition to create (if %BD_PART_TYPE_REQ_NEXT, the partition type will be determined automatically based on the existing partitions) where the partition should start (i.e. offset from the disk start) desired size of the partition (if 0, a max-sized partition is created) alignment to use for the partition whether the partition table was successfully created or not Tech category: %BD_PART_TECH_MODE_CREATE_TABLE + the tech according to @type path of the disk block device to create partition table on type of the partition table to create whether to ignore/overwrite the existing table or not (reports an error if %FALSE and there's some table on @disk) whether the @part partition was successfully deleted from @disk Tech category: %BD_PART_TECH_MODE_MODIFY_TABLE + the tech according to the partition table type disk to remove the partition from partition to remove spec of the best free region on @disk for a new partition of type @type with the size of @size or %NULL if there is none such region or if there was an error (@error gets populated) Note: For the @type %BD_PART_TYPE_NORMAL, the smallest possible space that *is not* in an extended partition is found. For the @type %BD_PART_TYPE_LOGICAL, the smallest possible space that *is* in an extended partition is found. For %BD_PART_TYPE_EXTENDED, the biggest possible space is found as long as there is no other extended partition (there can only be one). Tech category: %BD_PART_TECH_MODE_QUERY_TABLE + the tech according to the partition table type disk to get the best free region for type of the partition that is planned to be added size of the partition to be added specs of the free regions from @disk or %NULL in case of error Tech category: %BD_PART_TECH_MODE_QUERY_TABLE + the tech according to the partition table type disk to get free regions for specs of the partitions from @disk or %NULL in case of error Tech category: %BD_PART_TECH_MODE_QUERY_TABLE + the tech according to the partition table type disk to get information about partitions for information about the given @disk or %NULL (in case of error) Tech category: %BD_PART_TECH_MODE_QUERY_TABLE + the tech according to the partition table type disk to get information about spec of the partition from @disk spanning over the @position or %NULL if no such partition exists or in case of error (@error is set) Tech category: %BD_PART_TECH_MODE_QUERY_PART + the tech according to the partition table type disk to remove the partition from position (in bytes) determining the partition spec of the @part partition from @disk or %NULL in case of error Tech category: %BD_PART_TECH_MODE_QUERY_PART + the tech according to the partition table type disk to remove the partition from partition to get spec for string representation of @table_type Tech category: the tech according to @type table type to get string representation for string representation of @type Tech category: always available type to get string representation for whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation (#BDPartTechMode) for @tech whether the @part partition was successfully resized on @disk to @size NOTE: The resulting partition may be slightly bigger than requested due to alignment. Tech category: %BD_PART_TECH_MODE_MODIFY_TABLE + the tech according to the partition table type disk containing the partition partition to resize new partition size, 0 for maximal size alignment to use for the partition end whether the @attrs GPT attributes were successfully set for @part or not Tech category: %BD_PART_TECH_GPT-%BD_PART_TECH_MODE_MODIFY_PART device the partition belongs to partition the attributes should be set for GPT attributes to set on @part whether the @bootable flag was successfully set for @part or not Tech category: %BD_PART_TECH_MBR-%BD_PART_TECH_MODE_MODIFY_PART device the partition belongs to partition the bootable flag should be set for whether to set or unset the bootable flag whether the @part_id type was successfully set for @part or not Tech category: %BD_PART_TECH_MBR-%BD_PART_TECH_MODE_MODIFY_PART device the partition belongs to partition the ID should be set for partition Id whether the name was successfully set or not Tech category: %BD_PART_TECH_GPT-%BD_PART_TECH_MODE_MODIFY_PART device the partition belongs to partition the name should be set for name to set whether the @type_guid type was successfully set for @part or not Tech category: %BD_PART_TECH_GPT-%BD_PART_TECH_MODE_MODIFY_PART device the partition belongs to partition the type should be set for GUID of the type whether the @uuid type was successfully set for @part or not Tech category: %BD_PART_TECH_MODE_MODIFY_PART + the tech according to the partition table type device the partition belongs to partition the UUID should be set for partition UUID to set whether the library was successfully initialized or not If @reload is %TRUE all the plugins are closed and reloaded otherwise only the missing plugins are loaded. %NULL-terminated list of plugins that should be loaded (if no so_name is specified for the plugin, the default is used) or %NULL to load all plugins whether to reload the already loaded plugins or not logging function to use or %NULL to keep the old one whether @label is a valid label for swap or not (reason is provided in @error) Tech category: always available label to check whether @uuid is a valid UUID for swap or not (reason is provided in @error) Tech category: always available UUID to check whether the @tech-@mode combination is available -- supported by the plugin implementation and having all the runtime dependencies available the queried tech a bit mask of queried modes of operation (#BDSwapTechMode) for @tech whether the swap space was successfully created or not Tech category: %BD_SWAP_TECH_SWAP-%BD_SWAP_TECH_MODE_CREATE a device to create swap space on a label for the swap space device UUID for the swap space device extra options for the creation (right now passed to the 'mkswap' utility) whether the label was successfully set or not Tech category: %BD_SWAP_TECH_SWAP-%BD_SWAP_TECH_MODE_SET_LABEL a device to set label on label that will be set whether the UUID was successfully set or not Tech category: %BD_SWAP_TECH_SWAP-%BD_SWAP_TECH_MODE_SET_UUID a device to set UUID on UUID that will be set whether the swap device was successfully deactivated or not Tech category: %BD_SWAP_TECH_SWAP-%BD_SWAP_TECH_MODE_ACTIVATE_DEACTIVATE swap device to deactivate whether the swap device was successfully activated or not Tech category: %BD_SWAP_TECH_SWAP-%BD_SWAP_TECH_MODE_ACTIVATE_DEACTIVATE swap device to activate priority of the activated device or -1 to use the default %TRUE if the swap device is active, %FALSE if not active or failed to determine (@error) is set not a non-NULL value in such case) Tech category: %BD_SWAP_TECH_SWAP-%BD_SWAP_TECH_MODE_QUERY swap device to get status of whether the library was successfully initialized with all the required or default (see @require_plugins) plugins or not *UNLIKE IN CASE OF bd_init() AND bd_ensure_init(), FAILURE TO LOAD A PLUGIN IS NOT CONSIDERED ERROR* %NULL-terminated list of plugins that should be loaded (if no so_name is specified for the plugin, the default is used) or %NULL to load all plugins logging function to use names of the successfully loaded plugins whether the library was successfully initialized or not If @reload is %TRUE all the plugins are closed and reloaded otherwise only the missing plugins are loaded. *UNLIKE IN CASE OF bd_init() AND bd_ensure_init(), FAILURE TO LOAD A PLUGIN IS NOT CONSIDERED ERROR* %NULL-terminated list of plugins that should be loaded (if no so_name is specified for the plugin, the default is used) or %NULL to load all plugins whether to reload the already loaded plugins or not logging function to use or %NULL to keep the old one names of the successfully loaded plugins Checks whether the currently running linux kernel version is equal or higher than the specified required @major.@minor.@micro version. an integer less than, equal to, or greater than zero, if detected version is <, == or > than the specified @major.@minor.@micro version. Minimal major linux kernel version. Minimal minor linux kernel version. Minimal micro linux kernel version. whether the @util is available in a version >= @version or not (@error is set in such case). name of the utility to check minimum required version of the utility or %NULL if no version is required argument to use with the @util to get version info or %NULL to use "--version" regexp to extract version from the version info or %NULL if only version is printed by "$ @util @version_arg" whether the service was found in the system existing GDBusConnection or %NULL bus type (system or session), ignored if @connection is specified name of the service to check (e.g. "com.redhat.lvmdbus1") object path prefix for the service (e.g. "/com/redhat/lvmdbus1") whether the @str was successfully written to @file_path or not. string to write to @file_path path to file Note that any NULL bytes read from standard output and standard error output will be discarded. whether the @argv was successfully executed capturing the output or not the argv array for the call extra arguments variable to store output to whether the @argv was successfully executed (no error and exit code 0) or not the argv array for the call extra arguments whether the @argv was successfully executed (no error and exit code 0) or not the argv array for the call extra arguments Note that any NULL bytes read from standard output and standard error output are treated as separators similar to newlines and @prog_extract will be called with the respective chunk. whether the @argv was successfully executed (no error and exit code 0) or not the argv array for the call extra arguments function for extracting progress information place to store the process exit status whether the @argv was successfully executed (no error and exit code 0) or not the argv array for the call extra arguments place to store the status whether the @argv was successfully executed (no error and exit code 0) or not the argv array for the call input for the executed program extra arguments a list of all symlinks (known to udev) for the device specified with @dev_spec or %NULL in case of error specification of the device (e.g. "/dev/sda", any symlink, or the name of a file under "/dev") Retrieves version of currently running Linux kernel. Acts also as an initializer for statically cached data. Detected Linux kernel version or %NULL in case of an error. The returned value belongs to the library, do not free. whether the @module_name was found in the system, either as a module or built-in in the kernel name of the kernel module to check whether logging was successfully initialized or not logging function to use or %NULL to disable logging; use #bd_utils_log_stdout to reset to the default behaviour whether progress reporting was successfully initialized or not progress reporting function to use or %NULL to reset to default whether progress reporting was successfully initialized or not progress reporting function to use on current thread or %NULL to reset to default or global whether the @module_name was successfully loaded or not name of the kernel module to load module options log level log message log level printf-style format for the log message arguments for @format Convenient function for logging to stdout. Can be used as #BDUtilsLogFunc. log level log message ID of the task the status of which is being logged log message whether progress reporting for the current thread was successfully muted (deinitialized even in presence of a global reporting function) or not TRUE if progress reporting has been initialized, i.e. a reporting function was set up with either bd_utils_init_prog_reporting or bd_utils_init_prog_reporting_thread (takes precedence). FALSE if bd_utils_mute_prog_reporting_thread was used to mute the thread. ID of the task/action message describing the status of the task/action ID of the task/action percentage of completion message describing the status of the task/action ID of the started task/action message describing the started task/action the full real path of the device (e.g. "/dev/md126" for "/dev/md/my_raid") or %NULL in case of error specification of the device (e.g. "/dev/sda", any symlink, or the name of a file under "/dev") Level of messages to log. Only messages with level <= @level will be logged. For example using with #BD_UTILS_LOG_WARNING (default value) only messages with log levels #BD_UTILS_LOG_WARNING, #BD_UTILS_LOG_ERR, ..., #BD_UTILS_LOG_EMERG will be logged. Note: #BD_UTILS_LOG_DEBUG level messages are always skipped unless compiled with `--enable-debug` configure option. log level whether the @module_name was successfully unloaded or not name of the kernel module to unload -1, 0 or 1 if @ver_string1 is lower, the same or higher version as @ver_string2 respectively. If an error occurs, returns -2 and @error is set. **ONLY SUPPORTS VERSION STRINGS OF FORMAT `X[.Y[.Z[.Z2[.Z3...[-R]]]]]` where all components are natural numbers!** first version string second version string