1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
<?php
/**
* @defgroup Benchmark Benchmark
* @ingroup Maintenance
*/
/**
* Base code for benchmark scripts.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Benchmark
*/
use Wikimedia\RunningStat;
// @codeCoverageIgnoreStart
require_once __DIR__ . '/../Maintenance.php';
// @codeCoverageIgnoreEnd
/**
* Base class for benchmark scripts.
*
* @ingroup Benchmark
*/
abstract class Benchmarker extends Maintenance {
/** @var int */
protected $defaultCount = 100;
public function __construct() {
parent::__construct();
$this->addOption( 'count', "How many times to run a benchmark. Default: {$this->defaultCount}", false, true );
$this->addOption( 'verbose', 'Verbose logging of resource usage', false, false, 'v' );
}
public function bench( array $benchs ) {
$this->startBench();
$count = $this->getOption( 'count', $this->defaultCount );
$verbose = $this->hasOption( 'verbose' );
$normBenchs = [];
$shortNames = [];
// Normalise
foreach ( $benchs as $key => $bench ) {
// Shortcut for simple functions
if ( is_callable( $bench ) ) {
$bench = [ 'function' => $bench ];
}
// Default to no arguments
if ( !isset( $bench['args'] ) ) {
$bench['args'] = [];
}
// Name defaults to name of called function
if ( is_string( $key ) ) {
$name = $key;
} else {
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
if ( is_array( $bench['function'] ) ) {
$class = $bench['function'][0];
if ( is_object( $class ) ) {
$class = get_class( $class );
}
$name = $class . '::' . $bench['function'][1];
} else {
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
$name = strval( $bench['function'] );
}
$argsText = implode(
', ',
array_map(
static function ( $a ) {
return var_export( $a, true );
},
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
$bench['args']
)
);
$index = $shortNames[$name] = ( $shortNames[$name] ?? 0 ) + 1;
$shorten = strlen( $argsText ) > 80 || str_contains( $argsText, "\n" );
if ( !$shorten ) {
$name = "$name($argsText)";
}
if ( $shorten || $index > 1 ) {
$name = "$name@$index";
}
}
$normBenchs[$name] = $bench;
}
foreach ( $normBenchs as $name => $bench ) {
// Optional setup called outside time measure
if ( isset( $bench['setup'] ) ) {
call_user_func( $bench['setup'] );
}
// Run benchmarks
$stat = new RunningStat();
for ( $i = 0; $i < $count; $i++ ) {
// Setup outside of time measure for each loop
if ( isset( $bench['setupEach'] ) ) {
$bench['setupEach']();
}
$t = microtime( true );
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
call_user_func_array( $bench['function'], $bench['args'] );
$t = ( microtime( true ) - $t ) * 1000;
if ( $verbose ) {
$this->verboseRun( $i );
}
$stat->addObservation( $t );
}
$this->addResult( [
'name' => $name,
'count' => $stat->getCount(),
// Get rate per second from mean (in ms)
'rate' => $stat->getMean() == 0 ? INF : ( 1.0 / ( $stat->getMean() / 1000.0 ) ),
'total' => $stat->getMean() * $stat->getCount(),
'mean' => $stat->getMean(),
'max' => $stat->max,
'stddev' => $stat->getStdDev(),
'usage' => [
'mem' => memory_get_usage( true ),
'mempeak' => memory_get_peak_usage( true ),
],
] );
}
}
public function startBench() {
$this->output(
sprintf( "Running PHP version %s (%s) on %s %s %s\n\n",
phpversion(),
php_uname( 'm' ),
php_uname( 's' ),
php_uname( 'r' ),
php_uname( 'v' )
)
);
}
public function addResult( $res ) {
$ret = sprintf( "%s\n %' 6s: %d\n",
$res['name'],
'count',
$res['count']
);
$ret .= sprintf( " %' 6s: %8.1f/s\n",
'rate',
$res['rate']
);
foreach ( [ 'total', 'mean', 'max', 'stddev' ] as $metric ) {
$ret .= sprintf( " %' 6s: %8.2fms\n",
$metric,
$res[$metric]
);
}
foreach ( [
'mem' => 'Current memory usage',
'mempeak' => 'Peak memory usage'
] as $key => $label ) {
$ret .= sprintf( "%' 20s: %s\n",
$label,
$this->formatSize( $res['usage'][$key] )
);
}
$this->output( "$ret\n" );
}
protected function verboseRun( $iteration ) {
$this->output( sprintf( "#%3d - memory: %-10s - peak: %-10s\n",
$iteration,
$this->formatSize( memory_get_usage( true ) ),
$this->formatSize( memory_get_peak_usage( true ) )
) );
}
/**
* Format an amount of bytes into short human-readable string.
*
* This is simplified version of Language::formatSize() to avoid pulling
* all the general MediaWiki services, which can significantly influence
* measured memory use.
*
* @param int|float $bytes
* @return string Formatted in using IEC bytes (multiples of 1024)
*/
private function formatSize( $bytes ): string {
if ( $bytes >= ( 1024 ** 3 ) ) {
return number_format( $bytes / ( 1024 ** 3 ), 2 ) . ' GiB';
}
if ( $bytes >= ( 1024 ** 2 ) ) {
return number_format( $bytes / ( 1024 ** 2 ), 2 ) . ' MiB';
}
if ( $bytes >= 1024 ) {
return number_format( $bytes / 1024, 1 ) . ' KiB';
}
return $bytes . ' B';
}
/**
* @since 1.32
* @param string $file Path to file (maybe compressed with gzip)
* @return string|false Contents of file, or false if file not found
*/
protected function loadFile( $file ) {
$content = file_get_contents( $file );
// Detect GZIP compression header
if ( str_starts_with( $content, "\037\213" ) ) {
$content = gzdecode( $content );
}
return $content;
}
}
|
