summaryrefslogtreecommitdiffstats
path: root/src/shared-main-lib/iostatus.cpp
blob: f1efc612a200247c1343458b4e0b23ca0dbd2eff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

#include "iostatus.h"

#include <QFile>

using namespace Qt::StringLiterals;

/*!
    \qmltype IoStatus
    \inqmlmodule QtApplicationManager
    \ingroup common-instantiatable
    \brief Provides information on the status of I/O devices.

    IoStatus provides information on the status of I/O devices.
    Its property values are updated whenever the method update() is called.

    You can use this component as a MonitorModel data source if you want to plot its
    previous values over time.

    \qml
    import QtQuick
    import QtApplicationManager
    ...
    MonitorModel {
        IoStatus {
            deviceNames: ["sda", "sdb"]
        }
    }
    \endqml

    You can also use it alongside a Timer for instance, when you're only interested in its current value.

    \qml
    import QtQuick
    import QtApplicationManager
    ...
    IoStatus {
        id: ioStatus
        deviceNames: ["sda", "sdb"]
    }
    Timer {
        interval: 500
        running: true
        repeat: true
        onTriggered: ioStatus.update()
    }
    Text {
        property string loadPercent: Number(ioStatus.ioLoad.sda * 100).toLocaleString(Qt.locale("en_US"), 'f', 1)
        text: "sda load: " + loadPercent + "%"
    }
    \endqml
*/

QT_USE_NAMESPACE_AM

IoStatus::IoStatus(QObject *parent)
    : QObject(parent)
{
}

IoStatus::~IoStatus()
{
    qDeleteAll(m_ioHash);
}

/*!
    \qmlproperty list<string> IoStatus::deviceNames

    Names of the I/O devices to be probed.

    \note Currently this is only supported on Linux: device names have to match to filenames in
    the \c /sys/block directory.
*/
QStringList IoStatus::deviceNames() const
{
    return m_deviceNames;
}

void IoStatus::setDeviceNames(const QStringList &value)
{
    qDeleteAll(m_ioHash);
    m_ioHash.clear();

    m_deviceNames = value;

    for (auto it = m_deviceNames.cbegin(); it != m_deviceNames.cend(); ++it)
        addIoReader(*it);

    emit deviceNamesChanged();
}

/*!
    \qmlproperty var IoStatus::ioLoad
    \readonly

    A map of devices registered in deviceNames and their corresponding I/O loads in the
    range [0, 1]. For instance the load of a device named "sda" can be accessed through
    \c ioLoad.sda.

    Devices whose status could not be fetched won't be present in this property.

    The value of this property is updated when update() is called.

    \sa update
*/
QVariantMap IoStatus::ioLoad() const
{
    return m_ioLoad;
}

/*!
    \qmlproperty list<string> IoStatus::roleNames
    \readonly

    Names of the roles provided by IoStatus when used as a MonitorModel data source.

    \sa MonitorModel
*/
QStringList IoStatus::roleNames() const
{
    return { u"ioLoad"_s };
}

/*!
    \qmlmethod IoStatus::update

    Updates the ioLoad property.

    \sa ioLoad
*/
void IoStatus::update()
{
    m_ioLoad.clear();
    for (auto it = m_ioHash.cbegin(); it != m_ioHash.cend(); ++it) {
        qreal ioVal = it.value()->readLoadValue();
        m_ioLoad.insert(it.key(), ioVal);
    }
    emit ioLoadChanged();
}

void IoStatus::addIoReader(const QString &deviceName)
{
    if (!QFile::exists(u"/dev/"_s + deviceName))
        return;
    if (m_ioHash.contains(deviceName))
        return;

    IoReader *ior = new IoReader(deviceName.toLocal8Bit().constData());
    m_ioHash.insert(deviceName, ior);
}

#include "moc_iostatus.cpp"