<?php
/**
+ * @defgroup Profiler Profiler
+ *
+ * @file
+ * @ingroup Profiler
* This file is only included if profiling is enabled
- * @addtogroup Profiler
*/
/** backward compatibility */
/**
* Begin profiling of a function
- * @param $functioname name of the function we will profile
+ * @param $functionname String: name of the function we will profile
*/
function wfProfileIn( $functionname ) {
global $wgProfiler;
/**
* Stop profiling of a function
- * @param $functioname name of the function we have profiled
+ * @param $functionname String: name of the function we have profiled
*/
function wfProfileOut( $functionname = 'missing' ) {
global $wgProfiler;
/**
* Returns a profiling output to be stored in debug file
*
- * @param float $start
- * @param float $elapsed time elapsed since the beginning of the request
+ * @param $start Float
+ * @param $elapsed Float: time elapsed since the beginning of the request
*/
function wfGetProfilingOutput( $start, $elapsed ) {
global $wgProfiler;
}
/**
+ * @ingroup Profiler
* @todo document
- * @addtogroup Profiler
*/
class Profiler {
var $mStack = array (), $mWorkStack = array (), $mCollated = array ();
var $mCalls = array (), $mTotals = array ();
+ var $mTemplated = false;
function __construct() {
// Push an entry for the pre-profile setup time onto the stack
/**
* Called by wfProfieIn()
- * @param string $functionname
+ *
+ * @param $functionname String
*/
function profileIn( $functionname ) {
- global $wgDebugFunctionEntry;
-
+ global $wgDebugFunctionEntry, $wgProfiling;
+ if( !$wgProfiling ) return;
if( $wgDebugFunctionEntry ){
$this->debug( str_repeat( ' ', count( $this->mWorkStack ) ) . 'Entering ' . $functionname . "\n" );
}
/**
* Called by wfProfieOut()
- * @param string $functionname
+ *
+ * @param $functionname String
*/
function profileOut($functionname) {
- global $wgDebugFunctionEntry;
-
+ global $wgDebugFunctionEntry, $wgProfiling;
+ if( !$wgProfiling ) return;
$memory = memory_get_usage();
$time = $this->getTime();
* called by wfProfileClose()
*/
function close() {
+ global $wgProfiling;
+
+ # Avoid infinite loop
+ if( !$wgProfiling )
+ return;
+
while( count( $this->mWorkStack ) ){
$this->profileOut( 'close' );
}
}
/**
- * called by wfGetProfilingOutput()
+ * Mark this call as templated or not
+ *
+ * @param $t Boolean
+ */
+ function setTemplated( $t ) {
+ $this->mTemplated = $t;
+ }
+
+ /**
+ * Called by wfGetProfilingOutput()
*/
function getOutput() {
global $wgDebugFunctionEntry, $wgProfileCallTree;
}
$this->close();
- if( $wgProfileCallTree ){
+ if( $wgProfileCallTree ) {
+ global $wgProfileToDatabase;
+ # XXX: We must call $this->getFunctionReport() to log to the DB
+ if( $wgProfileToDatabase ) {
+ $this->getFunctionReport();
+ }
return $this->getCallTree();
} else {
return $this->getFunctionReport();
}
/**
- * returns a tree of function call instead of a list of functions
+ * Returns a tree of function call instead of a list of functions
*/
function getCallTree() {
return implode( '', array_map( array( &$this, 'getCallTreeLine' ), $this->remapCallTree( $this->mStack ) ) );
/**
* Recursive function the format the current profiling array into a tree
*
- * @param array $stack profiling array
+ * @param $stack profiling array
*/
function remapCallTree( $stack ) {
if( count( $stack ) < 2 ){
/**
* Callback to get a formatted line for the call tree
*/
- function getCallTreeLine($entry) {
+ function getCallTreeLine( $entry ) {
list( $fname, $level, $start, /* $x */, $end) = $entry;
$delta = $end - $start;
$space = str_repeat(' ', $level);
-
# The ugly double sprintf is to work around a PHP bug,
# which has been fixed in recent releases.
- return sprintf( "%10s %s %s\n",
- trim( sprintf( "%7.3f", $delta * 1000.0 ) ),
- $space, $fname );
+ return sprintf( "%10s %s %s\n", trim( sprintf( "%7.3f", $delta * 1000.0 ) ), $space, $fname );
}
function getTime() {
wfProfileOut( '-overhead-total' );
# First, subtract the overhead!
+ $overheadTotal = $overheadMemory = $overheadInternal = array();
foreach( $this->mStack as $entry ){
$fname = $entry[0];
$start = $entry[2];
$overheadInternal[] = $elapsed;
}
}
- $overheadTotal = array_sum( $overheadTotal ) / count( $overheadInternal );
- $overheadMemory = array_sum( $overheadMemory ) / count( $overheadInternal );
- $overheadInternal = array_sum( $overheadInternal ) / count( $overheadInternal );
+ $overheadTotal = $overheadTotal ? array_sum( $overheadTotal ) / count( $overheadInternal ) : 0;
+ $overheadMemory = $overheadMemory ? array_sum( $overheadMemory ) / count( $overheadInternal ) : 0;
+ $overheadInternal = $overheadInternal ? array_sum( $overheadInternal ) / count( $overheadInternal ) : 0;
# Collate
foreach( $this->mStack as $index => $entry ){
$percent = $total ? 100. * $elapsed / $total : 0;
$memory = $this->mMemory[$fname];
$prof .= sprintf($format, substr($fname, 0, $nameWidth), $calls, (float) ($elapsed * 1000), (float) ($elapsed * 1000) / $calls, $percent, $memory, ($this->mMin[$fname] * 1000.0), ($this->mMax[$fname] * 1000.0), $this->mOverhead[$fname]);
-
- if( $wgProfileToDatabase ){
+ # Log to the DB
+ if( $wgProfileToDatabase ) {
self::logToDB($fname, (float) ($elapsed * 1000), $calls, (float) ($memory) );
}
}
/**
* Log a function into the database.
*
- * @param string $name function name
- * @param float $timeSum
- * @param int $eventCount number of times that function was called
+ * @param $name String: function name
+ * @param $timeSum Float
+ * @param $eventCount Integer: number of times that function was called
+ * @param $memorySum Integer: memory used by the function
*/
static function logToDB( $name, $timeSum, $eventCount, $memorySum ){
# Do not log anything if database is readonly (bug 5375)
if( wfReadOnly() ) { return; }
- # Warning: $wguname is a live patch, it should be moved to Setup.php
- global $wguname, $wgProfilePerHost;
+ global $wgProfilePerHost;
$dbw = wfGetDB( DB_MASTER );
if( !is_object( $dbw ) )
$name = substr($name, 0, 255);
if( $wgProfilePerHost ){
- $pfhost = $wguname['nodename'];
+ $pfhost = wfHostname();
} else {
$pfhost = '';
}
/**
* Get function caller
- * @param int $level
+ *
+ * @param $level Integer
*/
static function getCaller( $level ) {
$backtrace = wfDebugBacktrace();
/**
* Add an entry in the debug log file
- * @param string $s string to output
+ *
+ * @param $s String to output
*/
function debug( $s ) {
if( function_exists( 'wfDebug' ) ) {
dépôts / lhc / web / wiklou.git / blobdiff