libcalamares: deal with QMutexLocker

- Add a compat/ directory with support for Calamares-named
  variations of Qt classes where there are relevant differences
  between Qt5 and Qt6
This commit is contained in:
Adriaan de Groot 2023-09-03 14:39:54 +02:00
parent 50f2a6ad4a
commit 27329a497a
7 changed files with 53 additions and 19 deletions

View File

@ -11,33 +11,34 @@
#include "GlobalStorage.h" #include "GlobalStorage.h"
#include "compat/Mutex.h"
#include "utils/Logger.h" #include "utils/Logger.h"
#include "utils/Units.h" #include "utils/Units.h"
#include "utils/Yaml.h" #include "utils/Yaml.h"
#include <QFile> #include <QFile>
#include <QJsonDocument> #include <QJsonDocument>
#include <QMutexLocker>
using namespace CalamaresUtils::Units; using namespace CalamaresUtils::Units;
namespace Calamares namespace Calamares
{ {
class GlobalStorage::ReadLock : public QMutexLocker class GlobalStorage::ReadLock : public MutexLocker
{ {
public: public:
ReadLock( const GlobalStorage* gs ) ReadLock( const GlobalStorage* gs )
: QMutexLocker( &gs->m_mutex ) : MutexLocker( &gs->m_mutex )
{ {
} }
}; };
class GlobalStorage::WriteLock : public QMutexLocker class GlobalStorage::WriteLock : public MutexLocker
{ {
public: public:
WriteLock( GlobalStorage* gs ) WriteLock( GlobalStorage* gs )
: QMutexLocker( &gs->m_mutex ) : MutexLocker( &gs->m_mutex )
, m_gs( gs ) , m_gs( gs )
{ {
} }

View File

@ -13,10 +13,10 @@
#include "CalamaresConfig.h" #include "CalamaresConfig.h"
#include "GlobalStorage.h" #include "GlobalStorage.h"
#include "Job.h" #include "Job.h"
#include "compat/Mutex.h"
#include "utils/Logger.h" #include "utils/Logger.h"
#include <QMutex> #include <QMutex>
#include <QMutexLocker>
#include <QThread> #include <QThread>
#include <memory> #include <memory>
@ -61,8 +61,8 @@ public:
void finalize() void finalize()
{ {
Q_ASSERT( m_runningJobs->isEmpty() ); Q_ASSERT( m_runningJobs->isEmpty() );
QMutexLocker qlock( &m_enqueMutex ); Calamares::MutexLocker qlock( &m_enqueMutex );
QMutexLocker rlock( &m_runMutex ); Calamares::MutexLocker rlock( &m_runMutex );
std::swap( m_runningJobs, m_queuedJobs ); std::swap( m_runningJobs, m_queuedJobs );
m_overallQueueWeight m_overallQueueWeight
= m_runningJobs->isEmpty() ? 0.0 : ( m_runningJobs->last().cumulative + m_runningJobs->last().weight ); = m_runningJobs->isEmpty() ? 0.0 : ( m_runningJobs->last().cumulative + m_runningJobs->last().weight );
@ -83,7 +83,7 @@ public:
void enqueue( int moduleWeight, const JobList& jobs ) void enqueue( int moduleWeight, const JobList& jobs )
{ {
QMutexLocker qlock( &m_enqueMutex ); Calamares::MutexLocker qlock( &m_enqueMutex );
qreal cumulative qreal cumulative
= m_queuedJobs->isEmpty() ? 0.0 : ( m_queuedJobs->last().cumulative + m_queuedJobs->last().weight ); = m_queuedJobs->isEmpty() ? 0.0 : ( m_queuedJobs->last().cumulative + m_queuedJobs->last().weight );
@ -108,7 +108,7 @@ public:
void run() override void run() override
{ {
QMutexLocker rlock( &m_runMutex ); Calamares::MutexLocker rlock( &m_runMutex );
bool failureEncountered = false; bool failureEncountered = false;
QString message; ///< Filled in with errors QString message; ///< Filled in with errors
QString details; QString details;
@ -159,7 +159,7 @@ public:
*/ */
QStringList queuedJobs() const QStringList queuedJobs() const
{ {
QMutexLocker qlock( &m_enqueMutex ); Calamares::MutexLocker qlock( &m_enqueMutex );
QStringList l; QStringList l;
l.reserve( m_queuedJobs->count() ); l.reserve( m_queuedJobs->count() );
for ( const auto& j : *m_queuedJobs ) for ( const auto& j : *m_queuedJobs )

View File

@ -0,0 +1,30 @@
/* === This file is part of Calamares - <https://calamares.io> ===
*
* SPDX-FileCopyrightText: 2023 Adriaan de Groot <groot@kde.org>
* SPDX-License-Identifier: GPL-3.0-or-later
*
* Calamares is Free Software: see the License-Identifier above.
*
*
*/
#ifndef CALAMARES_COMPAT_MUTEX_H
#define CALAMARES_COMPAT_MUTEX_H
#include <QMutexLocker>
namespace Calamares
{
/*
* In Qt5, QMutexLocker is a class and operates implicitly on
* QMutex but in Qt6 it is a template and needs a specialization.
*/
#if QT_VERSION < QT_VERSION_CHECK( 6, 0, 0 )
using MutexLocker = QMutexLocker;
#else
using MutexLocker = QMutexLocker< QMutex >;
#endif
} // namespace Calamares
#endif

View File

@ -10,6 +10,7 @@
#include "RequirementsChecker.h" #include "RequirementsChecker.h"
#include "compat/Mutex.h"
#include "modulesystem/Module.h" #include "modulesystem/Module.h"
#include "modulesystem/Requirement.h" #include "modulesystem/Requirement.h"
#include "modulesystem/RequirementsModel.h" #include "modulesystem/RequirementsModel.h"
@ -61,7 +62,7 @@ void
RequirementsChecker::finished() RequirementsChecker::finished()
{ {
static QMutex finishedMutex; static QMutex finishedMutex;
QMutexLocker lock( &finishedMutex ); Calamares::MutexLocker lock( &finishedMutex );
if ( m_progressTimer if ( m_progressTimer
&& std::all_of( && std::all_of(

View File

@ -10,6 +10,7 @@
#include "RequirementsModel.h" #include "RequirementsModel.h"
#include "compat/Mutex.h"
#include "utils/Logger.h" #include "utils/Logger.h"
namespace Calamares namespace Calamares
@ -18,7 +19,7 @@ namespace Calamares
void void
RequirementsModel::clear() RequirementsModel::clear()
{ {
QMutexLocker l( &m_addLock ); Calamares::MutexLocker l( &m_addLock );
beginResetModel(); beginResetModel();
m_requirements.clear(); m_requirements.clear();
endResetModel(); endResetModel();
@ -28,7 +29,7 @@ RequirementsModel::clear()
void void
RequirementsModel::addRequirementsList( const Calamares::RequirementsList& requirements ) RequirementsModel::addRequirementsList( const Calamares::RequirementsList& requirements )
{ {
QMutexLocker l( &m_addLock ); Calamares::MutexLocker l( &m_addLock );
beginResetModel(); beginResetModel();
for ( const auto& r : requirements ) for ( const auto& r : requirements )

View File

@ -9,11 +9,11 @@
#include "Manager.h" #include "Manager.h"
#include "compat/Mutex.h"
#include "utils/Logger.h" #include "utils/Logger.h"
#include <QEventLoop> #include <QEventLoop>
#include <QMutex> #include <QMutex>
#include <QMutexLocker>
#include <QNetworkAccessManager> #include <QNetworkAccessManager>
#include <QNetworkReply> #include <QNetworkReply>
#include <QNetworkRequest> #include <QNetworkRequest>
@ -84,7 +84,7 @@ namMutex()
QNetworkAccessManager* QNetworkAccessManager*
Manager::Private::nam() Manager::Private::nam()
{ {
QMutexLocker lock( namMutex() ); Calamares::MutexLocker lock( namMutex() );
auto* thread = QThread::currentThread(); auto* thread = QThread::currentThread();
for ( const auto& n : m_perThreadNams ) for ( const auto& n : m_perThreadNams )
@ -106,7 +106,7 @@ Manager::Private::nam()
void void
Manager::Private::cleanupNam() Manager::Private::cleanupNam()
{ {
QMutexLocker lock( namMutex() ); Calamares::MutexLocker lock( namMutex() );
auto* thread = QThread::currentThread(); auto* thread = QThread::currentThread();
bool cleanupFound = false; bool cleanupFound = false;

View File

@ -14,6 +14,7 @@
#include "Logger.h" #include "Logger.h"
#include "CalamaresVersionX.h" #include "CalamaresVersionX.h"
#include "compat/Mutex.h"
#include "utils/Dirs.h" #include "utils/Dirs.h"
#include <QCoreApplication> #include <QCoreApplication>
@ -84,7 +85,7 @@ log_enabled( unsigned int level )
static void static void
log_implementation( const char* msg, unsigned int debugLevel, const bool withTime ) log_implementation( const char* msg, unsigned int debugLevel, const bool withTime )
{ {
QMutexLocker lock( &s_mutex ); Calamares::MutexLocker lock( &s_mutex );
const auto date = QDate::currentDate().toString( Qt::ISODate ); const auto date = QDate::currentDate().toString( Qt::ISODate );
const auto time = QTime::currentTime().toString(); const auto time = QTime::currentTime().toString();
@ -173,7 +174,7 @@ setupLogfile()
// Lock while (re-)opening the logfile // Lock while (re-)opening the logfile
{ {
QMutexLocker lock( &s_mutex ); Calamares::MutexLocker lock( &s_mutex );
logfile.open( logFile().toLocal8Bit(), std::ios::app ); logfile.open( logFile().toLocal8Bit(), std::ios::app );
if ( logfile.tellp() ) if ( logfile.tellp() )
{ {