libstorage-ng
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
storage::Multipath Class Reference

A multipath device. More...

#include <Multipath.h>

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

Public Member Functions

const std::string & get_vendor () const
 The vendor as reported by multipath tools.
 
const std::string & get_model () const
 The model as reported by multipath tools.
 
std::vector< BlkDevice * > get_blk_devices ()
 Return blk devices used for the Multipath.
 
std::vector< const BlkDevice * > get_blk_devices () const
 Return blk devices used for the Multipath.
 
bool is_rotational () const
 Return whether the multipath device is of rotational or non-rotational type.
 
Impl & get_impl ()
 
const Impl & get_impl () const
 
virtual Multipathclone () const override
 
- 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.
 
void set_range (unsigned int range)
 Set the range of device nodes available.
 
bool is_usable_as_partitionable () const
 Checks whether the partitionable is in general usable as a partitionable (can hold a partition table).
 
PtType get_default_partition_table_type () const
 Get the default partition table type for the partitionable.
 
std::vector< PtTypeget_possible_partition_table_types () const
 Get possible partition table types for the disk.
 
PartitionTablecreate_partition_table (PtType pt_type)
 Create a partition table on the partitionable.
 
bool has_partition_table () const
 Check whether the partitionable has a partition table.
 
PartitionTableget_partition_table ()
 Return the partition table of the partitionable.
 
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.
 
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.
 
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 Multipathcreate (Devicegraph *devicegraph, const std::string &name)
 Create a device of type Multipath.
 
static Multipathcreate (Devicegraph *devicegraph, const std::string &name, const Region &region)
 Create a device of type Multipath.
 
static Multipathcreate (Devicegraph *devicegraph, const std::string &name, unsigned long long size)
 Create a device of type Multipath.
 
static Multipathload (Devicegraph *devicegraph, const xmlNode *node)
 
static std::vector< Multipath * > get_all (Devicegraph *devicegraph)
 Get all Multipaths.
 
static std::vector< const Multipath * > get_all (const Devicegraph *devicegraph)
 Get all Multipaths.
 
static Multipathfind_by_name (Devicegraph *devicegraph, const std::string &name)
 Find a Multipath by its name.
 
static const Multipathfind_by_name (const Devicegraph *devicegraph, const std::string &name)
 Find a Multipath by its name.
 
- 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.
 
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.
 
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

 Multipath (Impl *impl)
 
- 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)
 Create a device in the devicegraph.
 
void load (Devicegraph *devicegraph)
 

Detailed Description

A multipath device.

Not for native NVMe multipath.

Member Function Documentation

◆ clone()

virtual Multipath * storage::Multipath::clone ( ) const
overridevirtual

Implements storage::Device.

◆ create() [1/3]

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

Create a device of type Multipath.

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

See also
Device::create(Devicegraph*)

◆ create() [2/3]

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

Create a device of type Multipath.

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

See also
Device::create(Devicegraph*)

◆ create() [3/3]

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

Create a device of type Multipath.

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

See also
Device::create(Devicegraph*)

◆ find_by_name() [1/2]

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

Find a Multipath by its name.

Only the name returned by get_name() is considered.

Exceptions
DeviceNotFound,DeviceHasWrongType

◆ find_by_name() [2/2]

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

Find a Multipath by its name.

Only the name returned by get_name() is considered.

Exceptions
DeviceNotFound,DeviceHasWrongType

◆ get_all()

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

Get all Multipaths.

◆ get_blk_devices()

std::vector< const BlkDevice * > storage::Multipath::get_blk_devices ( ) const

Return blk devices used for the Multipath.

◆ get_model()

const std::string & storage::Multipath::get_model ( ) const

The model as reported by multipath tools.

E.g. "2107900".

See also
get_vendor()

◆ get_vendor()

const std::string & storage::Multipath::get_vendor ( ) const

The vendor as reported by multipath tools.

E.g. "IBM".

See also
get_model()

◆ is_rotational()

bool storage::Multipath::is_rotational ( ) const

Return whether the multipath device is of rotational or non-rotational type.

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


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