BDUtilsProgExtract ()

gboolean
(*BDUtilsProgExtract) (const gchar *line,
                       guint8 *completion);

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.

BDUtilsProgFunc ()

void
(*BDUtilsProgFunc) (guint64 task_id,
                    BDUtilsProgStatus status,
                    guint8 completion,
                    gchar *msg);

BDUtilsLogFunc ()

void
(*BDUtilsLogFunc) (gint level,
                   const gchar *msg);

Function type for logging function used by the libblockdev's exec utils to log the information about program executing.

bd_utils_exec_error_quark ()

GQuark
bd_utils_exec_error_quark (void);

[skip]

bd_utils_dev_utils_error_quark ()

GQuark
bd_utils_dev_utils_error_quark (void);

[skip]

bd_utils_exec_and_report_error ()

gboolean
bd_utils_exec_and_report_error (const gchar **argv,
                                const BDExtraArg **extra,
                                GError **error);

bd_utils_exec_and_report_status_error ()

gboolean
bd_utils_exec_and_report_status_error (const gchar **argv,
                                       const BDExtraArg **extra,
                                       gint *status,
                                       GError **error);

bd_utils_exec_and_capture_output ()

gboolean
bd_utils_exec_and_capture_output (const gchar **argv,
                                  const BDExtraArg **extra,
                                  gchar **output,
                                  GError **error);

Note that any NULL bytes read from standard output and standard error output will be discarded.

bd_utils_exec_and_capture_output_no_progress ()

gboolean
bd_utils_exec_and_capture_output_no_progress
                               (const gchar **argv,
                                const BDExtraArg **extra,
                                gchar **output,
                                gchar **stderr,
                                gint *status,
                                GError **error);

bd_utils_exec_and_report_error_no_progress ()

gboolean
bd_utils_exec_and_report_error_no_progress
                               (const gchar **argv,
                                const BDExtraArg **extra,
                                GError **error);

bd_utils_exec_and_report_progress ()

gboolean
bd_utils_exec_and_report_progress (const gchar **argv,
                                   const BDExtraArg **extra,
                                   BDUtilsProgExtract prog_extract,
                                   gint *proc_status,
                                   GError **error);

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.

bd_utils_exec_with_input ()

gboolean
bd_utils_exec_with_input (const gchar **argv,
                          const gchar *input,
                          const BDExtraArg **extra,
                          GError **error);

bd_utils_prog_reporting_initialized ()

gboolean
bd_utils_prog_reporting_initialized (void);

bd_utils_init_logging ()

gboolean
bd_utils_init_logging (BDUtilsLogFunc new_log_func,
                       GError **error);

bd_utils_init_prog_reporting ()

gboolean
bd_utils_init_prog_reporting (BDUtilsProgFunc new_prog_func,
                              GError **error);

bd_utils_init_prog_reporting_thread ()

gboolean
bd_utils_init_prog_reporting_thread (BDUtilsProgFunc new_prog_func,
                                     GError **error);

bd_utils_mute_prog_reporting_thread ()

gboolean
bd_utils_mute_prog_reporting_thread (GError **error);

bd_utils_report_finished ()

void
bd_utils_report_finished (guint64 task_id,
                          const gchar *msg);

bd_utils_report_progress ()

void
bd_utils_report_progress (guint64 task_id,
                          guint64 completion,
                          const gchar *msg);

bd_utils_report_started ()

guint64
bd_utils_report_started (const gchar *msg);

bd_utils_get_next_task_id ()

guint64
bd_utils_get_next_task_id (void);

bd_utils_log_task_status ()

void
bd_utils_log_task_status (guint64 task_id,
                          const gchar *msg);

bd_utils_log ()

void
bd_utils_log (gint level,
              const gchar *msg);

bd_utils_log_format ()

void
bd_utils_log_format (gint level,
                     const gchar *format,
                     ...);

bd_utils_log_stdout ()

void
bd_utils_log_stdout (gint level,
                     const gchar *msg);

Convenient function for logging to stdout. Can be used as BDUtilsLogFunc.

bd_utils_echo_str_to_file ()

gboolean
bd_utils_echo_str_to_file (const gchar *str,
                           const gchar *file_path,
                           GError **error);

bd_utils_set_log_level ()

void
bd_utils_set_log_level (gint level);

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.

bd_utils_check_util_version ()

gboolean
bd_utils_check_util_version (const gchar *util,
                             const gchar *version,
                             const gchar *version_arg,
                             const gchar *version_regexp,
                             GError **error);

Note: Both supplied version and parsed result using version_regexp must be in format X[.Y[.Z[.Z2[.Z3...[-R]]]]] where all components are natural numbers, see bd_utils_version_cmp for details.

bd_utils_version_cmp ()

gint
bd_utils_version_cmp (const gchar *ver_string1,
                      const gchar *ver_string2,
                      GError **error);

bd_extra_arg_new ()

BDExtraArg *
bd_extra_arg_new (const gchar *opt,
                  const gchar *val);

Example of calling bd_fs_xfs_mkfs() with an extra argument. This will result in calling mkfs.xfs with -L label.

1
2
3
4

BDExtraArg label_arg = {"-L", "label"};
const BDExtraArg *extra_args[2] = {&label_arg, NULL};

ret = bd_fs_xfs_mkfs ("/dev/sda", extra_args, error);

[constructor]

bd_extra_arg_copy ()

BDExtraArg *
bd_extra_arg_copy (BDExtraArg *arg);

Creates a new copy of arg .

bd_extra_arg_free ()

void
bd_extra_arg_free (BDExtraArg *arg);

Frees arg .

bd_extra_arg_list_free ()

void
bd_extra_arg_list_free (BDExtraArg **args);

Frees args and all its elements.

bd_extra_arg_get_type ()

GType
bd_extra_arg_get_type (void);

bd_utils_resolve_device ()

gchar *
bd_utils_resolve_device (const gchar *dev_spec,
                         GError **error);

bd_utils_get_device_symlinks ()

gchar **
bd_utils_get_device_symlinks (const gchar *dev_spec,
                              GError **error);

bd_utils_have_kernel_module ()

gboolean
bd_utils_have_kernel_module (const gchar *module_name,
                             GError **error);

bd_utils_load_kernel_module ()

gboolean
bd_utils_load_kernel_module (const gchar *module_name,
                             const gchar *options,
                             GError **error);

bd_utils_unload_kernel_module ()

gboolean
bd_utils_unload_kernel_module (const gchar *module_name,
                               GError **error);

bd_utils_get_linux_version ()

BDUtilsLinuxVersion *
bd_utils_get_linux_version (GError **error);

Retrieves version of currently running Linux kernel. Acts also as an initializer for statically cached data.

bd_utils_check_linux_version ()

gint
bd_utils_check_linux_version (guint major,
                              guint minor,
                              guint micro);

Checks whether the currently running linux kernel version is equal or higher than the specified required major .minor .micro version.

bd_utils_dbus_service_available ()

gboolean
bd_utils_dbus_service_available (GDBusConnection *connection,
                                 GBusType bus_type,
                                 const gchar *bus_name,
                                 const gchar *obj_prefix,
                                 GError **error);

bd_utils_dbus_error_quark ()

GQuark
bd_utils_dbus_error_quark (void);

[skip]

bd_utils_module_error_quark ()

GQuark
bd_utils_module_error_quark (void);

[skip]

enum BDUtilsProgStatus

BD_UTILS_EXEC_ERROR

#define BD_UTILS_EXEC_ERROR bd_utils_exec_error_quark ()

enum BDUtilsExecError

enum BDUtilsDevUtilsError

enum BDUtilsDBusError

enum BDUtilsModuleError

BD_UTILS_DEV_UTILS_ERROR

#define BD_UTILS_DEV_UTILS_ERROR bd_utils_dev_utils_error_quark ()

BD_UTILS_DBUS_ERROR

#define BD_UTILS_DBUS_ERROR bd_utils_dbus_error_quark ()

BD_UTILS_MODULE_ERROR

#define BD_UTILS_MODULE_ERROR bd_utils_module_error_quark ()

BDUtilsLinuxVersion

typedef struct {
    guint major;
    guint minor;
    guint micro;
} BDUtilsLinuxVersion;

BDExtraArg

typedef struct {
    gchar *opt;
    gchar *val;
} BDExtraArg;

See bd_extra_arg_new() for an example on how to construct the extra args.

EXBIBYTE

#define EXBIBYTE *1024ULL PEBIBYTE

EiB

#define EiB EXBIBYTE

GIBIBYTE

#define GIBIBYTE *1024ULL MEBIBYTE

GiB

#define GiB GIBIBYTE

KIBIBYTE

#define KIBIBYTE *1024ULL

KiB

#define KiB KIBIBYTE

MEBIBYTE

#define MEBIBYTE *1024ULL KIBIBYTE

MiB

#define MiB MEBIBYTE

PEBIBYTE

#define PEBIBYTE *1024ULL TEBIBYTE

PiB

#define PiB PEBIBYTE

TEBIBYTE

#define TEBIBYTE *1024ULL GIBIBYTE

TiB

#define TiB TEBIBYTE

EB

#define EB EXABYTE

EXABYTE

#define EXABYTE *1000ULL PETABYTE

GB

#define GB GIGABYTE

GIGABYTE

#define GIGABYTE *1000ULL MEGABYTE

KB

#define KB KILOBYTE

KILOBYTE

#define KILOBYTE *1000ULL

MB

#define MB MEGABYTE

MEGABYTE

#define MEGABYTE *1000ULL KILOBYTE

PB

#define PB PETABYTE

PETABYTE

#define PETABYTE *1000ULL TERABYTE

TB

#define TB TERABYTE

TERABYTE

#define TERABYTE *1000ULL GIGABYTE

BD_UTILS_LOG_EMERG

#define BD_UTILS_LOG_EMERG   0

BD_UTILS_LOG_ALERT

#define BD_UTILS_LOG_ALERT   1

BD_UTILS_LOG_CRIT

#define BD_UTILS_LOG_CRIT    2

BD_UTILS_LOG_ERR

#define BD_UTILS_LOG_ERR     3

BD_UTILS_LOG_WARNING

#define BD_UTILS_LOG_WARNING 4

BD_UTILS_LOG_NOTICE

#define BD_UTILS_LOG_NOTICE  5

BD_UTILS_LOG_INFO

#define BD_UTILS_LOG_INFO    6

BD_UTILS_LOG_DEBUG

#define BD_UTILS_LOG_DEBUG   7