Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract Qt atomic operation wrappers into separate header file #4306

Merged
merged 1 commit into from
Sep 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions src/control/controlvalue.h
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
#pragma once

#include <limits>

#include <QAtomicInt>
#include <QObject>
#include <limits>

#include "util/assert.h"
#include "util/compatibility.h"
#include "util/compatibility/qatomic.h"

// for lock free access, this value has to be >= the number of value using threads
// value must be a fraction of an integer
Expand Down
2 changes: 1 addition & 1 deletion src/controllers/bulk/bulkcontroller.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#include "controllers/controllerdebug.h"
#include "controllers/defs_controllers.h"
#include "moc_bulkcontroller.cpp"
#include "util/compatibility.h"
#include "util/compatibility/qatomic.h"
#include "util/time.h"
#include "util/trace.h"

Expand Down
2 changes: 1 addition & 1 deletion src/engine/cachingreader/cachingreader.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#include "moc_cachingreader.cpp"
#include "track/track.h"
#include "util/assert.h"
#include "util/compatibility.h"
#include "util/compatibility/qatomic.h"
#include "util/counter.h"
#include "util/logger.h"
#include "util/math.h"
Expand Down
2 changes: 1 addition & 1 deletion src/engine/cachingreader/cachingreaderworker.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#include "moc_cachingreaderworker.cpp"
#include "sources/soundsourceproxy.h"
#include "track/track.h"
#include "util/compatibility.h"
#include "util/compatibility/qatomic.h"
#include "util/compatibility/qmutex.h"
#include "util/event.h"
#include "util/logger.h"
Expand Down
2 changes: 1 addition & 1 deletion src/engine/controls/loopingcontrol.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#include "moc_loopingcontrol.cpp"
#include "preferences/usersettings.h"
#include "track/track.h"
#include "util/compatibility.h"
#include "util/compatibility/qatomic.h"
#include "util/math.h"
#include "util/sample.h"

Expand Down
2 changes: 1 addition & 1 deletion src/engine/enginebuffer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
#include "track/keyutils.h"
#include "track/track.h"
#include "util/assert.h"
#include "util/compatibility.h"
#include "util/compatibility/qatomic.h"
#include "util/defs.h"
#include "util/logger.h"
#include "util/sample.h"
Expand Down
1 change: 1 addition & 0 deletions src/engine/sidechain/shoutconnection.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
#include "preferences/usersettings.h"
#include "recording/defs_recording.h"
#include "track/track.h"
#include "util/compatibility/qatomic.h"
#include "util/logger.h"

namespace {
Expand Down
1 change: 1 addition & 0 deletions src/library/coverartdelegate.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
#include "library/trackmodel.h"
#include "moc_coverartdelegate.cpp"
#include "track/track.h"
#include "util/compatibility.h"
#include "util/logger.h"

namespace {
Expand Down
1 change: 1 addition & 0 deletions src/library/dlgcoverartfullsize.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#include "library/coverartutils.h"
#include "moc_dlgcoverartfullsize.cpp"
#include "track/track.h"
#include "util/compatibility.h"
#include "util/widgethelper.h"

DlgCoverArtFullSize::DlgCoverArtFullSize(QWidget* parent, BaseTrackPlayer* pPlayer)
Expand Down
1 change: 1 addition & 0 deletions src/library/export/trackexportworker.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

#include "moc_trackexportworker.cpp"
#include "track/track.h"
#include "util/compatibility/qatomic.h"

namespace {

Expand Down
1 change: 1 addition & 0 deletions src/mixer/playermanager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
#include "soundio/soundmanager.h"
#include "track/track.h"
#include "util/assert.h"
#include "util/compatibility/qatomic.h"
#include "util/defs.h"
#include "util/logger.h"
#include "util/sleepableqthread.h"
Expand Down
2 changes: 1 addition & 1 deletion src/preferences/broadcastprofile.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ using namespace QKeychain;
#include "defs_urls.h"
#include "moc_broadcastprofile.cpp"
#include "recording/defs_recording.h"
#include "util/compatibility.h"
#include "util/compatibility/qatomic.h"
#include "util/logger.h"
#include "util/memory.h"
#include "util/xml.h"
Expand Down
1 change: 1 addition & 0 deletions src/preferences/dialog/dlgprefinterface.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
#include "skin/legacy/legacyskinparser.h"
#include "skin/skin.h"
#include "skin/skinloader.h"
#include "util/compatibility.h"
#include "util/screensaver.h"
#include "util/screensavermanager.h"
#include "util/widgethelper.h"
Expand Down
2 changes: 1 addition & 1 deletion src/soundio/soundmanager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#include "soundio/sounddeviceportaudio.h"
#include "soundio/soundmanagerutil.h"
#include "util/cmdlineargs.h"
#include "util/compatibility.h"
#include "util/compatibility/qatomic.h"
#include "util/defs.h"
#include "util/sample.h"
#include "util/sleep.h"
Expand Down
86 changes: 2 additions & 84 deletions src/util/compatibility.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
#pragma once

// TODO: Split this file into separate header files in subdirectory util/compatibility

#include <QCoreApplication>
#include <QGuiApplication>
#include <QScreen>
Expand Down Expand Up @@ -36,87 +38,3 @@ QString uuidToNullableStringWithoutBraces(const QUuid& uuid) {
return uuidToStringWithoutBraces(uuid);
}
}

template <typename T>
inline T atomicLoadAcquire(const QAtomicInteger<T>& atomicInt) {
// TODO: QBasicAtomicInteger<T>::load() is deprecated and should be
// replaced with QBasicAtomicInteger<T>::loadRelaxed() However, the
// proposed alternative has just been introduced in Qt 5.14. Until the
// minimum required Qt version of Mixxx is increased, we need a version
// check here
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
return atomicInt.loadAcquire();
#else
return atomicInt.load();
#endif
}

template <typename T>
inline T* atomicLoadAcquire(const QAtomicPointer<T>& atomicPtr) {
// TODO: QBasicAtomicPointer<T>::load() is deprecated and should be
// replaced with QBasicAtomicPointer<T>::loadRelaxed() However, the
// proposed alternative has just been introduced in Qt 5.14. Until the
// minimum required Qt version of Mixxx is increased, we need a version
// check here
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
return atomicPtr.loadAcquire();
#else
return atomicPtr.load();
#endif
}

template <typename T>
inline T atomicLoadRelaxed(const QAtomicInteger<T>& atomicInt) {
// TODO: QBasicAtomicInteger<T>::load() is deprecated and should be
// replaced with QBasicAtomicInteger<T>::loadRelaxed() However, the
// proposed alternative has just been introduced in Qt 5.14. Until the
// minimum required Qt version of Mixxx is increased, we need a version
// check here
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
return atomicInt.loadRelaxed();
#else
return atomicInt.load();
#endif
}

template <typename T>
inline T* atomicLoadRelaxed(const QAtomicPointer<T>& atomicPtr) {
// TODO: QBasicAtomicPointer<T>::load() is deprecated and should be
// replaced with QBasicAtomicPointer<T>::loadRelaxed() However, the
// proposed alternative has just been introduced in Qt 5.14. Until the
// minimum required Qt version of Mixxx is increased, we need a version
// check here
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
return atomicPtr.loadRelaxed();
#else
return atomicPtr.load();
#endif
}

template <typename T>
inline void atomicStoreRelaxed(QAtomicInteger<T>& atomicInt, T newValue) {
// TODO: QBasicAtomicInteger<T>::store(T newValue) is deprecated and should
// be replaced with QBasicAtomicInteger<T>::storeRelaxed(T newValue)
// However, the proposed alternative has just been introduced in Qt 5.14.
// Until the minimum required Qt version of Mixxx is increased, we need a
// version check here
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
atomicInt.storeRelaxed(newValue);
#else
atomicInt.store(newValue);
#endif
}

template <typename T>
inline void atomicStoreRelaxed(QAtomicPointer<T>& atomicPtr, T* newValue) {
// TODO: QBasicAtomicPointer<T>::store(T* newValue) is deprecated and
// should be replaced with QBasicAtomicPointer<T>::storeRelaxed(T*
// newValue) However, the proposed alternative has just been introduced in
// Qt 5.14. Until the minimum required Qt version of Mixxx is increased, we
// need a version check here
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
atomicPtr.storeRelaxed(newValue);
#else
atomicPtr.store(newValue);
#endif
}
64 changes: 64 additions & 0 deletions src/util/compatibility/qatomic.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
#pragma once

#include <QAtomicInteger>
#include <QAtomicPointer>

// TODO: QBasicAtomicInteger/Pointer<T>::load/store() are deprecated and
// should be replaced with their explicit relaxed/acquire/release counterparts.
// However, the proposed alternatives have just been introduced in Qt 5.14.
// Until the minimum required Qt version of Mixxx is increased some utility
// functions that work independently of the Qt version are needed.

template<typename T>
inline T atomicLoadAcquire(const QAtomicInteger<T>& atomicInt) {
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
return atomicInt.loadAcquire();
#else
return atomicInt.load();
#endif
}

template<typename T>
inline T* atomicLoadAcquire(const QAtomicPointer<T>& atomicPtr) {
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
return atomicPtr.loadAcquire();
#else
return atomicPtr.load();
#endif
}

template<typename T>
inline T atomicLoadRelaxed(const QAtomicInteger<T>& atomicInt) {
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
return atomicInt.loadRelaxed();
#else
return atomicInt.load();
#endif
}

template<typename T>
inline T* atomicLoadRelaxed(const QAtomicPointer<T>& atomicPtr) {
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
return atomicPtr.loadRelaxed();
#else
return atomicPtr.load();
#endif
}

template<typename T>
inline void atomicStoreRelaxed(QAtomicInteger<T>& atomicInt, T newValue) {
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
atomicInt.storeRelaxed(newValue);
#else
atomicInt.store(newValue);
#endif
}

template<typename T>
inline void atomicStoreRelaxed(QAtomicPointer<T>& atomicPtr, T* newValue) {
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
atomicPtr.storeRelaxed(newValue);
#else
atomicPtr.store(newValue);
#endif
}
2 changes: 1 addition & 1 deletion src/util/statsmanager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

#include "moc_statsmanager.cpp"
#include "util/cmdlineargs.h"
#include "util/compatibility.h"
#include "util/compatibility/qatomic.h"
#include "util/compatibility/qmutex.h"

// In practice we process stats pipes about once a minute @1ms latency.
Expand Down
2 changes: 1 addition & 1 deletion src/util/task.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#include <QtDebug>

#include "moc_task.cpp"
#include "util/compatibility.h"
#include "util/compatibility/qatomic.h"

TaskWatcher::TaskWatcher(QObject* pParent) : QObject(pParent) {
}
Expand Down
2 changes: 1 addition & 1 deletion src/waveform/waveform.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#include <vector>

#include "util/class.h"
#include "util/compatibility.h"
#include "util/compatibility/qatomic.h"
#include "util/compatibility/qmutex.h"

enum FilterIndex { Low = 0, Mid = 1, High = 2, FilterCount = 3};
Expand Down