Merge "Change line breaks in LocalFile::recordUpload2()"
[lhc/web/wiklou.git] / includes / profiler / Profiler.php
index 6f112ae..235a5ad 100644 (file)
  * @param string $functionname name of the function we will profile
  */
 function wfProfileIn( $functionname ) {
-       global $wgProfiler;
-       if ( $wgProfiler instanceof Profiler || isset( $wgProfiler['class'] ) ) {
-               Profiler::instance()->profileIn( $functionname );
+       if ( Profiler::$__instance === null ) { // use this directly to reduce overhead
+               Profiler::instance();
+       }
+       if ( !( Profiler::$__instance instanceof ProfilerStub ) ) {
+               Profiler::$__instance->profileIn( $functionname );
        }
 }
 
@@ -42,9 +44,11 @@ function wfProfileIn( $functionname ) {
  * @param string $functionname name of the function we have profiled
  */
 function wfProfileOut( $functionname = 'missing' ) {
-       global $wgProfiler;
-       if ( $wgProfiler instanceof Profiler || isset( $wgProfiler['class'] ) ) {
-               Profiler::instance()->profileOut( $functionname );
+       if ( Profiler::$__instance === null ) { // use this directly to reduce overhead
+               Profiler::instance();
+       }
+       if ( !( Profiler::$__instance instanceof ProfilerStub ) ) {
+               Profiler::$__instance->profileOut( $functionname );
        }
 }
 
@@ -73,7 +77,7 @@ class ProfileSection {
                if ( Profiler::$__instance === null ) { // use this directly to reduce overhead
                        Profiler::instance();
                }
-               if ( Profiler::$__instance && !( Profiler::$__instance instanceof ProfilerStub ) ) {
+               if ( !( Profiler::$__instance instanceof ProfilerStub ) ) {
                        $this->enabled = true;
                        Profiler::$__instance->profileIn( $this->name );
                }
@@ -96,6 +100,12 @@ class Profiler {
        protected $mTimeMetric = 'wall';
        protected $mProfileID = false, $mCollateDone = false, $mTemplated = false;
 
+       protected $mDBLockThreshold = 5.0; // float; seconds
+       /** @var Array DB/server name => (active trx count,timestamp) */
+       protected $mDBTrxHoldingLocks = array();
+       /** @var Array DB/server name => list of (method, elapsed time) */
+       protected $mDBTrxMethodTimes = array();
+
        /** @var Profiler */
        public static $__instance = null; // do not call this outside Profiler and ProfileSection
 
@@ -115,12 +125,10 @@ class Profiler {
         * @return Profiler
         */
        public static function instance() {
-               if ( is_null( self::$__instance ) ) {
+               if ( self::$__instance === null ) {
                        global $wgProfiler;
                        if ( is_array( $wgProfiler ) ) {
                                if ( !isset( $wgProfiler['class'] ) ) {
-                                       wfDebug( __METHOD__ . " called without \$wgProfiler['class']"
-                                               . " set, falling back to ProfilerStub for safety\n" );
                                        $class = 'ProfilerStub';
                                } else {
                                        $class = $wgProfiler['class'];
@@ -129,8 +137,6 @@ class Profiler {
                        } elseif ( $wgProfiler instanceof Profiler ) {
                                self::$__instance = $wgProfiler; // back-compat
                        } else {
-                               wfDebug( __METHOD__ . ' called with bogus $wgProfiler setting,'
-                                               . " falling back to ProfilerStub for safety\n" );
                                self::$__instance = new ProfilerStub( $wgProfiler );
                        }
                }
@@ -223,20 +229,19 @@ class Profiler {
                if ( !$bit ) {
                        $this->debug( "Profiling error, !\$bit: $functionname\n" );
                } else {
-                       //if( $wgDebugProfiling ) {
-                               if ( $functionname == 'close' ) {
-                                       $message = "Profile section ended by close(): {$bit[0]}";
-                                       $this->debug( "$message\n" );
-                                       $this->mStack[] = array( $message, 0, 0.0, 0, 0.0, 0 );
-                               } elseif ( $bit[0] != $functionname ) {
-                                       $message = "Profiling error: in({$bit[0]}), out($functionname)";
-                                       $this->debug( "$message\n" );
-                                       $this->mStack[] = array( $message, 0, 0.0, 0, 0.0, 0 );
-                               }
-                       //}
+                       if ( $functionname == 'close' ) {
+                               $message = "Profile section ended by close(): {$bit[0]}";
+                               $this->debug( "$message\n" );
+                               $this->mStack[] = array( $message, 0, 0.0, 0, 0.0, 0 );
+                       } elseif ( $bit[0] != $functionname ) {
+                               $message = "Profiling error: in({$bit[0]}), out($functionname)";
+                               $this->debug( "$message\n" );
+                               $this->mStack[] = array( $message, 0, 0.0, 0, 0.0, 0 );
+                       }
                        $bit[] = $time;
                        $bit[] = $memory;
                        $this->mStack[] = $bit;
+                       $this->updateTrxProfiling( $functionname, $time );
                }
        }
 
@@ -249,6 +254,83 @@ class Profiler {
                }
        }
 
+       /**
+        * Mark a DB as in a transaction with one or more writes pending
+        *
+        * Note that there can be multiple connections to a single DB.
+        *
+        * @param string $server DB server
+        * @param string $db DB name
+        */
+       public function transactionWritingIn( $server, $db ) {
+               $name = "{$server} ({$db})";
+               if ( isset( $this->mDBTrxHoldingLocks[$name] ) ) {
+                       ++$this->mDBTrxHoldingLocks[$name]['refs'];
+               } else {
+                       $this->mDBTrxHoldingLocks[$name] = array( 'refs' => 1, 'start' => microtime( true ) );
+                       $this->mDBTrxMethodTimes[$name] = array();
+               }
+       }
+
+       /**
+        * Register the name and time of a method for slow DB trx detection
+        *
+        * @param string $method Function name
+        * @param float $realtime Wal time ellapsed
+        */
+       protected function updateTrxProfiling( $method, $realtime ) {
+               if ( !$this->mDBTrxHoldingLocks ) {
+                       return; // short-circuit
+               // @TODO: hardcoded check is a tad janky (what about FOR UPDATE?)
+               } elseif ( !preg_match( '/^query-m: (?!SELECT)/', $method )
+                       && $realtime < $this->mDBLockThreshold
+               ) {
+                       return; // not a DB master query nor slow enough
+               }
+               $now = microtime( true );
+               foreach ( $this->mDBTrxHoldingLocks as $name => $info ) {
+                       // Hacky check to exclude entries from before the first TRX write
+                       if ( ( $now - $realtime ) >= $info['start'] ) {
+                               $this->mDBTrxMethodTimes[$name][] = array( $method, $realtime );
+                       }
+               }
+       }
+
+       /**
+        * Mark a DB as no longer in a transaction
+        *
+        * This will check if locks are possibly held for longer than
+        * needed and log any affected transactions to a special DB log.
+        * Note that there can be multiple connections to a single DB.
+        *
+        * @param string $server DB server
+        * @param string $db DB name
+        */
+       public function transactionWritingOut( $server, $db ) {
+               $name = "{$server} ({$db})";
+               if ( --$this->mDBTrxHoldingLocks[$name]['refs'] <= 0 ) {
+                       $slow = false;
+                       foreach ( $this->mDBTrxMethodTimes[$name] as $info ) {
+                               list( $method, $realtime ) = $info;
+                               if ( $realtime >= $this->mDBLockThreshold ) {
+                                       $slow = true;
+                                       break;
+                               }
+                       }
+                       if ( $slow ) {
+                               $dbs = implode( ', ', array_keys( $this->mDBTrxHoldingLocks ) );
+                               $msg = "Sub-optimal transaction on DB(s) {$dbs}:\n";
+                               foreach ( $this->mDBTrxMethodTimes[$name] as $i => $info ) {
+                                       list( $method, $realtime ) = $info;
+                                       $msg .= sprintf( "%d\t%.6f\t%s\n", $i, $realtime, $method );
+                               }
+                               wfDebugLog( 'DBPerformance', $msg );
+                       }
+                       unset( $this->mDBTrxHoldingLocks[$name] );
+                       unset( $this->mDBTrxMethodTimes[$name] );
+               }
+       }
+
        /**
         * Mark this call as templated or not
         *
@@ -462,8 +544,8 @@ class Profiler {
                                # Adjust for profiling overhead (except special values with elapsed=0
                                if ( $elapsed ) {
                                        $elapsed -= $overheadInternal;
-                                       $elapsed -= ($subcalls * $overheadTotal);
-                                       $memory -= ($subcalls * $overheadMemory);
+                                       $elapsed -= ( $subcalls * $overheadTotal );
+                                       $memory -= ( $subcalls * $overheadMemory );
                                }
                        }
 
@@ -509,7 +591,17 @@ class Profiler {
                        $calls = $this->mCalls[$fname];
                        $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] );
+                       $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]
+                       );
                }
                $prof .= "\nTotal: $total\n\n";
 
@@ -573,13 +665,13 @@ class Profiler {
 
                        foreach ( $this->mCollated as $name => $elapsed ) {
                                $eventCount = $this->mCalls[$name];
-                               $timeSum = (float) ($elapsed * 1000);
+                               $timeSum = (float)( $elapsed * 1000 );
                                $memorySum = (float)$this->mMemory[$name];
                                $name = substr( $name, 0, 255 );
 
                                // Kludge
-                               $timeSum = ($timeSum >= 0) ? $timeSum : 0;
-                               $memorySum = ($memorySum >= 0) ? $memorySum : 0;
+                               $timeSum = $timeSum >= 0 ? $timeSum : 0;
+                               $memorySum = $memorySum >= 0 ? $memorySum : 0;
 
                                $dbw->update( 'profiling',
                                        array(