Queue.java 56.2 KB
Newer Older
K
kohsuke 已提交
1 2 3
/*
 * The MIT License
 * 
M
mindless 已提交
4 5
 * Copyright (c) 2004-2010, Sun Microsystems, Inc., Kohsuke Kawaguchi,
 * Stephen Connolly, Tom Huybrechts, InfraDNA, Inc.
K
kohsuke 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
K
kohsuke 已提交
25 26
package hudson.model;

27
import hudson.AbortException;
28
import hudson.BulkChange;
29 30
import hudson.ExtensionList;
import hudson.ExtensionPoint;
31
import hudson.Util;
K
kohsuke 已提交
32
import hudson.XmlFile;
K
kohsuke 已提交
33 34
import hudson.init.Initializer;
import static hudson.init.InitMilestone.JOB_LOADED;
35 36
import static hudson.util.Iterators.reverse;

37 38
import hudson.cli.declarative.CLIMethod;
import hudson.cli.declarative.CLIResolver;
39
import hudson.model.queue.AbstractQueueTask;
40
import hudson.model.queue.Executables;
41
import hudson.model.queue.SubTask;
42
import hudson.model.queue.FutureImpl;
43 44
import hudson.model.queue.MappingWorksheet;
import hudson.model.queue.MappingWorksheet.Mapping;
45
import hudson.model.queue.QueueSorter;
46
import hudson.model.queue.QueueTaskDispatcher;
47
import hudson.model.queue.Tasks;
48
import hudson.model.queue.WorkUnit;
K
kohsuke 已提交
49
import hudson.model.Node.Mode;
50
import hudson.model.listeners.SaveableListener;
51
import hudson.model.queue.CauseOfBlockage;
K
kohsuke 已提交
52
import hudson.model.queue.FoldableAction;
53 54 55 56
import hudson.model.queue.CauseOfBlockage.BecauseLabelIsBusy;
import hudson.model.queue.CauseOfBlockage.BecauseNodeIsOffline;
import hudson.model.queue.CauseOfBlockage.BecauseLabelIsOffline;
import hudson.model.queue.CauseOfBlockage.BecauseNodeIsBusy;
57
import hudson.model.queue.WorkUnitContext;
58 59
import hudson.triggers.SafeTimerTask;
import hudson.triggers.Trigger;
K
kohsuke 已提交
60
import hudson.util.OneShotEvent;
61
import hudson.util.TimeUnit2;
62
import hudson.util.XStream2;
63 64
import hudson.util.ConsistentHash;
import hudson.util.ConsistentHash.Hash;
K
kohsuke 已提交
65

66 67 68 69 70
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
71
import java.lang.ref.WeakReference;
K
kohsuke 已提交
72
import java.util.ArrayList;
73
import java.util.Arrays;
K
kohsuke 已提交
74
import java.util.Calendar;
75
import java.util.Collection;
76
import java.util.Collections;
K
kohsuke 已提交
77 78 79 80 81
import java.util.GregorianCalendar;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
82
import java.util.NoSuchElementException;
K
kohsuke 已提交
83 84
import java.util.Set;
import java.util.TreeSet;
S
stephenconnolly 已提交
85
import java.util.Map.Entry;
86
import java.util.concurrent.atomic.AtomicInteger;
87
import java.util.concurrent.Future;
K
kohsuke 已提交
88 89 90
import java.util.logging.Level;
import java.util.logging.Logger;

K
kohsuke 已提交
91
import javax.management.timer.Timer;
92
import javax.servlet.ServletException;
K
kohsuke 已提交
93 94

import org.acegisecurity.AccessDeniedException;
95 96
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.HttpResponses;
K
kohsuke 已提交
97 98 99 100 101 102
import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.export.ExportedBean;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.converters.basic.AbstractSingleValueConverter;

K
kohsuke 已提交
103 104
/**
 * Build queue.
105 106
 *
 * <p>
107 108
 * This class implements the core scheduling logic. {@link Task} represents the executable
 * task that are placed in the queue. While in the queue, it's wrapped into {@link Item}
109
 * so that we can keep track of additional data used for deciding what to exeucte when.
110 111
 *
 * <p>
112 113 114 115 116 117
 * Items in queue goes through several stages, as depicted below:
 * <pre>
 * (enter) --> waitingList --+--> blockedProjects
 *                           |        ^
 *                           |        |
 *                           |        v
118
 *                           +--> buildables ---> pending ---> (executed)
119
 * </pre>
120 121
 *
 * <p>
122 123 124
 * In addition, at any stage, an item can be removed from the queue (for example, when the user
 * cancels a job in the queue.) See the corresponding field for their exact meanings.
 *
K
kohsuke 已提交
125 126
 * @author Kohsuke Kawaguchi
 */
127
@ExportedBean
128
public class Queue extends ResourceController implements Saveable {
K
kohsuke 已提交
129
    /**
130
     * Items that are waiting for its quiet period to pass.
131 132
     *
     * <p>
K
kohsuke 已提交
133 134 135
     * This consists of {@link Item}s that cannot be run yet
     * because its time has not yet come.
     */
136
    private final Set<WaitingItem> waitingList = new TreeSet<WaitingItem>();
K
kohsuke 已提交
137 138

    /**
139
     * {@link Task}s that can be built immediately
140 141 142
     * but blocked because another build is in progress,
     * required {@link Resource}s are not available, or otherwise blocked
     * by {@link Task#isBuildBlocked()}.
K
kohsuke 已提交
143
     */
144
    private final ItemList<BlockedItem> blockedProjects = new ItemList<BlockedItem>();
K
kohsuke 已提交
145 146

    /**
147
     * {@link Task}s that can be built immediately
K
kohsuke 已提交
148
     * that are waiting for available {@link Executor}.
149
     * This list is sorted in such a way that earlier items are built earlier.
K
kohsuke 已提交
150
     */
151
    private final ItemList<BuildableItem> buildables = new ItemList<BuildableItem>();
152

153
    /**
154 155
     * {@link Task}s that are being handed over to the executor, but execution
     * has not started yet.
156 157 158
     */
    private final ItemList<BuildableItem> pendings = new ItemList<BuildableItem>();

K
kohsuke 已提交
159 160
    /**
     * Data structure created for each idle {@link Executor}.
161
     * This is a job offer from the queue to an executor.
162 163
     *
     * <p>
K
kohsuke 已提交
164 165
     * An idle executor (that calls {@link Queue#pop()} creates
     * a new {@link JobOffer} and gets itself {@linkplain Queue#parked parked},
166
     * and we'll eventually hand out an {@link #workUnit} to build.
K
kohsuke 已提交
167
     */
K
kohsuke 已提交
168
    public class JobOffer extends MappingWorksheet.ExecutorSlot {
K
kohsuke 已提交
169
        public final Executor executor;
K
kohsuke 已提交
170 171 172 173 174

        /**
         * Used to wake up an executor, when it has an offered
         * {@link Project} to build.
         */
175
        private final OneShotEvent event = new OneShotEvent(Queue.this);
K
kohsuke 已提交
176

K
kohsuke 已提交
177
        /**
178
         * The work unit that this {@link Executor} is going to handle.
K
kohsuke 已提交
179 180
         * (Or null, in which case event is used to trigger a queue maintenance.)
         */
181
        private WorkUnit workUnit;
K
kohsuke 已提交
182

K
kohsuke 已提交
183
        private JobOffer(Executor executor) {
K
kohsuke 已提交
184 185 186
            this.executor = executor;
        }

K
kohsuke 已提交
187 188
        @Override
        protected void set(WorkUnit p) {
189 190
            assert this.workUnit == null;
            this.workUnit = p;
K
kohsuke 已提交
191 192 193
            event.signal();
        }

K
kohsuke 已提交
194 195 196 197 198
        @Override
        public Executor getExecutor() {
            return executor;
        }

199 200 201 202
        /**
         * Verifies that the {@link Executor} represented by this object is capable of executing the given task.
         */
        public boolean canTake(Task task) {
203 204 205
            Node node = getNode();
            if (node==null)     return false;   // this executor is about to die

206 207
            if(node.canTake(task)!=null)
                return false;   // this node is not able to take the task
208

209 210 211
            for (QueueTaskDispatcher d : QueueTaskDispatcher.all())
                if (d.canTake(node,task)!=null)
                    return false;
212 213 214 215 216 217 218

            return isAvailable();
        }

        /**
         * Is this executor ready to accept some tasks?
         */
K
kohsuke 已提交
219
        public boolean isAvailable() {
220
            return workUnit == null && !executor.getOwner().isOffline() && executor.getOwner().isAcceptingTasks();
K
kohsuke 已提交
221 222 223 224 225 226 227
        }

        public Node getNode() {
            return executor.getOwner().getNode();
        }

        public boolean isNotExclusive() {
228
            return getNode().getMode() == Mode.NORMAL;
K
kohsuke 已提交
229 230 231
        }
    }

S
stephenconnolly 已提交
232
    /**
K
kohsuke 已提交
233
     * The executors that are currently waiting for a job to run.
S
stephenconnolly 已提交
234
     */
K
kohsuke 已提交
235
    private final Map<Executor,JobOffer> parked = new HashMap<Executor,JobOffer>();
K
kohsuke 已提交
236

237
    private volatile transient LoadBalancer loadBalancer;
238

239
    private volatile transient QueueSorter sorter;
240

241 242
    public Queue(LoadBalancer loadBalancer) {
        this.loadBalancer =  loadBalancer.sanitize();
243 244 245 246 247
        // if all the executors are busy doing something, then the queue won't be maintained in
        // timely fashion, so use another thread to make sure it happens.
        new MaintainTask(this);
    }

248 249 250 251 252 253 254 255 256
    public LoadBalancer getLoadBalancer() {
        return loadBalancer;
    }

    public void setLoadBalancer(LoadBalancer loadBalancer) {
        if(loadBalancer==null)  throw new IllegalArgumentException();
        this.loadBalancer = loadBalancer;
    }

257 258 259 260 261 262 263 264
    public QueueSorter getSorter() {
        return sorter;
    }

    public void setSorter(QueueSorter sorter) {
        this.sorter = sorter;
    }

K
kohsuke 已提交
265 266 267 268 269
    /**
     * Loads the queue contents that was {@link #save() saved}.
     */
    public synchronized void load() {
        try {
K
TAB->WS  
kohsuke 已提交
270
            // first try the old format
K
kohsuke 已提交
271
            File queueFile = getQueueFile();
K
kohsuke 已提交
272 273
            if (queueFile.exists()) {
                BufferedReader in = new BufferedReader(new InputStreamReader(new FileInputStream(queueFile)));
K
TAB->WS  
kohsuke 已提交
274 275 276 277
                String line;
                while ((line = in.readLine()) != null) {
                    AbstractProject j = Hudson.getInstance().getItemByFullName(line, AbstractProject.class);
                    if (j != null)
M
mindless 已提交
278
                        j.scheduleBuild();
K
TAB->WS  
kohsuke 已提交
279 280 281 282 283 284 285
                }
                in.close();
                // discard the queue file now that we are done
                queueFile.delete();
            } else {
                queueFile = getXMLQueueFile();
                if (queueFile.exists()) {
286
                    List list = (List) new XmlFile(XSTREAM, queueFile).read();
K
kohsuke 已提交
287 288 289
                    int maxId = 0;
                    for (Object o : list) {
                        if (o instanceof Task) {
290
                            // backward compatibility
291
                            schedule((Task)o, 0);
K
kohsuke 已提交
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
                        } else if (o instanceof Item) {
                            Item item = (Item)o;
                            if(item.task==null)
                                continue;   // botched persistence. throw this one away

                            maxId = Math.max(maxId, item.id);
                            if (item instanceof WaitingItem) {
                                waitingList.add((WaitingItem) item);
                            } else if (item instanceof BlockedItem) {
                                blockedProjects.put(item.task, (BlockedItem) item);
                            } else if (item instanceof BuildableItem) {
                                buildables.add((BuildableItem) item);
                            } else {
                                throw new IllegalStateException("Unknown item type! " + item);
                            }
                        } // this conveniently ignores null
K
TAB->WS  
kohsuke 已提交
308
                    }
K
kohsuke 已提交
309
                    WaitingItem.COUNTER.set(maxId);
310 311 312 313 314 315 316 317 318

                    // I just had an incident where all the executors are dead at AbstractProject._getRuns()
                    // because runs is null. Debugger revealed that this is caused by a MatrixConfiguration
                    // object that doesn't appear to be de-serialized properly.
                    // I don't know how this problem happened, but to diagnose this problem better
                    // when it happens again, save the old queue file for introspection.
                    File bk = new File(queueFile.getPath() + ".bak");
                    bk.delete();
                    queueFile.renameTo(bk);
K
TAB->WS  
kohsuke 已提交
319 320 321
                    queueFile.delete();
                }
            }
322
        } catch (IOException e) {
323
            LOGGER.log(Level.WARNING, "Failed to load the queue file " + getXMLQueueFile(), e);
K
kohsuke 已提交
324 325 326 327 328 329 330
        }
    }

    /**
     * Persists the queue contents to the disk.
     */
    public synchronized void save() {
331 332
        if(BulkChange.contains(this))  return;
        
K
kohsuke 已提交
333
        // write out the tasks on the queue
334
    	ArrayList<Queue.Item> items = new ArrayList<Queue.Item>();
K
kohsuke 已提交
335
    	for (Item item: getItems()) {
K
kohsuke 已提交
336
            if(item.task instanceof TransientTask)  continue;
337
    	    items.add(item);
K
kohsuke 已提交
338
    	}
K
kohsuke 已提交
339

K
kohsuke 已提交
340
        try {
341 342 343
            XmlFile queueFile = new XmlFile(XSTREAM, getXMLQueueFile());
            queueFile.write(items);
            SaveableListener.fireOnChange(this, queueFile);
344
        } catch (IOException e) {
345
            LOGGER.log(Level.WARNING, "Failed to write out the queue file " + getXMLQueueFile(), e);
K
kohsuke 已提交
346 347 348
        }
    }

349 350 351
    /**
     * Wipes out all the items currently in the queue, as if all of them are cancelled at once.
     */
352
    @CLIMethod(name="clear-queue")
353
    public synchronized void clear() {
354
        Hudson.getInstance().checkPermission(Hudson.ADMINISTER);
355 356
        for (WaitingItem i : waitingList)
            i.onCancelled();
357
        waitingList.clear();
358 359
        blockedProjects.cancelAll();
        buildables.cancelAll();
360 361 362
        scheduleMaintenance();
    }

K
kohsuke 已提交
363
    private File getQueueFile() {
K
TAB->WS  
kohsuke 已提交
364 365
        return new File(Hudson.getInstance().getRootDir(), "queue.txt");
    }
K
kohsuke 已提交
366

367
    /*package*/ File getXMLQueueFile() {
K
TAB->WS  
kohsuke 已提交
368 369
        return new File(Hudson.getInstance().getRootDir(), "queue.xml");
    }
K
kohsuke 已提交
370

371 372 373 374 375 376 377 378
    /**
     * @deprecated as of 1.311
     *      Use {@link #schedule(AbstractProject)}
     */
    public boolean add(AbstractProject p) {
        return schedule(p)!=null;
    }

K
kohsuke 已提交
379 380
    /**
     * Schedule a new build for this project.
381
     *
382 383 384
     * @return true if the project is actually added to the queue.
     *         false if the queue contained it and therefore the add()
     *         was noop
K
kohsuke 已提交
385
     */
386 387
    public WaitingItem schedule(AbstractProject p) {
        return schedule(p, p.getQuietPeriod());
388 389 390 391
    }

    /**
     * Schedules a new build with a custom quiet period.
392 393
     *
     * <p>
K
kohsuke 已提交
394 395
     * Left for backward compatibility with &lt;1.114.
     *
396
     * @since 1.105
397 398
     * @deprecated as of 1.311
     *      Use {@link #schedule(Task, int)}
399
     */
400 401
    public boolean add(AbstractProject p, int quietPeriod) {
        return schedule(p, quietPeriod)!=null;
K
kohsuke 已提交
402
    }
403 404 405 406

    /**
     * Schedules an execution of a task.
     *
407
     * @param actions
K
kohsuke 已提交
408 409 410
     *      These actions can be used for associating information scoped to a particular build, to
     *      the task being queued. Upon the start of the build, these {@link Action}s will be automatically
     *      added to the {@link Run} object, and hence avaialable to everyone.
411
     *      For the convenience of the caller, this list can contain null, and those will be silently ignored.
412 413 414 415 416 417 418 419 420 421
     * @since 1.311
     * @return
     *      null if this task is already in the queue and therefore the add operation was no-op.
     *      Otherwise indicates the {@link WaitingItem} object added, although the nature of the queue
     *      is that such {@link Item} only captures the state of the item at a particular moment,
     *      and by the time you inspect the object, some of its information can be already stale.
     *
     *      That said, one can still look at {@link WaitingItem#future}, {@link WaitingItem#id}, etc.
     */
    public synchronized WaitingItem schedule(Task p, int quietPeriod, List<Action> actions) {
422 423 424 425 426 427 428
        // remove nulls
        actions = new ArrayList<Action>(actions);
        for (Iterator<Action> itr = actions.iterator(); itr.hasNext();) {
            Action a =  itr.next();
            if (a==null)    itr.remove();
        }

K
kohsuke 已提交
429 430 431 432 433
    	for(QueueDecisionHandler h : QueueDecisionHandler.all())
    		if (!h.shouldSchedule(p, actions))
                return null;    // veto

        return scheduleInternal(p, quietPeriod, actions);
434
    }
435

436 437 438 439 440 441 442 443 444 445 446 447 448
    /**
     * Schedules an execution of a task.
     *
     * @since 1.311
     * @return
     *      null if this task is already in the queue and therefore the add operation was no-op.
     *      Otherwise indicates the {@link WaitingItem} object added, although the nature of the queue
     *      is that such {@link Item} only captures the state of the item at a particular moment,
     *      and by the time you inspect the object, some of its information can be already stale.
     *
     *      That said, one can still look at {@link WaitingItem#future}, {@link WaitingItem#id}, etc.
     */
    private synchronized WaitingItem scheduleInternal(Task p, int quietPeriod, List<Action> actions) {
K
kohsuke 已提交
449
        Calendar due = new GregorianCalendar();
450
    	due.add(Calendar.SECOND, quietPeriod);
451

452
        // Do we already have this task in the queue? Because if so, we won't schedule a new one.
453
    	List<Item> duplicatesInQueue = new ArrayList<Item>();
K
kohsuke 已提交
454
    	for(Item item : getItems(p)) {
455
    		boolean shouldScheduleItem = false;
K
kohsuke 已提交
456 457
    		for (QueueAction action: item.getActions(QueueAction.class)) {
                shouldScheduleItem |= action.shouldSchedule(actions);
458
    		}
K
kohsuke 已提交
459 460
    		for (QueueAction action: Util.filter(actions,QueueAction.class)) {
                shouldScheduleItem |= action.shouldSchedule(item.getActions());
461 462 463 464 465
    		}
    		if(!shouldScheduleItem) {
    			duplicatesInQueue.add(item);
    		}
    	}
466
    	if (duplicatesInQueue.isEmpty()) {
467
    		LOGGER.fine(p.getFullDisplayName() + " added to queue");
468

469
    		// put the item in the queue
K
kohsuke 已提交
470 471 472 473 474
            WaitingItem added = new WaitingItem(due,p,actions);
    		waitingList.add(added);
            scheduleMaintenance();   // let an executor know that a new item is in the queue.
            return added;
    	}
K
kohsuke 已提交
475

K
kohsuke 已提交
476
        LOGGER.fine(p.getFullDisplayName() + " is already in the queue");
477

K
kohsuke 已提交
478 479 480
        // but let the actions affect the existing stuff.
        for(Item item : duplicatesInQueue) {
            for(FoldableAction a : Util.filter(actions,FoldableAction.class)) {
481
                a.foldIntoExisting(item, p, actions);
K
kohsuke 已提交
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
            }
        }

        boolean queueUpdated = false;
        for(WaitingItem wi : Util.filter(duplicatesInQueue,WaitingItem.class)) {
            if(quietPeriod<=0) {
                // the user really wants to build now, and they mean NOW.
                // so let's pull in the timestamp if we can.
                if (wi.timestamp.before(due))
                    continue;
            } else {
                // otherwise we do the normal quiet period implementation
                if (wi.timestamp.after(due))
                    continue;
                // quiet period timer reset. start the period over again
            }

            // waitingList is sorted, so when we change a timestamp we need to maintain order
            waitingList.remove(wi);
            wi.timestamp = due;
            waitingList.add(wi);
            queueUpdated=true;
        }

        if (queueUpdated)   scheduleMaintenance();
        return null;
K
kohsuke 已提交
508
    }
509
    
510 511 512 513
    /**
     * @deprecated as of 1.311
     *      Use {@link #schedule(Task, int)} 
     */
514
    public synchronized boolean add(Task p, int quietPeriod) {
515
    	return schedule(p, quietPeriod)!=null;
516 517
    }

518 519 520 521 522 523
    public synchronized WaitingItem schedule(Task p, int quietPeriod) {
    	return schedule(p, quietPeriod, new Action[0]);
    }

    /**
     * @deprecated as of 1.311
524
     *      Use {@link #schedule(Task, int, Action...)} 
525
     */
526
    public synchronized boolean add(Task p, int quietPeriod, Action... actions) {
527 528 529
    	return schedule(p, quietPeriod, actions)!=null;
    }

530
    /**
K
kohsuke 已提交
531
     * Convenience wrapper method around {@link #schedule(Task, int, List)}
532
     */
533 534
    public synchronized WaitingItem schedule(Task p, int quietPeriod, Action... actions) {
    	return schedule(p, quietPeriod, Arrays.asList(actions));
535
    }
K
kohsuke 已提交
536

K
kohsuke 已提交
537
    /**
538
     * Cancels the item in the queue. If the item is scheduled more than once, cancels the first occurrence.
K
kohsuke 已提交
539
     *
540 541
     * @return true if the project was indeed in the queue and was removed.
     *         false if this was no-op.
K
kohsuke 已提交
542
     */
K
kohsuke 已提交
543
    public synchronized boolean cancel(Task p) {
K
kohsuke 已提交
544
        LOGGER.fine("Cancelling " + p.getFullDisplayName());
K
kohsuke 已提交
545 546
        for (Iterator<WaitingItem> itr = waitingList.iterator(); itr.hasNext();) {
            Item item = itr.next();
K
kohsuke 已提交
547
            if (item.task.equals(p)) {
K
kohsuke 已提交
548
                itr.remove();
549
                item.onCancelled();
K
kohsuke 已提交
550
                return true;
K
kohsuke 已提交
551 552
            }
        }
K
kohsuke 已提交
553
        // use bitwise-OR to make sure that both branches get evaluated all the time
554
        return blockedProjects.cancel(p)!=null | buildables.cancel(p)!=null;
K
kohsuke 已提交
555
    }
556 557 558
    
    public synchronized boolean cancel(Item item) {
        LOGGER.fine("Cancelling " + item.task.getFullDisplayName() + " item#" + item.id);
559 560 561 562 563
        // use bitwise-OR to make sure that all the branches get evaluated all the time
        boolean r = (item instanceof WaitingItem && waitingList.remove(item)) | blockedProjects.remove(item) | buildables.remove(item);
        if(r)
            item.onCancelled();
        return r;
564
    }
K
kohsuke 已提交
565 566

    public synchronized boolean isEmpty() {
567
        return waitingList.isEmpty() && blockedProjects.isEmpty() && buildables.isEmpty() && pendings.isEmpty();
K
kohsuke 已提交
568 569
    }

570
    private synchronized WaitingItem peek() {
571
        return waitingList.iterator().next();
K
kohsuke 已提交
572 573 574 575
    }

    /**
     * Gets a snapshot of items in the queue.
576 577 578
     *
     * Generally speaking the array is sorted such that the items that are most likely built sooner are
     * at the end.
K
kohsuke 已提交
579
     */
580
    @Exported(inline=true)
K
kohsuke 已提交
581
    public synchronized Item[] getItems() {
582
        Item[] r = new Item[waitingList.size() + blockedProjects.size() + buildables.size() + pendings.size()];
583 584
        waitingList.toArray(r);
        int idx = waitingList.size();
585 586
        for (BlockedItem p : blockedProjects.values())
            r[idx++] = p;
587
        for (BuildableItem p : reverse(buildables.values()))
588
            r[idx++] = p;
589 590
        for (BuildableItem p : reverse(pendings.values()))
            r[idx++] = p;
K
kohsuke 已提交
591 592
        return r;
    }
593 594 595 596 597
    
    public synchronized Item getItem(int id) {
    	for (Item item: waitingList) if (item.id == id) return item;
    	for (Item item: blockedProjects) if (item.id == id) return item;
    	for (Item item: buildables) if (item.id == id) return item;
598
        for (Item item: pendings) if (item.id == id) return item;
599 600
    	return null;
    }
K
kohsuke 已提交
601

K
kohsuke 已提交
602 603 604
    /**
     * Gets all the {@link BuildableItem}s that are waiting for an executor in the given {@link Computer}.
     */
605 606
    public synchronized List<BuildableItem> getBuildableItems(Computer c) {
        List<BuildableItem> result = new ArrayList<BuildableItem>();
607 608 609 610 611 612
        _getBuildableItems(c, buildables, result);
        _getBuildableItems(c, pendings, result);
        return result;
    }

    private void _getBuildableItems(Computer c, ItemList<BuildableItem> col, List<BuildableItem> result) {
613
        Node node = c.getNode();
614
        for (BuildableItem p : col.values()) {
615 616
            if (node.canTake(p.task) == null)
                result.add(p);
617 618 619
        }
    }

K
kohsuke 已提交
620
    /**
621
     * Gets the snapshot of all {@link BuildableItem}s.
K
kohsuke 已提交
622 623
     */
    public synchronized List<BuildableItem> getBuildableItems() {
624 625 626
        ArrayList<BuildableItem> r = new ArrayList<BuildableItem>(buildables.values());
        r.addAll(pendings.values());
        return r;
K
kohsuke 已提交
627 628
    }

629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
    /**
     * Gets the snapshot of all {@link BuildableItem}s.
     */
    public synchronized List<BuildableItem> getPendingItems() {
        return new ArrayList<BuildableItem>(pendings.values());
    }

    /**
     * Is the given task currently pending execution?
     */
    public synchronized boolean isPending(Task t) {
        for (BuildableItem i : pendings)
            if (i.task.equals(t))
                return true;
        return false;
    }

K
kohsuke 已提交
646 647 648 649 650 651 652 653
    /**
     * How many {@link BuildableItem}s are assigned for the given label?
     */
    public synchronized int countBuildableItemsFor(Label l) {
        int r = 0;
        for (BuildableItem bi : buildables.values())
            if(bi.task.getAssignedLabel()==l)
                r++;
654 655 656
        for (BuildableItem bi : pendings.values())
            if(bi.task.getAssignedLabel()==l)
                r++;
K
kohsuke 已提交
657 658 659
        return r;
    }

K
kohsuke 已提交
660 661 662 663 664
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
     */
665 666
    public synchronized Item getItem(Task t) {
        BlockedItem bp = blockedProjects.get(t);
667
        if (bp!=null)
668 669
            return bp;
        BuildableItem bi = buildables.get(t);
670 671 672
        if(bi!=null)
            return bi;
        bi = pendings.get(t);
673
        if(bi!=null)
674 675
            return bi;

676
        for (Item item : waitingList) {
677
            if (item.task == t)
K
kohsuke 已提交
678 679 680 681 682
                return item;
        }
        return null;
    }

683 684 685 686 687 688 689 690 691
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
     */
    public synchronized List<Item> getItems(Task t) {
    	List<Item> result =new ArrayList<Item>();
    	result.addAll(blockedProjects.getAll(t));
    	result.addAll(buildables.getAll(t));
692
        result.addAll(pendings.getAll(t));
693 694 695 696 697 698 699
        for (Item item : waitingList) {
            if (item.task == t)
                result.add(item);
        }
        return result;
    }

700 701
    /**
     * Left for backward compatibility.
702
     *
703 704
     * @see #getItem(Task)
    public synchronized Item getItem(AbstractProject p) {
705
        return getItem((Task) p);
706
    }
K
kohsuke 已提交
707
     */
708

K
kohsuke 已提交
709
    /**
K
kohsuke 已提交
710
     * Returns true if this queue contains the said project.
K
kohsuke 已提交
711
     */
712
    public synchronized boolean contains(Task t) {
713
        if (blockedProjects.containsKey(t) || buildables.containsKey(t) || pendings.containsKey(t))
K
kohsuke 已提交
714
            return true;
715
        for (Item item : waitingList) {
716
            if (item.task == t)
K
kohsuke 已提交
717 718 719 720 721 722 723
                return true;
        }
        return false;
    }

    /**
     * Called by the executor to fetch something to build next.
724
     * <p>
K
kohsuke 已提交
725 726
     * This method blocks until a next project becomes buildable.
     */
727
    public synchronized WorkUnit pop() throws InterruptedException {
K
kohsuke 已提交
728
        final Executor exec = Executor.currentExecutor();
729

K
kohsuke 已提交
730
        try {
731
            while (true) {
K
kohsuke 已提交
732 733 734
                final JobOffer offer = new JobOffer(exec);
                long sleep = -1;

735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
                // consider myself parked
                assert !parked.containsKey(exec);
                parked.put(exec, offer);

                // reuse executor thread to do a queue maintenance.
                // at the end of this we get all the buildable jobs
                // in the buildables field.
                maintain();

                // allocate buildable jobs to executors
                Iterator<BuildableItem> itr = buildables.iterator();
                while (itr.hasNext()) {
                    BuildableItem p = itr.next();

                    // one last check to make sure this build is not blocked.
                    if (isBuildBlocked(p.task)) {
K
kohsuke 已提交
751
                        itr.remove();
752 753
                        blockedProjects.put(p.task,new BlockedItem(p));
                        continue;
K
kohsuke 已提交
754 755
                    }

756 757 758 759 760
                    List<JobOffer> candidates = new ArrayList<JobOffer>(parked.size());
                    for (JobOffer j : parked.values())
                        if(j.canTake(p.task))
                            candidates.add(j);

K
kohsuke 已提交
761 762
                    MappingWorksheet ws = new MappingWorksheet(p, candidates);
                    Mapping m = loadBalancer.map(p.task, ws);
763
                    if (m == null)
764 765 766 767
                        // if we couldn't find the executor that fits,
                        // just leave it in the buildables list and
                        // check if we can execute other projects
                        continue;
K
kohsuke 已提交
768

769
                    // found a matching executor. use it.
770 771
                    WorkUnitContext wuc = new WorkUnitContext(p);
                    m.execute(wuc);
772

773
                    itr.remove();
774 775
                    if (!wuc.getWorkUnits().isEmpty())
                        pendings.add(p);
776 777 778 779 780 781 782 783 784 785 786
                }

                // we went over all the buildable projects and awaken
                // all the executors that got work to do. now, go to sleep
                // until this thread is awakened. If this executor assigned a job to
                // itself above, the block method will return immediately.

                if (!waitingList.isEmpty()) {
                    // wait until the first item in the queue is due
                    sleep = peek().timestamp.getTimeInMillis() - new GregorianCalendar().getTimeInMillis();
                    if (sleep < 100) sleep = 100;    // avoid wait(0)
K
kohsuke 已提交
787 788
                }

789
                if (sleep == -1)
K
kohsuke 已提交
790 791 792 793
                    offer.event.block();
                else
                    offer.event.block(sleep);

794 795 796 797 798
                // retract the offer object
                assert parked.get(exec) == offer;
                parked.remove(exec);

                // am I woken up because I have a project to build?
799
                if (offer.workUnit != null) {
800
                    // if so, just build it
801 802 803 804 805
                    LOGGER.fine("Pop returning " + offer.workUnit + " for " + exec.getName());

                    // TODO: I think this has to be done by the last executor that leaves the pop(), not by main executor
                    if (offer.workUnit.isMainWork())
                        pendings.remove(offer.workUnit.context.item);
806

807
                    return offer.workUnit;
K
kohsuke 已提交
808
                }
809
                // otherwise run a queue maintenance
K
kohsuke 已提交
810 811
            }
        } finally {
812 813
            // remove myself from the parked list
            JobOffer offer = parked.remove(exec);
814 815
            if (offer != null && offer.workUnit != null) {
                // we are already assigned a project, but now we can't handle it.
816
                offer.workUnit.context.abort(new AbortException());
K
kohsuke 已提交
817
            }
818 819 820 821 822 823

            // since this executor might have been chosen for
            // maintenance, schedule another one. Worst case
            // we'll just run a pointless maintenance, and that's
            // fine.
            scheduleMaintenance();
K
kohsuke 已提交
824 825 826 827 828
        }
    }

    /**
     * Checks the queue and runs anything that can be run.
829 830
     *
     * <p>
K
kohsuke 已提交
831
     * When conditions are changed, this method should be invoked.
832
     * <p>
K
kohsuke 已提交
833 834 835 836 837 838 839
     * This wakes up one {@link Executor} so that it will maintain a queue.
     */
    public synchronized void scheduleMaintenance() {
        // this code assumes that after this method is called
        // no more executors will be offered job except by
        // the pop() code.
        for (Entry<Executor, JobOffer> av : parked.entrySet()) {
840
            if (av.getValue().workUnit == null) {
K
kohsuke 已提交
841 842 843 844 845 846
                av.getValue().event.signal();
                return;
            }
        }
    }

847 848 849
    /**
     * Checks if the given task is blocked.
     */
850
    private boolean isBuildBlocked(Task t) {
851 852 853
        return t.isBuildBlocked() || !canRun(t.getResourceList());
    }

854
    /**
855 856
     * Make sure we don't queue two tasks of the same project to be built
     * unless that project allows concurrent builds.
857
     */
858 859 860 861 862 863 864
    private boolean allowNewBuildableTask(Task t) {
        try {
            if (t.isConcurrentBuild())
                return true;
        } catch (AbstractMethodError e) {
            // earlier versions don't have the "isConcurrentBuild" method, so fall back gracefully
        }
865
        return !buildables.containsKey(t) && !pendings.containsKey(t);
866
    }
867

K
kohsuke 已提交
868
    /**
K
kohsuke 已提交
869
     * Queue maintenance.
870
     * <p>
871
     * Move projects between {@link #waitingList}, {@link #blockedProjects}, and {@link #buildables}
K
kohsuke 已提交
872 873
     * appropriately.
     */
874
    public synchronized void maintain() {
875 876
        if (LOGGER.isLoggable(Level.FINE))
            LOGGER.fine("Queue maintenance started " + this);
877

878
        // blocked -> buildable
879
        Iterator<BlockedItem> itr = blockedProjects.values().iterator();
880
        while (itr.hasNext()) {
881
            BlockedItem p = itr.next();
882
            if (!isBuildBlocked(p.task) && allowNewBuildableTask(p.task)) {
K
kohsuke 已提交
883
                // ready to be executed
884
                if (makeBuildable(new BuildableItem(p))) {
K
kohsuke 已提交
885
                LOGGER.fine(p.task.getFullDisplayName() + " no longer blocked");
K
kohsuke 已提交
886
                itr.remove();
887
                }
K
kohsuke 已提交
888 889 890
            }
        }

891
        while (!waitingList.isEmpty()) {
892
            WaitingItem top = peek();
K
kohsuke 已提交
893

894
            if (!top.timestamp.before(new GregorianCalendar()))
K
kohsuke 已提交
895 896
                return; // finished moving all ready items from queue

897
            waitingList.remove(top);
898
            Task p = top.task;
899
            boolean isReady = false;
900
            if (!isBuildBlocked(p) && allowNewBuildableTask(p)) {
901 902 903 904
                // maybe ready to be executed immediately
                isReady = makeBuildable(new BuildableItem(top));
            }
            if (isReady) {
K
kohsuke 已提交
905
                LOGGER.fine(p.getFullDisplayName() + " ready to build");
K
kohsuke 已提交
906
            } else {
907
                // this can't be built now because another build is in progress
K
kohsuke 已提交
908
                // set this project aside.
K
kohsuke 已提交
909
                LOGGER.fine(p.getFullDisplayName() + " is blocked");
910
                blockedProjects.put(p,new BlockedItem(top));
K
kohsuke 已提交
911 912
            }
        }
913 914 915 916

        final QueueSorter s = sorter;
        if (s != null)
        	s.sortBuildableItems(buildables);
K
kohsuke 已提交
917 918
    }

919
    private boolean makeBuildable(BuildableItem p) {
920
        if(Hudson.FLYWEIGHT_SUPPORT && p.task instanceof FlyweightTask && !ifBlockedByHudsonShutdown(p.task)) {
921 922 923 924 925 926 927 928 929
            ConsistentHash<Node> hash = new ConsistentHash<Node>(new Hash<Node>() {
                public String hash(Node node) {
                    return node.getNodeName();
                }
            });
            Hudson h = Hudson.getInstance();
            hash.add(h, h.getNumExecutors()*100);
            for (Node n : h.getNodes())
                hash.add(n,n.getNumExecutors()*100);
930 931

            Label lbl = p.task.getAssignedLabel();
932 933
            for (Node n : hash.list(p.task.getFullDisplayName())) {
                Computer c = n.toComputer();
K
kohsuke 已提交
934
                if (c==null || c.isOffline())    continue;
935
                if (lbl!=null && !lbl.contains(n))  continue;
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955

                // Prevent multiple instances of a project's FlyWeightTask
                // from all executing on the same computer at the same time.
                // Without this logic, queuing-up several builds for a
                // parameterized matrix project didn't work:  parent builds
                // weren't waiting their turn in the queue.

                List<OneOffExecutor> oneOffExecutors = c.getOneOffExecutors();
                for (OneOffExecutor ooe : oneOffExecutors) {
                    Queue.Executable exe = ooe.getCurrentExecutable();
                    if (exe == null)
                        return false;
                    if (exe instanceof AbstractBuild) {
                        AbstractBuild b = (AbstractBuild) exe;
                        String running = b.getProject().getName();
                        String toRun = p.task.getName();
                        if (toRun.equals(running))
                            return false;
                    }
                }
956
                c.startFlyWeightTask(new WorkUnitContext(p).createWorkUnit(p.task));
957
                return true;
958 959 960 961 962 963
            }
            // if the execution get here, it means we couldn't schedule it anywhere.
            // so do the scheduling like other normal jobs.
        }
        
        buildables.put(p.task,p);
964
        return true;
965 966
    }

967 968 969 970
    public static boolean ifBlockedByHudsonShutdown(Task task) {
        return Hudson.getInstance().isQuietingDown() && !(task instanceof NonBlockingTask);
    }

971 972 973 974
    public Api getApi() {
        return new Api(this);
    }

K
kohsuke 已提交
975 976 977 978 979 980
    /**
     * Marks {@link Task}s that are not persisted.
     * @since 1.311
     */
    public interface TransientTask extends Task {}

981 982 983 984 985 986 987
    /**
     * Marks {@link Task}s that do not consume {@link Executor}.
     * @see OneOffExecutor
     * @since 1.318
     */
    public interface FlyweightTask extends Task {}

K
kohsuke 已提交
988
    /**
989
     * Marks {@link Task}s that are not affected by the {@linkplain Hudson#isQuietingDown()}  quieting down},
K
kohsuke 已提交
990 991 992 993 994 995
     * because these tasks keep other tasks executing.
     *
     * @since 1.336 
     */
    public interface NonBlockingTask extends Task {}

K
kohsuke 已提交
996 997
    /**
     * Task whose execution is controlled by the queue.
998
     *
999
     * <p>
K
kohsuke 已提交
1000 1001 1002
     * {@link #equals(Object) Value equality} of {@link Task}s is used
     * to collapse two tasks into one. This is used to avoid infinite
     * queue backlog.
1003 1004 1005
     *
     * <p>
     * Pending {@link Task}s are persisted when Hudson shuts down, so
K
kohsuke 已提交
1006 1007
     * it needs to be persistable via XStream. To create a non-persisted
     * transient Task, extend {@link TransientTask} marker interface.
1008 1009 1010 1011 1012
     *
     * <p>
     * Plugins are encouraged to extend from {@link AbstractQueueTask}
     * instead of implementing this interface directly, to maintain
     * compatibility with future changes to this interface.
1013 1014 1015 1016 1017 1018
     *
     * <p>
     * For historical reasons, {@link Task} object by itself
     * also represents the "primary" sub-task (and as implied by this
     * design, a {@link Task} must have at least one sub-task.)
     * Most of the time, the primary subtask is the only sub task.
K
kohsuke 已提交
1019
     */
1020
    public interface Task extends ModelObject, SubTask {
1021 1022 1023
        /**
         * Returns true if the execution should be blocked
         * for temporary reasons.
1024 1025
         *
         * <p>
1026
         * Short-hand for {@code getCauseOfBlockage()!=null}.
1027 1028 1029 1030
         */
        boolean isBuildBlocked();

        /**
1031 1032
         * @deprecated as of 1.330
         *      Use {@link CauseOfBlockage#getShortDescription()} instead.
1033 1034 1035
         */
        String getWhyBlocked();

1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
        /**
         * If the execution of this task should be blocked for temporary reasons,
         * this method returns a non-null object explaining why.
         *
         * <p>
         * Otherwise this method returns null, indicating that the build can proceed right away.
         *
         * <p>
         * This can be used to define mutual exclusion that goes beyond
         * {@link #getResourceList()}.
         */
        CauseOfBlockage getCauseOfBlockage();

1049
        /**
K
kohsuke 已提交
1050
         * Unique name of this task.
K
kohsuke 已提交
1051
         *
K
kohsuke 已提交
1052 1053
         * <p>
         * This method is no longer used, left here for compatibility. Just return {@link #getDisplayName()}.
1054 1055 1056
         */
        String getName();

1057 1058 1059 1060 1061
        /**
         * @see hudson.model.Item#getFullDisplayName()
         */
        String getFullDisplayName();

1062 1063 1064 1065 1066 1067 1068
        /**
         * Checks the permission to see if the current user can abort this executable.
         * Returns normally from this method if it's OK.
         *
         * @throws AccessDeniedException if the permission is not granted.
         */
        void checkAbortPermission();
K
kohsuke 已提交
1069 1070 1071 1072 1073 1074

        /**
         * Works just like {@link #checkAbortPermission()} except it indicates the status by a return value,
         * instead of exception.
         */
        boolean hasAbortPermission();
1075 1076
        
        /**
K
kohsuke 已提交
1077 1078 1079 1080 1081 1082 1083 1084
         * Returns the URL of this task relative to the context root of the application.
         *
         * <p>
         * When the user clicks an item in the queue, this is the page where the user is taken to.
         * Hudson expects the current instance to be bound to the URL returned by this method.
         *
         * @return
         *      URL that ends with '/'.
1085 1086
         */
        String getUrl();
1087 1088 1089
        
        /**
         * True if the task allows concurrent builds
1090 1091
         *
         * @since 1.338
1092 1093
         */
        boolean isConcurrentBuild();
1094

1095
        /**
1096
         * Obtains the {@link SubTask}s that constitute this task.
1097
         *
1098
         * <p>
1099 1100 1101
         * The collection returned by this method must also contain the primary {@link SubTask}
         * represented by this {@link Task} object itself as the first element.
         * The returned value is read-only.
1102
         *
1103
         * <p>
1104
         * At least size 1.
1105
         *
1106 1107 1108 1109
         * <p>
         * Since this is a newly added method, the invocation may results in {@link AbstractMethodError}.
         * Use {@link Tasks#getSubTasksOf(Task)} that avoids this.
         *
M
mindless 已提交
1110
         * @since 1.377
1111
         */
1112
        Collection<? extends SubTask> getSubTasks();
1113 1114
    }

1115
    /**
M
mindless 已提交
1116
     * Represents the real meat of the computation run by {@link Executor}.
1117 1118 1119 1120 1121
     *
     * <h2>Views</h2>
     * <p>
     * Implementation must have <tt>executorCell.jelly</tt>, which is
     * used to render the HTML that indicates this executable is executing.
1122
     */
1123 1124 1125
    public interface Executable extends Runnable {
        /**
         * Task from which this executable was created.
K
kohsuke 已提交
1126
         * Never null.
1127 1128
         *
         * <p>
M
mindless 已提交
1129
         * Since this method went through a signature change in 1.377, the invocation may results in
1130 1131
         * {@link AbstractMethodError}.
         * Use {@link Executables#getParentOf(Executable)} that avoids this.
1132
         */
1133
        SubTask getParent();
1134 1135 1136 1137 1138

        /**
         * Called by {@link Executor} to perform the task
         */
        void run();
1139 1140 1141 1142
        
        /**
         * Estimate of how long will it take to execute this executable.
         * Measured in milliseconds.
1143
         * 
1144
         * Please, consider using {@link Executables#getEstimatedDurationFor(Executable)}
1145
         * to protected against AbstractMethodErrors!
1146 1147 1148 1149 1150
         *
         * @return -1 if it's impossible to estimate.
         * @since 1.383
         */
        long getEstimatedDuration();
1151 1152 1153 1154

        /**
         * Used to render the HTML. Should be a human readable text of what this executable is.
         */
1155
        @Override String toString();
1156 1157
    }

K
kohsuke 已提交
1158 1159 1160
    /**
     * Item in a queue.
     */
1161
    @ExportedBean(defaultVisibility = 999)
1162
    public static abstract class Item extends Actionable {
1163 1164 1165 1166
        /**
         * VM-wide unique ID that tracks the {@link Task} as it moves through different stages
         * in the queue (each represented by different subtypes of {@link Item}.
         */
1167 1168 1169
    	public final int id;
    	
		/**
K
kohsuke 已提交
1170 1171
         * Project to be built.
         */
1172
        @Exported
1173
        public final Task task;
1174

1175
        private /*almost final*/ transient FutureImpl future;
1176

1177
        /**
1178 1179 1180
         * Build is blocked because another build is in progress,
         * required {@link Resource}s are not available, or otherwise blocked
         * by {@link Task#isBuildBlocked()}.
1181
         */
K
kohsuke 已提交
1182
        @Exported
1183
        public boolean isBlocked() { return this instanceof BlockedItem; }
1184 1185 1186 1187 1188 1189

        /**
         * Build is waiting the executor to become available.
         * This flag is only used in {@link Queue#getItems()} for
         * 'pseudo' items that are actually not really in the queue.
         */
K
kohsuke 已提交
1190
        @Exported
1191
        public boolean isBuildable() { return this instanceof BuildableItem; }
1192

1193 1194 1195 1196 1197 1198
        /**
         * True if the item is starving for an executor for too long.
         */
        @Exported
        public boolean isStuck() { return false; }

1199 1200 1201 1202 1203 1204 1205
        /**
         * Can be used to wait for the completion (either normal, abnormal, or cancellation) of the {@link Task}.
         * <p>
         * Just like {@link #id}, the same object tracks various stages of the queue.
         */
        public Future<Executable> getFuture() { return future; }

1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
        /**
         * Convenience method that returns a read only view of the {@link Cause}s associated with this item in the queue.
         *
         * @return can be empty but never null
         * @since 1.343
         */
        public final List<Cause> getCauses() {
            CauseAction ca = getAction(CauseAction.class);
            if (ca!=null)
                return Collections.unmodifiableList(ca.getCauses());
            return Collections.emptyList();
        }

1219
        protected Item(Task task, List<Action> actions, int id, FutureImpl future) {
1220 1221
            this.task = task;
            this.id = id;
1222
            this.future = future;
1223 1224 1225 1226
            for (Action action: actions) addAction(action);
        }
        
        protected Item(Item item) {
1227
        	this(item.task, item.getActions(), item.id, item.future);
K
kohsuke 已提交
1228 1229
        }

1230
        /**
1231
         * Gets a human-readable status message describing why it's in the queue.
1232
         */
K
kohsuke 已提交
1233
        @Exported
1234 1235 1236 1237 1238
        public final String getWhy() {
            CauseOfBlockage cob = getCauseOfBlockage();
            return cob!=null ? cob.getShortDescription() : null;
        }

K
kohsuke 已提交
1239 1240 1241
        /**
         * Gets an object that describes why this item is in the queue.
         */
1242 1243
        public abstract CauseOfBlockage getCauseOfBlockage();

1244 1245 1246 1247 1248 1249
        /**
         * Gets a human-readable message about the parameters of this item
         * @return String
         */
        @Exported
        public String getParams() {
K
kohsuke 已提交
1250
        	StringBuilder s = new StringBuilder();
1251 1252 1253 1254
        	for(Action action : getActions()) {
        		if(action instanceof ParametersAction) {
        			ParametersAction pa = (ParametersAction)action;
        			for (ParameterValue p : pa.getParameters()) {
K
kohsuke 已提交
1255
        				s.append('\n').append(p.getShortDescription());
1256 1257 1258
        			}
        		}
        	}
K
kohsuke 已提交
1259
        	return s.toString();
1260 1261
        }
        
1262 1263 1264
        public boolean hasCancelPermission() {
            return task.hasAbortPermission();
        }
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
        
        public String getDisplayName() {
			// TODO Auto-generated method stub
			return null;
		}

		public String getSearchUrl() {
			// TODO Auto-generated method stub
			return null;
		}

        /**
         * Called from queue.jelly.
         */
1279
        public HttpResponse doCancelQueue() throws IOException, ServletException {
1280
        	Hudson.getInstance().getQueue().cancel(this);
1281
            return HttpResponses.forwardToPreviousPage();
1282
        }
1283 1284 1285 1286 1287 1288 1289 1290 1291

        /**
         * Participates in the cancellation logic to set the {@link #future} accordingly.
         */
        /*package*/ void onCancelled() {
            future.setAsCancelled();
        }

        private Object readResolve() {
1292
            this.future = new FutureImpl(task);
1293 1294
            return this;
        }
K
kohsuke 已提交
1295 1296 1297 1298 1299

        @Override
        public String toString() {
            return getClass().getName()+':'+task.toString();
        }
1300 1301 1302 1303 1304
    }
    
    /**
     * An optional interface for actions on Queue.Item.
     * Lets the action cooperate in queue management.
1305 1306
     * 
     * @since 1.300-ish.
1307 1308 1309 1310 1311 1312 1313
     */
    public interface QueueAction extends Action {
    	/**
    	 * Returns whether the new item should be scheduled. 
    	 * An action should return true if the associated task is 'different enough' to warrant a separate execution.
    	 */
    	public boolean shouldSchedule(List<Action> actions);
1314
    }
1315

1316
    /**
K
kohsuke 已提交
1317 1318 1319 1320 1321 1322
     * Extension point for deciding if particular job should be scheduled or not.
     *
     * <p>
     * This handler is consulted every time someone tries to submit a task to the queue.
     * If any of the registered handlers returns false, the task will not be added
     * to the queue, and the task will never get executed. 
1323 1324 1325 1326 1327 1328 1329 1330 1331
     *
     * <p>
     * This extension point is still a subject to change, as we are seeking more
     * comprehensive Queue pluggability. See HUDSON-2072.
     *
     * @since 1.316
     */
    public static abstract class QueueDecisionHandler implements ExtensionPoint {
    	/**
K
kohsuke 已提交
1332
    	 * Returns whether the new item should be scheduled.
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
    	 */
    	public abstract boolean shouldSchedule(Task p, List<Action> actions);
    	    	
    	/**
    	 * All registered {@link QueueDecisionHandler}s
    	 * @return
    	 */
    	public static ExtensionList<QueueDecisionHandler> all() {
    		return Hudson.getInstance().getExtensionList(QueueDecisionHandler.class);
    	}
    }
    
1345 1346 1347
    /**
     * {@link Item} in the {@link Queue#waitingList} stage.
     */
1348 1349 1350
    public static final class WaitingItem extends Item implements Comparable<WaitingItem> {
    	private static final AtomicInteger COUNTER = new AtomicInteger(0);
    	
1351 1352 1353 1354 1355
        /**
         * This item can be run after this time.
         */
        @Exported
        public Calendar timestamp;
1356

1357
        public WaitingItem(Calendar timestamp, Task project, List<Action> actions) {
1358
            super(project, actions, COUNTER.incrementAndGet(), new FutureImpl(project));
1359 1360
            this.timestamp = timestamp;
        }
1361
        
1362 1363 1364 1365 1366 1367 1368
        public int compareTo(WaitingItem that) {
            int r = this.timestamp.getTime().compareTo(that.timestamp.getTime());
            if (r != 0) return r;

            return this.id - that.id;
        }

1369
        public CauseOfBlockage getCauseOfBlockage() {
1370
            long diff = timestamp.getTimeInMillis() - System.currentTimeMillis();
1371
            if (diff > 0)
1372
                return CauseOfBlockage.fromMessage(Messages._Queue_InQuietPeriod(Util.getTimeSpanString(diff)));
1373
            else
1374
                return CauseOfBlockage.fromMessage(Messages._Queue_Unknown());
1375 1376
        }
    }
K
kohsuke 已提交
1377

1378 1379 1380
    /**
     * Common part between {@link BlockedItem} and {@link BuildableItem}.
     */
1381
    public static abstract class NotWaitingItem extends Item {
1382 1383 1384 1385 1386 1387 1388
        /**
         * When did this job exit the {@link Queue#waitingList} phase?
         */
        @Exported
        public final long buildableStartMilliseconds;

        protected NotWaitingItem(WaitingItem wi) {
1389
            super(wi);
1390
            buildableStartMilliseconds = System.currentTimeMillis();
K
kohsuke 已提交
1391
        }
1392

1393
        protected NotWaitingItem(NotWaitingItem ni) {
1394
            super(ni);
1395
            buildableStartMilliseconds = ni.buildableStartMilliseconds;
1396
        }
1397
    }
1398

1399 1400 1401 1402 1403 1404 1405
    /**
     * {@link Item} in the {@link Queue#blockedProjects} stage.
     */
    public final class BlockedItem extends NotWaitingItem {
        public BlockedItem(WaitingItem wi) {
            super(wi);
        }
1406

1407 1408 1409 1410
        public BlockedItem(NotWaitingItem ni) {
            super(ni);
        }

1411
        public CauseOfBlockage getCauseOfBlockage() {
1412 1413 1414
            ResourceActivity r = getBlockingActivity(task);
            if (r != null) {
                if (r == task) // blocked by itself, meaning another build is in progress
1415 1416
                    return CauseOfBlockage.fromMessage(Messages._Queue_InProgress());
                return CauseOfBlockage.fromMessage(Messages._Queue_BlockedBy(r.getDisplayName()));
1417
            }
1418
            return task.getCauseOfBlockage();
1419
        }
1420
    }
1421

1422 1423 1424
    /**
     * {@link Item} in the {@link Queue#buildables} stage.
     */
1425
    public final static class BuildableItem extends NotWaitingItem {
1426 1427 1428 1429 1430 1431 1432 1433
        public BuildableItem(WaitingItem wi) {
            super(wi);
        }

        public BuildableItem(NotWaitingItem ni) {
            super(ni);
        }

1434
        public CauseOfBlockage getCauseOfBlockage() {
1435
            Hudson hudson = Hudson.getInstance();
1436
            if(ifBlockedByHudsonShutdown(task))
1437
                return CauseOfBlockage.fromMessage(Messages._Queue_HudsonIsAboutToShutDown());
K
kohsuke 已提交
1438 1439

            Label label = task.getAssignedLabel();
K
kohsuke 已提交
1440
            if (hudson.getNodes().isEmpty())
1441
                label = null;    // no master/slave. pointless to talk about nodes
1442

1443 1444
            if (label != null) {
                if (label.isOffline()) {
1445
                    Set<Node> nodes = label.getNodes();
1446
                    if (nodes.size() != 1)      return new BecauseLabelIsOffline(label);
1447
                    else                        return new BecauseNodeIsOffline(nodes.iterator().next());
1448 1449 1450
                }
            }

1451
            if(label==null)
1452
                return CauseOfBlockage.fromMessage(Messages._Queue_WaitingForNextAvailableExecutor());
1453 1454

            Set<Node> nodes = label.getNodes();
1455
            if (nodes.size() != 1)      return new BecauseLabelIsBusy(label);
1456
            else                        return new BecauseNodeIsBusy(nodes.iterator().next());
1457
        }
1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468

        @Override
        public boolean isStuck() {
            Label label = task.getAssignedLabel();
            if(label!=null && label.isOffline())
                // no executor online to process this job. definitely stuck.
                return true;

            long d = task.getEstimatedDuration();
            long elapsed = System.currentTimeMillis()-buildableStartMilliseconds;
            if(d>=0) {
1469
                // if we were running elsewhere, we would have done this build ten times.
1470
                return elapsed > Math.max(d,60000L)*10;
1471 1472
            } else {
                // more than a day in the queue
1473
                return TimeUnit2.MILLISECONDS.toHours(elapsed)>24;
1474 1475
            }
        }
K
kohsuke 已提交
1476 1477 1478
    }

    private static final Logger LOGGER = Logger.getLogger(Queue.class.getName());
1479

1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
    /**
     * This {@link XStream} instance is used to persist {@link Task}s.
     */
    public static final XStream XSTREAM = new XStream2();

    static {
        XSTREAM.registerConverter(new AbstractSingleValueConverter() {

			@Override
			@SuppressWarnings("unchecked")
			public boolean canConvert(Class klazz) {
				return hudson.model.Item.class.isAssignableFrom(klazz);
			}

			@Override
			public Object fromString(String string) {
                Object item = Hudson.getInstance().getItemByFullName(string);
                if(item==null)  throw new NoSuchElementException("No such job exists: "+string);
                return item;
			}

			@Override
			public String toString(Object item) {
				return ((hudson.model.Item) item).getFullName();
			}
        });
        XSTREAM.registerConverter(new AbstractSingleValueConverter() {

			@SuppressWarnings("unchecked")
			@Override
			public boolean canConvert(Class klazz) {
				return Run.class.isAssignableFrom(klazz);
			}

			@Override
			public Object fromString(String string) {
				String[] split = string.split("#");
				String projectName = split[0];
				int buildNumber = Integer.parseInt(split[1]);
				Job<?,?> job = (Job<?,?>) Hudson.getInstance().getItemByFullName(projectName);
                if(job==null)  throw new NoSuchElementException("No such job exists: "+projectName);
				Run<?,?> run = job.getBuildByNumber(buildNumber);
K
kohsuke 已提交
1522
                if(run==null)  throw new NoSuchElementException("No such build: "+string);
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
				return run;
			}

			@Override
			public String toString(Object object) {
				Run<?,?> run = (Run<?,?>) object;
				return run.getParent().getFullName() + "#" + run.getNumber();
			}
        });
    }

1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
    /**
     * Regularly invokes {@link Queue#maintain()} and clean itself up when
     * {@link Queue} gets GC-ed.
     */
    private static class MaintainTask extends SafeTimerTask {
        private final WeakReference<Queue> queue;

        MaintainTask(Queue queue) {
            this.queue = new WeakReference<Queue>(queue);

            long interval = 5 * Timer.ONE_SECOND;
            Trigger.timer.schedule(this, interval, interval);
        }

        protected void doRun() {
            Queue q = queue.get();
1550
            if (q != null)
1551 1552 1553 1554 1555
                q.maintain();
            else
                cancel();
        }
    }
1556 1557
    
    /**
1558
     * {@link ArrayList} of {@link Item} with more convenience methods.
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
     */
    private static class ItemList<T extends Item> extends ArrayList<T> {
    	public T get(Task task) {
    		for (T item: this) {
    			if (item.task == task) {
    				return item;
    			}
    		}
    		return null;
    	}
    	
    	public List<T> getAll(Task task) {
    		List<T> result = new ArrayList<T>();
    		for (T item: this) {
    			if (item.task == task) {
    				result.add(item);
    			}
    		}
    		return result;
    	}
    	
    	public boolean containsKey(Task task) {
    		return get(task) != null;
    	}
    	
    	public T remove(Task task) {
    		Iterator<T> it = iterator();
    		while (it.hasNext()) {
    			T t = it.next();
    			if (t.task == task) {
    				it.remove();
    				return t;
    			}
    		}
    		return null;
    	}
    	
    	public void put(Task task, T item) {
    		assert item.task == task;
    		add(item);
    	}
    	
    	public ItemList<T> values() {
    		return this;
    	}
1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627

        /**
         * Works like {@link #remove(Task)} but also marks the {@link Item} as cancelled.
         */
        public T cancel(Task p) {
            T x = remove(p);
            if(x!=null) x.onCancelled();
            return x;
        }

        /**
         * Works like {@link #remove(Object)} but also marks the {@link Item} as cancelled.
         */
        public boolean cancel(Item t) {
            boolean r = remove(t);
            if(r)   t.onCancelled();
            return r;
        }

        public void cancelAll() {
            for (T t : this)
                t.onCancelled();
            clear();
        }
1628
    }
1629 1630 1631 1632 1633

    @CLIResolver
    public static Queue getInstance() {
        return Hudson.getInstance().getQueue();
    }
K
kohsuke 已提交
1634 1635 1636 1637 1638 1639 1640 1641

    /**
     * Restores the queue content during the start up.
     */
    @Initializer(after=JOB_LOADED)
    public static void init(Hudson h) {
        h.getQueue().load();
    }
K
kohsuke 已提交
1642
}