DeviceMapper

DeviceMapper — plugin for basic operations with device mapper

Synopsis

#include <dm.h>

gboolean            bd_dm_check_deps                    ();
void                bd_dm_close                         ();
gboolean            bd_dm_init                          ();
GQuark              bd_dm_error_quark                   (void);
#define             BD_DM_ERROR
enum                BDDMError;
gboolean            bd_dm_create_linear                 (const gchar *map_name,
                                                         const gchar *device,
                                                         guint64 length,
                                                         const gchar *uuid,
                                                         GError **error);
gboolean            bd_dm_remove                        (const gchar *map_name,
                                                         GError **error);
gchar *             bd_dm_name_from_node                (const gchar *dm_node,
                                                         GError **error);
gchar *             bd_dm_node_from_name                (const gchar *map_name,
                                                         GError **error);
gboolean            bd_dm_map_exists                    (const gchar *map_name,
                                                         gboolean live_only,
                                                         gboolean active_only,
                                                         GError **error);
gchar **            bd_dm_get_member_raid_sets          (const gchar *name,
                                                         const gchar *uuid,
                                                         gint major,
                                                         gint minor,
                                                         GError **error);
gboolean            bd_dm_activate_raid_set             (const gchar *name,
                                                         GError **error);
gboolean            bd_dm_deactivate_raid_set           (const gchar *name,
                                                         GError **error);
gchar *             bd_dm_get_raid_set_type             (const gchar *name,
                                                         GError **error);

Description

A plugin for basic operations with device mapper.

Details

bd_dm_check_deps ()

gboolean            bd_dm_check_deps                    ();

Returns :

 whether the plugin's runtime dependencies are satisfied or not Function checking plugin's runtime dependencies.

bd_dm_close ()

void                bd_dm_close                         ();

Cleans up after the plugin. **This function is called automatically by the library's functions that unload it.**

bd_dm_init ()

gboolean            bd_dm_init                          ();

Initializes the plugin. **This function is called automatically by the library's initialization functions.**

bd_dm_error_quark ()

GQuark              bd_dm_error_quark                   (void);

BD_DM_ERROR

#define             BD_DM_ERROR

enum BDDMError

typedef enum {
    BD_DM_ERROR_SYS,
    BD_DM_ERROR_NOT_ROOT,
    BD_DM_ERROR_TASK,
    BD_DM_ERROR_RAID_FAIL,
    BD_DM_ERROR_RAID_NO_DEVS,
    BD_DM_ERROR_RAID_NO_EXIST,
} BDDMError;

BD_DM_ERROR_SYS

BD_DM_ERROR_NOT_ROOT

BD_DM_ERROR_TASK

BD_DM_ERROR_RAID_FAIL

BD_DM_ERROR_RAID_NO_DEVS

BD_DM_ERROR_RAID_NO_EXIST

bd_dm_create_linear ()

gboolean            bd_dm_create_linear                 (const gchar *map_name,
                                                         const gchar *device,
                                                         guint64 length,
                                                         const gchar *uuid,
                                                         GError **error);

map_name :

 name of the map

device :

 device to create map for

length :

 length of the mapping in sectors

uuid :

 UUID for the new dev mapper device or NULL if not specified. [allow-none]

error :

 place to store error (if any). [out]

Returns :

 whether the new linear mapping map_name was successfully created for the device or not

bd_dm_remove ()

gboolean            bd_dm_remove                        (const gchar *map_name,
                                                         GError **error);

map_name :

 name of the map to remove

error :

 place to store error (if any). [out]

Returns :

 whether the map_name map was successfully removed or not

bd_dm_name_from_node ()

gchar *             bd_dm_name_from_node                (const gchar *dm_node,
                                                         GError **error);

dm_node :

 name of the DM node (e.g. "dm-0")

error :

 place to store error (if any). [out]

Returns :

 map name of the map providing the dm_node device or NULL (error) contains the error in such cases)

bd_dm_node_from_name ()

gchar *             bd_dm_node_from_name                (const gchar *map_name,
                                                         GError **error);

map_name :

 name of the queried DM map

error :

 place to store error (if any). [out]

Returns :

 DM node name for the map_name map or NULL (error) contains the error in such cases)

bd_dm_map_exists ()

gboolean            bd_dm_map_exists                    (const gchar *map_name,
                                                         gboolean live_only,
                                                         gboolean active_only,
                                                         GError **error);

map_name :

 name of the queried map

live_only :

 whether to go through the live maps only or not

active_only :

 whether to ignore suspended maps or not

error :

 place to store error (if any). [out]

Returns :

 whether the given map_name exists (and is live if live_only is TRUE (and is active if active_only is TRUE)).

bd_dm_get_member_raid_sets ()

gchar **            bd_dm_get_member_raid_sets          (const gchar *name,
                                                         const gchar *uuid,
                                                         gint major,
                                                         gint minor,
                                                         GError **error);

name :

 name of the member. [allow-none]

uuid :

 uuid of the member. [allow-none]

major :

 major number of the device or -1 if not specified

minor :

 minor number of the device or -1 if not specified

error :

 variable to store error (if any). [out]

Returns :

 list of names of the RAID sets related to the member or NULL in case of error One of name, uuid or major:minor has to be given. [transfer full][array zero-terminated=1]

bd_dm_activate_raid_set ()

gboolean            bd_dm_activate_raid_set             (const gchar *name,
                                                         GError **error);

name :

 name of the DM RAID set to activate

error :

 variable to store error (if any). [out]

Returns :

 whether the RAID set name was successfully activate or not

bd_dm_deactivate_raid_set ()

gboolean            bd_dm_deactivate_raid_set           (const gchar *name,
                                                         GError **error);

name :

 name of the DM RAID set to deactivate

error :

 variable to store error (if any). [out]

Returns :

 whether the RAID set name was successfully deactivate or not

bd_dm_get_raid_set_type ()

gchar *             bd_dm_get_raid_set_type             (const gchar *name,
                                                         GError **error);

name :

 name of the DM RAID set to get the type of

error :

 variable to store error (if any). [out]

Returns :

 string representation of the name RAID set's type
Generated by GTK-Doc V1.19