includes/libs/Xhprof.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 /**
  22  * Convenience class for working with XHProf
  23  * <https://github.com/phacility/xhprof>. XHProf can be installed as a PECL
  24  * package for use with PHP5 (Zend PHP) and is built-in to HHVM 3.3.0.
  25  *
  26  * This also supports using the Tideways profiler
  27  * <https://github.com/tideways/php-profiler-extension>, which additionally
  28  * has support for PHP7.
  29  *
  30  * @since 1.28
  31  */
  32 class Xhprof {
  33         /**
  34          * @var bool $enabled Whether XHProf is currently running.
  35          */
  36         protected static $enabled;
  37
  38         /**
  39          * Start xhprof profiler
  40          * @return bool
  41          */
  42         public static function isEnabled() {
  43                 return self::$enabled;
  44         }
  45
  46         /**
  47          * Start xhprof profiler
  48          * @param int $flags
  49          * @param array $options
  50          * @throws Exception
  51          */
  52         public static function enable( $flags = 0, $options = [] ) {
  53                 if ( self::isEnabled() ) {
  54                         throw new Exception( 'Profiling is already enabled.' );
  55                 }
  56                 self::$enabled = true;
  57                 if ( function_exists( 'xhprof_enable' ) ) {
  58                         xhprof_enable( $flags, $options );
  59                 } elseif ( function_exists( 'tideways_enable' ) ) {
  60                         tideways_enable( $flags, $options );
  61                 } else {
  62                         throw new Exception( "Neither xhprof nor tideways are installed" );
  63                 }
  64         }
  65
  66         /**
  67          * Stop xhprof profiler
  68          *
  69          * @return array|null xhprof data from the run, or null if xhprof was not running.
  70          */
  71         public static function disable() {
  72                 if ( self::isEnabled() ) {
  73                         self::$enabled = false;
  74                         if ( function_exists( 'xhprof_disable' ) ) {
  75                                 return xhprof_disable();
  76                         } else {
  77                                 // tideways
  78                                 return tideways_disable();
  79                         }
  80                 }
  81         }
  82 }