libstorage-ng
Loading...
Searching...
No Matches
storage::BlkDevice Class Reference

An abstract Block Device. More...

#include <BlkDevice.h>

Inheritance diagram for storage::BlkDevice:
[legend]
Collaboration diagram for storage::BlkDevice:
[legend]

Public Member Functions

const std::string & get_name () const
void set_name (const std::string &name)
const Regionget_region () const
void set_region (const Region &region)
unsigned long long get_size () const
 Returns the size of the block device.
void set_size (unsigned long long size)
 Set the size of the block device.
std::string get_size_string () const
 Returns the size of the block device as a localised string.
const Topologyget_topology () const
 Get the topology.
void set_topology (const Topology &topology)
 Set the topology.
bool is_active () const
bool is_read_only () const
 Return whether the block device is read-only.
const std::string & get_sysfs_name () const
const std::string & get_sysfs_path () const
const std::vector< std::string > & get_udev_paths () const
 Return the names of the udev by-path links of the blk device.
const std::vector< std::string > & get_udev_ids () const
 Return the names of the udev by-id links of the blk device.
bool is_usable_as_blk_device () const
 Checks whether the blk device is in general usable as a blk device.
RemoveInfo detect_remove_info () const
 Check whether the device can be removed.
const std::string & get_dm_table_name () const
 Return device-mapper table name (dm-table-name for short).
void set_dm_table_name (const std::string &dm_table_name)
 Set the device-mapper table name (dm-table-name for short).
BlkFilesystemcreate_blk_filesystem (FsType fs_type)
 Creates a block filesystem on the block device.
bool has_blk_filesystem () const
 Return whether the block device has a block filesystem.
BlkFilesystemget_blk_filesystem ()
 Return the block filesystem of the block device.
const BlkFilesystemget_blk_filesystem () const
 Return the block filesystem of the block device.
BlkFilesystemcreate_filesystem (FsType fs_type) ST_DEPRECATED
 Creates a block filesystem on the block device.
bool has_filesystem () const ST_DEPRECATED
 Return whether the block device has a block filesystem.
BlkFilesystemget_filesystem () ST_DEPRECATED
 Return the block filesystem of the block device.
const BlkFilesystemget_filesystem () const ST_DEPRECATED
 Return the block filesystem of the block device.
Encryptioncreate_encryption (const std::string &dm_table_name) ST_DEPRECATED
 Creates an encryption device on the blk device.
Encryptioncreate_encryption (const std::string &dm_table_name, EncryptionType type)
 Creates an encryption device on the blk device.
void remove_encryption ()
 Removes an encryption device on the blk device.
bool has_encryption () const
 Return whether the block device has an Encryption.
Encryptionget_encryption ()
 Return the Encryption of the block device.
const Encryptionget_encryption () const
 Return the Encryption of the block device.
Bcachecreate_bcache (const std::string &name)
 Creates a Bcache on the blk device.
bool has_bcache () const
 Return whether the block device has a BCache.
Bcacheget_bcache ()
 Return the Bcache of the block device.
const Bcacheget_bcache () const
 Return the Bcache of the block device.
BcacheCsetcreate_bcache_cset ()
 Creates a BcacheCset on the blk device.
bool has_bcache_cset () const
 Return whether the block device has a BcacheCset.
BcacheCsetget_bcache_cset ()
 Return the BcacheCset of the block device.
const BcacheCsetget_bcache_cset () const
 Return the BcacheCset of the block device.
std::vector< MountByTypepossible_mount_bys () const
 Returns the possible mount-by methods to reference the block device.
Impl & get_impl ()
const Impl & get_impl () const
Public Member Functions inherited from storage::Device
sid_t get_sid () const
 Return the storage id (sid) of the device.
bool operator== (const Device &rhs) const
bool operator!= (const Device &rhs) const
Devicecopy_to_devicegraph (Devicegraph *devicegraph) const
 Copies the device to the devicegraph.
bool exists_in_devicegraph (const Devicegraph *devicegraph) const
 Checks if the device exists in the devicegraph.
bool exists_in_probed () const
 Checks if the device exists in the probed devicegraph.
bool exists_in_staging () const
 Checks if the device exists in the staging devicegraph.
bool exists_in_system () const
 Checks if the device exists in the system devicegraph.
std::string get_displayname () const
ResizeInfo detect_resize_info () const
 Detect the resize info of the device.
bool has_children () const
size_t num_children () const
bool has_parents () const
size_t num_parents () const
std::vector< Device * > get_children ()
std::vector< const Device * > get_children () const
std::vector< Device * > get_children (View view)
 Get all children of the device.
std::vector< const Device * > get_children (View view) const
 Get all children of the device.
std::vector< Device * > get_parents ()
std::vector< const Device * > get_parents () const
std::vector< Device * > get_parents (View view)
 Get all parents of the device.
std::vector< const Device * > get_parents (View view) const
 Get all parents of the device.
std::vector< Device * > get_siblings (bool itself)
std::vector< const Device * > get_siblings (bool itself) const
std::vector< Device * > get_descendants (bool itself)
std::vector< const Device * > get_descendants (bool itself) const
std::vector< Device * > get_descendants (bool itself, View view)
std::vector< const Device * > get_descendants (bool itself, View view) const
std::vector< Device * > get_ancestors (bool itself)
std::vector< const Device * > get_ancestors (bool itself) const
std::vector< Device * > get_leaves (bool itself)
std::vector< const Device * > get_leaves (bool itself) const
std::vector< Device * > get_roots (bool itself)
std::vector< const Device * > get_roots (bool itself) const
std::vector< Holder * > get_in_holders ()
std::vector< const Holder * > get_in_holders () const
std::vector< Holder * > get_out_holders ()
std::vector< const Holder * > get_out_holders () const
void remove_descendants () ST_DEPRECATED
void remove_descendants (View view)
 Remove all descendants of the device.
const std::map< std::string, std::string > & get_userdata () const
 Return the userdata of the device.
void set_userdata (const std::map< std::string, std::string > &userdata)
 Set the userdata of the device.
std::string get_name_sort_key () const
 Get a sort-key based on the device name.
Devicegraphget_devicegraph ()
 Return the devicegraph the device belongs to.
const Devicegraphget_devicegraph () const
 Return the devicegraph the device belongs to.
Impl & get_impl ()
const Impl & get_impl () const
virtual Deviceclone () const =0
void save (xmlNode *node) const ST_DEPRECATED

Static Public Member Functions

static std::vector< BlkDevice * > get_all (Devicegraph *devicegraph)
 Get all BlkDevices.
static std::vector< const BlkDevice * > get_all (const Devicegraph *devicegraph)
 Get all BlkDevices.
static BlkDevicefind_by_name (Devicegraph *devicegraph, const std::string &name)
 Find a block device by its name.
static const BlkDevicefind_by_name (const Devicegraph *devicegraph, const std::string &name)
 Find a block device by its name.
static bool exists_by_any_name (const Devicegraph *devicegraph, const std::string &name, SystemInfo &system_info)
 Check if a block device by any name including any symbolic links in /dev.
static BlkDevicefind_by_any_name (Devicegraph *devicegraph, const std::string &name) ST_DEPRECATED
 Find a block device by any name including any symbolic links in /dev.
static BlkDevicefind_by_any_name (Devicegraph *devicegraph, const std::string &name, SystemInfo &system_info)
 Find a block device by any name including any symbolic links in /dev.
static const BlkDevicefind_by_any_name (const Devicegraph *devicegraph, const std::string &name) ST_DEPRECATED
 Find a block device by any name including any symbolic links in /dev.
static const BlkDevicefind_by_any_name (const Devicegraph *devicegraph, const std::string &name, SystemInfo &system_info)
 Find a block device by any name including any symbolic links in /dev.
static bool compare_by_dm_table_name (const BlkDevice *lhs, const BlkDevice *rhs)
 Compare (less than) two BlkDevices by DM table name.
Static Public Member Functions inherited from storage::Device
static std::vector< Device * > get_all (Devicegraph *devicegraph)
 Get all Devices.
static std::vector< const Device * > get_all (const Devicegraph *devicegraph)
 Get all Devices.
static bool compare_by_sid (const Device *lhs, const Device *rhs)
 Compare (less than) two Devices by sid.
static bool compare_by_name (const Device *lhs, const Device *rhs)
 Compare (less than) two Devices by name.

Protected Member Functions

 BlkDevice (Impl *impl)
Protected Member Functions inherited from storage::Device
 Device (Impl *impl)
void create (Devicegraph *devicegraph) ST_DEPRECATED
 Create a device in the devicegraph.
void load (Devicegraph *devicegraph) ST_DEPRECATED

Detailed Description

An abstract Block Device.

Member Function Documentation

◆ compare_by_dm_table_name()

bool storage::BlkDevice::compare_by_dm_table_name ( const BlkDevice * lhs,
const BlkDevice * rhs )
static

Compare (less than) two BlkDevices by DM table name.

The comparison is locale unaware.

See also
get_dm_table_name()

◆ create_bcache()

Bcache * storage::BlkDevice::create_bcache ( const std::string & name)

Creates a Bcache on the blk device.

If the blk device has children the children will become children of the bcache device.

◆ create_bcache_cset()

BcacheCset * storage::BlkDevice::create_bcache_cset ( )

Creates a BcacheCset on the blk device.

Exceptions
WrongNumberOfChildren

◆ create_blk_filesystem()

BlkFilesystem * storage::BlkDevice::create_blk_filesystem ( FsType fs_type)

Creates a block filesystem on the block device.

Exceptions
WrongNumberOfChildren,UnsupportedException

◆ create_encryption() [1/2]

Encryption * storage::BlkDevice::create_encryption ( const std::string & dm_table_name)

Creates an encryption device on the blk device.

If the blk device has children the children will become children of the encryption device.

It will also set the mount-by method of the encryption to the storage default mount-by method.

◆ create_encryption() [2/2]

Encryption * storage::BlkDevice::create_encryption ( const std::string & dm_table_name,
EncryptionType type )

Creates an encryption device on the blk device.

If the blk device has children the children will become children of the encryption device.

Allowed encryption types are LUKS1, LUKS2 and PLAIN.

It will also set the mount-by method of the encryption to the storage default mount-by method.

See also
EncryptionType

◆ create_filesystem()

BlkFilesystem * storage::BlkDevice::create_filesystem ( FsType fs_type)
inline

Creates a block filesystem on the block device.

Exceptions
WrongNumberOfChildren,UnsupportedException

◆ detect_remove_info()

RemoveInfo storage::BlkDevice::detect_remove_info ( ) const

Check whether the device can be removed.

E.g. disks and DASDs cannot be removed.

See also
RemoveInfo
Exceptions
Exception

◆ exists_by_any_name()

bool storage::BlkDevice::exists_by_any_name ( const Devicegraph * devicegraph,
const std::string & name,
SystemInfo & system_info )
static

Check if a block device by any name including any symbolic links in /dev.

Function might require a system lookup and is therefore slow. Only works on the probed devicegraph.

Exceptions
Exception

◆ find_by_any_name() [1/4]

const BlkDevice * storage::BlkDevice::find_by_any_name ( const Devicegraph * devicegraph,
const std::string & name )
static

Find a block device by any name including any symbolic links in /dev.

Function might require a system lookup and is therefore slow. Only works on the probed devicegraph.

Exceptions
DeviceNotFoundByName,DeviceHasWrongType,Exception

◆ find_by_any_name() [2/4]

const BlkDevice * storage::BlkDevice::find_by_any_name ( const Devicegraph * devicegraph,
const std::string & name,
SystemInfo & system_info )
static

Find a block device by any name including any symbolic links in /dev.

Function might require a system lookup and is therefore slow. Only works on the probed devicegraph.

Exceptions
DeviceNotFoundByName,DeviceHasWrongType,Exception

◆ find_by_any_name() [3/4]

BlkDevice * storage::BlkDevice::find_by_any_name ( Devicegraph * devicegraph,
const std::string & name )
static

Find a block device by any name including any symbolic links in /dev.

Function might require a system lookup and is therefore slow. Only works on the probed devicegraph.

Exceptions
DeviceNotFoundByName,DeviceHasWrongType,Exception

◆ find_by_any_name() [4/4]

BlkDevice * storage::BlkDevice::find_by_any_name ( Devicegraph * devicegraph,
const std::string & name,
SystemInfo & system_info )
static

Find a block device by any name including any symbolic links in /dev.

Function might require a system lookup and is therefore slow. Only works on the probed devicegraph.

Exceptions
DeviceNotFoundByName,DeviceHasWrongType,Exception

◆ find_by_name() [1/2]

const BlkDevice * storage::BlkDevice::find_by_name ( const Devicegraph * devicegraph,
const std::string & name )
static

Find a block device by its name.

Only the name returned by get_name() is considered.

Exceptions
DeviceNotFoundByName,DeviceHasWrongType

◆ find_by_name() [2/2]

BlkDevice * storage::BlkDevice::find_by_name ( Devicegraph * devicegraph,
const std::string & name )
static

Find a block device by its name.

Only the name returned by get_name() is considered.

Exceptions
DeviceNotFoundByName,DeviceHasWrongType

◆ get_all()

std::vector< const BlkDevice * > storage::BlkDevice::get_all ( const Devicegraph * devicegraph)
static

Get all BlkDevices.

◆ get_bcache() [1/2]

Bcache * storage::BlkDevice::get_bcache ( )

Return the Bcache of the block device.

Exceptions
WrongNumberOfChildren,DeviceHasWrongType

◆ get_bcache() [2/2]

const Bcache * storage::BlkDevice::get_bcache ( ) const

Return the Bcache of the block device.

Exceptions
WrongNumberOfChildren,DeviceHasWrongType

◆ get_bcache_cset() [1/2]

BcacheCset * storage::BlkDevice::get_bcache_cset ( )

Return the BcacheCset of the block device.

Exceptions
WrongNumberOfChildren,DeviceHasWrongType

◆ get_bcache_cset() [2/2]

const BcacheCset * storage::BlkDevice::get_bcache_cset ( ) const

Return the BcacheCset of the block device.

Exceptions
WrongNumberOfChildren,DeviceHasWrongType

◆ get_blk_filesystem() [1/2]

BlkFilesystem * storage::BlkDevice::get_blk_filesystem ( )

Return the block filesystem of the block device.

Exceptions
WrongNumberOfChildren,DeviceHasWrongType

◆ get_blk_filesystem() [2/2]

const BlkFilesystem * storage::BlkDevice::get_blk_filesystem ( ) const

Return the block filesystem of the block device.

Exceptions
WrongNumberOfChildren,DeviceHasWrongType

◆ get_dm_table_name()

const std::string & storage::BlkDevice::get_dm_table_name ( ) const

Return device-mapper table name (dm-table-name for short).

Empty if this is not a device-mapper device.

◆ get_encryption() [1/2]

Encryption * storage::BlkDevice::get_encryption ( )

Return the Encryption of the block device.

Exceptions
WrongNumberOfChildren,DeviceHasWrongType

◆ get_encryption() [2/2]

const Encryption * storage::BlkDevice::get_encryption ( ) const

Return the Encryption of the block device.

Exceptions
WrongNumberOfChildren,DeviceHasWrongType

◆ get_filesystem() [1/2]

const BlkFilesystem * storage::BlkDevice::get_filesystem ( ) const
inline

Return the block filesystem of the block device.

Exceptions
WrongNumberOfChildren,DeviceHasWrongType

◆ get_filesystem() [2/2]

BlkFilesystem * storage::BlkDevice::get_filesystem ( )
inline

Return the block filesystem of the block device.

Exceptions
WrongNumberOfChildren,DeviceHasWrongType

◆ get_size_string()

std::string storage::BlkDevice::get_size_string ( ) const

Returns the size of the block device as a localised string.

See also
get_size(), byte_to_humanstring()
Returns
size as string

◆ get_udev_ids()

const std::vector< std::string > & storage::BlkDevice::get_udev_ids ( ) const

Return the names of the udev by-id links of the blk device.

The names do not include the directory.

Example return value: [ "ata-SAMSUNG_SSD_PM871b_2.5_7mm_512GB_S3U3NE0K803507", "scsi-0ATA_SAMSUNG_SSD_PM87_S3U3NE0K803507" ]

This may not be the complete list of names known to udev since the library filters names that are known to cause problems.

◆ get_udev_paths()

const std::vector< std::string > & storage::BlkDevice::get_udev_paths ( ) const

Return the names of the udev by-path links of the blk device.

The names do not include the directory. Usually there is only one by-path link.

Example return value: [ "pci-0000:00:17.0-ata-1" ]

This may not be the complete list of names known to udev since the library filters names that are known to cause problems.

◆ has_filesystem()

bool storage::BlkDevice::has_filesystem ( ) const
inline

Return whether the block device has a block filesystem.

◆ is_read_only()

bool storage::BlkDevice::is_read_only ( ) const

Return whether the block device is read-only.

E.g. LVM logical volumes can be read-only.

◆ is_usable_as_blk_device()

bool storage::BlkDevice::is_usable_as_blk_device ( ) const

Checks whether the blk device is in general usable as a blk device.

This is not the case for some DASDs, see doc/dasd.md, extended partitions, LVM thin and cache pools, MD RAID containers, see doc/md-raid.md and host-managed zoned disks.

Does not consider if the blk device is already in use.

◆ possible_mount_bys()

std::vector< MountByType > storage::BlkDevice::possible_mount_bys ( ) const

Returns the possible mount-by methods to reference the block device.

PARTLABEL is included even if the partition label is not set.

◆ remove_encryption()

void storage::BlkDevice::remove_encryption ( )

Removes an encryption device on the blk device.

If the encryption device has children the children will become children of the blk device.

Exceptions
WrongNumberOfChildren,DeviceHasWrongType

◆ set_dm_table_name()

void storage::BlkDevice::set_dm_table_name ( const std::string & dm_table_name)

Set the device-mapper table name (dm-table-name for short).

See also
get_dm_table_name()

◆ set_region()

void storage::BlkDevice::set_region ( const Region & region)
Exceptions
Exception

◆ set_size()

void storage::BlkDevice::set_size ( unsigned long long size)

Set the size of the block device.

See also
get_size()
Exceptions
Exception

◆ set_topology()

void storage::BlkDevice::set_topology ( const Topology & topology)

Set the topology.

Only useful for testsuites.


The documentation for this class was generated from the following file:
  • /home/abuild/rpmbuild/BUILD/libstorage-ng-4.5.263-build/libstorage-ng-4.5.263/storage/Devices/BlkDevice.h