Top |
UDisksState * | udisks_state_new () |
void | udisks_state_start_cleanup () |
void | udisks_state_stop_cleanup () |
void | udisks_state_check () |
void | udisks_state_check_sync () |
void | udisks_state_check_block () |
UDisksDaemon * | udisks_state_get_daemon () |
void | udisks_state_add_mounted_fs () |
gchar * | udisks_state_find_mounted_fs () |
void | udisks_state_add_unlocked_crypto_dev () |
dev_t | udisks_state_find_unlocked_crypto_dev () |
void | udisks_state_add_loop () |
gboolean | udisks_state_has_loop () |
void | udisks_state_add_mdraid () |
gboolean | udisks_state_has_mdraid () |
void | udisks_state_add_module () |
void | udisks_state_clear_modules () |
gchar ** | udisks_state_get_modules () |
This type is used for recording actions done by users and cleaning up when devices set up via the udisks interfaces are removed while still in use - for example, a USB stick being yanked.
The following files are used:
Table 3. Persistent information and state
File | Usage |
---|---|
/run/udisks2/mounted-fs |
A serialized 'a{sa{sv}}' GVariant mapping from the
mount point (e.g. /media/EOS_DIGITAL ) into a set of details.
Known details include
block-device
(of type 't') that is the dev_t
for the mounted device,
mounted-by-uid
(of type 'u') that is the uid_t
of the user who mounted the device, and
fstab-mount
(of type 'b') that is TRUE
if the device was mounted via an entry in /etc/fstab.
Contains only non-persistent mount points. This state file is typically stored on
a non-persistent filesystem.
|
/var/lib/udisks2/mounted-fs-persistent |
Similar in contents and data structure to /run/udisks2/mounted-fs
except that only persistent mount points are stored there. This state file is
typically stored on a persistent filesystem.
|
/run/udisks2/unlocked-crypto-dev |
A serialized 'a{ta{sv}}' GVariant mapping from the
dev_t of the clear-text device (e.g. /dev/dm-0 ) into a set of details.
Known details include
crypto-device
(of type 't') that is the dev_t
for the crypto-text device,
dm-uuid
(of type 'ay') that is the device mapper UUID
for the clear-text device and
unlocked-by-uid
(of type 'u') that is the uid_t
of the user who unlocked the device.
|
/run/udisks2/loop |
A serialized 'a{sa{sv}}' GVariant mapping from the
loop device name (e.g. /dev/loop0 ) into a set of details.
Known details include
backing-file
(of type 'ay') for the name of the backing file and
backing-file-device
(of type 't') for the dev_t
for of the device holding the backing file (or 0 if unknown) and
setup-by-uid
(of type 'u') that is the uid_t
of the user who set up the loop device.
|
/run/udisks2/mdraid |
A serialized 'a{ta{sv}}' GVariant mapping from the
dev_t of the raid device (e.g. /dev/md127 ) into a set of details.
Known details include
started-by-uid
(of type 'u') that is the uid_t
of the user who started the array.
|
/run/udisks2/modules |
A serialized 'a{sa{sv}}' GVariant mapping from the
module name (e.g. lvm2 ) into a set of details.
No details are defined at this point, reserved for future use.
Contains currently active module names primarily for the purpose
of crash recovery upon next daemon start.
|
Cleaning up is implemented by running a thread (to ensure that
actions are serialized) that checks all data in the files mentioned
above and cleans up the entry in question by e.g. unmounting a
filesystem, removing a mount point or tearing down a device-mapper
device when needed. The clean-up thread itself needs to be manually
kicked using e.g. udisks_state_check()
from suitable places in
the UDisksDaemon and UDisksProvider implementations.
Since cleaning up is only necessary when a device has been removed without having been properly stopped or shut down, the fact that it was cleaned up is logged to ensure that the information is brought to the attention of the system administrator.
UDisksState *
udisks_state_new (UDisksDaemon *daemon
);
Creates a new UDisksState object.
void
udisks_state_start_cleanup (UDisksState *state
);
Starts the clean-up thread.
The clean-up thread will hold a reference to state
for as long as
it's running - use udisks_state_stop_cleanup()
to stop it.
void
udisks_state_stop_cleanup (UDisksState *state
);
Stops the clean-up thread. Blocks the calling thread until it has stopped.
void
udisks_state_check (UDisksState *state
);
Causes the clean-up thread for state
to check if anything should be cleaned up.
This can be called from any thread and will not block the calling thread.
void
udisks_state_check_sync (UDisksState *state
);
Causes the clean-up thread for state
to check if anything should be cleaned up and perform the cleanup.
This can be called from any thread and in contrast to udisks_state_check()
will block the calling thread until cleanup is finished.
void udisks_state_check_block (UDisksState *state
,dev_t block_device
);
Performs cleanup of a mounted filesystem over a single block device. In case the clean-up thread is busy, waits until the current iteration is finished.
This can be called from any thread and will block the calling thread until cleanup is finished. Note that this ignores UDisksLinuxBlockObject cleanup lock that is supposed to be held by the caller.
UDisksDaemon *
udisks_state_get_daemon (UDisksState *state
);
Gets the daemon used by state
.
void udisks_state_add_mounted_fs (UDisksState *state
,const gchar *mount_point
,dev_t block_device
,uid_t uid
,gboolean fstab_mount
,gboolean persistent
);
Adds a new entry to the
/run/udisks2/mounted-fs
file.
state |
A UDisksState. |
|
block_device |
The block device. |
|
mount_point |
The mount point. |
|
uid |
The user id of the process requesting the device to be mounted. |
|
fstab_mount |
|
|
persistent |
|
gchar * udisks_state_find_mounted_fs (UDisksState *state
,dev_t block_device
,uid_t *out_uid
,gboolean *out_fstab_mount
);
Gets the mount point for block_device
, if it exists in the
/run/udisks2/mounted-fs
file.
state |
A UDisksState. |
|
block_device |
The block device. |
|
out_uid |
Return location for the user id who mounted the device or |
|
out_fstab_mount |
Return location for whether the device was a fstab mount or |
void udisks_state_add_unlocked_crypto_dev (UDisksState *state
,dev_t cleartext_device
,dev_t crypto_device
,const gchar *dm_uuid
,uid_t uid
);
Adds a new entry to the
/run/udisks2/unlocked-crypto-dev
file.
state |
A UDisksState. |
|
cleartext_device |
The clear-text device. |
|
crypto_device |
The crypto device. |
|
dm_uuid |
The UUID of the unlocked dm device. |
|
uid |
The user id of the process requesting the device to be unlocked. |
dev_t udisks_state_find_unlocked_crypto_dev (UDisksState *state
,dev_t crypto_device
,uid_t *out_uid
);
Gets the clear-text device for crypto_device
, if it exists in the
/run/udisks2/unlocked-crypto-dev
file.
state |
A UDisksState. |
|
crypto_device |
The block device. |
|
out_uid |
Return location for the user id who mounted the device or |
void udisks_state_add_loop (UDisksState *state
,const gchar *device_file
,const gchar *backing_file
,dev_t backing_file_device
,uid_t uid
);
Adds a new entry to the /run/udisks2/loop
file.
state |
A UDisksState. |
|
device_file |
The loop device file. |
|
backing_file |
The backing file. |
|
backing_file_device |
The dev_t of the backing file or 0 if unknown. |
|
uid |
The user id of the process requesting the loop device. |
gboolean udisks_state_has_loop (UDisksState *state
,const gchar *device_file
,uid_t *out_uid
);
Checks if device_file
is set up via udisks.
void udisks_state_add_mdraid (UDisksState *state
,dev_t raid_device
,uid_t uid
);
Adds a new entry to the /run/udisks2/mdraid
file.
state |
A UDisksState. |
|
raid_device |
The dev_t for the RAID device. |
|
uid |
The user id of the process requesting the loop device. |
gboolean udisks_state_has_mdraid (UDisksState *state
,dev_t raid_device
,uid_t *out_uid
);
Checks if raid_device
is set up via udisks.
void udisks_state_add_module (UDisksState *state
,const gchar *module_name
);
Adds a new entry to the /run/udisks2/modules
file. The module_name
string should be the one returned by
udisks_module_get_name()
.
void
udisks_state_clear_modules (UDisksState *state
);
Removes all entries from the /run/udisks2/modules
state file.
gchar **
udisks_state_get_modules (UDisksState *state
);
Retrieves list of modules recorded in the /run/udisks2/modules
state file.
typedef struct _UDisksState UDisksState;
The UDisksState structure contains only private data and should only be accessed using the provided API.
“daemon”
property“daemon” UDisksDaemon *
The UDisksDaemon object.
Owner: UDisksState
Flags: Read / Write / Construct Only