Btrfs.h

/*
 * Copyright (c) 2015 Novell, Inc.
 * Copyright (c) [2017-2020] 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_BTRFS_H
#define STORAGE_BTRFS_H
 
 
#include "storage/Devicegraph.h"
#include "storage/Filesystems/BlkFilesystem.h"
#include "storage/Filesystems/BtrfsQgroup.h"
 
 
namespace storage
{
 
    class BtrfsSubvolume;
    class FilesystemUser;
 
 
    enum class BtrfsRaidLevel
    {
        UNKNOWN, DEFAULT, SINGLE, DUP, RAID0, RAID1, RAID5, RAID6, RAID10, RAID1C3, RAID1C4
    };
 
 
    std::string get_btrfs_raid_level_name(BtrfsRaidLevel btrfs_raid_level);
 
 
    class BtrfsSubvolumeNotFoundByPath : public DeviceNotFound
    {
    public:
 
        BtrfsSubvolumeNotFoundByPath(const std::string& path);
    };
 
 
    class BtrfsQgroupNotFoundById : public DeviceNotFound
    {
    public:
 
        BtrfsQgroupNotFoundById(const BtrfsQgroup::id_t& id);
    };
 
 
    class Btrfs : public BlkFilesystem
    {
    public:
 
        static Btrfs* create(Devicegraph* devicegraph);
 
        static Btrfs* load(Devicegraph* devicegraph, const xmlNode* node);
 
        BtrfsRaidLevel get_metadata_raid_level() const;
 
        void set_metadata_raid_level(BtrfsRaidLevel metadata_raid_level);
 
        BtrfsRaidLevel get_data_raid_level() const;
 
        void set_data_raid_level(BtrfsRaidLevel data_raid_level);
 
        std::vector<BtrfsRaidLevel> get_allowed_metadata_raid_levels() const;
 
        std::vector<BtrfsRaidLevel> get_allowed_data_raid_levels() const;
 
        bool has_quota() const;
 
        void set_quota(bool quota);
 
        FilesystemUser* add_device(BlkDevice* blk_device);
 
        void remove_device(BlkDevice* blk_device);
 
        BtrfsSubvolume* get_top_level_btrfs_subvolume();
 
        const BtrfsSubvolume* get_top_level_btrfs_subvolume() const;
 
        BtrfsSubvolume* get_default_btrfs_subvolume();
 
        const BtrfsSubvolume* get_default_btrfs_subvolume() const;
 
        void set_default_btrfs_subvolume(BtrfsSubvolume* btrfs_subvolume) const;
 
        std::vector<BtrfsSubvolume*> get_btrfs_subvolumes();
 
        std::vector<const BtrfsSubvolume*> get_btrfs_subvolumes() const;
 
        BtrfsSubvolume* find_btrfs_subvolume_by_path(const std::string& path);
 
        const BtrfsSubvolume* find_btrfs_subvolume_by_path(const std::string& path) const;
 
        BtrfsQgroup* create_btrfs_qgroup(const BtrfsQgroup::id_t& id);
 
        std::vector<BtrfsQgroup*> get_btrfs_qgroups();
 
        std::vector<const BtrfsQgroup*> get_btrfs_qgroups() const;
 
        BtrfsQgroup* find_btrfs_qgroup_by_id(const BtrfsQgroup::id_t& id);
 
        const BtrfsQgroup* find_btrfs_qgroup_by_id(const BtrfsQgroup::id_t& id) const;
 
        static std::vector<Btrfs*> get_all(Devicegraph* devicegraph);
 
        static std::vector<const Btrfs*> get_all(const Devicegraph* devicegraph);
 
        bool get_configure_snapper() const;
        void set_configure_snapper(bool configure);
 
    public:
 
        class Impl;
 
        Impl& get_impl();
        const Impl& get_impl() const;
 
        virtual Btrfs* clone() const override;
 
    protected:
 
        Btrfs(Impl* impl);
 
    };
 
 
    bool is_btrfs(const Device* device);
 
    Btrfs* to_btrfs(Device* device);
 
    const Btrfs* to_btrfs(const Device* device);
 
}
 
#endif