benchmarkParse.php
No OneTemporary
Actions

Size

6 KB

Referenced Files

None

Subscribers

None

benchmarkParse.php
View Options

	<?php
	/**
	* Benchmark script for parse operations
	*
	* 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
	* @author Tim Starling <tstarling@wikimedia.org>
	* @ingroup Benchmark
	*/

	// @codeCoverageIgnoreStart
	require_once __DIR__ . '/../Maintenance.php';
	// @codeCoverageIgnoreEnd

	use MediaWiki\Cache\LinkCache;
	use MediaWiki\Linker\LinkTarget;
	use MediaWiki\Maintenance\Maintenance;
	use MediaWiki\Revision\RevisionRecord;
	use MediaWiki\Revision\SlotRecord;
	use MediaWiki\Title\Title;
	use Wikimedia\Rdbms\SelectQueryBuilder;

	/**
	* Maintenance script to benchmark how long it takes to parse a given title at an optionally
	* specified timestamp
	*
	* @since 1.23
	*/
	class BenchmarkParse extends Maintenance {
	/** @var string MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS) */
	private $templateTimestamp = null;

	/** @var bool */
	private $clearLinkCache = false;

	/**
	* @var LinkCache
	*/
	private $linkCache;

	/** @var array Cache that maps a Title DB key to revision ID for the requested timestamp */
	private $idCache = [];

	public function __construct() {
	parent::__construct();
	$this->addDescription( 'Benchmark parse operation' );
	$this->addArg( 'title', 'The name of the page to parse' );
	$this->addOption( 'warmup', 'Repeat the parse operation this number of times to warm the cache',
	false, true );
	$this->addOption( 'loops', 'Number of times to repeat parse operation post-warmup',
	false, true );
	$this->addOption( 'page-time',
	'Use the version of the page which was current at the given time',
	false, true );
	$this->addOption( 'tpl-time',
	'Use templates which were current at the given time (except that moves and ' .
	'deletes are not handled properly)',
	false, true );
	$this->addOption( 'reset-linkcache', 'Reset the LinkCache after every parse.',
	false, false );
	}

	public function execute() {
	if ( $this->hasOption( 'tpl-time' ) ) {
	$this->templateTimestamp = wfTimestamp( TS_MW, strtotime( $this->getOption( 'tpl-time' ) ) );
	$hookContainer = $this->getHookContainer();
	$hookContainer->register( 'BeforeParserFetchTemplateRevisionRecord', [ $this, 'onFetchTemplate' ] );
	}

	$this->clearLinkCache = $this->hasOption( 'reset-linkcache' );
	// Set as a member variable to avoid function calls when we're timing the parse
	$this->linkCache = $this->getServiceContainer()->getLinkCache();

	$title = Title::newFromText( $this->getArg( 0 ) );
	if ( !$title ) {
	$this->fatalError( "Invalid title" );
	}

	$revLookup = $this->getServiceContainer()->getRevisionLookup();
	if ( $this->hasOption( 'page-time' ) ) {
	$pageTimestamp = wfTimestamp( TS_MW, strtotime( $this->getOption( 'page-time' ) ) );
	$id = $this->getRevIdForTime( $title, $pageTimestamp );
	if ( !$id ) {
	$this->fatalError( "The page did not exist at that time" );
	}

	$revision = $revLookup->getRevisionById( (int)$id );
	} else {
	$revision = $revLookup->getRevisionByTitle( $title );
	}

	if ( !$revision ) {
	$this->fatalError( "Unable to load revision, incorrect title?" );
	}

	$warmup = $this->getOption( 'warmup', 1 );
	for ( $i = 0; $i < $warmup; $i++ ) {
	$this->runParser( $revision );
	}

	$loops = $this->getOption( 'loops', 1 );
	if ( $loops < 1 ) {
	$this->fatalError( 'Invalid number of loops specified' );
	}
	$startUsage = getrusage();
	$startTime = microtime( true );
	for ( $i = 0; $i < $loops; $i++ ) {
	$this->runParser( $revision );
	}
	$endUsage = getrusage();
	$endTime = microtime( true );

	printf( "CPU time = %.3f s, wall clock time = %.3f s\n",
	// CPU time
	( $endUsage['ru_utime.tv_sec'] + $endUsage['ru_utime.tv_usec'] * 1e-6
	- $startUsage['ru_utime.tv_sec'] - $startUsage['ru_utime.tv_usec'] * 1e-6 ) / $loops,
	// Wall clock time
	( $endTime - $startTime ) / $loops
	);
	}

	/**
	* Fetch the ID of the revision of a Title that occurred
	*
	* @param Title $title
	* @param string $timestamp
	* @return bool\|string Revision ID, or false if not found or error
	*/
	private function getRevIdForTime( Title $title, $timestamp ) {
	$dbr = $this->getReplicaDB();

	$id = $dbr->newSelectQueryBuilder()
	->select( 'rev_id' )
	->from( 'revision' )
	->join( 'page', null, 'rev_page=page_id' )
	->where( [ 'page_namespace' => $title->getNamespace(), 'page_title' => $title->getDBkey() ] )
	->andWhere( $dbr->expr( 'rev_timestamp', '<=', $timestamp ) )
	->orderBy( 'rev_timestamp', SelectQueryBuilder::SORT_DESC )
	->caller( __METHOD__ )->fetchField();

	return $id;
	}

	/**
	* Parse the text from a given RevisionRecord
	*
	* @param RevisionRecord $revision
	*/
	private function runParser( RevisionRecord $revision ) {
	$content = $revision->getContent( SlotRecord::MAIN );
	$contentRenderer = $this->getServiceContainer()->getContentRenderer();
	// @phan-suppress-next-line PhanTypeMismatchArgumentNullable getId does not return null here
	$contentRenderer->getParserOutput( $content, $revision->getPage(), $revision->getId() );
	if ( $this->clearLinkCache ) {
	$this->linkCache->clear();
	}
	}

	/**
	* Hook into the parser's revision ID fetcher. Make sure that the parser only
	* uses revisions around the specified timestamp.
	*
	* @param ?LinkTarget $contextTitle
	* @param LinkTarget $titleTarget
	* @param bool &$skip
	* @param ?RevisionRecord &$revRecord
	* @return bool
	*/
	private function onFetchTemplate(
	?LinkTarget $contextTitle,
	LinkTarget $titleTarget,
	bool &$skip,
	?RevisionRecord &$revRecord
	): bool {
	$title = Title::newFromLinkTarget( $titleTarget );

	$pdbk = $title->getPrefixedDBkey();
	if ( !isset( $this->idCache[$pdbk] ) ) {
	$proposedId = $this->getRevIdForTime( $title, $this->templateTimestamp );
	$this->idCache[$pdbk] = $proposedId;
	}
	if ( $this->idCache[$pdbk] !== false ) {
	$revLookup = $this->getServiceContainer()->getRevisionLookup();
	$revRecord = $revLookup->getRevisionById( $this->idCache[$pdbk] );
	}

	return true;
	}
	}

	// @codeCoverageIgnoreStart
	$maintClass = BenchmarkParse::class;
	require_once RUN_MAINTENANCE_IF_MAIN;
	// @codeCoverageIgnoreEnd

File Metadata

Mime Type: text/x-php
Expires: Sat, May 16, 22:18 (1 d, 4 h)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 85/61/9a0d8af23fd19118c5e46dd68ec2
Default Alt Text: benchmarkParse.php (6 KB)

benchmarkParse.phpNo OneTemporaryActions

benchmarkParse.phpView Options

File Metadata

Event Timeline

benchmarkParse.php
No OneTemporary
Actions

benchmarkParse.php
View Options