includes/profiler/Profiler.php

   1 <?php
   2 /**
   3  * Base class for profiling.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Profiler
  22  * @defgroup Profiler Profiler
  23  */
  24
  25 /**
  26  * Profiler base class that defines the interface and some trivial
  27  * functionality
  28  *
  29  * @ingroup Profiler
  30  */
  31 abstract class Profiler {
  32         /** @var string|bool Profiler ID for bucketing data */
  33         protected $mProfileID = false;
  34         /** @var bool Whether MediaWiki is in a SkinTemplate output context */
  35         protected $mTemplated = false;
  36
  37         /** @var TransactionProfiler */
  38         protected $trxProfiler;
  39
  40         // @codingStandardsIgnoreStart PSR2.Classes.PropertyDeclaration.Underscore
  41         /** @var Profiler Do not call this outside Profiler and ProfileSection */
  42         public static $__instance = null;
  43         // @codingStandardsIgnoreEnd
  44
  45         /**
  46          * @param array $params
  47          */
  48         public function __construct( array $params ) {
  49                 if ( isset( $params['profileID'] ) ) {
  50                         $this->mProfileID = $params['profileID'];
  51                 }
  52                 $this->trxProfiler = new TransactionProfiler();
  53         }
  54
  55         /**
  56          * Singleton
  57          * @return Profiler
  58          */
  59         final public static function instance() {
  60                 if ( self::$__instance === null ) {
  61                         global $wgProfiler;
  62                         if ( is_array( $wgProfiler ) ) {
  63                                 if ( !isset( $wgProfiler['class'] ) ) {
  64                                         $class = 'ProfilerStub';
  65                                 } else {
  66                                         $class = $wgProfiler['class'];
  67                                 }
  68                                 self::$__instance = new $class( $wgProfiler );
  69                         } else {
  70                                 self::$__instance = new ProfilerStub( array() );
  71                         }
  72                 }
  73                 return self::$__instance;
  74         }
  75
  76         /**
  77          * Return whether this a stub profiler
  78          *
  79          * @return bool
  80          */
  81         abstract public function isStub();
  82
  83         /**
  84          * Return whether this profiler stores data
  85          *
  86          * Called by Parser::braceSubstitution. If true, the parser will not
  87          * generate per-title profiling sections, to avoid overloading the
  88          * profiling data collector.
  89          *
  90          * @see Profiler::logData()
  91          * @return bool
  92          */
  93         abstract public function isPersistent();
  94
  95         /**
  96          * @param string $id
  97          */
  98         public function setProfileID( $id ) {
  99                 $this->mProfileID = $id;
 100         }
 101
 102         /**
 103          * @return string
 104          */
 105         public function getProfileID() {
 106                 if ( $this->mProfileID === false ) {
 107                         return wfWikiID();
 108                 } else {
 109                         return $this->mProfileID;
 110                 }
 111         }
 112
 113         /**
 114          * Called by wfProfieIn()
 115          *
 116          * @param string $functionname
 117          */
 118         abstract public function profileIn( $functionname );
 119
 120         /**
 121          * Called by wfProfieOut()
 122          *
 123          * @param string $functionname
 124          */
 125         abstract public function profileOut( $functionname );
 126
 127         /**
 128          * @return TransactionProfiler
 129          * @since 1.25
 130          */
 131         public function getTransactionProfiler() {
 132                 return $this->trxProfiler;
 133         }
 134
 135         /**
 136          * Close opened profiling sections
 137          */
 138         abstract public function close();
 139
 140         /**
 141          * Log the data to some store or even the page output
 142          */
 143         abstract public function logData();
 144
 145         /**
 146          * Mark this call as templated or not
 147          *
 148          * @param bool $t
 149          */
 150         public function setTemplated( $t ) {
 151                 $this->mTemplated = $t;
 152         }
 153
 154         /**
 155          * Returns a profiling output to be stored in debug file
 156          *
 157          * @return string
 158          */
 159         abstract public function getOutput();
 160
 161         /**
 162          * @return array
 163          */
 164         abstract public function getRawData();
 165
 166         /**
 167          * Get the initial time of the request, based either on $wgRequestTime or
 168          * $wgRUstart. Will return null if not able to find data.
 169          *
 170          * @param string|bool $metric Metric to use, with the following possibilities:
 171          *   - user: User CPU time (without system calls)
 172          *   - cpu: Total CPU time (user and system calls)
 173          *   - wall (or any other string): elapsed time
 174          *   - false (default): will fall back to default metric
 175          * @return float|null
 176          */
 177         protected function getTime( $metric = 'wall' ) {
 178                 if ( $metric === 'cpu' || $metric === 'user' ) {
 179                         $ru = wfGetRusage();
 180                         if ( !$ru ) {
 181                                 return 0;
 182                         }
 183                         $time = $ru['ru_utime.tv_sec'] + $ru['ru_utime.tv_usec'] / 1e6;
 184                         if ( $metric === 'cpu' ) {
 185                                 # This is the time of system calls, added to the user time
 186                                 # it gives the total CPU time
 187                                 $time += $ru['ru_stime.tv_sec'] + $ru['ru_stime.tv_usec'] / 1e6;
 188                         }
 189                         return $time;
 190                 } else {
 191                         return microtime( true );
 192                 }
 193         }
 194
 195         /**
 196          * Get the initial time of the request, based either on $wgRequestTime or
 197          * $wgRUstart. Will return null if not able to find data.
 198          *
 199          * @param string|bool $metric Metric to use, with the following possibilities:
 200          *   - user: User CPU time (without system calls)
 201          *   - cpu: Total CPU time (user and system calls)
 202          *   - wall (or any other string): elapsed time
 203          *   - false (default): will fall back to default metric
 204          * @return float|null
 205          */
 206         protected function getInitialTime( $metric = 'wall' ) {
 207                 global $wgRequestTime, $wgRUstart;
 208
 209                 if ( $metric === 'cpu' || $metric === 'user' ) {
 210                         if ( !count( $wgRUstart ) ) {
 211                                 return null;
 212                         }
 213
 214                         $time = $wgRUstart['ru_utime.tv_sec'] + $wgRUstart['ru_utime.tv_usec'] / 1e6;
 215                         if ( $metric === 'cpu' ) {
 216                                 # This is the time of system calls, added to the user time
 217                                 # it gives the total CPU time
 218                                 $time += $wgRUstart['ru_stime.tv_sec'] + $wgRUstart['ru_stime.tv_usec'] / 1e6;
 219                         }
 220                         return $time;
 221                 } else {
 222                         if ( empty( $wgRequestTime ) ) {
 223                                 return null;
 224                         } else {
 225                                 return $wgRequestTime;
 226                         }
 227                 }
 228         }
 229 }