includes/jobqueue/JobRunner.php

   1 <?php
   2 /**
   3  * Job queue runner utility methods
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup JobQueue
  22  */
  23
  24 use MediaWiki\Logger\LoggerFactory;
  25 use Psr\Log\LoggerAwareInterface;
  26 use Psr\Log\LoggerInterface;
  27
  28 /**
  29  * Job queue runner utility methods
  30  *
  31  * @ingroup JobQueue
  32  * @since 1.24
  33  */
  34 class JobRunner implements LoggerAwareInterface {
  35         /** @var callable|null Debug output handler */
  36         protected $debug;
  37
  38         /**
  39          * @var LoggerInterface $logger
  40          */
  41         protected $logger;
  42
  43         /**
  44          * @param callable $debug Optional debug output handler
  45          */
  46         public function setDebugHandler( $debug ) {
  47                 $this->debug = $debug;
  48         }
  49
  50         /**
  51          * @param LoggerInterface $logger
  52          * @return void
  53          */
  54         public function setLogger( LoggerInterface $logger ) {
  55                 $this->logger = $logger;
  56         }
  57
  58         /**
  59          * @param LoggerInterface $logger
  60          */
  61         public function __construct( LoggerInterface $logger = null ) {
  62                 if ( $logger === null ) {
  63                         $logger = LoggerFactory::getInstance( 'runJobs' );
  64                 }
  65                 $this->setLogger( $logger );
  66         }
  67
  68         /**
  69          * Run jobs of the specified number/type for the specified time
  70          *
  71          * The response map has a 'job' field that lists status of each job, including:
  72          *   - type   : the job type
  73          *   - status : ok/failed
  74          *   - error  : any error message string
  75          *   - time   : the job run time in ms
  76          * The response map also has:
  77          *   - backoffs : the (job type => seconds) map of backoff times
  78          *   - elapsed  : the total time spent running tasks in ms
  79          *   - reached  : the reason the script finished, one of (none-ready, job-limit, time-limit)
  80          *
  81          * This method outputs status information only if a debug handler was set.
  82          * Any exceptions are caught and logged, but are not reported as output.
  83          *
  84          * @param array $options Map of parameters:
  85          *    - type     : the job type (or false for the default types)
  86          *    - maxJobs  : maximum number of jobs to run
  87          *    - maxTime  : maximum time in seconds before stopping
  88          *    - throttle : whether to respect job backoff configuration
  89          * @return array Summary response that can easily be JSON serialized
  90          */
  91         public function run( array $options ) {
  92                 global $wgJobClasses, $wgTrxProfilerLimits;
  93
  94                 $response = array( 'jobs' => array(), 'reached' => 'none-ready' );
  95
  96                 $type = isset( $options['type'] ) ? $options['type'] : false;
  97                 $maxJobs = isset( $options['maxJobs'] ) ? $options['maxJobs'] : false;
  98                 $maxTime = isset( $options['maxTime'] ) ? $options['maxTime'] : false;
  99                 $noThrottle = isset( $options['throttle'] ) && !$options['throttle'];
 100
 101                 if ( $type !== false && !isset( $wgJobClasses[$type] ) ) {
 102                         $response['reached'] = 'none-possible';
 103                         return $response;
 104                 }
 105
 106                 // Bail out if in read-only mode
 107                 if ( wfReadOnly() ) {
 108                         $response['reached'] = 'read-only';
 109                         return $response;
 110                 }
 111
 112                 $profiler = Profiler::instance();
 113
 114                 // Catch huge single updates that lead to slave lag
 115                 $trxProfiler = $profiler->getTransactionProfiler();
 116                 $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
 117                 $trxProfiler->setExpectations( $wgTrxProfilerLimits['JobRunner'], __METHOD__ );
 118
 119                 // Bail out if there is too much DB lag.
 120                 // This check should not block as we want to try other wiki queues.
 121                 $maxAllowedLag = 3;
 122                 list( , $maxLag ) = wfGetLB( wfWikiID() )->getMaxLag();
 123                 if ( $maxLag >= $maxAllowedLag ) {
 124                         $response['reached'] = 'slave-lag-limit';
 125                         return $response;
 126                 }
 127
 128                 $group = JobQueueGroup::singleton();
 129
 130                 // Flush any pending DB writes for sanity
 131                 wfGetLBFactory()->commitMasterChanges();
 132
 133                 // Some jobs types should not run until a certain timestamp
 134                 $backoffs = array(); // map of (type => UNIX expiry)
 135                 $backoffDeltas = array(); // map of (type => seconds)
 136                 $wait = 'wait'; // block to read backoffs the first time
 137
 138                 $jobsRun = 0;
 139                 $timeMsTotal = 0;
 140                 $flags = JobQueueGroup::USE_CACHE;
 141                 $startTime = microtime( true ); // time since jobs started running
 142                 $checkLagPeriod = 1.0; // check slave lag this many seconds
 143                 $lastCheckTime = 1; // timestamp of last slave check
 144                 do {
 145                         // Sync the persistent backoffs with concurrent runners
 146                         $backoffs = $this->syncBackoffDeltas( $backoffs, $backoffDeltas, $wait );
 147                         $blacklist = $noThrottle ? array() : array_keys( $backoffs );
 148                         $wait = 'nowait'; // less important now
 149
 150                         if ( $type === false ) {
 151                                 $job = $group->pop( JobQueueGroup::TYPE_DEFAULT, $flags, $blacklist );
 152                         } elseif ( in_array( $type, $blacklist ) ) {
 153                                 $job = false; // requested queue in backoff state
 154                         } else {
 155                                 $job = $group->pop( $type ); // job from a single queue
 156                         }
 157
 158                         if ( $job ) { // found a job
 159                                 $jType = $job->getType();
 160
 161                                 // Back off of certain jobs for a while (for throttling and for errors)
 162                                 $ttw = $this->getBackoffTimeToWait( $job );
 163                                 if ( $ttw > 0 ) {
 164                                         // Always add the delta for other runners in case the time running the
 165                                         // job negated the backoff for each individually but not collectively.
 166                                         $backoffDeltas[$jType] = isset( $backoffDeltas[$jType] )
 167                                                 ? $backoffDeltas[$jType] + $ttw
 168                                                 : $ttw;
 169                                         $backoffs = $this->syncBackoffDeltas( $backoffs, $backoffDeltas, $wait );
 170                                 }
 171
 172                                 $msg = $job->toString() . " STARTING";
 173                                 $this->logger->debug( $msg );
 174                                 $this->debugCallback( $msg );
 175
 176                                 // Run the job...
 177                                 $psection = $profiler->scopedProfileIn( __METHOD__ . '-' . $jType );
 178                                 $jobStartTime = microtime( true );
 179                                 try {
 180                                         ++$jobsRun;
 181                                         $status = $job->run();
 182                                         $error = $job->getLastError();
 183                                         $this->commitMasterChanges( $job );
 184                                 } catch ( Exception $e ) {
 185                                         MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 186                                         $status = false;
 187                                         $error = get_class( $e ) . ': ' . $e->getMessage();
 188                                         MWExceptionHandler::logException( $e );
 189                                 }
 190                                 $timeMs = intval( ( microtime( true ) - $jobStartTime ) * 1000 );
 191                                 $timeMsTotal += $timeMs;
 192                                 $profiler->scopedProfileOut( $psection );
 193
 194                                 // Mark the job as done on success or when the job cannot be retried
 195                                 if ( $status !== false || !$job->allowRetries() ) {
 196                                         $group->ack( $job ); // done
 197                                 }
 198
 199                                 // Back off of certain jobs for a while (for throttling and for errors)
 200                                 if ( $status === false && mt_rand( 0, 49 ) == 0 ) {
 201                                         $ttw = max( $ttw, 30 ); // too many errors
 202                                         $backoffDeltas[$jType] = isset( $backoffDeltas[$jType] )
 203                                                 ? $backoffDeltas[$jType] + $ttw
 204                                                 : $ttw;
 205                                 }
 206
 207                                 if ( $status === false ) {
 208                                         $msg = $job->toString() . " t=$timeMs error={$error}";
 209                                         $this->logger->error( $msg );
 210                                         $this->debugCallback( $msg );
 211                                 } else {
 212                                         $msg = $job->toString() . " t=$timeMs good";
 213                                         $this->logger->info( $msg );
 214                                         $this->debugCallback( $msg );
 215                                 }
 216
 217                                 $response['jobs'][] = array(
 218                                         'type'   => $jType,
 219                                         'status' => ( $status === false ) ? 'failed' : 'ok',
 220                                         'error'  => $error,
 221                                         'time'   => $timeMs
 222                                 );
 223
 224                                 // Break out if we hit the job count or wall time limits...
 225                                 if ( $maxJobs && $jobsRun >= $maxJobs ) {
 226                                         $response['reached'] = 'job-limit';
 227                                         break;
 228                                 } elseif ( $maxTime && ( microtime( true ) - $startTime ) > $maxTime ) {
 229                                         $response['reached'] = 'time-limit';
 230                                         break;
 231                                 }
 232
 233                                 // Don't let any of the main DB slaves get backed up.
 234                                 // This only waits for so long before exiting and letting
 235                                 // other wikis in the farm (on different masters) get a chance.
 236                                 $timePassed = microtime( true ) - $lastCheckTime;
 237                                 if ( $timePassed >= $checkLagPeriod || $timePassed < 0 ) {
 238                                         if ( !wfWaitForSlaves( $lastCheckTime, false, '*', $maxAllowedLag ) ) {
 239                                                 $response['reached'] = 'slave-lag-limit';
 240                                                 break;
 241                                         }
 242                                         $lastCheckTime = microtime( true );
 243                                 }
 244                                 // Don't let any queue slaves/backups fall behind
 245                                 if ( $jobsRun > 0 && ( $jobsRun % 100 ) == 0 ) {
 246                                         $group->waitForBackups();
 247                                 }
 248
 249                                 // Bail if near-OOM instead of in a job
 250                                 $this->assertMemoryOK();
 251                         }
 252                 } while ( $job ); // stop when there are no jobs
 253
 254                 // Sync the persistent backoffs for the next runJobs.php pass
 255                 if ( $backoffDeltas ) {
 256                         $this->syncBackoffDeltas( $backoffs, $backoffDeltas, 'wait' );
 257                 }
 258
 259                 $response['backoffs'] = $backoffs;
 260                 $response['elapsed'] = $timeMsTotal;
 261
 262                 return $response;
 263         }
 264
 265         /**
 266          * @param Job $job
 267          * @return int Seconds for this runner to avoid doing more jobs of this type
 268          * @see $wgJobBackoffThrottling
 269          */
 270         private function getBackoffTimeToWait( Job $job ) {
 271                 global $wgJobBackoffThrottling;
 272
 273                 if ( !isset( $wgJobBackoffThrottling[$job->getType()] ) ||
 274                         $job instanceof DuplicateJob // no work was done
 275                 ) {
 276                         return 0; // not throttled
 277                 }
 278
 279                 $itemsPerSecond = $wgJobBackoffThrottling[$job->getType()];
 280                 if ( $itemsPerSecond <= 0 ) {
 281                         return 0; // not throttled
 282                 }
 283
 284                 $seconds = 0;
 285                 if ( $job->workItemCount() > 0 ) {
 286                         $exactSeconds = $job->workItemCount() / $itemsPerSecond;
 287                         // use randomized rounding
 288                         $seconds = floor( $exactSeconds );
 289                         $remainder = $exactSeconds - $seconds;
 290                         $seconds += ( mt_rand() / mt_getrandmax() < $remainder ) ? 1 : 0;
 291                 }
 292
 293                 return (int)$seconds;
 294         }
 295
 296         /**
 297          * Get the previous backoff expiries from persistent storage
 298          * On I/O or lock acquisition failure this returns the original $backoffs.
 299          *
 300          * @param array $backoffs Map of (job type => UNIX timestamp)
 301          * @param string $mode Lock wait mode - "wait" or "nowait"
 302          * @return array Map of (job type => backoff expiry timestamp)
 303          */
 304         private function loadBackoffs( array $backoffs, $mode = 'wait' ) {
 305                 $file = wfTempDir() . '/mw-runJobs-backoffs.json';
 306                 if ( is_file( $file ) ) {
 307                         $noblock = ( $mode === 'nowait' ) ? LOCK_NB : 0;
 308                         $handle = fopen( $file, 'rb' );
 309                         if ( !flock( $handle, LOCK_SH | $noblock ) ) {
 310                                 fclose( $handle );
 311                                 return $backoffs; // don't wait on lock
 312                         }
 313                         $content = stream_get_contents( $handle );
 314                         flock( $handle, LOCK_UN );
 315                         fclose( $handle );
 316                         $ctime = microtime( true );
 317                         $cBackoffs = json_decode( $content, true ) ?: array();
 318                         foreach ( $cBackoffs as $type => $timestamp ) {
 319                                 if ( $timestamp < $ctime ) {
 320                                         unset( $cBackoffs[$type] );
 321                                 }
 322                         }
 323                 } else {
 324                         $cBackoffs = array();
 325                 }
 326
 327                 return $cBackoffs;
 328         }
 329
 330         /**
 331          * Merge the current backoff expiries from persistent storage
 332          *
 333          * The $deltas map is set to an empty array on success.
 334          * On I/O or lock acquisition failure this returns the original $backoffs.
 335          *
 336          * @param array $backoffs Map of (job type => UNIX timestamp)
 337          * @param array $deltas Map of (job type => seconds)
 338          * @param string $mode Lock wait mode - "wait" or "nowait"
 339          * @return array The new backoffs account for $backoffs and the latest file data
 340          */
 341         private function syncBackoffDeltas( array $backoffs, array &$deltas, $mode = 'wait' ) {
 342                 if ( !$deltas ) {
 343                         return $this->loadBackoffs( $backoffs, $mode );
 344                 }
 345
 346                 $noblock = ( $mode === 'nowait' ) ? LOCK_NB : 0;
 347                 $file = wfTempDir() . '/mw-runJobs-backoffs.json';
 348                 $handle = fopen( $file, 'wb+' );
 349                 if ( !flock( $handle, LOCK_EX | $noblock ) ) {
 350                         fclose( $handle );
 351                         return $backoffs; // don't wait on lock
 352                 }
 353                 $ctime = microtime( true );
 354                 $content = stream_get_contents( $handle );
 355                 $cBackoffs = json_decode( $content, true ) ?: array();
 356                 foreach ( $deltas as $type => $seconds ) {
 357                         $cBackoffs[$type] = isset( $cBackoffs[$type] ) && $cBackoffs[$type] >= $ctime
 358                                 ? $cBackoffs[$type] + $seconds
 359                                 : $ctime + $seconds;
 360                 }
 361                 foreach ( $cBackoffs as $type => $timestamp ) {
 362                         if ( $timestamp < $ctime ) {
 363                                 unset( $cBackoffs[$type] );
 364                         }
 365                 }
 366                 ftruncate( $handle, 0 );
 367                 fwrite( $handle, json_encode( $cBackoffs ) );
 368                 flock( $handle, LOCK_UN );
 369                 fclose( $handle );
 370
 371                 $deltas = array();
 372
 373                 return $cBackoffs;
 374         }
 375
 376         /**
 377          * Make sure that this script is not too close to the memory usage limit.
 378          * It is better to die in between jobs than OOM right in the middle of one.
 379          * @throws MWException
 380          */
 381         private function assertMemoryOK() {
 382                 static $maxBytes = null;
 383                 if ( $maxBytes === null ) {
 384                         $m = array();
 385                         if ( preg_match( '!^(\d+)(k|m|g|)$!i', ini_get( 'memory_limit' ), $m ) ) {
 386                                 list( , $num, $unit ) = $m;
 387                                 $conv = array( 'g' => 1073741824, 'm' => 1048576, 'k' => 1024, '' => 1 );
 388                                 $maxBytes = $num * $conv[strtolower( $unit )];
 389                         } else {
 390                                 $maxBytes = 0;
 391                         }
 392                 }
 393                 $usedBytes = memory_get_usage();
 394                 if ( $maxBytes && $usedBytes >= 0.95 * $maxBytes ) {
 395                         throw new MWException( "Detected excessive memory usage ($usedBytes/$maxBytes)." );
 396                 }
 397         }
 398
 399         /**
 400          * Log the job message
 401          * @param string $msg The message to log
 402          */
 403         private function debugCallback( $msg ) {
 404                 if ( $this->debug ) {
 405                         call_user_func_array( $this->debug, array( wfTimestamp( TS_DB ) . " $msg\n" ) );
 406                 }
 407         }
 408
 409         /**
 410          * Commit any DB master changes from a job on all load balancers
 411          *
 412          * @param Job $job
 413          * @throws DBError
 414          */
 415         private function commitMasterChanges( Job $job ) {
 416                 global $wgJobSerialCommitThreshold;
 417
 418                 $lb = wfGetLB( wfWikiID() );
 419                 if ( $wgJobSerialCommitThreshold !== false ) {
 420                         // Generally, there is one master connection to the local DB
 421                         $dbwSerial = $lb->getAnyOpenConnection( $lb->getWriterIndex() );
 422                 } else {
 423                         $dbwSerial = false;
 424                 }
 425
 426                 if ( !$dbwSerial
 427                         || !$dbwSerial->namedLocksEnqueue()
 428                         || $dbwSerial->pendingWriteQueryDuration() < $wgJobSerialCommitThreshold
 429                 ) {
 430                         // Writes are all to foreign DBs, named locks don't form queues,
 431                         // or $wgJobSerialCommitThreshold is not reached; commit changes now
 432                         wfGetLBFactory()->commitMasterChanges();
 433                         return;
 434                 }
 435
 436                 $ms = intval( 1000 * $dbwSerial->pendingWriteQueryDuration() );
 437                 $msg = $job->toString() . " COMMIT ENQUEUED [{$ms}ms of writes]";
 438                 $this->logger->info( $msg );
 439                 $this->debugCallback( $msg );
 440
 441                 // Wait for an exclusive lock to commit
 442                 if ( !$dbwSerial->lock( 'jobrunner-serial-commit', __METHOD__, 30 ) ) {
 443                         // This will trigger a rollback in the main loop
 444                         throw new DBError( $dbwSerial, "Timed out waiting on commit queue." );
 445                 }
 446                 // Wait for the generic slave to catch up
 447                 $pos = $lb->getMasterPos();
 448                 if ( $pos ) {
 449                         $lb->waitForOne( $pos );
 450                 }
 451
 452                 $fname = __METHOD__;
 453                 // Re-ping all masters with transactions. This throws DBError if some
 454                 // connection died while waiting on locks/slaves, triggering a rollback.
 455                 wfGetLBFactory()->forEachLB( function( LoadBalancer $lb ) use ( $fname ) {
 456                         $lb->forEachOpenConnection( function( DatabaseBase $conn ) use ( $fname ) {
 457                                 if ( $conn->writesOrCallbacksPending() ) {
 458                                         $conn->query( "SELECT 1", $fname );
 459                                 }
 460                         } );
 461                 } );
 462
 463                 // Actually commit the DB master changes
 464                 wfGetLBFactory()->commitMasterChanges();
 465
 466                 // Release the lock
 467                 $dbwSerial->unlock( 'jobrunner-serial-commit', __METHOD__ );
 468         }
 469 }