summaryrefslogtreecommitdiff
path: root/www/wiki/includes/libs/Xhprof.php
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/includes/libs/Xhprof.php')
-rw-r--r--www/wiki/includes/libs/Xhprof.php82
1 files changed, 82 insertions, 0 deletions
diff --git a/www/wiki/includes/libs/Xhprof.php b/www/wiki/includes/libs/Xhprof.php
new file mode 100644
index 00000000..e58d98fc
--- /dev/null
+++ b/www/wiki/includes/libs/Xhprof.php
@@ -0,0 +1,82 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Convenience class for working with XHProf
+ * <https://github.com/phacility/xhprof>. XHProf can be installed as a PECL
+ * package for use with PHP5 (Zend PHP) and is built-in to HHVM 3.3.0.
+ *
+ * This also supports using the Tideways profiler
+ * <https://github.com/tideways/php-profiler-extension>, which additionally
+ * has support for PHP7.
+ *
+ * @since 1.28
+ */
+class Xhprof {
+ /**
+ * @var bool $enabled Whether XHProf is currently running.
+ */
+ protected static $enabled;
+
+ /**
+ * Start xhprof profiler
+ * @return bool
+ */
+ public static function isEnabled() {
+ return self::$enabled;
+ }
+
+ /**
+ * Start xhprof profiler
+ * @param int $flags
+ * @param array $options
+ * @throws Exception
+ */
+ public static function enable( $flags = 0, $options = [] ) {
+ if ( self::isEnabled() ) {
+ throw new Exception( 'Profiling is already enabled.' );
+ }
+ self::$enabled = true;
+ if ( function_exists( 'xhprof_enable' ) ) {
+ xhprof_enable( $flags, $options );
+ } elseif ( function_exists( 'tideways_enable' ) ) {
+ tideways_enable( $flags, $options );
+ } else {
+ throw new Exception( "Neither xhprof nor tideways are installed" );
+ }
+ }
+
+ /**
+ * Stop xhprof profiler
+ *
+ * @return array|null xhprof data from the run, or null if xhprof was not running.
+ */
+ public static function disable() {
+ if ( self::isEnabled() ) {
+ self::$enabled = false;
+ if ( function_exists( 'xhprof_disable' ) ) {
+ return xhprof_disable();
+ } else {
+ // tideways
+ return tideways_disable();
+ }
+ }
+ }
+}