Queue.java 56.4 KB
Newer Older
K
kohsuke 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*
 * The MIT License
 * 
 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi, Stephen Connolly, Tom Huybrechts
 * 
 * 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 已提交
24 25
package hudson.model;

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

35 36
import hudson.cli.declarative.CLIMethod;
import hudson.cli.declarative.CLIResolver;
37
import hudson.model.queue.AbstractQueueTask;
38
import hudson.model.queue.QueueSorter;
39
import hudson.model.queue.QueueTaskDispatcher;
40
import hudson.model.queue.WorkUnit;
41
import hudson.remoting.AsyncFutureImpl;
K
kohsuke 已提交
42
import hudson.model.Node.Mode;
43
import hudson.model.listeners.SaveableListener;
44
import hudson.model.queue.CauseOfBlockage;
K
kohsuke 已提交
45
import hudson.model.queue.FoldableAction;
46 47 48 49
import hudson.model.queue.CauseOfBlockage.BecauseLabelIsBusy;
import hudson.model.queue.CauseOfBlockage.BecauseNodeIsOffline;
import hudson.model.queue.CauseOfBlockage.BecauseLabelIsOffline;
import hudson.model.queue.CauseOfBlockage.BecauseNodeIsBusy;
50 51
import hudson.triggers.SafeTimerTask;
import hudson.triggers.Trigger;
K
kohsuke 已提交
52
import hudson.util.OneShotEvent;
53
import hudson.util.TimeUnit2;
54
import hudson.util.XStream2;
55 56
import hudson.util.ConsistentHash;
import hudson.util.ConsistentHash.Hash;
K
kohsuke 已提交
57

58 59 60 61 62
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
63
import java.lang.ref.WeakReference;
K
kohsuke 已提交
64
import java.util.ArrayList;
65
import java.util.Arrays;
K
kohsuke 已提交
66
import java.util.Calendar;
67
import java.util.Collection;
68
import java.util.Collections;
K
kohsuke 已提交
69 70 71 72 73
import java.util.GregorianCalendar;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
74
import java.util.NoSuchElementException;
K
kohsuke 已提交
75 76
import java.util.Set;
import java.util.TreeSet;
S
stephenconnolly 已提交
77
import java.util.Map.Entry;
78
import java.util.concurrent.atomic.AtomicInteger;
79
import java.util.concurrent.Future;
K
kohsuke 已提交
80 81 82
import java.util.logging.Level;
import java.util.logging.Logger;

K
kohsuke 已提交
83
import javax.management.timer.Timer;
84
import javax.servlet.ServletException;
K
kohsuke 已提交
85 86

import org.acegisecurity.AccessDeniedException;
87 88
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
K
kohsuke 已提交
89 90 91 92 93 94
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 已提交
95 96
/**
 * Build queue.
97 98
 *
 * <p>
99 100
 * 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}
101
 * so that we can keep track of additional data used for deciding what to exeucte when.
102 103
 *
 * <p>
104 105 106 107 108 109
 * Items in queue goes through several stages, as depicted below:
 * <pre>
 * (enter) --> waitingList --+--> blockedProjects
 *                           |        ^
 *                           |        |
 *                           |        v
110
 *                           +--> buildables ---> pending ---> (executed)
111
 * </pre>
112 113
 *
 * <p>
114 115 116
 * 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 已提交
117 118
 * @author Kohsuke Kawaguchi
 */
119
@ExportedBean
120
public class Queue extends ResourceController implements Saveable {
K
kohsuke 已提交
121
    /**
122
     * Items that are waiting for its quiet period to pass.
123 124
     *
     * <p>
K
kohsuke 已提交
125 126 127
     * This consists of {@link Item}s that cannot be run yet
     * because its time has not yet come.
     */
128
    private final Set<WaitingItem> waitingList = new TreeSet<WaitingItem>();
K
kohsuke 已提交
129 130

    /**
131
     * {@link Task}s that can be built immediately
132 133 134
     * but blocked because another build is in progress,
     * required {@link Resource}s are not available, or otherwise blocked
     * by {@link Task#isBuildBlocked()}.
K
kohsuke 已提交
135
     */
136
    private final ItemList<BlockedItem> blockedProjects = new ItemList<BlockedItem>();
K
kohsuke 已提交
137 138

    /**
139
     * {@link Task}s that can be built immediately
K
kohsuke 已提交
140
     * that are waiting for available {@link Executor}.
141
     * This list is sorted in such a way that earlier items are built earlier.
K
kohsuke 已提交
142
     */
143
    private final ItemList<BuildableItem> buildables = new ItemList<BuildableItem>();
144

145
    /**
146 147
     * {@link Task}s that are being handed over to the executor, but execution
     * has not started yet.
148 149 150
     */
    private final ItemList<BuildableItem> pendings = new ItemList<BuildableItem>();

K
kohsuke 已提交
151 152
    /**
     * Data structure created for each idle {@link Executor}.
153
     * This is a job offer from the queue to an executor.
154 155
     *
     * <p>
K
kohsuke 已提交
156 157 158
     * An idle executor (that calls {@link Queue#pop()} creates
     * a new {@link JobOffer} and gets itself {@linkplain Queue#parked parked},
     * and we'll eventually hand out an {@link #item} to build.
K
kohsuke 已提交
159
     */
160
    public class JobOffer {
K
kohsuke 已提交
161
        public final Executor executor;
K
kohsuke 已提交
162 163 164 165 166

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

K
kohsuke 已提交
169 170 171 172
        /**
         * The project that this {@link Executor} is going to build.
         * (Or null, in which case event is used to trigger a queue maintenance.)
         */
K
kohsuke 已提交
173
        private BuildableItem item;
K
kohsuke 已提交
174

K
kohsuke 已提交
175
        private JobOffer(Executor executor) {
K
kohsuke 已提交
176 177 178
            this.executor = executor;
        }

179 180 181
        public void set(BuildableItem p) {
            assert this.item == null;
            this.item = p;
K
kohsuke 已提交
182 183 184
            event.signal();
        }

185 186 187 188
        /**
         * Verifies that the {@link Executor} represented by this object is capable of executing the given task.
         */
        public boolean canTake(Task task) {
189 190 191
            Node node = getNode();
            if (node==null)     return false;   // this executor is about to die

192 193
            if(node.canTake(task)!=null)
                return false;   // this node is not able to take the task
194

195 196 197
            for (QueueTaskDispatcher d : QueueTaskDispatcher.all())
                if (d.canTake(node,task)!=null)
                    return false;
198 199 200 201 202 203 204

            return isAvailable();
        }

        /**
         * Is this executor ready to accept some tasks?
         */
K
kohsuke 已提交
205
        public boolean isAvailable() {
206
            return item == null && !executor.getOwner().isOffline() && executor.getOwner().isAcceptingTasks();
K
kohsuke 已提交
207 208 209 210 211 212 213
        }

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

        public boolean isNotExclusive() {
214
            return getNode().getMode() == Mode.NORMAL;
K
kohsuke 已提交
215 216 217
        }
    }

S
stephenconnolly 已提交
218
    /**
K
kohsuke 已提交
219
     * The executors that are currently waiting for a job to run.
S
stephenconnolly 已提交
220
     */
K
kohsuke 已提交
221
    private final Map<Executor,JobOffer> parked = new HashMap<Executor,JobOffer>();
K
kohsuke 已提交
222

223
    private volatile transient LoadBalancer loadBalancer;
224

225
    private volatile transient QueueSorter sorter;
226

227 228
    public Queue(LoadBalancer loadBalancer) {
        this.loadBalancer =  loadBalancer.sanitize();
229 230 231 232 233
        // 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);
    }

234 235 236 237 238 239 240 241 242
    public LoadBalancer getLoadBalancer() {
        return loadBalancer;
    }

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

243 244 245 246 247 248 249 250
    public QueueSorter getSorter() {
        return sorter;
    }

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

K
kohsuke 已提交
251 252 253 254 255
    /**
     * Loads the queue contents that was {@link #save() saved}.
     */
    public synchronized void load() {
        try {
K
TAB->WS  
kohsuke 已提交
256
            // first try the old format
K
kohsuke 已提交
257
            File queueFile = getQueueFile();
K
kohsuke 已提交
258 259
            if (queueFile.exists()) {
                BufferedReader in = new BufferedReader(new InputStreamReader(new FileInputStream(queueFile)));
K
TAB->WS  
kohsuke 已提交
260 261 262 263
                String line;
                while ((line = in.readLine()) != null) {
                    AbstractProject j = Hudson.getInstance().getItemByFullName(line, AbstractProject.class);
                    if (j != null)
M
mindless 已提交
264
                        j.scheduleBuild();
K
TAB->WS  
kohsuke 已提交
265 266 267 268 269 270 271
                }
                in.close();
                // discard the queue file now that we are done
                queueFile.delete();
            } else {
                queueFile = getXMLQueueFile();
                if (queueFile.exists()) {
272
                    List list = (List) new XmlFile(XSTREAM, queueFile).read();
K
kohsuke 已提交
273 274 275
                    int maxId = 0;
                    for (Object o : list) {
                        if (o instanceof Task) {
276
                            // backward compatibility
277
                            schedule((Task)o, 0);
K
kohsuke 已提交
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
                        } 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 已提交
294
                    }
K
kohsuke 已提交
295
                    WaitingItem.COUNTER.set(maxId);
296 297 298 299 300 301 302 303 304

                    // 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 已提交
305 306 307
                    queueFile.delete();
                }
            }
308
        } catch (IOException e) {
309
            LOGGER.log(Level.WARNING, "Failed to load the queue file " + getXMLQueueFile(), e);
K
kohsuke 已提交
310 311 312 313 314 315 316
        }
    }

    /**
     * Persists the queue contents to the disk.
     */
    public synchronized void save() {
317 318
        if(BulkChange.contains(this))  return;
        
K
kohsuke 已提交
319
        // write out the tasks on the queue
320
    	ArrayList<Queue.Item> items = new ArrayList<Queue.Item>();
K
kohsuke 已提交
321
    	for (Item item: getItems()) {
K
kohsuke 已提交
322
            if(item.task instanceof TransientTask)  continue;
323
    	    items.add(item);
K
kohsuke 已提交
324
    	}
K
kohsuke 已提交
325

K
kohsuke 已提交
326
        try {
327 328 329
            XmlFile queueFile = new XmlFile(XSTREAM, getXMLQueueFile());
            queueFile.write(items);
            SaveableListener.fireOnChange(this, queueFile);
330
        } catch (IOException e) {
331
            LOGGER.log(Level.WARNING, "Failed to write out the queue file " + getXMLQueueFile(), e);
K
kohsuke 已提交
332 333 334
        }
    }

335 336 337
    /**
     * Wipes out all the items currently in the queue, as if all of them are cancelled at once.
     */
338
    @CLIMethod(name="clear-queue")
339
    public synchronized void clear() {
340
        Hudson.getInstance().checkPermission(Hudson.ADMINISTER);
341 342
        for (WaitingItem i : waitingList)
            i.onCancelled();
343
        waitingList.clear();
344 345
        blockedProjects.cancelAll();
        buildables.cancelAll();
346 347 348
        scheduleMaintenance();
    }

K
kohsuke 已提交
349
    private File getQueueFile() {
K
TAB->WS  
kohsuke 已提交
350 351
        return new File(Hudson.getInstance().getRootDir(), "queue.txt");
    }
K
kohsuke 已提交
352

353
    /*package*/ File getXMLQueueFile() {
K
TAB->WS  
kohsuke 已提交
354 355
        return new File(Hudson.getInstance().getRootDir(), "queue.xml");
    }
K
kohsuke 已提交
356

357 358 359 360 361 362 363 364
    /**
     * @deprecated as of 1.311
     *      Use {@link #schedule(AbstractProject)}
     */
    public boolean add(AbstractProject p) {
        return schedule(p)!=null;
    }

K
kohsuke 已提交
365 366
    /**
     * Schedule a new build for this project.
367
     *
368 369 370
     * @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 已提交
371
     */
372 373
    public WaitingItem schedule(AbstractProject p) {
        return schedule(p, p.getQuietPeriod());
374 375 376 377
    }

    /**
     * Schedules a new build with a custom quiet period.
378 379
     *
     * <p>
K
kohsuke 已提交
380 381
     * Left for backward compatibility with &lt;1.114.
     *
382
     * @since 1.105
383 384
     * @deprecated as of 1.311
     *      Use {@link #schedule(Task, int)}
385
     */
386 387
    public boolean add(AbstractProject p, int quietPeriod) {
        return schedule(p, quietPeriod)!=null;
K
kohsuke 已提交
388
    }
389 390 391 392

    /**
     * Schedules an execution of a task.
     *
393
     * @param actions
K
kohsuke 已提交
394 395 396
     *      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.
397
     *      For the convenience of the caller, this list can contain null, and those will be silently ignored.
398 399 400 401 402 403 404 405 406 407
     * @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) {
408 409 410 411 412 413 414
        // 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 已提交
415 416 417 418 419
    	for(QueueDecisionHandler h : QueueDecisionHandler.all())
    		if (!h.shouldSchedule(p, actions))
                return null;    // veto

        return scheduleInternal(p, quietPeriod, actions);
420
    }
421

422 423 424 425 426 427 428 429 430 431 432 433 434
    /**
     * 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 已提交
435
        Calendar due = new GregorianCalendar();
436
    	due.add(Calendar.SECOND, quietPeriod);
437

438
        // Do we already have this task in the queue? Because if so, we won't schedule a new one.
439
    	List<Item> duplicatesInQueue = new ArrayList<Item>();
K
kohsuke 已提交
440
    	for(Item item : getItems(p)) {
441
    		boolean shouldScheduleItem = false;
K
kohsuke 已提交
442 443
    		for (QueueAction action: item.getActions(QueueAction.class)) {
                shouldScheduleItem |= action.shouldSchedule(actions);
444
    		}
K
kohsuke 已提交
445 446
    		for (QueueAction action: Util.filter(actions,QueueAction.class)) {
                shouldScheduleItem |= action.shouldSchedule(item.getActions());
447 448 449 450 451
    		}
    		if(!shouldScheduleItem) {
    			duplicatesInQueue.add(item);
    		}
    	}
452
    	if (duplicatesInQueue.isEmpty()) {
453
    		LOGGER.fine(p.getFullDisplayName() + " added to queue");
454

455
    		// put the item in the queue
K
kohsuke 已提交
456 457 458 459 460
            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 已提交
461

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

K
kohsuke 已提交
464 465 466
        // but let the actions affect the existing stuff.
        for(Item item : duplicatesInQueue) {
            for(FoldableAction a : Util.filter(actions,FoldableAction.class)) {
467
                a.foldIntoExisting(item, p, actions);
K
kohsuke 已提交
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
            }
        }

        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 已提交
494
    }
495
    
496 497 498 499
    /**
     * @deprecated as of 1.311
     *      Use {@link #schedule(Task, int)} 
     */
500
    public synchronized boolean add(Task p, int quietPeriod) {
501
    	return schedule(p, quietPeriod)!=null;
502 503
    }

504 505 506 507 508 509
    public synchronized WaitingItem schedule(Task p, int quietPeriod) {
    	return schedule(p, quietPeriod, new Action[0]);
    }

    /**
     * @deprecated as of 1.311
510
     *      Use {@link #schedule(Task, int, Action...)} 
511
     */
512
    public synchronized boolean add(Task p, int quietPeriod, Action... actions) {
513 514 515
    	return schedule(p, quietPeriod, actions)!=null;
    }

516
    /**
K
kohsuke 已提交
517
     * Convenience wrapper method around {@link #schedule(Task, int, List)}
518
     */
519 520
    public synchronized WaitingItem schedule(Task p, int quietPeriod, Action... actions) {
    	return schedule(p, quietPeriod, Arrays.asList(actions));
521
    }
K
kohsuke 已提交
522

K
kohsuke 已提交
523
    /**
524
     * Cancels the item in the queue. If the item is scheduled more than once, cancels the first occurrence.
K
kohsuke 已提交
525
     *
526 527
     * @return true if the project was indeed in the queue and was removed.
     *         false if this was no-op.
K
kohsuke 已提交
528
     */
K
kohsuke 已提交
529
    public synchronized boolean cancel(Task p) {
K
kohsuke 已提交
530
        LOGGER.fine("Cancelling " + p.getFullDisplayName());
K
kohsuke 已提交
531 532
        for (Iterator<WaitingItem> itr = waitingList.iterator(); itr.hasNext();) {
            Item item = itr.next();
K
kohsuke 已提交
533
            if (item.task.equals(p)) {
K
kohsuke 已提交
534
                itr.remove();
535
                item.onCancelled();
K
kohsuke 已提交
536
                return true;
K
kohsuke 已提交
537 538
            }
        }
K
kohsuke 已提交
539
        // use bitwise-OR to make sure that both branches get evaluated all the time
540
        return blockedProjects.cancel(p)!=null | buildables.cancel(p)!=null;
K
kohsuke 已提交
541
    }
542 543 544
    
    public synchronized boolean cancel(Item item) {
        LOGGER.fine("Cancelling " + item.task.getFullDisplayName() + " item#" + item.id);
545 546 547 548 549
        // 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;
550
    }
K
kohsuke 已提交
551 552

    public synchronized boolean isEmpty() {
553
        return waitingList.isEmpty() && blockedProjects.isEmpty() && buildables.isEmpty() && pendings.isEmpty();
K
kohsuke 已提交
554 555
    }

556
    private synchronized WaitingItem peek() {
557
        return waitingList.iterator().next();
K
kohsuke 已提交
558 559 560 561
    }

    /**
     * Gets a snapshot of items in the queue.
562 563 564
     *
     * Generally speaking the array is sorted such that the items that are most likely built sooner are
     * at the end.
K
kohsuke 已提交
565
     */
566
    @Exported(inline=true)
K
kohsuke 已提交
567
    public synchronized Item[] getItems() {
568
        Item[] r = new Item[waitingList.size() + blockedProjects.size() + buildables.size() + pendings.size()];
569 570
        waitingList.toArray(r);
        int idx = waitingList.size();
571 572
        for (BlockedItem p : blockedProjects.values())
            r[idx++] = p;
573
        for (BuildableItem p : reverse(buildables.values()))
574
            r[idx++] = p;
575 576
        for (BuildableItem p : reverse(pendings.values()))
            r[idx++] = p;
K
kohsuke 已提交
577 578
        return r;
    }
579 580 581 582 583
    
    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;
584
        for (Item item: pendings) if (item.id == id) return item;
585 586
    	return null;
    }
K
kohsuke 已提交
587

K
kohsuke 已提交
588 589 590
    /**
     * Gets all the {@link BuildableItem}s that are waiting for an executor in the given {@link Computer}.
     */
591 592
    public synchronized List<BuildableItem> getBuildableItems(Computer c) {
        List<BuildableItem> result = new ArrayList<BuildableItem>();
593 594 595 596 597 598
        _getBuildableItems(c, buildables, result);
        _getBuildableItems(c, pendings, result);
        return result;
    }

    private void _getBuildableItems(Computer c, ItemList<BuildableItem> col, List<BuildableItem> result) {
599
        Node node = c.getNode();
600
        for (BuildableItem p : col.values()) {
601 602
            if (node.canTake(p.task) == null)
                result.add(p);
603 604 605
        }
    }

K
kohsuke 已提交
606
    /**
607
     * Gets the snapshot of all {@link BuildableItem}s.
K
kohsuke 已提交
608 609
     */
    public synchronized List<BuildableItem> getBuildableItems() {
610 611 612
        ArrayList<BuildableItem> r = new ArrayList<BuildableItem>(buildables.values());
        r.addAll(pendings.values());
        return r;
K
kohsuke 已提交
613 614
    }

615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
    /**
     * 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 已提交
632 633 634 635 636 637 638 639
    /**
     * 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++;
640 641 642
        for (BuildableItem bi : pendings.values())
            if(bi.task.getAssignedLabel()==l)
                r++;
K
kohsuke 已提交
643 644 645
        return r;
    }

K
kohsuke 已提交
646 647 648 649 650
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
     */
651 652
    public synchronized Item getItem(Task t) {
        BlockedItem bp = blockedProjects.get(t);
653
        if (bp!=null)
654 655
            return bp;
        BuildableItem bi = buildables.get(t);
656 657 658
        if(bi!=null)
            return bi;
        bi = pendings.get(t);
659
        if(bi!=null)
660 661
            return bi;

662
        for (Item item : waitingList) {
663
            if (item.task == t)
K
kohsuke 已提交
664 665 666 667 668
                return item;
        }
        return null;
    }

669 670 671 672 673 674 675 676 677
    /**
     * 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));
678
        result.addAll(pendings.getAll(t));
679 680 681 682 683 684 685
        for (Item item : waitingList) {
            if (item.task == t)
                result.add(item);
        }
        return result;
    }

686 687
    /**
     * Left for backward compatibility.
688
     *
689 690
     * @see #getItem(Task)
    public synchronized Item getItem(AbstractProject p) {
691
        return getItem((Task) p);
692
    }
K
kohsuke 已提交
693
     */
694

K
kohsuke 已提交
695
    /**
K
kohsuke 已提交
696
     * Returns true if this queue contains the said project.
K
kohsuke 已提交
697
     */
698
    public synchronized boolean contains(Task t) {
699
        if (blockedProjects.containsKey(t) || buildables.containsKey(t) || pendings.containsKey(t))
K
kohsuke 已提交
700
            return true;
701
        for (Item item : waitingList) {
702
            if (item.task == t)
K
kohsuke 已提交
703 704 705 706 707 708 709
                return true;
        }
        return false;
    }

    /**
     * Called by the executor to fetch something to build next.
710
     * <p>
K
kohsuke 已提交
711 712
     * This method blocks until a next project becomes buildable.
     */
713
    public synchronized WorkUnit pop() throws InterruptedException {
K
kohsuke 已提交
714
        final Executor exec = Executor.currentExecutor();
715

K
kohsuke 已提交
716
        try {
717
            while (true) {
K
kohsuke 已提交
718 719 720
                final JobOffer offer = new JobOffer(exec);
                long sleep = -1;

721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
                // 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 已提交
737
                        itr.remove();
738 739
                        blockedProjects.put(p.task,new BlockedItem(p));
                        continue;
K
kohsuke 已提交
740 741
                    }

742 743 744 745 746 747
                    JobOffer runner = loadBalancer.choose(p.task, new ApplicableJobOfferList(p.task));
                    if (runner == null)
                        // 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 已提交
748

749 750 751 752
                    assert runner.canTake(p.task);

                    // found a matching executor. use it.
                    runner.set(p);
753 754
                    itr.remove();
                    pendings.add(p);
755 756 757 758 759 760 761 762 763 764 765
                }

                // 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 已提交
766 767
                }

768
                if (sleep == -1)
K
kohsuke 已提交
769 770 771 772
                    offer.event.block();
                else
                    offer.event.block(sleep);

773 774 775 776 777 778 779 780 781
                // retract the offer object
                assert parked.get(exec) == offer;
                parked.remove(exec);

                // am I woken up because I have a project to build?
                if (offer.item != null) {
                    // if so, just build it
                    LOGGER.fine("Pop returning " + offer.item + " for " + exec.getName());
                    offer.item.future.startExecuting(exec);
782
                    pendings.remove(offer.item);
783
                    return new WorkUnit(offer.item, offer.item.task);
K
kohsuke 已提交
784
                }
785
                // otherwise run a queue maintenance
K
kohsuke 已提交
786 787
            }
        } finally {
788 789 790 791 792 793 794 795 796 797
            // remove myself from the parked list
            JobOffer offer = parked.remove(exec);
            if (offer != null && offer.item != null) {
                // we are already assigned a project,
                // ask for someone else to build it.
                // note that while this thread is waiting for CPU
                // someone else can schedule this build again,
                // so check the contains method first.
                if (!contains(offer.item.task))
                    buildables.put(offer.item.task,offer.item);
K
kohsuke 已提交
798
            }
799 800 801 802 803 804

            // 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 已提交
805 806 807 808
        }
    }

    /**
809
     * Represents a list of {@linkplain JobOffer#canTake(Task) applicable} {@link JobOffer}s
810
     * and provides various typical 
K
kohsuke 已提交
811
     */
812
    public final class ApplicableJobOfferList implements Iterable<JobOffer> {
813 814 815 816
        private final List<JobOffer> list;
        // laziy filled
        private Map<Node,List<JobOffer>> nodes;

817
        private ApplicableJobOfferList(Task task) {
818 819
            list = new ArrayList<JobOffer>(parked.size());
            for (JobOffer j : parked.values())
820
                if(j.canTake(task))
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
                    list.add(j);
        }

        /**
         * Returns all the {@linkplain JobOffer#isAvailable() available} {@link JobOffer}s.
         */
        public List<JobOffer> all() {
            return list;
        }

        public Iterator<JobOffer> iterator() {
            return list.iterator();
        }

        /**
         * List up all the {@link Node}s that have some available offers.
         */
        public Set<Node> nodes() {
            return byNodes().keySet();
        }

        /**
         * Gets a {@link JobOffer} for an executor of the given node, if any.
         * Otherwise null. 
         */
        public JobOffer _for(Node n) {
            List<JobOffer> r = byNodes().get(n);
            if(r==null) return null;
            return r.get(0);
        }

        public Map<Node,List<JobOffer>> byNodes() {
            if(nodes==null) {
                nodes = new HashMap<Node,List<JobOffer>>();
                for (JobOffer o : list) {
                    List<JobOffer> l = nodes.get(o.getNode());
                    if(l==null) nodes.put(o.getNode(),l=new ArrayList<JobOffer>());
                    l.add(o);
                }
            }
            return nodes;
        }
K
kohsuke 已提交
863 864 865 866
    }

    /**
     * Checks the queue and runs anything that can be run.
867 868
     *
     * <p>
K
kohsuke 已提交
869
     * When conditions are changed, this method should be invoked.
870
     * <p>
K
kohsuke 已提交
871 872 873 874 875 876 877
     * 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()) {
878
            if (av.getValue().item == null) {
K
kohsuke 已提交
879 880 881 882 883 884
                av.getValue().event.signal();
                return;
            }
        }
    }

885 886 887
    /**
     * Checks if the given task is blocked.
     */
888
    private boolean isBuildBlocked(Task t) {
889 890 891
        return t.isBuildBlocked() || !canRun(t.getResourceList());
    }

892
    /**
893 894
     * Make sure we don't queue two tasks of the same project to be built
     * unless that project allows concurrent builds.
895
     */
896 897 898 899 900 901 902
    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
        }
903
        return !buildables.containsKey(t) && !pendings.containsKey(t);
904
    }
905

K
kohsuke 已提交
906
    /**
K
kohsuke 已提交
907
     * Queue maintenance.
908
     * <p>
909
     * Move projects between {@link #waitingList}, {@link #blockedProjects}, and {@link #buildables}
K
kohsuke 已提交
910 911
     * appropriately.
     */
912
    public synchronized void maintain() {
913 914
        if (LOGGER.isLoggable(Level.FINE))
            LOGGER.fine("Queue maintenance started " + this);
915

916
        Iterator<BlockedItem> itr = blockedProjects.values().iterator();
917
        while (itr.hasNext()) {
918
            BlockedItem p = itr.next();
919
            if (!isBuildBlocked(p.task) && allowNewBuildableTask(p.task)) {
K
kohsuke 已提交
920
                // ready to be executed
K
kohsuke 已提交
921
                LOGGER.fine(p.task.getFullDisplayName() + " no longer blocked");
K
kohsuke 已提交
922
                itr.remove();
923
                makeBuildable(new BuildableItem(p));
K
kohsuke 已提交
924 925 926
            }
        }

927
        while (!waitingList.isEmpty()) {
928
            WaitingItem top = peek();
K
kohsuke 已提交
929

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

933
            waitingList.remove(top);
934
            Task p = top.task;
935
            if (!isBuildBlocked(p) && allowNewBuildableTask(p)) {
K
kohsuke 已提交
936
                // ready to be executed immediately
K
kohsuke 已提交
937
                LOGGER.fine(p.getFullDisplayName() + " ready to build");
938
                makeBuildable(new BuildableItem(top));
K
kohsuke 已提交
939
            } else {
940
                // this can't be built now because another build is in progress
K
kohsuke 已提交
941
                // set this project aside.
K
kohsuke 已提交
942
                LOGGER.fine(p.getFullDisplayName() + " is blocked");
943
                blockedProjects.put(p,new BlockedItem(top));
K
kohsuke 已提交
944 945
            }
        }
946 947 948 949

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

952
    private void makeBuildable(BuildableItem p) {
953
        if(Hudson.FLYWEIGHT_SUPPORT && p.task instanceof FlyweightTask && (!Hudson.getInstance().isQuietingDown() || p.task instanceof NonBlockingTask)) {
954 955 956 957 958 959 960 961 962
            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);
963 964

            Label lbl = p.task.getAssignedLabel();
965 966
            for (Node n : hash.list(p.task.getFullDisplayName())) {
                Computer c = n.toComputer();
K
kohsuke 已提交
967
                if (c==null || c.isOffline())    continue;
968
                if (lbl!=null && !lbl.contains(n))  continue;
969 970 971 972 973 974 975 976 977 978
                c.startFlyWeightTask(p);
                return;
            }
            // 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);
    }

979 980 981 982
    public Api getApi() {
        return new Api(this);
    }

K
kohsuke 已提交
983 984 985 986 987 988
    /**
     * Marks {@link Task}s that are not persisted.
     * @since 1.311
     */
    public interface TransientTask extends Task {}

989 990 991 992 993 994 995
    /**
     * Marks {@link Task}s that do not consume {@link Executor}.
     * @see OneOffExecutor
     * @since 1.318
     */
    public interface FlyweightTask extends Task {}

K
kohsuke 已提交
996
    /**
997
     * Marks {@link Task}s that are not affected by the {@linkplain Hudson#isQuietingDown()}  quieting down},
K
kohsuke 已提交
998 999 1000 1001 1002 1003
     * because these tasks keep other tasks executing.
     *
     * @since 1.336 
     */
    public interface NonBlockingTask extends Task {}

K
kohsuke 已提交
1004 1005
    /**
     * Task whose execution is controlled by the queue.
1006
     *
1007
     * <p>
K
kohsuke 已提交
1008 1009 1010
     * {@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.
1011 1012 1013
     *
     * <p>
     * Pending {@link Task}s are persisted when Hudson shuts down, so
K
kohsuke 已提交
1014 1015
     * it needs to be persistable via XStream. To create a non-persisted
     * transient Task, extend {@link TransientTask} marker interface.
1016 1017 1018 1019 1020
     *
     * <p>
     * Plugins are encouraged to extend from {@link AbstractQueueTask}
     * instead of implementing this interface directly, to maintain
     * compatibility with future changes to this interface.
K
kohsuke 已提交
1021
     */
1022
    public interface Task extends ModelObject, ExecutionUnit {
1023
        /**
1024 1025 1026
         * If this task needs to be run on a node with a particular label,
         * return that {@link Label}. Otherwise null, indicating
         * it can run on anywhere.
1027
         */
1028
        Label getAssignedLabel();
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039

        /**
         * If the previous execution of this task run on a certain node
         * and this task prefers to run on the same node, return that.
         * Otherwise null.
         */
        Node getLastBuiltOn();

        /**
         * Returns true if the execution should be blocked
         * for temporary reasons.
1040 1041
         *
         * <p>
1042
         * Short-hand for {@code getCauseOfBlockage()!=null}.
1043 1044 1045 1046
         */
        boolean isBuildBlocked();

        /**
1047 1048
         * @deprecated as of 1.330
         *      Use {@link CauseOfBlockage#getShortDescription()} instead.
1049 1050 1051
         */
        String getWhyBlocked();

1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
        /**
         * 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();

1065
        /**
K
kohsuke 已提交
1066
         * Unique name of this task.
K
kohsuke 已提交
1067
         *
K
kohsuke 已提交
1068 1069
         * <p>
         * This method is no longer used, left here for compatibility. Just return {@link #getDisplayName()}.
1070 1071 1072
         */
        String getName();

1073 1074 1075 1076 1077
        /**
         * @see hudson.model.Item#getFullDisplayName()
         */
        String getFullDisplayName();

1078 1079 1080 1081
        /**
         * Estimate of how long will it take to execute this task.
         * Measured in milliseconds.
         *
1082
         * @return -1 if it's impossible to estimate.
1083 1084 1085
         */
        long getEstimatedDuration();

K
kohsuke 已提交
1086
        /**
1087
         * Creates {@link Executable}, which performs the actual execution of the task.
K
kohsuke 已提交
1088
         */
1089
        Executable createExecutable() throws IOException;
1090 1091 1092 1093 1094 1095 1096 1097

        /**
         * 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 已提交
1098 1099 1100 1101 1102 1103

        /**
         * Works just like {@link #checkAbortPermission()} except it indicates the status by a return value,
         * instead of exception.
         */
        boolean hasAbortPermission();
1104 1105
        
        /**
K
kohsuke 已提交
1106 1107 1108 1109 1110 1111 1112 1113
         * 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 '/'.
1114 1115
         */
        String getUrl();
1116 1117 1118
        
        /**
         * True if the task allows concurrent builds
1119 1120
         *
         * @since 1.338
1121 1122
         */
        boolean isConcurrentBuild();
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139

        Collection<? extends ExecutionUnit> getMemberExecutionUnits();
    }

    public interface ExecutionUnit extends ResourceActivity {
        /**
         * Estimate of how long will it take to execute this task.
         * Measured in milliseconds.
         *
         * @return -1 if it's impossible to estimate.
         */
        long getEstimatedDuration();

        /**
         * Creates {@link Executable}, which performs the actual execution of the task.
         */
        Executable createExecutable() throws IOException;
1140 1141 1142 1143 1144
    }

    public interface Executable extends Runnable {
        /**
         * Task from which this executable was created.
K
kohsuke 已提交
1145
         * Never null.
1146 1147 1148 1149 1150 1151 1152
         */
        Task getParent();

        /**
         * Called by {@link Executor} to perform the task
         */
        void run();
1153 1154 1155 1156

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

1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
    /*package*/ static final class FutureImpl extends AsyncFutureImpl<Executable> {
        private final Task task;
        /**
         * If the computation has started, set to {@link Executor} that's running the build.
         */
        private volatile Executor executor;

        private FutureImpl(Task task) {
            this.task = task;
        }

        @Override
        public boolean cancel(boolean mayInterruptIfRunning) {
            Queue q = Hudson.getInstance().getQueue();
            synchronized (q) {
                if(executor!=null) {
                    if(mayInterruptIfRunning)
                        executor.interrupt();
                    return mayInterruptIfRunning;
                }
                return q.cancel(task);
            }
        }

1184
        private void startExecuting(Executor executor) {
1185 1186 1187 1188
            this.executor = executor;
        }
    }

K
kohsuke 已提交
1189 1190 1191
    /**
     * Item in a queue.
     */
1192
    @ExportedBean(defaultVisibility = 999)
1193
    public static abstract class Item extends Actionable {
1194 1195 1196 1197
        /**
         * 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}.
         */
1198 1199 1200
    	public final int id;
    	
		/**
K
kohsuke 已提交
1201 1202
         * Project to be built.
         */
1203
        @Exported
1204
        public final Task task;
1205

1206
        /*package almost final*/ transient FutureImpl future;
1207

1208
        /**
1209 1210 1211
         * Build is blocked because another build is in progress,
         * required {@link Resource}s are not available, or otherwise blocked
         * by {@link Task#isBuildBlocked()}.
1212
         */
K
kohsuke 已提交
1213
        @Exported
1214
        public boolean isBlocked() { return this instanceof BlockedItem; }
1215 1216 1217 1218 1219 1220

        /**
         * 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 已提交
1221
        @Exported
1222
        public boolean isBuildable() { return this instanceof BuildableItem; }
1223

1224 1225 1226 1227 1228 1229
        /**
         * True if the item is starving for an executor for too long.
         */
        @Exported
        public boolean isStuck() { return false; }

1230 1231 1232 1233 1234 1235 1236
        /**
         * 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; }

1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
        /**
         * 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();
        }

1250
        protected Item(Task task, List<Action> actions, int id, FutureImpl future) {
1251 1252
            this.task = task;
            this.id = id;
1253
            this.future = future;
1254 1255 1256 1257
            for (Action action: actions) addAction(action);
        }
        
        protected Item(Item item) {
1258
        	this(item.task, item.getActions(), item.id, item.future);
K
kohsuke 已提交
1259 1260
        }

1261
        /**
1262
         * Gets a human-readable status message describing why it's in the queue.
1263
         */
K
kohsuke 已提交
1264
        @Exported
1265 1266 1267 1268 1269
        public final String getWhy() {
            CauseOfBlockage cob = getCauseOfBlockage();
            return cob!=null ? cob.getShortDescription() : null;
        }

K
kohsuke 已提交
1270 1271 1272
        /**
         * Gets an object that describes why this item is in the queue.
         */
1273 1274
        public abstract CauseOfBlockage getCauseOfBlockage();

1275 1276 1277 1278 1279 1280
        /**
         * Gets a human-readable message about the parameters of this item
         * @return String
         */
        @Exported
        public String getParams() {
K
kohsuke 已提交
1281
        	StringBuilder s = new StringBuilder();
1282 1283 1284 1285
        	for(Action action : getActions()) {
        		if(action instanceof ParametersAction) {
        			ParametersAction pa = (ParametersAction)action;
        			for (ParameterValue p : pa.getParameters()) {
K
kohsuke 已提交
1286
        				s.append('\n').append(p.getShortDescription());
1287 1288 1289
        			}
        		}
        	}
K
kohsuke 已提交
1290
        	return s.toString();
1291 1292
        }
        
1293 1294 1295
        public boolean hasCancelPermission() {
            return task.hasAbortPermission();
        }
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
        
        public String getDisplayName() {
			// TODO Auto-generated method stub
			return null;
		}

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

        /**
         * Called from queue.jelly.
         */
        public void doCancelQueue( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        	Hudson.getInstance().getQueue().cancel(this);
            rsp.forwardToPreviousPage(req);
        }
1314 1315 1316 1317 1318 1319 1320 1321 1322

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

        private Object readResolve() {
1323
            this.future = new FutureImpl(task);
1324 1325
            return this;
        }
K
kohsuke 已提交
1326 1327 1328 1329 1330

        @Override
        public String toString() {
            return getClass().getName()+':'+task.toString();
        }
1331 1332 1333 1334 1335
    }
    
    /**
     * An optional interface for actions on Queue.Item.
     * Lets the action cooperate in queue management.
1336 1337
     * 
     * @since 1.300-ish.
1338 1339 1340 1341 1342 1343 1344
     */
    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);
1345
    }
1346

1347
    /**
K
kohsuke 已提交
1348 1349 1350 1351 1352 1353
     * 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. 
1354 1355 1356 1357 1358 1359 1360 1361 1362
     *
     * <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 已提交
1363
    	 * Returns whether the new item should be scheduled.
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
    	 */
    	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);
    	}
    }
    
1376 1377 1378
    /**
     * {@link Item} in the {@link Queue#waitingList} stage.
     */
1379 1380 1381
    public static final class WaitingItem extends Item implements Comparable<WaitingItem> {
    	private static final AtomicInteger COUNTER = new AtomicInteger(0);
    	
1382 1383 1384 1385 1386
        /**
         * This item can be run after this time.
         */
        @Exported
        public Calendar timestamp;
1387

1388
        WaitingItem(Calendar timestamp, Task project, List<Action> actions) {
1389
            super(project, actions, COUNTER.incrementAndGet(), new FutureImpl(project));
1390 1391
            this.timestamp = timestamp;
        }
1392
        
1393 1394 1395 1396 1397 1398 1399
        public int compareTo(WaitingItem that) {
            int r = this.timestamp.getTime().compareTo(that.timestamp.getTime());
            if (r != 0) return r;

            return this.id - that.id;
        }

1400
        public CauseOfBlockage getCauseOfBlockage() {
1401
            long diff = timestamp.getTimeInMillis() - System.currentTimeMillis();
1402
            if (diff > 0)
1403
                return CauseOfBlockage.fromMessage(Messages._Queue_InQuietPeriod(Util.getTimeSpanString(diff)));
1404
            else
1405
                return CauseOfBlockage.fromMessage(Messages._Queue_Unknown());
1406 1407
        }
    }
K
kohsuke 已提交
1408

1409 1410 1411
    /**
     * Common part between {@link BlockedItem} and {@link BuildableItem}.
     */
1412
    public static abstract class NotWaitingItem extends Item {
1413 1414 1415 1416 1417 1418 1419
        /**
         * When did this job exit the {@link Queue#waitingList} phase?
         */
        @Exported
        public final long buildableStartMilliseconds;

        protected NotWaitingItem(WaitingItem wi) {
1420
            super(wi);
1421
            buildableStartMilliseconds = System.currentTimeMillis();
K
kohsuke 已提交
1422
        }
1423

1424
        protected NotWaitingItem(NotWaitingItem ni) {
1425
            super(ni);
1426
            buildableStartMilliseconds = ni.buildableStartMilliseconds;
1427
        }
1428
    }
1429

1430 1431 1432 1433 1434 1435 1436
    /**
     * {@link Item} in the {@link Queue#blockedProjects} stage.
     */
    public final class BlockedItem extends NotWaitingItem {
        public BlockedItem(WaitingItem wi) {
            super(wi);
        }
1437

1438 1439 1440 1441
        public BlockedItem(NotWaitingItem ni) {
            super(ni);
        }

1442
        public CauseOfBlockage getCauseOfBlockage() {
1443 1444 1445
            ResourceActivity r = getBlockingActivity(task);
            if (r != null) {
                if (r == task) // blocked by itself, meaning another build is in progress
1446 1447
                    return CauseOfBlockage.fromMessage(Messages._Queue_InProgress());
                return CauseOfBlockage.fromMessage(Messages._Queue_BlockedBy(r.getDisplayName()));
1448
            }
1449
            return task.getCauseOfBlockage();
1450
        }
1451
    }
1452

1453 1454 1455
    /**
     * {@link Item} in the {@link Queue#buildables} stage.
     */
1456
    public final static class BuildableItem extends NotWaitingItem {
1457 1458 1459 1460 1461 1462 1463 1464
        public BuildableItem(WaitingItem wi) {
            super(wi);
        }

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

1465
        public CauseOfBlockage getCauseOfBlockage() {
1466
            Hudson hudson = Hudson.getInstance();
K
kohsuke 已提交
1467
            if(hudson.isQuietingDown() && !(task instanceof NonBlockingTask))
1468
                return CauseOfBlockage.fromMessage(Messages._Queue_HudsonIsAboutToShutDown());
K
kohsuke 已提交
1469 1470

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

1474 1475
            if (label != null) {
                if (label.isOffline()) {
1476
                    Set<Node> nodes = label.getNodes();
1477
                    if (nodes.size() != 1)      return new BecauseLabelIsOffline(label);
1478
                    else                        return new BecauseNodeIsOffline(nodes.iterator().next());
1479 1480 1481
                }
            }

1482
            if(label==null)
1483
                return CauseOfBlockage.fromMessage(Messages._Queue_WaitingForNextAvailableExecutor());
1484 1485

            Set<Node> nodes = label.getNodes();
1486
            if (nodes.size() != 1)      return new BecauseLabelIsBusy(label);
1487
            else                        return new BecauseNodeIsBusy(nodes.iterator().next());
1488
        }
1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499

        @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) {
1500
                // if we were running elsewhere, we would have done this build ten times.
1501
                return elapsed > Math.max(d,60000L)*10;
1502 1503
            } else {
                // more than a day in the queue
1504
                return TimeUnit2.MILLISECONDS.toHours(elapsed)>24;
1505 1506
            }
        }
K
kohsuke 已提交
1507 1508 1509
    }

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

1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
    /**
     * 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 已提交
1553
                if(run==null)  throw new NoSuchElementException("No such build: "+string);
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
				return run;
			}

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

1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
    /**
     * 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();
1581
            if (q != null)
1582 1583 1584 1585 1586
                q.maintain();
            else
                cancel();
        }
    }
1587 1588
    
    /**
1589
     * {@link ArrayList} of {@link Item} with more convenience methods.
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
     */
    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;
    	}
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658

        /**
         * 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();
        }
1659
    }
1660 1661 1662 1663 1664

    @CLIResolver
    public static Queue getInstance() {
        return Hudson.getInstance().getQueue();
    }
K
kohsuke 已提交
1665 1666 1667 1668 1669 1670 1671 1672

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