57 $this->collateOnly = empty(
$params[
'trace'] );
58 $this->profileOutCallback =
function ( $profiler,
$section ) {
59 $profiler->profileOutInternal(
$section );
104 $totalCpu = max( $this->end[
'cpu'] - $this->start[
'cpu'], 0 );
105 $totalReal = max( $this->end[
'real'] - $this->start[
'real'], 0 );
106 $totalMem = max( $this->end[
'memory'] - $this->start[
'memory'], 0 );
109 foreach ( $this->collated
as $fname => $data ) {
112 'calls' => $data[
'count'],
113 'real' => $data[
'real'] * 1000,
114 '%real' => $totalReal ? 100 * $data[
'real'] / $totalReal : 0,
115 'cpu' => $data[
'cpu'] * 1000,
116 '%cpu' => $totalCpu ? 100 * $data[
'cpu'] / $totalCpu : 0,
117 'memory' => $data[
'memory'],
118 '%memory' => $totalMem ? 100 * $data[
'memory'] / $totalMem : 0,
119 'min_real' => 1000 * $data[
'min_real'],
120 'max_real' => 1000 * $data[
'max_real']
127 'real' => 1000 * $totalReal,
129 'cpu' => 1000 * $totalCpu,
131 'memory' => $totalMem,
133 'min_real' => 1000 * $totalReal,
134 'max_real' => 1000 * $totalReal
147 $this->workStack = [];
148 $this->collated = [];
149 $this->collateDone =
false;
184 $entry =& $this->collated[
$name];
185 if ( !is_array( $entry ) ) {
187 $this->collated[
$name] =& $entry;
189 $entry[
'cpu'] += $elapsedCpu;
190 $entry[
'real'] += $elapsedReal;
191 $entry[
'memory'] += $memChange > 0 ? $memChange : 0;
193 $entry[
'min_real'] = min( $entry[
'min_real'], $elapsedReal );
194 $entry[
'max_real'] = max( $entry[
'max_real'], $elapsedReal );
206 $this->collateDone =
false;
208 $cpu = $this->
getTime(
'cpu' );
209 $real = $this->
getTime(
'wall' );
210 $memory = memory_get_usage();
212 if ( $this->start === null ) {
213 $this->start = [
'cpu' => $cpu,
'real' => $real,
'memory' => $memory ];
216 $this->workStack[] = [
218 count( $this->workStack ),
231 $item = array_pop( $this->workStack );
232 if ( $item === null ) {
233 $this->
debugGroup(
'profileerror',
"Profiling error: $functionname" );
236 list( $ofname, , $ortime, $octime, $omem ) = $item;
238 if ( $functionname ===
'close' ) {
239 $message =
"Profile section ended by close(): {$ofname}";
240 $this->
debugGroup(
'profileerror', $message );
241 if ( $this->collateOnly ) {
244 $this->stack[] = [ $message, 0, 0.0, 0.0, 0, 0.0, 0.0, 0 ];
246 $functionname = $ofname;
247 } elseif ( $ofname !== $functionname ) {
248 $message =
"Profiling error: in({$ofname}), out($functionname)";
249 $this->
debugGroup(
'profileerror', $message );
250 if ( $this->collateOnly ) {
253 $this->stack[] = [ $message, 0, 0.0, 0.0, 0, 0.0, 0.0, 0 ];
257 $realTime = $this->
getTime(
'wall' );
258 $cpuTime = $this->
getTime(
'cpu' );
259 $memUsage = memory_get_usage();
261 if ( $this->collateOnly ) {
262 $elapsedcpu = $cpuTime - $octime;
263 $elapsedreal = $realTime - $ortime;
264 $memchange = $memUsage - $omem;
265 $this->
updateEntry( $functionname, $elapsedcpu, $elapsedreal, $memchange );
267 $this->stack[] = array_merge( $item, [ $realTime, $cpuTime, $memUsage ] );
273 'memory' => $memUsage
283 if ( $this->collateOnly ) {
284 throw new Exception(
"Tree is only available for trace profiling." );
286 return implode(
'', array_map(
287 [ $this,
'getCallTreeLine' ], $this->
remapCallTree( $this->stack )
298 if ( count( $stack ) < 2 ) {
302 for ( $max = count( $stack ) - 1; $max > 0; ) {
304 $level = $stack[$max][1];
306 for ( $i = $max -1; $i >= 0; $i-- ) {
307 if ( $stack[$i][1] > $level ) {
308 $working[] = $stack[$i];
313 $working = $this->
remapCallTree( array_reverse( $working ) );
315 foreach ( $working
as $item ) {
318 array_unshift(
$output, $stack[$max] );
321 array_unshift( $outputs,
$output );
325 foreach ( $output
as $item ) {
339 list(
$fname, $level, $startreal, , , $endreal ) = $entry;
340 $delta = $endreal - $startreal;
341 $space = str_repeat(
' ', $level );
342 # The ugly double sprintf is to work around a PHP bug,
343 # which has been fixed in recent releases.
344 return sprintf(
"%10s %s %s\n",
345 trim( sprintf(
"%7.3f", $delta * 1000.0 ) ), $space,
$fname );
352 if ( $this->collateDone ) {
355 $this->collateDone =
true;
357 while ( count( $this->workStack ) ) {
361 if ( $this->collateOnly ) {
365 $this->collated = [];
367 # Estimate profiling overhead
369 $profileCount = count( $this->stack );
372 # First, subtract the overhead!
373 $overheadTotal = $overheadMemory = $overheadInternal = [];
374 foreach ( $this->stack
as $entry ) {
377 $elapsed = $entry[5] - $entry[2];
378 $memchange = $entry[7] - $entry[4];
380 if (
$fname ===
'-overhead-total' ) {
381 $overheadTotal[] = $elapsed;
382 $overheadMemory[] = max( 0, $memchange );
383 } elseif (
$fname ===
'-overhead-internal' ) {
384 $overheadInternal[] = $elapsed;
387 $overheadTotal = $overheadTotal ?
388 array_sum( $overheadTotal ) / count( $overheadInternal ) : 0;
389 $overheadMemory = $overheadMemory ?
390 array_sum( $overheadMemory ) / count( $overheadInternal ) : 0;
391 $overheadInternal = $overheadInternal ?
392 array_sum( $overheadInternal ) / count( $overheadInternal ) : 0;
395 foreach ( $this->stack
as $index => $entry ) {
398 $elapsedCpu = $entry[6] - $entry[3];
399 $elapsedReal = $entry[5] - $entry[2];
400 $memchange = $entry[7] - $entry[4];
403 if ( substr(
$fname, 0, 9 ) !==
'-overhead' ) {
404 # Adjust for profiling overhead (except special values with elapsed=0)
406 $elapsed -= $overheadInternal;
407 $elapsed -= ( $subcalls * $overheadTotal );
408 $memchange -= ( $subcalls * $overheadMemory );
415 $this->collated[
'-overhead-total'][
'count'] = $profileCount;
416 arsort( $this->collated, SORT_NUMERIC );
419 $this->end = $oldEnd;
429 for ( $i = 0; $i < $profileCount; $i++ ) {
447 for ( $i =
$start -1; $i >= 0 &&
$stack[$i][1] > $level; $i-- ) {
463 protected function getTime( $metric =
'wall' ) {
464 if ( $metric ===
'cpu' || $metric ===
'user' ) {
469 $time = $ru[
'ru_utime.tv_sec'] + $ru[
'ru_utime.tv_usec'] / 1e6;
470 if ( $metric ===
'cpu' ) {
471 # This is the time of system calls, added to the user time
472 # it gives the total CPU time
473 $time += $ru[
'ru_stime.tv_sec'] + $ru[
'ru_stime.tv_usec'] / 1e6;
477 return microtime(
true );
487 if ( function_exists(
'wfDebug' ) ) {
499 if ( function_exists(
'wfDebugLog' ) ) {
521 parent::__construct( null );
527 $this->profiler->profileOutInternal( $this->section );
array $collated
Map of (function name => aggregate data array)
reset()
Clear all of the profiling data for another run.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
the array() calling protocol came about after MediaWiki 1.4rc1.
array $start
Map of (mem,real,cpu)
profileOutInternal($functionname)
This method should not be called outside SectionProfiler.
profileInInternal($functionname)
This method should not be called outside SectionProfiler.
wfGetRusage()
Get system resource usage of current request context.
collateData()
Populate collated data.
array $stack
List of resolved profile calls with start/end data.
scopedProfileOut(ScopedCallback &$section)
getCallTreeReport()
Returns a tree of function calls with their real times.
see documentation in includes Linker php for Linker::makeImageLink & $time
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Custom PHP profiler for parser/DB type section names that xhprof/xdebug can't handle.
Class for asserting that a callback happens when an dummy object leaves scope.
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
calltreeCount($stack, $start)
Counts the number of profiled function calls sitting under the given point in the call graph...
array $workStack
Queue of open profile calls with start data.
__construct(array $params=[])
getFunctionStats()
Get the aggregated inclusive profiling data for each method.
getCallTreeLine($entry)
Callback to get a formatted line for the call tree.
debug($s)
Add an entry in the debug log file.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
array $end
Map of (mem,real,cpu)
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
__construct(SectionProfiler $profiler, $section)
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined...
Subclass ScopedCallback to avoid call_user_func_array(), which is slow.
getTime($metric= 'wall')
Get the initial time of the request, based on getrusage()
scopedProfileIn($section)
updateEntry($name, $elapsedCpu, $elapsedReal, $memChange)
Update the collation entry for a given method name.
SectionProfiler $profiler
debugGroup($group, $s)
Add an entry in the debug log group.
bool $collateOnly
Whether to collect the full stack trace or just aggregates.
remapCallTree(array $stack)
Recursive function the format the current profiling array into a tree.
array $errorEntry
Cache of a standard broken collation entry.
callable $profileOutCallback
Cache of a profile out callback.
calculateOverhead($profileCount)
Dummy calls to calculate profiling overhead.
Allows to change the fields on the form that will be generated $name