napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[libcalamares] Address outdates assumptions about thread-safety

Browse Source
This commit is contained in:
Adriaan de Groot 2020-08-06 23:27:04 +02:00
parent 0121e3755b
commit dc5d98af7d
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/libcalamares/GlobalStorage.h
View File

@ -22,6 +22,7 @@
#ifndef CALAMARES_GLOBALSTORAGE_H #ifndef CALAMARES_GLOBALSTORAGE_H
#define CALAMARES_GLOBALSTORAGE_H #define CALAMARES_GLOBALSTORAGE_H
#include <QMutex>
#include <QObject> #include <QObject>
#include <QString> #include <QString>
#include <QVariantMap> #include <QVariantMap>
@ -45,8 +46,11 @@ namespace Calamares
* *
* In general, see QVariantMap (possibly after calling data()) for details. * In general, see QVariantMap (possibly after calling data()) for details.
* *
* This class is not thread-safe, but as long as JobQueue is, that's ok * This class is thread-safe -- most accesses go through JobQueue, which
* because only one module is active at a time. * handles threading itself, but because modules load in parallel and can
* have asynchronous tasks like GeoIP lookups, the storage itself also
* has locking. All methods are thread-safe, use data() to make a snapshot
* copy for use outside of the thread-safe API.
*/ */
class GlobalStorage : public QObject class GlobalStorage : public QObject
{ {
@ -117,13 +121,11 @@ public:
*/ */
bool loadYaml( const QString& filename ); bool loadYaml( const QString& filename );
/** @brief Get internal mapping as a constant object /** @brief Make a complete copy of the data
* *
* Note that the VariantMap underneath may change, because * Provides a snapshot of the data at a given time.
* it's not constant in itself. Connect to the changed()
* signal for notifications.
*/ */
const QVariantMap& data() const { return m; } QVariantMap data() const { return m; }
public Q_SLOTS: public Q_SLOTS:
/** @brief Does the store contain the given key? /** @brief Does the store contain the given key?
@ -164,7 +166,10 @@ signals:
void changed(); void changed();
private: private:
class ReadLock;
class WriteLock;
QVariantMap m; QVariantMap m;
mutable QMutex m_mutex;
}; };
} // namespace Calamares } // namespace Calamares