/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the test suite of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include <QtTest/QtTest>

#include <QAtomicInt>

#include <QCoreApplication>

#include <limits.h>

//TESTED_CLASS=

//TESTED_FILES=

class tst_QAtomicInt : public QObject

{

    Q_OBJECT

public:

    tst_QAtomicInt();

    ~tst_QAtomicInt();

private slots:

    void warningFree();

    // QAtomicInt members

    void constructor_data();

    void constructor();

    void copy_constructor_data();

    void copy_constructor();

    void equality_operator_data();

    void equality_operator();

    void inequality_operator_data();

    void inequality_operator();

    void not_operator_data();

    void not_operator();

    void cast_operator_data();

    void cast_operator();

    void assignment_operator_data();

    void assignment_operator();

    void isReferenceCountingNative();

    void isReferenceCountingWaitFree();

    void ref_data();

    void ref();

    void deref_data();

    void deref();

    void isTestAndSetNative();

    void isTestAndSetWaitFree();

    void testAndSet_data();

    void testAndSet();

    void isFetchAndStoreNative();

    void isFetchAndStoreWaitFree();

    void fetchAndStore_data();

    void fetchAndStore();

    void isFetchAndAddNative();

    void isFetchAndAddWaitFree();

    void fetchAndAdd_data();

    void fetchAndAdd();

    // stress tests

    void testAndSet_loop();

    void fetchAndAdd_loop();

    void fetchAndAdd_threadedLoop();

private:

    static void warningFreeHelper();

};

tst_QAtomicInt::tst_QAtomicInt()

{ }

tst_QAtomicInt::~tst_QAtomicInt()

{ }

void tst_QAtomicInt::warningFreeHelper()

{

    Q_ASSERT(false);

    // The code below is bogus, and shouldn't be run. We're looking for warnings, only.

    QBasicAtomicInt i = Q_BASIC_ATOMIC_INITIALIZER(0);

    int expectedValue = 0;

    int newValue = 0;

    int valueToAdd = 0;

    i.ref();

    i.deref();

    i.testAndSetRelaxed(expectedValue, newValue);

    i.testAndSetAcquire(expectedValue, newValue);

    i.testAndSetRelease(expectedValue, newValue);

    i.testAndSetOrdered(expectedValue, newValue);

    i.fetchAndStoreRelaxed(newValue);

    i.fetchAndStoreAcquire(newValue);

    i.fetchAndStoreRelease(newValue);

    i.fetchAndStoreOrdered(newValue);

    i.fetchAndAddRelaxed(valueToAdd);

    i.fetchAndAddAcquire(valueToAdd);

    i.fetchAndAddRelease(valueToAdd);

    i.fetchAndAddOrdered(valueToAdd);

}

void tst_QAtomicInt::warningFree()

{

    // This is a compile time check for warnings.

    // No need for actual work here.

    void (*foo)() = &warningFreeHelper;

    (void)foo;

}

void tst_QAtomicInt::constructor_data()

{

    QTest::addColumn<int>("value");

    QTest::newRow("0") << 31337;

    QTest::newRow("1") << 0;

    QTest::newRow("2") << 1;

    QTest::newRow("3") << -1;

    QTest::newRow("4") << 2;

    QTest::newRow("5") << -2;

    QTest::newRow("6") << 3;

    QTest::newRow("7") << -3;

    QTest::newRow("8") << INT_MAX;

    QTest::newRow("9") << INT_MIN+1;

}

void tst_QAtomicInt::constructor()

{

    QFETCH(int, value);

    QAtomicInt atomic1(value);

    QCOMPARE(int(atomic1), value);

    QAtomicInt atomic2 = value;

    QCOMPARE(int(atomic2), value);

}

void tst_QAtomicInt::copy_constructor_data()

{ constructor_data(); }

void tst_QAtomicInt::copy_constructor()

{

    QFETCH(int, value);

    QAtomicInt atomic1(value);

    QCOMPARE(int(atomic1), value);

    QAtomicInt atomic2(atomic1);

    QCOMPARE(int(atomic2), value);

    QAtomicInt atomic3 = atomic1;

    QCOMPARE(int(atomic3), value);

    QAtomicInt atomic4(atomic2);

    QCOMPARE(int(atomic4), value);

    QAtomicInt atomic5 = atomic2;

    QCOMPARE(int(atomic5), value);

}

void tst_QAtomicInt::equality_operator_data()

{

    QTest::addColumn<int>("value1");

    QTest::addColumn<int>("value2");

    QTest::addColumn<int>("result");

    QTest::newRow("success0") <<  1 <<  1 << 1;

    QTest::newRow("success1") << -1 << -1 << 1;

    QTest::newRow("failure0") <<  0 <<  1 << 0;

    QTest::newRow("failure1") <<  1 <<  0 << 0;

    QTest::newRow("failure2") <<  0 << -1 << 0;

    QTest::newRow("failure3") << -1 <<  0 << 0;

}

void tst_QAtomicInt::equality_operator()

{

    QFETCH(int, value1);

    QFETCH(int, value2);

    QAtomicInt x = value1;

    QTEST(x == value2 ? 1 : 0, "result");

}

void tst_QAtomicInt::inequality_operator_data()

{

    QTest::addColumn<int>("value1");

    QTest::addColumn<int>("value2");

    QTest::addColumn<int>("result");

    QTest::newRow("failure0") <<  1 <<  1 << 0;

    QTest::newRow("failure1") << -1 << -1 << 0;

    QTest::newRow("success0") <<  0 <<  1 << 1;

    QTest::newRow("success1") <<  1 <<  0 << 1;

    QTest::newRow("success2") <<  0 << -1 << 1;

    QTest::newRow("success3") << -1 <<  0 << 1;

}

void tst_QAtomicInt::inequality_operator()

{

    QFETCH(int, value1);

    QFETCH(int, value2);

    QAtomicInt x = value1;

    QTEST(x != value2 ? 1 : 0, "result");

}

void tst_QAtomicInt::not_operator_data()

{ constructor_data(); }

void tst_QAtomicInt::not_operator()

{

    QFETCH(int, value);

    QAtomicInt atomic = value;

    QCOMPARE(!atomic, !value);

}

void tst_QAtomicInt::cast_operator_data()

{ constructor_data(); }

void tst_QAtomicInt::cast_operator()

{

    QFETCH(int, value);

    QAtomicInt atomic = value;

    int copy = atomic;

    QCOMPARE(copy, value);

}

void tst_QAtomicInt::assignment_operator_data()

{

    QTest::addColumn<int>("value");

    QTest::addColumn<int>("newval");

    QTest::newRow("value0") <<  0 <<  1;

    QTest::newRow("value1") <<  1 <<  0;

    QTest::newRow("value2") <<  0 << -1;

    QTest::newRow("value3") << -1 <<  0;

    QTest::newRow("value4") << -1 <<  1;

    QTest::newRow("value5") <<  1 << -1;

}

void tst_QAtomicInt::assignment_operator()

{

    QFETCH(int, value);

    QFETCH(int, newval);

    {

        QAtomicInt atomic1 = value;

        atomic1 = newval;

        QCOMPARE(int(atomic1), newval);

        atomic1 = value;

        QCOMPARE(int(atomic1), value);

        QAtomicInt atomic2 = newval;

        atomic1 = atomic2;

        QCOMPARE(atomic1, atomic2);

    }

}

void tst_QAtomicInt::isReferenceCountingNative()

{

#if defined(Q_ATOMIC_INT_REFERENCE_COUNTING_IS_ALWAYS_NATIVE)

    // the runtime test should say the same thing

    QVERIFY(QAtomicInt::isReferenceCountingNative());

#  if (defined(Q_ATOMIC_INT_REFERENCE_COUNTING_IS_SOMETIMES_NATIVE)     \

       || defined(Q_ATOMIC_INT_REFERENCE_COUNTING_IS_NOT_NATIVE))

#    error "Define only one of Q_ATOMIC_INT_REFERENCE_COUNTING_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE"

#  endif

#elif defined(Q_ATOMIC_INT_REFERENCE_COUNTING_IS_SOMETIMES_NATIVE)

    // could be either, just want to make sure the function is implemented

    QVERIFY(QAtomicInt::isReferenceCountingNative() || !QAtomicInt::isReferenceCountingNative());

#  if (defined(Q_ATOMIC_INT_REFERENCE_COUNTING_IS_ALWAYS_NATIVE) \

       || defined(Q_ATOMIC_INT_REFERENCE_COUNTING_IS_NOT_NATIVE))

#    error "Define only one of Q_ATOMIC_INT_REFERENCE_COUNTING_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE"

#  endif

#elif defined(Q_ATOMIC_INT_REFERENCE_COUNTING_IS_NOT_NATIVE)

    // the runtime test should say the same thing

    QVERIFY(!QAtomicInt::isReferenceCountingNative());

#  if (defined(Q_ATOMIC_INT_REFERENCE_COUNTING_IS_ALWAYS_NATIVE) \

       || defined(Q_ATOMIC_INT_REFERENCE_COUNTING_IS_SOMETIMES_NATIVE))

#    error "Define only one of Q_ATOMIC_INT_REFERENCE_COUNTING_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE"

#  endif

#else

#  error "Q_ATOMIC_INT_REFERENCE_COUNTING_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE is not defined"

#endif

}

void tst_QAtomicInt::isReferenceCountingWaitFree()

{

#if defined(Q_ATOMIC_INT_REFERENCE_COUNTING_IS_WAIT_FREE)

    // the runtime test should say the same thing

    QVERIFY(QAtomicInt::isReferenceCountingWaitFree());

    // enforce some invariants

    QVERIFY(QAtomicInt::isReferenceCountingNative());

#  if defined(Q_ATOMIC_INT_REFERENCE_COUNTING_IS_NOT_NATIVE)

#    error "Reference counting cannot be wait-free and unsupported at the same time!"

#  endif

#else

    // the runtime test should say the same thing

    QVERIFY(!QAtomicInt::isReferenceCountingWaitFree());

#endif

}

void tst_QAtomicInt::ref_data()

{

    QTest::addColumn<int>("value");

    QTest::addColumn<int>("result");

    QTest::addColumn<int>("expected");

    QTest::newRow("data0") <<  0 << 1 << 1;

    QTest::newRow("data1") << -1 << 0 << 0;

    QTest::newRow("data2") <<  1 << 1 << 2;

}

void tst_QAtomicInt::ref()

{

    QFETCH(int, value);

    QAtomicInt x = value;

    QTEST(x.ref() ? 1 : 0, "result");

    QTEST(int(x), "expected");

}

void tst_QAtomicInt::deref_data()

{

    QTest::addColumn<int>("value");

    QTest::addColumn<int>("result");

    QTest::addColumn<int>("expected");

    QTest::newRow("data0") <<  0 << 1 << -1;

    QTest::newRow("data1") <<  1 << 0 <<  0;

    QTest::newRow("data2") <<  2 << 1 <<  1;

}

void tst_QAtomicInt::deref()

{

    QFETCH(int, value);

    QAtomicInt x = value;

    QTEST(x.deref() ? 1 : 0, "result");

    QTEST(int(x), "expected");

}

void tst_QAtomicInt::isTestAndSetNative()

{

#if defined(Q_ATOMIC_INT_TEST_AND_SET_IS_ALWAYS_NATIVE)

    // the runtime test should say the same thing

    QVERIFY(QAtomicInt::isTestAndSetNative());

#  if (defined(Q_ATOMIC_INT_TEST_AND_SET_IS_SOMETIMES_NATIVE)     \

       || defined(Q_ATOMIC_INT_TEST_AND_SET_IS_NOT_NATIVE))

#    error "Define only one of Q_ATOMIC_INT_TEST_AND_SET_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE"

#  endif

#elif defined(Q_ATOMIC_INT_TEST_AND_SET_IS_SOMETIMES_NATIVE)

    // could be either, just want to make sure the function is implemented

    QVERIFY(QAtomicInt::isTestAndSetNative() || !QAtomicInt::isTestAndSetNative());

#  if (defined(Q_ATOMIC_INT_TEST_AND_SET_IS_ALWAYS_NATIVE) \

       || defined(Q_ATOMIC_INT_TEST_AND_SET_IS_NOT_NATIVE))

#    error "Define only one of Q_ATOMIC_INT_TEST_AND_SET_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE"

#  endif

#elif defined(Q_ATOMIC_INT_TEST_AND_SET_IS_NOT_NATIVE)

    // the runtime test should say the same thing

    QVERIFY(!QAtomicInt::isTestAndSetNative());

#  if (defined(Q_ATOMIC_INT_TEST_AND_SET_IS_ALWAYS_NATIVE) \

       || defined(Q_ATOMIC_INT_TEST_AND_SET_IS_SOMETIMES_NATIVE))

#    error "Define only one of Q_ATOMIC_INT_TEST_AND_SET_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE"

#  endif

#else

#  error "Q_ATOMIC_INT_TEST_AND_SET_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE is not defined"

#endif

}

void tst_QAtomicInt::isTestAndSetWaitFree()

{

#if defined(Q_ATOMIC_INT_TEST_AND_SET_IS_WAIT_FREE)

    // the runtime test should say the same thing

    QVERIFY(QAtomicInt::isTestAndSetWaitFree());

    // enforce some invariants

    QVERIFY(QAtomicInt::isTestAndSetNative());

#  if defined(Q_ATOMIC_INT_TEST_AND_SET_IS_NOT_NATIVE)

#    error "Reference counting cannot be wait-free and unsupported at the same time!"

#  endif

#else

    // the runtime test should say the same thing

    QVERIFY(!QAtomicInt::isTestAndSetWaitFree());

#endif

}

void tst_QAtomicInt::testAndSet_data()

{

    QTest::addColumn<int>("value");

    QTest::addColumn<int>("expected");

    QTest::addColumn<int>("newval");

    QTest::addColumn<int>("result");

    // these should succeed

    QTest::newRow("success0") <<         0 <<         0 <<         0 << 1;

    QTest::newRow("success1") <<         0 <<         0 <<         1 << 1;

    QTest::newRow("success2") <<         0 <<         0 <<        -1 << 1;

    QTest::newRow("success3") <<         1 <<         1 <<         0 << 1;

    QTest::newRow("success4") <<         1 <<         1 <<         1 << 1;

    QTest::newRow("success5") <<         1 <<         1 <<        -1 << 1;

    QTest::newRow("success6") <<        -1 <<        -1 <<         0 << 1;

    QTest::newRow("success7") <<        -1 <<        -1 <<         1 << 1;

    QTest::newRow("success8") <<        -1 <<        -1 <<        -1 << 1;

    QTest::newRow("success9") << INT_MIN+1 << INT_MIN+1 << INT_MIN+1 << 1;

    QTest::newRow("successA") << INT_MIN+1 << INT_MIN+1 <<         1 << 1;

    QTest::newRow("successB") << INT_MIN+1 << INT_MIN+1 <<        -1 << 1;

    QTest::newRow("successC") << INT_MAX   << INT_MAX   << INT_MAX   << 1;

    QTest::newRow("successD") << INT_MAX   << INT_MAX   <<         1 << 1;

    QTest::newRow("successE") << INT_MAX   << INT_MAX   <<        -1 << 1;

    // these should fail

    QTest::newRow("failure0") <<       0   <<       1   <<        ~0 << 0;

    QTest::newRow("failure1") <<       0   <<      -1   <<        ~0 << 0;

    QTest::newRow("failure2") <<       1   <<       0   <<        ~0 << 0;

    QTest::newRow("failure3") <<      -1   <<       0   <<        ~0 << 0;

    QTest::newRow("failure4") <<       1   <<      -1   <<        ~0 << 0;

    QTest::newRow("failure5") <<      -1   <<       1   <<        ~0 << 0;

    QTest::newRow("failure6") << INT_MIN+1 << INT_MAX   <<        ~0 << 0;

    QTest::newRow("failure7") << INT_MAX   << INT_MIN+1 <<        ~0 << 0;

}

void tst_QAtomicInt::testAndSet()

{

    QFETCH(int, value);

    QFETCH(int, expected);

    QFETCH(int, newval);

    {

        QAtomicInt atomic = value;

        QTEST(atomic.testAndSetRelaxed(expected, newval) ? 1 : 0, "result");

    }

    {

        QAtomicInt atomic = value;

        QTEST(atomic.testAndSetAcquire(expected, newval) ? 1 : 0, "result");

    }

    {

        QAtomicInt atomic = value;

        QTEST(atomic.testAndSetRelease(expected, newval) ? 1 : 0, "result");

    }

    {

        QAtomicInt atomic = value;

        QTEST(atomic.testAndSetOrdered(expected, newval) ? 1 : 0, "result");

    }

}

void tst_QAtomicInt::isFetchAndStoreNative()

{

#if defined(Q_ATOMIC_INT_FETCH_AND_STORE_IS_ALWAYS_NATIVE)

    // the runtime test should say the same thing

    QVERIFY(QAtomicInt::isFetchAndStoreNative());

#  if (defined(Q_ATOMIC_INT_FETCH_AND_STORE_IS_SOMETIMES_NATIVE)     \

       || defined(Q_ATOMIC_INT_FETCH_AND_STORE_IS_NOT_NATIVE))

#    error "Define only one of Q_ATOMIC_INT_FETCH_AND_STORE_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE"

#  endif

#elif defined(Q_ATOMIC_INT_FETCH_AND_STORE_IS_SOMETIMES_NATIVE)

    // could be either, just want to make sure the function is implemented

    QVERIFY(QAtomicInt::isFetchAndStoreNative() || !QAtomicInt::isFetchAndStoreNative());

#  if (defined(Q_ATOMIC_INT_FETCH_AND_STORE_IS_ALWAYS_NATIVE) \

       || defined(Q_ATOMIC_INT_FETCH_AND_STORE_IS_NOT_NATIVE))

#    error "Define only one of Q_ATOMIC_INT_FETCH_AND_STORE_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE"

#  endif

#elif defined(Q_ATOMIC_INT_FETCH_AND_STORE_IS_NOT_NATIVE)

    // the runtime test should say the same thing

    QVERIFY(!QAtomicInt::isFetchAndStoreNative());

#  if (defined(Q_ATOMIC_INT_FETCH_AND_STORE_IS_ALWAYS_NATIVE) \

       || defined(Q_ATOMIC_INT_FETCH_AND_STORE_IS_SOMETIMES_NATIVE))

#    error "Define only one of Q_ATOMIC_INT_FETCH_AND_STORE_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE"

#  endif

#else

#  error "Q_ATOMIC_INT_FETCH_AND_STORE_IS_{ALWAYS,SOMTIMES,NOT}_NATIVE is not defined"

#endif

}

void tst_QAtomicInt::isFetchAndStoreWaitFree()

{

#if defined(Q_ATOMIC_INT_FETCH_AND_STORE_IS_WAIT_FREE)

    // the runtime test should say the same thing

    QVERIFY(QAtomicInt::isFetchAndStoreWaitFree());

    // enforce some invariants