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_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_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.
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 (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_lvm_snapshot ()
 The constructor.
 chroot_lvm_snapshot (const chroot_lvm_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 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.


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.

Implements sbuild::chroot.

References chroot_lvm_snapshot().

Referenced by clone_source().

Here is the caller graph for this function:

sbuild::chroot::ptr chroot_lvm_snapshot::clone_session ( std::string const &  name,
std::string const &  user,
bool  root 
) const [virtual]

Create a session chroot.

Parameters:
name the identifier (session_id) for the new session.
user the user creating the session.
root true if the user has root access, otherwise false.
Returns:
a session chroot.

Implements sbuild::chroot.

References chroot_lvm_snapshot().

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

Create a source chroot.

Returns:
a source chroot.

Implements sbuild::chroot.

References clone().

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().

Here is the caller graph for this function:

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 set_keyfile().

Here is the caller graph for this function:

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().

Here is the caller graph for this function:

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().

Here is the caller graph for this function:

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

Get the type of the chroot.

Returns:
the chroot type.

Implements sbuild::chroot.

void chroot_lvm_snapshot::setup_env ( chroot const &  chroot,
environment env 
) const [virtual]

Set environment.

Set the environment that the setup scripts will see during execution.

Parameters:
chroot the chroot to use.
env the environment to set.

Reimplemented from sbuild::chroot_block_device_base.

References sbuild::environment::add(), sbuild::basename(), get_snapshot_device(), get_snapshot_options(), and sbuild::chroot_block_device_base::setup_env().

sbuild::chroot::session_flags chroot_lvm_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.

Parameters:
chroot the chroot to use.
Returns:
the session flags.

Reimplemented from sbuild::chroot_block_device_base.

References sbuild::chroot::SESSION_NOFLAGS, and sbuild::chroot::SESSION_PURGE.

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

Implements sbuild::chroot.

References sbuild::chroot::CHROOT_DEVICE, sbuild::chroot_block_device_base::device, sbuild::chroot::DEVICE_LOCK, sbuild::chroot::DEVICE_NOTBLOCK, sbuild::chroot::DEVICE_UNLOCK, sbuild::chroot_block_device_base::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 ( chroot const &  chroot,
format_detail detail 
) const [protected, virtual]

Get detailed information about the chroot for output.

Parameters:
chroot the chroot to use.
detail the details to output to.

Reimplemented from sbuild::chroot_block_device_base.

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

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

Parameters:
chroot the chroot to use.
keyfile the keyfile to use.

Reimplemented from sbuild::chroot_block_device_base.

References sbuild::chroot_block_device_base::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 ( 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.

Parameters:
chroot the chroot to use.
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_base.

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


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

Generated on Wed Jun 1 08:00:15 2011 for sbuild by  doxygen 1.5.6