sbuild::chroot_lvm_snapshot Class Reference

A chroot stored on an LVM logical volume (LV). More...

#include <sbuild-chroot-lvm-snapshot.h>

Inheritance diagram for sbuild::chroot_lvm_snapshot:

Inheritance graph
[legend]
Collaboration diagram for sbuild::chroot_lvm_snapshot:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~chroot_lvm_snapshot ()
 The destructor.
virtual chroot::ptr clone () const
 Copy the chroot.
virtual chroot::ptr clone_source () const
 Create a source chroot.
std::string const & get_snapshot_device () const
 Get the logical volume snapshot device name.
void set_snapshot_device (std::string const &snapshot_device)
 Set the logical volume snapshot device name.
virtual std::string const & get_mount_device () const
 Get the mount device of the chroot.
std::string const & get_snapshot_options () const
 Get the logical volume snapshot options.
void set_snapshot_options (std::string const &snapshot_options)
 Set the logical volume snapshot options.
virtual std::string const & get_chroot_type () const
 Get the type of the chroot.
virtual void setup_env (environment &env)
 Set environment.
virtual session_flags get_session_flags () const
 Get the session flags of the chroot.

Protected Member Functions

 chroot_lvm_snapshot ()
 The constructor.
virtual void setup_lock (chroot::setup_type type, bool lock, int status)
 Unlock a chroot during setup.
virtual void get_details (format_detail &detail) const
 Get detailed information about the chroot for output.
virtual void get_keyfile (keyfile &keyfile) const
 Copy the chroot properties into a keyfile.
virtual void set_keyfile (keyfile const &keyfile, string_list &used_keys)
 Set the chroot properties from a keyfile.

Private Attributes

std::string snapshot_device
 LVM snapshot device name for lvcreate.
std::string snapshot_options
 LVM snapshot options for lvcreate.

Friends

class chroot


Detailed Description

A chroot stored on an LVM logical volume (LV).

A snapshot LV will be created and mounted on demand.


Constructor & Destructor Documentation

chroot_lvm_snapshot::chroot_lvm_snapshot (  )  [protected]

chroot_lvm_snapshot::~chroot_lvm_snapshot (  )  [virtual]

The destructor.


Member Function Documentation

sbuild::chroot::ptr chroot_lvm_snapshot::clone (  )  const [virtual]

Copy the chroot.

This is a virtual copy constructor.

Returns:
a shared_ptr to the new copy of the chroot.

Reimplemented from sbuild::chroot_block_device.

References chroot_lvm_snapshot().

Referenced by clone_source().

sbuild::chroot::ptr chroot_lvm_snapshot::clone_source (  )  const [virtual]

std::string const & chroot_lvm_snapshot::get_snapshot_device (  )  const

Get the logical volume snapshot device name.

This is used by lvcreate.

Returns:
the device name.

References snapshot_device.

Referenced by get_details(), get_keyfile(), setup_env(), and setup_lock().

void chroot_lvm_snapshot::set_snapshot_device ( std::string const &  snapshot_device  ) 

Set the logical volume snapshot device name.

This is used by lvcreate.

Parameters:
snapshot_device the device name.

References sbuild::chroot::DEVICE_ABS, and sbuild::is_absname().

Referenced by sbuild::session::run_impl(), and set_keyfile().

std::string const & chroot_lvm_snapshot::get_mount_device (  )  const [virtual]

Get the mount device of the chroot.

Returns:
the device.

Reimplemented from sbuild::chroot_block_device.

References snapshot_device.

std::string const & chroot_lvm_snapshot::get_snapshot_options (  )  const

Get the logical volume snapshot options.

These are used by lvcreate.

Returns:
the options.

References snapshot_options.

Referenced by get_details(), get_keyfile(), and setup_env().

void chroot_lvm_snapshot::set_snapshot_options ( std::string const &  snapshot_options  ) 

Set the logical volume snapshot options.

These are used by lvcreate.

Parameters:
snapshot_options the options.

Referenced by set_keyfile().

std::string const & chroot_lvm_snapshot::get_chroot_type (  )  const [virtual]

Get the type of the chroot.

Returns:
the chroot type.

Reimplemented from sbuild::chroot_block_device.

void chroot_lvm_snapshot::setup_env ( environment env  )  [virtual]

sbuild::chroot::session_flags chroot_lvm_snapshot::get_session_flags (  )  const [virtual]

Get the session flags of the chroot.

These determine how the Session controlling the chroot will operate.

Returns:
the session flags.

Reimplemented from sbuild::chroot_block_device.

References sbuild::chroot_source::get_session_flags(), and sbuild::chroot::SESSION_CREATE.

void chroot_lvm_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.

Parameters:
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).

Reimplemented from sbuild::chroot_block_device.

References sbuild::chroot::CHROOT_DEVICE, sbuild::chroot_block_device::device, sbuild::chroot::DEVICE_LOCK, sbuild::chroot::DEVICE_NOTBLOCK, sbuild::chroot::DEVICE_UNLOCK, sbuild::chroot::EXEC_START, sbuild::chroot::EXEC_STOP, sbuild::chroot_block_device::get_device(), get_snapshot_device(), sbuild::stat::is_block(), sbuild::lock::LOCK_EXCLUSIVE, sbuild::device_lock::set_lock(), sbuild::chroot::setup_session_info(), sbuild::chroot::SETUP_START, sbuild::chroot::SETUP_STOP, and sbuild::device_lock::unset_lock().

void chroot_lvm_snapshot::get_details ( format_detail detail  )  const [protected, virtual]

Get detailed information about the chroot for output.

Parameters:
detail the details to output to.

Reimplemented from sbuild::chroot_block_device.

References sbuild::format_detail::add(), sbuild::chroot_source::get_details(), sbuild::chroot_block_device::get_details(), get_snapshot_device(), get_snapshot_options(), snapshot_device, and snapshot_options.

void chroot_lvm_snapshot::get_keyfile ( 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.

Parameters:
keyfile the keyfile to use.

Reimplemented from sbuild::chroot_block_device.

References sbuild::chroot::get_active(), sbuild::chroot_source::get_keyfile(), sbuild::chroot_block_device::get_keyfile(), sbuild::chroot::get_name(), get_snapshot_device(), get_snapshot_options(), and sbuild::basic_keyfile< K, P >::set_object_value().

void chroot_lvm_snapshot::set_keyfile ( 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.

Parameters:
keyfile the keyfile to get the properties from.
used_keys a list of the keys used will be set.

Reimplemented from sbuild::chroot_block_device.

References sbuild::chroot::get_active(), sbuild::chroot::get_name(), sbuild::basic_keyfile< K, P >::get_object_value(), sbuild::keyfile_base::PRIORITY_DISALLOWED, sbuild::keyfile_base::PRIORITY_REQUIRED, sbuild::chroot_source::set_keyfile(), sbuild::chroot_block_device::set_keyfile(), set_snapshot_device(), and set_snapshot_options().


Friends And Related Function Documentation

friend class chroot [friend]

Reimplemented from sbuild::chroot_block_device.


Member Data Documentation

LVM snapshot device name for lvcreate.

Referenced by get_details(), get_mount_device(), and get_snapshot_device().

LVM snapshot options for lvcreate.

Referenced by get_details(), and get_snapshot_options().


The documentation for this class was generated from the following files:

Generated on Sat Jul 5 12:00:00 2008 for sbuild by  doxygen 1.5.6