ProfilerXhprof.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Profiler;
 
use RuntimeException;
use Wikimedia\XhprofData;
 
class ProfilerXhprof extends Profiler {
    protected $xhprofData;
 
    protected $sprofiler;
 
    public function __construct( array $params = [] ) {
        parent::__construct( $params );
 
        // See T180183 and T247332 for why we need the 'running' option.
        if ( empty( $params['running'] ) ) {
            $flags = $params['flags'] ?? 0;
            if ( function_exists( 'xhprof_enable' ) ) {
                $options = isset( $params['exclude'] )
                    ? [ 'ignored_functions' => $params['exclude'] ]
                    : [];
                xhprof_enable( $flags, $options );
            } elseif ( function_exists( 'tideways_xhprof_enable' ) ) {
                if ( isset( $params['exclude'] ) ) {
                    throw new RuntimeException( 'The exclude option is not supported in tideways_xhprof' );
                }
                tideways_xhprof_enable( $flags );
            } else {
                throw new RuntimeException( 'Neither xhprof nor tideways_xhprof is installed' );
            }
        }
 
        $this->sprofiler = new SectionProfiler();
    }
 
    public function getXhprofData() {
        if ( !$this->xhprofData ) {
            if ( function_exists( 'xhprof_disable' ) ) {
                $data = xhprof_disable();
            } elseif ( function_exists( 'tideways_xhprof_disable' ) ) {
                $data = tideways_xhprof_disable();
            } else {
                throw new RuntimeException( 'Neither xhprof nor tideways_xhprof is installed' );
            }
            $this->xhprofData = new XhprofData( $data, $this->params );
        }
        return $this->xhprofData;
    }
 
    #[\NoDiscard]
    public function scopedProfileIn( $section ): ?SectionProfileCallback {
        $key = 'section.' . ltrim( $section, '.' );
        return $this->sprofiler->scopedProfileIn( $key );
    }
 
    public function close() {
    }
 
    private function shouldExclude( $name ) {
        if ( $name === '-total' ) {
            return true;
        }
        if ( !empty( $this->params['include'] ) ) {
            foreach ( $this->params['include'] as $pattern ) {
                if ( fnmatch( $pattern, $name, FNM_NOESCAPE ) ) {
                    return false;
                }
            }
            return true;
        }
        if ( !empty( $this->params['exclude'] ) ) {
            foreach ( $this->params['exclude'] as $pattern ) {
                if ( fnmatch( $pattern, $name, FNM_NOESCAPE ) ) {
                    return true;
                }
            }
        }
        return false;
    }
 
    public function getFunctionStats() {
        $metrics = $this->getXhprofData()->getCompleteMetrics();
        $profile = [];
 
        $main = null; // units in ms
        foreach ( $metrics as $fname => $stats ) {
            if ( $this->shouldExclude( $fname ) ) {
                continue;
            }
            // Convert elapsed times from μs to ms to match interface
            $entry = [
                'name' => $fname,
                'calls' => $stats['ct'],
                'real' => $stats['wt']['total'] / 1000,
                '%real' => $stats['wt']['percent'],
                'cpu' => ( $stats['cpu']['total'] ?? 0 ) / 1000,
                '%cpu' => $stats['cpu']['percent'] ?? 0,
                'memory' => $stats['mu']['total'] ?? 0,
                '%memory' => $stats['mu']['percent'] ?? 0,
                'min_real' => $stats['wt']['min'] / 1000,
                'max_real' => $stats['wt']['max'] / 1000
            ];
            $profile[] = $entry;
            if ( $fname === 'main()' ) {
                $main = $entry;
            }
        }
 
        // Merge in all of the custom profile sections
        foreach ( $this->sprofiler->getFunctionStats() as $stats ) {
            if ( $this->shouldExclude( $stats['name'] ) ) {
                continue;
            }
 
            // @note: getFunctionStats() values already in ms
            $stats['%real'] = $main['real'] ? $stats['real'] / $main['real'] * 100 : 0;
            $stats['%cpu'] = $main['cpu'] ? $stats['cpu'] / $main['cpu'] * 100 : 0;
            $stats['%memory'] = $main['memory'] ? $stats['memory'] / $main['memory'] * 100 : 0;
            $profile[] = $stats; // assume no section names collide with $metrics
        }
 
        return $profile;
    }
 
    public function getOutput() {
        return $this->getFunctionReport();
    }
 
    protected function getFunctionReport() {
        $data = $this->getFunctionStats();
        usort( $data, static function ( $a, $b ) {
            return $b['real'] <=> $a['real']; // descending
        } );
 
        $width = 140;
        $nameWidth = $width - 65;
        $format = "%-{$nameWidth}s %6d %9d %9d %9d %9d %7.3f%% %9d";
        $out = [];
        $out[] = sprintf( "%-{$nameWidth}s %6s %9s %9s %9s %9s %7s %9s",
            'Name', 'Calls', 'Total', 'Min', 'Each', 'Max', '%', 'Mem'
        );
        foreach ( $data as $stats ) {
            $out[] = sprintf( $format,
                $stats['name'],
                $stats['calls'],
                $stats['real'] * 1000,
                $stats['min_real'] * 1000,
                $stats['real'] / $stats['calls'] * 1000,
                $stats['max_real'] * 1000,
                $stats['%real'],
                $stats['memory']
            );
        }
        return implode( "\n", $out );
    }
 
    public function getRawData() {
        return $this->getXhprofData()->getRawData();
    }
}
 
class_alias( ProfilerXhprof::class, 'ProfilerXhprof' );