Benchmarker.php

Go to the documentation of this file.

<?php
use Wikimedia\RunningStat;
 
// @codeCoverageIgnoreStart
require_once __DIR__ . '/../Maintenance.php';
// @codeCoverageIgnoreEnd
 
abstract class Benchmarker extends Maintenance {
    protected $defaultCount = 100;
 
    public function __construct() {
        parent::__construct();
        $this->addOption( 'count', "How many times to run a benchmark. Default: {$this->defaultCount}", false, true );
        $this->addOption( 'verbose', 'Verbose logging of resource usage', false, false, 'v' );
    }
 
    public function bench( array $benchs ) {
        $this->startBench();
        $count = $this->getOption( 'count', $this->defaultCount );
        $verbose = $this->hasOption( 'verbose' );
 
        $normBenchs = [];
        $shortNames = [];
 
        // Normalise
        foreach ( $benchs as $key => $bench ) {
            // Shortcut for simple functions
            if ( is_callable( $bench ) ) {
                $bench = [ 'function' => $bench ];
            }
 
            // Default to no arguments
            if ( !isset( $bench['args'] ) ) {
                $bench['args'] = [];
            }
 
            // Name defaults to name of called function
            if ( is_string( $key ) ) {
                $name = $key;
            } else {
                // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
                if ( is_array( $bench['function'] ) ) {
                    $class = $bench['function'][0];
                    if ( is_object( $class ) ) {
                        $class = get_class( $class );
                    }
                    $name = $class . '::' . $bench['function'][1];
                } else {
                    // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
                    $name = strval( $bench['function'] );
                }
                $argsText = implode(
                    ', ',
                    array_map(
                        static function ( $a ) {
                            return var_export( $a, true );
                        },
                        // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
                        $bench['args']
                    )
                );
                $index = $shortNames[$name] = ( $shortNames[$name] ?? 0 ) + 1;
                $shorten = strlen( $argsText ) > 80 || str_contains( $argsText, "\n" );
                if ( !$shorten ) {
                    $name = "$name($argsText)";
                }
                if ( $shorten || $index > 1 ) {
                    $name = "$name@$index";
                }
            }
 
            $normBenchs[$name] = $bench;
        }
 
        foreach ( $normBenchs as $name => $bench ) {
            // Optional setup called outside time measure
            if ( isset( $bench['setup'] ) ) {
                call_user_func( $bench['setup'] );
            }
 
            // Run benchmarks
            $stat = new RunningStat();
            for ( $i = 0; $i < $count; $i++ ) {
                // Setup outside of time measure for each loop
                if ( isset( $bench['setupEach'] ) ) {
                    $bench['setupEach']();
                }
                $t = microtime( true );
                // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
                call_user_func_array( $bench['function'], $bench['args'] );
                $t = ( microtime( true ) - $t ) * 1000;
                if ( $verbose ) {
                    $this->verboseRun( $i );
                }
                $stat->addObservation( $t );
            }
 
            $this->addResult( [
                'name' => $name,
                'count' => $stat->getCount(),
                // Get rate per second from mean (in ms)
                'rate' => $stat->getMean() == 0 ? INF : ( 1.0 / ( $stat->getMean() / 1000.0 ) ),
                'total' => $stat->getMean() * $stat->getCount(),
                'mean' => $stat->getMean(),
                'max' => $stat->max,
                'stddev' => $stat->getStdDev(),
                'usage' => [
                    'mem' => memory_get_usage( true ),
                    'mempeak' => memory_get_peak_usage( true ),
                ],
            ] );
        }
    }
 
    public function startBench() {
        $this->output(
            sprintf( "Running PHP version %s (%s) on %s %s %s\n\n",
                phpversion(),
                php_uname( 'm' ),
                php_uname( 's' ),
                php_uname( 'r' ),
                php_uname( 'v' )
            )
        );
    }
 
    public function addResult( $res ) {
        $ret = sprintf( "%s\n  %' 6s: %d\n",
            $res['name'],
            'count',
            $res['count']
        );
        $ret .= sprintf( "  %' 6s: %8.1f/s\n",
            'rate',
            $res['rate']
        );
        foreach ( [ 'total', 'mean', 'max', 'stddev' ] as $metric ) {
            $ret .= sprintf( "  %' 6s: %8.2fms\n",
                $metric,
                $res[$metric]
            );
        }
 
        foreach ( [
            'mem' => 'Current memory usage',
            'mempeak' => 'Peak memory usage'
        ] as $key => $label ) {
            $ret .= sprintf( "%' 20s: %s\n",
                $label,
                $this->formatSize( $res['usage'][$key] )
            );
        }
 
        $this->output( "$ret\n" );
    }
 
    protected function verboseRun( $iteration ) {
        $this->output( sprintf( "#%3d - memory: %-10s - peak: %-10s\n",
            $iteration,
            $this->formatSize( memory_get_usage( true ) ),
            $this->formatSize( memory_get_peak_usage( true ) )
        ) );
    }
 
    private function formatSize( $bytes ): string {
        if ( $bytes >= ( 1024 ** 3 ) ) {
            return number_format( $bytes / ( 1024 ** 3 ), 2 ) . ' GiB';
        }
        if ( $bytes >= ( 1024 ** 2 ) ) {
            return number_format( $bytes / ( 1024 ** 2 ), 2 ) . ' MiB';
        }
        if ( $bytes >= 1024 ) {
            return number_format( $bytes / 1024, 1 ) . ' KiB';
        }
        return $bytes . ' B';
    }
 
    protected function loadFile( $file ) {
        $content = file_get_contents( $file );
        // Detect GZIP compression header
        if ( str_starts_with( $content, "\037\213" ) ) {
            $content = gzdecode( $content );
        }
        return $content;
    }
}