Holder from a BlkDevice to an Md. More...

#include <MdUser.h>

Inheritance diagram for storage::MdUser:

Collaboration diagram for storage::MdUser:

Public Member Functions
virtual MdUser *	clone () const override
virtual std::unique_ptr< Holder >	clone_v2 () const override
bool	is_spare () const
	Return whether the target device is a spare device.
void	set_spare (bool spare)
	Set the target device to be a spare device.
bool	is_faulty () const
	Return whether the target device is a faulty device.
void	set_faulty (bool faulty)
	Set the target device to be a faulty device.
bool	is_journal () const
	Return whether the target device is a journal device.
void	set_journal (bool journal)
	Set the target device to be a journal device.
unsigned int	get_sort_key () const
	Return the sort key.
void	set_sort_key (unsigned int sort_key)
	Set the sort key.
Impl &	get_impl ()
const Impl &	get_impl () const
	MdUser (Impl *impl)
ST_NO_SWIG	MdUser (std::unique_ptr< Holder::Impl > &&impl)
Public Member Functions inherited from storage::User
Impl &	get_impl ()
const Impl &	get_impl () const
	User (Impl *impl)
ST_NO_SWIG	User (std::unique_ptr< Holder::Impl > &&impl)
Public Member Functions inherited from storage::Holder
Device *	get_source ()
	Get the source device of the holder.
const Device *	get_source () const
	Get the source device of the holder.
void	set_source (const Device *source)
	Set the source device of the holder.
void	set_target (const Device *target)
	Set the target device of the holder.
sid_t	get_source_sid () const
	Return the storage id (sid) of the source of the holder.
Device *	get_target ()
	Get the target device of the holder.
const Device *	get_target () const
	Get the target device of the holder.
sid_t	get_target_sid () const
	Return the storage id (sid) of the target of the holder.
bool	operator== (const Holder &rhs) const
bool	operator!= (const Holder &rhs) const
Holder *	copy_to_devicegraph (Devicegraph *devicegraph) const
	Copies the holder to the devicegraph.
bool	exists_in_devicegraph (const Devicegraph *devicegraph) const
	Checks if the holder exists in the devicegraph.
bool	exists_in_probed () const
	Checks if the holder exists in the probed devicegraph.
bool	exists_in_staging () const
	Checks if the holder exists in the staging devicegraph.
bool	exists_in_system () const
	Checks if the holder exists in the system devicegraph.
const std::map< std::string, std::string > &	get_userdata () const
	Return the userdata of the holder.
void	set_userdata (const std::map< std::string, std::string > &userdata)
	Set the userdata of the holder.
Devicegraph *	get_devicegraph ()
	Return the devicegraph the holder belongs to.
const Devicegraph *	get_devicegraph () const
	Return the devicegraph the holder belongs to.
Impl &	get_impl ()
const Impl &	get_impl () const
void	save (xmlNode *node) const ST_DEPRECATED

Static Public Member Functions
static MdUser *	create (Devicegraph devicegraph, const Device source, const Device *target)
	Create a holder of type MdUser.
static MdUser *	load (Devicegraph devicegraph, const xmlNode node)
Static Public Member Functions inherited from storage::User
static User *	create (Devicegraph devicegraph, const Device source, const Device *target)
	Create a holder of type User.
static User *	load (Devicegraph devicegraph, const xmlNode node)

Additional Inherited Members
Protected Member Functions inherited from storage::Holder
	Holder (Impl *impl) ST_DEPRECATED
ST_NO_SWIG	Holder (std::unique_ptr< Impl > &&impl)
void	create (Devicegraph devicegraph, const Device source, const Device *target) ST_DEPRECATED
	Create a holder between source and target in the devicegraph.
void	load (Devicegraph devicegraph, const xmlNode node) ST_DEPRECATED

Detailed Description

Holder from a BlkDevice to an Md.

See also: User, Holder

Member Function Documentation

◆ clone()

virtual MdUser * storage::MdUser::clone ( ) const

overridevirtual

Reimplemented from storage::User.

◆ clone_v2()

virtual std::unique_ptr< Holder > storage::MdUser::clone_v2 ( ) const

overridevirtual

Reimplemented from storage::User.

◆ create()

MdUser * storage::MdUser::create	(	Devicegraph *	devicegraph,
		const Device *	source,
		const Device *	target )

static

Create a holder of type MdUser.

Usually this function is not called directly. Functions like Md::add_device() call it.

See also: Holder::create(Devicegraph*, const Device*, const Device*)

Exceptions

HolderAlreadyExists

◆ get_sort_key()

unsigned int storage::MdUser::get_sort_key ( ) const

Return the sort key.

When creating a MD RAID the device list passed to the mdadm command is sorted according to the sort-key. For use-cases see https://fate.suse.com/313521/.

The RAID devices, spare and journal devices are sorted independently. Sorting of devices with the same sort-key is undefined. Any value is allowed but 0 should mean unknown/unspecified.