<?php
+/**
+ * Class for managing forking command line scripts.
+ *
+ * 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
+ */
+use MediaWiki\MediaWikiServices;
/**
* Class for managing forking command line scripts.
- * Currently just does forking and process control, but it could easily be extended
+ * Currently just does forking and process control, but it could easily be extended
* to provide IPC and job dispatch.
*
* This class requires the posix and pcntl extensions.
+ *
+ * @ingroup Maintenance
*/
class ForkController {
- var $children = array();
- var $termReceived = false;
- var $flags = 0, $procsToStart = 0;
+ protected $children = [], $childNumber = 0;
+ protected $termReceived = false;
+ protected $flags = 0, $procsToStart = 0;
- static $restartableSignals = array(
+ protected static $restartableSignals = [
SIGFPE,
SIGILL,
SIGSEGV,
SIGPIPE,
SIGXCPU,
SIGXFSZ,
- );
+ ];
/**
* Pass this flag to __construct() to cause the class to automatically restart
const RESTART_ON_ERROR = 1;
public function __construct( $numProcs, $flags = 0 ) {
- if ( php_sapi_name() != 'cli' ) {
- throw new MWException( "MultiProcess cannot be used from the web." );
+ if ( PHP_SAPI != 'cli' ) {
+ throw new MWException( "ForkController cannot be used from the web." );
}
$this->procsToStart = $numProcs;
$this->flags = $flags;
}
/**
- * Start the child processes.
+ * Start the child processes.
*
- * This should only be called from the command line. It should be called
+ * This should only be called from the command line. It should be called
* as early as possible during execution.
*
- * This will return 'child' in the child processes. In the parent process,
- * it will run until all the child processes exit or a TERM signal is
+ * This will return 'child' in the child processes. In the parent process,
+ * it will run until all the child processes exit or a TERM signal is
* received. It will then return 'done'.
+ * @return string
*/
public function start() {
// Trap SIGTERM
- pcntl_signal( SIGTERM, array( $this, 'handleTermSignal' ), false );
+ pcntl_signal( SIGTERM, [ $this, 'handleTermSignal' ], false );
do {
// Start child processes
// Restart if the signal was abnormal termination
// Don't restart if it was deliberately killed
$signal = pcntl_wtermsig( $status );
- if ( in_array( $signal, self::$restartableSignals ) ) {
+ if ( in_array( $signal, self::$restartableSignals ) ) {
echo "Worker exited with signal $signal, restarting\n";
$this->procsToStart++;
}
} elseif ( pcntl_wifexited( $status ) ) {
// Restart on non-zero exit status
$exitStatus = pcntl_wexitstatus( $status );
- if ( $exitStatus > 0 ) {
+ if ( $exitStatus != 0 ) {
echo "Worker exited with status $exitStatus, restarting\n";
$this->procsToStart++;
+ } else {
+ echo "Worker exited normally\n";
}
}
}
if ( function_exists( 'pcntl_signal_dispatch' ) ) {
pcntl_signal_dispatch();
} else {
- declare (ticks=1) { $status = $status; }
+ declare( ticks = 1 ) {
+ $status = $status;
+ }
}
// Respond to TERM signal
if ( $this->termReceived ) {
return 'done';
}
+ /**
+ * Get the number of the child currently running. Note, this
+ * is not the pid, but rather which of the total number of children
+ * we are
+ * @return int
+ */
+ public function getChildNumber() {
+ return $this->childNumber;
+ }
+
protected function prepareEnvironment() {
- global $wgCaches, $wgMemc;
- // Don't share DB or memcached connections
- wfGetLBFactory()->destroyInstance();
- $wgCaches = array();
- unset( $wgMemc );
+ global $wgMemc;
+ // Don't share DB, storage, or memcached connections
+ MediaWikiServices::resetChildProcessServices();
+ FileBackendGroup::destroySingleton();
+ LockManagerGroup::destroySingletons();
+ JobQueueGroup::destroySingletons();
+ ObjectCache::clear();
+ RedisConnectionPool::destroySingletons();
+ $wgMemc = null;
}
/**
* Fork a number of worker processes.
+ *
+ * @param int $numProcs
+ * @return string
*/
protected function forkWorkers( $numProcs ) {
- global $wgMemc, $wgCaches, $wgMainCacheType;
-
$this->prepareEnvironment();
// Create the child processes
if ( !$pid ) {
$this->initChild();
+ $this->childNumber = $i;
return 'child';
} else {
// This is the parent process
global $wgMemc, $wgMainCacheType;
$wgMemc = wfGetCache( $wgMainCacheType );
$this->children = null;
- pcntl_signal( SIGTERM, SIG_DFL );
+ pcntl_signal( SIGTERM, SIG_DFL );
}
protected function handleTermSignal( $signal ) {
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff