LvmVg.h

/*
 * Copyright (c) [2016-2021] 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_LVM_VG_H
#define STORAGE_LVM_VG_H
 
 
#include "storage/Devices/Device.h"
#include "storage/Devices/LvmLv.h"
#include "storage/Devicegraph.h"
 
 
namespace storage
{
    class Region;
    class BlkDevice;
    class LvmPv;
    class LvmLv;
 
 
    class LvmVgNotFoundByVgName : public DeviceNotFound
    {
    public:
 
        LvmVgNotFoundByVgName(const std::string& vg_name);
    };
 
 
    class InvalidExtentSize : public Exception
    {
    public:
 
        InvalidExtentSize(unsigned long long extent_size) ST_DEPRECATED;
        InvalidExtentSize(const std::string& msg);
    };
 
 
    class LvmVg : public Device
    {
    public:
 
        static LvmVg* create(Devicegraph* devicegraph, const std::string& vg_name);
 
        static LvmVg* load(Devicegraph* devicegraph, const xmlNode* node);
 
        const std::string& get_vg_name() const;
 
        void set_vg_name(const std::string& vg_name);
 
        static bool is_valid_vg_name(const std::string& vg_name);
 
        const Region& get_region() const;
 
        unsigned long long get_size() const;
 
        std::string get_size_string() const;
 
        unsigned long long get_extent_size() const;
 
        void set_extent_size(unsigned long long extent_size);
 
        unsigned long long number_of_extents() const;
 
        unsigned long long number_of_used_extents() const;
 
        unsigned long long number_of_free_extents() const;
 
        bool is_overcommitted() const;
 
        LvmPv* add_lvm_pv(BlkDevice* blk_device);
 
        void remove_lvm_pv(BlkDevice* blk_device);
 
        unsigned long long max_size_for_lvm_lv(LvType lv_type) const;
 
        LvmLv* create_lvm_lv(const std::string& lv_name, LvType lv_type,
                             unsigned long long size);
 
        LvmLv* create_lvm_lv(const std::string& lv_name, unsigned long long size) ST_DEPRECATED;
 
        void delete_lvm_lv(LvmLv* lvm_lv);
 
        static std::vector<LvmVg*> get_all(Devicegraph* devicegraph);
 
        static std::vector<const LvmVg*> get_all(const Devicegraph* devicegraph);
 
        static LvmVg* find_by_vg_name(Devicegraph* devicegraph, const std::string& vg_name);
 
        static const LvmVg* find_by_vg_name(const Devicegraph* devicegraph, const std::string& vg_name);
 
        std::vector<LvmPv*> get_lvm_pvs();
 
        std::vector<const LvmPv*> get_lvm_pvs() const;
 
        LvmLv* get_lvm_lv(const std::string& lv_name);
 
        std::vector<LvmLv*> get_lvm_lvs();
 
        std::vector<const LvmLv*> get_lvm_lvs() const;
 
        static bool compare_by_vg_name(const LvmVg* lhs, const LvmVg* rhs);
 
    public:
 
        class Impl;
 
        Impl& get_impl();
        const Impl& get_impl() const;
 
        virtual LvmVg* clone() const override;
 
    protected:
 
        LvmVg(Impl* impl);
 
    };
 
 
    bool is_lvm_vg(const Device* device);
 
    LvmVg* to_lvm_vg(Device* device);
 
    const LvmVg* to_lvm_vg(const Device* device);
 
}
 
#endif