Merge "Make sure images that don't have an explicit alignment get aligned right"
[mediawiki.git] / maintenance / runJobs.php
blob9b86e1b6177ec2237d2124b8314088b1d6536d1d
1 <?php
2 /**
3 * Run pending jobs.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
20 * @file
21 * @ingroup Maintenance
24 require_once __DIR__ . '/Maintenance.php';
26 /**
27 * Maintenance script that runs pending jobs.
29 * @ingroup Maintenance
31 class RunJobs extends Maintenance {
32 public function __construct() {
33 parent::__construct();
34 $this->mDescription = "Run pending jobs";
35 $this->addOption( 'maxjobs', 'Maximum number of jobs to run', false, true );
36 $this->addOption( 'maxtime', 'Maximum amount of wall-clock time', false, true );
37 $this->addOption( 'type', 'Type of job to run', false, true );
38 $this->addOption( 'procs', 'Number of processes to use', false, true );
39 $this->addOption( 'nothrottle', 'Ignore job throttling configuration', false, false );
42 public function memoryLimit() {
43 if ( $this->hasOption( 'memory-limit' ) ) {
44 return parent::memoryLimit();
47 // Don't eat all memory on the machine if we get a bad job.
48 return "150M";
51 public function execute() {
52 if ( wfReadOnly() ) {
53 $this->error( "Unable to run jobs; the wiki is in read-only mode.", 1 ); // die
56 if ( $this->hasOption( 'procs' ) ) {
57 $procs = intval( $this->getOption( 'procs' ) );
58 if ( $procs < 1 || $procs > 1000 ) {
59 $this->error( "Invalid argument to --procs", true );
60 } elseif ( $procs != 1 ) {
61 $fc = new ForkController( $procs );
62 if ( $fc->start() != 'child' ) {
63 exit( 0 );
68 $type = $this->getOption( 'type', false );
69 $maxJobs = $this->getOption( 'maxjobs', false );
70 $maxTime = $this->getOption( 'maxtime', false );
71 $noThrottle = $this->hasOption( 'nothrottle' );
72 $startTime = time();
74 $group = JobQueueGroup::singleton();
75 // Handle any required periodic queue maintenance
76 $count = $group->executeReadyPeriodicTasks();
77 if ( $count > 0 ) {
78 $this->runJobsLog( "Executed $count periodic queue task(s)." );
81 $backoffs = $this->loadBackoffs(); // map of (type => UNIX expiry)
82 $startingBackoffs = $backoffs; // avoid unnecessary writes
83 $backoffExpireFunc = function ( $t ) {
84 return $t > time();
87 $jobsRun = 0; // counter
88 $flags = JobQueueGroup::USE_CACHE;
89 $lastTime = time(); // time since last slave check
90 do {
91 $backoffs = array_filter( $backoffs, $backoffExpireFunc );
92 $blacklist = $noThrottle ? array() : array_keys( $backoffs );
93 if ( $type === false ) {
94 $job = $group->pop( JobQueueGroup::TYPE_DEFAULT, $flags, $blacklist );
95 } elseif ( in_array( $type, $blacklist ) ) {
96 $job = false; // requested queue in backoff state
97 } else {
98 $job = $group->pop( $type ); // job from a single queue
100 if ( $job ) { // found a job
101 ++$jobsRun;
102 $this->runJobsLog( $job->toString() . " STARTING" );
104 // Set timer to stop the job if too much CPU time is used
105 set_time_limit( $maxTime ? : 0 );
106 // Run the job...
107 wfProfileIn( __METHOD__ . '-' . get_class( $job ) );
108 $t = microtime( true );
109 try {
110 $status = $job->run();
111 $error = $job->getLastError();
112 } catch ( MWException $e ) {
113 MWExceptionHandler::rollbackMasterChangesAndLog( $e );
114 $status = false;
115 $error = get_class( $e ) . ': ' . $e->getMessage();
116 $e->report(); // write error to STDERR and the log
118 $timeMs = intval( ( microtime( true ) - $t ) * 1000 );
119 wfProfileOut( __METHOD__ . '-' . get_class( $job ) );
120 // Disable the timer
121 set_time_limit( 0 );
123 // Mark the job as done on success or when the job cannot be retried
124 if ( $status !== false || !$job->allowRetries() ) {
125 $group->ack( $job ); // done
128 if ( $status === false ) {
129 $this->runJobsLog( $job->toString() . " t=$timeMs error={$error}" );
130 } else {
131 $this->runJobsLog( $job->toString() . " t=$timeMs good" );
134 // Back off of certain jobs for a while
135 $ttw = $this->getBackoffTimeToWait( $job );
136 if ( $ttw > 0 ) {
137 $jType = $job->getType();
138 $backoffs[$jType] = isset( $backoffs[$jType] ) ? $backoffs[$jType] : 0;
139 $backoffs[$jType] = max( $backoffs[$jType], time() + $ttw );
142 // Break out if we hit the job count or wall time limits...
143 if ( $maxJobs && $jobsRun >= $maxJobs ) {
144 break;
145 } elseif ( $maxTime && ( time() - $startTime ) > $maxTime ) {
146 break;
149 // Don't let any of the main DB slaves get backed up
150 $timePassed = time() - $lastTime;
151 if ( $timePassed >= 5 || $timePassed < 0 ) {
152 wfWaitForSlaves();
153 $lastTime = time();
155 // Don't let any queue slaves/backups fall behind
156 if ( $jobsRun > 0 && ( $jobsRun % 100 ) == 0 ) {
157 $group->waitForBackups();
160 // Bail if near-OOM instead of in a job
161 $this->assertMemoryOK();
163 } while ( $job ); // stop when there are no jobs
164 // Sync the persistent backoffs for the next runJobs.php pass
165 $backoffs = array_filter( $backoffs, $backoffExpireFunc );
166 if ( $backoffs !== $startingBackoffs ) {
167 $this->syncBackoffs( $backoffs );
172 * @param Job $job
173 * @return int Seconds for this runner to avoid doing more jobs of this type
174 * @see $wgJobBackoffThrottling
176 private function getBackoffTimeToWait( Job $job ) {
177 global $wgJobBackoffThrottling;
179 if ( !isset( $wgJobBackoffThrottling[$job->getType()] ) ||
180 $job instanceof DuplicateJob // no work was done
182 return 0; // not throttled
185 $itemsPerSecond = $wgJobBackoffThrottling[$job->getType()];
186 if ( $itemsPerSecond <= 0 ) {
187 return 0; // not throttled
190 $seconds = 0;
191 if ( $job->workItemCount() > 0 ) {
192 $exactSeconds = $job->workItemCount() / $itemsPerSecond;
193 // use randomized rounding
194 $seconds = floor( $exactSeconds );
195 $remainder = $exactSeconds - $seconds;
196 $seconds += ( mt_rand() / mt_getrandmax() < $remainder ) ? 1 : 0;
199 return (int)$seconds;
203 * Get the previous backoff expiries from persistent storage
205 * @return array Map of (job type => backoff expiry timestamp)
207 private function loadBackoffs() {
208 $section = new ProfileSection( __METHOD__ );
210 $backoffs = array();
211 $file = wfTempDir() . '/mw-runJobs-backoffs.json';
212 if ( is_file( $file ) ) {
213 $handle = fopen( $file, 'rb' );
214 flock( $handle, LOCK_SH );
215 $content = stream_get_contents( $handle );
216 flock( $handle, LOCK_UN );
217 fclose( $handle );
218 $backoffs = json_decode( $content, true ) ? : array();
221 return $backoffs;
225 * Merge the current backoff expiries from persistent storage
227 * @param array $backoffs Map of (job type => backoff expiry timestamp)
229 private function syncBackoffs( array $backoffs ) {
230 $section = new ProfileSection( __METHOD__ );
232 $file = wfTempDir() . '/mw-runJobs-backoffs.json';
233 $handle = fopen( $file, 'wb+' );
234 flock( $handle, LOCK_EX );
235 $content = stream_get_contents( $handle );
236 $cBackoffs = json_decode( $content, true ) ? : array();
237 foreach ( $backoffs as $type => $timestamp ) {
238 $cBackoffs[$type] = isset( $cBackoffs[$type] ) ? $cBackoffs[$type] : 0;
239 $cBackoffs[$type] = max( $cBackoffs[$type], $backoffs[$type] );
241 ftruncate( $handle, 0 );
242 fwrite( $handle, json_encode( $backoffs ) );
243 flock( $handle, LOCK_UN );
244 fclose( $handle );
248 * Make sure that this script is not too close to the memory usage limit.
249 * It is better to die in between jobs than OOM right in the middle of one.
250 * @throws MWException
252 private function assertMemoryOK() {
253 static $maxBytes = null;
254 if ( $maxBytes === null ) {
255 $m = array();
256 if ( preg_match( '!^(\d+)(k|m|g|)$!i', ini_get( 'memory_limit' ), $m ) ) {
257 list( , $num, $unit ) = $m;
258 $conv = array( 'g' => 1073741824, 'm' => 1048576, 'k' => 1024, '' => 1 );
259 $maxBytes = $num * $conv[strtolower( $unit )];
260 } else {
261 $maxBytes = 0;
264 $usedBytes = memory_get_usage();
265 if ( $maxBytes && $usedBytes >= 0.95 * $maxBytes ) {
266 throw new MWException( "Detected excessive memory usage ($usedBytes/$maxBytes)." );
271 * Log the job message
272 * @param string $msg The message to log
274 private function runJobsLog( $msg ) {
275 $this->output( wfTimestamp( TS_DB ) . " $msg\n" );
276 wfDebugLog( 'runJobs', $msg );
280 $maintClass = "RunJobs";
281 require_once RUN_MAINTENANCE_IF_MAIN;