BlkDevice.h

/*
 * Copyright (c) [2014-2015] Novell, Inc.
 * Copyright (c) [2016-2025] SUSE LLC
 *
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as published
 * by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, contact Novell, Inc.
 *
 * To contact Novell about this file by physical or electronic mail, you may
 * find current contact information at www.novell.com.
 */
 
 
#ifndef STORAGE_BLK_DEVICE_H
#define STORAGE_BLK_DEVICE_H
 
 
#include <vector>
 
#include "storage/Utils/Swig.h"
#include "storage/Devices/Device.h"
#include "storage/Filesystems/BlkFilesystem.h"
 
 
namespace storage
{
 
    class Region;
    class Topology;
    class Encryption;
    enum class EncryptionType;
    class Bcache;
    class BcacheCset;
    class RemoveInfo;
    class SystemInfo;
 

    class BlkDevice : public Device
    {
    public:

        const std::string& get_name() const;

        void set_name(const std::string& name);
 
        const Region& get_region() const;

        void set_region(const Region& region);

        unsigned long long get_size() const;

        void set_size(unsigned long long size);

        std::string get_size_string() const;

        const Topology& get_topology() const;

        void set_topology(const Topology& topology);
 
        bool is_active() const;

        bool is_read_only() const;
 
        const std::string& get_sysfs_name() const;
        const std::string& get_sysfs_path() const;

        const std::vector<std::string>& get_udev_paths() const;

        const std::vector<std::string>& get_udev_ids() const;

        bool is_usable_as_blk_device() const;

        RemoveInfo detect_remove_info() const;

        const std::string& get_dm_table_name() const;

        void set_dm_table_name(const std::string& dm_table_name);

        static bool is_valid_dm_table_name(const std::string& dm_table_name);

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

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

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

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

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

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

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

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

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

        BlkFilesystem* create_blk_filesystem(FsType fs_type);

        bool has_blk_filesystem() const;

        BlkFilesystem* get_blk_filesystem();

        const BlkFilesystem* get_blk_filesystem() const;

        BlkFilesystem* create_filesystem(FsType fs_type) ST_DEPRECATED { return create_blk_filesystem(fs_type); }

        bool has_filesystem() const ST_DEPRECATED { return has_blk_filesystem(); }

        BlkFilesystem* get_filesystem() ST_DEPRECATED { return get_blk_filesystem(); }

        const BlkFilesystem* get_filesystem() const ST_DEPRECATED { return get_blk_filesystem(); }

        Encryption* create_encryption(const std::string& dm_table_name) ST_DEPRECATED;

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

        void remove_encryption();

        bool has_encryption() const;

        Encryption* get_encryption();

        const Encryption* get_encryption() const;

        Bcache* create_bcache(const std::string& name);

        bool has_bcache() const;

        Bcache* get_bcache();

        const Bcache* get_bcache() const;

        BcacheCset* create_bcache_cset();

        bool has_bcache_cset() const;

        BcacheCset* get_bcache_cset();

        const BcacheCset* get_bcache_cset() const;

        static bool compare_by_dm_table_name(const BlkDevice* lhs, const BlkDevice* rhs);

        std::vector<MountByType> possible_mount_bys() const;
 
    public:
 
        class Impl;
 
        Impl& get_impl();
        const Impl& get_impl() const;
 
    protected:
 
        BlkDevice(Impl* impl);
        ST_NO_SWIG BlkDevice(std::unique_ptr<Device::Impl>&& impl);
 
    };
 

    bool is_blk_device(const Device* device);

    BlkDevice* to_blk_device(Device* device);

    const BlkDevice* to_blk_device(const Device* device);
 
}
 
#endif