diff options
Diffstat (limited to 'src/testlib/qbenchmark_p.h')
| -rw-r--r-- | src/testlib/qbenchmark_p.h | 200 |
1 files changed, 200 insertions, 0 deletions
diff --git a/src/testlib/qbenchmark_p.h b/src/testlib/qbenchmark_p.h new file mode 100644 index 0000000000..ace17dbe8b --- /dev/null +++ b/src/testlib/qbenchmark_p.h @@ -0,0 +1,200 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtTest module 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$ +** +****************************************************************************/ + +#ifndef QBENCHMARK_P_H +#define QBENCHMARK_P_H + +#include <stdlib.h> + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include <QtCore/qglobal.h> + +#if (defined(Q_OS_LINUX) || defined Q_OS_MAC) && !defined(QT_NO_PROCESS) +#define QTESTLIB_USE_VALGRIND +#else +#undef QTESTLIB_USE_VALGRIND +#endif + +#include "QtTest/private/qbenchmarkmeasurement_p.h" +#include <QtCore/QMap> +#include <QtTest/qtest_global.h> +#ifdef QTESTLIB_USE_VALGRIND +#include "QtTest/private/qbenchmarkvalgrind_p.h" +#endif +#include "QtTest/private/qbenchmarkevent_p.h" +#include "QtTest/private/qbenchmarkmetric_p.h" + +QT_BEGIN_NAMESPACE + +struct QBenchmarkContext +{ + // None of the strings below are assumed to contain commas (see toString() below) + QString slotName; + QString tag; // from _data() function + + int checkpointIndex; + + QString toString() const + { + QString s = QString::fromLatin1("%1,%2,%3").arg(slotName).arg(tag).arg(checkpointIndex); + return s; + } + + QBenchmarkContext() : checkpointIndex(-1) {} +}; + +class QBenchmarkResult +{ +public: + QBenchmarkContext context; + qreal value; + int iterations; + QTest::QBenchmarkMetric metric; + bool setByMacro; + bool valid; + + QBenchmarkResult() + : value(-1) + , iterations(-1) + , setByMacro(true) + , valid(false) + { } + + QBenchmarkResult( + const QBenchmarkContext &context, const qreal value, const int iterations, + QTest::QBenchmarkMetric metric, bool setByMacro) + : context(context) + , value(value) + , iterations(iterations) + , metric(metric) + , setByMacro(setByMacro) + , valid(true) + { } + + bool operator<(const QBenchmarkResult &other) const + { + return (value / iterations) < (other.value / other.iterations); + } +}; + +/* + The QBenchmarkGlobalData class stores global benchmark-related data. + QBenchmarkGlobalData:current is created at the beginning of qExec() + and cleared at the end. +*/ +class Q_TESTLIB_EXPORT QBenchmarkGlobalData +{ +public: + static QBenchmarkGlobalData *current; + + QBenchmarkGlobalData(); + ~QBenchmarkGlobalData(); + enum Mode { WallTime, CallgrindParentProcess, CallgrindChildProcess, TickCounter, EventCounter }; + void setMode(Mode mode); + Mode mode() const { return mode_; } + QBenchmarkMeasurerBase *createMeasurer(); + int adjustMedianIterationCount(); + + QBenchmarkMeasurerBase *measurer; + QBenchmarkContext context; + int walltimeMinimum; + int iterationCount; + int medianIterationCount; + bool createChart; + bool verboseOutput; + QString callgrindOutFileBase; +private: + Mode mode_; +}; + +/* + The QBenchmarkTestMethodData class stores all benchmark-related data + for the current test case. QBenchmarkTestMethodData:current is + created at the beginning of qInvokeTestMethod() and cleared at + the end. +*/ +class Q_TESTLIB_EXPORT QBenchmarkTestMethodData +{ +public: + static QBenchmarkTestMethodData *current; + QBenchmarkTestMethodData(); + ~QBenchmarkTestMethodData(); + + // Called once for each data row created by the _data function, + // before and after calling the test function itself. + void beginDataRun(); + void endDataRun(); + + bool isBenchmark() const { return result.valid; } + bool resultsAccepted() const { return resultAccepted; } + int adjustIterationCount(int suggestion); + void setResult(qreal value, QTest::QBenchmarkMetric metric, bool setByMacro = true); + + QBenchmarkResult result; + bool resultAccepted; + bool runOnce; + int iterationCount; +}; + +// low-level API: +namespace QTest +{ + int iterationCount(); + void setIterationCountHint(int count); + void setIterationCount(int count); + + Q_TESTLIB_EXPORT void beginBenchmarkMeasurement(); + Q_TESTLIB_EXPORT quint64 endBenchmarkMeasurement(); +} + +QT_END_NAMESPACE + +#endif // QBENCHMARK_H |