Queue.java 56.6 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.labels.LabelAssignmentAction;
40
import hudson.model.queue.AbstractQueueTask;
41
import hudson.model.queue.Executables;
42
import hudson.model.queue.SubTask;
43
import hudson.model.queue.FutureImpl;
44 45
import hudson.model.queue.MappingWorksheet;
import hudson.model.queue.MappingWorksheet.Mapping;
46
import hudson.model.queue.QueueSorter;
47
import hudson.model.queue.QueueTaskDispatcher;
48
import hudson.model.queue.Tasks;
49
import hudson.model.queue.WorkUnit;
K
kohsuke 已提交
50
import hudson.model.Node.Mode;
51
import hudson.model.listeners.SaveableListener;
52
import hudson.model.queue.CauseOfBlockage;
K
kohsuke 已提交
53
import hudson.model.queue.FoldableAction;
54 55 56 57
import hudson.model.queue.CauseOfBlockage.BecauseLabelIsBusy;
import hudson.model.queue.CauseOfBlockage.BecauseNodeIsOffline;
import hudson.model.queue.CauseOfBlockage.BecauseLabelIsOffline;
import hudson.model.queue.CauseOfBlockage.BecauseNodeIsBusy;
58
import hudson.model.queue.WorkUnitContext;
59 60
import hudson.triggers.SafeTimerTask;
import hudson.triggers.Trigger;
K
kohsuke 已提交
61
import hudson.util.OneShotEvent;
62
import hudson.util.TimeUnit2;
63
import hudson.util.XStream2;
64 65
import hudson.util.ConsistentHash;
import hudson.util.ConsistentHash.Hash;
K
kohsuke 已提交
66

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

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

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

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

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

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

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

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

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

K
kohsuke 已提交
186
        private JobOffer(Executor executor) {
K
kohsuke 已提交
187 188 189
            this.executor = executor;
        }

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

K
kohsuke 已提交
197 198 199 200 201
        @Override
        public Executor getExecutor() {
            return executor;
        }

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

209
            if(node.canTake(item)!=null)
210
                return false;   // this node is not able to take the task
211

212
            for (QueueTaskDispatcher d : QueueTaskDispatcher.all())
213
                if (d.canTake(node,item)!=null)
214
                    return false;
215 216 217 218 219 220 221

            return isAvailable();
        }

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

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

        public boolean isNotExclusive() {
231
            return getNode().getMode() == Mode.NORMAL;
K
kohsuke 已提交
232 233 234
        }
    }

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

240
    private volatile transient LoadBalancer loadBalancer;
241

242
    private volatile transient QueueSorter sorter;
243

244 245
    public Queue(LoadBalancer loadBalancer) {
        this.loadBalancer =  loadBalancer.sanitize();
246 247 248 249 250
        // 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);
    }

251 252 253 254 255 256 257 258 259
    public LoadBalancer getLoadBalancer() {
        return loadBalancer;
    }

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

260 261 262 263 264 265 266 267
    public QueueSorter getSorter() {
        return sorter;
    }

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

K
kohsuke 已提交
268 269 270 271 272
    /**
     * Loads the queue contents that was {@link #save() saved}.
     */
    public synchronized void load() {
        try {
K
TAB->WS  
kohsuke 已提交
273
            // first try the old format
K
kohsuke 已提交
274
            File queueFile = getQueueFile();
K
kohsuke 已提交
275 276
            if (queueFile.exists()) {
                BufferedReader in = new BufferedReader(new InputStreamReader(new FileInputStream(queueFile)));
K
TAB->WS  
kohsuke 已提交
277 278
                String line;
                while ((line = in.readLine()) != null) {
279
                    AbstractProject j = Jenkins.getInstance().getItemByFullName(line, AbstractProject.class);
K
TAB->WS  
kohsuke 已提交
280
                    if (j != null)
M
mindless 已提交
281
                        j.scheduleBuild();
K
TAB->WS  
kohsuke 已提交
282 283 284 285 286 287 288
                }
                in.close();
                // discard the queue file now that we are done
                queueFile.delete();
            } else {
                queueFile = getXMLQueueFile();
                if (queueFile.exists()) {
289
                    List list = (List) new XmlFile(XSTREAM, queueFile).read();
K
kohsuke 已提交
290 291 292
                    int maxId = 0;
                    for (Object o : list) {
                        if (o instanceof Task) {
293
                            // backward compatibility
294
                            schedule((Task)o, 0);
K
kohsuke 已提交
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
                        } 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 已提交
311
                    }
K
kohsuke 已提交
312
                    WaitingItem.COUNTER.set(maxId);
313 314 315 316 317 318 319 320 321

                    // 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 已提交
322 323 324
                    queueFile.delete();
                }
            }
325
        } catch (IOException e) {
326
            LOGGER.log(Level.WARNING, "Failed to load the queue file " + getXMLQueueFile(), e);
K
kohsuke 已提交
327 328 329 330 331 332 333
        }
    }

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

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

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

K
kohsuke 已提交
366
    private File getQueueFile() {
367
        return new File(Jenkins.getInstance().getRootDir(), "queue.txt");
K
TAB->WS  
kohsuke 已提交
368
    }
K
kohsuke 已提交
369

370
    /*package*/ File getXMLQueueFile() {
371
        return new File(Jenkins.getInstance().getRootDir(), "queue.xml");
K
TAB->WS  
kohsuke 已提交
372
    }
K
kohsuke 已提交
373

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

K
kohsuke 已提交
382 383
    /**
     * Schedule a new build for this project.
384
     *
385 386 387
     * @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 已提交
388
     */
389 390
    public WaitingItem schedule(AbstractProject p) {
        return schedule(p, p.getQuietPeriod());
391 392 393 394
    }

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

    /**
     * Schedules an execution of a task.
     *
410
     * @param actions
K
kohsuke 已提交
411 412 413
     *      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.
414
     *      For the convenience of the caller, this list can contain null, and those will be silently ignored.
415 416 417 418 419 420 421 422 423 424
     * @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) {
425 426 427 428 429 430 431
        // 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 已提交
432 433 434 435 436
    	for(QueueDecisionHandler h : QueueDecisionHandler.all())
    		if (!h.shouldSchedule(p, actions))
                return null;    // veto

        return scheduleInternal(p, quietPeriod, actions);
437
    }
438

439 440 441 442 443 444 445 446 447 448 449 450 451
    /**
     * 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 已提交
452
        Calendar due = new GregorianCalendar();
453
    	due.add(Calendar.SECOND, quietPeriod);
454

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

472
    		// put the item in the queue
K
kohsuke 已提交
473 474 475 476 477
            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 已提交
478

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

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

        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 已提交
511
    }
512
    
513 514 515 516
    /**
     * @deprecated as of 1.311
     *      Use {@link #schedule(Task, int)} 
     */
517
    public synchronized boolean add(Task p, int quietPeriod) {
518
    	return schedule(p, quietPeriod)!=null;
519 520
    }

521 522 523 524 525 526
    public synchronized WaitingItem schedule(Task p, int quietPeriod) {
    	return schedule(p, quietPeriod, new Action[0]);
    }

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

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

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

    public synchronized boolean isEmpty() {
570
        return waitingList.isEmpty() && blockedProjects.isEmpty() && buildables.isEmpty() && pendings.isEmpty();
K
kohsuke 已提交
571 572
    }

573
    private synchronized WaitingItem peek() {
574
        return waitingList.iterator().next();
K
kohsuke 已提交
575 576 577 578
    }

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

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

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

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

632 633 634 635 636 637 638
    /**
     * Gets the snapshot of all {@link BuildableItem}s.
     */
    public synchronized List<BuildableItem> getPendingItems() {
        return new ArrayList<BuildableItem>(pendings.values());
    }

639 640
    /**
     * Gets all items that are in the queue but not blocked
641 642
     *
     * @since 1.402
643
     */
644 645 646 647 648 649
    public synchronized List<Item> getUnblockedItems() {
    	List<Item> queuedNotBlocked = new ArrayList<Item>();
        queuedNotBlocked.addAll(waitingList);
        queuedNotBlocked.addAll(buildables);
        queuedNotBlocked.addAll(pendings);
        // but not 'blockedProjects'
650 651 652
        return queuedNotBlocked;
    }

653 654 655 656 657 658 659 660 661 662 663 664 665
    /**
     * Works just like {@link #getUnblockedItems()} but return tasks.
     *
     * @since 1.402
     */
    public synchronized Set<Task> getUnblockedTasks() {
        List<Item> items = getUnblockedItems();
        Set<Task> unblockedTasks = new HashSet<Task>(items.size());
        for (Queue.Item t : items)
            unblockedTasks.add(t.task);
        return unblockedTasks;
    }

666 667 668 669 670 671 672 673 674 675
    /**
     * 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 已提交
676 677 678 679 680 681
    /**
     * 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())
682
            if(bi.getAssignedLabel()==l)
K
kohsuke 已提交
683
                r++;
684
        for (BuildableItem bi : pendings.values())
685
            if(bi.getAssignedLabel()==l)
686
                r++;
K
kohsuke 已提交
687 688 689
        return r;
    }

K
kohsuke 已提交
690 691 692 693 694
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
     */
695 696
    public synchronized Item getItem(Task t) {
        BlockedItem bp = blockedProjects.get(t);
697
        if (bp!=null)
698 699
            return bp;
        BuildableItem bi = buildables.get(t);
700 701 702
        if(bi!=null)
            return bi;
        bi = pendings.get(t);
703
        if(bi!=null)
704 705
            return bi;

706
        for (Item item : waitingList) {
707
            if (item.task == t)
K
kohsuke 已提交
708 709 710 711 712
                return item;
        }
        return null;
    }

713 714 715 716 717 718 719 720 721
    /**
     * 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));
722
        result.addAll(pendings.getAll(t));
723 724 725 726 727 728 729
        for (Item item : waitingList) {
            if (item.task == t)
                result.add(item);
        }
        return result;
    }

730 731
    /**
     * Left for backward compatibility.
732
     *
733 734
     * @see #getItem(Task)
    public synchronized Item getItem(AbstractProject p) {
735
        return getItem((Task) p);
736
    }
K
kohsuke 已提交
737
     */
738

K
kohsuke 已提交
739
    /**
K
kohsuke 已提交
740
     * Returns true if this queue contains the said project.
K
kohsuke 已提交
741
     */
742
    public synchronized boolean contains(Task t) {
743
        if (blockedProjects.containsKey(t) || buildables.containsKey(t) || pendings.containsKey(t))
K
kohsuke 已提交
744
            return true;
745
        for (Item item : waitingList) {
746
            if (item.task == t)
K
kohsuke 已提交
747 748 749 750 751 752 753
                return true;
        }
        return false;
    }

    /**
     * Called by the executor to fetch something to build next.
754
     * <p>
K
kohsuke 已提交
755 756
     * This method blocks until a next project becomes buildable.
     */
757
    public synchronized WorkUnit pop() throws InterruptedException {
K
kohsuke 已提交
758
        final Executor exec = Executor.currentExecutor();
759

760 761 762 763 764 765 766
        if (exec instanceof OneOffExecutor) {
            OneOffExecutor ooe = (OneOffExecutor) exec;
            final WorkUnit wu = ooe.getAssignedWorkUnit();
            pendings.remove(wu.context.item);
            return wu;
        }

K
kohsuke 已提交
767
        try {
768
            while (true) {
K
kohsuke 已提交
769 770 771
                final JobOffer offer = new JobOffer(exec);
                long sleep = -1;

772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
                // 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 已提交
788
                        itr.remove();
789 790
                        blockedProjects.put(p.task,new BlockedItem(p));
                        continue;
K
kohsuke 已提交
791 792
                    }

793 794
                    List<JobOffer> candidates = new ArrayList<JobOffer>(parked.size());
                    for (JobOffer j : parked.values())
795
                        if(j.canTake(p))
796 797
                            candidates.add(j);

K
kohsuke 已提交
798 799
                    MappingWorksheet ws = new MappingWorksheet(p, candidates);
                    Mapping m = loadBalancer.map(p.task, ws);
800
                    if (m == null)
801 802 803 804
                        // 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 已提交
805

806
                    // found a matching executor. use it.
807 808
                    WorkUnitContext wuc = new WorkUnitContext(p);
                    m.execute(wuc);
809

810
                    itr.remove();
811 812
                    if (!wuc.getWorkUnits().isEmpty())
                        pendings.add(p);
813 814 815 816 817 818 819 820 821 822 823
                }

                // 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 已提交
824 825
                }

826
                if (sleep == -1)
K
kohsuke 已提交
827 828 829 830
                    offer.event.block();
                else
                    offer.event.block(sleep);

831 832 833 834 835
                // retract the offer object
                assert parked.get(exec) == offer;
                parked.remove(exec);

                // am I woken up because I have a project to build?
836
                if (offer.workUnit != null) {
837
                    // if so, just build it
838 839 840 841 842
                    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);
843

844
                    return offer.workUnit;
K
kohsuke 已提交
845
                }
846
                // otherwise run a queue maintenance
K
kohsuke 已提交
847 848
            }
        } finally {
849 850
            // remove myself from the parked list
            JobOffer offer = parked.remove(exec);
851 852
            if (offer != null && offer.workUnit != null) {
                // we are already assigned a project, but now we can't handle it.
853
                offer.workUnit.context.abort(new AbortException());
K
kohsuke 已提交
854
            }
855 856 857 858 859 860

            // 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 已提交
861 862 863 864 865
        }
    }

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

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

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

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

915
        // blocked -> buildable
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)) {
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(Jenkins.FLYWEIGHT_SUPPORT && p.task instanceof FlyweightTask && !ifBlockedByHudsonShutdown(p.task)) {
954 955 956 957 958
            ConsistentHash<Node> hash = new ConsistentHash<Node>(new Hash<Node>() {
                public String hash(Node node) {
                    return node.getNodeName();
                }
            });
959
            Jenkins h = Jenkins.getInstance();
960 961 962
            hash.add(h, h.getNumExecutors()*100);
            for (Node n : h.getNodes())
                hash.add(n,n.getNumExecutors()*100);
963

964
            Label lbl = p.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
                if (n.canTake(p) != null) continue;
970
                c.startFlyWeightTask(new WorkUnitContext(p).createWorkUnit(p.task));
971
                pendings.add(p);
972
                return;
973 974 975 976 977 978 979 980
            }
            // 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);
    }

981
    public static boolean ifBlockedByHudsonShutdown(Task task) {
982
        return Jenkins.getInstance().isQuietingDown() && !(task instanceof NonBlockingTask);
983 984
    }

985 986 987 988
    public Api getApi() {
        return new Api(this);
    }

K
kohsuke 已提交
989 990 991 992 993 994
    /**
     * Marks {@link Task}s that are not persisted.
     * @since 1.311
     */
    public interface TransientTask extends Task {}

995 996 997 998 999 1000 1001
    /**
     * Marks {@link Task}s that do not consume {@link Executor}.
     * @see OneOffExecutor
     * @since 1.318
     */
    public interface FlyweightTask extends Task {}

K
kohsuke 已提交
1002
    /**
1003
     * Marks {@link Task}s that are not affected by the {@linkplain Jenkins#isQuietingDown()}  quieting down},
K
kohsuke 已提交
1004 1005 1006 1007 1008 1009
     * because these tasks keep other tasks executing.
     *
     * @since 1.336 
     */
    public interface NonBlockingTask extends Task {}

K
kohsuke 已提交
1010 1011
    /**
     * Task whose execution is controlled by the queue.
1012
     *
1013
     * <p>
K
kohsuke 已提交
1014 1015 1016
     * {@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.
1017 1018 1019
     *
     * <p>
     * Pending {@link Task}s are persisted when Hudson shuts down, so
K
kohsuke 已提交
1020 1021
     * it needs to be persistable via XStream. To create a non-persisted
     * transient Task, extend {@link TransientTask} marker interface.
1022 1023 1024 1025 1026
     *
     * <p>
     * Plugins are encouraged to extend from {@link AbstractQueueTask}
     * instead of implementing this interface directly, to maintain
     * compatibility with future changes to this interface.
1027 1028 1029 1030 1031 1032
     *
     * <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 已提交
1033
     */
1034
    public interface Task extends ModelObject, SubTask {
1035 1036 1037
        /**
         * Returns true if the execution should be blocked
         * for temporary reasons.
1038 1039
         *
         * <p>
1040
         * Short-hand for {@code getCauseOfBlockage()!=null}.
1041 1042 1043 1044
         */
        boolean isBuildBlocked();

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

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

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

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

1076 1077 1078 1079 1080 1081 1082
        /**
         * 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 已提交
1083 1084 1085 1086 1087 1088

        /**
         * Works just like {@link #checkAbortPermission()} except it indicates the status by a return value,
         * instead of exception.
         */
        boolean hasAbortPermission();
1089 1090
        
        /**
K
kohsuke 已提交
1091 1092 1093 1094 1095 1096 1097 1098
         * 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 '/'.
1099 1100
         */
        String getUrl();
1101 1102 1103
        
        /**
         * True if the task allows concurrent builds
1104 1105
         *
         * @since 1.338
1106 1107
         */
        boolean isConcurrentBuild();
1108

1109
        /**
1110
         * Obtains the {@link SubTask}s that constitute this task.
1111
         *
1112
         * <p>
1113 1114 1115
         * 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.
1116
         *
1117
         * <p>
1118
         * At least size 1.
1119
         *
1120 1121 1122 1123
         * <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 已提交
1124
         * @since 1.377
1125
         */
1126
        Collection<? extends SubTask> getSubTasks();
1127 1128
    }

1129
    /**
M
mindless 已提交
1130
     * Represents the real meat of the computation run by {@link Executor}.
1131 1132 1133 1134 1135
     *
     * <h2>Views</h2>
     * <p>
     * Implementation must have <tt>executorCell.jelly</tt>, which is
     * used to render the HTML that indicates this executable is executing.
1136
     */
1137 1138 1139
    public interface Executable extends Runnable {
        /**
         * Task from which this executable was created.
K
kohsuke 已提交
1140
         * Never null.
1141 1142
         *
         * <p>
M
mindless 已提交
1143
         * Since this method went through a signature change in 1.377, the invocation may results in
1144 1145
         * {@link AbstractMethodError}.
         * Use {@link Executables#getParentOf(Executable)} that avoids this.
1146
         */
1147
        SubTask getParent();
1148 1149 1150 1151 1152

        /**
         * Called by {@link Executor} to perform the task
         */
        void run();
1153 1154 1155 1156
        
        /**
         * Estimate of how long will it take to execute this executable.
         * Measured in milliseconds.
1157
         * 
1158
         * Please, consider using {@link Executables#getEstimatedDurationFor(Executable)}
1159
         * to protected against AbstractMethodErrors!
1160 1161 1162 1163 1164
         *
         * @return -1 if it's impossible to estimate.
         * @since 1.383
         */
        long getEstimatedDuration();
1165 1166 1167 1168

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

K
kohsuke 已提交
1172 1173 1174
    /**
     * Item in a queue.
     */
1175
    @ExportedBean(defaultVisibility = 999)
1176
    public static abstract class Item extends Actionable {
1177 1178 1179 1180
        /**
         * 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}.
         */
1181 1182 1183
    	public final int id;
    	
		/**
K
kohsuke 已提交
1184 1185
         * Project to be built.
         */
1186
        @Exported
1187
        public final Task task;
1188

1189
        private /*almost final*/ transient FutureImpl future;
1190

1191
        /**
1192 1193 1194
         * Build is blocked because another build is in progress,
         * required {@link Resource}s are not available, or otherwise blocked
         * by {@link Task#isBuildBlocked()}.
1195
         */
K
kohsuke 已提交
1196
        @Exported
1197
        public boolean isBlocked() { return this instanceof BlockedItem; }
1198 1199 1200 1201 1202 1203

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

1207 1208 1209 1210 1211 1212
        /**
         * True if the item is starving for an executor for too long.
         */
        @Exported
        public boolean isStuck() { return false; }

1213 1214 1215 1216 1217 1218 1219
        /**
         * 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; }

1220 1221 1222 1223 1224 1225 1226 1227
        public Label getAssignedLabel() {
            for (LabelAssignmentAction laa : getActions(LabelAssignmentAction.class)) {
                Label l = laa.getAssignedLabel(task);
                if (l!=null)    return l;
            }
            return task.getAssignedLabel();
        }

1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
        /**
         * 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();
        }

1241
        protected Item(Task task, List<Action> actions, int id, FutureImpl future) {
1242 1243
            this.task = task;
            this.id = id;
1244
            this.future = future;
1245 1246 1247 1248
            for (Action action: actions) addAction(action);
        }
        
        protected Item(Item item) {
1249
        	this(item.task, item.getActions(), item.id, item.future);
K
kohsuke 已提交
1250 1251
        }

1252
        /**
1253
         * Gets a human-readable status message describing why it's in the queue.
1254
         */
K
kohsuke 已提交
1255
        @Exported
1256 1257 1258 1259 1260
        public final String getWhy() {
            CauseOfBlockage cob = getCauseOfBlockage();
            return cob!=null ? cob.getShortDescription() : null;
        }

K
kohsuke 已提交
1261 1262 1263
        /**
         * Gets an object that describes why this item is in the queue.
         */
1264 1265
        public abstract CauseOfBlockage getCauseOfBlockage();

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

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

        /**
         * Called from queue.jelly.
         */
1301
        public HttpResponse doCancelQueue() throws IOException, ServletException {
1302
        	Jenkins.getInstance().getQueue().cancel(this);
1303
            return HttpResponses.forwardToPreviousPage();
1304
        }
1305 1306 1307 1308 1309 1310 1311 1312 1313

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

        private Object readResolve() {
1314
            this.future = new FutureImpl(task);
1315 1316
            return this;
        }
K
kohsuke 已提交
1317 1318 1319 1320 1321

        @Override
        public String toString() {
            return getClass().getName()+':'+task.toString();
        }
1322 1323 1324 1325 1326
    }
    
    /**
     * An optional interface for actions on Queue.Item.
     * Lets the action cooperate in queue management.
1327 1328
     * 
     * @since 1.300-ish.
1329 1330 1331 1332 1333 1334 1335
     */
    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);
1336
    }
1337

1338
    /**
K
kohsuke 已提交
1339 1340 1341 1342 1343 1344
     * 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. 
1345 1346 1347 1348 1349 1350 1351 1352 1353
     *
     * <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 已提交
1354
    	 * Returns whether the new item should be scheduled.
1355 1356 1357 1358 1359 1360 1361 1362
    	 */
    	public abstract boolean shouldSchedule(Task p, List<Action> actions);
    	    	
    	/**
    	 * All registered {@link QueueDecisionHandler}s
    	 * @return
    	 */
    	public static ExtensionList<QueueDecisionHandler> all() {
1363
    		return Jenkins.getInstance().getExtensionList(QueueDecisionHandler.class);
1364 1365 1366
    	}
    }
    
1367 1368 1369
    /**
     * {@link Item} in the {@link Queue#waitingList} stage.
     */
1370 1371 1372
    public static final class WaitingItem extends Item implements Comparable<WaitingItem> {
    	private static final AtomicInteger COUNTER = new AtomicInteger(0);
    	
1373 1374 1375 1376 1377
        /**
         * This item can be run after this time.
         */
        @Exported
        public Calendar timestamp;
1378

1379
        public WaitingItem(Calendar timestamp, Task project, List<Action> actions) {
1380
            super(project, actions, COUNTER.incrementAndGet(), new FutureImpl(project));
1381 1382
            this.timestamp = timestamp;
        }
1383
        
1384 1385 1386 1387 1388 1389 1390
        public int compareTo(WaitingItem that) {
            int r = this.timestamp.getTime().compareTo(that.timestamp.getTime());
            if (r != 0) return r;

            return this.id - that.id;
        }

1391
        public CauseOfBlockage getCauseOfBlockage() {
1392
            long diff = timestamp.getTimeInMillis() - System.currentTimeMillis();
1393
            if (diff > 0)
1394
                return CauseOfBlockage.fromMessage(Messages._Queue_InQuietPeriod(Util.getTimeSpanString(diff)));
1395
            else
1396
                return CauseOfBlockage.fromMessage(Messages._Queue_Unknown());
1397 1398
        }
    }
K
kohsuke 已提交
1399

1400 1401 1402
    /**
     * Common part between {@link BlockedItem} and {@link BuildableItem}.
     */
1403
    public static abstract class NotWaitingItem extends Item {
1404 1405 1406 1407 1408 1409 1410
        /**
         * When did this job exit the {@link Queue#waitingList} phase?
         */
        @Exported
        public final long buildableStartMilliseconds;

        protected NotWaitingItem(WaitingItem wi) {
1411
            super(wi);
1412
            buildableStartMilliseconds = System.currentTimeMillis();
K
kohsuke 已提交
1413
        }
1414

1415
        protected NotWaitingItem(NotWaitingItem ni) {
1416
            super(ni);
1417
            buildableStartMilliseconds = ni.buildableStartMilliseconds;
1418
        }
1419
    }
1420

1421 1422 1423 1424 1425 1426 1427
    /**
     * {@link Item} in the {@link Queue#blockedProjects} stage.
     */
    public final class BlockedItem extends NotWaitingItem {
        public BlockedItem(WaitingItem wi) {
            super(wi);
        }
1428

1429 1430 1431 1432
        public BlockedItem(NotWaitingItem ni) {
            super(ni);
        }

1433
        public CauseOfBlockage getCauseOfBlockage() {
1434 1435 1436
            ResourceActivity r = getBlockingActivity(task);
            if (r != null) {
                if (r == task) // blocked by itself, meaning another build is in progress
1437 1438
                    return CauseOfBlockage.fromMessage(Messages._Queue_InProgress());
                return CauseOfBlockage.fromMessage(Messages._Queue_BlockedBy(r.getDisplayName()));
1439
            }
1440
            return task.getCauseOfBlockage();
1441
        }
1442
    }
1443

1444 1445 1446
    /**
     * {@link Item} in the {@link Queue#buildables} stage.
     */
1447
    public final static class BuildableItem extends NotWaitingItem {
1448 1449 1450 1451 1452 1453 1454 1455
        public BuildableItem(WaitingItem wi) {
            super(wi);
        }

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

1456
        public CauseOfBlockage getCauseOfBlockage() {
1457
            Jenkins hudson = Jenkins.getInstance();
1458
            if(ifBlockedByHudsonShutdown(task))
1459
                return CauseOfBlockage.fromMessage(Messages._Queue_HudsonIsAboutToShutDown());
K
kohsuke 已提交
1460

1461
            Label label = getAssignedLabel();
K
kohsuke 已提交
1462
            if (hudson.getNodes().isEmpty())
1463
                label = null;    // no master/slave. pointless to talk about nodes
1464

1465 1466
            if (label != null) {
                if (label.isOffline()) {
1467
                    Set<Node> nodes = label.getNodes();
1468
                    if (nodes.size() != 1)      return new BecauseLabelIsOffline(label);
1469
                    else                        return new BecauseNodeIsOffline(nodes.iterator().next());
1470 1471 1472
                }
            }

1473
            if(label==null)
1474
                return CauseOfBlockage.fromMessage(Messages._Queue_WaitingForNextAvailableExecutor());
1475 1476

            Set<Node> nodes = label.getNodes();
1477
            if (nodes.size() != 1)      return new BecauseLabelIsBusy(label);
1478
            else                        return new BecauseNodeIsBusy(nodes.iterator().next());
1479
        }
1480 1481 1482

        @Override
        public boolean isStuck() {
1483
            Label label = getAssignedLabel();
1484 1485 1486 1487 1488 1489 1490
            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) {
1491
                // if we were running elsewhere, we would have done this build ten times.
1492
                return elapsed > Math.max(d,60000L)*10;
1493 1494
            } else {
                // more than a day in the queue
1495
                return TimeUnit2.MILLISECONDS.toHours(elapsed)>24;
1496 1497
            }
        }
K
kohsuke 已提交
1498 1499 1500
    }

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

1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
    /**
     * 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) {
1518
                Object item = Jenkins.getInstance().getItemByFullName(string);
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540
                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]);
1541
				Job<?,?> job = (Job<?,?>) Jenkins.getInstance().getItemByFullName(projectName);
1542 1543
                if(job==null)  throw new NoSuchElementException("No such job exists: "+projectName);
				Run<?,?> run = job.getBuildByNumber(buildNumber);
K
kohsuke 已提交
1544
                if(run==null)  throw new NoSuchElementException("No such build: "+string);
1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
				return run;
			}

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

1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
    /**
     * 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();
1572
            if (q != null)
1573 1574 1575 1576 1577
                q.maintain();
            else
                cancel();
        }
    }
1578 1579
    
    /**
1580
     * {@link ArrayList} of {@link Item} with more convenience methods.
1581
     */
1582
    private static class ItemList<T extends Item> extends ArrayList<T> {
1583 1584 1585 1586 1587 1588 1589 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
    	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;
    	}
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649

        /**
         * 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();
        }
1650
    }
1651 1652 1653

    @CLIResolver
    public static Queue getInstance() {
1654
        return Jenkins.getInstance().getQueue();
1655
    }
K
kohsuke 已提交
1656 1657 1658 1659 1660

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