A chroot stored on an BTRFS logical volume (LV). More...
#include <sbuild-chroot-btrfs-snapshot.h>
Public Member Functions | |
virtual | ~chroot_btrfs_snapshot () |
The destructor. | |
virtual chroot::ptr | clone () const |
Copy the chroot. | |
virtual chroot::ptr | clone_session (std::string const &session_id, std::string const &user, bool root) const |
Create a session chroot. | |
virtual chroot::ptr | clone_source () const |
Create a source chroot. | |
std::string const & | get_source_subvolume () const |
Get the source subvolume path. | |
void | set_source_subvolume (std::string const &source_subvolume) |
Set the source subvolume path. | |
std::string const & | get_snapshot_directory () const |
Get the snapshot directory. | |
void | set_snapshot_directory (std::string const &snapshot_directory) |
Set the snapshot directory. | |
std::string const & | get_snapshot_name () const |
Get the snapshot name. | |
void | set_snapshot_name (std::string const &snapshot_name) |
Set the snapshot name. | |
virtual std::string const & | get_chroot_type () const |
Get the type of the chroot. | |
virtual std::string | get_path () const |
Get the path to the chroot. | |
virtual void | setup_env (chroot const &chroot, environment &env) const |
Set environment. | |
virtual session_flags | get_session_flags (chroot const &chroot) const |
Get the session flags of the chroot. | |
Protected Member Functions | |
chroot_btrfs_snapshot () | |
The constructor. | |
chroot_btrfs_snapshot (const chroot_btrfs_snapshot &rhs) | |
The copy constructor. | |
virtual void | setup_lock (chroot::setup_type type, bool lock, int status) |
Unlock a chroot during setup. | |
virtual void | get_details (chroot const &chroot, format_detail &detail) const |
Get detailed information about the chroot for output. | |
virtual void | get_keyfile (chroot const &chroot, keyfile &keyfile) const |
Copy the chroot properties into a keyfile. | |
virtual void | set_keyfile (chroot &chroot, keyfile const &keyfile, string_list &used_keys) |
Set the chroot properties from a keyfile. | |
Private Attributes | |
std::string | source_subvolume |
Btrfs source subvolume. | |
std::string | snapshot_directory |
Btrfs snapshot path. | |
std::string | snapshot_name |
Btrfs snapshot name. | |
Friends | |
class | chroot |
A chroot stored on an BTRFS logical volume (LV).
A snapshot LV will be created and mounted on demand.
chroot_btrfs_snapshot::chroot_btrfs_snapshot | ( | ) | [protected] |
The constructor.
References sbuild::chroot::add_facet(), and sbuild::chroot_facet_source_clonable::create().
Referenced by clone(), and clone_session().
chroot_btrfs_snapshot::chroot_btrfs_snapshot | ( | const chroot_btrfs_snapshot & | rhs | ) | [protected] |
The copy constructor.
chroot_btrfs_snapshot::~chroot_btrfs_snapshot | ( | ) | [virtual] |
The destructor.
sbuild::chroot::ptr chroot_btrfs_snapshot::clone | ( | ) | const [virtual] |
Copy the chroot.
This is a virtual copy constructor.
Implements sbuild::chroot.
References chroot_btrfs_snapshot().
Referenced by clone_source().
sbuild::chroot::ptr chroot_btrfs_snapshot::clone_session | ( | std::string const & | session_id, | |
std::string const & | user, | |||
bool | root | |||
) | const [virtual] |
Create a session chroot.
session_id | the identifier for the new session. | |
user | the user creating the session. | |
root | true if the user has root access, otherwise false. |
Implements sbuild::chroot.
References chroot_btrfs_snapshot().
sbuild::chroot::ptr chroot_btrfs_snapshot::clone_source | ( | ) | const [virtual] |
std::string const & chroot_btrfs_snapshot::get_chroot_type | ( | ) | const [virtual] |
void chroot_btrfs_snapshot::get_details | ( | chroot const & | chroot, | |
format_detail & | detail | |||
) | const [protected, virtual] |
Get detailed information about the chroot for output.
chroot | the chroot to use. | |
detail | the details to output to. |
Implements sbuild::chroot.
References sbuild::_(), sbuild::format_detail::add(), get_snapshot_directory(), get_snapshot_name(), and get_source_subvolume().
void chroot_btrfs_snapshot::get_keyfile | ( | chroot const & | chroot, | |
keyfile & | keyfile | |||
) | const [protected, virtual] |
Copy the chroot properties into a keyfile.
The keyfile group with the name of the chroot will be set; if it already exists, it will be removed before setting it.
chroot | the chroot to use. | |
keyfile | the keyfile to use. |
Implements sbuild::chroot.
References sbuild::chroot::get_active(), sbuild::chroot::get_keyfile_name(), get_snapshot_directory(), get_snapshot_name(), get_source_subvolume(), and sbuild::basic_keyfile< K, P >::set_object_value().
std::string chroot_btrfs_snapshot::get_path | ( | ) | const [virtual] |
Get the path to the chroot.
This is the absolute path to the root of the chroot, and is typically the same as the mount location and location concatenated together, but is overridden by the chroot type if required.
Implements sbuild::chroot.
References sbuild::chroot::get_mount_location().
sbuild::chroot::session_flags chroot_btrfs_snapshot::get_session_flags | ( | chroot const & | chroot | ) | const [virtual] |
Get the session flags of the chroot.
These determine how the Session controlling the chroot will operate.
chroot | the chroot to use. |
Implements sbuild::chroot.
References sbuild::chroot::get_active(), sbuild::chroot::SESSION_NOFLAGS, and sbuild::chroot::SESSION_PURGE.
std::string const & chroot_btrfs_snapshot::get_snapshot_directory | ( | ) | const |
Get the snapshot directory.
References snapshot_directory.
Referenced by get_details(), get_keyfile(), and setup_env().
std::string const & chroot_btrfs_snapshot::get_snapshot_name | ( | ) | const |
Get the snapshot name.
This is used by "btrfs subvolume snapshot", and is the full path to the snapshot.
References snapshot_name.
Referenced by get_details(), get_keyfile(), and setup_env().
std::string const & chroot_btrfs_snapshot::get_source_subvolume | ( | ) | const |
Get the source subvolume path.
This is used by "btrfs subvolume snapshot".
References source_subvolume.
Referenced by get_details(), get_keyfile(), and setup_env().
void chroot_btrfs_snapshot::set_keyfile | ( | chroot & | chroot, | |
keyfile const & | keyfile, | |||
string_list & | used_keys | |||
) | [protected, virtual] |
Set the chroot properties from a keyfile.
The chroot name must have previously been set, so that the correct keyfile group may be determined.
chroot | the chroot to use. | |
keyfile | the keyfile to get the properties from. | |
used_keys | a list of the keys used will be set. |
Implements sbuild::chroot.
References sbuild::chroot::get_active(), sbuild::chroot::get_keyfile_name(), sbuild::basic_keyfile< K, P >::get_object_value(), sbuild::keyfile_base::PRIORITY_DISALLOWED, sbuild::keyfile_base::PRIORITY_REQUIRED, set_snapshot_directory(), set_snapshot_name(), and set_source_subvolume().
void chroot_btrfs_snapshot::set_snapshot_directory | ( | std::string const & | snapshot_directory | ) |
Set the snapshot directory.
snapshot_directory | the snapshot directory. |
References sbuild::chroot::DIRECTORY_ABS, sbuild::is_absname(), and source_subvolume.
Referenced by set_keyfile().
void chroot_btrfs_snapshot::set_snapshot_name | ( | std::string const & | snapshot_name | ) |
Set the snapshot name.
This is used by "btrfs subvolume snapshot", and is the full path to the snapshot.
snapshot_name | the snapshot name. |
References sbuild::chroot::DIRECTORY_ABS, sbuild::is_absname(), and source_subvolume.
Referenced by set_keyfile().
void chroot_btrfs_snapshot::set_source_subvolume | ( | std::string const & | source_subvolume | ) |
Set the source subvolume path.
This is used by "btrfs subvolume snapshot".
source_subvolume | the source subvolume. |
References sbuild::chroot::DIRECTORY_ABS, and sbuild::is_absname().
Referenced by set_keyfile().
void chroot_btrfs_snapshot::setup_env | ( | chroot const & | chroot, | |
environment & | env | |||
) | const [virtual] |
Set environment.
Set the environment that the setup scripts will see during execution.
chroot | the chroot to use. | |
env | the environment to set. |
Implements sbuild::chroot.
References sbuild::environment::add(), get_snapshot_directory(), get_snapshot_name(), and get_source_subvolume().
void chroot_btrfs_snapshot::setup_lock | ( | chroot::setup_type | type, | |
bool | lock, | |||
int | status | |||
) | [protected, virtual] |
Unlock a chroot during setup.
The locking technique (if any) may vary depending upon the chroot type and setup stage. For example, during creation of an LVM snapshot a block device might require locking, but afterwards this will change to the new block device.
An error will be thrown on failure.
type | the type of setup being performed | |
lock | true to lock, false to unlock | |
status | the exit status of the setup commands (0 for success, nonzero for failure). |
Implements sbuild::chroot.
References sbuild::chroot::setup_session_info(), sbuild::chroot::SETUP_START, and sbuild::chroot::SETUP_STOP.
friend class chroot [friend] |
std::string sbuild::chroot_btrfs_snapshot::snapshot_directory [private] |
Btrfs snapshot path.
Referenced by get_snapshot_directory().
std::string sbuild::chroot_btrfs_snapshot::snapshot_name [private] |
Btrfs snapshot name.
Referenced by get_snapshot_name().
std::string sbuild::chroot_btrfs_snapshot::source_subvolume [private] |
Btrfs source subvolume.
Referenced by get_source_subvolume(), set_snapshot_directory(), and set_snapshot_name().