libstorage-ng
Public Member Functions | Static Public Member Functions | List of all members
storage::Dasd Class Reference

A physical DASD device. More...

#include <Dasd.h>

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

Public Member Functions

std::string get_bus_id () const
 Get the bus ID of the DASD. More...
 
void set_bus_id (std::string bus_id)
 Set the bus ID of the DASD. More...
 
bool is_rotational () const
 Return whether the DASD is of rotational or non-rotational type. More...
 
DasdType get_type () const
 Get the DASD type. More...
 
void set_type (DasdType type)
 Set the DASD type. More...
 
DasdFormat get_format () const
 Get the DASD format. More...
 
void set_format (DasdFormat format)
 Set the DASD format. More...
 
Impl & get_impl ()
 
const Impl & get_impl () const
 
virtual Dasdclone () const override
 
 Dasd (Impl *impl)
 
- Public Member Functions inherited from storage::Partitionable
const Topologyget_topology () const
 
void set_topology (const Topology &topology)
 
unsigned int get_range () const
 Query the range of device nodes available. More...
 
void set_range (unsigned int range)
 Set the range of device nodes available. More...
 
bool is_usable_as_partitionable () const
 Checks whether the partitionable is in general usable as a partitionable (can hold a partition table). More...
 
PtType get_default_partition_table_type () const
 Get the default partition table type for the partitionable. More...
 
std::vector< PtTypeget_possible_partition_table_types () const
 Get possible partition table types for the disk. More...
 
PartitionTablecreate_partition_table (PtType pt_type)
 Create a partition table on the partitionable. More...
 
bool has_partition_table () const
 Check whether the partitionable has a partition table.
 
PartitionTableget_partition_table ()
 Return the partition table of the partitionable. More...
 
virtual std::string partition_name (int number) const
 Return the name of the partition with the specified number.
 
const PartitionTableget_partition_table () const
 Return the partition table of the partitionable. More...
 
Impl & get_impl ()
 
const Impl & get_impl () const
 
- Public Member Functions inherited from storage::BlkDevice
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. More...
 
std::string get_size_string () const
 Returns the size of the block device as a localised string. More...
 
const Topologyget_topology () const
 Get the topology.
 
void set_topology (const Topology &topology)
 Set the topology. More...
 
bool is_active () const
 
bool is_read_only () const
 Return whether the block device is read-only. More...
 
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. More...
 
const std::vector< std::string > & get_udev_ids () const
 Return the names of the udev by-id links of the blk device. More...
 
bool is_usable_as_blk_device () const
 Checks whether the blk device is in general usable as a blk device. More...
 
RemoveInfo detect_remove_info () const
 Check whether the device can be removed. More...
 
const std::string & get_dm_table_name () const
 Return device-mapper table name (dm-table-name for short). More...
 
void set_dm_table_name (const std::string &dm_table_name)
 Set the device-mapper table name (dm-table-name for short). More...
 
BlkFilesystemcreate_blk_filesystem (FsType fs_type)
 Creates a block filesystem on the block device. More...
 
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. More...
 
const BlkFilesystemget_blk_filesystem () const
 Return the block filesystem of the block device. More...
 
BlkFilesystemcreate_filesystem (FsType fs_type) ST_DEPRECATED
 Creates a block filesystem on the block device. More...
 
bool has_filesystem () const ST_DEPRECATED
 Return whether the block device has a block filesystem. More...
 
BlkFilesystemget_filesystem () ST_DEPRECATED
 Return the block filesystem of the block device. More...
 
const BlkFilesystemget_filesystem () const ST_DEPRECATED
 Return the block filesystem of the block device. More...
 
Encryptioncreate_encryption (const std::string &dm_table_name) ST_DEPRECATED
 Creates an encryption device on the blk device. More...
 
Encryptioncreate_encryption (const std::string &dm_table_name, EncryptionType type)
 Creates an encryption device on the blk device. More...
 
void remove_encryption ()
 Removes an encryption device on the blk device. More...
 
bool has_encryption () const
 Return whether the block device has an Encryption.
 
Encryptionget_encryption ()
 Return the Encryption of the block device. More...
 
const Encryptionget_encryption () const
 Return the Encryption of the block device. More...
 
Bcachecreate_bcache (const std::string &name)
 Creates a Bcache on the blk device. More...
 
bool has_bcache () const
 Return whether the block device has a BCache.
 
Bcacheget_bcache ()
 Return the Bcache of the block device. More...
 
const Bcacheget_bcache () const
 Return the Bcache of the block device. More...
 
BcacheCsetcreate_bcache_cset ()
 Creates a BcacheCset on the blk device. More...
 
bool has_bcache_cset () const
 Return whether the block device has a BcacheCset.
 
BcacheCsetget_bcache_cset ()
 Return the BcacheCset of the block device. More...
 
const BcacheCsetget_bcache_cset () const
 Return the BcacheCset of the block device. More...
 
std::vector< MountByTypepossible_mount_bys () const
 Returns the possible mount-by methods to reference the block device. More...
 
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. More...
 
bool operator== (const Device &rhs) const
 
bool operator!= (const Device &rhs) const
 
Devicecopy_to_devicegraph (Devicegraph *devicegraph) const
 Copies the device to the devicegraph. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
Devicegraphget_devicegraph ()
 Return the devicegraph the device belongs to.
 
const Devicegraphget_devicegraph () const
 Return the devicegraph the device belongs to. More...
 
Impl & get_impl ()
 
const Impl & get_impl () const
 
void save (xmlNode *node) const ST_DEPRECATED
 

Static Public Member Functions

static Dasdcreate (Devicegraph *devicegraph, const std::string &name)
 Create a device of type Dasd. More...
 
static Dasdcreate (Devicegraph *devicegraph, const std::string &name, const Region &region)
 Create a device of type Dasd. More...
 
static Dasdcreate (Devicegraph *devicegraph, const std::string &name, unsigned long long size)
 Create a device of type Dasd. More...
 
static Dasdload (Devicegraph *devicegraph, const xmlNode *node)
 
static std::vector< Dasd * > get_all (Devicegraph *devicegraph)
 Get all Dasds.
 
static std::vector< const Dasd * > get_all (const Devicegraph *devicegraph)
 Get all Dasds. More...
 
static Dasdfind_by_name (Devicegraph *devicegraph, const std::string &name)
 Find a Dasd by its name. More...
 
static const Dasdfind_by_name (const Devicegraph *devicegraph, const std::string &name)
 Find a Dasd by its name. More...
 
- Static Public Member Functions inherited from storage::Partitionable
static std::vector< Partitionable * > get_all (Devicegraph *devicegraph)
 Get all Partitionables.
 
static std::vector< const Partitionable * > get_all (const Devicegraph *devicegraph)
 Get all Partitionables. More...
 
static Partitionablefind_by_name (Devicegraph *devicegraph, const std::string &name)
 
static const Partitionablefind_by_name (const Devicegraph *devicegraph, const std::string &name)
 
- Static Public Member Functions inherited from storage::BlkDevice
static std::vector< BlkDevice * > get_all (Devicegraph *devicegraph)
 Get all BlkDevices.
 
static std::vector< const BlkDevice * > get_all (const Devicegraph *devicegraph)
 Get all BlkDevices. More...
 
static BlkDevicefind_by_name (Devicegraph *devicegraph, const std::string &name)
 Find a block device by its name. More...
 
static const BlkDevicefind_by_name (const Devicegraph *devicegraph, const std::string &name)
 Find a block device by its name. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
static bool compare_by_dm_table_name (const BlkDevice *lhs, const BlkDevice *rhs)
 Compare (less than) two BlkDevices by DM table name. More...
 
- 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. More...
 
static bool compare_by_sid (const Device *lhs, const Device *rhs)
 Compare (less than) two Devices by sid. More...
 
static bool compare_by_name (const Device *lhs, const Device *rhs)
 Compare (less than) two Devices by name. More...
 

Additional Inherited Members

- Protected Member Functions inherited from storage::Partitionable
 Partitionable (Impl *impl)
 
- Protected Member Functions inherited from storage::BlkDevice
 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. More...
 
void load (Devicegraph *devicegraph) ST_DEPRECATED
 

Detailed Description

A physical DASD device.

Member Function Documentation

◆ create() [1/3]

static Dasd* storage::Dasd::create ( Devicegraph devicegraph,
const std::string &  name 
)
static

Create a device of type Dasd.

Usually this function is not called directly. It is called during probing.

See also
Device::create(Devicegraph*)

◆ create() [2/3]

static Dasd* storage::Dasd::create ( Devicegraph devicegraph,
const std::string &  name,
const Region region 
)
static

Create a device of type Dasd.

Usually this function is not called directly. It is called during probing.

See also
Device::create(Devicegraph*)

◆ create() [3/3]

static Dasd* storage::Dasd::create ( Devicegraph devicegraph,
const std::string &  name,
unsigned long long  size 
)
static

Create a device of type Dasd.

Usually this function is not called directly. It is called during probing.

See also
Device::create(Devicegraph*)

◆ find_by_name() [1/2]

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

Find a Dasd by its name.

Only the name returned by get_name() is considered.

Exceptions
DeviceNotFound,DeviceHasWrongType

◆ find_by_name() [2/2]

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

Find a Dasd by its name.

Only the name returned by get_name() is considered.

Exceptions
DeviceNotFound,DeviceHasWrongType

◆ get_all()

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

Get all Dasds.

◆ get_bus_id()

std::string storage::Dasd::get_bus_id ( ) const

Get the bus ID of the DASD.

E.g. "0.0.0150".

◆ get_format()

DasdFormat storage::Dasd::get_format ( ) const

Get the DASD format.

See also
DasdFormat

◆ get_type()

DasdType storage::Dasd::get_type ( ) const

Get the DASD type.

See also
DasdType

◆ is_rotational()

bool storage::Dasd::is_rotational ( ) const

Return whether the DASD is of rotational or non-rotational type.

See the kernel documentation block/queue-sysfs.rst for more information.

◆ set_bus_id()

void storage::Dasd::set_bus_id ( std::string  bus_id)

Set the bus ID of the DASD.

Note
The bus ID cannot be changed on disk. The function is only for testsuites.
See also
get_bus_id()

◆ set_format()

void storage::Dasd::set_format ( DasdFormat  format)

Set the DASD format.

Note
The library does not support to change the format on disk. The function is only for testsuites.
See also
DasdFormat

◆ set_type()

void storage::Dasd::set_type ( DasdType  type)

Set the DASD type.

Note
The library does not support to change the type on disk. The function is only for testsuites.
See also
DasdType

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