Top | ![]() |
![]() |
![]() |
![]() |
gboolean bd_vdo_init ();
Initializes the plugin. **This function is called automatically by the library's initialization functions.**
void
bd_vdo_close ();
Cleans up after the plugin. **This function is called automatically by the library's functions that unload it.**
const gchar * bd_vdo_get_write_policy_str (BDVDOWritePolicy policy
,GError **error
);
policy |
policy to get the string representation for |
|
error |
place to store error (if any). |
[out] |
string representation of policy
or NULL
in case of error
Tech category: always provided/supported
BDVDOWritePolicy bd_vdo_get_write_policy_from_str (const gchar *policy_str
,GError **error
);
BDVDOInfo * bd_vdo_info (const gchar *name
,GError **error
);
information about the VDO volume or NULL
in case of error (error
gets populated in those cases)
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_QUERY
.
[transfer full]
gboolean bd_vdo_create (const gchar *name
,const gchar *backing_device
,guint64 logical_size
,guint64 index_memory
,gboolean compression
,gboolean deduplication
,BDVDOWritePolicy write_policy
,const BDExtraArg **extra
,GError **error
);
name |
name for the VDO volume |
|
backing_device |
device to use for VDO storage |
|
logical_size |
logical VDO volume size or 0 for default (size of |
|
index_memory |
amount of index memory or 0 for default; note that only some sizes are valid here (0.25, 0.5 and 0.75 GB and integer multiples of 1 GB) invalid sizes will be rounded DOWN to nearest GB (or one of the allowed decimal values) |
|
compression |
whether to enable compression or not |
|
deduplication |
whether to enable deduplication or not |
|
write_policy |
write policy for the volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the VDO volume was successfully created or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_MODE_CREATE
gboolean bd_vdo_remove (const gchar *name
,gboolean force
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
force |
force remove the volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the VDO volume was successfully removed or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_MODIFY
gboolean bd_vdo_change_write_policy (const gchar *name
,BDVDOWritePolicy write_policy
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
write_policy |
new write policy for the volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the policy was successfully changed or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_MODIFY
gboolean bd_vdo_enable_compression (const gchar *name
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the compression was successfully enabled or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_MODIFY
gboolean bd_vdo_disable_compression (const gchar *name
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the compression was successfully disabled or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_MODIFY
gboolean bd_vdo_enable_deduplication (const gchar *name
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the deduplication was successfully enabled or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_MODIFY
gboolean bd_vdo_disable_deduplication (const gchar *name
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the deduplication was successfully disabled or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_MODIFY
gboolean bd_vdo_activate (const gchar *name
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the VDO volume was successfully activated or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_ACTIVATE_DEACTIVATE
gboolean bd_vdo_deactivate (const gchar *name
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the VDO volume was successfully deactivated or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_ACTIVATE_DEACTIVATE
gboolean bd_vdo_start (const gchar *name
,gboolean rebuild
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
rebuild |
force rebuild the volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the VDO volume was successfully started or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_START_STOP
gboolean bd_vdo_stop (const gchar *name
,gboolean force
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
force |
force stop the volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the VDO volume was successfully stopped or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_START_STOP
gboolean bd_vdo_grow_logical (const gchar *name
,guint64 size
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
size |
new logical size for the volume |
|
extra |
extra options for the VDO creation (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the VDO volume was successfully resized or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_GROW
gboolean bd_vdo_grow_physical (const gchar *name
,const BDExtraArg **extra
,GError **error
);
name |
name of an existing VDO volume |
|
extra |
extra options for the VDO tool (just passed to VDO as is). |
[allow-none][array zero-terminated=1] |
error |
place to store error (if any). |
[out] |
whether the VDO volume was successfully grown or not
Tech category: BD_VDO_TECH_VDO
-BD_VDO_TECH_MODE_GROW
gboolean bd_vdo_is_tech_avail (BDVDOTech tech
,guint64 mode
,GError **error
);
tech |
the queried tech |
|
mode |
a bit mask of queried modes of operation (BDVDOTechMode) for |
|
error |
place to store error (details about why the |
[out] |
typedef struct { gchar *name; gchar *device; gboolean active; gboolean deduplication; gboolean compression; guint64 logical_size; guint64 physical_size; guint64 index_memory; BDVDOWritePolicy write_policy; } BDVDOInfo;
gchar * |
name of the VDO volume |
|
gchar * |
underlying block device |
|
gboolean |
whether the volume is active or not |
|
gboolean |
whether deduplication is enabled |
|
gboolean |
whether compression is enabled |
|
guint64 |
logical size of the volume |
|
guint64 |
sphysical size of the volume |
|
guint64 |
index memory size |
|
write policy of the volume |