sbuild::chroot_block_device Class Reference

A chroot stored on an unmounted block device. More...

#include <sbuild-chroot-block-device.h>

Inheritance diagram for sbuild::chroot_block_device:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~chroot_block_device ()
 The destructor.
virtual chroot::ptr clone () const
 Copy the chroot.
std::string const & get_device () const
 Get the block device of the chroot.
void set_device (std::string const &device)
 Set the block device of the chroot.
virtual std::string const & get_mount_device () const
 Get the mount device of the chroot.
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_block_device ()
 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 device
 The block device to use.

Friends

class chroot


Detailed Description

A chroot stored on an unmounted block device.

The device will be mounted on demand.


Constructor & Destructor Documentation

chroot_block_device::chroot_block_device (  )  [protected]

The constructor.

Referenced by clone(), and sbuild::chroot_lvm_snapshot::clone_source().

chroot_block_device::~chroot_block_device (  )  [virtual]

The destructor.


Member Function Documentation

sbuild::chroot::ptr chroot_block_device::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.

Reimplemented in sbuild::chroot_lvm_snapshot.

References chroot_block_device().

std::string const & chroot_block_device::get_device (  )  const

Get the block device of the chroot.

Returns:
the device.

References device.

Referenced by get_details(), get_keyfile(), sbuild::session::run_impl(), setup_env(), sbuild::chroot_lvm_snapshot::setup_lock(), and setup_lock().

void chroot_block_device::set_device ( std::string const &  device  ) 

Set the block device of the chroot.

This is the "source" device. It may be the case that the real device is different (for example, an LVM snapshot PV), but by default will be the device to mount.

Parameters:
device the device.

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

Referenced by set_keyfile().

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

Get the mount device of the chroot.

Returns:
the device.

Implements sbuild::chroot_mountable.

Reimplemented in sbuild::chroot_lvm_snapshot.

References device.

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

Get the type of the chroot.

Returns:
the chroot type.

Implements sbuild::chroot.

Reimplemented in sbuild::chroot_lvm_snapshot.

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

Set environment.

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

Parameters:
env the environment to set.

Reimplemented from sbuild::chroot_mountable.

Reimplemented in sbuild::chroot_lvm_snapshot.

References sbuild::environment::add(), get_device(), sbuild::chroot_mountable::setup_env(), and sbuild::chroot::setup_env().

Referenced by sbuild::chroot_lvm_snapshot::setup_env().

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

Reimplemented in sbuild::chroot_lvm_snapshot.

References sbuild::chroot_mountable::get_session_flags(), and sbuild::chroot::SESSION_NOFLAGS.

void chroot_block_device::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.

Reimplemented in sbuild::chroot_lvm_snapshot.

References device, sbuild::chroot::DEVICE_LOCK, sbuild::chroot::DEVICE_NOTBLOCK, sbuild::chroot::DEVICE_UNLOCK, sbuild::chroot::EXEC_START, sbuild::chroot::EXEC_STOP, get_device(), sbuild::lock::LOCK_EXCLUSIVE, sbuild::device_lock::set_lock(), sbuild::chroot::SETUP_START, sbuild::chroot::SETUP_STOP, and sbuild::device_lock::unset_lock().

void chroot_block_device::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_mountable.

Reimplemented in sbuild::chroot_lvm_snapshot.

References sbuild::format_detail::add(), device, sbuild::chroot_mountable::get_details(), sbuild::chroot::get_details(), and get_device().

Referenced by sbuild::chroot_lvm_snapshot::get_details().

void chroot_block_device::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_mountable.

Reimplemented in sbuild::chroot_lvm_snapshot.

References get_device(), sbuild::chroot_mountable::get_keyfile(), sbuild::chroot::get_keyfile(), sbuild::chroot::get_name(), and sbuild::basic_keyfile< K, P >::set_object_value().

Referenced by sbuild::chroot_lvm_snapshot::get_keyfile().

void chroot_block_device::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_mountable.

Reimplemented in sbuild::chroot_lvm_snapshot.

References sbuild::chroot::get_name(), sbuild::basic_keyfile< K, P >::get_object_value(), sbuild::keyfile_base::PRIORITY_REQUIRED, set_device(), sbuild::chroot_mountable::set_keyfile(), and sbuild::chroot::set_keyfile().

Referenced by sbuild::chroot_lvm_snapshot::set_keyfile().


Friends And Related Function Documentation

friend class chroot [friend]

Reimplemented from sbuild::chroot_mountable.

Reimplemented in sbuild::chroot_lvm_snapshot.


Member Data Documentation

std::string sbuild::chroot_block_device::device [private]


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

Generated on Sat Jul 5 11:59:57 2008 for sbuild by  doxygen 1.5.6