Disk.h

/*
 * Copyright (c) [2014-2015] Novell, Inc.
 * Copyright (c) [2016-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_DISK_H
#define STORAGE_DISK_H
 
 
#include "storage/Devices/Partitionable.h"
 
 
namespace storage
{
 
    enum class Transport {
        UNKNOWN, SBP, ATA, FC, ISCSI, SAS, SATA, SPI, USB, FCOE
    };
 
 
    std::string get_transport_name(Transport transport);
 
 
    enum class ZoneModel {
        NONE, HOST_AWARE, HOST_MANAGED
    };
 
 
    std::string get_zone_model_name(ZoneModel zone_model);
 
 
    class Disk : public Partitionable
    {
    public:
 
        static Disk* create(Devicegraph* devicegraph, const std::string& name);
 
        static Disk* create(Devicegraph* devicegraph, const std::string& name,
                            const Region& region);
 
        static Disk* create(Devicegraph* devicegraph, const std::string& name,
                            unsigned long long size);
 
        static Disk* load(Devicegraph* devicegraph, const xmlNode* node);
 
        static std::vector<Disk*> get_all(Devicegraph* devicegraph);
 
        static std::vector<const Disk*> get_all(const Devicegraph* devicegraph);
 
        bool is_rotational() const;
 
        bool is_dax() const;
 
        Transport get_transport() const;
 
        ZoneModel get_zone_model() const;
 
        bool is_pmem() const;
 
        bool is_nvme() const;
 
        static Disk* find_by_name(Devicegraph* devicegraph, const std::string& name);
 
        static const Disk* find_by_name(const Devicegraph* devicegraph, const std::string& name);
 
    public:
 
        class Impl;
 
        Impl& get_impl();
        const Impl& get_impl() const;
 
        virtual Disk* clone() const override;
 
    protected:
 
        Disk(Impl* impl);
 
    };
 
 
    bool is_disk(const Device* device);
 
    Disk* to_disk(Device* device);
 
    const Disk* to_disk(const Device* device);
 
}
 
#endif