src/corelib/thread/qatomic.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtCore module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #ifndef QATOMIC_H
       
    43 #define QATOMIC_H
       
    44 
       
    45 #include <QtCore/qglobal.h>
       
    46 #include <QtCore/qbasicatomic.h>
       
    47 
       
    48 QT_BEGIN_HEADER
       
    49 
       
    50 QT_BEGIN_NAMESPACE
       
    51 
       
    52 QT_MODULE(Core)
       
    53 
       
    54 // High-level atomic integer operations
       
    55 class Q_CORE_EXPORT QAtomicInt : public QBasicAtomicInt
       
    56 {
       
    57 public:
       
    58     inline QAtomicInt(int value = 0)
       
    59     {
       
    60 #ifdef QT_ARCH_PARISC
       
    61         this->_q_lock[0] = this->_q_lock[1] = this->_q_lock[2] = this->_q_lock[3] = -1;
       
    62 #endif
       
    63         _q_value = value;
       
    64     }
       
    65     inline QAtomicInt(const QAtomicInt &other)
       
    66     {
       
    67 #ifdef QT_ARCH_PARISC
       
    68         this->_q_lock[0] = this->_q_lock[1] = this->_q_lock[2] = this->_q_lock[3] = -1;
       
    69 #endif
       
    70         _q_value = other._q_value;
       
    71     }
       
    72 
       
    73     inline QAtomicInt &operator=(int value)
       
    74     {
       
    75         (void) QBasicAtomicInt::operator=(value);
       
    76         return *this;
       
    77     }
       
    78 
       
    79     inline QAtomicInt &operator=(const QAtomicInt &other)
       
    80     {
       
    81         (void) QBasicAtomicInt::operator=(other);
       
    82         return *this;
       
    83     }
       
    84 
       
    85 #ifdef qdoc
       
    86     bool operator==(int value) const;
       
    87     bool operator!=(int value) const;
       
    88     bool operator!() const;
       
    89     operator int() const;
       
    90 
       
    91     static bool isReferenceCountingNative();
       
    92     static bool isReferenceCountingWaitFree();
       
    93 
       
    94     bool ref();
       
    95     bool deref();
       
    96 
       
    97     static bool isTestAndSetNative();
       
    98     static bool isTestAndSetWaitFree();
       
    99 
       
   100     bool testAndSetRelaxed(int expectedValue, int newValue);
       
   101     bool testAndSetAcquire(int expectedValue, int newValue);
       
   102     bool testAndSetRelease(int expectedValue, int newValue);
       
   103     bool testAndSetOrdered(int expectedValue, int newValue);
       
   104 
       
   105     static bool isFetchAndStoreNative();
       
   106     static bool isFetchAndStoreWaitFree();
       
   107 
       
   108     int fetchAndStoreRelaxed(int newValue);
       
   109     int fetchAndStoreAcquire(int newValue);
       
   110     int fetchAndStoreRelease(int newValue);
       
   111     int fetchAndStoreOrdered(int newValue);
       
   112 
       
   113     static bool isFetchAndAddNative();
       
   114     static bool isFetchAndAddWaitFree();
       
   115 
       
   116     int fetchAndAddRelaxed(int valueToAdd);
       
   117     int fetchAndAddAcquire(int valueToAdd);
       
   118     int fetchAndAddRelease(int valueToAdd);
       
   119     int fetchAndAddOrdered(int valueToAdd);
       
   120 #endif
       
   121 };
       
   122 
       
   123 // High-level atomic pointer operations
       
   124 template <typename T>
       
   125 class QAtomicPointer : public QBasicAtomicPointer<T>
       
   126 {
       
   127 public:
       
   128     inline QAtomicPointer(T *value = 0)
       
   129     {
       
   130 #ifdef QT_ARCH_PARISC
       
   131         this->_q_lock[0] = this->_q_lock[1] = this->_q_lock[2] = this->_q_lock[3] = -1;
       
   132 #endif
       
   133         QBasicAtomicPointer<T>::_q_value = value;
       
   134     }
       
   135     inline QAtomicPointer(const QAtomicPointer<T> &other)
       
   136     {
       
   137 #ifdef QT_ARCH_PARISC
       
   138         this->_q_lock[0] = this->_q_lock[1] = this->_q_lock[2] = this->_q_lock[3] = -1;
       
   139 #endif
       
   140         QBasicAtomicPointer<T>::_q_value = other._q_value;
       
   141     }
       
   142 
       
   143     inline QAtomicPointer<T> &operator=(T *value)
       
   144     {
       
   145         (void) QBasicAtomicPointer<T>::operator=(value);
       
   146         return *this;
       
   147     }
       
   148 
       
   149     inline QAtomicPointer<T> &operator=(const QAtomicPointer<T> &other)
       
   150     {
       
   151         (void) QBasicAtomicPointer<T>::operator=(other);
       
   152         return *this;
       
   153     }
       
   154 
       
   155 #ifdef qdoc
       
   156     bool operator==(T *value) const;
       
   157     bool operator!=(T *value) const;
       
   158     bool operator!() const;
       
   159     operator T *() const;
       
   160     T *operator->() const;
       
   161 
       
   162     static bool isTestAndSetNative();
       
   163     static bool isTestAndSetWaitFree();
       
   164 
       
   165     bool testAndSetRelaxed(T *expectedValue, T *newValue);
       
   166     bool testAndSetAcquire(T *expectedValue, T *newValue);
       
   167     bool testAndSetRelease(T *expectedValue, T *newValue);
       
   168     bool testAndSetOrdered(T *expectedValue, T *newValue);
       
   169 
       
   170     static bool isFetchAndStoreNative();
       
   171     static bool isFetchAndStoreWaitFree();
       
   172 
       
   173     T *fetchAndStoreRelaxed(T *newValue);
       
   174     T *fetchAndStoreAcquire(T *newValue);
       
   175     T *fetchAndStoreRelease(T *newValue);
       
   176     T *fetchAndStoreOrdered(T *newValue);
       
   177 
       
   178     static bool isFetchAndAddNative();
       
   179     static bool isFetchAndAddWaitFree();
       
   180 
       
   181     T *fetchAndAddRelaxed(qptrdiff valueToAdd);
       
   182     T *fetchAndAddAcquire(qptrdiff valueToAdd);
       
   183     T *fetchAndAddRelease(qptrdiff valueToAdd);
       
   184     T *fetchAndAddOrdered(qptrdiff valueToAdd);
       
   185 #endif
       
   186 };
       
   187 
       
   188 /*!
       
   189     This is a helper for the assignment operators of implicitly
       
   190     shared classes. Your assignment operator should look like this:
       
   191 
       
   192     \snippet doc/src/snippets/code/src.corelib.thread.qatomic.h 0
       
   193 */
       
   194 template <typename T>
       
   195 inline void qAtomicAssign(T *&d, T *x)
       
   196 {
       
   197     if (d == x)
       
   198         return;
       
   199     x->ref.ref();
       
   200     if (!d->ref.deref())
       
   201         delete d;
       
   202     d = x;
       
   203 }
       
   204 
       
   205 /*!
       
   206     This is a helper for the detach method of implicitly shared
       
   207     classes. Your private class needs a copy constructor which copies
       
   208     the members and sets the refcount to 1. After that, your detach
       
   209     function should look like this:
       
   210 
       
   211     \snippet doc/src/snippets/code/src.corelib.thread.qatomic.h 1
       
   212 */
       
   213 template <typename T>
       
   214 inline void qAtomicDetach(T *&d)
       
   215 {
       
   216     if (d->ref == 1)
       
   217         return;
       
   218     T *x = d;
       
   219     d = new T(*d);
       
   220     if (!x->ref.deref())
       
   221         delete x;
       
   222 }
       
   223 
       
   224 QT_END_NAMESPACE
       
   225 QT_END_HEADER
       
   226 
       
   227 #endif // QATOMIC_H