1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). |
4 | ** Contact: http://www.qt-project.org/legal |
5 | ** |
6 | ** This file is part of the QtTest module of the Qt Toolkit. |
7 | ** |
8 | ** $QT_BEGIN_LICENSE:LGPL$ |
9 | ** Commercial License Usage |
10 | ** Licensees holding valid commercial Qt licenses may use this file in |
11 | ** accordance with the commercial license agreement provided with the |
12 | ** Software or, alternatively, in accordance with the terms contained in |
13 | ** a written agreement between you and Digia. For licensing terms and |
14 | ** conditions see http://qt.digia.com/licensing. For further information |
15 | ** use the contact form at http://qt.digia.com/contact-us. |
16 | ** |
17 | ** GNU Lesser General Public License Usage |
18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
19 | ** General Public License version 2.1 as published by the Free Software |
20 | ** Foundation and appearing in the file LICENSE.LGPL included in the |
21 | ** packaging of this file. Please review the following information to |
22 | ** ensure the GNU Lesser General Public License version 2.1 requirements |
23 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
24 | ** |
25 | ** In addition, as a special exception, Digia gives you certain additional |
26 | ** rights. These rights are described in the Digia Qt LGPL Exception |
27 | ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
28 | ** |
29 | ** GNU General Public License Usage |
30 | ** Alternatively, this file may be used under the terms of the GNU |
31 | ** General Public License version 3.0 as published by the Free Software |
32 | ** Foundation and appearing in the file LICENSE.GPL included in the |
33 | ** packaging of this file. Please review the following information to |
34 | ** ensure the GNU General Public License version 3.0 requirements will be |
35 | ** met: http://www.gnu.org/copyleft/gpl.html. |
36 | ** |
37 | ** |
38 | ** $QT_END_LICENSE$ |
39 | ** |
40 | ****************************************************************************/ |
41 | |
42 | #ifndef QBENCHMARK_P_H |
43 | #define QBENCHMARK_P_H |
44 | |
45 | #include <stdlib.h> |
46 | |
47 | // |
48 | // W A R N I N G |
49 | // ------------- |
50 | // |
51 | // This file is not part of the Qt API. It exists purely as an |
52 | // implementation detail. This header file may change from version to |
53 | // version without notice, or even be removed. |
54 | // |
55 | // We mean it. |
56 | // |
57 | |
58 | #include <QtCore/qglobal.h> |
59 | |
60 | #if (defined(Q_OS_LINUX) || defined Q_OS_MAC) && !defined(QT_NO_PROCESS) |
61 | #define QTESTLIB_USE_VALGRIND |
62 | #else |
63 | #undef QTESTLIB_USE_VALGRIND |
64 | #endif |
65 | |
66 | #include "QtTest/private/qbenchmarkmeasurement_p.h" |
67 | #include <QtCore/QMap> |
68 | #include <QtTest/qtest_global.h> |
69 | #ifdef QTESTLIB_USE_VALGRIND |
70 | #include "QtTest/private/qbenchmarkvalgrind_p.h" |
71 | #endif |
72 | #include "QtTest/private/qbenchmarkevent_p.h" |
73 | #include "QtTest/private/qbenchmarkmetric_p.h" |
74 | |
75 | QT_BEGIN_NAMESPACE |
76 | |
77 | struct QBenchmarkContext |
78 | { |
79 | // None of the strings below are assumed to contain commas (see toString() below) |
80 | QString slotName; |
81 | QString tag; // from _data() function |
82 | |
83 | int checkpointIndex; |
84 | |
85 | QString toString() const |
86 | { |
87 | QString s = QString::fromLatin1("%1,%2,%3" ).arg(slotName).arg(tag).arg(checkpointIndex); |
88 | return s; |
89 | } |
90 | |
91 | QBenchmarkContext() : checkpointIndex(-1) {} |
92 | }; |
93 | |
94 | class QBenchmarkResult |
95 | { |
96 | public: |
97 | QBenchmarkContext context; |
98 | qreal value; |
99 | int iterations; |
100 | QTest::QBenchmarkMetric metric; |
101 | bool setByMacro; |
102 | bool valid; |
103 | |
104 | QBenchmarkResult() |
105 | : value(-1) |
106 | , iterations(-1) |
107 | , setByMacro(true) |
108 | , valid(false) |
109 | { } |
110 | |
111 | QBenchmarkResult( |
112 | const QBenchmarkContext &context, const qreal value, const int iterations, |
113 | QTest::QBenchmarkMetric metric, bool setByMacro) |
114 | : context(context) |
115 | , value(value) |
116 | , iterations(iterations) |
117 | , metric(metric) |
118 | , setByMacro(setByMacro) |
119 | , valid(true) |
120 | { } |
121 | |
122 | bool operator<(const QBenchmarkResult &other) const |
123 | { |
124 | return (value / iterations) < (other.value / other.iterations); |
125 | } |
126 | }; |
127 | |
128 | /* |
129 | The QBenchmarkGlobalData class stores global benchmark-related data. |
130 | QBenchmarkGlobalData:current is created at the beginning of qExec() |
131 | and cleared at the end. |
132 | */ |
133 | class Q_TESTLIB_EXPORT QBenchmarkGlobalData |
134 | { |
135 | public: |
136 | static QBenchmarkGlobalData *current; |
137 | |
138 | QBenchmarkGlobalData(); |
139 | ~QBenchmarkGlobalData(); |
140 | enum Mode { WallTime, CallgrindParentProcess, CallgrindChildProcess, TickCounter, EventCounter }; |
141 | void setMode(Mode mode); |
142 | Mode mode() const { return mode_; } |
143 | QBenchmarkMeasurerBase *createMeasurer(); |
144 | int adjustMedianIterationCount(); |
145 | |
146 | QBenchmarkMeasurerBase *measurer; |
147 | QBenchmarkContext context; |
148 | int walltimeMinimum; |
149 | int iterationCount; |
150 | int medianIterationCount; |
151 | bool createChart; |
152 | bool verboseOutput; |
153 | QString callgrindOutFileBase; |
154 | private: |
155 | Mode mode_; |
156 | }; |
157 | |
158 | /* |
159 | The QBenchmarkTestMethodData class stores all benchmark-related data |
160 | for the current test case. QBenchmarkTestMethodData:current is |
161 | created at the beginning of qInvokeTestMethod() and cleared at |
162 | the end. |
163 | */ |
164 | class Q_TESTLIB_EXPORT QBenchmarkTestMethodData |
165 | { |
166 | public: |
167 | static QBenchmarkTestMethodData *current; |
168 | QBenchmarkTestMethodData(); |
169 | ~QBenchmarkTestMethodData(); |
170 | |
171 | // Called once for each data row created by the _data function, |
172 | // before and after calling the test function itself. |
173 | void beginDataRun(); |
174 | void endDataRun(); |
175 | |
176 | bool isBenchmark() const { return result.valid; } |
177 | bool resultsAccepted() const { return resultAccepted; } |
178 | int adjustIterationCount(int suggestion); |
179 | void setResult(qreal value, QTest::QBenchmarkMetric metric, bool setByMacro = true); |
180 | |
181 | QBenchmarkResult result; |
182 | bool resultAccepted; |
183 | bool runOnce; |
184 | int iterationCount; |
185 | }; |
186 | |
187 | // low-level API: |
188 | namespace QTest |
189 | { |
190 | int iterationCount(); |
191 | void setIterationCountHint(int count); |
192 | void setIterationCount(int count); |
193 | |
194 | Q_TESTLIB_EXPORT void beginBenchmarkMeasurement(); |
195 | Q_TESTLIB_EXPORT quint64 endBenchmarkMeasurement(); |
196 | } |
197 | |
198 | QT_END_NAMESPACE |
199 | |
200 | #endif // QBENCHMARK_H |
201 | |