24#ifndef STORAGE_BLK_DEVICE_H
25#define STORAGE_BLK_DEVICE_H
29#include "storage/Utils/Swig.h"
30#include "storage/Devices/Device.h"
31#include "storage/Filesystems/BlkFilesystem.h"
40 enum class EncryptionType;
48 class BlkDevice :
public Device
52 const std::string& get_name()
const;
53 void set_name(
const std::string& name);
55 const Region& get_region()
const;
93 bool is_active()
const;
101 const std::string& get_sysfs_name()
const;
102 const std::string& get_sysfs_path()
const;
389 const Impl& get_impl()
const;
393 BlkDevice(Impl* impl);
A bcache cache set.
Definition BcacheCset.h:42
A bcache device.
Definition Bcache.h:79
An abstract Block Device.
Definition BlkDevice.h:49
BlkFilesystem * get_blk_filesystem()
Return the block filesystem of the block device.
unsigned long long get_size() const
Returns the size of the block device.
Bcache * create_bcache(const std::string &name)
Creates a Bcache on the blk device.
BcacheCset * get_bcache_cset()
Return the BcacheCset of the block device.
BcacheCset * create_bcache_cset()
Creates a BcacheCset on 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.
BlkFilesystem * get_filesystem() ST_DEPRECATED
Return the block filesystem of the block device.
Definition BlkDevice.h:265
void set_region(const Region ®ion)
const Topology & get_topology() const
Get the topology.
bool is_read_only() const
Return whether the block device is read-only.
bool has_blk_filesystem() const
Return whether the block device has a block filesystem.
const BlkFilesystem * get_filesystem() const ST_DEPRECATED
Return the block filesystem of the block device.
Definition BlkDevice.h:270
static const BlkDevice * find_by_name(const Devicegraph *devicegraph, const std::string &name)
Find a block device by its name.
bool has_encryption() const
Return whether the block device has an Encryption.
bool is_usable_as_blk_device() const
Checks whether the blk device is in general usable as a blk device.
std::vector< MountByType > possible_mount_bys() const
Returns the possible mount-by methods to reference the block device.
Encryption * get_encryption()
Return the Encryption of the block device.
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 bool compare_by_dm_table_name(const BlkDevice *lhs, const BlkDevice *rhs)
Compare (less than) two BlkDevices by DM table name.
const BcacheCset * get_bcache_cset() const
Return the BcacheCset of the block device.
Bcache * get_bcache()
Return the Bcache of the block device.
bool has_filesystem() const ST_DEPRECATED
Return whether the block device has a block filesystem.
Definition BlkDevice.h:260
const Encryption * get_encryption() const
Return the Encryption of the block device.
static BlkDevice * find_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 std::vector< const BlkDevice * > get_all(const Devicegraph *devicegraph)
Get all BlkDevices.
std::string get_size_string() const
Returns the size of the block device as a localised string.
const std::string & get_dm_table_name() const
Return device-mapper table name (dm-table-name for short).
Encryption * create_encryption(const std::string &dm_table_name) ST_DEPRECATED
Creates an encryption device on the blk device.
const BlkFilesystem * get_blk_filesystem() const
Return the block filesystem of the block device.
static BlkDevice * find_by_name(Devicegraph *devicegraph, const std::string &name)
Find a block device by its name.
BlkFilesystem * create_filesystem(FsType fs_type) ST_DEPRECATED
Creates a block filesystem on the block device.
Definition BlkDevice.h:255
RemoveInfo detect_remove_info() const
Check whether the device can be removed.
const std::vector< std::string > & get_udev_paths() const
Return the names of the udev by-path links of the blk device.
Encryption * create_encryption(const std::string &dm_table_name, EncryptionType type)
Creates an encryption device on the blk device.
static const BlkDevice * find_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.
BlkFilesystem * create_blk_filesystem(FsType fs_type)
Creates a block filesystem on the block device.
void set_size(unsigned long long size)
Set the size of the block device.
static std::vector< BlkDevice * > get_all(Devicegraph *devicegraph)
Get all BlkDevices.
void set_dm_table_name(const std::string &dm_table_name)
Set the device-mapper table name (dm-table-name for short).
bool has_bcache_cset() const
Return whether the block device has a BcacheCset.
static const BlkDevice * find_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 BlkDevice * find_by_any_name(Devicegraph *devicegraph, const std::string &name) ST_DEPRECATED
Find a block device by any name including any symbolic links in /dev.
void remove_encryption()
Removes an encryption device on the blk device.
bool has_bcache() const
Return whether the block device has a BCache.
const Bcache * get_bcache() const
Return the Bcache of the block device.
void set_topology(const Topology &topology)
Set the topology.
Definition BlkFilesystem.h:43
An abstract base class for storage devices.
Definition Device.h:82
The main container of the libstorage-ng.
Definition Devicegraph.h:170
An encryption layer on a blk device.
Definition Encryption.h:55
A start/length pair with a block size.
Definition Region.h:85
Definition FreeInfo.h:294
The SystemInfo class keeps various system information.
Definition SystemInfo.h:49
A class to represent hardware alignment information.
Definition Topology.h:39
The storage namespace.
Definition Actiongraph.h:40
bool is_blk_device(const Device *device)
Checks whether device points to an BlkDevice.
BlkDevice * to_blk_device(Device *device)
Converts pointer to Device to pointer to BlkDevice.