24use Wikimedia\ScopedCallback;
56 $this->collateOnly = empty(
$params[
'trace'] );
100 $totalCpu = max( $this->end[
'cpu'] - $this->start[
'cpu'], 0 );
101 $totalReal = max( $this->end[
'real'] - $this->start[
'real'], 0 );
102 $totalMem = max( $this->end[
'memory'] - $this->start[
'memory'], 0 );
105 foreach ( $this->collated
as $fname => $data ) {
108 'calls' => $data[
'count'],
109 'real' => $data[
'real'] * 1000,
110 '%real' => $totalReal ? 100 * $data[
'real'] / $totalReal : 0,
111 'cpu' => $data[
'cpu'] * 1000,
112 '%cpu' => $totalCpu ? 100 * $data[
'cpu'] / $totalCpu : 0,
113 'memory' => $data[
'memory'],
114 '%memory' => $totalMem ? 100 * $data[
'memory'] / $totalMem : 0,
115 'min_real' => 1000 * $data[
'min_real'],
116 'max_real' => 1000 * $data[
'max_real']
123 'real' => 1000 * $totalReal,
125 'cpu' => 1000 * $totalCpu,
127 'memory' => $totalMem,
129 'min_real' => 1000 * $totalReal,
130 'max_real' => 1000 * $totalReal
143 $this->workStack = [];
144 $this->collated = [];
145 $this->collateDone =
false;
179 protected function updateEntry( $name, $elapsedCpu, $elapsedReal, $memChange ) {
180 $entry =& $this->collated[
$name];
181 if ( !is_array( $entry ) ) {
183 $this->collated[
$name] =& $entry;
185 $entry[
'cpu'] += $elapsedCpu;
186 $entry[
'real'] += $elapsedReal;
187 $entry[
'memory'] += $memChange > 0 ? $memChange : 0;
189 $entry[
'min_real'] = min( $entry[
'min_real'], $elapsedReal );
190 $entry[
'max_real'] = max( $entry[
'max_real'], $elapsedReal );
202 $this->collateDone =
false;
204 $cpu = $this->
getTime(
'cpu' );
205 $real = $this->
getTime(
'wall' );
206 $memory = memory_get_usage();
208 if ( $this->start ===
null ) {
209 $this->start = [
'cpu' => $cpu,
'real' => $real,
'memory' => $memory ];
212 $this->workStack[] = [
214 count( $this->workStack ),
227 $item = array_pop( $this->workStack );
228 if ( $item ===
null ) {
229 $this->
debugGroup(
'profileerror',
"Profiling error: $functionname" );
232 list( $ofname, , $ortime, $octime, $omem ) = $item;
234 if ( $functionname ===
'close' ) {
235 $message =
"Profile section ended by close(): {$ofname}";
236 $this->
debugGroup(
'profileerror', $message );
237 if ( $this->collateOnly ) {
240 $this->stack[] = [ $message, 0, 0.0, 0.0, 0, 0.0, 0.0, 0 ];
242 $functionname = $ofname;
243 } elseif ( $ofname !== $functionname ) {
244 $message =
"Profiling error: in({$ofname}), out($functionname)";
245 $this->
debugGroup(
'profileerror', $message );
246 if ( $this->collateOnly ) {
249 $this->stack[] = [ $message, 0, 0.0, 0.0, 0, 0.0, 0.0, 0 ];
253 $realTime = $this->
getTime(
'wall' );
254 $cpuTime = $this->
getTime(
'cpu' );
255 $memUsage = memory_get_usage();
257 if ( $this->collateOnly ) {
258 $elapsedcpu = $cpuTime - $octime;
259 $elapsedreal = $realTime - $ortime;
260 $memchange = $memUsage - $omem;
261 $this->
updateEntry( $functionname, $elapsedcpu, $elapsedreal, $memchange );
263 $this->stack[] = array_merge( $item, [ $realTime, $cpuTime, $memUsage ] );
269 'memory' => $memUsage
279 if ( $this->collateOnly ) {
280 throw new Exception(
"Tree is only available for trace profiling." );
282 return implode(
'', array_map(
283 [ $this,
'getCallTreeLine' ], $this->
remapCallTree( $this->stack )
294 if ( count(
$stack ) < 2 ) {
298 for ( $max = count(
$stack ) - 1; $max > 0; ) {
302 for ( $i = $max -1; $i >= 0; $i-- ) {
303 if (
$stack[$i][1] > $level ) {
309 $working = $this->
remapCallTree( array_reverse( $working ) );
311 foreach ( $working
as $item ) {
317 array_unshift( $outputs,
$output );
335 list(
$fname, $level, $startreal, , , $endreal ) = $entry;
336 $delta = $endreal - $startreal;
337 $space = str_repeat(
' ', $level );
338 # The ugly double sprintf is to work around a PHP bug,
339 # which has been fixed in recent releases.
340 return sprintf(
"%10s %s %s\n",
341 trim( sprintf(
"%7.3f", $delta * 1000.0 ) ), $space,
$fname );
348 if ( $this->collateDone ) {
351 $this->collateDone =
true;
353 while ( count( $this->workStack ) ) {
357 if ( $this->collateOnly ) {
361 $this->collated = [];
363 # Estimate profiling overhead
365 $profileCount = count( $this->stack );
368 # First, subtract the overhead!
369 $overheadTotal = $overheadMemory = $overheadInternal = [];
370 foreach ( $this->stack
as $entry ) {
373 $elapsed = $entry[5] - $entry[2];
374 $memchange = $entry[7] - $entry[4];
376 if (
$fname ===
'-overhead-total' ) {
377 $overheadTotal[] = $elapsed;
378 $overheadMemory[] = max( 0, $memchange );
379 } elseif (
$fname ===
'-overhead-internal' ) {
380 $overheadInternal[] = $elapsed;
383 $overheadTotal = $overheadTotal ?
384 array_sum( $overheadTotal ) / count( $overheadInternal ) : 0;
385 $overheadMemory = $overheadMemory ?
386 array_sum( $overheadMemory ) / count( $overheadInternal ) : 0;
387 $overheadInternal = $overheadInternal ?
388 array_sum( $overheadInternal ) / count( $overheadInternal ) : 0;
391 foreach ( $this->stack
as $index => $entry ) {
394 $elapsedCpu = $entry[6] - $entry[3];
395 $elapsedReal = $entry[5] - $entry[2];
396 $memchange = $entry[7] - $entry[4];
399 if ( substr(
$fname, 0, 9 ) !==
'-overhead' ) {
400 # Adjust for profiling overhead (except special values with elapsed=0)
402 $elapsed -= $overheadInternal;
403 $elapsed -= ( $subcalls * $overheadTotal );
404 $memchange -= ( $subcalls * $overheadMemory );
411 $this->collated[
'-overhead-total'][
'count'] = $profileCount;
412 arsort( $this->collated, SORT_NUMERIC );
415 $this->end = $oldEnd;
425 for ( $i = 0; $i < $profileCount; $i++ ) {
443 for ( $i =
$start -1; $i >= 0 &&
$stack[$i][1] > $level; $i-- ) {
459 protected function getTime( $metric =
'wall' ) {
460 if ( $metric ===
'cpu' || $metric ===
'user' ) {
465 $time = $ru[
'ru_utime.tv_sec'] + $ru[
'ru_utime.tv_usec'] / 1e6;
466 if ( $metric ===
'cpu' ) {
467 # This is the time of system calls, added to the user time
468 # it gives the total CPU time
469 $time += $ru[
'ru_stime.tv_sec'] + $ru[
'ru_stime.tv_usec'] / 1e6;
473 return microtime(
true );
483 if ( function_exists(
'wfDebug' ) ) {
495 if ( function_exists(
'wfDebugLog' ) ) {
517 parent::__construct(
null );
523 $this->profiler->profileOutInternal( $this->section );
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
wfGetRusage()
Get system resource usage of current request context.
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.
__construct(SectionProfiler $profiler, $section)
SectionProfiler $profiler
Custom PHP profiler for parser/DB type section names that xhprof/xdebug can't handle.
array $stack
List of resolved profile calls with start/end data.
remapCallTree(array $stack)
Recursive function the format the current profiling array into a tree.
getCallTreeLine( $entry)
Callback to get a formatted line for the call tree.
profileInInternal( $functionname)
This method should not be called outside SectionProfiler.
array $errorEntry
Cache of a standard broken collation entry.
scopedProfileOut(ScopedCallback &$section)
array $collated
Map of (function name => aggregate data array)
debug( $s)
Add an entry in the debug log file.
getTime( $metric='wall')
Get the initial time of the request, based on getrusage()
bool $collateOnly
Whether to collect the full stack trace or just aggregates.
__construct(array $params=[])
array $workStack
Queue of open profile calls with start data.
array $start
Map of (mem,real,cpu)
debugGroup( $group, $s)
Add an entry in the debug log group.
getFunctionStats()
Get the aggregated inclusive profiling data for each method.
getCallTreeReport()
Returns a tree of function calls with their real times.
scopedProfileIn( $section)
calculateOverhead( $profileCount)
Dummy calls to calculate profiling overhead.
profileOutInternal( $functionname)
This method should not be called outside SectionProfiler.
reset()
Clear all of the profiling data for another run.
updateEntry( $name, $elapsedCpu, $elapsedReal, $memChange)
Update the collation entry for a given method name.
array $end
Map of (mem,real,cpu)
calltreeCount( $stack, $start)
Counts the number of profiled function calls sitting under the given point in the call graph.
collateData()
Populate collated data.
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
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
the array() calling protocol came about after MediaWiki 1.4rc1.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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
see documentation in includes Linker php for Linker::makeImageLink & $time
Allows to change the fields on the form that will be generated $name
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $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