kpmcore/src/core/raid/softwareraid.h

/*
    SPDX-FileCopyrightText: 2018 Caio Jordão Carvalho <caiojcarvalho@gmail.com>

    SPDX-License-Identifier: GPL-3.0-or-later
*/

#ifndef KPMCORE_SOFTWARERAID_H
#define KPMCORE_SOFTWARERAID_H

#include "core/volumemanagerdevice.h"
#include "util/libpartitionmanagerexport.h"
#include "util/report.h"

class LIBKPMCORE_EXPORT SoftwareRAID : public VolumeManagerDevice
{
    Q_DISABLE_COPY(SoftwareRAID)

    friend class VolumeManagerDevice;

public:
    enum class Status {
        Active,
        Inactive,
        Resync,
        Recovery,
    };

    explicit SoftwareRAID(const QString& name,
                 SoftwareRAID::Status status = SoftwareRAID::Status::Active,
                 const QString& iconName = QString());

    const QStringList deviceNodes() const override;
    const QStringList& partitionNodes() const override;
    qint64 partitionSize(QString &partitionPath) const override;

    virtual bool growArray(Report& report, const QStringList& devices);

    virtual bool shrinkArray(Report& report, const QStringList& devices);

    virtual QString prettyName() const override;

    virtual bool operator==(const Device& other) const override;

    qint32 raidLevel() const;
    qint64 chunkSize() const;
    qint64 totalChunk() const;
    qint64 arraySize() const;
    QString uuid() const;
    SoftwareRAID::Status status() const;

    void setStatus(SoftwareRAID::Status status);

public:
    static qint32 getRaidLevel(const QString& path);
    static qint64 getChunkSize(const QString& path);
    static qint64 getTotalChunk(const QString& path);
    static qint64 getArraySize(const QString& path);
    static QString getUUID(const QString& path);
    static QStringList getDevicePathList(const QString& path);

    static bool isRaidPath(const QString& devicePath);

    static bool createSoftwareRAID(Report& report,
                                   const QString& name,
                                   const QStringList devicePathList,
                                   const qint32 raidLevel,
                                   const qint32 chunkSize);

    static bool deleteSoftwareRAID(Report& report,
                                   SoftwareRAID& raidDevice);

    static bool assembleSoftwareRAID(const QString& deviceNode);

    static bool stopSoftwareRAID(Report& report, const QString& deviceNode);

    static bool reassembleSoftwareRAID(Report& report, const QString& deviceNode);

    static QString getRaidArrayName(const QString& partitionPath);

    static void setRaidConfigurationFilePath(const QString& filePath);

    static QString raidConfigurationFilePath();

    static QString getDefaultRaidConfigFile();

    static bool failPV(Report& report, const QString& devicePath, const QString& physicalVolume);

    //static bool insertPV(Report& report, SoftwareRAID& raid, const QString& deviceNode);

    static bool removePV(Report& report, const QString& devicePath, const QString& physicalVolume);

protected:
    void initPartitions() override;

    qint64 mappedSector(const QString &partitionPath, qint64 sector) const override;

private:
    static bool eraseDeviceMDSuperblock(const QString& path);

    static bool updateConfigurationFile(const QString& path);
    
    static void scanSoftwareRAID(QList<Device*>& devices);

    static QString getDetail(const QString& path);

    static QString getRAIDConfiguration();

    static QString getDeviceInformation(const QString& deviceName);

    void setPartitionNodes(const QStringList& partitionNodes);

private:
    static QString s_raidConfigurationFile;
};

#endif // SOFTWARERAID_H