sbuild  1.7.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
sbuild::chroot::facet::block_device_base Class Reference

A base class for block-device chroots. More...

#include <block-device-base.h>

+ Inheritance diagram for sbuild::chroot::facet::block_device_base:
+ Collaboration diagram for sbuild::chroot::facet::block_device_base:

Public Types

typedef chroot::error error
 Exception type.
 
- Public Types inherited from sbuild::chroot::facet::facet
enum  session_flags { SESSION_NOFLAGS = 0, SESSION_CREATE = 1 << 0, SESSION_CLONE = 1 << 1, SESSION_PURGE = 1 << 2 }
 Chroot session properties. More...
 
typedef std::shared_ptr< facetptr
 A shared_ptr to a chroot facet object.
 
typedef std::shared_ptr< const
facet
const_ptr
 A shared_ptr to a const chroot facet object.
 
- Public Types inherited from sbuild::chroot::facet::storage
typedef std::shared_ptr< storageptr
 A shared_ptr to a chroot storage object.
 
typedef std::shared_ptr< const
storage
const_ptr
 A shared_ptr to a const chroot storage object.
 

Public Member Functions

virtual ~block_device_base ()
 The destructor.
 
std::string const & get_device () const
 Get the block device of the chroot. More...
 
void set_device (const std::string &device)
 Set the block device of the chroot. More...
 
virtual std::string get_path () const
 Get the path to the chroot. More...
 
virtual void setup_env (environment &env) const
 Set environment. More...
 
- Public Member Functions inherited from sbuild::chroot::facet::facet
virtual ~facet ()
 The destructor.
 
virtual ptr clone () const =0
 Copy the chroot facet. More...
 
virtual std::string const & get_name () const =0
 Get the name of the chroot facet. More...
 
virtual session_flags get_session_flags () const
 Get the session flags of the chroot. More...
 
- Public Member Functions inherited from sbuild::chroot::facet::storage
virtual ~storage ()
 The destructor.
 
virtual void setup_lock (chroot::setup_type type, bool lock, int status)
 

Protected Member Functions

 block_device_base ()
 The constructor.
 
 block_device_base (const block_device_base &rhs)
 The copy constructor.
 
void set_chroot (chroot &chroot, bool copy)
 Set containing chroot. More...
 
virtual void get_details (format_detail &detail) const
 Get detailed information about the chroot for output. More...
 
virtual void get_used_keys (string_list &used_keys) const
 Get a list of the keys used during keyfile parsing. More...
 
virtual void get_keyfile (keyfile &keyfile) const
 Copy the chroot properties into a keyfile. More...
 
virtual void set_keyfile (const keyfile &keyfile)
 Set the chroot properties from a keyfile. More...
 
- Protected Member Functions inherited from sbuild::chroot::facet::facet
 facet ()
 The constructor.
 
- Protected Member Functions inherited from sbuild::chroot::facet::storage
 storage ()
 The constructor.
 

Protected Attributes

std::string device
 The block device to use.
 
- Protected Attributes inherited from sbuild::chroot::facet::facet
chrootowner
 Chroot owning this facet.
 

Friends

class chroot
 

Detailed Description

A base class for block-device chroots.

This class doesn't implement a chroot (get_chroot_type is not implemented).

Originally lvm-snapshot inherited from the block-device chroot, but this was changed when union support was introduced. This design prevents lvm-snapshot offering union based sessions.

Member Function Documentation

void sbuild::chroot::facet::block_device_base::get_details ( format_detail detail) const
protectedvirtual

Get detailed information about the chroot for output.

Parameters
detailthe details to output to.

Reimplemented from sbuild::chroot::facet::facet.

Reimplemented in sbuild::chroot::facet::lvm_snapshot.

References sbuild::_(), sbuild::format_detail::add(), device, and get_device().

Referenced by sbuild::chroot::facet::lvm_snapshot::get_details().

+ Here is the caller graph for this function:

std::string const & sbuild::chroot::facet::block_device_base::get_device ( ) const

Get the block device of the chroot.

Returns
the device.

References device.

Referenced by sbuild::chroot::facet::block_device::chroot_session_setup(), sbuild::chroot::facet::lvm_snapshot::chroot_session_setup(), get_details(), get_keyfile(), and setup_env().

+ Here is the caller graph for this function:

void sbuild::chroot::facet::block_device_base::get_keyfile ( keyfile keyfile) const
protectedvirtual

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
keyfilethe keyfile to use.

Reimplemented from sbuild::chroot::facet::facet.

Reimplemented in sbuild::chroot::facet::lvm_snapshot.

References get_device(), sbuild::chroot::chroot::get_name(), sbuild::chroot::facet::facet::owner, and sbuild::keyfile::set_object_value().

Referenced by sbuild::chroot::facet::lvm_snapshot::get_keyfile().

+ Here is the caller graph for this function:

std::string sbuild::chroot::facet::block_device_base::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.

Returns
the path.

Implements sbuild::chroot::facet::storage.

References sbuild::chroot::chroot::get_facet(), sbuild::chroot::chroot::get_mount_location(), and sbuild::chroot::facet::facet::owner.

void sbuild::chroot::facet::block_device_base::get_used_keys ( string_list used_keys) const
protectedvirtual

Get a list of the keys used during keyfile parsing.

Returns
a list of key names.

Reimplemented from sbuild::chroot::facet::facet.

Reimplemented in sbuild::chroot::facet::lvm_snapshot.

Referenced by sbuild::chroot::facet::lvm_snapshot::get_used_keys().

+ Here is the caller graph for this function:

void sbuild::chroot::facet::block_device_base::set_chroot ( chroot chroot,
bool  copy 
)
protectedvirtual

Set containing chroot.

The copy parameter is used to inform the facet if it is new or a copy; this is intended to allow additional facets to only be added if the facet is new, for example, to avoid re-adding removed facets when copying a chroot.

Parameters
chrootthe chroot containing this facet.
copytrue if the facet has been copied, or false if this is a new instance.

Reimplemented from sbuild::chroot::facet::facet.

Reimplemented in sbuild::chroot::facet::block_device, and sbuild::chroot::facet::lvm_snapshot.

References sbuild::chroot::chroot::add_facet(), sbuild::chroot::facet::mountable::create(), sbuild::chroot::chroot::get_facet(), sbuild::chroot::facet::facet::owner, and sbuild::chroot::facet::facet::set_chroot().

Referenced by sbuild::chroot::facet::lvm_snapshot::set_chroot(), and sbuild::chroot::facet::block_device::set_chroot().

+ Here is the caller graph for this function:

void sbuild::chroot::facet::block_device_base::set_device ( const std::string &  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
devicethe device.

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

Referenced by set_keyfile().

+ Here is the caller graph for this function:

void sbuild::chroot::facet::block_device_base::set_keyfile ( const keyfile keyfile)
protectedvirtual

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
keyfilethe keyfile to get the properties from.

Reimplemented from sbuild::chroot::facet::facet.

Reimplemented in sbuild::chroot::facet::lvm_snapshot.

References sbuild::chroot::chroot::get_name(), sbuild::keyfile::get_object_value(), sbuild::chroot::facet::facet::owner, sbuild::keyfile::PRIORITY_REQUIRED, and set_device().

Referenced by sbuild::chroot::facet::lvm_snapshot::set_keyfile().

+ Here is the caller graph for this function:

void sbuild::chroot::facet::block_device_base::setup_env ( environment env) const
virtual

Set environment.

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

Parameters
envthe environment to set.

Reimplemented from sbuild::chroot::facet::facet.

Reimplemented in sbuild::chroot::facet::lvm_snapshot.

References sbuild::environment::add(), and get_device().

Referenced by sbuild::chroot::facet::lvm_snapshot::setup_env().

+ Here is the caller graph for this function:


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