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
21 * @author Aaron Schulz
25 * Class to handle enqueueing of background jobs
32 protected static $instances = array();
34 /** @var ProcessCacheLRU */
37 protected $wiki; // string; wiki ID
39 /** @var array Map of (bucket => (queue => JobQueue, types => list of types) */
40 protected $coalescedQueues;
42 const TYPE_DEFAULT
= 1; // integer; jobs popped by default
43 const TYPE_ANY
= 2; // integer; any job
45 const USE_CACHE
= 1; // integer; use process or persistent cache
46 const USE_PRIORITY
= 2; // integer; respect deprioritization
48 const PROC_CACHE_TTL
= 15; // integer; seconds
50 const CACHE_VERSION
= 1; // integer; cache version
53 * @param string $wiki Wiki ID
55 protected function __construct( $wiki ) {
57 $this->cache
= new ProcessCacheLRU( 10 );
61 * @param string $wiki Wiki ID
62 * @return JobQueueGroup
64 public static function singleton( $wiki = false ) {
65 $wiki = ( $wiki === false ) ?
wfWikiID() : $wiki;
66 if ( !isset( self
::$instances[$wiki] ) ) {
67 self
::$instances[$wiki] = new self( $wiki );
70 return self
::$instances[$wiki];
74 * Destroy the singleton instances
78 public static function destroySingletons() {
79 self
::$instances = array();
83 * Get the job queue object for a given queue type
88 public function get( $type ) {
89 global $wgJobTypeConf;
91 $conf = array( 'wiki' => $this->wiki
, 'type' => $type );
92 if ( isset( $wgJobTypeConf[$type] ) ) {
93 $conf = $conf +
$wgJobTypeConf[$type];
95 $conf = $conf +
$wgJobTypeConf['default'];
98 return JobQueue
::factory( $conf );
102 * Insert jobs into the respective queues of with the belong.
104 * This inserts the jobs into the queue specified by $wgJobTypeConf
105 * and updates the aggregate job queue information cache as needed.
107 * @param $jobs Job|array A single Job or a list of Jobs
108 * @throws MWException
111 public function push( $jobs ) {
112 $jobs = is_array( $jobs ) ?
$jobs : array( $jobs );
114 $jobsByType = array(); // (job type => list of jobs)
115 foreach ( $jobs as $job ) {
116 if ( $job instanceof Job
) {
117 $jobsByType[$job->getType()][] = $job;
119 throw new MWException( "Attempted to push a non-Job object into a queue." );
124 foreach ( $jobsByType as $type => $jobs ) {
125 if ( $this->get( $type )->push( $jobs ) ) {
126 JobQueueAggregator
::singleton()->notifyQueueNonEmpty( $this->wiki
, $type );
132 if ( $this->cache
->has( 'queues-ready', 'list' ) ) {
133 $list = $this->cache
->get( 'queues-ready', 'list' );
134 if ( count( array_diff( array_keys( $jobsByType ), $list ) ) ) {
135 $this->cache
->clear( 'queues-ready' );
143 * Pop a job off one of the job queues
145 * This pops a job off a queue as specified by $wgJobTypeConf and
146 * updates the aggregate job queue information cache as needed.
148 * @param $qtype integer|string JobQueueGroup::TYPE_DEFAULT or type string
149 * @param $flags integer Bitfield of JobQueueGroup::USE_* constants
150 * @return Job|bool Returns false on failure
152 public function pop( $qtype = self
::TYPE_DEFAULT
, $flags = 0 ) {
153 if ( is_string( $qtype ) ) { // specific job type
154 if ( ( $flags & self
::USE_PRIORITY
) && $this->isQueueDeprioritized( $qtype ) ) {
155 return false; // back off
157 $job = $this->get( $qtype )->pop();
159 JobQueueAggregator
::singleton()->notifyQueueEmpty( $this->wiki
, $qtype );
163 } else { // any job in the "default" jobs types
164 if ( $flags & self
::USE_CACHE
) {
165 if ( !$this->cache
->has( 'queues-ready', 'list', self
::PROC_CACHE_TTL
) ) {
166 $this->cache
->set( 'queues-ready', 'list', $this->getQueuesWithJobs() );
168 $types = $this->cache
->get( 'queues-ready', 'list' );
170 $types = $this->getQueuesWithJobs();
173 if ( $qtype == self
::TYPE_DEFAULT
) {
174 $types = array_intersect( $types, $this->getDefaultQueueTypes() );
176 shuffle( $types ); // avoid starvation
178 foreach ( $types as $type ) { // for each queue...
179 if ( ( $flags & self
::USE_PRIORITY
) && $this->isQueueDeprioritized( $type ) ) {
180 continue; // back off
182 $job = $this->get( $type )->pop();
183 if ( $job ) { // found
185 } else { // not found
186 JobQueueAggregator
::singleton()->notifyQueueEmpty( $this->wiki
, $type );
187 $this->cache
->clear( 'queues-ready' );
191 return false; // no jobs found
196 * Acknowledge that a job was completed
201 public function ack( Job
$job ) {
202 return $this->get( $job->getType() )->ack( $job );
206 * Register the "root job" of a given job into the queue for de-duplication.
207 * This should only be called right *after* all the new jobs have been inserted.
212 public function deduplicateRootJob( Job
$job ) {
213 return $this->get( $job->getType() )->deduplicateRootJob( $job );
217 * Wait for any slaves or backup queue servers to catch up.
219 * This does nothing for certain queue classes.
222 * @throws MWException
224 public function waitForBackups() {
225 global $wgJobTypeConf;
227 wfProfileIn( __METHOD__
);
228 // Try to avoid doing this more than once per queue storage medium
229 foreach ( $wgJobTypeConf as $type => $conf ) {
230 $this->get( $type )->waitForBackups();
232 wfProfileOut( __METHOD__
);
236 * Get the list of queue types
238 * @return array List of strings
240 public function getQueueTypes() {
241 return array_keys( $this->getCachedConfigVar( 'wgJobClasses' ) );
245 * Get the list of default queue types
247 * @return array List of strings
249 public function getDefaultQueueTypes() {
250 global $wgJobTypesExcludedFromDefaultQueue;
252 return array_diff( $this->getQueueTypes(), $wgJobTypesExcludedFromDefaultQueue );
256 * Get the list of job types that have non-empty queues
258 * @return Array List of job types that have non-empty queues
260 public function getQueuesWithJobs() {
262 foreach ( $this->getCoalescedQueues() as $info ) {
263 $nonEmpty = $info['queue']->getSiblingQueuesWithJobs( $this->getQueueTypes() );
264 if ( is_array( $nonEmpty ) ) { // batching features supported
265 $types = array_merge( $types, $nonEmpty );
266 } else { // we have to go through the queues in the bucket one-by-one
267 foreach ( $info['types'] as $type ) {
268 if ( !$this->get( $type )->isEmpty() ) {
279 * Get the size of the queus for a list of job types
281 * @return Array Map of (job type => size)
283 public function getQueueSizes() {
285 foreach ( $this->getCoalescedQueues() as $info ) {
286 $sizes = $info['queue']->getSiblingQueueSizes( $this->getQueueTypes() );
287 if ( is_array( $sizes ) ) { // batching features supported
288 $sizeMap = $sizeMap +
$sizes;
289 } else { // we have to go through the queues in the bucket one-by-one
290 foreach ( $info['types'] as $type ) {
291 $sizeMap[$type] = $this->get( $type )->getSize();
302 protected function getCoalescedQueues() {
303 global $wgJobTypeConf;
305 if ( $this->coalescedQueues
=== null ) {
306 $this->coalescedQueues
= array();
307 foreach ( $wgJobTypeConf as $type => $conf ) {
308 $queue = JobQueue
::factory(
309 array( 'wiki' => $this->wiki
, 'type' => 'null' ) +
$conf );
310 $loc = $queue->getCoalesceLocationInternal();
311 if ( !isset( $this->coalescedQueues
[$loc] ) ) {
312 $this->coalescedQueues
[$loc]['queue'] = $queue;
313 $this->coalescedQueues
[$loc]['types'] = array();
315 if ( $type === 'default' ) {
316 $this->coalescedQueues
[$loc]['types'] = array_merge(
317 $this->coalescedQueues
[$loc]['types'],
318 array_diff( $this->getQueueTypes(), array_keys( $wgJobTypeConf ) )
321 $this->coalescedQueues
[$loc]['types'][] = $type;
326 return $this->coalescedQueues
;
330 * Check if jobs should not be popped of a queue right now.
331 * This is only used for performance, such as to avoid spamming
332 * the queue with many sub-jobs before they actually get run.
334 * @param $type string
337 public function isQueueDeprioritized( $type ) {
338 if ( $this->cache
->has( 'isDeprioritized', $type, 5 ) ) {
339 return $this->cache
->get( 'isDeprioritized', $type );
341 if ( $type === 'refreshLinks2' ) {
342 // Don't keep converting refreshLinks2 => refreshLinks jobs if the
343 // later jobs have not been done yet. This helps throttle queue spam.
344 $deprioritized = !$this->get( 'refreshLinks' )->isEmpty();
345 $this->cache
->set( 'isDeprioritized', $type, $deprioritized );
347 return $deprioritized;
354 * Execute any due periodic queue maintenance tasks for all queues.
356 * A task is "due" if the time ellapsed since the last run is greater than
357 * the defined run period. Concurrent calls to this function will cause tasks
358 * to be attempted twice, so they may need their own methods of mutual exclusion.
360 * @return integer Number of tasks run
362 public function executeReadyPeriodicTasks() {
365 list( $db, $prefix ) = wfSplitWikiID( $this->wiki
);
366 $key = wfForeignMemcKey( $db, $prefix, 'jobqueuegroup', 'taskruns', 'v1' );
367 $lastRuns = $wgMemc->get( $key ); // (queue => task => UNIX timestamp)
370 $tasksRun = array(); // (queue => task => UNIX timestamp)
371 foreach ( $this->getQueueTypes() as $type ) {
372 $queue = $this->get( $type );
373 foreach ( $queue->getPeriodicTasks() as $task => $definition ) {
374 if ( $definition['period'] <= 0 ) {
375 continue; // disabled
376 } elseif ( !isset( $lastRuns[$type][$task] )
377 ||
$lastRuns[$type][$task] < ( time() - $definition['period'] )
380 if ( call_user_func( $definition['callback'] ) !== null ) {
381 $tasksRun[$type][$task] = time();
384 } catch ( JobQueueError
$e ) {
385 MWExceptionHandler
::logException( $e );
391 $wgMemc->merge( $key, function ( $cache, $key, $lastRuns ) use ( $tasksRun ) {
392 if ( is_array( $lastRuns ) ) {
393 foreach ( $tasksRun as $type => $tasks ) {
394 foreach ( $tasks as $task => $timestamp ) {
395 if ( !isset( $lastRuns[$type][$task] )
396 ||
$timestamp > $lastRuns[$type][$task]
398 $lastRuns[$type][$task] = $timestamp;
403 $lastRuns = $tasksRun;
413 * @param $name string
416 private function getCachedConfigVar( $name ) {
417 global $wgConf, $wgMemc;
419 if ( $this->wiki
=== wfWikiID() ) {
420 return $GLOBALS[$name]; // common case
422 list( $db, $prefix ) = wfSplitWikiID( $this->wiki
);
423 $key = wfForeignMemcKey( $db, $prefix, 'configvalue', $name );
424 $value = $wgMemc->get( $key ); // ('v' => ...) or false
425 if ( is_array( $value ) ) {
428 $value = $wgConf->getConfig( $this->wiki
, $name );
429 $wgMemc->set( $key, array( 'v' => $value ), 86400 +
mt_rand( 0, 86400 ) );